Skip to content

Commit 64882c6

Browse files
committed
Update README
Signed-off-by: JeffMboya <[email protected]>
1 parent c229ad3 commit 64882c6

File tree

2 files changed

+366
-55
lines changed

2 files changed

+366
-55
lines changed

README.md

+66-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,74 @@
11
## DevOps
22

3-
DevOps scripts for Magistrala IoT platform
3+
Scripts for managing the Magistrala IoT platform.
44

5-
## Install
5+
## Prerequisites
66

7-
Follow the instructions in [`charts`](charts) directory.
7+
Make sure [Helm](https://helm.sh) is installed. If not, follow the [Helm documentation](https://helm.sh/docs) to get started.
88

9-
Detailed documentation can be found [here](https://docs.magistrala.abstractmachines.fr/kubernetes/).
9+
## Usage Instructions
10+
11+
### Step 1: Add the Magistrala DevOps Repository
12+
13+
After installing Helm, add the Magistrala DevOps Helm repository by running:
14+
15+
```bash
16+
helm repo add <name> https://absmach.github.io/devops/
17+
```
18+
19+
- Replace `<name>` with a repository alias of your choice. This alias will be used in future Helm commands.
20+
**Example**:
21+
22+
```bash
23+
helm repo add magistrala-devops https://absmach.github.io/devops/
24+
```
25+
26+
### Step 2: Install the Magistrala Chart
27+
28+
To install the Magistrala chart, run:
29+
30+
```bash
31+
helm install my-magistrala magistrala-devops/magistrala --version 1.0.6
32+
```
33+
34+
- `my-magistrala`: Choose a release name for the installation.
35+
- `magistrala-devops/magistrala`: Refers to the chart in the added repository.
36+
- `--version 1.0.6`: Installs version 1.0.6 of the chart.
37+
38+
To customize the installation, you can:
39+
- Use the `--values` flag to provide a custom values file.
40+
- Use the `--set` flag for inline configuration changes.
41+
42+
### Step 3: Update the Repository
43+
44+
If you’ve already added the Magistrala repo, update it to fetch the latest chart versions:
45+
46+
```bash
47+
helm repo update
48+
```
49+
50+
### Step 4: Search for Charts
51+
52+
To search for charts by keyword in the repository:
53+
54+
```bash
55+
helm search repo [keyword]
56+
```
57+
58+
### Step 5: Uninstall the Magistrala Chart
59+
60+
When you no longer need the chart, uninstall it by running:
61+
62+
```bash
63+
helm uninstall my-magistrala
64+
```
65+
66+
- Replace `my-magistrala` with the release name you used during installation. This command removes all resources created by the chart and clears the release history.
67+
68+
For further details, refer to the [Magistrala Kubernetes documentation](https://docs.magistrala.abstractmachines.fr/kubernetes/).
1069

1170
## License
1271

13-
[Apace-2.0](LICENSE)
72+
This project is licensed under the [Apache-2.0](LICENSE).
73+
74+
---

0 commit comments

Comments
 (0)