Skip to content

Commit 564eb2b

Browse files
authored
Fix URLs to install and estrcuture quickstart file. (#12)
1 parent 5904218 commit 564eb2b

File tree

1 file changed

+31
-16
lines changed

1 file changed

+31
-16
lines changed

docs/quickstart.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,27 @@ SPDX-License-Identifier: CC-BY-4.0
88
# 🚀 Quick Start
99

1010
> [!IMPORTANT]
11-
> **Prerequisites**: You need to have **cert-manager** installed in your cluster before deploying the operator.
11+
> **Prerequisites**: Ensure **cert-manager** is installed in your cluster before deploying the operator.
12+
1213

1314
Choose your preferred installation method:
1415

15-
### 📦 Installation Methods
16+
## 📦 Installation Methods
1617

17-
<details>
18-
<summary><strong>🎯 Method 1: Helm Installation (Recommended)</strong></summary>
18+
### 🎯 Method 1: Helm Installation (Recommended)
1919

2020
#### 1️⃣ Clone the Repository
2121

22+
Clone the repository to your local machine:
23+
2224
```bash
2325
git clone https://github.com/InditexTech/k8s-overcommit-operator.git
2426
cd k8s-overcommit-operator
2527
```
2628

2729
#### 2️⃣ Configure Values
2830

29-
Edit the [`chart/values.yaml`](chart/values.yaml) file to customize your deployment:
31+
Edit the [`values.yaml`](../chart/values.yaml) file to customize your deployment. Below is an example configuration:
3032

3133
```yaml
3234
# Example configuration
@@ -39,32 +41,33 @@ deployment:
3941
4042
#### 3️⃣ Install with Helm
4143
44+
Install the operator using Helm:
45+
4246
```bash
4347
helm install k8s-overcommit-operator chart
4448
```
4549

46-
</details>
47-
48-
<details>
49-
<summary><strong>🔧 Method 2: OLM Installation</strong></summary>
50+
### 🔧 Method 2: OLM Installation
5051

51-
#### 1️⃣ Install the catalog source
52+
#### 1️⃣ Install the CatalogSource
5253

53-
For OpenShift or clusters with OLM installed:
54+
For OpenShift or clusters with OLM installed, apply the catalog source:
5455

5556
```bash
56-
kubectl apply -f https://github.com/InditexTech/k8s-overcommit-operator/deploy/catalog_source.yaml
57+
kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/catalog_source.yaml
5758
```
5859

59-
#### 2️⃣ Apply the operatorGroup
60+
#### 2️⃣ Apply the OperatorGroup
61+
62+
Apply the operator group configuration:
6063

6164
```bash
62-
kubectl apply -f https://github.com/InditexTech/k8s-overcommit-operator/deploy/operator_group.yaml
65+
kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/operator_group.yaml
6366
```
6467

6568
#### 3️⃣ Create the Subscription (Alternative)
6669

67-
You can create your own or use the one in the route *https://github.com/InditexTech/k8s-overcommit-operator/deploy/subscription.yaml*
70+
You can create your own subscription or use the default [`subscription.yaml`](../deploy/subscription.yaml). Below is an example:
6871

6972
```yaml
7073
apiVersion: operators.coreos.com/v1alphav1
@@ -79,4 +82,16 @@ spec:
7982
sourceNamespace: olm
8083
```
8184
82-
</details>
85+
Apply the subscription:
86+
87+
```bash
88+
kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/subscription.yaml
89+
```
90+
91+
#### 4️⃣ Validation
92+
93+
After installation, validate that the operator is running:
94+
95+
```bash
96+
kubectl get pods -n k8s-overcommit
97+
```

0 commit comments

Comments
 (0)