-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Add v0.6 documentation content and update documentation build c… #71
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,9 @@ | ||
| import { defineCollection } from 'astro:content'; | ||
| import { docsLoader } from '@astrojs/starlight/loaders'; | ||
| import { docsSchema } from '@astrojs/starlight/schema'; | ||
| import { docsVersionsLoader } from 'starlight-versions/loader'; | ||
|
|
||
| export const collections = { | ||
| docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }) | ||
| docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), | ||
| versions: defineCollection({ loader: docsVersionsLoader() }) | ||
| }; |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,47 @@ | ||||||
| --- | ||||||
| title: NTP Server | ||||||
| description: Configure NTP server for OtterScale. | ||||||
| slug: v0.6/basicconfiguration/01-ntp-server | ||||||
|
||||||
| slug: v0.6/basicconfiguration/01-ntp-server | |
| slug: v0.6/basic/configuration/01-ntp-server |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| title: Boot Image | ||
| description: Configure boot image for OtterScale. | ||
| slug: v0.6/basicconfiguration/02-boot-image | ||
| --- | ||
|
|
||
| import { Steps } from '@astrojs/starlight/components'; | ||
|
|
||
| This page allows you to manage the operating system images (Boot Images) available for provisioning machines in the OtterScale cluster. These images are typically Ubuntu LTS releases. | ||
|
|
||
| ## Introduction | ||
|
|
||
| The Boot Image settings page displays a list of configured boot images. The table includes the following information: | ||
|
|
||
| * **Name**: The display name of the operating system (e.g., Ubuntu 22.04 LTS). | ||
| * **Source**: The URL of the image repository. | ||
| * **Distro Series**: The codename of the distribution release (e.g., `jammy`, `noble`). | ||
| * **Default**: Indicates if this is the default image used when no specific image is requested. | ||
| * **Architecture**: The CPU architectures supported by this image (e.g., `amd64`, `arm64`). | ||
| * **Status**: Shows the sync status of the image architectures. | ||
|
|
||
| ## Manage Boot Images | ||
|
|
||
| You can perform the following actions to manage boot images: | ||
|
|
||
| ### Create a New Boot Image | ||
|
|
||
| To add a new boot image configuration: | ||
|
|
||
| <Steps> | ||
| 1. Click the **Create** button (plus icon) at the top of the page. | ||
|
|
||
| 2. A modal window titled "Create Boot Image" will appear. | ||
|
|
||
| 3. **Select Distro Series**: Choose the desired Ubuntu release from the dropdown menu. | ||
|
|
||
| 4. **Select Architecture**: Choose one or more CPU architectures to support for this release. | ||
|
|
||
| 5. Click **Confirm** to save. The system will begin tracking this image configuration. | ||
| </Steps> | ||
|
|
||
| ### Import Images | ||
|
|
||
| To synchronize the local image cache with the upstream source: | ||
|
|
||
| 1. Click the **Import** button (refresh icon). | ||
| 2. The system will trigger a background process to download and update the images. The button will show an "Importing..." state with a spinner while the process is running. | ||
|
|
||
| ### Set Default Image | ||
|
|
||
| The image marked with a circle icon in the **Default** column is the current default. To change the default image, use the actions menu (three dots) on the desired image row and select **Set Default**. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: Machine Tag | ||
| description: Configure machine tags for OtterScale. | ||
| slug: v0.6/basicconfiguration/03-machine-tag | ||
| --- | ||
|
|
||
| import { Steps } from '@astrojs/starlight/components'; | ||
|
|
||
| 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 in a table format. Tags are identifiable labels that can be assigned to machines for various purposes such as: | ||
|
|
||
| * **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 | ||
|
|
||
| You can create new tags or delete existing ones. | ||
|
|
||
| ### Create a New Tag | ||
|
|
||
| To create a custom tag: | ||
|
|
||
| <Steps> | ||
| 1. Click the **Create** button (plus icon) at the top of the page. | ||
|
|
||
| 2. A modal window titled "Create Machine Tag" will appear. | ||
|
|
||
| 3. **Name**: Enter a unique name for the tag. | ||
|
|
||
| 4. **Comment**: (Optional) Enter a description for the tag. | ||
|
|
||
| 5. Click **Confirm** to save. The new tag will appear in the list. | ||
| </Steps> | ||
|
|
||
| ### Delete a Tag | ||
|
|
||
| To remove a tag: | ||
|
|
||
| <Steps> | ||
| 1. Locate the tag you want to remove in the list. | ||
|
|
||
| 2. Click the **Delete** button (trash icon) in the actions column. | ||
|
|
||
| * **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. | ||
| ::: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: Package Repository | ||
| description: Configure package repositories for OtterScale. | ||
| slug: v0.6/basicconfiguration/04-package-repository | ||
| --- | ||
|
|
||
| import { Steps } from '@astrojs/starlight/components'; | ||
|
|
||
| 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 in a table format. By default, OtterScale includes standard Ubuntu repositories such as: | ||
|
|
||
| * **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 | ||
|
|
||
| You can modify the URL of existing package repositories. This is useful if you want to point to a local mirror or a different upstream source to improve download speeds or manage bandwidth. | ||
|
|
||
| ### Edit Repository URL | ||
|
|
||
| To change the URL of a package repository: | ||
|
|
||
| <Steps> | ||
| 1. Locate the repository you want to modify in the list. | ||
|
|
||
| 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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The slug
v0.6/basicconfiguration/01-ntp-serveris inconsistent with the directory structurebasic/configuration. This could make URLs less intuitive and harder to maintain. For consistency, consider using a slug that mirrors the directory path. This pattern is repeated in other new documentation files within this PR.