Add doc index and improve installation with helm support #173
Conversation
|
Hy team, do you need any additionnal change to validate this PR. I don't know if it's add some value to this project. Feel free to tell me if it's not the case or if you need additionnal change to make it usable for the community. |
|
@paigerube14 @chaitanyaenr do you see anything to change or refactoring from my site. I now it's only documentation, but do you think it could help others ? |
Update according to @pagerube14 review Minor update Add doc index and improve installation with helm support Update according to @pagerube14 review Minor update Add doc index and improve installation with helm support
|
@paigerube14 finish adding some more content according to your suggestions. If you need anything else, do not hesitate to tell me. |
| ## Workflow | ||
|
|
||
| Let us start by understanding the workflow of Cerberus: the user will start by running cerberus by pointing to a specific OpenShift cluster using kubeconfig to be able to talk to the platform on top of which the OpenShift cluster is hosted. This can be done by either the oc/kubectl API or the cloud API. Based on the configuration of cerberus, it will [watch for nodes](https://github.com/startxfr/cerberus/blob/main/docs/config.md#watch-nodes), | ||
| [watch for cluster operators](https://github.com/startxfr/cerberus/blob/main/docs/config.md#watch-cluster-operators), |
There was a problem hiding this comment.
There is a list here of components that cerberus can watch. Could you update that check box list with the links to the docs/config section for each? Please be sure to add the link to the main chaos-kubox repo not your own thanks
|
|
||
| NOTE: It is not recommended to run Cerberus internal to the cluster as the pod which is running Cerberus might get disrupted. | ||
| Refer to the [instructions](https://github.com/chaos-kubox/cerberus/blob/master/docs/installation.md#run-in-kubernetesopenshift) for information on how to run cerberus as a Kubernetes or OpenShift application. |
There was a problem hiding this comment.
Lets use a link to another doc like this: ../docs/installation.md#run-in-kubernetesopenshift
|
@startxfr Great content, very useful! May be we can add a new section under docs called "Adopters" and have the content in there along with the use case in your environment as a separate document? Something along the lines of https://github.com/chaos-mesh/chaos-mesh/blob/master/ADOPTERS.md. Thoughts? |
|
Hi @startxfr, thoughts on restructuring on the content as described ^? |
|
Hi @startxfr, thoughts? Also the commit needs to be rebased. |
| backoffLimit: 2 | ||
| ``` | ||
|
|
||
| ## Using tekton pipeline |
There was a problem hiding this comment.
@startx-lab thoughts on creating a new section called use cases/Cerberus in practice and moving the content over there similar to how you did for Kraken: krkn-chaos/krkn#333?
Adding example of tekton usage (consuming the signal as part of a tekton pipeline)
Adding an index (inspired for kraken one) to the docs directory (not sure it's part of a website build like kraken)
Complete the installation documentation with helm chart example