macolso / spin-operator

Spin Operator is a Kubernetes operator that empowers platform engineers to deploy Spin applications as custom resources to their Kubernetes clusters

Spin Operator

The Spin Operator enables deploying Spin applications to Kubernetes. It watches SpinApp Custom Resources and realizes the desired state in the Kubernetes cluster. This project was built using the Kubebuilder framework and contains a Spin App CRD and controller.

Documentation

To learn more about the Spin Operator and the SpinKube organization, please visit the official Spin Operator documentation which is housed inside the the official SpinKube documentation.

At this point in the preview, we recommend testing Spin Operator on a local k3d cluster via make install. The quickstart guide will walk you through prequisites and the installation workflow.

Spin Operator installation via Helm chart for remote clusters while in private preview is WIP and can tracked here. In the meantime, please use the guidance from our quickstart guide.

Tutorials

There are a host of tutorials in the Spin Operator tutorials directory of the documentation. For example:

• Quickstart
• Running Locally
• Running on a remote (non-local) K8s cluster
• Deploying on Azure k8s service
• Scaling Spin Apps with Horizontal Pod Autoscaler (HPA)
• Scaling Spin Apps with Kubernetes Event Driver Autoscaler (KEDA)

Feedback

The remaining articles are under construction. You're welcome to view and open both Spin Operator and documentation issues and feature requests. As this work is under development, please note that current features, functionality and supporting documentation are likely to change as the projects evolve and improvements are made.

For questions or support, please visit our Discord channel.

Contributing (Spin Operator)

If you would like to contribute, please visit this contributing page.

Contributing (Documentation)

If you would like to contribute to SpinKube and Spin Operator, please visit this contributing page.

The documentation is written using Hugo (as the static site generator), Docsy (as the technical documentation template) and GitHub pages (for hosting). However, during construction (prior to the website being rendered and publicly available) you are welcome to run a local copy of the documentation using the hugo server command. You can do so by following these instructions.