Rename gotk binary to flux
Signed-off-by: Hidde Beydals <hello@hidde.co>
This commit is contained in:
Hidde Beydals
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -34,13 +34,13 @@ curl -s https://toolkit.fluxcd.io/install.sh | sudo bash
|
||||
Verify that your dev machine satisfies the prerequisites with:
|
||||
|
||||
```sh
|
||||
gotk check --pre
|
||||
flux check --pre
|
||||
```
|
||||
|
||||
Install the toolkit controllers on the dev cluster:
|
||||
|
||||
```sh
|
||||
gotk install
|
||||
flux install
|
||||
```
|
||||
|
||||
## Clone the sample controller
|
||||
@@ -84,7 +84,7 @@ make run
|
||||
Create a Git source:
|
||||
|
||||
```sh
|
||||
gotk create source git test \
|
||||
flux create source git test \
|
||||
--url=https://github.com/stefanprodan/podinfo \
|
||||
--tag=4.0.0
|
||||
```
|
||||
@@ -100,7 +100,7 @@ Processing files...
|
||||
Change the Git tag:
|
||||
|
||||
```sh
|
||||
gotk create source git test \
|
||||
flux create source git test \
|
||||
--url=https://github.com/stefanprodan/podinfo \
|
||||
--tag=4.0.1
|
||||
```
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
Flux v1 is a monolithic do-it-all operator; the GitOps Toolkit separates the functionalities into specialized controllers.
|
||||
|
||||
Flux v2 will be a curated configuration of the GitOps Toolkit, which you can install and operate simply using the `gotk` command. You can easily pick and choose the functionality you need and extend it to serve your own purposes.
|
||||
Flux v2 will be a curated configuration of the GitOps Toolkit, which you can install and operate simply using the `flux` command. You can easily pick and choose the functionality you need and extend it to serve your own purposes.
|
||||
|
||||
The timeline we are looking at right now is:
|
||||
|
||||
|
||||
@@ -19,30 +19,30 @@ export GITHUB_USER=<your-username>
|
||||
|
||||
## Install the toolkit CLI
|
||||
|
||||
To install the latest `gotk` release on MacOS and Linux using
|
||||
To install the latest `flux` release on MacOS and Linux using
|
||||
[Homebrew](https://brew.sh/) run:
|
||||
|
||||
```sh
|
||||
brew tap fluxcd/tap
|
||||
brew install gotk
|
||||
brew install flux
|
||||
```
|
||||
|
||||
Or install `gotk` by downloading precompiled binaries using a Bash script:
|
||||
Or install `flux` by downloading precompiled binaries using a Bash script:
|
||||
|
||||
```sh
|
||||
curl -s https://toolkit.fluxcd.io/install.sh | sudo bash
|
||||
```
|
||||
|
||||
The install script downloads the gotk binary to `/usr/local/bin`.
|
||||
The install script downloads the flux binary to `/usr/local/bin`.
|
||||
|
||||
Binaries for **macOS**, **Windows** and **Linux** AMD64/ARM are available for download on the
|
||||
[release page](https://github.com/fluxcd/toolkit/releases).
|
||||
|
||||
To configure your shell to load gotk completions add to your Bash profile:
|
||||
To configure your shell to load flux completions add to your Bash profile:
|
||||
|
||||
```sh
|
||||
# ~/.bashrc or ~/.bash_profile
|
||||
. <(gotk completion bash)
|
||||
. <(flux completion bash)
|
||||
```
|
||||
|
||||
`zsh`, `fish`, and `powershell` are also supported with their own sub-commands.
|
||||
@@ -70,7 +70,7 @@ kubectl cluster-info --context kind-staging
|
||||
Verify that your staging cluster satisfies the prerequisites with:
|
||||
|
||||
```console
|
||||
$ gotk check --pre
|
||||
$ flux check --pre
|
||||
► checking prerequisites
|
||||
✔ kubectl 1.18.3 >=1.18.0
|
||||
✔ kubernetes 1.18.2 >=1.16.0
|
||||
@@ -80,7 +80,7 @@ $ gotk check --pre
|
||||
Run the bootstrap command:
|
||||
|
||||
```sh
|
||||
gotk bootstrap github \
|
||||
flux bootstrap github \
|
||||
--owner=$GITHUB_USER \
|
||||
--repository=fleet-infra \
|
||||
--branch=main \
|
||||
@@ -100,7 +100,7 @@ Then it configures the target cluster to synchronize with the specified path ins
|
||||
If you wish to create the repository under a GitHub organization:
|
||||
|
||||
```sh
|
||||
gotk bootstrap github \
|
||||
flux bootstrap github \
|
||||
--owner=<organization> \
|
||||
--repository=<repo-name> \
|
||||
--branch=<organization default branch> \
|
||||
@@ -112,7 +112,7 @@ gotk bootstrap github \
|
||||
Example output:
|
||||
|
||||
```text
|
||||
$ gotk bootstrap github --owner=gitopsrun --repository=fleet-infra --path=staging-cluster --team=devs
|
||||
$ flux bootstrap github --owner=gitopsrun --repository=fleet-infra --path=staging-cluster --team=devs
|
||||
► connecting to github.com
|
||||
✔ repository created
|
||||
✔ devs team access granted
|
||||
@@ -133,14 +133,14 @@ deployment "notification-controller" successfully rolled out
|
||||
✔ bootstrap finished
|
||||
```
|
||||
|
||||
If you prefer GitLab, export `GITLAB_TOKEN` env var and use the command [gotk bootstrap gitlab](../cmd/gotk_bootstrap_gitlab.md).
|
||||
If you prefer GitLab, export `GITLAB_TOKEN` env var and use the command [flux bootstrap gitlab](../cmd/flux_bootstrap_gitlab.md).
|
||||
|
||||
!!! hint "Idempotency"
|
||||
It is safe to run the bootstrap command as many times as you want.
|
||||
If the toolkit components are present on the cluster,
|
||||
the bootstrap command will perform an upgrade if needed.
|
||||
You can target a specific toolkit [version](https://github.com/fluxcd/toolkit/releases)
|
||||
with `gotk bootstrap --version=<semver>`.
|
||||
with `flux bootstrap --version=<semver>`.
|
||||
|
||||
## Staging workflow
|
||||
|
||||
@@ -154,7 +154,7 @@ cd fleet-infra
|
||||
Create a git source pointing to a public repository master branch:
|
||||
|
||||
```sh
|
||||
gotk create source git webapp \
|
||||
flux create source git webapp \
|
||||
--url=https://github.com/stefanprodan/podinfo \
|
||||
--branch=master \
|
||||
--interval=30s \
|
||||
@@ -164,7 +164,7 @@ gotk create source git webapp \
|
||||
Create a kustomization for synchronizing the common manifests on the cluster:
|
||||
|
||||
```sh
|
||||
gotk create kustomization webapp-common \
|
||||
flux create kustomization webapp-common \
|
||||
--source=webapp \
|
||||
--path="./deploy/webapp/common" \
|
||||
--prune=true \
|
||||
@@ -176,7 +176,7 @@ gotk create kustomization webapp-common \
|
||||
Create a kustomization for the backend service that depends on common:
|
||||
|
||||
```sh
|
||||
gotk create kustomization webapp-backend \
|
||||
flux create kustomization webapp-backend \
|
||||
--depends-on=webapp-common \
|
||||
--source=webapp \
|
||||
--path="./deploy/webapp/backend" \
|
||||
@@ -191,7 +191,7 @@ gotk create kustomization webapp-backend \
|
||||
Create a kustomization for the frontend service that depends on backend:
|
||||
|
||||
```sh
|
||||
gotk create kustomization webapp-frontend \
|
||||
flux create kustomization webapp-frontend \
|
||||
--depends-on=webapp-backend \
|
||||
--source=webapp \
|
||||
--path="./deploy/webapp/frontend" \
|
||||
@@ -212,7 +212,7 @@ git add -A && git commit -m "add staging webapp" && git push
|
||||
In about 30s the synchronization should start:
|
||||
|
||||
```console
|
||||
$ watch gotk get kustomizations
|
||||
$ watch flux get kustomizations
|
||||
NAME REVISION SUSPENDED READY MESSAGE
|
||||
flux-system main/6eea299fe9997c8561b826b67950afaf9a476cf8 False True Applied revision: main/6eea299fe9997c8561b826b67950afaf9a476cf8
|
||||
webapp-backend False False dependency 'flux-system/webapp-common' is not ready
|
||||
@@ -243,8 +243,8 @@ were previously applied from that kustomization.
|
||||
|
||||
If you alter the webapp deployment using `kubectl edit`, the changes will be reverted to match
|
||||
the state described in git. When dealing with an incident, you can pause the reconciliation of a
|
||||
kustomization with `gotk suspend kustomization <name>`. Once the debugging session
|
||||
is over, you can re-enable the reconciliation with `gotk resume kustomization <name>`.
|
||||
kustomization with `flux suspend kustomization <name>`. Once the debugging session
|
||||
is over, you can re-enable the reconciliation with `flux resume kustomization <name>`.
|
||||
|
||||
## Production bootstrap
|
||||
|
||||
@@ -261,7 +261,7 @@ kubectl cluster-info --context kind-production
|
||||
Run the bootstrap for the production environment:
|
||||
|
||||
```sh
|
||||
gotk bootstrap github \
|
||||
flux bootstrap github \
|
||||
--owner=$GITHUB_USER \
|
||||
--repository=fleet-infra \
|
||||
--path=prod-cluster \
|
||||
@@ -278,7 +278,7 @@ git pull
|
||||
Create a git source using a semver range to target stable releases:
|
||||
|
||||
```sh
|
||||
gotk create source git webapp \
|
||||
flux create source git webapp \
|
||||
--url=https://github.com/stefanprodan/podinfo \
|
||||
--tag-semver=">=4.0.0 <4.0.2" \
|
||||
--interval=30s \
|
||||
@@ -288,7 +288,7 @@ gotk create source git webapp \
|
||||
Create a kustomization for webapp pointing to the production overlay:
|
||||
|
||||
```sh
|
||||
gotk create kustomization webapp \
|
||||
flux create kustomization webapp \
|
||||
--source=webapp \
|
||||
--path="./deploy/overlays/production" \
|
||||
--prune=true \
|
||||
@@ -309,7 +309,7 @@ git add -A && git commit -m "add prod webapp" && git push
|
||||
List git sources:
|
||||
|
||||
```console
|
||||
$ gotk get sources git
|
||||
$ flux get sources git
|
||||
NAME REVISION READY MESSAGE
|
||||
flux-system main/5ae055e24b2c8a78f981708b61507a97a30bd7a6 True Fetched revision: main/113360052b3153e439a0cf8de76b8e3d2a7bdf27
|
||||
webapp 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27 True Fetched revision: 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27
|
||||
@@ -320,7 +320,7 @@ The kubectl equivalent is `kubectl -n flux-system get gitrepositories`.
|
||||
List kustomization:
|
||||
|
||||
```console
|
||||
$ gotk get kustomizations
|
||||
$ flux get kustomizations
|
||||
NAME REVISION SUSPENDED READY MESSAGE
|
||||
flux-system main/5ae055e24b2c8a78f981708b61507a97a30bd7a6 False True Applied revision: main/5ae055e24b2c8a78f981708b61507a97a30bd7a6
|
||||
webapp 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27 False True Applied revision: 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27
|
||||
@@ -331,7 +331,7 @@ The kubectl equivalent is `kubectl -n flux-system get kustomizations`.
|
||||
If you want to upgrade to the latest 4.x version, you can change the semver expression to:
|
||||
|
||||
```sh
|
||||
gotk create source git webapp \
|
||||
flux create source git webapp \
|
||||
--url=https://github.com/stefanprodan/podinfo \
|
||||
--tag-semver=">=4.0.0 <5.0.0" \
|
||||
--interval=30s \
|
||||
@@ -343,7 +343,7 @@ git add -A && git commit -m "update prod webapp" && git push
|
||||
Trigger a git sync:
|
||||
|
||||
```console
|
||||
$ gotk reconcile ks flux-system --with-source
|
||||
$ flux reconcile ks flux-system --with-source
|
||||
► annotating source flux-system
|
||||
✔ source annotated
|
||||
◎ waiting for reconcilitation
|
||||
@@ -359,7 +359,7 @@ The kubectl equivalent is `kubectl -n flux-system annotate gitrepository/flux-sy
|
||||
Wait for the webapp to be upgraded:
|
||||
|
||||
```console
|
||||
$ watch gotk get kustomizations
|
||||
$ watch flux get kustomizations
|
||||
NAME REVISION SUSPENDED READY MESSAGE
|
||||
flux-system main/d751ea264d48bf0db8b588d1d08184834ac8fec9 False True Applied revision: main/d751ea264d48bf0db8b588d1d08184834ac8fec9
|
||||
webapp 4.0.6/26a630c0b4b3452833d96c511d93f6f2d2e90a99 False True Applied revision: 4.0.6/26a630c0b4b3452833d96c511d93f6f2d2e90a99
|
||||
|
||||
@@ -14,7 +14,7 @@ With Homebrew:
|
||||
|
||||
```sh
|
||||
brew tap fluxcd/tap
|
||||
brew install gotk
|
||||
brew install flux
|
||||
```
|
||||
|
||||
With Bash:
|
||||
@@ -23,7 +23,7 @@ With Bash:
|
||||
curl -s https://toolkit.fluxcd.io/install.sh | sudo bash
|
||||
|
||||
# enable completions in ~/.bash_profile
|
||||
. <(gotk completion bash)
|
||||
. <(flux completion bash)
|
||||
```
|
||||
|
||||
Command-line completion for `zsh`, `fish`, and `powershell`
|
||||
@@ -35,12 +35,12 @@ Binaries for macOS, Windows and Linux AMD64/ARM are available for download on th
|
||||
Verify that your cluster satisfies the prerequisites with:
|
||||
|
||||
```sh
|
||||
gotk check --pre
|
||||
flux check --pre
|
||||
```
|
||||
|
||||
## Bootstrap
|
||||
|
||||
Using the `gotk bootstrap` command you can install the toolkit on a Kubernetes cluster
|
||||
Using the `flux bootstrap` command you can install the toolkit on a Kubernetes cluster
|
||||
and configure it to manage itself from a Git repository.
|
||||
|
||||
The bootstrap creates a Git repository if one doesn't exist and
|
||||
@@ -55,7 +55,7 @@ The bootstrap is idempotent, it's safe to run the command as many times as you w
|
||||
You can choose what components to install and for which cluster with:
|
||||
|
||||
```sh
|
||||
gotk bootstrap <GIT-PROVIDER> \
|
||||
flux bootstrap <GIT-PROVIDER> \
|
||||
--components=source-controller,kustomize-controller,helm-controller,notification-controller \
|
||||
--path=my-cluster \
|
||||
--version=latest
|
||||
@@ -85,7 +85,7 @@ cluster e.g. `staging-cluster` and `production-cluster`:
|
||||
|
||||
!!! hint "Change the default branch"
|
||||
If you wish to change the branch to something else than main, create the repository manually,
|
||||
push a branch to origin and then use `gotk bootstrap <GIT-PROVIDER> --branch=your-branch`.
|
||||
push a branch to origin and then use `flux bootstrap <GIT-PROVIDER> --branch=your-branch`.
|
||||
|
||||
### GitHub and GitHub Enterprise
|
||||
|
||||
@@ -101,7 +101,7 @@ export GITHUB_TOKEN=<your-token>
|
||||
Run the bootstrap for a repository on your personal GitHub account:
|
||||
|
||||
```sh
|
||||
gotk bootstrap github \
|
||||
flux bootstrap github \
|
||||
--owner=my-github-username \
|
||||
--repository=my-repository \
|
||||
--path=my-cluster \
|
||||
@@ -111,7 +111,7 @@ gotk bootstrap github \
|
||||
Run the bootstrap for a repository owned by a GitHub organization:
|
||||
|
||||
```sh
|
||||
gotk bootstrap github \
|
||||
flux bootstrap github \
|
||||
--owner=my-github-organization \
|
||||
--repository=my-repository \
|
||||
--team=team1-slug \
|
||||
@@ -124,7 +124,7 @@ When you specify a list of teams, those teams will be granted maintainer access
|
||||
To run the bootstrap for a repository hosted on GitHub Enterprise, you have to specify your GitHub hostname:
|
||||
|
||||
```sh
|
||||
gotk bootstrap github \
|
||||
flux bootstrap github \
|
||||
--hostname=my-github-enterprise.com \
|
||||
--owner=my-github-organization \
|
||||
--repository=my-repository \
|
||||
@@ -146,7 +146,7 @@ export GITLAB_TOKEN=<your-token>
|
||||
Run the bootstrap for a repository on your personal GitLab account:
|
||||
|
||||
```sh
|
||||
gotk bootstrap gitlab \
|
||||
flux bootstrap gitlab \
|
||||
--owner=my-gitlab-username \
|
||||
--repository=my-repository \
|
||||
--branch=master \
|
||||
@@ -157,7 +157,7 @@ gotk bootstrap gitlab \
|
||||
To run the bootstrap for a repository using deploy keys for authentication, you have to specify the SSH hostname:
|
||||
|
||||
```sh
|
||||
gotk bootstrap gitlab \
|
||||
flux bootstrap gitlab \
|
||||
--ssh-hostname=gitlab.com \
|
||||
--owner=my-gitlab-username \
|
||||
--repository=my-repository \
|
||||
@@ -173,7 +173,7 @@ gotk bootstrap gitlab \
|
||||
Run the bootstrap for a repository owned by a GitLab group:
|
||||
|
||||
```sh
|
||||
gotk bootstrap gitlab \
|
||||
flux bootstrap gitlab \
|
||||
--owner=my-gitlab-group \
|
||||
--repository=my-repository \
|
||||
--branch=master \
|
||||
@@ -183,7 +183,7 @@ gotk bootstrap gitlab \
|
||||
To run the bootstrap for a repository hosted on GitLab on-prem or enterprise, you have to specify your GitLab hostname:
|
||||
|
||||
```sh
|
||||
gotk bootstrap gitlab \
|
||||
flux bootstrap gitlab \
|
||||
--hostname=my-gitlab.com \
|
||||
--owner=my-gitlab-group \
|
||||
--repository=my-repository \
|
||||
@@ -211,7 +211,7 @@ mkdir -p ./my-cluster/flux-system
|
||||
Generate the toolkit manifests with:
|
||||
|
||||
```sh
|
||||
gotk install --version=latest \
|
||||
flux install --version=latest \
|
||||
--arch=amd64 \ # on ARM64/AARCH64 clusters use --arch=arm64
|
||||
--export > ./my-cluster/flux-system/toolkit-components.yaml
|
||||
```
|
||||
@@ -238,7 +238,7 @@ kubectl -n flux-system create secret generic regcred \
|
||||
Set your registry domain, and the pull secret when generating the manifests:
|
||||
|
||||
```sh
|
||||
gotk install --version=latest \
|
||||
flux install --version=latest \
|
||||
--registry=registry.internal/fluxcd \
|
||||
--image-pull-secret=regcred \
|
||||
--export > ./my-cluster/flux-system/toolkit-components.yaml
|
||||
@@ -259,13 +259,13 @@ kubectl apply -f ./my-cluster/flux-system/toolkit-components.yaml
|
||||
Verify that the toolkit controllers have started:
|
||||
|
||||
```sh
|
||||
gotk check
|
||||
flux check
|
||||
```
|
||||
|
||||
Create a `GitRepository` object on your cluster by specifying the SSH address of your repo:
|
||||
|
||||
```sh
|
||||
gotk create source git flux-system \
|
||||
flux create source git flux-system \
|
||||
--url= ssh://<host>/<org>/my-repository \
|
||||
--ssh-key-algorithm=ecdsa \
|
||||
--ssh-ecdsa-curve=p521 \
|
||||
@@ -274,12 +274,12 @@ gotk create source git flux-system \
|
||||
```
|
||||
|
||||
You will be prompted to add a deploy key to your repository.
|
||||
If you don't specify the SSH algorithm, then gotk will generate an RSA 2048 bits key.
|
||||
If you don't specify the SSH algorithm, then flux will generate an RSA 2048 bits key.
|
||||
|
||||
If your Git server supports basic auth, you can set the URL to HTTPS and specify the credentials with:
|
||||
|
||||
```sh
|
||||
gotk create source git flux-system \
|
||||
flux create source git flux-system \
|
||||
--url=https://<host>/<org>/my-repository \
|
||||
--username=my-username \
|
||||
--password=my-password \
|
||||
@@ -290,7 +290,7 @@ gotk create source git flux-system \
|
||||
Create a `Kustomization` object on your cluster:
|
||||
|
||||
```sh
|
||||
gotk create kustomization flux-system \
|
||||
flux create kustomization flux-system \
|
||||
--source=flux-system \
|
||||
--path="./my-cluster" \
|
||||
--prune=true \
|
||||
@@ -300,10 +300,10 @@ gotk create kustomization flux-system \
|
||||
Export both objects, commit and push the manifests to Git:
|
||||
|
||||
```sh
|
||||
gotk export source git flux-system \
|
||||
flux export source git flux-system \
|
||||
> ./my-cluster/flux-system/toolkit-source.yaml
|
||||
|
||||
gotk export kustomization flux-system \
|
||||
flux export kustomization flux-system \
|
||||
> ./my-cluster/flux-system/toolkit-kustomization.yaml
|
||||
|
||||
git add -A && git commit -m "add toolkit reconciliation" && git push
|
||||
@@ -312,7 +312,7 @@ git add -A && git commit -m "add toolkit reconciliation" && git push
|
||||
To upgrade the toolkit to a newer version, run the install command and commit the changes:
|
||||
|
||||
```sh
|
||||
gotk install --version=latest \
|
||||
flux install --version=latest \
|
||||
--export > ./my-cluster/flux-system/toolkit-components.yaml
|
||||
|
||||
git add -A && git commit -m "update toolkit" && git push
|
||||
@@ -328,19 +328,19 @@ For testing purposes you can install the toolkit without storing its manifests i
|
||||
Here is the equivalent to `fluxctl install`:
|
||||
|
||||
```sh
|
||||
gotk install \
|
||||
flux install \
|
||||
--components=source-controller,kustomize-controller
|
||||
```
|
||||
|
||||
Then you can register Git repositories and reconcile them on your cluster:
|
||||
|
||||
```sh
|
||||
gotk create source git podinfo \
|
||||
flux create source git podinfo \
|
||||
--url=https://github.com/stefanprodan/podinfo \
|
||||
--tag-semver=">=4.0.0" \
|
||||
--interval=1m
|
||||
|
||||
gotk create kustomization podinfo-default \
|
||||
flux create kustomization podinfo-default \
|
||||
--source=podinfo \
|
||||
--path="./kustomize" \
|
||||
--prune=true \
|
||||
@@ -353,18 +353,18 @@ gotk create kustomization podinfo-default \
|
||||
Here is the equivalent to `helm install helm-operator`:
|
||||
|
||||
```sh
|
||||
gotk install \
|
||||
flux install \
|
||||
--components=source-controller,kustomize-controller,helm-controller
|
||||
```
|
||||
|
||||
Then you can register Helm repositories and create Helm releases:
|
||||
|
||||
```sh
|
||||
gotk create source helm stable \
|
||||
flux create source helm stable \
|
||||
--interval=1h \
|
||||
--url=https://charts.helm.sh/stable
|
||||
|
||||
gotk create helmrelease sealed-secrets \
|
||||
flux create helmrelease sealed-secrets \
|
||||
--interval=1h \
|
||||
--release-name=sealed-secrets \
|
||||
--target-namespace=flux-system \
|
||||
@@ -385,7 +385,7 @@ To install the monitoring stack please follow this [guide](monitoring.md).
|
||||
You can uninstall the toolkit components with:
|
||||
|
||||
```sh
|
||||
gotk uninstall --crds
|
||||
flux uninstall --crds
|
||||
```
|
||||
|
||||
The above command will delete the toolkit custom resources definitions, the controllers
|
||||
|
||||
@@ -9,10 +9,10 @@ The toolkit comes with a monitoring stack composed of:
|
||||
|
||||
## Install the monitoring stack
|
||||
|
||||
To install the monitoring stack with `gotk`, first register the toolkit Git repository on your cluster:
|
||||
To install the monitoring stack with `flux`, first register the toolkit Git repository on your cluster:
|
||||
|
||||
```sh
|
||||
gotk create source git monitoring \
|
||||
flux create source git monitoring \
|
||||
--interval=30m \
|
||||
--url=https://github.com/fluxcd/toolkit \
|
||||
--branch=main
|
||||
@@ -22,7 +22,7 @@ Then apply the [manifests/monitoring](https://github.com/fluxcd/toolkit/tree/mai
|
||||
kustomization:
|
||||
|
||||
```sh
|
||||
gotk create kustomization monitoring \
|
||||
flux create kustomization monitoring \
|
||||
--interval=1h \
|
||||
--prune=true \
|
||||
--source=monitoring \
|
||||
|
||||
@@ -83,14 +83,14 @@ You can now commit the encrypted secret to your Git repository.
|
||||
Registry the Git repository on your cluster:
|
||||
|
||||
```sh
|
||||
gotk create source git my-secrets \
|
||||
flux create source git my-secrets \
|
||||
--url=https://github.com/my-org/my-secrets
|
||||
```
|
||||
|
||||
Create a kustomization for reconciling the secrets on the cluster:
|
||||
|
||||
```sh
|
||||
gotk create kustomization my-secrets \
|
||||
flux create kustomization my-secrets \
|
||||
--source=my-secrets \
|
||||
--prune=true \
|
||||
--interval=10m \
|
||||
@@ -147,7 +147,7 @@ spec:
|
||||
```
|
||||
|
||||
!!! hint
|
||||
You can generate the above manifests using `gotk create <kind> --export > manifest.yaml`.
|
||||
You can generate the above manifests using `flux create <kind> --export > manifest.yaml`.
|
||||
|
||||
Assuming a team member wants to deploy an application that needs to connect
|
||||
to a database using a username and password, they'll be doing the following:
|
||||
|
||||
@@ -34,7 +34,7 @@ the sealed-secrets controller from its [Helm chart](https://hub.kubeapps.com/cha
|
||||
First you have to register the Helm repository where the sealed-secrets chart is published:
|
||||
|
||||
```sh
|
||||
gotk create source helm stable \
|
||||
flux create source helm stable \
|
||||
--interval=1h \
|
||||
--url=https://charts.helm.sh/stable
|
||||
```
|
||||
@@ -46,7 +46,7 @@ source-controller will signal helm-controller that a new chart is available.
|
||||
Create a Helm release that installs the latest version of sealed-secrets controller:
|
||||
|
||||
```sh
|
||||
gotk create helmrelease sealed-secrets \
|
||||
flux create helmrelease sealed-secrets \
|
||||
--interval=1h \
|
||||
--release-name=sealed-secrets \
|
||||
--target-namespace=flux-system \
|
||||
@@ -148,7 +148,7 @@ spec:
|
||||
```
|
||||
|
||||
!!! hint
|
||||
You can generate the above manifests using `gotk create <kind> --export > manifest.yaml`.
|
||||
You can generate the above manifests using `flux create <kind> --export > manifest.yaml`.
|
||||
|
||||
Once the sealed-secrets controller is installed, the admin fetches the
|
||||
public key and shares it with the teams that operate on the fleet clusters via Git.
|
||||
|
||||
@@ -53,7 +53,7 @@ Components:
|
||||
## Get Started
|
||||
|
||||
!!!hint "Get started with the GitOps Toolkit!"
|
||||
Following this [guide](get-started/index.md) will just take a couple of minutes to complete: After installing the `gotk` binary and running a couple of very simple commands, you will have a GitOps workflow setup which involves a staging and a production cluster.
|
||||
Following this [guide](get-started/index.md) will just take a couple of minutes to complete: After installing the `flux` binary and running a couple of very simple commands, you will have a GitOps workflow setup which involves a staging and a production cluster.
|
||||
|
||||
## Community
|
||||
|
||||
|
||||
Reference in New Issue
Block a user