litmuschaos
/
litmus-docs
mirror of https://github.com/litmuschaos/litmus-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update TOC and Overview for Consistency (#313) 

* Update TOC and Overview

Signed-off-by: andoriyaprashant <prashantandoriya@gmail.com>

* Changes

Signed-off-by: andoriyaprashant <prashantandoriya@gmail.com>

* Sidebar

Signed-off-by: andoriyaprashant <prashantandoriya@gmail.com>

---------

Signed-off-by: andoriyaprashant <prashantandoriya@gmail.com>
This commit is contained in:
Prashant Andoriya 2025-01-15 11:51:21 +05:30 committed by GitHub
parent 5b394aecc4
commit 4a3ea6452d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 61 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/concepts/chaos-workflow.md
View File

@ -1,7 +1,7 @@
--- ---
id: chaos-workflow id: chaos-workflow
title: Chaos experiment title: Chaos experiment
sidebar_label: Chaos experiment sidebar_label: Chaos Experiment
--- ---
--- ---

2
website/docs/concepts/infrastructure.md
View File

@ -1,7 +1,7 @@
--- ---
id: chaos-infrastructure id: chaos-infrastructure
title: Chaos infrastructure title: Chaos infrastructure
sidebar_label: Chaos infrastructure sidebar_label: Chaos Infrastructure
--- ---
Chaos infrastructure is a service that runs in your target environment and aids the Litmus control plane in accessing and injecting chaos at a cloud-native scale. All the chaos infrastructure services adhere to the principle of least privilege, where the services execute with the minimum number of required permissions. A chaos infrastructure can be created under a Chaos Environment. Chaos infrastructure is a service that runs in your target environment and aids the Litmus control plane in accessing and injecting chaos at a cloud-native scale. All the chaos infrastructure services adhere to the principle of least privilege, where the services execute with the minimum number of required permissions. A chaos infrastructure can be created under a Chaos Environment.

17
website/docs/concepts/overview.md
View File

@ -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. 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) ### [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 Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster.
### [Chaos Infrastructure](infrastructure.md) ### [Resilience 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) ### [User Management](user-management.md)
@ -39,3 +39,12 @@ Teaming feature to facilitate collaboration between users using project level ro
### [GitOps](gitops.md) ### [GitOps](gitops.md)
GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults. 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.

2
website/docs/concepts/user-management.md
View File

@ -1,7 +1,7 @@
--- ---
id: user-management id: user-management
title: User management title: User management
sidebar_label: User management sidebar_label: User Management
--- ---
--- ---

2
website/docs/concepts/visualize-experiment.md
View File

@ -1,7 +1,7 @@
--- ---
id: visualize-experiment id: visualize-experiment
title: Visualize chaos experiment title: Visualize chaos experiment
sidebar_label: Visualize chaos experiment sidebar_label: Visualize Chaos Experiment
--- ---
--- ---

15
website/docs/user-guides/overview.md
View File

@ -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. 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) ### [Injecting Fault](schedule-experiment.md)
Constructing, Scheduling, Editing and Observing chaos experiments. Constructing, Scheduling, Editing and Observing chaos experiments.
### [Event Triggered Chaos using GitOps](gitops-configuration.md) ### [Resilience Probes](create-resilience-probe.md)
Define and manage probes that are used to check the resilience of applications during chaos experiments.
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.
### [Account Settings](account-settings.md) ### [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. Adding members to a project, Editing user-invite and Removing team members from a project.
### [Configuring 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 in a Chaos Experiment](image-registry.md)
Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment. Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment.

3
website/sidebars.js
View File

@ -32,7 +32,8 @@ module.exports = {
'concepts/projects', 'concepts/projects',
'concepts/teaming', 'concepts/teaming',
'concepts/gitops', 'concepts/gitops',
'concepts/oauth-dex-concept' 'concepts/oauth-dex-concept',
'concepts/visualize-experiment'
] ]
}, },
{ {

2
website/versioned_docs/version-3.12.0/concepts/chaos-workflow.md
View File

@ -1,7 +1,7 @@
--- ---
id: chaos-workflow id: chaos-workflow
title: Chaos experiment title: Chaos experiment
sidebar_label: Chaos experiment sidebar_label: Chaos Experiment
--- ---
--- ---

2
website/versioned_docs/version-3.12.0/concepts/infrastructure.md
View File

@ -1,7 +1,7 @@
--- ---
id: chaos-infrastructure id: chaos-infrastructure
title: Chaos infrastructure title: Chaos infrastructure
sidebar_label: Chaos infrastructure sidebar_label: Chaos Infrastructure
--- ---
Chaos infrastructure is a service that runs in your target environment and aids the Litmus control plane in accessing and injecting chaos at a cloud-native scale. All the chaos infrastructure services adhere to the principle of least privilege, where the services execute with the minimum number of required permissions. A chaos infrastructure can be created under a Chaos Environment. Chaos infrastructure is a service that runs in your target environment and aids the Litmus control plane in accessing and injecting chaos at a cloud-native scale. All the chaos infrastructure services adhere to the principle of least privilege, where the services execute with the minimum number of required permissions. A chaos infrastructure can be created under a Chaos Environment.

16
website/versioned_docs/version-3.12.0/concepts/overview.md
View File

@ -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. 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) ### [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 Experiment is a set of different operations coupled together to achieve desired chaos impact on a Kubernetes Cluster.
### [Chaos Infrastructure](infrastructure.md) ### [Resilience 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) ### [User Management](user-management.md)
@ -39,3 +39,11 @@ Teaming feature to facilitate collaboration between users using project level ro
### [GitOps](gitops.md) ### [GitOps](gitops.md)
GitOps feature in Litmus enables you to configure a single source of truth for your chaos experiments and faults. 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.

2
website/versioned_docs/version-3.12.0/concepts/user-management.md
View File

@ -1,7 +1,7 @@
--- ---
id: user-management id: user-management
title: User management title: User management
sidebar_label: User management sidebar_label: User Management
--- ---
--- ---

2
website/versioned_docs/version-3.12.0/concepts/visualize-experiment.md
View File

@ -1,7 +1,7 @@
--- ---
id: visualize-experiment id: visualize-experiment
title: Visualize chaos experiment title: Visualize chaos experiment
sidebar_label: Visualize chaos experiment sidebar_label: Visualize Chaos Experiment
--- ---
--- ---

15
website/versioned_docs/version-3.12.0/user-guides/overview.md
View File

@ -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. 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) ### [Injecting Fault](schedule-experiment.md)
Constructing, Scheduling, Editing and Observing chaos experiments. Constructing, Scheduling, Editing and Observing chaos experiments.
### [Event Triggered Chaos using GitOps](gitops-configuration.md) ### [Resilience Probes](create-resilience-probe.md)
Define and manage probes that are used to check the resilience of applications during chaos experiments.
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.
### [Account Settings](account-settings.md) ### [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. Adding members to a project, Editing user-invite and Removing team members from a project.
### [Configuring 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 in a Chaos Experiment](image-registry.md)
Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment. Using different Image Registries like Docker, Red Hat Quay, Google Container Registry in a Chaos Experiment.

3
website/versioned_sidebars/version-3.12.0-sidebars.json
View File

@ -35,7 +35,8 @@
"concepts/projects", "concepts/projects",
"concepts/teaming", "concepts/teaming",
"concepts/gitops", "concepts/gitops",
"concepts/oauth-dex-concept" "concepts/oauth-dex-concept",
"concepts/visualize-experiment"
] ]
}, },
{ {