Rainbond

https://www.rainbond.com/docs
Admin
Rainbond is a cloud-native application platform that enables deployment, management, and scaling of...
Tokens:176,789
Snippets:1,767
Trust Score:8.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Start Development

Source: https://www.rainbond.com/docs/contribution/document

Navigate to the project directory, install dependencies, and start the local development server.

```bash
cd rainbond-docs
yarn install
```

```bash
yarn start
```

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

### Example Installation Status

Source: https://www.rainbond.com/docs/installation/install-with-helm

An example output showing the status of pods after a successful Rainbond installation. All pods should be in a '1/1 Running' state.

```bash
NAME                                      READY   STATUS    RESTARTS   AGE
local-path-provisioner-78d88b6df5-wkr84   1/1     Running   0          5m37s
minio-0                                   1/1     Running   0          5m37s
rainbond-operator-59ff8bb988-nlqrt        1/1     Running   0          5m56s
rbd-api-5466bd748f-brqmv                  1/1     Running   0          5m15s
rbd-app-ui-5577b8ff88-fpnnv               1/1     Running   0          4m39s
rbd-chaos-6828h                           1/1     Running   0          5m12s
rbd-db-0                                  1/1     Running   0          5m35s
rbd-gateway-69bfb68f4d-7xd9n              2/2     Running   0          5m34s
rbd-hub-8457697d4c-fqwgn                  1/1     Running   0          5m28s
rbd-monitor-0                             1/1     Running   0          5m27s
rbd-mq-5b6f94b695-gmdnn                   1/1     Running   0          5m25s
rbd-worker-7db9f9cccc-s9wml               1/1     Running   0          5m22s
```

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

### Install Application Response Example

Source: https://www.rainbond.com/docs/api/application/installAppByMarket

This is an example of a successful response when installing an application. It includes enterprise and team IDs, a note, the application ID, region name, and a list of services with their detailed information.

```json
{
  "enterprise_id": "string",
  "team_id": "string",
  "note": "string",
  "ID": 3,
  "region_name": "string",
  "service_list": [
    {
      "status": "",
      "access_infos": [
        "string"
      ],
      "service_id": "string",
      "tenant_id": "string",
      "service_key": "string",
      "service_alias": "string",
      "service_cname": "string",
      "service_region": "string",
      "desc": "string",
      "category": "string",
      "version": "string",
      "update_version": 3,
      "image": "string",
      "cmd": "string",
      "min_node": 3,
      "min_cpu": 3,
      "container_gpu": 3,
      "min_memory": 3,
      "extend_method": "string",
      "code_from": "string",
      "git_url": "string",
      "git_project_id": 3,
      "code_version": "string",
      "service_type": "string",
      "creater": 3,
      "language": "string",
      "total_memory": 3,
      "is_service": true,
      "service_origin": "string",
      "tenant_service_group_id": 3,
      "open_webhooks": true,
      "service_source": "string",
      "create_status": "string",
      "check_uuid": "string",
      "check_event_id": "string",
      "docker_cmd": "string",
      "server_type": "string",
      "is_upgrate": true,
      "build_upgrade": true,
      "oauth_service_id": 3,
      "k8s_component_name": "string"
    }
  ]
}
```

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

### Example of Successful Rainbond Installation Pods

Source: https://www.rainbond.com/docs/ops-guides/more-installation/k3s

This output shows an example of all Rainbond pods running successfully, indicating a complete installation.

```text
NAME                                      READY   STATUS    RESTARTS   AGE
local-path-provisioner-78d88b6df5-wkr84   1/1     Running   0          5m37s
minio-0                                   1/1     Running   0          5m37s
rainbond-operator-59ff8bb988-nlqrt        1/1     Running   0          5m56s
rbd-api-5466bd748f-brqmv                  1/1     Running   0          5m15s
rbd-app-ui-5577b8ff88-fpnnv               1/1     Running   0          4m39s
rbd-chaos-6828h                           1/1     Running   0          5m12s
rbd-db-0                                  1/1     Running   0          5m35s
rbd-gateway-69bfb68f4d-7xd9n              2/2     Running   0          5m34s
rbd-hub-8457697d4c-fqwgn                  1/1     Running   0          5m28s
rbd-monitor-0                             1/1     Running   0          5m27s
rbd-mq-5b6f94b695-gmdnn                   1/1     Running   0          5m25s
rbd-worker-7db9f9cccc-s9wml               1/1     Running   0          5m22s

```

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

### Start Rainbond Installation

Source: https://www.rainbond.com/docs/installation/offline

Execute this command from the directory containing `roi`, `cluster.yaml`, and the `offline-packages` directory to begin the Rainbond installation process.

```bash
./roi up
```

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

### Start Project with Yarn

Source: https://www.rainbond.com/docs/contribution/code/ui

Alternatively, start the project using the Yarn start command.

```bash
yarn start
```

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

### Start Project with npm

Source: https://www.rainbond.com/docs/contribution/code/ui

Run the project locally using the npm start command.

```bash
npm run start
```

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

### Install Application Request Body Example

Source: https://www.rainbond.com/docs/api/application/installAppByMarket

This JSON body is used to send installation requests for an application. It includes market details and the specific application model ID and version to install. The 'market_type' defaults to 'rainstore'.

```json
{
  "market_url": "https://hub.rainbond.com",
  "market_domain": "rainbond",
  "market_type": "rainstore",
  "market_access_key": "123456789012340af5dff63cb740788e",
  "app_model_id": "string",
  "app_model_version": "string"
}
```

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

### Example Helm Chart Configuration

Source: https://www.rainbond.com/docs/ops-guides/configuration/vaules-config

A comprehensive example of a values.yaml file for Rainbond Helm chart installation. Customize these values to configure your Rainbond cluster.

```yaml
operator:
  env:
  - name: STORAGE_CLASS_NAME
    value: "nfs-storage"
Cluster:
  gatewayIngressIPs: 192.168.8.8

  nodesForGateway:
  - externalIP: 192.168.8.8
    internalIP: 192.168.8.8
    name: k8s1
# - More nodes for gateway

  nodesForChaos:
  - name: k8s1
# - More nodes for chaos

  containerdRuntimePath: /run/containerd

  imageHub:
    enable: true
    domain: image.image.com
    namespace: admin
    username: admin
    password: admin

  regionDatabase:
    enable: true
    host: 192.168.8.8
    port: 3306
    name: region
    username: root
    password: root

  uiDatabase:
    enable: true
    host: 192.168.8.8
    port: 3306
    name: console
    username: root
    password: root

  rainbondImageRepository: registry.cn-hangzhou.aliyuncs.com/goodrain
  # https://github.com/goodrain/rainbond/releases
  installVersion: <version>
  imagePullPolicy: IfNotPresent
  replicas: 1

```

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

### Start Django Development Server

Source: https://www.rainbond.com/docs/contribution/code/console

Commands to start the development server for initialized or uninitialized databases.

```bash
python3 manage.py runserver  
```

```bash
python3 manage.py makemigrations www  
python3 manage.py makemigrations console  
python3 manage.py migrate  
  
python3 manage.py runserver  
```

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

### Response Example: Get List of Apps

Source: https://www.rainbond.com/docs/Intro

Example response body for the 'Get List of Apps' endpoint. The 'ID' field represents the 'app_id'.

```json
[
    {
        "ID":1,
        "tenant_id":"8e5a07dd37e34dd7a2a74b0a2ab29d95",
        "group_name":"测试应用",
        "region_name":"test",
        "is_default":true,
        "order_index":0,
        "note":"",
        "username":"",
        "governance_mode":"BUILD_IN_SERVICE_MESH",
        "create_time":"2022-06-01T13:52:13.407637",
        "update_time":"2022-06-15T15:37:51.020167",
        "app_type":"rainbond",
        "app_store_name":null,
        "app_store_url":null,
        "app_template_name":null,
        "version":null,
        "logo":"",
        "k8s_app":"app-38b4d14a"
    }
]
```

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

### Install K3s

Source: https://www.rainbond.com/docs/ops-guides/more-installation/k3s

Execute the K3s installation script using the specified mirror. Ensure you have the necessary permissions to run this command.

```bash
curl -sfL https://rancher-mirror.rancher.cn/k3s/k3s-install.sh | INSTALL_K3S_MIRROR=cn sh -s -
```

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

### Create Application Response Example

Source: https://www.rainbond.com/docs/api/application/createTeamApps

Example JSON response returned upon successful application creation.

```json
{
  "ID": 3,
  "tenant_id": "string",
  "group_name": "string",
  "region_name": "string",
  "is_default": true,
  "order_index": 3,
  "note": "string",
  "username": "string",
  "governance_mode": "string",
  "create_time": "2004-01-01 11:11:11",
  "update_time": "2004-01-01 11:11:11",
  "app_type": "string",
  "app_store_name": "string",
  "app_store_url": "string",
  "app_template_name": "string",
  "version": "string",
  "logo": "string",
  "k8s_app": "string"
}
```

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

### Install Model Definition

Source: https://www.rainbond.com/docs/api/application/installAppByMarket

This JSON structure defines the parameters required for the 'Install' request. It includes details about the application and the market from which it is being installed.

```json
{
  "market_url": "string",
  "market_domain": "string",
  "market_type": "string",
  "market_access_key": "string",
  "app_model_id": "string",
  "app_model_version": "string"
}
```

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

### Install KubeBlocks

Source: https://www.rainbond.com/docs/how-to-guides/databases/install

Install KubeBlocks CRDs and the main application using Helm with custom registry settings.

```bash
# 安装 CRDs  
kubectl create -f https://jihulab.com/api/v4/projects/98723/packages/generic/kubeblocks/v1.0.1/kubeblocks_crds.yaml  
  
# 设置 Helm Repository  
helm repo add kubeblocks https://jihulab.com/api/v4/projects/85949/packages/helm/stable  
helm repo update  
  
# 设置使用 KubeBlocks 提供的国内阿里云镜像源  
helm install kubeblocks kubeblocks/kubeblocks --namespace kb-system --create-namespace --version=v1.0.1 \
--set image.registry=apecloud-registry.cn-zhangjiakou.cr.aliyuncs.com \
--set dataProtection.image.registry=apecloud-registry.cn-zhangjiakou.cr.aliyuncs.com \
--set addonChartsImage.registry=apecloud-registry.cn-zhangjiakou.cr.aliyuncs.com \
-f backuprepo.yaml  
```

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

### Response Example: Build Component

Source: https://www.rainbond.com/docs/Intro

Example response body after initiating a component build. It contains an 'event_id' for tracking the build process.

```json
{
    "event_id": "5821167607ec460b89b326084fb3d1e0"
}
```

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

### Install Helm Chart Application

Source: https://www.rainbond.com/docs/api/application/buildHelmApp

Installs a Helm chart application using a POST request.

```http
Post /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/helm_chart
```

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

### Install Rainbond with Local Chart

Source: https://www.rainbond.com/docs/ops-guides/management/change-default-ports

Install Rainbond using Helm with a local chart directory, applying custom configurations from a `values.yaml` file.

```bash
helm install rainbond ./rainbond-chart \
  -f values.yaml \
  --create-namespace \
  --namespace rbd-system
```

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

### Create Application Request Body Example

Source: https://www.rainbond.com/docs/api/application/createTeamApps

Example JSON payload for the application creation request.

```json
{
  "app_name": "Test",
  "app_note": "sint dolor in consectetur"
}
```

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

### Verify Plugin Installation

Source: https://www.rainbond.com/docs/how-to-guides/databases/install

Check if the kb-adapter pod is running in the rbd-system namespace to confirm successful plugin installation.

```bash
kubectl get pod -n rbd-system | grep kb-adapter
```

```text
# 预期输出:
kb-adapter-rbdplugin-8569878bbc-qp997    1/1     Running   0              17s  
```

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

### Install Rainbond via Shell

Source: https://www.rainbond.com/docs/get-start/concept/plugin

Execute this command in your terminal to download and run the installation script. Ensure you have access to the target infrastructure before running.

```bash
curl -o install.sh https://get.rainbond.com && bash ./install.sh
```

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

### Install Rainbond using Helm

Source: https://www.rainbond.com/docs/ops-guides/more-installation/k3s

Install Rainbond by deploying the Rainbond Helm chart. This command creates the necessary namespace and deploys Rainbond components.

```bash
helm install rainbond rainbond/rainbond --create-namespace -n rbd-system

```

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

### Installation Completion and Access Info

Source: https://www.rainbond.com/docs/installation/offline

Upon successful installation, the logs will display the console access URL and commands to check cluster status using `kubectl`.

```bash
✅ Installation completed successfully!  
  
📝 Next Steps:  
  1. Access Rainbond console:  
     http://172.16.0.135:7070  
  
  2. Check cluster status:  
     kubectl get nodes  
     kubectl get pods -n rbd-system  
```

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

### Response Example: Get List of Regions

Source: https://www.rainbond.com/docs/Intro

Example response body for the 'Get List of Regions' endpoint. The 'region_name' is the unique identifier for a cluster.

```json
[
    {
        "region_id":"febc993cefe84d158b3ac245d7aa0943",
        "region_name":"test",
        "region_alias":"自建集群",
        "url":"https://192.168.2.225:8443",
        "status":"1",
        "desc":"提供主机安装 Kubernetes 集群并对接",
        "scope":"private",
        "ssl_ca_cert":null,
        "cert_file":null,
        "key_file":null
    }
]
```

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

### Example of Successful Pod Status

Source: https://www.rainbond.com/docs/ops-guides/more-installation/cce

This output shows an example of all Rainbond pods running successfully in the 'rbd-system' namespace after installation.

```text
NAME                                      READY   STATUS    RESTARTS   AGE  
local-path-provisioner-78d88b6df5-wkr84   1/1     Running   0          5m37s  
minio-0                                   1/1     Running   0          5m37s  
rainbond-operator-59ff8bb988-nlqrt        1/1     Running   0          5m56s  
rbd-api-5466bd748f-brqmv                  1/1     Running   0          5m15s  
rbd-app-ui-5577b8ff88-fpnnv               1/1     Running   0          4m39s  
rbd-chaos-6828h                           1/1     Running   0          5m12s  
rbd-db-0                                  1/1     Running   0          5m35s  
rbd-gateway-69bfb68f4d-7xd9n              2/2     Running   0          5m34s  
rbd-hub-8457697d4c-fqwgn                  1/1     Running   0          5m28s  
rbd-monitor-0                             1/1     Running   0          5m27s  
rbd-mq-5b6f94b695-gmdnn                   1/1     Running   0          5m25s  
rbd-worker-7db9f9cccc-s9wml               1/1     Running   0          5m22s  


```

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

### Complete Cluster Configuration Example

Source: https://www.rainbond.com/docs/ops-guides/roi-reference/configuration

This example demonstrates a full cluster.yaml configuration, including host definitions, role assignments, storage, database, and Rainbond settings. It serves as a template for setting up a Rainbond cluster.

```yaml
# ==========================================  
# 主机配置  
# ==========================================  
hosts:  
  - name: node-1                          # 主机名  
    address: 192.168.1.10                 # 公网 IP  
    internalAddress: 172.16.0.10          # 内网 IP  
    port: 22                              # SSH 端口(默认: 22)  
    user: root                            # SSH 用户  
    password: "SecurePassword123!"        # SSH 密码  
  
  - name: node-2  
    address: 192.168.1.11  
    internalAddress: 172.16.0.11  
    user: root  
    password: "SecurePassword123!"  
  
  - name: node-3  
    address: 192.168.1.20  
    internalAddress: 172.16.0.20  
    user: root  
    password: "SecurePassword123!"  
  
# ==========================================  
# 角色分配  
# ==========================================  
roleGroups:  
  # Etcd 节点  
  etcd:  
    - node-1  
    - node-2  
    - node-3  
  
  # Master 节点(控制平面)  
  master:  
    - node-1  
    - node-2  
    - node-3  
  
  # Worker 节点(运行业务负载)  
  worker:  
    - node-1  
    - node-2  
    - node-3  
  
  # NFS 服务器节点(只能一个)  
  nfs-server:  
    - node-1  
  
  # Rainbond 网关节点(可多个,用于高可用)  
  rbd-gateway:  
    - node-1  
    - node-2  
    - node-3  
  
  # Rainbond 构建节点(可多个)  
  rbd-chaos:  
    - node-1  
    - node-2  
    - node-3  
  
# ==========================================  
# 存储配置  
# ==========================================  
storage:  
  # LVM 配置，自动创建 RKE2 和 Rainbond 所需的逻辑卷  
  lvm:  
    enabled: false        # 是否启用 LVM，默认 false  
    # 填写各个节点的磁盘设备列表，必须与 hosts 中的节点一一对应  
    nodeDevices:  
      node-1:  
        - /dev/sdb  
        - /dev/sdc  
      node-2:  
        - /dev/nvme0n1  
      node-3:  
        - /dev/vdb  
  
    # 方式1: 百分比分配(推荐)  
    rke2Percentage: 70       # RKE2 存储占比 70% (/var/lib/rancher/rke2)，存储 RKE2 数据包括镜像数据等  
    rainbondPercentage: 30   # Rainbond 存储占比 30% (/opt/rainbond)，组件本地存储默认路径以及构建缓存数据等  
    # rke2Percentage: 100    # 如果为 100 则只创建 RKE2 分区  
    # rainbondPercentage: 0  # 如果为 0 则跳过 Rainbond 分区创建  
  
    # 方式2: 固定大小分配(会覆盖百分比配置)  
    # rke2Size: "200G"  
    # rainbondSize: "100G"  
  
  # NFS Server 配置  
  nfs:  
    enabled: false               # 是否启用 NFS，默认 false，启动后会在 nfs-server 节点上安装 NFS 服务  
    sharePath: /nfs-data/k8s     # NFS 共享路径，默认 /nfs-data/k8s  
    storageClass:  
      enabled: true              # 是否创建 StorageClass，默认 true  
  
  
# ==========================================  
# 数据库配置  
# ==========================================  
database:  
  # 启用 ROI 工具安装的 MySQL 主从集群  
  mysql:  
    enabled: false                          # 是否启用，默认 false  
    masterPassword: "Root123456"            # Root 用户默认密码  
    replicationPassword: "ReplPassword123!" # 复制用户默认密码  
    replicaCount: 1                         # secondary副本数,默认1  
    # 持久化配置(自动推断)  
    # persistence:  
    #   enabled: true                        # 自动根据 mysql.enabled 设置  
    #   storageClass: "nfs-storage"          # 自动根据 nfs.enabled 选择，如果启用 NFS 则为 nfs-storage，否则为 local-path（本地存储）  
    #   size: "5Gi"                          # 数据卷大小  
  # 对接集群之外的自定义 MySQL 数据库  
  custom:  
    enabled: false                           # 是否启用，默认 false   
    console:                                 # Rainbond 控制台数据库配置          
      host: "mysql.example.com"                 # MySQL 主机地址  
      port: 3306                                # MySQL 端口  
      database: "console"                       # 数据库名称  
      username: "rainbond"                      # 数据库用户名  
      password: "your-password"                 # 数据库密码  
    region:                                  # Rainbond Region 数据库配置  
      host: "mysql.example.com"                 # MySQL 主机地址  
      port: 3306                                # MySQL 端口  
      database: "region"                        # 数据库名称  
      username: "rainbond"                      # 数据库用户名  
      password: "your-password"                 # 数据库密码  
  
# ==========================================  
# Rainbond 配置  
# ==========================================  
rainbond:  
  # 通过 github release 获取最新版本号，https://github.com/goodrain/rainbond/releases/latest  
  version: v6.x.x-release                   # 默认 Rainbond 最新版本  

```

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

### Check and Install Helm Chart Application

Source: https://www.rainbond.com/docs/api/application/buildHelmApp

This endpoint allows you to check and install a Helm chart package. It supports GET requests to verify the chart and POST requests to initiate the installation.

```APIDOC
## GET /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/helm_chart

### Description
Checks if a Helm chart can be installed.

### Method
GET

### Endpoint
/openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/helm_chart

### Parameters
#### Path Parameters
- **team_id** (string) - Required - Team ID or name.
- **region_name** (string) - Required - Datacenter name.
- **app_id** (integer) - Required - Application group ID.

#### Request Body
- **repo_name** (string) - Optional - Helm repository name.
- **chart_name** (string) - Optional - Helm chart application name.
- **version** (string) - Optional - Application version.

### Request Example
```json
{
  "repo_name": "string",
  "chart_name": "string",
  "version": "string"
}
```

### Response
#### Success Response (200)
- **checkAdopt** (bool) - Indicates if the check passed.
- **yaml** (string) - Reason for failure if the check did not pass.

#### Response Example
```json
{
  "checkAdopt": true,
  "yaml": ""
}
```
```

```APIDOC
## POST /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/helm_chart

### Description
Installs a Helm chart package.

### Method
POST

### Endpoint
/openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/helm_chart

### Parameters
#### Path Parameters
- **team_id** (string) - Required - Team ID or name.
- **region_name** (string) - Required - Datacenter name.
- **app_id** (integer) - Required - Application group ID.

#### Request Body
- **repo_name** (string) - Optional - Helm repository name.
- **chart_name** (string) - Optional - Helm chart application name.
- **version** (string) - Optional - Application version.

### Request Example
```json
{
  "repo_name": "string",
  "chart_name": "string",
  "version": "string"
}
```

### Response
#### Success Response (200)
- **checkAdopt** (bool) - Indicates if the check passed.
- **yaml** (string) - Reason for failure if the check did not pass.

#### Response Example
```json
{
  "checkAdopt": true,
  "yaml": ""
}
```
```

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

### Response Example: Get List of Teams

Source: https://www.rainbond.com/docs/Intro

This is an example of the response body when successfully retrieving a list of teams. The 'tenant_id' corresponds to the 'team_id' parameter.

```json
{
    "tenants":[
        {
            "ID":1,
            "tenant_id":"8e5a07dd37e34dd7a2a74b0a2ab29d95",
            "tenant_name":"o19p6wen",
            "tenant_alias":"admin的团队",
            "is_active":true,
            "enterprise_id":"f246bce23170eeaac90d6f7b150793f0",
            "create_time":"2022-06-01T13:52:13.321196",
            "creater":"admin",
            "role_infos":[
                {
                    "role_id":"1",
                    "role_name":"管理员"
                }
            ]
        }
    ],
    "total":1,
    "page":1,
    "page_size":10
}
```

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

### Access and View Console Logs (Quick Install)

Source: https://www.rainbond.com/docs/ops-guides/overview

Steps to access the Rainbond console logs for quick installation versions. This involves entering the Docker container and then the specific UI pod.

```bash
# 1. 进入容器
docker exec -it rainbond bash

# 2. 进入 Pod
kubectl exec -it $(kubectl get pod -l name=rbd-app-ui -n rbd-system -o name) -n rbd-system -- bash

# 3. 查看日志
tail -f /app/logs/goodrain.log
```

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

### Custom Startup Script Configuration

Source: https://www.rainbond.com/docs/how-to-guides/app-deploy/source-code/nodejs

Define custom build and start scripts in package.json to override default Rainbond behavior.

```json
{
  "scripts": {
    "build": "next build",
    "start": "node server.js"
  }
}
```

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

### Install Python Dependencies

Source: https://www.rainbond.com/docs/contribution/code/console

Use virtualenv to manage project dependencies before starting the application.

```bash
python3.6 -m virtualenv venv  
source venv/bin/activate  
pip install -r requirements.txt  
```

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

### Verify MySQL Database Connection

Source: https://www.rainbond.com/docs/how-to-guides/micro-service-deploy/pig-example

Connect to the MySQL database using the command-line client to verify the installation and database setup. Ensure you have the correct credentials.

```bash
mysql -uroot -proot # 连接 MySQL 数据库  
show databases; # 查看数据库列表  
use pig; # 切换到 pig 数据库  
show tables; # 查看表列表  
select * from sys_user; # 查看用户表数据  
exit; # 退出 MySQL 客户端  
```

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

### 编辑 BuildKit 配置

Source: https://www.rainbond.com/docs/ops-guides/management/buildkit-args

使用 kubectl 编辑 goodrain.me 配置映射以调整 BuildKit 设置。

```bash
kubectl edit cm goodrain.me -n rbd-system
```

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

### Build Project

Source: https://www.rainbond.com/docs/contribution/code/ui

Command to compile the project.

```bash
npm run build  
```

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

### Request Body Example for Mounting Storage

Source: https://www.rainbond.com/docs/api/application/bindVolumes

Provide the volume name, type, path, and capacity in the request body to mount storage. Ensure the volume_type is supported by your Rainbond setup.

```json
{
  "volume_name": "name",
  "volume_type": "share-file",
  "volume_path": "/data4",
  "volume_capacity": 1
}
```

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

### Install Snapshot Controller via Helm

Source: https://www.rainbond.com/docs/how-to-guides/databases/install

Deploy the Snapshot Controller into the kb-system namespace using Helm.

```bash
helm repo add piraeus-charts https://piraeus.io/helm-charts/  
helm repo update  
helm install snapshot-controller piraeus-charts/snapshot-controller -n kb-system --create-namespace \
  --set controller.image.repository=k8s.m.daocloud.io/sig-storage/snapshot-controller  
```

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

### Custom Startup Command with Procfile

Source: https://www.rainbond.com/docs/how-to-guides/app-deploy/source-code/golang

To customize the startup command for a Go application, you can add a Procfile in the root directory of your source code. This file specifies the command to run the application.

```yaml
web: ./your-binary
```

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

### Install Rainbond on Linux

Source: https://www.rainbond.com/docs/quick-start/quick-install

Execute this command on Linux to install Rainbond using Docker. It's suitable for experience installations and compatible with trusted environments.

```bash
curl -o install.sh https://get.rainbond.com && bash ./install.sh  

```

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

### Check Installation Progress

Source: https://www.rainbond.com/docs/installation/install-with-helm

Monitor the installation progress of Rainbond by checking the status of pods in the rbd-system namespace. Installation is complete when all pods are in a Running state.

```bash
kubectl get pod -n rbd-system
```

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

### roi up - Install Cluster

Source: https://www.rainbond.com/docs/ops-guides/roi-reference/command-reference

The main command to install a Rainbond cluster.

```APIDOC
## roi up - Install Cluster

Installs the Rainbond cluster.

### Basic Usage

```
roi up [flags]
```

### Parameter Description

**Configuration File Parameter:**

```
-f, --file string    # Specify the path to the cluster configuration file (default: cluster.yaml)
```

**Phase Control Parameters:**

Supports executing only specific phases for debugging or retries:

```
--check              # Only execute the environment check phase
--optimize           # Only execute the system optimization phase
--rke2               # Only execute the RKE2 installation phase
--mysql              # Only execute the MySQL installation phase
--rainbond           # Only execute the Rainbond installation phase
```

**Storage Specific Parameters:**

Fine-grained control over storage configuration:

```
--storage-lvm                # Configure LVM storage only
--storage-nfs                # Configure NFS server only
--storage-nfs-provisioner    # Install NFS provisioner only
```

**Installation Options:**

```
--skip-production-check      # Skip production environment check (for development/testing only)
--skip-optimize              # Skip the system optimization phase
```

### Usage Examples

```
# Single-node zero-configuration installation
roi up

# Full installation using a configuration file
roi up -f production.yaml

# Only check the environment
roi up -f cluster.yaml --check

# Configure LVM storage only
roi up -f cluster.yaml --storage-lvm

# Redeploy Rainbond (keeping Kubernetes)
roi up -f cluster.yaml --rainbond

# Skip checks for quick installation (development environment)
roi up --skip-production-check --skip-optimize

# Enable debug logs
roi up -f cluster.yaml -d
```
```

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

### 更新集群中的组件镜像

Source: https://www.rainbond.com/docs/contribution/code/region

通过修改 rbdcomponent 资源并查看 Pod 状态来应用新的镜像。

```bash
kubectl edit rbdcomponent rbd-chaos -n rbd-system
```

```yaml
image: rainbond/rbd-chaos:v5.5.0-release
imagePolicy: IfNotPresent
```

```bash
kubectl get po -n rbd-system
```

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

### Add RabbitMQ Addon

Source: https://www.rainbond.com/docs/how-to-guides/databases/install

Install the RabbitMQ addon using the specified mirror registry.

```bash
helm upgrade -i kb-addon-rabbitmq kubeblocks-addons/rabbitmq --version 1.0.1 -n kb-system \
--set image.registry=apecloud-registry.cn-zhangjiakou.cr.aliyuncs.com  
```

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

### Install Dependencies with Yarn

Source: https://www.rainbond.com/docs/contribution/code/ui

Install project dependencies using the Yarn package manager.

```bash
yarn install
```

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

### Install Commitizen

Source: https://www.rainbond.com/docs/contribution

Commands to install Commitizen globally and configure the conventional changelog adapter.

```bash
npm install -g commitizen  
npm install -g cz-conventional-changelog  
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc  

```

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

### Custom .NET Project Startup Command

Source: https://www.rainbond.com/docs/how-to-guides/app-deploy/source-code/dotnet

Provide a custom startup command for your ASP.NET Core project by creating a Procfile in the source root or by specifying it in the build parameters.

```shell
web: dotnet app.dll
```

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

### Check Virtualization Support

Source: https://www.rainbond.com/docs/vm-guide/vm_deploy

Use this command to verify if your server's CPU supports virtualization. A non-zero output indicates support.

```bash
egrep -c '(vmx|svm)' /proc/cpuinfo
```

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

### 查看组件本地存储使用情况

Source: https://www.rainbond.com/docs/ops-guides/management/resource-cleanup

检查 /opt/rainbond/local-path-provisioner 目录下各组件存储的占用空间。

```bash
du -sh /opt/rainbond/local-path-provisioner/*  
```

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

### GET /openapi/v1/configs - Get Enterprise Configuration Information

Source: https://www.rainbond.com/docs/api/enterprise/getEnterpriseConfigInfo

Retrieves the current enterprise configuration settings.

```APIDOC
## GET /openapi/v1/configs

### Description
Retrieves the enterprise configuration information.

### Method
GET

### Endpoint
/openapi/v1/configs

### Response
#### Success Response (200)
- **export_app** (object) - Configuration for exporting applications.
- **auto_ssl** (object) - Configuration for automatic SSL.
- **oauth_services** (object) - Configuration for OAuth services.
- **cloud_market** (object) - Configuration for the cloud market.
- **object_storage** (object) - Configuration for object storage.
- **appstore_image_hub** (object) - Configuration for the app store image hub.
- **newbie_guide** (object) - Configuration for the newbie guide.

#### Response Example
```json
{
  "export_app": {
    "enable": false,
    "value": "string"
  },
  "auto_ssl": {
    "enable": false,
    "value": "string"
  },
  "oauth_services": {
    "enable": false,
    "value": [
      {
        "enable": true,
        "auth_url": "string",
        "name": "string",
        "is_console": false,
        "is_auto_login": false,
        "service_id": 0,
        "oauth_type": "string",
        "eid": "string",
        "home_url": "string",
        "access_token_url": "string",
        "api_url": "string",
        "is_deleted": false,
        "is_git": false
      }
    ]
  },
  "cloud_market": {
    "enable": false,
    "value": "string"
  },
  "object_storage": {
    "enable": false,
    "value": {
      "provider": "string",
      "endpoint": "string",
      "access_key": "string",
      "secret_key": "string",
      "bucket_name": "string"
    }
  },
  "appstore_image_hub": {
    "enable": false,
    "value": {
      "namespace": "string",
      "hub_password": "string",
      "hub_url": "string",
      "hub_user": "string"
    }
  },
  "newbie_guide": {
    "enable": false,
    "value": "string"
  }
}
```
```

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

### Component Port Update Request Body Example

Source: https://www.rainbond.com/docs/api/application/handleComponentPorts

Example of a request body for updating a component port. This specific example changes the port alias. Other actions like opening/closing services or changing protocols are also supported.

```json
{
    "action": "change_port_alias",
    "port_alias": "NGINX_PORT",
    "k8s_service_name": "nginx_port",
    "protocol": "tcp",
}
```

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

### Install Rainbond Cluster on New Node

Source: https://www.rainbond.com/docs/tutorial/docking-selfhost

Execute this command on the target server to initialize Kubernetes nodes, deploy components, and join the Rainbond cluster. Ensure the control plane and worker flags are set according to your needs. The token is required for authentication.

```bash
# Example command (actual output may vary based on console)
curl -sfL http://<Console IP>:7070/install-cluster.sh | sh -s - --rbd-url http://<Console IP>:7070 --etcd --control-plane --worker --token <TOKEN> --mirror cn  

```

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

### Get Helm Chart Information

Source: https://www.rainbond.com/docs/api/application/buildHelmApp

Retrieves information about a Helm chart application using a GET request.

```http
Get /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/helm_chart
```

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

### Download ROI for ARM Architecture

Source: https://www.rainbond.com/docs/installation/offline

Use this command to download the Rainbond Installation tool (ROI) for ARM (arm64) architecture. Ensure you have internet access for this step.

```bash
curl -o roi https://get.rainbond.com/roi/roi-arm64 && chmod +x roi
```

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

### Example values.yaml Configuration

Source: https://www.rainbond.com/docs/how-to-guides/app-deploy/deploy-using-yaml-helm/export-chart

The `values.yaml` file in the Helm Chart package allows configuration of parameters such as database connection details, image repository, and storage class.

```yaml
mysql:
  MYSQL_HOST:127.0.0.1
  MYSQL_PASS:123456
redis:
  REDIS_HOST:127.0.0.1
  REDIS_PASS:123456
imageDomain: goodrain.me
storageClass: ""  

```

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

### Clone the Frontend Project

Source: https://www.rainbond.com/docs/contribution/code/ui

Clone the Rainbond UI repository from GitHub to start development.

```bash
git clone https://github.com/goodrain/rainbond-ui.git
```
Tokens:
Raw