ONES

https://opsdoc.ones.cn/docs/
Admin
ONES is a privately deployable enterprise system for operations implementation, covering environment...
Tokens:161,885
Snippets:634
Trust Score:8.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start and Check TASK Service Status

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-task

This snippet shows how to start the TASK services using `task_ctl start` and then check their status with `task_ctl status`. It's important to ensure the environment variables are loaded correctly, especially when switching users.

```Shell
task_ctl start
```

```Shell
task_ctl status
```

--------------------------------

### TASK Installation Complete Messages

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-task

Upon successful installation, the system provides several commands for managing TASK services, including starting, upgrading, and getting help. It also provides the access addresses for the TASK services.

```Shell
>>> The Installation is Complete

1. You can use the following command to start task services
# task_ctl start

2. For more information about task control commands
# task_ctl for help

3. For more information about task installer commands
# ./task_installer for help

4. For upgrade, you must go to task-intaller-xxx directory.
# ./task_installer upgrade

5. task services access address.

Following HTTP access is ready.
http://10.0.0.201:8080

If https config is correct, following HTTPS access should work without https certificate warning.
https://ones-task:8443
```

--------------------------------

### Configure TASK Installation

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-task

This section shows how to modify the `config-init.txt` file for TASK installation. It includes essential parameters for connecting to the ONES main service, such as protocol, port, and domain. Remember to adjust paths based on your extracted installer directory.

```Shell
cd task-installer-private-x-xxxx
vi config-init.txt
```

```Shell
#视情况修改以下配置
################################ ONES 主服务信息配置  ############################
#以下部分配置在安装完成后，如再次修改，需执行 task_ctl restart 重启Task服务。
ONES_SERVICE_HTTP_PROTOCOL=http        #ONES服务使用的协议，http或https
ONES_SERVICE_WS_PROTOCOL=ws            #对应http和https，如果协议为http则此参数为ws；如果为https则此参数为wss
ONES_SERVICE_PORT=30011                 #ONES服务访问端口(如果是域名访问则为空)
ONES_SERVICE_DOMAIN=120.79.224.181      #ONES服务访问地址，对应ONES服务中private.yaml文件中去掉协议的ip或域名


###Task访问ONES主服务时使用的URL配置。（注意填写的是Task 访问 ONES 的路径配置，这部分别填错位置了！）
ONES_BACKEND_SERVICE_HTTP_PROTOCOL='http'
ONES_BACKEND_SERVICE_DOMAIN='10.0.0.203'
ONES_BACKEND_SERVICE_PORT='30011'
```

--------------------------------

### Download and Install Specific ONES Version

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

Download and install a specific version of ONES by first listing available versions and then using curl to pipe the install script to bash. Replace '<ones-version>' with the desired version, e.g., 'v3.14.0'.

```bash
# 1. List all available versions
curl https://packages.ones.cn/release/ones-versions.yaml
```

```bash
# 2. Specify ONES version, e.g., v3.14.0, replace <ones-version> with the specified version, then execute the following command for installation
curl https://packages.ones.cn/release/<ones-version>/install.sh | bash -
```

--------------------------------

### Setup Ones Application

Source: https://opsdoc.ones.cn/docs/matching/K3S/open-oldWiki

Executes the setup script for the Ones application. This command initiates the deployment and configuration process, ensuring all necessary components are installed and set up correctly. It typically involves Python scripts and interacts with Kubernetes resources.

```bash
make setup-ones
```

--------------------------------

### Download and Extract TASK Installer

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-task

This snippet demonstrates how to download the TASK installer package using curl and extract it. It includes creating a directory for packages and navigating into it. Ensure you have the correct credentials and URL for the download.

```Shell
mkdir -p /opt/pkg && cd /opt/pkg
curl --user 'task:sem2pristemp4FRAP' -O https://r.feixiang.work/private-0/task-installer-private-0-latest.tar.gz
tar -vxf task-installer-private-0-latest.tar.gz
```

--------------------------------

### ONES Installation Success Output

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-offline

This snippet shows the successful deployment output after installing ONES. It includes messages about registry readiness, image loading, and instructions for the next steps.

```Shell
[root@ones-cn-server-oper k3s]# OFFLINE_PKG=/tmp/offline_pkg.tar IMAGE_REGISTRY=localhost:5000 IMAGE_REGISTRY_REGISTRY_USER=" " IMAGE_REGISTRY_REGISTRY_PASSWORD=" " REGISTRY_DISABLE=false bash install.sh  
INFO: 2023-07-11 16:55:54| Tue Jul 11 16:55:54 CST 2023| retry [  kubectl -n kube-system rollout status sts registry --timeout=30s ], remaining 600 seconds  
INFO: 2023-07-11 16:56:06| registry ready  
INFO: 2023-07-11 16:56:06| deploy registry ok  
INFO: 2023-07-11 16:56:06| load images to registry...  
INFO: 2023-07-11 16:56:06| load images from offline_pkg/images  
INFO: 2023-07-11 16:56:06| tar -zxf /root/offline/offline_pkg/images/ones_images.tar.gz -C /data/ones/registry  
INFO: 2023-07-11 16:59:12| load images to registry ok  
  
INFO: 2023-07-11 16:59:13| Please choose one of the methods to continue installing ONES.  
INFO: 2023-07-11 16:59:13| 1.web page: Bootstrap information for deploying ONES:  
     If the server is in a private cloud,  please use this internal address to access http://10.0.0.201:30011  
         If access fails, you can choose the internal network ip by yourself, (such as ip -br a | grep -w UP)  

```

--------------------------------

### Install TASK Component

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-task

This command executes the TASK installation process. The installation may take some time as it handles image processing. Successful completion is indicated by a specific message in the terminal.

```Shell
./task_installer install
```

--------------------------------

### Deploy ONES using Command Line

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-offline

This snippet outlines the command-line steps for deploying ONES. It includes initializing configuration and executing the deployment script. Troubleshooting steps using kubectl are also mentioned.

```bash
ones-ai-k8s.sh make init-config
ones-ai-k8s.sh bash script/ones/deploy-ones.sh
```

--------------------------------

### View ONES Boot Information

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

Access boot information for ONES using the 'ones-boot-info.sh' script. This script helps in understanding the startup process and diagnosing any issues related to ONES initialization.

```bash
ones-boot-info.sh
```

--------------------------------

### ONES Installation Success Output

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

This snippet shows the expected console output after a successful ONES installation. It includes informational messages about dependency checks and prompts for the next steps in the deployment process.

```Shell
[root@ones-cn-server-node03 ~]# sudo bash ./install_linux_amd64.sh  
INFO: 2023-07-12 12:28:10| check dependencies: curl gzip pv  
INFO: 2023-07-12 12:28:10| complete system dependencies  
...省略  
INFO: 2023-07-12 14:03:23| Please choose one of the methods to continue installing ONES.  
INFO: 2023-07-12 14:03:23| 1.web page: Bootstrap information for deploying ONES:   
     If the server is in a private cloud,  please use this internal address to access http://10.0.0.202:30011   
         If access fails, you can choose the internal network ip by yourself, (such as ip -br a | grep -w UP)   
     If the server is in the public cloud, please use this external address to access http://120.79.215.28:30011   
         If access fails, you can choose the external network ip by yourself, (such as curl ip.gs)   
     If access still fails, please contact the server administrator to troubleshoot. (For example, enable security group rules.)  
INFO: 2023-07-12 14:03:23| 2.Command line: Bootstrap information for deploying ONES:   
     1. Initial configuration: ones-ai-k8s.sh make init-config   
     2. Deploy ONES: ones-ai-k8s.sh bash script/ones/deploy-ones.sh  
```

--------------------------------

### Environment Check Failure Example

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

This snippet displays a typical environment check failure during ONES installation, specifically highlighting the 'Transparent-Hugepage Enabled' setting as 'no pass' with a description of the required fix.

```Shell
********check result********  
+------------------------------+---------------------------------------+------------------+--------------------------------------------------------------------------+
|          check item          |               situation               |      result      |                               description                                |
+------------------------------+---------------------------------------+------------------+--------------------------------------------------------------------------+
|             Swap             |                  off                  |  pass   |                                                                          |
|             Port             |                                       |  pass   |                                                                          |
|          OSVersion           |               7.9.2009                |  pass   |                                                                          |
|        SELinuxStatus         |               Disabled                |  pass   |                                                                          |
|          CPU-Cores           |                   8                   |  pass   |                                                                          |
|           TimeZone           |             Asia/Shanghai             |  pass   |                                                                          |
|              IO              |   IO write=295MB/s, IO read=6.1GB/s   |  pass   |                                                                          |
|            Umask             |                 0022                  |  pass   |                                                                          |
|            Memory            |                  15G                  |  pass   |                                                                          |
|            kernel            |      3.10.0-1127.19.1.el7.x86_64      |  pass   |                                                                          |
|          DataMount           |            mount path is /            |  pass   |                                                                          |
|        DataAvailable         | data disk( / ) available size is 139G |  pass   |                                                                          |
|          User-Group          |        Users and groups are OK        |  pass   |                                                                          |
| Transparent-Hugepage Enabled |               [always]                | no pass | transparent_hugepage enabled needs to be madvise, but it is [always] now |
+------------------------------+---------------------------------------+------------------+--------------------------------------------------------------------------+
  
****************************  
********adjust command tips********  
+------------------------------+--------------------------------------------------------------------------------+
|          check item          |                                  fix command                                   |
+------------------------------+--------------------------------------------------------------------------------+
| Transparent-Hugepage Enabled | echo 'madvise' | sudo tee /sys/kernel/mm/transparent_hugepage/enabled |
+------------------------------+--------------------------------------------------------------------------------+

```

--------------------------------

### Install Latest ONES Version

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

This command downloads and executes the latest ONES installation script from the provided URL. It is designed to be run on a Linux host with external network access.

```Shell
curl https://packages.ones.cn/release/latest/install.sh | bash -
```

--------------------------------

### Enable and Start NFS Services

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/nfs-install

Enables and starts NFS services, including rpcbind and nfs-server, ensuring they start on boot.

```shell
# centos/Redhat  
sudo systemctl enable --now rpcbind nfs-server  
  
# ubuntu  
sudo systemctl enable --now nfs-server  
  
```

--------------------------------

### ONES Setup Script Output Example

Source: https://opsdoc.ones.cn/docs/matching/K3S/open-webhook

This snippet shows the expected output from the 'make setup-ones' command after applying configuration changes. It includes informational messages about rendering, merging configs, and setting up resources.

```Shell
python3 ./script/python/ones/cmd/setupapp.py --app=ones --version=v1  --ones-path=  
2023-07-19 08:23:23,003 [INFO] ones_path=, k8s_root_dir=/data/ones/ones-ai-k8s  
2023-07-19 08:23:23,295 [INFO] render config  
2023-07-19 08:23:23,295 [INFO] merge configs  
2023-07-19 08:23:29,085 [WARNING] /data/ones/ones-ai-k8s/private-overlay-templates/ones/v1 not found, skip  
2023-07-19 08:23:29,085 [INFO] ones_path=, k8s_root_dir=/data/ones/ones-ai-k8s  
2023-07-19 08:23:29,157 [INFO] compatible overlay  
2023-07-19 08:23:30,394 [INFO] collect dir info  
2023-07-19 08:23:30,416 [INFO] setup global resrouces  
2023-07-19 08:23:30,684 [INFO] gen registry credentials  
2023-07-19 08:23:30,691 [INFO] setup namespace, registry-secret  
2023-07-19 08:23:31,013 [INFO] setup local-storage static-pvc, static-pv (cache config to tmp/config.yaml)  
storageclass.storage.k8s.io/ones-local-storage unchanged  
storageclass.storage.k8s.io/ones-local-storage-mock unchanged  
deployment.apps/localstorage-ones-cn-server-node03 unchanged  
storageclass.storage.k8s.io/ones-local-storage unchanged  
storageclass.storage.k8s.io/ones-local-storage-mock unchanged  
2023-07-19 08:23:35,419 [INFO] backward compatible  
2023-07-19 08:23:35,554 [INFO] diff ones before setup  
2023-07-19 08:23:40,485 [INFO] setup ones  
2023-07-19 08:23:43,461 [INFO] record latest data  
2023-07-19 08:23:45,493 [INFO] latest_hash == current_hash, skip  
2023-07-19 08:23:45,493 [INFO] remove /data/ones/ones-ai-k8s/tmp  
2023-07-19 08:23:45,497 [INFO] setup ones finish  
2023-07-19 08:23:45,497 [INFO] elapsed time: 22.202 seconds  
```

--------------------------------

### Install ONES System (Offline)

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-offline

This command executes the ONES offline installation script. Ensure you replace `<ones-version>` with the actual version of the offline package. The script requires the offline package to be present in the /tmp directory.

```Shell
#<ones-version>替换成对应版本  
OFFLINE_PKG=/tmp/offline_pkg_<ones-version>.tar bash /tmp/install_linux_amd64.sh  
```

--------------------------------

### Execute as Root User

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

This command switches the current user to the root user, which is required for performing the ONES installation. Ensure you have the necessary write permissions in the directory where you execute the commands.

```Shell
sudo su -
```

--------------------------------

### Deploy and Start Webhook Client

Source: https://opsdoc.ones.cn/docs/matching/Docker/open-webhook

Copies the webhook_client to a Docker container, makes it executable, changes directory, and starts it as a background process. It first identifies the container ID based on deployment name and port.

```Shell
containerID=$(docker ps |grep $(./json-util -config config.json -operator select -key deploy_name) | grep '0.0.0.0:'$(./json-util -operator select -key port -config ./config.json)'->' | awk '{print $1}')
docker cp webhook_client $containerID:/
docker exec -it $containerID bash
chmod +x /webhook_client
cd /
./webhook_client &
```

--------------------------------

### Navigate to ONES Installation Directory

Source: https://opsdoc.ones.cn/docs/matching/Docker/email-config

This command navigates the user to the installation directory of the current ONES instance, which is necessary for applying configuration changes.

```shell
cd /data/ones/pkg/ones-example-3.14.xxxxx
```

--------------------------------

### Download and Prepare Installation Package

Source: https://opsdoc.ones.cn/docs/install-upgrade/Docker/upgrade-standard

This snippet downloads the Ones installation package and prepares it for the upgrade. It creates a directory, fetches the installation script using curl with authentication, and then executes the script to create a versioned package directory and pull Docker images. The script should not be executed repeatedly.

```Shell
mkdir -p /data/ones/pkg & cd /data/ones/pkg  

curl --user 'package:48toEWREv5AJ'  -O https://res.ones.pro/package/ones-release/ones-package.sh  

ones-package.sh <version>
```

```Shell
# If no interruption occurred, no need to execute the following commands
docker pull ones-ai-docker.ones.cn/package/ones-release:<version>
docker tag ones-ai-docker.ones.cn/package/ones-release:<version> ones-release:<version>
```

--------------------------------

### Execute ONES AI Kubernetes Commands

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

Interact with the ONES AI Kubernetes environment using the 'ones-ai-k8s.sh' script. You can execute specific commands like 'make config-ones' by appending them to the script.

```bash
ones-ai-k8s.sh <command>
```

```bash
ones-ai-k8s.sh make config-ones
```

--------------------------------

### Switch Installer Web

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/upgrade-info

After upgrading to versions above 6.38.3, this command is used to switch the installer web interface to Tengine. This ensures the installer page uses the updated gateway.

```Shell
make setup-installer-web

```

--------------------------------

### ONES Installation Script Parameters

Source: https://opsdoc.ones.cn/docs/common/reinstall-k3s

Lists and describes parameters available for the ONES installation script, covering ONES-specific configurations like ONES_DATA_DIR and K3S_DEFAULT_REGISTRY_PORT, as well as various K3s installation options.

```bash
# ONES Configuration Parameters:
# ONES_DATA_DIR: Base path for ONES data storage.
# K3S_DEFAULT_REGISTRY_PORT: Port for the K3s local private registry.

# K3s Installation Script Parameters:
# INSTALL_K3S_EXEC: Custom server or agent arguments (e.g., "server --disable=traefik --cluster-cidr=10.42.0.0/16 --service-cidr=10.43.0.0/16").
# K3S_TOKEN: Token for agent registration.
# INSTALL_K3S_SKIP_DOWNLOAD: Skip downloading K3s binary.
# INSTALL_K3S_SYMLINK: Create symlinks for K3s.
# INSTALL_K3S_SKIP_ENABLE: Skip enabling K3s service.
# INSTALL_K3S_SKIP_START: Skip starting K3s service.
# INSTALL_K3S_VERSION: Specify K3s version.
# INSTALL_K3S_BIN_DIR: Directory for K3s binaries.
# INSTALL_K3S_BIN_DIR_READ_ONLY: Make K3s binary directory read-only.
# INSTALL_K3S_SYSTEMD_DIR: Directory for K3s systemd units.
# INSTALL_K3S_NAME: Name for the K3s service.
# INSTALL_K3S_TYPE: Type of K3s installation (server/agent).
# INSTALL_K3S_SELINUX_WARN: Show SELinux warning.
# INSTALL_K3S_SKIP_SELINUX_RPM: Skip SELinux RPM installation.
# INSTALL_K3S_CHANNEL_URL: URL for K3s channel.
# INSTALL_K3S_CHANNEL: K3s channel to use.
```

--------------------------------

### Extract Installation Package

Source: https://opsdoc.ones.cn/docs/data/Docker/system-migration

These commands create the ONES installation directory on the new server, copy the installation package from /tmp to the new directory, and then extract the compressed tarball.

```Shell
mkdir -p /data/ones/pkg
```

```Shell
cd /data/ones/pkg
```

```Shell
cp /tmp/ones-example-3.14.xxxxx.tar.gz   ./
```

```Shell
tar -zxf ones-example-3.14.xxxxx.tar.gz
```

```Shell
cd ones-example-3.14.xxxxx
```

--------------------------------

### Setup Ones Application

Source: https://opsdoc.ones.cn/docs/matching/K3S/open-newWiki

This command initiates the setup process for the Ones application. It executes a Python script that configures the application, including rendering and merging configurations, setting up global resources, and generating registry credentials. The process also handles storage class configurations and performs a backward compatibility check before setting up Ones.

```bash
make setup-ones
```

--------------------------------

### 应用 ONES 监控系统配置

Source: https://opsdoc.ones.cn/docs/matching/K3S/open-monitoring

执行 `make setup-monitoring-system` 和 `make setup-fluent-bit` 命令来应用监控系统的配置和 Fluent Bit 的配置。

```Shell
make setup-monitoring-system
make setup-fluent-bit
```

--------------------------------

### Get ONES Data Directory Path

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/upgrade-online

Retrieves the path to the ONES data directory by inspecting the installer API deployment details in Kubernetes. This path is essential for subsequent upgrade operations.

```Shell
kubectl -n ones-installer describe deploy installer-api | grep Path:
```

--------------------------------

### Troubleshoot ONES Deployment with kubectl

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

Use 'kubectl get po -n ones' to check the status of ONES pods and diagnose deployment issues. This command is essential for identifying and resolving problems during the ONES deployment process.

```bash
kubectl get po -n ones
```

--------------------------------

### 更新 ONES Fluent Bit 配置

Source: https://opsdoc.ones.cn/docs/matching/K3S/open-monitoring

执行 `make setup-fluent-bit` 命令来更新 ONES 的 Fluent Bit 配置。

```Shell
make setup-fluent-bit
```

--------------------------------

### Example Output of ONES Initialization

Source: https://opsdoc.ones.cn/docs/databases/K3S/install-with-TDSQL

This example shows the typical output when running the `ones-ai-k8s.sh make init-config` command, including kubectl commands for checking deployment status and executing the initialization script. It also demonstrates the interactive prompts for configuration.

```bash
[root@localhost config]# ones-ai-k8s.sh make init-config  
kubectl rollout status deploy -n ones-installer  installer-api --timeout=60s  
deployment "installer-api" successfully rolled out  
kubectl get po -n ones-installer  -l app=installer-api --sort-by='{.metadata.creationTimestamp}' -o jsonpath='{.items[-1].metadata.name}'  
kubectl exec -n ones-installer -it installer-api-74cc465bcb-wv6qv -c installer-api -- bash -c "cd /data/ones/ones-ai-k8s && make init-config"  
make[1]: Entering directory '/data/ones/ones-ai-k8s'  
python3 script/app/files/init-config.py \  
        --cmd_to_list_env="make get_value GET_ALL_CONFIG=true --no-print-directory" \  
        --config_rules=default/init-config/init-config-rules.yaml    
local_env by [sh -c make get_value GET_ALL_CONFIG=true --no-print-directory]  
  
        Notice!!!  
  
        Please read the Terms of Service( https://ones.cn/service-terms ) and Privacy Policy( https://ones.cn/privacy-policy ) of ONES.  
  
          
Please enter 'yes' to save the configuration, otherwise exit: yes  
# [defaultLanguage] Team's default language. For example 'zh(Chinese)', 'en(English)', 'ja(Japanese)' etc.  
# [defaultLanguage] When entering an empty value, use the system-generated value 'zh'  
please input [defaultLanguage]:   
...more  
```

--------------------------------

### Uninstall All Components

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

Execute the 'all-uninstall.sh' script to remove all associated components. This script provides a comprehensive cleanup of the ONES installation.

```bash
all-uninstall.sh
```

--------------------------------

### Apply Configuration and Verify Services

Source: https://opsdoc.ones.cn/docs/data/K3S/single-node-backup/k3s-single-backup

Applies the system configuration and verifies the status of various backup-related services using make and kubectl commands.

```Shell
make setup-ones
make setup-ones-built-in-mysql
```

```Shell
kubectl -n ones get po | grep kafka-backup
```

```Shell
kubectl get pod -A|grep -i clickhouse-backup
```

```Shell
kubectl -n ones get po | grep mysql
```

```Shell
kubectl get po -n ones -l app=mc-backup-tools
```

--------------------------------

### ONES Installation Environment Check Failure

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-offline

This snippet displays the output of an environment check during ONES installation, indicating a failure in 'Transparent-Hugepage Enabled'. It also shows the recommended command to fix this issue.

```Shell
********check result********  
+------------------------------+---------------------------------------+------------------+--------------------------------------------------------------------------+  
|          check item          |               situation               |      result      |                               description                                |
+------------------------------+---------------------------------------+------------------+--------------------------------------------------------------------------+  
|             Swap             |                  off                  |  pass   |                                                                          |
|             Port             |                                       |  pass   |                                                                          |
|          OSVersion           |               7.9.2009                |  pass   |                                                                          |
|        SELinuxStatus         |               Disabled                |  pass   |                                                                          |
|          CPU-Cores           |                   8                   |  pass   |                                                                          |
|           TimeZone           |             Asia/Shanghai             |  pass   |                                                                          |
|              IO              |   IO write=295MB/s, IO read=6.1GB/s   |  pass   |                                                                          |
|            Umask             |                 0022                  |  pass   |                                                                          |
|            Memory            |                  15G                  |  pass   |                                                                          |
|            kernel            |      3.10.0-1127.19.1.el7.x86_64      |  pass   |                                                                          |
|          DataMount           |            mount path is /            |  pass   |                                                                          |
|        DataAvailable         | data disk( / ) available size is 139G |  pass   |                                                                          |
|          User-Group          |        Users and groups are OK        |  pass   |                                                                          |
| Transparent-Hugepage Enabled |               [always]                | no pass | transparent_hugepage enabled needs to be madvise, but it is [always] now |
+------------------------------+---------------------------------------+------------------+--------------------------------------------------------------------------+  
  
****************************  
********adjust command tips********  
+------------------------------+--------------------------------------------------------------------------------+
|          check item          |                                  fix command                                   |
+------------------------------+--------------------------------------------------------------------------------+
| Transparent-Hugepage Enabled | echo 'madvise' | sudo tee /sys/kernel/mm/transparent_hugepage/enabled |
+------------------------------+--------------------------------------------------------------------------------+

```

--------------------------------

### Initialize ONES Configuration via Command Line

Source: https://opsdoc.ones.cn/docs/databases/K3S/install-with-TDSQL

This command initiates the configuration process for ONES, prompting the user for necessary input to set up the environment. It involves running a Python script that reads configuration rules and applies them.

```bash
ones-ai-k8s.sh make init-config
```

--------------------------------

### Download Specific ONES Version Installer

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-offline

This section provides curl commands to download specific versions of the ONES installer. The first command lists available versions, and the second downloads the offline package for a specified version.

```bash
# 1. List all available versions
curl https://packages.ones.cn/release/ones-versions.yaml
# 2. Specify ONES version, e.g., v3.14.0, replace <ones-version> with the specified version, then execute the following command to download
curl https://packages.ones.cn/release/<ones-version>/build_offline_pkg_linux_amd64.sh | bash -
```

--------------------------------

### 生效配置并检查备份效果

Source: https://opsdoc.ones.cn/docs/data/K3S/single-node-backup/k3s-single-backup-new

执行配置生效命令，并检查 ClickHouse、MySQL 和文件备份相关的 Pod 是否正常启动，以验证备份配置是否生效。

```shell
make setup-ones   
make setup-ones-built-in-mysql  
  
# 检测clickhouse的pod启动  
kubectl get pod -A|grep -i clickhouse-backup  
  
# 检查MySQL变更  
kubectl -n ones get po | grep mysql  
# 确认 mysql-cluster-mysql 和 mysql-operator 有更新，增加 mysql-status-server-deployment  
  
# 检查文件备份  
kubectl get po -n ones -l app=mc-backup-tools  # 确认pod起来  
```

--------------------------------

### Navigate to ONES Installation Directory

Source: https://opsdoc.ones.cn/docs/databases/Docker/mysql-8

Change the current directory to the installation path of the running ONES instance. This is a prerequisite for executing migration scripts.

```Bash
cd /data/ones/pkg/ones-example-3.14.xxxxx
```

--------------------------------

### Fix Transparent Hugepage Setting

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

This command provides the solution to fix the 'Transparent-Hugepage Enabled' setting when it fails the environment check during ONES installation. It involves echoing 'madvise' to the appropriate system file.

```Shell
echo 'madvise' | sudo tee /sys/kernel/mm/transparent_hugepage/enabled
```

--------------------------------

### Download Webhook Client Script

Source: https://opsdoc.ones.cn/docs/matching/Docker/open-webhook

This command downloads a client script used for interacting with the webhook service. It fetches the binary from a provided URL.

```bash
curl -O  https://res.ones.pro/script/k3stool/webhook_client
```

--------------------------------

### Initialize and Mount Single Data Disk for ONES

Source: https://opsdoc.ones.cn/docs/common/centos-linux-fix

This guide details the process of partitioning, formatting, and mounting a single data disk for ONES, typically for the /data/ones directory. It covers checking existing mounts, partitioning with GPT, formatting with XFS (with ftype=1), creating the mount point, and configuring automatic mounting via /etc/fstab using UUIDs.

```Shell
# I. Disk Partitioning
### Query mounted partitions to check successful mounting
[root@ones ~]# df -h
Filesystem               Size  Used Avail Use% Mounted on
devtmpfs                  16G     0   16G   0% /dev
tmpfs                     16G  320K   16G   1% /dev/shm
tmpfs                     16G  725M   15G   5% /run
tmpfs                     16G     0   16G   0% /sys/fs/cgroup
/dev/mapper/centos-root   99G   39G   61G  40% /
/dev/vda1               1014M  150M  865M  15% /boot
/dev/vdb1               1024G  150M  1023G  1% /data/ones # Example

### Partition the new data disk vdb
[root@ones ~]# parted /dev/vdb mklabel gpt # Use gpt format
[root@ones ~]# parted /dev/vdb mkpart 1 xfs 2048 1TB # Disk 1T


# II. Disk Formatting and Mounting
### If using xfs, format with ftype=1, or use ext4 filesystem
[root@ones ~]# mkfs.xfs -n ftype=1 /dev/vdb1

### Create mount point
[root@ones ~]#mkdir -p /data/ones

### Check blkid for disk partition UUID
[root@ones ~]# blkid

### Check automatic disk mounting
[root@ones ~]# cat /etc/fstab
#
# /etc/fstab
# Created by anaconda on Fri Dec 22 15:25:13 2023
#
# Accessible filesystems, by reference, are maintained under '/dev/disk'
# See man pages fstab(5), findfs(8), mount(8) and/or blkid(8) for more info
#
/dev/mapper/centos-root /                       xfs     defaults        0 0
UUID=154ce567-1c9a-4279-8147-34a849ce9a57 /boot                   xfs     defaults        0 0
UUID=2145583b-79b6-4934-9d05-f5cd1bee752a / xfs defaults 0 0
UUID=OJayrk-nXIr-RYzx-FnL0-cpa4-8bfD-3h8py9 /data/ones xfs defaults 0 0 # Configure persistent mounting for automatic mounting on boot, using UUID to avoid potential issues with unstable disk letter assignments from some VM vendors

### Mount partitions, check if disk mounting is successful
[root@ones ~]#mount -a && df -h


# III. Isolate K3S agent data directory and server data directory (to prevent system disk IO limitations and insufficient system disk space, optional)
# Create K3S data directory
[root@ones ~]#K3S_DATA_DIR=/data/ones/ones-installer-pkg/k3s

[root@ones ~]#mkdir -p ${K3S_DATA_DIR}/etc/rancher ${K3S_DATA_DIR}/var/lib/rancher/k3s/agent ${K3S_DATA_DIR}/run/k3s ${K3S_DATA_DIR}/var/lib/kubelet

[root@ones ~]#ln -sf ${K3S_DATA_DIR}/etc/rancher /etc/rancher
[root@ones ~]#ln -sf ${K3S_DATA_DIR}/var/lib/rancher/k3s/agent /var/lib/rancher/k3s/agent
[root@ones ~]#ln -sf ${K3S_DATA_DIR}/run/k3s /run/k3s
[root@ones ~]#ln -sf ${K3S_DATA_DIR}/var/lib/kubelet /var/lib/kubelet
# If sufficient data disks are available, it is recommended to isolate etcd as well (optional)
[root@ones ~]#mkdir -p ${K3S_DATA_DIR}/var/lib/rancher/k3s/server/db/etcd
[root@ones ~]#ln -sf ${K3S_DATA_DIR}/var/lib/rancher/k3s/server/db/etcd /var/lib/rancher/k3s/server/db/etcd
```

--------------------------------

### Install SELinux Utilities on Debian/Ubuntu

Source: https://opsdoc.ones.cn/docs/common/centos-linux-fix

This command is used to install the SELinux utilities package on Debian-based systems like Ubuntu, which may be necessary for managing SELinux status and policies.

```bash
apt install selinux-utils

```

--------------------------------

### 导入数据库 SQL 文件

Source: https://opsdoc.ones.cn/docs/databases/Docker/mysql-5

连接到 ONES 的 MySQL 数据库，并依次执行解压出的 SQL 文件，包括 `project.sql`, `wiki.sql`, `wizeditor.sql`, `superset.sql`, `camunda.sql`, `open_platform_plugin.sql`, 和 `plugin_platform.sql`。

```sql
mysql -uones -h<mysql_host> -p<mysql_password> -P<mysql_port>
source /tmp/project.sql;
source /tmp/wiki.sql;
source /tmp/wizeditor.sql;
source /tmp/superset.sql;
source /tmp/camunda.sql;
source /tmp/open_platform_plugin.sql;
source /tmp/plugin_platform.sql;
```

--------------------------------

### Download ONES Offline Package (Linux AMD64)

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-offline

This command downloads the latest offline installation package for Linux AMD64. It uses curl to fetch the script and pipes it to bash for execution. The process may occupy port 5000 by default.

```Shell
curl https://packages.ones.cn/release/latest/build_offline_pkg_linux_amd64.sh | bash -  
```

--------------------------------

### Uninstall K3s

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-online

Remove the K3s cluster using the 'k3s-uninstall.sh' script. This is a specific uninstallation command for the K3s environment used by ONES.

```bash
k3s-uninstall.sh
```

--------------------------------

### 进入 ONES 容器

Source: https://opsdoc.ones.cn/docs/databases/Docker/mysql-5

使用 `onesconfigure e` 命令进入 ONES 的容器环境，为后续的数据导入做准备。

```bash
./onesconfigure e
```

--------------------------------

### Get Migration Pod for ONES Upgrade

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/upgrade-online

Retrieves the Kubernetes pod responsible for the ONES upgrade migration process, identified by a specific job name.

```Shell
$ kubectl -n ones-system get pod -l job-name=upgrade-ones-{升级前版本后}-{升级后版本号}-mysql
```

--------------------------------

### Configure Backup Agent

Source: https://opsdoc.ones.cn/docs/data/K3S/single-node-backup/k3s-single-backup

Sets up the backup agent (Nginx) with basic authentication. It requires generating a username and MD5-hashed password using an external tool.

```Shell
xbackupNginxEnable: true
xbackupNginxBasicAuthUser: "12345"
xbackupNginxBasicAuthPasswordSecret: "$apr1$xAF/EcYh$HOTn.2.CVTEAhhqHqRxOW1"
```

--------------------------------

### Retrieve ONES_CLIENT_SECRET

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-task

This command uses `grep` and `awk` to extract the `ONES_CLIENT_SECRET` value from the TASK service configuration file. This secret is crucial for communication between TASK and ONES.

```Shell
grep ONES_CLIENT_SECRET /opt/task/config/config.txt |awk -F \' '{print $2}'
```

--------------------------------

### Initialize ONES Cluster Operator and Configuration

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/upgrade-online

Executes commands to set up the ONES cluster operator, TiDB operator, and initialize ONES configurations and the database. These steps are necessary for applying new version resources.

```Shell
ones-ai-k8s.sh
make setup-ones-cluster-operator
make setup-tidb-operator
make init-config
make init-db
```

--------------------------------

### 修改 ONES 监控配置

Source: https://opsdoc.ones.cn/docs/matching/K3S/open-monitoring

进入 ONES 容器并修改 `config/private.yaml` 文件，添加或修改监控相关的配置项，如 `grafanaLocalNodePort`、`monitoringSystemOverlay` 和 `fluentOverlay`。

```Shell
vim config/private.yaml

# 添加如下配置
grafanaLocalNodePort: 31380
monitoringSystemOverlay: "only-local-storage"
fluentOverlay: "only-ones-logging"
```

--------------------------------

### Install/Update Built-in ONES Plugins

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/upgrade-online

Installs or updates the six standard built-in plugins for ONES, supported from version v6.18.1 onwards. Plugin enablement depends on licensing.

```Shell
make setup-ones-inner-plugins
```

--------------------------------

### Add Fluent Overlay Configuration

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-offline

This code snippet shows how to add a specific configuration to the `config/private.yaml` file. This is required for ONES versions older than LTS v3.14.129 or Feature v6.0.55.

```yaml
fluentOverlay: "only-ones-logging"
```

--------------------------------

### Restart ONES Service

Source: https://opsdoc.ones.cn/docs/install-upgrade/K3S/install-task

This command restarts the ONES service to apply the configuration changes made for TASK integration. Be aware that this action will cause a temporary unavailability of the ONES service.

```Shell
make setup-ones
```

--------------------------------

### Formatting and Mounting Disks

Source: https://opsdoc.ones.cn/docs/common/centos-linux-fix

This section covers formatting the partitioned disks with XFS (using `ftype=1`) and mounting them. It includes commands to format the partitions, view UUIDs using `blkid`, create mount points, and configure automatic mounting in `/etc/fstab`.

```bash
[root@ones ~]# mkfs.xfs -n ftype=1 /dev/vdb1
[root@ones ~]# mkfs.xfs -n ftype=1 /dev/vdc1
```

```bash
[root@ones ~]# blkid
```

```bash
[root@ones ~]#mkdir -p /data/ones/ones-local-storage/mysql
```

```bash
# /etc/fstab configuration for automatic mounting
UUID=OJayrk-nXIr-RYzx-FnL0-cpa4-8bfD-3sad9 /data/ones xfs defaults 0 0
UUID=OJayrk-nXIr-RYzx-FnL0-cpa4-8bfD-3xxxx /data/ones/ones-local-storage/mysql xfs defaults 0 0
```

```bash
[root@ones ~]#mount -a && df -h
```

--------------------------------

### Install Ingress Nginx Controller

Source: https://opsdoc.ones.cn/docs/matching/K3S/open-https

This command initiates the setup of the ingress-nginx-controller, a crucial component for managing external access to services within a Kubernetes cluster. It ensures that the controller is ready to handle traffic.

```bash
make setup-ingress-nginx-controller
```

--------------------------------

### 应用外置数据库配置

Source: https://opsdoc.ones.cn/docs/databases/K3S/mysql-external

通过执行 `ones-ai-k8s.sh` 和 `make setup-ones` 命令将外置数据库的配置应用到 ONES 服务中。在执行过程中，可能需要确认部署操作。

```shell
ones-ai-k8s.sh
make setup-ones
```
Tokens:
Raw