From 8dd2965c3d90cd99713ace1a2623a4986efa3e30 Mon Sep 17 00:00:00 2001 From: Shawn Tsai Date: Fri, 5 Dec 2025 16:06:45 +0800 Subject: [PATCH 1/3] doc: update configuration page --- .../basic/configuration/01-ntp-server.mdx | 15 ++++++--- .../basic/configuration/03-machine-tag.mdx | 20 +++++++++--- .../configuration/04-package-repository.mdx | 29 +++++++++++++---- .../configuration/05-helm-repository.mdx | 32 ------------------- 4 files changed, 49 insertions(+), 47 deletions(-) delete mode 100644 src/content/docs/basic/configuration/05-helm-repository.mdx diff --git a/src/content/docs/basic/configuration/01-ntp-server.mdx b/src/content/docs/basic/configuration/01-ntp-server.mdx index 43c8f78..c79f3ec 100644 --- a/src/content/docs/basic/configuration/01-ntp-server.mdx +++ b/src/content/docs/basic/configuration/01-ntp-server.mdx @@ -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. +- **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? @@ -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. diff --git a/src/content/docs/basic/configuration/03-machine-tag.mdx b/src/content/docs/basic/configuration/03-machine-tag.mdx index 72826a4..8df9d17 100644 --- a/src/content/docs/basic/configuration/03-machine-tag.mdx +++ b/src/content/docs/basic/configuration/03-machine-tag.mdx @@ -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 @@ -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. + +:::caution +Deleting a tag will remove it from all machines that currently have this tag assigned. This action cannot be undone. +::: diff --git a/src/content/docs/basic/configuration/04-package-repository.mdx b/src/content/docs/basic/configuration/04-package-repository.mdx index e10bbc5..1733e99 100644 --- a/src/content/docs/basic/configuration/04-package-repository.mdx +++ b/src/content/docs/basic/configuration/04-package-repository.mdx @@ -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 @@ -27,7 +32,7 @@ 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** link (displayed with a pencil icon) on the right side of the row. 3. A modal window titled "Edit Package Repository" will appear. @@ -36,3 +41,15 @@ To change the URL of a package repository: 5. Click **Confirm** to save your changes. + +### Enable or Disable a Repository + +To toggle a repository's active status: + +1. Locate the repository in the list. +2. Click on the circle icon in the **ENABLED** column to toggle between enabled (filled circle) and disabled (empty circle). +3. The change takes effect immediately. + +:::note +Disabling a repository will prevent machines from using it as a package source. Ensure that critical repositories remain enabled to avoid issues with package installation and updates. +::: diff --git a/src/content/docs/basic/configuration/05-helm-repository.mdx b/src/content/docs/basic/configuration/05-helm-repository.mdx deleted file mode 100644 index 2e7f67d..0000000 --- a/src/content/docs/basic/configuration/05-helm-repository.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Helm Repository -description: Configure helm repository for OtterScale. ---- - -import { Steps } from '@astrojs/starlight/components'; - -This page allows you to configure the Helm repositories used by the OtterScale system. Helm repositories are collections of charts that describe how to install and manage Kubernetes applications. - -## Introduction - -The Helm Repository settings page displays the currently configured Helm repository URLs. Each repository is represented by a package icon. - -## Edit Helm Repositories - -To manage the list of Helm repositories, follow these steps: - - - -1. Click the **Edit** button (pencil icon) located at the top right of the configuration section. - -2. A modal window titled "Edit Helm Repository" will appear. - -3. In the **URL** field, you can manage the list of repository URLs: - - - **Add a repository:** Type the Helm repository URL (e.g., `https://charts.bitnami.com/bitnami`) in the input field and click the **Add** button (or press Enter). - - **Remove a repository:** Click the remove icon next to an existing URL to delete it. - - **Clear all:** Use the **Clear** button to remove all entries. - -4. Click **Confirm** to save your changes. The system will update the configuration and the new list will be displayed. - - From 4ec1238ac5021e7c0883366d05958b431d409521 Mon Sep 17 00:00:00 2001 From: Shawn Tsai Date: Fri, 5 Dec 2025 16:11:00 +0800 Subject: [PATCH 2/3] doc: update repository page --- .../configuration/04-package-repository.mdx | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/src/content/docs/basic/configuration/04-package-repository.mdx b/src/content/docs/basic/configuration/04-package-repository.mdx index 1733e99..cb472ab 100644 --- a/src/content/docs/basic/configuration/04-package-repository.mdx +++ b/src/content/docs/basic/configuration/04-package-repository.mdx @@ -32,7 +32,7 @@ To change the URL of a package repository: 1. Locate the repository you want to modify in the list. -2. Click the **Edit** link (displayed with a pencil icon) on the right side of the row. +2. Click the **Edit** butto (displayed with a pencil icon) on the right side of the row. 3. A modal window titled "Edit Package Repository" will appear. @@ -40,16 +40,4 @@ To change the URL of a package repository: 5. Click **Confirm** to save your changes. - - -### Enable or Disable a Repository - -To toggle a repository's active status: - -1. Locate the repository in the list. -2. Click on the circle icon in the **ENABLED** column to toggle between enabled (filled circle) and disabled (empty circle). -3. The change takes effect immediately. - -:::note -Disabling a repository will prevent machines from using it as a package source. Ensure that critical repositories remain enabled to avoid issues with package installation and updates. -::: + \ No newline at end of file From 4e0cc8e43a67cffdb01de6169589b4a7c7c93a99 Mon Sep 17 00:00:00 2001 From: Shawn Tsai Date: Fri, 5 Dec 2025 16:13:00 +0800 Subject: [PATCH 3/3] doc: wrong spell --- src/content/docs/basic/configuration/04-package-repository.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/basic/configuration/04-package-repository.mdx b/src/content/docs/basic/configuration/04-package-repository.mdx index cb472ab..43e2c47 100644 --- a/src/content/docs/basic/configuration/04-package-repository.mdx +++ b/src/content/docs/basic/configuration/04-package-repository.mdx @@ -32,7 +32,7 @@ To change the URL of a package repository: 1. Locate the repository you want to modify in the list. -2. Click the **Edit** butto (displayed with a pencil icon) on the right side of the row. +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.