diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index e73ce250..22c40005 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -391,7 +391,7 @@ const side = { collapsed: true, items: [ { text: "gpu", link: "/developer/install/cli/gpu" }, - { text: "info", link: "/developer/install/cli/info" }, + { text: "osinfo", link: "/developer/install/cli/osinfo" }, { text: "node", link: "/developer/install/cli/node" }, { text: "olares backups", diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index e140f423..40b82bd2 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,5 +1,6 @@ // docs/.vitepress/theme/index.ts import DefaultTheme from "vitepress/theme"; +import "./styles/custom.css"; import "./styles/index.css"; import { inBrowser, useRoute, useRouter, useData } from "vitepress"; import Layout from "./components/Layout.vue"; diff --git a/docs/.vitepress/theme/styles/custom.css b/docs/.vitepress/theme/styles/custom.css new file mode 100644 index 00000000..4e35d17a --- /dev/null +++ b/docs/.vitepress/theme/styles/custom.css @@ -0,0 +1,8 @@ +/* 只影响文档正文里的表格 */ +.vp-doc table td:nth-child(2), +.vp-doc table th:nth-child(2) { + white-space: nowrap; /* 第二列不换行 */ +} + +/* 若想让整张表放宽布局，顺便改一下 ↓ */ +/* .vp-doc table { table-layout: auto; } */ diff --git a/docs/.vitepress/zh.ts b/docs/.vitepress/zh.ts index 9613d749..80c35869 100644 --- a/docs/.vitepress/zh.ts +++ b/docs/.vitepress/zh.ts @@ -395,7 +395,7 @@ const side = { collapsed: true, items: [ { text: "gpu", link: "/zh/developer/install/cli/gpu" }, - { text: "info", link: "/zh/developer/install/cli/info" }, + { text: "osinfo", link: "/zh/developer/install/cli/osinfo" }, { text: "node", link: "/zh/developer/install/cli/node" }, { text: "olares backups", @@ -436,7 +436,7 @@ const side = { }, { text: "olares release", - link: "/zhdeveloper/install/cli/olares-release", + link: "/zh/developer/install/cli/olares-release", }, { text: "olares start", diff --git a/docs/developer/contribute/olares.md b/docs/developer/contribute/olares.md index 96e174a8..0fea0986 100644 --- a/docs/developer/contribute/olares.md +++ b/docs/developer/contribute/olares.md @@ -88,5 +88,5 @@ make install VERSION=0.0.0-DEBUG ## How to uninstall ```bash -bash olares-uninstall.sh +bash olares-cli uninstall --all ``` diff --git a/docs/developer/install/cli/backup.md b/docs/developer/install/cli/backup.md index 5151474b..ab4e56ab 100644 --- a/docs/developer/install/cli/backup.md +++ b/docs/developer/install/cli/backup.md @@ -3,60 +3,60 @@ outline: [2, 3] --- # `olares backups backup` :::warning -The `olares-cli olares backups download` command must be run first to install Restic. Otherwise, this command will return an error. +The `olares-cli backups download` command must be run first to install Restic. Otherwise, this command will return an error. ::: ## Synopsis The `backup` subcommand allows you to back up data to the specified storage backend. It ensures your data is securely stored and can be restored whenever needed. ```bash -olares-cli olares backups backup --path --repo-name [options] +olares-cli backups backup --path --repo-name [options] ``` ## Common options These options apply to all backends: -| Name | Shorthand | Usage | -|---------------|-----------|----------------------------------------------| -| `--help` | `-h` | Displays help information. | -| `--path` | | Specifies the directory to back up. | -| `--repo-name` | | Specifies the name of the backup repository. | +| Option | Shorthand | Usage | Required | Default | +|---------------|-----------|----------------------------------------------|-------------------------|---------| +| `--help` | `-h` | Displays help information. | No | N/A | +| `--path` | | Specifies the directory to back up. | No | N/A | +| `--repo-name` | | Specifies the name of the backup repository. | No | N/A | ## Backend-specific options ### Options for `cos` -| Name | Shorthand | Usage | -|-----------------------|-----------|--------------------------------------------------------------------------------------------------| -| `--access-key` | | Specifies the Access Key for Tencent COS. | -| `--endpoint` | | Specifies the Tencent COS endpoint, e.g., `https://cos.{region}.myqcloud.com/{bucket}/{prefix}`. | -| `--limit-upload-rate` | | Limits the upload speed to a maximum rate in KiB/s (default: unlimited). | -| `--secret-access-key` | | Specifies the Secret Access Key for Tencent COS. | +| Option | Shorthand | Usage | Required | Default | +|-----------------------|-----------|--------------------------------------------------------------------------------------------------|-------------------------|------------| +| `--access-key` | | Specifies the Access Key for Tencent COS. | No | N/A | +| `--endpoint` | | Specifies the Tencent COS endpoint, e.g., `https://cos.{region}.myqcloud.com/{bucket}/{prefix}`. | No | N/A | +| `--limit-upload-rate` | | Limits the upload speed to a maximum rate in KiB/s. | No | unlimited | +| `--secret-access-key` | | Specifies the Secret Access Key for Tencent COS. | No | N/A | | ### Options for `fs` -| Name | Shorthand | Usage | -|--------------|-----------|----------------------------------------------------------------| -| `--endpoint` | | Specifies the local directory where the backup will be stored. | +| Option | Shorthand | Usage | Required | Default | +|------------|-----------|----------------------------------------------------------------|-------------------------|---------| +| `--endpoint` | | Specifies the local directory where the backup will be stored. | No | N/A | ### Options for `s3` -| Name | Shorthand | Usage | -|-----------------------|-----------|---------------------------------------------------------------------------------------------| -| `--access-key` | | Specifies the Access Key for Amazon S3. | -| `--endpoint` | | Specifies the Amazon S3 endpoint, e.g., `https://{bucket}.{region}.amazonaws.com/{prefix}`. | -| `--limit-upload-rate` | | Limits the upload speed to a maximum rate in KiB/s (default: unlimited). | -| `--secret-access-key` | | Specifies the Secret Access Key for Amazon S3. | +| Option | Shorthand | Usage | Required | Default | +|-----------------------|-----------|---------------------------------------------------------------------------------------------|-------------------------|------------| +| `--access-key` | | Specifies the Access Key for Amazon S3. | No | N/A | +| `--endpoint` | | Specifies the Amazon S3 endpoint, e.g., `https://{bucket}.{region}.amazonaws.com/{prefix}`. | No | N/A | +| `--limit-upload-rate` | | Limits the upload speed to a maximum rate in KiB/s. | No | unlimited | +| `--secret-access-key` | | Specifies the Secret Access Key for Amazon S3. | No | N/A | | ### Options for `space` -| Name | Shorthand | Usage | -|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------| -| `--access-token` 1 | | Specifies the access token for Olares Space. | -| `--cloud-api-mirror` | | Specifies the cloud API mirror. | -| `--cloud-name` | | Specifies the cloud name of the Olares Space instance.
The cloud name can be retrieved using the [`region`](region.md) subcommand. | -| `--cluster-id` 2 | | Specifies the cluster ID where the backup will be stored. | -| `--limit-upload-rate` | | Limits the upload speed to a maximum rate in KiB/s (default: unlimited). | -| `--olares-did` 1 | | Specifies the Olares DID. | -| `--region-id` | | Specifies the region ID of the Olares Space instance.
The region ID can be retrieved using the [`region`](region.md) subcommand. | +| Option | Shorthand | Usage | Required | Default | +|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|------------| +| `--access-token` 1 | | Specifies the access token for Olares Space. | No | N/A | +| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A | +| `--cloud-name` | | Specifies the cloud name of the Olares Space instance.
The cloud name can be retrieved using the [`region`](region.md) subcommand. | No | N/A | +| `--cluster-id` 2 | | Specifies the cluster ID where the backup will be stored. | No | N/A | +| `--limit-upload-rate` | | Limits the upload speed to a maximum rate in KiB/s. | No | unlimited | +| `--olares-did` 1 | | Specifies the Olares DID. | No | N/A | +| `--region-id` | | Specifies the region ID of the Olares Space instance.
The region ID can be retrieved using the [`region`](region.md) subcommand. | No | N/A | 1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID. @@ -68,13 +68,13 @@ These options apply to all backends: ## Example ```bash # Backup to Tencent COS -olares-cli olares backups backup cos --path /data --repo-name my_repo \ +olares-cli backups backup cos --path /data --repo-name my_repo \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://cos.region.myqcloud.com/bucket/prefix # Backup to Olares Space -olares-cli olares backups backup space --path /data --repo-name my_repo \ +olares-cli backups backup space --path /data --repo-name my_repo \ --access-token YOUR_ACCESS_TOKEN \ --cloud-api-mirror https://api-mirror.example.com \ --cloud-name my_cloud \ diff --git a/docs/developer/install/cli/download.md b/docs/developer/install/cli/download.md index e1bdc12d..8105955a 100644 --- a/docs/developer/install/cli/download.md +++ b/docs/developer/install/cli/download.md @@ -4,17 +4,16 @@ The `download` subcommand downloads the Restic dependency tool. Restic is required for performing backup and restore operations, as well as managing snapshots. ```bash -olares-cli olares backups download [options] +olares-cli backups download [options] ``` ## Options -| Name | Shorthand | Usage | -|----------------------|-----------|--------------------------------------------------------| -| `--download-cdn-url` | | Specifies the CDN URL for downloading the Restic tool. | -| `--help` | `-h` | Displays help information. | - +| Option | Shorthand | Usage | Required | Default | +|--------------------|-----------|--------------------------------------------------------|-------------------------|--------------------| +| `--download-cdn-url`| | Specifies the CDN URL for downloading the Restic tool. | No | System default URL | +| `--help` | `-h` | Displays help information. | No | N/A | ## Example -```bash +```bash d # Download Restic using a custom CDN URL -olares-cli olares backups download --download-cdn-url https://custom-cdn.example.com/restic +olares-cli backups download --download-cdn-url https://custom-cdn.example.com/restic ``` \ No newline at end of file diff --git a/docs/developer/install/cli/gpu.md b/docs/developer/install/cli/gpu.md index 6c139f52..245a2fc5 100644 --- a/docs/developer/install/cli/gpu.md +++ b/docs/developer/install/cli/gpu.md @@ -17,7 +17,7 @@ olares-cli gpu [options] | Subcommand | Description | |-------------|--------------------------------------------------------------------------------------------------------------------------------------------| -| `install` | Installs GPU drivers and dependencies. Requires specifying the installation directory (`--base-dir`) and the Olares version (`--version`). | +| `install` | Installs GPU drivers and dependencies. | | `enable` | Enables GPU functionality to support GPU-based applications. | | `disable` | Disables GPU functionality, stopping support for GPU-based applications. | | `uninstall` | Uninstalls GPU drivers and related components. | @@ -26,11 +26,11 @@ olares-cli gpu [options] ## Options -| Name | Short | Description | -|--------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Specifies the base installation directory for the GPU components. Typically, this is Olares' default installation directory `$HOME/.olares`. | -| `--version` | `-v` | Specifies the Olares version for GPU drivers and components.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | -| `--help` | `-h` | Displays help information. | +| Option | Shorthand | Usage | Required | Default | +|------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------| +| `--base-dir`| `-b` | Specifies the base installation directory for the GPU components. | No | `$HOME/.olares` | +| `--version`| `-v` | Specifies the Olares version for GPU drivers and components.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version | +| `--help` | `-h` | Displays help information. | No | N/A | ## Example diff --git a/docs/developer/install/cli/node.md b/docs/developer/install/cli/node.md index 097bc9e5..45ca3f63 100644 --- a/docs/developer/install/cli/node.md +++ b/docs/developer/install/cli/node.md @@ -17,17 +17,17 @@ olares-cli node [options] ## Options -| Name | Short | Description | -|---------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--master-host` | | Defines the IP address of the master node.
This option is required. | -| `--master-node-name` | | Specifies the Kubernetes node name of the master node. | -| `--master-ssh-user` | | Sets the remote Linux user name for SSH login to the master node.
Defaults to root. | -| `--master-ssh-password` | | Provides the password for the Linux user.
Required if a non-root `master-ssh-user` is specified. | -| `--master-ssh-private-key-path` | | Specifies the path to the private SSH key for authenticating as the Linux user.
Defaults to `/root/.ssh/id_rsa`. | -| `--master-ssh-port` | | Sets the SSH service's listening port on the master node.
Defaults to `22`. | -| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | -| `--help` | `-h` | Displays help information. | +| Option | Shorthand | Usage | Required | Default | +|---------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------| +| `--base-dir` | `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--master-host` | | Defines the IP address of the master node. | Yes | N/A | +| `--master-node-name` | | Specifies the Kubernetes node name of the master node. | No | N/A | +| `--master-ssh-user` | | Sets the remote Linux user name for SSH login to the master node. | No | `root` | +| `--master-ssh-password` | | Provides the password for the Linux user. | Yes if a non-root `master-ssh-user` is specified. | N/A | +| `--master-ssh-private-key-path` | | Specifies the path to the private SSH key for authenticating as the Linux user. | No | `/root/.ssh/id_rsa` | +| `--master-ssh-port` | | Sets the SSH service's listening port on the master node. | No | `22` | +| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version | +| `--help` | `-h` | Displays help information. | No | N/A | | ## Example diff --git a/docs/developer/install/cli/olares-change-ip.md b/docs/developer/install/cli/olares-change-ip.md index b93a9a77..6ffaad8c 100644 --- a/docs/developer/install/cli/olares-change-ip.md +++ b/docs/developer/install/cli/olares-change-ip.md @@ -7,28 +7,28 @@ When Olares is deployed _inside_ a virtualized environment, such as macOS (via M Change the local IP address for all Olares components. ```bash -olares-cli olares change-ip [option] +olares-cli change-ip [option] ``` ## Options -| Name | Shorthand | Usage | -|---------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--distribution` | `-d` | Sets the WSL distribution name. Only applicable on Windows.
Defaults to `Ubuntu`. | -| `--help` | `-h` | Displays help information. | -| `--new-master-host` | | Specifies the new IP address of the master node on the worker node.
Only applicable for a multi-node Olares cluster. | -| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS.
Defaults to `olares-0`. | -| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | +| Option | Shorthand | Usage | Required | Default | +|---------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------| +| `--base-dir` | `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--distribution` | `-d` | Sets the WSL distribution name. Only applicable on Windows. | No | `Ubuntu` | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--new-master-host` | | Specifies the new IP address of the master node on the worker node.
Only applicable for a multi-node Olares cluster. | No | N/A | +| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. | No | `olares-0` | +| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version | ## Examples - For macOS: ```bash # Specify the Minikube profile name and change the IP. -olares-cli olares change-ip --profile olares-0 +olares-cli change-ip --profile olares-0 ``` - For Windows WSL: ```bash # Specify the Linux distribution in WSL and change the IP. -olares-cli olares change-ip --distribution Ubuntu +olares-cli change-ip --distribution Ubuntu ``` \ No newline at end of file diff --git a/docs/developer/install/cli/olares-cli.md b/docs/developer/install/cli/olares-cli.md index 7fadacbb..e9fc2493 100644 --- a/docs/developer/install/cli/olares-cli.md +++ b/docs/developer/install/cli/olares-cli.md @@ -33,7 +33,7 @@ where Olares CLI allows you to temporarily override certain Olares default settings. Each option applies only to the command in which it is used. -For example, if you use the `--base-dir` option with `olares-cli olares download wizard`, it will only affect the wizard downloading process and will not change the base directory for other commands, such as during the "install" phase. +For example, if you use the `--base-dir` option with `olares-cli download wizard`, it will only affect the wizard downloading process and will not change the base directory for other commands, such as during the "install" phase. To get detailed help for any command, run `olares-cli help`. @@ -42,18 +42,18 @@ To get detailed help for any command, run `olares-cli help`. | Operation | Syntax | Description | |--------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| | `gpu` | `olares-cli gpu [option]` | Manages GPU-related operations. | -| `info` | `olares-cli olares info [option]` | Displays general information about the operating system of the current device. | +| `info` | `olares-cli info [option]` | Displays general information about the operating system of the current device. | | `node` | `olares-cli node [option]` | Manages node-related operations. | -| `olares backups` | `olares-cli olares backups [option]` | Manages backup-related operations. | -| `olares change-ip` | `olares-cli olares change-ip [option]` | Changes the IP address of the Olares OS. | -| `olares download` | `olares-cli olares download [option]` | Downloads specific resources. | -| `olares info` | `olares-cli olares info [option]` | Displays general information about the downloaded Olares OS. | -| `olares install` | `olares-cli olares install [option]` | Deploys system-level and user-level components of Olares. | -| `olares logs` | `olares-cli olares logs [option]` | Collects logs from Olares system components for debugging and troubleshooting. | -| `olares precheck` | `olares-cli olares precheck [option]` | Verifies whether the system environment meets all requirements for Olares installation. | -| `olares prepare` | `olares-cli olares prepare [option]` | Prepares the environment for the installation process, including setting up essential services and configurations of Olares. | -| `olares release` | `olares-cli olares release [option]` | Packages Olares installation resources for distribution or deployment. | -| `olares start` | `olares-cli olares start [option]` | Starts Olares services and components. | -| `olares stop` | `olares-cli olares stop [option]` | Stops Olares services and components. | -| `olares uninstall` | `olares-cli olares uninstall [option]` | Uninstalls Olares completely, or roll back the installation to a specific phase. | +| `olares backups` | `olares-cli backups [option]` | Manages backup-related operations. | +| `olares change-ip` | `olares-cli change-ip [option]` | Changes the IP address of the Olares OS. | +| `olares download` | `olares-cli download [option]` | Downloads specific resources. | +| `olares info` | `olares-cli info [option]` | Displays general information about the downloaded Olares OS. | +| `olares install` | `olares-cli install [option]` | Deploys system-level and user-level components of Olares. | +| `olares logs` | `olares-cli logs [option]` | Collects logs from Olares system components for debugging and troubleshooting. | +| `olares precheck` | `olares-cli precheck [option]` | Verifies whether the system environment meets all requirements for Olares installation. | +| `olares prepare` | `olares-cli prepare [option]` | Prepares the environment for the installation process, including setting up essential services and configurations of Olares. | +| `olares release` | `olares-cli release [option]` | Packages Olares installation resources for distribution or deployment. | +| `olares start` | `olares-cli start [option]` | Starts Olares services and components. | +| `olares stop` | `olares-cli stop [option]` | Stops Olares services and components. | +| `olares uninstall` | `olares-cli uninstall [option]` | Uninstalls Olares completely, or roll back the installation to a specific phase. | diff --git a/docs/developer/install/cli/olares-download.md b/docs/developer/install/cli/olares-download.md index 67077a36..d1928d72 100644 --- a/docs/developer/install/cli/olares-download.md +++ b/docs/developer/install/cli/olares-download.md @@ -4,43 +4,43 @@ The `olares download` command downloads the necessary packages and components required to install Olares on your local machine. It supports downloading components, checking the status of installation packages, and fetching the manifest file. ```bash -olares-cli olares download [option] +olares-cli download [option] ``` ## Subcommands | Name | Shorthand | Usage | Example | |-------------|-----------|-------------------------------------------------------|----------------------------------------| -| `check` | | Checks the status of the Olares installation package. | `olares-cli olares download check` | -| `component` | `c` | Downloads Olares components. | `olares-cli olares download component` | -| `wizard` | `w` | Downloads the manifest file. | `olares-cli olares download wizard` | +| `check` | | Checks the status of the Olares installation package. | `olares-cli download check` | +| `component` | `c` | Downloads Olares components. | `olares-cli download component` | +| `wizard` | `w` | Downloads the manifest file. | `olares-cli download wizard` | ## Options -| Name | Shorthand | Usage | -|----------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--download-cdn-url` | | Sets the CDN accelerated download URL in the format `https://example.cdn.com`.
If not provided, the default URL will be used. | -| `--help` | `-h` | Displays help information. | -| `--kube` | | Specifies the Kubernetes type.
Supported types are `k3s` (default) and `k8s`. | -| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | +| Option | Shorthand | Usage | Required | Default | +|--------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------| +| `--base-dir` | `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--download-cdn-url`| | Sets the CDN accelerated download URL in the format `https://example.cdn.com`. | No | System default URL | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--kube` | | Specifies the Kubernetes type.
Supported types are `k3s` and `k8s`. | No | `k3s` | +| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`). Defaults to the current version.
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version | ## Examples ```bash # Specifies the base directory where all downloaded components will be stored. -olares-cli olares download component -b /custom/path +olares-cli download component -b /custom/path # Specifies a CDN-accelerated URL for downloading Olares components. -olares-cli olares download component --download-cdn-url https://my.cdn.com +olares-cli download component --download-cdn-url https://my.cdn.com # Specifies the Kubernetes type for the installation. -olares-cli olares download component --kube k8s +olares-cli download component --kube k8s # Sets the path to the package manifest file. -olares-cli olares download component --manifest /custom/path/manifest.json +olares-cli download component --manifest /custom/path/manifest.json # Specifies the version of Olares packages and components to download. -olares-cli olares download component -v 1.11.0 +olares-cli download component -v 1.11.0 ``` diff --git a/docs/developer/install/cli/olares-info.md b/docs/developer/install/cli/olares-info.md index 66229cf3..4f2cc3e7 100644 --- a/docs/developer/install/cli/olares-info.md +++ b/docs/developer/install/cli/olares-info.md @@ -4,7 +4,7 @@ The `olares info` command displays general information about the installed Olares version. ```bash -olares-cli olares info +olares-cli info ``` ## Flag diff --git a/docs/developer/install/cli/olares-install.md b/docs/developer/install/cli/olares-install.md index 89837a21..d3336a08 100644 --- a/docs/developer/install/cli/olares-install.md +++ b/docs/developer/install/cli/olares-install.md @@ -1,19 +1,18 @@ # `olares install` ## Synopsis -The `olares install` command installs Olares on your system. It supports various options to customize the installation process, such as specifying directories, Kubernetes types, or Minikube profiles. +The `olares install` command installs Olares on your system. It supports various options to customize the installation process, such as specifying directories, Kubernetes types, or Minikube profiles. ```bash -olares-cli olares install [option] +olares-cli install [option] ``` ## Options -| Name | Shorthand | Usage | -|--------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--help` | `-h` | Displays help information. | -| `--kube` | | Specifies the Kubernetes type.
Supported types are `k3s` (default) and `k8s`. | -| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS.
Defaults to `olares-0`. | -| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | - +| Option | Shorthand | Usage | Required | Default | +|------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|------------------------------------------| +| `--base-dir`| `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--kube` | | Specifies the Kubernetes type.
Supported types are `k3s` and `k8s`. | No | `k3s` | +| `--profile`| `-p` | Sets the Minikube profile name. Only applicable on macOS. | No | `olares-0` | +| `--version`| `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Version installed in the `prepare` phase | \ No newline at end of file diff --git a/docs/developer/install/cli/olares-logs.md b/docs/developer/install/cli/olares-logs.md index e0b8724a..e63af9b1 100644 --- a/docs/developer/install/cli/olares-logs.md +++ b/docs/developer/install/cli/olares-logs.md @@ -14,28 +14,28 @@ The `olares logs` command retrieves logs from Olares components and services fou * Kubernetes node info ```bash -olares-cli olares logs [option] +olares-cli logs [option] ``` ## Options -| Name | Shorthand | Usage | -|------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--components` | | Collects logs from specific components (comma-separated).
Supported values: `k3s`, `containerd`, `olaresd`, `kubelet`, `juicefs`, `redis`, `minio`, `etcd`, `NetworkManager`.
Defaults to collecting logs from all detectable components. | -| `--help` | `-h` | Displays help information. | -| `--ignore-kube-errors` | | Ignores errors from `kubectl` commands (e.g., when Kubernetes API is unreachable) and continues collecting logs.
Default: `false`. | -| `--max-lines` | | Limits the maximum number of lines for each component's logs to prevent large log files.
Defaults to `3000`. | -| `--output-dir` | | Saves logs to the specified directory. Creates the directory if it does not exist.
Defaults to `./olares-logs`. | -| `--since` | | Fetches logs newer than a specified relative duration (e.g., `5s`, `2m`, `3h`).
Defaults to `7d`. | +| Option | Shorthand | Usage | Required | Default | +|------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------| +| `--components` | | Collects logs from specific components (comma-separated).
Supported values: `k3s`, `containerd`, `olaresd`, `kubelet`, `juicefs`, `redis`, `minio`, `etcd`, `NetworkManager`. | No | All detectable components | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--ignore-kube-errors` | | Ignores errors from `kubectl` commands (e.g., when Kubernetes API is unreachable) and continues collecting logs. | No | `false` | +| `--max-lines` | | Limits the maximum number of lines for each component's logs to prevent large log files. | No | `3000` | +| `--output-dir` | | Saves logs to the specified directory. Creates the directory if it does not exist. | No | `./olares-logs` | +| `--since` | | Fetches logs newer than a specified relative duration (e.g., `5s`, `2m`, `3h`). | No | `7d` | ## Example ```bash # Collect all logs with default settings -olares-cli olares logs +olares-cli logs # Collect logs for specific components -olares-cli olares logs --components k3s,redis,minio +olares-cli logs --components k3s,redis,minio # Collect logs for the last 3 hours only -olares-cli olares logs --since 3h +olares-cli logs --since 3h ``` \ No newline at end of file diff --git a/docs/developer/install/cli/olares-precheck.md b/docs/developer/install/cli/olares-precheck.md index 1b6c41b7..49276045 100644 --- a/docs/developer/install/cli/olares-precheck.md +++ b/docs/developer/install/cli/olares-precheck.md @@ -4,13 +4,13 @@ The `olares precheck` command verifies whether the system environment satisfies all prerequisites required for Olares installation. ```bash -olares-cli olares precheck [option] +olares-cli precheck [option] ``` ## Options -| Name | Shorthand | Usage | -|----------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--help` | `-h` | Displays help information. | -| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | \ No newline at end of file +| Option | Shorthand | Usage | Required | Default | +|------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------| +| `--base-dir`| `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--version`| `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version | \ No newline at end of file diff --git a/docs/developer/install/cli/olares-prepare.md b/docs/developer/install/cli/olares-prepare.md index 3f893272..3c5e1335 100644 --- a/docs/developer/install/cli/olares-prepare.md +++ b/docs/developer/install/cli/olares-prepare.md @@ -3,23 +3,23 @@ ## Synopsis The `olares prepare` command sets up the environment required for Olares to function. This includes installing dependencies, importing container images, and starting the Olares daemon (`olaresd`). ```bash -olares-cli olares prepare [option] +olares-cli prepare [option] ``` ## Options +| Option | Shorthand | Usage | Required | Default | +|--------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------| +| `--base-dir` | `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--kube` | | Specifies the Kubernetes type.
Supported types are `k3s` and `k8s`. | No | `k3s` | +| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. | No | `olares-0` | +| `--registry-mirrors`| `-r` | Specifies Docker container registry mirrors.
Multiple mirrors should be separated by commas. | No | N/A | +| `--with-juicefs` | | Configures JuiceFS as the root filesystem (rootfs) for Olares workloads instead of the local disk. | No | N/A | +| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version | -| Name | Shorthand | Usage | -|----------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--help` | `-h` | Displays help information. | -| `--kube` | | Specifies the Kubernetes type.
Supported types are `k3s` (default) and `k8s`. | -| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS.
Defaults to `olares-0`. | -| `--registry-mirrors` | `-r` | Specifies Docker container registry mirrors.
Multiple mirrors should be separated by commas. | -| `--with-juicefs` | | Configures JuiceFS as the root filesystem (rootfs) for Olares workloads instead of the local disk. | -| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | ## Example ```bash # Uses JuiceFS as the root filesystem -olares-cli olares prepare --with-juicefs=true +olares-cli prepare --with-juicefs=true ``` \ No newline at end of file diff --git a/docs/developer/install/cli/olares-release.md b/docs/developer/install/cli/olares-release.md index 225b7b9a..7d195843 100644 --- a/docs/developer/install/cli/olares-release.md +++ b/docs/developer/install/cli/olares-release.md @@ -4,17 +4,16 @@ Build a release version based on a local Olares repository. This command should be run in the root directory of the Olares repository. ```bash -olares-cli olares release [option] +olares-cli release [option] ``` ## Options -| Name | Shorthand | Usage | -|----------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--download-cdn-url` | | Sets the CDN URL used for downloading checksums of dependencies and images.
Defaults to `https://dc3p1870nn3cj.cloudfront.net`. | -| `--extract` | `-e` | Extracts the release to the `--base-dir` after the build. Set to `false` if only the release file itself is needed.
Defaults to `true`. | -| `--help` | `-h` | Displays help information. | -| `---ignore-missing-images` | | Ignores missing images when downloading checksums from the CDN.
Disable this only if no new images are added, as the build may fail if the image is not uploaded to the CDN yet.
Defaults to `true`. | -| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | - +| Option | Shorthand | Usage | Required | Default | +|---------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|----------------------------------------| +| `--base-dir` | `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--download-cdn-url` | | Sets the CDN URL used for downloading checksums of dependencies and images. | No | `https://dc3p1870nn3cj.cloudfront.net` | +| `--extract` | `-e` | Extracts the release to the `--base-dir` after the build. Set to `false` if only the release file itself is needed. | No | `true` | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--ignore-missing-images` | | Ignores missing images when downloading checksums from the CDN.
Disable this only if no new images are added, as the build may fail if the image is not uploaded to the CDN yet. | No | `true` | +| `--version` | `-v` | Specifies the Olares version.
Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).
Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version | \ No newline at end of file diff --git a/docs/developer/install/cli/olares-start.md b/docs/developer/install/cli/olares-start.md index da57e1fa..01c921c2 100644 --- a/docs/developer/install/cli/olares-start.md +++ b/docs/developer/install/cli/olares-start.md @@ -4,7 +4,7 @@ The `olares start` command is used to start the Olares system, including its components and services, after it has been stopped. ```bash -olares-cli olares start [option] +olares-cli start [option] ``` ## Option diff --git a/docs/developer/install/cli/olares-stop.md b/docs/developer/install/cli/olares-stop.md index f8123014..03c32bca 100644 --- a/docs/developer/install/cli/olares-stop.md +++ b/docs/developer/install/cli/olares-stop.md @@ -4,25 +4,25 @@ The `olares stop` command is used to stop the components of an installed (or partially installed) Olares system. ```bash -olares-cli olares stop [option] +olares-cli stop [option] ``` ## Options -| Name | Shorthand | Usage | -|--------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------| -| `--check-interval` | | Specifies the interval between checks for remaining processes during shutdown (e.g., `5s`, `2m`, `3h`).
Default: `10s`. | -| `--help` | `-h` | Displays help information. | -| `--timeout` | | Sets the maximum time to wait for a graceful shutdown before using SIGKILL (e.g., `5s`, `2m`, `3h`).
Default: `1m`. | +| Option | Shorthand | Usage | Required | Default | +|--------------------|-----------|-----------------------------------------------------------------------------------------------------------|-------------------------|---------| +| `--check-interval` | | Specifies the interval between checks for remaining processes during shutdown (e.g., `5s`, `2m`, `3h`). | No | `10s` | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--timeout` | | Sets the maximum time to wait for a graceful shutdown before using SIGKILL (e.g., `5s`, `2m`, `3h`). | No | `1m` | ## Example ```bash # Stop the Olares system -olares-cli olares stop +olares-cli stop # Adjust the timeout for shutdown -olares-cli olares stop --timeout 2m +olares-cli stop --timeout 2m # Specify a custom check interval -olares-cli olares stop --check-interval 5s +olares-cli stop --check-interval 5s ``` \ No newline at end of file diff --git a/docs/developer/install/cli/olares-uninstall.md b/docs/developer/install/cli/olares-uninstall.md index a07af7f3..6823c090 100644 --- a/docs/developer/install/cli/olares-uninstall.md +++ b/docs/developer/install/cli/olares-uninstall.md @@ -4,16 +4,16 @@ Uninstall Olares from your machine. ```bash -olares-cli olares uninstall [option] +olares-cli uninstall [option] ``` ## Options -| Name | Shorthand | Usage | -|--------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--all` | | Uninstalls Olares completely, including dependencies installed during the "prepare" phase. | -| `--base-dir` | `-b` | Sets the base directory for Olares.
Defaults to `$HOME/.olares`. | -| `--help` | `-h` | Displays help information. | -| `--phase` | | Uninstalls Olares from a specific phase and revert to the previous one.
For example, `--phase install` removes tasks performed during the "install" phase, reverting the system to the "prepare" stage.
Defaults to `install`. | -| `--quiet` | | Enables quiet mode (suppress output).
Defaults to `false`. | -| `--version` | `-v` | Specifies the Olares version to uninstall.
Use `olares-cli olares info` to check the downloaded version first. | +| Option | Shorthand | Usage | Required | Default | +|-------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------| +| `--all` | | Uninstalls Olares completely, including dependencies installed during the "prepare" phase. | No | Not applicable | +| `--base-dir`| `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` | +| `--help` | `-h` | Displays help information. | No | Not applicable | +| `--phase` | | Uninstalls Olares from a specific phase and revert to the previous one.
For example, `--phase install` removes tasks performed during the "install" phase, reverting the system to the "prepare" stage. | No | `install` | +| `--quiet` | | Enables quiet mode (suppress output). | No | `false` | +| `--version` | `-v` | Specifies the Olares version to uninstall.
Use `olares-cli info` to check the downloaded version first. | No | Current version | \ No newline at end of file diff --git a/docs/developer/install/cli/info.md b/docs/developer/install/cli/osinfo.md similarity index 96% rename from docs/developer/install/cli/info.md rename to docs/developer/install/cli/osinfo.md index d631d42d..f9f784ed 100644 --- a/docs/developer/install/cli/info.md +++ b/docs/developer/install/cli/osinfo.md @@ -1,11 +1,11 @@ -# `info` +# `osinfo` ## Synopsis The `info` command provides detailed information about the operating system of the current device. Specifically, it retrieves and displays metadata such as `OS_TYPE`, `OS_PLATFORM`, `OS_ARCH`, `OS_VERSION`, `OS_KERNEL`, and `OS_INFO`. ```bash -olares-cli info [options] +olares-cli osinfo [options] ``` ## Subcommand diff --git a/docs/developer/install/cli/region.md b/docs/developer/install/cli/region.md index c4775897..6c8fda00 100644 --- a/docs/developer/install/cli/region.md +++ b/docs/developer/install/cli/region.md @@ -3,24 +3,24 @@ ## Synopsis The `region` subcommand is used to retrieve the cloud name and region ID. It is specifically used when the storage backend is Olares Space. ```bash -olares-cli olares backups region space [options] +olares-cli backups region space [options] ``` ## Options -| Name | Shorthand | Usage | -|-------------------------------|-----------|----------------------------------------------| -| `--access-token` 1 | | Specifies the access token for Olares Space. | -| `--cloud-api-mirror` | | Specifies the cloud API mirror. | -| `--help` | `-h` | Displays help information. | -| `--olares-did` 1 | | Specifies the Olares DID. | +| Option | Shorthand | Usage | Required | Default | +|-------------------------------|-----------|----------------------------------------------|-------------------------|---------| +| `--access-token` 1 | | Specifies the access token for Olares Space. | No | N/A | +| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A | +| `--help` | `-h` | Displays help information. | No | N/A | +| `--olares-did` 1 | | Specifies the Olares DID. | No | N/A | 1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID. ## Example ```bash # Query cloud name and region ID -olares-cli olares backups region space \ +olares-cli backups region space \ --access-token YOUR_ACCESS_TOKEN \ --cloud-api-mirror https://api-mirror.example.com \ --olares-did did:xyz123 diff --git a/docs/developer/install/cli/restore.md b/docs/developer/install/cli/restore.md index 5337a5f1..b794e12a 100644 --- a/docs/developer/install/cli/restore.md +++ b/docs/developer/install/cli/restore.md @@ -3,64 +3,64 @@ outline: [2, 3] --- # `olares backups restore` :::warning -The `olares-cli olares backups download` command must be run first to install Restic. Otherwise, this command will return an error. +The `olares-cli backups download` command must be run first to install Restic. Otherwise, this command will return an error. ::: ## Synopsis The `restore` subcommand allows you to restore data from a specified backup repository and snapshot to a target directory. ```bash -olares-cli olares backups restore --path --repo-name --snapshot-id [options] +olares-cli backups restore --path --repo-name --snapshot-id [options] ``` ## Common options These options apply to all backends: -| Name | Shorthand | Usage | -|-----------------|-----------|--------------------------------------------------------------| -| `--help` | `-h` | Displays help information. | -| `--path` | | Specifies the directory to which data will be restored. | -| `--repo-name` | | Specifies the name of the backup repository to restore from. | -| `--snapshot-id` | | Specifies the snapshot ID to restore. | +| Option | Shorthand | Usage | Required | Default | +|---------------|-----------|--------------------------------------------------------------|-------------------------|---------| +| `--help` | `-h` | Displays help information. | No | N/A | +| `--path` | | Specifies the directory to which data will be restored. | No | N/A | +| `--repo-name` | | Specifies the name of the backup repository to restore from. | No | N/A | +| `--snapshot-id`| | Specifies the snapshot ID to restore. | No | N/A | | ## Backend-specific options ### Options for `cos` -| Name | Shorthand | Usage | -|-------------------------|-----------|--------------------------------------------------------------------------------------------------| -| `--access-key` | | Specifies the Access Key for Tencent COS. | -| `--endpoint` | | Specifies the Tencent COS endpoint, e.g., `https://cos.{region}.myqcloud.com/{bucket}/{prefix}`. | -| `--limit-download-rate` | | Limits the download speed to a maximum rate in KiB/s (default: unlimited). | -| `--secret-access-key` | | Specifies the Secret Access Key for Tencent COS. | +| Option | Shorthand | Usage | Required | Default | +|-------------------------|-----------|--------------------------------------------------------------------------------------------------|-------------------------|------------| +| `--access-key` | | Specifies the Access Key for Tencent COS. | No | N/A | +| `--endpoint` | | Specifies the Tencent COS endpoint, e.g., `https://cos.{region}.myqcloud.com/{bucket}/{prefix}`. | No | N/A | +| `--limit-download-rate` | | Limits the download speed to a maximum rate in KiB/s. | No | unlimited | +| `--secret-access-key` | | Specifies the Secret Access Key for Tencent COS. | No | N/A | ### Options for `fs` -| Name | Shorthand | Usage | -|---------------|-----------|-----------------------------------------------------------| -| `--endpoint` | | Specifies the local directory where the backup is stored. | -| `--olares-id` | | Specifies the Olares ID. | +| Option | Shorthand | Usage | Required | Default | +|-------------|-----------|-----------------------------------------------------------|-------------------------|---------| +| `--endpoint` | | Specifies the local directory where the backup is stored. | No | N/A | +| `--olares-id` | | Specifies the Olares ID. | No | N/A | ### Options for `s3` -| Name | Shorthand | Usage | -|-------------------------|-----------|---------------------------------------------------------------------------------------------| -| `--access-key` | | Specifies the Access Key for Amazon S3. | -| `--endpoint` | | Specifies the Amazon S3 endpoint, e.g., `https://{bucket}.{region}.amazonaws.com/{prefix}`. | -| `--limit-download-rate` | | Limits the download speed to a maximum rate in KiB/s (default: unlimited). | -| `--secret-access-key` | | Specifies the Secret Access Key for Amazon S3. | +| Option | Shorthand | Usage | Required | Default | +|-------------------------|-----------|---------------------------------------------------------------------------------------------|-------------------------|------------| +| `--access-key` | | Specifies the Access Key for Amazon S3. | No | N/A | +| `--endpoint` | | Specifies the Amazon S3 endpoint, e.g., `https://{bucket}.{region}.amazonaws.com/{prefix}`. | No | N/A | +| `--limit-download-rate` | | Limits the download speed to a maximum rate in KiB/s. | No | unlimited | +| `--secret-access-key` | | Specifies the Secret Access Key for Amazon S3. | No | N/A | ### Options for `space` -| Name | Shorthand | Usage | -|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------| -| `--access-token` 1 | | Specifies the access token for Olares Space. | -| `--cloud-api-mirror` | | Specifies the cloud API mirror. | -| `--cloud-name` | | Specifies the cloud name of the Olares Space instance.
The cloud name can be retrieved using the [`region`](region.md) subcommand. | -| `--cluster-id` 2 | | Specifies the cluster ID where the backup will be stored. | -| `--limit-download-rate` | | Limits the download speed to a maximum rate in KiB/s (default: unlimited). | -| `--olares-did` 1 | | Specifies the Olares DID. | -| `--region-id` | | Specifies the region ID of the Olares Space instance.
The region ID can be retrieved using the [`region`](region.md) subcommand. | +| Option | Shorthand | Usage | Required | Default | +|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|------------| +| `--access-token` 1 | | Specifies the access token for Olares Space. | No | N/A | +| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A | +| `--cloud-name` | | Specifies the cloud name of the Olares Space instance.
The cloud name can be retrieved using the [`region`](region.md) subcommand. | No | N/A | +| `--cluster-id` 2 | | Specifies the cluster ID where the backup will be stored. | No | N/A | +| `--limit-download-rate` | | Limits the download speed to a maximum rate in KiB/s. | No | unlimited | +| `--olares-did` 1 | | Specifies the Olares DID. | No | N/A | +| `--region-id` | | Specifies the region ID of the Olares Space instance.
The region ID can be retrieved using the [`region`](region.md) subcommand. | No | N/A | 1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID. @@ -72,13 +72,13 @@ These options apply to all backends: ## Example ```bash # Restore the data from Tencent COS -olares-cli olares backups restore cos --path /data_restore --repo-name my_repo \ +olares-cli backups restore cos --path /data_restore --repo-name my_repo \ --snapshot-id snapshot_12345 \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://cos.region.myqcloud.com/bucket/prefix # Restore the data from local filesystem -olares-cli olares backups restore fs --path /data_restore --repo-name my_repo \ +olares-cli backups restore fs --path /data_restore --repo-name my_repo \ --snapshot-id snapshot_12345 --endpoint /backup_repo ``` \ No newline at end of file diff --git a/docs/developer/install/cli/snapshots.md b/docs/developer/install/cli/snapshots.md index aabdb84c..1b3a9eed 100644 --- a/docs/developer/install/cli/snapshots.md +++ b/docs/developer/install/cli/snapshots.md @@ -3,56 +3,56 @@ outline: [2, 3] --- # `olares backups snapshots` :::warning -The `olares-cli olares backups download` command must be run first to install Restic. Otherwise, this command will return an error. +The `olares-cli backups download` command must be run first to install Restic. Otherwise, this command will return an error. ::: ## Synopsis The `snapshots` subcommand lists all available snapshots for a specific backup repository. It supports multiple storage backends and provides the necessary options to authenticate and query snapshots. ```bash -olares-cli olares backups snapshots --repo-name [options] +olares-cli backups snapshots --repo-name [options] ``` ## Common options These options apply to all backends: -| Name | Shorthand | Usage | -|---------------|-----------|--------------------------------------------------------| -| `--help` | `-h` | Displays help information. | -| `--repo-name` | | Specifies the name of the backup repository to query. | +| Option | Shorthand | Usage | Required | Default | +|---------------|-----------|-------------------------------------------------------|-------------------------|---------| +| `--help` | `-h` | Displays help information. | No | N/A | +| `--repo-name` | | Specifies the name of the backup repository to query. | No | N/A | ## Backend-specific options ### Options for `cos` -| Name | Shorthand | Usage | -|-----------------------|-----------|--------------------------------------------------------------------------------------------------| -| `--access-key` | | Specifies the Access Key for Tencent COS. | -| `--endpoint` | | Specifies the Tencent COS endpoint, e.g., `https://cos.{region}.myqcloud.com/{bucket}/{prefix}`. | -| `--secret-access-key` | | Specifies the Secret Access Key for Tencent COS. | +| Option | Shorthand | Usage | Required | Default | +|---------------------|-----------|--------------------------------------------------------------------------------------------------|-------------------------|---------| +| `--access-key` | | Specifies the Access Key for Tencent COS. | No | N/A | +| `--endpoint` | | Specifies the Tencent COS endpoint, e.g., `https://cos.{region}.myqcloud.com/{bucket}/{prefix}`. | No | N/A | +| `--secret-access-key` | | Specifies the Secret Access Key for Tencent COS. | No | N/A | ### Options for `fs` -| Name | Shorthand | Usage | -|--------------|-----------|----------------------------------------------------------------| -| `--endpoint` | | Specifies the local directory where the backup will be stored. | +| Option | Shorthand | Usage | Required | Default | +|------------|-----------|----------------------------------------------------------------|-------------------------|---------| +| `--endpoint` | | Specifies the local directory where the backup will be stored. | No | N/A | ### Options for `s3` -| Name | Shorthand | Usage | -|-----------------------|-----------|---------------------------------------------------------------------------------------------| -| `--access-key` | | Specifies the Access Key for Amazon S3. | -| `--endpoint` | | Specifies the Amazon S3 endpoint, e.g., `https://{bucket}.{region}.amazonaws.com/{prefix}`. | -| `--secret-access-key` | | Specifies the Secret Access Key for Amazon S3. | +| Option | Shorthand | Usage | Required | Default | +|---------------------|-----------|---------------------------------------------------------------------------------------------|-------------------------|---------| +| `--access-key` | | Specifies the Access Key for Amazon S3. | No | N/A | +| `--endpoint` | | Specifies the Amazon S3 endpoint, e.g., `https://{bucket}.{region}.amazonaws.com/{prefix}`. | No | N/A | +| `--secret-access-key` | | Specifies the Secret Access Key for Amazon S3. | No | N/A | ### Options for `space` -| Name | Shorthand | Usage | -|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------| -| `--access-token` 1 | | Specifies the access token for Olares Space. | -| `--cloud-api-mirror` | | Specifies the cloud API mirror. | -| `--cloud-name` | | Specifies the cloud name of the Olares Space instance.
The cloud name can be retrieved using the [`region`](region.md) subcommand. | -| `--cluster-id` 2 | | Specifies the cluster ID where the backup will be stored. | -| `--olares-did` 1 | | Specifies the Olares DID. | -| `--region-id` | | Specifies the region ID of the Olares Space instance.
The region ID can be retrieved using the [`region`](region.md) subcommand. | +| Option | Shorthand | Usage | Required | Default | +|-------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---------| +| `--access-token` 1 | | Specifies the access token for Olares Space. | No | N/A | +| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A | +| `--cloud-name` | | Specifies the cloud name of the Olares Space instance.
The cloud name can be retrieved using the [`region`](region.md) subcommand. | No | N/A | +| `--cluster-id` 2 | | Specifies the cluster ID where the backup will be stored. | No | N/A | +| `--olares-did` 1 | | Specifies the Olares DID. | No | N/A | +| `--region-id` | | Specifies the region ID of the Olares Space instance.
The region ID can be retrieved using the [`region`](region.md) subcommand. | No | N/A | 1. To retrieve the access token and Olares DID, inspect the payload of the network requests made by the Olares Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the Olares DID. @@ -64,11 +64,11 @@ These options apply to all backends: ## Example ```bash # List snapshots for Tencent COS -olares-cli olares backups snapshots cos --repo-name my_repo \ +olares-cli backups snapshots cos --repo-name my_repo \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://cos.region.myqcloud.com/bucket/prefix # List snapshots for local filesystem -olares-cli olares backups snapshots fs --repo-name my_repo --endpoint /backup_repo +olares-cli backups snapshots fs --repo-name my_repo --endpoint /backup_repo ``` \ No newline at end of file diff --git a/docs/developer/install/installation-process.md b/docs/developer/install/installation-process.md index 433f2baf..69f794e0 100644 --- a/docs/developer/install/installation-process.md +++ b/docs/developer/install/installation-process.md @@ -15,7 +15,7 @@ The Olares installation process is divided into four phases, each ensuring a smo ## Precheck phase -The precheck phase focuses on verifying that your system meets the necessary requirements for installing Olares. The `olares-cli olares precheck` command is used to run a series of validation checks. Any issues identified during this phase must be resolved before continuing with the installation. +The precheck phase focuses on verifying that your system meets the necessary requirements for installing Olares. The `olares-cli precheck` command is used to run a series of validation checks. Any issues identified during this phase must be resolved before continuing with the installation. Key checks include: - Checks the compatibility with the operating system type, version, and CPU architecture diff --git a/docs/developer/install/olares-home.md b/docs/developer/install/olares-home.md index 624894e9..5f32dc72 100644 --- a/docs/developer/install/olares-home.md +++ b/docs/developer/install/olares-home.md @@ -11,7 +11,7 @@ By default, Olares Home is located at `~/.olares`. You can customize its locatio ```bash # Specifies the base directory where all downloaded components will be saved -olares-cli olares download component --base-dir /custom/path +olares-cli download component --base-dir /custom/path ``` ## Directory structure diff --git a/docs/developer/install/reusables.md b/docs/developer/install/reusables.md index 12aa383e..eadf1abb 100644 --- a/docs/developer/install/reusables.md +++ b/docs/developer/install/reusables.md @@ -12,7 +12,7 @@ During the installation, you may be prompted to enter your root password. If an error occurs during installation, use the following command to uninstall first: ```bash -bash olares-uninstall.sh +bash olares-cli uninstall --all ``` After uninstalling, retry the installation by running the original installation command. ::: diff --git a/docs/manual/get-started/reusables.md b/docs/manual/get-started/reusables.md index 5087c4f9..91f5add9 100644 --- a/docs/manual/get-started/reusables.md +++ b/docs/manual/get-started/reusables.md @@ -12,7 +12,7 @@ During the installation, you may be prompted to enter your root password. If an error occurs during installation, use the following command to uninstall first: ```bash -bash olares-uninstall.sh +bash olares-cli uninstall --all ``` After uninstalling, retry the installation by running the original installation command. ::: diff --git a/docs/manual/tutorials/install-olares-multi-node.md b/docs/manual/tutorials/install-olares-multi-node.md index 8e38cb05..d9ba0a78 100644 --- a/docs/manual/tutorials/install-olares-multi-node.md +++ b/docs/manual/tutorials/install-olares-multi-node.md @@ -29,7 +29,7 @@ Before you begin, make sure the following requirements are met: ## Step 1: Set up the master node ::: tip Uninstall existing Olares cluster -If you have already installed an Olares cluster using the default installation command, uninstall it using `bash olares-uninstall.sh` before you set up your master node. +If you have already installed an Olares cluster using the default installation command, uninstall it using `bash olares-cli uninstall --all` before you set up your master node. ::: To set up the master node with the JuiceFS support, run the following command: diff --git a/docs/zh/developer/contribute/olares.md b/docs/zh/developer/contribute/olares.md index 3c9b4723..4ca3f45c 100644 --- a/docs/zh/developer/contribute/olares.md +++ b/docs/zh/developer/contribute/olares.md @@ -88,5 +88,5 @@ make install VERSION=0.0.0-DEBUG ## 如何卸载 ```bash -bash olares-uninstall.sh +bash olares-cli uninstall --all ``` diff --git a/docs/zh/developer/install/cli/backup.md b/docs/zh/developer/install/cli/backup.md index 79be8d88..5d0922ab 100644 --- a/docs/zh/developer/install/cli/backup.md +++ b/docs/zh/developer/install/cli/backup.md @@ -3,61 +3,60 @@ outline: [2, 3] --- # `olares backups backup` :::warning -必须先运行 `olares-cli olares backups download` 命令来安装 Restic，否则直接运行此命令将返回错误。 +必须先运行 `olares-cli backups download` 命令来安装 Restic，否则直接运行此命令将返回错误。 ::: ## 命令说明 `backup` 子命令用于将数据备份到指定的存储后端。它能确保数据安全存储，以便在需要时进行恢复。 ```bash -olares-cli olares backups backup <存储后端> --path <备份路径> --repo-name <仓库名称> [选项] +olares-cli backups backup <存储后端> --path <备份路径> --repo-name <仓库名称> [选项] ``` ## 通用选项 以下选项适用于所有后端： -| 名称 | 简写 | 用途 | -|---------------|------|------------| -| `--help` | `-h` | 显示命令帮助信息。 | -| `--path` | | 指定要备份的目录。 | -| `--repo-name` | | 指定备份仓库的名称。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|---------------|------|----------------|----------|--------| +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | +| `--path` | | 指定要备份的目录。 | 否 | 无 | +| `--repo-name` | | 指定备份仓库的名称。 | 否 | 无 | ## 存储后端配置选项 ### 腾讯云对象存储（`cos`）选项 -| 名称 | 简写 | 用途 | -|-----------------------|----|----------------------------------------------------------------------------| -| `--access-key` | | 设置腾讯云 COS 的访问密钥。 | -| `--endpoint` | | 设置腾讯云 COS 的终端节点，格式如：`https://cos.{region}.myqcloud.com/{bucket}/{prefix}`。 | -| `--limit-upload-rate` | | 设置上传速度的最大值，单位为 KiB/s（默认不限速）。 | -| `--secret-access-key` | | 设置腾讯云 COS 的密钥。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-----------------------|----|------------------------------------------------------------------------------|----------|----------| +| `--access-key` | | 设置腾讯云 COS 的访问密钥。 | 否 | 无 | +| `--endpoint` | | 设置腾讯云 COS 的终端节点，格式如：`https://cos.{region}.myqcloud.com/{bucket}/{prefix}`。 | 否 | 无 | +| `--limit-upload-rate` | | 设置上传速度的最大值，单位为 KiB/s。 | 否 | 不限速 | +| `--secret-access-key` | | 设置腾讯云 COS 的密钥。 | 否 | 无 | ### 本地文件系统（`fs`）选项 -| 名称 | 简写 | 用途 | -|--------------|----|----------------| -| `--endpoint` | | 指定存储备份的本地目录路径。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|--------------|----|--------------------|----------|--------| +| `--endpoint` | | 指定存储备份的本地目录路径。 | 否 | 无 | ### Amazon S3 选项（`s3`） -| 名称 | 简写 | 用途 | -|-----------------------|----|----------------------------------------------------------------------------| -| `--access-key` | | 设置 Amazon S3 的访问密钥。 | -| `--endpoint` | | 设置 Amazon S3 的终端节点，格式如：`https://{bucket}.{region}.amazonaws.com/{prefix}`。 | -| `--limit-upload-rate` | | 设置上传速度的最大值，单位为 KiB/s（默认不限速）。 | -| `--secret-access-key` | | 设置 Amazon S3 的密钥。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-----------------------|----|------------------------------------------------------------------------------|----------|----------| +| `--access-key` | | 设置 Amazon S3 的访问密钥。 | 否 | 无 | +| `--endpoint` | | 设置 Amazon S3 的终端节点，格式如：`https://{bucket}.{region}.amazonaws.com/{prefix}`。 | 否 | 无 | +| `--limit-upload-rate` | | 设置上传速度的最大值，单位为 KiB/s。 | 否 | 不限速 | +| `--secret-access-key` | | 设置 Amazon S3 的密钥。 | 否 | 无 | ### Olares Space 选项（`space`） -| 名称 | 简写 | 用途 | -|-------------------------------|----|-----------------------------------------------------------------| -| `--access-token` 1 | | 设置 Olares Space 的访问令牌。 | -| `--cloud-api-mirror` | | 设置云 API 镜像地址。 | -| `--cloud-name` | | 设置 Olares Space 实例的云名称。
可通过 [`region`](region.md) 子命令获取。 | -| `--cluster-id` 2 | | 设置用于存储备份的集群 ID。 | -| `--limit-upload-rate` | | 设置上传速度的最大值，单位为 KiB/s（默认不限速）。 | -| `--olares-did` 1 | | 设置 Olares DID。 | -| `--region-id` | | 设置 Olares Space 实例的区域 ID。
可通过 [`region`](region.md) 子命令获取。 | - +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------------------------|----|---------------------------------------------------------------------|----------|----------| +| `--access-token` 1 | | 设置 Olares Space 的访问令牌。 | 否 | 无 | +| `--cloud-api-mirror` | | 设置云 API 镜像地址。 | 否 | 无 | +| `--cloud-name` | | 设置 Olares Space 实例的云名称。
可通过 [`region`](region.md) 子命令获取。 | 否 | 无 | +| `--cluster-id` 2 | | 设置用于存储备份的集群 ID。 | 否 | 无 | +| `--limit-upload-rate` | | 设置上传速度的最大值，单位为 KiB/s。 | 否 | 不限速 | +| `--olares-did` 1 | | 设置 Olares DID。 | 否 | 无 | +| `--region-id` | | 设置 Olares Space 实例的区域 ID。
可通过 [`region`](region.md) 子命令获取。 | 否 | 无 | 1. 要获取访问令牌和 Olares DID，请在登录 Olares Space 后检查页面网络请求的负载。`token` 字段对应访问令牌，`userid` 字段对应 Olares DID。 @@ -68,13 +67,13 @@ olares-cli olares backups backup <存储后端> --path <备份路径> --repo-nam ## 使用示例 ```bash # 备份到腾讯云对象存储 -olares-cli olares backups backup cos --path /data --repo-name my_repo \ +olares-cli backups backup cos --path /data --repo-name my_repo \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://cos.region.myqcloud.com/bucket/prefix # 备份到 Olares Space -olares-cli olares backups backup space --path /data --repo-name my_repo \ +olares-cli backups backup space --path /data --repo-name my_repo \ --access-token YOUR_ACCESS_TOKEN \ --cloud-api-mirror https://api-mirror.example.com \ --cloud-name my_cloud \ diff --git a/docs/zh/developer/install/cli/download.md b/docs/zh/developer/install/cli/download.md index adbf4d16..3eb66e49 100644 --- a/docs/zh/developer/install/cli/download.md +++ b/docs/zh/developer/install/cli/download.md @@ -4,17 +4,17 @@ `download` 子命令用于下载 Restic 工具。Restic 是执行备份和恢复操作的必需工具，该命令可确保系统上已安装此工具。 ```bash -olares-cli olares backups download [选项] +olares-cli backups download [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|----------------------|------|-------------------------| -| `--download-cdn-url` | | 设置下载 Restic 工具的 CDN 地址。 | -| `--help` | `-h` | 显示命令帮助信息。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|----------------------|------|-----------------------------|----------|------------| +| `--download-cdn-url` | | 下载 Restic 工具的 CDN 地址。 | 否 | 系统默认 URL | +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | ## 使用示例 ```bash # 通过自定义 CDN 地址下载 Restic -olares-cli olares backups download --download-cdn-url https://custom-cdn.example.com/restic +olares-cli backups download --download-cdn-url https://custom-cdn.example.com/restic ``` \ No newline at end of file diff --git a/docs/zh/developer/install/cli/gpu.md b/docs/zh/developer/install/cli/gpu.md index 90d456b8..554d233d 100644 --- a/docs/zh/developer/install/cli/gpu.md +++ b/docs/zh/developer/install/cli/gpu.md @@ -17,7 +17,7 @@ olares-cli gpu <子命令> [选项] | 子命令 | 描述 | |-------------|------------------------------------------------------------------| -| `install` | 安装 GPU 驱动和相关依赖。必须指定安装目录（`--base-dir`）和 Olares 版本（`--version`）选项。 | +| `install` | 安装 GPU 驱动和相关依赖。| | `enable` | 启用 GPU 功能，支持 GPU 应用运行。 | | `disable` | 禁用 GPU 功能，停止支持 GPU 应用运行。 | | `uninstall` | 卸载 GPU 驱动和相关程序。 | @@ -25,11 +25,11 @@ olares-cli gpu <子命令> [选项] ## 选项 -| 名称 | 简写 | 描述 | -|--------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 指定安装的基础目录。通常是 Olares 的默认安装目录 `$HOME/.olares`。 | -| `--version` | `-v` | 安装指定 Olares 版本的 GPU 驱动及组件。版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | | -| `--help` | `-h` | 显示命令帮助信息。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|--------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------| +| `--base-dir` | `-b` | 指定安装的基础目录。 | 否 | `$HOME/.olares` | +| `--version` | `-v` | 安装指定 Olares 版本的 GPU 驱动及组件。版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | 否 | 当前已安装版本 | +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | ## 使用示例 ```bash diff --git a/docs/zh/developer/install/cli/node.md b/docs/zh/developer/install/cli/node.md index d46e8ad7..e0f2009b 100644 --- a/docs/zh/developer/install/cli/node.md +++ b/docs/zh/developer/install/cli/node.md @@ -17,17 +17,19 @@ olares-cli node <子命令> [选项] ## 选项 -| 名称 | 简写 | 描述 | -|---------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 指定安装的基础目录。通常是 Olares 的默认安装目录 `$HOME/.olares`。 | -| `--master-host` | | 指定主节点的 IP 地址。
此选项为必填项。 | -| `--master-node-name` | | 指定主节点的 Kubernetes 节点名称。 | -| `--master-ssh-user` | | 设置主节点 SSH 登录的 Linux 用户名。
默认为 root。 | -| `--master-ssh-password` | | 设置 Linux 用户的密码。
当指定非 root 用户时必填。 | -| `--master-ssh-private-key-path` | | 指定 Linux 用户 SSH 认证的私钥路径。
默认为 `/root/.ssh/id_rsa`。 | -| `--master-ssh-port` | | 设置主节点 SSH 服务的监听端口。
默认为 `22`。 | -| `--version` | `-v` | 安装指定 Olares 版本的 GPU 驱动及组件。版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | | -| `--help` | `-h` | 显示命令帮助信息。 | + + +| 选项 | 简写| 用途 | 是否必需 | 默认值 | +|---------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------| +| `--base-dir` | `-b` | 指定安装的基础目录。 | 否 | `$HOME/.olares` | +| `--master-host` | | 指定主节点的 IP 地址。 | 是 | 无 | +| `--master-node-name` | | 指定主节点的 Kubernetes 节点名称。 | 否 | 无 | +| `--master-ssh-user` | | 设置主节点 SSH 登录的 Linux 用户名。 | 否 | `root` | +| `--master-ssh-password` | | 设置 Linux 用户的密码。 | 当指定非 root 登录用户时必填。 | 无 | +| `--master-ssh-private-key-path` | | 指定 Linux 用户 SSH 认证的私钥路径。 | 否 | `/root/.ssh/id_rsa` | +| `--master-ssh-port` | | 设置主节点 SSH 服务的监听端口。 | 否 | `22` | +| `--version` | `-v` | 指定 Olares 版本。版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | 否 | 当前已安装版本 | +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | ## 使用示例 diff --git a/docs/zh/developer/install/cli/olares-change-ip.md b/docs/zh/developer/install/cli/olares-change-ip.md index 24c7aeca..e4d93954 100644 --- a/docs/zh/developer/install/cli/olares-change-ip.md +++ b/docs/zh/developer/install/cli/olares-change-ip.md @@ -7,27 +7,27 @@ 更新所有 Olares 组件使用的本地 IP 地址。 ```bash -olares-cli olares change-ip [选项] +olares-cli change-ip [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 设置 Olares 的基础目录。
默认为 `$HOME/.olares`。 | -| `--distribution` | `-d` | 指定 WSL 发行版名称，仅适用于 Windows。
默认为 `Ubuntu`。 | -| `--help` | `-h` | 显示帮助信息。 | -| `--profile` | `-p` | 设置 Minikube 配置文件名称，仅适用于 macOS。
默认为 `olares-0`。 | -| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------| +| `--base-dir` | `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares` | +| `--distribution` | `-d` | 指定 WSL 发行版名称，仅适用于 Windows。 | 否 | `Ubuntu` | +| `--help` | `-h` | 显示帮助信息。 | 否 | 无 | +| `--profile` | `-p` | 设置 Minikube 配置文件名称，仅适用于 macOS。 | 否 | `olares-0` | +| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | 否 | 当前安装版本 | ## 使用示例 - macOS: ```bash # 指定 Minikube 配置文件名称并更新 IP -olares-cli olares change-ip --profile olares-0 +olares-cli change-ip --profile olares-0 ``` - Windows WSL: ```bash # 指定 WSL 发行版并更新 IP -olares-cli olares change-ip --distribution Ubuntu +olares-cli change-ip --distribution Ubuntu ``` \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-cli.md b/docs/zh/developer/install/cli/olares-cli.md index 9612f710..8e19e098 100644 --- a/docs/zh/developer/install/cli/olares-cli.md +++ b/docs/zh/developer/install/cli/olares-cli.md @@ -33,7 +33,7 @@ Olares 命令行工具使用如下语法： 通过 Olares 命令行工具，你可以临时覆盖某些 Olares 默认设置。每个选项仅对当前执行的命令生效。 -例如，在执行 `olares-cli olares download wizard` 时使用 `--base-dir` 选项，只会影响向导的下载过程，而不会改变其他命令（如“安装”阶段）的基础目录。 +例如，在执行 `olares-cli download wizard` 时使用 `--base-dir` 选项，只会影响向导的下载过程，而不会改变其他命令（如“安装”阶段）的基础目录。 如需查看任何命令的详细帮助信息，请运行 `olares-cli help`。 @@ -42,18 +42,18 @@ Olares 命令行工具使用如下语法： | 操作 | 语法 | 说明 | |--------------------|-----------------------------------------|--------------------------------| | `gpu` | `olares-cli gpu <子命令> [选项]` | 管理 GPU 相关的操作。 | -| `info` | `olares-cli olares info <子命令> [选项]` | 显示当前设备的操作系统信息。 | +| `info` | `olares-cli info <子命令> [选项]` | 显示当前设备的操作系统信息。 | | `node` | `olares-cli node <子命令> [选项]` | 管理节点相关的操作。 | -| `olares backups` | `olares-cli olares backups <子命令> [选项]` | 管理备份相关操作。 | -| `olares change-ip` | `olares-cli olares change-ip [选项]` | 修改 Olares OS 的 IP 地址。 | -| `olares download` | `olares-cli olares download <子命令> [选项]` | 下载指定资源。 | -| `olares info` | `olares-cli olares info [选项]` | 显示已下载的 Olares OS 的常规信息。 | -| `olares install` | `olares-cli olares install [选项]` | 部署 Olares 的系统级和用户级组件。 | -| `olares logs` | `olares-cli olares logs [选项]` | 收集 Olares 系统组件的日志，用于调试和故障排查。 | -| `olares precheck` | `olares-cli olares precheck [选项]` | 检查系统环境是否满足 Olares 安装要求。 | -| `olares prepare` | `olares-cli olares prepare [选项]` | 为安装过程准备环境，包括设置 Olares 的基础服务和配置 | -| `olares release` | `olares-cli olares release [选项]` | 打包 Olares 安装资源以供分发或部署。 | -| `olares start` | `olares-cli olares start [选项]` | 启动 Olares 服务和组件。 | -| `olares stop` | `olares-cli olares stop [选项]` | 停止 Olares 服务和组件。 | -| `olares uninstall` | `olares-cli olares uninstall [选项]` | 完全卸载 Olares，或将安装回滚到特定阶段。 | +| `olares backups` | `olares-cli backups <子命令> [选项]` | 管理备份相关操作。 | +| `olares change-ip` | `olares-cli change-ip [选项]` | 修改 Olares OS 的 IP 地址。 | +| `olares download` | `olares-cli download <子命令> [选项]` | 下载指定资源。 | +| `olares info` | `olares-cli info [选项]` | 显示已下载的 Olares OS 的常规信息。 | +| `olares install` | `olares-cli install [选项]` | 部署 Olares 的系统级和用户级组件。 | +| `olares logs` | `olares-cli logs [选项]` | 收集 Olares 系统组件的日志，用于调试和故障排查。 | +| `olares precheck` | `olares-cli precheck [选项]` | 检查系统环境是否满足 Olares 安装要求。 | +| `olares prepare` | `olares-cli prepare [选项]` | 为安装过程准备环境，包括设置 Olares 的基础服务和配置 | +| `olares release` | `olares-cli release [选项]` | 打包 Olares 安装资源以供分发或部署。 | +| `olares start` | `olares-cli start [选项]` | 启动 Olares 服务和组件。 | +| `olares stop` | `olares-cli stop [选项]` | 停止 Olares 服务和组件。 | +| `olares uninstall` | `olares-cli uninstall [选项]` | 完全卸载 Olares，或将安装回滚到特定阶段。 | diff --git a/docs/zh/developer/install/cli/olares-download.md b/docs/zh/developer/install/cli/olares-download.md index 682fc15c..9e54d446 100644 --- a/docs/zh/developer/install/cli/olares-download.md +++ b/docs/zh/developer/install/cli/olares-download.md @@ -4,43 +4,42 @@ `olares download` 命令用于下载在本地机器上安装 Olares 所需的软件包和组件。它支持下载组件、检查安装包状态以及获取配置清单文件。 ```bash -olares-cli olares download <子命令> [选项] +olares-cli download <子命令> [选项] ``` ## 子命令 | 名称 | 简写 | 用途 | 示例 | |-------------|-----|------------------|----------------------------------------| -| `check` | | 检查 Olares 安装包的状态 | `olares-cli olares download check` | -| `component` | `c` | 下载 Olares 组件 | `olares-cli olares download component` | -| `wizard` | `w` | 下载配置清单文件 | `olares-cli olares download wizard` | +| `check` | | 检查 Olares 安装包的状态 | `olares-cli download check` | +| `component` | `c` | 下载 Olares 组件 | `olares-cli download component` | +| `wizard` | `w` | 下载配置清单文件 | `olares-cli download wizard` | ## 选项 - -| 名称 | 简写 | 用途 | -|----------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 设置 Olares 的基础目录。
默认为 `$HOME/.olares`。 | -| `--download-cdn-url` | | 设置 CDN 加速下载地址，格式为 `https://example.cdn.com`。
如不指定则使用默认地址。 | -| `--help` | `-h` | 显示帮助信息。 | -| `--kube` | | 指定 Kubernetes 类型。版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|----------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------| +| `--base-dir` | `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares`| +| `--download-cdn-url` | | 设置 CDN 加速下载地址，格式为 `https://example.cdn.com`。 | 否 | 默认地址 | +| `--help` | `-h` | 显示帮助信息。 | 否 | 无 | +| `--kube` | | 指定 Kubernetes 类型。
支持 `k3s` 和 `k8s`。 | 否 | `k3s` | +| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | 否 | 当前安装版本 | ## 使用示例 ```bash # 指定存储所有下载组件的基础目录 -olares-cli olares download component -b /custom/path +olares-cli download component -b /custom/path # 指定用于下载 Olares 组件的 CDN 加速地址 -olares-cli olares download component --download-cdn-url https://my.cdn.com +olares-cli download component --download-cdn-url https://my.cdn.com # 指定安装的 Kubernetes 类型 -olares-cli olares download component --kube k8s +olares-cli download component --kube k8s # 设置配置清单文件的路径 -olares-cli olares download component --manifest /custom/path/manifest.json +olares-cli download component --manifest /custom/path/manifest.json # 指定要下载的 Olares 软件包和组件版本 -olares-cli olares download component -v 1.11.0 +olares-cli download component -v 1.11.0 ``` diff --git a/docs/zh/developer/install/cli/olares-info.md b/docs/zh/developer/install/cli/olares-info.md index 9ced1ded..78d8d1ac 100644 --- a/docs/zh/developer/install/cli/olares-info.md +++ b/docs/zh/developer/install/cli/olares-info.md @@ -4,11 +4,11 @@ `olares info` 命令用于显示当前安装的 Olares 版本信息。 ```bash -olares-cli olares info +olares-cli info ``` ## 参数标记 -| 名称 | 简写 | 用途 | -|----------|------|------------| -| `--help` | `-h` | 显示命令的帮助信息。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|----------|------|------------------|----------|--------| +| `--help` | `-h` | 显示命令的帮助信息。 | 否 | 无 | \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-install.md b/docs/zh/developer/install/cli/olares-install.md index 10e7bf4d..ba226269 100644 --- a/docs/zh/developer/install/cli/olares-install.md +++ b/docs/zh/developer/install/cli/olares-install.md @@ -4,16 +4,15 @@ `olares install` 命令用于在系统上安装 Olares。通过各种选项可以自定义安装过程，比如指定安装目录、Kubernetes 类型或 Minikube 配置文件等。 ```bash -olares-cli olares install [选项] +olares-cli install [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|--------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 设置 Olares 的基础目录。
默认为 `$HOME/.olares`。 | -| `--help` | `-h` | 显示帮助信息。 | -| `--kube` | | 指定 Kubernetes 类型。 默认为 `olares-0`。 | -| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | - +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------| +| `--base-dir`| `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares` | +| `--help` | `-h` | 显示帮助信息。 | 否 | 无 | +| `--kube` | | 指定 Kubernetes 类型。
支持 `k3s` 和 `k8s`。 | 否 | `k3s` | +| `--profile` | `-p` | 设置 Minikube 配置文件名称，仅适用于 macOS。 | 否 | `olares-0` | +| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | 否 | `prepare` 阶段安装的版本 | diff --git a/docs/zh/developer/install/cli/olares-logs.md b/docs/zh/developer/install/cli/olares-logs.md index f6b6e896..d3f8047c 100644 --- a/docs/zh/developer/install/cli/olares-logs.md +++ b/docs/zh/developer/install/cli/olares-logs.md @@ -14,28 +14,28 @@ * Kubernetes 节点信息 ```bash -olares-cli olares logs [选项] +olares-cli logs [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------| -| `--components` | | 指定要收集日志的组件（用逗号分隔）。
支持的组件：`k3s`、`containerd`、`olaresd`、`kubelet`、`juicefs`、`redis`、`minio`、`etcd`、`NetworkManager`。
默认收集所有可检测到的组件日志。 | -| `--help` | `-h` | 显示命令帮助信息。 | -| `--ignore-kube-errors` | | 忽略 `kubectl` 命令的错误（例如无法连接 Kubernetes API）并继续收集其他日志。
默认值：`false`。 | -| `--max-lines` | | 限制每个组件日志的最大行数，避免日志文件过大。
默认值为 `3000` 行。 | -| `--output-dir` | | 设置日志保存目录。如果目录不存在则自动创建。
默认保存到 `./olares-logs`。 | -| `--since` | | 设置日志收集的时间范围（例如 `5s`、`2m`、`3h`）。
默认收集最近 `7d`（7天）的日志。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------| +| `--components` | | 指定要收集日志的组件（用逗号分隔）。
支持的组件：`k3s`、`containerd`、`olaresd`、`kubelet`、`juicefs`、`redis`、`minio`、`etcd`、`NetworkManager`。 | 否 | 所有可检测到的组件日志 | +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | +| `--ignore-kube-errors` | | 忽略 `kubectl` 命令的错误（例如无法连接 Kubernetes API）并继续收集其他日志。 | 否 | `false` | +| `--max-lines` | | 限制每个组件日志的最大行数，避免日志文件过大。 | 否 | `3000` 行 | +| `--output-dir` | | 设置日志保存目录。如果目录不存在则自动创建。 | 否 | `./olares-logs` | +| `--since` | | 设置日志收集的时间范围（例如 `5s`、`2m`、`3h`）。 | 否 | 最近 `7d`（7天）的日志 | ## 使用示例 ```bash # 使用默认设置收集所有日志 -olares-cli olares logs +olares-cli logs # 收集指定组件的日志 -olares-cli olares logs --components k3s,redis,minio +olares-cli logs --components k3s,redis,minio # 只收集最近 3 小时的日志 -olares-cli olares logs --since 3h +olares-cli logs --since 3h ``` \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-precheck.md b/docs/zh/developer/install/cli/olares-precheck.md index 2e7ac7a4..056fd59d 100644 --- a/docs/zh/developer/install/cli/olares-precheck.md +++ b/docs/zh/developer/install/cli/olares-precheck.md @@ -4,13 +4,13 @@ `olares precheck` 命令用于检查系统环境是否满足安装 Olares 的所有前置条件。 ```bash -olares-cli olares precheck [选项] +olares-cli precheck [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|--------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 设置 Olares 的基础目录。
默认为 `$HOME/.olares`。 | -| `--help` | `-h` | 显示帮助信息。 | -| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | \ No newline at end of file +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------| +| `--base-dir`| `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares` | +| `--help` | `-h` | 显示帮助信息。 | 否 | 无 | +| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | 否 | 当前安装版本 | \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-prepare.md b/docs/zh/developer/install/cli/olares-prepare.md index d911d682..51221531 100644 --- a/docs/zh/developer/install/cli/olares-prepare.md +++ b/docs/zh/developer/install/cli/olares-prepare.md @@ -4,23 +4,23 @@ `olares prepare` 命令用于配置 Olares 运行所需的环境，包括安装依赖项、导入容器镜像和启动 Olares 守护进程（`olaresd`）。 ```bash -olares-cli olares prepare [选项] +olares-cli prepare [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|----------------------|------|----------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 设置 Olares 的基础目录。
默认为 `$HOME/.olares`。 | -| `--help` | `-h` | 显示帮助信息。 | -| `--kube` | `-k` | 指定 Kubernetes 类型。支持 `k3s`（默认）和 `k8s`。 | -| `--profile` | `-p` | 设置 Minikube 配置文件名称，仅适用于 macOS。
默认为 `olares-0`。 | -| `--registry-mirrors` | `-r` | 设置 Docker 容器镜像仓库的镜像源。多个镜像源之间使用英文逗号分隔。 | -| `--with-juicefs` | `-j` | 将 JuiceFS 配置为 Olares 工作负载的根文件系统（rootfs），替代本地磁盘。 | -| `--version` | `-v` | 指定 Olares 版本。版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/olares/releases)。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|----------------------|------|------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------| +| `--base-dir` | `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares` | +| `--help` | `-h` | 显示帮助信息。 | 否 | 无 | +| `--kube` | `-k` | 指定 Kubernetes 类型。支持 `k3s` 和 `k8s`。 | 否 | `k3s` | +| `--profile` | `-p` | 设置 Minikube 配置文件名称，仅适用于 macOS。 | 否 | `olares-0` | +| `--registry-mirrors` | `-r` | 设置 Docker 容器镜像仓库的镜像源。多个镜像源之间使用英文逗号分隔。 | 否 | 无 | +| `--with-juicefs` | `-j` | 将 JuiceFS 配置为 Olares 工作负载的根文件系统（rootfs），替代本地磁盘。 | 否 | 无 | +| `--version` | `-v` | 指定 Olares 版本。版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/olares/releases)。 | 否 | 当前安装版本 | ## 使用示例 ```bash # 使用 JuiceFS 作为根文件系统 -olares-cli olares prepare --with-juicefs=true +olares-cli prepare --with-juicefs=true ``` \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-release.md b/docs/zh/developer/install/cli/olares-release.md index 9d958afa..74a2cfc6 100644 --- a/docs/zh/developer/install/cli/olares-release.md +++ b/docs/zh/developer/install/cli/olares-release.md @@ -4,17 +4,16 @@ 基于本地 Olares 代码仓库构建发布版本。此命令需要在 Olares 代码仓库的根目录下运行。 ```bash -olares-cli olares release [选项] +olares-cli release [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|----------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| `--base-dir` | `-b` | 设置 Olares 的基础目录。
默认为 `$HOME/.olares`。 | -| `--download-cdn-url` | | 设置用于下载依赖项和镜像校验和的 CDN URL。
默认为 `https://dc3p1870nn3cj.cloudfront.net`。 | -| `--extract` | `-e` | 构建完成后是否将发布包解压到 `--base-dir` 目录下。
如果只需要发布包文件本身，可设为 `false`。
默认为 `true`。 | -| `--help` | `-h` | 显示帮助信息。 | -| `---ignore-missing-images` | | 从 CDN 下载校验和时是否忽略缺失的镜像。
仅当确定没有新增镜像时才建议禁用此选项，因为新镜像可能尚未上传到 CDN 导致构建失败。
默认为 `true`。 | -| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | - +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-----------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------------------------------| +| `--base-dir` | `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares` | +| `--download-cdn-url` | | 设置用于下载依赖项和镜像校验和的 CDN URL。 | 否 | `https://dc3p1870nn3cj.cloudfront.net` | +| `--extract` | `-e` | 构建完成后是否将发布包解压到 `--base-dir` 目录下。
如果只需要发布包文件本身，可设为 `false`。 | 否 | `true` | +| `--help` | `-h` | 显示帮助信息。 | 否 | 无 | +| `--ignore-missing-images` | | 从 CDN 下载校验和时是否忽略缺失的镜像。
仅当确定没有新增镜像时才建议禁用此选项，因为新镜像可能尚未上传到 CDN 导致构建失败。 | 否 | `true` | +| `--version` | `-v` | 指定 Olares 版本。
版本号格式为 `x.y.z`（如 `1.10.0`）或包含构建日期（如 `1.10.0-20241109`）。
可用版本请参考 [GitHub Releases](https://github.com/beclab/Olares/releases)。 | 否 | 当前安装版本 | \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-start.md b/docs/zh/developer/install/cli/olares-start.md index dfbfabdf..e3a62d43 100644 --- a/docs/zh/developer/install/cli/olares-start.md +++ b/docs/zh/developer/install/cli/olares-start.md @@ -3,11 +3,11 @@ ## 命令说明 `olares start` 命令用于启动已停止的 Olares 系统，包括其所有组件和服务。 ```bash -olares-cli olares start [选项] +olares-cli start [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|----------|------|-----------| -| `--help` | `-h` | 显示命令帮助信息。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|----------|------|----------------|----------|--------| +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-stop.md b/docs/zh/developer/install/cli/olares-stop.md index fcff7959..9d6117bd 100644 --- a/docs/zh/developer/install/cli/olares-stop.md +++ b/docs/zh/developer/install/cli/olares-stop.md @@ -4,25 +4,25 @@ `olares stop` 命令用于停止已安装（或部分安装）的 Olares 系统中的各个组件。 ```bash -olares-cli olares stop [选项] +olares-cli stop [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|--------------------|------|--------------------------------------------------------------------| -| `--check-interval` | | 设置关闭过程中检查剩余进程的时间间隔（如 `5s`、`2m`、`3h`）。
默认值：`10s`。 | -| `--help` | `-h` | 显示命令帮助信息。 | -| `--timeout` | | 设置等待优雅关闭的最长时间，超时后将使用 SIGKILL 强制终止（如 `5s`、`2m`、`3h`）。
默认值：`1m`。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|--------------------|------|------------------------------------------------------------------------------|----------|----------| +| `--check-interval` | | 设置关闭过程中检查剩余进程的时间间隔（如 `5s`、`2m`、`3h`）。 | 否 | `10s` | +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | +| `--timeout` | | 设置等待优雅关闭的最长时间，超时后将使用 SIGKILL 强制终止（如 `5s`、`2m`、`3h`）。 | 否 | `1m` | ## 使用示例 ```bash # 停止 Olares 系统 -olares-cli olares stop +olares-cli stop # 调整关闭超时时间 -olares-cli olares stop --timeout 2m +olares-cli stop --timeout 2m # 自定义检查间隔时间 -olares-cli olares stop --check-interval 5s +olares-cli stop --check-interval 5s ``` \ No newline at end of file diff --git a/docs/zh/developer/install/cli/olares-uninstall.md b/docs/zh/developer/install/cli/olares-uninstall.md index 1c67f6d9..b3b86d32 100644 --- a/docs/zh/developer/install/cli/olares-uninstall.md +++ b/docs/zh/developer/install/cli/olares-uninstall.md @@ -4,16 +4,16 @@ 卸载 Olares。 ```bash -olares-cli olares uninstall [选项] +olares-cli uninstall [选项] ``` ## 选项 -| 名称 | 简写 | 用途 | -|--------------|------|--------------------------------------------------------------------------------------------------------| -| `--all` | | 完全卸载 Olares，包括在“准备”阶段安装的所有依赖项。 | -| `--base-dir` | `-b` | 设置 Olares 的基础目录。
默认为 `$HOME/.olares`。 | -| `--help` | `-h` | 显示帮助信息。 | -| `--phase` | | 从指定阶段卸载 Olares 并回退到前一个阶段。
例如，使用 `--phase install` 将移除“安装”阶段执行的任务，使系统回退到“准备”阶段。
默认为 `install`。 | -| `--quiet` | | 启用静默模式（不显示输出信息）。
默认为 `false`。 | -| `--version` | `-v` | 指定要卸载的 Olares 版本。
建议先使用 `olares-cli olares info` 命令查看已下载的版本。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------|------|---------------------------------------------------------------------------------------------------------------------------------------|----------|----------------| +| `--all` | | 完全卸载 Olares，包括在“准备”阶段安装的所有依赖项。 | 否 | 无 | +| `--base-dir`| `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares` | +| `--help` | `-h` | 显示帮助信息。 | 否 | 无 | +| `--phase` | | 从指定阶段卸载 Olares 并回退到前一个阶段。
例如，使用 `--phase install` 将移除“安装”阶段执行的任务，使系统回退到“准备”阶段。 | 否 | `install` | +| `--quiet` | | 启用静默模式（不显示输出信息）。 | 否 | `false` | +| `--version` | `-v` | 指定要卸载的 Olares 版本。
建议先使用 `olares-cli info` 命令查看已下载的版本。 | 否 | 当前安装版本 | \ No newline at end of file diff --git a/docs/zh/developer/install/cli/info.md b/docs/zh/developer/install/cli/osinfo.md similarity index 57% rename from docs/zh/developer/install/cli/info.md rename to docs/zh/developer/install/cli/osinfo.md index 7492e552..fd9f2c17 100644 --- a/docs/zh/developer/install/cli/info.md +++ b/docs/zh/developer/install/cli/osinfo.md @@ -1,11 +1,11 @@ -# `info` +# `osinfo` ## 命令说明 `info` 命令用于获取当前设备操作系统的详细信息。它能够检索并显示元数据信息，包括 `OS_TYPE`、`OS_PLATFORM`、`OS_ARCH`、`OS_VERSION`、`OS_KERNEL` 和 `OS_INFO` 等。 ```bash -olares-cli info <子命令> [选项] +olares-cli osinfo <子命令> [选项] ``` ## 子命令 @@ -14,8 +14,8 @@ olares-cli info <子命令> [选项] |--------|---------------| | `show` | 显示当前设备的操作系统信息 | -## 参数标记 +## 选项 -| 名称 | 简写 | 用途 | -|----------|------|------------| -| `--help` | `-h` | 显示命令的帮助信息。 | \ No newline at end of file +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|----------|------|------------------|----------|--------| +| `--help` | `-h` | 显示命令的帮助信息。 | 否 | 无 | \ No newline at end of file diff --git a/docs/zh/developer/install/cli/region.md b/docs/zh/developer/install/cli/region.md index f1304a02..d46557d3 100644 --- a/docs/zh/developer/install/cli/region.md +++ b/docs/zh/developer/install/cli/region.md @@ -3,7 +3,7 @@ ## 命令说明 `region` 子命令用于获取云名称和区域 ID。该命令专门用于存储后端为 Olares Space 的场景。 ```bash -olares-cli olares backups region space [选项] +olares-cli backups region space [选项] ``` ## 选项 @@ -20,7 +20,7 @@ olares-cli olares backups region space [选项] ## 使用示例 ```bash # 查询云名称和区域 ID -olares-cli olares backups region space \ +olares-cli backups region space \ --access-token YOUR_ACCESS_TOKEN \ --cloud-api-mirror https://api-mirror.example.com \ --olares-did did:xyz123 diff --git a/docs/zh/developer/install/cli/restore.md b/docs/zh/developer/install/cli/restore.md index 192e59d6..fbe5a033 100644 --- a/docs/zh/developer/install/cli/restore.md +++ b/docs/zh/developer/install/cli/restore.md @@ -3,64 +3,63 @@ outline: [2, 3] --- # `olares backups restore` :::warning -必须先运行 `olares-cli olares backups download` 命令来安装 Restic，否则直接运行此命令将返回错误。 +必须先运行 `olares-cli backups download` 命令来安装 Restic，否则直接运行此命令将返回错误。 ::: ## 命令说明 `restore` 子命令用于从指定的备份仓库和快照中恢复数据到目标目录。 ```bash -olares-cli olares backups restore <存储后端> --path <恢复路径> --repo-name <仓库名称> --snapshot-id <快照ID> [选项] +olares-cli backups restore <存储后端> --path <恢复路径> --repo-name <仓库名称> --snapshot-id <快照ID> [选项] ``` ## 通用选项 以下选项适用于所有后端： -| 名称 | 简写 | 用途 | -|-----------------|------|-----------------| -| `--help` | `-h` | 显示命令帮助信息。 | -| `--path` | | 设置数据恢复的目标目录路径。 | -| `--repo-name` | | 设置要恢复数据的备份仓库名称。 | -| `--snapshot-id` | | 设置要恢复的快照 ID。 | - +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-----------------|------|------------------------|----------|--------| +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | +| `--path` | | 设置数据恢复的目标目录路径。 | 否 | 无 | +| `--repo-name` | | 设置要恢复数据的备份仓库名称。 | 否 | 无 | +| `--snapshot-id` | | 设置要恢复的快照 ID。 | 否 | 无 | ## 存储后端配置选项 ### 腾讯云对象存储（`cos`）选项 -| 名称 | 简写 | 用途 | -|-------------------------|----|----------------------------------------------------------------------------| -| `--access-key` | | 设置腾讯云 COS 的访问密钥。 | -| `--endpoint` | | 设置腾讯云 COS 的终端节点，格式如：`https://cos.{region}.myqcloud.com/{bucket}/{prefix}`。 | -| `--limit-download-rate` | | 设置下载速度的最大值，单位为 KiB/s（默认不限速）。 | -| `--secret-access-key` | | 设置腾讯云 COS 的密钥。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------------------|----|------------------------------------------------------------------------------|----------|----------| +| `--access-key` | | 设置腾讯云 COS 的访问密钥。 | 否 | 无 | +| `--endpoint` | | 设置腾讯云 COS 的终端节点，格式如：`https://cos.{region}.myqcloud.com/{bucket}/{prefix}`。 | 否 | 无 | +| `--limit-download-rate` | | 设置下载速度的最大值，单位为 KiB/s。 | 否 | 不限速 | +| `--secret-access-key` | | 设置腾讯云 COS 的密钥。 | 否 | 无 | ### 本地文件系统（`fs`）选项 -| 名称 | 简写 | 用途 | -|---------------|----|----------------| -| `--endpoint` | | 设置存储备份的本地目录路径。 | -| `--olares-id` | | 设置 Olares ID。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|---------------|----|----------------------|----------|--------| +| `--endpoint` | | 设置存储备份的本地目录路径。 | 否 | 无 | +| `--olares-id` | | 设置 Olares ID。 | 否 | 无 | ### Amazon S3 选项（`s3`） -| 名称 | 简写 | 用途 | -|-------------------------|----|----------------------------------------------------------------------------| -| `--access-key` | | 设置 Amazon S3 的访问密钥。 | -| `--endpoint` | | 设置 Amazon S3 的终端节点，格式如：`https://{bucket}.{region}.amazonaws.com/{prefix}`。 | -| `--limit-download-rate` | | 设置下载速度的最大值，单位为 KiB/s（默认不限速）。 | -| `--secret-access-key` | | 设置 Amazon S3 的密钥。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------------------|----|------------------------------------------------------------------------------|----------|----------| +| `--access-key` | | 设置 Amazon S3 的访问密钥。 | 否 | 无 | +| `--endpoint` | | 设置 Amazon S3 的终端节点，格式如：`https://{bucket}.{region}.amazonaws.com/{prefix}`。 | 否 | 无 | +| `--limit-download-rate` | | 设置下载速度的最大值，单位为 KiB/s。 | 否 | 不限速 | +| `--secret-access-key` | | 设置 Amazon S3 的密钥。 | 否 | 无 | ### Olares Space 选项（`space`） -| 名称 | 简写 | 用途 | -|-------------------------------|----|-----------------------------------------------------------------| -| `--access-token` 1 | | 设置 Olares Space 的访问令牌。 | -| `--cloud-api-mirror` | | 设置云 API 镜像地址。 | -| `--cloud-name` | | 设置 Olares Space 实例的云名称。
可通过 [`region`](region.md) 子命令获取。 | -| `--cluster-id` 2 | | 设置用于存储备份的集群 ID。 | -| `--limit-download-rate` | | 设置下载速度的最大值，单位为 KiB/s（默认不限速）。 | -| `--olares-did` 1 | | 设置 Olares DID。 | -| `--region-id` | | 设置 Olares Space 实例的区域 ID。
可通过 [`region`](region.md) 子命令获取。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------------------------|----|---------------------------------------------------------------------|----------|----------| +| `--access-token` 1 | | 设置 Olares Space 的访问令牌。 | 否 | 无 | +| `--cloud-api-mirror` | | 设置云 API 镜像地址。 | 否 | 无 | +| `--cloud-name` | | 设置 Olares Space 实例的云名称。
可通过 [`region`](region.md) 子命令获取。 | 否 | 无 | +| `--cluster-id` 2 | | 设置用于存储备份的集群 ID。 | 否 | 无 | +| `--limit-download-rate` | | 设置下载速度的最大值，单位为 KiB/s。 | 否 | 不限速 | +| `--olares-did` 1 | | 设置 Olares DID。 | 否 | 无 | +| `--region-id` | | 设置 Olares Space 实例的区域 ID。
可通过 [`region`](region.md) 子命令获取。 | 否 | 无 | 1. 要获取访问令牌和 Olares DID，请在登录 Olares Space 后检查页面网络请求的负载。`token` 字段对应访问令牌，`userid` 字段对应 Olares DID。 @@ -71,13 +70,13 @@ olares-cli olares backups restore <存储后端> --path <恢复路径> --repo-na ## 使用示例 ```bash # 从腾讯云对象存储恢复数据 -olares-cli olares backups restore cos --path /data_restore --repo-name my_repo \ +olares-cli backups restore cos --path /data_restore --repo-name my_repo \ --snapshot-id snapshot_12345 \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://cos.region.myqcloud.com/bucket/prefix # 从本地文件系统恢复数据 -olares-cli olares backups restore fs --path /data_restore --repo-name my_repo \ +olares-cli backups restore fs --path /data_restore --repo-name my_repo \ --snapshot-id snapshot_12345 --endpoint /backup_repo ``` \ No newline at end of file diff --git a/docs/zh/developer/install/cli/snapshots.md b/docs/zh/developer/install/cli/snapshots.md index c88eb661..17e0ccbb 100644 --- a/docs/zh/developer/install/cli/snapshots.md +++ b/docs/zh/developer/install/cli/snapshots.md @@ -3,55 +3,55 @@ outline: [2, 3] --- # `olares backups snapshots` :::warning -必须先运行 `olares-cli olares backups download` 命令来安装 Restic，否则直接运行此命令将返回错误。 +必须先运行 `olares-cli backups download` 命令来安装 Restic，否则直接运行此命令将返回错误。 ::: ## 命令说明 `snapshots` 子命令用于列出指定备份仓库中的所有可用快照。它支持多种存储后端，并提供必要的选项来进行身份验证和查询快照。 ```bash -olares-cli olares backups snapshots <存储后端> --repo-name <仓库名称> [选项] +olares-cli backups snapshots <存储后端> --repo-name <仓库名称> [选项] ``` ## 通用选项 以下选项适用于所有后端： -| 名称 | 简写 | 用途 | -|---------------|------|---------------| -| `--help` | `-h` | 显示命令帮助信息。 | -| `--repo-name` | | 设置要查询的备份仓库名称。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|---------------|------|----------------------|----------|--------| +| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 | +| `--repo-name` | | 设置要查询的备份仓库名称。 | 否 | 无 | ## 存储后端配置选项 ### 腾讯云对象存储（`cos`）选项 -| 名称 | 简写 | 用途 | -|-----------------------|----|----------------------------------------------------------------------------| -| `--access-key` | | 设置腾讯云 COS 的访问密钥。 | -| `--endpoint` | | 设置腾讯云 COS 的终端节点，格式如：`https://cos.{region}.myqcloud.com/{bucket}/{prefix}`。 | -| `--secret-access-key` | | 设置腾讯云 COS 的密钥。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|---------------------|----|------------------------------------------------------------------------------|----------|--------| +| `--access-key` | | 设置腾讯云 COS 的访问密钥。 | 否 | 无 | +| `--endpoint` | | 设置腾讯云 COS 的终端节点，格式如：`https://cos.{region}.myqcloud.com/{bucket}/{prefix}`。 | 否 | 无 | +| `--secret-access-key` | | 设置腾讯云 COS 的密钥。 | 否 | 无 | | ### 本地文件系统（`fs`）选项 -| 名称 | 简写 | 用途 | -|--------------|----|----------------| -| `--endpoint` | | 设置存储备份的本地目录路径。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|--------------|----|----------------------|----------|--------| +| `--endpoint` | | 设置存储备份的本地目录路径。 | 否 | 无 | ### Amazon S3 选项（`s3`） -| 名称 | 简写 | 用途 | -|-----------------------|----|----------------------------------------------------------------------------| -| `--access-key` | | 设置 Amazon S3 的访问密钥。 | -| `--endpoint` | | 设置 Amazon S3 的终端节点，格式如：`https://{bucket}.{region}.amazonaws.com/{prefix}`。 | -| `--secret-access-key` | | 设置 Amazon S3 的密钥。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|---------------------|----|------------------------------------------------------------------------------|----------|--------| +| `--access-key` | | 设置 Amazon S3 的访问密钥。 | 否 | 无 | +| `--endpoint` | | 设置 Amazon S3 的终端节点，格式如：`https://{bucket}.{region}.amazonaws.com/{prefix}`。 | 否 | 无 | +| `--secret-access-key` | | 设置 Amazon S3 的密钥。 | 否 | 无 | ### Olares Space 选项（`space`） -| 名称 | 简写 | 用途 | -|-------------------------------|----|-----------------------------------------------------------------| -| `--access-token` 1 | | 设置 Olares Space 的访问令牌。 | -| `--cloud-api-mirror` | | 设置云 API 镜像地址。 | -| `--cloud-name` | | 设置 Olares Space 实例的云名称。
可通过 [`region`](region.md) 子命令获取。 | -| `--cluster-id` 2 | | 设置用于存储备份的集群 ID。 | -| `--olares-did` 1 | | 设置 Olares DID。 | -| `--region-id` | | 设置 Olares Space 实例的区域 ID。
可通过 [`region`](region.md) 子命令获取。 | +| 选项 | 简写 | 用途 | 是否必需 | 默认值 | +|-------------------------------|----|---------------------------------------------------------------------|----------|--------| +| `--access-token` 1 | | 设置 Olares Space 的访问令牌。 | 否 | 无 | +| `--cloud-api-mirror` | | 设置云 API 镜像地址。 | 否 | 无 | +| `--cloud-name` | | 设置 Olares Space 实例的云名称。
可通过 [`region`](region.md) 子命令获取。 | 否 | 无 | +| `--cluster-id` 2 | | 设置用于存储备份的集群 ID。 | 否 | 无 | +| `--olares-did` 1 | | 设置 Olares DID。 | 否 | 无 | +| `--region-id` | | 设置 Olares Space 实例的区域 ID。
可通过 [`region`](region.md) 子命令获取。 | 否 | 无 | 1. 要获取访问令牌和 Olares DID，请在登录 Olares Space 后检查页面网络请求的负载。`token` 字段对应访问令牌，`userid` 字段对应 Olares DID。 @@ -62,11 +62,11 @@ olares-cli olares backups snapshots <存储后端> --repo-name <仓库名称> [ ## 使用示例 ```bash # 列出腾讯云对象存储中的快照 -olares-cli olares backups snapshots cos --repo-name my_repo \ +olares-cli backups snapshots cos --repo-name my_repo \ --access-key YOUR_KEY \ --secret-access-key YOUR_SECRET \ --endpoint https://cos.region.myqcloud.com/bucket/prefix # 列出本地文件系统中的快照 -olares-cli olares backups snapshots fs --repo-name my_repo --endpoint /backup_repo +olares-cli backups snapshots fs --repo-name my_repo --endpoint /backup_repo ``` \ No newline at end of file diff --git a/docs/zh/developer/install/installation-process.md b/docs/zh/developer/install/installation-process.md index 28a63233..ac745e2d 100644 --- a/docs/zh/developer/install/installation-process.md +++ b/docs/zh/developer/install/installation-process.md @@ -15,7 +15,7 @@ Olares 的安装可分为以下四个阶段： ## 预检阶段 -预检阶段的重点是验证系统是否满足安装 Olares 的必要条件。通过运行 `olares-cli olares precheck` 命令执行一系列验证检查。若在此阶段发现任何问题，需在继续安装前解决。 +预检阶段的重点是验证系统是否满足安装 Olares 的必要条件。通过运行 `olares-cli precheck` 命令执行一系列验证检查。若在此阶段发现任何问题，需在继续安装前解决。 关键预检项目包括： - 检查操作系统类型、版本号以及处理器架构是否兼容 diff --git a/docs/zh/developer/install/olares-home.md b/docs/zh/developer/install/olares-home.md index 16140bfc..a944b5b0 100644 --- a/docs/zh/developer/install/olares-home.md +++ b/docs/zh/developer/install/olares-home.md @@ -11,7 +11,7 @@ Olares Home 是 Olares 的默认安装目录，用于存储镜像、日志、依 ```bash # 指定所有下载组件的存储目录 -olares-cli olares download component --base-dir /custom/path +olares-cli download component --base-dir /custom/path ``` ## 目录结构 diff --git a/docs/zh/developer/install/reusables.md b/docs/zh/developer/install/reusables.md index eb588975..958b05db 100644 --- a/docs/zh/developer/install/reusables.md +++ b/docs/zh/developer/install/reusables.md @@ -12,7 +12,7 @@ curl -fsSL https://cn.olares.sh | bash - 如果安装过程中出现错误，请先执行以下命令卸载： ```bash -bash olares-uninstall.sh +bash olares-cli uninstall --all ``` 卸载完成后，重新运行安装命令进行安装。 ::: diff --git a/docs/zh/manual/get-started/reusables.md b/docs/zh/manual/get-started/reusables.md index 9e55c135..7923b3b1 100644 --- a/docs/zh/manual/get-started/reusables.md +++ b/docs/zh/manual/get-started/reusables.md @@ -12,7 +12,7 @@ curl -fsSL https://cn.olares.sh | bash - 如果安装过程中出现错误，请先执行以下命令卸载： ```bash -bash olares-uninstall.sh +bash olares-cli uninstall --all ``` 卸载完成后，重新运行安装命令进行安装。 ::: diff --git a/docs/zh/manual/tutorials/install-olares-multi-node.md b/docs/zh/manual/tutorials/install-olares-multi-node.md index debcf640..f255a3ca 100644 --- a/docs/zh/manual/tutorials/install-olares-multi-node.md +++ b/docs/zh/manual/tutorials/install-olares-multi-node.md @@ -29,7 +29,7 @@ description: Olares 多节点集群部署教程，包括主节点配置、工作 ## 第一步：设置主节点 ::: tip 卸载已有的 Olares 集群 -如果你已经使用默认的安装命令在当前节点上安装了 Olares 集群，运行 `bash olares-uninstall.sh` 命令将其卸载。 +如果你已经使用默认的安装命令在当前节点上安装了 Olares 集群，运行 `bash olares-cli uninstall --all` 命令将其卸载。 ::: 在主节点上运行以下命令以启用 JuiceFS 支持：