nacos-k8s

Kubernetes Nacos

This project contains a Nacos Docker image meant to facilitate the deployment of Nacos on Kubernetes via StatefulSets.

中文文档

Tips

If you are using Nacos version 1.1.4 or lower, please refer to this Tag

It is recommended to deploy Nacos in Kubernetes using Nacos Operator.

Quick Start

• Clone Project

git clone https://github.com/nacos-group/nacos-k8s.git

• Simple Start

If you want to start Nacos without NFS, but emptyDirs will possibly result in a loss of data. as follows:

cd nacos-k8s
chmod +x quick-startup.sh
./quick-startup.sh

• Testing

  • Service registration
  powershell复制

  curl -X POST 'http://cluster-ip:8848/nacos/v2/ns/instance?serviceName=nacos.naming.serviceName&ip=20.18.7.10&port=8080'

  • Service discovery
  powershell复制

  curl -X GET 'http://cluster-ip:8848/nacos/v2/ns/instance/list?serviceName=nacos.naming.serviceName'

  • Publish config
  powershell复制

  curl -X POST "http://cluster-ip:8848/nacos/v2/cs/config?dataId=nacos.cfg.dataId&group=test&content=helloWorld"

  • Get config
  powershell复制

  curl -X GET "http://cluster-ip:8848/nacos/v2/cs/config?dataId=nacos.cfg.dataId&group=test"

Advanced

Tips

If you use a custom database, please initialize the database script yourself first.

In advanced use, the cluster is automatically scaled and data is persisted, but PersistentVolumeClaims must be deployed. In this example, NFS is used.

⚠️ Deprecation Notice: The NFS, Ceph, and OpenShift deployment methods below are deprecated and no longer actively maintained. They rely on archived upstream projects (kubernetes-incubator/external-storage) and outdated APIs. Please use the Helm chart instead, which supports persistent storage via any StorageClass (including NFS CSI and Rook-Ceph) with persistence.enabled=true.

Deploy NFS

• Create Role

kubectl create -f deploy/nfs/rbac.yaml

If your K8S namespace is not default, execute the following script before creating RBAC

# Set the subject of the RBAC objects to the current namespace where the provisioner is being deployed
$ NS=$(kubectl config get-contexts|grep -e "^\*" |awk '{print $5}')
$ NAMESPACE=${NS:-default}
$ sed -i "s/namespace:.*/namespace: $NAMESPACE/g" ./deploy/nfs/rbac.yaml

• Create ServiceAccount And deploy NFS-Client Provisioner

kubectl create -f deploy/nfs/deployment.yaml

• Create NFS StorageClass

kubectl create -f deploy/nfs/class.yaml

• Verify that NFS is working

kubectl get pod -l app=nfs-client-provisioner

Deploy database

• Deploy mysql

cd nacos-k8s

kubectl create -f deploy/mysql/mysql-nfs.yaml

• Verify that Database is working

kubectl get pod 
NAME                         READY   STATUS    RESTARTS   AGE
mysql-gf2vd                        1/1     Running   0          111m

Deploy Nacos

• Modify deploy/nacos/nacos-pvc-nfs.yaml

data:
  mysql.host: "db host"
  mysql.db.name: "db name"
  mysql.port: " db port"
  mysql.user: " db username"
  mysql.password: " db password"

• Create Nacos

kubectl create -f nacos-k8s/deploy/nacos/nacos-pvc-nfs.yaml

• Verify that Nacos is working

kubectl get pod -l app=nacos

NAME      READY   STATUS    RESTARTS   AGE
nacos-0   1/1     Running   0          19h
nacos-1   1/1     Running   0          19h
nacos-2   1/1     Running   0          19h

Scale Testing

• Use kubectl exec to get the cluster config of the Pods in the nacos StatefulSet.

for i in 0 1; do echo nacos-$i; kubectl exec nacos-$i -- cat conf/cluster.conf; done

The StatefulSet controller provides each Pod with a unique hostname based on its ordinal index. The hostnames take the form of -. Because the replicas field of the nacos StatefulSet is set to 2, In the cluster file only two nacos address

• Use kubectl to scale StatefulSets

kubectl scale sts nacos --replicas=3

• Use kubectl exec to get the cluster config of the Pods in the nacos StatefulSet after scale StatefulSets

for i in 0 1 2; do echo nacos-$i; kubectl exec nacos-$i -- cat conf/cluster.conf; done

Prerequisites

• Kubernetes Node configuration(for reference only)

• Kubernetes version：1.19+
• NFS version：4.1+

Limitations

• Persistent Volumes must be used. emptyDirs will possibly result in a loss of data

Project directory

Configuration properties

• nacos-pvc-nfs.yaml or nacos-quick-start.yaml

• nfs deployment.yaml

• mysql yaml