diff --git a/README.md b/README.md index 7e32e3c..9ce3bcc 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,33 @@ # entangle -// TODO(user): Add simple overview of use/purpose -## 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 entangle 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=/entangle: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 entangle +$ helm install kairos-entangle kairos/entangle ``` - -3. Deploy the controller to the cluster with the image specified by `IMG`: - -```sh -make deploy IMG=/entangle: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