Skip to content

Commit 8f4383f

Browse files
docs: update installation to use Helm and simplify quickstart
1 parent f4012b8 commit 8f4383f

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

src/content/docs/guides/installation.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,28 @@ kubectl wait --for=condition=available --timeout=300s deployment/cert-manager-we
3535

3636
### 2. Deploy Forkspacer
3737

38-
Install the Forkspacer operator and Custom Resource Definitions (CRDs):
38+
Install the Forkspacer operator using Helm:
3939

4040
```bash
41-
kubectl apply -f https://raw.githubusercontent.com/forkspacer/forkspacer/main/dist/install.yaml
41+
# Add the Forkspacer Helm repository
42+
helm repo add forkspacer https://forkspacer.github.io/forkspacer
43+
helm repo update
44+
45+
# Install Forkspacer
46+
helm install forkspacer forkspacer/forkspacer \
47+
--namespace forkspacer-system \
48+
--create-namespace
49+
```
50+
51+
For advanced configuration options:
52+
53+
```bash
54+
# Install with custom values
55+
helm install forkspacer forkspacer/forkspacer \
56+
--namespace forkspacer-system \
57+
--create-namespace \
58+
--set operator-ui.enabled=true \
59+
--set ingress.enabled=true
4260
```
4361

4462
### 3. Verify Installation
@@ -114,8 +132,8 @@ To remove Forkspacer from your cluster:
114132
kubectl delete workspaces --all -A
115133
kubectl delete modules --all -A
116134

117-
# Remove the operator
118-
kubectl delete -f https://raw.githubusercontent.com/forkspacer/forkspacer/main/dist/install.yaml
135+
# Remove the operator using Helm
136+
helm uninstall forkspacer -n forkspacer-system
119137

120138
# Optionally remove cert-manager
121139
kubectl delete -f https://github.com/cert-manager/cert-manager/releases/download/v1.18.2/cert-manager.yaml

src/content/docs/guides/quick-start.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -64,25 +64,7 @@ spec:
6464
name: default
6565
namespace: default
6666
source:
67-
raw:
68-
kind: Helm
69-
metadata:
70-
name: redis
71-
supportedOperatorVersion: ">= 0.0.0, < 1.0.0"
72-
spec:
73-
namespace: default
74-
repo: https://charts.bitnami.com/bitnami
75-
chartName: redis
76-
version: "18.0.0"
77-
values:
78-
- raw:
79-
image:
80-
repository: bitnamilegacy/redis
81-
global:
82-
security:
83-
allowInsecureImages: true
84-
replica:
85-
replicaCount: 1
67+
httpURL: https://raw.githubusercontent.com/forkspacer/modules/refs/heads/main/redis/1.0.0/module.yaml
8668
```
8769
8870
Deploy the module:

0 commit comments

Comments
 (0)