Skip to content

Commit 9feda00

Browse files
authored
Merge pull request #139 from fluxcd/docs-add-ns
Add namespace to API docs examples
2 parents 43c99d2 + 4b6ca1d commit 9feda00

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/spec/v1beta1/kustomization.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -258,10 +258,6 @@ A health check entry can reference one of the following types:
258258
* Toolkit kinds: HelmRelease, HelmRepository, GitRepository, etc
259259
* Custom resources that are compatible with [kstatus](https://github.com/kubernetes-sigs/cli-utils/tree/master/pkg/kstatus)
260260

261-
> :warning: **If you are using health checks for HelmRelease**: Helm charts containing a single replica will not behave as expected.
262-
> Its health check will allways succeed no matter the status of the pod. This is due to a [bug in Helms wait functionality](https://github.com/helm/helm/issues/8660).
263-
> A workaround until this issue is fixed is to add a Helm test with a job that waits until the pod is ready.
264-
265261
Assuming the kustomization source contains a Kubernetes Deployment named `backend`,
266262
a health check can be defined as follows:
267263

@@ -270,6 +266,7 @@ apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
270266
kind: Kustomization
271267
metadata:
272268
name: backend
269+
namespace: default
273270
spec:
274271
interval: 5m
275272
path: "./webapp/backend/"
@@ -299,6 +296,7 @@ apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
299296
kind: Kustomization
300297
metadata:
301298
name: webapp
299+
namespace: default
302300
spec:
303301
interval: 15m
304302
path: "./releases/"
@@ -342,6 +340,7 @@ apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
342340
kind: Kustomization
343341
metadata:
344342
name: common
343+
namespace: default
345344
spec:
346345
interval: 5m
347346
path: "./webapp/common/"
@@ -354,6 +353,7 @@ apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
354353
kind: Kustomization
355354
metadata:
356355
name: backend
356+
namespace: default
357357
spec:
358358
dependsOn:
359359
- name: common
@@ -390,6 +390,7 @@ apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
390390
kind: Kustomization
391391
metadata:
392392
name: backend
393+
namespace: default
393394
spec:
394395
dependsOn:
395396
- name: common
@@ -465,6 +466,7 @@ apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
465466
kind: Kustomization
466467
metadata:
467468
name: backend
469+
namespace: webapp
468470
spec:
469471
dependsOn:
470472
- name: common
@@ -503,11 +505,11 @@ Commit and push the encrypted file to Git.
503505
> **Note** that you should encrypt only the `data` section, encrypting the Kubernetes secret
504506
> metadata, kind or apiVersion is not supported by kustomize-controller.
505507

506-
Create a secret in the `gotk-system` namespace with the OpenPGP private key:
508+
Create a secret in the `default` namespace with the OpenPGP private key:
507509

508510
```sh
509511
gpg --export-secret-keys --armor FBC7B9E2A4F9289AC0C1D4843D16CEE4A27381B4 |
510-
kubectl -n gotk-system create secret generic sops-gpg \
512+
kubectl -n default create secret generic sops-gpg \
511513
--from-file=sops.asc=/dev/stdin
512514
```
513515

@@ -518,6 +520,7 @@ apiVersion: kustomize.toolkit.fluxcd.io/v1beta1
518520
kind: Kustomization
519521
metadata:
520522
name: my-secrets
523+
namespace: default
521524
spec:
522525
interval: 5m
523526
path: "./"
@@ -598,4 +601,3 @@ When a reconciliation fails, the controller logs the error and issues a Kubernet
598601
"error": "The Service 'backend' is invalid: spec.type: Unsupported value: 'Ingress'"
599602
}
600603
```
601-

0 commit comments

Comments
 (0)