Skip to content

knabben/tkw

Repository files navigation

Image Builder OVA Windows

This controller builds a new Windows OVA template using the image builder project. It uses the image-builder and burrito (windows-resource-bundle) to provide the required binaries for your plain installation. This works fully on airgap and Internet restricted environments, all it's needed is to run the controller on a TKG cluster and the controller will figure out the configurations required to build the image, you can still specify and overwrite any parameter.

Getting Started

You’ll need a Tanzu Kubernetes Grid cluster to run against. This will be available as a Tanzu package on next PR.

Running on the cluster

  1. Install Instances of Custom Resources, you can install the CR from the samples folder, change any parameter from the API spec:
kubectl apply -f config/samples/
  1. Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/tkw:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/tkw:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

Run, test and open a PR or issues with a detailed procedure to replicate

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Development

  1. Install the CRDs into the cluster:
make install
  1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run

Use tilt for automatic reload based on changes:

make tilt

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

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

More information can be found via the Kubebuilder Documentation

License

Copyright 2022.

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.