diff --git a/astro.config.mjs b/astro.config.mjs index d76ec07..e6219b0 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -97,6 +97,13 @@ export default defineConfig({ }, slug: 'service/models' }, + { + label: 'Repositories', + translations: { + 'zh-Hant': 'ε„²ε­˜εΊ«' + }, + slug: 'service/repositories' + }, { label: 'Applications', translations: { diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 4ab62a3..39872f6 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -2,6 +2,9 @@ title: A unified platform for simplified compute, storage, and networking. description: Get started building your docs site with Starlight. template: splash # Remove or comment out this line to display the site sidebar on this page. +banner: + content: | + πŸš€ OtterScale has shipped! β€” See what's new in OtterScale 0.6.0 hero: title: | OtterScale: diff --git a/src/content/docs/introduction.mdx b/src/content/docs/introduction.mdx index d8b0c33..f46d94b 100644 --- a/src/content/docs/introduction.mdx +++ b/src/content/docs/introduction.mdx @@ -56,7 +56,7 @@ The platform utilizes Ceph to provide a robust, self-healing storage fabric. Sto Integrated Prometheus and Grafana stack - + RBAC with LDAP/AD integration and SSO diff --git a/src/content/docs/service/applications/04-store.mdx b/src/content/docs/service/applications/04-store.mdx index 17a591c..588f1d0 100644 --- a/src/content/docs/service/applications/04-store.mdx +++ b/src/content/docs/service/applications/04-store.mdx @@ -57,12 +57,29 @@ To deploy a new application: 1. Click on the application card to open the details panel. 2. Click the **Install** button. 3. **Configuration**: + - **Name**: Enter a name for the release. - **Namespace**: Specify the target namespace. - **Version**: Select the chart version to install. - **Dry Run**: Toggle to simulate the installation without making changes. - - **Configuration**: Customize the `values.yaml` configuration for the chart. -4. Click **Confirm** to start the installation. + - **Configuration**: Customize the `values.yaml` configuration for the chart. You can modify the parameters to override the chart's defaults, such as replica counts, resource limits, or service settings. The editor supports YAML syntax highlighting and validation. + + ```yaml + # Example Configuration + replicaCount: 1 + image: + repository: nginx + tag: stable + service: + type: ClusterIP + port: 80 + resources: + limits: + cpu: 100m + memory: 128Mi + ``` + +4. Click **Confirm** to start the installation. Once installed, the application will appear in the **Releases** tab. diff --git a/src/content/docs/service/repositories.mdx b/src/content/docs/service/repositories.mdx new file mode 100644 index 0000000..b1409b5 --- /dev/null +++ b/src/content/docs/service/repositories.mdx @@ -0,0 +1,132 @@ +--- +title: Repositories +description: Manage container images and Helm charts in the registry. +--- + +import { Steps, Aside, Tabs, TabItem } from '@astrojs/starlight/components'; + +The Repositories page allows you to view and manage the container images and Helm charts stored in your private registry. + +## Introduction + +The Repositories table displays a list of all repositories. The table includes the following information: + +| Column | Description | +| :------------- | :----------------------------------------------------------------------------------------------------------------------------- | +| **Name** | The name of the repository. | +| **Latest Tag** | The most recent tag associated with the repository. | +| **Size** | The total size of the repository. | +| **Manifests** | The number of manifests (versions/tags) in the repository. Clicking the external link icon opens a detailed list of manifests. | + +## Upload Instructions + +You can upload Docker images and Helm charts to the repository via your local terminal. + + + + + + + + + + 1. Tag the image: + + ```bash + docker tag : /: + ``` + + 2. Push the image: + + ```bash + docker push /: + ``` + + 3. After uploading, navigate to the [Applications Store](/service/applications/04-store/) to update the Helm chart configuration to use your custom image: + + ```yaml + # Docker image + image: + # -- Docker image registry + repository: / + # -- Docker pull policy + pullPolicy: IfNotPresent + # -- Docker image tag, overrides the image tag whose default is the chart appVersion. + tag: + ``` + + + + + + + + + 1. Download a chart package from [Artifact Hub](https://artifacthub.io/). + + 2. Upload the downloaded chart: + + ```bash + helm push oci:/// --plain-http + ``` + + 3. After uploading, navigate to the [Applications Store](/service/applications/04-store/) to deploy the Helm chart. + + + + + + +## Manage Repositories + + + +### View Manifests + +To view the specific versions or tags within a repository: + + + +1. Locate the repository in the list. +2. Click the external link icon in the **Manifests** column. +3. A side panel will open displaying all manifests (tags) for that repository. + + + +### View Manifest Details + +You can inspect the details of a specific image or chart version. + + + +1. Open the **Manifests** list for a repository. +2. Click on any manifest item. +3. A dialog will appear showing detailed information: + - **Charts**: Displays version, description, dependencies, maintainers, and source links. + - **Images**: Displays author, creation time, architecture, and container configuration (ports, entrypoint, commands, etc.). + + + +### Delete Manifest + +You can delete specific versions (manifests) from a repository. + + + +1. Open the **Manifests** list for a repository. +2. Locate the specific tag/version you want to remove. +3. Click the **Delete** button (trash icon). +4. Confirm the deletion to permanently remove the manifest. + +