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 GitRepository sources and their status
  tk get sources git

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

  # Export GitRepository 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=true \
    --interval=5m \
    --validate=client \
    --health-check="Deployment/backend.webapp" \
    --health-check="Deployment/frontend.webapp" \
    --health-check-timeout=2m

  # Trigger a git sync of the Kustomization's source and apply changes
  tk reconcile 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 GitRepository source
  tk delete source git webapp-latest

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

Options

  -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 bootstrap - Bootstrap toolkit components
• tk check - Check requirements and installation
• tk completion - Generates bash completion scripts
• tk create - Create or update sources and resources
• tk delete - Delete sources and resources
• tk export - Export resources in YAML format
• tk get - Get sources and resources
• tk install - Install the toolkit components
• tk reconcile - Reconcile sources and resources
• tk resume - Resume suspended resources
• tk suspend - Suspend resources
• tk uninstall - Uninstall the toolkit components