Skip to content

Commit 3c19b77

Browse files
SimonSchubertSimonSchubert
committed
Add commands
1 parent f9762d9 commit 3c19b77

3 files changed

Lines changed: 183 additions & 0 deletions

File tree

‎assets/commands/flux-suspend.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# TAGLINE
2+
3+
Suspend reconciliation of Flux resources
4+
5+
# TLDR
6+
7+
**Suspend a Kustomization**
8+
9+
```flux suspend kustomization podinfo```
10+
11+
**Suspend all Kustomizations** in the current namespace
12+
13+
```flux suspend kustomization --all```
14+
15+
**Suspend a HelmRelease**
16+
17+
```flux suspend helmrelease podinfo```
18+
19+
**Suspend a GitRepository source**
20+
21+
```flux suspend source git my-repo```
22+
23+
**Suspend an ImageUpdateAutomation**
24+
25+
```flux suspend image update my-automation```
26+
27+
# SYNOPSIS
28+
29+
**flux** **suspend** _kind_ [_name_ ...] [_options_]
30+
31+
# DESCRIPTION
32+
33+
**flux suspend** disables reconciliation of a Flux custom resource. Controllers stop applying Git, Helm, OCI, or image-automation changes for that object until it is resumed with `flux resume`.
34+
35+
The resource name is required unless **--all** is set, which suspends every matching object in the namespace (default `flux-system`). Multiple names may be given in one invocation.
36+
37+
Short kind aliases such as `ks` for kustomization and `hr` for helmrelease are accepted.
38+
39+
# KINDS
40+
41+
**kustomization**
42+
> Suspend a Kustomization.
43+
44+
**helmrelease**
45+
> Suspend a HelmRelease.
46+
47+
**source git**, **source helm**, **source oci**, **source bucket**, **source chart**
48+
> Suspend a GitRepository, HelmRepository, OCIRepository, Bucket, or HelmChart.
49+
50+
**image policy**, **image repository**, **image update**
51+
> Suspend ImagePolicy, ImageRepository, or ImageUpdateAutomation objects.
52+
53+
**alert**, **alert-provider**, **receiver**
54+
> Suspend notification Alerts, Providers, and Receivers.
55+
56+
# PARAMETERS
57+
58+
**--all**
59+
> Suspend all resources of the given kind in the namespace.
60+
61+
**-n**, **--namespace** _ns_
62+
> Namespace scope for the CLI request (default `flux-system`).
63+
64+
**--timeout** _duration_
65+
> Timeout for the operation (default `5m0s`).
66+
67+
**--kubeconfig** _file_
68+
> Path to the kubeconfig file.
69+
70+
**--context** _name_
71+
> Kubeconfig context to use.
72+
73+
# CAVEATS
74+
75+
Suspension is stored on the live cluster object. GitOps will restore the previous spec if a source still defines `spec.suspend: false` (or omits it) and a controller reconciles that source. Cluster access via kubectl is required.
76+
77+
# INSTALL
78+
79+
```apk: sudo apk add flux```
80+
81+
```brew: brew install flux```
82+
83+
```nix: nix profile install nixpkgs#flux```
84+
85+
<!-- packages: 2026-10-09 -->
86+
87+
# SEE ALSO
88+
89+
[flux](/man/flux)(1), [flux-check](/man/flux-check)(1), [flux-create](/man/flux-create)(1), [flux-bootstrap](/man/flux-bootstrap)(1)
90+
91+
# RESOURCES
92+
93+
```[Source code](https://github.com/fluxcd/flux2)```
94+
95+
```[Documentation](https://fluxcd.io/flux/cmd/flux_suspend/)```
96+
97+
<!-- verified: 2026-10-09 -->

‎assets/commands/flux-uninstall.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# TAGLINE
2+
3+
Uninstall Flux components and custom resource definitions from a cluster
4+
5+
# TLDR
6+
7+
**Uninstall Flux** from the default `flux-system` namespace
8+
9+
```flux uninstall```
10+
11+
**Uninstall without a confirmation prompt**
12+
13+
```flux uninstall --silent```
14+
15+
**Uninstall from a specific namespace**
16+
17+
```flux uninstall --namespace infra```
18+
19+
**Uninstall Flux but keep the namespace**
20+
21+
```flux uninstall --keep-namespace```
22+
23+
**Print objects that would be deleted** without changing the cluster
24+
25+
```flux uninstall --dry-run```
26+
27+
# SYNOPSIS
28+
29+
**flux** **uninstall** [_options_]
30+
31+
# DESCRIPTION
32+
33+
**flux uninstall** removes Flux from a Kubernetes cluster. It deletes the Flux components in the target namespace, strips `toolkit.fluxcd.io` finalizers cluster-wide, deletes the Flux custom resource definitions, and (unless **--keep-namespace** is set) deletes the namespace.
34+
35+
The command takes no positional arguments. The namespace defaults to `flux-system`. Unless **--silent** or **--dry-run** is set, it asks for confirmation. If Flux was installed by another manager, the prompt names that manager before proceeding.
36+
37+
# PARAMETERS
38+
39+
**-s**, **--silent**
40+
> Delete components without asking for confirmation.
41+
42+
**--keep-namespace**
43+
> Skip namespace deletion.
44+
45+
**--dry-run**
46+
> Print the objects that would be deleted without applying changes.
47+
48+
**-n**, **--namespace** _ns_
49+
> Namespace that holds the Flux components (default `flux-system`).
50+
51+
**--timeout** _duration_
52+
> Timeout for the operation (default `5m0s`).
53+
54+
**--kubeconfig** _file_
55+
> Path to the kubeconfig file.
56+
57+
**--context** _name_
58+
> Kubeconfig context to use.
59+
60+
# CAVEATS
61+
62+
This is a destructive cluster operation. Custom resources of Flux kinds are removed with the CRDs. Workloads Flux previously applied are left in place unless those objects are also Flux CRDs. Cluster-admin access is typically required. Git still contains the bootstrap manifests unless they are deleted separately.
63+
64+
# INSTALL
65+
66+
```apk: sudo apk add flux```
67+
68+
```brew: brew install flux```
69+
70+
```nix: nix profile install nixpkgs#flux```
71+
72+
<!-- packages: 2026-10-09 -->
73+
74+
# SEE ALSO
75+
76+
[flux](/man/flux)(1), [flux-bootstrap](/man/flux-bootstrap)(1), [flux-check](/man/flux-check)(1)
77+
78+
# RESOURCES
79+
80+
```[Source code](https://github.com/fluxcd/flux2)```
81+
82+
```[Documentation](https://fluxcd.io/flux/cmd/flux_uninstall/)```
83+
84+
<!-- verified: 2026-10-09 -->

‎assets/commands/index.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2430,6 +2430,8 @@ flux-bootstrap.md
24302430
flux-build.md
24312431
flux-check.md
24322432
flux-create.md
2433+
flux-suspend.md
2434+
flux-uninstall.md
24332435
flux.md
24342436
fluxctl.md
24352437
fluxion.md

0 commit comments

Comments
 (0)