Skip to content

suse-coder/helm

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

36 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

OpenCloud Helm Charts

Welcome to the OpenCloud Helm Charts repository! This repository is intended as a community-driven space for developing and maintaining Helm charts for deploying OpenCloud on Kubernetes.

πŸ“‘ Table of Contents

πŸš€ About

This repository is created to welcome contributions from the community. It does not contain official charts from OpenCloud GmbH and is not officially supported by OpenCloud GmbH. Instead, these charts are maintained by the open-source community.

OpenCloud is a cloud collaboration platform that provides file sync and share, document collaboration, and more. This Helm chart deploys OpenCloud with Keycloak for authentication, MinIO for object storage, and multiple options for document editing including Collabora and OnlyOffice.

πŸ’¬ Community

Join our Matrix chat for discussions about OpenCloud Helm Charts:

For general OpenCloud discussions:

πŸ’‘ Contributing

We encourage contributions from the community! If you'd like to contribute:

  • Fork this repository
  • Submit a Pull Request
  • Discuss and collaborate on issues

Please ensure that your PR follows best practices and includes necessary documentation.

Prerequisites

  • Kubernetes 1.19+
  • Helm 3.2.0+
  • PV provisioner support in the underlying infrastructure (if persistence is enabled)
  • External ingress controller (e.g., Cilium Gateway API) for routing traffic to the services

πŸ“¦ Installing the Helm Charts

To install the chart with the release name opencloud:

helm install opencloud . \
  --namespace opencloud \
  --create-namespace \
  --set cilium.httproute.gateway.name=cilium-gateway \
  --set cilium.httproute.gateway.namespace=kube-system

Architecture

This Helm chart deploys the following components:

  1. OpenCloud - Main application (fork of ownCloud Infinite Scale)
  2. Keycloak - Authentication provider with OpenID Connect
  3. PostgreSQL - Database for Keycloak and OnlyOffice
  4. MinIO - S3-compatible object storage
  5. Collabora - Online document editor (CODE - Collabora Online Development Edition)
  6. OnlyOffice - Alternative document editor with real-time collaboration
  7. Collaboration Service - WOPI server that connects OpenCloud with document editors
  8. Redis - Cache for OnlyOffice
  9. RabbitMQ - Message queue for OnlyOffice

All services are deployed with ClusterIP type, which means they are only accessible within the Kubernetes cluster. You need to configure your own ingress controller (e.g., Cilium Gateway API) to expose the services externally.

Component Interaction Diagram

The following diagram shows how the different components interact with each other:

graph TD
    User[User Browser] -->|Accesses| Gateway[Gateway API]
    
    subgraph "OpenCloud System"
        Gateway -->|cloud.opencloud.test| OpenCloud[OpenCloud Pod]
        Gateway -->|collabora.opencloud.test| Collabora[Collabora Pod]
        Gateway -->|onlyoffice.opencloud.test| OnlyOffice[OnlyOffice Pod]
        Gateway -->|collaboration.opencloud.test| Collaboration[Collaboration Pod]
        Gateway -->|wopiserver.opencloud.test| Collaboration
        Gateway -->|keycloak.opencloud.test| Keycloak[Keycloak Pod]
        Gateway -->|minio.opencloud.test| MinIO[MinIO Pod]
        
        OpenCloud -->|Authentication| Keycloak
        OpenCloud -->|File Storage| MinIO
        
        Collabora -->|WOPI Protocol| Collaboration
        OnlyOffice -->|WOPI Protocol| Collaboration
        Collaboration -->|File Access| MinIO
        
        Collaboration -->|Authentication| Keycloak
        
        OpenCloud -->|Collaboration API| Collaboration
        
        OnlyOffice -->|Database| PostgreSQL[PostgreSQL]
        OnlyOffice -->|Cache| Redis[Redis]
        OnlyOffice -->|Message Queue| RabbitMQ[RabbitMQ]
    end
    
    classDef pod fill:#f9f,stroke:#333,stroke-width:2px;
    classDef gateway fill:#bbf,stroke:#333,stroke-width:2px;
    classDef user fill:#bfb,stroke:#333,stroke-width:2px;
    classDef db fill:#dfd,stroke:#333,stroke-width:2px;
    
    class OpenCloud,Collabora,OnlyOffice,Collaboration,Keycloak,MinIO pod;
    class PostgreSQL,Redis,RabbitMQ db;
    class Gateway gateway;
    class User user;
Loading

Key interactions:

  1. User to Gateway:

    • Users access all services through the Gateway API using different hostnames
  2. OpenCloud Pod:

    • Main application that users interact with
    • Authenticates users via Keycloak
    • Stores files in MinIO
    • Communicates with Collaboration service for collaborative editing
  3. Collabora Pod:

    • Office document editor
    • Connects to the Collaboration pod via WOPI protocol
    • Uses token server secret for authentication
  4. OnlyOffice Pod:

    • Alternative office document editor
    • Connects to the Collaboration pod via WOPI protocol
    • Uses PostgreSQL for database storage
    • Uses Redis for caching
    • Uses RabbitMQ for message queuing
    • Provides real-time collaborative editing
  5. Collaboration Pod:

    • Implements WOPI server functionality
    • Acts as intermediary between document editors and file storage
    • Handles collaborative editing sessions
    • Accesses files from MinIO
  6. Keycloak Pod:

    • Handles authentication for all services
    • Manages user identities and permissions
  7. MinIO Pod:

    • Object storage for all files
    • Accessed by OpenCloud and Collaboration pods

Configuration

The following table lists the configurable parameters of the OpenCloud chart and their default values.

Global Settings

Parameter Description Default
namespace Namespace to install the chart into opencloud
global.domain.opencloud Domain for OpenCloud cloud.opencloud.test
global.domain.keycloak Domain for Keycloak keycloak.opencloud.test
global.domain.minio Domain for MinIO minio.opencloud.test
global.domain.collabora Domain for Collabora collabora.opencloud.test
global.domain.onlyoffice Domain for OnlyOffice onlyoffice.opencloud.test
global.domain.companion Domain for Companion companion.opencloud.test
global.tls.enabled Enable TLS (set to false when using gateway TLS termination externally) false
global.tls.selfSigned Use self-signed certificates true
global.tls.acmeEmail ACME email for Let's Encrypt [email protected]
global.tls.acmeCAServer ACME CA server https://acme-v02.api.letsencrypt.org/directory
global.storage.storageClass Storage class for persistent volumes ""

Image Settings

Parameter Description Default
image.repository OpenCloud image repository opencloudeu/opencloud-rolling
image.tag OpenCloud image tag latest
image.pullPolicy Image pull policy IfNotPresent
image.pullSecrets Image pull secrets []

OpenCloud Settings

Parameter Description Default
opencloud.enabled Enable OpenCloud true
opencloud.replicas Number of replicas (Note: When using multiple replicas, persistence should be disabled or use a storage class that supports ReadWriteMany access mode) 1
opencloud.logLevel Log level info
opencloud.logColor Enable log color false
opencloud.logPretty Enable pretty logging false
opencloud.insecure Insecure mode (for self-signed certificates) true
opencloud.enableBasicAuth Enable basic auth false
opencloud.adminPassword Admin password admin
opencloud.createDemoUsers Create demo users false
opencloud.resources CPU/Memory resource requests/limits {}
opencloud.persistence.enabled Enable persistence true
opencloud.persistence.size Size of the persistent volume 10Gi
opencloud.persistence.storageClass Storage class ""
opencloud.persistence.accessMode Access mode ReadWriteOnce
opencloud.storage.s3.internal.enabled Enable internal MinIO instance true
opencloud.storage.s3.internal.rootUser MinIO root user opencloud
opencloud.storage.s3.internal.rootPassword MinIO root password opencloud-secret-key
opencloud.storage.s3.internal.bucketName MinIO bucket name opencloud-bucket
opencloud.storage.s3.internal.region MinIO region default
opencloud.storage.s3.internal.resources CPU/Memory resource requests/limits See values.yaml
opencloud.storage.s3.internal.persistence.enabled Enable MinIO persistence true
opencloud.storage.s3.internal.persistence.size Size of the MinIO persistent volume 30Gi
opencloud.storage.s3.internal.persistence.storageClass MinIO storage class ""
opencloud.storage.s3.internal.persistence.accessMode MinIO access mode ReadWriteOnce
opencloud.storage.s3.external.enabled Enable external S3 false
opencloud.storage.s3.external.endpoint External S3 endpoint URL ""
opencloud.storage.s3.external.region External S3 region default
opencloud.storage.s3.external.accessKey External S3 access key ""
opencloud.storage.s3.external.secretKey External S3 secret key ""
opencloud.storage.s3.external.bucket External S3 bucket ""
opencloud.storage.s3.external.createBucket Create bucket if it doesn't exist true

Keycloak Settings

Parameter Description Default
keycloak.enabled Enable Keycloak true
keycloak.replicas Number of replicas 1
keycloak.adminUser Admin user admin
keycloak.adminPassword Admin password admin
keycloak.resources CPU/Memory resource requests/limits {}
keycloak.realm Realm name openCloud
keycloak.persistence.enabled Enable persistence true
keycloak.persistence.size Size of the persistent volume 1Gi
keycloak.persistence.storageClass Storage class ""
keycloak.persistence.accessMode Access mode ReadWriteOnce

PostgreSQL Settings

Parameter Description Default
postgres.enabled Enable PostgreSQL true
postgres.database Database name keycloak
postgres.user Database user keycloak
postgres.password Database password keycloak
postgres.resources CPU/Memory resource requests/limits {}
postgres.persistence.enabled Enable persistence true
postgres.persistence.size Size of the persistent volume 1Gi
postgres.persistence.storageClass Storage class ""
postgres.persistence.accessMode Access mode ReadWriteOnce

OnlyOffice Settings

Parameter Description Default
onlyoffice.enabled Enable OnlyOffice true
onlyoffice.repository OnlyOffice image repository onlyoffice/documentserver
onlyoffice.tag OnlyOffice image tag 8.2.2
onlyoffice.pullPolicy Image pull policy IfNotPresent
onlyoffice.wopi.enabled Enable WOPI integration true
onlyoffice.useUnauthorizedStorage Use unauthorized storage (for self-signed certificates) true
onlyoffice.persistence.enabled Enable persistence true
onlyoffice.persistence.size Size of the persistent volume 2Gi
onlyoffice.resources CPU/Memory resource requests/limits {}
onlyoffice.config.coAuthoring.token.enable.request.inbox Enable token for incoming requests true
onlyoffice.config.coAuthoring.token.enable.request.outbox Enable token for outgoing requests true
onlyoffice.config.coAuthoring.token.enable.browser Enable token for browser requests true
onlyoffice.collaboration.enabled Enable collaboration service true

Collabora Settings

Parameter Description Default
collabora.enabled Enable Collabora true
collabora.repository Collabora image repository collabora/code
collabora.tag Collabora image tag 24.04.13.2.1
collabora.pullPolicy Image pull policy IfNotPresent
collabora.adminUser Admin user admin
collabora.adminPassword Admin password admin
collabora.ssl.enabled Enable SSL true
collabora.ssl.verification SSL verification true
collabora.resources CPU/Memory resource requests/limits {}

Collaboration Service Settings

Parameter Description Default
collaboration.enabled Enable collaboration service true
collaboration.wopiDomain WOPI server domain collaboration.opencloud.test
collaboration.resources CPU/Memory resource requests/limits {}

Cilium Gateway API Configuration

This chart includes Cilium HTTPRoute resources that can be used to expose the OpenCloud, Keycloak, and MinIO services externally. The HTTPRoutes are configured to route traffic to the respective services.

Cilium HTTPRoute Settings

Parameter Description Default
cilium.httproute.enabled Enable Cilium HTTPRoutes true
cilium.httproute.gateway.name Gateway name cilium-gateway
cilium.httproute.gateway.namespace Gateway namespace "" (defaults to Release.Namespace)

The following HTTPRoutes are created when cilium.httproute.enabled is set to true:

  1. OpenCloud HTTPRoute:

    • Hostname: global.domain.opencloud
    • Service: {{ release-name }}-opencloud
    • Port: 9200
    • Headers: Removes Permissions-Policy header to prevent browser console errors
  2. Keycloak HTTPRoute (when keycloak.enabled is true):

    • Hostname: global.domain.keycloak
    • Service: {{ release-name }}-keycloak
    • Port: 8080
    • Headers: Adds Permissions-Policy header to prevent browser features like interest-based advertising
  3. MinIO HTTPRoute (when opencloud.storage.s3.internal.enabled is true):

    • Hostname: global.domain.minio
    • Service: {{ release-name }}-minio
    • Port: 9001
    • Headers: Adds Permissions-Policy header to prevent browser features like interest-based advertising

    default user: opencloud pass: opencloud-secret-key

  4. OnlyOffice HTTPRoute (when onlyoffice.enabled is true):

    • Hostname: global.domain.onlyoffice
    • Service: {{ release-name }}-onlyoffice
    • Port: 80
    • Path: "/"
    • This route is used to access the OnlyOffice Document Server for collaborative editing
  5. WOPI HTTPRoute (when onlyoffice.collaboration.enabled and onlyoffice.enabled are true):

    • Hostname: global.domain.wopi
    • Service: {{ release-name }}-collaboration
    • Port: 9300
    • Path: "/"
    • This route is used for the WOPI protocol communication between OnlyOffice and the collaboration service
  6. Collabora HTTPRoute (when collabora.enabled is true):

    • Hostname: global.domain.collabora
    • Service: {{ release-name }}-collabora
    • Port: 9980
    • Headers: Adds Permissions-Policy header to prevent browser features like interest-based advertising
  7. Collaboration (WOPI) HTTPRoute (when collaboration.enabled is true):

    • Hostname: collaboration.wopiDomain
    • Service: {{ release-name }}-collaboration
    • Port: 9300
    • Headers: Adds Permissions-Policy header to prevent browser features like interest-based advertising

All HTTPRoutes are configured to use the same Gateway specified by cilium.httproute.gateway.name and cilium.httproute.gateway.namespace.

Setting Up Gateway API with Talos, Cilium, and cert-manager

This section provides a practical guide to setting up the Gateway API with Talos, Cilium, and cert-manager for OpenCloud.

Prerequisites

  • Talos Kubernetes cluster up and running
  • kubectl configured to access your cluster
  • Helm 3 installed

Step 1: Install Cilium with Gateway API Support

First, install Cilium with Gateway API support using Helm:

# Add the Cilium Helm repository
helm repo add cilium https://helm.cilium.io/

# Install Cilium with Gateway API enabled
helm install cilium cilium/cilium \
  --namespace kube-system \
  --set gatewayAPI.enabled=true \
  --set kubeProxyReplacement=strict \
  --set k8sServiceHost=<your-kubernetes-api-server-ip> \
  --set k8sServicePort=6443

Step 2: Install cert-manager

Install cert-manager to manage TLS certificates:

# Add the Jetstack Helm repository
helm repo add jetstack https://charts.jetstack.io

# Install cert-manager
helm install cert-manager jetstack/cert-manager \
  --namespace cert-manager \
  --create-namespace \
  --set installCRDs=true

Step 3: Create a ClusterIssuer for cert-manager

Create a ClusterIssuer for cert-manager to issue certificates:

# cluster-issuer.yaml
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: selfsigned-issuer
spec:
  selfSigned: {}

Apply the ClusterIssuer:

kubectl apply -f cluster-issuer.yaml

Step 3: Create a Wildcard Certificate for OpenCloud Domains

Create a wildcard certificate for all OpenCloud subdomains:

# cluster-issuer.yaml
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: selfsigned-issuer
spec:
  selfSigned: {}
---
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
  name: opencloud-wildcard-tls
  namespace: kube-system
spec:
  secretName: opencloud-wildcard-tls
  dnsNames:
    - "opencloud.test"
    - "*.opencloud.test"
  issuerRef:
    name: selfsigned-issuer
    kind: ClusterIssuer

Apply the certificate:

kubectl apply -f cluster-issuer.yaml

Step 4: Create the Gateway

Create a Gateway resource to expose your services:

# gateway.yaml
apiVersion: gateway.networking.k8s.io/v1beta1
kind: Gateway
metadata:
  name: cilium-gateway
  namespace: kube-system
spec:
  gatewayClassName: cilium
  infrastructure:
    annotations:
      io.cilium/lb-ipam-ips: "192.168.178.77"  # Replace with your desired IP
      cilium.io/hubble-visibility: "flow"
      cilium.io/preserve-client-cookies: "true"
      cilium.io/preserve-csrf-token: "true"
      io.cilium/websocket: "true"
      io.cilium/websocket-timeout: "3600"
  addresses:
    - type: IPAddress
      value: 192.168.178.77  # Replace with your desired IP
  listeners:
    - name: opencloud-https
      protocol: HTTPS
      port: 443
      hostname: "cloud.opencloud.test"
      tls:
        mode: Terminate
        certificateRefs:
          - name: opencloud-wildcard-tls
            namespace: kube-system
      allowedRoutes:
        namespaces:
          from: All
    - name: keycloak-https
      protocol: HTTPS
      port: 443
      hostname: "keycloak.opencloud.test"
      tls:
        mode: Terminate
        certificateRefs:
          - name: opencloud-wildcard-tls
            namespace: kube-system
      allowedRoutes:
        namespaces:
          from: All
    - name: minio-https
      protocol: HTTPS
      port: 443
      hostname: "minio.opencloud.test"
      tls:
        mode: Terminate
        certificateRefs:
          - name: opencloud-wildcard-tls
            namespace: kube-system
      allowedRoutes:
        namespaces:
          from: All
    - name: onlyoffice-https
      protocol: HTTPS
      port: 443
      hostname: "onlyoffice.opencloud.test"
      tls:
        mode: Terminate
        certificateRefs:
          - name: opencloud-wildcard-tls
            namespace: kube-system
      allowedRoutes:
        namespaces:
          from: All
    - name: collabora-https
      protocol: HTTPS
      port: 443
      hostname: "collabora.opencloud.test"
      tls:
        mode: Terminate
        certificateRefs:
          - name: opencloud-wildcard-tls
            namespace: kube-system
      allowedRoutes:
        namespaces:
          from: All
    - name: collaboration-https
      protocol: HTTPS
      port: 443
      hostname: "collaboration.opencloud.test"
      tls:
        mode: Terminate
        certificateRefs:
          - name: opencloud-wildcard-tls
            namespace: kube-system
      allowedRoutes:
        namespaces:
          from: All
    - name: wopi-https
      protocol: HTTPS
      port: 443
      hostname: "wopiserver.opencloud.test"
      tls:
        mode: Terminate
        certificateRefs:
          - name: opencloud-wildcard-tls
            namespace: kube-system
      allowedRoutes:
        namespaces:
          from: All

Apply the Gateway:

kubectl apply -f gateway.yaml

Step 5: Configure DNS

Configure your DNS to point to the Gateway IP address. You can use a wildcard DNS record or individual records for each service:

*.opencloud.test  IN  A  192.168.178.77  # Replace with your Gateway IP

Alternatively, for local testing, you can add entries to your /etc/hosts file:

192.168.178.77  cloud.opencloud.test
192.168.178.77  keycloak.opencloud.test
192.168.178.77  minio.opencloud.test
192.168.178.77  onlyoffice.opencloud.test
192.168.178.77  collabora.opencloud.test
192.168.178.77  collaboration.opencloud.test
192.168.178.77  wopiserver.opencloud.test

Step 6: Install OpenCloud

Finally, install OpenCloud using Helm:

# Clone the repository
git clone https://github.com/your-repo/opencloud-helm.git
cd opencloud-helm

# Install OpenCloud
helm install opencloud . \
  --namespace opencloud \
  --create-namespace \
  --set cilium.httproute.gateway.name=cilium-gateway \
  --set cilium.httproute.gateway.namespace=kube-system

Troubleshooting

If you encounter issues with the OnlyOffice or Collabora pods connecting to the WOPI server, ensure that:

  1. The WOPI server certificate is properly created in the kube-system namespace
  2. The OnlyOffice/Collabora pod is configured with the correct token settings in the configmap
  3. The Gateway is properly configured to route traffic to the WOPI server
  4. The ReferenceGrant is properly configured to allow the Gateway to access the TLS certificates

You can check the status of the certificates:

kubectl get certificates -n kube-system

Check the logs of the OnlyOffice pod:

kubectl logs -n opencloud -l app.kubernetes.io/component=onlyoffice

Or check the logs of the Collabora pod:

kubectl logs -n opencloud -l app.kubernetes.io/component=collabora

You can also check the status of the HTTPRoutes:

kubectl get httproutes -n opencloud

For OnlyOffice-specific issues, check that the PostgreSQL, Redis, and RabbitMQ services are running correctly:

kubectl get pods -n opencloud -l app.kubernetes.io/component=onlyoffice-postgresql
kubectl get pods -n opencloud -l app.kubernetes.io/component=onlyoffice-redis
kubectl get pods -n opencloud -l app.kubernetes.io/component=onlyoffice-rabbitmq

πŸ“¦ Installing the DEV Helm Charts

Spin up a temporary local instance of OpenCloud using a single Docker image.

Note: This chart is primarily intended for Kubernetes deployment development and testing environments, not for production use. It provides a simplified setup with minimal configuration.

This version deploys opencloud as a single Docker image as described here: https://docs.opencloud.eu/docs/admin/getting-started/docker/docker

Deployment from the file system:

$ helm install opencloud -n opencloud --create-namespace ./opencloud-dev --set=adminPassword="<MY-SECURE-PASSWORD>" --set=url="<PUBLIC-URL>"

It is important that the public-url is reachable, and forwarded to the backend-service opencloud-service:443, otherwise login will not be possible or the message "missing or invalid config" is shown.

For testing with the default settings port-forwarding from localhost can be used:

$ helm install opencloud -n opencloud --create-namespace ./opencloud-dev

  Release "opencloud" does not exist. Installing it now.
  NAME: opencloud
  LAST DEPLOYED: Wed Apr  2 01:16:19 2025
  NAMESPACE: opencloud
  STATUS: deployed
  REVISION: 1
  TEST SUITE: None

Establish a port-forwarding from localhost

$ kubectl port-forward -n opencloud svc/opencloud-service 9200:443

  Forwarding from 127.0.0.1:9200 -> 9200
  Forwarding from [::1]:9200 -> 9200
  ...

Now open in a browser the url: https://localhost:9200 while the port forwarding is active.

You need to accept the risc of a self signed certificate. (see Common Issues & Help) in the getting started with Docker documentation.

Now you can login with the default admin / admin

If you want to change the public URL you can upgrade the deployment with the following command:

$ helm upgrade opencloud -n opencloud ./charts/opencloud-dev --set=url="<NEW-PUBLIC-URL>"

  Release "opencloud" has been upgraded. Happy Helming!
  NAME: opencloud
  LAST DEPLOYED: Wed Apr  2 01:42:51 2025
  NAMESPACE: opencloud
  STATUS: deployed
  REVISION: 2
  TEST SUITE: None

The opencloud deployment will be restarted and is availble after a few seconds configured for the new url.

If you want to uninstall opencloud this can be done with

$ helm uninstall -n opencloud opencloud

  release "opencloud" uninstalled

The data PVC is configured to be kept, so it will survive uninstall and install of opencloud-dev

πŸ“œ License

This project is licensed under the AGPLv3 licence. See the LICENSE file for more details.

Community Maintained

This repository is community-maintained and not officially supported by OpenCloud GmbH. Use at your own risk, and feel free to contribute to improve the project!

About

Community Helm Charts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published