1. Packages
  2. Kong Provider
Kong v4.5.6 published on Wednesday, Oct 16, 2024 by Pulumi

Kong Provider

kong logo
Kong v4.5.6 published on Wednesday, Oct 16, 2024 by Pulumi

    Installation

    The kong provider is available as a package in all Pulumi languages:

    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 the KONG_ADMIN_ADDR environment variable
    • kongAdminUsername - (Optional) The username for the Kong admin API if set, can be sourced from the KONG_ADMIN_USERNAME environment variable
    • kongAdminPassword - (Optional) The password for the Kong admin API if set, can be sourced from the KONG_ADMIN_PASSWORD environment variable
    • tlsSkipVerify - (Optional) Whether to skip TLS certificate verification for the kong api when using https, can be sourced from the TLS_SKIP_VERIFY environment variable
    • kongApiKey - (Optional) API key used to secure the kong admin API, can be sourced from the KONG_API_KEY environment variable
    • kongAdminToken - (Optional) API key used to secure the kong admin API in the Enterprise Edition, can be sourced from the KONG_ADMIN_TOKEN environment variable
    • kongWorkspace - (Optional) Workspace context (Enterprise Edition)
    • strictPluginsMatch - (Optional) Should plugins configJson field strictly match plugin configuration
    kong logo
    Kong v4.5.6 published on Wednesday, Oct 16, 2024 by Pulumi