1
0
mirror of synced 2026-02-06 10:55:56 +00:00

Rename gotk binary to flux

Signed-off-by: Hidde Beydals <hello@hidde.co>
This commit is contained in:
Hidde Beydals
2020-10-29 14:37:07 +01:00
parent 9916a53761
commit e2752e4508
168 changed files with 767 additions and 887 deletions

View File

@@ -1,4 +1,4 @@
## gotk
## flux
Command line utility for assembling Kubernetes CD pipelines
@@ -10,28 +10,28 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
```
# Check prerequisites
gotk check --pre
flux check --pre
# Install the latest version of the toolkit
gotk install --version=master
flux install --version=master
# Create a source from a public Git repository
gotk create source git webapp-latest \
flux create source git webapp-latest \
--url=https://github.com/stefanprodan/podinfo \
--branch=master \
--interval=3m
# List GitRepository sources and their status
gotk get sources git
flux get sources git
# Trigger a GitRepository source reconciliation
gotk reconcile source git flux-system
flux reconcile source git flux-system
# Export GitRepository sources in YAML format
gotk export source git --all > sources.yaml
flux export source git --all > sources.yaml
# Create a Kustomization for deploying a series of microservices
gotk create kustomization webapp-dev \
flux create kustomization webapp-dev \
--source=webapp-latest \
--path="./deploy/webapp/" \
--prune=true \
@@ -42,32 +42,32 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
--health-check-timeout=2m
# Trigger a git sync of the Kustomization's source and apply changes
gotk reconcile kustomization webapp-dev --with-source
flux reconcile kustomization webapp-dev --with-source
# Suspend a Kustomization reconciliation
gotk suspend kustomization webapp-dev
flux suspend kustomization webapp-dev
# Export Kustomizations in YAML format
gotk export kustomization --all > kustomizations.yaml
flux export kustomization --all > kustomizations.yaml
# Resume a Kustomization reconciliation
gotk resume kustomization webapp-dev
flux resume kustomization webapp-dev
# Delete a Kustomization
gotk delete kustomization webapp-dev
flux delete kustomization webapp-dev
# Delete a GitRepository source
gotk delete source git webapp-latest
flux delete source git webapp-latest
# Uninstall the toolkit and delete CRDs
gotk uninstall --crds
flux uninstall --crds
```
### Options
```
-h, --help help for gotk
-h, --help help for flux
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
-n, --namespace string the namespace scope for this operation (default "flux-system")
--timeout duration timeout for this operation (default 5m0s)
@@ -76,16 +76,16 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
### SEE ALSO
* [gotk bootstrap](gotk_bootstrap.md) - Bootstrap toolkit components
* [gotk check](gotk_check.md) - Check requirements and installation
* [gotk completion](gotk_completion.md) - Generates completion scripts for various shells
* [gotk create](gotk_create.md) - Create or update sources and resources
* [gotk delete](gotk_delete.md) - Delete sources and resources
* [gotk export](gotk_export.md) - Export resources in YAML format
* [gotk get](gotk_get.md) - Get sources and resources
* [gotk install](gotk_install.md) - Install the toolkit components
* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources
* [gotk resume](gotk_resume.md) - Resume suspended resources
* [gotk suspend](gotk_suspend.md) - Suspend resources
* [gotk uninstall](gotk_uninstall.md) - Uninstall the toolkit components
* [flux bootstrap](flux_bootstrap.md) - Bootstrap toolkit components
* [flux check](flux_check.md) - Check requirements and installation
* [flux completion](flux_completion.md) - Generates completion scripts for various shells
* [flux create](flux_create.md) - Create or update sources and resources
* [flux delete](flux_delete.md) - Delete sources and resources
* [flux export](flux_export.md) - Export resources in YAML format
* [flux get](flux_get.md) - Get sources and resources
* [flux install](flux_install.md) - Install the toolkit components
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources
* [flux resume](flux_resume.md) - Resume suspended resources
* [flux suspend](flux_suspend.md) - Suspend resources
* [flux uninstall](flux_uninstall.md) - Uninstall the toolkit components

View File

@@ -1,4 +1,4 @@
## gotk bootstrap
## flux bootstrap
Bootstrap toolkit components
@@ -32,7 +32,7 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk bootstrap github](gotk_bootstrap_github.md) - Bootstrap toolkit components in a GitHub repository
* [gotk bootstrap gitlab](gotk_bootstrap_gitlab.md) - Bootstrap toolkit components in a GitLab repository
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux bootstrap github](flux_bootstrap_github.md) - Bootstrap toolkit components in a GitHub repository
* [flux bootstrap gitlab](flux_bootstrap_gitlab.md) - Bootstrap toolkit components in a GitLab repository

View File

@@ -1,4 +1,4 @@
## gotk bootstrap github
## flux bootstrap github
Bootstrap toolkit components in a GitHub repository
@@ -11,7 +11,7 @@ If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
```
gotk bootstrap github [flags]
flux bootstrap github [flags]
```
### Examples
@@ -21,22 +21,22 @@ gotk bootstrap github [flags]
export GITHUB_TOKEN=<my-token>
# Run bootstrap for a private repo owned by a GitHub organization
gotk bootstrap github --owner=<organization> --repository=<repo name>
flux bootstrap github --owner=<organization> --repository=<repo name>
# Run bootstrap for a private repo and assign organization teams to it
gotk bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug>
flux bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug>
# Run bootstrap for a repository path
gotk bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster
flux bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
gotk bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true
flux bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true
# Run bootstrap for a private repo hosted on GitHub Enterprise
gotk bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain>
flux bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain>
# Run bootstrap for a an existing repository with a branch named main
gotk bootstrap github --owner=<organization> --repository=<repo name> --branch=main
flux bootstrap github --owner=<organization> --repository=<repo name> --branch=main
```
@@ -74,5 +74,5 @@ gotk bootstrap github [flags]
### SEE ALSO
* [gotk bootstrap](gotk_bootstrap.md) - Bootstrap toolkit components
* [flux bootstrap](flux_bootstrap.md) - Bootstrap toolkit components

View File

@@ -1,4 +1,4 @@
## gotk bootstrap gitlab
## flux bootstrap gitlab
Bootstrap toolkit components in a GitLab repository
@@ -11,7 +11,7 @@ If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
```
gotk bootstrap gitlab [flags]
flux bootstrap gitlab [flags]
```
### Examples
@@ -21,22 +21,22 @@ gotk bootstrap gitlab [flags]
export GITLAB_TOKEN=<my-token>
# Run bootstrap for a private repo using HTTPS token authentication
gotk bootstrap gitlab --owner=<group> --repository=<repo name>
flux bootstrap gitlab --owner=<group> --repository=<repo name>
# Run bootstrap for a private repo using SSH authentication
gotk bootstrap gitlab --owner=<group> --repository=<repo name> --ssh-hostname=gitlab.com
flux bootstrap gitlab --owner=<group> --repository=<repo name> --ssh-hostname=gitlab.com
# Run bootstrap for a repository path
gotk bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster
flux bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster
# Run bootstrap for a public repository on a personal account
gotk bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true
flux bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true
# Run bootstrap for a private repo hosted on a GitLab server
gotk bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain>
flux bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain>
# Run bootstrap for a an existing repository with a branch named main
gotk bootstrap gitlab --owner=<organization> --repository=<repo name> --branch=main
flux bootstrap gitlab --owner=<organization> --repository=<repo name> --branch=main
```
@@ -74,5 +74,5 @@ gotk bootstrap gitlab [flags]
### SEE ALSO
* [gotk bootstrap](gotk_bootstrap.md) - Bootstrap toolkit components
* [flux bootstrap](flux_bootstrap.md) - Bootstrap toolkit components

View File

@@ -1,4 +1,4 @@
## gotk check
## flux check
Check requirements and installation
@@ -8,17 +8,17 @@ 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.
```
gotk check [flags]
flux check [flags]
```
### Examples
```
# Run pre-installation checks
gotk check --pre
flux check --pre
# Run installation checks
gotk check
flux check
```
@@ -41,5 +41,5 @@ gotk check [flags]
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines

View File

@@ -1,4 +1,4 @@
## gotk completion
## flux completion
Generates completion scripts for various shells
@@ -23,9 +23,9 @@ The completion sub-command generates completion scripts for various shells
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk completion bash](gotk_completion_bash.md) - Generates bash completion scripts
* [gotk completion fish](gotk_completion_fish.md) - Generates fish completion scripts
* [gotk completion powershell](gotk_completion_powershell.md) - Generates powershell completion scripts
* [gotk completion zsh](gotk_completion_zsh.md) - Generates zsh completion scripts
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux completion bash](flux_completion_bash.md) - Generates bash completion scripts
* [flux completion fish](flux_completion_fish.md) - Generates fish completion scripts
* [flux completion powershell](flux_completion_powershell.md) - Generates powershell completion scripts
* [flux completion zsh](flux_completion_zsh.md) - Generates zsh completion scripts

View File

@@ -1,4 +1,4 @@
## gotk completion bash
## flux completion bash
Generates bash completion scripts
@@ -7,7 +7,7 @@ Generates bash completion scripts
Generates bash completion scripts
```
gotk completion bash [flags]
flux completion bash [flags]
```
### Examples
@@ -15,12 +15,12 @@ gotk completion bash [flags]
```
To load completion run
. <(gotk completion bash)
. <(flux completion bash)
To configure your bash shell to load completions for each session add to your bashrc
# ~/.bashrc or ~/.profile
command -v gotk >/dev/null && . <(gotk completion bash)
command -v flux >/dev/null && . <(flux completion bash)
```
@@ -41,5 +41,5 @@ command -v gotk >/dev/null && . <(gotk completion bash)
### SEE ALSO
* [gotk completion](gotk_completion.md) - Generates completion scripts for various shells
* [flux completion](flux_completion.md) - Generates completion scripts for various shells

View File

@@ -1,4 +1,4 @@
## gotk completion fish
## flux completion fish
Generates fish completion scripts
@@ -7,7 +7,7 @@ Generates fish completion scripts
Generates fish completion scripts
```
gotk completion fish [flags]
flux completion fish [flags]
```
### Examples
@@ -15,11 +15,11 @@ gotk completion fish [flags]
```
To load completion run
. <(gotk completion fish)
. <(flux completion fish)
To configure your fish shell to load completions for each session write this script to your completions dir:
gotk completion fish > ~/.config/fish/completions/gotk
flux completion fish > ~/.config/fish/completions/flux
See http://fishshell.com/docs/current/index.html#completion-own for more details
@@ -42,5 +42,5 @@ See http://fishshell.com/docs/current/index.html#completion-own for more details
### SEE ALSO
* [gotk completion](gotk_completion.md) - Generates completion scripts for various shells
* [flux completion](flux_completion.md) - Generates completion scripts for various shells

View File

@@ -1,4 +1,4 @@
## gotk completion powershell
## flux completion powershell
Generates powershell completion scripts
@@ -7,7 +7,7 @@ Generates powershell completion scripts
Generates powershell completion scripts
```
gotk completion powershell [flags]
flux completion powershell [flags]
```
### Examples
@@ -15,19 +15,19 @@ gotk completion powershell [flags]
```
To load completion run
. <(gotk completion powershell)
. <(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"
gotk completion >> gotk-completion.ps1
flux completion >> flux-completion.ps1
Linux:
cd "${XDG_CONFIG_HOME:-"$HOME/.config/"}/powershell/modules"
gotk completion >> gotk-completions.ps1
flux completion >> flux-completions.ps1
```
@@ -48,5 +48,5 @@ gotk completion >> gotk-completions.ps1
### SEE ALSO
* [gotk completion](gotk_completion.md) - Generates completion scripts for various shells
* [flux completion](flux_completion.md) - Generates completion scripts for various shells

View File

@@ -1,4 +1,4 @@
## gotk completion zsh
## flux completion zsh
Generates zsh completion scripts
@@ -7,7 +7,7 @@ Generates zsh completion scripts
Generates zsh completion scripts
```
gotk completion zsh [flags]
flux completion zsh [flags]
```
### Examples
@@ -15,20 +15,20 @@ gotk completion zsh [flags]
```
To load completion run
. <(gotk completion zsh) && compdef _gotk gotk
. <(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 gotk >/dev/null && . <(gotk completion zsh) && compdef _gotk gotk
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
gotk completions zsh > _gotk
flux completions zsh > _flux
mv _gotk ~/.oh-my-zsh/completions # oh-my-zsh
mv _gotk ~/.zprezto/modules/completion/external/src/ # zprezto
mv _flux ~/.oh-my-zsh/completions # oh-my-zsh
mv _flux ~/.zprezto/modules/completion/external/src/ # zprezto
```
@@ -49,5 +49,5 @@ mv _gotk ~/.zprezto/modules/completion/external/src/ # zprezto
### SEE ALSO
* [gotk completion](gotk_completion.md) - Generates completion scripts for various shells
* [flux completion](flux_completion.md) - Generates completion scripts for various shells

View File

@@ -1,4 +1,4 @@
## gotk create
## flux create
Create or update sources and resources
@@ -26,11 +26,11 @@ The create sub-commands generate sources and resources.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk create alert](gotk_create_alert.md) - Create or update a Alert resource
* [gotk create alert-provider](gotk_create_alert-provider.md) - Create or update a Provider resource
* [gotk create helmrelease](gotk_create_helmrelease.md) - Create or update a HelmRelease resource
* [gotk create kustomization](gotk_create_kustomization.md) - Create or update a Kustomization resource
* [gotk create receiver](gotk_create_receiver.md) - Create or update a Receiver resource
* [gotk create source](gotk_create_source.md) - Create or update sources
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux create alert](flux_create_alert.md) - Create or update a Alert resource
* [flux create alert-provider](flux_create_alert-provider.md) - Create or update a Provider resource
* [flux create helmrelease](flux_create_helmrelease.md) - Create or update a HelmRelease resource
* [flux create kustomization](flux_create_kustomization.md) - Create or update a Kustomization resource
* [flux create receiver](flux_create_receiver.md) - Create or update a Receiver resource
* [flux create source](flux_create_source.md) - Create or update sources

View File

@@ -1,4 +1,4 @@
## gotk create alert-provider
## flux create alert-provider
Create or update a Provider resource
@@ -7,21 +7,21 @@ Create or update a Provider resource
The create alert-provider command generates a Provider resource.
```
gotk create alert-provider [name] [flags]
flux create alert-provider [name] [flags]
```
### Examples
```
# Create a Provider for a Slack channel
gotk create alert-provider slack \
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
gotk create alert-provider github-podinfo \
flux create alert-provider github-podinfo \
--type github \
--address https://github.com/stefanprodan/podinfo \
--secret-ref github-token
@@ -53,5 +53,5 @@ gotk create alert-provider [name] [flags]
### SEE ALSO
* [gotk create](gotk_create.md) - Create or update sources and resources
* [flux create](flux_create.md) - Create or update sources and resources

View File

@@ -1,4 +1,4 @@
## gotk create alert
## flux create alert
Create or update a Alert resource
@@ -7,14 +7,14 @@ Create or update a Alert resource
The create alert command generates a Alert resource.
```
gotk create alert [name] [flags]
flux create alert [name] [flags]
```
### Examples
```
# Create an Alert for kustomization events
gotk create alert \
flux create alert \
--event-severity info \
--event-source Kustomization/flux-system \
--provider-ref slack \
@@ -45,5 +45,5 @@ gotk create alert [name] [flags]
### SEE ALSO
* [gotk create](gotk_create.md) - Create or update sources and resources
* [flux create](flux_create.md) - Create or update sources and resources

View File

@@ -1,4 +1,4 @@
## gotk create helmrelease
## flux create helmrelease
Create or update a HelmRelease resource
@@ -7,51 +7,51 @@ Create or update a HelmRelease resource
The helmrelease create command generates a HelmRelease resource for a given HelmRepository source.
```
gotk create helmrelease [name] [flags]
flux create helmrelease [name] [flags]
```
### Examples
```
# Create a HelmRelease with a chart from a HelmRepository source
gotk create hr podinfo \
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
gotk create hr podinfo \
flux create hr podinfo \
--interval=10m \
--source=GitRepository/podinfo \
--chart=./charts/podinfo
# Create a HelmRelease with a chart from a Bucket source
gotk create hr podinfo \
flux create hr podinfo \
--interval=10m \
--source=Bucket/podinfo \
--chart=./charts/podinfo
# Create a HelmRelease with values from a local YAML file
gotk create hr podinfo \
flux create hr podinfo \
--source=HelmRepository/podinfo \
--chart=podinfo \
--values=./my-values.yaml
# Create a HelmRelease with a custom release name
gotk create hr podinfo \
flux create hr podinfo \
--release-name=podinfo-dev
--source=HelmRepository/podinfo \
--chart=podinfo \
# Create a HelmRelease targeting another namespace than the resource
gotk create hr podinfo \
flux create hr podinfo \
--target-namespace=default \
--source=HelmRepository/podinfo \
--chart=podinfo
# Create a HelmRelease definition on disk without applying it on the cluster
gotk create hr podinfo \
flux create hr podinfo \
--source=HelmRepository/podinfo \
--chart=podinfo \
--values=./values.yaml \
@@ -86,5 +86,5 @@ gotk create helmrelease [name] [flags]
### SEE ALSO
* [gotk create](gotk_create.md) - Create or update sources and resources
* [flux create](flux_create.md) - Create or update sources and resources

View File

@@ -1,4 +1,4 @@
## gotk create kustomization
## flux create kustomization
Create or update a Kustomization resource
@@ -7,14 +7,14 @@ Create or update a Kustomization resource
The kustomization source create command generates a Kustomize resource for a given source.
```
gotk create kustomization [name] [flags]
flux create kustomization [name] [flags]
```
### Examples
```
# Create a Kustomization resource from a source at a given path
gotk create kustomization contour \
flux create kustomization contour \
--source=contour \
--path="./examples/contour/" \
--prune=true \
@@ -25,7 +25,7 @@ gotk create kustomization [name] [flags]
--health-check-timeout=3m
# Create a Kustomization resource that depends on the previous one
gotk create kustomization webapp \
flux create kustomization webapp \
--depends-on=contour \
--source=webapp \
--path="./deploy/overlays/dev" \
@@ -34,7 +34,7 @@ gotk create kustomization [name] [flags]
--validation=client
# Create a Kustomization resource that references a Bucket
gotk create kustomization secrets \
flux create kustomization secrets \
--source=Bucket/secrets \
--prune=true \
--interval=5m
@@ -72,5 +72,5 @@ gotk create kustomization [name] [flags]
### SEE ALSO
* [gotk create](gotk_create.md) - Create or update sources and resources
* [flux create](flux_create.md) - Create or update sources and resources

View File

@@ -1,4 +1,4 @@
## gotk create receiver
## flux create receiver
Create or update a Receiver resource
@@ -7,14 +7,14 @@ Create or update a Receiver resource
The create receiver command generates a Receiver resource.
```
gotk create receiver [name] [flags]
flux create receiver [name] [flags]
```
### Examples
```
# Create a Receiver
gotk create receiver github-receiver \
flux create receiver github-receiver \
--type github \
--event ping \
--event push \
@@ -48,5 +48,5 @@ gotk create receiver [name] [flags]
### SEE ALSO
* [gotk create](gotk_create.md) - Create or update sources and resources
* [flux create](flux_create.md) - Create or update sources and resources

View File

@@ -1,4 +1,4 @@
## gotk create source
## flux create source
Create or update sources
@@ -26,8 +26,8 @@ The create source sub-commands generate sources.
### SEE ALSO
* [gotk create](gotk_create.md) - Create or update sources and resources
* [gotk create source bucket](gotk_create_source_bucket.md) - Create or update a Bucket source
* [gotk create source git](gotk_create_source_git.md) - Create or update a GitRepository source
* [gotk create source helm](gotk_create_source_helm.md) - Create or update a HelmRepository source
* [flux create](flux_create.md) - Create or update sources and resources
* [flux create source bucket](flux_create_source_bucket.md) - Create or update a Bucket source
* [flux create source git](flux_create_source_git.md) - Create or update a GitRepository source
* [flux create source helm](flux_create_source_helm.md) - Create or update a HelmRepository source

View File

@@ -1,4 +1,4 @@
## gotk create source bucket
## flux create source bucket
Create or update a Bucket source
@@ -9,14 +9,14 @@ The create source bucket command generates a Bucket resource and waits for it to
For Buckets with static authentication, the credentials are stored in a Kubernetes secret.
```
gotk create source bucket [name] [flags]
flux create source bucket [name] [flags]
```
### Examples
```
# Create a source from a Buckets using static authentication
gotk create source bucket podinfo \
flux create source bucket podinfo \
--bucket-name=podinfo \
--endpoint=minio.minio.svc.cluster.local:9000 \
--insecure=true \
@@ -25,7 +25,7 @@ gotk create source bucket [name] [flags]
--interval=10m
# Create a source from an Amazon S3 Bucket using IAM authentication
gotk create source bucket podinfo \
flux create source bucket podinfo \
--bucket-name=podinfo \
--provider=aws \
--endpoint=s3.amazonaws.com \
@@ -62,5 +62,5 @@ gotk create source bucket [name] [flags]
### SEE ALSO
* [gotk create source](gotk_create_source.md) - Create or update sources
* [flux create source](flux_create_source.md) - Create or update sources

View File

@@ -1,4 +1,4 @@
## gotk create source git
## flux create source git
Create or update a GitRepository source
@@ -10,42 +10,42 @@ For Git over SSH, host and SSH keys are automatically generated and stored in a
For private Git repositories, the basic authentication credentials are stored in a Kubernetes secret.
```
gotk create source git [name] [flags]
flux create source git [name] [flags]
```
### Examples
```
# Create a source from a public Git repository master branch
gotk create source git podinfo \
flux create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \
--branch=master
# Create a source from a Git repository pinned to specific git tag
gotk create source git podinfo \
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
gotk create source git podinfo \
flux create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \
--tag-semver=">=3.2.0 <3.3.0"
# Create a source from a Git repository using SSH authentication
gotk create source git podinfo \
flux create source git podinfo \
--url=ssh://git@github.com/stefanprodan/podinfo \
--branch=master
# Create a source from a Git repository using SSH authentication and an
# ECDSA P-521 curve public key
gotk create source git podinfo \
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 from a Git repository using basic authentication
gotk create source git podinfo \
flux create source git podinfo \
--url=https://github.com/stefanprodan/podinfo \
--username=username \
--password=password
@@ -82,5 +82,5 @@ gotk create source git [name] [flags]
### SEE ALSO
* [gotk create source](gotk_create_source.md) - Create or update sources
* [flux create source](flux_create_source.md) - Create or update sources

View File

@@ -1,4 +1,4 @@
## gotk create source helm
## flux create source helm
Create or update a HelmRepository source
@@ -9,25 +9,25 @@ The create source helm command generates a HelmRepository resource and waits for
For private Helm repositories, the basic authentication credentials are stored in a Kubernetes secret.
```
gotk create source helm [name] [flags]
flux create source helm [name] [flags]
```
### Examples
```
# Create a source from a public Helm repository
gotk create source helm podinfo \
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--interval=10m
# Create a source from a Helm repository using basic authentication
gotk create source helm podinfo \
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--username=username \
--password=password
# Create a source from a Helm repository using TLS authentication
gotk create source helm podinfo \
flux create source helm podinfo \
--url=https://stefanprodan.github.io/podinfo \
--cert-file=./cert.crt \
--key-file=./key.crt \
@@ -62,5 +62,5 @@ gotk create source helm [name] [flags]
### SEE ALSO
* [gotk create source](gotk_create_source.md) - Create or update sources
* [flux create source](flux_create_source.md) - Create or update sources

View File

@@ -1,4 +1,4 @@
## gotk delete
## flux delete
Delete sources and resources
@@ -24,11 +24,11 @@ The delete sub-commands delete sources and resources.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk delete alert](gotk_delete_alert.md) - Delete a Alert resource
* [gotk delete alert-provider](gotk_delete_alert-provider.md) - Delete a Provider resource
* [gotk delete helmrelease](gotk_delete_helmrelease.md) - Delete a HelmRelease resource
* [gotk delete kustomization](gotk_delete_kustomization.md) - Delete a Kustomization resource
* [gotk delete receiver](gotk_delete_receiver.md) - Delete a Receiver resource
* [gotk delete source](gotk_delete_source.md) - Delete sources
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux delete alert](flux_delete_alert.md) - Delete a Alert resource
* [flux delete alert-provider](flux_delete_alert-provider.md) - Delete a Provider resource
* [flux delete helmrelease](flux_delete_helmrelease.md) - Delete a HelmRelease resource
* [flux delete kustomization](flux_delete_kustomization.md) - Delete a Kustomization resource
* [flux delete receiver](flux_delete_receiver.md) - Delete a Receiver resource
* [flux delete source](flux_delete_source.md) - Delete sources

View File

@@ -1,4 +1,4 @@
## gotk delete alert-provider
## flux delete alert-provider
Delete a Provider resource
@@ -7,14 +7,14 @@ Delete a Provider resource
The delete alert-provider command removes the given Provider from the cluster.
```
gotk delete alert-provider [name] [flags]
flux delete alert-provider [name] [flags]
```
### Examples
```
# Delete a Provider and the Kubernetes resources created by it
gotk delete alert-provider slack
flux delete alert-provider slack
```
@@ -36,5 +36,5 @@ gotk delete alert-provider [name] [flags]
### SEE ALSO
* [gotk delete](gotk_delete.md) - Delete sources and resources
* [flux delete](flux_delete.md) - Delete sources and resources

View File

@@ -1,4 +1,4 @@
## gotk delete alert
## flux delete alert
Delete a Alert resource
@@ -7,14 +7,14 @@ Delete a Alert resource
The delete alert command removes the given Alert from the cluster.
```
gotk delete alert [name] [flags]
flux delete alert [name] [flags]
```
### Examples
```
# Delete an Alert and the Kubernetes resources created by it
gotk delete alert main
flux delete alert main
```
@@ -36,5 +36,5 @@ gotk delete alert [name] [flags]
### SEE ALSO
* [gotk delete](gotk_delete.md) - Delete sources and resources
* [flux delete](flux_delete.md) - Delete sources and resources

View File

@@ -1,4 +1,4 @@
## gotk delete helmrelease
## flux delete helmrelease
Delete a HelmRelease resource
@@ -7,14 +7,14 @@ Delete a HelmRelease resource
The delete helmrelease command removes the given HelmRelease from the cluster.
```
gotk delete helmrelease [name] [flags]
flux delete helmrelease [name] [flags]
```
### Examples
```
# Delete a Helm release and the Kubernetes resources created by it
gotk delete hr podinfo
flux delete hr podinfo
```
@@ -36,5 +36,5 @@ gotk delete helmrelease [name] [flags]
### SEE ALSO
* [gotk delete](gotk_delete.md) - Delete sources and resources
* [flux delete](flux_delete.md) - Delete sources and resources

View File

@@ -1,4 +1,4 @@
## gotk delete kustomization
## flux delete kustomization
Delete a Kustomization resource
@@ -7,14 +7,14 @@ Delete a Kustomization resource
The delete kustomization command deletes the given Kustomization from the cluster.
```
gotk delete kustomization [name] [flags]
flux delete kustomization [name] [flags]
```
### Examples
```
# Delete a kustomization and the Kubernetes resources created by it
gotk delete kustomization podinfo
flux delete kustomization podinfo
```
@@ -36,5 +36,5 @@ gotk delete kustomization [name] [flags]
### SEE ALSO
* [gotk delete](gotk_delete.md) - Delete sources and resources
* [flux delete](flux_delete.md) - Delete sources and resources

View File

@@ -1,4 +1,4 @@
## gotk delete receiver
## flux delete receiver
Delete a Receiver resource
@@ -7,14 +7,14 @@ Delete a Receiver resource
The delete receiver command removes the given Receiver from the cluster.
```
gotk delete receiver [name] [flags]
flux delete receiver [name] [flags]
```
### Examples
```
# Delete an Receiver and the Kubernetes resources created by it
gotk delete receiver main
flux delete receiver main
```
@@ -36,5 +36,5 @@ gotk delete receiver [name] [flags]
### SEE ALSO
* [gotk delete](gotk_delete.md) - Delete sources and resources
* [flux delete](flux_delete.md) - Delete sources and resources

View File

@@ -1,4 +1,4 @@
## gotk delete source
## flux delete source
Delete sources
@@ -24,8 +24,8 @@ The delete source sub-commands delete sources.
### SEE ALSO
* [gotk delete](gotk_delete.md) - Delete sources and resources
* [gotk delete source bucket](gotk_delete_source_bucket.md) - Delete a Bucket source
* [gotk delete source git](gotk_delete_source_git.md) - Delete a GitRepository source
* [gotk delete source helm](gotk_delete_source_helm.md) - Delete a HelmRepository source
* [flux delete](flux_delete.md) - Delete sources and resources
* [flux delete source bucket](flux_delete_source_bucket.md) - Delete a Bucket source
* [flux delete source git](flux_delete_source_git.md) - Delete a GitRepository source
* [flux delete source helm](flux_delete_source_helm.md) - Delete a HelmRepository source

View File

@@ -1,4 +1,4 @@
## gotk delete source bucket
## flux delete source bucket
Delete a Bucket source
@@ -7,14 +7,14 @@ Delete a Bucket source
The delete source bucket command deletes the given Bucket from the cluster.
```
gotk delete source bucket [name] [flags]
flux delete source bucket [name] [flags]
```
### Examples
```
# Delete a Bucket source
gotk delete source bucket podinfo
flux delete source bucket podinfo
```
@@ -36,5 +36,5 @@ gotk delete source bucket [name] [flags]
### SEE ALSO
* [gotk delete source](gotk_delete_source.md) - Delete sources
* [flux delete source](flux_delete_source.md) - Delete sources

View File

@@ -1,4 +1,4 @@
## gotk delete source git
## flux delete source git
Delete a GitRepository source
@@ -7,14 +7,14 @@ Delete a GitRepository source
The delete source git command deletes the given GitRepository from the cluster.
```
gotk delete source git [name] [flags]
flux delete source git [name] [flags]
```
### Examples
```
# Delete a Git repository
gotk delete source git podinfo
flux delete source git podinfo
```
@@ -36,5 +36,5 @@ gotk delete source git [name] [flags]
### SEE ALSO
* [gotk delete source](gotk_delete_source.md) - Delete sources
* [flux delete source](flux_delete_source.md) - Delete sources

View File

@@ -1,4 +1,4 @@
## gotk delete source helm
## flux delete source helm
Delete a HelmRepository source
@@ -7,14 +7,14 @@ Delete a HelmRepository source
The delete source helm command deletes the given HelmRepository from the cluster.
```
gotk delete source helm [name] [flags]
flux delete source helm [name] [flags]
```
### Examples
```
# Delete a Helm repository
gotk delete source helm podinfo
flux delete source helm podinfo
```
@@ -36,5 +36,5 @@ gotk delete source helm [name] [flags]
### SEE ALSO
* [gotk delete source](gotk_delete_source.md) - Delete sources
* [flux delete source](flux_delete_source.md) - Delete sources

View File

@@ -1,4 +1,4 @@
## gotk export
## flux export
Export resources in YAML format
@@ -24,11 +24,11 @@ The export sub-commands export resources in YAML format.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk export alert](gotk_export_alert.md) - Export Alert resources in YAML format
* [gotk export alert-provider](gotk_export_alert-provider.md) - Export Provider resources in YAML format
* [gotk export helmrelease](gotk_export_helmrelease.md) - Export HelmRelease resources in YAML format
* [gotk export kustomization](gotk_export_kustomization.md) - Export Kustomization resources in YAML format
* [gotk export receiver](gotk_export_receiver.md) - Export Receiver resources in YAML format
* [gotk export source](gotk_export_source.md) - Export sources
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux export alert](flux_export_alert.md) - Export Alert resources in YAML format
* [flux export alert-provider](flux_export_alert-provider.md) - Export Provider resources in YAML format
* [flux export helmrelease](flux_export_helmrelease.md) - Export HelmRelease resources in YAML format
* [flux export kustomization](flux_export_kustomization.md) - Export Kustomization resources in YAML format
* [flux export receiver](flux_export_receiver.md) - Export Receiver resources in YAML format
* [flux export source](flux_export_source.md) - Export sources

View File

@@ -1,4 +1,4 @@
## gotk export alert-provider
## flux export alert-provider
Export Provider resources in YAML format
@@ -7,17 +7,17 @@ Export Provider resources in YAML format
The export alert-provider command exports one or all Provider resources in YAML format.
```
gotk export alert-provider [name] [flags]
flux export alert-provider [name] [flags]
```
### Examples
```
# Export all Provider resources
gotk export alert-provider --all > alert-providers.yaml
flux export alert-provider --all > alert-providers.yaml
# Export a Provider
gotk export alert-provider slack > slack.yaml
flux export alert-provider slack > slack.yaml
```
@@ -39,5 +39,5 @@ gotk export alert-provider [name] [flags]
### SEE ALSO
* [gotk export](gotk_export.md) - Export resources in YAML format
* [flux export](flux_export.md) - Export resources in YAML format

View File

@@ -1,4 +1,4 @@
## gotk export alert
## flux export alert
Export Alert resources in YAML format
@@ -7,17 +7,17 @@ Export Alert resources in YAML format
The export alert command exports one or all Alert resources in YAML format.
```
gotk export alert [name] [flags]
flux export alert [name] [flags]
```
### Examples
```
# Export all Alert resources
gotk export alert --all > alerts.yaml
flux export alert --all > alerts.yaml
# Export a Alert
gotk export alert main > main.yaml
flux export alert main > main.yaml
```
@@ -39,5 +39,5 @@ gotk export alert [name] [flags]
### SEE ALSO
* [gotk export](gotk_export.md) - Export resources in YAML format
* [flux export](flux_export.md) - Export resources in YAML format

View File

@@ -1,4 +1,4 @@
## gotk export helmrelease
## flux export helmrelease
Export HelmRelease resources in YAML format
@@ -7,17 +7,17 @@ Export HelmRelease resources in YAML format
The export helmrelease command exports one or all HelmRelease resources in YAML format.
```
gotk export helmrelease [name] [flags]
flux export helmrelease [name] [flags]
```
### Examples
```
# Export all HelmRelease resources
gotk export helmrelease --all > kustomizations.yaml
flux export helmrelease --all > kustomizations.yaml
# Export a HelmRelease
gotk export hr my-app > app-release.yaml
flux export hr my-app > app-release.yaml
```
@@ -39,5 +39,5 @@ gotk export helmrelease [name] [flags]
### SEE ALSO
* [gotk export](gotk_export.md) - Export resources in YAML format
* [flux export](flux_export.md) - Export resources in YAML format

View File

@@ -1,4 +1,4 @@
## gotk export kustomization
## flux export kustomization
Export Kustomization resources in YAML format
@@ -7,17 +7,17 @@ Export Kustomization resources in YAML format
The export kustomization command exports one or all Kustomization resources in YAML format.
```
gotk export kustomization [name] [flags]
flux export kustomization [name] [flags]
```
### Examples
```
# Export all Kustomization resources
gotk export kustomization --all > kustomizations.yaml
flux export kustomization --all > kustomizations.yaml
# Export a Kustomization
gotk export kustomization my-app > kustomization.yaml
flux export kustomization my-app > kustomization.yaml
```
@@ -39,5 +39,5 @@ gotk export kustomization [name] [flags]
### SEE ALSO
* [gotk export](gotk_export.md) - Export resources in YAML format
* [flux export](flux_export.md) - Export resources in YAML format

View File

@@ -1,4 +1,4 @@
## gotk export receiver
## flux export receiver
Export Receiver resources in YAML format
@@ -7,17 +7,17 @@ Export Receiver resources in YAML format
The export receiver command exports one or all Receiver resources in YAML format.
```
gotk export receiver [name] [flags]
flux export receiver [name] [flags]
```
### Examples
```
# Export all Receiver resources
gotk export receiver --all > receivers.yaml
flux export receiver --all > receivers.yaml
# Export a Receiver
gotk export receiver main > main.yaml
flux export receiver main > main.yaml
```
@@ -39,5 +39,5 @@ gotk export receiver [name] [flags]
### SEE ALSO
* [gotk export](gotk_export.md) - Export resources in YAML format
* [flux export](flux_export.md) - Export resources in YAML format

View File

@@ -1,4 +1,4 @@
## gotk export source
## flux export source
Export sources
@@ -25,8 +25,8 @@ The export source sub-commands export sources in YAML format.
### SEE ALSO
* [gotk export](gotk_export.md) - Export resources in YAML format
* [gotk export source bucket](gotk_export_source_bucket.md) - Export Bucket sources in YAML format
* [gotk export source git](gotk_export_source_git.md) - Export GitRepository sources in YAML format
* [gotk export source helm](gotk_export_source_helm.md) - Export HelmRepository sources in YAML format
* [flux export](flux_export.md) - Export resources in YAML format
* [flux export source bucket](flux_export_source_bucket.md) - Export Bucket sources in YAML format
* [flux export source git](flux_export_source_git.md) - Export GitRepository sources in YAML format
* [flux export source helm](flux_export_source_helm.md) - Export HelmRepository sources in YAML format

View File

@@ -1,4 +1,4 @@
## gotk export source bucket
## flux export source bucket
Export Bucket sources in YAML format
@@ -7,17 +7,17 @@ Export Bucket sources in YAML format
The export source git command exports on or all Bucket sources in YAML format.
```
gotk export source bucket [name] [flags]
flux export source bucket [name] [flags]
```
### Examples
```
# Export all Bucket sources
gotk export source bucket --all > sources.yaml
flux export source bucket --all > sources.yaml
# Export a Bucket source including the static credentials
gotk export source bucket my-bucket --with-credentials > source.yaml
flux export source bucket my-bucket --with-credentials > source.yaml
```
@@ -40,5 +40,5 @@ gotk export source bucket [name] [flags]
### SEE ALSO
* [gotk export source](gotk_export_source.md) - Export sources
* [flux export source](flux_export_source.md) - Export sources

View File

@@ -1,4 +1,4 @@
## gotk export source git
## flux export source git
Export GitRepository sources in YAML format
@@ -7,17 +7,17 @@ Export GitRepository sources in YAML format
The export source git command exports on or all GitRepository sources in YAML format.
```
gotk export source git [name] [flags]
flux export source git [name] [flags]
```
### Examples
```
# Export all GitRepository sources
gotk export source git --all > sources.yaml
flux export source git --all > sources.yaml
# Export a GitRepository source including the SSH key pair or basic auth credentials
gotk export source git my-private-repo --with-credentials > source.yaml
flux export source git my-private-repo --with-credentials > source.yaml
```
@@ -40,5 +40,5 @@ gotk export source git [name] [flags]
### SEE ALSO
* [gotk export source](gotk_export_source.md) - Export sources
* [flux export source](flux_export_source.md) - Export sources

View File

@@ -1,4 +1,4 @@
## gotk export source helm
## flux export source helm
Export HelmRepository sources in YAML format
@@ -7,17 +7,17 @@ Export HelmRepository sources in YAML format
The export source git command exports on or all HelmRepository sources in YAML format.
```
gotk export source helm [name] [flags]
flux export source helm [name] [flags]
```
### Examples
```
# Export all HelmRepository sources
gotk export source helm --all > sources.yaml
flux export source helm --all > sources.yaml
# Export a HelmRepository source including the basic auth credentials
gotk export source helm my-private-repo --with-credentials > source.yaml
flux export source helm my-private-repo --with-credentials > source.yaml
```
@@ -40,5 +40,5 @@ gotk export source helm [name] [flags]
### SEE ALSO
* [gotk export source](gotk_export_source.md) - Export sources
* [flux export source](flux_export_source.md) - Export sources

View File

@@ -1,4 +1,4 @@
## gotk get
## flux get
Get sources and resources
@@ -24,11 +24,11 @@ The get sub-commands print the statuses of sources and resources.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk get alert-providers](gotk_get_alert-providers.md) - Get Provider statuses
* [gotk get alerts](gotk_get_alerts.md) - Get Alert statuses
* [gotk get helmreleases](gotk_get_helmreleases.md) - Get HelmRelease statuses
* [gotk get kustomizations](gotk_get_kustomizations.md) - Get Kustomization statuses
* [gotk get receivers](gotk_get_receivers.md) - Get Receiver statuses
* [gotk get sources](gotk_get_sources.md) - Get source statuses
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux get alert-providers](flux_get_alert-providers.md) - Get Provider statuses
* [flux get alerts](flux_get_alerts.md) - Get Alert statuses
* [flux get helmreleases](flux_get_helmreleases.md) - Get HelmRelease statuses
* [flux get kustomizations](flux_get_kustomizations.md) - Get Kustomization statuses
* [flux get receivers](flux_get_receivers.md) - Get Receiver statuses
* [flux get sources](flux_get_sources.md) - Get source statuses

View File

@@ -1,4 +1,4 @@
## gotk get alert-providers
## flux get alert-providers
Get Provider statuses
@@ -7,14 +7,14 @@ Get Provider statuses
The get alert-provider command prints the statuses of the resources.
```
gotk get alert-providers [flags]
flux get alert-providers [flags]
```
### Examples
```
# List all Providers and their status
gotk get alert-providers
flux get alert-providers
```
@@ -36,5 +36,5 @@ gotk get alert-providers [flags]
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources
* [flux get](flux_get.md) - Get sources and resources

View File

@@ -1,4 +1,4 @@
## gotk get alerts
## flux get alerts
Get Alert statuses
@@ -7,14 +7,14 @@ Get Alert statuses
The get alert command prints the statuses of the resources.
```
gotk get alerts [flags]
flux get alerts [flags]
```
### Examples
```
# List all Alerts and their status
gotk get alerts
flux get alerts
```
@@ -36,5 +36,5 @@ gotk get alerts [flags]
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources
* [flux get](flux_get.md) - Get sources and resources

View File

@@ -1,4 +1,4 @@
## gotk get helmreleases
## flux get helmreleases
Get HelmRelease statuses
@@ -7,14 +7,14 @@ Get HelmRelease statuses
The get helmreleases command prints the statuses of the resources.
```
gotk get helmreleases [flags]
flux get helmreleases [flags]
```
### Examples
```
# List all Helm releases and their status
gotk get helmreleases
flux get helmreleases
```
@@ -36,5 +36,5 @@ gotk get helmreleases [flags]
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources
* [flux get](flux_get.md) - Get sources and resources

View File

@@ -1,4 +1,4 @@
## gotk get kustomizations
## flux get kustomizations
Get Kustomization statuses
@@ -7,14 +7,14 @@ Get Kustomization statuses
The get kustomizations command prints the statuses of the resources.
```
gotk get kustomizations [flags]
flux get kustomizations [flags]
```
### Examples
```
# List all kustomizations and their status
gotk get kustomizations
flux get kustomizations
```
@@ -36,5 +36,5 @@ gotk get kustomizations [flags]
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources
* [flux get](flux_get.md) - Get sources and resources

View File

@@ -1,4 +1,4 @@
## gotk get receivers
## flux get receivers
Get Receiver statuses
@@ -7,14 +7,14 @@ Get Receiver statuses
The get receiver command prints the statuses of the resources.
```
gotk get receivers [flags]
flux get receivers [flags]
```
### Examples
```
# List all Receiver and their status
gotk get receivers
flux get receivers
```
@@ -36,5 +36,5 @@ gotk get receivers [flags]
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources
* [flux get](flux_get.md) - Get sources and resources

View File

@@ -1,4 +1,4 @@
## gotk get sources
## flux get sources
Get source statuses
@@ -24,8 +24,8 @@ The get source sub-commands print the statuses of the sources.
### SEE ALSO
* [gotk get](gotk_get.md) - Get sources and resources
* [gotk get sources bucket](gotk_get_sources_bucket.md) - Get Bucket source statuses
* [gotk get sources git](gotk_get_sources_git.md) - Get GitRepository source statuses
* [gotk get sources helm](gotk_get_sources_helm.md) - Get HelmRepository source statuses
* [flux get](flux_get.md) - Get sources and resources
* [flux get sources bucket](flux_get_sources_bucket.md) - Get Bucket source statuses
* [flux get sources git](flux_get_sources_git.md) - Get GitRepository source statuses
* [flux get sources helm](flux_get_sources_helm.md) - Get HelmRepository source statuses

View File

@@ -1,4 +1,4 @@
## gotk get sources bucket
## flux get sources bucket
Get Bucket source statuses
@@ -7,14 +7,14 @@ Get Bucket source statuses
The get sources bucket command prints the status of the Bucket sources.
```
gotk get sources bucket [flags]
flux get sources bucket [flags]
```
### Examples
```
# List all Buckets and their status
gotk get sources bucket
flux get sources bucket
```
@@ -36,5 +36,5 @@ gotk get sources bucket [flags]
### SEE ALSO
* [gotk get sources](gotk_get_sources.md) - Get source statuses
* [flux get sources](flux_get_sources.md) - Get source statuses

View File

@@ -1,4 +1,4 @@
## gotk get sources git
## flux get sources git
Get GitRepository source statuses
@@ -7,14 +7,14 @@ Get GitRepository source statuses
The get sources git command prints the status of the GitRepository sources.
```
gotk get sources git [flags]
flux get sources git [flags]
```
### Examples
```
# List all Git repositories and their status
gotk get sources git
flux get sources git
```
@@ -36,5 +36,5 @@ gotk get sources git [flags]
### SEE ALSO
* [gotk get sources](gotk_get_sources.md) - Get source statuses
* [flux get sources](flux_get_sources.md) - Get source statuses

View File

@@ -1,4 +1,4 @@
## gotk get sources helm
## flux get sources helm
Get HelmRepository source statuses
@@ -7,14 +7,14 @@ Get HelmRepository source statuses
The get sources helm command prints the status of the HelmRepository sources.
```
gotk get sources helm [flags]
flux get sources helm [flags]
```
### Examples
```
# List all Helm repositories and their status
gotk get sources helm
flux get sources helm
```
@@ -36,5 +36,5 @@ gotk get sources helm [flags]
### SEE ALSO
* [gotk get sources](gotk_get_sources.md) - Get source statuses
* [flux get sources](flux_get_sources.md) - Get source statuses

View File

@@ -1,4 +1,4 @@
## gotk install
## flux install
Install the toolkit components
@@ -8,23 +8,23 @@ The install command deploys the toolkit components in the specified namespace.
If a previous version is installed, then an in-place upgrade will be performed.
```
gotk install [flags]
flux install [flags]
```
### Examples
```
# Install the latest version in the flux-system namespace
gotk install --version=latest --namespace=flux-system
flux install --version=latest --namespace=flux-system
# Dry-run install for a specific version and a series of components
gotk install --dry-run --version=v0.0.7 --components="source-controller,kustomize-controller"
flux install --dry-run --version=v0.0.7 --components="source-controller,kustomize-controller"
# Dry-run install with manifests preview
gotk install --dry-run --verbose
flux install --dry-run --verbose
# Write install manifests to file
gotk install --export > flux-system.yaml
flux install --export > flux-system.yaml
```
@@ -55,5 +55,5 @@ gotk install [flags]
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines

View File

@@ -1,4 +1,4 @@
## gotk reconcile
## flux reconcile
Reconcile sources and resources
@@ -23,11 +23,11 @@ The reconcile sub-commands trigger a reconciliation of sources and resources.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk reconcile alert](gotk_reconcile_alert.md) - Reconcile an Alert
* [gotk reconcile alert-provider](gotk_reconcile_alert-provider.md) - Reconcile a Provider
* [gotk reconcile helmrelease](gotk_reconcile_helmrelease.md) - Reconcile a HelmRelease resource
* [gotk reconcile kustomization](gotk_reconcile_kustomization.md) - Reconcile a Kustomization resource
* [gotk reconcile receiver](gotk_reconcile_receiver.md) - Reconcile a Receiver
* [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux reconcile alert](flux_reconcile_alert.md) - Reconcile an Alert
* [flux reconcile alert-provider](flux_reconcile_alert-provider.md) - Reconcile a Provider
* [flux reconcile helmrelease](flux_reconcile_helmrelease.md) - Reconcile a HelmRelease resource
* [flux reconcile kustomization](flux_reconcile_kustomization.md) - Reconcile a Kustomization resource
* [flux reconcile receiver](flux_reconcile_receiver.md) - Reconcile a Receiver
* [flux reconcile source](flux_reconcile_source.md) - Reconcile sources

View File

@@ -1,4 +1,4 @@
## gotk reconcile alert-provider
## flux reconcile alert-provider
Reconcile a Provider
@@ -7,14 +7,14 @@ Reconcile a Provider
The reconcile alert-provider command triggers a reconciliation of a Provider resource and waits for it to finish.
```
gotk reconcile alert-provider [name] [flags]
flux reconcile alert-provider [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing provider
gotk reconcile alert-provider slack
flux reconcile alert-provider slack
```
@@ -35,5 +35,5 @@ gotk reconcile alert-provider [name] [flags]
### SEE ALSO
* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources

View File

@@ -1,4 +1,4 @@
## gotk reconcile alert
## flux reconcile alert
Reconcile an Alert
@@ -7,14 +7,14 @@ Reconcile an Alert
The reconcile alert command triggers a reconciliation of an Alert resource and waits for it to finish.
```
gotk reconcile alert [name] [flags]
flux reconcile alert [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing alert
gotk reconcile alert main
flux reconcile alert main
```
@@ -35,5 +35,5 @@ gotk reconcile alert [name] [flags]
### SEE ALSO
* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources

View File

@@ -1,4 +1,4 @@
## gotk reconcile helmrelease
## flux reconcile helmrelease
Reconcile a HelmRelease resource
@@ -8,17 +8,17 @@ Reconcile a HelmRelease resource
The reconcile kustomization command triggers a reconciliation of a HelmRelease resource and waits for it to finish.
```
gotk reconcile helmrelease [name] [flags]
flux reconcile helmrelease [name] [flags]
```
### Examples
```
# Trigger a HelmRelease apply outside of the reconciliation interval
gotk reconcile hr podinfo
flux reconcile hr podinfo
# Trigger a reconciliation of the HelmRelease's source and apply changes
gotk reconcile hr podinfo --with-source
flux reconcile hr podinfo --with-source
```
@@ -40,5 +40,5 @@ gotk reconcile helmrelease [name] [flags]
### SEE ALSO
* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources

View File

@@ -1,4 +1,4 @@
## gotk reconcile kustomization
## flux reconcile kustomization
Reconcile a Kustomization resource
@@ -8,17 +8,17 @@ Reconcile a Kustomization resource
The reconcile kustomization command triggers a reconciliation of a Kustomization resource and waits for it to finish.
```
gotk reconcile kustomization [name] [flags]
flux reconcile kustomization [name] [flags]
```
### Examples
```
# Trigger a Kustomization apply outside of the reconciliation interval
gotk reconcile kustomization podinfo
flux reconcile kustomization podinfo
# Trigger a sync of the Kustomization's source and apply changes
gotk reconcile kustomization podinfo --with-source
flux reconcile kustomization podinfo --with-source
```
@@ -40,5 +40,5 @@ gotk reconcile kustomization [name] [flags]
### SEE ALSO
* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources

View File

@@ -1,4 +1,4 @@
## gotk reconcile receiver
## flux reconcile receiver
Reconcile a Receiver
@@ -7,14 +7,14 @@ Reconcile a Receiver
The reconcile receiver command triggers a reconciliation of a Receiver resource and waits for it to finish.
```
gotk reconcile receiver [name] [flags]
flux reconcile receiver [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing receiver
gotk reconcile receiver main
flux reconcile receiver main
```
@@ -35,5 +35,5 @@ gotk reconcile receiver [name] [flags]
### SEE ALSO
* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources

View File

@@ -1,4 +1,4 @@
## gotk reconcile source
## flux reconcile source
Reconcile sources
@@ -23,8 +23,8 @@ The reconcile source sub-commands trigger a reconciliation of sources.
### SEE ALSO
* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources
* [gotk reconcile source bucket](gotk_reconcile_source_bucket.md) - Reconcile a Bucket source
* [gotk reconcile source git](gotk_reconcile_source_git.md) - Reconcile a GitRepository source
* [gotk reconcile source helm](gotk_reconcile_source_helm.md) - Reconcile a HelmRepository source
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources
* [flux reconcile source bucket](flux_reconcile_source_bucket.md) - Reconcile a Bucket source
* [flux reconcile source git](flux_reconcile_source_git.md) - Reconcile a GitRepository source
* [flux reconcile source helm](flux_reconcile_source_helm.md) - Reconcile a HelmRepository source

View File

@@ -1,4 +1,4 @@
## gotk reconcile source bucket
## flux reconcile source bucket
Reconcile a Bucket source
@@ -7,14 +7,14 @@ Reconcile a Bucket source
The reconcile source command triggers a reconciliation of a Bucket resource and waits for it to finish.
```
gotk reconcile source bucket [name] [flags]
flux reconcile source bucket [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing source
gotk reconcile source bucket podinfo
flux reconcile source bucket podinfo
```
@@ -35,5 +35,5 @@ gotk reconcile source bucket [name] [flags]
### SEE ALSO
* [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources
* [flux reconcile source](flux_reconcile_source.md) - Reconcile sources

View File

@@ -1,4 +1,4 @@
## gotk reconcile source git
## flux reconcile source git
Reconcile a GitRepository source
@@ -7,14 +7,14 @@ Reconcile a GitRepository source
The reconcile source command triggers a reconciliation of a GitRepository resource and waits for it to finish.
```
gotk reconcile source git [name] [flags]
flux reconcile source git [name] [flags]
```
### Examples
```
# Trigger a git pull for an existing source
gotk reconcile source git podinfo
flux reconcile source git podinfo
```
@@ -35,5 +35,5 @@ gotk reconcile source git [name] [flags]
### SEE ALSO
* [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources
* [flux reconcile source](flux_reconcile_source.md) - Reconcile sources

View File

@@ -1,4 +1,4 @@
## gotk reconcile source helm
## flux reconcile source helm
Reconcile a HelmRepository source
@@ -7,14 +7,14 @@ Reconcile a HelmRepository source
The reconcile source command triggers a reconciliation of a HelmRepository resource and waits for it to finish.
```
gotk reconcile source helm [name] [flags]
flux reconcile source helm [name] [flags]
```
### Examples
```
# Trigger a reconciliation for an existing source
gotk reconcile source helm podinfo
flux reconcile source helm podinfo
```
@@ -35,5 +35,5 @@ gotk reconcile source helm [name] [flags]
### SEE ALSO
* [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources
* [flux reconcile source](flux_reconcile_source.md) - Reconcile sources

View File

@@ -1,4 +1,4 @@
## gotk resume
## flux resume
Resume suspended resources
@@ -23,9 +23,9 @@ The resume sub-commands resume a suspended resource.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk resume alert](gotk_resume_alert.md) - Resume a suspended Alert
* [gotk resume helmrelease](gotk_resume_helmrelease.md) - Resume a suspended HelmRelease
* [gotk resume kustomization](gotk_resume_kustomization.md) - Resume a suspended Kustomization
* [gotk resume receiver](gotk_resume_receiver.md) - Resume a suspended Receiver
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux resume alert](flux_resume_alert.md) - Resume a suspended Alert
* [flux resume helmrelease](flux_resume_helmrelease.md) - Resume a suspended HelmRelease
* [flux resume kustomization](flux_resume_kustomization.md) - Resume a suspended Kustomization
* [flux resume receiver](flux_resume_receiver.md) - Resume a suspended Receiver

View File

@@ -1,4 +1,4 @@
## gotk resume alert
## flux resume alert
Resume a suspended Alert
@@ -8,14 +8,14 @@ The resume command marks a previously suspended Alert resource for reconciliatio
finish the apply.
```
gotk resume alert [name] [flags]
flux resume alert [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Alert
gotk resume alert main
flux resume alert main
```
@@ -36,5 +36,5 @@ gotk resume alert [name] [flags]
### SEE ALSO
* [gotk resume](gotk_resume.md) - Resume suspended resources
* [flux resume](flux_resume.md) - Resume suspended resources

View File

@@ -1,4 +1,4 @@
## gotk resume helmrelease
## flux resume helmrelease
Resume a suspended HelmRelease
@@ -8,14 +8,14 @@ The resume command marks a previously suspended HelmRelease resource for reconci
finish the apply.
```
gotk resume helmrelease [name] [flags]
flux resume helmrelease [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Helm release
gotk resume hr podinfo
flux resume hr podinfo
```
@@ -36,5 +36,5 @@ gotk resume helmrelease [name] [flags]
### SEE ALSO
* [gotk resume](gotk_resume.md) - Resume suspended resources
* [flux resume](flux_resume.md) - Resume suspended resources

View File

@@ -1,4 +1,4 @@
## gotk resume kustomization
## flux resume kustomization
Resume a suspended Kustomization
@@ -8,14 +8,14 @@ The resume command marks a previously suspended Kustomization resource for recon
finish the apply.
```
gotk resume kustomization [name] [flags]
flux resume kustomization [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Kustomization
gotk resume ks podinfo
flux resume ks podinfo
```
@@ -36,5 +36,5 @@ gotk resume kustomization [name] [flags]
### SEE ALSO
* [gotk resume](gotk_resume.md) - Resume suspended resources
* [flux resume](flux_resume.md) - Resume suspended resources

View File

@@ -1,4 +1,4 @@
## gotk resume receiver
## flux resume receiver
Resume a suspended Receiver
@@ -8,14 +8,14 @@ The resume command marks a previously suspended Receiver resource for reconcilia
finish the apply.
```
gotk resume receiver [name] [flags]
flux resume receiver [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing Receiver
gotk resume receiver main
flux resume receiver main
```
@@ -36,5 +36,5 @@ gotk resume receiver [name] [flags]
### SEE ALSO
* [gotk resume](gotk_resume.md) - Resume suspended resources
* [flux resume](flux_resume.md) - Resume suspended resources

View File

@@ -1,4 +1,4 @@
## gotk suspend
## flux suspend
Suspend resources
@@ -23,9 +23,9 @@ The suspend sub-commands suspend the reconciliation of a resource.
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [gotk suspend alert](gotk_suspend_alert.md) - Suspend reconciliation of Alert
* [gotk suspend helmrelease](gotk_suspend_helmrelease.md) - Suspend reconciliation of HelmRelease
* [gotk suspend kustomization](gotk_suspend_kustomization.md) - Suspend reconciliation of Kustomization
* [gotk suspend receiver](gotk_suspend_receiver.md) - Suspend reconciliation of Receiver
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux suspend alert](flux_suspend_alert.md) - Suspend reconciliation of Alert
* [flux suspend helmrelease](flux_suspend_helmrelease.md) - Suspend reconciliation of HelmRelease
* [flux suspend kustomization](flux_suspend_kustomization.md) - Suspend reconciliation of Kustomization
* [flux suspend receiver](flux_suspend_receiver.md) - Suspend reconciliation of Receiver

View File

@@ -1,4 +1,4 @@
## gotk suspend alert
## flux suspend alert
Suspend reconciliation of Alert
@@ -7,14 +7,14 @@ Suspend reconciliation of Alert
The suspend command disables the reconciliation of a Alert resource.
```
gotk suspend alert [name] [flags]
flux suspend alert [name] [flags]
```
### Examples
```
# Suspend reconciliation for an existing Alert
gotk suspend alert main
flux suspend alert main
```
@@ -35,5 +35,5 @@ gotk suspend alert [name] [flags]
### SEE ALSO
* [gotk suspend](gotk_suspend.md) - Suspend resources
* [flux suspend](flux_suspend.md) - Suspend resources

View File

@@ -1,4 +1,4 @@
## gotk suspend helmrelease
## flux suspend helmrelease
Suspend reconciliation of HelmRelease
@@ -7,14 +7,14 @@ Suspend reconciliation of HelmRelease
The suspend command disables the reconciliation of a HelmRelease resource.
```
gotk suspend helmrelease [name] [flags]
flux suspend helmrelease [name] [flags]
```
### Examples
```
# Suspend reconciliation for an existing Helm release
gotk suspend hr podinfo
flux suspend hr podinfo
```
@@ -35,5 +35,5 @@ gotk suspend helmrelease [name] [flags]
### SEE ALSO
* [gotk suspend](gotk_suspend.md) - Suspend resources
* [flux suspend](flux_suspend.md) - Suspend resources

View File

@@ -1,4 +1,4 @@
## gotk suspend kustomization
## flux suspend kustomization
Suspend reconciliation of Kustomization
@@ -7,14 +7,14 @@ Suspend reconciliation of Kustomization
The suspend command disables the reconciliation of a Kustomization resource.
```
gotk suspend kustomization [name] [flags]
flux suspend kustomization [name] [flags]
```
### Examples
```
# Suspend reconciliation for an existing Kustomization
gotk suspend ks podinfo
flux suspend ks podinfo
```
@@ -35,5 +35,5 @@ gotk suspend kustomization [name] [flags]
### SEE ALSO
* [gotk suspend](gotk_suspend.md) - Suspend resources
* [flux suspend](flux_suspend.md) - Suspend resources

View File

@@ -1,4 +1,4 @@
## gotk suspend receiver
## flux suspend receiver
Suspend reconciliation of Receiver
@@ -7,14 +7,14 @@ Suspend reconciliation of Receiver
The suspend command disables the reconciliation of a Receiver resource.
```
gotk suspend receiver [name] [flags]
flux suspend receiver [name] [flags]
```
### Examples
```
# Suspend reconciliation for an existing Receiver
gotk suspend receiver main
flux suspend receiver main
```
@@ -35,5 +35,5 @@ gotk suspend receiver [name] [flags]
### SEE ALSO
* [gotk suspend](gotk_suspend.md) - Suspend resources
* [flux suspend](flux_suspend.md) - Suspend resources

View File

@@ -1,4 +1,4 @@
## gotk uninstall
## flux uninstall
Uninstall the toolkit components
@@ -7,17 +7,17 @@ Uninstall the toolkit components
The uninstall command removes the namespace, cluster roles, cluster role bindings and CRDs from the cluster.
```
gotk uninstall [flags]
flux uninstall [flags]
```
### Examples
```
# Dry-run uninstall of all components
gotk uninstall --dry-run --namespace=flux-system
flux uninstall --dry-run --namespace=flux-system
# Uninstall all components and delete custom resource definitions
gotk uninstall --resources --crds --namespace=flux-system
flux uninstall --resources --crds --namespace=flux-system
```
@@ -42,5 +42,5 @@ gotk uninstall [flags]
### SEE ALSO
* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines

View File

@@ -1,40 +0,0 @@
## gotk get alert-provider
Get Provider statuses
### Synopsis
The get alert-provider command prints the statuses of the resources.
```
gotk get alert-provider [flags]
```
### Examples
```
# List all Providers and their status
gotk get alert-provider
```
### Options
```
-h, --help help for alert-provider
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
-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
* [gotk get](gotk_get.md) - Get sources and resources

View File

@@ -1,40 +0,0 @@
## gotk get alert
Get Alert statuses
### Synopsis
The get alert command prints the statuses of the resources.
```
gotk get alert [flags]
```
### Examples
```
# List all Alerts and their status
gotk get alert
```
### Options
```
-h, --help help for alert
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
-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
* [gotk get](gotk_get.md) - Get sources and resources

View File

@@ -1,40 +0,0 @@
## gotk get receiver
Get Receiver statuses
### Synopsis
The get receiver command prints the statuses of the resources.
```
gotk get receiver [flags]
```
### Examples
```
# List all Receiver and their status
gotk get receiver
```
### Options
```
-h, --help help for receiver
```
### Options inherited from parent commands
```
-A, --all-namespaces list the requested object(s) across all namespaces
--kubeconfig string path to the kubeconfig file (default "~/.kube/config")
-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
* [gotk get](gotk_get.md) - Get sources and resources