netboxipcontroller

NetBox IP Controller

This controller watches Kubernetes pods and services and imports their IPs, along with some metadata such as domain names and Kubernetes labels, into NetBox.

Configuration

Controller configuration may be specified with either flags or environment variables, with flags taking precedence. For each of the flags listed below, the corresponding environment variable is all-uppercase with dashes (-) replaced with underscores (_).

Running locally

The most basic setup includes a NetBox and Kubernetes apiserver to connect to. The controller will be using current-context from the specified kubeconfig:

go get github.com/digitalocean/netbox-ip-controller/cmd/netbox-ip-controller
netbox-ip-controller --kube-config=/.kube/config --netbox-api-url=https://some-netbox.example.com/api --netbox-token=<your-token> \
  

Running integration tests locally

Integration tests can be run locally by using the integration-test make target. This sets up, executes, and cleans up the integration test. Alternatively, you can use the setup, execute, and cleanup targets individually, which can be helpful for leaving the netbox environment up after executing tests for debugging.

Install

A sample deployment for running in-cluster can be found at docs/example-deployment.yml. Note that the controller will only export the IPs of the pods and services that have at least one of --pod-publish-labels or --service-publish-labels respectively set.

If you have RBAC enabled in the cluster, you will also need docs/rbac.yml.

Docker images are automatically built and distributed for each release and can be found at digitalocean/netbox-ip-controller:<tag>. Image tags will always correspond to a release's version number.

Alternatively, you can build and host the image yourself. After cloning the repo, build and push the docker image:

docker build -t <username>/netbox-ip-controller:<tag> ./cmd/netbox-ip-controller/
docker push <username>/netbox-ip-controller:<tag>

and use <username>/netbox-ip-controller:<tag> in your deployment manifest.

Uninstall

After stopping netbox-ip-controller, the IP addresses published to NetBox by the controller will remain. You can perform cleanup by running netbox-ip-controller clean, which will delete the IPs from NetBox and remove NetBoxIP custom resource objects from the cluster. Make sure to supply the same netbox-api-url, netbox-token, and kube-config (if any) as those used by the running controller.

Contributing

Contributions are welcome and appreciated. To help us review code and resolve issues faster, please follow the guidelines.

License

Copyright 2022 DigitalOcean

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.