Skip to content

Commit 95045d7

Browse files
michaelstinglmichaelstingl
committed
Improve documentation structure and reduce redundancy
- Create dedicated README.md for charts/opencloud-dev - Create NOTES.txt for charts/opencloud-dev - Reduce redundancy between main README and chart READMEs - Add httpRoute.enabled=true to all installation commands - Clarify installation context for both charts - Fix repository URL and LICENSE references - Update table of contents
1 parent fc322e6 commit 95045d7

File tree

4 files changed

+209
-167
lines changed

4 files changed

+209
-167
lines changed

‎README.md

Lines changed: 42 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Welcome to the **OpenCloud Helm Charts** repository! This repository is intended
1010
- [Community](#-community)
1111
- [Contributing](#-contributing)
1212
- [Prerequisites](#prerequisites)
13-
- [Installing the Helm Charts](#-installing-the-helm-charts)
13+
- [Available Charts](#-available-charts)
14+
- [Production Chart](#production-chart-chartsopencloud)
15+
- [Development Chart](#development-chart-chartsopencloud-dev)
1416
- [Architecture](#architecture)
1517
- [Component Interaction Diagram](#component-interaction-diagram)
1618
- [Configuration](#configuration)
@@ -25,7 +27,6 @@ Welcome to the **OpenCloud Helm Charts** repository! This repository is intended
2527
- [Gateway API Configuration](#gateway-api-configuration)
2628
- [HTTPRoute Settings](#httproute-settings)
2729
- [Setting Up Gateway API with Talos, Cilium, and cert-manager](#setting-up-gateway-api-with-talos-cilium-and-cert-manager)
28-
- [Installing the DEV Helm Charts](#-installing-the-dev-helm-charts)
2930
- [License](#-license)
3031
- [Community Maintained](#community-maintained)
3132

@@ -61,21 +62,50 @@ Please ensure that your PR follows best practices and includes necessary documen
6162
- PV provisioner support in the underlying infrastructure (if persistence is enabled)
6263
- External ingress controller (e.g., Cilium Gateway API) for routing traffic to the services
6364

64-
## 📦 Installing the Helm Charts
65+
## 📦 Available Charts
6566

66-
To install the chart with the release name `opencloud`:
67+
This repository contains the following charts:
68+
69+
### Production Chart (`charts/opencloud`)
70+
71+
The complete OpenCloud deployment with all components for production use:
72+
73+
- Full microservices architecture
74+
- Keycloak for authentication
75+
- MinIO for object storage
76+
- Document editing with Collabora and/or OnlyOffice
77+
- Full Gateway API integration
6778

6879
```bash
6980
helm install opencloud ./charts/opencloud \
7081
--namespace opencloud \
7182
--create-namespace \
83+
--set httpRoute.enabled=true \
7284
--set httpRoute.gateway.name=opencloud-gateway \
7385
--set httpRoute.gateway.namespace=kube-system
7486
```
7587

88+
[View Production Chart Documentation](./charts/opencloud/README.md)
89+
90+
### Development Chart (`charts/opencloud-dev`)
91+
92+
A lightweight single-container deployment for development and testing:
93+
94+
- Simplified deployment (single Docker container)
95+
- Minimal resource requirements
96+
- Quick setup for testing
97+
98+
```bash
99+
helm install opencloud ./charts/opencloud-dev \
100+
--namespace opencloud \
101+
--create-namespace
102+
```
103+
104+
[View Development Chart Documentation](./charts/opencloud-dev/README.md)
105+
76106
## Architecture
77107

78-
This Helm chart deploys the following components:
108+
The production chart (`charts/opencloud`) deploys the following components:
79109

80110
1. **OpenCloud** - Main application (fork of ownCloud Infinite Scale)
81111
2. **Keycloak** - Authentication provider with OpenID Connect
@@ -173,7 +203,7 @@ Key interactions:
173203

174204
## Configuration
175205

176-
The following table lists the configurable parameters of the OpenCloud chart and their default values.
206+
The following sections outline the main configuration parameters for the production chart (`charts/opencloud`). For a complete list of configuration options, please refer to the [values.yaml](./charts/opencloud/values.yaml) file.
177207

178208
### Global Settings
179209

@@ -309,7 +339,7 @@ The following table lists the configurable parameters of the OpenCloud chart and
309339

310340
## Gateway API Configuration
311341

312-
This chart includes 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.
342+
The production chart includes 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.
313343

314344
### HTTPRoute Settings
315345

@@ -323,7 +353,7 @@ This chart includes HTTPRoute resources that can be used to expose the OpenCloud
323353

324354
### Advanced Configuration Options
325355

326-
The chart supports several advanced configuration options introduced in recent updates:
356+
The production chart supports several advanced configuration options introduced in recent updates:
327357

328358
#### Environment Variables
329359

@@ -416,7 +446,7 @@ All HTTPRoutes are configured to use the same Gateway specified by `httpRoute.ga
416446

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

419-
This section provides a practical guide to setting up the Gateway API with Talos, Cilium, and cert-manager for OpenCloud.
449+
This section provides a practical guide to setting up the Gateway API with Talos, Cilium, and cert-manager for the production OpenCloud chart.
420450

421451
### Prerequisites
422452

@@ -648,13 +678,14 @@ Finally, install OpenCloud using Helm:
648678

649679
```bash
650680
# Clone the repository
651-
git clone https://github.com/your-repo/opencloud-helm.git
681+
git clone https://github.com/opencloud-eu/helm.git opencloud-helm
652682
cd opencloud-helm
653683

654684
# Install OpenCloud
655-
helm install opencloud . \
685+
helm install opencloud ./charts/opencloud \
656686
--namespace opencloud \
657687
--create-namespace \
688+
--set httpRoute.enabled=true \
658689
--set httpRoute.gateway.name=opencloud-gateway \
659690
--set httpRoute.gateway.namespace=kube-system
660691
```
@@ -700,83 +731,6 @@ kubectl get pods -n opencloud -l app.kubernetes.io/component=onlyoffice-redis
700731
kubectl get pods -n opencloud -l app.kubernetes.io/component=onlyoffice-rabbitmq
701732
```
702733

703-
## 📦 Installing the DEV Helm Charts
704-
705-
Spin up a temporary local instance of OpenCloud using a single Docker image.
706-
707-
**Note:** This chart is primarily intended for Kubernetes deployment development and testing environments,
708-
not for production use. It provides a simplified setup with minimal configuration.
709-
710-
This version deploys opencloud as a single Docker image as described here:
711-
https://docs.opencloud.eu/docs/admin/getting-started/docker/docker
712-
713-
Deployment from the file system:
714-
715-
```
716-
$ helm install opencloud -n opencloud --create-namespace ./charts/opencloud-dev --set=adminPassword="<MY-SECURE-PASSWORD>" --set=url="<PUBLIC-URL>"
717-
```
718-
719-
It is important that the public-url is reachable, and forwarded to the backend-service opencloud-service:443,
720-
otherwise login will not be possible or the message "missing or invalid config" is shown.
721-
722-
For testing with the default settings port-forwarding from localhost can be used:
723-
724-
```
725-
$ helm install opencloud -n opencloud --create-namespace ./charts/opencloud-dev
726-
727-
Release "opencloud" does not exist. Installing it now.
728-
NAME: opencloud
729-
LAST DEPLOYED: Wed Apr 2 01:16:19 2025
730-
NAMESPACE: opencloud
731-
STATUS: deployed
732-
REVISION: 1
733-
TEST SUITE: None
734-
```
735-
736-
Establish a port-forwarding from localhost
737-
738-
```
739-
$ kubectl port-forward -n opencloud svc/opencloud-service 9200:443
740-
741-
Forwarding from 127.0.0.1:9200 -> 9200
742-
Forwarding from [::1]:9200 -> 9200
743-
...
744-
```
745-
746-
Now open in a browser the url: [https://localhost:9200](https://localhost:9200) while
747-
the port forwarding is active.
748-
749-
You need to accept the risc of a self signed certificate.
750-
(see [Common Issues & Help](https://docs.opencloud.eu/docs/admin/getting-started/docker/#troubleshooting)) in
751-
the getting started with Docker documentation.
752-
753-
Now you can login with the default admin / admin
754-
755-
If you want to change the public URL you can upgrade the deployment with the following command:
756-
757-
```
758-
$ helm upgrade opencloud -n opencloud ./charts/opencloud-dev --set=url="<NEW-PUBLIC-URL>"
759-
760-
Release "opencloud" has been upgraded. Happy Helming!
761-
NAME: opencloud
762-
LAST DEPLOYED: Wed Apr 2 01:42:51 2025
763-
NAMESPACE: opencloud
764-
STATUS: deployed
765-
REVISION: 2
766-
TEST SUITE: None
767-
```
768-
769-
The opencloud deployment will be restarted and is availble after a few seconds configured for the new url.
770-
771-
If you want to uninstall opencloud this can be done with
772-
773-
```
774-
$ helm uninstall -n opencloud opencloud
775-
776-
release "opencloud" uninstalled
777-
```
778-
779-
The data PVC is configured to be kept, so it will survive uninstall and install of opencloud-dev
780734

781735
## 📜 License
782736

‎charts/opencloud-dev/README.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<img src="https://helm.sh/img/helm.svg" width="100px" heigth="100px">
2+
3+
# OpenCloud Development Helm Chart
4+
5+
This Helm chart deploys a lightweight development version of OpenCloud using a single Docker container.
6+
7+
## 📑 Table of Contents
8+
9+
- [About](#-about)
10+
- [Prerequisites](#prerequisites)
11+
- [Installation](#-installation)
12+
- [Configuration](#configuration)
13+
- [Port Forwarding](#port-forwarding)
14+
- [License](#-license)
15+
16+
## 🚀 About
17+
18+
This development chart provides a simplified OpenCloud deployment for testing and development purposes.
19+
It uses a single Docker container that includes all necessary OpenCloud services bundled together.
20+
21+
**Note:** This chart is NOT intended for production use. For production deployments,
22+
please use the main [OpenCloud Helm Chart](../opencloud/).
23+
24+
## Prerequisites
25+
26+
- Kubernetes 1.19+
27+
- Helm 3.2.0+
28+
- PV provisioner support in the underlying infrastructure
29+
30+
## 📦 Installation
31+
32+
To install the chart with the release name `opencloud`:
33+
34+
```bash
35+
# Navigate to the chart directory first
36+
cd /path/to/helm-repo/charts/opencloud-dev
37+
38+
# Then run the installation command
39+
helm install opencloud . \
40+
--namespace opencloud \
41+
--create-namespace \
42+
--set adminPassword="<MY-SECURE-PASSWORD>" \
43+
--set url="<PUBLIC-URL>"
44+
```
45+
46+
Alternatively, from the repository root:
47+
48+
```bash
49+
helm install opencloud ./charts/opencloud-dev \
50+
--namespace opencloud \
51+
--create-namespace \
52+
--set adminPassword="<MY-SECURE-PASSWORD>" \
53+
--set url="<PUBLIC-URL>"
54+
```
55+
56+
**Important Notes:**
57+
- The `url` parameter must be reachable and forwarded to the backend service on port 443
58+
- If `url` is not properly configured, login will fail with "missing or invalid config" message
59+
60+
## Configuration
61+
62+
The following table lists the configurable parameters of the OpenCloud Development chart and their default values.
63+
64+
| Parameter | Description | Default |
65+
| --------- | ----------- | ------- |
66+
| `image` | OpenCloud image repository | `opencloudeu/opencloud-rolling` |
67+
| `tag` | OpenCloud image tag | `2.0.0` |
68+
| `adminPassword` | Admin password | `admin` |
69+
| `insecure` | Insecure mode (for self-signed certificates) | `true` |
70+
| `proxyHttpAddr` | Proxy HTTP address | `0.0.0.0:9200` |
71+
| `url` | Public URL for OpenCloud | `https://localhost:9200` |
72+
| `pvcSize` | Persistent volume size | `10Gi` |
73+
74+
## Port Forwarding
75+
76+
For local testing with default settings, you can use port-forwarding:
77+
78+
```bash
79+
# After installation
80+
kubectl port-forward -n opencloud svc/opencloud-service 9200:443
81+
```
82+
83+
Then access OpenCloud at [https://localhost:9200](https://localhost:9200) and login with:
84+
- Username: admin
85+
- Password: admin (or your custom password if set)
86+
87+
You will need to accept the self-signed certificate warning in your browser.
88+
89+
## Upgrading
90+
91+
To change the public URL or other settings, you can upgrade the deployment:
92+
93+
```bash
94+
helm upgrade opencloud . \
95+
--namespace opencloud \
96+
--set url="<NEW-PUBLIC-URL>"
97+
```
98+
99+
## Uninstalling
100+
101+
To uninstall OpenCloud:
102+
103+
```bash
104+
helm uninstall -n opencloud opencloud
105+
```
106+
107+
**Note:** The data PVC is configured to be kept, so it will survive uninstall and reinstall of the chart.
108+
109+
## 📜 License
110+
111+
This project is licensed under the **AGPLv3** license. See the [LICENSE](../../LICENSE) file for more details.

‎charts/opencloud-dev/templates/NOTES.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Thank you for installing {{ .Chart.Name }}.
2+
3+
Your release is named {{ .Release.Name }}.
4+
5+
To learn more about the release, try:
6+
7+
$ helm status {{ .Release.Name }}
8+
$ helm get all {{ .Release.Name }}
9+
10+
IMPORTANT: This is a development deployment using a single Docker container.
11+
For production use, please use the main OpenCloud chart and change the default credentials.
12+
13+
Default Login Credentials:
14+
- Admin User: admin
15+
- Admin Password: {{ .Values.adminPassword }}
16+
17+
The following service has been deployed:
18+
19+
1. OpenCloud (Single Container Deployment):
20+
- Service: {{ .Release.Name }}-service
21+
- Port: 443 (container port 9200)
22+
- URL: {{ .Values.url }}
23+
24+
Port Forwarding:
25+
To access OpenCloud locally, run:
26+
27+
$ kubectl port-forward -n {{ .Release.Namespace }} svc/{{ .Release.Name }}-service 9200:443
28+
29+
Then open in your browser: https://localhost:9200
30+
31+
IMPORTANT: You will need to accept the self-signed certificate warning in your browser.
32+
33+
For more information, please refer to the OpenCloud documentation:
34+
https://docs.opencloud.eu/docs/admin/getting-started/docker/

0 commit comments

Comments
 (0)