Skip to content

Commit ece4adc

Browse files
Updated chaos control plane arch (#159)
Signed-off-by: SarthakJain26 <[email protected]>
1 parent f459d39 commit ece4adc

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

website/docs/architecture/chaos-control-plane.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Chaos Control Plane consists of micro-services responsible for the functioning o
1212

1313
## Chaos Control Plane Components
1414

15-
* **Authentication Server:** A Golang micro-service that is responsible for authorizing as well as authenticating the requests received from Chaos Center. It primarily serves the cause of user creation, user login, reset the password, and update user information.
15+
* **Authentication Server:** A Golang micro-service that is responsible for authorizing, authenticating the requests received from Chaos Center and managing users along with their projects. It primarily serves the cause of user creation, user login, resetting the password, updating user information, creating project, managing project related operations.
1616

1717
* **Backend Server:** A GraphQL based Golang micro-service that serves the requests received from Chaos Center, by either querying the database for the relevant information or by fetching information from the Execution Plane.
1818

@@ -26,13 +26,13 @@ Chaos Control Plane consists of micro-services responsible for the functioning o
2626

2727
* **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:
2828

29-
* **Litmus Authentication API:** Used to authenticate the idenity of a user and to perform several user-specific tasks like update profile, change password, reset password, create new users, etc. It uses the Authentication Server to perform these tasks.
29+
* **Litmus Authentication API:** Used to authenticate the identity of a user and to perform several user and project specific tasks like create new users, update profile, update password, create project, invite users to project, get project details etc. It uses the Authentication Server to perform these tasks.
3030

3131
* **Litmus Portal API:** Provides command-line and UI experience for managing and monitoring the events around chaos workflows. It uses the Backend Server to perform its functions.
3232

3333
## Standard Chaos Control Plane Flow
3434

35-
1. The User logs in to the ChaosCenter using a valid login credential. Every user is a part of a project and has a role assigned to them. To schedule a workflow, the user needs to have an Editor or Owner role assigned in the project.
35+
1. The User logs in to the ChaosCenter using a valid login credential. A default project is created for the user on initial login. Every user is a part of a project and has a role assigned to them. To schedule a workflow, the user needs to have an Editor or Owner role assigned in the project.
3636
2. The user uploads a Chaos Workflow manifest using the ChaosCenter, which is received by the Backend Server.
3737
3. Backend Server stores the manifest in the Database and also sends it to the Chaos Agent.
3838
4. Chaos Agent uses the Chaos Workflow manifest to inject chaos into the target resources. The steps of the Chaos Workflow execution can be visualized using the ChaosCenter.
15.6 KB
Loading

website/versioned_docs/version-2.4.0/architecture/chaos-control-plane.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Chaos Control Plane consists of micro-services responsible for the functioning o
1212

1313
## Chaos Control Plane Components
1414

15-
* **Authentication Server:** A Golang micro-service that is responsible for authorizing as well as authenticating the requests received from Chaos Center. It primarily serves the cause of user creation, user login, reset the password, and update user information.
15+
* **Authentication Server:** A Golang micro-service that is responsible for authorizing, authenticating the requests received from Chaos Center and managing users along with their projects. It primarily serves the cause of user creation, user login, resetting the password, updating user information, creating project, managing project related operations.
1616

1717
* **Backend Server:** A GraphQL based Golang micro-service that serves the requests received from Chaos Center, by either querying the database for the relevant information or by fetching information from the Execution Plane.
1818

@@ -26,13 +26,13 @@ Chaos Control Plane consists of micro-services responsible for the functioning o
2626

2727
* **Litmus API:** Refers to two different Litmus APIs, namely Litmus Authentication API and Litmus Portal API:
2828

29-
* **Litmus Authentication API:** Used to authenticate the idenity of a user and to perform several user-specific tasks like update profile, change password, reset password, create new users, etc. It uses the Authentication Server to perform these tasks.
29+
* **Litmus Authentication API:** Used to authenticate the identity of a user and to perform several user and project specific tasks like create new users, update profile, update password, create project, invite users to project, get project details etc. It uses the Authentication Server to perform these tasks.
3030

3131
* **Litmus Portal API:** Provides command-line and UI experience for managing and monitoring the events around chaos workflows. It uses the Backend Server to perform its functions.
3232

3333
## Standard Chaos Control Plane Flow
3434

35-
1. The User logs in to the ChaosCenter using a valid login credential. Every user is a part of a project and has a role assigned to them. To schedule a workflow, the user needs to have an Editor or Owner role assigned in the project.
35+
1. The User logs in to the ChaosCenter using a valid login credential. A default project is created for the user on initial login. Every user is a part of a project and has a role assigned to them. To schedule a workflow, the user needs to have an Editor or Owner role assigned in the project.
3636
2. The user uploads a Chaos Workflow manifest using the ChaosCenter, which is received by the Backend Server.
3737
3. Backend Server stores the manifest in the Database and also sends it to the Chaos Agent.
3838
4. Chaos Agent uses the Chaos Workflow manifest to inject chaos into the target resources. The steps of the Chaos Workflow execution can be visualized using the ChaosCenter.
15.6 KB
Loading

0 commit comments

Comments
 (0)