flux2/docs/cmd/tk.md

tk

Command line utility for assembling Kubernetes CD pipelines

Synopsis

Command line utility for assembling Kubernetes CD pipelines the GitOps way.

Examples

  # Check prerequisites 
  tk check --pre

  # Install the latest version of the toolkit
  tk install --version=master

  # Create a source from a public Git repository
  tk create source git webapp-latest \
    --url=https://github.com/stefanprodan/podinfo \
    --branch=master \
    --interval=3m

  # List git sources and their status
  tk get sources git

  # Trigger a git sync
  tk sync source git webapp-latest

  # Export git sources in YAML format
  tk export source git --all > sources.yaml

  # Create a kustomization for deploying a series of microservices
  tk create kustomization webapp-dev \
    --source=webapp-latest \
    --path="./deploy/webapp/" \
    --prune="instance=webapp" \
    --generate=true \
    --interval=5m \
    --validate=client \
    --health-check="Deployment/backend.webapp" \
    --health-check="Deployment/frontend.webapp" \
    --health-check-timeout=2m

  # Trigger a git sync and apply changes if any
  tk sync kustomization webapp-dev --with-source

  # Suspend a kustomization reconciliation
  tk suspend kustomization webapp-dev

  # Export kustomizations in YAML format
  tk export kustomization --all > kustomizations.yaml

  # Resume a kustomization reconciliation
  tk resume kustomization webapp-dev

  # Delete a kustomization
  tk delete kustomization webapp-dev

  # Delete a git source
  tk delete source git webapp-latest

  # Uninstall the toolkit and delete CRDs
  tk uninstall --crds

Options

      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
  -h, --help                 help for tk
      --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)
      --verbose              print generated objects

SEE ALSO

• tk check - Check requirements and installation
• tk create - Create commands
• tk delete - Delete commands
• tk export - Export commands
• tk get - Get commands
• tk install - Install the toolkit components
• tk resume - Resume commands
• tk suspend - Suspend commands
• tk sync - Synchronize commands
• tk uninstall - Uninstall the toolkit components

Auto generated by spf13/cobra on 30-Apr-2020