From e2752e450864f92b9899bcc844f43af085bd263f Mon Sep 17 00:00:00 2001
From: Hidde Beydals <hello@hidde.co>
Date: Thu, 29 Oct 2020 14:37:07 +0100
Subject: [PATCH] Rename `gotk` binary to `flux`
Signed-off-by: Hidde Beydals <hello@hidde.co>
---
.github/workflows/bootstrap.yaml | 22 +--
.github/workflows/docs.yaml | 2 +-
.github/workflows/e2e.yaml | 114 ++++++++--------
.goreleaser.yml | 10 +-
Makefile | 10 +-
README.md | 10 +-
cmd/{gotk => flux}/bootstrap.go | 0
cmd/{gotk => flux}/bootstrap_github.go | 18 +--
cmd/{gotk => flux}/bootstrap_gitlab.go | 18 +--
cmd/{gotk => flux}/check.go | 4 +-
cmd/{gotk => flux}/completion.go | 0
cmd/{gotk => flux}/completion_bash.go | 4 +-
cmd/{gotk => flux}/completion_fish.go | 4 +-
cmd/{gotk => flux}/completion_powershell.go | 6 +-
cmd/{gotk => flux}/completion_zsh.go | 10 +-
cmd/{gotk => flux}/create.go | 0
cmd/{gotk => flux}/create_alert.go | 2 +-
cmd/{gotk => flux}/create_alertprovider.go | 4 +-
cmd/{gotk => flux}/create_helmrelease.go | 14 +-
cmd/{gotk => flux}/create_kustomization.go | 6 +-
cmd/{gotk => flux}/create_receiver.go | 2 +-
cmd/{gotk => flux}/create_source.go | 0
cmd/{gotk => flux}/create_source_bucket.go | 4 +-
cmd/{gotk => flux}/create_source_git.go | 12 +-
cmd/{gotk => flux}/create_source_helm.go | 6 +-
cmd/{gotk => flux}/create_tenant.go | 4 +-
cmd/{gotk => flux}/delete.go | 0
cmd/{gotk => flux}/delete_alert.go | 2 +-
cmd/{gotk => flux}/delete_alertprovider.go | 2 +-
cmd/{gotk => flux}/delete_helmrelease.go | 2 +-
cmd/{gotk => flux}/delete_kustomization.go | 2 +-
cmd/{gotk => flux}/delete_receiver.go | 2 +-
cmd/{gotk => flux}/delete_source.go | 0
cmd/{gotk => flux}/delete_source_bucket.go | 2 +-
cmd/{gotk => flux}/delete_source_git.go | 2 +-
cmd/{gotk => flux}/delete_source_helm.go | 2 +-
cmd/{gotk => flux}/export.go | 0
cmd/{gotk => flux}/export_alert.go | 4 +-
cmd/{gotk => flux}/export_alertprovider.go | 4 +-
cmd/{gotk => flux}/export_helmrelease.go | 4 +-
cmd/{gotk => flux}/export_kustomization.go | 4 +-
cmd/{gotk => flux}/export_receiver.go | 4 +-
cmd/{gotk => flux}/export_source.go | 0
cmd/{gotk => flux}/export_source_bucket.go | 4 +-
cmd/{gotk => flux}/export_source_git.go | 4 +-
cmd/{gotk => flux}/export_source_helm.go | 4 +-
cmd/{gotk => flux}/get.go | 0
cmd/{gotk => flux}/get_alert.go | 2 +-
cmd/{gotk => flux}/get_alertprovider.go | 2 +-
cmd/{gotk => flux}/get_helmrelease.go | 2 +-
cmd/{gotk => flux}/get_kustomization.go | 2 +-
cmd/{gotk => flux}/get_receiver.go | 2 +-
cmd/{gotk => flux}/get_source.go | 0
cmd/{gotk => flux}/get_source_bucket.go | 2 +-
cmd/{gotk => flux}/get_source_git.go | 2 +-
cmd/{gotk => flux}/get_source_helm.go | 2 +-
cmd/{gotk => flux}/install.go | 8 +-
cmd/{gotk => flux}/log.go | 0
cmd/{gotk => flux}/main.go | 34 ++---
cmd/{gotk => flux}/reconcile.go | 0
cmd/{gotk => flux}/reconcile_alert.go | 2 +-
cmd/{gotk => flux}/reconcile_alertprovider.go | 2 +-
cmd/{gotk => flux}/reconcile_helmrelease.go | 4 +-
cmd/{gotk => flux}/reconcile_kustomization.go | 4 +-
cmd/{gotk => flux}/reconcile_receiver.go | 2 +-
cmd/{gotk => flux}/reconcile_source.go | 0
cmd/{gotk => flux}/reconcile_source_bucket.go | 2 +-
cmd/{gotk => flux}/reconcile_source_git.go | 2 +-
cmd/{gotk => flux}/reconcile_source_helm.go | 2 +-
cmd/{gotk => flux}/resume.go | 0
cmd/{gotk => flux}/resume_alert.go | 2 +-
cmd/{gotk => flux}/resume_helmrelease.go | 2 +-
cmd/{gotk => flux}/resume_kustomization.go | 2 +-
cmd/{gotk => flux}/resume_receiver.go | 2 +-
cmd/{gotk => flux}/suspend.go | 0
cmd/{gotk => flux}/suspend_alert.go | 2 +-
cmd/{gotk => flux}/suspend_helmrelease.go | 2 +-
cmd/{gotk => flux}/suspend_kustomization.go | 2 +-
cmd/{gotk => flux}/suspend_receiver.go | 2 +-
cmd/{gotk => flux}/uninstall.go | 4 +-
docs/cmd/{gotk.md => flux.md} | 56 ++++----
.../{gotk_bootstrap.md => flux_bootstrap.md} | 8 +-
...rap_github.md => flux_bootstrap_github.md} | 18 +--
...rap_gitlab.md => flux_bootstrap_gitlab.md} | 18 +--
docs/cmd/{gotk_check.md => flux_check.md} | 10 +-
...{gotk_completion.md => flux_completion.md} | 12 +-
...letion_bash.md => flux_completion_bash.md} | 10 +-
...letion_fish.md => flux_completion_fish.md} | 10 +-
...shell.md => flux_completion_powershell.md} | 12 +-
...mpletion_zsh.md => flux_completion_zsh.md} | 16 +--
docs/cmd/{gotk_create.md => flux_create.md} | 16 +--
...vider.md => flux_create_alert-provider.md} | 10 +-
...k_create_alert.md => flux_create_alert.md} | 8 +-
...mrelease.md => flux_create_helmrelease.md} | 20 +--
...zation.md => flux_create_kustomization.md} | 12 +-
...te_receiver.md => flux_create_receiver.md} | 8 +-
...create_source.md => flux_create_source.md} | 10 +-
...bucket.md => flux_create_source_bucket.md} | 10 +-
...ource_git.md => flux_create_source_git.md} | 18 +--
...rce_helm.md => flux_create_source_helm.md} | 12 +-
docs/cmd/{gotk_delete.md => flux_delete.md} | 16 +--
...vider.md => flux_delete_alert-provider.md} | 8 +-
...k_delete_alert.md => flux_delete_alert.md} | 8 +-
...mrelease.md => flux_delete_helmrelease.md} | 8 +-
...zation.md => flux_delete_kustomization.md} | 8 +-
...te_receiver.md => flux_delete_receiver.md} | 8 +-
...delete_source.md => flux_delete_source.md} | 10 +-
...bucket.md => flux_delete_source_bucket.md} | 8 +-
...ource_git.md => flux_delete_source_git.md} | 8 +-
...rce_helm.md => flux_delete_source_helm.md} | 8 +-
docs/cmd/{gotk_export.md => flux_export.md} | 16 +--
...vider.md => flux_export_alert-provider.md} | 10 +-
...k_export_alert.md => flux_export_alert.md} | 10 +-
...mrelease.md => flux_export_helmrelease.md} | 10 +-
...zation.md => flux_export_kustomization.md} | 10 +-
...rt_receiver.md => flux_export_receiver.md} | 10 +-
...export_source.md => flux_export_source.md} | 10 +-
...bucket.md => flux_export_source_bucket.md} | 10 +-
...ource_git.md => flux_export_source_git.md} | 10 +-
...rce_helm.md => flux_export_source_helm.md} | 10 +-
docs/cmd/{gotk_get.md => flux_get.md} | 16 +--
...oviders.md => flux_get_alert-providers.md} | 8 +-
...{gotk_get_alerts.md => flux_get_alerts.md} | 8 +-
...lmreleases.md => flux_get_helmreleases.md} | 8 +-
...izations.md => flux_get_kustomizations.md} | 8 +-
...get_receivers.md => flux_get_receivers.md} | 8 +-
...otk_get_sources.md => flux_get_sources.md} | 10 +-
...s_bucket.md => flux_get_sources_bucket.md} | 8 +-
...sources_git.md => flux_get_sources_git.md} | 8 +-
...urces_helm.md => flux_get_sources_helm.md} | 8 +-
docs/cmd/{gotk_install.md => flux_install.md} | 14 +-
.../{gotk_reconcile.md => flux_reconcile.md} | 16 +--
...er.md => flux_reconcile_alert-provider.md} | 8 +-
...ncile_alert.md => flux_reconcile_alert.md} | 8 +-
...lease.md => flux_reconcile_helmrelease.md} | 10 +-
...ion.md => flux_reconcile_kustomization.md} | 10 +-
...receiver.md => flux_reconcile_receiver.md} | 8 +-
...ile_source.md => flux_reconcile_source.md} | 10 +-
...ket.md => flux_reconcile_source_bucket.md} | 8 +-
...ce_git.md => flux_reconcile_source_git.md} | 8 +-
..._helm.md => flux_reconcile_source_helm.md} | 8 +-
docs/cmd/{gotk_resume.md => flux_resume.md} | 12 +-
...k_resume_alert.md => flux_resume_alert.md} | 8 +-
...mrelease.md => flux_resume_helmrelease.md} | 8 +-
...zation.md => flux_resume_kustomization.md} | 8 +-
...me_receiver.md => flux_resume_receiver.md} | 8 +-
docs/cmd/{gotk_suspend.md => flux_suspend.md} | 12 +-
...suspend_alert.md => flux_suspend_alert.md} | 8 +-
...release.md => flux_suspend_helmrelease.md} | 8 +-
...ation.md => flux_suspend_kustomization.md} | 8 +-
...d_receiver.md => flux_suspend_receiver.md} | 8 +-
.../{gotk_uninstall.md => flux_uninstall.md} | 10 +-
docs/cmd/gotk_get_alert-provider.md | 40 ------
docs/cmd/gotk_get_alert.md | 40 ------
docs/cmd/gotk_get_receiver.md | 40 ------
docs/dev-guides/source-watcher.md | 8 +-
docs/faq/index.md | 2 +-
docs/get-started/index.md | 54 ++++----
docs/guides/installation.md | 60 ++++----
docs/guides/monitoring.md | 6 +-
docs/guides/mozilla-sops.md | 6 +-
docs/guides/sealed-secrets.md | 6 +-
docs/index.md | 2 +-
install/README.md | 14 +-
install/{gotk.sh => flux.sh} | 24 ++--
mkdocs.yml | 128 +++++++++---------
pkg/manifestgen/doc.go | 4 +-
pkg/manifestgen/sync/options.go | 2 +-
168 files changed, 767 insertions(+), 887 deletions(-)
rename cmd/{gotk => flux}/bootstrap.go (100%)
rename cmd/{gotk => flux}/bootstrap_github.go (93%)
rename cmd/{gotk => flux}/bootstrap_gitlab.go (93%)
rename cmd/{gotk => flux}/check.go (99%)
rename cmd/{gotk => flux}/completion.go (100%)
rename cmd/{gotk => flux}/completion_bash.go (92%)
rename cmd/{gotk => flux}/completion_fish.go (93%)
rename cmd/{gotk => flux}/completion_powershell.go (91%)
rename cmd/{gotk => flux}/completion_zsh.go (81%)
rename cmd/{gotk => flux}/create.go (100%)
rename cmd/{gotk => flux}/create_alert.go (99%)
rename cmd/{gotk => flux}/create_alertprovider.go (98%)
rename cmd/{gotk => flux}/create_helmrelease.go (97%)
rename cmd/{gotk => flux}/create_kustomization.go (98%)
rename cmd/{gotk => flux}/create_receiver.go (99%)
rename cmd/{gotk => flux}/create_source.go (100%)
rename cmd/{gotk => flux}/create_source_bucket.go (98%)
rename cmd/{gotk => flux}/create_source_git.go (98%)
rename cmd/{gotk => flux}/create_source_helm.go (98%)
rename cmd/{gotk => flux}/create_tenant.go (99%)
rename cmd/{gotk => flux}/delete.go (100%)
rename cmd/{gotk => flux}/delete_alert.go (98%)
rename cmd/{gotk => flux}/delete_alertprovider.go (98%)
rename cmd/{gotk => flux}/delete_helmrelease.go (98%)
rename cmd/{gotk => flux}/delete_kustomization.go (98%)
rename cmd/{gotk => flux}/delete_receiver.go (98%)
rename cmd/{gotk => flux}/delete_source.go (100%)
rename cmd/{gotk => flux}/delete_source_bucket.go (98%)
rename cmd/{gotk => flux}/delete_source_git.go (98%)
rename cmd/{gotk => flux}/delete_source_helm.go (98%)
rename cmd/{gotk => flux}/export.go (100%)
rename cmd/{gotk => flux}/export_alert.go (97%)
rename cmd/{gotk => flux}/export_alertprovider.go (96%)
rename cmd/{gotk => flux}/export_helmrelease.go (96%)
rename cmd/{gotk => flux}/export_kustomization.go (96%)
rename cmd/{gotk => flux}/export_receiver.go (97%)
rename cmd/{gotk => flux}/export_source.go (100%)
rename cmd/{gotk => flux}/export_source_bucket.go (97%)
rename cmd/{gotk => flux}/export_source_git.go (97%)
rename cmd/{gotk => flux}/export_source_helm.go (97%)
rename cmd/{gotk => flux}/get.go (100%)
rename cmd/{gotk => flux}/get_alert.go (99%)
rename cmd/{gotk => flux}/get_alertprovider.go (98%)
rename cmd/{gotk => flux}/get_helmrelease.go (99%)
rename cmd/{gotk => flux}/get_kustomization.go (99%)
rename cmd/{gotk => flux}/get_receiver.go (99%)
rename cmd/{gotk => flux}/get_source.go (100%)
rename cmd/{gotk => flux}/get_source_bucket.go (98%)
rename cmd/{gotk => flux}/get_source_git.go (99%)
rename cmd/{gotk => flux}/get_source_helm.go (99%)
rename cmd/{gotk => flux}/install.go (96%)
rename cmd/{gotk => flux}/log.go (100%)
rename cmd/{gotk => flux}/main.go (85%)
rename cmd/{gotk => flux}/reconcile.go (100%)
rename cmd/{gotk => flux}/reconcile_alert.go (98%)
rename cmd/{gotk => flux}/reconcile_alertprovider.go (98%)
rename cmd/{gotk => flux}/reconcile_helmrelease.go (98%)
rename cmd/{gotk => flux}/reconcile_kustomization.go (98%)
rename cmd/{gotk => flux}/reconcile_receiver.go (98%)
rename cmd/{gotk => flux}/reconcile_source.go (100%)
rename cmd/{gotk => flux}/reconcile_source_bucket.go (98%)
rename cmd/{gotk => flux}/reconcile_source_git.go (98%)
rename cmd/{gotk => flux}/reconcile_source_helm.go (99%)
rename cmd/{gotk => flux}/resume.go (100%)
rename cmd/{gotk => flux}/resume_alert.go (99%)
rename cmd/{gotk => flux}/resume_helmrelease.go (99%)
rename cmd/{gotk => flux}/resume_kustomization.go (99%)
rename cmd/{gotk => flux}/resume_receiver.go (99%)
rename cmd/{gotk => flux}/suspend.go (100%)
rename cmd/{gotk => flux}/suspend_alert.go (98%)
rename cmd/{gotk => flux}/suspend_helmrelease.go (98%)
rename cmd/{gotk => flux}/suspend_kustomization.go (98%)
rename cmd/{gotk => flux}/suspend_receiver.go (98%)
rename cmd/{gotk => flux}/uninstall.go (97%)
rename docs/cmd/{gotk.md => flux.md} (54%)
rename docs/cmd/{gotk_bootstrap.md => flux_bootstrap.md} (89%)
rename docs/cmd/{gotk_bootstrap_github.md => flux_bootstrap_github.md} (86%)
rename docs/cmd/{gotk_bootstrap_gitlab.md => flux_bootstrap_gitlab.md} (86%)
rename docs/cmd/{gotk_check.md => flux_check.md} (88%)
rename docs/cmd/{gotk_completion.md => flux_completion.md} (66%)
rename docs/cmd/{gotk_completion_bash.md => flux_completion_bash.md} (77%)
rename docs/cmd/{gotk_completion_fish.md => flux_completion_fish.md} (79%)
rename docs/cmd/{gotk_completion_powershell.md => flux_completion_powershell.md} (77%)
rename docs/cmd/{gotk_completion_zsh.md => flux_completion_zsh.md} (68%)
rename docs/cmd/{gotk_create.md => flux_create.md} (67%)
rename docs/cmd/{gotk_create_alert-provider.md => flux_create_alert-provider.md} (87%)
rename docs/cmd/{gotk_create_alert.md => flux_create_alert.md} (89%)
rename docs/cmd/{gotk_create_helmrelease.md => flux_create_helmrelease.md} (89%)
rename docs/cmd/{gotk_create_kustomization.md => flux_create_kustomization.md} (92%)
rename docs/cmd/{gotk_create_receiver.md => flux_create_receiver.md} (87%)
rename docs/cmd/{gotk_create_source.md => flux_create_source.md} (75%)
rename docs/cmd/{gotk_create_source_bucket.md => flux_create_source_bucket.md} (90%)
rename docs/cmd/{gotk_create_source_git.md => flux_create_source_git.md} (89%)
rename docs/cmd/{gotk_create_source_helm.md => flux_create_source_helm.md} (89%)
rename docs/cmd/{gotk_delete.md => flux_delete.md} (60%)
rename docs/cmd/{gotk_delete_alert-provider.md => flux_delete_alert-provider.md} (80%)
rename docs/cmd/{gotk_delete_alert.md => flux_delete_alert.md} (82%)
rename docs/cmd/{gotk_delete_helmrelease.md => flux_delete_helmrelease.md} (82%)
rename docs/cmd/{gotk_delete_kustomization.md => flux_delete_kustomization.md} (81%)
rename docs/cmd/{gotk_delete_receiver.md => flux_delete_receiver.md} (82%)
rename docs/cmd/{gotk_delete_source.md => flux_delete_source.md} (69%)
rename docs/cmd/{gotk_delete_source_bucket.md => flux_delete_source_bucket.md} (79%)
rename docs/cmd/{gotk_delete_source_git.md => flux_delete_source_git.md} (80%)
rename docs/cmd/{gotk_delete_source_helm.md => flux_delete_source_helm.md} (80%)
rename docs/cmd/{gotk_export.md => flux_export.md} (61%)
rename docs/cmd/{gotk_export_alert-provider.md => flux_export_alert-provider.md} (74%)
rename docs/cmd/{gotk_export_alert.md => flux_export_alert.md} (77%)
rename docs/cmd/{gotk_export_helmrelease.md => flux_export_helmrelease.md} (76%)
rename docs/cmd/{gotk_export_kustomization.md => flux_export_kustomization.md} (74%)
rename docs/cmd/{gotk_export_receiver.md => flux_export_receiver.md} (76%)
rename docs/cmd/{gotk_export_source.md => flux_export_source.md} (72%)
rename docs/cmd/{gotk_export_source_bucket.md => flux_export_source_bucket.md} (76%)
rename docs/cmd/{gotk_export_source_git.md => flux_export_source_git.md} (77%)
rename docs/cmd/{gotk_export_source_helm.md => flux_export_source_helm.md} (77%)
rename docs/cmd/{gotk_get.md => flux_get.md} (60%)
rename docs/cmd/{gotk_get_alert-providers.md => flux_get_alert-providers.md} (82%)
rename docs/cmd/{gotk_get_alerts.md => flux_get_alerts.md} (85%)
rename docs/cmd/{gotk_get_helmreleases.md => flux_get_helmreleases.md} (83%)
rename docs/cmd/{gotk_get_kustomizations.md => flux_get_kustomizations.md} (83%)
rename docs/cmd/{gotk_get_receivers.md => flux_get_receivers.md} (84%)
rename docs/cmd/{gotk_get_sources.md => flux_get_sources.md} (71%)
rename docs/cmd/{gotk_get_sources_bucket.md => flux_get_sources_bucket.md} (82%)
rename docs/cmd/{gotk_get_sources_git.md => flux_get_sources_git.md} (83%)
rename docs/cmd/{gotk_get_sources_helm.md => flux_get_sources_helm.md} (83%)
rename docs/cmd/{gotk_install.md => flux_install.md} (87%)
rename docs/cmd/{gotk_reconcile.md => flux_reconcile.md} (60%)
rename docs/cmd/{gotk_reconcile_alert-provider.md => flux_reconcile_alert-provider.md} (78%)
rename docs/cmd/{gotk_reconcile_alert.md => flux_reconcile_alert.md} (81%)
rename docs/cmd/{gotk_reconcile_helmrelease.md => flux_reconcile_helmrelease.md} (80%)
rename docs/cmd/{gotk_reconcile_kustomization.md => flux_reconcile_kustomization.md} (78%)
rename docs/cmd/{gotk_reconcile_receiver.md => flux_reconcile_receiver.md} (80%)
rename docs/cmd/{gotk_reconcile_source.md => flux_reconcile_source.md} (69%)
rename docs/cmd/{gotk_reconcile_source_bucket.md => flux_reconcile_source_bucket.md} (78%)
rename docs/cmd/{gotk_reconcile_source_git.md => flux_reconcile_source_git.md} (79%)
rename docs/cmd/{gotk_reconcile_source_helm.md => flux_reconcile_source_helm.md} (79%)
rename docs/cmd/{gotk_resume.md => flux_resume.md} (64%)
rename docs/cmd/{gotk_resume_alert.md => flux_resume_alert.md} (82%)
rename docs/cmd/{gotk_resume_helmrelease.md => flux_resume_helmrelease.md} (81%)
rename docs/cmd/{gotk_resume_kustomization.md => flux_resume_kustomization.md} (81%)
rename docs/cmd/{gotk_resume_receiver.md => flux_resume_receiver.md} (81%)
rename docs/cmd/{gotk_suspend.md => flux_suspend.md} (66%)
rename docs/cmd/{gotk_suspend_alert.md => flux_suspend_alert.md} (81%)
rename docs/cmd/{gotk_suspend_helmrelease.md => flux_suspend_helmrelease.md} (81%)
rename docs/cmd/{gotk_suspend_kustomization.md => flux_suspend_kustomization.md} (80%)
rename docs/cmd/{gotk_suspend_receiver.md => flux_suspend_receiver.md} (81%)
rename docs/cmd/{gotk_uninstall.md => flux_uninstall.md} (83%)
delete mode 100644 docs/cmd/gotk_get_alert-provider.md
delete mode 100644 docs/cmd/gotk_get_alert.md
delete mode 100644 docs/cmd/gotk_get_receiver.md
rename install/{gotk.sh => flux.sh} (86%)
diff --git a/.github/workflows/bootstrap.yaml b/.github/workflows/bootstrap.yaml
index 8fe7f738..1986c725 100644
--- a/.github/workflows/bootstrap.yaml
+++ b/.github/workflows/bootstrap.yaml
@@ -28,43 +28,43 @@ jobs:
id: vars
run: echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
- name: Build
- run: sudo go build -o ./bin/gotk ./cmd/gotk
+ run: sudo go build -o ./bin/flux ./cmd/flux
- name: bootstrap init
run: |
- ./bin/gotk bootstrap github --manifests ./manifests/install/ \
+ ./bin/flux bootstrap github --manifests ./manifests/install/ \
--owner=fluxcd-testing \
- --repository=gotk-test-${{ steps.vars.outputs.sha_short }} \
+ --repository=flux-test-${{ steps.vars.outputs.sha_short }} \
--branch=main \
--path=test-cluster
env:
GITHUB_TOKEN: ${{ secrets.GITPROVIDER_BOT_TOKEN }}
- name: bootstrap no-op
run: |
- ./bin/gotk bootstrap github --manifests ./manifests/install/ \
+ ./bin/flux bootstrap github --manifests ./manifests/install/ \
--owner=fluxcd-testing \
- --repository=gotk-test-${{ steps.vars.outputs.sha_short }} \
+ --repository=flux-test-${{ steps.vars.outputs.sha_short }} \
--branch=main \
--path=test-cluster
env:
GITHUB_TOKEN: ${{ secrets.GITPROVIDER_BOT_TOKEN }}
- name: uninstall
run: |
- ./bin/gotk suspend kustomization flux-system
- ./bin/gotk uninstall --resources --crds -s
+ ./bin/flux suspend kustomization flux-system
+ ./bin/flux uninstall --resources --crds -s
- name: bootstrap reinstall
run: |
- ./bin/gotk bootstrap github --manifests ./manifests/install/ \
+ ./bin/flux bootstrap github --manifests ./manifests/install/ \
--owner=fluxcd-testing \
- --repository=gotk-test-${{ steps.vars.outputs.sha_short }} \
+ --repository=flux-test-${{ steps.vars.outputs.sha_short }} \
--branch=main \
--path=test-cluster
env:
GITHUB_TOKEN: ${{ secrets.GITPROVIDER_BOT_TOKEN }}
- name: delete repository
run: |
- ./bin/gotk bootstrap github --manifests ./manifests/install/ \
+ ./bin/flux bootstrap github --manifests ./manifests/install/ \
--owner=fluxcd-testing \
- --repository=gotk-test-${{ steps.vars.outputs.sha_short }} \
+ --repository=flux-test-${{ steps.vars.outputs.sha_short }} \
--branch=main \
--path=test-cluster \
--delete
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index 8f8c8c5d..feefd56d 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -56,7 +56,7 @@ jobs:
{
# install script
- cp install/gotk.sh docs/install.sh
+ cp install/flux.sh docs/install.sh
}
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml
index 1945174e..87fee7e7 100644
--- a/.github/workflows/e2e.yaml
+++ b/.github/workflows/e2e.yaml
@@ -37,34 +37,34 @@ jobs:
exit 1
fi
- name: Build
- run: sudo go build -o ./bin/gotk ./cmd/gotk
- - name: gotk check --pre
+ run: sudo go build -o ./bin/flux ./cmd/flux
+ - name: flux check --pre
run: |
- ./bin/gotk check --pre
- - name: gotk install --manifests
+ ./bin/flux check --pre
+ - name: flux install --manifests
run: |
- ./bin/gotk install --manifests ./manifests/install/
- - name: gotk create source git
+ ./bin/flux install --manifests ./manifests/install/
+ - name: flux create source git
run: |
- ./bin/gotk create source git podinfo \
+ ./bin/flux create source git podinfo \
--url https://github.com/stefanprodan/podinfo \
--tag-semver=">=3.2.3"
- - name: gotk create source git export apply
+ - name: flux create source git export apply
run: |
- ./bin/gotk create source git podinfo-export \
+ ./bin/flux create source git podinfo-export \
--url https://github.com/stefanprodan/podinfo \
--tag-semver=">=3.2.3" \
--export | kubectl apply -f -
- ./bin/gotk delete source git podinfo-export --silent
- - name: gotk get sources git
+ ./bin/flux delete source git podinfo-export --silent
+ - name: flux get sources git
run: |
- ./bin/gotk get sources git
- - name: gotk get sources git --all-namespaces
+ ./bin/flux get sources git
+ - name: flux get sources git --all-namespaces
run: |
- ./bin/gotk get sources git --all-namespaces
- - name: gotk create kustomization
+ ./bin/flux get sources git --all-namespaces
+ - name: flux create kustomization
run: |
- ./bin/gotk create kustomization podinfo \
+ ./bin/flux create kustomization podinfo \
--source=podinfo \
--path="./deploy/overlays/dev" \
--prune=true \
@@ -73,75 +73,75 @@ jobs:
--health-check="Deployment/frontend.dev" \
--health-check="Deployment/backend.dev" \
--health-check-timeout=3m
- - name: gotk reconcile kustomization --with-source
+ - name: flux reconcile kustomization --with-source
run: |
- ./bin/gotk reconcile kustomization podinfo --with-source
- - name: gotk get kustomizations
+ ./bin/flux reconcile kustomization podinfo --with-source
+ - name: flux get kustomizations
run: |
- ./bin/gotk get kustomizations
- - name: gotk get kustomizations --all-namespaces
+ ./bin/flux get kustomizations
+ - name: flux get kustomizations --all-namespaces
run: |
- ./bin/gotk get kustomizations --all-namespaces
- - name: gotk suspend kustomization
+ ./bin/flux get kustomizations --all-namespaces
+ - name: flux suspend kustomization
run: |
- ./bin/gotk suspend kustomization podinfo
- - name: gotk resume kustomization
+ ./bin/flux suspend kustomization podinfo
+ - name: flux resume kustomization
run: |
- ./bin/gotk resume kustomization podinfo
- - name: gotk export
+ ./bin/flux resume kustomization podinfo
+ - name: flux export
run: |
- ./bin/gotk export source git --all
- ./bin/gotk export kustomization --all
- - name: gotk delete kustomization
+ ./bin/flux export source git --all
+ ./bin/flux export kustomization --all
+ - name: flux delete kustomization
run: |
- ./bin/gotk delete kustomization podinfo --silent
- - name: gotk create source helm
+ ./bin/flux delete kustomization podinfo --silent
+ - name: flux create source helm
run: |
- ./bin/gotk create source helm podinfo \
+ ./bin/flux create source helm podinfo \
--url https://stefanprodan.github.io/podinfo
- - name: gotk create helmrelease --source=HelmRepository/podinfo
+ - name: flux create helmrelease --source=HelmRepository/podinfo
run: |
- ./bin/gotk create hr podinfo-helm \
+ ./bin/flux create hr podinfo-helm \
--target-namespace=default \
--source=HelmRepository/podinfo \
--chart=podinfo \
--chart-version=">4.0.0 <5.0.0"
- - name: gotk create helmrelease --source=GitRepository/podinfo
+ - name: flux create helmrelease --source=GitRepository/podinfo
run: |
- ./bin/gotk create hr podinfo-git \
+ ./bin/flux create hr podinfo-git \
--target-namespace=default \
--source=GitRepository/podinfo \
--chart=./charts/podinfo
- - name: gotk reconcile helmrelease --with-source
+ - name: flux reconcile helmrelease --with-source
run: |
- ./bin/gotk reconcile helmrelease podinfo-git --with-source
- - name: gotk get helmreleases
+ ./bin/flux reconcile helmrelease podinfo-git --with-source
+ - name: flux get helmreleases
run: |
- ./bin/gotk get helmreleases
- - name: gotk get helmreleases --all-namespaces
+ ./bin/flux get helmreleases
+ - name: flux get helmreleases --all-namespaces
run: |
- ./bin/gotk get helmreleases --all-namespaces
- - name: gotk export helmrelease
+ ./bin/flux get helmreleases --all-namespaces
+ - name: flux export helmrelease
run: |
- ./bin/gotk export hr --all
- - name: gotk delete helmrelease podinfo-helm
+ ./bin/flux export hr --all
+ - name: flux delete helmrelease podinfo-helm
run: |
- ./bin/gotk delete hr podinfo-helm --silent
- - name: gotk delete helmrelease podinfo-git
+ ./bin/flux delete hr podinfo-helm --silent
+ - name: flux delete helmrelease podinfo-git
run: |
- ./bin/gotk delete hr podinfo-git --silent
- - name: gotk delete source helm
+ ./bin/flux delete hr podinfo-git --silent
+ - name: flux delete source helm
run: |
- ./bin/gotk delete source helm podinfo --silent
- - name: gotk delete source git
+ ./bin/flux delete source helm podinfo --silent
+ - name: flux delete source git
run: |
- ./bin/gotk delete source git podinfo --silent
- - name: gotk check
+ ./bin/flux delete source git podinfo --silent
+ - name: flux check
run: |
- ./bin/gotk check
- - name: gotk uninstall
+ ./bin/flux check
+ - name: flux uninstall
run: |
- ./bin/gotk uninstall --crds --silent
+ ./bin/flux uninstall --crds --silent
- name: Debug failure
if: failure()
run: |
diff --git a/.goreleaser.yml b/.goreleaser.yml
index dae20d49..c72e9af0 100644
--- a/.goreleaser.yml
+++ b/.goreleaser.yml
@@ -1,7 +1,7 @@
builds:
- <<: &build_defaults
- binary: gotk
- main: ./cmd/gotk
+ binary: flux
+ main: ./cmd/flux
ldflags:
- -s -w -X main.VERSION={{ .Version }}
env:
@@ -37,16 +37,16 @@ archives:
files:
- none*
brews:
- - name: gotk
+ - name: flux
tap:
owner: fluxcd
name: homebrew-tap
token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
folder: Formula
homepage: "https://toolkit.fluxcd.io/"
- description: "GitOps Toolkit CLI"
+ description: "Flux CLI"
dependencies:
- name: kubectl
type: optional
test: |
- system "#{bin}/gotk --version"
+ system "#{bin}/flux --version"
diff --git a/Makefile b/Makefile
index 45c19b81..32c16e42 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,4 @@
-VERSION?=$(shell grep 'VERSION' cmd/gotk/main.go | awk '{ print $$4 }' | tr -d '"')
+VERSION?=$(shell grep 'VERSION' cmd/flux/main.go | awk '{ print $$4 }' | tr -d '"')
all: test build
@@ -15,14 +15,14 @@ test: tidy fmt vet docs
go test ./... -coverprofile cover.out
build:
- CGO_ENABLED=0 go build -o ./bin/gotk ./cmd/gotk
+ CGO_ENABLED=0 go build -o ./bin/flux ./cmd/flux
install:
- go install cmd/gotk
+ go install cmd/flux
.PHONY: docs
docs:
- mkdir -p ./docs/cmd && go run ./cmd/gotk/ docgen
+ mkdir -p ./docs/cmd && go run ./cmd/flux/ docgen
install-dev:
- CGO_ENABLED=0 go build -o /usr/local/bin ./cmd/gotk
+ CGO_ENABLED=0 go build -o /usr/local/bin ./cmd/flux
diff --git a/README.md b/README.md
index cd92912f..232ca975 100644
--- a/README.md
+++ b/README.md
@@ -20,13 +20,13 @@ Flux v2 is constructed with the [GitOps Toolkit](#gitops-toolkit), a
set of composable APIs and specialized tools for building Continuous
Delivery on top of Kubernetes.
-## `gotk` installation
+## `flux` installation
With Homebrew:
```sh
brew tap fluxcd/tap
-brew install gotk
+brew install flux
```
With Bash:
@@ -35,7 +35,7 @@ With Bash:
curl -s https://toolkit.fluxcd.io/install.sh | sudo bash
# enable completions in ~/.bash_profile
-. <(gotk completion bash)
+. <(flux completion bash)
```
Binaries for macOS, Windows and Linux AMD64/ARM are available to download on the
@@ -44,7 +44,7 @@ Binaries for macOS, Windows and Linux AMD64/ARM are available to download on the
Verify that your cluster satisfies the prerequisites with:
```sh
-gotk check --pre
+flux check --pre
```
## Get started
@@ -72,7 +72,7 @@ guides](https://toolkit.fluxcd.io/dev-guides/).
### Components
-- [Toolkit CLI](https://toolkit.fluxcd.io/cmd/gotk/)
+- [Toolkit CLI](https://toolkit.fluxcd.io/cmd/flux/)
- [Source Controller](https://toolkit.fluxcd.io/components/source/controller/)
- [GitRepository CRD](https://toolkit.fluxcd.io/components/source/gitrepositories/)
- [HelmRepository CRD](https://toolkit.fluxcd.io/components/source/helmrepositories/)
diff --git a/cmd/gotk/bootstrap.go b/cmd/flux/bootstrap.go
similarity index 100%
rename from cmd/gotk/bootstrap.go
rename to cmd/flux/bootstrap.go
diff --git a/cmd/gotk/bootstrap_github.go b/cmd/flux/bootstrap_github.go
similarity index 93%
rename from cmd/gotk/bootstrap_github.go
rename to cmd/flux/bootstrap_github.go
index c7d42a17..f4ae1a2a 100644
--- a/cmd/gotk/bootstrap_github.go
+++ b/cmd/flux/bootstrap_github.go
@@ -43,22 +43,22 @@ the bootstrap command will perform an upgrade if needed.`,
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
`,
RunE: bootstrapGitHubCmdRun,
}
@@ -105,7 +105,7 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error {
return err
}
- repository, err := git.NewRepository(ghRepository, ghOwner, ghHostname, ghToken, "gotk", ghOwner+"@users.noreply.github.com")
+ repository, err := git.NewRepository(ghRepository, ghOwner, ghHostname, ghToken, "flux", ghOwner+"@users.noreply.github.com")
if err != nil {
return err
}
@@ -214,9 +214,9 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error {
return fmt.Errorf("generating deploy key failed: %w", err)
}
- keyName := "gotk"
+ keyName := "flux"
if ghPath != "" {
- keyName = fmt.Sprintf("gotk-%s", ghPath)
+ keyName = fmt.Sprintf("flux-%s", ghPath)
}
if changed, err := provider.AddDeployKey(ctx, repository, key, keyName); err != nil {
diff --git a/cmd/gotk/bootstrap_gitlab.go b/cmd/flux/bootstrap_gitlab.go
similarity index 93%
rename from cmd/gotk/bootstrap_gitlab.go
rename to cmd/flux/bootstrap_gitlab.go
index fbf59204..d183318d 100644
--- a/cmd/gotk/bootstrap_gitlab.go
+++ b/cmd/flux/bootstrap_gitlab.go
@@ -45,22 +45,22 @@ the bootstrap command will perform an upgrade if needed.`,
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
`,
RunE: bootstrapGitLabCmdRun,
}
@@ -99,7 +99,7 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error {
return err
}
- repository, err := git.NewRepository(glRepository, glOwner, glHostname, glToken, "gotk", glOwner+"@users.noreply.gitlab.com")
+ repository, err := git.NewRepository(glRepository, glOwner, glHostname, glToken, "flux", glOwner+"@users.noreply.gitlab.com")
if err != nil {
return err
}
@@ -195,9 +195,9 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error {
return fmt.Errorf("generating deploy key failed: %w", err)
}
- keyName := "gotk"
+ keyName := "flux"
if glPath != "" {
- keyName = fmt.Sprintf("gotk-%s", glPath)
+ keyName = fmt.Sprintf("flux-%s", glPath)
}
if changed, err := provider.AddDeployKey(ctx, repository, key, keyName); err != nil {
diff --git a/cmd/gotk/check.go b/cmd/flux/check.go
similarity index 99%
rename from cmd/gotk/check.go
rename to cmd/flux/check.go
index 3f4d97eb..b1bc6233 100644
--- a/cmd/gotk/check.go
+++ b/cmd/flux/check.go
@@ -37,10 +37,10 @@ var checkCmd = &cobra.Command{
Long: `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.`,
Example: ` # Run pre-installation checks
- gotk check --pre
+ flux check --pre
# Run installation checks
- gotk check
+ flux check
`,
RunE: runCheckCmd,
}
diff --git a/cmd/gotk/completion.go b/cmd/flux/completion.go
similarity index 100%
rename from cmd/gotk/completion.go
rename to cmd/flux/completion.go
diff --git a/cmd/gotk/completion_bash.go b/cmd/flux/completion_bash.go
similarity index 92%
rename from cmd/gotk/completion_bash.go
rename to cmd/flux/completion_bash.go
index 0e4bf5c1..4bc2a98d 100644
--- a/cmd/gotk/completion_bash.go
+++ b/cmd/flux/completion_bash.go
@@ -27,12 +27,12 @@ var completionBashCmd = &cobra.Command{
Short: "Generates bash completion scripts",
Example: `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)
`,
Run: func(cmd *cobra.Command, args []string) {
rootCmd.GenBashCompletion(os.Stdout)
diff --git a/cmd/gotk/completion_fish.go b/cmd/flux/completion_fish.go
similarity index 93%
rename from cmd/gotk/completion_fish.go
rename to cmd/flux/completion_fish.go
index 13ecfe58..03225474 100644
--- a/cmd/gotk/completion_fish.go
+++ b/cmd/flux/completion_fish.go
@@ -27,11 +27,11 @@ var completionFishCmd = &cobra.Command{
Short: "Generates fish completion scripts",
Example: `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
`,
diff --git a/cmd/gotk/completion_powershell.go b/cmd/flux/completion_powershell.go
similarity index 91%
rename from cmd/gotk/completion_powershell.go
rename to cmd/flux/completion_powershell.go
index ec401d4f..e23485d5 100644
--- a/cmd/gotk/completion_powershell.go
+++ b/cmd/flux/completion_powershell.go
@@ -27,19 +27,19 @@ var completionPowerShellCmd = &cobra.Command{
Short: "Generates powershell completion scripts",
Example: `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
`,
Run: func(cmd *cobra.Command, args []string) {
rootCmd.GenPowerShellCompletion(os.Stdout)
diff --git a/cmd/gotk/completion_zsh.go b/cmd/flux/completion_zsh.go
similarity index 81%
rename from cmd/gotk/completion_zsh.go
rename to cmd/flux/completion_zsh.go
index 9698934a..fa286a8c 100644
--- a/cmd/gotk/completion_zsh.go
+++ b/cmd/flux/completion_zsh.go
@@ -27,20 +27,20 @@ var completionZshCmd = &cobra.Command{
Short: "Generates zsh completion scripts",
Example: `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
`,
Run: func(cmd *cobra.Command, args []string) {
rootCmd.GenZshCompletion(os.Stdout)
diff --git a/cmd/gotk/create.go b/cmd/flux/create.go
similarity index 100%
rename from cmd/gotk/create.go
rename to cmd/flux/create.go
diff --git a/cmd/gotk/create_alert.go b/cmd/flux/create_alert.go
similarity index 99%
rename from cmd/gotk/create_alert.go
rename to cmd/flux/create_alert.go
index edd1634e..d35c3cc5 100644
--- a/cmd/gotk/create_alert.go
+++ b/cmd/flux/create_alert.go
@@ -39,7 +39,7 @@ var createAlertCmd = &cobra.Command{
Short: "Create or update a Alert resource",
Long: "The create alert command generates a Alert resource.",
Example: ` # Create an Alert for kustomization events
- gotk create alert \
+ flux create alert \
--event-severity info \
--event-source Kustomization/flux-system \
--provider-ref slack \
diff --git a/cmd/gotk/create_alertprovider.go b/cmd/flux/create_alertprovider.go
similarity index 98%
rename from cmd/gotk/create_alertprovider.go
rename to cmd/flux/create_alertprovider.go
index 3150ee00..44582570 100644
--- a/cmd/gotk/create_alertprovider.go
+++ b/cmd/flux/create_alertprovider.go
@@ -38,14 +38,14 @@ var createAlertProviderCmd = &cobra.Command{
Short: "Create or update a Provider resource",
Long: "The create alert-provider command generates a Provider resource.",
Example: ` # 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
diff --git a/cmd/gotk/create_helmrelease.go b/cmd/flux/create_helmrelease.go
similarity index 97%
rename from cmd/gotk/create_helmrelease.go
rename to cmd/flux/create_helmrelease.go
index 46fb4b13..e1d92074 100644
--- a/cmd/gotk/create_helmrelease.go
+++ b/cmd/flux/create_helmrelease.go
@@ -43,44 +43,44 @@ var createHelmReleaseCmd = &cobra.Command{
Short: "Create or update a HelmRelease resource",
Long: "The helmrelease create command generates a HelmRelease resource for a given HelmRepository source.",
Example: ` # 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 \
diff --git a/cmd/gotk/create_kustomization.go b/cmd/flux/create_kustomization.go
similarity index 98%
rename from cmd/gotk/create_kustomization.go
rename to cmd/flux/create_kustomization.go
index 0c67b77c..1151d1f5 100644
--- a/cmd/gotk/create_kustomization.go
+++ b/cmd/flux/create_kustomization.go
@@ -43,7 +43,7 @@ var createKsCmd = &cobra.Command{
Short: "Create or update a Kustomization resource",
Long: "The kustomization source create command generates a Kustomize resource for a given source.",
Example: ` # 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 \
@@ -54,7 +54,7 @@ var createKsCmd = &cobra.Command{
--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" \
@@ -63,7 +63,7 @@ var createKsCmd = &cobra.Command{
--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
diff --git a/cmd/gotk/create_receiver.go b/cmd/flux/create_receiver.go
similarity index 99%
rename from cmd/gotk/create_receiver.go
rename to cmd/flux/create_receiver.go
index d25f92e1..6027579b 100644
--- a/cmd/gotk/create_receiver.go
+++ b/cmd/flux/create_receiver.go
@@ -38,7 +38,7 @@ var createReceiverCmd = &cobra.Command{
Short: "Create or update a Receiver resource",
Long: "The create receiver command generates a Receiver resource.",
Example: ` # Create a Receiver
- gotk create receiver github-receiver \
+ flux create receiver github-receiver \
--type github \
--event ping \
--event push \
diff --git a/cmd/gotk/create_source.go b/cmd/flux/create_source.go
similarity index 100%
rename from cmd/gotk/create_source.go
rename to cmd/flux/create_source.go
diff --git a/cmd/gotk/create_source_bucket.go b/cmd/flux/create_source_bucket.go
similarity index 98%
rename from cmd/gotk/create_source_bucket.go
rename to cmd/flux/create_source_bucket.go
index 238d5e12..6068ec1e 100644
--- a/cmd/gotk/create_source_bucket.go
+++ b/cmd/flux/create_source_bucket.go
@@ -42,7 +42,7 @@ var createSourceBucketCmd = &cobra.Command{
The create source bucket command generates a Bucket resource and waits for it to be downloaded.
For Buckets with static authentication, the credentials are stored in a Kubernetes secret.`,
Example: ` # 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 \
@@ -51,7 +51,7 @@ For Buckets with static authentication, the credentials are stored in a Kubernet
--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 \
diff --git a/cmd/gotk/create_source_git.go b/cmd/flux/create_source_git.go
similarity index 98%
rename from cmd/gotk/create_source_git.go
rename to cmd/flux/create_source_git.go
index 5dfb3b89..ddd4fd8e 100644
--- a/cmd/gotk/create_source_git.go
+++ b/cmd/flux/create_source_git.go
@@ -50,35 +50,35 @@ The create source git command generates a GitRepository resource and waits for i
For Git over SSH, host and SSH keys are automatically generated and stored in a Kubernetes secret.
For private Git repositories, the basic authentication credentials are stored in a Kubernetes secret.`,
Example: ` # 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
diff --git a/cmd/gotk/create_source_helm.go b/cmd/flux/create_source_helm.go
similarity index 98%
rename from cmd/gotk/create_source_helm.go
rename to cmd/flux/create_source_helm.go
index 11009974..b0520bec 100644
--- a/cmd/gotk/create_source_helm.go
+++ b/cmd/flux/create_source_helm.go
@@ -42,18 +42,18 @@ var createSourceHelmCmd = &cobra.Command{
The create source helm command generates a HelmRepository resource and waits for it to fetch the index.
For private Helm repositories, the basic authentication credentials are stored in a Kubernetes secret.`,
Example: ` # 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 \
diff --git a/cmd/gotk/create_tenant.go b/cmd/flux/create_tenant.go
similarity index 99%
rename from cmd/gotk/create_tenant.go
rename to cmd/flux/create_tenant.go
index 4cfc4b0d..4eadc2f2 100644
--- a/cmd/gotk/create_tenant.go
+++ b/cmd/flux/create_tenant.go
@@ -41,12 +41,12 @@ var createTenantCmd = &cobra.Command{
The create tenant command generates namespaces and role bindings to limit the
reconcilers scope to the tenant namespaces.`,
Example: ` # Create a tenant with access to a namespace
- gotk create tenant dev-team \
+ flux create tenant dev-team \
--with-namespace=frontend \
--label=environment=dev
# Generate tenant namespaces and role bindings in YAML format
- gotk create tenant dev-team \
+ flux create tenant dev-team \
--with-namespace=frontend \
--with-namespace=backend \
--export > dev-team.yaml
diff --git a/cmd/gotk/delete.go b/cmd/flux/delete.go
similarity index 100%
rename from cmd/gotk/delete.go
rename to cmd/flux/delete.go
diff --git a/cmd/gotk/delete_alert.go b/cmd/flux/delete_alert.go
similarity index 98%
rename from cmd/gotk/delete_alert.go
rename to cmd/flux/delete_alert.go
index d873f354..fca194ca 100644
--- a/cmd/gotk/delete_alert.go
+++ b/cmd/flux/delete_alert.go
@@ -33,7 +33,7 @@ var deleteAlertCmd = &cobra.Command{
Short: "Delete a Alert resource",
Long: "The delete alert command removes the given Alert from the cluster.",
Example: ` # Delete an Alert and the Kubernetes resources created by it
- gotk delete alert main
+ flux delete alert main
`,
RunE: deleteAlertCmdRun,
}
diff --git a/cmd/gotk/delete_alertprovider.go b/cmd/flux/delete_alertprovider.go
similarity index 98%
rename from cmd/gotk/delete_alertprovider.go
rename to cmd/flux/delete_alertprovider.go
index 7a119b9f..2f5ca41b 100644
--- a/cmd/gotk/delete_alertprovider.go
+++ b/cmd/flux/delete_alertprovider.go
@@ -33,7 +33,7 @@ var deleteAlertProviderCmd = &cobra.Command{
Short: "Delete a Provider resource",
Long: "The delete alert-provider command removes the given Provider from the cluster.",
Example: ` # Delete a Provider and the Kubernetes resources created by it
- gotk delete alert-provider slack
+ flux delete alert-provider slack
`,
RunE: deleteAlertProviderCmdRun,
}
diff --git a/cmd/gotk/delete_helmrelease.go b/cmd/flux/delete_helmrelease.go
similarity index 98%
rename from cmd/gotk/delete_helmrelease.go
rename to cmd/flux/delete_helmrelease.go
index 078a457e..6ab6477a 100644
--- a/cmd/gotk/delete_helmrelease.go
+++ b/cmd/flux/delete_helmrelease.go
@@ -34,7 +34,7 @@ var deleteHelmReleaseCmd = &cobra.Command{
Short: "Delete a HelmRelease resource",
Long: "The delete helmrelease command removes the given HelmRelease from the cluster.",
Example: ` # Delete a Helm release and the Kubernetes resources created by it
- gotk delete hr podinfo
+ flux delete hr podinfo
`,
RunE: deleteHelmReleaseCmdRun,
}
diff --git a/cmd/gotk/delete_kustomization.go b/cmd/flux/delete_kustomization.go
similarity index 98%
rename from cmd/gotk/delete_kustomization.go
rename to cmd/flux/delete_kustomization.go
index 85b94b90..a71d60c9 100644
--- a/cmd/gotk/delete_kustomization.go
+++ b/cmd/flux/delete_kustomization.go
@@ -33,7 +33,7 @@ var deleteKsCmd = &cobra.Command{
Short: "Delete a Kustomization resource",
Long: "The delete kustomization command deletes the given Kustomization from the cluster.",
Example: ` # Delete a kustomization and the Kubernetes resources created by it
- gotk delete kustomization podinfo
+ flux delete kustomization podinfo
`,
RunE: deleteKsCmdRun,
}
diff --git a/cmd/gotk/delete_receiver.go b/cmd/flux/delete_receiver.go
similarity index 98%
rename from cmd/gotk/delete_receiver.go
rename to cmd/flux/delete_receiver.go
index f362f510..66603678 100644
--- a/cmd/gotk/delete_receiver.go
+++ b/cmd/flux/delete_receiver.go
@@ -33,7 +33,7 @@ var deleteReceiverCmd = &cobra.Command{
Short: "Delete a Receiver resource",
Long: "The delete receiver command removes the given Receiver from the cluster.",
Example: ` # Delete an Receiver and the Kubernetes resources created by it
- gotk delete receiver main
+ flux delete receiver main
`,
RunE: deleteReceiverCmdRun,
}
diff --git a/cmd/gotk/delete_source.go b/cmd/flux/delete_source.go
similarity index 100%
rename from cmd/gotk/delete_source.go
rename to cmd/flux/delete_source.go
diff --git a/cmd/gotk/delete_source_bucket.go b/cmd/flux/delete_source_bucket.go
similarity index 98%
rename from cmd/gotk/delete_source_bucket.go
rename to cmd/flux/delete_source_bucket.go
index 43bd1951..ffb628f2 100644
--- a/cmd/gotk/delete_source_bucket.go
+++ b/cmd/flux/delete_source_bucket.go
@@ -32,7 +32,7 @@ var deleteSourceBucketCmd = &cobra.Command{
Short: "Delete a Bucket source",
Long: "The delete source bucket command deletes the given Bucket from the cluster.",
Example: ` # Delete a Bucket source
- gotk delete source bucket podinfo
+ flux delete source bucket podinfo
`,
RunE: deleteSourceBucketCmdRun,
}
diff --git a/cmd/gotk/delete_source_git.go b/cmd/flux/delete_source_git.go
similarity index 98%
rename from cmd/gotk/delete_source_git.go
rename to cmd/flux/delete_source_git.go
index 771d6e5e..74337139 100644
--- a/cmd/gotk/delete_source_git.go
+++ b/cmd/flux/delete_source_git.go
@@ -32,7 +32,7 @@ var deleteSourceGitCmd = &cobra.Command{
Short: "Delete a GitRepository source",
Long: "The delete source git command deletes the given GitRepository from the cluster.",
Example: ` # Delete a Git repository
- gotk delete source git podinfo
+ flux delete source git podinfo
`,
RunE: deleteSourceGitCmdRun,
}
diff --git a/cmd/gotk/delete_source_helm.go b/cmd/flux/delete_source_helm.go
similarity index 98%
rename from cmd/gotk/delete_source_helm.go
rename to cmd/flux/delete_source_helm.go
index 951e3a1d..11b3e7ca 100644
--- a/cmd/gotk/delete_source_helm.go
+++ b/cmd/flux/delete_source_helm.go
@@ -32,7 +32,7 @@ var deleteSourceHelmCmd = &cobra.Command{
Short: "Delete a HelmRepository source",
Long: "The delete source helm command deletes the given HelmRepository from the cluster.",
Example: ` # Delete a Helm repository
- gotk delete source helm podinfo
+ flux delete source helm podinfo
`,
RunE: deleteSourceHelmCmdRun,
}
diff --git a/cmd/gotk/export.go b/cmd/flux/export.go
similarity index 100%
rename from cmd/gotk/export.go
rename to cmd/flux/export.go
diff --git a/cmd/gotk/export_alert.go b/cmd/flux/export_alert.go
similarity index 97%
rename from cmd/gotk/export_alert.go
rename to cmd/flux/export_alert.go
index c6ce2f08..a3eab1d4 100644
--- a/cmd/gotk/export_alert.go
+++ b/cmd/flux/export_alert.go
@@ -35,10 +35,10 @@ var exportAlertCmd = &cobra.Command{
Short: "Export Alert resources in YAML format",
Long: "The export alert command exports one or all Alert resources in YAML format.",
Example: ` # 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
`,
RunE: exportAlertCmdRun,
}
diff --git a/cmd/gotk/export_alertprovider.go b/cmd/flux/export_alertprovider.go
similarity index 96%
rename from cmd/gotk/export_alertprovider.go
rename to cmd/flux/export_alertprovider.go
index 08db77b0..ea26eeab 100644
--- a/cmd/gotk/export_alertprovider.go
+++ b/cmd/flux/export_alertprovider.go
@@ -35,10 +35,10 @@ var exportAlertProviderCmd = &cobra.Command{
Short: "Export Provider resources in YAML format",
Long: "The export alert-provider command exports one or all Provider resources in YAML format.",
Example: ` # 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
`,
RunE: exportAlertProviderCmdRun,
}
diff --git a/cmd/gotk/export_helmrelease.go b/cmd/flux/export_helmrelease.go
similarity index 96%
rename from cmd/gotk/export_helmrelease.go
rename to cmd/flux/export_helmrelease.go
index 4874802a..8f50a795 100644
--- a/cmd/gotk/export_helmrelease.go
+++ b/cmd/flux/export_helmrelease.go
@@ -36,10 +36,10 @@ var exportHelmReleaseCmd = &cobra.Command{
Short: "Export HelmRelease resources in YAML format",
Long: "The export helmrelease command exports one or all HelmRelease resources in YAML format.",
Example: ` # 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
`,
RunE: exportHelmReleaseCmdRun,
}
diff --git a/cmd/gotk/export_kustomization.go b/cmd/flux/export_kustomization.go
similarity index 96%
rename from cmd/gotk/export_kustomization.go
rename to cmd/flux/export_kustomization.go
index d3759db1..517f976f 100644
--- a/cmd/gotk/export_kustomization.go
+++ b/cmd/flux/export_kustomization.go
@@ -36,10 +36,10 @@ var exportKsCmd = &cobra.Command{
Short: "Export Kustomization resources in YAML format",
Long: "The export kustomization command exports one or all Kustomization resources in YAML format.",
Example: ` # 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
`,
RunE: exportKsCmdRun,
}
diff --git a/cmd/gotk/export_receiver.go b/cmd/flux/export_receiver.go
similarity index 97%
rename from cmd/gotk/export_receiver.go
rename to cmd/flux/export_receiver.go
index 48ec9f3f..03bae3a2 100644
--- a/cmd/gotk/export_receiver.go
+++ b/cmd/flux/export_receiver.go
@@ -35,10 +35,10 @@ var exportReceiverCmd = &cobra.Command{
Short: "Export Receiver resources in YAML format",
Long: "The export receiver command exports one or all Receiver resources in YAML format.",
Example: ` # 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
`,
RunE: exportReceiverCmdRun,
}
diff --git a/cmd/gotk/export_source.go b/cmd/flux/export_source.go
similarity index 100%
rename from cmd/gotk/export_source.go
rename to cmd/flux/export_source.go
diff --git a/cmd/gotk/export_source_bucket.go b/cmd/flux/export_source_bucket.go
similarity index 97%
rename from cmd/gotk/export_source_bucket.go
rename to cmd/flux/export_source_bucket.go
index 049fa1c8..09ab9402 100644
--- a/cmd/gotk/export_source_bucket.go
+++ b/cmd/flux/export_source_bucket.go
@@ -36,10 +36,10 @@ var exportSourceBucketCmd = &cobra.Command{
Short: "Export Bucket sources in YAML format",
Long: "The export source git command exports on or all Bucket sources in YAML format.",
Example: ` # 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
`,
RunE: exportSourceBucketCmdRun,
}
diff --git a/cmd/gotk/export_source_git.go b/cmd/flux/export_source_git.go
similarity index 97%
rename from cmd/gotk/export_source_git.go
rename to cmd/flux/export_source_git.go
index c0770c9e..dc5520e7 100644
--- a/cmd/gotk/export_source_git.go
+++ b/cmd/flux/export_source_git.go
@@ -36,10 +36,10 @@ var exportSourceGitCmd = &cobra.Command{
Short: "Export GitRepository sources in YAML format",
Long: "The export source git command exports on or all GitRepository sources in YAML format.",
Example: ` # 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
`,
RunE: exportSourceGitCmdRun,
}
diff --git a/cmd/gotk/export_source_helm.go b/cmd/flux/export_source_helm.go
similarity index 97%
rename from cmd/gotk/export_source_helm.go
rename to cmd/flux/export_source_helm.go
index 89a7f928..9900230a 100644
--- a/cmd/gotk/export_source_helm.go
+++ b/cmd/flux/export_source_helm.go
@@ -36,10 +36,10 @@ var exportSourceHelmCmd = &cobra.Command{
Short: "Export HelmRepository sources in YAML format",
Long: "The export source git command exports on or all HelmRepository sources in YAML format.",
Example: ` # 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
`,
RunE: exportSourceHelmCmdRun,
}
diff --git a/cmd/gotk/get.go b/cmd/flux/get.go
similarity index 100%
rename from cmd/gotk/get.go
rename to cmd/flux/get.go
diff --git a/cmd/gotk/get_alert.go b/cmd/flux/get_alert.go
similarity index 99%
rename from cmd/gotk/get_alert.go
rename to cmd/flux/get_alert.go
index 0512a607..95762966 100644
--- a/cmd/gotk/get_alert.go
+++ b/cmd/flux/get_alert.go
@@ -36,7 +36,7 @@ var getAlertCmd = &cobra.Command{
Short: "Get Alert statuses",
Long: "The get alert command prints the statuses of the resources.",
Example: ` # List all Alerts and their status
- gotk get alerts
+ flux get alerts
`,
RunE: getAlertCmdRun,
}
diff --git a/cmd/gotk/get_alertprovider.go b/cmd/flux/get_alertprovider.go
similarity index 98%
rename from cmd/gotk/get_alertprovider.go
rename to cmd/flux/get_alertprovider.go
index a0e438d6..b8e8846e 100644
--- a/cmd/gotk/get_alertprovider.go
+++ b/cmd/flux/get_alertprovider.go
@@ -34,7 +34,7 @@ var getAlertProviderCmd = &cobra.Command{
Short: "Get Provider statuses",
Long: "The get alert-provider command prints the statuses of the resources.",
Example: ` # List all Providers and their status
- gotk get alert-providers
+ flux get alert-providers
`,
RunE: getAlertProviderCmdRun,
}
diff --git a/cmd/gotk/get_helmrelease.go b/cmd/flux/get_helmrelease.go
similarity index 99%
rename from cmd/gotk/get_helmrelease.go
rename to cmd/flux/get_helmrelease.go
index 6052f856..4304cfff 100644
--- a/cmd/gotk/get_helmrelease.go
+++ b/cmd/flux/get_helmrelease.go
@@ -38,7 +38,7 @@ var getHelmReleaseCmd = &cobra.Command{
Short: "Get HelmRelease statuses",
Long: "The get helmreleases command prints the statuses of the resources.",
Example: ` # List all Helm releases and their status
- gotk get helmreleases
+ flux get helmreleases
`,
RunE: getHelmReleaseCmdRun,
}
diff --git a/cmd/gotk/get_kustomization.go b/cmd/flux/get_kustomization.go
similarity index 99%
rename from cmd/gotk/get_kustomization.go
rename to cmd/flux/get_kustomization.go
index 263ad0b2..8c92833b 100644
--- a/cmd/gotk/get_kustomization.go
+++ b/cmd/flux/get_kustomization.go
@@ -37,7 +37,7 @@ var getKsCmd = &cobra.Command{
Short: "Get Kustomization statuses",
Long: "The get kustomizations command prints the statuses of the resources.",
Example: ` # List all kustomizations and their status
- gotk get kustomizations
+ flux get kustomizations
`,
RunE: getKsCmdRun,
}
diff --git a/cmd/gotk/get_receiver.go b/cmd/flux/get_receiver.go
similarity index 99%
rename from cmd/gotk/get_receiver.go
rename to cmd/flux/get_receiver.go
index f8c329e8..aeb3a218 100644
--- a/cmd/gotk/get_receiver.go
+++ b/cmd/flux/get_receiver.go
@@ -36,7 +36,7 @@ var getReceiverCmd = &cobra.Command{
Short: "Get Receiver statuses",
Long: "The get receiver command prints the statuses of the resources.",
Example: ` # List all Receiver and their status
- gotk get receivers
+ flux get receivers
`,
RunE: getReceiverCmdRun,
}
diff --git a/cmd/gotk/get_source.go b/cmd/flux/get_source.go
similarity index 100%
rename from cmd/gotk/get_source.go
rename to cmd/flux/get_source.go
diff --git a/cmd/gotk/get_source_bucket.go b/cmd/flux/get_source_bucket.go
similarity index 98%
rename from cmd/gotk/get_source_bucket.go
rename to cmd/flux/get_source_bucket.go
index 29f9818b..03d992fa 100644
--- a/cmd/gotk/get_source_bucket.go
+++ b/cmd/flux/get_source_bucket.go
@@ -34,7 +34,7 @@ var getSourceBucketCmd = &cobra.Command{
Short: "Get Bucket source statuses",
Long: "The get sources bucket command prints the status of the Bucket sources.",
Example: ` # List all Buckets and their status
- gotk get sources bucket
+ flux get sources bucket
`,
RunE: getSourceBucketCmdRun,
}
diff --git a/cmd/gotk/get_source_git.go b/cmd/flux/get_source_git.go
similarity index 99%
rename from cmd/gotk/get_source_git.go
rename to cmd/flux/get_source_git.go
index ed709112..0385e01e 100644
--- a/cmd/gotk/get_source_git.go
+++ b/cmd/flux/get_source_git.go
@@ -34,7 +34,7 @@ var getSourceGitCmd = &cobra.Command{
Short: "Get GitRepository source statuses",
Long: "The get sources git command prints the status of the GitRepository sources.",
Example: ` # List all Git repositories and their status
- gotk get sources git
+ flux get sources git
`,
RunE: getSourceGitCmdRun,
}
diff --git a/cmd/gotk/get_source_helm.go b/cmd/flux/get_source_helm.go
similarity index 99%
rename from cmd/gotk/get_source_helm.go
rename to cmd/flux/get_source_helm.go
index 03a65349..edc5c67a 100644
--- a/cmd/gotk/get_source_helm.go
+++ b/cmd/flux/get_source_helm.go
@@ -34,7 +34,7 @@ var getSourceHelmCmd = &cobra.Command{
Short: "Get HelmRepository source statuses",
Long: "The get sources helm command prints the status of the HelmRepository sources.",
Example: ` # List all Helm repositories and their status
- gotk get sources helm
+ flux get sources helm
`,
RunE: getSourceHelmCmdRun,
}
diff --git a/cmd/gotk/install.go b/cmd/flux/install.go
similarity index 96%
rename from cmd/gotk/install.go
rename to cmd/flux/install.go
index 03e835d9..b939222c 100644
--- a/cmd/gotk/install.go
+++ b/cmd/flux/install.go
@@ -37,16 +37,16 @@ var installCmd = &cobra.Command{
Long: `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.`,
Example: ` # 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
`,
RunE: installCmdRun,
}
diff --git a/cmd/gotk/log.go b/cmd/flux/log.go
similarity index 100%
rename from cmd/gotk/log.go
rename to cmd/flux/log.go
diff --git a/cmd/gotk/main.go b/cmd/flux/main.go
similarity index 85%
rename from cmd/gotk/main.go
rename to cmd/flux/main.go
index 7555dc7f..fe43d5c7 100644
--- a/cmd/gotk/main.go
+++ b/cmd/flux/main.go
@@ -26,42 +26,42 @@ import (
"github.com/spf13/cobra/doc"
_ "k8s.io/client-go/plugin/pkg/client/auth"
- gotklog "github.com/fluxcd/toolkit/pkg/log"
+ fluxlog "github.com/fluxcd/toolkit/pkg/log"
"github.com/fluxcd/toolkit/pkg/manifestgen/install"
)
var VERSION = "0.0.0-dev.0"
var rootCmd = &cobra.Command{
- Use: "gotk",
+ Use: "flux",
Version: VERSION,
SilenceUsage: true,
SilenceErrors: true,
Short: "Command line utility for assembling Kubernetes CD pipelines",
Long: `Command line utility for assembling Kubernetes CD pipelines the GitOps way.`,
Example: ` # 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 \
@@ -72,25 +72,25 @@ var rootCmd = &cobra.Command{
--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
`,
}
@@ -100,7 +100,7 @@ var (
timeout time.Duration
verbose bool
pollInterval = 2 * time.Second
- logger gotklog.Logger = printLogger{}
+ logger fluxlog.Logger = printLogger{}
defaults = install.MakeDefaultOptions()
)
diff --git a/cmd/gotk/reconcile.go b/cmd/flux/reconcile.go
similarity index 100%
rename from cmd/gotk/reconcile.go
rename to cmd/flux/reconcile.go
diff --git a/cmd/gotk/reconcile_alert.go b/cmd/flux/reconcile_alert.go
similarity index 98%
rename from cmd/gotk/reconcile_alert.go
rename to cmd/flux/reconcile_alert.go
index 1f01e4df..6f8eac95 100644
--- a/cmd/gotk/reconcile_alert.go
+++ b/cmd/flux/reconcile_alert.go
@@ -36,7 +36,7 @@ var reconcileAlertCmd = &cobra.Command{
Short: "Reconcile an Alert",
Long: `The reconcile alert command triggers a reconciliation of an Alert resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing alert
- gotk reconcile alert main
+ flux reconcile alert main
`,
RunE: reconcileAlertCmdRun,
}
diff --git a/cmd/gotk/reconcile_alertprovider.go b/cmd/flux/reconcile_alertprovider.go
similarity index 98%
rename from cmd/gotk/reconcile_alertprovider.go
rename to cmd/flux/reconcile_alertprovider.go
index c0f7aa35..f842531c 100644
--- a/cmd/gotk/reconcile_alertprovider.go
+++ b/cmd/flux/reconcile_alertprovider.go
@@ -36,7 +36,7 @@ var reconcileAlertProviderCmd = &cobra.Command{
Short: "Reconcile a Provider",
Long: `The reconcile alert-provider command triggers a reconciliation of a Provider resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing provider
- gotk reconcile alert-provider slack
+ flux reconcile alert-provider slack
`,
RunE: reconcileAlertProviderCmdRun,
}
diff --git a/cmd/gotk/reconcile_helmrelease.go b/cmd/flux/reconcile_helmrelease.go
similarity index 98%
rename from cmd/gotk/reconcile_helmrelease.go
rename to cmd/flux/reconcile_helmrelease.go
index ad95176e..d93e16aa 100644
--- a/cmd/gotk/reconcile_helmrelease.go
+++ b/cmd/flux/reconcile_helmrelease.go
@@ -42,10 +42,10 @@ var reconcileHrCmd = &cobra.Command{
Long: `
The reconcile kustomization command triggers a reconciliation of a HelmRelease resource and waits for it to finish.`,
Example: ` # 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
`,
RunE: reconcileHrCmdRun,
}
diff --git a/cmd/gotk/reconcile_kustomization.go b/cmd/flux/reconcile_kustomization.go
similarity index 98%
rename from cmd/gotk/reconcile_kustomization.go
rename to cmd/flux/reconcile_kustomization.go
index 7b21df8f..8bf75a37 100644
--- a/cmd/gotk/reconcile_kustomization.go
+++ b/cmd/flux/reconcile_kustomization.go
@@ -42,10 +42,10 @@ var reconcileKsCmd = &cobra.Command{
Long: `
The reconcile kustomization command triggers a reconciliation of a Kustomization resource and waits for it to finish.`,
Example: ` # 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
`,
RunE: reconcileKsCmdRun,
}
diff --git a/cmd/gotk/reconcile_receiver.go b/cmd/flux/reconcile_receiver.go
similarity index 98%
rename from cmd/gotk/reconcile_receiver.go
rename to cmd/flux/reconcile_receiver.go
index 16fb1f20..ac1493a8 100644
--- a/cmd/gotk/reconcile_receiver.go
+++ b/cmd/flux/reconcile_receiver.go
@@ -36,7 +36,7 @@ var reconcileReceiverCmd = &cobra.Command{
Short: "Reconcile a Receiver",
Long: `The reconcile receiver command triggers a reconciliation of a Receiver resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing receiver
- gotk reconcile receiver main
+ flux reconcile receiver main
`,
RunE: reconcileReceiverCmdRun,
}
diff --git a/cmd/gotk/reconcile_source.go b/cmd/flux/reconcile_source.go
similarity index 100%
rename from cmd/gotk/reconcile_source.go
rename to cmd/flux/reconcile_source.go
diff --git a/cmd/gotk/reconcile_source_bucket.go b/cmd/flux/reconcile_source_bucket.go
similarity index 98%
rename from cmd/gotk/reconcile_source_bucket.go
rename to cmd/flux/reconcile_source_bucket.go
index 14ea0025..eaefdd35 100644
--- a/cmd/gotk/reconcile_source_bucket.go
+++ b/cmd/flux/reconcile_source_bucket.go
@@ -38,7 +38,7 @@ var reconcileSourceBucketCmd = &cobra.Command{
Short: "Reconcile a Bucket source",
Long: `The reconcile source command triggers a reconciliation of a Bucket resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing source
- gotk reconcile source bucket podinfo
+ flux reconcile source bucket podinfo
`,
RunE: reconcileSourceBucketCmdRun,
}
diff --git a/cmd/gotk/reconcile_source_git.go b/cmd/flux/reconcile_source_git.go
similarity index 98%
rename from cmd/gotk/reconcile_source_git.go
rename to cmd/flux/reconcile_source_git.go
index 85940548..5d6fddaa 100644
--- a/cmd/gotk/reconcile_source_git.go
+++ b/cmd/flux/reconcile_source_git.go
@@ -36,7 +36,7 @@ var reconcileSourceGitCmd = &cobra.Command{
Short: "Reconcile a GitRepository source",
Long: `The reconcile source command triggers a reconciliation of a GitRepository resource and waits for it to finish.`,
Example: ` # Trigger a git pull for an existing source
- gotk reconcile source git podinfo
+ flux reconcile source git podinfo
`,
RunE: reconcileSourceGitCmdRun,
}
diff --git a/cmd/gotk/reconcile_source_helm.go b/cmd/flux/reconcile_source_helm.go
similarity index 99%
rename from cmd/gotk/reconcile_source_helm.go
rename to cmd/flux/reconcile_source_helm.go
index 7a0474d0..3fc4a1ac 100644
--- a/cmd/gotk/reconcile_source_helm.go
+++ b/cmd/flux/reconcile_source_helm.go
@@ -38,7 +38,7 @@ var reconcileSourceHelmCmd = &cobra.Command{
Short: "Reconcile a HelmRepository source",
Long: `The reconcile source command triggers a reconciliation of a HelmRepository resource and waits for it to finish.`,
Example: ` # Trigger a reconciliation for an existing source
- gotk reconcile source helm podinfo
+ flux reconcile source helm podinfo
`,
RunE: reconcileSourceHelmCmdRun,
}
diff --git a/cmd/gotk/resume.go b/cmd/flux/resume.go
similarity index 100%
rename from cmd/gotk/resume.go
rename to cmd/flux/resume.go
diff --git a/cmd/gotk/resume_alert.go b/cmd/flux/resume_alert.go
similarity index 99%
rename from cmd/gotk/resume_alert.go
rename to cmd/flux/resume_alert.go
index 3ae0a4e0..98176eb5 100644
--- a/cmd/gotk/resume_alert.go
+++ b/cmd/flux/resume_alert.go
@@ -38,7 +38,7 @@ var resumeAlertCmd = &cobra.Command{
Long: `The resume command marks a previously suspended Alert resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Alert
- gotk resume alert main
+ flux resume alert main
`,
RunE: resumeAlertCmdRun,
}
diff --git a/cmd/gotk/resume_helmrelease.go b/cmd/flux/resume_helmrelease.go
similarity index 99%
rename from cmd/gotk/resume_helmrelease.go
rename to cmd/flux/resume_helmrelease.go
index 0586bd40..cc3a015a 100644
--- a/cmd/gotk/resume_helmrelease.go
+++ b/cmd/flux/resume_helmrelease.go
@@ -39,7 +39,7 @@ var resumeHrCmd = &cobra.Command{
Long: `The resume command marks a previously suspended HelmRelease resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Helm release
- gotk resume hr podinfo
+ flux resume hr podinfo
`,
RunE: resumeHrCmdRun,
}
diff --git a/cmd/gotk/resume_kustomization.go b/cmd/flux/resume_kustomization.go
similarity index 99%
rename from cmd/gotk/resume_kustomization.go
rename to cmd/flux/resume_kustomization.go
index b48541ee..58c65c35 100644
--- a/cmd/gotk/resume_kustomization.go
+++ b/cmd/flux/resume_kustomization.go
@@ -38,7 +38,7 @@ var resumeKsCmd = &cobra.Command{
Long: `The resume command marks a previously suspended Kustomization resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Kustomization
- gotk resume ks podinfo
+ flux resume ks podinfo
`,
RunE: resumeKsCmdRun,
}
diff --git a/cmd/gotk/resume_receiver.go b/cmd/flux/resume_receiver.go
similarity index 99%
rename from cmd/gotk/resume_receiver.go
rename to cmd/flux/resume_receiver.go
index e429080b..54d5e634 100644
--- a/cmd/gotk/resume_receiver.go
+++ b/cmd/flux/resume_receiver.go
@@ -38,7 +38,7 @@ var resumeReceiverCmd = &cobra.Command{
Long: `The resume command marks a previously suspended Receiver resource for reconciliation and waits for it to
finish the apply.`,
Example: ` # Resume reconciliation for an existing Receiver
- gotk resume receiver main
+ flux resume receiver main
`,
RunE: resumeReceiverCmdRun,
}
diff --git a/cmd/gotk/suspend.go b/cmd/flux/suspend.go
similarity index 100%
rename from cmd/gotk/suspend.go
rename to cmd/flux/suspend.go
diff --git a/cmd/gotk/suspend_alert.go b/cmd/flux/suspend_alert.go
similarity index 98%
rename from cmd/gotk/suspend_alert.go
rename to cmd/flux/suspend_alert.go
index c73a7255..2da27a36 100644
--- a/cmd/gotk/suspend_alert.go
+++ b/cmd/flux/suspend_alert.go
@@ -32,7 +32,7 @@ var suspendAlertCmd = &cobra.Command{
Short: "Suspend reconciliation of Alert",
Long: "The suspend command disables the reconciliation of a Alert resource.",
Example: ` # Suspend reconciliation for an existing Alert
- gotk suspend alert main
+ flux suspend alert main
`,
RunE: suspendAlertCmdRun,
}
diff --git a/cmd/gotk/suspend_helmrelease.go b/cmd/flux/suspend_helmrelease.go
similarity index 98%
rename from cmd/gotk/suspend_helmrelease.go
rename to cmd/flux/suspend_helmrelease.go
index 6b7b5b3f..a0d456df 100644
--- a/cmd/gotk/suspend_helmrelease.go
+++ b/cmd/flux/suspend_helmrelease.go
@@ -33,7 +33,7 @@ var suspendHrCmd = &cobra.Command{
Short: "Suspend reconciliation of HelmRelease",
Long: "The suspend command disables the reconciliation of a HelmRelease resource.",
Example: ` # Suspend reconciliation for an existing Helm release
- gotk suspend hr podinfo
+ flux suspend hr podinfo
`,
RunE: suspendHrCmdRun,
}
diff --git a/cmd/gotk/suspend_kustomization.go b/cmd/flux/suspend_kustomization.go
similarity index 98%
rename from cmd/gotk/suspend_kustomization.go
rename to cmd/flux/suspend_kustomization.go
index 447fc25a..2117731e 100644
--- a/cmd/gotk/suspend_kustomization.go
+++ b/cmd/flux/suspend_kustomization.go
@@ -32,7 +32,7 @@ var suspendKsCmd = &cobra.Command{
Short: "Suspend reconciliation of Kustomization",
Long: "The suspend command disables the reconciliation of a Kustomization resource.",
Example: ` # Suspend reconciliation for an existing Kustomization
- gotk suspend ks podinfo
+ flux suspend ks podinfo
`,
RunE: suspendKsCmdRun,
}
diff --git a/cmd/gotk/suspend_receiver.go b/cmd/flux/suspend_receiver.go
similarity index 98%
rename from cmd/gotk/suspend_receiver.go
rename to cmd/flux/suspend_receiver.go
index 58d5bac1..d58a28b0 100644
--- a/cmd/gotk/suspend_receiver.go
+++ b/cmd/flux/suspend_receiver.go
@@ -32,7 +32,7 @@ var suspendReceiverCmd = &cobra.Command{
Short: "Suspend reconciliation of Receiver",
Long: "The suspend command disables the reconciliation of a Receiver resource.",
Example: ` # Suspend reconciliation for an existing Receiver
- gotk suspend receiver main
+ flux suspend receiver main
`,
RunE: suspendReceiverCmdRun,
}
diff --git a/cmd/gotk/uninstall.go b/cmd/flux/uninstall.go
similarity index 97%
rename from cmd/gotk/uninstall.go
rename to cmd/flux/uninstall.go
index 8576cd37..cff20014 100644
--- a/cmd/gotk/uninstall.go
+++ b/cmd/flux/uninstall.go
@@ -37,10 +37,10 @@ var uninstallCmd = &cobra.Command{
Short: "Uninstall the toolkit components",
Long: "The uninstall command removes the namespace, cluster roles, cluster role bindings and CRDs from the cluster.",
Example: ` # 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
`,
RunE: uninstallCmdRun,
}
diff --git a/docs/cmd/gotk.md b/docs/cmd/flux.md
similarity index 54%
rename from docs/cmd/gotk.md
rename to docs/cmd/flux.md
index 046fe5fa..cde824d8 100644
--- a/docs/cmd/gotk.md
+++ b/docs/cmd/flux.md
@@ -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
diff --git a/docs/cmd/gotk_bootstrap.md b/docs/cmd/flux_bootstrap.md
similarity index 89%
rename from docs/cmd/gotk_bootstrap.md
rename to docs/cmd/flux_bootstrap.md
index 9e622c92..9295229c 100644
--- a/docs/cmd/gotk_bootstrap.md
+++ b/docs/cmd/flux_bootstrap.md
@@ -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
diff --git a/docs/cmd/gotk_bootstrap_github.md b/docs/cmd/flux_bootstrap_github.md
similarity index 86%
rename from docs/cmd/gotk_bootstrap_github.md
rename to docs/cmd/flux_bootstrap_github.md
index 7630e27d..bb3d4bc1 100644
--- a/docs/cmd/gotk_bootstrap_github.md
+++ b/docs/cmd/flux_bootstrap_github.md
@@ -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
diff --git a/docs/cmd/gotk_bootstrap_gitlab.md b/docs/cmd/flux_bootstrap_gitlab.md
similarity index 86%
rename from docs/cmd/gotk_bootstrap_gitlab.md
rename to docs/cmd/flux_bootstrap_gitlab.md
index 3ef87b22..e320dff1 100644
--- a/docs/cmd/gotk_bootstrap_gitlab.md
+++ b/docs/cmd/flux_bootstrap_gitlab.md
@@ -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
diff --git a/docs/cmd/gotk_check.md b/docs/cmd/flux_check.md
similarity index 88%
rename from docs/cmd/gotk_check.md
rename to docs/cmd/flux_check.md
index b20823af..d84f6ee8 100644
--- a/docs/cmd/gotk_check.md
+++ b/docs/cmd/flux_check.md
@@ -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
diff --git a/docs/cmd/gotk_completion.md b/docs/cmd/flux_completion.md
similarity index 66%
rename from docs/cmd/gotk_completion.md
rename to docs/cmd/flux_completion.md
index 6bdb75ed..c129c268 100644
--- a/docs/cmd/gotk_completion.md
+++ b/docs/cmd/flux_completion.md
@@ -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
diff --git a/docs/cmd/gotk_completion_bash.md b/docs/cmd/flux_completion_bash.md
similarity index 77%
rename from docs/cmd/gotk_completion_bash.md
rename to docs/cmd/flux_completion_bash.md
index 4fead006..1d774ca6 100644
--- a/docs/cmd/gotk_completion_bash.md
+++ b/docs/cmd/flux_completion_bash.md
@@ -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
diff --git a/docs/cmd/gotk_completion_fish.md b/docs/cmd/flux_completion_fish.md
similarity index 79%
rename from docs/cmd/gotk_completion_fish.md
rename to docs/cmd/flux_completion_fish.md
index 4c636f98..37dd69f8 100644
--- a/docs/cmd/gotk_completion_fish.md
+++ b/docs/cmd/flux_completion_fish.md
@@ -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
diff --git a/docs/cmd/gotk_completion_powershell.md b/docs/cmd/flux_completion_powershell.md
similarity index 77%
rename from docs/cmd/gotk_completion_powershell.md
rename to docs/cmd/flux_completion_powershell.md
index 65621e0a..f2980bb1 100644
--- a/docs/cmd/gotk_completion_powershell.md
+++ b/docs/cmd/flux_completion_powershell.md
@@ -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
diff --git a/docs/cmd/gotk_completion_zsh.md b/docs/cmd/flux_completion_zsh.md
similarity index 68%
rename from docs/cmd/gotk_completion_zsh.md
rename to docs/cmd/flux_completion_zsh.md
index fa63d644..3b7c51fd 100644
--- a/docs/cmd/gotk_completion_zsh.md
+++ b/docs/cmd/flux_completion_zsh.md
@@ -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
diff --git a/docs/cmd/gotk_create.md b/docs/cmd/flux_create.md
similarity index 67%
rename from docs/cmd/gotk_create.md
rename to docs/cmd/flux_create.md
index 8f8c1d36..4f5a8e01 100644
--- a/docs/cmd/gotk_create.md
+++ b/docs/cmd/flux_create.md
@@ -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
diff --git a/docs/cmd/gotk_create_alert-provider.md b/docs/cmd/flux_create_alert-provider.md
similarity index 87%
rename from docs/cmd/gotk_create_alert-provider.md
rename to docs/cmd/flux_create_alert-provider.md
index 53f3f141..80d8cf17 100644
--- a/docs/cmd/gotk_create_alert-provider.md
+++ b/docs/cmd/flux_create_alert-provider.md
@@ -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
diff --git a/docs/cmd/gotk_create_alert.md b/docs/cmd/flux_create_alert.md
similarity index 89%
rename from docs/cmd/gotk_create_alert.md
rename to docs/cmd/flux_create_alert.md
index edf9ff32..c5a2a3fe 100644
--- a/docs/cmd/gotk_create_alert.md
+++ b/docs/cmd/flux_create_alert.md
@@ -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
diff --git a/docs/cmd/gotk_create_helmrelease.md b/docs/cmd/flux_create_helmrelease.md
similarity index 89%
rename from docs/cmd/gotk_create_helmrelease.md
rename to docs/cmd/flux_create_helmrelease.md
index 33d45dba..86fa38ec 100644
--- a/docs/cmd/gotk_create_helmrelease.md
+++ b/docs/cmd/flux_create_helmrelease.md
@@ -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
diff --git a/docs/cmd/gotk_create_kustomization.md b/docs/cmd/flux_create_kustomization.md
similarity index 92%
rename from docs/cmd/gotk_create_kustomization.md
rename to docs/cmd/flux_create_kustomization.md
index b7286732..098fa9e1 100644
--- a/docs/cmd/gotk_create_kustomization.md
+++ b/docs/cmd/flux_create_kustomization.md
@@ -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
diff --git a/docs/cmd/gotk_create_receiver.md b/docs/cmd/flux_create_receiver.md
similarity index 87%
rename from docs/cmd/gotk_create_receiver.md
rename to docs/cmd/flux_create_receiver.md
index a811fcb9..69437bad 100644
--- a/docs/cmd/gotk_create_receiver.md
+++ b/docs/cmd/flux_create_receiver.md
@@ -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
diff --git a/docs/cmd/gotk_create_source.md b/docs/cmd/flux_create_source.md
similarity index 75%
rename from docs/cmd/gotk_create_source.md
rename to docs/cmd/flux_create_source.md
index 1878790c..067cca6d 100644
--- a/docs/cmd/gotk_create_source.md
+++ b/docs/cmd/flux_create_source.md
@@ -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
diff --git a/docs/cmd/gotk_create_source_bucket.md b/docs/cmd/flux_create_source_bucket.md
similarity index 90%
rename from docs/cmd/gotk_create_source_bucket.md
rename to docs/cmd/flux_create_source_bucket.md
index 65c944fd..b1f7b408 100644
--- a/docs/cmd/gotk_create_source_bucket.md
+++ b/docs/cmd/flux_create_source_bucket.md
@@ -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
diff --git a/docs/cmd/gotk_create_source_git.md b/docs/cmd/flux_create_source_git.md
similarity index 89%
rename from docs/cmd/gotk_create_source_git.md
rename to docs/cmd/flux_create_source_git.md
index 00b1cb32..5aa1b984 100644
--- a/docs/cmd/gotk_create_source_git.md
+++ b/docs/cmd/flux_create_source_git.md
@@ -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
diff --git a/docs/cmd/gotk_create_source_helm.md b/docs/cmd/flux_create_source_helm.md
similarity index 89%
rename from docs/cmd/gotk_create_source_helm.md
rename to docs/cmd/flux_create_source_helm.md
index 83d351ed..0d5be022 100644
--- a/docs/cmd/gotk_create_source_helm.md
+++ b/docs/cmd/flux_create_source_helm.md
@@ -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
diff --git a/docs/cmd/gotk_delete.md b/docs/cmd/flux_delete.md
similarity index 60%
rename from docs/cmd/gotk_delete.md
rename to docs/cmd/flux_delete.md
index 4336517a..0e01c53e 100644
--- a/docs/cmd/gotk_delete.md
+++ b/docs/cmd/flux_delete.md
@@ -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
diff --git a/docs/cmd/gotk_delete_alert-provider.md b/docs/cmd/flux_delete_alert-provider.md
similarity index 80%
rename from docs/cmd/gotk_delete_alert-provider.md
rename to docs/cmd/flux_delete_alert-provider.md
index b0ca34fe..66b96181 100644
--- a/docs/cmd/gotk_delete_alert-provider.md
+++ b/docs/cmd/flux_delete_alert-provider.md
@@ -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
diff --git a/docs/cmd/gotk_delete_alert.md b/docs/cmd/flux_delete_alert.md
similarity index 82%
rename from docs/cmd/gotk_delete_alert.md
rename to docs/cmd/flux_delete_alert.md
index a1cca380..f596e32d 100644
--- a/docs/cmd/gotk_delete_alert.md
+++ b/docs/cmd/flux_delete_alert.md
@@ -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
diff --git a/docs/cmd/gotk_delete_helmrelease.md b/docs/cmd/flux_delete_helmrelease.md
similarity index 82%
rename from docs/cmd/gotk_delete_helmrelease.md
rename to docs/cmd/flux_delete_helmrelease.md
index 6ae3031c..dbfc70d2 100644
--- a/docs/cmd/gotk_delete_helmrelease.md
+++ b/docs/cmd/flux_delete_helmrelease.md
@@ -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
diff --git a/docs/cmd/gotk_delete_kustomization.md b/docs/cmd/flux_delete_kustomization.md
similarity index 81%
rename from docs/cmd/gotk_delete_kustomization.md
rename to docs/cmd/flux_delete_kustomization.md
index 463b31a4..d4a2ed25 100644
--- a/docs/cmd/gotk_delete_kustomization.md
+++ b/docs/cmd/flux_delete_kustomization.md
@@ -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
diff --git a/docs/cmd/gotk_delete_receiver.md b/docs/cmd/flux_delete_receiver.md
similarity index 82%
rename from docs/cmd/gotk_delete_receiver.md
rename to docs/cmd/flux_delete_receiver.md
index 1c20287d..bd3324e3 100644
--- a/docs/cmd/gotk_delete_receiver.md
+++ b/docs/cmd/flux_delete_receiver.md
@@ -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
diff --git a/docs/cmd/gotk_delete_source.md b/docs/cmd/flux_delete_source.md
similarity index 69%
rename from docs/cmd/gotk_delete_source.md
rename to docs/cmd/flux_delete_source.md
index ad1b525f..a5442963 100644
--- a/docs/cmd/gotk_delete_source.md
+++ b/docs/cmd/flux_delete_source.md
@@ -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
diff --git a/docs/cmd/gotk_delete_source_bucket.md b/docs/cmd/flux_delete_source_bucket.md
similarity index 79%
rename from docs/cmd/gotk_delete_source_bucket.md
rename to docs/cmd/flux_delete_source_bucket.md
index 5913f662..f4045d18 100644
--- a/docs/cmd/gotk_delete_source_bucket.md
+++ b/docs/cmd/flux_delete_source_bucket.md
@@ -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
diff --git a/docs/cmd/gotk_delete_source_git.md b/docs/cmd/flux_delete_source_git.md
similarity index 80%
rename from docs/cmd/gotk_delete_source_git.md
rename to docs/cmd/flux_delete_source_git.md
index f0315fdb..287e61a1 100644
--- a/docs/cmd/gotk_delete_source_git.md
+++ b/docs/cmd/flux_delete_source_git.md
@@ -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
diff --git a/docs/cmd/gotk_delete_source_helm.md b/docs/cmd/flux_delete_source_helm.md
similarity index 80%
rename from docs/cmd/gotk_delete_source_helm.md
rename to docs/cmd/flux_delete_source_helm.md
index 5d96d882..cd3aed25 100644
--- a/docs/cmd/gotk_delete_source_helm.md
+++ b/docs/cmd/flux_delete_source_helm.md
@@ -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
diff --git a/docs/cmd/gotk_export.md b/docs/cmd/flux_export.md
similarity index 61%
rename from docs/cmd/gotk_export.md
rename to docs/cmd/flux_export.md
index 01b20b2d..4430bc11 100644
--- a/docs/cmd/gotk_export.md
+++ b/docs/cmd/flux_export.md
@@ -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
diff --git a/docs/cmd/gotk_export_alert-provider.md b/docs/cmd/flux_export_alert-provider.md
similarity index 74%
rename from docs/cmd/gotk_export_alert-provider.md
rename to docs/cmd/flux_export_alert-provider.md
index 96fc1804..590759f2 100644
--- a/docs/cmd/gotk_export_alert-provider.md
+++ b/docs/cmd/flux_export_alert-provider.md
@@ -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
diff --git a/docs/cmd/gotk_export_alert.md b/docs/cmd/flux_export_alert.md
similarity index 77%
rename from docs/cmd/gotk_export_alert.md
rename to docs/cmd/flux_export_alert.md
index 37615437..c8bc4e85 100644
--- a/docs/cmd/gotk_export_alert.md
+++ b/docs/cmd/flux_export_alert.md
@@ -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
diff --git a/docs/cmd/gotk_export_helmrelease.md b/docs/cmd/flux_export_helmrelease.md
similarity index 76%
rename from docs/cmd/gotk_export_helmrelease.md
rename to docs/cmd/flux_export_helmrelease.md
index bf192468..68c2d93c 100644
--- a/docs/cmd/gotk_export_helmrelease.md
+++ b/docs/cmd/flux_export_helmrelease.md
@@ -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
diff --git a/docs/cmd/gotk_export_kustomization.md b/docs/cmd/flux_export_kustomization.md
similarity index 74%
rename from docs/cmd/gotk_export_kustomization.md
rename to docs/cmd/flux_export_kustomization.md
index 57116197..6e635f8d 100644
--- a/docs/cmd/gotk_export_kustomization.md
+++ b/docs/cmd/flux_export_kustomization.md
@@ -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
diff --git a/docs/cmd/gotk_export_receiver.md b/docs/cmd/flux_export_receiver.md
similarity index 76%
rename from docs/cmd/gotk_export_receiver.md
rename to docs/cmd/flux_export_receiver.md
index 93bbcaed..a9544316 100644
--- a/docs/cmd/gotk_export_receiver.md
+++ b/docs/cmd/flux_export_receiver.md
@@ -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
diff --git a/docs/cmd/gotk_export_source.md b/docs/cmd/flux_export_source.md
similarity index 72%
rename from docs/cmd/gotk_export_source.md
rename to docs/cmd/flux_export_source.md
index 36b6bb9e..7ab2d58d 100644
--- a/docs/cmd/gotk_export_source.md
+++ b/docs/cmd/flux_export_source.md
@@ -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
diff --git a/docs/cmd/gotk_export_source_bucket.md b/docs/cmd/flux_export_source_bucket.md
similarity index 76%
rename from docs/cmd/gotk_export_source_bucket.md
rename to docs/cmd/flux_export_source_bucket.md
index d5a64173..df5ad19c 100644
--- a/docs/cmd/gotk_export_source_bucket.md
+++ b/docs/cmd/flux_export_source_bucket.md
@@ -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
diff --git a/docs/cmd/gotk_export_source_git.md b/docs/cmd/flux_export_source_git.md
similarity index 77%
rename from docs/cmd/gotk_export_source_git.md
rename to docs/cmd/flux_export_source_git.md
index d6b6543a..df2419fc 100644
--- a/docs/cmd/gotk_export_source_git.md
+++ b/docs/cmd/flux_export_source_git.md
@@ -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
diff --git a/docs/cmd/gotk_export_source_helm.md b/docs/cmd/flux_export_source_helm.md
similarity index 77%
rename from docs/cmd/gotk_export_source_helm.md
rename to docs/cmd/flux_export_source_helm.md
index de5c199f..f4172bf3 100644
--- a/docs/cmd/gotk_export_source_helm.md
+++ b/docs/cmd/flux_export_source_helm.md
@@ -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
diff --git a/docs/cmd/gotk_get.md b/docs/cmd/flux_get.md
similarity index 60%
rename from docs/cmd/gotk_get.md
rename to docs/cmd/flux_get.md
index 6910c368..794eceea 100644
--- a/docs/cmd/gotk_get.md
+++ b/docs/cmd/flux_get.md
@@ -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
diff --git a/docs/cmd/gotk_get_alert-providers.md b/docs/cmd/flux_get_alert-providers.md
similarity index 82%
rename from docs/cmd/gotk_get_alert-providers.md
rename to docs/cmd/flux_get_alert-providers.md
index 70b26301..e570bf60 100644
--- a/docs/cmd/gotk_get_alert-providers.md
+++ b/docs/cmd/flux_get_alert-providers.md
@@ -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
diff --git a/docs/cmd/gotk_get_alerts.md b/docs/cmd/flux_get_alerts.md
similarity index 85%
rename from docs/cmd/gotk_get_alerts.md
rename to docs/cmd/flux_get_alerts.md
index 0fe8bd03..7afda065 100644
--- a/docs/cmd/gotk_get_alerts.md
+++ b/docs/cmd/flux_get_alerts.md
@@ -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
diff --git a/docs/cmd/gotk_get_helmreleases.md b/docs/cmd/flux_get_helmreleases.md
similarity index 83%
rename from docs/cmd/gotk_get_helmreleases.md
rename to docs/cmd/flux_get_helmreleases.md
index 4914d2d2..aec7ab80 100644
--- a/docs/cmd/gotk_get_helmreleases.md
+++ b/docs/cmd/flux_get_helmreleases.md
@@ -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
diff --git a/docs/cmd/gotk_get_kustomizations.md b/docs/cmd/flux_get_kustomizations.md
similarity index 83%
rename from docs/cmd/gotk_get_kustomizations.md
rename to docs/cmd/flux_get_kustomizations.md
index 0a539a2b..08f35b5b 100644
--- a/docs/cmd/gotk_get_kustomizations.md
+++ b/docs/cmd/flux_get_kustomizations.md
@@ -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
diff --git a/docs/cmd/gotk_get_receivers.md b/docs/cmd/flux_get_receivers.md
similarity index 84%
rename from docs/cmd/gotk_get_receivers.md
rename to docs/cmd/flux_get_receivers.md
index 940772eb..23b4f8d1 100644
--- a/docs/cmd/gotk_get_receivers.md
+++ b/docs/cmd/flux_get_receivers.md
@@ -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
diff --git a/docs/cmd/gotk_get_sources.md b/docs/cmd/flux_get_sources.md
similarity index 71%
rename from docs/cmd/gotk_get_sources.md
rename to docs/cmd/flux_get_sources.md
index a33cf5cc..44fc03f9 100644
--- a/docs/cmd/gotk_get_sources.md
+++ b/docs/cmd/flux_get_sources.md
@@ -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
diff --git a/docs/cmd/gotk_get_sources_bucket.md b/docs/cmd/flux_get_sources_bucket.md
similarity index 82%
rename from docs/cmd/gotk_get_sources_bucket.md
rename to docs/cmd/flux_get_sources_bucket.md
index 092031fd..c5e39d1f 100644
--- a/docs/cmd/gotk_get_sources_bucket.md
+++ b/docs/cmd/flux_get_sources_bucket.md
@@ -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
diff --git a/docs/cmd/gotk_get_sources_git.md b/docs/cmd/flux_get_sources_git.md
similarity index 83%
rename from docs/cmd/gotk_get_sources_git.md
rename to docs/cmd/flux_get_sources_git.md
index d6151837..41d35cb7 100644
--- a/docs/cmd/gotk_get_sources_git.md
+++ b/docs/cmd/flux_get_sources_git.md
@@ -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
diff --git a/docs/cmd/gotk_get_sources_helm.md b/docs/cmd/flux_get_sources_helm.md
similarity index 83%
rename from docs/cmd/gotk_get_sources_helm.md
rename to docs/cmd/flux_get_sources_helm.md
index 500f9352..c1231319 100644
--- a/docs/cmd/gotk_get_sources_helm.md
+++ b/docs/cmd/flux_get_sources_helm.md
@@ -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
diff --git a/docs/cmd/gotk_install.md b/docs/cmd/flux_install.md
similarity index 87%
rename from docs/cmd/gotk_install.md
rename to docs/cmd/flux_install.md
index 1f0a0181..99eaba15 100644
--- a/docs/cmd/gotk_install.md
+++ b/docs/cmd/flux_install.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile.md b/docs/cmd/flux_reconcile.md
similarity index 60%
rename from docs/cmd/gotk_reconcile.md
rename to docs/cmd/flux_reconcile.md
index 8e8903fc..feb9525d 100644
--- a/docs/cmd/gotk_reconcile.md
+++ b/docs/cmd/flux_reconcile.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_alert-provider.md b/docs/cmd/flux_reconcile_alert-provider.md
similarity index 78%
rename from docs/cmd/gotk_reconcile_alert-provider.md
rename to docs/cmd/flux_reconcile_alert-provider.md
index 05f392af..e8001f29 100644
--- a/docs/cmd/gotk_reconcile_alert-provider.md
+++ b/docs/cmd/flux_reconcile_alert-provider.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_alert.md b/docs/cmd/flux_reconcile_alert.md
similarity index 81%
rename from docs/cmd/gotk_reconcile_alert.md
rename to docs/cmd/flux_reconcile_alert.md
index 388830bd..b04a8879 100644
--- a/docs/cmd/gotk_reconcile_alert.md
+++ b/docs/cmd/flux_reconcile_alert.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_helmrelease.md b/docs/cmd/flux_reconcile_helmrelease.md
similarity index 80%
rename from docs/cmd/gotk_reconcile_helmrelease.md
rename to docs/cmd/flux_reconcile_helmrelease.md
index f13cbd4f..4daa63aa 100644
--- a/docs/cmd/gotk_reconcile_helmrelease.md
+++ b/docs/cmd/flux_reconcile_helmrelease.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_kustomization.md b/docs/cmd/flux_reconcile_kustomization.md
similarity index 78%
rename from docs/cmd/gotk_reconcile_kustomization.md
rename to docs/cmd/flux_reconcile_kustomization.md
index 92ba2a3c..068b091d 100644
--- a/docs/cmd/gotk_reconcile_kustomization.md
+++ b/docs/cmd/flux_reconcile_kustomization.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_receiver.md b/docs/cmd/flux_reconcile_receiver.md
similarity index 80%
rename from docs/cmd/gotk_reconcile_receiver.md
rename to docs/cmd/flux_reconcile_receiver.md
index c8499f5c..a53a034f 100644
--- a/docs/cmd/gotk_reconcile_receiver.md
+++ b/docs/cmd/flux_reconcile_receiver.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_source.md b/docs/cmd/flux_reconcile_source.md
similarity index 69%
rename from docs/cmd/gotk_reconcile_source.md
rename to docs/cmd/flux_reconcile_source.md
index 5fa64ff5..8a175616 100644
--- a/docs/cmd/gotk_reconcile_source.md
+++ b/docs/cmd/flux_reconcile_source.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_source_bucket.md b/docs/cmd/flux_reconcile_source_bucket.md
similarity index 78%
rename from docs/cmd/gotk_reconcile_source_bucket.md
rename to docs/cmd/flux_reconcile_source_bucket.md
index 997b40bd..679c74ab 100644
--- a/docs/cmd/gotk_reconcile_source_bucket.md
+++ b/docs/cmd/flux_reconcile_source_bucket.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_source_git.md b/docs/cmd/flux_reconcile_source_git.md
similarity index 79%
rename from docs/cmd/gotk_reconcile_source_git.md
rename to docs/cmd/flux_reconcile_source_git.md
index 90920796..6a2edf0d 100644
--- a/docs/cmd/gotk_reconcile_source_git.md
+++ b/docs/cmd/flux_reconcile_source_git.md
@@ -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
diff --git a/docs/cmd/gotk_reconcile_source_helm.md b/docs/cmd/flux_reconcile_source_helm.md
similarity index 79%
rename from docs/cmd/gotk_reconcile_source_helm.md
rename to docs/cmd/flux_reconcile_source_helm.md
index 2e989b96..ce221c42 100644
--- a/docs/cmd/gotk_reconcile_source_helm.md
+++ b/docs/cmd/flux_reconcile_source_helm.md
@@ -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
diff --git a/docs/cmd/gotk_resume.md b/docs/cmd/flux_resume.md
similarity index 64%
rename from docs/cmd/gotk_resume.md
rename to docs/cmd/flux_resume.md
index 0607d4a0..a61d4ebf 100644
--- a/docs/cmd/gotk_resume.md
+++ b/docs/cmd/flux_resume.md
@@ -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
diff --git a/docs/cmd/gotk_resume_alert.md b/docs/cmd/flux_resume_alert.md
similarity index 82%
rename from docs/cmd/gotk_resume_alert.md
rename to docs/cmd/flux_resume_alert.md
index 2e68792b..13efa81b 100644
--- a/docs/cmd/gotk_resume_alert.md
+++ b/docs/cmd/flux_resume_alert.md
@@ -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
diff --git a/docs/cmd/gotk_resume_helmrelease.md b/docs/cmd/flux_resume_helmrelease.md
similarity index 81%
rename from docs/cmd/gotk_resume_helmrelease.md
rename to docs/cmd/flux_resume_helmrelease.md
index 351fc7d5..3905b5ef 100644
--- a/docs/cmd/gotk_resume_helmrelease.md
+++ b/docs/cmd/flux_resume_helmrelease.md
@@ -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
diff --git a/docs/cmd/gotk_resume_kustomization.md b/docs/cmd/flux_resume_kustomization.md
similarity index 81%
rename from docs/cmd/gotk_resume_kustomization.md
rename to docs/cmd/flux_resume_kustomization.md
index 5f6fa7e3..a0a6f898 100644
--- a/docs/cmd/gotk_resume_kustomization.md
+++ b/docs/cmd/flux_resume_kustomization.md
@@ -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
diff --git a/docs/cmd/gotk_resume_receiver.md b/docs/cmd/flux_resume_receiver.md
similarity index 81%
rename from docs/cmd/gotk_resume_receiver.md
rename to docs/cmd/flux_resume_receiver.md
index 56ff4b7b..7e293ca4 100644
--- a/docs/cmd/gotk_resume_receiver.md
+++ b/docs/cmd/flux_resume_receiver.md
@@ -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
diff --git a/docs/cmd/gotk_suspend.md b/docs/cmd/flux_suspend.md
similarity index 66%
rename from docs/cmd/gotk_suspend.md
rename to docs/cmd/flux_suspend.md
index 058bb93a..0b49574a 100644
--- a/docs/cmd/gotk_suspend.md
+++ b/docs/cmd/flux_suspend.md
@@ -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
diff --git a/docs/cmd/gotk_suspend_alert.md b/docs/cmd/flux_suspend_alert.md
similarity index 81%
rename from docs/cmd/gotk_suspend_alert.md
rename to docs/cmd/flux_suspend_alert.md
index c620ea89..8a0f6ff4 100644
--- a/docs/cmd/gotk_suspend_alert.md
+++ b/docs/cmd/flux_suspend_alert.md
@@ -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
diff --git a/docs/cmd/gotk_suspend_helmrelease.md b/docs/cmd/flux_suspend_helmrelease.md
similarity index 81%
rename from docs/cmd/gotk_suspend_helmrelease.md
rename to docs/cmd/flux_suspend_helmrelease.md
index 32703f6f..ea7d9884 100644
--- a/docs/cmd/gotk_suspend_helmrelease.md
+++ b/docs/cmd/flux_suspend_helmrelease.md
@@ -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
diff --git a/docs/cmd/gotk_suspend_kustomization.md b/docs/cmd/flux_suspend_kustomization.md
similarity index 80%
rename from docs/cmd/gotk_suspend_kustomization.md
rename to docs/cmd/flux_suspend_kustomization.md
index 17e0cda0..2844a867 100644
--- a/docs/cmd/gotk_suspend_kustomization.md
+++ b/docs/cmd/flux_suspend_kustomization.md
@@ -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
diff --git a/docs/cmd/gotk_suspend_receiver.md b/docs/cmd/flux_suspend_receiver.md
similarity index 81%
rename from docs/cmd/gotk_suspend_receiver.md
rename to docs/cmd/flux_suspend_receiver.md
index f786239e..0737d308 100644
--- a/docs/cmd/gotk_suspend_receiver.md
+++ b/docs/cmd/flux_suspend_receiver.md
@@ -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
diff --git a/docs/cmd/gotk_uninstall.md b/docs/cmd/flux_uninstall.md
similarity index 83%
rename from docs/cmd/gotk_uninstall.md
rename to docs/cmd/flux_uninstall.md
index 37a8617f..6cf4d08c 100644
--- a/docs/cmd/gotk_uninstall.md
+++ b/docs/cmd/flux_uninstall.md
@@ -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
diff --git a/docs/cmd/gotk_get_alert-provider.md b/docs/cmd/gotk_get_alert-provider.md
deleted file mode 100644
index 538eb2a1..00000000
--- a/docs/cmd/gotk_get_alert-provider.md
+++ /dev/null
@@ -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
-
diff --git a/docs/cmd/gotk_get_alert.md b/docs/cmd/gotk_get_alert.md
deleted file mode 100644
index e84945d8..00000000
--- a/docs/cmd/gotk_get_alert.md
+++ /dev/null
@@ -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
-
diff --git a/docs/cmd/gotk_get_receiver.md b/docs/cmd/gotk_get_receiver.md
deleted file mode 100644
index ca034c47..00000000
--- a/docs/cmd/gotk_get_receiver.md
+++ /dev/null
@@ -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
-
diff --git a/docs/dev-guides/source-watcher.md b/docs/dev-guides/source-watcher.md
index 39fff892..69371db1 100644
--- a/docs/dev-guides/source-watcher.md
+++ b/docs/dev-guides/source-watcher.md
@@ -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
```
diff --git a/docs/faq/index.md b/docs/faq/index.md
index c58c5e12..2c586574 100644
--- a/docs/faq/index.md
+++ b/docs/faq/index.md
@@ -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:
diff --git a/docs/get-started/index.md b/docs/get-started/index.md
index 03c6e031..906c813c 100644
--- a/docs/get-started/index.md
+++ b/docs/get-started/index.md
@@ -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
diff --git a/docs/guides/installation.md b/docs/guides/installation.md
index 0cfc3e43..7f04a42e 100644
--- a/docs/guides/installation.md
+++ b/docs/guides/installation.md
@@ -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
diff --git a/docs/guides/monitoring.md b/docs/guides/monitoring.md
index 80adb113..b8bc2558 100644
--- a/docs/guides/monitoring.md
+++ b/docs/guides/monitoring.md
@@ -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 \
diff --git a/docs/guides/mozilla-sops.md b/docs/guides/mozilla-sops.md
index 37d9326d..d6cb7f3e 100644
--- a/docs/guides/mozilla-sops.md
+++ b/docs/guides/mozilla-sops.md
@@ -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:
diff --git a/docs/guides/sealed-secrets.md b/docs/guides/sealed-secrets.md
index 6a86d361..e6345b32 100644
--- a/docs/guides/sealed-secrets.md
+++ b/docs/guides/sealed-secrets.md
@@ -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.
diff --git a/docs/index.md b/docs/index.md
index c06d793c..cd325172 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -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
diff --git a/install/README.md b/install/README.md
index 014d7eb9..ae152d1e 100644
--- a/install/README.md
+++ b/install/README.md
@@ -1,4 +1,4 @@
-# GOTK CLI Installation
+# flux CLI Installation
Binaries for macOS and Linux AMD64 are available for download on the
[release page](https://github.com/fluxcd/toolkit/releases).
@@ -6,19 +6,19 @@ Binaries for macOS and Linux AMD64 are available for download on the
To install the latest release run:
```bash
-curl -s https://raw.githubusercontent.com/fluxcd/toolkit/master/install/gotk.sh | sudo bash
+curl -s https://raw.githubusercontent.com/fluxcd/toolkit/master/install/flux.sh | sudo bash
```
The install script does the following:
* attempts to detect your OS
* downloads and unpacks the release tar file in a temporary directory
-* copies the gotk binary to `/usr/local/bin`
+* copies the flux binary to `/usr/local/bin`
* removes the temporary directory
-If you want to use gotk as a kubectl plugin, rename the binary to `kubectl-gotk`:
+If you want to use flux as a kubectl plugin, rename the binary to `kubectl-flux`:
```sh
-mv /usr/local/bin/gotk /usr/local/bin/kubectl-gotk
+mv /usr/local/bin/flux /usr/local/bin/kubectl-flux
```
## Build from source
@@ -30,7 +30,7 @@ git clone https://github.com/fluxcd/toolkit
cd toolkit
```
-Build the `gotk` binary (requires go >= 1.14):
+Build the `flux` binary (requires go >= 1.14):
```bash
make build
@@ -39,5 +39,5 @@ make build
Run the binary:
```bash
-./bin/gotk -h
+./bin/flux -h
```
diff --git a/install/gotk.sh b/install/flux.sh
similarity index 86%
rename from install/gotk.sh
rename to install/flux.sh
index 5d99d5e1..103a10c0 100755
--- a/install/gotk.sh
+++ b/install/flux.sh
@@ -68,10 +68,10 @@ verify_downloader() {
# Create tempory directory and cleanup when done
setup_tmp() {
- TMP_DIR=$(mktemp -d -t gotk-install.XXXXXXXXXX)
- TMP_METADATA="${TMP_DIR}/gotk.json"
- TMP_HASH="${TMP_DIR}/gotk.hash"
- TMP_BIN="${TMP_DIR}/gotk.tar.gz"
+ TMP_DIR=$(mktemp -d -t flux-install.XXXXXXXXXX)
+ TMP_METADATA="${TMP_DIR}/flux.json"
+ TMP_HASH="${TMP_DIR}/flux.hash"
+ TMP_BIN="${TMP_DIR}/flux.tar.gz"
cleanup() {
code=$?
set +e
@@ -89,9 +89,9 @@ get_release_version() {
info "Downloading metadata ${METADATA_URL}"
download "${TMP_METADATA}" "${METADATA_URL}"
- VERSION_GOTK=$(grep '"tag_name":' "${TMP_METADATA}" | sed -E 's/.*"([^"]+)".*/\1/' | cut -c 2-)
- if [[ -n "${VERSION_GOTK}" ]]; then
- info "Using ${VERSION_GOTK} as release"
+ VERSION_FLUX=$(grep '"tag_name":' "${TMP_METADATA}" | sed -E 's/.*"([^"]+)".*/\1/' | cut -c 2-)
+ if [[ -n "${VERSION_FLUX}" ]]; then
+ info "Using ${VERSION_FLUX} as release"
else
fatal "Unable to determine release version"
fi
@@ -119,16 +119,16 @@ download() {
# Download hash from Github URL
download_hash() {
- HASH_URL="https://github.com/${GITHUB_REPO}/releases/download/v${VERSION_GOTK}/toolkit_${VERSION_GOTK}_checksums.txt"
+ HASH_URL="https://github.com/${GITHUB_REPO}/releases/download/v${VERSION_FLUX}/toolkit_${VERSION_FLUX}_checksums.txt"
info "Downloading hash ${HASH_URL}"
download "${TMP_HASH}" "${HASH_URL}"
- HASH_EXPECTED=$(grep " gotk_${VERSION_GOTK}_${OS}_${ARCH}.tar.gz$" "${TMP_HASH}")
+ HASH_EXPECTED=$(grep " flux_${VERSION_FLUX}_${OS}_${ARCH}.tar.gz$" "${TMP_HASH}")
HASH_EXPECTED=${HASH_EXPECTED%%[[:blank:]]*}
}
# Download binary from Github URL
download_binary() {
- BIN_URL="https://github.com/${GITHUB_REPO}/releases/download/v${VERSION_GOTK}/gotk_${VERSION_GOTK}_${OS}_${ARCH}.tar.gz"
+ BIN_URL="https://github.com/${GITHUB_REPO}/releases/download/v${VERSION_FLUX}/flux_${VERSION_FLUX}_${OS}_${ARCH}.tar.gz"
info "Downloading binary ${BIN_URL}"
download "${TMP_BIN}" "${BIN_URL}"
}
@@ -161,10 +161,10 @@ verify_binary() {
# Setup permissions and move binary
setup_binary() {
chmod 755 "${TMP_BIN}"
- info "Installing gotk to ${BIN_DIR}/gotk"
+ info "Installing flux to ${BIN_DIR}/flux"
tar -xzf "${TMP_BIN}" -C "${TMP_DIR}"
- local CMD_MOVE="mv -f \"${TMP_DIR}/gotk\" \"${BIN_DIR}\""
+ local CMD_MOVE="mv -f \"${TMP_DIR}/flux\" \"${BIN_DIR}\""
if [[ -w "${BIN_DIR}" ]]; then
eval "${CMD_MOVE}"
else
diff --git a/mkdocs.yml b/mkdocs.yml
index 2d17f64b..42154a1f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -76,70 +76,70 @@ nav:
- Receiver CRD: components/notification/receiver.md
- Notification API Reference: components/notification/api.md
- Toolkit CLI:
- - Overview: cmd/gotk.md
- - Bootstrap: cmd/gotk_bootstrap.md
- - Bootstrap github: cmd/gotk_bootstrap_github.md
- - Bootstrap gitlab: cmd/gotk_bootstrap_gitlab.md
- - Check: cmd/gotk_check.md
- - Create: cmd/gotk_create.md
- - Create kustomization: cmd/gotk_create_kustomization.md
- - Create helmrelease: cmd/gotk_create_helmrelease.md
- - Create source: cmd/gotk_create_source.md
- - Create source git: cmd/gotk_create_source_git.md
- - Create source helm: cmd/gotk_create_source_helm.md
- - Create source bucket: cmd/gotk_create_source_bucket.md
- - Create alert provider: cmd/gotk_create_alert-provider.md
- - Create alert: cmd/gotk_create_alert.md
- - Create receiver: cmd/gotk_create_receiver.md
- #- Create tenant: cmd/gotk_create_tenant.md
- - Delete: cmd/gotk_delete.md
- - Delete kustomization: cmd/gotk_delete_kustomization.md
- - Delete helmrelease: cmd/gotk_delete_helmrelease.md
- - Delete source: cmd/gotk_delete_source.md
- - Delete source git: cmd/gotk_delete_source_git.md
- - Delete source helm: cmd/gotk_delete_source_helm.md
- - Delete source bucket: cmd/gotk_delete_source_bucket.md
- - Export: cmd/gotk_export.md
- - Export kustomization: cmd/gotk_export_kustomization.md
- - Export helmrelease: cmd/gotk_export_helmrelease.md
- - Export source: cmd/gotk_export_source.md
- - Export source git: cmd/gotk_export_source_git.md
- - Export source helm: cmd/gotk_export_source_helm.md
- - Export source bucket: cmd/gotk_export_source_bucket.md
- - Export alert provider: cmd/gotk_export_alert-provider.md
- - Export alert: cmd/gotk_export_alert.md
- - Export receiver: cmd/gotk_export_receiver.md
- - Get: cmd/gotk_get.md
- - Get kustomizations: cmd/gotk_get_kustomizations.md
- - Get helmreleases: cmd/gotk_get_helmreleases.md
- - Get sources: cmd/gotk_get_sources.md
- - Get sources git: cmd/gotk_get_sources_git.md
- - Get sources helm: cmd/gotk_get_sources_helm.md
- - Get sources bucket: cmd/gotk_get_sources_bucket.md
- - Get alert provider: cmd/gotk_get_alert-provider.md
- - Get alert: cmd/gotk_get_alert.md
- - Get receiver: cmd/gotk_get_receiver.md
- - Install: cmd/gotk_install.md
- - Resume: cmd/gotk_resume.md
- - Resume kustomization: cmd/gotk_resume_kustomization.md
- - Resume helmrelease: cmd/gotk_resume_helmrelease.md
- - Resume alert provider: cmd/gotk_resume_alert-provider.md
- - Resume alert: cmd/gotk_resume_alert.md
- - Resume receiver: cmd/gotk_resume_receiver.md
- - Suspend: cmd/gotk_suspend.md
- - Suspend kustomization: cmd/gotk_suspend_kustomization.md
- - Suspend helmrelease: cmd/gotk_suspend_helmrelease.md
- - Suspend alert provider: cmd/gotk_suspend_alert-provider.md
- - Suspend alert: cmd/gotk_suspend_alert.md
- - Suspend receiver: cmd/gotk_suspend_receiver.md
- - Reconcile: cmd/gotk_reconcile.md
- - Reconcile kustomization: cmd/gotk_reconcile_kustomization.md
- - Reconcile helmrelease: cmd/gotk_reconcile_helmrelease.md
- - Reconcile source: cmd/gotk_reconcile_source.md
- - Reconcile source git: cmd/gotk_reconcile_source_git.md
- - Reconcile source helm: cmd/gotk_reconcile_source_helm.md
- - Reconcile source bucket: cmd/gotk_reconcile_source_bucket.md
- - Uninstall: cmd/gotk_uninstall.md
+ - Overview: cmd/flux.md
+ - Bootstrap: cmd/flux_bootstrap.md
+ - Bootstrap github: cmd/flux_bootstrap_github.md
+ - Bootstrap gitlab: cmd/flux_bootstrap_gitlab.md
+ - Check: cmd/flux_check.md
+ - Create: cmd/flux_create.md
+ - Create kustomization: cmd/flux_create_kustomization.md
+ - Create helmrelease: cmd/flux_create_helmrelease.md
+ - Create source: cmd/flux_create_source.md
+ - Create source git: cmd/flux_create_source_git.md
+ - Create source helm: cmd/flux_create_source_helm.md
+ - Create source bucket: cmd/flux_create_source_bucket.md
+ - Create alert provider: cmd/flux_create_alert-provider.md
+ - Create alert: cmd/flux_create_alert.md
+ - Create receiver: cmd/flux_create_receiver.md
+ #- Create tenant: cmd/flux_create_tenant.md
+ - Delete: cmd/flux_delete.md
+ - Delete kustomization: cmd/flux_delete_kustomization.md
+ - Delete helmrelease: cmd/flux_delete_helmrelease.md
+ - Delete source: cmd/flux_delete_source.md
+ - Delete source git: cmd/flux_delete_source_git.md
+ - Delete source helm: cmd/flux_delete_source_helm.md
+ - Delete source bucket: cmd/flux_delete_source_bucket.md
+ - Export: cmd/flux_export.md
+ - Export kustomization: cmd/flux_export_kustomization.md
+ - Export helmrelease: cmd/flux_export_helmrelease.md
+ - Export source: cmd/flux_export_source.md
+ - Export source git: cmd/flux_export_source_git.md
+ - Export source helm: cmd/flux_export_source_helm.md
+ - Export source bucket: cmd/flux_export_source_bucket.md
+ - Export alert provider: cmd/flux_export_alert-provider.md
+ - Export alert: cmd/flux_export_alert.md
+ - Export receiver: cmd/flux_export_receiver.md
+ - Get: cmd/flux_get.md
+ - Get kustomizations: cmd/flux_get_kustomizations.md
+ - Get helmreleases: cmd/flux_get_helmreleases.md
+ - Get sources: cmd/flux_get_sources.md
+ - Get sources git: cmd/flux_get_sources_git.md
+ - Get sources helm: cmd/flux_get_sources_helm.md
+ - Get sources bucket: cmd/flux_get_sources_bucket.md
+ - Get alert provider: cmd/flux_get_alert-provider.md
+ - Get alert: cmd/flux_get_alert.md
+ - Get receiver: cmd/flux_get_receiver.md
+ - Install: cmd/flux_install.md
+ - Resume: cmd/flux_resume.md
+ - Resume kustomization: cmd/flux_resume_kustomization.md
+ - Resume helmrelease: cmd/flux_resume_helmrelease.md
+ - Resume alert provider: cmd/flux_resume_alert-provider.md
+ - Resume alert: cmd/flux_resume_alert.md
+ - Resume receiver: cmd/flux_resume_receiver.md
+ - Suspend: cmd/flux_suspend.md
+ - Suspend kustomization: cmd/flux_suspend_kustomization.md
+ - Suspend helmrelease: cmd/flux_suspend_helmrelease.md
+ - Suspend alert provider: cmd/flux_suspend_alert-provider.md
+ - Suspend alert: cmd/flux_suspend_alert.md
+ - Suspend receiver: cmd/flux_suspend_receiver.md
+ - Reconcile: cmd/flux_reconcile.md
+ - Reconcile kustomization: cmd/flux_reconcile_kustomization.md
+ - Reconcile helmrelease: cmd/flux_reconcile_helmrelease.md
+ - Reconcile source: cmd/flux_reconcile_source.md
+ - Reconcile source git: cmd/flux_reconcile_source_git.md
+ - Reconcile source helm: cmd/flux_reconcile_source_helm.md
+ - Reconcile source bucket: cmd/flux_reconcile_source_bucket.md
+ - Uninstall: cmd/flux_uninstall.md
- Roadmap: roadmap/index.md
- Contributing: contributing/index.md
- Dev Guides:
diff --git a/pkg/manifestgen/doc.go b/pkg/manifestgen/doc.go
index 2629b5f0..9432da29 100644
--- a/pkg/manifestgen/doc.go
+++ b/pkg/manifestgen/doc.go
@@ -14,6 +14,6 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-// Package manifestgen generates Kubernetes manifests for gotk install
-// and the Git source and Kustomization manifests for gotk bootstrap.
+// Package manifestgen generates Kubernetes manifests for flux install
+// and the Git source and Kustomization manifests for flux bootstrap.
package manifestgen
diff --git a/pkg/manifestgen/sync/options.go b/pkg/manifestgen/sync/options.go
index a2739034..411612af 100644
--- a/pkg/manifestgen/sync/options.go
+++ b/pkg/manifestgen/sync/options.go
@@ -35,7 +35,7 @@ func MakeDefaultOptions() Options {
Name: "flux-system",
Namespace: "flux-system",
Branch: "main",
- ManifestFile: "flux-sync.yaml",
+ ManifestFile: "gotk-sync.yaml",
TargetPath: "",
}
}
--
GitLab