ipxe-operator

The iPXE Operator is a Kubernetes controller designed to streamline the management of iPXE infrastructure within Kubernetes environments. This operator simplifies network booting processes by automating iPXE script generation and ignition content delivery based on Kubernetes Custom Resource Definitions (CRDs).

Key Components

• IPXE HTTP Server: Serves dynamic iPXE scripts and ignition content through HTTP endpoints, tailored to individual machine specifications.

• Reconciler: Configures the IPXE HTTP Server based on the desired state specified in IPXEBootConfiguration CRDs, ensuring the server's configuration aligns with cluster resources.

• Translator (Optional): Converts BootConfiguration CustomResources from MetalAPI provided by Ironcore into the format expected by the iPXE Operator, enhancing integration capabilities.

HTTP Server Endpoints

• /ignition/{UUID}: Matches an IPXEBootConfiguration using the provided {UUID} (Spec.systemUUID) and serves the associated ignition content.

• /ipxe: Identifies the corresponding IPXEBootConfiguration based on the requester's system IP (Spec.SystemIP). It then renders the templates/ipxe-script.tpl with values from the CRD (e.g., KernelURL, InitrdURL, SquashfsURL) and returns the customized iPXE script.

Getting Started

Prerequisites

• go version v1.21.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>/ipxe-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>/ipxe-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 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 are the steps to build the installer and distribute this project to users.

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

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

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>/ipxe-operator/<tag or branch>/dist/install.yaml

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

More information can be found via the Kubebuilder Documentation

Roadmap

Looking ahead, the iPXE Operator aims to introduce a range of enhancements to further empower Kubernetes-driven infrastructure provisioning:

• Configurable iPXE Scripts: Enable customization of iPXE script templates to accommodate diverse booting requirements.

• Custom Image Registry Support: Dynamically generate URLs for the kernel, initrd, and squashfs images from a specified image registry, facilitating streamlined updates and deployments.

• Expanded Endpoints: Introduce additional endpoints, such as /ztp for Zero Touch Provisioning of switches and /certs for certificate management, broadening the operator's utility.

• Enhanced Indexing: Implement indexing based on MAC addresses in addition to the existing SystemUUID and SystemIP, offering more granular control and identification of network boot targets.

Contributing

We'd love to get feedback from you. Please report bugs, suggestions or post questions by opening a GitHub issue.

License

Copyright 2024.

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.