Skip to content

Commit 61982e1

Browse files
feriferi
authored andcommitted
added feedback from @michaelstingl
make clear, that this is a DEV only version not for productive use.
1 parent a2b16ef commit 61982e1

File tree

9 files changed

+22
-44
lines changed

9 files changed

+22
-44
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,28 @@ This repository is created to **welcome contributions from the community**. It d
1010

1111
## 📦 Installing the Helm Charts
1212

13-
Currently only deployment from the file system is supported:
13+
(please add)
14+
15+
## 📦 Installing the DEV Helm Charts
16+
17+
Spin up a temporary local instance of OpenCloud using a single Docker image.
18+
19+
This version deploys opencloud as a single Docker image as described here:
20+
https://docs.opencloud.eu/docs/admin/getting-started/docker/docker
21+
22+
Deployment from the file system:
1423

1524
```
16-
$ helm install opencloud -n opencloud --create-namespace ./charts/opencloud --set=adminPassword="<MY-SECURE-PASSWORD>" --set=url="<PUBLIC-URL>"
25+
$ helm install opencloud -n opencloud --create-namespace ./charts/opencloud-dev --set=adminPassword="<MY-SECURE-PASSWORD>" --set=url="<PUBLIC-URL>"
1726
```
1827

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

22-
An example ingress for nginx with cert-manager annotations is in ./inwork/opencloud-ingress.yaml.
23-
24-
2531
For testing with the default settings port-forwarding from localhost can be used:
2632

2733
```
28-
$ helm install opencloud -n opencloud --create-namespace ./charts/opencloud
34+
$ helm install opencloud -n opencloud --create-namespace ./charts/opencloud-dev
2935
3036
Release "opencloud" does not exist. Installing it now.
3137
NAME: opencloud
@@ -58,7 +64,7 @@ Now you can login with the default admin / admin
5864
If you want to change the public URL you can upgrade the deployment with the following command:
5965

6066
```
61-
$ helm upgrade opencloud -n opencloud ./charts/opencloud --set=url="<NEW-PUBLIC-URL>"
67+
$ helm upgrade opencloud -n opencloud ./charts/opencloud-dev --set=url="<NEW-PUBLIC-URL>"
6268
6369
Release "opencloud" has been upgraded. Happy Helming!
6470
NAME: opencloud
@@ -73,18 +79,15 @@ The opencloud deployment will be restarted and is availble after a few seconds c
7379

7480
If you want to uninstall opencloud this can be done with
7581

76-
ATTENTION: all you data will be lost, PVCs are not kept at the moment.
77-
7882
```
7983
$ helm uninstall -n opencloud opencloud
8084
8185
release "opencloud" uninstalled
8286
```
8387

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

8590

86-
(please add)
87-
8891
## 💡 Contributing
8992

9093
We encourage contributions from the community! If you'd like to contribute:
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
apiVersion: v2
22
type: application
3-
name: opencloud
3+
name: opencloud-dev
44
version: 0.1.0
5-
description: Plain deployment of the OpenCloud dockerfile.
6-
The initial helm chart follows the description given for starting a docker instance
5+
description: DEV Deployment of the OpenCloud dockerfile.
6+
The DEV Helm chart follows the description given for starting a docker instance:
77
https://docs.opencloud.eu/docs/admin/getting-started/docker
8-
It is thought as a first starting point.
8+
It is not thought for productive use
99
home: https://github.com/opencloud-eu/helm
1010
image: https://raw.githubusercontent.com/opencloud-eu/opencloud/refs/heads/main/opencloud_logo.png
1111
sources:
1212
- https://github.com/opencloud-eu/helm
1313
appVersion: 2.0.0
14-
15-

charts/opencloud/templates/opencloud-data-pvc.yaml renamed to charts/opencloud-dev/templates/opencloud-data-pvc.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ apiVersion: v1
22
kind: PersistentVolumeClaim
33
metadata:
44
name: opencloud-data-pvc
5+
annotations:
6+
# prevent data pvc from being uninstalled
7+
helm.sh/resource-policy: "keep"
58
labels:
69
app: opencloud
710
spec:
File renamed without changes.

examples/opencloud-ingress.yaml

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)