Skip to main content

VKPR kong install

Description​

Install Kong Gateway into cluster. For more information about Kong, click here.

Commands​

Interactive inputs:

  vkpr kong install [flags]

Non-interactive without setting values or using VKPR Values:

  vkpr kong install --default
Info

If the VKPR dont identify any postgresql installed in the cluster, he will install to use with kong.

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
  --HA              Specifies if the application will have High Availability
  --mode            Specifies the type of Kong Deployment
  --license         Specifies the Kong Enterprise License path
  --rbac_password   Specifies the RBAC Super Admin Password Has no effect on hybrid data plane installatio
  --plane           If mode is set do hybrid, specifies which plane to install
  --cp_url          Specifies which kong CP endpoint
  --telemetry_url   Specifies which kong CP telemetry endpoint

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.

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.
  • HA - (Optional) Specifies if the application will have High Availability. The default is false.
  • metrics - (Optional) Specifies if the application will expose your metrics. The default is false.
  • mode - (Required) Specifies the type of Kong Deployment. Allowed Values: dbless, standalone and hybrid. The default is dbless.
  • enterprise
    • license - (Optional) Specifies the Kong Enterprise License path.
  • rbac
    • adminPassword - (Required) Specify the kong admin password. The default is vkpr123.
    • openid
      • enabled - (Optional) Enable Kong Manager OpenID Connect with Keycloak.
      • clientSecret - Specifies the Client Secret used by Keycloak.
  • vitals
    • prometheusStrategy - (Optional) Use prometheus to collect the vital's metrics from Kong.
  • hybrid
    • plane - (Optional) Specifies the Kong Plane to be installed. Allowed Values: control and data. The default is control.
    • dataPlane
      • controlPlaneEndpoint - (Required with DataPlane) Specifies the Kong Control Plane endpoint to communicate between the planes.
      • telemetryEndpoint - (Required with DataPlane) Specifies the Kong Telemetry enpoint to communicate between the planes.
  • 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 if you know what you're doing.

Environment values​

The following variables are supported:

  • namespace - VKPR_ENV_KONG_NAMESPACE
  • HA - VKPR_ENV_KONG_HA
  • mode - VKPR_ENV_KONG_MODE
  • metrics - VKPR_ENV_KONG_METRICS
  • license - VKPR_ENV_KONG_ENTERPRISE_LICENSE
  • prometheusStrategy - VKPR_ENV_KONG_VITALS_STRATEGY
  • adminPassword - VKPR_ENV_KONG_RBAC_ADMIN_PASSWORD
  • openid
    • enabled - VKPR_ENV_KONG_KEYCLOAK_OPENID
    • clientSecret - VKPR_ENV_KONG_KEYCLOAK_OPENID_CLIENTSECRET
  • plane - VKPR_ENV_KONG_PLANE
  • controlPlaneEndpoint - VKPR_ENV_KONG_CP_ENDPOINT
  • telemetryEndpoint - VKPR_ENV_KONG_TELEMETRY_URL
About the Formula

Chart Version: 2.19.0
Application Version: 3.2.2.1
Helm Chart: kong/kong

See Also​