backyards install 🔗︎

Install Backyards

Synopsis 🔗︎

Installs Backyards.

The command automatically applies the resources. It can only dump the applicable resources with the ‘–dump-resources’ option.

The command can install every component at once with the ‘–install-everything’ option.

backyards install [flags]

Examples 🔗︎

  # Default install.
  backyards install

  # Install Backyards into a non-default namespace.
  backyards install -n backyards-system

Options 🔗︎

      --additional-cp-settings string   A yaml file containing additional settings to be added to the freshly created control plane object.
      --anonymous-auth                  Switch to anonymous mode
      --api-image string                Image for the API
  -d, --dump-resources                  Dump resources to stdout instead of applying them
      --enable-auditsink                Enable deploying the auditsink service and sending audit logs over http
      --enable-ha                       Enable HA mode for backyards components (requires at least 3 nodes in the destination cluster)
  -h, --help                            help for install
      --install-cert-manager            Whether to install cert manager (default true)
  -a, --install-everything              Install all required components at once
      --istio-cr-file string            Filename of a custom Istio CR yaml
      --istio-namespace string          Namespace of Istio sidecar injector (default "istio-system")
      --release-name string             Name of the release (default "backyards")
      --run-demo                        Install demo application, send load and open up the dashboard
      --web-image string                Image for the frontend

Options inherited from parent commands 🔗︎

      --accept-license                   Accept the 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
      --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/
      --resource-wait-timeout duration   The length of time to wait before giving up on waiting for resource coditions to met (default 5m0s)
      --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