The Consul resource provider for Pulumi lets you manage Consul resources in your cloud programs. To use this package, please install the Pulumi CLI first.
This package is available in many languages in the standard packaging formats.
To use from JavaScript or TypeScript in Node.js, install using either npm
:
$ npm install @pulumi/consul
or yarn
:
$ yarn add @pulumi/consul
To use from Python, install using pip
:
$ pip install pulumi_consul
To use from Go, use go get
to grab the latest version of the library
$ go get github.com/pulumi/pulumi-consul/sdk/v3
To use from .NET, install using dotnet add package
:
$ dotnet add package Pulumi.Consul
The following configuration points are available:
consul:address
- (Optional) The HTTP(S) API address of the agent to use. Defaults to127.0.0.1:8500
.consul:scheme
- (Optional) The URL scheme of the agent to use (http
orhttps
). Defaults tohttp
.consul:httpAuth
- (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. This may also be specified using theCONSUL_HTTP_AUTH
environment variable.consul:datacenter
- (Optional) The datacenter to use. Defaults to that of the agent.consul:token
- (Optional) The ACL token to use by default when making requests to the agent. Can also be specified withCONSUL_HTTP_TOKEN
orCONSUL_TOKEN
as an environment variable.consul:caFile
- (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.consul:certFile
- (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use ofkeyFile
.consul:keyFile
- (Optional) A path to a PEM-encoded private key, required ifcertFile
is specified.consul:caPath
- (Optional) A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with theCONSUL_CAPATH
environment variable.consul:insecureHttps
- (Optional) Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set tohttps
.
For further information, please visit the Consul provider docs or for detailed reference documentation, please visit the API docs.