From 3da30cebd65181804d0cb7b0515ff8b1fd307e52 Mon Sep 17 00:00:00 2001 From: wangyajing <413741312@qq.com> Date: Wed, 8 Jan 2025 14:10:15 +0800 Subject: [PATCH 01/13] refine developer docs --- docs/.vitepress/en.ts | 58 ++- docs/developer/develop/index.md | 2 +- docs/developer/install/cli/olares-cli.md | 9 +- .../install/environment-variables.md | 360 ++++++++---------- docs/developer/install/index.md | 10 +- .../install/installation-overview.md | 94 ++--- .../developer/install/installation-process.md | 191 ++++++---- docs/developer/install/olares-home.md | 27 +- .../install/environment-variables.md | 84 ++-- .../install/installation-overview.md | 35 +- .../developer/install/installation-process.md | 28 +- docs/zh/developer/install/olares-home.md | 32 +- 12 files changed, 439 insertions(+), 491 deletions(-) diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index 6edcf2bb..c95956f9 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -328,21 +328,22 @@ const side = { "/developer/": [ { - text: "Installing Olares", + text: "Olares installation", link: "/developer/install/", items: [ { text: "Installation overview", link: "/developer/install/installation-overview", + collapsed: true, }, - { - text: "Installation process", - link: "/developer/install/installation-process", - }, - { - text: "Olares Home", - link: "/developer/install/olares-home", - }, + { + text: "Installation breakdown", + link: "/developer/install/installation-process", + }, + { + text: "Olares Home", + link: "/developer/install/olares-home", + }, { text: "Environment variables", link: "/developer/install/environment-variables", @@ -376,12 +377,9 @@ const side = { ], }, { - text: "Developing Olares App", + text: "Develop Olares app", + link: "/developer/develop/", items: [ - { - text: "Overview", - link: "/developer/develop/", - }, { text: "Tutorial", collapsed: true, @@ -392,20 +390,20 @@ const side = { link: "/developer/develop/tutorial/devbox", }, { - text: "Create Your First Apps", + text: "Create your first app", collapsed: true, link: "/developer/develop/tutorial/note/", items: [ { - text: "1. Create App", + text: "1. Create app", link: "/developer/develop/tutorial/note/create", }, { - text: "2. Develop Backend", + text: "2. Develop backend", link: "/developer/develop/tutorial/note/backend", }, { - text: "3. Develop Frontend", + text: "3. Develop frontend", link: "/developer/develop/tutorial/note/frontend", }, ], @@ -413,11 +411,11 @@ const side = { ], }, { - text: "Application Package", + text: "Application package", collapsed: true, items: [ { - text: "Application Chart", + text: "Application chart", link: "/developer/develop/package/chart", }, { @@ -429,11 +427,11 @@ const side = { link: "/developer/develop/package/model", }, { - text: "Recommend", + text: "Recommendation", link: "/developer/develop/package/recommend", }, { - text: "Helm Extension", + text: "Helm extension", link: "/developer/develop/package/extension", }, ], @@ -447,7 +445,7 @@ const side = { link: "/developer/develop/advanced/terminus-info", }, { - text: "Service Provider", + text: "Service provider", link: "/developer/develop/advanced/provider", }, { @@ -473,7 +471,7 @@ const side = { link: "/developer/develop/advanced/websocket", }, { - text: "File Upload", + text: "File upload", link: "/developer/develop/advanced/file-upload", }, // { @@ -500,21 +498,17 @@ const side = { }, { - text: "Submit Application", + text: "Submit application", collapsed: true, link: "/developer/develop/submit/", }, ], }, { - text: "Contributing To Olares", + text: "Contribute to Olares", items: [ { - text: "Olares", - link: "/developer/contribute/olares", - }, - { - text: "Develop System App", + text: "Develop system app", collapsed: true, items: [ @@ -553,7 +547,7 @@ export const en = defineConfig({ nav: [ { text: "Manual", link: "/manual/docs-home" }, - { text: "Developer", link: "/developer/develop/" }, + { text: "Developer Guide", link: "/developer/install/" }, ], sidebar: side, diff --git a/docs/developer/develop/index.md b/docs/developer/develop/index.md index 161c5861..a72ee2d2 100644 --- a/docs/developer/develop/index.md +++ b/docs/developer/develop/index.md @@ -1,4 +1,4 @@ -# Overview +# Develop Olares application Developing applications on Olares is not much different from regular website development. Once you learn a few basic Olares concepts, you can start creating applications on his platform. diff --git a/docs/developer/install/cli/olares-cli.md b/docs/developer/install/cli/olares-cli.md index a5136ebf..ee784cdc 100644 --- a/docs/developer/install/cli/olares-cli.md +++ b/docs/developer/install/cli/olares-cli.md @@ -7,10 +7,11 @@ Olares provides Olares CLI, a command-line tool for developers and system admini The recommended [one-liner installation command](../../../manual/get-started/install-olares.md) retrieves a shell script from https://olares.sh/ that downloads and installs Olares CLI. Once installed, the CLI orchestrates the remainder of the setup. -In general, Olares CLI manages installation through three main phases: -1. **Download**: Olares CLI fetches the necessary components. -2. **Prepare**: Olares CLI prepares the environment for installation. -3. **Install**: Olares CLI installs the core services of Olares. +In general, Olares CLI manages installation through four main phases: +1. **Precheck**: Olares CLI checks the system environment. +2. **Download**: Olares CLI fetches the necessary components. +3. **Prepare**: Olares CLI prepares the environment for installation. +4. **Install**: Olares CLI installs the core services of Olares. This page explains the Olares CLI syntax and describes the command operations. diff --git a/docs/developer/install/environment-variables.md b/docs/developer/install/environment-variables.md index 03aab188..ec36d5ce 100644 --- a/docs/developer/install/environment-variables.md +++ b/docs/developer/install/environment-variables.md @@ -1,22 +1,12 @@ # Olares environment variables -In most scenarios, you can install Olares with a single-line script: +Olares provides a highly customizable installation process through the use of environment variables. These variables can override default settings, enabling advanced configurations to suit your specific requirements. -```bash -curl -sSfL https://olares.sh | bash -``` - -To meet more advanced installation requirements, the Olares installation script also supports a range of environment variables that can override default configurations and behaviors. - -## How to use environment variables - -You can specify these environment variables in several ways: +## Usage examples -::: tip Note -In the examples below, we use `KUBE_TYPE=k8s` to illustrate how to install K8s instead of k3s for Olares. Other environment variables can be used similarly. -::: +To customize the installation process, you can define environment variables in several ways: -- Specify inline while running the installation script: +- Specify the variables inline while running the installation script: ```bash KUBE_TYPE=k8s bash install.sh @@ -29,13 +19,13 @@ In the examples below, we use `KUBE_TYPE=k8s` to illustrate how to install K8s i bash install.sh ``` -- Chain commands with `&&`: +- Use `&&` to chain commands: ```bash export KUBE_TYPE=k8s && bash install.sh ``` -Of course, you can also combine multiple environment variables for more flexible customization, for example: +You can also combine multiple environment variables for more flexible customization, for example: ```bash export KUBE_TYPE=k8s \ @@ -44,206 +34,174 @@ export KUBE_TYPE=k8s \ bash install.sh ``` -## List of environment variables +## Environment variables reference The section lists all the environment variables supported by the installation script, along with their default values, optional values, and descriptions. Configure them as needed. -### KUBE_TYPE -- Specifies the Kubernetes distribution to use. If you need the full version of k8s, set this to `k8s`. Only applies when running `install.sh`. -- **Possible Values**: `k8s` / `k3s` -- **Default Value**: `k3s` - - - -### REGISTRY_MIRRORS -- Sets the Docker registry mirror. Only applies when running `install.sh`. -- **Possible Values**: `https://mirrors.joinolares.cn` or another mirror URL -- **Default Value**: *(None; if not set, defaults to* `https://registry-1.docker.io`) - - - -### PREINSTALL -- When set to `1`, only finishes the preinstall phase (installs system dependencies). If unset or empty, Olares will be installed fully. Only applies when running `install.sh`. -- **Possible Values**: `1` -- **Default Value**: None - - - -### JUICEFS -- When set to `1`, installs [JuiceFS](https://juicefs.com/). By default, it is not installed. Only applies when running `install.sh`. -- **Possible Values**: `1` -- **Default Value**: None - - - -### TERMINUS_OS_DOMAINNAME -- Presets the domain name before installation, skipping the interactive prompt. -- **Possible Values**: Any valid domain name -- **Default Value**: None - - - -### TERMINUS_OS_USERNAME -- Presets the username before installation, skipping the interactive prompt. - **Reserved keywords:** - ``` - user, system, space, default, os, kubesphere, kube, kubekey, kubernetes, - gpu, tapr, bfl, bytetrade, project, pod - ``` -- **Possible Values**: Any valid username (length 2–250; no conflicts with reserved keywords) -- **Default Value**: None - - - -### TERMINUS_OS_EMAIL -- Presets the email address before installation, skipping the interactive prompt. If not set, a temporary email is automatically generated. -- **Possible Values**: Any valid email address -- **Default Value**: Automatically generated email address - - - -### TERMINUS_OS_PASSWORD -- Presets the password before installation, skipping the interactive prompt. -- **Possible Values**: 6–32 characters -- **Default Value**: A randomly 8-digit password - - - -### TERMINUS_IS_CLOUD_VERSION -- Explicitly marks this machine as a cloud instance. -- **Possible Values**: `true` -- **Default Value**: None - - - -### LOCAL_GPU_ENABLE -- Specifies whether to enable GPU and install drivers. -- **Possible Values**: `0` (disable)/ `1`(enable) -- **Default Value**: `0` (disable) - - - -### LOCAL_GPU_SHARE -- Specifies whether to enable GPU sharing. Only available when GPU is already enabled. -- **Possible Values**: `0` (disable)/ `1`(enable) -- **Default Value**: `0` (disable) - - - -### CLOUDFLARE_ENABLE -- Specifies whether to enable the Cloudflare proxy. -- **Possible Values**: `0` (disable)/ `1`(enable) -- **Default Value**: `0` (disable) - - - -### FRP_ENABLE -- Specifies whether to enable FRP for internal network tunneling. If you use a custom FRP server, you must also set `FRP_SERVER`, `FRP_PORT`, and other FRP-related variables. -- **Possible Values**: `0` (disable)/ `1`(enable) -- **Default Value**: `0` (disable) - - - -### FRP_SERVER -- Specifies the FRP server address. -- **Possible Values**: Any valid FRP server address -- **Default Value**: None - - -### FRP_PORT -- Sets the FRP server’s listening port. If not specified (or `0`), it defaults to 7000. -- **Possible Values**: Integer in the range `1–65535` -- **Default Value**: `0` - - - -### FRP_AUTH_METHOD -- Sets the FRP authentication method. If set to `token`, you must also provide `FRP_AUTH_TOKEN`. If left blank, no authentication is used. -- **Possible Values**: `jws` / `token` / (empty) -- **Default Value**: `jws` - - - -### FRP_AUTH_TOKEN -- When `FRP_AUTH_METHOD=token`, specifies the token for server communication. -- **Possible Values**: Any non-empty string -- **Default Value**: None - - - -### TOKEN_MAX_AGE -- Sets the maximum valid duration for the token (in seconds). -- **Possible Values**: Any integer (in seconds) -- **Default Value**: `31536000` (365 days) - - - -### MARKET_PROVIDER -- Specifies the backend domain used by the application marketplace (Market). Choose an appropriate domain for optimal network access. -- **Possible Values**: - - `appstore-server-prod.bttcdn.com` / - - `appstore-china-server-prod.api.jointerminus.cn` -- **Default Value**: `appstore-server-prod.bttcdn.com` - - - -### TERMINUS_CERT_SERVICE_API -- Specifies the endpoint for the Olares HTTPS certificate service. For better connectivity within mainland China, use `https://terminus-cert.api.jointerminus.cn`. -- **Possible Values**: +### `KUBE_TYPE` +Determines the Kubernetes distribution to install. +- **Valid values**: + - `k8s` (full Kubernetes) + - `k3s` (lightweight Kubernetes) +- **Default**: `k3s` +- **Usage**: Only applicable with `install.sh`. + +### `REGISTRY_MIRRORS` +Specifies a custom Docker registry mirror for faster image pulls. +- **Valid values**: `https://mirrors.joinolares.cn` or any other valid URL +- **Default**: `https://registry-1.docker.io` +- **Usage**: Only applicable with `install.sh`. + +### `PREINSTALL` +Runs only the pre-installation phase (system dependency setup) without proceeding with the full Olares installation. +- **Valid values**: `1` +- **Default**: None (full installation is performed if not set). +- **Usage**: Only applicable with `install.sh`. + +### `JUICEFS` +Installs [JuiceFS](https://juicefs.com/) alongside Olares. Should only be used with `install.sh`. +- **Valid values**: `1` +- **Default**: None (JuiceFS is not installed if not set). +- **Usage**: Only applicable with `install.sh`. + +### `TERMINUS_OS_DOMAINNAME` +Sets the domain name before installation and skip the interactive prompt. +- **Valid values**: Any valid domain name +- **Default**: None (prompts for domain name if not set). + +### `TERMINUS_OS_USERNAME` +Sets the username before installation and skip the interactive prompt. + +- **Valid values**: Any valid username (2–250 characters, excluding reserved keywords) +- **Default**: None (prompts for username if not set). +- **Validation**: Reserved keywords are `user`, `system`, `space`, `default`, `os`, `kubesphere`, `kube`, `kubekey`, `kubernetes`, + `gpu`, `tapr`, `bfl`, `bytetrade`, `project`, `pod`. + +### `TERMINUS_OS_EMAIL` +Specifies the email address instead of the generated one. +- **Valid values**: Any valid email address +- **Default**: None (a temporary email is auto-generated if not set). + +### `TERMINUS_OS_PASSWORD` +Specifies the password instead of the generated one. +- **Valid values**: A valid password with 6–32 characters +- **Default**: A randomly 8-digit password + +### `TERMINUS_IS_CLOUD_VERSION` +Marks the machine explicitly as a cloud instance. +- **Valid values**: `true` +- **Default**: None + +### `LOCAL_GPU_ENABLE` +Enables GPU support and installs necessary drivers. +- **Valid values**: + - `0` (disable) + - `1` (enable) +- **Default**: `0` + +### `LOCAL_GPU_SHARE` +Enables GPU sharing (only applicable if GPU is enabled). +- **Valid values**: + - `0` (disable) + - `1` (enable) +- **Default**: `0` + +### `CLOUDFLARE_ENABLE` +Enables the Cloudflare proxy. +- **Valid values**: + - `0` (disable) + - `1` (enable) +- **Default**: `0` + +### `FRP_ENABLE` +Enables FRP for internal network tunneling. Requires additional FRP-related variables if using a custom server. +- **Valid values**: + - `0` (disable) + - `1` (enable) +- **Default**: `0` + +### `FRP_SERVER` +Specifies the FRP server address. +- **Valid values**: Any valid FRP server address +- **Default**: None + +### `FRP_PORT` +Specifies the FRP server's listening port. +- **Valid values**: Integer in the range `1–65535` +- **Default**: `7000` if not set or set to `0`. + +### `FRP_AUTH_METHOD` +- Sets the FRP authentication method. +- **Valid values**: + - `jws` + - `token` (requires `FRP_AUTH_TOKEN`) + - (empty) – No authentication +- **Default**: `jws`. + +### `FRP_AUTH_TOKEN` +Specifies the token for FRP communication (required if `FRP_AUTH_METHOD=token`). +- **Valid values**: Any non-empty string +- **Default**: None + +### `TOKEN_MAX_AGE` +Sets the maximum duration for a token's validity (in seconds). +- **Valid values**: Any integer (in seconds) +- **Default**: `31536000` (365 days) + +### `MARKET_PROVIDER` +Specifies the backend domain used by the application marketplace (Market). +- **Valid values**: + - `appstore-server-prod.bttcdn.com` + - `appstore-china-server-prod.api.jointerminus.cn` (Recommended for mainland China users with better connectivity) +- **Default**: `appstore-server-prod.bttcdn.com` + +### `TERMINUS_CERT_SERVICE_API` +Specifies the endpoint for the Olares HTTPS certificate service. +- **Valid values**: - `https://terminus-cert.snowinning.com` - - `https://terminus-cert.api.jointerminus.cn` -- **Default Value**: `https://terminus-cert.snowinning.com` + - `https://terminus-cert.api.jointerminus.cn` (Recommended for mainland China users with better connectivity) +- **Default**: `https://terminus-cert.snowinning.com` -### TERMINUS_DNS_SERVICE_API -- Specifies the endpoint for the Olares DNS service. For better connectivity within mainland China, use `https://terminus-dnsop.api.jointerminus.cn`. -- **Possible Values**: +### `TERMINUS_DNS_SERVICE_API` +Specifies the endpoint for the Olares DNS service. +- **Valid values**: - `https://terminus-dnsop.snowinning.com` - - `https://terminus-dnsop.api.jointerminus.cn` -- **Default Value**: `https://terminus-dnsop.snowinning.com` - + - `https://terminus-dnsop.api.jointerminus.cn` (Recommended for mainland China users with better connectivity) +- **Default**: `https://terminus-dnsop.snowinning.com` - -### DID_GATE_URL -- Specifies the endpoint for the DID gateway. For better connectivity within mainland China, use `https://did-gate-v3.api.jointerminus.cn/`. -- **Possible Values**: +### `DID_GATE_URL` +Specifies the endpoint for the DID gateway. +- **Valid values**: - `https://did-gate-v3.bttcdn.com/` - - `https://did-gate-v3.api.jointerminus.cn/` -- **Default Value**: `https://did-gate-v3.bttcdn.com/` - - + - `https://did-gate-v3.api.jointerminus.cn/` (Recommended for mainland China users with better connectivity) +- **Default**: `https://did-gate-v3.bttcdn.com/` -### OLARES_SPACE_URL -- Specifies the endpoint for the Olares Space service. For better connectivity within mainland China, use `https://cloud-api.api.jointerminus.cn/`. -- **Possible Values**: +### `OLARES_SPACE_URL` +Specifies the endpoint for the Olares Space service. +- **Valid values**: - `https://cloud-api.bttcdn.com/` - - `https://cloud-api.api.jointerminus.cn/` -- **Default Value**: `https://cloud-api.bttcdn.com/` - - + - `https://cloud-api.api.jointerminus.cn/` (Recommended for mainland China users with better connectivity) +- **Default**: `https://cloud-api.bttcdn.com/` -### FIREBASE_PUSH_URL -- Specifies the endpoint for Firebase push services. For better connectivity within mainland China, use `https://firebase-push-test.api.jointerminus.cn/v1/api/push`. -- **Possible Values**: +### `FIREBASE_PUSH_URL` +Specifies the endpoint for Firebase push services. +- **Valid values**: - `https://firebase-push-test.bttcdn.com/v1/api/push` - - `https://firebase-push-test.api.jointerminus.cn/v1/api/push` -- **Default Value**: `https://firebase-push-test.bttcdn.com/v1/api/push` + - `https://firebase-push-test.api.jointerminus.cn/v1/api/push` (Recommended for mainland China users with better connectivity) +- **Default**: `https://firebase-push-test.bttcdn.com/v1/api/push` - - -### FRP_LIST_URL -- Specifies the endpoint for the Olares FRP information service. For better connectivity within mainland China, use `https://terminus-frp.api.jointerminus.cn`. -- **Possible Values**: +### `FRP_LIST_URL` +Specifies the endpoint for the Olares FRP information service. +- **Valid values**: - `https://terminus-frp.snowinning.com` - - `https://terminus-frp.api.jointerminus.cn` -- **Default Value**: `https://terminus-frp.snowinning.com` - - + - `https://terminus-frp.api.jointerminus.cn` (Recommended for mainland China users with better connectivity) +- **Default**: `https://terminus-frp.snowinning.com` -### TAILSCALE_CONTROLPLANE_URL -- Specifies the endpoint for the Olares Tailscale control-plane service. For better connectivity within mainland China, use `https://controlplane.api.jointerminus.cn`. -- **Possible Values**: +### `TAILSCALE_CONTROLPLANE_URL` +Specifies the endpoint for the Olares Tailscale control-plane service. +- **Valid values**: - `https://controlplane.snowinning.com` - - `https://controlplane.api.jointerminus.cn` -- **Default Value**: `https://controlplane.snowinning.com` \ No newline at end of file + - `https://controlplane.api.jointerminus.cn` (Recommended for mainland China users with better connectivity) +- **Default**: `https://controlplane.snowinning.com` \ No newline at end of file diff --git a/docs/developer/install/index.md b/docs/developer/install/index.md index f8b9ca97..c67d3978 100644 --- a/docs/developer/install/index.md +++ b/docs/developer/install/index.md @@ -4,8 +4,8 @@ This section provides in-depth information and command references to help you ex - [Olares installation overview](installation-process.md): Learn how Olares is installed from the perspectives of overall architecture and core components. -- [Olares installation process](installation-process.md): Explore each installation phase in detail. -- [Olares Home introduction](olares-home.md): Learn the structure of the base installation directory and gain a clearer understanding of the Olares installation process. -- [Olares environment variables](environment-variables.md): Look up the right environment variables for you to customize the installation. -- [Olares CLI reference](./index.md): Fine tune or troubleshoot Olares installation using `olares-cli` command line tools -- [Olares versioning](versioning.md): Learn versioning rules, release types, branch management practices, and upgrade guidelines of Olares. \ No newline at end of file +- [Olares installation breakdown](installation-process.md): Explore the Olares installation process in detail, broken down into four key phases. +- [Olares Home introduction](olares-home.md): Understand the structure of the base installation directory. +- [Olares environment variables reference](environment-variables.md): Find the right environment variables for you to customize the installation. +- [Olares CLI reference](./index.md): Uses the Olares CLI for advanced customization and troubleshooting during installation. +- [Olares versioning](versioning.md): Learn versioning rules, release types, branch management practices, and upgrade guidelines of Olares. diff --git a/docs/developer/install/installation-overview.md b/docs/developer/install/installation-overview.md index 157ad09e..266e8b37 100644 --- a/docs/developer/install/installation-overview.md +++ b/docs/developer/install/installation-overview.md @@ -1,85 +1,87 @@ -# Olares installation +# Olares installation overview -This document provides a high-level look at how Olares is installed, focusing on its overall architecture and core components. +This document provides a high-level overview of the Olares installation process, focusing on its overall architecture and core components. It is intended for system administrators and developers who need a foundational understanding of how Olares operates and is installed. -Typically, when you start the installation using the one-click installation script (`install.sh`), you first install `olares-cli`, a command-line tool designed for installing and maintaining the Olares cluster. `olares-cli` orchestrates the installation of subsequent components, which include: - -![Install arch](/images/developer/install/olares-install.png) +## Three layers of Olares installation +The Olares installation is structured into three key layers: - **Operating system layer**: Manages Linux system configurations and installs essential environment dependencies. - **Container orchestration layer**: Deploys the Kubernetes cluster to enable automated service management and scaling. - **Containerization layer**: Launches containerized core system services and user applications, providing the final runtime environment. -::: tip Note -To learn the detailed installation procedures, refer to [Olares installation process](installation-process.md) +The installation process is managed by the `olares-cli` tool. This command-line tool orchestrates the installation, configuration, and lifecycle management of all components. + +![Install arch](/images/developer/install/olares-install.png) + +::: tip +To understand the detailed installation process phase-by-phase, refer to [Olares installation breakdown](installation-process.md). ::: ## Operating system layer +The Olares installation process begins at the operating system layer, ensuring that the underlying Linux environment supports distributed storage, container runtimes, and Kubernetes cluster management. -This operating system layer ensures that the underlying Linux environment supports distributed storage, container runtimes, and Kubernetes cluster management. The configuration includes core Linux system settings, file system initialization, container runtime installation, and the deployment of critical system services. +This layer's configuration includes core Linux system settings, file system initialization, container runtime installation, and deployment of critical system services. ### Environment configuration -The installation first configures the basic Linux installation environment. This includes setting up Domain Name System (DNS), Secure Shell (SSH), and Network Time Protocol (NTP) services to ensure time synchronization and remote management capabilities. Additionally, necessary dependencies such as the GNU Compiler Collection (GCC) and Network Tools (net-tools) are installed to ensure a robust runtime environment. +The installation first configures the basic Linux installation environment. This includes setting up Domain Name System (DNS), Secure Shell (SSH), and Network Time Protocol (NTP) services to ensure time synchronization and remote management capabilities. + +Additionally, necessary dependencies such as the GNU Compiler Collection (GCC) and Network Tools (net-tools) are installed to ensure a robust runtime environment. ### File system configuration -The root file system (rootfs) is used to store and access system core components and user data. Depending on the installation mode, Olares supports the following two file systems: +The root file system (rootfs) is used to store and access system core components and user data. Olares supports the following two file systems based on deployment needs: -- **LocalFS**: This is the default file system for Olares using the local Linux disk for storage. It is ideal for single-node deployments that require high data throughput without the need for network sharing. +- **LocalFS** (default): Uses the local Linux disk for storage. It is ideal for single-node deployments that require high data throughput without the need for network sharing. -- **JuiceFS**: JuiceFS offers a distributed file system by acting as a file system gateway. It stores file data in locally installed MinIO instances or remote storage buckets such as Amazon S3. This setup allows different storage nodes to share a unified storage view. It is ideal for multi-node cluster deployments where data needs to be accessible across multiple nodes. To install, you must either set the appropriate [environment variables](environment-variables.md#juicefs) for the installation script or use the [`olares-cli` command](./cli/olares-prepare.md#options) with JuiceFS-specific flags. +- **JuiceFS**: Provides a distributed file system for multi-node cluster. File data are stored in locally installed MinIO instances or remote storage buckets such as Amazon S3. This setup allows different storage nodes to share a unified storage view. -### Container runtime: Containerd + :::tip Enable JuiceFS + JuiceFS and MinIO are not installed by default. To enable them, set the necessary [environment variables](environment-variables.md#juicefs) or use `olares-cli` with JuiceFS-specific flags. + ::: -All core components of Olares are containerized and deployed using Containerd, a lightweight container runtime. It provides the following functionalities: -- Container image management, which +### Container runtime: containerd +Olares uses containerd, a lightweight container runtime, for containerized deployments. Its features include: +- **Container image management**: - Downloads packaged container images from the Content Delivery Network (CDN) - - Imports them into Containerd during the environment pre-installation phase - - Starts the images as container processes during the formal installation phase + - Imports them into containerd during the "prepare" phase + - Starts the images as container processes during the "install" phase +- **Container lifecycle management**: Starts, stops, restarts, and monitors containerized application services. -- Container lifecycle management: Starts, stops, restarts, and monitors containerized application services. - -::: tip Note -If Containerd is already installed on your machine, especially in the form of Docker, it may conflict with the container runtime in Olares. Please uninstall the existing Containerd before installing Olares. +::: tip Compatibility issue +If containerd is already installed on your machine (for example, as part of Docker), it may cause compatibility issues with the containerd used by Olares. Please uninstall the existing containerd before installing Olares. ::: -### System daemon service: `olaresd` +### System daemon: olaresd -`olaresd` is the system daemon for Olares, running continuously in the background as a system service. It provides system management functionalities like: -- Automated configuration updates: Automatically detects and adjusts when IP addresses or related configuration items change. -- Remote system management: Executes remote system operations such as Olares installation, activation, factory reset, and Wi-Fi connection through the LarePass client or command-line requests. +olaresd is the system daemon that runs in the background, providing essential management functionalities such as: +- **Automated configuration updates**: Automatically adjusts configurations when system changes (e.g. IP changes) are detected. +- **Remote system management**: Executes remote system operations, such as Olares installation and activation, based on requests issued from the LarePass client or `olares-cli`. ### CUDA support - -To ensure local Artificial Intelligence (AI) models and applications can fully utilize the GPU performance, `olares-cli` supports installing the Compute Unified Device Architecture (CUDA) toolkit and drivers in the operating system layer. +To enable GPU acceleration for local AI models and applications, Olares supports the installation of the CUDA toolkit and drivers through `olares-cli`. ## Container orchestration layer +The container orchestration layer integrates system components into an efficient runtime environment using Kubernetes. -After completing the operating system configuration, the installation proceeds to the container orchestration Layer. This layer’s primary task is to integrate various system components (core services, auxiliary tools, user applications) into an organized, efficient, and scalable runtime environment. Kubernetes serves as the backbone of this layer, providing the foundational framework for automated deployment, operation, scaling, and management of multi-component services. - -### Why Kubernetes? - - Kubernetes is the de-facto standard for container orchestration. Compared to earlier solutions like Docker Compose or Docker Swarm, Kubernetes offers significant advantages in community support, architectural scalability, production-grade reliability, and security. Its robust ecosystem allows a vast array of system applications to be easily integrated into Olares through Helm Charts, Operators, and Custom Resource Definitions (CRDs), offering users a diverse range of options and a cloud-native experience. - -### Kubernetes choice for Olares - -Olares supports both official Kubernetes and Rancher's lightweight K3s across various Linux environments including: +### Roles of Kubernetes +Kubernetes serves as the backbone of this layer, providing automated deployment, operation, scaling, and management of multi-component services. -- Ubuntu/Debian -- Windows Subsystem for Linux (WSL) -- Proxmox Virtual Environment (PVE) -- Raspberry Pi - -K3s is installed by default to optimize performance and resource efficiency on local hardware. +Compared to tools like Docker Compose or Docker Swarm, Kubernetes offers: +- High scalability and production-grade reliability. +- Robust community support and a rich ecosystem for integrating applications via Helm Charts, Operators, and Custom Resource Definitions (CRDs). -For macOS users, Olares deploys Kubernetes through Minikube in a Linux virtual machine to ensure consistency in underlying features and user experience. +### Kubernetes options in Olares +Olares supports the following Kubernetes setups: +- **K3s** (default): A lightweight Kubernetes distribution optimized for resource efficiency on local hardware. +- **Kubernetes**: The full-featured Kubernetes distribution for advanced or custom deployments. +- **Minikube** (macOS only): A tool that sets up a single-node Kubernetes cluster, ensuring consistent features and user experience. -## Containerization layer: the app runtime for Olares +## Containerization layer -The containerization layer represents the final presentation form of the Olares system. All Olares components and user applications run within containers, with the full lifecycle managed via Kubernetes. This ensures that the system remains efficient, stable, and scalable. +The containerization layer is where Olares' components and applications come together to provide the system's full functionality. All Olares components and user applications run within containers, with the full lifecycle managed via Kubernetes. This ensures that the system remains efficient, stable, and scalable. -You can view the running containers using the ControlHub application in an environment where Olares is already installed: +Once Olares is installed and activated, you can view the running containers through a graphical user interface provided by the Control Hub app: ![Running pods](/images/developer/install/running-pods.png) diff --git a/docs/developer/install/installation-process.md b/docs/developer/install/installation-process.md index 823eeeee..ce734e58 100644 --- a/docs/developer/install/installation-process.md +++ b/docs/developer/install/installation-process.md @@ -1,48 +1,51 @@ -# Olares installation process +# Olares installation breakdown -A typical Olares installation begins by running the following script: +This document explains the Olares installation process from the perspective of its four main phases. It is aimed at developers and system administrators who want to understand the installation in detail, including the underlying commands, configurations, and logic behind each phase. -```bash -curl -fsSL https://olares.sh | bash - -``` - -This script automatically downloads and installs the latest `olares-cli` command-line tool, which then launches the Olares cluster installation process. To ensure stability and efficiency, the installation proceeds in four phases: **Precheck**, **Download**, **Prepare**, and **Install**. +## Four phases of installation +The Olares installation process is divided into four phases, each ensuring a smooth and stable setup: -This document walks you through each installation phase in detail. +- **Precheck**: Verifies that the system environment meets all prerequisites for Olares installation. +- **Download**: Retrieves all necessary files, dependencies, and container images for the installation. +- **Prepare**: Configures the operating system and system services to create an environment ready for Kubernetes and Olares components. +- **Install**: Deploys Kubernetes, integrates KubeSphere, and installs core Olares services and applications. -## Precheck +## Precheck phase -Both installing and running Olares require that your target machine’s operating system meets a series of conditions. Before actual installation, the script executes the `olares-cli olares precheck` command to check these conditions in advance. If any condition is not met, a warning appears, and the installation aborts. +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. -Specific checks include: -- Compatibility with operating system type, version, and CPU architecture -- Ensuring the system uses `Systemd` as its initialization process -- Making sure multiple network ports that Olares needs to expose are available -- Verifying that no conflicting container runtime is installed +Key checks include: +- Checks the compatibility with the operating system type, version, and CPU architecture +- Confirms that the system uses `Systemd` as its initialization process +- Ensures required ports that Olares needs to expose are available +- Verifies that no conflicting container runtime is installed -Below is an example of a failed precheck. Two checks failed: +If the precheck fails, you'll see a warning like this: ![Precheck](/images/developer/install/precheck.png) -- Port 9100 required by Olares is already in use; +In this example: +- Port `9100` required by Olares is already in use. - An existing container runtime is detected in the system. -You must fix these issues before trying again. +You must resolve these issues before proceeding. -## Download +## Download phase -During the download phase, `olares-cli` retrieves the necessary wizard files, system dependencies, and container images required for Olares installation. +The download phase retrieves the necessary wizard files, system dependencies, and container images required for Olares installation. -### Download wizard files -The wizard file is a metadata package for Olares installation. It contains download URLs and configuration details for all Olares components. The installation script extracts this file into the directory: +### Download the wizard file + +The wizard file is a metadata package that contains download URLs and configuration details for all Olares components. It is the first file retrieved during this phase, as it provides critical information for the subsequent downloads. + +By default, the wizard file is stored in: + +`HOME/.olares/versions/` -```bash -HOME/.olares/versions/ -``` where: -- `$HOME/.olares` is the base installation directory for Olares where all images, logs, dependencies and other version-related files are stored. See [Olares home overview](olares-home.md) for more details. -- `` refers to the version number of Olares associated with the wizard file (for example, 1.12.0-20241215). +- `$HOME/.olares` is the base directory for Olares. +- `` refers to the version number of Olares (e.g. `1.12.0-20241215`). **Example script output**: @@ -63,11 +66,12 @@ Greetings, Olares /home/keven/.olares/versions/v1.12.0-20241215/wizard/config/account/Chart.yaml ``` -### Download required components and container images +### Download components and container images +Once the wizard file has been downloaded, the script retrieves all necessary dependencies and container images. These files are stored in: +- `$HOME/.olares/pkg` for dependency packages. +- `$HOME/.olares/image` for container images. -After the wizard file, `olares-cli` proceeds to download the base software, container images, and dependency packages. These files are stored in `$HOME/.olares/pkg` and `$HOME/.olares/image`. - -Unlike the wizard file, these components are generally stable and reusable over time, so they are not stored under a specific version directory. This setup allows incremental downloads for new or updated images on reinstallation, preventing redundant downloads. +This storage structure allows reusing stable components across multiple versions to avoid redundant downloads. **Example script output**: @@ -89,13 +93,19 @@ Greetings, Olares ... ``` -## Prepare +## Prepare phase + +The prepare phase configures the system environment to support Kubernetes, container images, and Olares services. -After the download phase, the prepare phase configures the operating system to ensure smooth operation of Kubernetes, container images, and other system services. - -### Install and configure system dependencies -- Adjust DNS, NTP, and SSH services to ensure proper network functionality and time synchronization. -- Install essential dependencies (e.g., curl, net-tools, gcc, make) via `apt`. +This phase involves three main tasks: +- Configure the system +- Set up the container runtime +- Install the system daemon + +### Configure system +The installation script configures the Linux environment to meet Olares' requirements. These configurations include: +- Adjusts DNS, NTP, and SSH services to ensure proper network functionality and time synchronization. +- Installs essential dependencies (e.g., curl, net-tools, gcc, make) via `apt`. **Example script output**: @@ -121,30 +131,31 @@ Hit:2 https://download.docker.com/linux/ubuntu jammy InRelease Hit:3 http://hk.archive.ubuntu.com/ubuntu jammy InRelease ... ``` -### Install system dependencies and container runtime -- Install and start the previously downloaded dependencies -- Install containerd on the system and start the service -- Import the downloaded container images into containerd +### Set up container runtime +The container runtime is a critical component for running containerized applications. During this step, the installation script: +- Installs and start the previously downloaded dependencies +- Installs containerd on the system and start the service +- Imports the downloaded container images into containerd - - **Example script output**: +**Example script output**: - ```bash - 2024-12-17T19:47:37.510+0800 [Module] InstallContainerModule(k3s) - 2024-12-17T19:47:37.518+0800 [A] ubuntu: ZfsMountReset skipped (7.321811ms) - 2024-12-17T19:47:37.525+0800 [A] ubuntu: CreateZfsMount skipped (7.322591ms) - 2024-12-17T19:47:38.188+0800 [A] ubuntu: SyncContainerd success (662.643982ms) - 2024-12-17T19:47:38.368+0800 [A] ubuntu: SyncCrictlBinaries success (179.758334ms) - 2024-12-17T19:47:38.399+0800 [A] ubuntu: GenerateContainerdService success (31.410118ms) - 2024-12-17T19:47:38.451+0800 [A] ubuntu: GenerateContainerdConfig success (52.047108ms) - 2024-12-17T19:47:38.505+0800 [A] ubuntu: GenerateCrictlConfig success (53.760209ms) - 2024-12-17T19:47:38.857+0800 [A] ubuntu: EnableContainerd success (352.128078ms) - 2024-12-17T19:47:38.857+0800 [Module] PreloadImages - 2024-12-17T19:47:41.665+0800 (1/145) imported image: rancher/mirrored-pause:3.6, time: 194.363948ms - ... - ``` +```bash +2024-12-17T19:47:37.510+0800 [Module] InstallContainerModule(k3s) +2024-12-17T19:47:37.518+0800 [A] ubuntu: ZfsMountReset skipped (7.321811ms) +2024-12-17T19:47:37.525+0800 [A] ubuntu: CreateZfsMount skipped (7.322591ms) +2024-12-17T19:47:38.188+0800 [A] ubuntu: SyncContainerd success (662.643982ms) +2024-12-17T19:47:38.368+0800 [A] ubuntu: SyncCrictlBinaries success (179.758334ms) +2024-12-17T19:47:38.399+0800 [A] ubuntu: GenerateContainerdService success (31.410118ms) +2024-12-17T19:47:38.451+0800 [A] ubuntu: GenerateContainerdConfig success (52.047108ms) +2024-12-17T19:47:38.505+0800 [A] ubuntu: GenerateCrictlConfig success (53.760209ms) +2024-12-17T19:47:38.857+0800 [A] ubuntu: EnableContainerd success (352.128078ms) +2024-12-17T19:47:38.857+0800 [Module] PreloadImages +2024-12-17T19:47:41.665+0800 (1/145) imported image: rancher/mirrored-pause:3.6, time: 194.363948ms +... +``` ### Install system daemon -Install and start `olaresd`, the system daemon for Olares. `olaresd` runs in the background and automatically performs maintenance operations. +The Olares system daemon, olaresd, is then installed and started to monitor the system and automatically perform maintenance tasks. **Example script output**: @@ -171,27 +182,30 @@ WantedBy=multi-user.target ... ``` -### Optional installations +### Optional settings If you want to enable distributed shared storage (e.g., JuiceFS, Redis, MinIO) or GPU support (CUDA), you can set corresponding [environment variables](environment-variables.md) when running the installation script. -## Install +## Install phase +The install phase brings all system components online and ensures the runtime environment is fully operational. -During this phase, the script primarily completes the following steps: -- Deploy and start Kubernetes. -- Install and configure KubeSphere for cloud-native management and observability. -- Install the Olares account. -- Deploy built-in apps (e.g., storage, backup, account system, file services) and bring all Olares environment modules online. +During this phase, the script primarily completes the following tasks: +- Deploy Kubernetes. +- Integrate KubeSphere for cloud-native management and observability. +- Configure the Olares account. +- Deploy and start built-in apps and services. ### Deploy Kubernetes -By default, Olares installs K3s, a lightweight Kubernetes distribution. This step includes: -1. Starting the etcd database. -2. Starting and configuring K3s. -3. Installing a Container Network Interface (CNI) plugin for cluster networking. -4. Copying the `kubeconfig` file to the current user’s directory, enabling interaction with the cluster via kubectl. +Kubernetes is the backbone of the Olares system. During this step, the installation script: +1. Starts the etcd database. +2. Starts and configures K3s, the default Kubernetes distribution used by Olares. +3. Installs a Container Network Interface (CNI) plugin for cluster networking. +4. Copies the `kubeconfig` file to the current user's directory, enabling interaction with the cluster via `kubectl`. -You can also choose to install the official Kubernetes. The script will install using kubeadm, an official tool that assists you in creating a minimum viable cluster. On macOS, the scripts uses Minikube, which will skip the above installation steps. +K3s is the default Kubernetes distribution for Olares due to its lightweight design and ease of use. However, kubernetes is also available for advanced or custom setups. + +On macOS, the scripts uses Minikube, which will skip the above step. **Example script output**: @@ -234,15 +248,20 @@ You can also choose to install the official Kubernetes. The script will install ... ``` -### Install and integrate KubeSphere +### Integrate KubeSphere + +KubeSphere is installed on top of Kubernetes to enhance system management and observability. It provides features such as: -This process installs KubeSphere on top of Kubernetes. Olares integrates part of KubeSphere’s functionality, mainly for system monitoring, alerts, workspace management, and more. It creates various namespaces and CRDs (Custom Resource Definitions), and starts KubeSphere’s backend services. +- System monitoring and alerting. +- Resource and workspace management. +- Namespaces and custom resource definitions (CRDs). -### Install Olares account +### Configure account +The Olares ID is created on the LarePass app. During this step, the installation script prompts you to enter the following info, so you can use LarePass to activate Olares later: +- **Olares domain name**: Olares provides default names `olares.com` and `olares.cn`. This can be customized if the custom domain has been added to Olares Space. +- **Olares ID**: Enter the username part of your Olares ID. -After KubeSphere installation is complete, the command line prompts you to enter your Olares ID. This creates a system account for logging in to Olares and completes several background access and permission configurations. -- **Olares domain name** (default olares.com, can be customized) -- **Olares ID**: Enter the username part of your Olares ID +This creates a system account for logging in to Olares and completes several background access and permission configurations. **Example script output:** @@ -256,17 +275,16 @@ Enter the Olares ID (which you registered in the LarePass app): terminus 2024-12-17T20:58:52.584+0800 using password: 2uO5PZ2X ``` -### Install Olares components and built-in applications - -In this step, core Olares functions and common services are deployed via Helm: -- Core system services (in the `os-system` namespace), such as backups (Velero), storage (OpenEBS), Redis, Nats, MinIO, and other key components -- User applications (in namespaces like `user-space-xxx`), including file management like Files, system tools like Desktop and Settings, and other self-hosted apps. +### Deploy built-in applications +The final deployment step installs core services and user applications using Helm charts: +- **Core system services** (in the `os-system` namespace): Includes backups (Velero), storage (OpenEBS), Redis, Nats, MinIO, etc. +- **User applications** (in namespaces like `user-space-xxx`): Includes Files, Desktop, Settings, etc. During installation, the log will display messages such as `[helm] app installed success` and `xxx created`, indicating that the respective Helm charts or Kubernetes resources have been installed successfully. -### Installation completes +### Complete the installation -Once all components start and run properly, the script outputs a summary similar to the following: +Once all components are deployed, the script outputs a summary with a URL for the activation wizard: ```bash 2024-12-17T21:00:58.086+0800 [INFO] Installation wizard is complete @@ -284,7 +302,12 @@ Once all components start and run properly, the script outputs a summary similar 2024-12-17T21:00:58.086+0800 Password: 2uO5PZ2X ``` -Open your browser and enter the provided URL and log in to the activation wizard with initial password. Then, follow the on-screen prompt to finish the activation. That's all for the installation. +To complete the installation, you need to: +1. Open your browser and enter the provided URL. +2. Log in to the activation wizard with initial password. +3. Follow the on-screen prompt to finish the activation. + +After activation, your Olares will be fully operational and ready to use. ## Learn more diff --git a/docs/developer/install/olares-home.md b/docs/developer/install/olares-home.md index a2214818..724dd504 100644 --- a/docs/developer/install/olares-home.md +++ b/docs/developer/install/olares-home.md @@ -1,15 +1,13 @@ # Olares Home -**Olares Home** is the default installation directory for Olares. It stores images, logs, dependency components, and version management data. In this document, you will learn the structure of Olares Home and gain a clearer understanding of the Olares installation process. - +"Olares Home" is the default installation directory for Olares. It stores images, logs, dependency components, and version management data. In this document, you will learn the structure of Olares Home and gain a clearer understanding of the Olares installation process. ## Path configuration -By default, **Olares Home** is located at `~/.olares`. You can customize its location in the following ways: - -- Set the environment variable `olares-home`. -- Use the `olares-cli` command-line option `base_dir` to change the path. +By default, Olares Home is located at `~/.olares`. You can customize its location in the following ways: +- Set the environment variable `OLARES-HOME`. +- Use the `olares-cli` command-line option `base-dir` to change the path. ## Directory structure @@ -53,14 +51,13 @@ A typical Olares Home directory might look like this: ``` -## Key features - -The structure of Olares Home enables efficient file management and flexible version switching, allowing for simplified installation and daily operations. - -- **Versioned storage**: Each Olares version is stored under the `versions` directory. All files and logs related to a particular version are contained within its subdirectory. +The structure of Olares Home is designed to optimize file management, version control, and resource sharing. The advantages include: -- **Single Olares instance per machine** - Only one Olares instance can run on a single machine at a time, preventing version conflicts. +- Each Olares version is stored under the `versions` directory. All files and logs related to a particular version are contained within its subdirectory. +- Only one Olares instance can run on a single machine at a time, preventing version conflicts. +- The `images` and `pkg` directories are shared across all Olares versions. This design reduces redundancy, minimizes duplicate downloads, and saves disk space. -- **Shared images and dependencies** - Different Olares versions share the files in the `images` and `pkg` directories, reducing duplicate downloads and saving storage space. +## Learn more +- [Olares CLI](../install/cli/olares-cli.md) +- [Olares installation process](installation-process.md) +- [Olares environment variables](environment-variables.md) \ No newline at end of file diff --git a/docs/zh/developer/install/environment-variables.md b/docs/zh/developer/install/environment-variables.md index 11217508..ba7e0c8b 100644 --- a/docs/zh/developer/install/environment-variables.md +++ b/docs/zh/developer/install/environment-variables.md @@ -1,15 +1,12 @@ # Olares 环境变量参考 -在大多数场景下，你只需通过一行脚本 `install.sh` 即可完成 Olares 的快速安装和使用。 +在大多数场景下，你只需通过一行脚本即可完成 Olares 的快速安装和使用。 然而，为了满足更细化的安装需求，Olares 安装脚本也支持通过一系列环境变量来改变默认的配置和行为。 - -## 环境变量的使用方式 - -环境变量可通过以下方式使用： +## 使用示例 ::: tip 提示 -下文示例以 KUBE_TYPE=k8s（指定安装 K8S）为例，其他环境变量的用法类似。 +下文示例以 `KUBE_TYPE=k8s`（指定安装 K8S）为例，其他环境变量的用法类似。 ::: - 在执行安装脚本时直接指定： @@ -62,43 +59,39 @@ curl -sSfL https://olares.sh | bash 以下列出了安装脚本所支持的全部环境变量，以及它们的默认值、可选值和说明。你可以根据具体需求进行配置。 ### KUBE_TYPE -- 指定要使用的 Kubernetes 发行版。如果需要完整版本的 k8s，请将其设置为 `k8s`。仅在执行 `install.sh` 时生效。 +指定要使用的 Kubernetes 发行版。如果需要完整版本的 k8s，请将其设置为 `k8s`。仅在执行 `install.sh` 时生效。 - **可选值**: `k8s` / `k3s` - **默认值**: `k3s` - - ### REGISTRY_MIRRORS -- 设置 Docker 镜像加速地址。仅在执行 `install.sh` 时生效。 +设置 Docker 镜像加速地址。仅在执行 `install.sh` 时生效。 （如果不设置，则默认使用 `https://registry-1.docker.io`） - **可选值**: `https://mirrors.joinolares.cn` 或其他镜像源地址 - **默认值**: `https://registry-1.docker.io` - - ### PREINSTALL -- 当该值设为 `1` 时，仅完成预安装阶段（安装系统依赖）。如果未设置或留空，则完整安装 Olares。仅在执行 `install.sh` 时生效。 +当该值设为 `1` 时，仅完成预安装阶段（安装系统依赖）。如果未设置或留空，则完整安装 Olares。仅在执行 `install.sh` 时生效。 - **可选值**: `1` - **默认值**: 无 ### JUICEFS -- 当该值设为 `1` 时，安装 [JuiceFS](https://juicefs.com/)，默认不安装。仅在执行 `install.sh` 时生效。 +当该值设为 `1` 时，安装 [JuiceFS](https://juicefs.com/)，默认不安装。仅在执行 `install.sh` 时生效。 - **可选值**: `1` - **默认值**: 无 ### TERMINUS_OS_DOMAINNAME -- 在安装前预先设置域名，可跳过安装过程中的交互式提示。 +在安装前预先设置域名，可跳过安装过程中的交互式提示。 - **可选值**: 任意有效域名 - **默认值**: 无 ### TERMINUS_OS_USERNAME -- 在安装前预先设置用户名，会跳过安装过程中的对应交互式提示。 +在安装前预先设置用户名，会跳过安装过程中的对应交互式提示。 - **保留关键词**（不可使用以下关键词作为用户名）： ``` user, system, space, default, os, kubesphere, kube, kubekey, kubernetes, @@ -107,94 +100,75 @@ curl -sSfL https://olares.sh | bash - **可选值**: 任意有效用户名（长度 2～250，且不与保留关键词冲突） - **默认值**: 无 - - ### TERMINUS_OS_EMAIL -- 在安装前预先设置邮箱地址，会跳过安装过程中的交互式提示。如果未设置，将自动生成一个临时邮箱。 +在安装前预先设置邮箱地址，会跳过安装过程中的交互式提示。如果未设置，将自动生成一个临时邮箱。 - **可选值**: 任意有效邮箱地址 - **默认值**: 自动生成的邮箱地址 - - ### TERMINUS_OS_PASSWORD -- 在安装前预先设置密码，会跳过安装过程中的交互式提示。 +在安装前预先设置密码，会跳过安装过程中的交互式提示。 - **可选值**: 6～32 个字符 - **默认值**: 随机生成 8 位密码 - - ### TERMINUS_IS_CLOUD_VERSION -- 明确将此机器标记为云端实例（cloud instance）。 +明确将此机器标记为云端实例（cloud instance）。 - **可选值**: `true` - **默认值**: 无 - - ### LOCAL_GPU_ENABLE -- 指定是否启用 GPU 并安装相关驱动。 +指定是否启用 GPU 并安装相关驱动。 - **可选值**: `0`（关闭） / `1`（开启） - **默认值**: `0`（关闭） - - ### LOCAL_GPU_SHARE -- 指定是否启用 GPU 共享功能。仅在已启用 GPU 时生效。 +指定是否启用 GPU 共享功能。仅在已启用 GPU 时生效。 - **可选值**: `0`（关闭） / `1`（开启） - **默认值**: `0`（关闭） - ### CLOUDFLARE_ENABLE -- 指定是否启用 Cloudflare 代理。 +指定是否启用 Cloudflare 代理。 - **可选值**: `0`（关闭） / `1`（开启） - **默认值**: `0`（关闭） - ### FRP_ENABLE -- 指定是否启用 FRP 内网穿透。如果使用自定义 FRP 服务器，还需额外设置 `FRP_SERVER`、`FRP_PORT` 等相关变量。 +指定是否启用 FRP 内网穿透。如果使用自定义 FRP 服务器，还需额外设置 `FRP_SERVER`、`FRP_PORT` 等相关变量。 - **可选值**: `0`（关闭） / `1`（开启） - **默认值**: `0`（关闭） - - ### FRP_SERVER -- 指定 FRP 服务端地址。 +指定 FRP 服务端地址。 - **可选值**: 任意有效的 FRP 服务地址 - **默认值**: *(无，例如 `yoursfrpserver.com`)* - - ### FRP_PORT -- 设置 FRP 服务端监听端口。如果未指定或为 `0`，则默认使用 7000。 +设置 FRP 服务端监听端口。如果未指定或为 `0`，则默认使用 7000。 - **可选值**: 整数范围 `1～65535` - **默认值**: `0` - ### FRP_AUTH_METHOD -- 设置 FRP 的认证方式。如果将其设置为 `token`，则必须提供 `FRP_AUTH_TOKEN`；如果留空，则不使用任何认证。 +设置 FRP 的认证方式。如果将其设置为 `token`，则必须提供 `FRP_AUTH_TOKEN`；如果留空，则不使用任何认证。 - **可选值**: `jws` / `token` / *(空字符串)* - **默认值**: `jws` - - ### FRP_AUTH_TOKEN -- 当 `FRP_AUTH_METHOD=token` 时，用于指定服务器通信所需的 Token。 +当 `FRP_AUTH_METHOD=token` 时，用于指定服务器通信所需的 Token。 - **可选值**: 任意非空字符串 - **默认值**: 无 ### TOKEN_MAX_AGE -- 设置 Token 的最大有效时长（单位：秒）。 +设置 Token 的最大有效时长（单位：秒）。 - **可选值**: 任意整数（单位：秒） - **默认值**: `31536000`（365 天） ### MARKET_PROVIDER -- 指定应用市场（Market）后端服务所使用的域名，可根据网络环境选择合适的域名以优化访问速度。 +指定应用市场（Market）后端服务所使用的域名，可根据网络环境选择合适的域名以优化访问速度。 - **可选值**: - `appstore-server-prod.bttcdn.com` - `appstore-china-server-prod.api.jointerminus.cn` @@ -203,7 +177,7 @@ curl -sSfL https://olares.sh | bash ### TERMINUS_CERT_SERVICE_API -- 指定 Olares HTTPS 证书服务的地址。若在中国大陆地区使用，推荐 `https://terminus-cert.api.jointerminus.cn`。 +指定 Olares HTTPS 证书服务的地址。若在中国大陆地区使用，推荐 `https://terminus-cert.api.jointerminus.cn`。 - **可选值**: - `https://terminus-cert.snowinning.com` - `https://terminus-cert.api.jointerminus.cn` @@ -212,7 +186,7 @@ curl -sSfL https://olares.sh | bash ### TERMINUS_DNS_SERVICE_API -- 指定 Olares DNS 服务的地址。若在中国大陆地区使用，推荐 `https://terminus-dnsop.api.jointerminus.cn`。 +指定 Olares DNS 服务的地址。若在中国大陆地区使用，推荐 `https://terminus-dnsop.api.jointerminus.cn`。 - **可选值**: - `https://terminus-dnsop.snowinning.com` - `https://terminus-dnsop.api.jointerminus.cn` @@ -221,7 +195,7 @@ curl -sSfL https://olares.sh | bash ### DID_GATE_URL -- 指定 DID 网关服务的地址。若在中国大陆地区使用，推荐 `https://did-gate-v3.api.jointerminus.cn/`。 +指定 DID 网关服务的地址。若在中国大陆地区使用，推荐 `https://did-gate-v3.api.jointerminus.cn/`。 - **可选值**: - `https://did-gate-v3.bttcdn.com/` - `https://did-gate-v3.api.jointerminus.cn/` @@ -230,7 +204,7 @@ curl -sSfL https://olares.sh | bash ### OLARES_SPACE_URL -- 指定 Olares Space 服务的地址。若在中国大陆地区使用，推荐 `https://cloud-api.api.jointerminus.cn/`。 +指定 Olares Space 服务的地址。若在中国大陆地区使用，推荐 `https://cloud-api.api.jointerminus.cn/`。 - **可选值**: - `https://cloud-api.bttcdn.com/` - `https://cloud-api.api.jointerminus.cn/` @@ -239,7 +213,7 @@ curl -sSfL https://olares.sh | bash ### FIREBASE_PUSH_URL -- 指定 Firebase 推送服务的地址。若在中国大陆地区使用，推荐 `https://firebase-push-test.api.jointerminus.cn/v1/api/push`。 +指定 Firebase 推送服务的地址。若在中国大陆地区使用，推荐 `https://firebase-push-test.api.jointerminus.cn/v1/api/push`。 - **可选值**: - `https://firebase-push-test.bttcdn.com/v1/api/push` - `https://firebase-push-test.api.jointerminus.cn/v1/api/push` @@ -248,7 +222,7 @@ curl -sSfL https://olares.sh | bash ### FRP_LIST_URL -- 指定 Olares FRP 信息服务的地址。若在中国大陆地区使用，推荐 `https://terminus-frp.api.jointerminus.cn`。 +指定 Olares FRP 信息服务的地址。若在中国大陆地区使用，推荐 `https://terminus-frp.api.jointerminus.cn`。 - **可选值**: - `https://terminus-frp.snowinning.com` - `https://terminus-frp.api.jointerminus.cn` @@ -257,7 +231,7 @@ curl -sSfL https://olares.sh | bash ### TAILSCALE_CONTROLPLANE_URL -- 指定 Olares Tailscale 控制平面（control-plane）服务的地址。若在中国大陆地区使用，推荐 `https://controlplane.api.jointerminus.cn`。 +指定 Olares Tailscale 控制平面（control-plane）服务的地址。若在中国大陆地区使用，推荐 `https://controlplane.api.jointerminus.cn`。 - **可选值**: - `https://controlplane.snowinning.com` - `https://controlplane.api.jointerminus.cn` diff --git a/docs/zh/developer/install/installation-overview.md b/docs/zh/developer/install/installation-overview.md index e9652500..a39c1b92 100644 --- a/docs/zh/developer/install/installation-overview.md +++ b/docs/zh/developer/install/installation-overview.md @@ -1,21 +1,21 @@ # Olares 安装概述 -本文档将向你介绍 Olares 安装的整体架构及核心组件。 +本文档介绍 Olares 安装的整体架构及核心组件。 -执行一键安装安装脚本后，你将首先安装 `olares-cli`。`olares-cli` 是一个 Olares 的命令行工具，用于安装维护 Olares 集群、管理应用、管理用户、以及扩展硬件节点等日常任务。`olares-cli` 会主导后续组件的安装，具体包括： +执行安装脚本后，你将首先安装 `olares-cli`。`olares-cli` 是一个 Olares 的命令行工具，用于安装维护 Olares 集群、管理应用、管理用户、以及扩展硬件节点等日常任务。`olares-cli` 会主导后续组件的安装，具体包括： ![Install arch](/images/developer/install/olares-install.png) -- 操作系统层：处理 Linux 系统配置与基础环境依赖安装。 -- 容器编排层：部署 Kubernetes 集群，实现服务的自动化管理与扩展。 -- 容器化层：启动容器化的系统核心服务和用户应用，提供最终运行环境。 +- **操作系统层**：处理 Linux 系统配置与基础环境依赖安装。 +- **容器编排层**：部署 Kubernetes 集群，实现服务的自动化管理与扩展。 +- **容器化层**：启动容器化的系统核心服务和用户应用，提供最终运行环境。 ::: tip 提示 -要了解这些组件涉及的具体安装过程，请参考[Olares 安装过程](installation-process.md)文档。 +要了解这些组件涉及的具体安装过程，请参考 [Olares 安装过程](installation-process.md)文档。 ::: ## 操作系统层面 -Olares 的安装从 操作系统层面 开始，确保底层 Linux 环境支持分布式存储、容器运行时和 Kubernetes 集群管理。该层的配置涵盖 Linux 系统的核心环境设置、文件系统初始化、容器运行时安装以及关键系统服务部署。 +Olares 的安装从操作系统层面开始，确保底层 Linux 环境支持分布式存储、容器运行时和 Kubernetes 集群管理。该层的配置涵盖 Linux 系统的核心环境设置、文件系统初始化、容器运行时安装以及关键系统服务部署。 ### 环境配置 @@ -23,30 +23,30 @@ Olares 的安装从 操作系统层面 开始，确保底层 Linux 环境支持 ### 文件系统配置 -文件系统 （rootfs）用于存取系统核心组件与用户数据。根据安装模式，支持以下两种文件系统： +文件系统（rootfs）用于存取系统核心组件与用户数据。根据安装模式，支持以下两种文件系统： -- **LocalFS**: 默认文件系统。使用 Linux 本地磁盘作为存储系统。适用于单节点部署，数据吞吐要求高，且无网络共享需求的日常部署场景。. +- **LocalFS**：默认文件系统。使用 Linux 本地磁盘作为存储系统。适用于单节点部署，数据吞吐要求高，且无网络共享需求的日常部署场景。 -- **JuiceFS**: 分布式文件系统 。该方式使用 JuiceFS 充当 文件系统网关，将文件数据存入 Olares 本地安装的 MinIO，或是远端存储桶（如 S3）。不同存储节点可拥有统一的存储视图。该方式适用于多节点集群部署，数据跨节点共享的场景。JuiceFS 和 MinIO 默认不安装，需安装时设置[环境变量](environment-variables.md#juicefs) 或用 [olares-cli 脚本](./cli/olares-prepare.md#选项)配合 JuiceFS 相应参数安装。 +- **JuiceFS**：分布式文件系统。该方式使用 JuiceFS 充当文件系统网关，将文件数据存入 Olares 本地安装的 MinIO，或是远端存储桶（如 S3）。不同存储节点可拥有统一的存储视图。该方式适用于多节点集群部署，数据跨节点共享的场景。JuiceFS 和 MinIO 默认不安装，需安装时设置[环境变量](environment-variables.md#juicefs)或用 [olares-cli 脚本](./cli/olares-prepare.md#选项)配合 JuiceFS 相应参数安装。 -### 容器运行时：Containerd +### 容器运行时：containerd Olares 的核心组件全部都是容器化发布和部署的，因此需要安装轻量级容器运行时 containerd。功能如下： - 容器镜像管理：将打包好的容器镜像从 CDN 下载下来，在环境预装阶段导入至 containerd, 并在正式安装环节以容器进程的方式启动镜像。 - 容器生命周期管理：负责启动、停止、重启和监控容器化应用服务。 -::: tip 注意 -如果系统之前安装过 containerd，尤其是以 Docker 的形式安装的，可能会与 Olares 有兼容性问题。请卸载之后再安装 Olares。 +::: tip containerd 与 Olares 兼容性问题 +如果系统之前安装过 containerd，尤其是以 Docker 形式安装的，可能会与 Olares 有兼容性问题。请卸载之后再安装 Olares。 ::: -### 系统守护进程：`olaresd` +### 系统守护进程：olaresd -Olaresd 是 Olares 的系统守护进程，以 system daemon 服务的形式持续在后台运行。它主要提供以下系统管理服务： +olaresd 是 Olares 的系统守护进程，以 system daemon 服务的形式持续在后台运行。它主要提供以下系统管理服务： - 自动化配置更新：当 IP 地址或相关配置项发生变更时，自动调检测并调整。 -- 系统管理：通过 LarePass 客户端或命令行的请求，执行 Olares 安装、激活、恢复出厂设置、连接 WiFI 等系统操作。 +- 系统管理：通过 LarePass 客户端或命令行的请求，执行 Olares 安装、激活、恢复出厂设置、连接 Wi-Fi 等系统操作。 ### CUDA 支持 -Olares集成了强大的本地 AI 能力。为了确保用户在 Olares 部署的本地 AI 模型和应用可充分利用 Nvidia 显卡的性能，用户可通过配置相关环境变量安装统一计算架构（CUDA）的工具包及相应驱动。 +Olares 集成了强大的本地 AI 能力。为了确保用户在 Olares 部署的本地 AI 模型和应用可充分利用 NVIDIA 显卡的性能，用户可通过配置相关环境变量安装统一计算架构（CUDA）的工具包及相应驱动。 ## 容器编排层：Kubernetes @@ -81,5 +81,6 @@ Olares 在以下 Linux 环境中，Olares 支持官方 Kubernetes 和 Rancher ## 了解更多 - [Olares 安装过程](installation-process.md) +- [Olares Home 概述](olares-home.md) - [`olares-cli` 命令行参考](../install/cli/olares-cli.md) - [Olares 环境变量](environment-variables.md) \ 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 43d67063..996de96a 100644 --- a/docs/zh/developer/install/installation-process.md +++ b/docs/zh/developer/install/installation-process.md @@ -6,13 +6,13 @@ curl -fsSL https://cn.olares.sh | bash - ``` -该脚本首先会下载并安装最新版的 `olares-cli` 命令行工具，之后即自动开始执行 Olares 集群的安装流程。为了提高稳定性和效率，Olares的安装分为四个阶段：**Precheck（预检）**、**Download（下载）**、**Prepare（预装环境）**、**Install（安装）**。 +该脚本首先会下载并安装最新版的 `olares-cli` 命令行工具，之后即自动开始执行 Olares 集群的安装流程。为了提高稳定性和效率，Olares 的安装分为四个阶段：**Precheck（预检）**、**Download（下载）**、**Prepare（预装环境）**、**Install（安装）**。 本文档将为你详细介绍每个安装阶段的步骤与细节。 ## Precheck（预检） -Olares的安装及运行都需要宿主系统满足一系列的条件。在实际安装前，脚本将执行 `olares-cli olares precheck` 命令，对这些条件预先进行检查。若条件不满足，则会提供提示信息并退出安装流程。具体来说，会针对以下条件进行预检： +Olares 的安装及运行都需要宿主系统满足一系列的条件。在实际安装前，脚本将执行 `olares-cli olares precheck` 命令，对这些条件预先进行检查。若条件不满足，则会提供提示信息并退出安装流程。具体来说，会针对以下条件进行预检： - 操作系统类型、版本号以及处理器架构的兼容性检测 - 系统是否是以 `Systemd` 作为初始化进程启动 - Olares 对外暴露服务所需的网络端口是否可用 @@ -21,7 +21,7 @@ Olares的安装及运行都需要宿主系统满足一系列的条件。在实 下图是一个预检不通过的示例，其中有两项检查失败了： ![Precheck](/images/developer/install/precheck.png) -- Olares所需的9100端口已被占用 +- Olares 所需的`9100`端口已被占用 - 系统中存在已有的容器运行时 需解决这些问题后，再次尝试安装。 @@ -36,13 +36,13 @@ Download 阶段会下载 Olares 安装所需的 wizard 文件及系统所依赖 Wizard 文件是 Olares 的安装包的元数据，包含了 Olares 不同组件的下载地址及安装配置。安装脚本会解压该文件到 `$HOME/.olares/versions/` 目录，其中， - `$HOME/.olares`是 Olares 的基础安装目录，用于存储所有镜像、日志、依赖项以及其他版本相关文件。详细目录结构请参考 [Olares Home 概述](olares-home.md)文档。 -- `` 是此 wizard 文件对应的 Olares 版本号，如示例中的 1.12.0-20241215。 +- `` 是此 wizard 文件对应的 Olares 版本号，如示例中的 `1.12.0-20241215`。 **示例脚本输出**： ```bash ➜ ~ ./install.sh -the KUBE_TYPE env var is not set, defaulting to "k3s +the KUBE_TYPE env var is not set, defaulting to "k3s" olares-cli already installed and is the expected version downloading installation wizard... @@ -59,7 +59,7 @@ Greetings, Olares ### 下载安装所需组件与容器镜像 -完成 Wizard 下载后，olares-cli 会下载 Olares 所需的基础软件、容器镜像和依赖包，这些文件会保存在 `$HOME/.olares/pkg` 和 `$HOME/.olares/image` 下。 +Wizard 下载完成后，Olares CLI 会下载 Olares 所需的基础软件、容器镜像和依赖包，这些文件会保存在 `$HOME/.olares/pkg` 和 `$HOME/.olares/image` 下。 和 Wizard 的保存路径不同，大部分组件是通用且长期稳定的，不会保存在具体版本对应的路径下。因此重新安装时仅需对新增或更新的镜像进行增量下载，避免重复下载。 @@ -87,7 +87,7 @@ Greetings, Olares 在完成下载后，安装脚本将对操作系统进行配置，以保证能够顺利运行 Kubernetes、容器镜像等系统服务。 -### 系统依赖安装与配置 +### 安装与配置系统依赖 - 调整 DNS、NTP、SSH 服务，确保机器网络正常、时间同步无误。 - 通过 apt 安装必要依赖（curl、net-tools、gcc、make 等）。 @@ -179,9 +179,9 @@ WantedBy=multi-user.target ### 部署 Kubernetes Olares 默认安装 K3s，一款轻量级的 Kubernetes 发行版。此步骤将： -1. 启动 etcd 数据库； -2. 启动并配置 K3s； -3. 安装容器网络界面（CNI）插件以提供集群网络能力； +1. 启动 etcd 数据库。 +2. 启动并配置 K3s。 +3. 安装容器网络界面（CNI）插件以提供集群网络能力。 4. 将 `kubeconfig` 文件复制到当前用户路径，以便使用 `kubectl` 与集群交互。 如果你选择安装官方的 Kubernetes，脚本将使用 `kubeadm` 完成部署。`kubeadm` 是 Kubernetes 提供的官方工具，可帮助你创建最低可行集群。在 macOS 上，脚本会使用 Minikube 来进行安装，不会执行上述安装步骤。 @@ -233,9 +233,9 @@ Olares 会基于 Kubernetes 安装 KubeSphere。 Olares 集成了一部分 KubeS ### 安装 Olares 账户 -在KubeSphere安装完成后，命令行会提示用户输入自己的 Olares ID。 这将创建一个系统账号用于登录 Olares，并且在后台完成多处访问与权限配置。 +在KubeSphere 安装完成后，命令行会提示用户输入自己的 Olares ID。 这将创建一个系统账号用于登录 Olares，并且在后台完成多处访问与权限配置。 -- Olares 域名: 默认为 `olares.cn`，可以自定义）。 +- Olares 域名: 默认为 `olares.cn`，可以自定义。 - Olares ID: 输入 Olares ID 中的用户名部分。 **示例脚本输出**： @@ -255,7 +255,7 @@ Enter the Olares ID (which you registered in the LarePass app): marvin113 此步骤会会通过 Helm 部署 Olares 系统的核心功能与常用服务： - 核心系统服务（`os-system` 命名空间）：如备份（Velero）、存储（OpenEBS）、Redis、Nats、MinIO 等关键组件。 -- 用户应用（`user-space-xxx` 命名空间）：如文件管理器、桌面、设置、知识库应用、和其他自托管应用等。 +- 用户应用（`user-space-xxx` 命名空间）：如文件管理器、桌面、设置等系统应用。 日志中会显示 `[helm] app installed success` 以及一系列 `xxx created` 的提示，表示对应的 Helm Chart 或 Kubernetes 资源安装成功。 @@ -299,7 +299,7 @@ local (default) openebs.io/local Delete WaitForFirstConsumer false 31s 2024-12-17T21:00:58.086+0800 Password: 2uO5PZ2X ``` -打开浏览器，输入提供的 URL，并使用得到的初始密码登录 Olares 引导页面。按照屏幕提示即可完成系统激活。安装流程至此结束。 +打开浏览器，输入提供的 URL，并使用得到的初始密码登录 Olares 引导页面。按照屏幕提示即可完成系统激活。 ## 了解更多 diff --git a/docs/zh/developer/install/olares-home.md b/docs/zh/developer/install/olares-home.md index fe9776ce..b0efc255 100644 --- a/docs/zh/developer/install/olares-home.md +++ b/docs/zh/developer/install/olares-home.md @@ -5,8 +5,8 @@ Olares Home 是 Olares 的默认安装目录，用于存储镜像、日志、依 ## 路径及设置 Olares Home 默认路径为 `~/.olares`。你可以通过以下方式自定义其位置： -- 设置环境变量 [`olares-home`](environment-variables.md)。 -- 使用 `olares-cli` 提供的 [`base_dir`](./cli/olares-install.md#options)命令更改路径。 +- 设置环境变量 `OLARES-HOME`。 +- 使用 `olares-cli` 提供的 `--base-dir` 命令更改路径。 ## 目录结构 @@ -18,25 +18,25 @@ Olares Home 目录结构如下： │   ├── {镜像文件}.tar.gz │   └── {镜像文件}.tar.gz ├── logs # 存放所有日志 -├── pkg # 存放下载的系统依赖组件 -│   ├── cni # K8s的网络插件 -│   ├── components # 存放与K8s无关的Olaers基础软件依赖，如olaresd/JuiceFS/Redis等 +├── pkg # 存放下载的系统依赖组件 +│   ├── cni # K8s 的网络插件 +│   ├── components # 存放与 K8s 无关的 Olaers 基础软件依赖，如 olaresd/JuiceFS/Redis 等 │   ├── containerd # CRI runtime -│   ├── crictl # CRI命令行工具 -│   ├── etcd # K8s的持久化数据库 -│   ├── helm # K8s的app管理命令行工具 -│   ├── kube # 存放K8s的核心程序，如kubeadm/kubelet/k3s +│   ├── crictl # CRI 命令行工具 +│   ├── etcd # K8s 的持久化数据库 +│   ├── helm # K8s 的 app 管理命令行工具 +│   ├── kube # 存放 K8s 的核心程序，如 kubeadm/kubelet/k3s │   └── runc # OCI runtime -└── versions # 存放不同的Olares版本 +└── versions # 存放不同的 Olares 版本 ├── v1.10.0-20241001 # olares 安装版本 │   ├── cli │   ├── deploy │   ├── files │   ├── images - │ ├── logs # 存放该Olares版本相关的日志 + │ ├── logs # 存放该 Olares 版本相关的日志 │ │   ├── install.log │ │   └── uninstall.log - │   └── wizard # 存放Olares自带的系统及用户应用Helm chart + │   └── wizard # 存放 Olares 自带的系统及用户应用 Helm chart └── v1.10.0-20240930 ├── cli ├── deploy @@ -48,12 +48,10 @@ Olares Home 目录结构如下： └── wizard ``` -## 关键特性 - -Olares 提供了高效的文件管理和灵活的版本切换能力，帮助用户简化安装和使用流程。 -- 不同版本的 Olares 被存储在 `versions` 目录下，每个版本有版本相关的文件和日志。 +Olares Home 的结构设计旨在优化文件管理、版本控制和资源共享，其优势包括： +- 不同版本的 Olares 存储在 `versions` 目录下，版本相关的所有文件和日志都集中在对应的子目录中。 - 一台机器上只能运行一个 Olares 实例，避免版本冲突。 -- 不同版本会共享 `images` 和 `pkg` 目录下的文件，避免重复下载。 +- 不同版本会共享 `images` 和 `pkg` 目录下的文件，避免重复下载，节省磁盘空间。 ## 了解更多 From d7aa86f8f952f4197da79e63a868214a5df9d70e Mon Sep 17 00:00:00 2001 From: Yajing <110797546+fnalways@users.noreply.github.com> Date: Thu, 9 Jan 2025 15:57:46 +0800 Subject: [PATCH 02/13] Apply suggestions from code review Co-authored-by: Calvin W. --- docs/developer/install/installation-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer/install/installation-overview.md b/docs/developer/install/installation-overview.md index 266e8b37..55b2480d 100644 --- a/docs/developer/install/installation-overview.md +++ b/docs/developer/install/installation-overview.md @@ -59,13 +59,13 @@ olaresd is the system daemon that runs in the background, providing essential ma - **Remote system management**: Executes remote system operations, such as Olares installation and activation, based on requests issued from the LarePass client or `olares-cli`. ### CUDA support -To enable GPU acceleration for local AI models and applications, Olares supports the installation of the CUDA toolkit and drivers through `olares-cli`. +To enable GPU acceleration for local AI models and applications, Olares supports automatic installation of the CUDA toolkit and drivers through [`olares-cli`](./cli/gpu.md). ## Container orchestration layer The container orchestration layer integrates system components into an efficient runtime environment using Kubernetes. ### Roles of Kubernetes -Kubernetes serves as the backbone of this layer, providing automated deployment, operation, scaling, and management of multi-component services. +Kubernetes serves as the backbone of the container orchestration layer, providing automated deployment, operation, scaling, and management of multi-component services. Compared to tools like Docker Compose or Docker Swarm, Kubernetes offers: - High scalability and production-grade reliability. From e7bca0ace77a7c473644e85ab0433363a287d786 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 16:18:54 +0800 Subject: [PATCH 03/13] Update usage example --- .../install/environment-variables.md | 23 ++++--------------- 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/docs/developer/install/environment-variables.md b/docs/developer/install/environment-variables.md index ec36d5ce..723deba1 100644 --- a/docs/developer/install/environment-variables.md +++ b/docs/developer/install/environment-variables.md @@ -4,26 +4,13 @@ Olares provides a highly customizable installation process through the use of en ## Usage examples -To customize the installation process, you can define environment variables in several ways: - -- Specify the variables inline while running the installation script: - - ```bash - KUBE_TYPE=k8s bash install.sh - ``` - -- Export the variables first, then run the script: - +To use environment variables, you typically export them before running the one-line installation script. For example: + ```bash export KUBE_TYPE=k8s bash install.sh ``` - -- Use `&&` to chain commands: - - ```bash - export KUBE_TYPE=k8s && bash install.sh - ``` +In this example, the `KUBE_TYPE` variable is set to `k8s`. This will instruct `olares-cli` to install the full Kubernetes (K8s) instead of the lightweight K3s version. You can also combine multiple environment variables for more flexible customization, for example: @@ -59,7 +46,7 @@ Runs only the pre-installation phase (system dependency setup) without proceedin - **Usage**: Only applicable with `install.sh`. ### `JUICEFS` -Installs [JuiceFS](https://juicefs.com/) alongside Olares. Should only be used with `install.sh`. +Installs [JuiceFS](https://juicefs.com/) alongside Olares. - **Valid values**: `1` - **Default**: None (JuiceFS is not installed if not set). - **Usage**: Only applicable with `install.sh`. @@ -204,4 +191,4 @@ Specifies the endpoint for the Olares Tailscale control-plane service. - **Valid values**: - `https://controlplane.snowinning.com` - `https://controlplane.api.jointerminus.cn` (Recommended for mainland China users with better connectivity) -- **Default**: `https://controlplane.snowinning.com` \ No newline at end of file +- **Default**: `https://controlplane.snowinning.com` From a0080a9af5c7901aba642709d83ee7a449f25dde Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 16:26:07 +0800 Subject: [PATCH 04/13] Update path config method --- docs/developer/install/olares-home.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/developer/install/olares-home.md b/docs/developer/install/olares-home.md index 724dd504..f6f54de2 100644 --- a/docs/developer/install/olares-home.md +++ b/docs/developer/install/olares-home.md @@ -4,10 +4,12 @@ ## Path configuration -By default, Olares Home is located at `~/.olares`. You can customize its location in the following ways: +By default, Olares Home is located at `~/.olares`. You can customize its location using the `--base-dir` option with a specific `olares-cli` command, for example: -- Set the environment variable `OLARES-HOME`. -- Use the `olares-cli` command-line option `base-dir` to change the path. +```bash +# Specifies the base directory where all downloaded components will be saved +olares-cli olares download component --base-dir /custom/path +``` ## Directory structure @@ -60,4 +62,4 @@ The structure of Olares Home is designed to optimize file management, version co ## Learn more - [Olares CLI](../install/cli/olares-cli.md) - [Olares installation process](installation-process.md) -- [Olares environment variables](environment-variables.md) \ No newline at end of file +- [Olares environment variables](environment-variables.md) From 4944fbe9438f94c9c4b9be57efea317b5c2ec1f7 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 16:54:07 +0800 Subject: [PATCH 05/13] Update environment-variables for cn.md --- .../install/environment-variables.md | 43 ++++++------------- 1 file changed, 13 insertions(+), 30 deletions(-) diff --git a/docs/zh/developer/install/environment-variables.md b/docs/zh/developer/install/environment-variables.md index ba7e0c8b..8a766317 100644 --- a/docs/zh/developer/install/environment-variables.md +++ b/docs/zh/developer/install/environment-variables.md @@ -1,33 +1,16 @@ # Olares 环境变量参考 -在大多数场景下，你只需通过一行脚本即可完成 Olares 的快速安装和使用。 -然而，为了满足更细化的安装需求，Olares 安装脚本也支持通过一系列环境变量来改变默认的配置和行为。 +Olares 提供了丰富的环境变量以满足定制化安装需求。通过修改这些变量，你可以覆盖默认安装设置，实现灵活的个性化安装配置。 ## 使用示例 -::: tip 提示 -下文示例以 `KUBE_TYPE=k8s`（指定安装 K8S）为例，其他环境变量的用法类似。 -::: - -- 在执行安装脚本时直接指定： - - ```bash - KUBE_TYPE=k8s bash cn.install.sh - ``` - -- 先导出环境变量，再执行脚本： - - ```bash - export KUBE_TYPE=k8s - bash install.sh - ``` - -- 使用 **&&** 链式命令： - - ```bash - export KUBE_TYPE=k8s && bash install.sh - ``` +你可以按以下示例中的方式为安装脚本指定环境变量： +```bash +export KUBE_TYPE=k8s +bash install.sh +``` +该示例为安装脚本指定了 `KUBE_TYPE=k8s` 的环境变量设置，这会引导 `olares-cli` 安装完整的 Kubernetes (K8s) 而非轻量级的 K3s 版本。 当然，你也可以组合多个环境变量来实现更灵活的自定义效果。例如中国大陆的用户通过`cn.olares.sh`获取的安装脚本，就是一个在默认安装脚本之上设置了一系列环境变量的脚本： @@ -59,32 +42,32 @@ curl -sSfL https://olares.sh | bash 以下列出了安装脚本所支持的全部环境变量，以及它们的默认值、可选值和说明。你可以根据具体需求进行配置。 ### KUBE_TYPE -指定要使用的 Kubernetes 发行版。如果需要完整版本的 k8s，请将其设置为 `k8s`。仅在执行 `install.sh` 时生效。 +指定要使用的 Kubernetes 发行版。如果需要完整版本的 k8s，请将其设置为 `k8s`。 - **可选值**: `k8s` / `k3s` - **默认值**: `k3s` ### REGISTRY_MIRRORS -设置 Docker 镜像加速地址。仅在执行 `install.sh` 时生效。 +设置 Docker 镜像加速地址。 （如果不设置，则默认使用 `https://registry-1.docker.io`） - **可选值**: `https://mirrors.joinolares.cn` 或其他镜像源地址 - **默认值**: `https://registry-1.docker.io` ### PREINSTALL -当该值设为 `1` 时，仅完成预安装阶段（安装系统依赖）。如果未设置或留空，则完整安装 Olares。仅在执行 `install.sh` 时生效。 +当该值设为 `1` 时，仅完成预安装阶段（安装系统依赖）。如果未设置或留空，则完整安装 Olares。 - **可选值**: `1` - **默认值**: 无 ### JUICEFS -当该值设为 `1` 时，安装 [JuiceFS](https://juicefs.com/)，默认不安装。仅在执行 `install.sh` 时生效。 +当该值设为 `1` 时，安装 [JuiceFS](https://juicefs.com/)，默认不安装。 - **可选值**: `1` - **默认值**: 无 ### TERMINUS_OS_DOMAINNAME -在安装前预先设置域名，可跳过安装过程中的交互式提示。 +在安装前预先设置域名，会跳过安装过程中的交互式提示。 - **可选值**: 任意有效域名 - **默认值**: 无 @@ -235,4 +218,4 @@ curl -sSfL https://olares.sh | bash - **可选值**: - `https://controlplane.snowinning.com` - `https://controlplane.api.jointerminus.cn` -- **默认值**: `https://controlplane.snowinning.com` \ No newline at end of file +- **默认值**: `https://controlplane.snowinning.com` From 22842dca4ab68b178d7c4829966409de4120d59f Mon Sep 17 00:00:00 2001 From: wangyajing <413741312@qq.com> Date: Thu, 9 Jan 2025 16:57:05 +0800 Subject: [PATCH 06/13] update wording related to installation script and installation command --- .../install/environment-variables.md | 47 +++++++------------ .../developer/install/installation-process.md | 4 -- docs/developer/install/versioning.md | 2 +- docs/zh/developer/install/versioning.md | 2 +- 4 files changed, 18 insertions(+), 37 deletions(-) diff --git a/docs/developer/install/environment-variables.md b/docs/developer/install/environment-variables.md index ec36d5ce..f8881146 100644 --- a/docs/developer/install/environment-variables.md +++ b/docs/developer/install/environment-variables.md @@ -4,39 +4,24 @@ Olares provides a highly customizable installation process through the use of en ## Usage examples -To customize the installation process, you can define environment variables in several ways: - -- Specify the variables inline while running the installation script: - - ```bash - KUBE_TYPE=k8s bash install.sh - ``` - -- Export the variables first, then run the script: - - ```bash - export KUBE_TYPE=k8s - bash install.sh - ``` - -- Use `&&` to chain commands: - - ```bash - export KUBE_TYPE=k8s && bash install.sh - ``` - -You can also combine multiple environment variables for more flexible customization, for example: +To customize the installation process, you can set the environment variables before running the installation command. For example: ```bash +# Specify Kubernetes (k8s) instead of k3s export KUBE_TYPE=k8s \ - REGISTRY_MIRRORS="https://mirrors.joinolares.cn" \ - FRP_ENABLE=1 && \ -bash install.sh +&& curl -sSfL https://olares.sh | bash - +``` +Or, if you have already downloaded the installation script `install.sh`: + +```bash +# Specify Kubernetes (k8s) instead of k3s +export KUBE_TYPE=k8s && bash install.sh ``` +Both methods achieve the same result. The environment variable `KUBE_TYPE` will be passed to the script, and the script will use it to modify its behavior. ## Environment variables reference -The section lists all the environment variables supported by the installation script, along with their default values, optional values, and descriptions. Configure them as needed. +The section lists all the environment variables, along with their default values, optional values, and descriptions. Configure them as needed. ### `KUBE_TYPE` Determines the Kubernetes distribution to install. @@ -44,25 +29,25 @@ Determines the Kubernetes distribution to install. - `k8s` (full Kubernetes) - `k3s` (lightweight Kubernetes) - **Default**: `k3s` -- **Usage**: Only applicable with `install.sh`. +- **Usage**: Must be used with `install.sh` or with the installation command. ### `REGISTRY_MIRRORS` Specifies a custom Docker registry mirror for faster image pulls. - **Valid values**: `https://mirrors.joinolares.cn` or any other valid URL - **Default**: `https://registry-1.docker.io` -- **Usage**: Only applicable with `install.sh`. +- **Usage**: Must be used with `install.sh` or with the installation command. ### `PREINSTALL` Runs only the pre-installation phase (system dependency setup) without proceeding with the full Olares installation. - **Valid values**: `1` - **Default**: None (full installation is performed if not set). -- **Usage**: Only applicable with `install.sh`. +- **Usage**: Must be used with `install.sh` or with the installation command. ### `JUICEFS` -Installs [JuiceFS](https://juicefs.com/) alongside Olares. Should only be used with `install.sh`. +Installs [JuiceFS](https://juicefs.com/) alongside Olares. - **Valid values**: `1` - **Default**: None (JuiceFS is not installed if not set). -- **Usage**: Only applicable with `install.sh`. +- **Usage**: Must be used with `install.sh` or with the installation command. ### `TERMINUS_OS_DOMAINNAME` Sets the domain name before installation and skip the interactive prompt. diff --git a/docs/developer/install/installation-process.md b/docs/developer/install/installation-process.md index ce734e58..f6df9279 100644 --- a/docs/developer/install/installation-process.md +++ b/docs/developer/install/installation-process.md @@ -182,10 +182,6 @@ WantedBy=multi-user.target ... ``` -### Optional settings - -If you want to enable distributed shared storage (e.g., JuiceFS, Redis, MinIO) or GPU support (CUDA), you can set corresponding [environment variables](environment-variables.md) when running the installation script. - ## Install phase The install phase brings all system components online and ensures the runtime environment is fully operational. diff --git a/docs/developer/install/versioning.md b/docs/developer/install/versioning.md index aed0d16a..9ecb2b12 100644 --- a/docs/developer/install/versioning.md +++ b/docs/developer/install/versioning.md @@ -16,7 +16,7 @@ Olares offers three types of releases: **Stable**, **Release Candidate (RC)**, a ### Stable releases -Stable releases are thoroughly tested versions suitable for production environments. The official installation script (`https://olares.sh`) always defaults to the latest stable version. +Stable releases are thoroughly tested versions suitable for production environments. The official one-line installation command always defaults to the latest stable version. - **Release cadence**: Monthly - **Examples**: `v1.10.5`, `v1.11.0`, `v1.11.1`, `v1.12.0` diff --git a/docs/zh/developer/install/versioning.md b/docs/zh/developer/install/versioning.md index 68cae6aa..75498e8c 100644 --- a/docs/zh/developer/install/versioning.md +++ b/docs/zh/developer/install/versioning.md @@ -15,7 +15,7 @@ Olares 提供三种类型的版本：**正式版**、**候选（RC）版**和** ### 正式版 -正式版是经过全面测试后发布的版本，适用于生产环境。官方安装脚本（`https://olares.sh`）始终默认安装最新发布的正式版。 +正式版是经过全面测试后发布的版本，适用于生产环境。官方的一行安装命令始终默认安装最新发布的正式版。 - **发布节奏**：每月一次 - **示例**：`v1.10.5`、`v1.11.0`、`v1.11.1`、`v1.12.0` From 9bfea915b908faaa7774a86be9b8d5f9fbe91af5 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 16:57:28 +0800 Subject: [PATCH 07/13] Update environment-variables.md --- docs/developer/install/environment-variables.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/developer/install/environment-variables.md b/docs/developer/install/environment-variables.md index 723deba1..52e8b127 100644 --- a/docs/developer/install/environment-variables.md +++ b/docs/developer/install/environment-variables.md @@ -31,25 +31,21 @@ Determines the Kubernetes distribution to install. - `k8s` (full Kubernetes) - `k3s` (lightweight Kubernetes) - **Default**: `k3s` -- **Usage**: Only applicable with `install.sh`. ### `REGISTRY_MIRRORS` Specifies a custom Docker registry mirror for faster image pulls. - **Valid values**: `https://mirrors.joinolares.cn` or any other valid URL - **Default**: `https://registry-1.docker.io` -- **Usage**: Only applicable with `install.sh`. ### `PREINSTALL` Runs only the pre-installation phase (system dependency setup) without proceeding with the full Olares installation. - **Valid values**: `1` - **Default**: None (full installation is performed if not set). -- **Usage**: Only applicable with `install.sh`. ### `JUICEFS` Installs [JuiceFS](https://juicefs.com/) alongside Olares. - **Valid values**: `1` - **Default**: None (JuiceFS is not installed if not set). -- **Usage**: Only applicable with `install.sh`. ### `TERMINUS_OS_DOMAINNAME` Sets the domain name before installation and skip the interactive prompt. From 4930ba6c6e6d4214937eb9dee3a1b451f5731d91 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 17:15:56 +0800 Subject: [PATCH 08/13] Update olares-home for consitency.md --- docs/zh/developer/install/olares-home.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/zh/developer/install/olares-home.md b/docs/zh/developer/install/olares-home.md index b0efc255..96a13c43 100644 --- a/docs/zh/developer/install/olares-home.md +++ b/docs/zh/developer/install/olares-home.md @@ -1,12 +1,15 @@ # Olares Home -Olares Home 是 Olares 的默认安装目录，用于存储镜像、日志、依赖组件以及版本管理数据。 +Olares Home 是 Olares 的默认安装目录，用于存储镜像、日志、依赖组件以及版本管理数据。本文将带你了解 Olares Home 的结构，更全面掌握 Olares 安装过程。 ## 路径及设置 -Olares Home 默认路径为 `~/.olares`。你可以通过以下方式自定义其位置： -- 设置环境变量 `OLARES-HOME`。 -- 使用 `olares-cli` 提供的 `--base-dir` 命令更改路径。 +默认情况下，Olares Home 位于 `~/.olares`。你可以执行 `olares-cli` 命令时配合 `--base-dir` 选项更改其位置。例如： + +```bash +# 指定所有下载组件的存储目录 +olares-cli olares download component --base-dir /custom/path +``` ## 目录结构 @@ -57,4 +60,4 @@ Olares Home 的结构设计旨在优化文件管理、版本控制和资源共 - [`olares-cli` 命令行参考](../install/cli/olares-cli.md) - [Olares 安装过程](installation-process.md) -- [Olares 环境变量](environment-variables.md) \ No newline at end of file +- [Olares 环境变量](environment-variables.md) From 5431d1cc932aa97f3063b8bcef7b41d5956dc112 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 18:11:48 +0800 Subject: [PATCH 09/13] Update cn translation for installation-overview.md --- .../install/installation-overview.md | 84 +++++++++++-------- 1 file changed, 48 insertions(+), 36 deletions(-) diff --git a/docs/zh/developer/install/installation-overview.md b/docs/zh/developer/install/installation-overview.md index a39c1b92..f600ff9d 100644 --- a/docs/zh/developer/install/installation-overview.md +++ b/docs/zh/developer/install/installation-overview.md @@ -1,79 +1,91 @@ # Olares 安装概述 -本文档介绍 Olares 安装的整体架构及核心组件。 - -执行安装脚本后，你将首先安装 `olares-cli`。`olares-cli` 是一个 Olares 的命令行工具，用于安装维护 Olares 集群、管理应用、管理用户、以及扩展硬件节点等日常任务。`olares-cli` 会主导后续组件的安装，具体包括： - +本文档概述了 Olares 的安装流程，重点介绍其整体架构和核心组件，旨在为系统管理员和开发者提供 Olares 的运行原理及安装方法的基本了解。 ![Install arch](/images/developer/install/olares-install.png) +## Olares 安装的三层结构 + +Olares 的安装流程分为三个关键层级： - **操作系统层**：处理 Linux 系统配置与基础环境依赖安装。 - **容器编排层**：部署 Kubernetes 集群，实现服务的自动化管理与扩展。 - **容器化层**：启动容器化的系统核心服务和用户应用，提供最终运行环境。 +安装过程由命令行工具 `olares-cli` 管理。该工具负责协调所有组件的安装、配置以及生命周期管理。 + ::: tip 提示 -要了解这些组件涉及的具体安装过程，请参考 [Olares 安装过程](installation-process.md)文档。 +要了解安装的详细过程，请参考 [Olares 安装分解](installation-process.md)文档。 ::: -## 操作系统层面 -Olares 的安装从操作系统层面开始，确保底层 Linux 环境支持分布式存储、容器运行时和 Kubernetes 集群管理。该层的配置涵盖 Linux 系统的核心环境设置、文件系统初始化、容器运行时安装以及关键系统服务部署。 +## 操作系统层 +Olares 的安装从操作系统层面开始，确保底层 Linux 环境支持分布式存储、容器运行时和 Kubernetes 集群管理。 + +该层的配置涵盖核心 Linux 环境设置、文件系统初始化、容器运行时安装以及关键系统服务部署。 ### 环境配置 -安装 Olares 时，系统首先会 Linux 进行基本安装环境配置，如配置 DNS、SSH、NTP 服务，确保时间同步与远程管理。同时，也会安装必要依赖，如 gcc、net-tools 等系统工具，确保运行时环境。 +安装 Olares 时，系统首先会 Linux 进行基本安装环境配置，如配置域名解析系统 （DNS）、安全外壳（SSH）远程访问协议、网络时间协议 （NTP）等服务，以确保时间同步与远程管理。 + +同时，也会安装必要依赖，如 GNU 编译器集合（GCC）、网络工具（net-tools） 等系统工具，确保运行时环境。 ### 文件系统配置 -文件系统（rootfs）用于存取系统核心组件与用户数据。根据安装模式，支持以下两种文件系统： +文件系统（rootfs）用于存取系统核心组件与用户数据。根据部署要求，支持以下两种文件系统： + +- LocalFS（默认）：使用本地 Linux 磁盘进行存储，适用于无需网络共享且需要高数据吞吐量的单节点部署。 -- **LocalFS**：默认文件系统。使用 Linux 本地磁盘作为存储系统。适用于单节点部署，数据吞吐要求高，且无网络共享需求的日常部署场景。 +- JuiceFS：为多节点集群提供分布式文件系统。文件数据可以存储在本地安装的 MinIO 实例中，也可以存储在 Amazon S3 这一类远程存储桶中。该配置支持不同存储节点共享统一的存储视图。 -- **JuiceFS**：分布式文件系统。该方式使用 JuiceFS 充当文件系统网关，将文件数据存入 Olares 本地安装的 MinIO，或是远端存储桶（如 S3）。不同存储节点可拥有统一的存储视图。该方式适用于多节点集群部署，数据跨节点共享的场景。JuiceFS 和 MinIO 默认不安装，需安装时设置[环境变量](environment-variables.md#juicefs)或用 [olares-cli 脚本](./cli/olares-prepare.md#选项)配合 JuiceFS 相应参数安装。 +:::tip 启用 JuiceFS +JuiceFS 和 MinIO 默认不安装，需安装时设置必要的[环境变量](environment-variables.md#juicefs)或用 [olares-cli 命令](./cli/olares-prepare.md#选项)配合 JuiceFS 相应参数安装。 ### 容器运行时：containerd +Olares 使用轻量级容器运行时 containerd 进行容器化部署，其主要功能包括： Olares 的核心组件全部都是容器化发布和部署的，因此需要安装轻量级容器运行时 containerd。功能如下： -- 容器镜像管理：将打包好的容器镜像从 CDN 下载下来，在环境预装阶段导入至 containerd, 并在正式安装环节以容器进程的方式启动镜像。 -- 容器生命周期管理：负责启动、停止、重启和监控容器化应用服务。 - -::: tip containerd 与 Olares 兼容性问题 -如果系统之前安装过 containerd，尤其是以 Docker 形式安装的，可能会与 Olares 有兼容性问题。请卸载之后再安装 Olares。 +- **容器镜像管理** + - 从内容分发网络（CDN）下载已打包的容器镜像。 + - 在预装阶段导入将下载镜像导入至 containerd, + - 在安装环阶段以容器进程的方式启动镜像。 + +- **容器生命周期管理**：启动、停止、重启和监控容器化应用服务。 + +::: tip 兼容性问题 +如果你的机器之前安装过 containerd，比如通过 Docker 安装，可能会与 Olares 安装的 containerd 有兼容性问题。请卸载已有版本之后再安装 Olares。 ::: ### 系统守护进程：olaresd -olaresd 是 Olares 的系统守护进程，以 system daemon 服务的形式持续在后台运行。它主要提供以下系统管理服务： -- 自动化配置更新：当 IP 地址或相关配置项发生变更时，自动调检测并调整。 -- 系统管理：通过 LarePass 客户端或命令行的请求，执行 Olares 安装、激活、恢复出厂设置、连接 Wi-Fi 等系统操作。 +olaresd 是系统守护进程，运行于后台，提供以下关键管理功能： +- 自动配置更新：当系统发生变化（如 IP 地址变更）时，自动检测并调整相关配置项。 +- 远程系统管理：通过 LarePass 客户端或 `olares-cli` 命令处理远程操作系统，例如 Olares 的安装、激活、恢复出厂设置以及 Wi-Fi 连接。 ### CUDA 支持 -Olares 集成了强大的本地 AI 能力。为了确保用户在 Olares 部署的本地 AI 模型和应用可充分利用 NVIDIA 显卡的性能，用户可通过配置相关环境变量安装统一计算架构（CUDA）的工具包及相应驱动。 +为了为本地 AI 模型和应用启用 GPU 加速，Olares 支持通过 `olares-cli` 自动检测并安装 CUDA 工具包和相关驱动程序。 ## 容器编排层：Kubernetes -在完成操作系统层的环境准备后，Olares 的安装会进入容器编排层。这一层的主要任务是将系统的各个组件（核心服务、辅助工具、用户应用）整合到一个有序、高效且易于扩展的运行环境中。这一层的核心是 Kubernetes，它为多组件服务的自动化部署、运行、扩缩和管理提供了基础框架。 - -### 为什么使用 Kubernetes？ - -在容器编排领域，Kubernetes 是公认的事实标准。相比早期的 docker-compose 或 Docker Swarm，Kubernetes 在社区活跃度、架构可扩展性、生产级别的可靠性与安全性方面有着显著优势。同时，其强大的生态意味着海量系统应用可通过 Helm Charts、Operators、CRD（自定义资源定义）等方式轻松集成到 Olares 中，为用户提供更多样的选择和云原生的使用体验。 +容器编排层通过 Kubernetes 将系统组件集成到高效的运行环境中。 -### Olares 的 Kubernetes 选择 +### Kubernetes 的角色 -Olares 在以下 Linux 环境中，Olares 支持官方 Kubernetes 和 Rancher 的轻量级 K3s： +Kubernetes 是容器编排层的核心，负责实现多组件服务的自动部署、运行、扩展和管理。 -- Ubuntu/Debian -- Windows Subsystem for Linux (WSL) -- Proxmox Virtual Environment (PVE) -- 树莓派 +与 Docker Compose 或 Docker Swarm 等工具相比，Kubernetes 提供了以下优势： +- 高可扩展性和生产级可靠性：适用于大规模集群部署和关键任务环境。 +- 丰富的社区支持：拥有活跃的社区和丰富的生态系统，可通过 Helm Charts、Operators 和自定义资源定义（CRDs）集成各种应用程序。 -默认会选择 K3s 以在本地硬件上取得更佳性能和资源利用效率。 +### Olares 支持的 Kubernetes 版本 -在 macOS 上，Olares 通过 Minikube 在 Linux 虚拟机中部署 Kubernetes，从而确保底层功能和用户体验的一致性。 +Olares 支持以下 Kubernetes 部署方式： + • K3s（默认）：轻量级 Kubernetes 发行版，可优化本地硬件上的资源利用效率。 + • Kubernetes：完整功能的 Kubernetes 发行版，适用于高级或自定义部署需求。 + • Minikube（仅限 macOS）：通过 Minikube 工具部署的本地单节点 Kubernetes 集群，确保一致的功能和用户体验。 ## 容器化层：Olares 的应用运行机制 -容器化层就是 Olares 系统的最终呈现形式。在这一层中，Olares 的所有组件（如存储管理、认证服务、应用网关等）和用户应用都运行在容器内，通过 Kubernetes 进行全生命周期管理，确保系统高效、稳定和可扩展。 +在容器化层，Olares 各组件和应用协同工作提供系统完整功能。所有组件和用户应用程序都运行在容器中，并通过 Kubernetes 进行全生命周期管理。种架构确保了系统的高效性、稳定性和可扩展性。 -你可以在一个已经安装了 Olares 的环境上，使用**控制面板**应用查看正在运行的容器： +在安装并激活 Olares 后，您可以通过控制面板应用的图形界面查看正在运行的容器。 ![Running pods](/images/developer/install/running-pods.png) @@ -83,4 +95,4 @@ Olares 在以下 Linux 环境中，Olares 支持官方 Kubernetes 和 Rancher - [Olares 安装过程](installation-process.md) - [Olares Home 概述](olares-home.md) - [`olares-cli` 命令行参考](../install/cli/olares-cli.md) -- [Olares 环境变量](environment-variables.md) \ No newline at end of file +- [Olares 环境变量](environment-variables.md) From 9b5ade3cda7ac324e3b636779cadc2b6f2f659f5 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 20:33:40 +0800 Subject: [PATCH 10/13] Update cn translation for installation-process.md --- .../developer/install/installation-process.md | 154 ++++++++++-------- 1 file changed, 88 insertions(+), 66 deletions(-) diff --git a/docs/zh/developer/install/installation-process.md b/docs/zh/developer/install/installation-process.md index 996de96a..5d756716 100644 --- a/docs/zh/developer/install/installation-process.md +++ b/docs/zh/developer/install/installation-process.md @@ -1,42 +1,46 @@ -# Olares 安装流程 +# Olares 安装分解 +本文档从四个主要阶段详细说明 Olares 的安装流程，包括各阶段的底层命令、配置和逻辑。文档适用于希望深入了解安装过程的开发者和系统管理员。 -通常，安装 Olares 会从以下脚本开始， +## 四个安装阶段 -```bash -curl -fsSL https://cn.olares.sh | bash - -``` +Olares 的安装可分为以下四个阶段： -该脚本首先会下载并安装最新版的 `olares-cli` 命令行工具，之后即自动开始执行 Olares 集群的安装流程。为了提高稳定性和效率，Olares 的安装分为四个阶段：**Precheck（预检）**、**Download（下载）**、**Prepare（预装环境）**、**Install（安装）**。 +- **预检（Precheck）**：验证系统环境是否满足 Olares 安装的所有前置条件。 +- **下载（Download）**：获取安装所需的所有文件、依赖项和容器镜像。 +- **环境准备（Prepare）**：配置操作系统和系统服务，为 Kubernetes 和 Olares 组件创建就绪的环境。 +- **安装（Install）**：部署 Kubernetes，集成 KubeSphere，并安装 Olares 的核心服务和应用程序。 -本文档将为你详细介绍每个安装阶段的步骤与细节。 +## 预检阶段 -## Precheck（预检） +预检阶段的重点是验证系统是否满足安装 Olares 的必要条件。通过运行 `olares-cli olares precheck`命令执行一系列验证检查。若在此阶段发现任何问题，需在继续安装前解决。 -Olares 的安装及运行都需要宿主系统满足一系列的条件。在实际安装前，脚本将执行 `olares-cli olares precheck` 命令，对这些条件预先进行检查。若条件不满足，则会提供提示信息并退出安装流程。具体来说，会针对以下条件进行预检： -- 操作系统类型、版本号以及处理器架构的兼容性检测 -- 系统是否是以 `Systemd` 作为初始化进程启动 -- Olares 对外暴露服务所需的网络端口是否可用 -- 系统是否已安装了冲突的容器运行时 +关键预检项目包括： +- 检查操作系统类型、版本号以及处理器架构是否兼容 +- 确保系统使用 `Systemd` 作为初始化进程 +- 验证 Olares 需要暴露的多个网络端口是否可用 +- 系统里是否存在与 Olares 冲突的容器运行时 -下图是一个预检不通过的示例，其中有两项检查失败了： +下图是一个预检失败的示例： ![Precheck](/images/developer/install/precheck.png) -- Olares 所需的`9100`端口已被占用 -- 系统中存在已有的容器运行时 +在此示例中，有两项检查失败： +- Olares 所需的端口 `9100` 已被占用。 +- 系统中检测到已有的容器运行时。 -需解决这些问题后，再次尝试安装。 +必须解决这些问题后才可继续安装。 +## 下载阶段 -## Download（下载） - -Download 阶段会下载 Olares 安装所需的 wizard 文件及系统所依赖的组件和容器镜像。 +下载阶段会下载 Olares 安装所需的 Wizard 文件、系统依赖组件和容器镜像。 ### 下载 Wizard 文件 -Wizard 文件是 Olares 的安装包的元数据，包含了 Olares 不同组件的下载地址及安装配置。安装脚本会解压该文件到 `$HOME/.olares/versions/` 目录，其中， +Wizard 文件是一个元数据包，包含所有 Olares 组件的下载链接和配置信息。Wizard 文件是此阶段首个被获取的文件，为后续的下载提供了关键信息。 + +Wizard 文件会被默认解压存储至 `$HOME/.olares/versions/` 目录，其中， -- `$HOME/.olares`是 Olares 的基础安装目录，用于存储所有镜像、日志、依赖项以及其他版本相关文件。详细目录结构请参考 [Olares Home 概述](olares-home.md)文档。 -- `` 是此 wizard 文件对应的 Olares 版本号，如示例中的 `1.12.0-20241215`。 +- `$HOME/.olares`是 Olares 的基础安装目录， +- `` 是 Olares 版本号，如示例中的 `1.12.0-20241215`。 **示例脚本输出**： @@ -59,9 +63,12 @@ Greetings, Olares ### 下载安装所需组件与容器镜像 -Wizard 下载完成后，Olares CLI 会下载 Olares 所需的基础软件、容器镜像和依赖包，这些文件会保存在 `$HOME/.olares/pkg` 和 `$HOME/.olares/image` 下。 +Wizard 下载完成后，脚本会下载 Olares 所需的所有依赖组件和容器镜像。保存路径如下： -和 Wizard 的保存路径不同，大部分组件是通用且长期稳定的，不会保存在具体版本对应的路径下。因此重新安装时仅需对新增或更新的镜像进行增量下载，避免重复下载。 +- 依赖包：`$HOME/.olares/pkg` +- 容器镜像：`$HOME/.olares/image` + +这种存储结构支持在多个版本之间复用稳定组件，避免重复下载。 **示例脚本输出**： @@ -83,13 +90,21 @@ Greetings, Olares ... ``` -## Prepare（预装环境） +## 环境准备阶段 + +环境准备阶段的任务是配置操作系统进行，以支持 Kubernetes、容器镜像和 Olares 系统服务。 + +此阶段包括以下主要任务： +- 配置系统 +- 配置容器运行时 +- 安装系统守护进程 -在完成下载后，安装脚本将对操作系统进行配置，以保证能够顺利运行 Kubernetes、容器镜像等系统服务。 +### 配置系统 -### 安装与配置系统依赖 -- 调整 DNS、NTP、SSH 服务，确保机器网络正常、时间同步无误。 -- 通过 apt 安装必要依赖（curl、net-tools、gcc、make 等）。 +安装脚本会配置 Linux 环境以满足 Olares 的要求，这些配置包括： + +- 配置域名解析系统（DNS）、网络时间协议（NTP）和安全远程访问（SSH）等服务，确保机器网络正常、时间同步无误。 +- 通过 apt 方式安装必要的依赖项，如 curl、网络工具 （net-tools）、GNC 编译器集合 （GCC)、make 工具等。 **示例脚本输出** ```bash @@ -114,10 +129,11 @@ Hit:2 https://download.docker.com/linux/ubuntu jammy InRelease Hit:3 http://hk.archive.ubuntu.com/ubuntu jammy InRelease ... ``` -### 安装依赖组件及容器运行时 -- 将之前下载的依赖组件安装并启动。 +### 配置容器运行时 +容器运行时是运行容器化应用程序的关键组件。在此步骤中，安装脚本将： +- 安装并启动之前下载的依赖组件。 - 将 containerd 安装到系统中，并启动服务。 -- 将下载好的容器镜像全部导入到 containerd。 +- 将下载好的容器镜像导入至 containerd。 **示例脚本输出**： @@ -136,10 +152,10 @@ Hit:3 http://hk.archive.ubuntu.com/ubuntu jammy InRelease ... ``` -### 安装系统守护进程（olaresd） - -预安装阶段还会安装并启动 [olaresd](installation-overview.md#系统守护进程olaresd)，Olares 的系统守护进程服务。olaresd 会在后台运行并自动执行系统维护操作，如变更 IP 地址时自动更新配置。 +### 安装系统守护进程 +容器运行时配置完成后，Olares 系统守护进程 olaresd 会被安装并启动，用于监控系统并自动执行维护任务。 + **示例脚本输出**： ```bash @@ -164,27 +180,25 @@ WantedBy=multi-user.target 2024-12-17T19:52:32.033+0800 [A] ubuntu: EnableOlaresdService success (147.987242ms) ... ``` +## 安装阶段 +安装阶段将所有组件整合起来，并完成最终环境配置。在此阶段，脚本会执行以下关键任务： +- 部署 Kubernetes。 +- 集成 KubeSphere，实现云原生管理与可观测性。 +- 配置 Olares 账户。 +- 部署并启动内置应用和服务。 -### 可选安装项目 - -如果你想启用分布式共享存储（JuiceFS、Redis 以及MinIO）或 GPU 支持（CUDA），可在执行安装脚本时设置相应的[环境变量](environment-variables.md#olares-环境变量参考)。 +### 部署 Kubernetes -## Install (安装) +Kubernetes 是 Olares 系统的核心调度组件。在此步骤中，安装脚本会执行以下操作： -此阶段主要通过以下步骤完成： -- 部署并启动 Kubernetes。 -- 安装并配置 KubeSphere，提供云原生管理能力与可视化工具集。 -- 安装 Olares 账户。 -- 部署内置应用（如存储、备份、账号系统、文件服务等），完成 Olares 环境的所有功能模块。 +1. 启动 etcd 数据库。 +2. 启动并配置 Olares 默认的 Kubernetes 发行版 — K3s。 +3. 安装用于集群网络通信的容器网络界面（CNI） 插件。 +4. 将 `kubeconfig` 文件复制到当前用户目录，以便使用 `kubectl` 与集群进行交互。 -### 部署 Kubernetes -Olares 默认安装 K3s，一款轻量级的 Kubernetes 发行版。此步骤将： -1. 启动 etcd 数据库。 -2. 启动并配置 K3s。 -3. 安装容器网络界面（CNI）插件以提供集群网络能力。 -4. 将 `kubeconfig` 文件复制到当前用户路径，以便使用 `kubectl` 与集群交互。 +由于 K3s 轻量且易用，Olares 默认使用它作为 Kubernetes 的发行版。如果你有高级或自定义的配置需求，也可以选择安装完整的 Kubernetes。 -如果你选择安装官方的 Kubernetes，脚本将使用 `kubeadm` 完成部署。`kubeadm` 是 Kubernetes 提供的官方工具，可帮助你创建最低可行集群。在 macOS 上，脚本会使用 Minikube 来进行安装，不会执行上述安装步骤。 +在 macOS 环境下，脚本会使用 Minikube 部署集群，并跳过上述步骤。 **示例脚本输出** @@ -227,16 +241,21 @@ Olares 默认安装 K3s，一款轻量级的 Kubernetes 发行版。此步骤将 ... ``` -### 安装并集成 KubeSphere +### 集成 KubeSphere + +Olares 会基于 Kubernetes 安装 KubeSphere，以增强系统的管理和可观测性。主要特性包括： +- 系统监控与告警 +- 资源和工作区管理 +- 命名空间和自定义资源定义（CRD）管理 -Olares 会基于 Kubernetes 安装 KubeSphere。 Olares 集成了一部分 KubeSphere 的功能，主要用于系统监控、告警、工作空间管理等。此过程会创建一系列命名空间与 CRD（自定义资源定义）对象，并启动 KubeSphere 的后台服务。 +### 安装账户 -### 安装 Olares 账户 +Olares ID 在 LarePass 应用中创建。安装脚本会在此步骤中提示你输入以下信息，以便之后使用 LarePass 激活 Olares： -在KubeSphere 安装完成后，命令行会提示用户输入自己的 Olares ID。 这将创建一个系统账号用于登录 Olares，并且在后台完成多处访问与权限配置。 +- Olares 域名: Olares 默认提供了 `olares.com` 和 `olares.cn` 这两个域名。如果你已将自定义域名添加到 Olares Space，也可以在此步骤中输入自定义域名。 +- Olares ID: 输入 Olares ID 中的用户名部分。 -- Olares 域名: 默认为 `olares.cn`，可以自定义。 -- Olares ID: 输入 Olares ID 中的用户名部分。 +完成此步骤后，系统会为你创建一个用于登录 Olares 的账户，并完成相关的访问和权限配置。 **示例脚本输出**： @@ -250,14 +269,14 @@ Enter the Olares ID (which you registered in the LarePass app): marvin113 2024-12-17T20:58:52.584+0800 using password: 2uO5PZ2X ``` -### 安装 Olares 组件与内置应用 +### 安装 Olares 系统应用 -此步骤会会通过 Helm 部署 Olares 系统的核心功能与常用服务： +安装的最后一步会通过 Helm 部署 Olares 系统的核心服务与内置用户应用： -- 核心系统服务（`os-system` 命名空间）：如备份（Velero）、存储（OpenEBS）、Redis、Nats、MinIO 等关键组件。 -- 用户应用（`user-space-xxx` 命名空间）：如文件管理器、桌面、设置等系统应用。 +- 核心系统服务（`os-system` 命名空间）：包含备份（Velero）、存储（OpenEBS）、Redis、Nats、MinIO 等关键组件。 +- 用户应用（`user-space-xxx` 命名空间）：包含文件管理器、桌面、设置等系统应用。 -日志中会显示 `[helm] app installed success` 以及一系列 `xxx created` 的提示，表示对应的 Helm Chart 或 Kubernetes 资源安装成功。 +安装过程中，日志中会显示 `[helm] app installed success` 以及一系列 `xxx created` 的提示，表示对应的 Helm Chart 或 Kubernetes 资源安装成功。 **示例脚本输出**： ```bash @@ -279,9 +298,9 @@ local (default) openebs.io/local Delete WaitForFirstConsumer false 31s ... ``` -### 安装成功 +### 完成安装 -待所有组件启动并运行后，脚本会输出类似下面的汇总信息： +待所有组件部署成功后，脚本会输出包含激活向导页面 URL 的汇总信息： ```bash 2024-12-17T21:00:58.086+0800 [INFO] Installation wizard is complete @@ -299,7 +318,10 @@ local (default) openebs.io/local Delete WaitForFirstConsumer false 31s 2024-12-17T21:00:58.086+0800 Password: 2uO5PZ2X ``` -打开浏览器，输入提供的 URL，并使用得到的初始密码登录 Olares 引导页面。按照屏幕提示即可完成系统激活。 +此时，执行以下操作以完成安装： +1. 打开浏览器并输入提供的 URL。 +2. 使用初始密码登录激活向导。 +3. 按照屏幕提示完成激活流程。 ## 了解更多 From 5324e2eefb5400cc38b864cdfb214597f1af3580 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 20:44:10 +0800 Subject: [PATCH 11/13] remove usage description --- docs/developer/install/environment-variables.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/developer/install/environment-variables.md b/docs/developer/install/environment-variables.md index 009ea2c1..a3f0eb3f 100644 --- a/docs/developer/install/environment-variables.md +++ b/docs/developer/install/environment-variables.md @@ -29,25 +29,21 @@ Determines the Kubernetes distribution to install. - `k8s` (full Kubernetes) - `k3s` (lightweight Kubernetes) - **Default**: `k3s` -- **Usage**: Must be used with `install.sh` or with the installation command. ### `REGISTRY_MIRRORS` Specifies a custom Docker registry mirror for faster image pulls. - **Valid values**: `https://mirrors.joinolares.cn` or any other valid URL - **Default**: `https://registry-1.docker.io` -- **Usage**: Must be used with `install.sh` or with the installation command. ### `PREINSTALL` Runs only the pre-installation phase (system dependency setup) without proceeding with the full Olares installation. - **Valid values**: `1` - **Default**: None (full installation is performed if not set). -- **Usage**: Must be used with `install.sh` or with the installation command. ### `JUICEFS` Installs [JuiceFS](https://juicefs.com/) alongside Olares. - **Valid values**: `1` - **Default**: None (JuiceFS is not installed if not set). -- **Usage**: Must be used with `install.sh` or with the installation command. ### `TERMINUS_OS_DOMAINNAME` Sets the domain name before installation and skip the interactive prompt. From 018aeed13f6ed3324e89833aa0ba8cdd66312345 Mon Sep 17 00:00:00 2001 From: "Calvin W." Date: Thu, 9 Jan 2025 20:45:00 +0800 Subject: [PATCH 12/13] Update cn translation for environment-variables.md --- .../install/environment-variables.md | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/zh/developer/install/environment-variables.md b/docs/zh/developer/install/environment-variables.md index 8a766317..d3e0e265 100644 --- a/docs/zh/developer/install/environment-variables.md +++ b/docs/zh/developer/install/environment-variables.md @@ -4,13 +4,19 @@ Olares 提供了丰富的环境变量以满足定制化安装需求。通过修 ## 使用示例 -你可以按以下示例中的方式为安装脚本指定环境变量： +你可以在运行安装命令前设置环境变量，以自定义安装流程。例如： + ```bash + # 指定安装完整的 Kubernetes (k8s) 而非轻量级 k3s + export KUBE_TYPE=k8s \ + && curl -sSfL https://olares.sh | bash - + ``` -```bash -export KUBE_TYPE=k8s -bash install.sh -``` -该示例为安装脚本指定了 `KUBE_TYPE=k8s` 的环境变量设置，这会引导 `olares-cli` 安装完整的 Kubernetes (K8s) 而非轻量级的 K3s 版本。 +如果你已预先下载了安装脚本 `install.sh`，也可以使用以下方式： + ```bash + # 指定使用完整的 Kubernetes (k8s) 而非轻量级 k3s + export KUBE_TYPE=k8s && bash install.sh + ``` +两种方式的执行效果相同：环境变量 `KUBE_TYPE` 会传递给安装脚本，脚本会根据这个变量来调整其安装逻辑。 当然，你也可以组合多个环境变量来实现更灵活的自定义效果。例如中国大陆的用户通过`cn.olares.sh`获取的安装脚本，就是一个在默认安装脚本之上设置了一系列环境变量的脚本： @@ -58,14 +64,12 @@ curl -sSfL https://olares.sh | bash - **默认值**: 无 - ### JUICEFS 当该值设为 `1` 时，安装 [JuiceFS](https://juicefs.com/)，默认不安装。 - **可选值**: `1` - **默认值**: 无 - ### TERMINUS_OS_DOMAINNAME 在安装前预先设置域名，会跳过安装过程中的交互式提示。 - **可选值**: 任意有效域名 From 3335280b5ebb2e4dfbf78c3ae7dff02090efd515 Mon Sep 17 00:00:00 2001 From: Calvin W Date: Thu, 9 Jan 2025 21:09:54 +0800 Subject: [PATCH 13/13] update index file and fix links --- docs/developer/install/installation-overview.md | 2 +- docs/developer/install/installation-process.md | 2 +- docs/developer/install/olares-home.md | 2 +- docs/zh/developer/install/index.md | 6 +++--- docs/zh/developer/install/installation-overview.md | 2 +- docs/zh/developer/install/installation-process.md | 4 ++-- docs/zh/developer/install/olares-home.md | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/developer/install/installation-overview.md b/docs/developer/install/installation-overview.md index 55b2480d..d3399522 100644 --- a/docs/developer/install/installation-overview.md +++ b/docs/developer/install/installation-overview.md @@ -88,7 +88,7 @@ Once Olares is installed and activated, you can view the running containers thro ## Learn more -- [Olares installation process](installation-process.md) +- [Olares installation breakdown](installation-process.md) - [Olares Home](olares-home.md) - [Olares CLI](../install/cli/olares-cli.md) - [Olares environment variables](environment-variables.md) \ No newline at end of file diff --git a/docs/developer/install/installation-process.md b/docs/developer/install/installation-process.md index f6df9279..a4be1af2 100644 --- a/docs/developer/install/installation-process.md +++ b/docs/developer/install/installation-process.md @@ -308,7 +308,7 @@ After activation, your Olares will be fully operational and ready to use. ## Learn more - [Olares CLI reference](./cli/olares-cli.md) -- [Olares installation overview](installation-process.md) +- [Olares installation overview](installation-overview.md) diff --git a/docs/developer/install/olares-home.md b/docs/developer/install/olares-home.md index f6f54de2..441af6b4 100644 --- a/docs/developer/install/olares-home.md +++ b/docs/developer/install/olares-home.md @@ -61,5 +61,5 @@ The structure of Olares Home is designed to optimize file management, version co ## Learn more - [Olares CLI](../install/cli/olares-cli.md) -- [Olares installation process](installation-process.md) +- [Olares installation breakdown](installation-process.md) - [Olares environment variables](environment-variables.md) diff --git a/docs/zh/developer/install/index.md b/docs/zh/developer/install/index.md index ed0be091..a9e2f1ec 100644 --- a/docs/zh/developer/install/index.md +++ b/docs/zh/developer/install/index.md @@ -3,8 +3,8 @@ 本章节将为你提供关于 Olares 安装的详细信息和命令参考，帮助你探索、学习并自定义 Olares 的安装。 - [Olares 安装概览](installation-overview.md)：从整体架构和核心组件的角度了解 Olares 的安装过程。 -- [Olares 安装流程](installation-process.md)：详细了解 Olares 安装的各个阶段。 -- [Olares Home 介绍](olares-home.md)：了解 Olares 默认安装目录的结构，更全面理解 Olares 的安装流程。 +- [安装流程详解](installation-process.md)：详解 Olares 安装四个主要安装阶段。 +- [Olares Home 介绍](olares-home.md)：了解 Olares 默认安装目录的结构。 - [Olares 环境变量](environment-variables.md)：查找所需环境变量，定制你的 Olares 安装过程。 -- [Olares CLI 参考](./index.md)：使用 `olares-cli` 命令行工具，对 Olares 安装进行微调或排障。 +- [Olares CLI 参考](./index.md)：使用 Olares CLI 命令行工具，对 Olares 进行高级定制化安装或排查安装问题。 - [Olares 版本说明](versioning.md): 了解 Olares 的版本号规则、版本类型、分支管理实践以及升级策略。 \ No newline at end of file diff --git a/docs/zh/developer/install/installation-overview.md b/docs/zh/developer/install/installation-overview.md index f600ff9d..43dcfb6b 100644 --- a/docs/zh/developer/install/installation-overview.md +++ b/docs/zh/developer/install/installation-overview.md @@ -13,7 +13,7 @@ Olares 的安装流程分为三个关键层级： 安装过程由命令行工具 `olares-cli` 管理。该工具负责协调所有组件的安装、配置以及生命周期管理。 ::: tip 提示 -要了解安装的详细过程，请参考 [Olares 安装分解](installation-process.md)文档。 +要了解安装的详细过程，请参考 [安装流程详解](installation-process.md)文档。 ::: ## 操作系统层 diff --git a/docs/zh/developer/install/installation-process.md b/docs/zh/developer/install/installation-process.md index 5d756716..7f95fd86 100644 --- a/docs/zh/developer/install/installation-process.md +++ b/docs/zh/developer/install/installation-process.md @@ -1,4 +1,4 @@ -# Olares 安装分解 +# 安装流程详解 本文档从四个主要阶段详细说明 Olares 的安装流程，包括各阶段的底层命令、配置和逻辑。文档适用于希望深入了解安装过程的开发者和系统管理员。 ## 四个安装阶段 @@ -326,7 +326,7 @@ local (default) openebs.io/local Delete WaitForFirstConsumer false 31s ## 了解更多 - [`olares-cli` 命令行参考](../install/cli/olares-cli.md) -- [Olares 安装过程](installation-process.md) +- [安装流程详解](installation-process.md) - [Olares 环境变量](environment-variables.md) diff --git a/docs/zh/developer/install/olares-home.md b/docs/zh/developer/install/olares-home.md index 96a13c43..bf7c58fe 100644 --- a/docs/zh/developer/install/olares-home.md +++ b/docs/zh/developer/install/olares-home.md @@ -59,5 +59,5 @@ Olares Home 的结构设计旨在优化文件管理、版本控制和资源共 ## 了解更多 - [`olares-cli` 命令行参考](../install/cli/olares-cli.md) -- [Olares 安装过程](installation-process.md) +- [安装流程详解](installation-process.md) - [Olares 环境变量](environment-variables.md)