From 43f3adaa2b00389ec4125cb64c439f8e30f2d834 Mon Sep 17 00:00:00 2001 From: Paige Rubendall <64206430+paigerube14@users.noreply.github.com> Date: Wed, 11 Oct 2023 16:52:55 -0400 Subject: [PATCH] Updating doc name (#145) * updating doc name * deleting namespace scenario * namespace taken out in main readme --- README.md | 2 +- .../{namespace-scenarios.md => service-disruption-scenarios.md} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename docs/{namespace-scenarios.md => service-disruption-scenarios.md} (94%) diff --git a/README.md b/README.md index d15e43d..f9457c8 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Scenario | Description | Working [Node cpu hog](docs/node-cpu-hog.md) | Hogs CPU on the targeted nodes | :heavy_check_mark: | [Node memory hog](docs/node-memory-hog.md) | Hogs memory on the targeted nodes | :heavy_check_mark: | [Node IO hog](docs/node-io-hog.md) | Hogs io on the targeted nodes | :heavy_check_mark: | -[Namespace failures](docs/namespace-scenarios.md) | Fails the components in a namespace by deleting it | :heavy_check_mark: | +[Service Disruption](docs/service-disruption-scenarios.md) | Deleting all objects within a namespace | :heavy_check_mark: | [Application outages](docs/application-outages.md) | Isolates application Ingress/Egress traffic to observe the impact on dependent applications and recovery/initialization timing | :heavy_check_mark: | [Power Outages](docs/power-outages.md) | Shuts down the cluster for the specified duration and turns it back on to check the cluster health | :heavy_check_mark: | [PVC disk fill](docs/pvc-scenarios.md) | Fills up a given PersistenVolumeClaim by creating a temp file on the PVC from a pod associated with it | :heavy_check_mark: | diff --git a/docs/namespace-scenarios.md b/docs/service-disruption-scenarios.md similarity index 94% rename from docs/namespace-scenarios.md rename to docs/service-disruption-scenarios.md index 8db63fe..4a38645 100644 --- a/docs/namespace-scenarios.md +++ b/docs/service-disruption-scenarios.md @@ -1,5 +1,5 @@ ### Namespace/Service Disruption Scenarios -This scenario deletes a namespace in your Kubernetes/OpenShift cluster. More information can be found [here](https://github.com/redhat-chaos/krkn/blob/master/docs/service_disruption_scenarios.md). +This scenario deletes main objects within a namespace in your Kubernetes/OpenShift cluster. More information can be found [here](https://github.com/redhat-chaos/krkn/blob/master/docs/service_disruption_scenarios.md). #### Run If enabling [Cerberus](https://github.com/redhat-chaos/krkn#kraken-scenario-passfail-criteria-and-report) to monitor the cluster and pass/fail the scenario post chaos, refer [docs](https://github.com/redhat-chaos/krkn-hub/tree/main/docs/cerberus.md). Make sure to start it before injecting the chaos and set `CERBERUS_ENABLED` environment variable for the chaos injection container to autoconnect.