Skip to main content

Kubernetes Installation (Recommended)

Prerequisites​

Before installation, ensure you have:

Kubernetes/Helm Installation​

Owlistic supports deployment on Kubernetes using Helm. Follow these steps to install Owlistic helm chart on your Kubernetes cluster.

Step 1: Add the Owlistic Helm Repository​

helm repo add owlistic oci://ghcr.io/owlistic-notes/helm-charts
helm repo update

Step 2: Install Using Helm​

# Create a values file (values.yaml) for your configuration
helm install owlistic owlistic/owlistic -f values.yaml

Example values.yaml:

rserver:
  enabled: true
  service:
    enabled: true
    type: ClusterIP
    port: 8080
  persistence:
    data:
      enabled: true
      existingClaim: <your-persistent-volume-claim-name>
  env:
    DB_HOST: postgresql
    DB_PORT: 5432
    DB_NAME: owlistic
    DB_USER: owlistic
    DB_PASSWORD: owlistic
    KAFKA_BROKER: kafka:9092

app:
  enabled: true
  service:
    enabled: true
    type: ClusterIP
    port: 80

postgresql:
  enabled: true
  global:
    postgresql:
      auth:
        username: owlistic
        password: owlistic
        database: owlistic

zookeeper:
  enabled: true

kafka:
  enabled: true
  extraEnvVars:
    - name: KAFKA_BROKER_ID
      value: "1"
    - name: KAFKA_ZOOKEEPER_CONNECT
      value: zookeeper:2181
    - name: ALLOW_PLAINTEXT_LISTENER
      value: yes
    - name: KAFKA_ADVERTISED_LISTENERS
      value: PLAINTEXT://kafka:9092
    - name: KAFKA_LISTENERS
      value: PLAINTEXT://
    - name: KAFKA_LISTENER_SECURITY_PROTOCOL_MAP
      value: PLAINTEXT:PLAINTEXT

Step 3: Verify the Installation​

kubectl get pods -l app.kubernetes.io/name=owlistic
kubectl get services -l app.kubernetes.io/name=owlistic

Post-Installation​

After installation:

  • The backend should be running on port 8080
  • The frontend should be accessible on port 80
  • Visit http://your-server to access the web interface

Troubleshooting​

If you encounter any issues during installation, please refer to the Troubleshooting section for assistance.