Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 29 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,26 +52,20 @@ The **k8s-overcommit Operator** is a Kubernetes operator designed to intelligent

## 🚀 Quick Start

> [!IMPORTANT]
> **Prerequisites**: You need to have **cert-manager** installed in your cluster before deploying the operator.

Choose your preferred installation method:

### 📦 Installation Methods

<details>
<summary><strong>🎯 Method 1: Helm Installation (Recommended)</strong></summary>
### 🎯 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
```

#### 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
Expand All @@ -84,32 +78,33 @@ deployment:

#### 3️⃣ Install with Helm

Install the operator using Helm:

```bash
helm install k8s-overcommit-operator chart
```

</details>

<details>
<summary><strong>🔧 Method 2: OLM Installation</strong></summary>
### 🔧 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
Expand All @@ -124,7 +119,20 @@ spec:
sourceNamespace: olm
```

</details>
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
```


## 📝 Configuration

Expand Down
3 changes: 1 addition & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ SPDX-License-Identifier: CC-BY-4.0
> [!IMPORTANT]
> **Prerequisites**: Ensure **cert-manager** is installed in your cluster before deploying the operator.


Choose your preferred installation method:

## 📦 Installation Methods
Expand Down Expand Up @@ -70,7 +69,7 @@ kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-op
You can create your own subscription or use the default [`subscription.yaml`](../deploy/subscription.yaml). Below is an example:

```yaml
apiVersion: operators.coreos.com/v1alphav1
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: k8s-overcommit-operator
Expand Down