You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enhanced Documentation and Cluster Creation Feedback (#62)
* Update development workflow documentation to include Replicated API Token setup and correct chart paths for Helm commands
* Enhance cluster creation task in Taskfile.yaml to check for existing clusters and output detailed information if found. This improves user feedback during the cluster setup process.
Copy file name to clipboardExpand all lines: applications/wg-easy/docs/development-workflow.md
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,12 @@ Before starting the development workflow, ensure you have the following tools in
17
17
18
18
-**Task:** The task runner used in this project. ([Installation Guide](https://taskfile.dev/installation/))
19
19
-**Container runtime tool** Either [Podman](https://podman.io/docs/installation) (default) or [Docker](https://docs.docker.com/get-docker/) for local development. Export `CONTAINER_RUNTIME=docker` in your shell if you use docker.
20
+
-**Replicated API Token:** Export `REPLICATED_API_TOKEN` in your shell. This can be obtained from the [Replicated Vendor Portal](https://vendor.replicated.com) under Account Settings → API Tokens.
21
+
22
+
```bash
23
+
# Add to your shell's rc file (.bashrc, .zshrc, etc.)
24
+
export REPLICATED_API_TOKEN="<your-token-here>"
25
+
```
20
26
21
27
All other tools will be automatically provided through task commands and containers.
22
28
@@ -29,7 +35,7 @@ Begin by defining and verifying chart dependencies.
29
35
1. Define or update dependencies in `Chart.yaml`:
30
36
31
37
```yaml
32
-
# Example: cert-manager/Chart.yaml
38
+
# Example: charts/cert-manager/Chart.yaml
33
39
dependencies:
34
40
- name: cert-manager
35
41
version: '1.14.5'
@@ -44,13 +50,13 @@ Begin by defining and verifying chart dependencies.
44
50
```bash
45
51
task dependencies-update
46
52
# Or for a single chart:
47
-
helm dependency update ./cert-manager
53
+
helm dependency update ./charts/cert-manager
48
54
```
49
55
50
56
3. Verify charts were downloaded:
51
57
52
58
```bash
53
-
ls -la ./cert-manager/charts/
59
+
ls -la ./charts/cert-manager/charts/
54
60
```
55
61
56
62
**Validation point**: Dependencies should be successfully downloaded to the `/charts` directory.
@@ -105,7 +111,7 @@ Validate chart templates locally without deploying to a cluster.
105
111
106
112
1. Run helm template to render the chart and inspect manifests:
107
113
```bash
108
-
helm template ./cert-manager | less
114
+
helm template ./charts/cert-manager | less
109
115
```
110
116
111
117
**Validation point**: Generated Kubernetes manifests should be valid and contain the expected resources.
@@ -117,14 +123,22 @@ Deploy individual charts to a test cluster to verify functionality.
0 commit comments