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 register and manage Kubernetes services to Google Cloud's Service Directory. The project and region must be provided in the ConfigMap, and the service account file must be provided as a Secret. Please follow this section to learn how to set up the operator and provide such files.

Try It Out

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

Documentation

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