Skip to main content

VKPR consul install

Description​

Install Consul into cluster. For more information about Consul, click here.

Commands​

Interactive inputs:

  vkpr consul install [flags]

Non-interactive without setting values or using VKPR Values:

  vkpr consul install --default
caution

Consul will always be installed in HA (High Availability), it is recommended that the cluster has at least 3 Nodes.

Argument Reference​

Flags​

  --default   Use to automatically fill inputs with default values
  --dry_run   Simulate an install
  --domain    Set the application address
  --secure    Using HTTPS in the application
  --ssl       Defines that the application will use its own certificate
  --crt_file  Specifies the consul .crt file path
  --key_file  Specifies the consul .key file path

Values File​

Globals​

The following arguments are supported by the globals:

  • domain - (Required) Define the domain used by the application. The default is localhost.
  • secure - (Required) Specifies if the services from the application will expose HTTPS ports inside the cluster. The default is false.
  • namespace - (Optional) Define where the application will be provisioned. The default is vkpr.
  • ingressClassName - (Optional) Define which ingress controller will expose the application. The default is nginx.

Local​

The following arguments are supported:

  • enabled - (Optional) Enables the installation if performed with the command vkpr apply.
  • namespace - (Optional) Define where the application will be provisioned. The default is vkpr.
  • ingressClassName - (Optional) Define which ingress controller will expose the application. The default is nginx.
  • metrics - (Optional) Specifies if the application will expose your metrics. The default is false.
  • ssl
    • enabled - (Optional) Enable the manual certificate into ingress. The default is false.
    • crt - Specify the certificate path.
    • key - Specify the key path.
    • secretName - (Optional) Specifies if the content from the application will be storage in a volume.
  • helmArgs - (Optional) Used when you need to change some value or add a new value to the helm values used by the formula.
caution

Using helmArgs the application may behave in a way that VKPR may not be used in the best way it was designed. Use it when you know what you're doing

Environment values​

The following variables are supported:

  • namespace - VKPR_ENV_CONSUL_NAMESPACE
  • ingressClassName - VKPR_ENV_CONSUL_INGRESS_CLASS_NAME
  • metrics - VKPR_ENV_CONSUL_METRICS
  • ssl
    • enabled - VKPR_ENV_CONSUL_SSL
    • crt - VKPR_ENV_CONSUL_CERTIFICATE
    • key - VKPR_ENV_CONSUL_KEY
    • secretName - VKPR_ENV_CONSUL_SSL_SECRET
About the Formula

Chart Version: 1.2.1
Application Version: v1.16.1
Helm Chart: hashicorp/consul

See Also​