From d7a7b291295b3639f1eb8484d61b4140918fbd99 Mon Sep 17 00:00:00 2001 From: andoriyaprashant Date: Tue, 10 Dec 2024 15:36:51 +0530 Subject: [PATCH] Update TOC and Overview --- website/docs/concepts/overview.md | 17 +++++++++++++---- website/docs/user-guides/overview.md | 15 ++++++++++++--- website/sidebars.js | 3 ++- .../version-3.12.0/concepts/overview.md | 16 ++++++++++++---- .../version-3.12.0/user-guides/overview.md | 15 ++++++++++++--- .../version-3.12.0-sidebars.json | 3 ++- 6 files changed, 53 insertions(+), 16 deletions(-) diff --git a/website/docs/concepts/overview.md b/website/docs/concepts/overview.md index 5f2e2134..36896934 100644 --- a/website/docs/concepts/overview.md +++ b/website/docs/concepts/overview.md @@ -8,9 +8,9 @@ sidebar_label: Overview The Concepts section contains Definitions, Design principles, Terminology and Working technical theory. This section will not have the actual usage instructions or guides those will be made available in the [User Guides](../user-guides/overview.md) section. -### [Probes](probes.md) +### [Chaos Infrastructure](infrastructure.md) -Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault. +Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos. ### [ChaosHub](chaoshub.md) @@ -20,9 +20,9 @@ ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster. -### [Chaos Infrastructure](infrastructure.md) +### [Probes](probes.md) -Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos. +Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault. ### [User Management](user-management.md) @@ -39,3 +39,12 @@ Teaming feature to facilitate collaboration between users using project level ro ### [GitOps](gitops.md) GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults. + +### [Authentication in ChaosCenter](oauth-dex-concept.md) + +Authentication in ChaosCenter supports both local and OAuth-based authentication through the Authentication Server and Dex OIDC Server, offering enhanced flexibility and secure access management. + +### [Visualize chaos experiment](visualize-experiment.md) + +ChaosCenter enables users to visualize the execution of chaos experiments in real-time, displaying key details like step statuses, logs, and results. This visualization helps in analyzing the impact and resiliency of the experiment, with graphs showing the experiment’s progress and individual node information. + diff --git a/website/docs/user-guides/overview.md b/website/docs/user-guides/overview.md index 7c253a23..882a6fc7 100644 --- a/website/docs/user-guides/overview.md +++ b/website/docs/user-guides/overview.md @@ -12,13 +12,18 @@ The User Guides section details Processes, User-flows and How-tos detailing all Install ChaosCenter and Chaos Infrastructure in various environment configurations. +### [Environments](create-environment.md) +Create, Edit, and Delete Environments used for chaos experiments. + +### [Chaos Infrastructure](create-infrastructure.md) +Set up and manage the infrastructure needed for running chaos experiments. + ### [Injecting Fault](schedule-experiment.md) Constructing, Scheduling, Editing and Observing chaos experiments. -### [Event Triggered Chaos using GitOps](gitops-configuration.md) - -GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec. +### [Resilience Probes](create-resilience-probe.md) +Define and manage probes that are used to check the resilience of applications during chaos experiments. ### [Account Settings](account-settings.md) @@ -36,6 +41,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C Adding members to a project, Editing user-invite and Removing team members from a project. +### [Event Triggered Chaos using GitOps](gitops-configuration.md) + +GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec. + ### [Using different Image Registries in a Chaos Experiment](image-registry.md) Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment. diff --git a/website/sidebars.js b/website/sidebars.js index 6b5cdc39..52674a25 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -33,7 +33,8 @@ module.exports = { 'concepts/projects', 'concepts/teaming', 'concepts/gitops', - 'concepts/oauth-dex-concept' + 'concepts/oauth-dex-concept', + 'concepts/visualize-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..584b5c96 100644 --- a/website/versioned_docs/version-3.12.0/concepts/overview.md +++ b/website/versioned_docs/version-3.12.0/concepts/overview.md @@ -8,9 +8,9 @@ sidebar_label: Overview The Concepts section contains Definitions, Design principles, Terminology and Working technical theory. This section will not have the actual usage instructions or guides those will be made available in the [User Guides](../user-guides/overview.md) section. -### [Probes](probes.md) +### [Chaos Infrastructure](infrastructure.md) -Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault. +Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos. ### [ChaosHub](chaoshub.md) @@ -20,9 +20,9 @@ ChaosHub allows you to orchestrate chaos experiments from the Public **[ChaosHub Chaos Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster. -### [Chaos Infrastructure](infrastructure.md) +### [Probes](probes.md) -Chaos infrastructure is a service that runs in your target environment and aids Litmus control plane in accessing and injecting chaos. +Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Fault. ### [User Management](user-management.md) @@ -39,3 +39,11 @@ Teaming feature to facilitate collaboration between users using project level ro ### [GitOps](gitops.md) GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults. + +### [Authentication in ChaosCenter](oauth-dex-concept.md) + +Authentication in ChaosCenter supports both local and OAuth-based authentication through the Authentication Server and Dex OIDC Server, offering enhanced flexibility and secure access management. + +### [Visualize chaos experiment](visualize-experiment.md) + +ChaosCenter enables users to visualize the execution of chaos experiments in real-time, displaying key details like step statuses, logs, and results. This visualization helps in analyzing the impact and resiliency of the experiment, with graphs showing the experiment’s progress and individual node information. diff --git a/website/versioned_docs/version-3.12.0/user-guides/overview.md b/website/versioned_docs/version-3.12.0/user-guides/overview.md index 7c253a23..882a6fc7 100644 --- a/website/versioned_docs/version-3.12.0/user-guides/overview.md +++ b/website/versioned_docs/version-3.12.0/user-guides/overview.md @@ -12,13 +12,18 @@ The User Guides section details Processes, User-flows and How-tos detailing all Install ChaosCenter and Chaos Infrastructure in various environment configurations. +### [Environments](create-environment.md) +Create, Edit, and Delete Environments used for chaos experiments. + +### [Chaos Infrastructure](create-infrastructure.md) +Set up and manage the infrastructure needed for running chaos experiments. + ### [Injecting Fault](schedule-experiment.md) Constructing, Scheduling, Editing and Observing chaos experiments. -### [Event Triggered Chaos using GitOps](gitops-configuration.md) - -GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec. +### [Resilience Probes](create-resilience-probe.md) +Define and manage probes that are used to check the resilience of applications during chaos experiments. ### [Account Settings](account-settings.md) @@ -36,6 +41,10 @@ Probes are pluggable checks that can be defined within the ChaosEngine for any C Adding members to a project, Editing user-invite and Removing team members from a project. +### [Event Triggered Chaos using GitOps](gitops-configuration.md) + +GitOps in Litmus provides a way of using Event-Driven Chaos Injection, where target resources(stateful sets, deployments, etc.) can be configured to automatically trigger chaos experiment with any changes in the resource spec. + ### [Using different Image Registries in a Chaos Experiment](image-registry.md) Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment. diff --git a/website/versioned_sidebars/version-3.12.0-sidebars.json b/website/versioned_sidebars/version-3.12.0-sidebars.json index 9c12b115..53befcb9 100644 --- a/website/versioned_sidebars/version-3.12.0-sidebars.json +++ b/website/versioned_sidebars/version-3.12.0-sidebars.json @@ -36,7 +36,8 @@ "concepts/projects", "concepts/teaming", "concepts/gitops", - "concepts/oauth-dex-concept" + "concepts/oauth-dex-concept", + "concepts/visualize-experiment" ] }, {