# openGauss-operator

**Repository Path**: waterme7on/openGauss-operator

## Basic Information

- **Project Name**: openGauss-operator
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-03-03
- **Last Updated**: 2022-07-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# openGauss-operator

The openGauss-operator uses the [client-go](https://github.com/kubernetes/client-go) library to develop a custom controller monitoring, scheduling and updating openGauss cluster in kubernetes.

### Table of Content

- [Build & Run](#Build-&-Run)
- [Structure](#Structure)
- [Develop](#Develop)


## 1. Build & Run
### Deploy Prometheus Monitoring

Use prometheus to monitor the pod and node status.

Follow [kube-prometheus quick start](https://github.com/prometheus-operator/kube-prometheus#quickstart) to install prometheus stack.

### Generate code
Before generating code, make sure your project is in a directory with path `xxx/github.com/waterme7on/`.

Fetch code-generator repo and execute script.

```sh
go mod vendor
./hack/update-codegen.sh
```

### Deploy OpenGauss controller

Fetch the project
```sh
git clone https://github.com/waterme7on/openGauss-operator.git
cd openGauss-operator
```

Build and Run in Process
```sh
go build -o controller .
# kubeconfig won't be needed if run in-cluster
./controller -kubeconfig=$HOME/.kube/config
```

Or Run in Deploymente
```sh
kubectl apply -f manifests manifests/serviceaccount.yaml 
kubectl apply -f manifests/deploy.yaml
```


Create Crd and example OpenGauss cluster

```sh
# create openGauss CustomResourceDefination
kubectl create -f manifests/crd.yaml
# create a openGauss object
kubectl create -f example/opengauss.yaml
```

Check status

```sh
# check all the components of opengauss defined by example
kubectl get all | grep opengauss
```


## 2. Structure

data flow and logic graph

![](./docs/diagrams/logic.png)

<br>

components

![](./docs/diagrams/operator.png)

<br>

## 3. Develop

### Contributions

1. modify
2. git checkout -b xxx
3. git push origin xxx:feat_xxx
4. pull request

### Use code-generator to update apis

Use [code-generator](https://github.com/kubernetes/code-generator) to update code if you want to modify openGauss apis.

You may need to manually install [code-generator](https://github.com/kubernetes/code-generator) or use command `go mod vendor` to create and populate `vendor` diretory to get the source file.

Build command:

```sh
# get the code-generator
go mod vendor
# or use command "go get k8s.io/code-generator"

# update apis
bash hack/update-codegen.sh
# then build and run
```

### [client-go under the hood](https://github.com/kubernetes/sample-controller/blob/master/docs/controller-client-go.md)

how the various components in the [client-go](https://github.com/kubernetes/client-go) library work and their interaction points with the custom controller code

![](./docs/diagrams/client-go-controller-interaction.jpeg)

### grpc code generate

For protoc installation and instructions, see [grpc in go](https://grpc.io/docs/languages/go/)

```sh
cd rpc
protoc --go_out=. --go_opt=paths=source_relative     --go-grpc_out=. --go-grpc_opt=paths=source_relative    protobuf/clients.proto
```