Remove Flux CLI docs

They are imported into the docs like so:
	https://github.com/fluxcd/website/blob/main/hack/import-flux2-assets.sh#L139

Signed-off-by: Daniel Holbach <daniel@weave.works>
pull/1365/head
Daniel Holbach 4 years ago
parent ec21eedd56
commit 695fb55b13

@ -14,7 +14,7 @@ fmt:
vet: vet:
go vet ./... go vet ./...
test: $(EMBEDDED_MANIFESTS_TARGET) tidy fmt vet docs test: $(EMBEDDED_MANIFESTS_TARGET) tidy fmt vet
go test ./... -coverprofile cover.out go test ./... -coverprofile cover.out
$(EMBEDDED_MANIFESTS_TARGET): $(call rwildcard,manifests/,*.yaml *.json) $(EMBEDDED_MANIFESTS_TARGET): $(call rwildcard,manifests/,*.yaml *.json)
@ -26,10 +26,5 @@ build: $(EMBEDDED_MANIFESTS_TARGET)
install: install:
go install cmd/flux go install cmd/flux
.PHONY: docs
docs:
rm -rf docs/cmd/*
mkdir -p ./docs/cmd && go run ./cmd/flux/ docgen
install-dev: install-dev:
CGO_ENABLED=0 go build -o /usr/local/bin ./cmd/flux CGO_ENABLED=0 go build -o /usr/local/bin ./cmd/flux

@ -1,96 +0,0 @@
---
title: "flux command"
---
## flux
Command line utility for assembling Kubernetes CD pipelines
### Synopsis
Command line utility for assembling Kubernetes CD pipelines the GitOps way.
### Examples
```
# Check prerequisites
flux check --pre
# Install the latest version of Flux
flux install --version=master
# Create a source for a public Git repository
flux create source git webapp-latest \
--url=https://github.com/stefanprodan/podinfo \
--branch=master \
--interval=3m
# List GitRepository sources and their status
flux get sources git
# Trigger a GitRepository source reconciliation
flux reconcile source git flux-system
# Export GitRepository sources in YAML format
flux export source git --all > sources.yaml
# Create a Kustomization for deploying a series of microservices
flux create kustomization webapp-dev \
--source=webapp-latest \
--path="./deploy/webapp/" \
--prune=true \
--interval=5m \
--validation=client \
--health-check="Deployment/backend.webapp" \
--health-check="Deployment/frontend.webapp" \
--health-check-timeout=2m
# Trigger a git sync of the Kustomization's source and apply changes
flux reconcile kustomization webapp-dev --with-source
# Suspend a Kustomization reconciliation
flux suspend kustomization webapp-dev
# Export Kustomizations in YAML format
flux export kustomization --all > kustomizations.yaml
# Resume a Kustomization reconciliation
flux resume kustomization webapp-dev
# Delete a Kustomization
flux delete kustomization webapp-dev
# Delete a GitRepository source
flux delete source git webapp-latest
# Uninstall Flux and delete CRDs
flux uninstall
```
### Options
```
--context string kubernetes context to use
-h, --help help for flux
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux bootstrap](../flux_bootstrap/) - Bootstrap toolkit components
* [flux check](../flux_check/) - Check requirements and installation
* [flux completion](../flux_completion/) - Generates completion scripts for various shells
* [flux create](../flux_create/) - Create or update sources and resources
* [flux delete](../flux_delete/) - Delete sources and resources
* [flux export](../flux_export/) - Export resources in YAML format
* [flux get](../flux_get/) - Get the resources and their status
* [flux install](../flux_install/) - Install or upgrade Flux
* [flux logs](../flux_logs/) - Display formatted logs for Flux components
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources
* [flux resume](../flux_resume/) - Resume suspended resources
* [flux suspend](../flux_suspend/) - Suspend resources
* [flux uninstall](../flux_uninstall/) - Uninstall Flux and its custom resource definitions

@ -1,57 +0,0 @@
---
title: "flux bootstrap command"
---
## flux bootstrap
Bootstrap toolkit components
### Synopsis
The bootstrap sub-commands bootstrap the toolkit components on the targeted Git provider.
### Options
```
--author-email string author email for Git commits
--author-name string author name for Git commits (default "Flux")
--branch string Git branch (default "main")
--ca-file string path to TLS CA file used for validating self-signed certificates
--cluster-domain string internal cluster domain (default "cluster.local")
--commit-message-appendix string string to add to the commit messages, e.g. '[ci skip]'
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
-h, --help help for bootstrap
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--log-level logLevel log level, available options are: (debug, info, error) (default info)
--network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true)
--private-key-file string path to a private key file used for authenticating to the Git SSH server
--recurse-submodules when enabled, configures the GitRepository source to initialize and include Git submodules in the artifact it produces
--registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd")
--secret-name string name of the secret the sync credentials can be found in or stored to (default "flux-system")
--ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (default p384)
--ssh-hostname string SSH hostname, to be used when the SSH host differs from the HTTPS one
--ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa)
--ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048)
--token-auth when enabled, the personal access token will be used instead of SSH deploy key
--toleration-keys strings list of toleration keys used to schedule the components pods onto nodes with matching taints
-v, --version string toolkit version, when specified the manifests are downloaded from https://github.com/fluxcd/flux2/releases
--watch-all-namespaces watch for custom resources in all namespaces, if set to false it will only watch the namespace where the toolkit is installed (default true)
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux bootstrap git](../flux_bootstrap_git/) - Bootstrap toolkit components in a Git repository
* [flux bootstrap github](../flux_bootstrap_github/) - Bootstrap toolkit components in a GitHub repository
* [flux bootstrap gitlab](../flux_bootstrap_gitlab/) - Bootstrap toolkit components in a GitLab repository

@ -1,83 +0,0 @@
---
title: "flux bootstrap git command"
---
## flux bootstrap git
Bootstrap toolkit components in a Git repository
### Synopsis
The bootstrap git command commits the toolkit components manifests to the
branch of a Git repository. It then configures the target cluster to synchronize with
the repository. If the toolkit components are present on the cluster, the bootstrap
command will perform an upgrade if needed.
```
flux bootstrap git [flags]
```
### Examples
```
# Run bootstrap for a Git repository and authenticate with your SSH agent
flux bootstrap git --url=ssh://git@example.com/repository.git
# Run bootstrap for a Git repository and authenticate using a password
flux bootstrap git --url=https://example.com/repository.git --password=<password>
# Run bootstrap for a Git repository with a passwordless private key
flux bootstrap git --url=ssh://git@example.com/repository.git --private-key-file=<path/to/private.key>
# Run bootstrap for a Git repository with a private key and password
flux bootstrap git --url=ssh://git@example.com/repository.git --private-key-file=<path/to/private.key> --password=<password>
```
### Options
```
-h, --help help for git
--interval duration sync interval (default 1m0s)
-p, --password string basic authentication password
--path safeRelativePath path relative to the repository root, when specified the cluster sync will be scoped to this path
--url string Git repository URL
-u, --username string basic authentication username (default "git")
```
### Options inherited from parent commands
```
--author-email string author email for Git commits
--author-name string author name for Git commits (default "Flux")
--branch string Git branch (default "main")
--ca-file string path to TLS CA file used for validating self-signed certificates
--cluster-domain string internal cluster domain (default "cluster.local")
--commit-message-appendix string string to add to the commit messages, e.g. '[ci skip]'
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
--context string kubernetes context to use
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--kubeconfig string absolute path to the kubeconfig file
--log-level logLevel log level, available options are: (debug, info, error) (default info)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true)
--private-key-file string path to a private key file used for authenticating to the Git SSH server
--recurse-submodules when enabled, configures the GitRepository source to initialize and include Git submodules in the artifact it produces
--registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd")
--secret-name string name of the secret the sync credentials can be found in or stored to (default "flux-system")
--ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (default p384)
--ssh-hostname string SSH hostname, to be used when the SSH host differs from the HTTPS one
--ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa)
--ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048)
--timeout duration timeout for this operation (default 5m0s)
--token-auth when enabled, the personal access token will be used instead of SSH deploy key
--toleration-keys strings list of toleration keys used to schedule the components pods onto nodes with matching taints
--verbose print generated objects
-v, --version string toolkit version, when specified the manifests are downloaded from https://github.com/fluxcd/flux2/releases
--watch-all-namespaces watch for custom resources in all namespaces, if set to false it will only watch the namespace where the toolkit is installed (default true)
```
### SEE ALSO
* [flux bootstrap](../flux_bootstrap/) - Bootstrap toolkit components

@ -1,100 +0,0 @@
---
title: "flux bootstrap github command"
---
## flux bootstrap github
Bootstrap toolkit components in a GitHub repository
### Synopsis
The bootstrap github command creates the GitHub repository if it doesn't exists and
commits the toolkit components manifests to the main branch.
Then it configures the target cluster to synchronize with the repository.
If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
```
flux bootstrap github [flags]
```
### Examples
```
# Create a GitHub personal access token and export it as an env var
export GITHUB_TOKEN=<my-token>
# Run bootstrap for a private repository owned by a GitHub organization
flux bootstrap github --owner=<organization> --repository=<repository name>
# Run bootstrap for a private repository and assign organization teams to it
flux bootstrap github --owner=<organization> --repository=<repository name> --team=<team1 slug> --team=<team2 slug>
# Run bootstrap for a repository path
flux bootstrap github --owner=<organization> --repository=<repository name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
flux bootstrap github --owner=<user> --repository=<repository name> --private=false --personal=true
# Run bootstrap for a private repository hosted on GitHub Enterprise using SSH auth
flux bootstrap github --owner=<organization> --repository=<repository name> --hostname=<domain> --ssh-hostname=<domain>
# Run bootstrap for a private repository hosted on GitHub Enterprise using HTTPS auth
flux bootstrap github --owner=<organization> --repository=<repository name> --hostname=<domain> --token-auth
# Run bootstrap for an existing repository with a branch named main
flux bootstrap github --owner=<organization> --repository=<repository name> --branch=main
```
### Options
```
-h, --help help for github
--hostname string GitHub hostname (default "github.com")
--interval duration sync interval (default 1m0s)
--owner string GitHub user or organization name
--path safeRelativePath path relative to the repository root, when specified the cluster sync will be scoped to this path
--personal if true, the owner is assumed to be a GitHub user; otherwise an org
--private if true, the repository is setup or configured as private (default true)
--read-write-key if true, the deploy key is configured with read/write permissions
--reconcile if true, the configured options are also reconciled if the repository already exists
--repository string GitHub repository name
--team stringArray GitHub team to be given maintainer access
```
### Options inherited from parent commands
```
--author-email string author email for Git commits
--author-name string author name for Git commits (default "Flux")
--branch string Git branch (default "main")
--ca-file string path to TLS CA file used for validating self-signed certificates
--cluster-domain string internal cluster domain (default "cluster.local")
--commit-message-appendix string string to add to the commit messages, e.g. '[ci skip]'
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
--context string kubernetes context to use
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--kubeconfig string absolute path to the kubeconfig file
--log-level logLevel log level, available options are: (debug, info, error) (default info)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true)
--private-key-file string path to a private key file used for authenticating to the Git SSH server
--recurse-submodules when enabled, configures the GitRepository source to initialize and include Git submodules in the artifact it produces
--registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd")
--secret-name string name of the secret the sync credentials can be found in or stored to (default "flux-system")
--ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (default p384)
--ssh-hostname string SSH hostname, to be used when the SSH host differs from the HTTPS one
--ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa)
--ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048)
--timeout duration timeout for this operation (default 5m0s)
--token-auth when enabled, the personal access token will be used instead of SSH deploy key
--toleration-keys strings list of toleration keys used to schedule the components pods onto nodes with matching taints
--verbose print generated objects
-v, --version string toolkit version, when specified the manifests are downloaded from https://github.com/fluxcd/flux2/releases
--watch-all-namespaces watch for custom resources in all namespaces, if set to false it will only watch the namespace where the toolkit is installed (default true)
```
### SEE ALSO
* [flux bootstrap](../flux_bootstrap/) - Bootstrap toolkit components

@ -1,97 +0,0 @@
---
title: "flux bootstrap gitlab command"
---
## flux bootstrap gitlab
Bootstrap toolkit components in a GitLab repository
### Synopsis
The bootstrap gitlab command creates the GitLab repository if it doesn't exists and
commits the toolkit components manifests to the master branch.
Then it configures the target cluster to synchronize with the repository.
If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
```
flux bootstrap gitlab [flags]
```
### Examples
```
# Create a GitLab API token and export it as an env var
export GITLAB_TOKEN=<my-token>
# Run bootstrap for a private repository using HTTPS token authentication
flux bootstrap gitlab --owner=<group> --repository=<repository name> --token-auth
# Run bootstrap for a private repository using SSH authentication
flux bootstrap gitlab --owner=<group> --repository=<repository name>
# Run bootstrap for a repository path
flux bootstrap gitlab --owner=<group> --repository=<repository name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
flux bootstrap gitlab --owner=<user> --repository=<repository name> --private=false --personal --token-auth
# Run bootstrap for a private repository hosted on a GitLab server
flux bootstrap gitlab --owner=<group> --repository=<repository name> --hostname=<domain> --token-auth
# Run bootstrap for a an existing repository with a branch named main
flux bootstrap gitlab --owner=<organization> --repository=<repository name> --branch=main --token-auth
```
### Options
```
-h, --help help for gitlab
--hostname string GitLab hostname (default "gitlab.com")
--interval duration sync interval (default 1m0s)
--owner string GitLab user or group name
--path safeRelativePath path relative to the repository root, when specified the cluster sync will be scoped to this path
--personal if true, the owner is assumed to be a GitLab user; otherwise a group
--private if true, the repository is setup or configured as private (default true)
--read-write-key if true, the deploy key is configured with read/write permissions
--reconcile if true, the configured options are also reconciled if the repository already exists
--repository string GitLab repository name
--team stringArray GitLab teams to be given maintainer access
```
### Options inherited from parent commands
```
--author-email string author email for Git commits
--author-name string author name for Git commits (default "Flux")
--branch string Git branch (default "main")
--ca-file string path to TLS CA file used for validating self-signed certificates
--cluster-domain string internal cluster domain (default "cluster.local")
--commit-message-appendix string string to add to the commit messages, e.g. '[ci skip]'
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
--context string kubernetes context to use
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--kubeconfig string absolute path to the kubeconfig file
--log-level logLevel log level, available options are: (debug, info, error) (default info)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true)
--private-key-file string path to a private key file used for authenticating to the Git SSH server
--recurse-submodules when enabled, configures the GitRepository source to initialize and include Git submodules in the artifact it produces
--registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd")
--secret-name string name of the secret the sync credentials can be found in or stored to (default "flux-system")
--ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (default p384)
--ssh-hostname string SSH hostname, to be used when the SSH host differs from the HTTPS one
--ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa)
--ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048)
--timeout duration timeout for this operation (default 5m0s)
--token-auth when enabled, the personal access token will be used instead of SSH deploy key
--toleration-keys strings list of toleration keys used to schedule the components pods onto nodes with matching taints
--verbose print generated objects
-v, --version string toolkit version, when specified the manifests are downloaded from https://github.com/fluxcd/flux2/releases
--watch-all-namespaces watch for custom resources in all namespaces, if set to false it will only watch the namespace where the toolkit is installed (default true)
```
### SEE ALSO
* [flux bootstrap](../flux_bootstrap/) - Bootstrap toolkit components

@ -1,49 +0,0 @@
---
title: "flux check command"
---
## flux check
Check requirements and installation
### Synopsis
The check command will perform a series of checks to validate that
the local environment is configured correctly and if the installed components are healthy.
```
flux check [flags]
```
### Examples
```
# Run pre-installation checks
flux check --pre
# Run installation checks
flux check
```
### Options
```
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
-h, --help help for check
--pre only run pre-installation checks
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines

@ -1,35 +0,0 @@
---
title: "flux completion command"
---
## flux completion
Generates completion scripts for various shells
### Synopsis
The completion sub-command generates completion scripts for various shells
### Options
```
-h, --help help for completion
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux completion bash](../flux_completion_bash/) - Generates bash completion scripts
* [flux completion fish](../flux_completion_fish/) - Generates fish completion scripts
* [flux completion powershell](../flux_completion_powershell/) - Generates powershell completion scripts
* [flux completion zsh](../flux_completion_zsh/) - Generates zsh completion scripts

@ -1,44 +0,0 @@
---
title: "flux completion bash command"
---
## flux completion bash
Generates bash completion scripts
```
flux completion bash [flags]
```
### Examples
```
To load completion run
. <(flux completion bash)
To configure your bash shell to load completions for each session add to your bashrc
# ~/.bashrc or ~/.profile
command -v flux >/dev/null && . <(flux completion bash)
```
### Options
```
-h, --help help for bash
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux completion](../flux_completion/) - Generates completion scripts for various shells

@ -1,41 +0,0 @@
---
title: "flux completion fish command"
---
## flux completion fish
Generates fish completion scripts
```
flux completion fish [flags]
```
### Examples
```
To configure your fish shell to load completions for each session write this script to your completions dir:
flux completion fish > ~/.config/fish/completions/flux.fish
See http://fishshell.com/docs/current/index.html#completion-own for more details
```
### Options
```
-h, --help help for fish
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux completion](../flux_completion/) - Generates completion scripts for various shells

@ -1,51 +0,0 @@
---
title: "flux completion powershell command"
---
## flux completion powershell
Generates powershell completion scripts
```
flux completion powershell [flags]
```
### Examples
```
To load completion run
. <(flux completion powershell)
To configure your powershell shell to load completions for each session add to your powershell profile
Windows:
cd "$env:USERPROFILE\Documents\WindowsPowerShell\Modules"
flux completion >> flux-completion.ps1
Linux:
cd "${XDG_CONFIG_HOME:-"$HOME/.config/"}/powershell/modules"
flux completion >> flux-completions.ps1
```
### Options
```
-h, --help help for powershell
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux completion](../flux_completion/) - Generates completion scripts for various shells

@ -1,52 +0,0 @@
---
title: "flux completion zsh command"
---
## flux completion zsh
Generates zsh completion scripts
```
flux completion zsh [flags]
```
### Examples
```
To load completion run
. <(flux completion zsh) && compdef _flux flux
To configure your zsh shell to load completions for each session add to your zshrc
# ~/.zshrc or ~/.profile
command -v flux >/dev/null && . <(flux completion zsh) && compdef _flux flux
or write a cached file in one of the completion directories in your ${fpath}:
echo "${fpath// /\n}" | grep -i completion
flux completion zsh > _flux
mv _flux ~/.oh-my-zsh/completions # oh-my-zsh
mv _flux ~/.zprezto/modules/completion/external/src/ # zprezto
```
### Options
```
-h, --help help for zsh
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux completion](../flux_completion/) - Generates completion scripts for various shells

@ -1,43 +0,0 @@
---
title: "flux create command"
---
## flux create
Create or update sources and resources
### Synopsis
The create sub-commands generate sources and resources.
### Options
```
--export export in YAML format to stdout
-h, --help help for create
--interval duration source sync interval (default 1m0s)
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux create alert](../flux_create_alert/) - Create or update a Alert resource
* [flux create alert-provider](../flux_create_alert-provider/) - Create or update a Provider resource
* [flux create helmrelease](../flux_create_helmrelease/) - Create or update a HelmRelease resource
* [flux create image](../flux_create_image/) - Create or update resources dealing with image automation
* [flux create kustomization](../flux_create_kustomization/) - Create or update a Kustomization resource
* [flux create receiver](../flux_create_receiver/) - Create or update a Receiver resource
* [flux create secret](../flux_create_secret/) - Create or update Kubernetes secrets
* [flux create source](../flux_create_source/) - Create or update sources
* [flux create tenant](../flux_create_tenant/) - Create or update a tenant

@ -1,60 +0,0 @@
---
title: "flux create alert-provider command"
---
## flux create alert-provider
Create or update a Provider resource
### Synopsis
The create alert-provider command generates a Provider resource.
```
flux create alert-provider [name] [flags]
```
### Examples
```
# Create a Provider for a Slack channel
flux create alert-provider slack \
--type slack \
--channel general \
--address https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK \
--secret-ref webhook-url
# Create a Provider for a Github repository
flux create alert-provider github-podinfo \
--type github \
--address https://github.com/stefanprodan/podinfo \
--secret-ref github-token
```
### Options
```
--address string path to either the git repository, chat provider or webhook
--channel string channel to send messages to in the case of a chat provider
-h, --help help for alert-provider
--secret-ref string name of secret containing authentication token
--type string type of provider
--username string bot username used by the provider
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources

@ -1,52 +0,0 @@
---
title: "flux create alert command"
---
## flux create alert
Create or update a Alert resource
### Synopsis
The create alert command generates a Alert resource.
```
flux create alert [name] [flags]
```
### Examples
```
# Create an Alert for kustomization events
flux create alert \
--event-severity info \
--event-source Kustomization/flux-system \
--provider-ref slack \
flux-system
```
### Options
```
--event-severity string severity of events to send alerts for
--event-source stringArray sources that should generate alerts (<kind>/<name>)
-h, --help help for alert
--provider-ref string reference to provider
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources

@ -1,111 +0,0 @@
---
title: "flux create helmrelease command"
---
## flux create helmrelease
Create or update a HelmRelease resource
### Synopsis
The helmrelease create command generates a HelmRelease resource for a given HelmRepository source.
```
flux create helmrelease [name] [flags]
```
### Examples
```
# Create a HelmRelease with a chart from a HelmRepository source
flux create hr podinfo \
--interval=10m \
--source=HelmRepository/podinfo \
--chart=podinfo \
--chart-version=">4.0.0"
# Create a HelmRelease with a chart from a GitRepository source
flux create hr podinfo \
--interval=10m \
--source=GitRepository/podinfo \
--chart=./charts/podinfo
# Create a HelmRelease with a chart from a Bucket source
flux create hr podinfo \
--interval=10m \
--source=Bucket/podinfo \
--chart=./charts/podinfo
# Create a HelmRelease with values from local YAML files
flux create hr podinfo \
--source=HelmRepository/podinfo \
--chart=podinfo \
--values=./my-values1.yaml \
--values=./my-values2.yaml
# Create a HelmRelease with values from a Kubernetes secret
kubectl -n app create secret generic my-secret-values \
--from-file=values.yaml=/path/to/my-secret-values.yaml
flux -n app create hr podinfo \
--source=HelmRepository/podinfo \
--chart=podinfo \
--values-from=Secret/my-secret-values
# Create a HelmRelease with a custom release name
flux create hr podinfo \
--release-name=podinfo-dev
--source=HelmRepository/podinfo \
--chart=podinfo \
# Create a HelmRelease targeting another namespace than the resource
flux create hr podinfo \
--target-namespace=default \
--source=HelmRepository/podinfo \
--chart=podinfo
# Create a HelmRelease using a source from a different namespace
flux create hr podinfo \
--namespace=default \
--source=HelmRepository/podinfo.flux-system \
--chart=podinfo
# Create a HelmRelease definition on disk without applying it on the cluster
flux create hr podinfo \
--source=HelmRepository/podinfo \
--chart=podinfo \
--values=./values.yaml \
--export > podinfo-release.yaml
```
### Options
```
--chart string Helm chart name or path
--chart-version string Helm chart version, accepts a semver range (ignored for charts from GitRepository sources)
--crds crds upgrade CRDs policy, available options are: (Skip, Create, CreateReplace)
--depends-on stringArray HelmReleases that must be ready before this release can be installed, supported formats '<name>' and '<namespace>/<name>'
-h, --help help for helmrelease
--release-name string name used for the Helm release, defaults to a composition of '[<target-namespace>-]<HelmRelease-name>'
--service-account string the name of the service account to impersonate when reconciling this HelmRelease
--source helmChartSource source that contains the chart in the format '<kind>/<name>.<namespace>', where kind must be one of: (HelmRepository, GitRepository, Bucket)
--target-namespace string namespace to install this release, defaults to the HelmRelease namespace
--values stringArray local path to values.yaml files
--values-from helmReleaseValuesFrom Kubernetes object reference that contains the values.yaml data key in the format '<kind>/<name>', where kind must be one of: (Secret, ConfigMap)
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources

@ -1,39 +0,0 @@
---
title: "flux create image command"
---
## flux create image
Create or update resources dealing with image automation
### Synopsis
The create image sub-commands work with image automation objects; that is,
object controlling updates to git based on e.g., new container images
being available.
### Options
```
-h, --help help for image
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources
* [flux create image policy](../flux_create_image_policy/) - Create or update an ImagePolicy object
* [flux create image repository](../flux_create_image_repository/) - Create or update an ImageRepository object
* [flux create image update](../flux_create_image_update/) - Create or update an ImageUpdateAutomation object

@ -1,65 +0,0 @@
---
title: "flux create image policy command"
---
## flux create image policy
Create or update an ImagePolicy object
### Synopsis
The create image policy command generates an ImagePolicy resource.
An ImagePolicy object calculates a "latest image" given an image
repository and a policy, e.g., semver.
The image that sorts highest according to the policy is recorded in
the status of the object.
```
flux create image policy [name] [flags]
```
### Examples
```
# Create an ImagePolicy to select the latest stable release
flux create image policy podinfo \
--image-ref=podinfo \
--select-semver=">=1.0.0"
# Create an ImagePolicy to select the latest main branch build tagged as "${GIT_BRANCH}-${GIT_SHA:0:7}-$(date +%s)"
flux create image policy podinfo \
--image-ref=podinfo \
--select-numeric=asc \
--filter-regex='^main-[a-f0-9]+-(?P<ts>[0-9]+)' \
--filter-extract='$ts'
```
### Options
```
--filter-extract string replacement pattern (using capture groups from --filter-regex) to use for sorting
--filter-regex string regular expression pattern used to filter the image tags
-h, --help help for policy
--image-ref string the name of an image repository object
--select-alpha string use alphabetical sorting to select image; either "asc" meaning select the last, or "desc" meaning select the first
--select-numeric string use numeric sorting to select image; either "asc" meaning select the last, or "desc" meaning select the first
--select-semver string a semver range to apply to tags; e.g., '1.x'
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create image](../flux_create_image/) - Create or update resources dealing with image automation

@ -1,72 +0,0 @@
---
title: "flux create image repository command"
---
## flux create image repository
Create or update an ImageRepository object
### Synopsis
The create image repository command generates an ImageRepository resource.
An ImageRepository object specifies an image repository to scan.
```
flux create image repository [name] [flags]
```
### Examples
```
# Create an ImageRepository object to scan the alpine image repository:
flux create image repository alpine-repo --image alpine --interval 20m
# Create an image repository that uses an image pull secret (assumed to
# have been created already):
flux create image repository myapp-repo \
--secret-ref image-pull \
--image ghcr.io/example.com/myapp --interval 5m
# Create a TLS secret for a local image registry using a self-signed
# host certificate, and use it to scan an image. ca.pem is a file
# containing the CA certificate used to sign the host certificate.
flux create secret tls local-registry-cert --ca-file ./ca.pem
flux create image repository app-repo \
--cert-secret-ref local-registry-cert \
--image local-registry:5000/app --interval 5m
# Create a TLS secret with a client certificate and key, and use it
# to scan a private image registry.
flux create secret tls client-cert \
--cert-file client.crt --key-file client.key
flux create image repository app-repo \
--cert-secret-ref client-cert \
--image registry.example.com/private/app --interval 5m
```
### Options
```
--cert-ref string the name of a secret to use for TLS certificates
-h, --help help for repository
--image string the image repository to scan; e.g., library/alpine
--scan-timeout duration a timeout for scanning; this defaults to the interval if not set
--secret-ref string the name of a docker-registry secret to use for credentials
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create image](../flux_create_image/) - Create or update resources dealing with image automation

@ -1,70 +0,0 @@
---
title: "flux create image update command"
---
## flux create image update
Create or update an ImageUpdateAutomation object
### Synopsis
The create image update command generates an ImageUpdateAutomation resource.
An ImageUpdateAutomation object specifies an automated update to images
mentioned in YAMLs in a git repository.
```
flux create image update [name] [flags]
```
### Examples
```
# Configure image updates for the main repository created by flux bootstrap
flux create image update flux-system \
--git-repo-ref=flux-system \
--git-repo-path="./clusters/my-cluster" \
--checkout-branch=main \
--author-name=flux \
--author-email=flux@example.com \
--commit-template="{{range .Updated.Images}}{{println .}}{{end}}"
# Configure image updates to push changes to a different branch, if the branch doesn't exists it will be created
flux create image update flux-system \
--git-repo-ref=flux-system \
--git-repo-path="./clusters/my-cluster" \
--checkout-branch=main \
--push-branch=image-updates \
--author-name=flux \
--author-email=flux@example.com \
--commit-template="{{range .Updated.Images}}{{println .}}{{end}}"
```
### Options
```
--author-email string the email to use for commit author
--author-name string the name to use for commit author
--checkout-branch string the branch to checkout
--commit-template string a template for commit messages
--git-repo-path string path to the directory containing the manifests to be updated, defaults to the repository root
--git-repo-ref string the name of a GitRepository resource with details of the upstream Git repository
-h, --help help for update
--push-branch string the branch to push commits to, defaults to the checkout branch if not specified
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create image](../flux_create_image/) - Create or update resources dealing with image automation

@ -1,88 +0,0 @@
---
title: "flux create kustomization command"
---
## flux create kustomization
Create or update a Kustomization resource
### Synopsis
The kustomization source create command generates a Kustomize resource for a given source.
```
flux create kustomization [name] [flags]
```
### Examples
```
# Create a Kustomization resource from a source at a given path
flux create kustomization contour \
--source=GitRepository/contour \
--path="./examples/contour/" \
--prune=true \
--interval=10m \
--validation=client \
--health-check="Deployment/contour.projectcontour" \
--health-check="DaemonSet/envoy.projectcontour" \
--health-check-timeout=3m
# Create a Kustomization resource that depends on the previous one
flux create kustomization webapp \
--depends-on=contour \
--source=GitRepository/webapp \
--path="./deploy/overlays/dev" \
--prune=true \
--interval=5m \
--validation=client
# Create a Kustomization using a source from a different namespace
flux create kustomization podinfo \
--namespace=default \
--source=GitRepository/podinfo.flux-system \
--path="./deploy/overlays/dev" \
--prune=true \
--interval=5m \
--validation=client
# Create a Kustomization resource that references a Bucket
flux create kustomization secrets \
--source=Bucket/secrets \
--prune=true \
--interval=5m
```
### Options
```
--decryption-provider decryptionProvider decryption provider, available options are: (sops)
--decryption-secret string set the Kubernetes secret name that contains the OpenPGP private keys used for sops decryption
--depends-on stringArray Kustomization that must be ready before this Kustomization can be applied, supported formats '<name>' and '<namespace>/<name>'
--health-check stringArray workload to be included in the health assessment, in the format '<kind>/<name>.<namespace>'
--health-check-timeout duration timeout of health checking operations (default 2m0s)
-h, --help help for kustomization
--path safeRelativePath path to the directory containing a kustomization.yaml file (default ./)
--prune enable garbage collection
--service-account string the name of the service account to impersonate when reconciling this Kustomization
--source kustomizationSource source that contains the Kubernetes manifests in the format '[<kind>/]<name>.<namespace>', where kind must be one of: (GitRepository, Bucket), if kind is not specified it defaults to GitRepository
--target-namespace string overrides the namespace of all Kustomization objects reconciled by this Kustomization
--validation string validate the manifests before applying them on the cluster, can be 'client' or 'server'
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources

@ -1,55 +0,0 @@
---
title: "flux create receiver command"
---
## flux create receiver
Create or update a Receiver resource
### Synopsis
The create receiver command generates a Receiver resource.
```
flux create receiver [name] [flags]
```
### Examples
```
# Create a Receiver
flux create receiver github-receiver \
--type github \
--event ping \
--event push \
--secret-ref webhook-token \
--resource GitRepository/webapp \
--resource HelmRepository/webapp
```
### Options
```
--event stringArray
-h, --help help for receiver
--resource stringArray
--secret-ref string
--type string
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources

@ -1,37 +0,0 @@
---
title: "flux create secret command"
---
## flux create secret
Create or update Kubernetes secrets
### Synopsis
The create source sub-commands generate Kubernetes secrets specific to Flux.
### Options
```
-h, --help help for secret
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources
* [flux create secret git](../flux_create_secret_git/) - Create or update a Kubernetes secret for Git authentication
* [flux create secret helm](../flux_create_secret_helm/) - Create or update a Kubernetes secret for Helm repository authentication
* [flux create secret tls](../flux_create_secret_tls/) - Create or update a Kubernetes secret with TLS certificates

@ -1,94 +0,0 @@
---
title: "flux create secret git command"
---
## flux create secret git
Create or update a Kubernetes secret for Git authentication
### Synopsis
The create secret git command generates a Kubernetes secret with Git credentials.
For Git over SSH, the host and SSH keys are automatically generated and stored in the secret.
For Git over HTTP/S, the provided basic authentication credentials are stored in the secret.
```
flux create secret git [name] [flags]
```
### Examples
```
# Create a Git SSH authentication secret using an ECDSA P-521 curve public key
flux create secret git podinfo-auth \
--url=ssh://git@github.com/stefanprodan/podinfo \
--ssh-key-algorithm=ecdsa \
--ssh-ecdsa-curve=p521
# Create a Git SSH authentication secret with a passwordless private key from file
# The public SSH host key will still be gathered from the host
flux create secret git podinfo-auth \
--url=ssh://git@github.com/stefanprodan/podinfo \
--private-key-file=./private.key
# Create a Git SSH authentication secret with a passworded private key from file
# The public SSH host key will still be gathered from the host
flux create secret git podinfo-auth \
--url=ssh://git@github.com/stefanprodan/podinfo \
--private-key-file=./private.key \
--password=<password>
# Create a secret for a Git repository using basic authentication
flux create secret git podinfo-auth \
--url=https://github.com/stefanprodan/podinfo \
--username=username \
--password=password
# Create a Git SSH secret on disk and print the deploy key
flux create secret git podinfo-auth \
--url=ssh://git@github.com/stefanprodan/podinfo \
--export > podinfo-auth.yaml
yq read podinfo-auth.yaml 'data."identity.pub"' | base64 --decode
# Create a Git SSH secret on disk and encrypt it with Mozilla SOPS
flux create secret git podinfo-auth \
--namespace=apps \
--url=ssh://git@github.com/stefanprodan/podinfo \
--export > podinfo-auth.yaml
sops --encrypt --encrypted-regex '^(data|stringData)$' \
--in-place podinfo-auth.yaml
```
### Options
```
--ca-file string path to TLS CA file used for validating self-signed certificates
-h, --help help for git
-p, --password string basic authentication password
--private-key-file string path to a passwordless private key file used for authenticating to the Git SSH server
--ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (default p384)
--ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa)
--ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048)
--url string git address, e.g. ssh://git@host/org/repository
-u, --username string basic authentication username
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create secret](../flux_create_secret/) - Create or update Kubernetes secrets

@ -1,65 +0,0 @@
---
title: "flux create secret helm command"
---
## flux create secret helm
Create or update a Kubernetes secret for Helm repository authentication
### Synopsis
The create secret helm command generates a Kubernetes secret with basic authentication credentials.
```
flux create secret helm [name] [flags]
```
### Examples
```
# Create a Helm authentication secret on disk and encrypt it with Mozilla SOPS
flux create secret helm repo-auth \
--namespace=my-namespace \
--username=my-username \
--password=my-password \
--export > repo-auth.yaml
sops --encrypt --encrypted-regex '^(data|stringData)$' \
--in-place repo-auth.yaml
# Create a Helm authentication secret using a custom TLS cert
flux create secret helm repo-auth \
--username=username \
--password=password \
--cert-file=./cert.crt \
--key-file=./key.crt \
--ca-file=./ca.crt
```
### Options
```
--ca-file string TLS authentication CA file path
--cert-file string TLS authentication cert file path
-h, --help help for helm
--key-file string TLS authentication key file path
-p, --password string basic authentication password
-u, --username string basic authentication username
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create secret](../flux_create_secret/) - Create or update Kubernetes secrets

@ -1,56 +0,0 @@
---
title: "flux create secret tls command"
---
## flux create secret tls
Create or update a Kubernetes secret with TLS certificates
### Synopsis
The create secret tls command generates a Kubernetes secret with certificates for use with TLS.
```
flux create secret tls [name] [flags]
```
### Examples
```
# Create a TLS secret on disk and encrypt it with Mozilla SOPS.
# Files are expected to be PEM-encoded.
flux create secret tls certs \
--namespace=my-namespace \
--cert-file=./client.crt \
--key-file=./client.key \
--export > certs.yaml
sops --encrypt --encrypted-regex '^(data|stringData)$' \
--in-place certs.yaml
```
### Options
```
--ca-file string TLS authentication CA file path
--cert-file string TLS authentication cert file path
-h, --help help for tls
--key-file string TLS authentication key file path
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create secret](../flux_create_secret/) - Create or update Kubernetes secrets

@ -1,37 +0,0 @@
---
title: "flux create source command"
---
## flux create source
Create or update sources
### Synopsis
The create source sub-commands generate sources.
### Options
```
-h, --help help for source
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources
* [flux create source bucket](../flux_create_source_bucket/) - Create or update a Bucket source
* [flux create source git](../flux_create_source_git/) - Create or update a GitRepository source
* [flux create source helm](../flux_create_source_helm/) - Create or update a HelmRepository source

@ -1,68 +0,0 @@
---
title: "flux create source bucket command"
---
## flux create source bucket
Create or update a Bucket source
### Synopsis
The create source bucket command generates a Bucket resource and waits for it to be downloaded.
For Buckets with static authentication, the credentials are stored in a Kubernetes secret.
```
flux create source bucket [name] [flags]
```
### Examples
```
# Create a source for a Bucket using static authentication
flux create source bucket podinfo \
--bucket-name=podinfo \
--endpoint=minio.minio.svc.cluster.local:9000 \
--insecure=true \
--access-key=myaccesskey \
--secret-key=mysecretkey \
--interval=10m
# Create a source for an Amazon S3 Bucket using IAM authentication
flux create source bucket podinfo \
--bucket-name=podinfo \
--provider=aws \
--endpoint=s3.amazonaws.com \
--region=us-east-1 \
--interval=10m
```
### Options
```
--access-key string the bucket access key
--bucket-name string the bucket name
--endpoint string the bucket endpoint address
-h, --help help for bucket
--insecure for when connecting to a non-TLS S3 HTTP endpoint
--provider sourceBucketProvider the S3 compatible storage provider name, available options are: (generic, aws) (default generic)
--region string the bucket region
--secret-key string the bucket secret key
--secret-ref string the name of an existing secret containing credentials
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create source](../flux_create_source/) - Create or update sources

@ -1,109 +0,0 @@
---
title: "flux create source git command"
---
## flux create source git
Create or update a GitRepository source
### Synopsis
The create source git command generates a GitRepository resource and waits for it to sync.
For Git over SSH, host and SSH keys are automatically generated and stored in a Kubernetes secret.
For private Git repositories, the basic authentication credentials are stored in a Kubernetes secret.
```
flux create source git [name] [flags]
```
### Examples
```
# Create a source from a public Git repository master branch
flux create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \
--branch=master
# Create a source for a Git repository pinned to specific git tag
flux create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \
--tag="3.2.3"
# Create a source from a public Git repository tag that matches a semver range
flux create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \
--tag-semver=">=3.2.0 <3.3.0"
# Create a source for a Git repository using SSH authentication
flux create source git podinfo \
--url=ssh://git@github.com/stefanprodan/podinfo \
--branch=master
# Create a source for a Git repository using SSH authentication and an
# ECDSA P-521 curve public key
flux create source git podinfo \
--url=ssh://git@github.com/stefanprodan/podinfo \
--branch=master \
--ssh-key-algorithm=ecdsa \
--ssh-ecdsa-curve=p521
# Create a source for a Git repository using SSH authentication and a
# passwordless private key from file
# The public SSH host key will still be gathered from the host
flux create source git podinfo \
--url=ssh://git@github.com/stefanprodan/podinfo \
--branch=master \
--private-key-file=./private.key
# Create a source for a Git repository using SSH authentication and a
# private key with a password from file
# The public SSH host key will still be gathered from the host
flux create source git podinfo \
--url=ssh://git@github.com/stefanprodan/podinfo \
--branch=master \
--private-key-file=./private.key \
--password=<password>
# Create a source for a Git repository using basic authentication
flux create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \
--username=username \
--password=password
```
### Options
```
--branch string git branch (default "master")
--ca-file string path to TLS CA file used for validating self-signed certificates
--git-implementation gitImplementation the Git implementation to use, available options are: (go-git, libgit2)
-h, --help help for git
-p, --password string basic authentication password
--private-key-file string path to a passwordless private key file used for authenticating to the Git SSH server
--recurse-submodules when enabled, configures the GitRepository source to initialize and include Git submodules in the artifact it produces
--secret-ref string the name of an existing secret containing SSH or basic credentials
--ssh-ecdsa-curve ecdsaCurve SSH ECDSA public key curve (p256, p384, p521) (default p384)
--ssh-key-algorithm publicKeyAlgorithm SSH public key algorithm (rsa, ecdsa, ed25519) (default rsa)
--ssh-rsa-bits rsaKeyBits SSH RSA public key bit size (multiplies of 8) (default 2048)
--tag string git tag
--tag-semver string git tag semver range
--url string git address, e.g. ssh://git@host/org/repository
-u, --username string basic authentication username
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create source](../flux_create_source/) - Create or update sources

@ -1,68 +0,0 @@
---
title: "flux create source helm command"
---
## flux create source helm
Create or update a HelmRepository source
### Synopsis
The create source helm command generates a HelmRepository resource and waits for it to fetch the index.
For private Helm repositories, the basic authentication credentials are stored in a Kubernetes secret.
```
flux create source helm [name] [flags]
```
### Examples
```
# Create a source for a public Helm repository
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--interval=10m
# Create a source for a Helm repository using basic authentication
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--username=username \
--password=password
# Create a source for a Helm repository using TLS authentication
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--cert-file=./cert.crt \
--key-file=./key.crt \
--ca-file=./ca.crt
```
### Options
```
--ca-file string TLS authentication CA file path
--cert-file string TLS authentication cert file path
-h, --help help for helm
--key-file string TLS authentication key file path
-p, --password string basic authentication password
--secret-ref string the name of an existing secret containing TLS or basic auth credentials
--url string Helm repository address
-u, --username string basic authentication username
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create source](../flux_create_source/) - Create or update sources

@ -1,56 +0,0 @@
---
title: "flux create tenant command"
---
## flux create tenant
Create or update a tenant
### Synopsis
The create tenant command generates namespaces, service accounts and role bindings to limit the
reconcilers scope to the tenant namespaces.
```
flux create tenant [flags]
```
### Examples
```
# Create a tenant with access to a namespace
flux create tenant dev-team \
--with-namespace=frontend \
--label=environment=dev
# Generate tenant namespaces and role bindings in YAML format
flux create tenant dev-team \
--with-namespace=frontend \
--with-namespace=backend \
--export > dev-team.yaml
```
### Options
```
--cluster-role string cluster role of the tenant role binding (default "cluster-admin")
-h, --help help for tenant
--with-namespace strings namespace belonging to this tenant
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--export export in YAML format to stdout
--interval duration source sync interval (default 1m0s)
--kubeconfig string absolute path to the kubeconfig file
--label strings set labels on the resource (can specify multiple labels with commas: label1=value1,label2=value2)
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux create](../flux_create/) - Create or update sources and resources

@ -1,39 +0,0 @@
---
title: "flux delete command"
---
## flux delete
Delete sources and resources
### Synopsis
The delete sub-commands delete sources and resources.
### Options
```
-h, --help help for delete
-s, --silent delete resource without asking for confirmation
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux delete alert](../flux_delete_alert/) - Delete a Alert resource
* [flux delete alert-provider](../flux_delete_alert-provider/) - Delete a Provider resource
* [flux delete helmrelease](../flux_delete_helmrelease/) - Delete a HelmRelease resource
* [flux delete image](../flux_delete_image/) - Delete image automation objects
* [flux delete kustomization](../flux_delete_kustomization/) - Delete a Kustomization resource
* [flux delete receiver](../flux_delete_receiver/) - Delete a Receiver resource
* [flux delete source](../flux_delete_source/) - Delete sources

@ -1,43 +0,0 @@
---
title: "flux delete alert-provider command"
---
## flux delete alert-provider
Delete a Provider resource
### Synopsis
The delete alert-provider command removes the given Provider from the cluster.
```
flux delete alert-provider [name] [flags]
```
### Examples
```
# Delete a Provider and the Kubernetes resources created by it
flux delete alert-provider slack
```
### Options
```
-h, --help help for alert-provider
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete](../flux_delete/) - Delete sources and resources

@ -1,43 +0,0 @@
---
title: "flux delete alert command"
---
## flux delete alert
Delete a Alert resource
### Synopsis
The delete alert command removes the given Alert from the cluster.
```
flux delete alert [name] [flags]
```
### Examples
```
# Delete an Alert and the Kubernetes resources created by it
flux delete alert main
```
### Options
```
-h, --help help for alert
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete](../flux_delete/) - Delete sources and resources

@ -1,43 +0,0 @@
---
title: "flux delete helmrelease command"
---
## flux delete helmrelease
Delete a HelmRelease resource
### Synopsis
The delete helmrelease command removes the given HelmRelease from the cluster.
```
flux delete helmrelease [name] [flags]
```
### Examples
```
# Delete a Helm release and the Kubernetes resources created by it
flux delete hr podinfo
```
### Options
```
-h, --help help for helmrelease
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete](../flux_delete/) - Delete sources and resources

@ -1,35 +0,0 @@
---
title: "flux delete image command"
---
## flux delete image
Delete image automation objects
### Synopsis
The delete image sub-commands delete image automation objects.
### Options
```
-h, --help help for image
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete](../flux_delete/) - Delete sources and resources
* [flux delete image policy](../flux_delete_image_policy/) - Delete an ImagePolicy object
* [flux delete image repository](../flux_delete_image_repository/) - Delete an ImageRepository object
* [flux delete image update](../flux_delete_image_update/) - Delete an ImageUpdateAutomation object

@ -1,43 +0,0 @@
---
title: "flux delete image policy command"
---
## flux delete image policy
Delete an ImagePolicy object
### Synopsis
The delete image policy command deletes the given ImagePolicy from the cluster.
```
flux delete image policy [name] [flags]
```
### Examples
```
# Delete an image policy
flux delete image policy alpine3.x
```
### Options
```
-h, --help help for policy
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete image](../flux_delete_image/) - Delete image automation objects

@ -1,43 +0,0 @@
---
title: "flux delete image repository command"
---
## flux delete image repository
Delete an ImageRepository object
### Synopsis
The delete image repository command deletes the given ImageRepository from the cluster.
```
flux delete image repository [name] [flags]
```
### Examples
```
# Delete an image repository
flux delete image repository alpine
```
### Options
```
-h, --help help for repository
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete image](../flux_delete_image/) - Delete image automation objects

@ -1,43 +0,0 @@
---
title: "flux delete image update command"
---
## flux delete image update
Delete an ImageUpdateAutomation object
### Synopsis
The delete image update command deletes the given ImageUpdateAutomation from the cluster.
```
flux delete image update [name] [flags]
```
### Examples
```
# Delete an image update automation
flux delete image update latest-images
```
### Options
```
-h, --help help for update
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete image](../flux_delete_image/) - Delete image automation objects

@ -1,43 +0,0 @@
---
title: "flux delete kustomization command"
---
## flux delete kustomization
Delete a Kustomization resource
### Synopsis
The delete kustomization command deletes the given Kustomization from the cluster.
```
flux delete kustomization [name] [flags]
```
### Examples
```
# Delete a kustomization and the Kubernetes resources created by it
flux delete kustomization podinfo
```
### Options
```
-h, --help help for kustomization
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete](../flux_delete/) - Delete sources and resources

@ -1,43 +0,0 @@
---
title: "flux delete receiver command"
---
## flux delete receiver
Delete a Receiver resource
### Synopsis
The delete receiver command removes the given Receiver from the cluster.
```
flux delete receiver [name] [flags]
```
### Examples
```
# Delete an Receiver and the Kubernetes resources created by it
flux delete receiver main
```
### Options
```
-h, --help help for receiver
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete](../flux_delete/) - Delete sources and resources

@ -1,35 +0,0 @@
---
title: "flux delete source command"
---
## flux delete source
Delete sources
### Synopsis
The delete source sub-commands delete sources.
### Options
```
-h, --help help for source
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete](../flux_delete/) - Delete sources and resources
* [flux delete source bucket](../flux_delete_source_bucket/) - Delete a Bucket source
* [flux delete source git](../flux_delete_source_git/) - Delete a GitRepository source
* [flux delete source helm](../flux_delete_source_helm/) - Delete a HelmRepository source

@ -1,43 +0,0 @@
---
title: "flux delete source bucket command"
---
## flux delete source bucket
Delete a Bucket source
### Synopsis
The delete source bucket command deletes the given Bucket from the cluster.
```
flux delete source bucket [name] [flags]
```
### Examples
```
# Delete a Bucket source
flux delete source bucket podinfo
```
### Options
```
-h, --help help for bucket
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete source](../flux_delete_source/) - Delete sources

@ -1,43 +0,0 @@
---
title: "flux delete source git command"
---
## flux delete source git
Delete a GitRepository source
### Synopsis
The delete source git command deletes the given GitRepository from the cluster.
```
flux delete source git [name] [flags]
```
### Examples
```
# Delete a Git repository
flux delete source git podinfo
```
### Options
```
-h, --help help for git
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete source](../flux_delete_source/) - Delete sources

@ -1,43 +0,0 @@
---
title: "flux delete source helm command"
---
## flux delete source helm
Delete a HelmRepository source
### Synopsis
The delete source helm command deletes the given HelmRepository from the cluster.
```
flux delete source helm [name] [flags]
```
### Examples
```
# Delete a Helm repository
flux delete source helm podinfo
```
### Options
```
-h, --help help for helm
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
-s, --silent delete resource without asking for confirmation
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux delete source](../flux_delete_source/) - Delete sources

@ -1,39 +0,0 @@
---
title: "flux export command"
---
## flux export
Export resources in YAML format
### Synopsis
The export sub-commands export resources in YAML format.
### Options
```
--all select all resources
-h, --help help for export
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux export alert](../flux_export_alert/) - Export Alert resources in YAML format
* [flux export alert-provider](../flux_export_alert-provider/) - Export Provider resources in YAML format
* [flux export helmrelease](../flux_export_helmrelease/) - Export HelmRelease resources in YAML format
* [flux export image](../flux_export_image/) - Export image automation objects
* [flux export kustomization](../flux_export_kustomization/) - Export Kustomization resources in YAML format
* [flux export receiver](../flux_export_receiver/) - Export Receiver resources in YAML format
* [flux export source](../flux_export_source/) - Export sources

@ -1,46 +0,0 @@
---
title: "flux export alert-provider command"
---
## flux export alert-provider
Export Provider resources in YAML format
### Synopsis
The export alert-provider command exports one or all Provider resources in YAML format.
```
flux export alert-provider [name] [flags]
```
### Examples
```
# Export all Provider resources
flux export alert-provider --all > alert-providers.yaml
# Export a Provider
flux export alert-provider slack > slack.yaml
```
### Options
```
-h, --help help for alert-provider
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export](../flux_export/) - Export resources in YAML format

@ -1,46 +0,0 @@
---
title: "flux export alert command"
---
## flux export alert
Export Alert resources in YAML format
### Synopsis
The export alert command exports one or all Alert resources in YAML format.
```
flux export alert [name] [flags]
```
### Examples
```
# Export all Alert resources
flux export alert --all > alerts.yaml
# Export a Alert
flux export alert main > main.yaml
```
### Options
```
-h, --help help for alert
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export](../flux_export/) - Export resources in YAML format

@ -1,46 +0,0 @@
---
title: "flux export helmrelease command"
---
## flux export helmrelease
Export HelmRelease resources in YAML format
### Synopsis
The export helmrelease command exports one or all HelmRelease resources in YAML format.
```
flux export helmrelease [name] [flags]
```
### Examples
```
# Export all HelmRelease resources
flux export helmrelease --all > kustomizations.yaml
# Export a HelmRelease
flux export hr my-app > app-release.yaml
```
### Options
```
-h, --help help for helmrelease
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export](../flux_export/) - Export resources in YAML format

@ -1,35 +0,0 @@
---
title: "flux export image command"
---
## flux export image
Export image automation objects
### Synopsis
The export image sub-commands export image automation objects in YAML format.
### Options
```
-h, --help help for image
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export](../flux_export/) - Export resources in YAML format
* [flux export image policy](../flux_export_image_policy/) - Export ImagePolicy resources in YAML format
* [flux export image repository](../flux_export_image_repository/) - Export ImageRepository resources in YAML format
* [flux export image update](../flux_export_image_update/) - Export ImageUpdateAutomation resources in YAML format

@ -1,46 +0,0 @@
---
title: "flux export image policy command"
---
## flux export image policy
Export ImagePolicy resources in YAML format
### Synopsis
The export image policy command exports one or all ImagePolicy resources in YAML format.
```
flux export image policy [name] [flags]
```
### Examples
```
# Export all ImagePolicy resources
flux export image policy --all > image-policies.yaml
# Export a specific policy
flux export image policy alpine1x > alpine1x.yaml
```
### Options
```
-h, --help help for policy
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export image](../flux_export_image/) - Export image automation objects

@ -1,46 +0,0 @@
---
title: "flux export image repository command"
---
## flux export image repository
Export ImageRepository resources in YAML format
### Synopsis
The export image repository command exports one or all ImageRepository resources in YAML format.
```
flux export image repository [name] [flags]
```
### Examples
```
# Export all ImageRepository resources
flux export image repository --all > image-repositories.yaml
# Export a specific ImageRepository resource
flux export image repository alpine > alpine.yaml
```
### Options
```
-h, --help help for repository
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export image](../flux_export_image/) - Export image automation objects

@ -1,46 +0,0 @@
---
title: "flux export image update command"
---
## flux export image update
Export ImageUpdateAutomation resources in YAML format
### Synopsis
The export image update command exports one or all ImageUpdateAutomation resources in YAML format.
```
flux export image update [name] [flags]
```
### Examples
```
# Export all ImageUpdateAutomation resources
flux export image update --all > updates.yaml
# Export a specific automation
flux export image update latest-images > latest.yaml
```
### Options
```
-h, --help help for update
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export image](../flux_export_image/) - Export image automation objects

@ -1,46 +0,0 @@
---
title: "flux export kustomization command"
---
## flux export kustomization
Export Kustomization resources in YAML format
### Synopsis
The export kustomization command exports one or all Kustomization resources in YAML format.
```
flux export kustomization [name] [flags]
```
### Examples
```
# Export all Kustomization resources
flux export kustomization --all > kustomizations.yaml
# Export a Kustomization
flux export kustomization my-app > kustomization.yaml
```
### Options
```
-h, --help help for kustomization
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export](../flux_export/) - Export resources in YAML format

@ -1,46 +0,0 @@
---
title: "flux export receiver command"
---
## flux export receiver
Export Receiver resources in YAML format
### Synopsis
The export receiver command exports one or all Receiver resources in YAML format.
```
flux export receiver [name] [flags]
```
### Examples
```
# Export all Receiver resources
flux export receiver --all > receivers.yaml
# Export a Receiver
flux export receiver main > main.yaml
```
### Options
```
-h, --help help for receiver
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export](../flux_export/) - Export resources in YAML format

@ -1,36 +0,0 @@
---
title: "flux export source command"
---
## flux export source
Export sources
### Synopsis
The export source sub-commands export sources in YAML format.
### Options
```
-h, --help help for source
--with-credentials include credential secrets
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux export](../flux_export/) - Export resources in YAML format
* [flux export source bucket](../flux_export_source_bucket/) - Export Bucket sources in YAML format
* [flux export source git](../flux_export_source_git/) - Export GitRepository sources in YAML format
* [flux export source helm](../flux_export_source_helm/) - Export HelmRepository sources in YAML format

@ -1,47 +0,0 @@
---
title: "flux export source bucket command"
---
## flux export source bucket
Export Bucket sources in YAML format
### Synopsis
The export source git command exports one or all Bucket sources in YAML format.
```
flux export source bucket [name] [flags]
```
### Examples
```
# Export all Bucket sources
flux export source bucket --all > sources.yaml
# Export a Bucket source including the static credentials
flux export source bucket my-bucket --with-credentials > source.yaml
```
### Options
```
-h, --help help for bucket
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
--with-credentials include credential secrets
```
### SEE ALSO
* [flux export source](../flux_export_source/) - Export sources

@ -1,47 +0,0 @@
---
title: "flux export source git command"
---
## flux export source git
Export GitRepository sources in YAML format
### Synopsis
The export source git command exports one or all GitRepository sources in YAML format.
```
flux export source git [name] [flags]
```
### Examples
```
# Export all GitRepository sources
flux export source git --all > sources.yaml
# Export a GitRepository source including the SSH key pair or basic auth credentials
flux export source git my-private-repo --with-credentials > source.yaml
```
### Options
```
-h, --help help for git
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
--with-credentials include credential secrets
```
### SEE ALSO
* [flux export source](../flux_export_source/) - Export sources

@ -1,47 +0,0 @@
---
title: "flux export source helm command"
---
## flux export source helm
Export HelmRepository sources in YAML format
### Synopsis
The export source git command exports one or all HelmRepository sources in YAML format.
```
flux export source helm [name] [flags]
```
### Examples
```
# Export all HelmRepository sources
flux export source helm --all > sources.yaml
# Export a HelmRepository source including the basic auth credentials
flux export source helm my-private-repo --with-credentials > source.yaml
```
### Options
```
-h, --help help for helm
```
### Options inherited from parent commands
```
--all select all resources
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
--with-credentials include credential secrets
```
### SEE ALSO
* [flux export source](../flux_export_source/) - Export sources

@ -1,40 +0,0 @@
---
title: "flux get command"
---
## flux get
Get the resources and their status
### Synopsis
The get sub-commands print the statuses of Flux resources.
### Options
```
-A, --all-namespaces list the requested object(s) across all namespaces
-h, --help help for get
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux get alert-providers](../flux_get_alert-providers/) - Get Provider statuses
* [flux get alerts](../flux_get_alerts/) - Get Alert statuses
* [flux get all](../flux_get_all/) - Get all resources and statuses
* [flux get helmreleases](../flux_get_helmreleases/) - Get HelmRelease statuses
* [flux get images](../flux_get_images/) - Get image automation object status
* [flux get kustomizations](../flux_get_kustomizations/) - Get Kustomization statuses
* [flux get receivers](../flux_get_receivers/) - Get Receiver statuses
* [flux get sources](../flux_get_sources/) - Get source statuses

@ -1,43 +0,0 @@
---
title: "flux get alert-providers command"
---
## flux get alert-providers
Get Provider statuses
### Synopsis
The get alert-provider command prints the statuses of the resources.
```
flux get alert-providers [flags]
```
### Examples
```
# List all Providers and their status
flux get alert-providers
```
### Options
```
-h, --help help for alert-providers
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status

@ -1,43 +0,0 @@
---
title: "flux get alerts command"
---
## flux get alerts
Get Alert statuses
### Synopsis
The get alert command prints the statuses of the resources.
```
flux get alerts [flags]
```
### Examples
```
# List all Alerts and their status
flux get alerts
```
### Options
```
-h, --help help for alerts
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status

@ -1,46 +0,0 @@
---
title: "flux get all command"
---
## flux get all
Get all resources and statuses
### Synopsis
The get all command print the statuses of all resources.
```
flux get all [flags]
```
### Examples
```
# List all resources in a namespace
flux get all --namespace=flux-system
# List all resources in all namespaces
flux get all --all-namespaces
```
### Options
```
-h, --help help for all
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status

@ -1,43 +0,0 @@
---
title: "flux get helmreleases command"
---
## flux get helmreleases
Get HelmRelease statuses
### Synopsis
The get helmreleases command prints the statuses of the resources.
```
flux get helmreleases [flags]
```
### Examples
```
# List all Helm releases and their status
flux get helmreleases
```
### Options
```
-h, --help help for helmreleases
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status

@ -1,36 +0,0 @@
---
title: "flux get images command"
---
## flux get images
Get image automation object status
### Synopsis
The get image sub-commands print the status of image automation objects.
### Options
```
-h, --help help for images
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status
* [flux get images all](../flux_get_images_all/) - Get all image statuses
* [flux get images policy](../flux_get_images_policy/) - Get ImagePolicy status
* [flux get images repository](../flux_get_images_repository/) - Get ImageRepository status
* [flux get images update](../flux_get_images_update/) - Get ImageUpdateAutomation status

@ -1,46 +0,0 @@
---
title: "flux get images all command"
---
## flux get images all
Get all image statuses
### Synopsis
The get image sub-commands print the statuses of all image objects.
```
flux get images all [flags]
```
### Examples
```
# List all image objects in a namespace
flux get images all --namespace=flux-system
# List all image objects in all namespaces
flux get images all --all-namespaces
```
### Options
```
-h, --help help for all
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get images](../flux_get_images/) - Get image automation object status

@ -1,46 +0,0 @@
---
title: "flux get images policy command"
---
## flux get images policy
Get ImagePolicy status
### Synopsis
The get image policy command prints the status of ImagePolicy objects.
```
flux get images policy [flags]
```
### Examples
```
# List all image policies and their status
flux get image policy
# List image policies from all namespaces
flux get image policy --all-namespaces
```
### Options
```
-h, --help help for policy
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get images](../flux_get_images/) - Get image automation object status

@ -1,46 +0,0 @@
---
title: "flux get images repository command"
---
## flux get images repository
Get ImageRepository status
### Synopsis
The get image repository command prints the status of ImageRepository objects.
```
flux get images repository [flags]
```
### Examples
```
# List all image repositories and their status
flux get image repository
# List image repositories from all namespaces
flux get image repository --all-namespaces
```
### Options
```
-h, --help help for repository
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get images](../flux_get_images/) - Get image automation object status

@ -1,46 +0,0 @@
---
title: "flux get images update command"
---
## flux get images update
Get ImageUpdateAutomation status
### Synopsis
The get image update command prints the status of ImageUpdateAutomation objects.
```
flux get images update [flags]
```
### Examples
```
# List all image update automation object and their status
flux get image update
# List image update automations from all namespaces
flux get image update --all-namespaces
```
### Options
```
-h, --help help for update
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get images](../flux_get_images/) - Get image automation object status

@ -1,43 +0,0 @@
---
title: "flux get kustomizations command"
---
## flux get kustomizations
Get Kustomization statuses
### Synopsis
The get kustomizations command prints the statuses of the resources.
```
flux get kustomizations [flags]
```
### Examples
```
# List all kustomizations and their status
flux get kustomizations
```
### Options
```
-h, --help help for kustomizations
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status

@ -1,43 +0,0 @@
---
title: "flux get receivers command"
---
## flux get receivers
Get Receiver statuses
### Synopsis
The get receiver command prints the statuses of the resources.
```
flux get receivers [flags]
```
### Examples
```
# List all Receiver and their status
flux get receivers
```
### Options
```
-h, --help help for receivers
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status

@ -1,37 +0,0 @@
---
title: "flux get sources command"
---
## flux get sources
Get source statuses
### Synopsis
The get source sub-commands print the statuses of the sources.
### Options
```
-h, --help help for sources
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get](../flux_get/) - Get the resources and their status
* [flux get sources all](../flux_get_sources_all/) - Get all source statuses
* [flux get sources bucket](../flux_get_sources_bucket/) - Get Bucket source statuses
* [flux get sources chart](../flux_get_sources_chart/) - Get HelmChart statuses
* [flux get sources git](../flux_get_sources_git/) - Get GitRepository source statuses
* [flux get sources helm](../flux_get_sources_helm/) - Get HelmRepository source statuses

@ -1,46 +0,0 @@
---
title: "flux get sources all command"
---
## flux get sources all
Get all source statuses
### Synopsis
The get sources all command print the statuses of all sources.
```
flux get sources all [flags]
```
### Examples
```
# List all sources in a namespace
flux get sources all --namespace=flux-system
# List all sources in all namespaces
flux get sources all --all-namespaces
```
### Options
```
-h, --help help for all
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get sources](../flux_get_sources/) - Get source statuses

@ -1,46 +0,0 @@
---
title: "flux get sources bucket command"
---
## flux get sources bucket
Get Bucket source statuses
### Synopsis
The get sources bucket command prints the status of the Bucket sources.
```
flux get sources bucket [flags]
```
### Examples
```
# List all Buckets and their status
flux get sources bucket
# List buckets from all namespaces
flux get sources helm --all-namespaces
```
### Options
```
-h, --help help for bucket
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get sources](../flux_get_sources/) - Get source statuses

@ -1,46 +0,0 @@
---
title: "flux get sources chart command"
---
## flux get sources chart
Get HelmChart statuses
### Synopsis
The get sources chart command prints the status of the HelmCharts.
```
flux get sources chart [flags]
```
### Examples
```
# List all Helm charts and their status
flux get sources chart
# List Helm charts from all namespaces
flux get sources chart --all-namespaces
```
### Options
```
-h, --help help for chart
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get sources](../flux_get_sources/) - Get source statuses

@ -1,46 +0,0 @@
---
title: "flux get sources git command"
---
## flux get sources git
Get GitRepository source statuses
### Synopsis
The get sources git command prints the status of the GitRepository sources.
```
flux get sources git [flags]
```
### Examples
```
# List all Git repositories and their status
flux get sources git
# List Git repositories from all namespaces
flux get sources git --all-namespaces
```
### Options
```
-h, --help help for git
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get sources](../flux_get_sources/) - Get source statuses

@ -1,46 +0,0 @@
---
title: "flux get sources helm command"
---
## flux get sources helm
Get HelmRepository source statuses
### Synopsis
The get sources helm command prints the status of the HelmRepository sources.
```
flux get sources helm [flags]
```
### Examples
```
# List all Helm repositories and their status
flux get sources helm
# List Helm repositories from all namespaces
flux get sources helm --all-namespaces
```
### Options
```
-h, --help help for helm
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux get sources](../flux_get_sources/) - Get source statuses

@ -1,67 +0,0 @@
---
title: "flux install command"
---
## flux install
Install or upgrade Flux
### Synopsis
The install command deploys Flux in the specified namespace.
If a previous version is installed, then an in-place upgrade will be performed.
```
flux install [flags]
```
### Examples
```
# Install the latest version in the flux-system namespace
flux install --version=latest --namespace=flux-system
# Install a specific version and a series of components
flux install --dry-run --version=v0.0.7 --components="source-controller,kustomize-controller"
# Install Flux onto tainted Kubernetes nodes
flux install --toleration-keys=node.kubernetes.io/dedicated-to-flux
# Dry-run install with manifests preview
flux install --dry-run --verbose
# Write install manifests to file
flux install --export > flux-system.yaml
```
### Options
```
--cluster-domain string internal cluster domain (default "cluster.local")
--components strings list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
--components-extra strings list of components in addition to those supplied or defaulted, accepts comma-separated values
--dry-run only print the object that would be applied
--export write the install manifests to stdout and exit
-h, --help help for install
--image-pull-secret string Kubernetes secret name used for pulling the toolkit images from a private registry
--log-level logLevel log level, available options are: (debug, info, error) (default info)
--network-policy deny ingress access to the toolkit controllers from other namespaces using network policies (default true)
--registry string container registry where the toolkit images are published (default "ghcr.io/fluxcd")
--toleration-keys strings list of toleration keys used to schedule the components pods onto nodes with matching taints
-v, --version string toolkit version, when specified the manifests are downloaded from https://github.com/fluxcd/flux2/releases
--watch-all-namespaces watch for custom resources in all namespaces, if set to false it will only watch the namespace where the toolkit is installed (default true)
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines

@ -1,59 +0,0 @@
---
title: "flux logs command"
---
## flux logs
Display formatted logs for Flux components
### Synopsis
The logs command displays formatted logs from various Flux components.
```
flux logs [flags]
```
### Examples
```
# Print the reconciliation logs of all Flux custom resources in your cluster
flux logs --all-namespaces
# Stream logs for a particular log level
flux logs --follow --level=error --all-namespaces
# Filter logs by kind, name and namespace
flux logs --kind=Kustomization --name=podinfo --namespace=default
# Print logs when Flux is installed in a different namespace than flux-system
flux logs --flux-namespace=my-namespace
```
### Options
```
-A, --all-namespaces displays logs for objects across all namespaces
--flux-namespace string the namespace where the Flux components are running (default "flux-system")
-f, --follow specifies if the logs should be streamed
-h, --help help for logs
--kind string displays errors of a particular toolkit kind e.g GitRepository
--level logLevel log level, available options are: (debug, info, error)
--name string specifies the name of the object logs to be displayed
--tail int lines of recent log file to display (default -1)
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines

@ -1,38 +0,0 @@
---
title: "flux reconcile command"
---
## flux reconcile
Reconcile sources and resources
### Synopsis
The reconcile sub-commands trigger a reconciliation of sources and resources.
### Options
```
-h, --help help for reconcile
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux reconcile alert](../flux_reconcile_alert/) - Reconcile an Alert
* [flux reconcile alert-provider](../flux_reconcile_alert-provider/) - Reconcile a Provider
* [flux reconcile helmrelease](../flux_reconcile_helmrelease/) - Reconcile a HelmRelease resource
* [flux reconcile image](../flux_reconcile_image/) - Reconcile image automation objects
* [flux reconcile kustomization](../flux_reconcile_kustomization/) - Reconcile a Kustomization resource
* [flux reconcile receiver](../flux_reconcile_receiver/) - Reconcile a Receiver
* [flux reconcile source](../flux_reconcile_source/) - Reconcile sources

@ -1,42 +0,0 @@
---
title: "flux reconcile alert-provider command"
---
## flux reconcile alert-provider
Reconcile a Provider
### Synopsis
The reconcile alert-provider command triggers a reconciliation of a Provider resource and waits for it to finish.
```
flux reconcile alert-provider [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing provider
flux reconcile alert-provider slack
```
### Options
```
-h, --help help for alert-provider
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources

@ -1,42 +0,0 @@
---
title: "flux reconcile alert command"
---
## flux reconcile alert
Reconcile an Alert
### Synopsis
The reconcile alert command triggers a reconciliation of an Alert resource and waits for it to finish.
```
flux reconcile alert [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing alert
flux reconcile alert main
```
### Options
```
-h, --help help for alert
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources

@ -1,47 +0,0 @@
---
title: "flux reconcile helmrelease command"
---
## flux reconcile helmrelease
Reconcile a HelmRelease resource
### Synopsis
The reconcile kustomization command triggers a reconciliation of a HelmRelease resource and waits for it to finish.
```
flux reconcile helmrelease [name] [flags]
```
### Examples
```
# Trigger a HelmRelease apply outside of the reconciliation interval
flux reconcile hr podinfo
# Trigger a reconciliation of the HelmRelease's source and apply changes
flux reconcile hr podinfo --with-source
```
### Options
```
-h, --help help for helmrelease
--with-source reconcile HelmRelease source
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources

@ -1,33 +0,0 @@
---
title: "flux reconcile image command"
---
## flux reconcile image
Reconcile image automation objects
### Synopsis
The reconcile sub-commands trigger a reconciliation of image automation objects.
### Options
```
-h, --help help for image
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources
* [flux reconcile image repository](../flux_reconcile_image_repository/) - Reconcile an ImageRepository
* [flux reconcile image update](../flux_reconcile_image_update/) - Reconcile an ImageUpdateAutomation

@ -1,42 +0,0 @@
---
title: "flux reconcile image repository command"
---
## flux reconcile image repository
Reconcile an ImageRepository
### Synopsis
The reconcile image repository command triggers a reconciliation of an ImageRepository resource and waits for it to finish.
```
flux reconcile image repository [name] [flags]
```
### Examples
```
# Trigger an scan for an existing image repository
flux reconcile image repository alpine
```
### Options
```
-h, --help help for repository
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile image](../flux_reconcile_image/) - Reconcile image automation objects

@ -1,42 +0,0 @@
---
title: "flux reconcile image update command"
---
## flux reconcile image update
Reconcile an ImageUpdateAutomation
### Synopsis
The reconcile image update command triggers a reconciliation of an ImageUpdateAutomation resource and waits for it to finish.
```
flux reconcile image update [name] [flags]
```
### Examples
```
# Trigger an automation run for an existing image update automation
flux reconcile image update latest-images
```
### Options
```
-h, --help help for update
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile image](../flux_reconcile_image/) - Reconcile image automation objects

@ -1,47 +0,0 @@
---
title: "flux reconcile kustomization command"
---
## flux reconcile kustomization
Reconcile a Kustomization resource
### Synopsis
The reconcile kustomization command triggers a reconciliation of a Kustomization resource and waits for it to finish.
```
flux reconcile kustomization [name] [flags]
```
### Examples
```
# Trigger a Kustomization apply outside of the reconciliation interval
flux reconcile kustomization podinfo
# Trigger a sync of the Kustomization's source and apply changes
flux reconcile kustomization podinfo --with-source
```
### Options
```
-h, --help help for kustomization
--with-source reconcile Kustomization source
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources

@ -1,42 +0,0 @@
---
title: "flux reconcile receiver command"
---
## flux reconcile receiver
Reconcile a Receiver
### Synopsis
The reconcile receiver command triggers a reconciliation of a Receiver resource and waits for it to finish.
```
flux reconcile receiver [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing receiver
flux reconcile receiver main
```
### Options
```
-h, --help help for receiver
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources

@ -1,34 +0,0 @@
---
title: "flux reconcile source command"
---
## flux reconcile source
Reconcile sources
### Synopsis
The reconcile source sub-commands trigger a reconciliation of sources.
### Options
```
-h, --help help for source
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile](../flux_reconcile/) - Reconcile sources and resources
* [flux reconcile source bucket](../flux_reconcile_source_bucket/) - Reconcile a Bucket source
* [flux reconcile source git](../flux_reconcile_source_git/) - Reconcile a GitRepository source
* [flux reconcile source helm](../flux_reconcile_source_helm/) - Reconcile a HelmRepository source

@ -1,42 +0,0 @@
---
title: "flux reconcile source bucket command"
---
## flux reconcile source bucket
Reconcile a Bucket source
### Synopsis
The reconcile source command triggers a reconciliation of a Bucket resource and waits for it to finish.
```
flux reconcile source bucket [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing source
flux reconcile source bucket podinfo
```
### Options
```
-h, --help help for bucket
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile source](../flux_reconcile_source/) - Reconcile sources

@ -1,42 +0,0 @@
---
title: "flux reconcile source git command"
---
## flux reconcile source git
Reconcile a GitRepository source
### Synopsis
The reconcile source command triggers a reconciliation of a GitRepository resource and waits for it to finish.
```
flux reconcile source git [name] [flags]
```
### Examples
```
# Trigger a git pull for an existing source
flux reconcile source git podinfo
```
### Options
```
-h, --help help for git
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile source](../flux_reconcile_source/) - Reconcile sources

@ -1,42 +0,0 @@
---
title: "flux reconcile source helm command"
---
## flux reconcile source helm
Reconcile a HelmRepository source
### Synopsis
The reconcile source command triggers a reconciliation of a HelmRepository resource and waits for it to finish.
```
flux reconcile source helm [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing source
flux reconcile source helm podinfo
```
### Options
```
-h, --help help for helm
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux reconcile source](../flux_reconcile_source/) - Reconcile sources

@ -1,38 +0,0 @@
---
title: "flux resume command"
---
## flux resume
Resume suspended resources
### Synopsis
The resume sub-commands resume a suspended resource.
### Options
```
--all suspend all resources in that namespace
-h, --help help for resume
```
### Options inherited from parent commands
```
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux](../flux/) - Command line utility for assembling Kubernetes CD pipelines
* [flux resume alert](../flux_resume_alert/) - Resume a suspended Alert
* [flux resume helmrelease](../flux_resume_helmrelease/) - Resume a suspended HelmRelease
* [flux resume image](../flux_resume_image/) - Resume image automation objects
* [flux resume kustomization](../flux_resume_kustomization/) - Resume a suspended Kustomization
* [flux resume receiver](../flux_resume_receiver/) - Resume a suspended Receiver
* [flux resume source](../flux_resume_source/) - Resume sources

@ -1,44 +0,0 @@
---
title: "flux resume alert command"
---
## flux resume alert
Resume a suspended Alert
### Synopsis
The resume command marks a previously suspended Alert resource for reconciliation and waits for it to
finish the apply.
```
flux resume alert [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Alert
flux resume alert main
```
### Options
```
-h, --help help for alert
```
### Options inherited from parent commands
```
--all suspend all resources in that namespace
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux resume](../flux_resume/) - Resume suspended resources

@ -1,44 +0,0 @@
---
title: "flux resume helmrelease command"
---
## flux resume helmrelease
Resume a suspended HelmRelease
### Synopsis
The resume command marks a previously suspended HelmRelease resource for reconciliation and waits for it to
finish the apply.
```
flux resume helmrelease [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Helm release
flux resume hr podinfo
```
### Options
```
-h, --help help for helmrelease
```
### Options inherited from parent commands
```
--all suspend all resources in that namespace
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux resume](../flux_resume/) - Resume suspended resources

@ -1,34 +0,0 @@
---
title: "flux resume image command"
---
## flux resume image
Resume image automation objects
### Synopsis
The resume image sub-commands resume suspended image automation objects.
### Options
```
-h, --help help for image
```
### Options inherited from parent commands
```
--all suspend all resources in that namespace
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux resume](../flux_resume/) - Resume suspended resources
* [flux resume image repository](../flux_resume_image_repository/) - Resume a suspended ImageRepository
* [flux resume image update](../flux_resume_image_update/) - Resume a suspended ImageUpdateAutomation

@ -1,43 +0,0 @@
---
title: "flux resume image repository command"
---
## flux resume image repository
Resume a suspended ImageRepository
### Synopsis
The resume command marks a previously suspended ImageRepository resource for reconciliation and waits for it to finish.
```
flux resume image repository [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing ImageRepository
flux resume image repository alpine
```
### Options
```
-h, --help help for repository
```
### Options inherited from parent commands
```
--all suspend all resources in that namespace
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux resume image](../flux_resume_image/) - Resume image automation objects

@ -1,43 +0,0 @@
---
title: "flux resume image update command"
---
## flux resume image update
Resume a suspended ImageUpdateAutomation
### Synopsis
The resume command marks a previously suspended ImageUpdateAutomation resource for reconciliation and waits for it to finish.
```
flux resume image update [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing ImageUpdateAutomation
flux resume image update latest-images
```
### Options
```
-h, --help help for update
```
### Options inherited from parent commands
```
--all suspend all resources in that namespace
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux resume image](../flux_resume_image/) - Resume image automation objects

@ -1,44 +0,0 @@
---
title: "flux resume kustomization command"
---
## flux resume kustomization
Resume a suspended Kustomization
### Synopsis
The resume command marks a previously suspended Kustomization resource for reconciliation and waits for it to
finish the apply.
```
flux resume kustomization [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Kustomization
flux resume ks podinfo
```
### Options
```
-h, --help help for kustomization
```
### Options inherited from parent commands
```
--all suspend all resources in that namespace
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux resume](../flux_resume/) - Resume suspended resources

@ -1,44 +0,0 @@
---
title: "flux resume receiver command"
---
## flux resume receiver
Resume a suspended Receiver
### Synopsis
The resume command marks a previously suspended Receiver resource for reconciliation and waits for it to
finish the apply.
```
flux resume receiver [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Receiver
flux resume receiver main
```
### Options
```
-h, --help help for receiver
```
### Options inherited from parent commands
```
--all suspend all resources in that namespace
--context string kubernetes context to use
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
--verbose print generated objects
```
### SEE ALSO
* [flux resume](../flux_resume/) - Resume suspended resources

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save