From 7e893a9b4277ff94c25f33ea1a1090c4270dcb3b Mon Sep 17 00:00:00 2001 From: andoriyaprashant Date: Fri, 22 Nov 2024 17:11:24 +0530 Subject: [PATCH 1/3] Reorganize Getting Started and concepts Sections in Docs Signed-off-by: andoriyaprashant --- .../resources.md => concepts/chaos-center.md} | 8 ++++---- website/docs/concepts/chaos-workflow.md | 4 ++-- website/docs/concepts/overview.md | 4 ++++ .../docs/user-guides/chaos-infrastructure-installation.md | 2 +- website/docs/user-guides/image-registry.md | 2 +- website/docs/user-guides/setup-with-ingress.md | 2 +- website/docs/user-guides/setup-without-ingress.md | 6 +++--- website/docs/user-guides/uninstall-litmus.md | 2 +- website/sidebars.js | 3 ++- website/src/components/section/Home/Header.jsx | 5 ----- .../resources.md => concepts/chaos-center.md} | 8 ++++---- .../version-3.12.0/concepts/chaos-workflow.md | 4 ++-- .../versioned_docs/version-3.12.0/concepts/overview.md | 4 ++++ .../user-guides/chaos-infrastructure-installation.md | 2 +- .../version-3.12.0/user-guides/image-registry.md | 2 +- .../version-3.12.0/user-guides/setup-with-ingress.md | 4 ++-- .../version-3.12.0/user-guides/setup-without-ingress.md | 6 +++--- .../version-3.12.0/user-guides/uninstall-litmus.md | 2 +- website/versioned_sidebars/version-3.12.0-sidebars.json | 2 +- 19 files changed, 38 insertions(+), 34 deletions(-) rename website/docs/{getting-started/resources.md => concepts/chaos-center.md} (97%) rename website/versioned_docs/version-3.12.0/{getting-started/resources.md => concepts/chaos-center.md} (97%) diff --git a/website/docs/getting-started/resources.md b/website/docs/concepts/chaos-center.md similarity index 97% rename from website/docs/getting-started/resources.md rename to website/docs/concepts/chaos-center.md index 4a686853..92ec7526 100644 --- a/website/docs/getting-started/resources.md +++ b/website/docs/concepts/chaos-center.md @@ -1,7 +1,7 @@ --- -id: resources -title: Resources -sidebar_label: Resources +id: chaos-center +title: ChaosCenter +sidebar_label: ChaosCenter --- --- @@ -36,4 +36,4 @@ In Litmus, chaos infrastructures can be classified into two types: - **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. -- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. +- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. \ No newline at end of file diff --git a/website/docs/concepts/chaos-workflow.md b/website/docs/concepts/chaos-workflow.md index 6b341082..231e55dd 100644 --- a/website/docs/concepts/chaos-workflow.md +++ b/website/docs/concepts/chaos-workflow.md @@ -24,8 +24,8 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**. The following are required before creating a Chaos Experiment: -- [ChaosCenter](../getting-started/resources.md#chaoscenter) -- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) +- [ChaosCenter](../concepts/chaos-center.md#chaoscenter) +- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) - [Probes](probes.md) ## Defining and executing a chaos experiment diff --git a/website/docs/concepts/overview.md b/website/docs/concepts/overview.md index 5f2e2134..410ff6f9 100644 --- a/website/docs/concepts/overview.md +++ b/website/docs/concepts/overview.md @@ -16,6 +16,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Faults. +### [ChaosCenter](chaos-center.md) + +Learn about the core concepts of ChaosCenter, including its architecture, components, and how it integrates with Chaos Infrastructure. + ### [Chaos Experiment](chaos-workflow.md) Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster. diff --git a/website/docs/user-guides/chaos-infrastructure-installation.md b/website/docs/user-guides/chaos-infrastructure-installation.md index f80768db..3bbed02f 100644 --- a/website/docs/user-guides/chaos-infrastructure-installation.md +++ b/website/docs/user-guides/chaos-infrastructure-installation.md @@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation ## Prerequisites -- Before connecting a Chaos Infrastructure to the [ChaosCenter](../getting-started/resources.md#chaoscenter), learn about what is a [Chaos Infrastructure](../getting-started/resources.md#chaosagents) in Litmus. +- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) in Litmus. - Make sure [litmusctl](../litmusctl/installation.md) is installed. ## Connecting Chaos Infrastructure diff --git a/website/docs/user-guides/image-registry.md b/website/docs/user-guides/image-registry.md index b8f9d97c..45780198 100644 --- a/website/docs/user-guides/image-registry.md +++ b/website/docs/user-guides/image-registry.md @@ -61,4 +61,4 @@ Now, when scheduling a chaos experiment, the image registry changes will be visi ## Learn More - [What is a Chaos experiment](../concepts/chaos-workflow.md) -- [What is ChaosCenter](../getting-started/resources.md#chaoscenter) +- [What is ChaosCenter](../concepts/chaos-center.md#chaoscenter) diff --git a/website/docs/user-guides/setup-with-ingress.md b/website/docs/user-guides/setup-with-ingress.md index 18097773..622d1f32 100644 --- a/website/docs/user-guides/setup-with-ingress.md +++ b/website/docs/user-guides/setup-with-ingress.md @@ -8,7 +8,7 @@ sidebar_label: Setup with Ingress ## Prerequisites -Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed: +Before setting up endpoint with Ingress make sure the [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed: - [Install ChaosCenter with HTTP](../getting-started/installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) diff --git a/website/docs/user-guides/setup-without-ingress.md b/website/docs/user-guides/setup-without-ingress.md index 0be84d93..ddb43ad9 100644 --- a/website/docs/user-guides/setup-without-ingress.md +++ b/website/docs/user-guides/setup-without-ingress.md @@ -8,9 +8,9 @@ sidebar_label: Setup without ingress ## Prerequisites -Before setting up endpoint without Ingress, make sure [ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes: +Before setting up endpoint without Ingress, make sure [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed in either one of these scopes: -- [Install ChaosCenter with HTTP](../getting-started/installation.md)) +- [Install ChaosCenter with HTTP](../getting-started/installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) ## NodePort service setup @@ -81,5 +81,5 @@ By default you are assigned with a default project with Owner permissions. ## Learn more - [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress.md) -- [Install ChaosCenter with HTTP](../getting-started/installation.md)) +- [Install ChaosCenter with HTTP](../getting-started/installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) diff --git a/website/docs/user-guides/uninstall-litmus.md b/website/docs/user-guides/uninstall-litmus.md index 580ec5f4..3924428a 100644 --- a/website/docs/user-guides/uninstall-litmus.md +++ b/website/docs/user-guides/uninstall-litmus.md @@ -8,7 +8,7 @@ sidebar_label: Uninstall Litmus ## Chaos Infrastructure -To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosagents) connected to the [ChaosCenter](../getting-started/resources.md#chaoscenter), follow these steps - +To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps: 1. Remove the ChaosEngines of the respective Chaos Infrastructure diff --git a/website/sidebars.js b/website/sidebars.js index 6b5cdc39..82eb6cdc 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -11,7 +11,7 @@ module.exports = { ] }, { - 'Getting Started': ['getting-started/resources', 'getting-started/installation'] + "Getting Started": ["getting-started/installation"] }, { Architecture: [ @@ -27,6 +27,7 @@ module.exports = { 'concepts/overview', 'concepts/chaos-infrastructure', 'concepts/chaoshub', + 'concepts/chaos-center', 'concepts/chaos-workflow', 'concepts/probes', 'concepts/user-management', diff --git a/website/src/components/section/Home/Header.jsx b/website/src/components/section/Home/Header.jsx index 4f3be8c9..7ebd8770 100644 --- a/website/src/components/section/Home/Header.jsx +++ b/website/src/components/section/Home/Header.jsx @@ -18,11 +18,6 @@ const Header = () => { native SREs, QA teams and developers use Litmus to design, orchestrate and analyse chaos in their environments. - - - Get Started - - Header Image diff --git a/website/versioned_docs/version-3.12.0/getting-started/resources.md b/website/versioned_docs/version-3.12.0/concepts/chaos-center.md similarity index 97% rename from website/versioned_docs/version-3.12.0/getting-started/resources.md rename to website/versioned_docs/version-3.12.0/concepts/chaos-center.md index 4a686853..92ec7526 100644 --- a/website/versioned_docs/version-3.12.0/getting-started/resources.md +++ b/website/versioned_docs/version-3.12.0/concepts/chaos-center.md @@ -1,7 +1,7 @@ --- -id: resources -title: Resources -sidebar_label: Resources +id: chaos-center +title: ChaosCenter +sidebar_label: ChaosCenter --- --- @@ -36,4 +36,4 @@ In Litmus, chaos infrastructures can be classified into two types: - **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. -- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. +- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. \ No newline at end of file diff --git a/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md index 6b341082..231e55dd 100644 --- a/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md @@ -24,8 +24,8 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**. The following are required before creating a Chaos Experiment: -- [ChaosCenter](../getting-started/resources.md#chaoscenter) -- [Chaos Infrastructure](../getting-started/resources.md#chaosagents) +- [ChaosCenter](../concepts/chaos-center.md#chaoscenter) +- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) - [Probes](probes.md) ## Defining and executing a chaos experiment diff --git a/website/versioned_docs/version-3.12.0/concepts/overview.md b/website/versioned_docs/version-3.12.0/concepts/overview.md index 5f2e2134..410ff6f9 100644 --- a/website/versioned_docs/version-3.12.0/concepts/overview.md +++ b/website/versioned_docs/version-3.12.0/concepts/overview.md @@ -16,6 +16,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Faults. +### [ChaosCenter](chaos-center.md) + +Learn about the core concepts of ChaosCenter, including its architecture, components, and how it integrates with Chaos Infrastructure. + ### [Chaos Experiment](chaos-workflow.md) Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster. diff --git a/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md b/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md index f80768db..3bbed02f 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md +++ b/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md @@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation ## Prerequisites -- Before connecting a Chaos Infrastructure to the [ChaosCenter](../getting-started/resources.md#chaoscenter), learn about what is a [Chaos Infrastructure](../getting-started/resources.md#chaosagents) in Litmus. +- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) in Litmus. - Make sure [litmusctl](../litmusctl/installation.md) is installed. ## Connecting Chaos Infrastructure diff --git a/website/versioned_docs/version-3.12.0/user-guides/image-registry.md b/website/versioned_docs/version-3.12.0/user-guides/image-registry.md index b8f9d97c..45780198 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/image-registry.md +++ b/website/versioned_docs/version-3.12.0/user-guides/image-registry.md @@ -61,4 +61,4 @@ Now, when scheduling a chaos experiment, the image registry changes will be visi ## Learn More - [What is a Chaos experiment](../concepts/chaos-workflow.md) -- [What is ChaosCenter](../getting-started/resources.md#chaoscenter) +- [What is ChaosCenter](../concepts/chaos-center.md#chaoscenter) diff --git a/website/versioned_docs/version-3.12.0/user-guides/setup-with-ingress.md b/website/versioned_docs/version-3.12.0/user-guides/setup-with-ingress.md index 18097773..f15a1733 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/setup-with-ingress.md +++ b/website/versioned_docs/version-3.12.0/user-guides/setup-with-ingress.md @@ -8,7 +8,7 @@ sidebar_label: Setup with Ingress ## Prerequisites -Before setting up endpoint with Ingress make sure the [Litmus ChaosCenter](../getting-started/resources.md#chaoscenter) is installed: +Before setting up endpoint with Ingress make sure the [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed: - [Install ChaosCenter with HTTP](../getting-started/installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) @@ -104,7 +104,7 @@ spec: name: letsencrypt solvers: - http01: - ingress: + ingress: class: nginx ``` diff --git a/website/versioned_docs/version-3.12.0/user-guides/setup-without-ingress.md b/website/versioned_docs/version-3.12.0/user-guides/setup-without-ingress.md index 0be84d93..ddb43ad9 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/setup-without-ingress.md +++ b/website/versioned_docs/version-3.12.0/user-guides/setup-without-ingress.md @@ -8,9 +8,9 @@ sidebar_label: Setup without ingress ## Prerequisites -Before setting up endpoint without Ingress, make sure [ChaosCenter](../getting-started/resources.md#chaoscenter) is installed in either one of these scopes: +Before setting up endpoint without Ingress, make sure [ChaosCenter](../concepts/chaos-center.md#chaoscenter) is installed in either one of these scopes: -- [Install ChaosCenter with HTTP](../getting-started/installation.md)) +- [Install ChaosCenter with HTTP](../getting-started/installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) ## NodePort service setup @@ -81,5 +81,5 @@ By default you are assigned with a default project with Owner permissions. ## Learn more - [Setup Endpoints and Access ChaosCenter with Ingress](setup-with-ingress.md) -- [Install ChaosCenter with HTTP](../getting-started/installation.md)) +- [Install ChaosCenter with HTTP](../getting-started/installation.md) - [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md) diff --git a/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md index 580ec5f4..3924428a 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md @@ -8,7 +8,7 @@ sidebar_label: Uninstall Litmus ## Chaos Infrastructure -To disconnect the [Chaos Infrastructure](../getting-started/resources.md#chaosagents) connected to the [ChaosCenter](../getting-started/resources.md#chaoscenter), follow these steps - +To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps: 1. Remove the ChaosEngines of the respective Chaos Infrastructure diff --git a/website/versioned_sidebars/version-3.12.0-sidebars.json b/website/versioned_sidebars/version-3.12.0-sidebars.json index 9c12b115..09914e7b 100644 --- a/website/versioned_sidebars/version-3.12.0-sidebars.json +++ b/website/versioned_sidebars/version-3.12.0-sidebars.json @@ -12,7 +12,6 @@ }, { "Getting Started": [ - "getting-started/resources", "getting-started/installation" ] }, @@ -30,6 +29,7 @@ "concepts/overview", "concepts/chaos-infrastructure", "concepts/chaoshub", + "concepts/chaos-center", "concepts/chaos-workflow", "concepts/probes", "concepts/user-management", From 07b7e531a6c18559939b354cc8a14f720933f0c3 Mon Sep 17 00:00:00 2001 From: andoriyaprashant Date: Fri, 29 Nov 2024 10:15:14 +0530 Subject: [PATCH 2/3] Changes (infrastructure.md) Signed-off-by: andoriyaprashant --- website/docs/concepts/chaos-center.md | 11 +---------- website/docs/concepts/chaos-workflow.md | 2 +- website/docs/concepts/infrastructure.md | 8 ++++++++ .../user-guides/chaos-infrastructure-installation.md | 2 +- website/docs/user-guides/uninstall-litmus.md | 2 +- .../version-3.12.0/concepts/chaos-center.md | 11 ----------- .../version-3.12.0/concepts/chaos-workflow.md | 2 +- .../version-3.12.0/concepts/infrastructure.md | 8 ++++++++ .../user-guides/chaos-infrastructure-installation.md | 2 +- .../version-3.12.0/user-guides/uninstall-litmus.md | 2 +- 10 files changed, 23 insertions(+), 27 deletions(-) diff --git a/website/docs/concepts/chaos-center.md b/website/docs/concepts/chaos-center.md index 92ec7526..7c96633f 100644 --- a/website/docs/concepts/chaos-center.md +++ b/website/docs/concepts/chaos-center.md @@ -26,14 +26,5 @@ ChaosCenter gives you access to a plethora of features, the major ones include: - Rolling out automated changes using GitOps - Allowing image addition from custom image server (both public and private) - Measure and analyze the Resilience Score of each chaos scenario + -## Chaos Infrastructures -Chaos infrastructure is a service that runs in your target environment and aids Litmus in accessing and injecting chaos to your target environment. There should always be at least one or more than one chaos infrastructure connected to the ChaosCenter to execute an experiment. - -## Types of Chaos Infrastructures - -In Litmus, chaos infrastructures can be classified into two types: - -- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. - -- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. \ No newline at end of file diff --git a/website/docs/concepts/chaos-workflow.md b/website/docs/concepts/chaos-workflow.md index 231e55dd..d6237702 100644 --- a/website/docs/concepts/chaos-workflow.md +++ b/website/docs/concepts/chaos-workflow.md @@ -25,7 +25,7 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**. The following are required before creating a Chaos Experiment: - [ChaosCenter](../concepts/chaos-center.md#chaoscenter) -- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) +- [Chaos Infrastructure](../concepts/infrastructure.md#chaos-infrastructures) - [Probes](probes.md) ## Defining and executing a chaos experiment diff --git a/website/docs/concepts/infrastructure.md b/website/docs/concepts/infrastructure.md index 32f743d1..df55ca82 100644 --- a/website/docs/concepts/infrastructure.md +++ b/website/docs/concepts/infrastructure.md @@ -14,6 +14,14 @@ With the latest release of LitmusChaos 3.0.0 the term **Chaos Delegate/Agent** h An environment represents where you are installing your chaos infrastructure and acts as an additional level of abstraction for the same. You categorize each environment as prod or non-prod. +## Types of Chaos Infrastructures + +In Litmus, chaos infrastructures can be classified into two types: + +- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. + +- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. + ### Access types Chaos infrastructure can be created in two modes: diff --git a/website/docs/user-guides/chaos-infrastructure-installation.md b/website/docs/user-guides/chaos-infrastructure-installation.md index 3bbed02f..85412fee 100644 --- a/website/docs/user-guides/chaos-infrastructure-installation.md +++ b/website/docs/user-guides/chaos-infrastructure-installation.md @@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation ## Prerequisites -- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) in Litmus. +- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/infrastructure.md#chaos-infrastructures) in Litmus. - Make sure [litmusctl](../litmusctl/installation.md) is installed. ## Connecting Chaos Infrastructure diff --git a/website/docs/user-guides/uninstall-litmus.md b/website/docs/user-guides/uninstall-litmus.md index 3924428a..9372309c 100644 --- a/website/docs/user-guides/uninstall-litmus.md +++ b/website/docs/user-guides/uninstall-litmus.md @@ -8,7 +8,7 @@ sidebar_label: Uninstall Litmus ## Chaos Infrastructure -To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps: +To disconnect the [Chaos Infrastructure](../concepts/infrastructure.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps: 1. Remove the ChaosEngines of the respective Chaos Infrastructure diff --git a/website/versioned_docs/version-3.12.0/concepts/chaos-center.md b/website/versioned_docs/version-3.12.0/concepts/chaos-center.md index 92ec7526..548f04a7 100644 --- a/website/versioned_docs/version-3.12.0/concepts/chaos-center.md +++ b/website/versioned_docs/version-3.12.0/concepts/chaos-center.md @@ -26,14 +26,3 @@ ChaosCenter gives you access to a plethora of features, the major ones include: - Rolling out automated changes using GitOps - Allowing image addition from custom image server (both public and private) - Measure and analyze the Resilience Score of each chaos scenario - -## Chaos Infrastructures -Chaos infrastructure is a service that runs in your target environment and aids Litmus in accessing and injecting chaos to your target environment. There should always be at least one or more than one chaos infrastructure connected to the ChaosCenter to execute an experiment. - -## Types of Chaos Infrastructures - -In Litmus, chaos infrastructures can be classified into two types: - -- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. - -- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. \ No newline at end of file diff --git a/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md b/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md index 231e55dd..d6237702 100644 --- a/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md +++ b/website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md @@ -25,7 +25,7 @@ The term **Chaos Scenario/Workflow** has been changed to **Chaos Experiment**. The following are required before creating a Chaos Experiment: - [ChaosCenter](../concepts/chaos-center.md#chaoscenter) -- [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) +- [Chaos Infrastructure](../concepts/infrastructure.md#chaos-infrastructures) - [Probes](probes.md) ## Defining and executing a chaos experiment diff --git a/website/versioned_docs/version-3.12.0/concepts/infrastructure.md b/website/versioned_docs/version-3.12.0/concepts/infrastructure.md index 32f743d1..df55ca82 100644 --- a/website/versioned_docs/version-3.12.0/concepts/infrastructure.md +++ b/website/versioned_docs/version-3.12.0/concepts/infrastructure.md @@ -14,6 +14,14 @@ With the latest release of LitmusChaos 3.0.0 the term **Chaos Delegate/Agent** h An environment represents where you are installing your chaos infrastructure and acts as an additional level of abstraction for the same. You categorize each environment as prod or non-prod. +## Types of Chaos Infrastructures + +In Litmus, chaos infrastructures can be classified into two types: + +- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. + +- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. + ### Access types Chaos infrastructure can be created in two modes: diff --git a/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md b/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md index 3bbed02f..85412fee 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md +++ b/website/versioned_docs/version-3.12.0/user-guides/chaos-infrastructure-installation.md @@ -8,7 +8,7 @@ sidebar_label: Chaos Infrastructure Installation ## Prerequisites -- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) in Litmus. +- Before connecting a Chaos Infrastructure to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), learn about what is a [Chaos Infrastructure](../concepts/infrastructure.md#chaos-infrastructures) in Litmus. - Make sure [litmusctl](../litmusctl/installation.md) is installed. ## Connecting Chaos Infrastructure diff --git a/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md b/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md index 3924428a..9372309c 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md +++ b/website/versioned_docs/version-3.12.0/user-guides/uninstall-litmus.md @@ -8,7 +8,7 @@ sidebar_label: Uninstall Litmus ## Chaos Infrastructure -To disconnect the [Chaos Infrastructure](../concepts/chaos-center.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps: +To disconnect the [Chaos Infrastructure](../concepts/infrastructure.md#chaos-infrastructures) connected to the [ChaosCenter](../concepts/chaos-center.md#chaoscenter), follow these steps: 1. Remove the ChaosEngines of the respective Chaos Infrastructure From fd3cea37d6273436465fbb72efffa0cfa1c3f649 Mon Sep 17 00:00:00 2001 From: andoriyaprashant Date: Sat, 30 Nov 2024 16:45:20 +0530 Subject: [PATCH 3/3] infrastructure.md Signed-off-by: andoriyaprashant --- website/docs/concepts/infrastructure.md | 10 +--------- .../version-3.12.0/concepts/infrastructure.md | 10 +--------- 2 files changed, 2 insertions(+), 18 deletions(-) diff --git a/website/docs/concepts/infrastructure.md b/website/docs/concepts/infrastructure.md index df55ca82..f1696ddc 100644 --- a/website/docs/concepts/infrastructure.md +++ b/website/docs/concepts/infrastructure.md @@ -14,15 +14,7 @@ With the latest release of LitmusChaos 3.0.0 the term **Chaos Delegate/Agent** h An environment represents where you are installing your chaos infrastructure and acts as an additional level of abstraction for the same. You categorize each environment as prod or non-prod. -## Types of Chaos Infrastructures - -In Litmus, chaos infrastructures can be classified into two types: - -- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. - -- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. - -### Access types +## Access types Chaos infrastructure can be created in two modes: diff --git a/website/versioned_docs/version-3.12.0/concepts/infrastructure.md b/website/versioned_docs/version-3.12.0/concepts/infrastructure.md index df55ca82..f1696ddc 100644 --- a/website/versioned_docs/version-3.12.0/concepts/infrastructure.md +++ b/website/versioned_docs/version-3.12.0/concepts/infrastructure.md @@ -14,15 +14,7 @@ With the latest release of LitmusChaos 3.0.0 the term **Chaos Delegate/Agent** h An environment represents where you are installing your chaos infrastructure and acts as an additional level of abstraction for the same. You categorize each environment as prod or non-prod. -## Types of Chaos Infrastructures - -In Litmus, chaos infrastructures can be classified into two types: - -- **Self Chaos Infrastructures:** A Chaos Infrastructure that is connected to the same cluster and namespace where the ChaosCenter is deployed. It can be used to target the workloads executing on that cluster only. - -- **External Chaos Infrastructures:** A Chaos Infrastructure that is connected to a remote Kubernetes cluster. ChaosCenter can be operated in a cross-cloud manner, which allows connecting multiple External Chaos Infrastructure to the same ChaosCenter with the help of the [litmusctl](../litmusctl/installation.md) CLI. Once connected you can manage, monitor, observe and induce chaos from the ChaosCenter to the respective External Chaos Infrastructures. - -### Access types +## Access types Chaos infrastructure can be created in two modes: