Skip to content

Latest commit

 

History

History
133 lines (89 loc) · 4.33 KB

README.md

File metadata and controls

133 lines (89 loc) · 4.33 KB
Raw

ingress2acmebotreflector

A simple k8s controller that works with the https://github.com/shibayan/keyvault-acmebot project to move cert orders from inside the cluster to the outside. The application works from inside the cluster by watching all ingress resources and every time an ingress resource is changed or created it checks the acmebot api if a tls cert exists for the given ingress, and if not it orders a cert for the domain in question.

The image for the controller can be found on dockerhub: https://hub.docker.com/r/spvest/ingress2acmebotreflector

Description

// TODO(user): An in-depth paragraph about your project and overview of use

Getting Started

  1. Install keyvault acmebot in your azure environment
  2. Set up a the keyvault acmebot the expose an api through the azure portal
  3. Grant the managed-identity of the k8s cluster where the controller is access to the acmebot api
  4. Install the controller in your `k8s cluster`` by using either the helm chart or the sample deployment file in the project.

Build image

  1. Install Instances of Custom Resources:
kubectl apply -f config/deployment/samples/
  1. Build your image:
make docker-build docker-push IMG=<some-registry>/ingress2acmebotreflector:tag
  1. Push your image to the image repository location specified by IMG:
make docker-push docker-push IMG=<some-registry>/ingress2acmebotreflector:tag

Deploy to cluster from terminal

  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/ingress2acmebotreflector:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Helm

The helm repo for the helm chart chart/ingress2acmebotreflector is hosted by the github pages for this github repo. Add the repo locally:

helm repo add ingress2acmebotreflector-repo https://sparebankenvest.github.io/ingress2acmebotreflector/

Helm chart installation

The definition of the helm chart is found in the chart/ingress2acmebotreflector directory.

Install locally

  1. Clone repo locally: git clone git@github.com:SparebankenVest/ingress2acmebotreflector.git
  2. Go to chart directory: cd ingress2acmebotreflector/chart
  3. Insert required values in values.yaml.
  4. Install chart on cluster via helm: helm install my-ingress2acmebotreflector ingress2acmebotreflector

Install using self hosted helm repo

  1. Add helm repo: helm repo add <REPO-NAME> <REPO-URL>
  2. Install helm chart on cluster: helm install my-ingress2acmebotreflector <REPO-NAME>/ingress2acmebotreflector

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

  1. Install the CRDs into the cluster:
make install
  1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run

NOTE: You can also run this in one step by running: make install run

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

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.