Skip to content

Register your Kubernetes Services to a service registry of your choice and manage them automatically.

License

Notifications You must be signed in to change notification settings

CloudNativeSDWAN/cnwan-operator

Repository files navigation

CN-WAN Operator

GitHub GitHub go.mod Go version Go Report Card Kubernetes version GitHub Workflow Status GitHub release (latest SemVer including pre-releases) Docker Image Version (latest SemVer) DevNet published

Register and manage your Kubernetes Services to a Service Registry.

The CN-WAN Operator is part of the Cloud Native SD-WAN (CN-WAN) project. Please check the CN-WAN documentation for the general project overview and architecture. You can contact the CN-WAN team at [email protected].

Overview

CN-WAN Operator is a Kubernetes operator created with Kubebuilder that watches for changes in services deployed in your cluster and registers them to a service registry so that clients can later discover all registered services and know how to connect to them properly.

The service registry is populated with only the allowed resources and properties, as specified from a configuration file.

Supported Service Registries

Currently, the CN-WAN Operator can use the popular key-value storage etcd as a service registry or use other commercial solutions like Google Cloud's Service Directory.

We have a document about this topic so that you can learn more about it and we recommend you to read: Service registry.

If you're undecided or don't know which one to use or just want to try the project, you can try with etcd.

Try It Out

If you want to quickly see how CN-WAN Operator works, you can follow this simple step by step quickstart with etcd guide.

Documentation

etcd

Google Service Directory

AWS Cloud Map

Contributing

Thank you for interest in contributing to this project. Before starting, please make sure you know and agree to our Code of conduct.

  1. Fork it
  2. Download your fork git clone https://github.com/your_username/cnwan-operator && cd cnwan-operator
  3. Create your feature branch git checkout -b my-new-feature
  4. Make changes and add them git add .
  5. Commit your changes git commit -m 'Add some feature'
  6. Push to the branch git push origin my-new-feature
  7. Create new pull request to this repository

License

CN-WAN Operator is released under the Apache 2.0 license. See LICENSE