Skip to content

quickstart.md

Latest commit

 

History

History
96 lines (66 loc) · 2.23 KB

quickstart.md

File metadata and controls

96 lines (66 loc) · 2.23 KB

🚀 Quick Start

Important

Prerequisites: Ensure cert-manager is installed in your cluster before deploying the operator.

Choose your preferred installation method:

📦 Installation Methods

🎯 Method 1: Helm Installation (Recommended)

1️⃣ Clone the Repository

Clone the repository to your local machine:

git clone https://github.com/InditexTech/k8s-overcommit-operator.git
cd k8s-overcommit-operator

2️⃣ Configure Values

Edit the values.yaml file to customize your deployment. Below is an example configuration:

# Example configuration
deployment:
  image:
    registry: ghcr.io
    image: inditextech/k8s-overcommit-operator
    tag: 1.0.0

3️⃣ Install with Helm

Install the operator using Helm:

helm install k8s-overcommit-operator chart

🔧 Method 2: OLM Installation

1️⃣ Install the CatalogSource

For OpenShift or clusters with OLM installed, apply the catalog source:

kubectl apply -f https://raw.githubusercontent.com/InditexTech/k8s-overcommit-operator/refs/heads/main/deploy/catalog_source.yaml

2️⃣ Apply the OperatorGroup

Apply the operator group configuration:

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 subscription or use the default subscription.yaml. Below is an example:

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: k8s-overcommit-operator
  namespace: operators
spec:
  channel: alpha
  name: k8s-overcommit-operator
  source: community-operators
  sourceNamespace: olm

Apply the subscription:

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:

kubectl get pods -n k8s-overcommit