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

Rename tk binary to gotk

To avoid conflicts with the `tk` binary from the Tanka project.
This commit is contained in:
Hidde Beydals
2020-08-25 21:09:34 +02:00
parent cb23d3ff3c
commit 22624ae4d5
108 changed files with 500 additions and 500 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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
```

View File

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

View File

Before

Width:  |  Height:  |  Size: 289 KiB

After

Width:  |  Height:  |  Size: 289 KiB

View File

@@ -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:

View File

@@ -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

View File

@@ -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 \

View File

@@ -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.

View File

@@ -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.
![overview](diagrams/tk-feature.png)
![overview](diagrams/gotk-feature.png)
Target features:

View File

@@ -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)