On this page
meshctl install
Reference for the ‘meshctl install’ command.
meshctl install
Install a Gloo product by using a valid license key.
Synopsis
Install the Gloo management plane in a cluster, and provide the license for the Gloo product that you want to install. You can include basic profiles, which provide all the necessary settings for a complete installation, in the ‘–profiles flag’. For more information, see the CLI install profiles.
meshctl install [flags]
Examples
# Install the Gloo Mesh Enterprise management plane by using the 'mgmt-server' profile
meshctl install --profiles mgmt-server \
--kubecontext $MGMT_CONTEXT \
--set common.cluster=$MGMT_CLUSTER \
--set licensing.glooMeshLicenseKey=$GLOO_MESH_LICENSE_KEY
# Install Gloo Mesh Core in a single-cluster setup by using the 'gloo-core-single-cluster' profile
meshctl install --profiles gloo-core-single-cluster \
--set common.cluster=$CLUSTER_NAME \
--set licensing.glooMeshCoreLicenseKey=$GLOO_MESH_CORE_LICENSE_KEY
Options
--chart-file string Path to a local Helm chart for installing Gloo.
If unset, this command installs Gloo from the publicly released Helm chart.
--chart-values-file string File containing value overrides for the Gloo Helm chart.
--crd-chart-file string Path to a local Helm chart for installing Gloo Platform CRDs.
If unset, this command installs Gloo CRDs from the publicly released Helm chart.
-d, --dry-run Output the installation manifest without installing it.
-h, --help help for install
--profiles strings Profile(s) to use for basic Helm values. Multiple can be applied in a comma-delimited list, in which merge priority is left to right, and any values specified in '--set' or '--chart-values-file' flags have highest merge priority. (default [mgmt-server])
-r, --register Also register the Gloo management cluster as a workload cluster.
--relay-server-address string The address used by the Gloo agent to communicate with the relay server. Only required if the Gloo management cluster is also registered as a workload cluster.
--set stringArray Extra Helm values for the Gloo chart.
--skip-ui Skip installation of the Gloo UI
--version string Gloo version to install. By default, it installs the latest stable patch version of your meshctl CLI client's major and minor version.
Options inherited from parent commands
--kubeconfig string Path to the kubeconfig file for the cluster.
--kubecontext string Kubernetes context for the cluster to run the command in.
-n, --namespace string Namespace to run the command in. (default "gloo-mesh")
--plain Disable styling for terminal output.
-v, --verbose Enable verbose logging.
SEE ALSO
- meshctl - Use the
meshctl
command line interface (CLI) tool to set up and manage Gloo products in your environment.