Open questions:

• Do we want to build on-node? This lets us reuse the system Nix daemon, store, cache, etc., but also requires the node to have Nix installed. (Hard to test on seraphim, since kind’s nodes won’t have Nix.)

The controller will, eventually, be running in its own pod. It’ll need to access the Nix daemon somehow. If we wanted to do the build in a pod, it’d need to run a Nix daemon in there? Maybe?

The thing is, we’re only running one controller per cluster, or at most per control plane node (?); e.g. if enbi is running on cass only, then we can’t do any of the build steps in the controller itself anyway; we’ll want to be building on kala too!

So we do need to run in a pod; either we pass a socket to the docker daemon in, or run the build inside the container entirely. A socket would be nicer; it may be enough to just mount /nix (RO) and run with NIX_REMOTE=daemon. Forward NIX_PATH, and add the (resolved) path of the local nix binary to the container to find it in the store.

This still won’t work in our development environment on kind. Is supporting both foolish? Hope not. We can use nixos/nix to do the build without Nix on-node.

Let’s start with the dev one; first we need to acquire the source.

First: where/how do we do the clone? Need to spawn a pod which does the clone; then we need to store it somewhere. Controller probably needs its own PV, to keep clones in long-term.

Ideally we can have multiple builds on the same host, targetting the same clone, and one just waits while the other does the clone.

enbi

// TODO(user): Add simple overview of use/purpose

Description

// TODO(user): An in-depth paragraph about your project and overview of use

Getting Started

Prerequisites

• go version v1.23.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster.

To Deploy on the cluster

Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/enbi: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>/enbi: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 has 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

Project Distribution

Following the options to release and provide this solution to the users.

By providing a bundle with all YAML files

1. Build the installer for the image built and published in the registry:

make build-installer IMG=<some-registry>/enbi: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.

2. Using the installer

Users can just run ‘kubectl apply -f ’ to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/enbi/<tag or branch>/dist/install.yaml

By providing a Helm Chart

1. Build the chart using the optional helm plugin

kubebuilder edit --plugins=helm/v1-alpha

2. See that a chart was generated under ‘dist/chart’, and users can obtain this solution from there.

NOTE: If you change the project, you need to update the Helm Chart using the same command above to sync the latest changes. Furthermore, if you create webhooks, you need to use the above command with the ‘–force’ flag and manually ensure that any custom configuration previously added to ‘dist/chart/values.yaml’ or ‘dist/chart/manager/manager.yaml’ is manually re-applied afterwards.

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

NOTE: Run make help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2025.

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.