Skip to content

Commit 3b93e77

Browse files
Merge pull request #5 from forkspacer/docs/fix-crd-examples-and-quickstart
Docs/fix crd examples and quickstart
2 parents ae6d214 + a184778 commit 3b93e77

File tree

3 files changed

+9
-69
lines changed

3 files changed

+9
-69
lines changed

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

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,6 @@ spec:
2828
type: kubernetes
2929
connection:
3030
type: in-cluster
31-
autoHibernation:
32-
enabled: false
33-
schedule: "0 42 18 * * *" # 6-field cron with seconds
34-
wakeSchedule: "0 44 18 * * *"
3531
```
3632
3733
Apply the workspace:
@@ -64,58 +60,27 @@ metadata:
6460
name: redis
6561
namespace: default
6662
spec:
63+
workspace:
64+
name: default
65+
namespace: default
6766
source:
6867
raw:
6968
kind: Helm
7069
metadata:
7170
name: redis
7271
supportedOperatorVersion: ">= 0.0.0, < 1.0.0"
73-
74-
config:
75-
- type: option
76-
name: "Redis Version"
77-
alias: "version"
78-
spec:
79-
editable: true
80-
required: false
81-
default: "21.2.9"
82-
values:
83-
- "21.2.9"
84-
- "21.2.7"
85-
- "21.2.6"
86-
87-
- type: integer
88-
name: "Replica Count"
89-
alias: "replicaCount"
90-
spec:
91-
editable: true
92-
required: false
93-
default: 1
94-
min: 0
95-
max: 5
96-
9772
spec:
9873
namespace: default
9974
repo: https://charts.bitnami.com/bitnami
10075
chartName: redis
101-
version: "{{.config.version}}"
102-
76+
version: "18.0.0"
10377
values:
10478
- raw:
105-
replica:
106-
replicaCount: "{{.config.replicaCount}}"
107-
108-
cleanup:
109-
removeNamespace: false
110-
removePVCs: true
111-
112-
workspace:
113-
name: default
114-
namespace: default
115-
116-
config:
117-
version: 21.2.7
118-
replicaCount: 1
79+
image:
80+
repository: bitnamilegacy/redis
81+
global:
82+
security:
83+
allowInsecureImages: true
11984
```
12085
12186
Deploy the module:

src/content/docs/reference/CRDs/module.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,6 @@ spec:
3636
replicas: 3
3737
environment: production
3838
hibernated: false
39-
status:
40-
phase: ready
41-
lastActivity: "2025-10-01T10:30:00Z"
42-
conditions:
43-
- type: Available
44-
status: "True"
45-
lastTransitionTime: "2025-10-01T10:30:00Z"
46-
reason: ModuleReady
47-
message: Module is successfully installed and running
4839
```
4940
5041
### Custom Module Example
@@ -68,8 +59,6 @@ spec:
6859
supportedOperatorVersion: ">= 0.0.0, < 1.0.0"
6960
spec:
7061
image: my-registry/custom-app:v1.0.0
71-
status:
72-
phase: ready
7362
```
7463
7564
## Spec Fields

src/content/docs/reference/CRDs/workspace.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,20 +29,6 @@ spec:
2929
hibernated: false
3030
connection:
3131
type: local
32-
autoHibernation:
33-
enabled: true
34-
schedule: "0 18 * * 1-5" # Hibernate at 6 PM on weekdays
35-
wakeSchedule: "0 8 * * 1-5" # Wake at 8 AM on weekdays
36-
status:
37-
phase: ready
38-
ready: true
39-
lastActivity: "2025-10-01T10:30:00Z"
40-
conditions:
41-
- type: Available
42-
status: "True"
43-
lastTransitionTime: "2025-10-01T10:30:00Z"
44-
reason: WorkspaceReady
45-
message: Workspace is fully operational
4632
```
4733
4834
## Spec Fields

0 commit comments

Comments
 (0)