Skip to content

Commit d93d4e1

Browse files
committed
Add Argo PR link and FluxCD reference
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent b6d2bdb commit d93d4e1

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/openfaas-pro/function-crd.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,33 @@ ArgoCD health status:
182182
* Function is ready and can serve traffic to at least one Pod => Argo status: healthy
183183
* Function is ready (no changes need to be applied), but has been scaled down to zero replicas => Argo status: suspended
184184
185+
Note: [A pull request was sent to the ArgoCD project](https://github.com/argoproj/argo-cd/pull/18015), so in a future version of ArgoCD, you won't need to create the above ConfigMap manually. However if you do want to override the behaviour of the health status, then you can still create a ConfigMap with the above content.
186+
187+
#### FluxCD health status
188+
189+
When using FluxCD, and the kustomization controller, the built-in Ready condition will be observed to detect whether a rollout was successful.
190+
191+
Just make sure that the `spec.wait` field is set to `true` in the Kustomization resource.
192+
193+
From the FluxCD Kustomization docs:
194+
195+
> `.spec.wait` is an optional boolean field to perform health checks for all reconciled resources as part of the Kustomization.
196+
197+
```diff
198+
apiVersion: kustomize.toolkit.fluxcd.io/v1
199+
kind: Kustomization
200+
metadata:
201+
name: env
202+
spec:
203+
interval: 10m
204+
targetNamespace: openfaas-fn
205+
...
206+
path: ./apps/prod
207+
+ wait: true
208+
```
209+
210+
See also: [FluxCD Kustomization docs](https://fluxcd.io/flux/components/kustomize/kustomizations/)
211+
185212
### How to generate a spec from a stack.yml
186213

187214
If you already have functions defined in a stack.yml file, you can generate the Function resources with:

0 commit comments

Comments
 (0)