operator

README

Instaclustr Operator

The Instaclustr Operator allows users to deploy, scale and manage any one of data layer technologies deployed on the Instaclustr platform from Kubernetes.

Description

The Instaclustr Operator provides all the same functionality as the Instaclustr API, Instaclustr Console and Instaclustr terraform provider.

• Removes the need to write custom code integration directly with the Instaclustr API
• Use of existing Instaclustr authentication methodologies
• Declare Instaclustr infrastructure up front
• Scale, modify and change Instaclustr infrastructure with existing Kubernetes management tools / workflows
• Simplify Kubernetes native development workflow patterns (CI/CD integrations, production deployments etc).

C4 model diagrams

Context diagram	Container diagram	Component diagram

CRDs Relations

Getting Started

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).

Running on the cluster

1. Create the .env file, copy all content from the .env.tmpl and fill variables. When the operator deploys, it will create the secret from these variables to access the Instaclustr API.
2. Deploy the cert-manager:

make cert-deploy

1. Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/operator:tag

1. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/operator:tag

1. Install needed instances of Custom Resources:

kubectl apply -f config/samples/<resource-group>/<resource-name.yaml>

NOTE: You can also run IMG=<some-registry>/operator:tag make to simply install the controller

Uninstall CRDs

To delete all CRDs from the cluster:

make uninstall

Undeploy controller

Undeploy the controller from the cluster:

make undeploy

Undeploy cert-manager

Undeploy the cert manager:

make cert-undeploy

Contributing

We welcome all contributors. Please see our public contributing guidelines.

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

1. Run the controller tests:

make test

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2022.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.