From d386d18913b41dc553e20777f80035fc0c50c56e Mon Sep 17 00:00:00 2001 From: Javier Terceiro Date: Wed, 2 Jul 2025 16:30:27 +0200 Subject: [PATCH] Fix URLs to install and estrcuture quickstart file. --- docs/quickstart.md | 47 ++++++++++++++++++++++++++++++---------------- 1 file changed, 31 insertions(+), 16 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 7778c68..0cce48c 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -8,17 +8,19 @@ SPDX-License-Identifier: CC-BY-4.0 # 🚀 Quick Start > [!IMPORTANT] -> **Prerequisites**: You need to have **cert-manager** installed in your cluster before deploying the operator. +> **Prerequisites**: Ensure **cert-manager** is installed in your cluster before deploying the operator. + Choose your preferred installation method: -### 📦 Installation Methods +## 📦 Installation Methods -
-🎯 Method 1: Helm Installation (Recommended) +### 🎯 Method 1: Helm Installation (Recommended) #### 1️⃣ Clone the Repository +Clone the repository to your local machine: + ```bash git clone https://github.com/InditexTech/k8s-overcommit-operator.git cd k8s-overcommit-operator @@ -26,7 +28,7 @@ cd k8s-overcommit-operator #### 2️⃣ Configure Values -Edit the [`chart/values.yaml`](chart/values.yaml) file to customize your deployment: +Edit the [`values.yaml`](../chart/values.yaml) file to customize your deployment. Below is an example configuration: ```yaml # Example configuration @@ -39,32 +41,33 @@ deployment: #### 3️⃣ Install with Helm +Install the operator using Helm: + ```bash helm install k8s-overcommit-operator chart ``` -
- -
-🔧 Method 2: OLM Installation +### 🔧 Method 2: OLM Installation -#### 1️⃣ Install the catalog source +#### 1️⃣ Install the CatalogSource -For OpenShift or clusters with OLM installed: +For OpenShift or clusters with OLM installed, apply the catalog source: ```bash -kubectl apply -f https://github.com/InditexTech/k8s-overcommit-operator/deploy/catalog_source.yaml +kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/catalog_source.yaml ``` -#### 2️⃣ Apply the operatorGroup +#### 2️⃣ Apply the OperatorGroup + +Apply the operator group configuration: ```bash -kubectl apply -f https://github.com/InditexTech/k8s-overcommit-operator/deploy/operator_group.yaml +kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/operator_group.yaml ``` #### 3️⃣ Create the Subscription (Alternative) -You can create your own or use the one in the route *https://github.com/InditexTech/k8s-overcommit-operator/deploy/subscription.yaml* +You can create your own subscription or use the default [`subscription.yaml`](../deploy/subscription.yaml). Below is an example: ```yaml apiVersion: operators.coreos.com/v1alpha1 @@ -79,4 +82,16 @@ spec: sourceNamespace: olm ``` -
+Apply the subscription: + +```bash +kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/subscription.yaml +``` + +#### 4️⃣ Validation + +After installation, validate that the operator is running: + +```bash +kubectl get pods -n k8s-overcommit +```