Reorganize the content from https://github.com/startx-lab (#346)

Moving the content around installing kraken using helm to the
chaos in practice section of the guide to showcase how startx-lab
is deploying and leveraging Kraken.

docs/index.md

@@ -10,10 +10,9 @@
   * [Cluster recovery checks, metrics evaluation and pass/fail criteria](#cluster-recovery-checks-metrics-evaluation-and-passfail-criteria)
 * [Scenarios](#scenarios)
 * [Test Environment Recommendations - how and where to run chaos tests](#test-environment-recommendations---how-and-where-to-run-chaos-tests)
-* [Chaos testing in Practice within the OpenShift Organization](#chaos-testing-in-practice-within-the-OpenShift-Organization)
-* [Using kraken as part of a tekton pipeline](#using-kraken-as-part-of-a-tekton-pipeline)
-  * [Start as a single taskrun](#start-as-a-single-taskrun)
-  * [Start as a pipelinerun](#start-as-a-pipelinerun)
+* [Chaos testing in Practice](#chaos-testing-in-practice)
+  * [OpenShift oraganization](#openshift-organization)
+  * [startx-lab](#startx-lab)
 
 
 ### Introduction
@@ -210,8 +209,9 @@ Let us take a look at few recommendations on how and where to run the chaos test
   - You might have existing test cases, be it related to Performance, Scalability or QE. Run the chaos in the background during the test runs to observe the impact. Signaling feature in Kraken can help with coordinating the chaos runs i.e., start, stop, pause the scenarios based on the state of the other test jobs.
 
 
-#### Chaos testing in Practice within the OpenShift Organization
+#### Chaos testing in Practice
 
+##### OpenShift organization
 Within the OpenShift organization we use kraken to perform chaos testing throughout a release before the code is available to customers.
 
     1. We execute kraken during our regression test suite.
@@ -230,7 +230,14 @@ Within the OpenShift organization we use kraken to perform chaos testing through
 
     3. We are starting to add in test cases that perform chaos testing during an upgrade (not many iterations of this have been completed).
 
-### Using kraken as part of a tekton pipeline
+
+##### startx-lab
+
+**NOTE**: Requests for enhancements and any issues need to be filed at the mentioned links given that they are not natively supported in Kraken.
+
+The following content covers the implementation details around how Startx is leveraging Kraken:
+
+* Using kraken as part of a tekton pipeline
 
 You can find on [artifacthub.io](https://artifacthub.io/packages/search?kind=7&ts_query_web=kraken) the 
 [kraken-scenario](https://artifacthub.io/packages/tekton-task/startx-tekton-catalog/kraken-scenario) `tekton-task`
@@ -258,14 +265,47 @@ to reflect your cluster configuration. Refer to the [kraken configuration](https
 and [configuration examples](https://github.com/startxfr/tekton-catalog/blob/stable/task/kraken-scenario/0.1/samples/) 
 for details on how to configure theses resources.
 
-#### Start as a single taskrun
+* Start as a single taskrun
 
 ```bash
 oc apply -f https://github.com/startxfr/tekton-catalog/raw/stable/task/kraken-scenario/0.1/samples/taskrun.yaml
 ```
 
-#### Start as a pipelinerun
+* Start as a pipelinerun
 
 ```yaml
 oc apply -f https://github.com/startxfr/tekton-catalog/raw/stable/task/kraken-scenario/0.1/samples/pipelinerun.yaml
 ```
+
+* Deploying kraken using a helm-chart
+
+You can find on [artifacthub.io](https://artifacthub.io/packages/search?kind=0&ts_query_web=kraken) the
+[chaos-kraken](https://artifacthub.io/packages/helm/startx/chaos-kraken) `helm-chart`
+which can be used to deploy a kraken chaos scenarios.
+
+Default configuration create the following resources :
+
+  - 1 project named **chaos-kraken**
+  - 1 scc with privileged context for kraken deployment
+  - 1 configmap with kraken 21 generic scenarios, various scripts and configuration
+  - 1 configmap with kubeconfig of the targeted cluster
+  - 1 job named kraken-test-xxx
+  - 1 service to the kraken pods
+  - 1 route to the kraken service
+
+```bash
+# Install the startx helm repository
+helm repo add startx https://startxfr.github.io/helm-repository/packages/
+# Install the kraken project
+helm install --set project.enabled=true chaos-kraken-project  startx/chaos-kraken
+# Deploy the kraken instance
+helm install \
+--set kraken.enabled=true \
+--set kraken.aws.credentials.region="eu-west-3" \
+--set kraken.aws.credentials.key_id="AKIAXXXXXXXXXXXXXXXX" \
+--set kraken.aws.credentials.secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
+--set kraken.kubeconfig.token.server="https://api.mycluster:6443" \
+--set kraken.kubeconfig.token.token="sha256~XXXXXXXXXX_PUT_YOUR_TOKEN_HERE_XXXXXXXXXXXX" \
+-n chaos-kraken \
+chaos-kraken-instance startx/chaos-kraken
+```

docs/installation.md

@@ -5,7 +5,6 @@ The following ways are supported to run Kraken:
 - Standalone python program through Git.
 - Containerized version using either Podman or Docker as the runtime.
 - Kubernetes or OpenShift deployment.
-- Using chaos-kraken helm chart.
 
 **NOTE**: It is recommended to run Kraken external to the cluster ( Standalone or Containerized ) hitting the Kubernetes/OpenShift API as running it internal to the cluster might be disruptive to itself and also might not report back the results if the chaos leads to cluster's API server instability.
 
@@ -59,39 +58,6 @@ If you want to build your own kraken image see [here](https://github.com/redhat-
 Refer [Instructions](https://github.com/redhat-chaos/krkn/blob/main/containers/README.md) on how to deploy and run Kraken as a Kubernetes/OpenShift deployment.
 
 
-### Deploying kraken using a helm-chart
-
-You can find on [artifacthub.io](https://artifacthub.io/packages/search?kind=0&ts_query_web=kraken) the 
-[chaos-kraken](https://artifacthub.io/packages/helm/startx/chaos-kraken) `helm-chart`
-which can be used to deploy a kraken chaos scenarios.
-
-Default configuration create the following resources :
-
-  - 1 project named **chaos-kraken**
-  - 1 scc with privileged context for kraken deployment
-  - 1 configmap with kraken 21 generic scenarios, various scripts and configuration
-  - 1 configmap with kubeconfig of the targeted cluster
-  - 1 job named kraken-test-xxx
-  - 1 service to the kraken pods
-  - 1 route to the kraken service
-
-```bash
-# Install the startx helm repository
-helm repo add startx https://startxfr.github.io/helm-repository/packages/
-# Install the kraken project
-helm install --set project.enabled=true chaos-kraken-project  startx/chaos-kraken
-# Deploy the kraken instance
-helm install \
---set kraken.enabled=true \
---set kraken.aws.credentials.region="eu-west-3" \
---set kraken.aws.credentials.key_id="AKIAXXXXXXXXXXXXXXXX" \
---set kraken.aws.credentials.secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
---set kraken.kubeconfig.token.server="https://api.mycluster:6443" \
---set kraken.kubeconfig.token.token="sha256~XXXXXXXXXX_PUT_YOUR_TOKEN_HERE_XXXXXXXXXXXX" \
--n chaos-kraken \
-chaos-kraken-instance startx/chaos-kraken
-```
-
 Refer to the [chaos-kraken chart manpage](https://artifacthub.io/packages/helm/startx/chaos-kraken)
 and especially the [kraken configuration values](https://artifacthub.io/packages/helm/startx/chaos-kraken#chaos-kraken-values-dictionary) 
 for details on how to configure this chart.