Skip to content

Commit 5c1854e

Browse files
PriteshKiriPriteshKiri
authored
Helm dex setup (#340)
* update: doc version to 3.21.0 Signed-off-by: PriteshKiri <pritesh.d.kiri@gmail.com> * add: helm dex setup Signed-off-by: PriteshKiri <pritesh.d.kiri@gmail.com> * fix: removed gitlab Signed-off-by: PriteshKiri <pritesh.d.kiri@gmail.com> --------- Signed-off-by: PriteshKiri <pritesh.d.kiri@gmail.com>
1 parent f6a066b commit 5c1854e

File tree

6 files changed

+173
-24
lines changed

6 files changed

+173
-24
lines changed

‎website/docs/litmusctl/additional-commands.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
id: additional-commands
3+
title: Additional Commands
4+
sidebar_label: Additional Commands
5+
---
6+
7+
8+
9+
This guide covers additional litmusctl commands for managing your ChaosCenter account, projects, environments, and chaos infrastructures.
10+
11+
Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#additional-commands) to learn more about litmusctl commands.

‎website/docs/litmusctl/connect-chaos-infrastructure.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
id: connect-chaos-infrastructure
3+
title: Connect Chaos Infrastructure
4+
sidebar_label: Connect Chaos Infrastructure
5+
---
6+
7+
8+
9+
This guide walks you through connecting a Chaos Infrastructure to your ChaosCenter using litmusctl. A Chaos Infrastructure is required to run chaos experiments in your Kubernetes cluster.
10+
11+
Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture) to connect a Chaos Infrastructure.

‎website/docs/litmusctl/create-chaos-experiment.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
id: create-chaos-experiment
3+
title: Create Chaos Experiment
4+
sidebar_label: Create Chaos Experiment
5+
---
6+
7+
8+
This guide demonstrates how to create and run chaos experiments using litmusctl. You can create experiments using manifest files and manage them through the command line interface.
9+
10+
Follow this [guide](https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#steps-to-create-a-chaos-experiment) to create Chaos Experiment.

‎website/docs/litmusctl/litmusctl-usage.md‎

Lines changed: 49 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,55 @@
11
---
22
id: litmusctl-usage
3-
title: Litmusctl Usage
4-
sidebar_label: Litmusctl Usage
3+
title: Overview
4+
sidebar_label: Usage Overview
55
---
66

77
---
88

9-
<table>
10-
<tr>
11-
<th>Topic</th>
12-
<th>User Guides</th>
13-
</tr>
14-
<tr>
15-
<td>Connect Chaos Infrastructure</td>
16-
<td><a href="https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#steps-to-connect-a-chaos-infrastucture">Click Here</a></td>
17-
</tr>
18-
<tr>
19-
<td>Create Chaos Experiment</td>
20-
<td><a href="https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#steps-to-create-a-chaos-experiment">Click Here</a></td>
21-
</tr>
22-
<tr>
23-
<td>Additional Commands</td>
24-
<td><a href="https://github.com/litmuschaos/litmusctl/blob/master/Usage_0.23.0.md#additional-commands">Click Here</a></td>
25-
</tr>
26-
</table>
9+
This section provides comprehensive guides for using litmusctl to manage your chaos engineering workflows. litmusctl is the command-line interface for LitmusChaos that enables you to interact with ChaosCenter and manage chaos experiments from your terminal.
10+
11+
## What You Can Do with litmusctl
12+
13+
With litmusctl, you can:
14+
15+
- **Connect Chaos Infrastructure**: Set up and connect chaos infrastructure to your ChaosCenter
16+
- **Create and Manage Experiments**: Design, create, and run chaos experiments using manifest files
17+
- **Manage Projects and Environments**: Organize your chaos engineering efforts across different projects and environments
18+
- **Monitor and Control**: Track experiment status and manage your chaos engineering resources
19+
20+
## Getting Started
21+
22+
Before diving into the specific usage guides, ensure you have:
23+
24+
1. **litmusctl installed** - Follow the [installation guide](installation.md)
25+
2. **Access to ChaosCenter** - You'll need valid credentials for your ChaosCenter instance
26+
3. **Kubernetes cluster access** - Required for connecting chaos infrastructure
27+
28+
## Usage Guides
29+
30+
The following guides will walk you through the key litmusctl workflows:
31+
32+
### [Connect Chaos Infrastructure](connect-chaos-infrastructure.md)
33+
Learn how to connect a chaos infrastructure to your ChaosCenter. This is typically the first step after installation, allowing you to run chaos experiments in your Kubernetes cluster.
34+
35+
### [Create Chaos Experiment](create-chaos-experiment.md)
36+
Discover how to create and run chaos experiments using litmusctl. This guide covers creating experiments from manifest files, running them, and monitoring their progress.
37+
38+
### [Additional Commands](additional-commands.md)
39+
Explore additional litmusctl commands for account management, project operations, environment handling, and infrastructure management.
40+
41+
## Quick Reference
42+
43+
| Task | Command |
44+
|------|---------|
45+
| Setup account | `litmusctl config set-account` |
46+
| Connect infrastructure | `litmusctl connect chaos-infra` |
47+
| Create experiment | `litmusctl create chaos-experiment -f <file>` |
48+
| List projects | `litmusctl get projects` |
49+
| List infrastructures | `litmusctl get chaos-infra` |
50+
51+
## Next Steps
52+
53+
1. Start with [Connect Chaos Infrastructure](connect-chaos-infrastructure.md) to set up your first chaos infrastructure
54+
2. Move on to [Create Chaos Experiment](create-chaos-experiment.md) to run your first experiment
55+
3. Explore [Additional Commands](additional-commands.md) for advanced usage and management tasks

‎website/docs/user-guides/setup-with-helm.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
id: setup-with-helm
3+
title: Install ChaosCenter with Helm
4+
sidebar_label: Setup with Helm
5+
---
6+
7+
---
8+
9+
If you prefer to install and configure Dex via the LitmusChaos Helm chart, you can provide the required environment variables through a `values.yaml` file.
10+
11+
## Prerequisites
12+
Add Litmus Helm Repository
13+
14+
```bash
15+
helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/
16+
helm repo update
17+
```
18+
19+
## Create a values file
20+
Create a file named dex-values.yaml and add the required configuration:
21+
22+
```yaml
23+
chaoscenter:
24+
dex:
25+
enabled: true
26+
env:
27+
- name: DEX_ENABLED
28+
value: "true"
29+
- name: OIDC_ISSUER
30+
value: "<https://accounts.google.com>" # Example: Google, GitHub issuer URL
31+
- name: DEX_OAUTH_CALLBACK_URL
32+
value: "http://<chaoscenter-host>/auth/callback"
33+
- name: DEX_OAUTH_CLIENT_ID
34+
value: "<your-client-id>"
35+
- name: DEX_OAUTH_CLIENT_SECRET
36+
value: "<your-client-secret>"
37+
```
38+
39+
:::note
40+
- Replace `<chaoscenter-host>`, `<your-client-id>`, and `<your-client-secret>` with your actual values from the OAuth provider configuration.
41+
- For Google/GitHub, use their respective OIDC issuer URL.
42+
:::
43+
44+
## Install ChaosCenter with Dex enabled
45+
46+
```bash
47+
helm install chaos litmuschaos/litmus \
48+
-n litmus \
49+
--create-namespace \
50+
-f dex-values.yaml
51+
```
52+
53+
## Upgrade (if ChaosCenter already installed)
54+
55+
```bash
56+
helm upgrade chaos litmuschaos/litmus \
57+
-n litmus \
58+
-f dex-values.yaml
59+
```
60+
61+
## Verify the installation
62+
63+
- Check if the Dex pod is running:
64+
65+
```bash
66+
kubectl get pods -n litmus | grep dex
67+
```
68+
69+
Open the ChaosCenter UI and log in with your configured OAuth provider.
70+
71+
72+
## Learn more
73+
74+
- [Setup Endpoints and Access ChaosCenter without Ingress](setup-without-ingress.md)
75+
- [Install ChaosCenter with HTTP](../getting-started/installation.md)
76+
- [Install ChaosCenter with HTTPS](chaoscenter-advanced-installation.md)

‎website/sidebars.js‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ module.exports = {
8181
'user-guides/chaoscenter-oauth-dex-installation',
8282
'user-guides/chaoscenter-advanced-installation',
8383
'user-guides/setup-without-ingress',
84-
'user-guides/setup-with-ingress'
84+
'user-guides/setup-with-ingress',
85+
'user-guides/setup-with-helm'
8586
]
86-
},
87-
'user-guides/chaos-infrastructure-installation'
87+
}
8888
]
8989
},
9090
{
@@ -147,7 +147,19 @@ module.exports = {
147147
className: 'category-as-header',
148148
collapsed: false,
149149
collapsible: false,
150-
items: ['litmusctl/installation', 'litmusctl/litmusctl-usage']
150+
items: [
151+
'litmusctl/installation',
152+
{
153+
type: 'category',
154+
label: 'Litmusctl Usage',
155+
items: [
156+
'litmusctl/litmusctl-usage',
157+
'litmusctl/connect-chaos-infrastructure',
158+
'litmusctl/create-chaos-experiment',
159+
'litmusctl/additional-commands'
160+
]
161+
}
162+
]
151163
},
152164
{
153165
type: 'category',

0 commit comments

Comments
 (0)