Installing
This package is available in many languages in the standard packaging formats.
Node.js (Java/TypeScript)
To use from JavaScript or TypeScript in Node.js, install using either npm
:
`$ npm install @pulumi/pulumi-consul`
or yarn
:
`$ yarn add @pulumi/pulumi-consul`
Python
To use from Python, install using pip
:
`$ pip install pulumi_consul`
Go
To use from Go, use go get
to grab the latest version of the library
$ go get github.com/nrf110/pulumi-consul/sdk/go/...
Configuration
The following configuration points are available for the consul
provider:
consul:datacenter
- (Optional) The datacenter to use. Defaults to that of the agent.
consul:address
(environment: CONSUL_ADDRESS
or CONSUL_HTTP_ADDR
) - (Optional) The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
consul:scheme
(environment: CONSUL_SCHEME
or CONSUL_HTTP_SCHEME
) - (Optional) The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
consul:http_auth
(environment: CONSUL_HTTP_AUTH
) - (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user
or user:pass
.
consul:ca_file
(environment: CONSUL_CA_FILE
) - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
consul:cert_file
(environment: CONSUL_CERT_FILE
) - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of consul:key_file
.
consul:key_file
(environment: CONSUL_KEY_FILE
) - (Optional) A path to a PEM-encoded private key, required if consul:cert_file
is specified.
consul:ca_path
(environment: 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.
consul:insecure_https
- (Optional) Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with consul:scheme
set to "https".
consul:token
- (environment: CONSUL_TOKEN
or CONSUL_HTTP_TOKEN
) - (Optional) The ACL token to use by default when making requests to the agent.
Reference
For detailed reference documentation, please visit the API docs.