Install IOMesh · Documentation

Before installing IOMesh, refer to the following to choose how you install IOMesh.

Quick Installation: One-click online installation with default parameter values that cannot be modified.
Custom Installation: Configure parameters during installation, but ensure that your Kubernetes cluster is connected to the public network.
Offline Installation: Recommended for Kubernetes clusters with no public network connectivity and supports custom parameter configuration during installation.

Quick Installation

Prerequisite

The CPU architecture of the Kubernetes cluster must be Intel x86_64 or Kunpeng AArch64.

Limitations

The Community Edition is installed by default, which has a 3-node limit.
Only hybrid disk configurations are allowed.

Procedure

Access a master node.
Run the following command to install IOMesh. Make sure to replace 10.234.1.0/24 with your actual CIDR. After executing the following command, wait for a few minutes.

NOTE: Quick Installation utilizes Helm, which is included in the following command and will be installed automatically if it is not found.
```
# The IP address of each worker node running IOMesh must be within the same IOMESH_DATA_CIDR.
export IOMESH_DATA_CIDR=10.234.1.0/24; curl -sSL https://iomesh.run/install_iomesh.sh | sh -
```
Verify that all pods are in Running state. If so, then IOMesh has been successfully installed.
```
watch kubectl get --namespace iomesh-system pods
```
NOTE: IOMesh resources left by running the above commands will be saved for troubleshooting if any error occurs during installation. You can run the command curl -sSL https://iomesh.run/uninstall_iomesh.sh | sh - to remove all IOMesh resources from the Kubernetes cluster.

Custom Installation

Prerequisite

Make sure the CPU architecture of your Kubernetes cluster is Intel x86_64, Hygon x86_64, or Kunpeng AArch64.

Procedure

Access a master node in the Kubernetes cluster.

Install Helm. Skip this step if Helm is already installed.

curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh

For more details, refer to Installing Helm.

Add the IOMesh Helm repository.

helm repo add iomesh http://iomesh.com/charts

Export the IOMesh default configuration file iomesh.yaml.
```
helm show values iomesh/iomesh > iomesh.yaml
```
Configure iomesh.yaml.
- Set dataCIDR to the CIDR you previously configured in Prerequisites.
```
  iomesh:
    chunk:
      dataCIDR: "" # Fill in the dataCIDR you configured in Prerequisites.
```
- Set diskDeploymentMode according to your disk configurations. The system defaults to hybridFlash.
```
diskDeploymentMode: "hybridFlash" # Set the disk deployment mode.
```
- Specify the CPU architecture. If you have a hygon_x86_64 Kubernetes cluster, enter hygon_x86_64, or else leave the field blank.
```
platform: ""
```
- Specify the IOMesh edition. The field is blank by default, and if left unspecified, the system will install the Community edition automatically.
  
  If you have purchased the Enterprise edition, set the value of edition to enterprise. For details, refer to IOMesh Specifications.
```
edition: "" # If left blank, Community Edition will be installed.
```
- An optional step. The number of IOMesh chunk pods is 3 by default. If you install IOMesh Enterprise Edition, you can deploy more than 3 chunk pods。
```
iomesh:
  chunk:
    replicaCount: 3 # Enter the number of chunk pods.
```
- An optional step. If you want IOMesh to only use the disks of specific Kubernetes nodes, configure the label of the corresponding node in the chunk.podPolicy.affinity field.
```
iomesh:
  chunk:
    podPolicy:
      affinity:
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
            - matchExpressions:
              - key: kubernetes.io/hostname 
                operator: In
                values:
                - iomesh-worker-0 # Specify the values of the node label.
                - iomesh-worker-1
```
  It is recommended that you only configure values. For more configurations, refer to Pod Affinity.

On the master node, deploy the IOMesh cluster.

helm install iomesh iomesh/iomesh \
        --create-namespace \
        --namespace iomesh-system \
        --values iomesh.yaml \
        --wait

If successful, you should see output like this:

NAME: iomesh
LAST DEPLOYED: Wed Jun 30 16:00:32 2021
NAMESPACE: iomesh-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

Verify that all pods are in Running state. If so, then IOMesh has been installed successfully.

kubectl --namespace iomesh-system get pods

If successful, you should see output like this:

NAME                                                   READY   STATUS    RESTARTS   AGE
iomesh-blockdevice-monitor-76ddc8cf85-82d4h            1/1     Running   0          3m23s
iomesh-blockdevice-monitor-prober-kk2qf                1/1     Running   0          3m23s
iomesh-blockdevice-monitor-prober-w6g5q                1/1     Running   0          3m23s
iomesh-blockdevice-monitor-prober-z6b7f                1/1     Running   0          3m23s
iomesh-chunk-0                                         3/3     Running   2          2m17s
iomesh-chunk-1                                         3/3     Running   0          2m8s
iomesh-chunk-2                                         3/3     Running   0          113s
iomesh-csi-driver-controller-plugin-856565b79d-brt2j   6/6     Running   0          3m23s
iomesh-csi-driver-controller-plugin-856565b79d-g6rnd   6/6     Running   0          3m23s
iomesh-csi-driver-controller-plugin-856565b79d-kp9ct   6/6     Running   0          3m23s
iomesh-csi-driver-node-plugin-6pbpp                    3/3     Running   4          3m23s
iomesh-csi-driver-node-plugin-bpr7x                    3/3     Running   4          3m23s
iomesh-csi-driver-node-plugin-krjts                    3/3     Running   4          3m23s
iomesh-hostpath-provisioner-6ffbh                      1/1     Running   0          3m23s
iomesh-hostpath-provisioner-bqrjp                      1/1     Running   0          3m23s
iomesh-hostpath-provisioner-rm8ms                      1/1     Running   0          3m23s
iomesh-iscsi-redirector-2pc26                          2/2     Running   1          2m19s
iomesh-iscsi-redirector-7msvs                          2/2     Running   1          2m19s
iomesh-iscsi-redirector-nnbb2                          2/2     Running   1          2m19s
iomesh-localpv-manager-6flpl                           4/4     Running   0          3m23s
iomesh-localpv-manager-m8qgq                           4/4     Running   0          3m23s
iomesh-localpv-manager-p88x7                           4/4     Running   0          3m23s
iomesh-meta-0                                          2/2     Running   0          2m17s
iomesh-meta-1                                          2/2     Running   0          2m17s
iomesh-meta-2                                          2/2     Running   0          2m17s
iomesh-openebs-ndm-9chdk                               1/1     Running   0          3m23s
iomesh-openebs-ndm-cluster-exporter-68c757948-2lgvr    1/1     Running   0          3m23s
iomesh-openebs-ndm-f6qkg                               1/1     Running   0          3m23s
iomesh-openebs-ndm-ffbqv                               1/1     Running   0          3m23s
iomesh-openebs-ndm-node-exporter-pnc8h                 1/1     Running   0          3m23s
iomesh-openebs-ndm-node-exporter-scd6q                 1/1     Running   0          3m23s
iomesh-openebs-ndm-node-exporter-tksjh                 1/1     Running   0          3m23s
iomesh-openebs-ndm-operator-bd4b94fd6-zrpw7            1/1     Running   0          3m23s
iomesh-zookeeper-0                                     1/1     Running   0          3m17s
iomesh-zookeeper-1                                     1/1     Running   0          2m56s
iomesh-zookeeper-2                                     1/1     Running   0          2m21s
iomesh-zookeeper-operator-58f4df8d54-2wvgj             1/1     Running   0          3m23s
operator-87bb89877-fkbvd                               1/1     Running   0          3m23s
operator-87bb89877-kfs9d                               1/1     Running   0          3m23s
operator-87bb89877-z9tfr                               1/1     Running   0          3m23s

Offline Installation

Prerequisite

Make sure the CPU architecture of your Kubernetes cluster is Intel x86_64, Hygon x86_64, or Kunpeng AArch64.

Procedure

Download the IOMesh Offline Installation Package on each worker node and the master node, based on your CPU architecture.
Unpack the installation package on each worker node and the master node. Make sure to replace <VERSION> with v1.0.0 and <ARCH> based on your CPU architecture.
- Hygon x86_64: hygon-amd64
- Intel x86_64: amd64
- Kunpeng AArch64: arm64
```
tar -xf  iomesh-offline-<VERSION>-<ARCH>.tgz && cd iomesh-offline
```

Load the IOMesh image on each worker node and then execute the corresponding script based on your container runtime and container manager.

Docker

Containerd

Podman

docker load --input ./images/iomesh-offline-images.tar

ctr --namespace k8s.io image import ./images/iomesh-offline-images.tar

podman load --input ./images/iomesh-offline-images.tar

On the master node, export the IOMesh default configuration file iomesh.yaml.
```
./helm show values charts/iomesh > iomesh.yaml
```
Configure iomesh.yaml.
- Set dataCIDR to the data CIDR you previously configured in Prerequisites.
```
iomesh:
  chunk:
    dataCIDR: "" # Fill in the dataCIDR you configured previously in Prerequisites.
```
- Set diskDeploymentMode according to your disk configurations. The system defaults to hybridFlash.
```
diskDeploymentMode: "hybridFlash" # Set the disk deployment mode.
```
- Specify the CPU architecture. If you have a hygon_x86_64 Kubernetes cluster, enter hygon_x86_64, or else leave the field blank.
```
platform: ""
```
- Specify the IOMesh edition. The field is blank by default, and if left unspecified, the system will install the Community edition automatically.
  
  If you have purchased the Enterprise edition, set the value of edition to enterprise. For details, refer to IOMesh Specifications.
```
edition: "" # If left blank, Community Edition will be installed.
```
- An optional step. The number of IOMesh chunk pods is 3 by default. If you install IOMesh Enterprise Edition, you can deploy more than 3 chunk pods.
```
iomesh:
  chunk:
    replicaCount: 3 # Specify the number of chunk pods.
```
- An optional step. If you want IOMesh to only use the disks of specific Kubernetes nodes, configure the values of the node label.
```
iomesh:
  chunk:
    podPolicy:
      affinity:
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
            - matchExpressions:
              - key: kubernetes.io/hostname 
                operator: In
                values:
                - iomesh-worker-0 # Specify the values of the node label.
                - iomesh-worker-1
```
  It is recommended that you only configure values. For more configurations, refer to Pod Affinity.

On the master node, deploy the IOMesh cluster.

./helm install iomesh ./charts/iomesh \
    --create-namespace \
    --namespace iomesh-system \
    --values iomesh.yaml \
    --wait

If successful, you should see output like this:

NAME: iomesh
LAST DEPLOYED: Wed Jun 30 16:00:32 2021
NAMESPACE: iomesh-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

Verify that all pods are running. If so, then IOMesh has been installed successfully.

kubectl --namespace iomesh-system get pods

If successful, you should see output like this:

NAME                                                  READY   STATUS    RESTARTS   AGE
csi-driver-controller-plugin-89b55d6b5-8r2fc          6/6     Running   10         2m8s
csi-driver-controller-plugin-89b55d6b5-d4rbr          6/6     Running   10         2m8s
csi-driver-controller-plugin-89b55d6b5-n5s48          6/6     Running   10         2m8s
csi-driver-node-plugin-9wccv                          3/3     Running   2          2m8s
csi-driver-node-plugin-mbpnk                          3/3     Running   2          2m8s
csi-driver-node-plugin-x6qrk                          3/3     Running   2          2m8s
iomesh-chunk-0                                        3/3     Running   0          52s
iomesh-chunk-1                                        3/3     Running   0          47s
iomesh-chunk-2                                        3/3     Running   0          43s
iomesh-hostpath-provisioner-8fzvj                     1/1     Running   0          2m8s
iomesh-hostpath-provisioner-gfl9k                     1/1     Running   0          2m8s
iomesh-hostpath-provisioner-htzx9                     1/1     Running   0          2m8s
iomesh-iscsi-redirector-96672                         2/2     Running   1          55s
iomesh-iscsi-redirector-c2pwm                         2/2     Running   1          55s
iomesh-iscsi-redirector-pcx8c                         2/2     Running   1          55s
iomesh-meta-0                                         2/2     Running   0          55s
iomesh-meta-1                                         2/2     Running   0          55s
iomesh-meta-2                                         2/2     Running   0          55s
iomesh-localpv-manager-jwng7                          4/4     Running   0          6h23m
iomesh-localpv-manager-khhdw                          4/4     Running   0          6h23m
iomesh-localpv-manager-xwmzb                          4/4     Running   0          6h23m
iomesh-openebs-ndm-5457z                              1/1     Running   0          2m8s
iomesh-openebs-ndm-599qb                              1/1     Running   0          2m8s
iomesh-openebs-ndm-cluster-exporter-68c757948-gszzx   1/1     Running   0          2m8s
iomesh-openebs-ndm-node-exporter-kzjfc                1/1     Running   0          2m8s
iomesh-openebs-ndm-node-exporter-qc9pt                1/1     Running   0          2m8s
iomesh-openebs-ndm-node-exporter-v7sh7                1/1     Running   0          2m8s
iomesh-openebs-ndm-operator-56cfb5d7b6-srfzm          1/1     Running   0          2m8s
iomesh-openebs-ndm-svp9n                              1/1     Running   0          2m8s
iomesh-zookeeper-0                                    1/1     Running   0          2m3s
iomesh-zookeeper-1                                    1/1     Running   0          102s
iomesh-zookeeper-2                                    1/1     Running   0          76s
iomesh-zookeeper-operator-7b5f4b98dc-6mztk            1/1     Running   0          2m8s
operator-85877979-66888                               1/1     Running   0          2m8s
operator-85877979-s94vz                               1/1     Running   0          2m8s
operator-85877979-xqtml                               1/1     Running   0          2m8s