diff --git a/src/.vuepress/sidebar/V1.3.3/en.ts b/src/.vuepress/sidebar/V1.3.3/en.ts index 7e3eb8d65..ac0f3de9d 100644 --- a/src/.vuepress/sidebar/V1.3.3/en.ts +++ b/src/.vuepress/sidebar/V1.3.3/en.ts @@ -175,6 +175,7 @@ export const enSidebar = { { text: 'DBeaver', link: 'DBeaver' }, { text: 'Grafana(IoTDB)', link: 'Grafana-Connector' }, { text: 'Grafana Plugin', link: 'Grafana-Plugin' }, + { text: 'Kubernetes', link: 'Kubernetes_apache' }, { text: 'ThingsBoard', link: 'Thingsboard' }, ], }, diff --git a/src/.vuepress/sidebar/V1.3.3/zh.ts b/src/.vuepress/sidebar/V1.3.3/zh.ts index 42ae0c252..c45dc25b1 100644 --- a/src/.vuepress/sidebar/V1.3.3/zh.ts +++ b/src/.vuepress/sidebar/V1.3.3/zh.ts @@ -162,6 +162,7 @@ export const zhSidebar = { { text: 'DBeaver', link: 'DBeaver' }, { text: 'Grafana(IoTDB)', link: 'Grafana-Connector' }, { text: 'Grafana插件', link: 'Grafana-Plugin' }, + { text: 'Kubernetes', link: 'Kubernetes_apache' }, { text: 'ThingsBoard', link: 'Thingsboard' }, ], }, diff --git a/src/.vuepress/sidebar_timecho/V1.3.3/en.ts b/src/.vuepress/sidebar_timecho/V1.3.3/en.ts index 207df6539..35f195e7b 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.3/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.3/en.ts @@ -194,6 +194,7 @@ export const enSidebar = { { text: 'Ignition', link: 'Ignition-IoTDB-plugin_timecho' }, { text: 'Grafana(IoTDB)', link: 'Grafana-Connector' }, { text: 'Grafana Plugin', link: 'Grafana-Plugin' }, + { text: 'Kubernetes', link: 'Kubernetes_timecho' }, { text: 'ThingsBoard', link: 'Thingsboard' }, ], }, diff --git a/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts b/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts index ff86aaa3f..6d1c7535f 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.3/zh.ts @@ -177,6 +177,7 @@ export const zhSidebar = { { text: 'Ignition', link: 'Ignition-IoTDB-plugin_timecho' }, { text: 'Grafana(IoTDB)', link: 'Grafana-Connector' }, { text: 'Grafana插件', link: 'Grafana-Plugin' }, + { text: 'Kubernetes', link: 'Kubernetes_timecho' }, { text: 'ThingsBoard', link: 'Thingsboard' }, ], }, diff --git a/src/.vuepress/sidebar_timecho/V2.0.1/zh-Tree.ts b/src/.vuepress/sidebar_timecho/V2.0.1/zh-Tree.ts index fde8e0193..d2e444f98 100644 --- a/src/.vuepress/sidebar_timecho/V2.0.1/zh-Tree.ts +++ b/src/.vuepress/sidebar_timecho/V2.0.1/zh-Tree.ts @@ -177,6 +177,7 @@ export const zhSidebar = { { text: 'Ignition', link: 'Ignition-IoTDB-plugin_timecho' }, { text: 'Grafana(IoTDB)', link: 'Grafana-Connector' }, { text: 'Grafana插件', link: 'Grafana-Plugin' }, + { text: 'Kubernetes', link: 'Kubernetes_timecho' }, { text: 'ThingsBoard', link: 'Thingsboard' }, ], }, diff --git a/src/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_apache.md b/src/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_apache.md new file mode 100644 index 000000000..0fb5b73d9 --- /dev/null +++ b/src/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_apache.md @@ -0,0 +1,454 @@ + + +# Kubernetes + +## 1. Environment Preparation + +### 1.1 Prepare a Kubernetes Cluster + +Ensure that you have an available Kubernetes cluster (minimum recommended version: Kubernetes 1.24) as the foundation for deploying the IoTDB cluster. + +Kubernetes Version Requirement: The recommended version is Kubernetes 1.24 or above. + +IoTDB Version Requirement: The version of IoTDB must not be lower than v1.3.3. + +## 2. Create Namespace + +### 2.1 Create Namespace + +> Note: Before executing the namespace creation operation, verify that the specified namespace name has not been used in the Kubernetes cluster. If the namespace already exists, the creation command will fail, which may lead to errors during the deployment process. + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 View Namespace + +```Bash +kubectl get ns +``` + +## 3. Create PersistentVolume (PV) + +### 3.1 Create PV Configuration File + +PV is used for persistent storage of IoTDB's ConfigNode and DataNode data. You need to create one PV for each node. + +> Note: One ConfigNode and one DataNode count as two nodes, requiring two PVs. + +For example, with 3 ConfigNodes and 3 DataNodes: + +1. Create a `pv.yaml` file and make six copies, renaming them to `pv01.yaml` through `pv06.yaml`. + +```Bash +# Create a directory to store YAML files +# Create pv.yaml file +touch pv.yaml +``` + +2. Modify the `name` and `path` in each file to ensure consistency. + +**pv.yaml Example：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # Storage capacity + accessModes: # Access modes + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # Reclaim policy + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + storageClassName: local-storage + # Add the corresponding configuration based on your storage type + hostPath: # If using a local path + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # If this line is not configured, you need to manually create the directory +``` + +### 3.2 Apply PV Configuration + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 View PV + +```Bash +kubectl get pv +``` + + +### 3.4 Manually Create Directories + +> Note: If the type in the hostPath of the YAML file is not configured, you need to manually create the corresponding directories. + +Create the corresponding directories on all Kubernetes nodes: +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. Install Helm + +For installation steps, please refer to the[Helm Official Website.](https://helm.sh/zh/docs/intro/install/) + +## 5. Configure IoTDB Helm Chart + +### 5.1 Clone IoTDB Kubernetes Deployment Code + +Please contact timechodb staff to obtain the IoTDB Helm Chart. If you encounter proxy issues, disable the proxy settings: + + +If encountering proxy issues, cancel proxy settings: + +> The git clone error is as follows, indicating that the proxy has been configured and needs to be turned off fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 Modify YAML Files + +> Ensure that the version used is supported (>=1.3.3.2): + +**values.yaml Example：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" # Name after installation + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone # Repository and version used + +storage: + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + className: local-storage + +datanode: + name: datanode + nodeCount: 3 # Number of DataNode nodes + enableRestService: true + storageCapacity: 10Gi # Available space for DataNode + resources: + requests: + memory: 2Gi # Initial memory size for DataNode + cpu: 1000m # Initial CPU size for DataNode + limits: + memory: 4Gi # Maximum memory size for DataNode + cpu: 1000m # Maximum CPU size for DataNode + +confignode: + name: confignode + nodeCount: 3 # Number of ConfigNode nodes + storageCapacity: 10Gi # Available space for ConfigNode + resources: + requests: + memory: 512Mi # Initial memory size for ConfigNode + cpu: 1000m # Initial CPU size for ConfigNode + limits: + memory: 1024Mi # Maximum memory size for ConfigNode + cpu: 2000m # Maximum CPU size for ConfigNode + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. Configure Private Repository Information or Pre-Pull Images + +Configure private repository information on k8s as a prerequisite for the next helm install step. + +Option one is to pull the available iotdb images during helm insta, while option two is to import the available iotdb images into containerd in advance. + +### 6.1 [Option 1] Pull Image from Private Repository + +#### 6.1.1 Create a Secret to Allow k8s to Access the IoTDB Helm Private Repository + +Replace xxxxxx with the IoTDB private repository account, password, and email. + + + +```Bash +# Note the single quotes +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# View the secret +kubectl get secret timecho-nexus -n iotdb-ns +# View and output as YAML +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# View and decrypt +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 Load the Secret as a Patch to the Namespace iotdb-ns + +```Bash +# Add a patch to include login information for nexus in this namespace +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# View the information in this namespace +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 [Option 2] Import Image + +This step is for scenarios where the customer cannot connect to the private repository and requires assistance from company implementation staff. + +#### 6.2.1 Pull and Export the Image: + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 View and Export the Image: + +```Bash +# View +ctr images ls + +# Export +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 Import into the k8s Namespace: + +> Note that k8s.io is the namespace for ctr in the example environment; importing to other namespaces will not work. + +```Bash +# Import into the k8s namespace +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 View the Image: + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. Install IoTDB + +### 7.1 Install IoTDB + +```Bash +# Enter the directory +cd iotdb-cluster-k8s/helm + +# Install IoTDB +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 View Helm Installation List + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 View Pods + +```Bash +# View IoTDB pods +kubectl get pods -n iotdb-ns -o wide +``` + +After executing the command, if the output shows 6 Pods with confignode and datanode labels (3 each), it indicates a successful installation. Note that not all Pods may be in the Running state initially; inactive datanode Pods may keep restarting but will normalize after activation. + +### 7.4 Troubleshooting + +```Bash +# View k8s creation logs +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# Get detailed information +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# View ConfigNode logs +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. Activate IoTDB + +### 8.1 Option 1: Activate Directly in the Pod (Quickest) + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# Obtain the machine code and proceed with activation +``` + +### 8.2 Option 2: Activate Inside the ConfigNode Container + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# Obtain the machine code and proceed with activation +# Exit the container +``` + +### Option 3: Manual Activation + +1. View ConfigNode details to determine the node: + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# Example output: +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. View PVC and find the corresponding Volume for ConfigNode to determine the path: + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" +# Example output: +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# To view multiple ConfigNodes, use the following: +for i in {0..2}; do echo confignode-$i; kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:" +``` + +3. View the Detailed Information of the Corresponding Volume to Determine the Physical Directory Location: + + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# Example output: +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. Locate the system-info file in the corresponding directory on the corresponding node, use this system-info as the machine code to generate an activation code, and create a new file named license in the same directory, writing the activation code into this file. + +## 9. Verify IoTDB + +### 9.1 Check the Status of Pods within the Namespace + +View the IP, status, and other information of the pods in the iotdb-ns namespace to ensure they are all running normally. + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# Example output: +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 Check the Port Mapping within the Namespace + +```Bash +kubectl get svc -n iotdb-ns + +# Example output: +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 Start the CLI Script on Any Server to Verify the IoTDB Cluster Status + +Use the port of jdbc-balancer and the IP of any k8s node. + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. Scaling + +### 10.1 Add New PV + +Add a new PV; scaling is only possible with available PVs. + + + +**Note: DataNode cannot join the cluster after restart** + +**Reason**：The static storage hostPath mode is configured, and the script modifies the `iotdb-system.properties` file to set `dn_data_dirs` to `/iotdb6/iotdb_data,/iotdb7/iotdb_data`. However, the default storage path `/iotdb/data` is not mounted, leading to data loss upon restart. +**Solution**：Mount the `/iotdb/data` directory as well, and ensure this setting is applied to both ConfigNode and DataNode to maintain data integrity and cluster stability. + +### 10.2 Scale ConfigNode + +Example: Scale from 3 ConfigNodes to 4 ConfigNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of ConfigNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 Scale DataNode + +Example: Scale from 3 DataNodes to 4 DataNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of DataNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 Verify IoTDB Status + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_timecho.md b/src/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_timecho.md new file mode 100644 index 000000000..c59ddcce6 --- /dev/null +++ b/src/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_timecho.md @@ -0,0 +1,454 @@ + + +# Kubernetes + +## 1. Environment Preparation + +### 1.1 Prepare a Kubernetes Cluster + +Ensure that you have an available Kubernetes cluster (minimum recommended version: Kubernetes 1.24) as the foundation for deploying the IoTDB cluster. + +Kubernetes Version Requirement: The recommended version is Kubernetes 1.24 or above. + +IoTDB Version Requirement: The version of TimechoDB must not be lower than v1.3.3.2. + +## 2. Create Namespace + +### 2.1 Create Namespace + +> Note: Before executing the namespace creation operation, verify that the specified namespace name has not been used in the Kubernetes cluster. If the namespace already exists, the creation command will fail, which may lead to errors during the deployment process. + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 View Namespace + +```Bash +kubectl get ns +``` + +## 3. Create PersistentVolume (PV) + +### 3.1 Create PV Configuration File + +PV is used for persistent storage of IoTDB's ConfigNode and DataNode data. You need to create one PV for each node. + +> Note: One ConfigNode and one DataNode count as two nodes, requiring two PVs. + +For example, with 3 ConfigNodes and 3 DataNodes: + +1. Create a `pv.yaml` file and make six copies, renaming them to `pv01.yaml` through `pv06.yaml`. + +```Bash +# Create a directory to store YAML files +# Create pv.yaml file +touch pv.yaml +``` + +2. Modify the `name` and `path` in each file to ensure consistency. + +**pv.yaml Example：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # Storage capacity + accessModes: # Access modes + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # Reclaim policy + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + storageClassName: local-storage + # Add the corresponding configuration based on your storage type + hostPath: # If using a local path + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # If this line is not configured, you need to manually create the directory +``` + +### 3.2 Apply PV Configuration + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 View PV + +```Bash +kubectl get pv +``` + + +### 3.4 Manually Create Directories + +> Note: If the type in the hostPath of the YAML file is not configured, you need to manually create the corresponding directories. + +Create the corresponding directories on all Kubernetes nodes: +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. Install Helm + +For installation steps, please refer to the[Helm Official Website.](https://helm.sh/zh/docs/intro/install/) + +## 5. Configure IoTDB Helm Chart + +### 5.1 Clone IoTDB Kubernetes Deployment Code + +Please contact timechodb staff to obtain the IoTDB Helm Chart. If you encounter proxy issues, disable the proxy settings: + + +If encountering proxy issues, cancel proxy settings: + +> The git clone error is as follows, indicating that the proxy has been configured and needs to be turned off fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 Modify YAML Files + +> Ensure that the version used is supported (>=1.3.3.2): + +**values.yaml Example：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" # Name after installation + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone # Repository and version used + +storage: + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + className: local-storage + +datanode: + name: datanode + nodeCount: 3 # Number of DataNode nodes + enableRestService: true + storageCapacity: 10Gi # Available space for DataNode + resources: + requests: + memory: 2Gi # Initial memory size for DataNode + cpu: 1000m # Initial CPU size for DataNode + limits: + memory: 4Gi # Maximum memory size for DataNode + cpu: 1000m # Maximum CPU size for DataNode + +confignode: + name: confignode + nodeCount: 3 # Number of ConfigNode nodes + storageCapacity: 10Gi # Available space for ConfigNode + resources: + requests: + memory: 512Mi # Initial memory size for ConfigNode + cpu: 1000m # Initial CPU size for ConfigNode + limits: + memory: 1024Mi # Maximum memory size for ConfigNode + cpu: 2000m # Maximum CPU size for ConfigNode + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. Configure Private Repository Information or Pre-Pull Images + +Configure private repository information on k8s as a prerequisite for the next helm install step. + +Option one is to pull the available iotdb images during helm insta, while option two is to import the available iotdb images into containerd in advance. + +### 6.1 [Option 1] Pull Image from Private Repository + +#### 6.1.1 Create a Secret to Allow k8s to Access the IoTDB Helm Private Repository + +Replace xxxxxx with the IoTDB private repository account, password, and email. + + + +```Bash +# Note the single quotes +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# View the secret +kubectl get secret timecho-nexus -n iotdb-ns +# View and output as YAML +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# View and decrypt +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 Load the Secret as a Patch to the Namespace iotdb-ns + +```Bash +# Add a patch to include login information for nexus in this namespace +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# View the information in this namespace +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 [Option 2] Import Image + +This step is for scenarios where the customer cannot connect to the private repository and requires assistance from company implementation staff. + +#### 6.2.1 Pull and Export the Image: + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 View and Export the Image: + +```Bash +# View +ctr images ls + +# Export +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 Import into the k8s Namespace: + +> Note that k8s.io is the namespace for ctr in the example environment; importing to other namespaces will not work. + +```Bash +# Import into the k8s namespace +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 View the Image: + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. Install IoTDB + +### 7.1 Install IoTDB + +```Bash +# Enter the directory +cd iotdb-cluster-k8s/helm + +# Install IoTDB +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 View Helm Installation List + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 View Pods + +```Bash +# View IoTDB pods +kubectl get pods -n iotdb-ns -o wide +``` + +After executing the command, if the output shows 6 Pods with confignode and datanode labels (3 each), it indicates a successful installation. Note that not all Pods may be in the Running state initially; inactive datanode Pods may keep restarting but will normalize after activation. + +### 7.4 Troubleshooting + +```Bash +# View k8s creation logs +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# Get detailed information +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# View ConfigNode logs +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. Activate IoTDB + +### 8.1 Option 1: Activate Directly in the Pod (Quickest) + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# Obtain the machine code and proceed with activation +``` + +### 8.2 Option 2: Activate Inside the ConfigNode Container + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# Obtain the machine code and proceed with activation +# Exit the container +``` + +### Option 3: Manual Activation + +1. View ConfigNode details to determine the node: + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# Example output: +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. View PVC and find the corresponding Volume for ConfigNode to determine the path: + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" +# Example output: +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# To view multiple ConfigNodes, use the following: +for i in {0..2}; do echo confignode-$i; kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:" +``` + +3. View the Detailed Information of the Corresponding Volume to Determine the Physical Directory Location: + + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# Example output: +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. Locate the system-info file in the corresponding directory on the corresponding node, use this system-info as the machine code to generate an activation code, and create a new file named license in the same directory, writing the activation code into this file. + +## 9. Verify IoTDB + +### 9.1 Check the Status of Pods within the Namespace + +View the IP, status, and other information of the pods in the iotdb-ns namespace to ensure they are all running normally. + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# Example output: +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 Check the Port Mapping within the Namespace + +```Bash +kubectl get svc -n iotdb-ns + +# Example output: +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 Start the CLI Script on Any Server to Verify the IoTDB Cluster Status + +Use the port of jdbc-balancer and the IP of any k8s node. + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. Scaling + +### 10.1 Add New PV + +Add a new PV; scaling is only possible with available PVs. + + + +**Note: DataNode cannot join the cluster after restart** + +**Reason**：The static storage hostPath mode is configured, and the script modifies the `iotdb-system.properties` file to set `dn_data_dirs` to `/iotdb6/iotdb_data,/iotdb7/iotdb_data`. However, the default storage path `/iotdb/data` is not mounted, leading to data loss upon restart. +**Solution**：Mount the `/iotdb/data` directory as well, and ensure this setting is applied to both ConfigNode and DataNode to maintain data integrity and cluster stability. + +### 10.2 Scale ConfigNode + +Example: Scale from 3 ConfigNodes to 4 ConfigNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of ConfigNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 Scale DataNode + +Example: Scale from 3 DataNodes to 4 DataNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of DataNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 Verify IoTDB Status + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_apache.md b/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_apache.md new file mode 100644 index 000000000..0fb5b73d9 --- /dev/null +++ b/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_apache.md @@ -0,0 +1,454 @@ + + +# Kubernetes + +## 1. Environment Preparation + +### 1.1 Prepare a Kubernetes Cluster + +Ensure that you have an available Kubernetes cluster (minimum recommended version: Kubernetes 1.24) as the foundation for deploying the IoTDB cluster. + +Kubernetes Version Requirement: The recommended version is Kubernetes 1.24 or above. + +IoTDB Version Requirement: The version of IoTDB must not be lower than v1.3.3. + +## 2. Create Namespace + +### 2.1 Create Namespace + +> Note: Before executing the namespace creation operation, verify that the specified namespace name has not been used in the Kubernetes cluster. If the namespace already exists, the creation command will fail, which may lead to errors during the deployment process. + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 View Namespace + +```Bash +kubectl get ns +``` + +## 3. Create PersistentVolume (PV) + +### 3.1 Create PV Configuration File + +PV is used for persistent storage of IoTDB's ConfigNode and DataNode data. You need to create one PV for each node. + +> Note: One ConfigNode and one DataNode count as two nodes, requiring two PVs. + +For example, with 3 ConfigNodes and 3 DataNodes: + +1. Create a `pv.yaml` file and make six copies, renaming them to `pv01.yaml` through `pv06.yaml`. + +```Bash +# Create a directory to store YAML files +# Create pv.yaml file +touch pv.yaml +``` + +2. Modify the `name` and `path` in each file to ensure consistency. + +**pv.yaml Example：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # Storage capacity + accessModes: # Access modes + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # Reclaim policy + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + storageClassName: local-storage + # Add the corresponding configuration based on your storage type + hostPath: # If using a local path + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # If this line is not configured, you need to manually create the directory +``` + +### 3.2 Apply PV Configuration + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 View PV + +```Bash +kubectl get pv +``` + + +### 3.4 Manually Create Directories + +> Note: If the type in the hostPath of the YAML file is not configured, you need to manually create the corresponding directories. + +Create the corresponding directories on all Kubernetes nodes: +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. Install Helm + +For installation steps, please refer to the[Helm Official Website.](https://helm.sh/zh/docs/intro/install/) + +## 5. Configure IoTDB Helm Chart + +### 5.1 Clone IoTDB Kubernetes Deployment Code + +Please contact timechodb staff to obtain the IoTDB Helm Chart. If you encounter proxy issues, disable the proxy settings: + + +If encountering proxy issues, cancel proxy settings: + +> The git clone error is as follows, indicating that the proxy has been configured and needs to be turned off fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 Modify YAML Files + +> Ensure that the version used is supported (>=1.3.3.2): + +**values.yaml Example：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" # Name after installation + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone # Repository and version used + +storage: + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + className: local-storage + +datanode: + name: datanode + nodeCount: 3 # Number of DataNode nodes + enableRestService: true + storageCapacity: 10Gi # Available space for DataNode + resources: + requests: + memory: 2Gi # Initial memory size for DataNode + cpu: 1000m # Initial CPU size for DataNode + limits: + memory: 4Gi # Maximum memory size for DataNode + cpu: 1000m # Maximum CPU size for DataNode + +confignode: + name: confignode + nodeCount: 3 # Number of ConfigNode nodes + storageCapacity: 10Gi # Available space for ConfigNode + resources: + requests: + memory: 512Mi # Initial memory size for ConfigNode + cpu: 1000m # Initial CPU size for ConfigNode + limits: + memory: 1024Mi # Maximum memory size for ConfigNode + cpu: 2000m # Maximum CPU size for ConfigNode + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. Configure Private Repository Information or Pre-Pull Images + +Configure private repository information on k8s as a prerequisite for the next helm install step. + +Option one is to pull the available iotdb images during helm insta, while option two is to import the available iotdb images into containerd in advance. + +### 6.1 [Option 1] Pull Image from Private Repository + +#### 6.1.1 Create a Secret to Allow k8s to Access the IoTDB Helm Private Repository + +Replace xxxxxx with the IoTDB private repository account, password, and email. + + + +```Bash +# Note the single quotes +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# View the secret +kubectl get secret timecho-nexus -n iotdb-ns +# View and output as YAML +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# View and decrypt +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 Load the Secret as a Patch to the Namespace iotdb-ns + +```Bash +# Add a patch to include login information for nexus in this namespace +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# View the information in this namespace +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 [Option 2] Import Image + +This step is for scenarios where the customer cannot connect to the private repository and requires assistance from company implementation staff. + +#### 6.2.1 Pull and Export the Image: + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 View and Export the Image: + +```Bash +# View +ctr images ls + +# Export +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 Import into the k8s Namespace: + +> Note that k8s.io is the namespace for ctr in the example environment; importing to other namespaces will not work. + +```Bash +# Import into the k8s namespace +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 View the Image: + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. Install IoTDB + +### 7.1 Install IoTDB + +```Bash +# Enter the directory +cd iotdb-cluster-k8s/helm + +# Install IoTDB +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 View Helm Installation List + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 View Pods + +```Bash +# View IoTDB pods +kubectl get pods -n iotdb-ns -o wide +``` + +After executing the command, if the output shows 6 Pods with confignode and datanode labels (3 each), it indicates a successful installation. Note that not all Pods may be in the Running state initially; inactive datanode Pods may keep restarting but will normalize after activation. + +### 7.4 Troubleshooting + +```Bash +# View k8s creation logs +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# Get detailed information +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# View ConfigNode logs +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. Activate IoTDB + +### 8.1 Option 1: Activate Directly in the Pod (Quickest) + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# Obtain the machine code and proceed with activation +``` + +### 8.2 Option 2: Activate Inside the ConfigNode Container + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# Obtain the machine code and proceed with activation +# Exit the container +``` + +### Option 3: Manual Activation + +1. View ConfigNode details to determine the node: + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# Example output: +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. View PVC and find the corresponding Volume for ConfigNode to determine the path: + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" +# Example output: +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# To view multiple ConfigNodes, use the following: +for i in {0..2}; do echo confignode-$i; kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:" +``` + +3. View the Detailed Information of the Corresponding Volume to Determine the Physical Directory Location: + + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# Example output: +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. Locate the system-info file in the corresponding directory on the corresponding node, use this system-info as the machine code to generate an activation code, and create a new file named license in the same directory, writing the activation code into this file. + +## 9. Verify IoTDB + +### 9.1 Check the Status of Pods within the Namespace + +View the IP, status, and other information of the pods in the iotdb-ns namespace to ensure they are all running normally. + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# Example output: +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 Check the Port Mapping within the Namespace + +```Bash +kubectl get svc -n iotdb-ns + +# Example output: +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 Start the CLI Script on Any Server to Verify the IoTDB Cluster Status + +Use the port of jdbc-balancer and the IP of any k8s node. + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. Scaling + +### 10.1 Add New PV + +Add a new PV; scaling is only possible with available PVs. + + + +**Note: DataNode cannot join the cluster after restart** + +**Reason**：The static storage hostPath mode is configured, and the script modifies the `iotdb-system.properties` file to set `dn_data_dirs` to `/iotdb6/iotdb_data,/iotdb7/iotdb_data`. However, the default storage path `/iotdb/data` is not mounted, leading to data loss upon restart. +**Solution**：Mount the `/iotdb/data` directory as well, and ensure this setting is applied to both ConfigNode and DataNode to maintain data integrity and cluster stability. + +### 10.2 Scale ConfigNode + +Example: Scale from 3 ConfigNodes to 4 ConfigNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of ConfigNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 Scale DataNode + +Example: Scale from 3 DataNodes to 4 DataNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of DataNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 Verify IoTDB Status + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_timecho.md b/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_timecho.md new file mode 100644 index 000000000..c59ddcce6 --- /dev/null +++ b/src/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_timecho.md @@ -0,0 +1,454 @@ + + +# Kubernetes + +## 1. Environment Preparation + +### 1.1 Prepare a Kubernetes Cluster + +Ensure that you have an available Kubernetes cluster (minimum recommended version: Kubernetes 1.24) as the foundation for deploying the IoTDB cluster. + +Kubernetes Version Requirement: The recommended version is Kubernetes 1.24 or above. + +IoTDB Version Requirement: The version of TimechoDB must not be lower than v1.3.3.2. + +## 2. Create Namespace + +### 2.1 Create Namespace + +> Note: Before executing the namespace creation operation, verify that the specified namespace name has not been used in the Kubernetes cluster. If the namespace already exists, the creation command will fail, which may lead to errors during the deployment process. + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 View Namespace + +```Bash +kubectl get ns +``` + +## 3. Create PersistentVolume (PV) + +### 3.1 Create PV Configuration File + +PV is used for persistent storage of IoTDB's ConfigNode and DataNode data. You need to create one PV for each node. + +> Note: One ConfigNode and one DataNode count as two nodes, requiring two PVs. + +For example, with 3 ConfigNodes and 3 DataNodes: + +1. Create a `pv.yaml` file and make six copies, renaming them to `pv01.yaml` through `pv06.yaml`. + +```Bash +# Create a directory to store YAML files +# Create pv.yaml file +touch pv.yaml +``` + +2. Modify the `name` and `path` in each file to ensure consistency. + +**pv.yaml Example：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # Storage capacity + accessModes: # Access modes + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # Reclaim policy + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + storageClassName: local-storage + # Add the corresponding configuration based on your storage type + hostPath: # If using a local path + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # If this line is not configured, you need to manually create the directory +``` + +### 3.2 Apply PV Configuration + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 View PV + +```Bash +kubectl get pv +``` + + +### 3.4 Manually Create Directories + +> Note: If the type in the hostPath of the YAML file is not configured, you need to manually create the corresponding directories. + +Create the corresponding directories on all Kubernetes nodes: +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. Install Helm + +For installation steps, please refer to the[Helm Official Website.](https://helm.sh/zh/docs/intro/install/) + +## 5. Configure IoTDB Helm Chart + +### 5.1 Clone IoTDB Kubernetes Deployment Code + +Please contact timechodb staff to obtain the IoTDB Helm Chart. If you encounter proxy issues, disable the proxy settings: + + +If encountering proxy issues, cancel proxy settings: + +> The git clone error is as follows, indicating that the proxy has been configured and needs to be turned off fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 Modify YAML Files + +> Ensure that the version used is supported (>=1.3.3.2): + +**values.yaml Example：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" # Name after installation + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone # Repository and version used + +storage: + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + className: local-storage + +datanode: + name: datanode + nodeCount: 3 # Number of DataNode nodes + enableRestService: true + storageCapacity: 10Gi # Available space for DataNode + resources: + requests: + memory: 2Gi # Initial memory size for DataNode + cpu: 1000m # Initial CPU size for DataNode + limits: + memory: 4Gi # Maximum memory size for DataNode + cpu: 1000m # Maximum CPU size for DataNode + +confignode: + name: confignode + nodeCount: 3 # Number of ConfigNode nodes + storageCapacity: 10Gi # Available space for ConfigNode + resources: + requests: + memory: 512Mi # Initial memory size for ConfigNode + cpu: 1000m # Initial CPU size for ConfigNode + limits: + memory: 1024Mi # Maximum memory size for ConfigNode + cpu: 2000m # Maximum CPU size for ConfigNode + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. Configure Private Repository Information or Pre-Pull Images + +Configure private repository information on k8s as a prerequisite for the next helm install step. + +Option one is to pull the available iotdb images during helm insta, while option two is to import the available iotdb images into containerd in advance. + +### 6.1 [Option 1] Pull Image from Private Repository + +#### 6.1.1 Create a Secret to Allow k8s to Access the IoTDB Helm Private Repository + +Replace xxxxxx with the IoTDB private repository account, password, and email. + + + +```Bash +# Note the single quotes +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# View the secret +kubectl get secret timecho-nexus -n iotdb-ns +# View and output as YAML +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# View and decrypt +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 Load the Secret as a Patch to the Namespace iotdb-ns + +```Bash +# Add a patch to include login information for nexus in this namespace +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# View the information in this namespace +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 [Option 2] Import Image + +This step is for scenarios where the customer cannot connect to the private repository and requires assistance from company implementation staff. + +#### 6.2.1 Pull and Export the Image: + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 View and Export the Image: + +```Bash +# View +ctr images ls + +# Export +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 Import into the k8s Namespace: + +> Note that k8s.io is the namespace for ctr in the example environment; importing to other namespaces will not work. + +```Bash +# Import into the k8s namespace +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 View the Image: + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. Install IoTDB + +### 7.1 Install IoTDB + +```Bash +# Enter the directory +cd iotdb-cluster-k8s/helm + +# Install IoTDB +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 View Helm Installation List + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 View Pods + +```Bash +# View IoTDB pods +kubectl get pods -n iotdb-ns -o wide +``` + +After executing the command, if the output shows 6 Pods with confignode and datanode labels (3 each), it indicates a successful installation. Note that not all Pods may be in the Running state initially; inactive datanode Pods may keep restarting but will normalize after activation. + +### 7.4 Troubleshooting + +```Bash +# View k8s creation logs +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# Get detailed information +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# View ConfigNode logs +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. Activate IoTDB + +### 8.1 Option 1: Activate Directly in the Pod (Quickest) + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# Obtain the machine code and proceed with activation +``` + +### 8.2 Option 2: Activate Inside the ConfigNode Container + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# Obtain the machine code and proceed with activation +# Exit the container +``` + +### Option 3: Manual Activation + +1. View ConfigNode details to determine the node: + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# Example output: +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. View PVC and find the corresponding Volume for ConfigNode to determine the path: + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" +# Example output: +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# To view multiple ConfigNodes, use the following: +for i in {0..2}; do echo confignode-$i; kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:" +``` + +3. View the Detailed Information of the Corresponding Volume to Determine the Physical Directory Location: + + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# Example output: +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. Locate the system-info file in the corresponding directory on the corresponding node, use this system-info as the machine code to generate an activation code, and create a new file named license in the same directory, writing the activation code into this file. + +## 9. Verify IoTDB + +### 9.1 Check the Status of Pods within the Namespace + +View the IP, status, and other information of the pods in the iotdb-ns namespace to ensure they are all running normally. + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# Example output: +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 Check the Port Mapping within the Namespace + +```Bash +kubectl get svc -n iotdb-ns + +# Example output: +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 Start the CLI Script on Any Server to Verify the IoTDB Cluster Status + +Use the port of jdbc-balancer and the IP of any k8s node. + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. Scaling + +### 10.1 Add New PV + +Add a new PV; scaling is only possible with available PVs. + + + +**Note: DataNode cannot join the cluster after restart** + +**Reason**：The static storage hostPath mode is configured, and the script modifies the `iotdb-system.properties` file to set `dn_data_dirs` to `/iotdb6/iotdb_data,/iotdb7/iotdb_data`. However, the default storage path `/iotdb/data` is not mounted, leading to data loss upon restart. +**Solution**：Mount the `/iotdb/data` directory as well, and ensure this setting is applied to both ConfigNode and DataNode to maintain data integrity and cluster stability. + +### 10.2 Scale ConfigNode + +Example: Scale from 3 ConfigNodes to 4 ConfigNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of ConfigNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 Scale DataNode + +Example: Scale from 3 DataNodes to 4 DataNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of DataNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 Verify IoTDB Status + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/UserGuide/latest/Ecosystem-Integration/Kubernetes_apache.md b/src/UserGuide/latest/Ecosystem-Integration/Kubernetes_apache.md new file mode 100644 index 000000000..0fb5b73d9 --- /dev/null +++ b/src/UserGuide/latest/Ecosystem-Integration/Kubernetes_apache.md @@ -0,0 +1,454 @@ + + +# Kubernetes + +## 1. Environment Preparation + +### 1.1 Prepare a Kubernetes Cluster + +Ensure that you have an available Kubernetes cluster (minimum recommended version: Kubernetes 1.24) as the foundation for deploying the IoTDB cluster. + +Kubernetes Version Requirement: The recommended version is Kubernetes 1.24 or above. + +IoTDB Version Requirement: The version of IoTDB must not be lower than v1.3.3. + +## 2. Create Namespace + +### 2.1 Create Namespace + +> Note: Before executing the namespace creation operation, verify that the specified namespace name has not been used in the Kubernetes cluster. If the namespace already exists, the creation command will fail, which may lead to errors during the deployment process. + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 View Namespace + +```Bash +kubectl get ns +``` + +## 3. Create PersistentVolume (PV) + +### 3.1 Create PV Configuration File + +PV is used for persistent storage of IoTDB's ConfigNode and DataNode data. You need to create one PV for each node. + +> Note: One ConfigNode and one DataNode count as two nodes, requiring two PVs. + +For example, with 3 ConfigNodes and 3 DataNodes: + +1. Create a `pv.yaml` file and make six copies, renaming them to `pv01.yaml` through `pv06.yaml`. + +```Bash +# Create a directory to store YAML files +# Create pv.yaml file +touch pv.yaml +``` + +2. Modify the `name` and `path` in each file to ensure consistency. + +**pv.yaml Example：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # Storage capacity + accessModes: # Access modes + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # Reclaim policy + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + storageClassName: local-storage + # Add the corresponding configuration based on your storage type + hostPath: # If using a local path + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # If this line is not configured, you need to manually create the directory +``` + +### 3.2 Apply PV Configuration + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 View PV + +```Bash +kubectl get pv +``` + + +### 3.4 Manually Create Directories + +> Note: If the type in the hostPath of the YAML file is not configured, you need to manually create the corresponding directories. + +Create the corresponding directories on all Kubernetes nodes: +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. Install Helm + +For installation steps, please refer to the[Helm Official Website.](https://helm.sh/zh/docs/intro/install/) + +## 5. Configure IoTDB Helm Chart + +### 5.1 Clone IoTDB Kubernetes Deployment Code + +Please contact timechodb staff to obtain the IoTDB Helm Chart. If you encounter proxy issues, disable the proxy settings: + + +If encountering proxy issues, cancel proxy settings: + +> The git clone error is as follows, indicating that the proxy has been configured and needs to be turned off fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 Modify YAML Files + +> Ensure that the version used is supported (>=1.3.3.2): + +**values.yaml Example：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" # Name after installation + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone # Repository and version used + +storage: + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + className: local-storage + +datanode: + name: datanode + nodeCount: 3 # Number of DataNode nodes + enableRestService: true + storageCapacity: 10Gi # Available space for DataNode + resources: + requests: + memory: 2Gi # Initial memory size for DataNode + cpu: 1000m # Initial CPU size for DataNode + limits: + memory: 4Gi # Maximum memory size for DataNode + cpu: 1000m # Maximum CPU size for DataNode + +confignode: + name: confignode + nodeCount: 3 # Number of ConfigNode nodes + storageCapacity: 10Gi # Available space for ConfigNode + resources: + requests: + memory: 512Mi # Initial memory size for ConfigNode + cpu: 1000m # Initial CPU size for ConfigNode + limits: + memory: 1024Mi # Maximum memory size for ConfigNode + cpu: 2000m # Maximum CPU size for ConfigNode + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. Configure Private Repository Information or Pre-Pull Images + +Configure private repository information on k8s as a prerequisite for the next helm install step. + +Option one is to pull the available iotdb images during helm insta, while option two is to import the available iotdb images into containerd in advance. + +### 6.1 [Option 1] Pull Image from Private Repository + +#### 6.1.1 Create a Secret to Allow k8s to Access the IoTDB Helm Private Repository + +Replace xxxxxx with the IoTDB private repository account, password, and email. + + + +```Bash +# Note the single quotes +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# View the secret +kubectl get secret timecho-nexus -n iotdb-ns +# View and output as YAML +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# View and decrypt +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 Load the Secret as a Patch to the Namespace iotdb-ns + +```Bash +# Add a patch to include login information for nexus in this namespace +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# View the information in this namespace +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 [Option 2] Import Image + +This step is for scenarios where the customer cannot connect to the private repository and requires assistance from company implementation staff. + +#### 6.2.1 Pull and Export the Image: + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 View and Export the Image: + +```Bash +# View +ctr images ls + +# Export +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 Import into the k8s Namespace: + +> Note that k8s.io is the namespace for ctr in the example environment; importing to other namespaces will not work. + +```Bash +# Import into the k8s namespace +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 View the Image: + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. Install IoTDB + +### 7.1 Install IoTDB + +```Bash +# Enter the directory +cd iotdb-cluster-k8s/helm + +# Install IoTDB +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 View Helm Installation List + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 View Pods + +```Bash +# View IoTDB pods +kubectl get pods -n iotdb-ns -o wide +``` + +After executing the command, if the output shows 6 Pods with confignode and datanode labels (3 each), it indicates a successful installation. Note that not all Pods may be in the Running state initially; inactive datanode Pods may keep restarting but will normalize after activation. + +### 7.4 Troubleshooting + +```Bash +# View k8s creation logs +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# Get detailed information +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# View ConfigNode logs +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. Activate IoTDB + +### 8.1 Option 1: Activate Directly in the Pod (Quickest) + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# Obtain the machine code and proceed with activation +``` + +### 8.2 Option 2: Activate Inside the ConfigNode Container + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# Obtain the machine code and proceed with activation +# Exit the container +``` + +### Option 3: Manual Activation + +1. View ConfigNode details to determine the node: + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# Example output: +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. View PVC and find the corresponding Volume for ConfigNode to determine the path: + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" +# Example output: +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# To view multiple ConfigNodes, use the following: +for i in {0..2}; do echo confignode-$i; kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:" +``` + +3. View the Detailed Information of the Corresponding Volume to Determine the Physical Directory Location: + + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# Example output: +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. Locate the system-info file in the corresponding directory on the corresponding node, use this system-info as the machine code to generate an activation code, and create a new file named license in the same directory, writing the activation code into this file. + +## 9. Verify IoTDB + +### 9.1 Check the Status of Pods within the Namespace + +View the IP, status, and other information of the pods in the iotdb-ns namespace to ensure they are all running normally. + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# Example output: +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 Check the Port Mapping within the Namespace + +```Bash +kubectl get svc -n iotdb-ns + +# Example output: +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 Start the CLI Script on Any Server to Verify the IoTDB Cluster Status + +Use the port of jdbc-balancer and the IP of any k8s node. + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. Scaling + +### 10.1 Add New PV + +Add a new PV; scaling is only possible with available PVs. + + + +**Note: DataNode cannot join the cluster after restart** + +**Reason**：The static storage hostPath mode is configured, and the script modifies the `iotdb-system.properties` file to set `dn_data_dirs` to `/iotdb6/iotdb_data,/iotdb7/iotdb_data`. However, the default storage path `/iotdb/data` is not mounted, leading to data loss upon restart. +**Solution**：Mount the `/iotdb/data` directory as well, and ensure this setting is applied to both ConfigNode and DataNode to maintain data integrity and cluster stability. + +### 10.2 Scale ConfigNode + +Example: Scale from 3 ConfigNodes to 4 ConfigNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of ConfigNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 Scale DataNode + +Example: Scale from 3 DataNodes to 4 DataNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of DataNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 Verify IoTDB Status + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/UserGuide/latest/Ecosystem-Integration/Kubernetes_timecho.md b/src/UserGuide/latest/Ecosystem-Integration/Kubernetes_timecho.md new file mode 100644 index 000000000..c59ddcce6 --- /dev/null +++ b/src/UserGuide/latest/Ecosystem-Integration/Kubernetes_timecho.md @@ -0,0 +1,454 @@ + + +# Kubernetes + +## 1. Environment Preparation + +### 1.1 Prepare a Kubernetes Cluster + +Ensure that you have an available Kubernetes cluster (minimum recommended version: Kubernetes 1.24) as the foundation for deploying the IoTDB cluster. + +Kubernetes Version Requirement: The recommended version is Kubernetes 1.24 or above. + +IoTDB Version Requirement: The version of TimechoDB must not be lower than v1.3.3.2. + +## 2. Create Namespace + +### 2.1 Create Namespace + +> Note: Before executing the namespace creation operation, verify that the specified namespace name has not been used in the Kubernetes cluster. If the namespace already exists, the creation command will fail, which may lead to errors during the deployment process. + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 View Namespace + +```Bash +kubectl get ns +``` + +## 3. Create PersistentVolume (PV) + +### 3.1 Create PV Configuration File + +PV is used for persistent storage of IoTDB's ConfigNode and DataNode data. You need to create one PV for each node. + +> Note: One ConfigNode and one DataNode count as two nodes, requiring two PVs. + +For example, with 3 ConfigNodes and 3 DataNodes: + +1. Create a `pv.yaml` file and make six copies, renaming them to `pv01.yaml` through `pv06.yaml`. + +```Bash +# Create a directory to store YAML files +# Create pv.yaml file +touch pv.yaml +``` + +2. Modify the `name` and `path` in each file to ensure consistency. + +**pv.yaml Example：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # Storage capacity + accessModes: # Access modes + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # Reclaim policy + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + storageClassName: local-storage + # Add the corresponding configuration based on your storage type + hostPath: # If using a local path + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # If this line is not configured, you need to manually create the directory +``` + +### 3.2 Apply PV Configuration + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 View PV + +```Bash +kubectl get pv +``` + + +### 3.4 Manually Create Directories + +> Note: If the type in the hostPath of the YAML file is not configured, you need to manually create the corresponding directories. + +Create the corresponding directories on all Kubernetes nodes: +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. Install Helm + +For installation steps, please refer to the[Helm Official Website.](https://helm.sh/zh/docs/intro/install/) + +## 5. Configure IoTDB Helm Chart + +### 5.1 Clone IoTDB Kubernetes Deployment Code + +Please contact timechodb staff to obtain the IoTDB Helm Chart. If you encounter proxy issues, disable the proxy settings: + + +If encountering proxy issues, cancel proxy settings: + +> The git clone error is as follows, indicating that the proxy has been configured and needs to be turned off fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 Modify YAML Files + +> Ensure that the version used is supported (>=1.3.3.2): + +**values.yaml Example：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" # Name after installation + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone # Repository and version used + +storage: + # Storage class name, if using local static storage, do not configure; if using dynamic storage, this must be set + className: local-storage + +datanode: + name: datanode + nodeCount: 3 # Number of DataNode nodes + enableRestService: true + storageCapacity: 10Gi # Available space for DataNode + resources: + requests: + memory: 2Gi # Initial memory size for DataNode + cpu: 1000m # Initial CPU size for DataNode + limits: + memory: 4Gi # Maximum memory size for DataNode + cpu: 1000m # Maximum CPU size for DataNode + +confignode: + name: confignode + nodeCount: 3 # Number of ConfigNode nodes + storageCapacity: 10Gi # Available space for ConfigNode + resources: + requests: + memory: 512Mi # Initial memory size for ConfigNode + cpu: 1000m # Initial CPU size for ConfigNode + limits: + memory: 1024Mi # Maximum memory size for ConfigNode + cpu: 2000m # Maximum CPU size for ConfigNode + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. Configure Private Repository Information or Pre-Pull Images + +Configure private repository information on k8s as a prerequisite for the next helm install step. + +Option one is to pull the available iotdb images during helm insta, while option two is to import the available iotdb images into containerd in advance. + +### 6.1 [Option 1] Pull Image from Private Repository + +#### 6.1.1 Create a Secret to Allow k8s to Access the IoTDB Helm Private Repository + +Replace xxxxxx with the IoTDB private repository account, password, and email. + + + +```Bash +# Note the single quotes +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# View the secret +kubectl get secret timecho-nexus -n iotdb-ns +# View and output as YAML +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# View and decrypt +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 Load the Secret as a Patch to the Namespace iotdb-ns + +```Bash +# Add a patch to include login information for nexus in this namespace +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# View the information in this namespace +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 [Option 2] Import Image + +This step is for scenarios where the customer cannot connect to the private repository and requires assistance from company implementation staff. + +#### 6.2.1 Pull and Export the Image: + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 View and Export the Image: + +```Bash +# View +ctr images ls + +# Export +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 Import into the k8s Namespace: + +> Note that k8s.io is the namespace for ctr in the example environment; importing to other namespaces will not work. + +```Bash +# Import into the k8s namespace +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 View the Image: + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. Install IoTDB + +### 7.1 Install IoTDB + +```Bash +# Enter the directory +cd iotdb-cluster-k8s/helm + +# Install IoTDB +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 View Helm Installation List + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 View Pods + +```Bash +# View IoTDB pods +kubectl get pods -n iotdb-ns -o wide +``` + +After executing the command, if the output shows 6 Pods with confignode and datanode labels (3 each), it indicates a successful installation. Note that not all Pods may be in the Running state initially; inactive datanode Pods may keep restarting but will normalize after activation. + +### 7.4 Troubleshooting + +```Bash +# View k8s creation logs +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# Get detailed information +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# View ConfigNode logs +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. Activate IoTDB + +### 8.1 Option 1: Activate Directly in the Pod (Quickest) + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# Obtain the machine code and proceed with activation +``` + +### 8.2 Option 2: Activate Inside the ConfigNode Container + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# Obtain the machine code and proceed with activation +# Exit the container +``` + +### Option 3: Manual Activation + +1. View ConfigNode details to determine the node: + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# Example output: +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. View PVC and find the corresponding Volume for ConfigNode to determine the path: + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" +# Example output: +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# To view multiple ConfigNodes, use the following: +for i in {0..2}; do echo confignode-$i; kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:" +``` + +3. View the Detailed Information of the Corresponding Volume to Determine the Physical Directory Location: + + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# Example output: +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. Locate the system-info file in the corresponding directory on the corresponding node, use this system-info as the machine code to generate an activation code, and create a new file named license in the same directory, writing the activation code into this file. + +## 9. Verify IoTDB + +### 9.1 Check the Status of Pods within the Namespace + +View the IP, status, and other information of the pods in the iotdb-ns namespace to ensure they are all running normally. + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# Example output: +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 Check the Port Mapping within the Namespace + +```Bash +kubectl get svc -n iotdb-ns + +# Example output: +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 Start the CLI Script on Any Server to Verify the IoTDB Cluster Status + +Use the port of jdbc-balancer and the IP of any k8s node. + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. Scaling + +### 10.1 Add New PV + +Add a new PV; scaling is only possible with available PVs. + + + +**Note: DataNode cannot join the cluster after restart** + +**Reason**：The static storage hostPath mode is configured, and the script modifies the `iotdb-system.properties` file to set `dn_data_dirs` to `/iotdb6/iotdb_data,/iotdb7/iotdb_data`. However, the default storage path `/iotdb/data` is not mounted, leading to data loss upon restart. +**Solution**：Mount the `/iotdb/data` directory as well, and ensure this setting is applied to both ConfigNode and DataNode to maintain data integrity and cluster stability. + +### 10.2 Scale ConfigNode + +Example: Scale from 3 ConfigNodes to 4 ConfigNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of ConfigNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 Scale DataNode + +Example: Scale from 3 DataNodes to 4 DataNodes + +Modify the values.yaml file in iotdb-cluster-k8s/helm to change the number of DataNodes from 3 to 4. + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 Verify IoTDB Status + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_apache.md b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_apache.md new file mode 100644 index 000000000..566007d21 --- /dev/null +++ b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_apache.md @@ -0,0 +1,453 @@ + + +# Kubernetes + +## 1. 环境准备 + +### 1.1 准备 Kubernetes 集群 + +确保拥有一个可用的 Kubernetes 集群（建议最低版本：Kubernetes 1.24），作为部署 IoTDB 集群的基础。 + +Kubernetes 版本要求：建议版本为 Kubernetes 1.24及以上 + +IoTDB版本要求：不能低于v1.3.3.2 + +## 2. 创建命名空间 + +### 2.1 创建命名空间 + +> 注意：在执行命名空间创建操作之前，需验证所指定的命名空间名称在 Kubernetes 集群中尚未被使用。如果命名空间已存在，创建命令将无法执行，可能导致部署过程中的错误。 + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 查看命名空间 + +```Bash +kubectl get ns +``` + +## 3. 创建 PersistentVolume (PV) + +### 3.1 创建 PV 配置文件 + +PV用于持久化存储IoTDB的ConfigNode 和 DataNode的数据，有几个节点就要创建几个PV。 + +> 注：1个ConfigNode和1个DataNode 算2个节点，需要2个PV。 + +以 3ConfigNode、3DataNode 为例： + +1. 创建 `pv.yaml` 文件，并复制六份，分别重命名为 `pv01.yaml` ～ `pv06.yaml`。 + +```Bash +#可新建个文件夹放yaml文件 +#创建 pv.yaml 文件语句 +touch pv.yaml +``` + +2. 修改每个文件中的 `name` 和 `path` 以确保一致性。 + +**pv.yaml 示例：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # 存储容量 + accessModes: # 访问模式 + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # 回收策略 + # 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + storageClassName: local-storage + # 根据你的存储类型添加相应的配置 + hostPath: # 如果是使用本地路径 + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # 这行不配置就要手动创建文件夹 +``` + +### 3.2 应用 PV 配置 + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 查看 PV + +```Bash +kubectl get pv +``` + + +### 3.4 手动创建文件夹 + +> 如果yaml里的hostPath-type未配置，需要手动创建对应的文件夹 + +在所有 Kubernetes 节点上创建对应的文件夹： + +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. 安装 Helm + +安装Helm步骤请参考[Helm官网](https://helm.sh/zh/docs/intro/install/) + +## 5. 配置IoTDB的Helm Chart + +### 5.1 克隆 IoTDB Kubernetes 部署代码 + +请联系天谋工作人员获取IoTDB的Helm Chart + +如果遇到代理问题，取消代理设置： + +> git clone报错如下，说明是配置了代理，需要把代理关掉 fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 修改 YAML 文件 + +> 确保使用的是支持的版本 >=1.3.3.2 + +**values.yaml 示例：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" #软件安装后的名称 + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone #软件所用的仓库和版本 + +storage: +# 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + className: local-storage + +datanode: + name: datanode + nodeCount: 3 #datanode的节点数量 + enableRestService: true + storageCapacity: 10Gi #datanode的可用空间大小 + resources: + requests: + memory: 2Gi #datanode的内存初始化大小 + cpu: 1000m #datanode的CPU初始化大小 + limits: + memory: 4Gi #datanode的最大内存大小 + cpu: 1000m #datanode的最大CPU大小 + +confignode: + name: confignode + nodeCount: 3 #confignode的节点数量 + storageCapacity: 10Gi #confignode的可用空间大小 + resources: + requests: + memory: 512Mi #confignode的内存初始化大小 + cpu: 1000m #confignode的CPU初始化大小 + limits: + memory: 1024Mi #confignode的最大内存大小 + cpu: 2000m #confignode的最大CPU大小 + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. 配置私库信息或预先使用ctr拉取镜像 + +在k8s上配置私有仓库的信息，为下一步helm install的前置步骤。 + +方案一即在helm insta时拉取可用的iotdb镜像，方案二则是提前将可用的iotdb镜像导入到containerd里。 + +### 6.1 【方案一】从私有仓库拉取镜像 + +#### 6.1.1 创建secret 使k8s可访问iotdb-helm的私有仓库 + +下文中“xxxxxx”表示IoTDB私有仓库的账号、密码、邮箱。 + +```Bash +# 注意 单引号 +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# 查看secret +kubectl get secret timecho-nexus -n iotdb-ns +# 查看并输出为yaml +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# 查看并解密 +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 将secret作为一个patch加载到命名空间iotdb-ns + +```Bash +# 添加一个patch，使该命名空间增加登陆nexus的登陆信息 +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# 查看命名空间的该条信息 +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 【方案二】导入镜像 + +该步骤用于客户无法连接私库的场景，需要联系公司实施同事辅助准备。 + +#### 6.2.1 拉取并导出镜像： + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 查看并导出镜像： + +```Bash +# 查看 +ctr images ls + +# 导出 +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 导入到k8s的namespace下： + +> 注意，k8s.io为示例环境中k8s的ctr的命名空间，导入到其他命名空间是不行的 + +```Bash +# 导入到k8s的namespace下 +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 查看镜像 + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. 安装 IoTDB + +### 7.1 安装 IoTDB + +```Bash +# 进入文件夹 +cd iotdb-cluster-k8s/helm + +# 安装iotdb +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 查看 Helm 安装列表 + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 查看 Pods + +```Bash +# 查看 iotdb的pods +kubectl get pods -n iotdb-ns -o wide +``` + +执行命令后，输出了带有confignode和datanode标识的各3个Pods，，总共6个Pods，即表明安装成功；需要注意的是，并非所有Pods都处于Running状态，未激活的datanode可能会持续重启，但在激活后将恢复正常。 + +### 7.4 发现故障的排除方式 + +```Bash +# 查看k8s的创建log +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# 获取详细信息 +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# 查看confignode日志 +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. 激活 IoTDB + +### 8.1 方案1：直接在 Pod 中激活（最快捷） + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# 拿到机器码后进行激活 +``` + +### 8.2 方案2：进入confignode的容器中激活 + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# 拿到机器码后进行激活 +# 退出容器 +``` + +### 8.3 方案3：手动激活 + +1. 查看 ConfigNode 详细信息，确定所在节点： + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# 结果示例： +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. 查看 PVC 并找到 ConfigNode 对应的 Volume，确定所在路径： + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" + +# 结果示例： +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# 如果要查看多个confignode，使用如下： +for i in {0..2}; do echo confignode-$i;kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:"; echo "----"; done +``` + +3. 查看对应 Volume 的详细信息，确定物理目录的位置： + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# 结果示例： +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. 从对应节点的对应目录下找到 system-info 文件，使用该 system-info 作为机器码生成激活码，并在同级目录新建文件 license，将激活码写入到该文件。 + +## 9. 验证 IoTDB + +### 9.1 查看命名空间内的 Pods 状态 + +查看iotdb-ns命名空间内的IP、状态等信息，确定全部运行正常 + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# 结果示例： +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 查看命名空间内的端口映射情况 + +```Bash +kubectl get svc -n iotdb-ns + +# 结果示例： +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 在任意服务器启动 CLI 脚本验证 IoTDB 集群状态 + +端口即jdbc-balancer的端口，服务器为k8s任意节点的IP + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. 扩容 + +### 10.1 新增pv + +新增pv，必须有可用的pv才可以扩容。 + + + +**注意：DataNode重启后无法加入集群** + +**原因**：配置了静态存储的 hostPath 模式，并通过脚本修改了 `iotdb-system.properties` 文件，将 `dn_data_dirs` 设为 `/iotdb6/iotdb_data,/iotdb7/iotdb_data`，但未将默认存储路径 `/iotdb/data` 进行外挂，导致重启时数据丢失。 + +**解决方案**：是将 `/iotdb/data` 目录也进行外挂操作，且 ConfigNode 和 DataNode 均需如此设置，以确保数据完整性和集群稳定性。 + +### 10.2 扩容confignode + +示例：3 confignode 扩容为 4 confignode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将confignode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 扩容datanode + +示例：3 datanode 扩容为 4 datanode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将datanode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 验证IoTDB状态 + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_timecho.md b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_timecho.md new file mode 100644 index 000000000..74947c84c --- /dev/null +++ b/src/zh/UserGuide/Master/Tree/Ecosystem-Integration/Kubernetes_timecho.md @@ -0,0 +1,453 @@ + + +# Kubernetes + +## 1. 环境准备 + +### 1.1 准备 Kubernetes 集群 + +确保拥有一个可用的 Kubernetes 集群（建议最低版本：Kubernetes 1.24），作为部署 IoTDB 集群的基础。 + +Kubernetes 版本要求：建议版本为 Kubernetes 1.24及以上 + +IoTDB版本要求：不能低于v1.3.3 + +## 2. 创建命名空间 + +### 2.1 创建命名空间 + +> 注意：在执行命名空间创建操作之前，需验证所指定的命名空间名称在 Kubernetes 集群中尚未被使用。如果命名空间已存在，创建命令将无法执行，可能导致部署过程中的错误。 + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 查看命名空间 + +```Bash +kubectl get ns +``` + +## 3. 创建 PersistentVolume (PV) + +### 3.1 创建 PV 配置文件 + +PV用于持久化存储IoTDB的ConfigNode 和 DataNode的数据，有几个节点就要创建几个PV。 + +> 注：1个ConfigNode和1个DataNode 算2个节点，需要2个PV。 + +以 3ConfigNode、3DataNode 为例： + +1. 创建 `pv.yaml` 文件，并复制六份，分别重命名为 `pv01.yaml` ～ `pv06.yaml`。 + +```Bash +#可新建个文件夹放yaml文件 +#创建 pv.yaml 文件语句 +touch pv.yaml +``` + +2. 修改每个文件中的 `name` 和 `path` 以确保一致性。 + +**pv.yaml 示例：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # 存储容量 + accessModes: # 访问模式 + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # 回收策略 + # 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + storageClassName: local-storage + # 根据你的存储类型添加相应的配置 + hostPath: # 如果是使用本地路径 + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # 这行不配置就要手动创建文件夹 +``` + +### 3.2 应用 PV 配置 + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 查看 PV + +```Bash +kubectl get pv +``` + + +### 3.4 手动创建文件夹 + +> 如果yaml里的hostPath-type未配置，需要手动创建对应的文件夹 + +在所有 Kubernetes 节点上创建对应的文件夹： + +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. 安装 Helm + +安装Helm步骤请参考[Helm官网](https://helm.sh/zh/docs/intro/install/) + +## 5. 配置IoTDB的Helm Chart + +### 5.1 克隆 IoTDB Kubernetes 部署代码 + +请联系天谋工作人员获取IoTDB的Helm Chart + +如果遇到代理问题，取消代理设置： + +> git clone报错如下，说明是配置了代理，需要把代理关掉 fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 修改 YAML 文件 + +> 确保使用的是支持的版本 >=1.3.3.2 + +**values.yaml 示例：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" #软件安装后的名称 + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone #软件所用的仓库和版本 + +storage: +# 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + className: local-storage + +datanode: + name: datanode + nodeCount: 3 #datanode的节点数量 + enableRestService: true + storageCapacity: 10Gi #datanode的可用空间大小 + resources: + requests: + memory: 2Gi #datanode的内存初始化大小 + cpu: 1000m #datanode的CPU初始化大小 + limits: + memory: 4Gi #datanode的最大内存大小 + cpu: 1000m #datanode的最大CPU大小 + +confignode: + name: confignode + nodeCount: 3 #confignode的节点数量 + storageCapacity: 10Gi #confignode的可用空间大小 + resources: + requests: + memory: 512Mi #confignode的内存初始化大小 + cpu: 1000m #confignode的CPU初始化大小 + limits: + memory: 1024Mi #confignode的最大内存大小 + cpu: 2000m #confignode的最大CPU大小 + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. 配置私库信息或预先使用ctr拉取镜像 + +在k8s上配置私有仓库的信息，为下一步helm install的前置步骤。 + +方案一即在helm insta时拉取可用的iotdb镜像，方案二则是提前将可用的iotdb镜像导入到containerd里。 + +### 6.1 【方案一】从私有仓库拉取镜像 + +#### 6.1.1 创建secret 使k8s可访问iotdb-helm的私有仓库 + +下文中“xxxxxx”表示IoTDB私有仓库的账号、密码、邮箱。 + +```Bash +# 注意 单引号 +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# 查看secret +kubectl get secret timecho-nexus -n iotdb-ns +# 查看并输出为yaml +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# 查看并解密 +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 将secret作为一个patch加载到命名空间iotdb-ns + +```Bash +# 添加一个patch，使该命名空间增加登陆nexus的登陆信息 +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# 查看命名空间的该条信息 +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 【方案二】导入镜像 + +该步骤用于客户无法连接私库的场景，需要联系公司实施同事辅助准备。 + +#### 6.2.1 拉取并导出镜像： + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 查看并导出镜像： + +```Bash +# 查看 +ctr images ls + +# 导出 +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 导入到k8s的namespace下： + +> 注意，k8s.io为示例环境中k8s的ctr的命名空间，导入到其他命名空间是不行的 + +```Bash +# 导入到k8s的namespace下 +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 查看镜像 + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. 安装 IoTDB + +### 7.1 安装 IoTDB + +```Bash +# 进入文件夹 +cd iotdb-cluster-k8s/helm + +# 安装iotdb +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 查看 Helm 安装列表 + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 查看 Pods + +```Bash +# 查看 iotdb的pods +kubectl get pods -n iotdb-ns -o wide +``` + +执行命令后，输出了带有confignode和datanode标识的各3个Pods，，总共6个Pods，即表明安装成功；需要注意的是，并非所有Pods都处于Running状态，未激活的datanode可能会持续重启，但在激活后将恢复正常。 + +### 7.4 发现故障的排除方式 + +```Bash +# 查看k8s的创建log +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# 获取详细信息 +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# 查看confignode日志 +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. 激活 IoTDB + +### 8.1 方案1：直接在 Pod 中激活（最快捷） + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# 拿到机器码后进行激活 +``` + +### 8.2 方案2：进入confignode的容器中激活 + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# 拿到机器码后进行激活 +# 退出容器 +``` + +### 8.3 方案3：手动激活 + +1. 查看 ConfigNode 详细信息，确定所在节点： + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# 结果示例： +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. 查看 PVC 并找到 ConfigNode 对应的 Volume，确定所在路径： + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" + +# 结果示例： +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# 如果要查看多个confignode，使用如下： +for i in {0..2}; do echo confignode-$i;kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:"; echo "----"; done +``` + +3. 查看对应 Volume 的详细信息，确定物理目录的位置： + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# 结果示例： +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. 从对应节点的对应目录下找到 system-info 文件，使用该 system-info 作为机器码生成激活码，并在同级目录新建文件 license，将激活码写入到该文件。 + +## 9. 验证 IoTDB + +### 9.1 查看命名空间内的 Pods 状态 + +查看iotdb-ns命名空间内的IP、状态等信息，确定全部运行正常 + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# 结果示例： +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 查看命名空间内的端口映射情况 + +```Bash +kubectl get svc -n iotdb-ns + +# 结果示例： +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 在任意服务器启动 CLI 脚本验证 IoTDB 集群状态 + +端口即jdbc-balancer的端口，服务器为k8s任意节点的IP + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. 扩容 + +### 10.1 新增pv + +新增pv，必须有可用的pv才可以扩容。 + + + +**注意：DataNode重启后无法加入集群** + +**原因**：配置了静态存储的 hostPath 模式，并通过脚本修改了 `iotdb-system.properties` 文件，将 `dn_data_dirs` 设为 `/iotdb6/iotdb_data,/iotdb7/iotdb_data`，但未将默认存储路径 `/iotdb/data` 进行外挂，导致重启时数据丢失。 + +**解决方案**：是将 `/iotdb/data` 目录也进行外挂操作，且 ConfigNode 和 DataNode 均需如此设置，以确保数据完整性和集群稳定性。 + +### 10.2 扩容confignode + +示例：3 confignode 扩容为 4 confignode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将confignode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 扩容datanode + +示例：3 datanode 扩容为 4 datanode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将datanode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 验证IoTDB状态 + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_apache.md b/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_apache.md new file mode 100644 index 000000000..566007d21 --- /dev/null +++ b/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_apache.md @@ -0,0 +1,453 @@ + + +# Kubernetes + +## 1. 环境准备 + +### 1.1 准备 Kubernetes 集群 + +确保拥有一个可用的 Kubernetes 集群（建议最低版本：Kubernetes 1.24），作为部署 IoTDB 集群的基础。 + +Kubernetes 版本要求：建议版本为 Kubernetes 1.24及以上 + +IoTDB版本要求：不能低于v1.3.3.2 + +## 2. 创建命名空间 + +### 2.1 创建命名空间 + +> 注意：在执行命名空间创建操作之前，需验证所指定的命名空间名称在 Kubernetes 集群中尚未被使用。如果命名空间已存在，创建命令将无法执行，可能导致部署过程中的错误。 + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 查看命名空间 + +```Bash +kubectl get ns +``` + +## 3. 创建 PersistentVolume (PV) + +### 3.1 创建 PV 配置文件 + +PV用于持久化存储IoTDB的ConfigNode 和 DataNode的数据，有几个节点就要创建几个PV。 + +> 注：1个ConfigNode和1个DataNode 算2个节点，需要2个PV。 + +以 3ConfigNode、3DataNode 为例： + +1. 创建 `pv.yaml` 文件，并复制六份，分别重命名为 `pv01.yaml` ～ `pv06.yaml`。 + +```Bash +#可新建个文件夹放yaml文件 +#创建 pv.yaml 文件语句 +touch pv.yaml +``` + +2. 修改每个文件中的 `name` 和 `path` 以确保一致性。 + +**pv.yaml 示例：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # 存储容量 + accessModes: # 访问模式 + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # 回收策略 + # 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + storageClassName: local-storage + # 根据你的存储类型添加相应的配置 + hostPath: # 如果是使用本地路径 + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # 这行不配置就要手动创建文件夹 +``` + +### 3.2 应用 PV 配置 + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 查看 PV + +```Bash +kubectl get pv +``` + + +### 3.4 手动创建文件夹 + +> 如果yaml里的hostPath-type未配置，需要手动创建对应的文件夹 + +在所有 Kubernetes 节点上创建对应的文件夹： + +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. 安装 Helm + +安装Helm步骤请参考[Helm官网](https://helm.sh/zh/docs/intro/install/) + +## 5. 配置IoTDB的Helm Chart + +### 5.1 克隆 IoTDB Kubernetes 部署代码 + +请联系天谋工作人员获取IoTDB的Helm Chart + +如果遇到代理问题，取消代理设置： + +> git clone报错如下，说明是配置了代理，需要把代理关掉 fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 修改 YAML 文件 + +> 确保使用的是支持的版本 >=1.3.3.2 + +**values.yaml 示例：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" #软件安装后的名称 + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone #软件所用的仓库和版本 + +storage: +# 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + className: local-storage + +datanode: + name: datanode + nodeCount: 3 #datanode的节点数量 + enableRestService: true + storageCapacity: 10Gi #datanode的可用空间大小 + resources: + requests: + memory: 2Gi #datanode的内存初始化大小 + cpu: 1000m #datanode的CPU初始化大小 + limits: + memory: 4Gi #datanode的最大内存大小 + cpu: 1000m #datanode的最大CPU大小 + +confignode: + name: confignode + nodeCount: 3 #confignode的节点数量 + storageCapacity: 10Gi #confignode的可用空间大小 + resources: + requests: + memory: 512Mi #confignode的内存初始化大小 + cpu: 1000m #confignode的CPU初始化大小 + limits: + memory: 1024Mi #confignode的最大内存大小 + cpu: 2000m #confignode的最大CPU大小 + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. 配置私库信息或预先使用ctr拉取镜像 + +在k8s上配置私有仓库的信息，为下一步helm install的前置步骤。 + +方案一即在helm insta时拉取可用的iotdb镜像，方案二则是提前将可用的iotdb镜像导入到containerd里。 + +### 6.1 【方案一】从私有仓库拉取镜像 + +#### 6.1.1 创建secret 使k8s可访问iotdb-helm的私有仓库 + +下文中“xxxxxx”表示IoTDB私有仓库的账号、密码、邮箱。 + +```Bash +# 注意 单引号 +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# 查看secret +kubectl get secret timecho-nexus -n iotdb-ns +# 查看并输出为yaml +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# 查看并解密 +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 将secret作为一个patch加载到命名空间iotdb-ns + +```Bash +# 添加一个patch，使该命名空间增加登陆nexus的登陆信息 +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# 查看命名空间的该条信息 +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 【方案二】导入镜像 + +该步骤用于客户无法连接私库的场景，需要联系公司实施同事辅助准备。 + +#### 6.2.1 拉取并导出镜像： + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 查看并导出镜像： + +```Bash +# 查看 +ctr images ls + +# 导出 +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 导入到k8s的namespace下： + +> 注意，k8s.io为示例环境中k8s的ctr的命名空间，导入到其他命名空间是不行的 + +```Bash +# 导入到k8s的namespace下 +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 查看镜像 + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. 安装 IoTDB + +### 7.1 安装 IoTDB + +```Bash +# 进入文件夹 +cd iotdb-cluster-k8s/helm + +# 安装iotdb +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 查看 Helm 安装列表 + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 查看 Pods + +```Bash +# 查看 iotdb的pods +kubectl get pods -n iotdb-ns -o wide +``` + +执行命令后，输出了带有confignode和datanode标识的各3个Pods，，总共6个Pods，即表明安装成功；需要注意的是，并非所有Pods都处于Running状态，未激活的datanode可能会持续重启，但在激活后将恢复正常。 + +### 7.4 发现故障的排除方式 + +```Bash +# 查看k8s的创建log +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# 获取详细信息 +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# 查看confignode日志 +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. 激活 IoTDB + +### 8.1 方案1：直接在 Pod 中激活（最快捷） + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# 拿到机器码后进行激活 +``` + +### 8.2 方案2：进入confignode的容器中激活 + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# 拿到机器码后进行激活 +# 退出容器 +``` + +### 8.3 方案3：手动激活 + +1. 查看 ConfigNode 详细信息，确定所在节点： + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# 结果示例： +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. 查看 PVC 并找到 ConfigNode 对应的 Volume，确定所在路径： + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" + +# 结果示例： +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# 如果要查看多个confignode，使用如下： +for i in {0..2}; do echo confignode-$i;kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:"; echo "----"; done +``` + +3. 查看对应 Volume 的详细信息，确定物理目录的位置： + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# 结果示例： +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. 从对应节点的对应目录下找到 system-info 文件，使用该 system-info 作为机器码生成激活码，并在同级目录新建文件 license，将激活码写入到该文件。 + +## 9. 验证 IoTDB + +### 9.1 查看命名空间内的 Pods 状态 + +查看iotdb-ns命名空间内的IP、状态等信息，确定全部运行正常 + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# 结果示例： +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 查看命名空间内的端口映射情况 + +```Bash +kubectl get svc -n iotdb-ns + +# 结果示例： +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 在任意服务器启动 CLI 脚本验证 IoTDB 集群状态 + +端口即jdbc-balancer的端口，服务器为k8s任意节点的IP + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. 扩容 + +### 10.1 新增pv + +新增pv，必须有可用的pv才可以扩容。 + + + +**注意：DataNode重启后无法加入集群** + +**原因**：配置了静态存储的 hostPath 模式，并通过脚本修改了 `iotdb-system.properties` 文件，将 `dn_data_dirs` 设为 `/iotdb6/iotdb_data,/iotdb7/iotdb_data`，但未将默认存储路径 `/iotdb/data` 进行外挂，导致重启时数据丢失。 + +**解决方案**：是将 `/iotdb/data` 目录也进行外挂操作，且 ConfigNode 和 DataNode 均需如此设置，以确保数据完整性和集群稳定性。 + +### 10.2 扩容confignode + +示例：3 confignode 扩容为 4 confignode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将confignode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 扩容datanode + +示例：3 datanode 扩容为 4 datanode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将datanode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 验证IoTDB状态 + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_timecho.md b/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_timecho.md new file mode 100644 index 000000000..74947c84c --- /dev/null +++ b/src/zh/UserGuide/V2.0.1/Tree/Ecosystem-Integration/Kubernetes_timecho.md @@ -0,0 +1,453 @@ + + +# Kubernetes + +## 1. 环境准备 + +### 1.1 准备 Kubernetes 集群 + +确保拥有一个可用的 Kubernetes 集群（建议最低版本：Kubernetes 1.24），作为部署 IoTDB 集群的基础。 + +Kubernetes 版本要求：建议版本为 Kubernetes 1.24及以上 + +IoTDB版本要求：不能低于v1.3.3 + +## 2. 创建命名空间 + +### 2.1 创建命名空间 + +> 注意：在执行命名空间创建操作之前，需验证所指定的命名空间名称在 Kubernetes 集群中尚未被使用。如果命名空间已存在，创建命令将无法执行，可能导致部署过程中的错误。 + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 查看命名空间 + +```Bash +kubectl get ns +``` + +## 3. 创建 PersistentVolume (PV) + +### 3.1 创建 PV 配置文件 + +PV用于持久化存储IoTDB的ConfigNode 和 DataNode的数据，有几个节点就要创建几个PV。 + +> 注：1个ConfigNode和1个DataNode 算2个节点，需要2个PV。 + +以 3ConfigNode、3DataNode 为例： + +1. 创建 `pv.yaml` 文件，并复制六份，分别重命名为 `pv01.yaml` ～ `pv06.yaml`。 + +```Bash +#可新建个文件夹放yaml文件 +#创建 pv.yaml 文件语句 +touch pv.yaml +``` + +2. 修改每个文件中的 `name` 和 `path` 以确保一致性。 + +**pv.yaml 示例：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # 存储容量 + accessModes: # 访问模式 + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # 回收策略 + # 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + storageClassName: local-storage + # 根据你的存储类型添加相应的配置 + hostPath: # 如果是使用本地路径 + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # 这行不配置就要手动创建文件夹 +``` + +### 3.2 应用 PV 配置 + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 查看 PV + +```Bash +kubectl get pv +``` + + +### 3.4 手动创建文件夹 + +> 如果yaml里的hostPath-type未配置，需要手动创建对应的文件夹 + +在所有 Kubernetes 节点上创建对应的文件夹： + +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. 安装 Helm + +安装Helm步骤请参考[Helm官网](https://helm.sh/zh/docs/intro/install/) + +## 5. 配置IoTDB的Helm Chart + +### 5.1 克隆 IoTDB Kubernetes 部署代码 + +请联系天谋工作人员获取IoTDB的Helm Chart + +如果遇到代理问题，取消代理设置： + +> git clone报错如下，说明是配置了代理，需要把代理关掉 fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 修改 YAML 文件 + +> 确保使用的是支持的版本 >=1.3.3.2 + +**values.yaml 示例：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" #软件安装后的名称 + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone #软件所用的仓库和版本 + +storage: +# 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + className: local-storage + +datanode: + name: datanode + nodeCount: 3 #datanode的节点数量 + enableRestService: true + storageCapacity: 10Gi #datanode的可用空间大小 + resources: + requests: + memory: 2Gi #datanode的内存初始化大小 + cpu: 1000m #datanode的CPU初始化大小 + limits: + memory: 4Gi #datanode的最大内存大小 + cpu: 1000m #datanode的最大CPU大小 + +confignode: + name: confignode + nodeCount: 3 #confignode的节点数量 + storageCapacity: 10Gi #confignode的可用空间大小 + resources: + requests: + memory: 512Mi #confignode的内存初始化大小 + cpu: 1000m #confignode的CPU初始化大小 + limits: + memory: 1024Mi #confignode的最大内存大小 + cpu: 2000m #confignode的最大CPU大小 + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. 配置私库信息或预先使用ctr拉取镜像 + +在k8s上配置私有仓库的信息，为下一步helm install的前置步骤。 + +方案一即在helm insta时拉取可用的iotdb镜像，方案二则是提前将可用的iotdb镜像导入到containerd里。 + +### 6.1 【方案一】从私有仓库拉取镜像 + +#### 6.1.1 创建secret 使k8s可访问iotdb-helm的私有仓库 + +下文中“xxxxxx”表示IoTDB私有仓库的账号、密码、邮箱。 + +```Bash +# 注意 单引号 +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# 查看secret +kubectl get secret timecho-nexus -n iotdb-ns +# 查看并输出为yaml +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# 查看并解密 +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 将secret作为一个patch加载到命名空间iotdb-ns + +```Bash +# 添加一个patch，使该命名空间增加登陆nexus的登陆信息 +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# 查看命名空间的该条信息 +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 【方案二】导入镜像 + +该步骤用于客户无法连接私库的场景，需要联系公司实施同事辅助准备。 + +#### 6.2.1 拉取并导出镜像： + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 查看并导出镜像： + +```Bash +# 查看 +ctr images ls + +# 导出 +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 导入到k8s的namespace下： + +> 注意，k8s.io为示例环境中k8s的ctr的命名空间，导入到其他命名空间是不行的 + +```Bash +# 导入到k8s的namespace下 +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 查看镜像 + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. 安装 IoTDB + +### 7.1 安装 IoTDB + +```Bash +# 进入文件夹 +cd iotdb-cluster-k8s/helm + +# 安装iotdb +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 查看 Helm 安装列表 + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 查看 Pods + +```Bash +# 查看 iotdb的pods +kubectl get pods -n iotdb-ns -o wide +``` + +执行命令后，输出了带有confignode和datanode标识的各3个Pods，，总共6个Pods，即表明安装成功；需要注意的是，并非所有Pods都处于Running状态，未激活的datanode可能会持续重启，但在激活后将恢复正常。 + +### 7.4 发现故障的排除方式 + +```Bash +# 查看k8s的创建log +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# 获取详细信息 +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# 查看confignode日志 +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. 激活 IoTDB + +### 8.1 方案1：直接在 Pod 中激活（最快捷） + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# 拿到机器码后进行激活 +``` + +### 8.2 方案2：进入confignode的容器中激活 + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# 拿到机器码后进行激活 +# 退出容器 +``` + +### 8.3 方案3：手动激活 + +1. 查看 ConfigNode 详细信息，确定所在节点： + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# 结果示例： +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. 查看 PVC 并找到 ConfigNode 对应的 Volume，确定所在路径： + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" + +# 结果示例： +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# 如果要查看多个confignode，使用如下： +for i in {0..2}; do echo confignode-$i;kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:"; echo "----"; done +``` + +3. 查看对应 Volume 的详细信息，确定物理目录的位置： + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# 结果示例： +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. 从对应节点的对应目录下找到 system-info 文件，使用该 system-info 作为机器码生成激活码，并在同级目录新建文件 license，将激活码写入到该文件。 + +## 9. 验证 IoTDB + +### 9.1 查看命名空间内的 Pods 状态 + +查看iotdb-ns命名空间内的IP、状态等信息，确定全部运行正常 + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# 结果示例： +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 查看命名空间内的端口映射情况 + +```Bash +kubectl get svc -n iotdb-ns + +# 结果示例： +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 在任意服务器启动 CLI 脚本验证 IoTDB 集群状态 + +端口即jdbc-balancer的端口，服务器为k8s任意节点的IP + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. 扩容 + +### 10.1 新增pv + +新增pv，必须有可用的pv才可以扩容。 + + + +**注意：DataNode重启后无法加入集群** + +**原因**：配置了静态存储的 hostPath 模式，并通过脚本修改了 `iotdb-system.properties` 文件，将 `dn_data_dirs` 设为 `/iotdb6/iotdb_data,/iotdb7/iotdb_data`，但未将默认存储路径 `/iotdb/data` 进行外挂，导致重启时数据丢失。 + +**解决方案**：是将 `/iotdb/data` 目录也进行外挂操作，且 ConfigNode 和 DataNode 均需如此设置，以确保数据完整性和集群稳定性。 + +### 10.2 扩容confignode + +示例：3 confignode 扩容为 4 confignode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将confignode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 扩容datanode + +示例：3 datanode 扩容为 4 datanode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将datanode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 验证IoTDB状态 + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/latest/Ecosystem-Integration/Kubernetes_apache.md b/src/zh/UserGuide/latest/Ecosystem-Integration/Kubernetes_apache.md new file mode 100644 index 000000000..566007d21 --- /dev/null +++ b/src/zh/UserGuide/latest/Ecosystem-Integration/Kubernetes_apache.md @@ -0,0 +1,453 @@ + + +# Kubernetes + +## 1. 环境准备 + +### 1.1 准备 Kubernetes 集群 + +确保拥有一个可用的 Kubernetes 集群（建议最低版本：Kubernetes 1.24），作为部署 IoTDB 集群的基础。 + +Kubernetes 版本要求：建议版本为 Kubernetes 1.24及以上 + +IoTDB版本要求：不能低于v1.3.3.2 + +## 2. 创建命名空间 + +### 2.1 创建命名空间 + +> 注意：在执行命名空间创建操作之前，需验证所指定的命名空间名称在 Kubernetes 集群中尚未被使用。如果命名空间已存在，创建命令将无法执行，可能导致部署过程中的错误。 + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 查看命名空间 + +```Bash +kubectl get ns +``` + +## 3. 创建 PersistentVolume (PV) + +### 3.1 创建 PV 配置文件 + +PV用于持久化存储IoTDB的ConfigNode 和 DataNode的数据，有几个节点就要创建几个PV。 + +> 注：1个ConfigNode和1个DataNode 算2个节点，需要2个PV。 + +以 3ConfigNode、3DataNode 为例： + +1. 创建 `pv.yaml` 文件，并复制六份，分别重命名为 `pv01.yaml` ～ `pv06.yaml`。 + +```Bash +#可新建个文件夹放yaml文件 +#创建 pv.yaml 文件语句 +touch pv.yaml +``` + +2. 修改每个文件中的 `name` 和 `path` 以确保一致性。 + +**pv.yaml 示例：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # 存储容量 + accessModes: # 访问模式 + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # 回收策略 + # 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + storageClassName: local-storage + # 根据你的存储类型添加相应的配置 + hostPath: # 如果是使用本地路径 + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # 这行不配置就要手动创建文件夹 +``` + +### 3.2 应用 PV 配置 + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 查看 PV + +```Bash +kubectl get pv +``` + + +### 3.4 手动创建文件夹 + +> 如果yaml里的hostPath-type未配置，需要手动创建对应的文件夹 + +在所有 Kubernetes 节点上创建对应的文件夹： + +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. 安装 Helm + +安装Helm步骤请参考[Helm官网](https://helm.sh/zh/docs/intro/install/) + +## 5. 配置IoTDB的Helm Chart + +### 5.1 克隆 IoTDB Kubernetes 部署代码 + +请联系天谋工作人员获取IoTDB的Helm Chart + +如果遇到代理问题，取消代理设置： + +> git clone报错如下，说明是配置了代理，需要把代理关掉 fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 修改 YAML 文件 + +> 确保使用的是支持的版本 >=1.3.3.2 + +**values.yaml 示例：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" #软件安装后的名称 + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone #软件所用的仓库和版本 + +storage: +# 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + className: local-storage + +datanode: + name: datanode + nodeCount: 3 #datanode的节点数量 + enableRestService: true + storageCapacity: 10Gi #datanode的可用空间大小 + resources: + requests: + memory: 2Gi #datanode的内存初始化大小 + cpu: 1000m #datanode的CPU初始化大小 + limits: + memory: 4Gi #datanode的最大内存大小 + cpu: 1000m #datanode的最大CPU大小 + +confignode: + name: confignode + nodeCount: 3 #confignode的节点数量 + storageCapacity: 10Gi #confignode的可用空间大小 + resources: + requests: + memory: 512Mi #confignode的内存初始化大小 + cpu: 1000m #confignode的CPU初始化大小 + limits: + memory: 1024Mi #confignode的最大内存大小 + cpu: 2000m #confignode的最大CPU大小 + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. 配置私库信息或预先使用ctr拉取镜像 + +在k8s上配置私有仓库的信息，为下一步helm install的前置步骤。 + +方案一即在helm insta时拉取可用的iotdb镜像，方案二则是提前将可用的iotdb镜像导入到containerd里。 + +### 6.1 【方案一】从私有仓库拉取镜像 + +#### 6.1.1 创建secret 使k8s可访问iotdb-helm的私有仓库 + +下文中“xxxxxx”表示IoTDB私有仓库的账号、密码、邮箱。 + +```Bash +# 注意 单引号 +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# 查看secret +kubectl get secret timecho-nexus -n iotdb-ns +# 查看并输出为yaml +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# 查看并解密 +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 将secret作为一个patch加载到命名空间iotdb-ns + +```Bash +# 添加一个patch，使该命名空间增加登陆nexus的登陆信息 +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# 查看命名空间的该条信息 +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 【方案二】导入镜像 + +该步骤用于客户无法连接私库的场景，需要联系公司实施同事辅助准备。 + +#### 6.2.1 拉取并导出镜像： + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 查看并导出镜像： + +```Bash +# 查看 +ctr images ls + +# 导出 +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 导入到k8s的namespace下： + +> 注意，k8s.io为示例环境中k8s的ctr的命名空间，导入到其他命名空间是不行的 + +```Bash +# 导入到k8s的namespace下 +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 查看镜像 + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. 安装 IoTDB + +### 7.1 安装 IoTDB + +```Bash +# 进入文件夹 +cd iotdb-cluster-k8s/helm + +# 安装iotdb +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 查看 Helm 安装列表 + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 查看 Pods + +```Bash +# 查看 iotdb的pods +kubectl get pods -n iotdb-ns -o wide +``` + +执行命令后，输出了带有confignode和datanode标识的各3个Pods，，总共6个Pods，即表明安装成功；需要注意的是，并非所有Pods都处于Running状态，未激活的datanode可能会持续重启，但在激活后将恢复正常。 + +### 7.4 发现故障的排除方式 + +```Bash +# 查看k8s的创建log +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# 获取详细信息 +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# 查看confignode日志 +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. 激活 IoTDB + +### 8.1 方案1：直接在 Pod 中激活（最快捷） + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# 拿到机器码后进行激活 +``` + +### 8.2 方案2：进入confignode的容器中激活 + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# 拿到机器码后进行激活 +# 退出容器 +``` + +### 8.3 方案3：手动激活 + +1. 查看 ConfigNode 详细信息，确定所在节点： + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# 结果示例： +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. 查看 PVC 并找到 ConfigNode 对应的 Volume，确定所在路径： + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" + +# 结果示例： +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# 如果要查看多个confignode，使用如下： +for i in {0..2}; do echo confignode-$i;kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:"; echo "----"; done +``` + +3. 查看对应 Volume 的详细信息，确定物理目录的位置： + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# 结果示例： +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. 从对应节点的对应目录下找到 system-info 文件，使用该 system-info 作为机器码生成激活码，并在同级目录新建文件 license，将激活码写入到该文件。 + +## 9. 验证 IoTDB + +### 9.1 查看命名空间内的 Pods 状态 + +查看iotdb-ns命名空间内的IP、状态等信息，确定全部运行正常 + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# 结果示例： +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 查看命名空间内的端口映射情况 + +```Bash +kubectl get svc -n iotdb-ns + +# 结果示例： +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 在任意服务器启动 CLI 脚本验证 IoTDB 集群状态 + +端口即jdbc-balancer的端口，服务器为k8s任意节点的IP + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. 扩容 + +### 10.1 新增pv + +新增pv，必须有可用的pv才可以扩容。 + + + +**注意：DataNode重启后无法加入集群** + +**原因**：配置了静态存储的 hostPath 模式，并通过脚本修改了 `iotdb-system.properties` 文件，将 `dn_data_dirs` 设为 `/iotdb6/iotdb_data,/iotdb7/iotdb_data`，但未将默认存储路径 `/iotdb/data` 进行外挂，导致重启时数据丢失。 + +**解决方案**：是将 `/iotdb/data` 目录也进行外挂操作，且 ConfigNode 和 DataNode 均需如此设置，以确保数据完整性和集群稳定性。 + +### 10.2 扩容confignode + +示例：3 confignode 扩容为 4 confignode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将confignode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 扩容datanode + +示例：3 datanode 扩容为 4 datanode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将datanode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 验证IoTDB状态 + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/latest/Ecosystem-Integration/Kubernetes_timecho.md b/src/zh/UserGuide/latest/Ecosystem-Integration/Kubernetes_timecho.md new file mode 100644 index 000000000..74947c84c --- /dev/null +++ b/src/zh/UserGuide/latest/Ecosystem-Integration/Kubernetes_timecho.md @@ -0,0 +1,453 @@ + + +# Kubernetes + +## 1. 环境准备 + +### 1.1 准备 Kubernetes 集群 + +确保拥有一个可用的 Kubernetes 集群（建议最低版本：Kubernetes 1.24），作为部署 IoTDB 集群的基础。 + +Kubernetes 版本要求：建议版本为 Kubernetes 1.24及以上 + +IoTDB版本要求：不能低于v1.3.3 + +## 2. 创建命名空间 + +### 2.1 创建命名空间 + +> 注意：在执行命名空间创建操作之前，需验证所指定的命名空间名称在 Kubernetes 集群中尚未被使用。如果命名空间已存在，创建命令将无法执行，可能导致部署过程中的错误。 + +```Bash +kubectl create ns iotdb-ns +``` + +### 2.2 查看命名空间 + +```Bash +kubectl get ns +``` + +## 3. 创建 PersistentVolume (PV) + +### 3.1 创建 PV 配置文件 + +PV用于持久化存储IoTDB的ConfigNode 和 DataNode的数据，有几个节点就要创建几个PV。 + +> 注：1个ConfigNode和1个DataNode 算2个节点，需要2个PV。 + +以 3ConfigNode、3DataNode 为例： + +1. 创建 `pv.yaml` 文件，并复制六份，分别重命名为 `pv01.yaml` ～ `pv06.yaml`。 + +```Bash +#可新建个文件夹放yaml文件 +#创建 pv.yaml 文件语句 +touch pv.yaml +``` + +2. 修改每个文件中的 `name` 和 `path` 以确保一致性。 + +**pv.yaml 示例：** + +```YAML +# pv.yaml +apiVersion: v1 +kind: PersistentVolume +metadata: + name: iotdb-pv-01 +spec: + capacity: + storage: 10Gi # 存储容量 + accessModes: # 访问模式 + - ReadWriteOnce + persistentVolumeReclaimPolicy: Retain # 回收策略 + # 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + storageClassName: local-storage + # 根据你的存储类型添加相应的配置 + hostPath: # 如果是使用本地路径 + path: /data/k8s-data/iotdb-pv-01 + type: DirectoryOrCreate # 这行不配置就要手动创建文件夹 +``` + +### 3.2 应用 PV 配置 + +```Bash +kubectl apply -f pv01.yaml +kubectl apply -f pv-02.yaml +... +``` + +### 3.3 查看 PV + +```Bash +kubectl get pv +``` + + +### 3.4 手动创建文件夹 + +> 如果yaml里的hostPath-type未配置，需要手动创建对应的文件夹 + +在所有 Kubernetes 节点上创建对应的文件夹： + +```Bash +mkdir -p /data/k8s-data/iotdb-pv-01 +mkdir -p /data/k8s-data/iotdb-pv-02 +... +``` + +## 4. 安装 Helm + +安装Helm步骤请参考[Helm官网](https://helm.sh/zh/docs/intro/install/) + +## 5. 配置IoTDB的Helm Chart + +### 5.1 克隆 IoTDB Kubernetes 部署代码 + +请联系天谋工作人员获取IoTDB的Helm Chart + +如果遇到代理问题，取消代理设置： + +> git clone报错如下，说明是配置了代理，需要把代理关掉 fatal: unable to access 'https://gitlab.timecho.com/r-d/db/iotdb-cluster-k8s.git/': gnutls_handshake() failed: The TLS connection was non-properly terminated. + +```Bash +unset HTTPS_PROXY +``` + +### 5.2 修改 YAML 文件 + +> 确保使用的是支持的版本 >=1.3.3.2 + +**values.yaml 示例：** + +```YAML +nameOverride: "iotdb" +fullnameOverride: "iotdb" #软件安装后的名称 + +image: + repository: nexus.infra.timecho.com:8143/timecho/iotdb-enterprise + pullPolicy: IfNotPresent + tag: 1.3.3.2-standalone #软件所用的仓库和版本 + +storage: +# 存储类名称，如果使用本地静态存储storageClassName 不用配置，如果使用动态存储必需设置此项 + className: local-storage + +datanode: + name: datanode + nodeCount: 3 #datanode的节点数量 + enableRestService: true + storageCapacity: 10Gi #datanode的可用空间大小 + resources: + requests: + memory: 2Gi #datanode的内存初始化大小 + cpu: 1000m #datanode的CPU初始化大小 + limits: + memory: 4Gi #datanode的最大内存大小 + cpu: 1000m #datanode的最大CPU大小 + +confignode: + name: confignode + nodeCount: 3 #confignode的节点数量 + storageCapacity: 10Gi #confignode的可用空间大小 + resources: + requests: + memory: 512Mi #confignode的内存初始化大小 + cpu: 1000m #confignode的CPU初始化大小 + limits: + memory: 1024Mi #confignode的最大内存大小 + cpu: 2000m #confignode的最大CPU大小 + configNodeConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + schemaReplicationFactor: 3 + schemaRegionConsensusProtocolClass: org.apache.iotdb.consensus.ratis.RatisConsensus + dataReplicationFactor: 2 + dataRegionConsensusProtocolClass: org.apache.iotdb.consensus.iot.IoTConsensus +``` + +## 6. 配置私库信息或预先使用ctr拉取镜像 + +在k8s上配置私有仓库的信息，为下一步helm install的前置步骤。 + +方案一即在helm insta时拉取可用的iotdb镜像，方案二则是提前将可用的iotdb镜像导入到containerd里。 + +### 6.1 【方案一】从私有仓库拉取镜像 + +#### 6.1.1 创建secret 使k8s可访问iotdb-helm的私有仓库 + +下文中“xxxxxx”表示IoTDB私有仓库的账号、密码、邮箱。 + +```Bash +# 注意 单引号 +kubectl create secret docker-registry timecho-nexus \ + --docker-server='nexus.infra.timecho.com:8143' \ + --docker-username='xxxxxx' \ + --docker-password='xxxxxx' \ + --docker-email='xxxxxx' \ + -n iotdb-ns + +# 查看secret +kubectl get secret timecho-nexus -n iotdb-ns +# 查看并输出为yaml +kubectl get secret timecho-nexus --output=yaml -n iotdb-ns +# 查看并解密 +kubectl get secret timecho-nexus --output="jsonpath={.data.\.dockerconfigjson}" -n iotdb-ns | base64 --decode +``` + +#### 6.1.2 将secret作为一个patch加载到命名空间iotdb-ns + +```Bash +# 添加一个patch，使该命名空间增加登陆nexus的登陆信息 +kubectl patch serviceaccount default -n iotdb-ns -p '{"imagePullSecrets": [{"name": "timecho-nexus"}]}' + +# 查看命名空间的该条信息 +kubectl get serviceaccounts -n iotdb-ns -o yaml +``` + +### 6.2 【方案二】导入镜像 + +该步骤用于客户无法连接私库的场景，需要联系公司实施同事辅助准备。 + +#### 6.2.1 拉取并导出镜像： + +```Bash +ctr images pull --user xxxxxxxx nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.2 查看并导出镜像： + +```Bash +# 查看 +ctr images ls + +# 导出 +ctr images export iotdb-enterprise:1.3.3.2-standalone.tar nexus.infra.timecho.com:8143/timecho/iotdb-enterprise:1.3.3.2-standalone +``` + +#### 6.2.3 导入到k8s的namespace下： + +> 注意，k8s.io为示例环境中k8s的ctr的命名空间，导入到其他命名空间是不行的 + +```Bash +# 导入到k8s的namespace下 +ctr -n k8s.io images import iotdb-enterprise:1.3.3.2-standalone.tar +``` + +#### 6.2.4 查看镜像 + +```Bash +ctr --namespace k8s.io images list | grep 1.3.3.2 +``` + +## 7. 安装 IoTDB + +### 7.1 安装 IoTDB + +```Bash +# 进入文件夹 +cd iotdb-cluster-k8s/helm + +# 安装iotdb +helm install iotdb ./ -n iotdb-ns +``` + +### 7.2 查看 Helm 安装列表 + +```Bash +# helm list +helm list -n iotdb-ns +``` + +### 7.3 查看 Pods + +```Bash +# 查看 iotdb的pods +kubectl get pods -n iotdb-ns -o wide +``` + +执行命令后，输出了带有confignode和datanode标识的各3个Pods，，总共6个Pods，即表明安装成功；需要注意的是，并非所有Pods都处于Running状态，未激活的datanode可能会持续重启，但在激活后将恢复正常。 + +### 7.4 发现故障的排除方式 + +```Bash +# 查看k8s的创建log +kubectl get events -n iotdb-ns +watch kubectl get events -n iotdb-ns + +# 获取详细信息 +kubectl describe pod confignode-0 -n iotdb-ns +kubectl describe pod datanode-0 -n iotdb-ns + +# 查看confignode日志 +kubectl logs -n iotdb-ns confignode-0 -f +``` + +## 8. 激活 IoTDB + +### 8.1 方案1：直接在 Pod 中激活（最快捷） + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-1 -- /iotdb/sbin/start-activate.sh +kubectl exec -it -n iotdb-ns confignode-2 -- /iotdb/sbin/start-activate.sh +# 拿到机器码后进行激活 +``` + +### 8.2 方案2：进入confignode的容器中激活 + +```Bash +kubectl exec -it -n iotdb-ns confignode-0 -- /bin/bash +cd /iotdb/sbin +/bin/bash start-activate.sh +# 拿到机器码后进行激活 +# 退出容器 +``` + +### 8.3 方案3：手动激活 + +1. 查看 ConfigNode 详细信息，确定所在节点： + +```Bash +kubectl describe pod confignode-0 -n iotdb-ns | grep -e "Node:" -e "Path:" + +# 结果示例： +# Node: a87/172.20.31.87 +# Path: /data/k8s-data/env/confignode/.env +``` + +2. 查看 PVC 并找到 ConfigNode 对应的 Volume，确定所在路径： + +```Bash +kubectl get pvc -n iotdb-ns | grep "confignode-0" + +# 结果示例： +# map-confignode-confignode-0 Bound iotdb-pv-04 10Gi RWO local-storage 8h + +# 如果要查看多个confignode，使用如下： +for i in {0..2}; do echo confignode-$i;kubectl describe pod confignode-${i} -n iotdb-ns | grep -e "Node:" -e "Path:"; echo "----"; done +``` + +3. 查看对应 Volume 的详细信息，确定物理目录的位置： + +```Bash +kubectl describe pv iotdb-pv-04 | grep "Path:" + +# 结果示例： +# Path: /data/k8s-data/iotdb-pv-04 +``` + +4. 从对应节点的对应目录下找到 system-info 文件，使用该 system-info 作为机器码生成激活码，并在同级目录新建文件 license，将激活码写入到该文件。 + +## 9. 验证 IoTDB + +### 9.1 查看命名空间内的 Pods 状态 + +查看iotdb-ns命名空间内的IP、状态等信息，确定全部运行正常 + +```Bash +kubectl get pods -n iotdb-ns -o wide + +# 结果示例： +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` + +### 9.2 查看命名空间内的端口映射情况 + +```Bash +kubectl get svc -n iotdb-ns + +# 结果示例： +# NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +# confignode-svc NodePort 10.10.226.151 80:31026/TCP 7d8h +# datanode-svc NodePort 10.10.194.225 6667:31563/TCP 7d8h +# jdbc-balancer LoadBalancer 10.10.191.209 6667:31895/TCP 7d8h +``` + +### 9.3 在任意服务器启动 CLI 脚本验证 IoTDB 集群状态 + +端口即jdbc-balancer的端口，服务器为k8s任意节点的IP + +```Bash +start-cli.sh -h 172.20.31.86 -p 31895 +start-cli.sh -h 172.20.31.87 -p 31895 +start-cli.sh -h 172.20.31.88 -p 31895 +``` + + + +## 10. 扩容 + +### 10.1 新增pv + +新增pv，必须有可用的pv才可以扩容。 + + + +**注意：DataNode重启后无法加入集群** + +**原因**：配置了静态存储的 hostPath 模式，并通过脚本修改了 `iotdb-system.properties` 文件，将 `dn_data_dirs` 设为 `/iotdb6/iotdb_data,/iotdb7/iotdb_data`，但未将默认存储路径 `/iotdb/data` 进行外挂，导致重启时数据丢失。 + +**解决方案**：是将 `/iotdb/data` 目录也进行外挂操作，且 ConfigNode 和 DataNode 均需如此设置，以确保数据完整性和集群稳定性。 + +### 10.2 扩容confignode + +示例：3 confignode 扩容为 4 confignode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将confignode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + + + + +### 10.3 扩容datanode + +示例：3 datanode 扩容为 4 datanode + +修改iotdb-cluster-k8s/helm的values.yaml文件，将datanode的3改成4 + +```Shell +helm upgrade iotdb . -n iotdb-ns +``` + +### 10.4 验证IoTDB状态 + +```Shell +kubectl get pods -n iotdb-ns -o wide + +# NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES +# confignode-0 1/1 Running 0 75m 10.20.187.14 a87 +# confignode-1 1/1 Running 0 75m 10.20.191.75 a88 +# confignode-2 1/1 Running 0 75m 10.20.187.16 a87 +# datanode-0 1/1 Running 10 (5m54s ago) 75m 10.20.191.74 a88 +# datanode-1 1/1 Running 10 (5m42s ago) 75m 10.20.187.15 a87 +# datanode-2 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +# datanode-3 1/1 Running 10 (5m55s ago) 75m 10.20.191.76 a88 +``` \ No newline at end of file