Skip to content

Commit 5484828

Browse files
committed
Deprecate running krkn as kubernetes app
This commit removes the instructions on running krkn as kubernetes deployment as it is not supported/maintained and also not recommended. Signed-off-by: Naga Ravi Chaitanya Elluri <[email protected]>
1 parent d18b633 commit 5484828

File tree

3 files changed

+0
-90
lines changed

3 files changed

+0
-90
lines changed

containers/README.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,3 @@ Refer [instructions](https://github.com/redhat-chaos/krkn/blob/main/docs/install
1212
### Run Custom Kraken Image
1313

1414
Refer to [instructions](https://github.com/redhat-chaos/krkn/blob/main/containers/build_own_image-README.md) for information on how to run a custom containerized version of kraken using podman.
15-
16-
17-
### Kraken as a KubeApp ( Unsupported and not recommended )
18-
19-
#### GENERAL NOTES:
20-
21-
- It is not generally recommended to run Kraken internal to the cluster as the pod which is running Kraken might get disrupted, the suggested use case to run kraken from inside k8s/OpenShift is to target **another** cluster (eg. to bypass network restrictions or to leverage cluster's computational resources)
22-
23-
- your kubeconfig might contain several cluster contexts and credentials so be sure, before creating the ConfigMap, to keep **only** the credentials related to the destination cluster. Please refer to the [Kubernetes documentation](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) for more details
24-
- to add privileges to the service account you must be logged in the cluster with an highly privileged account (ideally kubeadmin)
25-
26-
27-
28-
To run containerized Kraken as a Kubernetes/OpenShift Deployment, follow these steps:
29-
30-
1. Configure the [config.yaml](https://github.com/redhat-chaos/krkn/blob/main/config/config.yaml) file according to your requirements.
31-
32-
**NOTE**: both the scenarios ConfigMaps are needed regardless you're running kraken in Kubernetes or OpenShift
33-
34-
2. Create a namespace under which you want to run the kraken pod using `kubectl create ns <namespace>`.
35-
3. Switch to `<namespace>` namespace:
36-
- In Kubernetes, use `kubectl config set-context --current --namespace=<namespace>`
37-
- In OpenShift, use `oc project <namespace>`
38-
39-
4. Create a ConfigMap named kube-config using `kubectl create configmap kube-config --from-file=<path_to_kubeconfig>` *(eg. ~/.kube/config)*
40-
5. Create a ConfigMap named kraken-config using `kubectl create configmap kraken-config --from-file=<path_to_kraken>/config`
41-
6. Create a ConfigMap named scenarios-config using `kubectl create configmap scenarios-config --from-file=<path_to_kraken>/scenarios`
42-
7. Create a ConfigMap named scenarios-openshift-config using `kubectl create configmap scenarios-openshift-config --from-file=<path_to_kraken>/scenarios/openshift`
43-
8. Create a ConfigMap named scenarios-kube-config using `kubectl create configmap scenarios-kube-config --from-file=<path_to_kraken>/scenarios/kube`
44-
9. Create a service account to run the kraken pod `kubectl create serviceaccount useroot`.
45-
10. In Openshift, add privileges to service account and execute `oc adm policy add-scc-to-user privileged -z useroot`.
46-
11. Create a Job using `kubectl apply -f <path_to_kraken>/containers/kraken.yml` and monitor the status using `oc get jobs` and `oc get pods`.

containers/kraken.yml

Lines changed: 0 additions & 49 deletions
This file was deleted.

docs/installation.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,3 @@ $ python3.9 run_kraken.py --config <config_file_location>
4343
[Krkn-hub](https://github.com/krkn-chaos/krkn-hub) is a wrapper that allows running Krkn chaos scenarios via podman or docker runtime with scenario parameters/configuration defined as environment variables.
4444

4545
Refer [instructions](https://github.com/krkn-chaos/krkn-hub#supported-chaos-scenarios) to get started.
46-
47-
48-
### Run Kraken as a Kubernetes deployment ( unsupported option - standalone or containerized deployers are recommended )
49-
Refer [Instructions](https://github.com/krkn-chaos/krkn/blob/main/containers/README.md) on how to deploy and run Kraken as a Kubernetes/OpenShift deployment.
50-
51-
52-
Refer to the [chaos-kraken chart manpage](https://artifacthub.io/packages/helm/startx/chaos-kraken)
53-
and especially the [kraken configuration values](https://artifacthub.io/packages/helm/startx/chaos-kraken#chaos-kraken-values-dictionary)
54-
for details on how to configure this chart.

0 commit comments

Comments
 (0)