From 4dcfcc417278bbed8f600d4714f985fefec670dc Mon Sep 17 00:00:00 2001 From: Ettore Di Giacinto Date: Fri, 23 Sep 2022 23:07:09 +0200 Subject: [PATCH] Update README.md --- README.md | 110 ++++++++++++------------------------------------------ 1 file changed, 23 insertions(+), 87 deletions(-) diff --git a/README.md b/README.md index 1d5e33f..34ab391 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,30 @@ -# osartifactbuilder-operator -// TODO(user): Add simple overview of use/purpose +# osbuilder -## Description -// TODO(user): An in-depth paragraph about your project and overview of use +| :exclamation: | This is experimental! | +|-|:-| -## Getting Started -You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/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). +This is the Kairos osbuilder Kubernetes Native Extension. -### Running on the cluster -1. Install Instances of Custom Resources: +To install, use helm: -```sh -kubectl apply -f config/samples/ ``` +# Adds the kairos repo to helm +$ helm repo add kairos https://kairos-io.github.io/helm-charts +"kairos" has been added to your repositories +$ helm repo update +Hang tight while we grab the latest from your chart repositories... +...Successfully got an update from the "kairos" chart repository +Update Complete. ⎈Happy Helming!⎈ -2. Build and push your image to the location specified by `IMG`: - -```sh -make docker-build docker-push IMG=/osartifactbuilder-operator:tag +# Install the CRD chart +$ helm install kairos-crd kairos/kairos-crds +NAME: kairos-crd +LAST DEPLOYED: Tue Sep 6 20:35:34 2022 +NAMESPACE: default +STATUS: deployed +REVISION: 1 +TEST SUITE: None + +# Installs osbuilder +$ helm install kairos-osbuilder kairos/osbuilder ``` - -3. Deploy the controller to the cluster with the image specified by `IMG`: - -```sh -make deploy IMG=/osartifactbuilder-operator:tag -``` - -### Uninstall CRDs -To delete the CRDs from the cluster: - -```sh -make uninstall -``` - -### Undeploy controller -UnDeploy the controller to the cluster: - -```sh -make undeploy -``` - -## Contributing -// TODO(user): Add detailed information on how you would like others to contribute to this project - -### How it works -This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) - -It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) -which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster - -### Test It Out -1. Install the CRDs into the cluster: - -```sh -make install -``` - -2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): - -```sh -make run -``` - -**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: - -```sh -make manifests -``` - -**NOTE:** Run `make --help` for more information on all potential `make` targets - -More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) - -## 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. -