Kong v4.5.6 published on Wednesday, Oct 16, 2024 by Pulumi
Kong Provider
Installation
The kong provider is available as a package in all Pulumi languages:
- JavaScript/TypeScript:
@pulumi/kong
- Python:
pulumi-kong
- Go:
github.com/pulumi/pulumi-kong/sdk/v4/go/kong
- .NET:
Pulumi.Kong
- Java:
com.pulumi/kong
Overview
The Kong Pulumi Provider tested against real Kong (using Docker)!
Pulumi provider tested to work against Kong 2.X.
Usage
To configure the provider:
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
kong:kongAdminUri:
value: http://localhost:8001
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
kong:kongAdminUri:
value: http://localhost:8001
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
kong:kongAdminUri:
value: http://localhost:8001
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
kong:kongAdminUri:
value: http://localhost:8001
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
kong:kongAdminUri:
value: http://localhost:8001
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
kong:kongAdminUri:
value: http://localhost:8001
Optionally you can configure Username and Password for BasicAuth:
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
kong:kongAdminPassword:
value: yourpass
kong:kongAdminUri:
value: http://localhost:8001
kong:kongAdminUsername:
value: youruser
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
kong:kongAdminPassword:
value: yourpass
kong:kongAdminUri:
value: http://localhost:8001
kong:kongAdminUsername:
value: youruser
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
kong:kongAdminPassword:
value: yourpass
kong:kongAdminUri:
value: http://localhost:8001
kong:kongAdminUsername:
value: youruser
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
kong:kongAdminPassword:
value: yourpass
kong:kongAdminUri:
value: http://localhost:8001
kong:kongAdminUsername:
value: youruser
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
kong:kongAdminPassword:
value: yourpass
kong:kongAdminUri:
value: http://localhost:8001
kong:kongAdminUsername:
value: youruser
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
kong:kongAdminPassword:
value: yourpass
kong:kongAdminUri:
value: http://localhost:8001
kong:kongAdminUsername:
value: youruser
Configuration Reference
In addition to generic provider arguments (e.g. alias and version), the following arguments are supported in the Kong provider block:
kongAdminUri
- (Required) The URI of the Kong admin API, can be sourced from theKONG_ADMIN_ADDR
environment variablekongAdminUsername
- (Optional) The username for the Kong admin API if set, can be sourced from theKONG_ADMIN_USERNAME
environment variablekongAdminPassword
- (Optional) The password for the Kong admin API if set, can be sourced from theKONG_ADMIN_PASSWORD
environment variabletlsSkipVerify
- (Optional) Whether to skip TLS certificate verification for the kong api when using https, can be sourced from theTLS_SKIP_VERIFY
environment variablekongApiKey
- (Optional) API key used to secure the kong admin API, can be sourced from theKONG_API_KEY
environment variablekongAdminToken
- (Optional) API key used to secure the kong admin API in the Enterprise Edition, can be sourced from theKONG_ADMIN_TOKEN
environment variablekongWorkspace
- (Optional) Workspace context (Enterprise Edition)strictPluginsMatch
- (Optional) Should pluginsconfigJson
field strictly match plugin configuration