Skip to content

Latest commit

 

History

History
98 lines (66 loc) · 2.99 KB

README.md

File metadata and controls

98 lines (66 loc) · 2.99 KB
Raw

kube-overlay-operator

This operator can create and manage simple overlay networks e.g. to connect to Pods via VPN or similar use cases. Networks are namespaced and can reuse the same CIDR.

Description

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

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. Install Instances of Custom Resources:
kubectl apply -f config/samples/
  1. Build and push your image to the location specified by IMG and IMG_TAG:
make docker-build-manager docker-build-sidecar docker-push-manager docker-push-sidecar IMG=<some-registry>/kube-overlay-operator IMG_TAG=tag

The resulting images will be ${IMG}/manager:${IMG_TAG} and ${IMG}/sidecar:${IMG_TAG}

  1. Deploy the controller to the cluster with the image specified by IMG and IMG_TAG:
make deploy IMG=<some-registry>/kube-overlay-operator IMG_TAG=tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

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 provides a reconcile function responsible for synchronizing resources untile 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 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.