Skip to content

Commit

Permalink
docs: Add translations of 'deploy_radondb-mysql_operator_on_k8s.md' a…
Browse files Browse the repository at this point in the history 
…nd 'deploy_radondb-mysql_operator_on_rancher.md'

Signed-off-by: Patrick-LuoYu <[email protected]>
  • Loading branch information
@patrickluoyu
patrickluoyu committed Mar 30, 2022
1 parent a6386c7 commit 4b5c926
Show file tree
Hide file tree
Showing 2 changed files with 403 additions and 0 deletions.
196 changes: 196 additions & 0 deletions docs/en-us/deploy_radondb-mysql_operator_on_k8s.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
Contents
===

* [Install a RadonDB MySQL Cluster on Kubernetes](#install-a-radondb-mysql-cluster-operator-on-kubernetes)
* [Introduction](#introduction)
* [Prerequisites](#prerequisites)
* [Procedure](#procedure)
* [Step 1: Add a Helm Repository](#step-1-add-a-helm-repository)
* [Step 2: Install Operator](#step-2-install-operator)
* [Step 3: Install a RadonDB MySQL Cluster](#step-3-install-a-radondb-mysql-cluster)
* [Verification](#verification)
* [Verify RadonDB MySQL Operator](#verify-radondb-mysql-operator)
* [Verify the RadonDB MySQL Cluster](#verify-the-radondb-mysql-cluster)
* [Access RadonDB MySQL](#access-radondb-mysql)
* [Uninstallation](#uninstallation)
* [Uninstall Operator](#uninstall-operator)
* [Uninstall RadonDB MySQL](#uninstall-radondb-mysql)
* [Uninstall the Custom Resources](#uninstall-the-custom-resources)

# Install a RadonDB MySQL Cluster (Operator) on Kubernetes

## Introduction

RadonDB MySQL is an open-source, highly available, and cloud-native database cluster solution based on MySQL. It supports a high availability (HA) architecture with one leader node and multiple follower nodes, and supports a full set of management features such as security, automatic backup, monitoring and alerting, and automatic scaling. RadonDB MySQL has been widely used in production by enterprises such as banks, insurance enterprises, and other traditional large enterprises.

RadonDB MySQL can be installed and managed on Kubernetes so that tasks relevant to RadonDB MySQL clusters are run automatically.

This tutorial demonstrates how to install a RadonDB MySQL cluster (Operator) on Kubernetes.

## Prerequisites

* You need to prepare a Kubernetes cluster.

## Procedure

### Step 1: Add a Helm Repository

```shell
helm repo add radondb https://radondb.github.io/radondb-mysql-kubernetes/
```

Check that a chart named `radondb/mysql-operator` exists in the repository.

```shell
$ helm search repo
NAME CHART VERSION APP VERSION DESCRIPTION
radondb/mysql-operator 0.1.0 v2.1.0 Open Source，High Availability Cluster，based on MySQL
```

### Step 2: Install Operator

The following sets the release name to `demo` and creates a [deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) named `demo-mysql-operator`.

```
helm install demo radondb/mysql-operator
```

> **Note**
>
> This step also creates the [CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) required by the cluster.
### Step 3: Install a RadonDB MySQL Cluster

Run the following command to create an instance of the `mysqlclusters.mysql.radondb.com` CRD and thereby create a RadonDB MySQL cluster by using the default parameters. You can customize the cluster parameters by referring to [Configuration Parameters](../zh-cn/config_para.md).

```kubectl
kubectl apply -f https://github.com/radondb/radondb-mysql-kubernetes/releases/latest/download/mysql_v1alpha1_mysqlcluster.yaml
```

## Verification

### Verify RadonDB MySQL Operator

Run the following command to check the `demo` deployment and its monitoring service. If the following information is displayed, the installation is successful.

```kubectl
$ kubectl get deployment,svc
NAME READY UP-TO-DATE AVAILABLE AGE
demo-mysql-operator 1/1 1 1 7h50m
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/mysql-operator-metrics ClusterIP 10.96.142.22 <none> 8443/TCP 8h
```

### Verify the RadonDB MySQL Cluster

Run the following command to check the CRDs:

```kubectl
$ kubectl get crd | grep mysql.radondb.com
backups.mysql.radondb.com 2021-11-02T07:00:01Z
mysqlclusters.mysql.radondb.com 2021-11-02T07:00:01Z
mysqlusers.mysql.radondb.com 2021-11-02T07:00:01Z
```

Run the following command to check the cluster. If a statefulset of three replicas (RadonDB MySQL nodes) and services used to access the nodes are displayed, the installation is successful.

```kubectl
$ kubectl get statefulset,svc
NAME READY AGE
sample-mysql 3/3 7h33m
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/sample-follower ClusterIP 10.96.131.84 <none> 3306/TCP 7h37m
service/sample-leader ClusterIP 10.96.111.214 <none> 3306/TCP 7h37m
service/sample-mysql ClusterIP None <none> 3306/TCP 7h37m
```

## Access RadonDB MySQL

> **Note**
>
> You need to prepare a client used to connect to MySQL.
- If the client is installed in a different Kubernetes cluster from the database, you need to configure port forwarding rules and load balancing by referring to [Access Applications in a Cluster](https://kubernetes.io/docs/tasks/access-application-cluster/).

- In the Kubernetes cluster, you can access RadonDB MySQL by using service names or cluster IP addresses.

> **Note**
>
> RadonDB MySQL provides a leader service and a follower service, which are used to access the leader node and follower nodes respectively. The leader service always points to the leader node that supports read and write, and the follower service always points to the follower nodes that are read-only.
The following demonstrates how to access RadonDB MySQL by using a client in the same Kubernetes cluster as the database.

### Use a Cluster IP Address

The HA read-and-write IP address of RadonDB MySQL points to the cluster IP address of the leader service, and the HA read-only IP address points to the IP address of the follower service.

```shell
mysql -h <clusterIP> -P <mysql_Port> -u <user_name> -p
```

For example, run the following command to access the leader service, where the username is `radondb_usr` and the cluster IP address of the leader service is `10.10.128.136`:

```shell
mysql -h 10.10.128.136 -P 3306 -u radondb_usr -p
```

### Use a Service Name

Pods in the Kubernetes cluster can access RadonDB MySQL by using a service name.

> **Note**
>
> Service names cannot be used to access RadonDB MySQL from the host machines of the Kubernetes cluster.
* Access the leader service (RadonDB MySQL leader node)

```shell
mysql -h <leader_service_name>.<namespace> -u <user_name> -p
```

For example, run the following command to access the leader service, where the username is `radondb_usr`, the release name is `sample`, and the namespace of RadonDB MySQL is `default`:

```shell
mysql -h sample-leader.default -u radondb_usr -p
```

* Access the follower service (RadonDB MySQL follower nodes)

```shell
mysql -h <follower_service_name>.<namespace> -u <user_name> -p
```

For example, run the following command to access the follower service, where the username is `radondb_usr`, the release name is `sample`, and the namespace of RadonDB MySQL is `default`:

```shell
mysql -h sample-follower.default -u radondb_usr -p
```

## Uninstallation

### Uninstall Operator

Uninstall RadonDB MySQL Operator with the release name `demo` in the current namespace.

```shell
helm delete demo
```

### Uninstall RadonDB MySQL

Uninstall the RadonDB MySQL cluster with the release name `sample`.

```kubectl
kubectl delete mysqlclusters.mysql.radondb.com sample
```

### Uninstall the Custom Resources

```kubectl
kubectl delete customresourcedefinitions.apiextensions.k8s.io mysqlclusters.mysql.radondb.com
kubectl delete customresourcedefinitions.apiextensions.k8s.io mysqlusers.mysql.radondb.com
kubectl delete customresourcedefinitions.apiextensions.k8s.io backups.mysql.radondb.com
```
Loading

0 comments on commit 4b5c926

Please sign in to comment.