Adding Documentation in Readme

Adding Documentation in Readme

Change-Id: Id16c746b802c02e16a2a187d8fd69ddbd5e74fd6
Signed-off-by: naman.gupta <naman.gupta@samsung.com>

diff --git a/depRicKubernetesOperator/README.md b/depRicKubernetesOperator/README.md
index e69de29..a026b03 100644 (file)
--- a/depRicKubernetesOperator/README.md
+++ b/depRicKubernetesOperator/README.md
@@ -0,0 +1,94 @@
+# depriclatest26oct\r
+// TODO(user): Add simple overview of use/purpose\r
+\r
+## Description\r
+// TODO(user): An in-depth paragraph about your project and overview of use\r
+\r
+## Getting Started\r
+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.\r
+**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).\r
+\r
+### Running on the cluster\r
+1. Install Instances of Custom Resources:\r
+\r
+```sh\r
+kubectl apply -f config/samples/\r
+```\r
+\r
+2. Build and push your image to the location specified by `IMG`:\r
+\r
+```sh\r
+make docker-build docker-push IMG=<some-registry>/depriclatest26oct:tag\r
+```\r
+\r
+3. Deploy the controller to the cluster with the image specified by `IMG`:\r
+\r
+```sh\r
+make deploy IMG=<some-registry>/depriclatest26oct:tag\r
+```\r
+\r
+### Uninstall CRDs\r
+To delete the CRDs from the cluster:\r
+\r
+```sh\r
+make uninstall\r
+```\r
+\r
+### Undeploy controller\r
+UnDeploy the controller from the cluster:\r
+\r
+```sh\r
+make undeploy\r
+```\r
+\r
+## Contributing\r
+// TODO(user): Add detailed information on how you would like others to contribute to this project\r
+\r
+### How it works\r
+This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).\r
+\r
+It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),\r
+which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.\r
+\r
+### Test It Out\r
+1. Install the CRDs into the cluster:\r
+\r
+```sh\r
+make install\r
+```\r
+\r
+2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):\r
+\r
+```sh\r
+make run\r
+```\r
+\r
+**NOTE:** You can also run this in one step by running: `make install run`\r
+\r
+### Modifying the API definitions\r
+If you are editing the API definitions, generate the manifests such as CRs or CRDs using:\r
+\r
+```sh\r
+make manifests\r
+```\r
+\r
+**NOTE:** Run `make --help` for more information on all potential `make` targets\r
+\r
+More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)\r
+\r
+## License\r
+\r
+Copyright 2023.\r
+\r
+Licensed under the Apache License, Version 2.0 (the "License");\r
+you may not use this file except in compliance with the License.\r
+You may obtain a copy of the License at\r
+\r
+    http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+Unless required by applicable law or agreed to in writing, software\r
+distributed under the License is distributed on an "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+See the License for the specific language governing permissions and\r
+limitations under the License.\r
+\r