diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 61f9eacc9a6a2b69973c7433fb6e33eed956f152..adac0afd95c3c65d7c5eb799b1950672d8d14098 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -53,7 +53,7 @@ jobs: { # install script - cp install/tk.sh docs/install.sh + cp install/gotk.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 c0ee18d930d9dad8f3e1f3263a84253cac7fa3aa..06cbff5502f119eacc70f2d9c2b3c8e3ee66a2f9 100644 --- a/.github/workflows/e2e.yaml +++ b/.github/workflows/e2e.yaml @@ -37,30 +37,30 @@ jobs: exit 1 fi - name: Build - run: sudo go build -o ./bin/tk ./cmd/tk - - name: tk check --pre + run: sudo go build -o ./bin/gotk ./cmd/gotk + - name: gotk check --pre run: | - ./bin/tk check --pre - - name: tk install --version + ./bin/gotk check --pre + - name: gotk install --version run: | - ./bin/tk install --version=master --namespace=test --verbose --components="source-controller,kustomize-controller" - - name: tk uninstall + ./bin/gotk install --version=master --namespace=test --verbose --components="source-controller,kustomize-controller" + - name: gotk uninstall run: | - ./bin/tk uninstall --namespace=test --crds --silent - - name: tk install --manifests + ./bin/gotk uninstall --namespace=test --crds --silent + - name: gotk install --manifests run: | - ./bin/tk install --manifests ./manifests/install/ --version="" - - name: tk create source git + ./bin/gotk install --manifests ./manifests/install/ --version="" + - name: gotk create source git run: | - ./bin/tk create source git podinfo \ + ./bin/gotk create source git podinfo \ --url https://github.com/stefanprodan/podinfo \ --tag-semver=">=3.2.3" - - name: tk get sources git + - name: gotk get sources git run: | - ./bin/tk get sources git - - name: tk create kustomization + ./bin/gotk get sources git + - name: gotk create kustomization run: | - ./bin/tk create kustomization podinfo \ + ./bin/gotk create kustomization podinfo \ --source=podinfo \ --path="./deploy/overlays/dev" \ --prune=true \ @@ -69,54 +69,54 @@ jobs: --health-check="Deployment/frontend.dev" \ --health-check="Deployment/backend.dev" \ --health-check-timeout=3m - - name: tk sync kustomization --with-source + - name: gotk sync kustomization --with-source run: | - ./bin/tk reconcile kustomization podinfo --with-source - - name: tk get kustomizations + ./bin/gotk reconcile kustomization podinfo --with-source + - name: gotk get kustomizations run: | - ./bin/tk get kustomizations - - name: tk suspend kustomization + ./bin/gotk get kustomizations + - name: gotk suspend kustomization run: | - ./bin/tk suspend kustomization podinfo - - name: tk resume kustomization + ./bin/gotk suspend kustomization podinfo + - name: gotk resume kustomization run: | - ./bin/tk resume kustomization podinfo - - name: tk export + ./bin/gotk resume kustomization podinfo + - name: gotk export run: | - ./bin/tk export source git --all - ./bin/tk export kustomization --all - - name: tk delete kustomization + ./bin/gotk export source git --all + ./bin/gotk export kustomization --all + - name: gotk delete kustomization run: | - ./bin/tk delete kustomization podinfo --silent - - name: tk delete source git + ./bin/gotk delete kustomization podinfo --silent + - name: gotk delete source git run: | - ./bin/tk delete source git podinfo --silent - - name: tk create source helm + ./bin/gotk delete source git podinfo --silent + - name: gotk create source helm run: | - ./bin/tk create source helm podinfo \ + ./bin/gotk create source helm podinfo \ --url https://stefanprodan.github.io/podinfo - - name: tk create helmrelease + - name: gotk create helmrelease run: | - ./bin/tk create hr podinfo \ + ./bin/gotk create hr podinfo \ --target-namespace=default \ --source=podinfo \ --chart-name=podinfo \ --chart-version=">4.0.0 <5.0.0" - - name: tk get helmreleases + - name: gotk get helmreleases run: | - ./bin/tk get helmreleases - - name: tk export helmrelease + ./bin/gotk get helmreleases + - name: gotk export helmrelease run: | - ./bin/tk export hr --all - - name: tk delete helmrelease + ./bin/gotk export hr --all + - name: gotk delete helmrelease run: | - ./bin/tk delete hr podinfo --silent - - name: tk delete source helm + ./bin/gotk delete hr podinfo --silent + - name: gotk delete source helm run: | - ./bin/tk delete source helm podinfo --silent - - name: tk check + ./bin/gotk delete source helm podinfo --silent + - name: gotk check run: | - ./bin/tk check + ./bin/gotk check - name: Debug failure if: failure() run: | diff --git a/.goreleaser.yml b/.goreleaser.yml index 1111fb9d970845de2b9b96fdf51c0378b242aacc..44d275fb4a389c3f8fc288e435fe8adbff0cbfaf 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,8 +1,8 @@ builds: - - main: ./cmd/tk + - main: ./cmd/gotk ldflags: - -s -w -X main.VERSION={{ .Version }} - binary: tk + binary: gotk goos: - darwin - linux diff --git a/Makefile b/Makefile index 6a25ecf58b892ea2ea37f6d4b765a3d7b15587c9..45c19b813904a7c666d75af9b5b48b68f20f8375 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -VERSION?=$(shell grep 'VERSION' cmd/tk/main.go | awk '{ print $$4 }' | tr -d '"') +VERSION?=$(shell grep 'VERSION' cmd/gotk/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/tk ./cmd/tk + CGO_ENABLED=0 go build -o ./bin/gotk ./cmd/gotk install: - go install cmd/tk + go install cmd/gotk .PHONY: docs docs: - mkdir -p ./docs/cmd && go run ./cmd/tk/ docgen + mkdir -p ./docs/cmd && go run ./cmd/gotk/ docgen install-dev: - CGO_ENABLED=0 go build -o /usr/local/bin ./cmd/tk + CGO_ENABLED=0 go build -o /usr/local/bin ./cmd/gotk diff --git a/README.md b/README.md index 7e07a258f0d9839bddff59856272235d3c90823d..8abca9069044262af1126184d14e73b96128a819 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,6 @@ Experimental toolkit for assembling CD pipelines the GitOps way. - + To get started with the toolkit please read the [docs](https://toolkit.fluxcd.io/). diff --git a/cmd/tk/bootstrap.go b/cmd/gotk/bootstrap.go similarity index 96% rename from cmd/tk/bootstrap.go rename to cmd/gotk/bootstrap.go index e9595eb1fe34f8a86b39fa620c14cb1841920acb..33b2d18069e76a5b90e14c85d13aabd536dd79dc 100644 --- a/cmd/tk/bootstrap.go +++ b/cmd/gotk/bootstrap.go @@ -71,14 +71,14 @@ func init() { } func generateInstallManifests(targetPath, namespace, tmpDir string) (string, error) { - tkDir := path.Join(tmpDir, ".tk") - defer os.RemoveAll(tkDir) + gotkDir := path.Join(tmpDir, ".gotk") + defer os.RemoveAll(gotkDir) - if err := os.MkdirAll(tkDir, os.ModePerm); err != nil { + if err := os.MkdirAll(gotkDir, os.ModePerm); err != nil { return "", fmt.Errorf("generating manifests failed: %w", err) } - if err := genInstallManifests(bootstrapVersion, namespace, bootstrapComponents, bootstrapRegistry, bootstrapImagePullSecret, tkDir); err != nil { + if err := genInstallManifests(bootstrapVersion, namespace, bootstrapComponents, bootstrapRegistry, bootstrapImagePullSecret, gotkDir); err != nil { return "", fmt.Errorf("generating manifests failed: %w", err) } @@ -88,7 +88,7 @@ func generateInstallManifests(targetPath, namespace, tmpDir string) (string, err } manifest := path.Join(manifestsDir, bootstrapInstallManifest) - if err := buildKustomization(tkDir, manifest); err != nil { + if err := buildKustomization(gotkDir, manifest); err != nil { return "", fmt.Errorf("build kustomization failed: %w", err) } diff --git a/cmd/tk/bootstrap_github.go b/cmd/gotk/bootstrap_github.go similarity index 91% rename from cmd/tk/bootstrap_github.go rename to cmd/gotk/bootstrap_github.go index ad4a6fbbb75df037daf6a45b5a59c33c00e0df10..cba98cde8dda7c84b9a5e15859d82dd5c59a4bc1 100644 --- a/cmd/tk/bootstrap_github.go +++ b/cmd/gotk/bootstrap_github.go @@ -42,19 +42,19 @@ 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 - tk bootstrap github --owner=<organization> --repository=<repo name> + gotk bootstrap github --owner=<organization> --repository=<repo name> # Run bootstrap for a private repo and assign organization teams to it - tk bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug> + gotk bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug> # Run bootstrap for a repository path - tk bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster + gotk bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster # Run bootstrap for a public repository on a personal account - tk bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true + gotk bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true # Run bootstrap for a private repo hosted on GitHub Enterprise - tk bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain> + gotk bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain> `, RunE: bootstrapGitHubCmdRun, } @@ -93,7 +93,7 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error { return fmt.Errorf("%s environment variable not found", git.GitHubTokenName) } - repository, err := git.NewRepository(ghRepository, ghOwner, ghHostname, ghToken, "tk", ghOwner+"@users.noreply.github.com") + repository, err := git.NewRepository(ghRepository, ghOwner, ghHostname, ghToken, "gotk", ghOwner+"@users.noreply.github.com") if err != nil { return err } @@ -194,9 +194,9 @@ func bootstrapGitHubCmdRun(cmd *cobra.Command, args []string) error { return fmt.Errorf("generating deploy key failed: %w", err) } - keyName := "tk" + keyName := "gotk" if ghPath != "" { - keyName = fmt.Sprintf("tk-%s", ghPath) + keyName = fmt.Sprintf("gotk-%s", ghPath) } if changed, err := provider.AddDeployKey(ctx, repository, key, keyName); err != nil { diff --git a/cmd/tk/bootstrap_gitlab.go b/cmd/gotk/bootstrap_gitlab.go similarity index 93% rename from cmd/tk/bootstrap_gitlab.go rename to cmd/gotk/bootstrap_gitlab.go index 2b8a5aac9c7352563a26f386dfc73d6590dc054c..7043c786e1a13865d403827c6cafeb090ddde575 100644 --- a/cmd/tk/bootstrap_gitlab.go +++ b/cmd/gotk/bootstrap_gitlab.go @@ -42,16 +42,16 @@ the bootstrap command will perform an upgrade if needed.`, export GITLAB_TOKEN=<my-token> # Run bootstrap for a private repo owned by a GitLab group - tk bootstrap gitlab --owner=<group> --repository=<repo name> + gotk bootstrap gitlab --owner=<group> --repository=<repo name> # Run bootstrap for a repository path - tk bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster + gotk bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster # Run bootstrap for a public repository on a personal account - tk bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true + gotk bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true # Run bootstrap for a private repo hosted on a GitLab server - tk bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain> + gotk bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain> `, RunE: bootstrapGitLabCmdRun, } @@ -86,7 +86,7 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error { return fmt.Errorf("%s environment variable not found", git.GitLabTokenName) } - repository, err := git.NewRepository(glRepository, glOwner, glHostname, glToken, "tk", glOwner+"@users.noreply.gitlab.com") + repository, err := git.NewRepository(glRepository, glOwner, glHostname, glToken, "gotk", glOwner+"@users.noreply.gitlab.com") if err != nil { return err } @@ -178,9 +178,9 @@ func bootstrapGitLabCmdRun(cmd *cobra.Command, args []string) error { return fmt.Errorf("generating deploy key failed: %w", err) } - keyName := "tk" + keyName := "gotk" if glPath != "" { - keyName = fmt.Sprintf("tk-%s", glPath) + keyName = fmt.Sprintf("gotk-%s", glPath) } if changed, err := provider.AddDeployKey(ctx, repository, key, keyName); err != nil { diff --git a/cmd/tk/check.go b/cmd/gotk/check.go similarity index 99% rename from cmd/tk/check.go rename to cmd/gotk/check.go index 2b376ccc6c29857ebb1ef32fa7ad7d4ff087203c..c9c4af54e3b4251b511a87a94d0b04ca15136ea7 100644 --- a/cmd/tk/check.go +++ b/cmd/gotk/check.go @@ -35,10 +35,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 - tk check --pre + gotk check --pre # Run installation checks - tk check + gotk check `, RunE: runCheckCmd, } diff --git a/cmd/tk/completion.go b/cmd/gotk/completion.go similarity index 96% rename from cmd/tk/completion.go rename to cmd/gotk/completion.go index 763b1746eef34d8b0457af8b412e14e61177039f..54f855b7866a38e3e6a9a8d9531b68d77fabb43f 100644 --- a/cmd/tk/completion.go +++ b/cmd/gotk/completion.go @@ -27,12 +27,12 @@ var completionCmd = &cobra.Command{ Short: "Generates bash completion scripts", Example: `To load completion run -. <(tk completion) +. <(gotk completion) To configure your bash shell to load completions for each session add to your bashrc # ~/.bashrc or ~/.profile -. <(tk completion) +. <(gotk completion) `, Run: func(cmd *cobra.Command, args []string) { rootCmd.GenBashCompletion(os.Stdout) diff --git a/cmd/tk/create.go b/cmd/gotk/create.go similarity index 100% rename from cmd/tk/create.go rename to cmd/gotk/create.go diff --git a/cmd/tk/create_helmrelease.go b/cmd/gotk/create_helmrelease.go similarity index 98% rename from cmd/tk/create_helmrelease.go rename to cmd/gotk/create_helmrelease.go index 9eebebd9fd5aeb026f26391b7fa07306bc9e645d..687e8f41d1ab9265b9cc0d380681acff4f438970 100644 --- a/cmd/tk/create_helmrelease.go +++ b/cmd/gotk/create_helmrelease.go @@ -42,7 +42,7 @@ 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 from a source - tk create hr podinfo \ + gotk create hr podinfo \ --interval=10m \ --release-name=podinfo \ --target-namespace=default \ @@ -51,7 +51,7 @@ var createHelmReleaseCmd = &cobra.Command{ --chart-version=">4.0.0" # Create a HelmRelease with values for a local YAML file - tk create hr podinfo \ + gotk create hr podinfo \ --target-namespace=default \ --source=podinfo \ --chart-name=podinfo \ @@ -59,7 +59,7 @@ var createHelmReleaseCmd = &cobra.Command{ --values=./my-values.yaml # Create a HelmRelease definition on disk without applying it on the cluster - tk create hr podinfo \ + gotk create hr podinfo \ --target-namespace=default \ --source=podinfo \ --chart-name=podinfo \ diff --git a/cmd/tk/create_kustomization.go b/cmd/gotk/create_kustomization.go similarity index 98% rename from cmd/tk/create_kustomization.go rename to cmd/gotk/create_kustomization.go index 92b8057c84a111ac627eb0bb1cfc5c5cf515ee96..4c6d3d120c94ac46588854b61ff27dccc603ee15 100644 --- a/cmd/tk/create_kustomization.go +++ b/cmd/gotk/create_kustomization.go @@ -40,7 +40,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 GitRepository source.", Example: ` # Create a Kustomization resource from a source at a given path - tk create kustomization contour \ + gotk create kustomization contour \ --source=contour \ --path="./examples/contour/" \ --prune=true \ @@ -51,7 +51,7 @@ var createKsCmd = &cobra.Command{ --health-check-timeout=3m # Create a Kustomization resource that depends on the previous one - tk create kustomization webapp \ + gotk create kustomization webapp \ --depends-on=contour \ --source=webapp \ --path="./deploy/overlays/dev" \ @@ -60,7 +60,7 @@ var createKsCmd = &cobra.Command{ --validation=client # Create a Kustomization resource that runs under a service account - tk create kustomization webapp \ + gotk create kustomization webapp \ --source=webapp \ --path="./deploy/overlays/staging" \ --prune=true \ diff --git a/cmd/tk/create_source.go b/cmd/gotk/create_source.go similarity index 100% rename from cmd/tk/create_source.go rename to cmd/gotk/create_source.go diff --git a/cmd/tk/create_source_git.go b/cmd/gotk/create_source_git.go similarity index 98% rename from cmd/tk/create_source_git.go rename to cmd/gotk/create_source_git.go index 31f3635c94d1ded7a349f595d7ca5fbce51b52d1..bb08e2043b0bd32d516ef151f5891ffe83793de0 100644 --- a/cmd/tk/create_source_git.go +++ b/cmd/gotk/create_source_git.go @@ -46,35 +46,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 - tk create source git podinfo \ + gotk create source git podinfo \ --url=https://github.com/stefanprodan/podinfo \ --branch=master # Create a source from a Git repository pinned to specific git tag - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk create source git podinfo \ --url=https://github.com/stefanprodan/podinfo \ --username=username \ --password=password diff --git a/cmd/tk/create_source_helm.go b/cmd/gotk/create_source_helm.go similarity index 98% rename from cmd/tk/create_source_helm.go rename to cmd/gotk/create_source_helm.go index 2037989cf45987652760c11a3eec64cc4353fba6..4bbfbe720340861e9a4ab8b3bbcb34589205f9cf 100644 --- a/cmd/tk/create_source_helm.go +++ b/cmd/gotk/create_source_helm.go @@ -40,18 +40,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 - tk create source helm podinfo \ + gotk create source helm podinfo \ --url=https://stefanprodan.github.io/podinfo \ --interval=10m # Create a source from a Helm repository using basic authentication - tk create source helm podinfo \ + gotk create source helm podinfo \ --url=https://stefanprodan.github.io/podinfo \ --username=username \ --password=password # Create a source from a Helm repository using TLS authentication - tk create source helm podinfo \ + gotk create source helm podinfo \ --url=https://stefanprodan.github.io/podinfo \ --cert-file=./cert.crt \ --key-file=./key.crt \ diff --git a/cmd/tk/delete.go b/cmd/gotk/delete.go similarity index 100% rename from cmd/tk/delete.go rename to cmd/gotk/delete.go diff --git a/cmd/tk/delete_helmrelease.go b/cmd/gotk/delete_helmrelease.go similarity index 98% rename from cmd/tk/delete_helmrelease.go rename to cmd/gotk/delete_helmrelease.go index 367fc13992b76dedcb497c1da21834e4eee2a910..87e208ed757fa13c7057f4602fdff03b86cb300d 100644 --- a/cmd/tk/delete_helmrelease.go +++ b/cmd/gotk/delete_helmrelease.go @@ -33,7 +33,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 - tk delete hr podinfo + gotk delete hr podinfo `, RunE: deleteHelmReleaseCmdRun, } diff --git a/cmd/tk/delete_kustomization.go b/cmd/gotk/delete_kustomization.go similarity index 98% rename from cmd/tk/delete_kustomization.go rename to cmd/gotk/delete_kustomization.go index 68c61851bdbf27fc7203f3e00925331d1ea37497..a3a49c6f8079d2d8a85fdf6884004afb7a7d2155 100644 --- a/cmd/tk/delete_kustomization.go +++ b/cmd/gotk/delete_kustomization.go @@ -32,7 +32,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 - tk delete kustomization podinfo + gotk delete kustomization podinfo `, RunE: deleteKsCmdRun, } diff --git a/cmd/tk/delete_source.go b/cmd/gotk/delete_source.go similarity index 100% rename from cmd/tk/delete_source.go rename to cmd/gotk/delete_source.go diff --git a/cmd/tk/delete_source_git.go b/cmd/gotk/delete_source_git.go similarity index 98% rename from cmd/tk/delete_source_git.go rename to cmd/gotk/delete_source_git.go index e307905e3b196d5ed93398caffa402a921c5051c..3deaf417e670a56588fe27a556f55deab354cbf5 100644 --- a/cmd/tk/delete_source_git.go +++ b/cmd/gotk/delete_source_git.go @@ -31,7 +31,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 - tk delete source git podinfo + gotk delete source git podinfo `, RunE: deleteSourceGitCmdRun, } diff --git a/cmd/tk/delete_source_helm.go b/cmd/gotk/delete_source_helm.go similarity index 98% rename from cmd/tk/delete_source_helm.go rename to cmd/gotk/delete_source_helm.go index 6dbe8397093c7abb38b07bf35f087f48651447dd..100921c19e6c3a60ee9e20d18c593dcef1c229f4 100644 --- a/cmd/tk/delete_source_helm.go +++ b/cmd/gotk/delete_source_helm.go @@ -31,7 +31,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 - tk delete source helm podinfo + gotk delete source helm podinfo `, RunE: deleteSourceHelmCmdRun, } diff --git a/cmd/tk/export.go b/cmd/gotk/export.go similarity index 100% rename from cmd/tk/export.go rename to cmd/gotk/export.go diff --git a/cmd/tk/export_helmrelease.go b/cmd/gotk/export_helmrelease.go similarity index 96% rename from cmd/tk/export_helmrelease.go rename to cmd/gotk/export_helmrelease.go index 4d7c08beb9d0f54c72b9978b1e05ac4ff610184d..6a5fdcdc560951afb213cf787d206847748d0c8b 100644 --- a/cmd/tk/export_helmrelease.go +++ b/cmd/gotk/export_helmrelease.go @@ -35,10 +35,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 - tk export helmrelease --all > kustomizations.yaml + gotk export helmrelease --all > kustomizations.yaml # Export a HelmRelease - tk export hr my-app > app-release.yaml + gotk export hr my-app > app-release.yaml `, RunE: exportHelmReleaseCmdRun, } diff --git a/cmd/tk/export_kustomization.go b/cmd/gotk/export_kustomization.go similarity index 96% rename from cmd/tk/export_kustomization.go rename to cmd/gotk/export_kustomization.go index 71032de4eab197791081626c90e7cf96431e8ca7..205a4757d394fd39af0a677e7199cb6eb948c5c8 100644 --- a/cmd/tk/export_kustomization.go +++ b/cmd/gotk/export_kustomization.go @@ -34,10 +34,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 - tk export kustomization --all > kustomizations.yaml + gotk export kustomization --all > kustomizations.yaml # Export a Kustomization - tk export kustomization my-app > kustomization.yaml + gotk export kustomization my-app > kustomization.yaml `, RunE: exportKsCmdRun, } diff --git a/cmd/tk/export_source.go b/cmd/gotk/export_source.go similarity index 100% rename from cmd/tk/export_source.go rename to cmd/gotk/export_source.go diff --git a/cmd/tk/export_source_git.go b/cmd/gotk/export_source_git.go similarity index 97% rename from cmd/tk/export_source_git.go rename to cmd/gotk/export_source_git.go index f891748c5c9d4473aab8faadb3e4825b39a31e52..7b08ac40c5503ef68e9f7b5acad44233615cf37e 100644 --- a/cmd/tk/export_source_git.go +++ b/cmd/gotk/export_source_git.go @@ -34,10 +34,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 - tk export source git --all > sources.yaml + gotk export source git --all > sources.yaml # Export a GitRepository source including the SSH key pair or basic auth credentials - tk export source git my-private-repo --with-credentials > source.yaml + gotk export source git my-private-repo --with-credentials > source.yaml `, RunE: exportSourceGitCmdRun, } diff --git a/cmd/tk/export_source_helm.go b/cmd/gotk/export_source_helm.go similarity index 96% rename from cmd/tk/export_source_helm.go rename to cmd/gotk/export_source_helm.go index 1026693c744df5cd493a74fb08a9b7189799582e..7d2b34893c6c315490c792e72c3c6126a523bc8a 100644 --- a/cmd/tk/export_source_helm.go +++ b/cmd/gotk/export_source_helm.go @@ -34,10 +34,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 - tk export source helm --all > sources.yaml + gotk export source helm --all > sources.yaml # Export a HelmRepository source including the basic auth credentials - tk export source helm my-private-repo --with-credentials > source.yaml + gotk export source helm my-private-repo --with-credentials > source.yaml `, RunE: exportSourceHelmCmdRun, } diff --git a/cmd/tk/flags.go b/cmd/gotk/flags.go similarity index 100% rename from cmd/tk/flags.go rename to cmd/gotk/flags.go diff --git a/cmd/tk/get.go b/cmd/gotk/get.go similarity index 100% rename from cmd/tk/get.go rename to cmd/gotk/get.go diff --git a/cmd/tk/get_helmrelease.go b/cmd/gotk/get_helmrelease.go similarity index 99% rename from cmd/tk/get_helmrelease.go rename to cmd/gotk/get_helmrelease.go index 585d05188a8d66f42ba90f93f8c80d2aa2289f35..4fdf3e7503ca0369b4bf01687e74748f72383e72 100644 --- a/cmd/tk/get_helmrelease.go +++ b/cmd/gotk/get_helmrelease.go @@ -32,7 +32,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 - tk get helmreleases + gotk get helmreleases `, RunE: getHelmReleaseCmdRun, } diff --git a/cmd/tk/get_kustomization.go b/cmd/gotk/get_kustomization.go similarity index 98% rename from cmd/tk/get_kustomization.go rename to cmd/gotk/get_kustomization.go index 83ad4aacf24cef1ee95e0c7d67fded28241622ea..32c2d5e44e97ec6ff663ea3bb40ec5a99bbc6829 100644 --- a/cmd/tk/get_kustomization.go +++ b/cmd/gotk/get_kustomization.go @@ -31,7 +31,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 - tk get kustomizations + gotk get kustomizations `, RunE: getKsCmdRun, } diff --git a/cmd/tk/get_source.go b/cmd/gotk/get_source.go similarity index 100% rename from cmd/tk/get_source.go rename to cmd/gotk/get_source.go diff --git a/cmd/tk/get_source_git.go b/cmd/gotk/get_source_git.go similarity index 98% rename from cmd/tk/get_source_git.go rename to cmd/gotk/get_source_git.go index 9492a2c5213f51e19c87fa9d498b73a4f6427fd4..73a9aff2e401f2735e577a45a2ac9279456efdbb 100644 --- a/cmd/tk/get_source_git.go +++ b/cmd/gotk/get_source_git.go @@ -30,7 +30,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 - tk get sources git + gotk get sources git `, RunE: getSourceGitCmdRun, } diff --git a/cmd/tk/get_source_helm.go b/cmd/gotk/get_source_helm.go similarity index 98% rename from cmd/tk/get_source_helm.go rename to cmd/gotk/get_source_helm.go index 04d46635733f2c72ac8bdf8c8b0f0ea758bfc73b..0ca4abcfd34fdda3a3fe0005b36165f3ce2bdf08 100644 --- a/cmd/tk/get_source_helm.go +++ b/cmd/gotk/get_source_helm.go @@ -30,7 +30,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 - tk get sources helm + gotk get sources helm `, RunE: getSourceHelmCmdRun, } diff --git a/cmd/tk/install.go b/cmd/gotk/install.go similarity index 97% rename from cmd/tk/install.go rename to cmd/gotk/install.go index cdc164a7ddd7c1ffeeea83c8cbd73afea9ec40bd..fe1761158a00118d2b241fd390d690c6b92c74d4 100644 --- a/cmd/tk/install.go +++ b/cmd/gotk/install.go @@ -39,16 +39,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 gitops-systems namespace - tk install --version=latest --namespace=gitops-systems + gotk install --version=latest --namespace=gitops-systems # Dry-run install for a specific version and a series of components - tk install --dry-run --version=v0.0.7 --components="source-controller,kustomize-controller" + gotk install --dry-run --version=v0.0.7 --components="source-controller,kustomize-controller" # Dry-run install with manifests preview - tk install --dry-run --verbose + gotk install --dry-run --verbose # Write install manifests to file - tk install --export > gitops-system.yaml + gotk install --export > gitops-system.yaml `, RunE: installCmdRun, } diff --git a/cmd/tk/log.go b/cmd/gotk/log.go similarity index 100% rename from cmd/tk/log.go rename to cmd/gotk/log.go diff --git a/cmd/tk/main.go b/cmd/gotk/main.go similarity index 84% rename from cmd/tk/main.go rename to cmd/gotk/main.go index 1ac64299c43ae6ada6532edc1f931e4740039d2b..8ba5a45c37a61ab975643740a2251d285952c027 100644 --- a/cmd/tk/main.go +++ b/cmd/gotk/main.go @@ -26,41 +26,41 @@ import ( "github.com/spf13/cobra/doc" _ "k8s.io/client-go/plugin/pkg/client/auth" - tklog "github.com/fluxcd/toolkit/pkg/log" + gotklog "github.com/fluxcd/toolkit/pkg/log" ) var VERSION = "0.0.0-dev.0" var rootCmd = &cobra.Command{ - Use: "tk", + Use: "gotk", 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 - tk check --pre + gotk check --pre # Install the latest version of the toolkit - tk install --version=master + gotk install --version=master # Create a source from a public Git repository - tk create source git webapp-latest \ + gotk create source git webapp-latest \ --url=https://github.com/stefanprodan/podinfo \ --branch=master \ --interval=3m # List GitRepository sources and their status - tk get sources git + gotk get sources git # Trigger a GitRepository source reconciliation - tk reconcile source git gitops-system + gotk reconcile source git gitops-system # Export GitRepository sources in YAML format - tk export source git --all > sources.yaml + gotk export source git --all > sources.yaml # Create a Kustomization for deploying a series of microservices - tk create kustomization webapp-dev \ + gotk create kustomization webapp-dev \ --source=webapp-latest \ --path="./deploy/webapp/" \ --prune=true \ @@ -71,25 +71,25 @@ var rootCmd = &cobra.Command{ --health-check-timeout=2m # Trigger a git sync of the Kustomization's source and apply changes - tk reconcile kustomization webapp-dev --with-source + gotk reconcile kustomization webapp-dev --with-source # Suspend a Kustomization reconciliation - tk suspend kustomization webapp-dev + gotk suspend kustomization webapp-dev # Export Kustomizations in YAML format - tk export kustomization --all > kustomizations.yaml + gotk export kustomization --all > kustomizations.yaml # Resume a Kustomization reconciliation - tk resume kustomization webapp-dev + gotk resume kustomization webapp-dev # Delete a Kustomization - tk delete kustomization webapp-dev + gotk delete kustomization webapp-dev # Delete a GitRepository source - tk delete source git webapp-latest + gotk delete source git webapp-latest # Uninstall the toolkit and delete CRDs - tk uninstall --crds + gotk uninstall --crds `, } @@ -99,8 +99,8 @@ var ( timeout time.Duration verbose bool utils Utils - pollInterval = 2 * time.Second - logger tklog.Logger = printLogger{} + pollInterval = 2 * time.Second + logger gotklog.Logger = printLogger{} ) var ( diff --git a/cmd/tk/reconcile.go b/cmd/gotk/reconcile.go similarity index 100% rename from cmd/tk/reconcile.go rename to cmd/gotk/reconcile.go diff --git a/cmd/tk/reconcile_helmrelease.go b/cmd/gotk/reconcile_helmrelease.go similarity index 98% rename from cmd/tk/reconcile_helmrelease.go rename to cmd/gotk/reconcile_helmrelease.go index fa4a4073438bc38bfa0b8d0b456dcd0c933fc12f..9bbab9945c4887abd62371bdf59a5942bb8b177a 100644 --- a/cmd/tk/reconcile_helmrelease.go +++ b/cmd/gotk/reconcile_helmrelease.go @@ -37,10 +37,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 - tk reconcile hr podinfo + gotk reconcile hr podinfo # Trigger a reconciliation of the HelmRelease's source and apply changes - tk reconcile hr podinfo --with-source + gotk reconcile hr podinfo --with-source `, RunE: reconcileHrCmdRun, } diff --git a/cmd/tk/reconcile_kustomization.go b/cmd/gotk/reconcile_kustomization.go similarity index 97% rename from cmd/tk/reconcile_kustomization.go rename to cmd/gotk/reconcile_kustomization.go index 42cee7a56fe1390e5cd791bada0925230c737ff0..8d6ab920cb6f1483eb152aa0a0bce035ee1da0c8 100644 --- a/cmd/tk/reconcile_kustomization.go +++ b/cmd/gotk/reconcile_kustomization.go @@ -34,10 +34,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 - tk reconcile kustomization podinfo + gotk reconcile kustomization podinfo # Trigger a sync of the Kustomization's source and apply changes - tk reconcile kustomization podinfo --with-source + gotk reconcile kustomization podinfo --with-source `, RunE: reconcileKsCmdRun, } diff --git a/cmd/tk/reconcile_source.go b/cmd/gotk/reconcile_source.go similarity index 100% rename from cmd/tk/reconcile_source.go rename to cmd/gotk/reconcile_source.go diff --git a/cmd/tk/reconcile_source_git.go b/cmd/gotk/reconcile_source_git.go similarity index 98% rename from cmd/tk/reconcile_source_git.go rename to cmd/gotk/reconcile_source_git.go index 9b0aaf01f0f60258c67f0dc302573cdd98a4ffac..04739f4d4bbb2d531a4e1b04739cdeb213ac4f04 100644 --- a/cmd/tk/reconcile_source_git.go +++ b/cmd/gotk/reconcile_source_git.go @@ -31,7 +31,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 - tk reconcile source git podinfo + gotk reconcile source git podinfo `, RunE: syncSourceGitCmdRun, } diff --git a/cmd/tk/reconcile_source_helm.go b/cmd/gotk/reconcile_source_helm.go similarity index 98% rename from cmd/tk/reconcile_source_helm.go rename to cmd/gotk/reconcile_source_helm.go index efffc261e6b57a52476769fb313d20e87f02c613..0a2afea71a8defc12dce9aad6e0947f34ce427a0 100644 --- a/cmd/tk/reconcile_source_helm.go +++ b/cmd/gotk/reconcile_source_helm.go @@ -35,7 +35,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 - tk reconcile source helm podinfo + gotk reconcile source helm podinfo `, RunE: syncSourceHelmCmdRun, } diff --git a/cmd/tk/resume.go b/cmd/gotk/resume.go similarity index 100% rename from cmd/tk/resume.go rename to cmd/gotk/resume.go diff --git a/cmd/tk/resume_helmrelease.go b/cmd/gotk/resume_helmrelease.go similarity index 99% rename from cmd/tk/resume_helmrelease.go rename to cmd/gotk/resume_helmrelease.go index a98ac07cc28c2c65a166222018f1dfb7beb5b1c7..21b1615dec288b5021a37606d65b40ab5d08611d 100644 --- a/cmd/tk/resume_helmrelease.go +++ b/cmd/gotk/resume_helmrelease.go @@ -36,7 +36,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 - tk resume hr podinfo + gotk resume hr podinfo `, RunE: resumeHrCmdRun, } diff --git a/cmd/tk/resume_kustomization.go b/cmd/gotk/resume_kustomization.go similarity index 99% rename from cmd/tk/resume_kustomization.go rename to cmd/gotk/resume_kustomization.go index bac1bf8893d71e6d0f0f56f707069d53bd448fee..e6550c2f08d1030c4b23578b010f21433dcf7fe2 100644 --- a/cmd/tk/resume_kustomization.go +++ b/cmd/gotk/resume_kustomization.go @@ -36,7 +36,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 - tk resume ks podinfo + gotk resume ks podinfo `, RunE: resumeKsCmdRun, } diff --git a/cmd/tk/suspend.go b/cmd/gotk/suspend.go similarity index 100% rename from cmd/tk/suspend.go rename to cmd/gotk/suspend.go diff --git a/cmd/tk/suspend_helmrelease.go b/cmd/gotk/suspend_helmrelease.go similarity index 98% rename from cmd/tk/suspend_helmrelease.go rename to cmd/gotk/suspend_helmrelease.go index c7840ef7ff4fae02bac0d5367df6d5c3390d0c54..cd42e3117c40b7db8d23705c019525cd1885d6c0 100644 --- a/cmd/tk/suspend_helmrelease.go +++ b/cmd/gotk/suspend_helmrelease.go @@ -32,7 +32,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 - tk suspend hr podinfo + gotk suspend hr podinfo `, RunE: suspendHrCmdRun, } diff --git a/cmd/tk/suspend_kustomization.go b/cmd/gotk/suspend_kustomization.go similarity index 98% rename from cmd/tk/suspend_kustomization.go rename to cmd/gotk/suspend_kustomization.go index 0a9593f5eb8e67de1605871d3ee62aab236a19be..1d6d23adf6c502cf10c32b976e0943421eff6b4d 100644 --- a/cmd/tk/suspend_kustomization.go +++ b/cmd/gotk/suspend_kustomization.go @@ -30,7 +30,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 - tk suspend ks podinfo + gotk suspend ks podinfo `, RunE: suspendKsCmdRun, } diff --git a/cmd/tk/uninstall.go b/cmd/gotk/uninstall.go similarity index 96% rename from cmd/tk/uninstall.go rename to cmd/gotk/uninstall.go index 5aca8a24a600d29e9bfbf08178f1bfec92c2707d..4c85f90a97e5e65910d96cb454b85c320bce04eb 100644 --- a/cmd/tk/uninstall.go +++ b/cmd/gotk/uninstall.go @@ -32,10 +32,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 - tk uninstall --dry-run --namespace=gitops-system + gotk uninstall --dry-run --namespace=gitops-system # Uninstall all components and delete custom resource definitions - tk uninstall --resources --crds --namespace=gitops-system + gotk uninstall --resources --crds --namespace=gitops-system `, RunE: uninstallCmdRun, } diff --git a/cmd/tk/utils.go b/cmd/gotk/utils.go similarity index 100% rename from cmd/tk/utils.go rename to cmd/gotk/utils.go diff --git a/docs/cmd/tk.md b/docs/cmd/gotk.md similarity index 52% rename from docs/cmd/tk.md rename to docs/cmd/gotk.md index ec88eccbc7a9d5d5069d93a79dc07026fef16817..c12df913ac04210fc5af74d9bee879f3bc88dfcf 100644 --- a/docs/cmd/tk.md +++ b/docs/cmd/gotk.md @@ -1,4 +1,4 @@ -## tk +## gotk 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 - tk check --pre + gotk check --pre # Install the latest version of the toolkit - tk install --version=master + gotk install --version=master # Create a source from a public Git repository - tk create source git webapp-latest \ + gotk create source git webapp-latest \ --url=https://github.com/stefanprodan/podinfo \ --branch=master \ --interval=3m # List GitRepository sources and their status - tk get sources git + gotk get sources git # Trigger a GitRepository source reconciliation - tk reconcile source git gitops-system + gotk reconcile source git gitops-system # Export GitRepository sources in YAML format - tk export source git --all > sources.yaml + gotk export source git --all > sources.yaml # Create a Kustomization for deploying a series of microservices - tk create kustomization webapp-dev \ + gotk 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 - tk reconcile kustomization webapp-dev --with-source + gotk reconcile kustomization webapp-dev --with-source # Suspend a Kustomization reconciliation - tk suspend kustomization webapp-dev + gotk suspend kustomization webapp-dev # Export Kustomizations in YAML format - tk export kustomization --all > kustomizations.yaml + gotk export kustomization --all > kustomizations.yaml # Resume a Kustomization reconciliation - tk resume kustomization webapp-dev + gotk resume kustomization webapp-dev # Delete a Kustomization - tk delete kustomization webapp-dev + gotk delete kustomization webapp-dev # Delete a GitRepository source - tk delete source git webapp-latest + gotk delete source git webapp-latest # Uninstall the toolkit and delete CRDs - tk uninstall --crds + gotk uninstall --crds ``` ### Options ``` - -h, --help help for tk + -h, --help help for gotk --kubeconfig string path to the kubeconfig file (default "~/.kube/config") --namespace string the namespace scope for this operation (default "gitops-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 -* [tk bootstrap](tk_bootstrap.md) - Bootstrap toolkit components -* [tk check](tk_check.md) - Check requirements and installation -* [tk completion](tk_completion.md) - Generates bash completion scripts -* [tk create](tk_create.md) - Create or update sources and resources -* [tk delete](tk_delete.md) - Delete sources and resources -* [tk export](tk_export.md) - Export resources in YAML format -* [tk get](tk_get.md) - Get sources and resources -* [tk install](tk_install.md) - Install the toolkit components -* [tk reconcile](tk_reconcile.md) - Reconcile sources and resources -* [tk resume](tk_resume.md) - Resume suspended resources -* [tk suspend](tk_suspend.md) - Suspend resources -* [tk uninstall](tk_uninstall.md) - Uninstall the toolkit components +* [gotk bootstrap](gotk_bootstrap.md) - Bootstrap toolkit components +* [gotk check](gotk_check.md) - Check requirements and installation +* [gotk completion](gotk_completion.md) - Generates bash completion scripts +* [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 diff --git a/docs/cmd/tk_bootstrap.md b/docs/cmd/gotk_bootstrap.md similarity index 77% rename from docs/cmd/tk_bootstrap.md rename to docs/cmd/gotk_bootstrap.md index 163dd26fcf46af696ddce6489c84a177d74925d5..aaa3f81ced001050f844d0986590a11c5ca3eabf 100644 --- a/docs/cmd/tk_bootstrap.md +++ b/docs/cmd/gotk_bootstrap.md @@ -1,4 +1,4 @@ -## tk bootstrap +## gotk bootstrap Bootstrap toolkit components @@ -27,7 +27,7 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk bootstrap github](tk_bootstrap_github.md) - Bootstrap toolkit components in a GitHub repository -* [tk bootstrap gitlab](tk_bootstrap_gitlab.md) - Bootstrap toolkit components in a GitLab repository +* [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 diff --git a/docs/cmd/tk_bootstrap_github.md b/docs/cmd/gotk_bootstrap_github.md similarity index 79% rename from docs/cmd/tk_bootstrap_github.md rename to docs/cmd/gotk_bootstrap_github.md index 2a27cd4b324bff8eee656ec40ce5721d91c0d1d4..1162a0d1410e96d641796de6d6eb58af4ab6279c 100644 --- a/docs/cmd/tk_bootstrap_github.md +++ b/docs/cmd/gotk_bootstrap_github.md @@ -1,4 +1,4 @@ -## tk bootstrap github +## gotk 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. ``` -tk bootstrap github [flags] +gotk bootstrap github [flags] ``` ### Examples @@ -21,19 +21,19 @@ tk bootstrap github [flags] export GITHUB_TOKEN=<my-token> # Run bootstrap for a private repo owned by a GitHub organization - tk bootstrap github --owner=<organization> --repository=<repo name> + gotk bootstrap github --owner=<organization> --repository=<repo name> # Run bootstrap for a private repo and assign organization teams to it - tk bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug> + gotk bootstrap github --owner=<organization> --repository=<repo name> --team=<team1 slug> --team=<team2 slug> # Run bootstrap for a repository path - tk bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster + gotk bootstrap github --owner=<organization> --repository=<repo name> --path=dev-cluster # Run bootstrap for a public repository on a personal account - tk bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true + gotk bootstrap github --owner=<user> --repository=<repo name> --private=false --personal=true # Run bootstrap for a private repo hosted on GitHub Enterprise - tk bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain> + gotk bootstrap github --owner=<organization> --repository=<repo name> --hostname=<domain> ``` @@ -66,5 +66,5 @@ tk bootstrap github [flags] ### SEE ALSO -* [tk bootstrap](tk_bootstrap.md) - Bootstrap toolkit components +* [gotk bootstrap](gotk_bootstrap.md) - Bootstrap toolkit components diff --git a/docs/cmd/tk_bootstrap_gitlab.md b/docs/cmd/gotk_bootstrap_gitlab.md similarity index 83% rename from docs/cmd/tk_bootstrap_gitlab.md rename to docs/cmd/gotk_bootstrap_gitlab.md index 9294349a075731b326191575329c014d18f0e940..dda38ac1bebdc0dcae35a89587dae93caa31883c 100644 --- a/docs/cmd/tk_bootstrap_gitlab.md +++ b/docs/cmd/gotk_bootstrap_gitlab.md @@ -1,4 +1,4 @@ -## tk bootstrap gitlab +## gotk 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. ``` -tk bootstrap gitlab [flags] +gotk bootstrap gitlab [flags] ``` ### Examples @@ -21,16 +21,16 @@ tk bootstrap gitlab [flags] export GITLAB_TOKEN=<my-token> # Run bootstrap for a private repo owned by a GitLab group - tk bootstrap gitlab --owner=<group> --repository=<repo name> + gotk bootstrap gitlab --owner=<group> --repository=<repo name> # Run bootstrap for a repository path - tk bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster + gotk bootstrap gitlab --owner=<group> --repository=<repo name> --path=dev-cluster # Run bootstrap for a public repository on a personal account - tk bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true + gotk bootstrap gitlab --owner=<user> --repository=<repo name> --private=false --personal=true # Run bootstrap for a private repo hosted on a GitLab server - tk bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain> + gotk bootstrap gitlab --owner=<group> --repository=<repo name> --hostname=<domain> ``` @@ -63,5 +63,5 @@ tk bootstrap gitlab [flags] ### SEE ALSO -* [tk bootstrap](tk_bootstrap.md) - Bootstrap toolkit components +* [gotk bootstrap](gotk_bootstrap.md) - Bootstrap toolkit components diff --git a/docs/cmd/tk_check.md b/docs/cmd/gotk_check.md similarity index 86% rename from docs/cmd/tk_check.md rename to docs/cmd/gotk_check.md index b5e6d5d7c4ff98d4464d255930e798d0cc405ff4..c0fcff777498c4a57434d8468a62b553ca745f59 100644 --- a/docs/cmd/tk_check.md +++ b/docs/cmd/gotk_check.md @@ -1,4 +1,4 @@ -## tk check +## gotk 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. ``` -tk check [flags] +gotk check [flags] ``` ### Examples ``` # Run pre-installation checks - tk check --pre + gotk check --pre # Run installation checks - tk check + gotk check ``` @@ -41,5 +41,5 @@ tk check [flags] ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines diff --git a/docs/cmd/tk_completion.md b/docs/cmd/gotk_completion.md similarity index 80% rename from docs/cmd/tk_completion.md rename to docs/cmd/gotk_completion.md index 79cc46c7920d03b8f35bc662666af2b845eb9be2..6deae89f6b88de8489e09fc70d47b4f90c361023 100644 --- a/docs/cmd/tk_completion.md +++ b/docs/cmd/gotk_completion.md @@ -1,4 +1,4 @@ -## tk completion +## gotk completion Generates bash completion scripts @@ -7,7 +7,7 @@ Generates bash completion scripts Generates bash completion scripts ``` -tk completion [flags] +gotk completion [flags] ``` ### Examples @@ -15,12 +15,12 @@ tk completion [flags] ``` To load completion run -. <(tk completion) +. <(gotk completion) To configure your bash shell to load completions for each session add to your bashrc # ~/.bashrc or ~/.profile -. <(tk completion) +. <(gotk completion) ``` @@ -41,5 +41,5 @@ To configure your bash shell to load completions for each session add to your ba ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines diff --git a/docs/cmd/tk_create.md b/docs/cmd/gotk_create.md similarity index 64% rename from docs/cmd/tk_create.md rename to docs/cmd/gotk_create.md index c326e11a4698cd0e29ba1ea82e406da80211120c..c626eb4ed6c7d9d73a06b5e4cc0a3ed37358e50c 100644 --- a/docs/cmd/tk_create.md +++ b/docs/cmd/gotk_create.md @@ -1,4 +1,4 @@ -## tk create +## gotk create Create or update sources and resources @@ -25,8 +25,8 @@ The create sub-commands generate sources and resources. ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk create helmrelease](tk_create_helmrelease.md) - Create or update a HelmRelease resource -* [tk create kustomization](tk_create_kustomization.md) - Create or update a Kustomization resource -* [tk create source](tk_create_source.md) - Create or update sources +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [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 source](gotk_create_source.md) - Create or update sources diff --git a/docs/cmd/tk_create_helmrelease.md b/docs/cmd/gotk_create_helmrelease.md similarity index 90% rename from docs/cmd/tk_create_helmrelease.md rename to docs/cmd/gotk_create_helmrelease.md index 1ed082e0076f184b766f208b19a007dcb4529ceb..a01e4bbb9181a2c1f3d23be87ddd3e5651e95e14 100644 --- a/docs/cmd/tk_create_helmrelease.md +++ b/docs/cmd/gotk_create_helmrelease.md @@ -1,4 +1,4 @@ -## tk create helmrelease +## gotk create helmrelease Create or update a HelmRelease resource @@ -7,14 +7,14 @@ Create or update a HelmRelease resource The helmrelease create command generates a HelmRelease resource for a given HelmRepository source. ``` -tk create helmrelease [name] [flags] +gotk create helmrelease [name] [flags] ``` ### Examples ``` # Create a HelmRelease from a source - tk create hr podinfo \ + gotk create hr podinfo \ --interval=10m \ --release-name=podinfo \ --target-namespace=default \ @@ -23,7 +23,7 @@ tk create helmrelease [name] [flags] --chart-version=">4.0.0" # Create a HelmRelease with values for a local YAML file - tk create hr podinfo \ + gotk create hr podinfo \ --target-namespace=default \ --source=podinfo \ --chart-name=podinfo \ @@ -31,7 +31,7 @@ tk create helmrelease [name] [flags] --values=./my-values.yaml # Create a HelmRelease definition on disk without applying it on the cluster - tk create hr podinfo \ + gotk create hr podinfo \ --target-namespace=default \ --source=podinfo \ --chart-name=podinfo \ @@ -67,5 +67,5 @@ tk create helmrelease [name] [flags] ### SEE ALSO -* [tk create](tk_create.md) - Create or update sources and resources +* [gotk create](gotk_create.md) - Create or update sources and resources diff --git a/docs/cmd/tk_create_kustomization.md b/docs/cmd/gotk_create_kustomization.md similarity index 90% rename from docs/cmd/tk_create_kustomization.md rename to docs/cmd/gotk_create_kustomization.md index 0523a5f4b701b1851600607c4317653588ccdd5d..171f6c0f37c3e4b2dacf10613ad04e7e87ea53b8 100644 --- a/docs/cmd/tk_create_kustomization.md +++ b/docs/cmd/gotk_create_kustomization.md @@ -1,4 +1,4 @@ -## tk create kustomization +## gotk 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 GitRepository source. ``` -tk create kustomization [name] [flags] +gotk create kustomization [name] [flags] ``` ### Examples ``` # Create a Kustomization resource from a source at a given path - tk create kustomization contour \ + gotk create kustomization contour \ --source=contour \ --path="./examples/contour/" \ --prune=true \ @@ -25,7 +25,7 @@ tk create kustomization [name] [flags] --health-check-timeout=3m # Create a Kustomization resource that depends on the previous one - tk create kustomization webapp \ + gotk create kustomization webapp \ --depends-on=contour \ --source=webapp \ --path="./deploy/overlays/dev" \ @@ -34,7 +34,7 @@ tk create kustomization [name] [flags] --validation=client # Create a Kustomization resource that runs under a service account - tk create kustomization webapp \ + gotk create kustomization webapp \ --source=webapp \ --path="./deploy/overlays/staging" \ --prune=true \ @@ -73,5 +73,5 @@ tk create kustomization [name] [flags] ### SEE ALSO -* [tk create](tk_create.md) - Create or update sources and resources +* [gotk create](gotk_create.md) - Create or update sources and resources diff --git a/docs/cmd/tk_create_source.md b/docs/cmd/gotk_create_source.md similarity index 68% rename from docs/cmd/tk_create_source.md rename to docs/cmd/gotk_create_source.md index 170694c9bdd5feb72f56930dc86f78181015884e..d64c16b3b2650b6823a4fa4ce86502f8d2a5c7d5 100644 --- a/docs/cmd/tk_create_source.md +++ b/docs/cmd/gotk_create_source.md @@ -1,4 +1,4 @@ -## tk create source +## gotk create source Create or update sources @@ -25,7 +25,7 @@ The create source sub-commands generate sources. ### SEE ALSO -* [tk create](tk_create.md) - Create or update sources and resources -* [tk create source git](tk_create_source_git.md) - Create or update a GitRepository source -* [tk create source helm](tk_create_source_helm.md) - Create or update a HelmRepository source +* [gotk create](gotk_create.md) - Create or update sources and resources +* [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 diff --git a/docs/cmd/tk_create_source_git.md b/docs/cmd/gotk_create_source_git.md similarity index 88% rename from docs/cmd/tk_create_source_git.md rename to docs/cmd/gotk_create_source_git.md index d7d55525a4e01692433105946586e123b14bc4aa..cebd3d38c0737871a6df0312a70e91803f434dc3 100644 --- a/docs/cmd/tk_create_source_git.md +++ b/docs/cmd/gotk_create_source_git.md @@ -1,4 +1,4 @@ -## tk create source git +## gotk 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. ``` -tk create source git [name] [flags] +gotk create source git [name] [flags] ``` ### Examples ``` # Create a source from a public Git repository master branch - tk create source git podinfo \ + gotk create source git podinfo \ --url=https://github.com/stefanprodan/podinfo \ --branch=master # Create a source from a Git repository pinned to specific git tag - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk 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 - tk create source git podinfo \ + gotk create source git podinfo \ --url=https://github.com/stefanprodan/podinfo \ --username=username \ --password=password @@ -80,5 +80,5 @@ tk create source git [name] [flags] ### SEE ALSO -* [tk create source](tk_create_source.md) - Create or update sources +* [gotk create source](gotk_create_source.md) - Create or update sources diff --git a/docs/cmd/tk_create_source_helm.md b/docs/cmd/gotk_create_source_helm.md similarity index 87% rename from docs/cmd/tk_create_source_helm.md rename to docs/cmd/gotk_create_source_helm.md index c7254692690b5465e1e25ebd876c3303a09df83a..ebe2d17bdc840f4ce43ad7d1f159b9219f5495f4 100644 --- a/docs/cmd/tk_create_source_helm.md +++ b/docs/cmd/gotk_create_source_helm.md @@ -1,4 +1,4 @@ -## tk create source helm +## gotk 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. ``` -tk create source helm [name] [flags] +gotk create source helm [name] [flags] ``` ### Examples ``` # Create a source from a public Helm repository - tk create source helm podinfo \ + gotk create source helm podinfo \ --url=https://stefanprodan.github.io/podinfo \ --interval=10m # Create a source from a Helm repository using basic authentication - tk create source helm podinfo \ + gotk create source helm podinfo \ --url=https://stefanprodan.github.io/podinfo \ --username=username \ --password=password # Create a source from a Helm repository using TLS authentication - tk create source helm podinfo \ + gotk create source helm podinfo \ --url=https://stefanprodan.github.io/podinfo \ --cert-file=./cert.crt \ --key-file=./key.crt \ @@ -60,5 +60,5 @@ tk create source helm [name] [flags] ### SEE ALSO -* [tk create source](tk_create_source.md) - Create or update sources +* [gotk create source](gotk_create_source.md) - Create or update sources diff --git a/docs/cmd/tk_delete.md b/docs/cmd/gotk_delete.md similarity index 63% rename from docs/cmd/tk_delete.md rename to docs/cmd/gotk_delete.md index b61bfac3666380243eb26d0c20e0c4a88e657e89..75d2f5e8e922118a712369ba0ec0196c8a81df64 100644 --- a/docs/cmd/tk_delete.md +++ b/docs/cmd/gotk_delete.md @@ -1,4 +1,4 @@ -## tk delete +## gotk delete Delete sources and resources @@ -24,8 +24,8 @@ The delete sub-commands delete sources and resources. ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk delete helmrelease](tk_delete_helmrelease.md) - Delete a HelmRelease resource -* [tk delete kustomization](tk_delete_kustomization.md) - Delete a Kustomization resource -* [tk delete source](tk_delete_source.md) - Delete sources +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk delete helmrelease](gotk_delete_helmrelease.md) - Delete a HelmRelease resource +* [gotk delete kustomization](gotk_delete_kustomization.md) - Delete a Kustomization resource +* [gotk delete source](gotk_delete_source.md) - Delete sources diff --git a/docs/cmd/tk_delete_helmrelease.md b/docs/cmd/gotk_delete_helmrelease.md similarity index 82% rename from docs/cmd/tk_delete_helmrelease.md rename to docs/cmd/gotk_delete_helmrelease.md index be4001531d073b44a562bcea0a5eb9c03a48704b..c46a17555461953df1fd70aa45226fa3d15635d8 100644 --- a/docs/cmd/tk_delete_helmrelease.md +++ b/docs/cmd/gotk_delete_helmrelease.md @@ -1,4 +1,4 @@ -## tk delete helmrelease +## gotk 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. ``` -tk delete helmrelease [name] [flags] +gotk delete helmrelease [name] [flags] ``` ### Examples ``` # Delete a Helm release and the Kubernetes resources created by it - tk delete hr podinfo + gotk delete hr podinfo ``` @@ -36,5 +36,5 @@ tk delete helmrelease [name] [flags] ### SEE ALSO -* [tk delete](tk_delete.md) - Delete sources and resources +* [gotk delete](gotk_delete.md) - Delete sources and resources diff --git a/docs/cmd/tk_delete_kustomization.md b/docs/cmd/gotk_delete_kustomization.md similarity index 81% rename from docs/cmd/tk_delete_kustomization.md rename to docs/cmd/gotk_delete_kustomization.md index 12465377ba9478db8810551f7fd3d481d7627e1f..919f92f517f96f7852f21aac1e44881884a5cd5f 100644 --- a/docs/cmd/tk_delete_kustomization.md +++ b/docs/cmd/gotk_delete_kustomization.md @@ -1,4 +1,4 @@ -## tk delete kustomization +## gotk 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. ``` -tk delete kustomization [name] [flags] +gotk delete kustomization [name] [flags] ``` ### Examples ``` # Delete a kustomization and the Kubernetes resources created by it - tk delete kustomization podinfo + gotk delete kustomization podinfo ``` @@ -36,5 +36,5 @@ tk delete kustomization [name] [flags] ### SEE ALSO -* [tk delete](tk_delete.md) - Delete sources and resources +* [gotk delete](gotk_delete.md) - Delete sources and resources diff --git a/docs/cmd/tk_delete_source.md b/docs/cmd/gotk_delete_source.md similarity index 68% rename from docs/cmd/tk_delete_source.md rename to docs/cmd/gotk_delete_source.md index 10ceb172166b9bbda1a2129145a089c9101fe41b..7bb32eca974739c57df78d72b45c2cf1db49e6b1 100644 --- a/docs/cmd/tk_delete_source.md +++ b/docs/cmd/gotk_delete_source.md @@ -1,4 +1,4 @@ -## tk delete source +## gotk delete source Delete sources @@ -24,7 +24,7 @@ The delete source sub-commands delete sources. ### SEE ALSO -* [tk delete](tk_delete.md) - Delete sources and resources -* [tk delete source git](tk_delete_source_git.md) - Delete a GitRepository source -* [tk delete source helm](tk_delete_source_helm.md) - Delete a HelmRepository source +* [gotk delete](gotk_delete.md) - Delete sources and resources +* [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 diff --git a/docs/cmd/tk_delete_source_git.md b/docs/cmd/gotk_delete_source_git.md similarity index 80% rename from docs/cmd/tk_delete_source_git.md rename to docs/cmd/gotk_delete_source_git.md index 81447b2f35d7afb2ddce6284487d3c556363a385..2087440a8979679f7318a19967eb3d30c981b6ac 100644 --- a/docs/cmd/tk_delete_source_git.md +++ b/docs/cmd/gotk_delete_source_git.md @@ -1,4 +1,4 @@ -## tk delete source git +## gotk 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. ``` -tk delete source git [name] [flags] +gotk delete source git [name] [flags] ``` ### Examples ``` # Delete a Git repository - tk delete source git podinfo + gotk delete source git podinfo ``` @@ -36,5 +36,5 @@ tk delete source git [name] [flags] ### SEE ALSO -* [tk delete source](tk_delete_source.md) - Delete sources +* [gotk delete source](gotk_delete_source.md) - Delete sources diff --git a/docs/cmd/tk_delete_source_helm.md b/docs/cmd/gotk_delete_source_helm.md similarity index 80% rename from docs/cmd/tk_delete_source_helm.md rename to docs/cmd/gotk_delete_source_helm.md index 18daa63f6b5c8d27cfaf9f723c99686afb7c4f66..2698668e0ecf283ff09521cfc8e4f9e0b457ce76 100644 --- a/docs/cmd/tk_delete_source_helm.md +++ b/docs/cmd/gotk_delete_source_helm.md @@ -1,4 +1,4 @@ -## tk delete source helm +## gotk 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. ``` -tk delete source helm [name] [flags] +gotk delete source helm [name] [flags] ``` ### Examples ``` # Delete a Helm repository - tk delete source helm podinfo + gotk delete source helm podinfo ``` @@ -36,5 +36,5 @@ tk delete source helm [name] [flags] ### SEE ALSO -* [tk delete source](tk_delete_source.md) - Delete sources +* [gotk delete source](gotk_delete_source.md) - Delete sources diff --git a/docs/cmd/tk_export.md b/docs/cmd/gotk_export.md similarity index 60% rename from docs/cmd/tk_export.md rename to docs/cmd/gotk_export.md index 917de19c69633a4fe627028ea2f4975a6cb0f082..a41ffe787f56b265c7c98d0e40b15ef2a6c1dff0 100644 --- a/docs/cmd/tk_export.md +++ b/docs/cmd/gotk_export.md @@ -1,4 +1,4 @@ -## tk export +## gotk export Export resources in YAML format @@ -24,8 +24,8 @@ The export sub-commands export resources in YAML format. ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk export helmrelease](tk_export_helmrelease.md) - Export HelmRelease resources in YAML format -* [tk export kustomization](tk_export_kustomization.md) - Export Kustomization resources in YAML format -* [tk export source](tk_export_source.md) - Export sources +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [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 source](gotk_export_source.md) - Export sources diff --git a/docs/cmd/tk_export_helmrelease.md b/docs/cmd/gotk_export_helmrelease.md similarity index 75% rename from docs/cmd/tk_export_helmrelease.md rename to docs/cmd/gotk_export_helmrelease.md index 308fb6f7c7027e011a23a70a9422fdcc2afb0a71..0499987b4102e8df48131dc9a989bc4d3b2da5eb 100644 --- a/docs/cmd/tk_export_helmrelease.md +++ b/docs/cmd/gotk_export_helmrelease.md @@ -1,4 +1,4 @@ -## tk export helmrelease +## gotk 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. ``` -tk export helmrelease [name] [flags] +gotk export helmrelease [name] [flags] ``` ### Examples ``` # Export all HelmRelease resources - tk export helmrelease --all > kustomizations.yaml + gotk export helmrelease --all > kustomizations.yaml # Export a HelmRelease - tk export hr my-app > app-release.yaml + gotk export hr my-app > app-release.yaml ``` @@ -39,5 +39,5 @@ tk export helmrelease [name] [flags] ### SEE ALSO -* [tk export](tk_export.md) - Export resources in YAML format +* [gotk export](gotk_export.md) - Export resources in YAML format diff --git a/docs/cmd/tk_export_kustomization.md b/docs/cmd/gotk_export_kustomization.md similarity index 74% rename from docs/cmd/tk_export_kustomization.md rename to docs/cmd/gotk_export_kustomization.md index eed9414ba583e8726709fe5c6807addef4578820..d4a75b51382c62e235e09c880ca4710ecb5f7ef9 100644 --- a/docs/cmd/tk_export_kustomization.md +++ b/docs/cmd/gotk_export_kustomization.md @@ -1,4 +1,4 @@ -## tk export kustomization +## gotk 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. ``` -tk export kustomization [name] [flags] +gotk export kustomization [name] [flags] ``` ### Examples ``` # Export all Kustomization resources - tk export kustomization --all > kustomizations.yaml + gotk export kustomization --all > kustomizations.yaml # Export a Kustomization - tk export kustomization my-app > kustomization.yaml + gotk export kustomization my-app > kustomization.yaml ``` @@ -39,5 +39,5 @@ tk export kustomization [name] [flags] ### SEE ALSO -* [tk export](tk_export.md) - Export resources in YAML format +* [gotk export](gotk_export.md) - Export resources in YAML format diff --git a/docs/cmd/tk_export_source.md b/docs/cmd/gotk_export_source.md similarity index 68% rename from docs/cmd/tk_export_source.md rename to docs/cmd/gotk_export_source.md index 06aa18d576720737695e234eb9765c8e573c19ff..6f7438a86f39b4692969066e4cef57d7d2abb0a3 100644 --- a/docs/cmd/tk_export_source.md +++ b/docs/cmd/gotk_export_source.md @@ -1,4 +1,4 @@ -## tk export source +## gotk export source Export sources @@ -25,7 +25,7 @@ The export source sub-commands export sources in YAML format. ### SEE ALSO -* [tk export](tk_export.md) - Export resources in YAML format -* [tk export source git](tk_export_source_git.md) - Export GitRepository sources in YAML format -* [tk export source helm](tk_export_source_helm.md) - Export HelmRepository sources in YAML format +* [gotk export](gotk_export.md) - Export resources 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 diff --git a/docs/cmd/tk_export_source_git.md b/docs/cmd/gotk_export_source_git.md similarity index 76% rename from docs/cmd/tk_export_source_git.md rename to docs/cmd/gotk_export_source_git.md index cba6b379d1c32ab20deffefc16eabb04ddf7bd5a..c10e06e34cbbbae6f48bee1d892cb8ee06b9f9ae 100644 --- a/docs/cmd/tk_export_source_git.md +++ b/docs/cmd/gotk_export_source_git.md @@ -1,4 +1,4 @@ -## tk export source git +## gotk 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. ``` -tk export source git [name] [flags] +gotk export source git [name] [flags] ``` ### Examples ``` # Export all GitRepository sources - tk export source git --all > sources.yaml + gotk export source git --all > sources.yaml # Export a GitRepository source including the SSH key pair or basic auth credentials - tk export source git my-private-repo --with-credentials > source.yaml + gotk export source git my-private-repo --with-credentials > source.yaml ``` @@ -40,5 +40,5 @@ tk export source git [name] [flags] ### SEE ALSO -* [tk export source](tk_export_source.md) - Export sources +* [gotk export source](gotk_export_source.md) - Export sources diff --git a/docs/cmd/tk_export_source_helm.md b/docs/cmd/gotk_export_source_helm.md similarity index 76% rename from docs/cmd/tk_export_source_helm.md rename to docs/cmd/gotk_export_source_helm.md index 1561ecf9dfe0df2d1b9c250b211f768ccab5bd1c..5c734d2d60088130d4021103ece60db32f821fa8 100644 --- a/docs/cmd/tk_export_source_helm.md +++ b/docs/cmd/gotk_export_source_helm.md @@ -1,4 +1,4 @@ -## tk export source helm +## gotk 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. ``` -tk export source helm [name] [flags] +gotk export source helm [name] [flags] ``` ### Examples ``` # Export all HelmRepository sources - tk export source helm --all > sources.yaml + gotk export source helm --all > sources.yaml # Export a HelmRepository source including the basic auth credentials - tk export source helm my-private-repo --with-credentials > source.yaml + gotk export source helm my-private-repo --with-credentials > source.yaml ``` @@ -40,5 +40,5 @@ tk export source helm [name] [flags] ### SEE ALSO -* [tk export source](tk_export_source.md) - Export sources +* [gotk export source](gotk_export_source.md) - Export sources diff --git a/docs/cmd/tk_get.md b/docs/cmd/gotk_get.md similarity index 61% rename from docs/cmd/tk_get.md rename to docs/cmd/gotk_get.md index d18444539c69d210ac58aa9a1a2db8ff3090bef3..aeb7e81e3b7ca47dded6b8c4ff4d639488becfaf 100644 --- a/docs/cmd/tk_get.md +++ b/docs/cmd/gotk_get.md @@ -1,4 +1,4 @@ -## tk get +## gotk get Get sources and resources @@ -23,8 +23,8 @@ The get sub-commands print the statuses of sources and resources. ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk get helmreleases](tk_get_helmreleases.md) - Get HelmRelease statuses -* [tk get kustomizations](tk_get_kustomizations.md) - Get Kustomization statuses -* [tk get sources](tk_get_sources.md) - Get source statuses +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk get helmreleases](gotk_get_helmreleases.md) - Get HelmRelease statuses +* [gotk get kustomizations](gotk_get_kustomizations.md) - Get Kustomization statuses +* [gotk get sources](gotk_get_sources.md) - Get source statuses diff --git a/docs/cmd/tk_get_helmreleases.md b/docs/cmd/gotk_get_helmreleases.md similarity index 82% rename from docs/cmd/tk_get_helmreleases.md rename to docs/cmd/gotk_get_helmreleases.md index f5d0695a4975db2c5a321aaa30e66f1f3db743fa..1087ec2f516635a3e02b4bfb7c6d7995c65a05f4 100644 --- a/docs/cmd/tk_get_helmreleases.md +++ b/docs/cmd/gotk_get_helmreleases.md @@ -1,4 +1,4 @@ -## tk get helmreleases +## gotk get helmreleases Get HelmRelease statuses @@ -7,14 +7,14 @@ Get HelmRelease statuses The get helmreleases command prints the statuses of the resources. ``` -tk get helmreleases [flags] +gotk get helmreleases [flags] ``` ### Examples ``` # List all Helm releases and their status - tk get helmreleases + gotk get helmreleases ``` @@ -35,5 +35,5 @@ tk get helmreleases [flags] ### SEE ALSO -* [tk get](tk_get.md) - Get sources and resources +* [gotk get](gotk_get.md) - Get sources and resources diff --git a/docs/cmd/tk_get_kustomizations.md b/docs/cmd/gotk_get_kustomizations.md similarity index 81% rename from docs/cmd/tk_get_kustomizations.md rename to docs/cmd/gotk_get_kustomizations.md index b82d5234a5bbfd97f4d9d3cd2f58a3797c5db749..be82136dee0f1d9b8ec841d22ba8e7ac6f464d38 100644 --- a/docs/cmd/tk_get_kustomizations.md +++ b/docs/cmd/gotk_get_kustomizations.md @@ -1,4 +1,4 @@ -## tk get kustomizations +## gotk get kustomizations Get Kustomization statuses @@ -7,14 +7,14 @@ Get Kustomization statuses The get kustomizations command prints the statuses of the resources. ``` -tk get kustomizations [flags] +gotk get kustomizations [flags] ``` ### Examples ``` # List all kustomizations and their status - tk get kustomizations + gotk get kustomizations ``` @@ -35,5 +35,5 @@ tk get kustomizations [flags] ### SEE ALSO -* [tk get](tk_get.md) - Get sources and resources +* [gotk get](gotk_get.md) - Get sources and resources diff --git a/docs/cmd/tk_get_sources.md b/docs/cmd/gotk_get_sources.md similarity index 67% rename from docs/cmd/tk_get_sources.md rename to docs/cmd/gotk_get_sources.md index 0d867e4a0df8cc7c2f088248369d23cd19d00a3d..38ff058c5774edc7a951341f95681cddcbe98085 100644 --- a/docs/cmd/tk_get_sources.md +++ b/docs/cmd/gotk_get_sources.md @@ -1,4 +1,4 @@ -## tk get sources +## gotk get sources Get source statuses @@ -23,7 +23,7 @@ The get source sub-commands print the statuses of the sources. ### SEE ALSO -* [tk get](tk_get.md) - Get sources and resources -* [tk get sources git](tk_get_sources_git.md) - Get GitRepository source statuses -* [tk get sources helm](tk_get_sources_helm.md) - Get HelmRepository source statuses +* [gotk get](gotk_get.md) - Get sources and resources +* [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 diff --git a/docs/cmd/tk_get_sources_git.md b/docs/cmd/gotk_get_sources_git.md similarity index 81% rename from docs/cmd/tk_get_sources_git.md rename to docs/cmd/gotk_get_sources_git.md index 41e64fc03317620846550480322d2d264ae86079..d57658a431e41c9e13fed63638a7e4d922aa9d6b 100644 --- a/docs/cmd/tk_get_sources_git.md +++ b/docs/cmd/gotk_get_sources_git.md @@ -1,4 +1,4 @@ -## tk get sources git +## gotk 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. ``` -tk get sources git [flags] +gotk get sources git [flags] ``` ### Examples ``` # List all Git repositories and their status - tk get sources git + gotk get sources git ``` @@ -35,5 +35,5 @@ tk get sources git [flags] ### SEE ALSO -* [tk get sources](tk_get_sources.md) - Get source statuses +* [gotk get sources](gotk_get_sources.md) - Get source statuses diff --git a/docs/cmd/tk_get_sources_helm.md b/docs/cmd/gotk_get_sources_helm.md similarity index 81% rename from docs/cmd/tk_get_sources_helm.md rename to docs/cmd/gotk_get_sources_helm.md index 198f3c7b860494ecc6f091562091758f1d5bfd19..730d8bd4333ef7fed89154344d0415a9478ee1ed 100644 --- a/docs/cmd/tk_get_sources_helm.md +++ b/docs/cmd/gotk_get_sources_helm.md @@ -1,4 +1,4 @@ -## tk get sources helm +## gotk 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. ``` -tk get sources helm [flags] +gotk get sources helm [flags] ``` ### Examples ``` # List all Helm repositories and their status - tk get sources helm + gotk get sources helm ``` @@ -35,5 +35,5 @@ tk get sources helm [flags] ### SEE ALSO -* [tk get sources](tk_get_sources.md) - Get source statuses +* [gotk get sources](gotk_get_sources.md) - Get source statuses diff --git a/docs/cmd/tk_install.md b/docs/cmd/gotk_install.md similarity index 82% rename from docs/cmd/tk_install.md rename to docs/cmd/gotk_install.md index 36f196130eb4080d1c56bc4897d6458057fd309c..a8096fe5431f5e500ee924e18f4b0738fe1c0651 100644 --- a/docs/cmd/tk_install.md +++ b/docs/cmd/gotk_install.md @@ -1,4 +1,4 @@ -## tk install +## gotk 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. ``` -tk install [flags] +gotk install [flags] ``` ### Examples ``` # Install the latest version in the gitops-systems namespace - tk install --version=latest --namespace=gitops-systems + gotk install --version=latest --namespace=gitops-systems # Dry-run install for a specific version and a series of components - tk install --dry-run --version=v0.0.7 --components="source-controller,kustomize-controller" + gotk install --dry-run --version=v0.0.7 --components="source-controller,kustomize-controller" # Dry-run install with manifests preview - tk install --dry-run --verbose + gotk install --dry-run --verbose # Write install manifests to file - tk install --export > gitops-system.yaml + gotk install --export > gitops-system.yaml ``` @@ -52,5 +52,5 @@ tk install [flags] ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines diff --git a/docs/cmd/tk_reconcile.md b/docs/cmd/gotk_reconcile.md similarity index 59% rename from docs/cmd/tk_reconcile.md rename to docs/cmd/gotk_reconcile.md index c206c9974e312401c6c7430dab643dcad5720a54..d39c8cabceaa44d00c02d083bc24a5fb424fe26f 100644 --- a/docs/cmd/tk_reconcile.md +++ b/docs/cmd/gotk_reconcile.md @@ -1,4 +1,4 @@ -## tk reconcile +## gotk reconcile Reconcile sources and resources @@ -23,8 +23,8 @@ The reconcile sub-commands trigger a reconciliation of sources and resources. ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk reconcile helmrelease](tk_reconcile_helmrelease.md) - Reconcile a HelmRelease resource -* [tk reconcile kustomization](tk_reconcile_kustomization.md) - Reconcile a Kustomization resource -* [tk reconcile source](tk_reconcile_source.md) - Reconcile sources +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk reconcile helmrelease](gotk_reconcile_helmrelease.md) - Reconcile a HelmRelease resource +* [gotk reconcile kustomization](gotk_reconcile_kustomization.md) - Reconcile a Kustomization resource +* [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources diff --git a/docs/cmd/tk_reconcile_helmrelease.md b/docs/cmd/gotk_reconcile_helmrelease.md similarity index 79% rename from docs/cmd/tk_reconcile_helmrelease.md rename to docs/cmd/gotk_reconcile_helmrelease.md index eadf3423b09dfc6ec820bb3e062962197e8ad5a3..2761f4d5b9ea87d8ad418cf5897f259cc22d9361 100644 --- a/docs/cmd/tk_reconcile_helmrelease.md +++ b/docs/cmd/gotk_reconcile_helmrelease.md @@ -1,4 +1,4 @@ -## tk reconcile helmrelease +## gotk 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. ``` -tk reconcile helmrelease [name] [flags] +gotk reconcile helmrelease [name] [flags] ``` ### Examples ``` # Trigger a HelmRelease apply outside of the reconciliation interval - tk reconcile hr podinfo + gotk reconcile hr podinfo # Trigger a reconciliation of the HelmRelease's source and apply changes - tk reconcile hr podinfo --with-source + gotk reconcile hr podinfo --with-source ``` @@ -40,5 +40,5 @@ tk reconcile helmrelease [name] [flags] ### SEE ALSO -* [tk reconcile](tk_reconcile.md) - Reconcile sources and resources +* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources diff --git a/docs/cmd/tk_reconcile_kustomization.md b/docs/cmd/gotk_reconcile_kustomization.md similarity index 77% rename from docs/cmd/tk_reconcile_kustomization.md rename to docs/cmd/gotk_reconcile_kustomization.md index b98eacc9711c30ce6b4c649da54ee9383b740594..b4dc089fe7bca3877ef5647c5a9eb28f2144c452 100644 --- a/docs/cmd/tk_reconcile_kustomization.md +++ b/docs/cmd/gotk_reconcile_kustomization.md @@ -1,4 +1,4 @@ -## tk reconcile kustomization +## gotk 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. ``` -tk reconcile kustomization [name] [flags] +gotk reconcile kustomization [name] [flags] ``` ### Examples ``` # Trigger a Kustomization apply outside of the reconciliation interval - tk reconcile kustomization podinfo + gotk reconcile kustomization podinfo # Trigger a sync of the Kustomization's source and apply changes - tk reconcile kustomization podinfo --with-source + gotk reconcile kustomization podinfo --with-source ``` @@ -40,5 +40,5 @@ tk reconcile kustomization [name] [flags] ### SEE ALSO -* [tk reconcile](tk_reconcile.md) - Reconcile sources and resources +* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources diff --git a/docs/cmd/tk_reconcile_source.md b/docs/cmd/gotk_reconcile_source.md similarity index 64% rename from docs/cmd/tk_reconcile_source.md rename to docs/cmd/gotk_reconcile_source.md index 138a4f57cdd15f17d5cb14f48ab5a6856ce2edcd..0d27f4530b08b5d24cce3b5b77c58b866f9a51e8 100644 --- a/docs/cmd/tk_reconcile_source.md +++ b/docs/cmd/gotk_reconcile_source.md @@ -1,4 +1,4 @@ -## tk reconcile source +## gotk reconcile source Reconcile sources @@ -23,7 +23,7 @@ The reconcile source sub-commands trigger a reconciliation of sources. ### SEE ALSO -* [tk reconcile](tk_reconcile.md) - Reconcile sources and resources -* [tk reconcile source git](tk_reconcile_source_git.md) - Reconcile a GitRepository source -* [tk reconcile source helm](tk_reconcile_source_helm.md) - Reconcile a HelmRepository source +* [gotk reconcile](gotk_reconcile.md) - Reconcile sources and resources +* [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 diff --git a/docs/cmd/tk_reconcile_source_git.md b/docs/cmd/gotk_reconcile_source_git.md similarity index 78% rename from docs/cmd/tk_reconcile_source_git.md rename to docs/cmd/gotk_reconcile_source_git.md index b2efa8b9479844c5260d10225b5402ca715a6976..955c27c90037d639c447e7b69a3e29b926ff8a50 100644 --- a/docs/cmd/tk_reconcile_source_git.md +++ b/docs/cmd/gotk_reconcile_source_git.md @@ -1,4 +1,4 @@ -## tk reconcile source git +## gotk 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. ``` -tk reconcile source git [name] [flags] +gotk reconcile source git [name] [flags] ``` ### Examples ``` # Trigger a git pull for an existing source - tk reconcile source git podinfo + gotk reconcile source git podinfo ``` @@ -35,5 +35,5 @@ tk reconcile source git [name] [flags] ### SEE ALSO -* [tk reconcile source](tk_reconcile_source.md) - Reconcile sources +* [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources diff --git a/docs/cmd/tk_reconcile_source_helm.md b/docs/cmd/gotk_reconcile_source_helm.md similarity index 78% rename from docs/cmd/tk_reconcile_source_helm.md rename to docs/cmd/gotk_reconcile_source_helm.md index b5ba734c559703d2511775cdbba4c9856e4d6ffa..946ed7f2f8a55072ef6ef9ecfba1d473705f4eb8 100644 --- a/docs/cmd/tk_reconcile_source_helm.md +++ b/docs/cmd/gotk_reconcile_source_helm.md @@ -1,4 +1,4 @@ -## tk reconcile source helm +## gotk 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. ``` -tk reconcile source helm [name] [flags] +gotk reconcile source helm [name] [flags] ``` ### Examples ``` # Trigger a reconciliation for an existing source - tk reconcile source helm podinfo + gotk reconcile source helm podinfo ``` @@ -35,5 +35,5 @@ tk reconcile source helm [name] [flags] ### SEE ALSO -* [tk reconcile source](tk_reconcile_source.md) - Reconcile sources +* [gotk reconcile source](gotk_reconcile_source.md) - Reconcile sources diff --git a/docs/cmd/tk_resume.md b/docs/cmd/gotk_resume.md similarity index 64% rename from docs/cmd/tk_resume.md rename to docs/cmd/gotk_resume.md index f7567b2f5743ad857714052c6405aec6446a636e..c565ebf50cef7e9025b45d4c72fe050be87cd35b 100644 --- a/docs/cmd/tk_resume.md +++ b/docs/cmd/gotk_resume.md @@ -1,4 +1,4 @@ -## tk resume +## gotk resume Resume suspended resources @@ -23,7 +23,7 @@ The resume sub-commands resume a suspended resource. ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk resume helmrelease](tk_resume_helmrelease.md) - Resume a suspended HelmRelease -* [tk resume kustomization](tk_resume_kustomization.md) - Resume a suspended Kustomization +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk resume helmrelease](gotk_resume_helmrelease.md) - Resume a suspended HelmRelease +* [gotk resume kustomization](gotk_resume_kustomization.md) - Resume a suspended Kustomization diff --git a/docs/cmd/tk_resume_helmrelease.md b/docs/cmd/gotk_resume_helmrelease.md similarity index 81% rename from docs/cmd/tk_resume_helmrelease.md rename to docs/cmd/gotk_resume_helmrelease.md index d365961bcb9f57a5726a88cfc0dbb7d49169a15b..9d0671ac6fd76588d292a72cd16d2eb26fdf3419 100644 --- a/docs/cmd/tk_resume_helmrelease.md +++ b/docs/cmd/gotk_resume_helmrelease.md @@ -1,4 +1,4 @@ -## tk resume helmrelease +## gotk resume helmrelease Resume a suspended HelmRelease @@ -8,14 +8,14 @@ The resume command marks a previously suspended HelmRelease resource for reconci finish the apply. ``` -tk resume helmrelease [name] [flags] +gotk resume helmrelease [name] [flags] ``` ### Examples ``` # Resume reconciliation for an existing Helm release - tk resume hr podinfo + gotk resume hr podinfo ``` @@ -36,5 +36,5 @@ tk resume helmrelease [name] [flags] ### SEE ALSO -* [tk resume](tk_resume.md) - Resume suspended resources +* [gotk resume](gotk_resume.md) - Resume suspended resources diff --git a/docs/cmd/tk_resume_kustomization.md b/docs/cmd/gotk_resume_kustomization.md similarity index 81% rename from docs/cmd/tk_resume_kustomization.md rename to docs/cmd/gotk_resume_kustomization.md index 5f16f38798923d68e6f31f41228a4d7f93e8a727..a9aa27bcf89da8010f93918b115a1c6c47074508 100644 --- a/docs/cmd/tk_resume_kustomization.md +++ b/docs/cmd/gotk_resume_kustomization.md @@ -1,4 +1,4 @@ -## tk resume kustomization +## gotk resume kustomization Resume a suspended Kustomization @@ -8,14 +8,14 @@ The resume command marks a previously suspended Kustomization resource for recon finish the apply. ``` -tk resume kustomization [name] [flags] +gotk resume kustomization [name] [flags] ``` ### Examples ``` # Resume reconciliation for an existing Kustomization - tk resume ks podinfo + gotk resume ks podinfo ``` @@ -36,5 +36,5 @@ tk resume kustomization [name] [flags] ### SEE ALSO -* [tk resume](tk_resume.md) - Resume suspended resources +* [gotk resume](gotk_resume.md) - Resume suspended resources diff --git a/docs/cmd/tk_suspend.md b/docs/cmd/gotk_suspend.md similarity index 63% rename from docs/cmd/tk_suspend.md rename to docs/cmd/gotk_suspend.md index b192ef0eae2a2db78870a54be39c9c3837d03a26..69c759524b8ce9b07f5966f5fd5415795f9821c0 100644 --- a/docs/cmd/tk_suspend.md +++ b/docs/cmd/gotk_suspend.md @@ -1,4 +1,4 @@ -## tk suspend +## gotk suspend Suspend resources @@ -23,7 +23,7 @@ The suspend sub-commands suspend the reconciliation of a resource. ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines -* [tk suspend helmrelease](tk_suspend_helmrelease.md) - Suspend reconciliation of HelmRelease -* [tk suspend kustomization](tk_suspend_kustomization.md) - Suspend reconciliation of Kustomization +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk suspend helmrelease](gotk_suspend_helmrelease.md) - Suspend reconciliation of HelmRelease +* [gotk suspend kustomization](gotk_suspend_kustomization.md) - Suspend reconciliation of Kustomization diff --git a/docs/cmd/tk_suspend_helmrelease.md b/docs/cmd/gotk_suspend_helmrelease.md similarity index 81% rename from docs/cmd/tk_suspend_helmrelease.md rename to docs/cmd/gotk_suspend_helmrelease.md index 65029bcc330e0b107e618536b6d976e9e841a0bb..e5fe7332ed73d32f79e9c75353f193df630dfe03 100644 --- a/docs/cmd/tk_suspend_helmrelease.md +++ b/docs/cmd/gotk_suspend_helmrelease.md @@ -1,4 +1,4 @@ -## tk suspend helmrelease +## gotk suspend helmrelease Suspend reconciliation of HelmRelease @@ -7,14 +7,14 @@ Suspend reconciliation of HelmRelease The suspend command disables the reconciliation of a HelmRelease resource. ``` -tk suspend helmrelease [name] [flags] +gotk suspend helmrelease [name] [flags] ``` ### Examples ``` # Suspend reconciliation for an existing Helm release - tk suspend hr podinfo + gotk suspend hr podinfo ``` @@ -35,5 +35,5 @@ tk suspend helmrelease [name] [flags] ### SEE ALSO -* [tk suspend](tk_suspend.md) - Suspend resources +* [gotk suspend](gotk_suspend.md) - Suspend resources diff --git a/docs/cmd/tk_suspend_kustomization.md b/docs/cmd/gotk_suspend_kustomization.md similarity index 80% rename from docs/cmd/tk_suspend_kustomization.md rename to docs/cmd/gotk_suspend_kustomization.md index 0df77d106b38f4bb5d04b0e11da4a30885ddfd13..6be8bb230da9bbebdd4bf4ed732a6adb9619e439 100644 --- a/docs/cmd/tk_suspend_kustomization.md +++ b/docs/cmd/gotk_suspend_kustomization.md @@ -1,4 +1,4 @@ -## tk suspend kustomization +## gotk suspend kustomization Suspend reconciliation of Kustomization @@ -7,14 +7,14 @@ Suspend reconciliation of Kustomization The suspend command disables the reconciliation of a Kustomization resource. ``` -tk suspend kustomization [name] [flags] +gotk suspend kustomization [name] [flags] ``` ### Examples ``` # Suspend reconciliation for an existing Kustomization - tk suspend ks podinfo + gotk suspend ks podinfo ``` @@ -35,5 +35,5 @@ tk suspend kustomization [name] [flags] ### SEE ALSO -* [tk suspend](tk_suspend.md) - Suspend resources +* [gotk suspend](gotk_suspend.md) - Suspend resources diff --git a/docs/cmd/tk_uninstall.md b/docs/cmd/gotk_uninstall.md similarity index 81% rename from docs/cmd/tk_uninstall.md rename to docs/cmd/gotk_uninstall.md index 1ba46e3c80d0a248054c3beb652c0fe0e1ddf74c..c7e504bd02b4ffe441eaa4e46b9cbbb3a2344b9b 100644 --- a/docs/cmd/tk_uninstall.md +++ b/docs/cmd/gotk_uninstall.md @@ -1,4 +1,4 @@ -## tk uninstall +## gotk 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. ``` -tk uninstall [flags] +gotk uninstall [flags] ``` ### Examples ``` # Dry-run uninstall of all components - tk uninstall --dry-run --namespace=gitops-system + gotk uninstall --dry-run --namespace=gitops-system # Uninstall all components and delete custom resource definitions - tk uninstall --resources --crds --namespace=gitops-system + gotk uninstall --resources --crds --namespace=gitops-system ``` @@ -42,5 +42,5 @@ tk uninstall [flags] ### SEE ALSO -* [tk](tk.md) - Command line utility for assembling Kubernetes CD pipelines +* [gotk](gotk.md) - Command line utility for assembling Kubernetes CD pipelines diff --git a/docs/dev-guides/source-watcher.md b/docs/dev-guides/source-watcher.md index 4200a0c1c4b04f3805eca5c79aa782015c7a461c..7e84b9ce19cfb2ff7f55bdac043f5f7e96099822 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 -tk check --pre +gotk check --pre ``` Install the toolkit controllers on the dev cluster: ```sh -tk install +gotk install ``` ## Clone the sample controller @@ -84,7 +84,7 @@ make run Create a Git source: ```sh -tk create source git test \ +gotk 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 -tk create source git test \ +gotk create source git test \ --url=https://github.com/stefanprodan/podinfo \ --tag=4.0.1 ``` diff --git a/docs/diagrams/tk-feature.png b/docs/diagrams/gotk-feature.png similarity index 100% rename from docs/diagrams/tk-feature.png rename to docs/diagrams/gotk-feature.png diff --git a/docs/diagrams/tk-overview.png b/docs/diagrams/gotk-overview.png similarity index 100% rename from docs/diagrams/tk-overview.png rename to docs/diagrams/gotk-overview.png diff --git a/docs/faq/index.md b/docs/faq/index.md index befad671721274f268dd3f654be9c442f7f66760..d6a68eccc2d076fa0f388fe4ecb934c2504e91a3 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 `tk` 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 `gotk` 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 8ace250dc309dee991e7cb5e6bd9646fa8964428..ea30e5a4dd8f90b7fd4aec832348109578b274e5 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -19,21 +19,21 @@ export GITHUB_USER=<your-username> ## Install the toolkit CLI -To install the latest `tk` release run: +To install the latest `gotk` release run: ```sh curl -s https://toolkit.fluxcd.io/install.sh | sudo bash ``` -The install script downloads the tk binary to `/usr/local/bin`. +The install script downloads the gotk binary to `/usr/local/bin`. Binaries for macOS and Linux AMD64 are available for download on the [release page](https://github.com/fluxcd/toolkit/releases). -To configure your shell to load tk completions add to your bash profile: +To configure your shell to load gotk completions add to your bash profile: ```sh # ~/.bashrc or ~/.bash_profile -. <(tk completion) +. <(gotk completion) ``` ## GitOps workflow @@ -59,7 +59,7 @@ kubectl cluster-info --context kind-staging Verify that your staging cluster satisfies the prerequisites with: ```console -$ tk check --pre +$ gotk check --pre ► checking prerequisites ✔ kubectl 1.18.3 >=1.18.0 @@ -70,7 +70,7 @@ $ tk check --pre Run the bootstrap command: ```sh -tk bootstrap github \ +gotk bootstrap github \ --owner=$GITHUB_USER \ --repository=fleet-infra \ --path=staging-cluster \ @@ -84,7 +84,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 -tk bootstrap github \ +gotk bootstrap github \ --owner=<organization> \ --repository=<repo-name> \ --team=<team1-slug> \ @@ -95,7 +95,7 @@ tk bootstrap github \ Example output: ```text -$ tk bootstrap github --owner=gitopsrun --repository=fleet-infra --path=staging-cluster --team=devs +$ gotk bootstrap github --owner=gitopsrun --repository=fleet-infra --path=staging-cluster --team=devs ► connecting to github.com ✔ repository created @@ -117,14 +117,14 @@ deployment "notification-controller" successfully rolled out ✔ bootstrap finished ``` -If you prefer GitLab, export `GITLAB_TOKEN` env var and use the command [tk bootstrap gitlab](../cmd/tk_bootstrap_gitlab.md). +If you prefer GitLab, export `GITLAB_TOKEN` env var and use the command [gotk bootstrap gitlab](../cmd/gotk_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 `tk bootstrap --version=<semver>`. + with `gotk bootstrap --version=<semver>`. ## Staging workflow @@ -138,7 +138,7 @@ cd fleet-infra Create a git source pointing to a public repository master branch: ```sh -tk create source git webapp \ +gotk create source git webapp \ --url=https://github.com/stefanprodan/podinfo \ --branch=master \ --interval=30s \ @@ -148,7 +148,7 @@ tk create source git webapp \ Create a kustomization for synchronizing the common manifests on the cluster: ```sh -tk create kustomization webapp-common \ +gotk create kustomization webapp-common \ --source=webapp \ --path="./deploy/webapp/common" \ --prune=true \ @@ -160,7 +160,7 @@ tk create kustomization webapp-common \ Create a kustomization for the backend service that depends on common: ```sh -tk create kustomization webapp-backend \ +gotk create kustomization webapp-backend \ --depends-on=webapp-common \ --source=webapp \ --path="./deploy/webapp/backend" \ @@ -175,7 +175,7 @@ tk create kustomization webapp-backend \ Create a kustomization for the frontend service that depends on backend: ```sh -tk create kustomization webapp-frontend \ +gotk create kustomization webapp-frontend \ --depends-on=webapp-backend \ --source=webapp \ --path="./deploy/webapp/frontend" \ @@ -196,7 +196,7 @@ git add -A && git commit -m "add staging webapp" && git push In about 30s the synchronization should start: ```console -$ watch tk get kustomizations +$ watch gotk get kustomizations ✔ gitops-system last applied revision master/35d5765a1acb9e9ce66cad7274c6fe03eee1e8eb ✔ webapp-backend reconciling @@ -228,8 +228,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 `tk suspend kustomization <name>`. Once the debugging session -is over, you can re-enable the reconciliation with `tk resume kustomization <name>`. +kustomization with `gotk suspend kustomization <name>`. Once the debugging session +is over, you can re-enable the reconciliation with `gotk resume kustomization <name>`. ## Production bootstrap @@ -246,7 +246,7 @@ kubectl cluster-info --context kind-production Run the bootstrap for the production environment: ```sh -tk bootstrap github \ +gotk bootstrap github \ --owner=$GITHUB_USER \ --repository=fleet-infra \ --path=prod-cluster \ @@ -264,7 +264,7 @@ git pull Create a git source using a semver range to target stable releases: ```sh -tk create source git webapp \ +gotk create source git webapp \ --url=https://github.com/stefanprodan/podinfo \ --tag-semver=">=4.0.0 <4.0.2" \ --interval=30s \ @@ -274,7 +274,7 @@ tk create source git webapp \ Create a kustomization for webapp pointing to the production overlay: ```sh -tk create kustomization webapp \ +gotk create kustomization webapp \ --source=webapp \ --path="./deploy/overlays/production" \ --prune=true \ @@ -295,7 +295,7 @@ git add -A && git commit -m "add prod webapp" && git push List git sources: ```console -$ tk get sources git +$ gotk get sources git ✔ gitops-system last fetched revision master/99072ee132abdead8b7799d7891eae2f524eb73d ✔ webapp last fetched revision 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27 @@ -306,7 +306,7 @@ The kubectl equivalent is `kubectl -n gitops-system get gitrepositories`. List kustomization: ```console -$ tk get kustomizations +$ gotk get kustomizations ✔ gitops-system last applied revision master/99072ee132abdead8b7799d7891eae2f524eb73d ✔ webapp last applied revision 4.0.1/113360052b3153e439a0cf8de76b8e3d2a7bdf27 @@ -317,7 +317,7 @@ The kubectl equivalent is `kubectl -n gitops-system get kustomizations`. If you want to upgrade to the latest 4.x version, you can change the semver expression to: ```sh -tk create source git webapp \ +gotk create source git webapp \ --url=https://github.com/stefanprodan/podinfo \ --tag-semver=">=4.0.0 <5.0.0" \ --interval=30s \ @@ -329,7 +329,7 @@ git add -A && git commit -m "update prod webapp" && git push Trigger a git sync: ```console -$ tk reconcile ks gitops-system --with-source +$ gotk reconcile ks gitops-system --with-source ► annotating source gitops-system ✔ source annotated @@ -346,7 +346,7 @@ The kubectl equivalent is `kubectl -n gitops-system annotate gitrepository/gitop Wait for the webapp to be upgraded: ```console -$ watch tk get kustomizations +$ watch gotk get kustomizations ✔ gitops-system last applied revision master/d751ea264d48bf0db8b588d1d08184834ac8fec9 ✔ webapp last applied revision 4.0.5/f43f9b2eb6766e07f318d266a99d2ec7c940b0cf diff --git a/docs/guides/installation.md b/docs/guides/installation.md index 22adf704a52b5f3f8f05f562ae818bcb4b6e2c47..84fb4a4978dfa2e78eb6b0bdbf6aeee1770edb34 100644 --- a/docs/guides/installation.md +++ b/docs/guides/installation.md @@ -14,19 +14,19 @@ Install the toolkit CLI with: curl -s https://toolkit.fluxcd.io/install.sh | sudo bash ``` -The install script downloads the tk binary to `/usr/local/bin`. +The install script downloads the gotk binary to `/usr/local/bin`. Binaries for macOS and Linux AMD64 are available for download on the [release page](https://github.com/fluxcd/toolkit/releases). Verify that your cluster satisfies the prerequisites with: ```sh -tk check --pre +gotk check --pre ``` ## Bootstrap -Using the `tk bootstrap` command you can install the toolkit on a Kubernetes cluster +Using the `gotk 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 @@ -41,7 +41,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 -tk bootstrap <GIT-PROVIDER> \ +gotk bootstrap <GIT-PROVIDER> \ --components=source-controller,kustomize-controller,helm-controller,notification-controller \ --path=my-cluster \ --version=latest @@ -78,7 +78,7 @@ export GITHUB_TOKEN=<your-token> Run the bootstrap for a repository on your personal GitHub account: ```sh -tk bootstrap github \ +gotk bootstrap github \ --owner=my-github-username \ --repository=my-repository \ --path=my-cluster \ @@ -88,7 +88,7 @@ tk bootstrap github \ Run the bootstrap for a repository owned by a GitHub organization: ```sh -tk bootstrap github \ +gotk bootstrap github \ --owner=my-github-organization \ --repository=my-repository \ --team=team1-slug \ @@ -101,7 +101,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 -tk bootstrap github \ +gotk bootstrap github \ --hostname=my-github-enterprise.com \ --owner=my-github-organization \ --repository=my-repository \ @@ -122,7 +122,7 @@ export GITLAB_TOKEN=<your-token> Run the bootstrap for a repository on your personal GitLab account: ```sh -tk bootstrap gitlab \ +gotk bootstrap gitlab \ --owner=my-gitlab-username \ --repository=my-repository \ --path=my-cluster \ @@ -132,7 +132,7 @@ tk bootstrap gitlab \ Run the bootstrap for a repository owned by a GitLab group: ```sh -tk bootstrap gitlab \ +gotk bootstrap gitlab \ --owner=my-gitlab-group \ --repository=my-repository \ --path=my-cluster @@ -141,7 +141,7 @@ tk bootstrap gitlab \ To run the bootstrap for a repository hosted on GitLab on-prem or enterprise, you have to specify your GitLab hostname: ```sh -tk bootstrap gitlab \ +gotk bootstrap gitlab \ --hostname=my-gitlab.com \ --owner=my-gitlab-group \ --repository=my-repository \ @@ -168,7 +168,7 @@ mkdir -p ./my-cluster/gitops-system Generate the toolkit manifests with: ```sh -tk install --version=latest \ +gotk install --version=latest \ --export > ./my-cluster/gitops-system/toolkit-components.yaml ``` @@ -194,7 +194,7 @@ kubectl -n gitops-system create secret generic regcred \ Set your registry domain, and the pull secret when generating the manifests: ```sh -tk install --version=latest \ +gotk install --version=latest \ --registry=registry.internal/fluxcd \ --image-pull-secret=regcred \ --export > ./my-cluster/gitops-system/toolkit-components.yaml @@ -215,13 +215,13 @@ kubectl apply -f ./my-cluster/gitops-system/toolkit-components.yaml Verify that the toolkit controllers have started: ```sh -tk check +gotk check ``` Create a `GitRepository` object on your cluster by specifying the SSH address of your repo: ```sh -tk create source git gitops-system \ +gotk create source git gitops-system \ --url= ssh://<host>/<org>/my-repository \ --ssh-key-algorithm=ecdsa \ --ssh-ecdsa-curve=p521 \ @@ -230,12 +230,12 @@ tk create source git gitops-system \ ``` You will be prompted to add a deploy key to your repository. -If you don't specify the SSH algorithm, then tk will generate an RSA 2048 bits key. +If you don't specify the SSH algorithm, then gotk 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 -tk create source git gitops-system \ +gotk create source git gitops-system \ --url=https://<host>/<org>/my-repository \ --username=my-username \ --password=my-password \ @@ -246,7 +246,7 @@ tk create source git gitops-system \ Create a `Kustomization` object on your cluster: ```sh -tk create kustomization gitops-system \ +gotk create kustomization gitops-system \ --source=gitops-system \ --path="./my-cluster" \ --prune=true \ @@ -256,10 +256,10 @@ tk create kustomization gitops-system \ Export both objects, commit and push the manifests to Git: ```sh -tk export source git gitops-system \ +gotk export source git gitops-system \ > ./my-cluster/gitops-system/toolkit-source.yaml -tk export kustomization gitops-system \ +gotk export kustomization gitops-system \ > ./my-cluster/gitops-system/toolkit-kustomization.yaml git add -A && git commit -m "add toolkit reconciliation" && git push @@ -268,7 +268,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 -tk install --version=latest \ +gotk install --version=latest \ --export > ./my-cluster/gitops-system/toolkit-components.yaml git add -A && git commit -m "update toolkit" && git push @@ -284,19 +284,19 @@ For testing purposes you can install the toolkit without storing its manifests i Here is the equivalent to `fluxctl install`: ```sh -tk install \ +gotk install \ --components=source-controller,kustomize-controller ``` Then you can register Git repositories and reconcile them on your cluster: ```sh -tk create source git podinfo \ +gotk create source git podinfo \ --url=https://github.com/stefanprodan/podinfo \ --tag-semver=">=4.0.0" \ --interval=1m -tk create kustomization podinfo-default \ +gotk create kustomization podinfo-default \ --source=podinfo \ --path="./kustomize" \ --prune=true \ @@ -309,18 +309,18 @@ tk create kustomization podinfo-default \ Here is the equivalent to `helm install helm-operator`: ```sh -tk install \ +gotk install \ --components=source-controller,kustomize-controller,helm-controller ``` Then you can register Helm repositories and create Helm releases: ```sh -tk create source helm stable \ +gotk create source helm stable \ --interval=1h \ --url=https://kubernetes-charts.storage.googleapis.com -tk create helmrelease sealed-secrets \ +gotk create helmrelease sealed-secrets \ --interval=1h \ --release-name=sealed-secrets \ --target-namespace=gitops-system \ diff --git a/docs/guides/sealed-secrets.md b/docs/guides/sealed-secrets.md index f024c744478b962fe1817d34c97dfbce6063a8cf..ded5df4dad63da97a9201045ac00fb0ee635e1fa 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 -tk create source helm stable \ +gotk create source helm stable \ --interval=1h \ --url=https://kubernetes-charts.storage.googleapis.com ``` @@ -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 -tk create helmrelease sealed-secrets \ +gotk create helmrelease sealed-secrets \ --interval=1h \ --release-name=sealed-secrets \ --target-namespace=gitops-system \ @@ -147,7 +147,7 @@ spec: ``` !!! hint - You can generate the above manifests using `tk create <kind> --export > manifest.yaml`. + You can generate the above manifests using `gotk 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 53fda189b89a098f06bac3f235fcbaea1bc1095c..2cbbc9bd96bcd522b06391f13764269a9803bf47 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ events and are responsible for the reconciliation of their designated API object the toolkit is in an active experimentation phase. If you wish to take part in this quest please reach out to us on Slack and GitHub. - + Target features: diff --git a/docs/roadmap/index.md b/docs/roadmap/index.md index 45a82b32c34be0949a929fd4f79bf28a7666258f..6575d31ced7f9ae38e19232068f11b35b457c14e 100644 --- a/docs/roadmap/index.md +++ b/docs/roadmap/index.md @@ -36,7 +36,7 @@ Tasks - [x] <span style="color:grey">Implement a notification controller for Slack, MS Teams, Discord, Rocket</span> - [x] <span style="color:grey">Implement Prometheus metrics in source and kustomize controllers</span> - [ ] Review the git source and kustomize APIs -- [ ] Implement the migration command in tk +- [ ] Implement the migration command in gotk - [ ] Create a migration guide for `flux.yaml` kustomize users - [ ] Include [support for SOPS](https://github.com/fluxcd/toolkit/discussions/156) diff --git a/install/README.md b/install/README.md index eaf937991fb193af7a01d2f950b2044637e57d36..014d7eb945895ed45e3d92630dee7e437ea32e44 100644 --- a/install/README.md +++ b/install/README.md @@ -1,4 +1,4 @@ -# TK CLI Installation +# GOTK 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/tk.sh | sudo bash +curl -s https://raw.githubusercontent.com/fluxcd/toolkit/master/install/gotk.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 tk binary to `/usr/local/bin` +* copies the gotk binary to `/usr/local/bin` * removes the temporary directory -If you want to use tk as a kubectl plugin, rename the binary to `kubectl-tk`: +If you want to use gotk as a kubectl plugin, rename the binary to `kubectl-gotk`: ```sh -mv /usr/local/bin/tk /usr/local/bin/kubectl-tk +mv /usr/local/bin/gotk /usr/local/bin/kubectl-gotk ``` ## Build from source @@ -30,7 +30,7 @@ git clone https://github.com/fluxcd/toolkit cd toolkit ``` -Build the tk binary (requires go >= 1.14): +Build the `gotk` binary (requires go >= 1.14): ```bash make build @@ -39,5 +39,5 @@ make build Run the binary: ```bash -./bin/tk -h +./bin/gotk -h ``` diff --git a/install/tk.sh b/install/gotk.sh similarity index 85% rename from install/tk.sh rename to install/gotk.sh index 7962bcb84ac462685b9afe8ef370eeb1d4cdbc78..20fe4420d5f86ab37ffbafd02d7fbec31ebbb45e 100755 --- a/install/tk.sh +++ b/install/gotk.sh @@ -65,10 +65,10 @@ verify_downloader() { # Create tempory directory and cleanup when done setup_tmp() { - TMP_DIR=$(mktemp -d -t tk-install.XXXXXXXXXX) - TMP_METADATA="${TMP_DIR}/tk.json" - TMP_HASH="${TMP_DIR}/tk.hash" - TMP_BIN="${TMP_DIR}/tk.tar.gz" + 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" cleanup() { code=$? set +e @@ -86,9 +86,9 @@ get_release_version() { info "Downloading metadata ${METADATA_URL}" download "${TMP_METADATA}" "${METADATA_URL}" - VERSION_TK=$(grep '"tag_name":' "${TMP_METADATA}" | sed -E 's/.*"([^"]+)".*/\1/' | cut -c 2-) - if [[ -n "${VERSION_TK}" ]]; then - info "Using ${VERSION_TK} as release" + 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" else fatal "Unable to determine release version" fi @@ -116,16 +116,16 @@ download() { # Download hash from Github URL download_hash() { - HASH_URL="https://github.com/${GITHUB_REPO}/releases/download/v${VERSION_TK}/toolkit_${VERSION_TK}_checksums.txt" + HASH_URL="https://github.com/${GITHUB_REPO}/releases/download/v${VERSION_GOTK}/toolkit_${VERSION_GOTK}_checksums.txt" info "Downloading hash ${HASH_URL}" download "${TMP_HASH}" "${HASH_URL}" - HASH_EXPECTED=$(grep " tk_${VERSION_TK}_${OS}_${ARCH}.tar.gz$" "${TMP_HASH}") + HASH_EXPECTED=$(grep " gotk_${VERSION_GOTK}_${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_TK}/tk_${VERSION_TK}_${OS}_${ARCH}.tar.gz" + BIN_URL="https://github.com/${GITHUB_REPO}/releases/download/v${VERSION_GOTK}/gotk_${VERSION_GOTK}_${OS}_${ARCH}.tar.gz" info "Downloading binary ${BIN_URL}" download "${TMP_BIN}" "${BIN_URL}" } @@ -158,10 +158,10 @@ verify_binary() { # Setup permissions and move binary setup_binary() { chmod 755 "${TMP_BIN}" - info "Installing tk to ${BIN_DIR}/tk" + info "Installing gotk to ${BIN_DIR}/gotk" tar -xzf "${TMP_BIN}" -C "${TMP_DIR}" - local CMD_MOVE="mv -f \"${TMP_DIR}/tk\" \"${BIN_DIR}\"" + local CMD_MOVE="mv -f \"${TMP_DIR}/gotk\" \"${BIN_DIR}\"" if [[ -w "${BIN_DIR}" ]]; then eval "${CMD_MOVE}" else diff --git a/mkdocs.yml b/mkdocs.yml index 11bc77e41fa91cd6e455813cc0b16ccd94c7adf4..135d9e5442077b2f468787819ba7ccf42683c16a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,49 +73,49 @@ nav: - Receiver CRD: components/notification/receiver.md - Notification API Reference: components/notification/api.md - Toolkit CLI: - - Overview: cmd/tk.md - - Bootstrap: cmd/tk_bootstrap.md - - Bootstrap github: cmd/tk_bootstrap_github.md - - Bootstrap gitlab: cmd/tk_bootstrap_gitlab.md - - Check: cmd/tk_check.md - - Create: cmd/tk_create.md - - Create kustomization: cmd/tk_create_kustomization.md - - Create helmrelease: cmd/tk_create_helmrelease.md - - Create source: cmd/tk_create_source.md - - Create source git: cmd/tk_create_source_git.md - - Create source helm: cmd/tk_create_source_helm.md - - Delete: cmd/tk_delete.md - - Delete kustomization: cmd/tk_delete_kustomization.md - - Delete helmrelease: cmd/tk_delete_helmrelease.md - - Delete source: cmd/tk_delete_source.md - - Delete source git: cmd/tk_delete_source_git.md - - Delete source helm: cmd/tk_delete_source_helm.md - - Export: cmd/tk_export.md - - Export kustomization: cmd/tk_export_kustomization.md - - Export helmrelease: cmd/tk_export_helmrelease.md - - Export source: cmd/tk_export_source.md - - Export source git: cmd/tk_export_source_git.md - - Export source helm: cmd/tk_export_source_helm.md - - Get: cmd/tk_get.md - - Get kustomizations: cmd/tk_get_kustomizations.md - - Get helmreleases: cmd/tk_get_helmreleases.md - - Get sources: cmd/tk_get_sources.md - - Get sources git: cmd/tk_get_sources_git.md - - Get sources helm: cmd/tk_get_sources_helm.md - - Install: cmd/tk_install.md - - Resume: cmd/tk_resume.md - - Resume kustomization: cmd/tk_resume_kustomization.md - - Resume helmrelease: cmd/tk_resume_helmrelease.md - - Suspend: cmd/tk_suspend.md - - Suspend kustomization: cmd/tk_suspend_kustomization.md - - Suspend helmrelease: cmd/tk_suspend_helmrelease.md - - Reconcile: cmd/tk_reconcile.md - - Reconcile kustomization: cmd/tk_reconcile_kustomization.md - - Reconcile helmrelease: cmd/tk_reconcile_helmrelease.md - - Reconcile source: cmd/tk_reconcile_source.md - - Reconcile source git: cmd/tk_reconcile_source_git.md - - Reconcile source helm: cmd/tk_reconcile_source_helm.md - - Uninstall: cmd/tk_uninstall.md + - 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 + - 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 + - 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 + - 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 + - Install: cmd/gotk_install.md + - Resume: cmd/gotk_resume.md + - Resume kustomization: cmd/gotk_resume_kustomization.md + - Resume helmrelease: cmd/gotk_resume_helmrelease.md + - Suspend: cmd/gotk_suspend.md + - Suspend kustomization: cmd/gotk_suspend_kustomization.md + - Suspend helmrelease: cmd/gotk_suspend_helmrelease.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 + - Uninstall: cmd/gotk_uninstall.md - Roadmap: roadmap/index.md - Contributing: contributing/index.md - Dev Guides: