@@ -52,26 +52,20 @@ The **k8s-overcommit Operator** is a Kubernetes operator designed to intelligent
5252
5353## 🚀 Quick Start
5454
55- > [ !IMPORTANT]
56- > ** Prerequisites** : You need to have ** cert-manager** installed in your cluster before deploying the operator.
57-
58- Choose your preferred installation method:
59-
60- ### 📦 Installation Methods
61-
62- <details >
63- <summary ><strong >🎯 Method 1: Helm Installation (Recommended)</strong ></summary >
55+ ### 🎯 Method 1: Helm Installation (Recommended)
6456
6557#### 1️⃣ Clone the Repository
6658
59+ Clone the repository to your local machine:
60+
6761``` bash
6862git clone https://github.com/InditexTech/k8s-overcommit-operator.git
6963cd k8s-overcommit-operator
7064```
7165
7266#### 2️⃣ Configure Values
7367
74- Edit the [ ` chart/ values.yaml` ] ( chart/values.yaml ) file to customize your deployment:
68+ Edit the [ ` values.yaml ` ] ( ../ chart/values.yaml) file to customize your deployment. Below is an example configuration :
7569
7670``` yaml
7771# Example configuration
@@ -84,32 +78,33 @@ deployment:
8478
8579#### 3️⃣ Install with Helm
8680
81+ Install the operator using Helm:
82+
8783` ` ` bash
8884helm install k8s-overcommit-operator chart
8985```
9086
91- </details >
92-
93- <details >
94- <summary ><strong >🔧 Method 2: OLM Installation</strong ></summary >
87+ ### 🔧 Method 2: OLM Installation
9588
96- #### 1️⃣ Install the catalog source
89+ #### 1️⃣ Install the CatalogSource
9790
98- For OpenShift or clusters with OLM installed:
91+ For OpenShift or clusters with OLM installed, apply the catalog source :
9992
10093``` bash
101- kubectl apply -f https://github. com/InditexTech/k8s-overcommit-operator/deploy/catalog_source.yaml
94+ kubectl apply -f https://raw.githubusercontent. com/InditexTech/k8s-overcommit-operator/refs/heads/main /deploy/catalog_source.yaml
10295```
10396
104- #### 2️⃣ Apply the operatorGroup
97+ #### 2️⃣ Apply the OperatorGroup
98+
99+ Apply the operator group configuration:
105100
106101``` bash
107- kubectl apply -f https://github. com/InditexTech/k8s-overcommit-operator/deploy/operator_group.yaml
102+ kubectl apply -f https://raw.githubusercontent. com/InditexTech/k8s-overcommit-operator/refs/heads/main /deploy/operator_group.yaml
108103```
109104
110105#### 3️⃣ Create the Subscription (Alternative)
111106
112- You can create your own or use the one in the route * https://github.com/InditexTech/k8s-overcommit-operator/ deploy/subscription.yaml*
107+ You can create your own subscription or use the default [ ` subscription.yaml ` ] ( ../ deploy/subscription.yaml) . Below is an example:
113108
114109``` yaml
115110apiVersion : operators.coreos.com/v1alpha1
@@ -124,7 +119,20 @@ spec:
124119 sourceNamespace : olm
125120` ` `
126121
127- </details>
122+ Apply the subscription:
123+
124+ ` ` ` bash
125+ kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/subscription.yaml
126+ ```
127+
128+ #### 4️⃣ Validation
129+
130+ After installation, validate that the operator is running:
131+
132+ ``` bash
133+ kubectl get pods -n k8s-overcommit
134+ ```
135+
128136
129137## 📝 Configuration
130138
0 commit comments