Skip to content

Commit a449a59

Browse files
authored
Merge pull request #110 from fluxcd/docs-add-ns
Add namespace to API docs examples
2 parents 6402c7d + 6a51152 commit a449a59

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

docs/spec/v2beta1/helmreleases.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `HelmRelease` API defines a resource for automated controller driven Helm re
44

55
## Specification
66

7-
A **helmrelease** object defines a resource for controller driven reconciliation
7+
A **HelmRelease** object defines a resource for controller driven reconciliation
88
of Helm releases via Helm actions such as install, upgrade, test, uninstall, and rollback.
99
This includes release placement (namespace/name), release content (chart/values overrides),
1010
action trigger configuration, individual action configuration, and statusing.
@@ -656,6 +656,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2beta1
656656
kind: HelmRelease
657657
metadata:
658658
name: backend
659+
namespace: default
659660
spec:
660661
interval: 5m
661662
chart:
@@ -665,6 +666,7 @@ spec:
665666
sourceRef:
666667
kind: HelmRepository
667668
name: podinfo
669+
namespace: default
668670
interval: 1m
669671
upgrade:
670672
remediation:
@@ -683,6 +685,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2beta1
683685
kind: HelmRelease
684686
metadata:
685687
name: frontend
688+
namespace: default
686689
spec:
687690
interval: 5m
688691
chart:
@@ -692,6 +695,7 @@ spec:
692695
sourceRef:
693696
kind: HelmRepository
694697
name: podinfo
698+
namespace: default
695699
interval: 1m
696700
dependsOn:
697701
- backend
@@ -731,6 +735,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2beta1
731735
kind: HelmRelease
732736
metadata:
733737
name: podinfo
738+
namespace: default
734739
spec:
735740
interval: 5m
736741
chart:
@@ -740,6 +745,7 @@ spec:
740745
sourceRef:
741746
kind: HelmRepository
742747
name: podinfo
748+
namespace: default
743749
interval: 1m
744750
test:
745751
enable: true
@@ -773,28 +779,30 @@ to true if at least one retry is configured.
773779
apiVersion: helm.fluxcd.io/v2beta1
774780
kind: HelmRelease
775781
metadata:
776-
name: podinfo
782+
name: podinfo
783+
namespace: default
777784
spec:
778-
interval: 5m
779-
chart:
780-
spec:
781-
chart: podinfo
782-
version: '>=4.0.0 <5.0.0'
783-
sourceRef:
784-
kind: HelmRepository
785-
name: podinfo
786-
interval: 1m
787-
install:
788-
remediation:
789-
retries: 3
790-
upgrade:
791-
remediation:
792-
remediateLastFailure: false
793-
values:
794-
resources:
795-
requests:
796-
cpu: 100m
797-
memory: 64Mi
785+
interval: 5m
786+
chart:
787+
spec:
788+
chart: podinfo
789+
version: '>=4.0.0 <5.0.0'
790+
sourceRef:
791+
kind: HelmRepository
792+
name: podinfo
793+
namespace: default
794+
interval: 1m
795+
install:
796+
remediation:
797+
retries: 3
798+
upgrade:
799+
remediation:
800+
remediateLastFailure: false
801+
values:
802+
resources:
803+
requests:
804+
cpu: 100m
805+
memory: 64Mi
798806
```
799807

800808
## Status

0 commit comments

Comments
 (0)