Cluster List

Create Cluster

The following scenarios are recommended to use multiple API7 Gateway clusters:

1. Isolate the test environment and production environment by creating API7 Gateway test clusters and API7 Gateway production clusters separately.
2. Isolate different businesses and create API7 Gateway clusters according to business divisions, such as intranet API7 Gateway clusters or public network API7 Gateway clusters.

• Each API7 Gateway cluster corresponds to an independent Control Plane.
• Each API7 Gateway cluster will have one or more Data Plane nodes. Different API7 Gateway clusters cannot share the same Data Plane node.
• Each API7 Gateway cluster needs to independently configure user role permissions.
• If an API7 Gateway cluster fails, other clusters aren't affected.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on Create button.
5. Fill in the form.
6. Click on Add button.

caution

So far the cluster only has a Control Plane node, and there is no Data Plane node yet. Even if upstream and routing are created, they cannot take effect. You need to refer to the "Copy Cluster Information" operation to add Data Plane nodes, so that the API7 Gateway cluster can actually run and receive business traffic.

Copying Cluster Information

Copy the etcd configuration information from a cluster to a gateway data plane node, and then add that data plane node to the corresponding cluster.

If the cluster is in an abnormal state and cannot connect to etcd resources, the copied cluster information will not take effect.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on More button for the corresponding cluster in the list, and then select Copy cluster info from the drop-down menu.
5. Install the API7-Gateway data plane component on a new node.
6. After successfully installing the API7-Gateway, modify the configure file:

vim /usr/local/apisix/conf/config.yaml

etcd:
  host:
    - "http://api7-dashboard-etcd.api7.svc.cluster.local:2379"
  prefix: "/api7/452869103972058061"
  timeout: 30

7. Restart API7-Gateway:

# RPM installation
apisix restart

# docker installation
docker restart ${containerID}

# k8s installation
kubectl delete pod ${podID} -n ${namespace}

Authorizing Cluster Roles

Grant specific operations on a designated cluster to a certain user.

• Only one cluster can be authorized for each operation, and different cluster roles need to be authorized separately.
• Each user can have any number of roles in the same cluster, even if these roles have overlapping permissions.
• Only individual users can be authorized for role authorization, and authorization for user groups/service accounts is not supported at this time.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on More button for the corresponding cluster in the list, and then click on Authorize in the drop-down menu.
5. Select the user to be authorized.
6. Select the role to be authorized.
7. Click on Update button.

Configure Cluster

Edit the cluster name and cluster description of a cluster.

Cannot modify the etcd resource of a cluster.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on More button of the corresponding cluster and select Configure from the drop-down menu.
5. Edit the cluster name/cluster desc of the cluster or replace the etcd resource of the cluster.
6. Click on Submit button.

Delete Cluster

The API7 Gateway cluster is no longer in use.

• The cluster cannot be recovered after deletion.
• Deleting the cluster only destroys the control plane and clears all the configuration in the etcd, but does not destroy the etcd cluster and the data plane nodes themselves. Although the data plane nodes still exist, the gateway cluster cannot continue to operate because it cannot obtain the configuration in the etcd.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on More button of the corresponding cluster, and then Click on Delete button in the drop-down menu.
5. Confirm that there is no impact on the business and enter the cluster name for confirmation.
6. Click on Confirm button.