Skip to content
faros Docs
Sections
Open console

Enter a topic to search documentation.

    faros dev update

    Upgrade the faros-hub release on an existing local environment

    Synopsis

    Upgrade the faros-hub Helm release on the hub kind cluster created by faros dev init. The kind clusters themselves are not modified; only the faros-hub release is upgraded (image, tag, chart version, …).

    Terminal
    faros dev update [flags]

    Examples

    Terminal
      # Upgrade the faros-hub release on the existing hub cluster
      faros dev update
    
      # Upgrade to a specific image tag
      faros dev update --tag v0.0.52
    
      # Upgrade to a specific chart version
      faros dev update --chart-version 0.1.0

    Options

    TEXT
          --agent-chart-path string           Helm chart path or OCI registry URL for agent (default "oci://ghcr.io/faroshq/charts/faros-agent")
          --agent-cluster-name string         Name of the agent cluster in dev mode (default "faros-agent")
          --api-server-port int               Kubernetes API server port for hub kind cluster (change if 6443 is already in use) (default 6443)
          --chart-path string                 Helm chart path or OCI registry URL for hub (default "oci://ghcr.io/faroshq/charts/faros-hub")
          --chart-version string              Helm chart version (default "0.0.51")
          --dex-http-port int                 Host port for the Dex NodePort mapping (Dex serves HTTPS on this port; default 5554) (default 5554)
      -h, --help                              help for update
          --hub-cluster-name string           Name of the hub cluster in dev mode (default "faros-hub")
          --hub-http-port int                 HTTP port for faros hub (change if 8080 is already in use) (default 8080)
          --hub-https-port int                HTTPS port for faros hub (change if 9443 is already in use) (default 9443)
          --image string                      faros hub image to use in dev mode (default "ghcr.io/faroshq/faros-hub")
          --image-pull-policy string          Image pull policy for the hub (use Never when the image is pre-loaded into kind) (default "IfNotPresent")
          --kcp-https-port int                Host port for the kcp front-proxy NodePort mapping (default 7443) (default 7443)
          --kind-network string               kind network to use in dev mode (default "faros-dev")
          --tag string                        faros hub image tag to use in dev mode
          --wait-for-ready-timeout duration   Timeout for waiting for the cluster to be ready (default 2m0s)
          --with-dex                          Deploy Dex as OIDC identity provider into the hub kind cluster
          --with-external-kcp                 Deploy kcp via Helm into the hub kind cluster instead of using embedded kcp
          --worker-count int                  Number of worker (agent) kind clusters to create. Default 0 = hub-only (local user). Use 1+ for development/tests; >1 names clusters <agent-cluster-name>-1, -2, …

    Inherited options

    TEXT
          --insecure-skip-tls-verify   Skip TLS certificate verification when talking to the hub
          --kubeconfig string          Path to the kubeconfig file (default: $KUBECONFIG, then ~/.kube/config)

    See also

    • faros dev — Manage development environment for faros