Skip to content

Commit

Permalink
Fixed broken links (#103)
Browse files Browse the repository at this point in the history
* Fixed broken links

Signed-off-by: SarthakJain26 <[email protected]>
  • Loading branch information
SarthakJain26 authored Aug 16, 2021
1 parent 62f4423 commit 3487c11
Show file tree
Hide file tree
Showing 67 changed files with 253 additions and 238 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ docs/embedmd-command.sh
website/translated_docs
website/yarn.lock
website/node_modules
website/build
website/i18n/*
*.log

Expand Down
Empty file removed website/build/.gitkeep
Empty file.
8 changes: 4 additions & 4 deletions website/docs/architecture/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ sidebar_label: Overview
---
The Architecture section contains the component overview, sequence diagrams and description of flow of information through the Litmus architecture.

### [Control Plane](chaos-control-plane)
### [Control Plane](chaos-control-plane.md)

Consists of micro-services responsible for the functioning of the ChaosCenter, the web based portal used for creating, scheduling, and monitoring chaos workflows.

### [Execution Plane](chaos-execution-plane)
### [Execution Plane](chaos-execution-plane.md)

Contains the components required for the orchestration of chaos injection in the target resources.

### [Chaos Experiment Flow](chaos-experiment-flow)
### [Chaos Experiment Flow](chaos-experiment-flow.md)

Flow of information during the execution of Litmus chaos experiments, grouped into the categories such as pod-level, node-level, application-level, and public-cloud.

### [Chaos Observability Flow](chaos-observability-flow)
### [Chaos Observability Flow](chaos-observability-flow.md)

Information flow for monitoring and observability during and post chaos using built-in Litmus analytics dashboard as well as external observability tools.
10 changes: 5 additions & 5 deletions website/docs/concepts/app-infra-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Monitor Chaos in your Application/Infrastructure
sidebar_label: Application/Infra Monitoring
---

## Introduction
---

Application OR Infra dashboards provide a way to monitor the chaos impact on application resources, services or cloud infrastructure from within the ChaosCenter. They are user-defined and offer a way to observe systems on ChaosAgent’s cluster in the specified scope (Cluster or Namespace)

Expand All @@ -14,8 +14,8 @@ These dashboards are associated with ChaosAgent(s) and consume a specific Promet

The following should be required before knowing about application or infrastructure monitoring using chaos center:

- [Data Source](../concepts/datasource)
- [Chaos Workflow](../concepts/chaos-workflow)
- [Data Source](datasource.md)
- [Chaos Workflow](chaos-workflow.md)

## Data flow architecture

Expand Down Expand Up @@ -71,5 +71,5 @@ Building a hypothesis around steady-state behaviour, varying real-world events,

## Learn More

- [Observe a Chaos Workflow](../concepts/visualize-workflow)
- [Workflow Statistics](../concepts/workflow-statistics)
- [Observe a Chaos Workflow](visualize-workflow.md)
- [Workflow Statistics](workflow-statistics.md)
6 changes: 3 additions & 3 deletions website/docs/concepts/chaos-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -907,6 +907,6 @@ This CR is also updated/patched with status of the chaos experiments, making it

## Learn More

- [Explore Probes](probes)
- [What is a Chaos Workflow](chaos-workflow)
- [Examine the ChaosResult](chaos-result)
- [Explore Probes](probes.md)
- [What is a Chaos Workflow](chaos-workflow.md)
- [Examine the ChaosResult](chaos-result.md)
2 changes: 1 addition & 1 deletion website/docs/concepts/chaos-experiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: ChaosExperiment

---

ChaosExperiment CR is the heart of litmus and contains the low-level execution information. They serve as off-the-shelf templates that one needs to "pull" (install on the cluster) before including them as part of a chaos run against any target applications (the binding being defined in the [ChaosEngine](../concepts/chaos-engine)). The experiments are installed on the cluster as Kubernetes custom resources and are designed to hold granular details of the experiment such as image, library, necessary permissions, chaos parameters (set to their default values). Most of the ChaosExperiment parameters, are essentially tunables that can be overridden from the ChaosEngine resource. The ChaosExperiment CRs are the primary artifacts hosted on the [ChaosHub](https://hub.litmuschaos.io)
ChaosExperiment CR is the heart of litmus and contains the low-level execution information. They serve as off-the-shelf templates that one needs to "pull" (install on the cluster.md) before including them as part of a chaos run against any target applications (the binding being defined in the [ChaosEngine](chaos-engine.md)). The experiments are installed on the cluster as Kubernetes custom resources and are designed to hold granular details of the experiment such as image, library, necessary permissions, chaos parameters (set to their default values). Most of the ChaosExperiment parameters, are essentially tunables that can be overridden from the ChaosEngine resource. The ChaosExperiment CRs are the primary artifacts hosted on the [ChaosHub](https://hub.litmuschaos.io)

This section describes the fields in the ChaosExperiment spec and the possible values that can be set against the same.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/concepts/chaos-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ ChaosResult resource holds the results of a ChaosExperiment with a namespace sco

## Prerequisites

To understand the concept of ChaosResult, make sure you have good knowledge of the [ChaosEngine](../concepts/chaos-engine) CR and
[Chaos Workflow](../concepts/chaos-workflow).
To understand the concept of ChaosResult, make sure you have good knowledge of the [ChaosEngine](chaos-engine.md) CR and
[Chaos Workflow](chaos-workflow.md).

## ChaosResult Spec

Expand Down Expand Up @@ -345,5 +345,5 @@ ChaosResult resource holds the results of a ChaosExperiment. It comprises of som

## Learn More

- [Run a Chaos Workflow](../getting-started/run-your-first-workflow)
- [Observe a chaos workflow](visualize-workflow)
- [Run a Chaos Workflow](../getting-started/run-your-first-workflow.md)
- [Observe a chaos workflow](visualize-workflow.md)
12 changes: 6 additions & 6 deletions website/docs/concepts/chaos-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The following should be required before creating a Chaos Workflow:

- ChaosCenter
- ChaosAgent
- [Chaos Experiment CR](../concepts/chaos-experiment)
- [ChaosEngine CR](../concepts/chaos-engine)
- [Probes](../concepts/probes)
- [Chaos Experiment CR](chaos-experiment.md)
- [ChaosEngine CR](chaos-engine.md)
- [Probes](probes.md)

## How do we define and execute a workflow?

Expand Down Expand Up @@ -421,6 +421,6 @@ These workflows consist of a cron syntax that is used for scheduling a workflow.

## Learn More

- [Explore Probes](probes)
- [Visualize a Chaos Workflow](visualize-workflow)
- [Examine the ChaosResult](chaos-result)
- [Explore Probes](probes.md)
- [Visualize a Chaos Workflow](visualize-workflow.md)
- [Examine the ChaosResult](chaos-result.md)
4 changes: 2 additions & 2 deletions website/docs/concepts/chaoshub.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,5 +100,5 @@ ChaosHubs are basically a collection of different clones of the Chaos-Charts rep

## Learn More

- [What is a Chaos Workflow](../concepts/chaos-workflow)
- [Examine the ChaosResult](../concepts/chaos-result)
- [What is a Chaos Workflow](chaos-workflow.md)
- [Examine the ChaosResult](chaos-result.md)
8 changes: 4 additions & 4 deletions website/docs/concepts/datasource.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Manage Datasources
sidebar_label: Datasource
---

## Introduction
---

The primary stateful data store for litmus's chaos center is a mongoDB statefulset. It powers all the features in chaos center including authentication, chaos injection and analysis, agent connections etc. Apart from the primary data store, the portal provides a way to add Prometheus (TSDB) data sources for time series data visualization and monitoring. The principle of Open observability drives the chaos center and allows users to manage the data sources for a project in multiple topologies for agent specific and cross agent dashboards. The system allows to either have multiple data sources or a single data source scraping metrics and events from all target agents for monitoring chaos impact on
application OR infrastructure.
Expand All @@ -13,7 +13,7 @@ application OR infrastructure.

The following should be required before knowing about managing data sources in chaos center:

- [Running Chaos Workflows](../getting-started/run-your-first-workflow)
- [Running Chaos Workflows](../getting-started/run-your-first-workflow.md)
- [Prometheus TSDB](https://prometheus.io/)

## Data flow architecture
Expand Down Expand Up @@ -47,5 +47,5 @@ LitmusChaos facilitates in-house real-time monitoring for `events` and `verdicts

## Learn More

- [Visualize a Chaos Workflow](../concepts/visualize-workflow)
- [Application and infrastructure monitoring](../concepts/app-infra-monitoring)
- [Visualize a Chaos Workflow](visualize-workflow.md)
- [Application and infrastructure monitoring](app-infra-monitoring.md)
8 changes: 4 additions & 4 deletions website/docs/concepts/gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: GitOps
## Prerequisites

- ChaosAgent
- [ChaosWorkflow](../concepts/chaos-workflow)
- [ChaosWorkflow](chaos-workflow.md)

GitOps feature in Litmus enables you to configure a single source of truth for your chaos workflows and experiments, any changes made either to the artifacts stored in the configured git repository or the portal will be synced. This allows you to create and execute workflows directly from git enabling a vast scope of automation in CI/CD pipelines.

Expand Down Expand Up @@ -43,6 +43,6 @@ GitOps is by default disabled for the projects created in Litmus, but it can be

## Learn More

- [Configuring GitOps](../user-guides/gitops-configuration)
- [Schedule a workflow](../user-guides/schedule-workflow)
- [Observe a Chaos Workflow](../user-guides/Observe-workflow)
- [Configuring GitOps](../user-guides/gitops-configuration.md)
- [Schedule a workflow](../user-guides/schedule-workflow.md)
- [Observe a Chaos Workflow](../user-guides/observe-workflow.md)
10 changes: 5 additions & 5 deletions website/docs/concepts/open-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ title: Open Observability
sidebar_label: Open Observability
---

## Introduction
---

Litmus 2.0 builds on principle of Open observability through observability hooks such as probes to validate steady state hypothesis along with chaos injection. Chaos exporter also provides prometheus metrics which can be used to generate alerts based on events and also to view chaos impact and application performance in terms of probe success percentage and experiment verdict. It provides for several integration points with Prometheus's alert manager and Grafana, also for the in-house application and infrastructure monitoring capabilities with chaos events, metadata and results.

## Prerequisites

The following should be required before knowing about Open observability hooks in litmus 2.0:

- [Probes](../concepts/probes)
- [Application / Infra. monitoring](../concepts/app-infra-monitoring)
- [Probes](probes.md)
- [Application / Infra. monitoring](app-infra-monitoring.md)

## Probes

Expand All @@ -28,7 +28,7 @@ _Litmus currently supports four types of probes:_

These probes can be used in isolation or in several combinations to achieve the desired checks.

More about Probes can be found [here](../concepts/probes)
More about Probes can be found [here](probes.md)

## Chaos exporter

Expand Down Expand Up @@ -68,4 +68,4 @@ Litmus supports several kinds of `probes` and also has a `chaos-exporter` on it'

- [Prometheus](../integrations/prometheus)
- [Grafana](../integrations/grafana)
- [Application and infrastructure monitoring](../concepts/app-infra-monitoring)
- [Application and infrastructure monitoring](app-infra-monitoring.md)
24 changes: 12 additions & 12 deletions website/docs/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,48 +6,48 @@ 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) 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.

### [Chaos Experiment](chaos-experiment)
### [Chaos Experiment](chaos-experiment.md)

ChaosExperiment CR is the heart of litmus and contains the low-level execution information.

### [Probes](probes)
### [Probes](probes.md)

Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment.

### [ChaosEngine](chaos-engine)
### [ChaosEngine](chaos-engine.md)

The ChaosEngine CR is the main user-facing chaos custom resource with a namespace scope and is designed to hold information around how the chaos experiments are executed.

### [ChaosResult](chaos-result)
### [ChaosResult](chaos-result.md)

ChaosResult resource holds the results of a ChaosExperiment with a namespace scope.

### [ChaosHub](chaoshub)
### [ChaosHub](chaoshub.md)

ChaosHub allows you to orchestrate workflows from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Experiments.

### [Chaos Workflow](chaos-workflow)
### [Chaos Workflow](chaos-workflow.md)

Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment.

### [Observability](workflow-statistics)
### [Observability](workflow-statistics.md)

Monitoring and observability during and post chaos using built-in Litmus analytics dashboard as well as external observability tools.

### [User Management](user-management)
### [User Management](user-management.md)

Role Privileges of different users in the ChaosCenter.

### [Projects](projects)
### [Projects](projects.md)

Project management system which can be used for working on chaos workflows with multiple different projects across different agents.

### [Teaming](probes)
### [Teaming](probes.md)

Teaming feature to facilitate collaboration between users using project level role access.

### [GitOps](gitops)
### [GitOps](gitops.md)

GitOps feature in Litmus enables you to configure a single source of truth for your chaos workflows and experiments.
8 changes: 4 additions & 4 deletions website/docs/concepts/probes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In Litmus, Probes are pluggable checks that can be defined within the ChaosEngin

## Prerequisites

To understand the concepts of Probes better make sure you are aware of the [ChaosEngine](../concepts/chaos-engine) Custom Resources and promql queries (for Prometheus Probes)
To understand the concepts of Probes better make sure you are aware of the [ChaosEngine](chaos-engine.md) Custom Resources and promql queries (for Prometheus Probes)

## Probes

Expand Down Expand Up @@ -54,7 +54,7 @@ The `httpProbe` allows developers to specify a URL which the experiment uses to

In HTTP `Get` method it sends a http `GET` request to the provided url and matches the response code based on the given criteria(`==`, `!=`, `oneOf`).

In HTTP `Post` method it sends a http `POST` request to the provided url. The http body can be provided in the `body` field. In the case of a complex POST request in which the body spans multiple lines, the `bodyPath` attribute can be used to provide the path to a file consisting of the same. This file can be made available to the experiment pod via a ConfigMap resource, with the ConfigMap name being defined in the [ChaosEngine](../concepts/chaos-engine) OR the ChaosExperiment CR.
In HTTP `Post` method it sends a http `POST` request to the provided url. The http body can be provided in the `body` field. In the case of a complex POST request in which the body spans multiple lines, the `bodyPath` attribute can be used to provide the path to a file consisting of the same. This file can be made available to the experiment pod via a ConfigMap resource, with the ConfigMap name being defined in the [ChaosEngine](chaos-engine.md) OR the ChaosExperiment CR.
It can be defined at `.spec.experiments[].spec.probe` inside ChaosEngine.

> `body` and `bodyPath` are mutually exclusive
Expand Down Expand Up @@ -1102,5 +1102,5 @@ Probes can be Chained, Probe chaining enables reuse of probe, the order of execu

## Learn more

- [Explore the ChaosResult Custom Resource](chaos-result)
- [Explore the ChaosEngine Custom Resource](chaos-engine)
- [Explore the ChaosResult Custom Resource](chaos-result.md)
- [Explore the ChaosEngine Custom Resource](chaos-engine.md)
10 changes: 5 additions & 5 deletions website/docs/concepts/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The ChaosCenter comes with a project management system which can be used for wor

## Prerequisites

Before learning abpout the concept of `projects`, it is important to note that a `project` signifies a separation between Agents,Schedules, [Visualization](visualize-workflow), and Teams (discussed in the next section) configurations, and prior knowledge of these will prove fruitful in understanding the concept of `projects` in-depth.
Before learning abpout the concept of `projects`, it is important to note that a `project` signifies a separation between Agents,Schedules, [Visualization](visualize-workflow.md), and Teams (discussed in the next section) configurations, and prior knowledge of these will prove fruitful in understanding the concept of `projects` in-depth.

## Projects

Expand All @@ -22,14 +22,14 @@ The specifics of project management with respect to different first layer privil

The **Admin** user of the portal has a default project (named as `admin’s project`) created on the initial login, and by default has the `owner` privileges in this project.

The Admin can [create a user](../user-guides/create-user) (these users will be treated as **non-admin** users), and each of these users will have their own projects created on completion of their initial login. The `Owner` of a project can invite multiple users to their project, and a user can be a part of multiple projects, these features are covered under the [teaming](teaming) section.
The Admin can [create a user](../user-guides/create-user.md) (these users will be treated as **non-admin** users), and each of these users will have their own projects created on completion of their initial login. The `Owner` of a project can invite multiple users to their project, and a user can be a part of multiple projects, these features are covered under the [teaming](teaming.md) section.

## Summary

Projects can be imagined as separations between multiple different configurations for your chaos and help you manage collaborations between multiple teams.

## Learn more

- [More about project management](../user-guides/change-project-name)
- [More about Teaming](../concepts/teaming)
- [Invite a member to your project](../user-guides/invite-team-member)
- [More about project management](../user-guides/change-project-name.md)
- [More about Teaming](teaming.md)
- [Invite a member to your project](../user-guides/invite-team-member.md)
8 changes: 4 additions & 4 deletions website/docs/concepts/teaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Teaming is based on the following principles and each user can have one of the 3
## Learn more

- [Invite a team member](../user-guides/invite-team-member)
- [Edit/Cancel an invite](../user-guides/edit-invite)
- [Accept an invite](../user-guides/accept-invite)
- [Remove a team member](../user-guides/remove-team-member)
- [Invite a team member](../user-guides/invite-team-member.md)
- [Edit/Cancel an invite](../user-guides/edit-invite.md)
- [Accept an invite](../user-guides/accept-invite.md)
- [Remove a team member](../user-guides/remove-team-member.md)
10 changes: 5 additions & 5 deletions website/docs/concepts/user-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_label: User Management

The ChaosCenter supports two different levels of hierarchy, a portal level access, and a project level access.

> This section discusses the detailed breakdown of the portal level roles a user may have. For project level roles refer [here](teaming).
> This section discusses the detailed breakdown of the portal level roles a user may have. For project level roles refer [here](teaming.md).
## Portal level user Roles (Admin, Non-Admins)

Expand All @@ -26,7 +26,7 @@ ChaosCenter supports two portal level roles for defining the privilege levels of

## Learn more

- [View Users](../user-guides/view-user)
- [Create a user](../user-guides/create-user)
- [Reset password of a user](../user-guides/reset-password)
- [Deactivate a user](../user-guides/deactivate-user)
- [View Users](../user-guides/view-user.md)
- [Create a user](../user-guides/create-user.md)
- [Reset password of a user](../user-guides/reset-password.md)
- [Deactivate a user](../user-guides/deactivate-user.md)
8 changes: 4 additions & 4 deletions website/docs/concepts/visualize-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ With ChaosCenter, the real-time data and status of the workflows can be observed
The following should be required before creating a Chaos Workflow:

- ChaosCenter
- [Workflows](../concepts/chaos-workflow)
- [Workflows](chaos-workflow.md)

## Litmus Workflow

Expand Down Expand Up @@ -66,6 +66,6 @@ After scheduling a workflow, a user can view the details of the running workflow

## Learn More

- [Explore Probes](../concepts/probes)
- [What is a Chaos Workflow](../concepts/chaos-workflow)
- [Examine the ChaosResult](../concepts/chaos-result)
- [Explore Probes](probes.md)
- [What is a Chaos Workflow](chaos-workflow.md)
- [Examine the ChaosResult](chaos-result.md)
Loading

0 comments on commit 3487c11

Please sign in to comment.