Add ChaosCenter developer guide docs locally #282
Conversation
kwx4957
requested review from
divya-mohan0209,
ksatchit and
k8s-dev
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
||
| ## **Prerequisites** | ||
| :::note | ||
| This document is ietented to be implemented locally. Please do not use in dev or prod environmentss |
There was a problem hiding this comment.
| This document is ietented to be implemented locally. Please do not use in dev or prod environmentss | |
| This document is intended to be implemented locally. Please do not use it in dev or prod environments. |
|
|
||
| ## **Control Plane** | ||
| Backend components consist of three microservices | ||
| 1. GraphQL-Server |
There was a problem hiding this comment.
| 1. GraphQL-Server | |
| 1. Backend server |
There was a problem hiding this comment.
I think it's fine to have graphql server since we have 2 backend servers
There was a problem hiding this comment.
Shoud we use graphql server for the name??
in docs using graphql
| ## **Control Plane** | ||
| Backend components consist of three microservices | ||
| 1. GraphQL-Server | ||
| 2. Authentication-Server |
There was a problem hiding this comment.
| 2. Authentication-Server | |
| 2. Authentication server |
| Windows | ||
| ```bash | ||
| # add hosts in hosts | ||
| notepad C:\Windows\System32\drivers\etc\hosts | ||
|
|
||
| # add the below line | ||
| 127.0.0.1 m1 m2 m3 | ||
| ``` | ||
|
|
||
| Linux/Mac | ||
| ```bash | ||
| # add hosts in hosts | ||
| sudo vim /etc/hosts | ||
|
|
||
| # add the below line | ||
| 127.0.0.1 m1 m2 m3 | ||
| ``` | ||
|
|
||
|
|
||
| Step-3: Configure the mongoDB replica set | ||
|
|
||
| ```bash | ||
| docker exec -it m1 mongo -port 27015 | ||
|
|
||
| config={"_id":"rs0","members":[{"_id":0,"host":"m1:27015"},{"_id":1,"host":"m2:27016"},{"_id":2,"host":"m3:27017"}]} | ||
|
|
||
| rs.initiate(config) | ||
|
|
||
| db.getSiblingDB("admin").createUser({user:"admin",pwd:"1234",roles:[{role:"root",db:"admin"}]}); | ||
| ``` |
There was a problem hiding this comment.
We should use Docusaurus tabs for individual infra types to show them. Please refactor in all the places.
|
CC: @Saranya-jena please review to validate the content. |
|
@kwx4957 thanks for the PR, it looks good, please make the suggested changes. |
| export HUB_BRANCH_NAME=v2.0.x | ||
| export INFRA_DEPLOYMENTS="[\"app=chaos-exporter\", \"name=chaos-operator\", \"app=event-tracker\",\"app=workflow-controller\"]" | ||
| export INFRA_COMPATIBLE_VERSIONS='["0.2.0", "0.1.0","ci"]' | ||
| export DEFAULT_HUB_BRANCH_NAME=master |
There was a problem hiding this comment.
We have updated the envs in the wiki, can you update them here as well?
There was a problem hiding this comment.
yes, sure. I'll update
|
@neelanjan00 thanks for reviews, i will refactor and apply suggestions changes!! |
Signed-off-by: DongYoung Kim <[email protected]>
Signed-off-by: DongYoung Kim <[email protected]>
Signed-off-by: kwx4957 <[email protected]>
Signed-off-by: DongYoung Kim <[email protected]>
|
@Saranya-jena just wondering if it is a good idea to keep developer docs in the same place as end-user docs? As per convention, it should be present in the GitHub repository readme itself. |
|
@kwx4957, This is added in 3.9.1 versioned docs, can you also add this in all the later versions and into master as well so that it gets into every version in future? |
|
@hrishavjha yes, i can. i will keep updated on future versions |
Signed-off-by: DongYoung Kim <[email protected]>
Signed-off-by: DongYoung Kim <[email protected]>
Signed-off-by: DongYoung Kim <[email protected]>
What this PR does / why we need it:
Currently, the development document has not been updated. It will not work if build development environment for the code according to the development document.
Preview Link
Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close that issue when PR gets merged): fixes #Special notes for your reviewer:
Checklist:
documentationtag