README
¶
network-operator
network-operator is a Kubernetes operator for automating network device provisioning.
Description
Network-operator is a project built using Kubebuilder and controller-runtime to facilitate the provisioning of network devices. It provides a robust and scalable solution for managing networking infrastructure, ensuring seamless integration and automation within Kubernetes environments.
Getting Started
Prerequisites
- go version v1.27.0+
- docker version 28+.
- kubectl version v1.33.1+.
- Access to a Kubernetes v1.33.0+ cluster.
- Git LFS installed (
git lfs install) - kind version 0.32.0+
- Tilt version v0.37.3+
- gh version 2.93.0+
- coreutils 9.11+
To Deploy on the cluster
Build your image to the tag specified by IMG:
make docker-build IMG=<some-registry>/network-operator:tag
NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.
Install the CRDs into the cluster:
make install
Deploy the Manager to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/network-operator:tag
NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.
Create instances of your solution You can apply the samples (examples) from the config/sample:
kubectl apply -k config/samples/
NOTE: Ensure that the samples have default values to test it out.
To Uninstall
Delete the instances (CRs) from the cluster:
kubectl delete -k config/samples/
Delete the APIs(CRDs) from the cluster:
make uninstall
UnDeploy the controller from the cluster:
make undeploy
kubectl Plugin
The kubectl-net plugin extends kubectl with shorthand flags and resource lifecycle operations tailored to network-operator.
kubectl net get interfaces --device leaf1
kubectl net pause devices leaf1 --recursive
See kubectl-net/README.md for installation and full usage documentation.
Project Distribution
Following are the steps to build the installer and distribute this project to users.
- Build the installer for the image built and published in the registry:
make build-installer IMG=<some-registry>/network-operator:tag
NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.
- Using the installer
Users can just run kubectl apply -f to install the project, i.e.:
kubectl apply -f https://raw.githubusercontent.com/<org>/network-operator/<tag or branch>/dist/install.yaml
Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright 2025 SAP SE or an SAP affiliate company and IronCore contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
cisco/nx/v1alpha1
Package v1alpha1 contains API Schema definitions for the nx.cisco.networking.metal.ironcore.dev v1alpha1 API group.
|
Package v1alpha1 contains API Schema definitions for the nx.cisco.networking.metal.ironcore.dev v1alpha1 API group. |
|
cisco/xe/v1alpha1
Package v1alpha1 contains API Schema definitions for the xe.cisco.networking.metal.ironcore.dev v1alpha1 API group.
|
Package v1alpha1 contains API Schema definitions for the xe.cisco.networking.metal.ironcore.dev v1alpha1 API group. |
|
cisco/xr/v1alpha1
Package v1alpha1 contains API Schema definitions for the xr.cisco.networking.metal.ironcore.dev v1alpha1 API group.
|
Package v1alpha1 contains API Schema definitions for the xr.cisco.networking.metal.ironcore.dev v1alpha1 API group. |
|
core/v1alpha1
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0
|
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0 |
|
evpn/v1alpha1
Package v1alpha1 contains API Schema definitions for the evpn.networking.metal.ironcore.dev v1alpha1 API group.
|
Package v1alpha1 contains API Schema definitions for the evpn.networking.metal.ironcore.dev v1alpha1 API group. |
|
pool/v1alpha1
Package v1alpha1 contains API Schema definitions for the pool.networking.metal.ironcore.dev v1alpha1 API group.
|
Package v1alpha1 contains API Schema definitions for the pool.networking.metal.ironcore.dev v1alpha1 API group. |
|
hack
|
|
|
decrypt-backup
command
Command decrypt-backup retrieves a remote ConfigBackup from S3 and decrypts it.
|
Command decrypt-backup retrieves a remote ConfigBackup from S3 and decrypts it. |
|
nxapi
command
nxapi is a minimal CLI tool for sending NX-API JSON-RPC commands to a Cisco NX-OS device and printing the results.
|
nxapi is a minimal CLI tool for sending NX-API JSON-RPC commands to a Cisco NX-OS device and printing the results. |
|
provider
command
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0
|
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0 |
|
internal
|
|
|
apistatus
Package apistatus provides a typed structured error for provider implementations.
|
Package apistatus provides a typed structured error for provider implementations. |
|
clientutil
Package clientutil provides a client wrapper for the controller-runtime client with convenience functions.
|
Package clientutil provides a client wrapper for the controller-runtime client with convenience functions. |
|
conditions
Package conditions provides utilities for managing status conditions on Kubernetes API objects.
|
Package conditions provides utilities for managing status conditions on Kubernetes API objects. |
|
controller/pool
Package pool contains controllers for the pool.networking.metal.ironcore.dev API group.
|
Package pool contains controllers for the pool.networking.metal.ironcore.dev API group. |
|
deviceutil
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0
|
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0 |
|
objectstorage
Package objectstorage provides a client for uploading, listing, and deleting objects on S3-compatible object stores.
|
Package objectstorage provides a client for uploading, listing, and deleting objects on S3-compatible object stores. |
|
paused
Package paused implements helper functions for managing the Paused condition on API objects.
|
Package paused implements helper functions for managing the Paused condition on API objects. |
|
provider
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0
|
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0 |
|
provider/cisco/iosxr
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0
|
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0 |
|
provider/cisco/nxos
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0
|
SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and IronCore contributors SPDX-License-Identifier: Apache-2.0 |
|
provider/openconfig
Package openconfig implements provider support for OpenConfig-compliant devices using gNMI (e.g.
|
Package openconfig implements provider support for OpenConfig-compliant devices using gNMI (e.g. |
|
resourcelock
Package resourcelock provides utilities for locking Kubernetes resources using Leases.
|
Package resourcelock provides utilities for locking Kubernetes resources using Leases. |
|
tftp
Package tftpserver implements a simple TFTP server for serving boot scripts to devices during provisioning.
|
Package tftpserver implements a simple TFTP server for serving boot scripts to devices during provisioning. |
|
transport/gnmiext
Package gnmiext provides a gNMI client with device capability awareness and configuration management utilities.
|
Package gnmiext provides a gNMI client with device capability awareness and configuration management utilities. |
|
transport/grpcext
Package grpcext provides convenience functions and types for working with gRPC clients.
|
Package grpcext provides convenience functions and types for working with gRPC clients. |
|
transport/nxapi
Package nxapi provides a JSON-RPC client for Cisco NX-OS devices via NX-API.
|
Package nxapi provides a JSON-RPC client for Cisco NX-OS devices via NX-API. |
|
kubectl-net
module
|
|
|
test
|
|