Add namespace to API docs examples

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
This commit is contained in:
Stefan Prodan 2020-10-13 17:41:49 +03:00
parent 6402c7d775
commit 6a51152c7f
No known key found for this signature in database
GPG Key ID: 3299AEB0E4085BAF
1 changed files with 30 additions and 22 deletions

View File

@ -4,7 +4,7 @@ The `HelmRelease` API defines a resource for automated controller driven Helm re
## Specification ## Specification
A **helmrelease** object defines a resource for controller driven reconciliation A **HelmRelease** object defines a resource for controller driven reconciliation
of Helm releases via Helm actions such as install, upgrade, test, uninstall, and rollback. of Helm releases via Helm actions such as install, upgrade, test, uninstall, and rollback.
This includes release placement (namespace/name), release content (chart/values overrides), This includes release placement (namespace/name), release content (chart/values overrides),
action trigger configuration, individual action configuration, and statusing. action trigger configuration, individual action configuration, and statusing.
@ -656,6 +656,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease kind: HelmRelease
metadata: metadata:
name: backend name: backend
namespace: default
spec: spec:
interval: 5m interval: 5m
chart: chart:
@ -665,6 +666,7 @@ spec:
sourceRef: sourceRef:
kind: HelmRepository kind: HelmRepository
name: podinfo name: podinfo
namespace: default
interval: 1m interval: 1m
upgrade: upgrade:
remediation: remediation:
@ -683,6 +685,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease kind: HelmRelease
metadata: metadata:
name: frontend name: frontend
namespace: default
spec: spec:
interval: 5m interval: 5m
chart: chart:
@ -692,6 +695,7 @@ spec:
sourceRef: sourceRef:
kind: HelmRepository kind: HelmRepository
name: podinfo name: podinfo
namespace: default
interval: 1m interval: 1m
dependsOn: dependsOn:
- backend - backend
@ -731,6 +735,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease kind: HelmRelease
metadata: metadata:
name: podinfo name: podinfo
namespace: default
spec: spec:
interval: 5m interval: 5m
chart: chart:
@ -740,6 +745,7 @@ spec:
sourceRef: sourceRef:
kind: HelmRepository kind: HelmRepository
name: podinfo name: podinfo
namespace: default
interval: 1m interval: 1m
test: test:
enable: true enable: true
@ -773,28 +779,30 @@ to true if at least one retry is configured.
apiVersion: helm.fluxcd.io/v2beta1 apiVersion: helm.fluxcd.io/v2beta1
kind: HelmRelease kind: HelmRelease
metadata: metadata:
name: podinfo name: podinfo
namespace: default
spec: spec:
interval: 5m interval: 5m
chart: chart:
spec: spec:
chart: podinfo chart: podinfo
version: '>=4.0.0 <5.0.0' version: '>=4.0.0 <5.0.0'
sourceRef: sourceRef:
kind: HelmRepository kind: HelmRepository
name: podinfo name: podinfo
interval: 1m namespace: default
install: interval: 1m
remediation: install:
retries: 3 remediation:
upgrade: retries: 3
remediation: upgrade:
remediateLastFailure: false remediation:
values: remediateLastFailure: false
resources: values:
requests: resources:
cpu: 100m requests:
memory: 64Mi cpu: 100m
memory: 64Mi
``` ```
## Status ## Status