Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize Getting Started and concepts Sections in Docs #305

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: resources
title: Resources
sidebar_label: Resources
id: chaos-center
title: ChaosCenter
sidebar_label: ChaosCenter
---

---
Expand All @@ -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.
4 changes: 2 additions & 2 deletions website/docs/concepts/chaos-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/infrastructure.md#chaos-infrastructures)
- [Probes](probes.md)

## Defining and executing a chaos experiment
Expand Down
2 changes: 1 addition & 1 deletion website/docs/concepts/infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +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.

### Access types
## Access types

Chaos infrastructure can be created in two modes:

Expand Down
4 changes: 4 additions & 0 deletions website/docs/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/infrastructure.md#chaos-infrastructures) in Litmus.
- Make sure [litmusctl](../litmusctl/installation.md) is installed.

## Connecting Chaos Infrastructure
Expand Down
2 changes: 1 addition & 1 deletion website/docs/user-guides/image-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion website/docs/user-guides/setup-with-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions website/docs/user-guides/setup-without-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
2 changes: 1 addition & 1 deletion website/docs/user-guides/uninstall-litmus.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/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

Expand Down
3 changes: 2 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ module.exports = {
]
},
{
'Getting Started': ['getting-started/resources', 'getting-started/installation']
"Getting Started": ["getting-started/installation"]
},
{
Architecture: [
Expand All @@ -27,6 +27,7 @@ module.exports = {
'concepts/overview',
'concepts/chaos-infrastructure',
'concepts/chaoshub',
'concepts/chaos-center',
'concepts/chaos-workflow',
'concepts/probes',
'concepts/user-management',
Expand Down
5 changes: 0 additions & 5 deletions website/src/components/section/Home/Header.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,6 @@ const Header = () => {
native SREs, QA teams and developers use Litmus to design, orchestrate and analyse chaos in their
environments.
</Paragraph>
<Row>
<Link to="/docs/getting-started/installation">
<ButtonFilled>Get Started</ButtonFilled>
</Link>
</Row>
</div>
<img className="headerImage" src={useBaseUrl('/img/header.png')} alt="Header Image" />
</ResponsiveRow>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: resources
title: Resources
sidebar_label: Resources
id: chaos-center
title: ChaosCenter
sidebar_label: ChaosCenter
---

---
Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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/infrastructure.md#chaos-infrastructures)
- [Probes](probes.md)

## Defining and executing a chaos experiment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +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.

### Access types
## Access types

Chaos infrastructure can be created in two modes:

Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-3.12.0/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/infrastructure.md#chaos-infrastructures) in Litmus.
- Make sure [litmusctl](../litmusctl/installation.md) is installed.

## Connecting Chaos Infrastructure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -104,7 +104,7 @@ spec:
name: letsencrypt
solvers:
- http01:
ingress:
ingress:
class: nginx
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Original file line number Diff line number Diff line change
Expand Up @@ -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/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

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_sidebars/version-3.12.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
},
{
"Getting Started": [
"getting-started/resources",
"getting-started/installation"
]
},
Expand All @@ -30,6 +29,7 @@
"concepts/overview",
"concepts/chaos-infrastructure",
"concepts/chaoshub",
"concepts/chaos-center",
"concepts/chaos-workflow",
"concepts/probes",
"concepts/user-management",
Expand Down