TiFlow-Operator manages tiflow clusters on Kubernetes and automates tasks related to operating a tiflow cluster. It makes tiflow a truly cloud-native data migration platform.
// TODO(user): An in-depth paragraph about your project and overview of use
- go version is 1.18.4
- kubernetes version is 1.24.0
- docker version is 20.10.17, docker desktop is 4.10.1
- kubebuilder version is 3.5.0
- kustomize version is 4.5.5
You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).
- Install Instances of Custom Resources:
kubectl apply -f examples/- Build and push your image to the location specified by
IMG:
make docker-build docker-push IMG=<some-registry>/tiflow-operator:tag- Deploy the controller to the cluster with the image specified by
IMG:
make deploy IMG=<some-registry>/tiflow-operator:tagTo delete the CRDs from the cluster:
make uninstallUnDeploy the controller to the cluster:
make undeploy// TODO(user): Add detailed information on how you would like others to contribute to this project
This project aims to follow the Kubernetes Operator pattern
It uses Controllers which provides a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster
- Install the CRDs into the cluster:
make install- Deploy your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make runNOTE: You can also run this in one step by running: make install run
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifestsNOTE: Run make --help for more information on all potential make targets
More information can be found via the Kubebuilder Documentation
TiFlow-Operator is under the Apache 2.0 license. See the LICENSE file for details.