Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/content/docs/basic/configuration/01-ntp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@ This page allows you to configure the Network Time Protocol (NTP) servers used b

## Introduction

The NTP Server settings page displays the currently configured NTP server addresses. Each server is shown with a clock icon.
The NTP Server configuration page allows you to manage the time synchronization sources for your OtterScale infrastructure. Here you can view and modify the list of NTP servers that will be used across all scopes.

**Key Points:**

- **Scope:** These settings apply to all scopes. Any changes made here will affect time synchronization for MAAS itself, all deployed machines, and devices using MAAS's DHCP services.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's an inconsistency in the product name. The documentation is for 'OtterScale', but this line refers to 'MAAS'. For consistency, 'MAAS' should be replaced with 'OtterScale'.

- **Scope:** These settings apply to all scopes. Any changes made here will affect time synchronization for OtterScale itself, all deployed machines, and devices using OtterScale's DHCP services.

- **Default Configuration:** By default, OtterScale uses `ntp.ubuntu.com` as the NTP server.
- **Address Format:** You can specify NTP servers using either IP addresses (e.g., `192.168.1.1`) or hostnames (e.g., `pool.ntp.org`, `time.google.com`).
- **Multiple Servers:** It's recommended to configure multiple NTP servers for redundancy. If one server becomes unavailable, the system will automatically fall back to alternative servers.
- **Display:** Each configured server is displayed with a clock icon in the configuration list.

## Why is NTP Important?

Expand All @@ -32,9 +40,8 @@ To modify the NTP server list, follow these steps:

3. In the **Address** field, you can manage the list of NTP servers:

- **Add a server:** Type the NTP server address (e.g., `pool.ntp.org`) in the input field and click the **Add** button (or press Enter).
- **Remove a server:** Click the remove icon next to an existing address to delete it.
- **Clear all:** Use the **Clear** button to remove all entries.
- **Add a server:** Type the NTP server address (e.g., `pool.ntp.org`) in the input field and click the **+** button to add it to the list (or press Enter).
- **Remove a server:** Click the **×** icon next to an existing address to delete it from the list.

4. Click **Confirm** to save your changes. The system will update the configuration and the new list will be displayed.

Expand Down
20 changes: 15 additions & 5 deletions src/content/docs/basic/configuration/03-machine-tag.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,20 @@ description: Configure machine tags for OtterScale.

import { Steps } from '@astrojs/starlight/components';

This page allows you to manage tags that can be assigned to machines in the OtterScale cluster. Tags are useful for grouping machines, applying specific configurations, or identifying machine roles (e.g., `kubernetes-worker`, `ceph-osd`).
This page allows you to manage tags that can be assigned to machines in the OtterScale cluster for filtering and group management. These tags help in organizing and managing machines based on their characteristics or purposes.

## Introduction

The Machine Tag settings page displays a list of all existing tags. The table includes the following information:
The Machine Tag settings page displays a list of all existing tags in a table format. Tags are identifiable labels that can be assigned to machines for various purposes such as:

- **Tag**: The name of the tag (e.g., `gpu`, `storage`).
- **Comment**: A description or note associated with the tag. Built-in tags may have specific comments indicating their purpose.
- **Role Identification**: Marking machines by their function (e.g., `kubernetes-worker`, `kubernetes-control-plane`, `ceph-osd`)
- **Hardware Features**: Identifying specific capabilities (e.g., `virtual` for VMs)
- **Grouping**: Organizing machines for bulk operations or filtering

### Table Columns

- **TAG**: The unique name of the tag (e.g., `virtual`, `kubernetes`, `ceph`).
- **COMMENT**: A description or note associated with the tag. Tags with "built-in" comment are system-managed tags that cannot be deleted.

## Manage Machine Tags

Expand Down Expand Up @@ -46,10 +52,14 @@ To remove a tag:

2. Click the **Delete** button (trash icon) in the actions column.

- **Note**: Tags marked as "built-in" in their comment cannot be deleted. The delete button will be disabled for these tags.
- **Note**: Built-in system tags (those with "built-in" in the comment field) cannot be deleted. The Delete link will be grayed out and disabled for these tags.

3. A confirmation modal will appear. You must type the name of the tag to confirm deletion.

4. Click **Confirm** to permanently delete the tag.

</Steps>

:::caution
Deleting a tag will remove it from all machines that currently have this tag assigned. This action cannot be undone.
:::
19 changes: 12 additions & 7 deletions src/content/docs/basic/configuration/04-package-repository.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,20 @@ description: Configure package repositories for OtterScale.

import { Steps } from '@astrojs/starlight/components';

This page allows you to manage the package repositories used by the machines in the OtterScale cluster. These repositories are the sources from which software packages and updates are downloaded (e.g., the Ubuntu archive).
Package repositories contain software packages that can be installed on machines. These repositories can be configured with custom URLs and enabled/disabled as needed to control software sources and updates for your infrastructure.

## Introduction

The Package Repository settings page displays a list of configured repositories. The table includes the following information:
The Package Repository settings page displays a list of configured repositories in a table format. By default, OtterScale includes standard Ubuntu repositories such as:

- **Name**: The name of the repository (e.g., `Ubuntu archive`).
- **URL**: The base URL of the repository.
- **Enabled**: Indicates whether the repository is currently active and being used.
- **Ubuntu extra architectures**: Provides packages for additional CPU architectures
- **Ubuntu archive**: The main Ubuntu package repository

### Table Columns

- **NAME**: The display name of the repository (e.g., `Ubuntu extra architectures`, `Ubuntu archive`).
- **URL**: The base URL of the repository (e.g., `http://ports.ubuntu.com/ubuntu-ports`, `http://tw.archive.ubuntu.com/ubuntu`).
- **ENABLED**: A toggle indicator showing whether the repository is currently active.

## Manage Package Repositories

Expand All @@ -27,12 +32,12 @@ To change the URL of a package repository:

1. Locate the repository you want to modify in the list.

2. Click the **Edit** button (pencil icon) in the actions column.
2. Click the **Edit** button (displayed with a pencil icon) on the right side of the row.

3. A modal window titled "Edit Package Repository" will appear.

4. **URL**: Enter the new URL for the repository.

5. Click **Confirm** to save your changes.

</Steps>
</Steps>
32 changes: 0 additions & 32 deletions src/content/docs/basic/configuration/05-helm-repository.mdx

This file was deleted.

Loading