Skip to content

Latest commit

 

History

History
65 lines (51 loc) · 2.42 KB

README.md

File metadata and controls

65 lines (51 loc) · 2.42 KB
Raw

Docker Artifact Hub

Helm Operator

Helm operator is a helm based operator using the Operator SDK.

The operator takes CRDs crds and charts from helm-charts and when a user creates a Custom Resource defined by the CRDs the operator deployes the corresponding helm chart.

Installation

Make your code changes and create a PR.

Testing

Using a test cluster

If adding new CRDs or charts in helm-charts make sure to build the new docker image and push it to your docker registry.

docker-compose build
docker push bgrigorov/helm-operator:test

Setup your KUBECONFIG env var and install the helm-operator helm chart

helm upgrade -i helm-operator charts/ -f charts/values.test.yaml

Local

  1. If you wish to run operator locally, install the crds manually
kubectl apply -f charts/templates/crds/

  1. Set your KUBECONFIG env variable

  2. Then you can run the operator with either docker-compose up -d or make run.

Testing the managed helm charts

Install the helm-chart managed by the operator

helm upgrade -i pgexp helm-charts/myexporter/ -f helm-charts/myexporter/values.test.yaml

Navigate to localhost:8080/metrics to see the exposed metrics. You can also connect to the mock DB that is running inside a sidecar container in the exporter pod and run some queries.

Creating Custom Resources

kubectl apply -f samples/myexporter.yaml
kubectl get pgx

Adding new CRDs

  1. Define and add your CRD in crds.
  2. Add resources to role.
  3. Add the corresponding helm chart in helm-charts. Make sure the names match.
  4. Add a sample in samples.
  5. Add watcher to watches.yaml.

Github Pages Website

helm lint chart/
helm package chart/
helm repo index --url https://bsgrigorov.github.io/helm-operator/ .

Add the package and index.yaml to branch gh-pages, commit and push.

TODO

Add github workflow files for pushing docker images and helm charts