docs: update operator deployment

docs/operator-manual/Uninstallation.md

@@ -0,0 +1,25 @@
+---
+title: Uninstall
+layout: default
+parent: Operator Manual
+nav_order: 5
+---
+
+# Uninstall
+
+```sh
+kubectl delete -f https://raw.githubusercontent.com/jkaninda/goma-operator/main/dist/install.yaml
+```
+
+### Force Gateway deletion
+
+```shell
+kubectl patch  gateways.gomaproj.github.io (gatewayName) -p '{"metadata":{"finalizers":[]}}' --type=merge
+```
+
+### Force gateway crd deletion
+
+```shell
+kubectl patch crd gateways.gomaproj.github.io -p '{"metadata":{"finalizers":[]}}' --type=merge
+
+```

docs/operator-manual/gateway.md

@@ -0,0 +1,88 @@
+---
+title: Gateway
+layout: default
+parent: Operator Manual
+nav_order: 2
+---
+
+## Gateway
+The **Gateway** serves as the entry point to the server, handling and routing incoming traffic.
+
+### Installation Details
+
+When a Gateway is installed, it automatically creates the following Kubernetes resources, all with the same name as the Gateway:
+
+- **Service**
+- **ConfigMap**
+- **Deployment**
+
+### Service Ports
+
+The service exposes the following ports:
+
+- **HTTP**: `8080`
+- **HTTPS**: `8443`
+
+### Exposing the Gateway Outside the Cluster
+
+To expose your Gateway outside the cluster, you have the following options:
+
+1. **Create an Ingress resource**:  
+   Configure an Ingress to route external traffic to your Gateway.
+
+2. **Change the Service Type**:  
+   Patch the Gateway's service to change its type (e.g., to `LoadBalancer` or `NodePort`) for external accessibility.
+
+A simple example of gateway
+
+```yaml
+apiVersion: gomaproj.github.io/v1beta1
+kind: Gateway
+metadata:
+  labels: {}
+  name: gateway-sample
+spec:
+  # The version of Goma Gateway
+  # See: https://github.com/jkaninda/goma-gateway/releases
+  gatewayVersion: latest
+  ## Server config
+  server:
+    # Kubernetes tls secret name
+    tlsSecretName: '' #Optional, tls-secret
+    #Redis configs for distributed rate limiting across multiple instances
+    redis:
+        addr: '' #Optional, redis:6379
+        password: '' #Optional, password
+    writeTimeout: 10
+    readTimeout: 15
+    idleTimeout: 30
+    logLevel: info
+    disableHealthCheckStatus: false
+    disableKeepAlive: false
+    enableMetrics: true
+  replicaCount: 1
+  resources:
+    limits:
+      cpu: 200m
+      memory: 512Mi
+    requests:
+      cpu: 100m
+      memory: 128Mi
+  # Enable auto scaling
+  autoScaling:
+    enabled: true
+    minReplicas: 2
+    maxReplicas: 5
+    targetCPUUtilizationPercentage: 80
+    targetMemoryUtilizationPercentage: 80
+  affinity: {}
+```
+### Delete gateway
+```shell
+kubectl delete gateway (gatewayName)
+```
+Or
+
+```shell
+kubectl delete gateways.gomaproj.github.io (gatewayName)
+```

docs/operator-manual/index.md

@@ -0,0 +1,8 @@
+---
+title: Operator Manual
+layout: default
+nav_order: 6
+has_children: true
+---
+
+## Operator Manual

docs/operator-manual/installation.md

@@ -0,0 +1,28 @@
+---
+title: Installation
+layout: default
+parent: Operator Manual
+nav_order: 1
+---
+
+# Installation
+
+## Kubernetes Advanced deployment using CRDs and an Operator
+
+**Install the CRDs and Operator into the cluster:**
+
+```sh
+kubectl apply -f https://raw.githubusercontent.com/jkaninda/goma-operator/main/dist/install.yaml
+```
+
+### Resources
+
+- Gateway
+- Middleware
+- Route
+
+### Resources order
+
+- Gateway
+- Middleware
+- Route

docs/operator-manual/middlware.md

@@ -0,0 +1,49 @@
+---
+title: Middleware
+layout: default
+parent: Operator Manual
+nav_order: 3
+---
+
+# Middleware
+
+### Basic-auth
+
+A simple example of middleware
+
+```yaml
+apiVersion: gomaproj.github.io/v1beta1
+kind: Middleware
+metadata:
+  name: basic-middleware-sample
+spec:
+    type: basic
+    paths:
+      - /admin/*
+    rule:
+        username: admin
+        password: admin
+```
+### JWT-auth
+
+```yaml
+
+```
+
+### Access
+
+```yaml
+apiVersion: gomaproj.github.io/v1beta1
+kind: Middleware
+metadata:
+  name: access-middleware-sample
+spec:
+    type: access
+  ## prevents access paths
+    paths:
+      - /swagger-ui/*
+      - /v2/swagger-ui/*
+      - /api-docs/*
+      - /internal/*
+      - /actuator/*
+```

docs/operator-manual/route.md

@@ -0,0 +1,47 @@
+---
+title: Route
+layout: default
+parent: Operator Manual
+nav_order: 4
+---
+
+# Route
+
+A simple example of route
+
+```yaml
+apiVersion: gomaproj.github.io/v1beta1
+kind: Route
+metadata:
+  labels: {}
+  name: route-sample
+spec:
+  gateway: gateway-sample
+  path: /
+  hosts: []
+  rewrite: /
+  methods:
+    - GET
+    - POST
+    - PUT
+  destination: https://example.com
+  backends: []
+  insecureSkipVerify: false
+  healthCheck:
+    path: /
+    interval: 10s
+    timeout: 10s
+    healthyStatuses:
+      - 200
+      - 404
+  cors:
+    origins: []
+    headers: {}
+  rateLimit: 15
+  disableHostFording: true
+  interceptErrors: []
+  blockCommonExploits: false
+  ## Middleware names
+  middlewares:
+    - basic-middleware-sample
+```