Skip to content

Commit 04172f0

Browse files
committed
Document development setup in README.md
1 parent 98788f2 commit 04172f0

File tree

2 files changed

+61
-63
lines changed

2 files changed

+61
-63
lines changed

CONTRIBUTING.md

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

README.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,64 @@ Please see [seafile/README.md](seafile/README.md) for detailed information & ins
1717

1818
## Contributing
1919

20-
Please see our [contributing guidelines](https://github.com/datamate-rethink-it/seafile-helm/blob/main/CONTRIBUTING.md).
20+
### Kubernetes Development Environment
21+
22+
You can use an environment provided by [hetznercloud/kubernetes-dev-env](https://github.com/hetznercloud/kubernetes-dev-env) or use your own.
23+
24+
#### Prerequisites
25+
26+
- [`k3sup`](https://github.com/alexellis/k3sup)
27+
- [`tofu`](https://opentofu.org)
28+
29+
#### Instructions
30+
31+
```bash
32+
git clone [email protected]:hetznercloud/kubernetes-dev-env.git
33+
34+
cd kubernetes-dev-env
35+
36+
# Token for Hetzner Cloud
37+
export HCLOUD_TOKEN=''
38+
39+
# Edit example/main.tf and set `deploy_csi_driver` to `true`
40+
# This is required in order to use volumes
41+
nano example/main.tf
42+
43+
# Deploy the cluster
44+
make -C example up
45+
46+
# Load environment variables into session (KUBECONFIG)
47+
source example/files/env.sh
48+
```
49+
50+
### Deploy Ingress Controller
51+
52+
Create `ingress-nginx-values.yaml`:
53+
54+
```yaml
55+
controller:
56+
config:
57+
use-proxy-protocol: true
58+
service:
59+
annotations:
60+
# kubernetes-dev-env deploys the cluster into hel1 by default
61+
load-balancer.hetzner.cloud/location: "hel1"
62+
load-balancer.hetzner.cloud/uses-proxyprotocol: true
63+
```
64+
65+
Deploy the controller:
66+
67+
```bash
68+
helm upgrade --install ingress-nginx ingress-nginx \
69+
--repo https://kubernetes.github.io/ingress-nginx \
70+
--namespace ingress-nginx \
71+
--create-namespace \
72+
-f ingress-nginx-values.yaml
73+
```
74+
75+
This will automatically provision a load balancer from Hetzner.
76+
You should use the load balancer's public IP address to access any services deployed inside the cluster.
77+
78+
### Deploy Seafile
79+
80+
Please follow the instructions inside [seafile/README.md](./seafile/README.md).

0 commit comments

Comments
 (0)