List of available commands ๐︎
The following commands are available in the backyards
command-line tool.
Install and manage Backyards
Usage:
backyards [flags]
Commands:
install Install Backyards
uninstall Uninstall Backyards
dashboard Open the Backyards dashboard in a web browser
graph Show graph
login Log in to Backyards (aliases: l)
mtls Manage mTLS policy related configurations
routing Manage service routing configurations (aliases: r)
sidecar-proxy Manage sidecar-proxy related configurations (aliases: sp)
tap Tap into HTTP/GRPC mesh traffic
config View and manage persistent configuration
license Shows Backyards license
version Print the client and api version information
help Help about any command
Components commands:
canary Install and manage canary feature
cert-manager Install and manage cert-manager
demoapp Install and manage demo application
istio Install and manage Istio
operator Install and manage Backyards operator
Flags:
--accept-license Accept the license: https://banzaicloud.com/docs/backyards/evaluation-license
--backyards-namespace string Namespace in which Backyards is installed [$BACKYARDS_NAMESPACE] (default "backyards-system")
--base-url string Custom Backyards base URL (uses port forwarding or proxying if empty)
--cacert string The CA to use for verifying Backyards' server certificate
--color use colors on non-tty outputs (default true)
--context string name of the kubeconfig context to use
--formatting.force-color force color even when non in a terminal
-h, --help help for backyards
--interactive ask questions interactively even if stdin or stdout is non-tty
-c, --kubeconfig string path to the kubeconfig file to use for CLI requests
-p, --local-port int Use this local port for port forwarding / proxying to Backyards (when set to 0, a random port will be used) (default -1)
--non-interactive never ask questions interactively
-o, --output string output format (table|yaml|json) (default "table")
--persistent-config-file string Backyards persistent config file to use instead of the default at ~/.banzai/backyards/
--token string Authentication token to use to communicate with Backyards
--use-portforward Use port forwarding instead of proxying to reach Backyards
-v, --verbose turn on debug logging
--version version for backyards
Use "backyards [command] --help" for more information about a command.
Cleanup and Uninstall ๐︎
To remove the demo application, Backyards, Istio, and any other components from your cluster, run the following command. It takes care of removing these components in the correct order.
$ backyards uninstall -a
To delete the Backyards operator, run:
$ helm del --purge backyards-operator
- backyards ยป
- backyards activate ยป
- backyards analyze ยป
- backyards canary ยป
- backyards canary install ยป
- backyards canary uninstall ยป
- backyards cert-manager ยป
- backyards cert-manager install ยป
- backyards cert-manager uninstall ยป
- backyards config ยป
- backyards config delete ยป
- backyards config edit ยป
- backyards config view ยป
- backyards dashboard ยป
- backyards demoapp ยป
- backyards demoapp install ยป
- backyards demoapp load ยป
- backyards demoapp load start ยป
- backyards demoapp load stop ยป
- backyards demoapp uninstall ยป
- backyards graph ยป
- backyards install ยป
- backyards istio ยป
- backyards istio cluster ยป
- backyards istio cluster attach ยป
- backyards istio cluster detach ยป
- backyards istio cluster status ยป
- backyards istio install ยป
- backyards istio outbound-traffic-policy ยป
- backyards istio overview ยป
- backyards istio uninstall ยป
- backyards license ยป
- backyards login ยป
- backyards mtls ยป
- backyards mtls allow ยป
- backyards mtls disable ยป
- backyards mtls get ยป
- backyards mtls require ยป
- backyards mtls unset ยป
- backyards operator ยป
- backyards operator reconcile ยป
- backyards registry ยป
- backyards registry add ยป
- backyards registry ecr ยป
- backyards registry list ยป
- backyards registry reconcile ยป
- backyards registry remove ยป
- backyards routing ยป
- backyards routing circuit-breaker ยป
- backyards routing circuit-breaker delete ยป
- backyards routing circuit-breaker get ยป
- backyards routing circuit-breaker graph ยป
- backyards routing circuit-breaker set ยป
- backyards routing fault-injection ยป
- backyards routing fault-injection delete ยป
- backyards routing fault-injection get ยป
- backyards routing fault-injection set ยป
- backyards routing mirror ยป
- backyards routing mirror delete ยป
- backyards routing mirror get ยป
- backyards routing mirror set ยป
- backyards routing rewrite ยป
- backyards routing rewrite delete ยป
- backyards routing rewrite get ยป
- backyards routing rewrite set ยป
- backyards routing route ยป
- backyards routing route delete ยป
- backyards routing route get ยป
- backyards routing route set ยป
- backyards routing traffic-shifting ยป
- backyards routing traffic-shifting delete ยป
- backyards routing traffic-shifting get ยป
- backyards routing traffic-shifting set ยป
- backyards sidecar-proxy ยป
- backyards sidecar-proxy auto-inject ยป
- backyards sidecar-proxy auto-inject off ยป
- backyards sidecar-proxy auto-inject on ยป
- backyards sidecar-proxy egress ยป
- backyards sidecar-proxy egress delete ยป
- backyards sidecar-proxy egress get ยป
- backyards sidecar-proxy egress recommend ยป
- backyards sidecar-proxy egress set ยป
- backyards tap ยป
- backyards uninstall ยป
- backyards version ยป