Skip to content

Commit 90cecbd

Browse files
committed
docs: update sequence diagrams with correct command flags
- Update all commands from 'helm values' to 'helm values-manager' - Add mandatory and optional flags for all commands - Fix command flag format for consistency - Update flag names (--env to --deployment) - Add descriptive values for flags
1 parent 896a604 commit 90cecbd

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

docs/Design/sequence-diagrams.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sequenceDiagram
1010
participant HelmValuesConfig
1111
participant FileSystem
1212
13-
User->>CLI: helm values init
13+
User->>CLI: helm values-manager init --release test-release
1414
activate CLI
1515
1616
CLI->>BaseCommand: execute()
@@ -52,7 +52,7 @@ sequenceDiagram
5252
participant HelmValuesConfig
5353
participant PathValidator
5454
55-
User->>CLI: helm values add-value-config --path=app.replicas --required
55+
User->>CLI: helm values-manager add-value-config --path app.replicas --description "Number of replicas" --required
5656
activate CLI
5757
5858
CLI->>BaseCommand: execute()
@@ -90,7 +90,7 @@ sequenceDiagram
9090
participant BaseCommand
9191
participant HelmValuesConfig
9292
93-
User->>CLI: helm values add-deployment prod
93+
User->>CLI: helm values-manager add-deployment prod
9494
activate CLI
9595
9696
CLI->>BaseCommand: execute()
@@ -129,7 +129,7 @@ sequenceDiagram
129129
participant HelmValuesConfig
130130
participant ValueBackend
131131
132-
User->>CLI: helm values add-backend aws --deployment=prod --region=us-west-2
132+
User->>CLI: helm values-manager add-backend aws --deployment prod --region us-west-2
133133
activate CLI
134134
135135
CLI->>BaseCommand: execute()
@@ -173,7 +173,7 @@ sequenceDiagram
173173
participant HelmValuesConfig
174174
participant ValueBackend
175175
176-
User->>CLI: helm values add-auth direct --deployment=prod --credentials='{...}'
176+
User->>CLI: helm values-manager add-auth direct --deployment prod --credentials '{...}'
177177
activate CLI
178178
179179
CLI->>BaseCommand: execute()
@@ -219,7 +219,7 @@ sequenceDiagram
219219
participant ValueBackend
220220
participant Storage
221221
222-
User->>CLI: helm values set-value path value --env=prod
222+
User->>CLI: helm values-manager set-value --path app.replicas --value 3 --deployment prod
223223
activate CLI
224224
225225
CLI->>BaseCommand: execute()
@@ -279,7 +279,7 @@ sequenceDiagram
279279
participant ValueBackend
280280
participant Storage
281281
282-
User->>CLI: helm values get-value path --env=prod
282+
User->>CLI: helm values-manager get-value --path app.replicas --deployment prod
283283
activate CLI
284284
285285
CLI->>BaseCommand: execute()
@@ -337,7 +337,7 @@ sequenceDiagram
337337
participant ValueBackend
338338
participant Validator
339339
340-
User->>CLI: helm values validate
340+
User->>CLI: helm values-manager validate
341341
activate CLI
342342
343343
CLI->>BaseCommand: execute()
@@ -388,7 +388,7 @@ sequenceDiagram
388388
participant ValueBackend
389389
participant Generator
390390
391-
User->>CLI: helm values generate --env=prod
391+
User->>CLI: helm values-manager generate --deployment prod --output ./
392392
activate CLI
393393
394394
CLI->>BaseCommand: execute()
@@ -442,7 +442,7 @@ sequenceDiagram
442442
participant Storage
443443
participant TableFormatter
444444
445-
User->>CLI: helm values list-values --env=prod
445+
User->>CLI: helm values-manager list-values --deployment prod
446446
activate CLI
447447
448448
CLI->>BaseCommand: execute()
@@ -490,7 +490,7 @@ sequenceDiagram
490490
participant HelmValuesConfig
491491
participant TableFormatter
492492
493-
User->>CLI: helm values list-deployments
493+
User->>CLI: helm values-manager list-deployments
494494
activate CLI
495495
496496
CLI->>BaseCommand: execute()
@@ -526,7 +526,7 @@ sequenceDiagram
526526
participant ValueBackend
527527
participant Storage
528528
529-
User->>CLI: helm values remove-deployment prod
529+
User->>CLI: helm values-manager remove-deployment prod
530530
activate CLI
531531
532532
CLI->>BaseCommand: execute()
@@ -576,7 +576,7 @@ sequenceDiagram
576576
participant ValueBackend
577577
participant Storage
578578
579-
User->>CLI: helm values remove-value path --env=prod
579+
User->>CLI: helm values-manager remove-value --path app.replicas --deployment prod
580580
activate CLI
581581
582582
CLI->>BaseCommand: execute()
@@ -624,7 +624,7 @@ sequenceDiagram
624624
participant HelmValuesConfig
625625
participant Value
626626
627-
User->>CLI: helm values remove-value-config --path=app.replicas
627+
User->>CLI: helm values-manager remove-value-config --path app.replicas
628628
activate CLI
629629
630630
CLI->>BaseCommand: execute()
@@ -659,6 +659,7 @@ sequenceDiagram
659659
```
660660

661661
Each diagram shows:
662+
662663
- The exact CLI command being executed
663664
- All components involved in processing the command
664665
- The sequence of operations and data flow
@@ -679,3 +680,4 @@ Each diagram shows:
679680
10. `remove-deployment` - Remove a deployment configuration
680681
11. `remove-value` - Remove a value for a specific path and environment
681682
12. `remove-value-config` - Remove a value configuration and its associated values
683+
13. `generate` - Generate a values file for a specific deployment

0 commit comments

Comments
 (0)