K4Indie (Kay-for-Indie)_ is a Kubernetes operator to simplify the deployment of applications to Kubernetes.
🚧🚧 This is not production ready and is still heavily a work in progress. Check the open issues for WIP and Roadmap 🚧🚧
K4Indie is focused on bringing a simple Heroku-like experience to deploy and run applications. This makes it a perfect candidate to run your application on cheap cloud-hosted Kubernetes platforms like DigitalOcean.
It exports a Custom Resource named Application that can be used to define an application's requirement.
After the Application resource is applied to the Kubernetes cluster, K4Indie will set up all the required native resources to ensure your application is running and accessible to the internet (in cases where that is necessary).
First, install this operator and its custom resource definitions in your cluster:
TBD: It is yet to be packaged for re-distribution, but you can the instructions on the 'Deploying to the Cluster' for how to deploy from this repository
Next, to make your application accessible to the internet, you'll need to install an Ingress controller. An easy one to install is nginx-ingress.
The step to install ingress controller will not be required in upcoming releases because it will be bundled as part of K4Indie.
The Kubernetes cluster is not ready to deploy applications. There are sample application definitions in the config/samples. Try deploying the nginx sample application by running the following command:
kubectl apply -f config/samples/operators_v1alpha1_nginx.yaml
Visit port 8080 of the cluster's IP address to preview the application.
The major resource for managing application workloads is the Application resource.
A proper specification document coming up soon. In the meantime, the OpenAPI Schema can be found here. Also, explore the
config/samplesdirectory for some example Application definitions.
You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster.
Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).
Before making a contribution, please open an issue to discuss your plans and get feedback.
- Install Instances of Custom Resources:
kubectl apply -f config/samples/- Build and push your image to the location specified by
IMG:
make docker-build docker-push IMG=<some-registry>/operator:tag- Deploy the controller to the cluster with the image specified by
IMG:
make deploy IMG=<some-registry>/operator:tagTo delete the CRDs from the cluster:
make uninstallUnDeploy the controller from the cluster:
make undeployThis project aims to follow the Kubernetes Operator pattern.
It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
- Install the CRDs into the cluster:
make install- Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make runNOTE: You can also run this in one step by running: make install run
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
make manifestsNOTE: Run make --help for more information on all potential make targets
More information can be found via the Kubebuilder Documentation
Copyright 2023.
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.