README
¶
CN-WAN Operator
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 cnwan@cisco.com.
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
- Quickstart with etcd
- Concepts
- Cluster setup
- Example interactions with etcd
- Configure CN-Operator with etcd
Google Service Directory
Contributing
Thank you for interest in contributing to this project.
Before starting, please make sure you know and agree to our Code of conduct.
- Fork it
- Download your fork
git clone https://github.com/your_username/cnwan-operator && cd cnwan-operator - Create your feature branch
git checkout -b my-new-feature - Make changes and add them
git add . - Commit your changes
git commit -m 'Add some feature' - Push to the branch
git push origin my-new-feature - Create new pull request to this repository
License
CN-WAN Operator is released under the Apache 2.0 license. See LICENSE
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package controllers contains code that implements the reconcile pattern, where a specific resource kind is monitored and when a relevant change is detected, it is processed and the appropriate actions are taken to bring the current state to the desired one.
|
Package controllers contains code that implements the reconcile pattern, where a specific resource kind is monitored and when a relevant change is detected, it is processed and the appropriate actions are taken to bring the current state to the desired one. |
|
internal
|
|
|
types
Package types contains some types or constants that are used throughout the whole program.
|
Package types contains some types or constants that are used throughout the whole program. |
|
utils
Package utils contains some utility code that can be reused by many components or whose purpose does not really fit the other packages, so it is moved here to keep some separation of concerns.
|
Package utils contains some utility code that can be reused by many components or whose purpose does not really fit the other packages, so it is moved here to keep some separation of concerns. |
|
pkg
|
|
|
servregistry
Package servregistry holds code and types that are useful/implemented by service registries.
|
Package servregistry holds code and types that are useful/implemented by service registries. |
|
servregistry/etcd
Package etcd connects to an etcd cluster to perform service registry operations.
|
Package etcd connects to an etcd cluster to perform service registry operations. |
|
servregistry/gcloud/servicedirectory
Package servicedirectory contains code that connects to Google Cloud Service Directory and performs some actions with specific resources.
|
Package servicedirectory contains code that connects to Google Cloud Service Directory and performs some actions with specific resources. |