Skip to main content

Configuration

Configuration for pulumi-portainer.
2 min read

Configuration for pulumi-portainer.

npm package pulumi-portainer version 2.0.2. Pulumi bridge terraform-provider version 1.4.0. Upstream provider registry.opentofu.org/portainer/portainer version 2.0.0.

An explicit provider is new portainer.Provider(name, args). Stack configuration is a pulumi.Config object named portainer.

A value marked secret is passed through pulumi.secret or listed in additionalSecretOutputs on the provider resource.

Fields#

PropertyTypeSourceSecretDescription
apiKeystringprovider args; stack config via config.getyesAPI key to authenticate with Portainer. Mutually exclusive with 'user' and 'password'.
apiPasswordstringprovider args; stack config via config.getyesPassword for authentication. Must be used together with 'user'.
apiUserstringprovider args; stack config via config.getyesUsername for authentication. Must be used together with 'password'.
customHeaders{ [key: string]: string }provider args; stack config via config.getObjectnoCustom headers to add to all requests (e.g. for Cloudflare Access or other security proxies).
endpointstringprovider args; stack config via config.getnoURL of the Portainer instance (e.g. https://portainer.example.com). '/api' will be appended automatically if missing.
skipSslVerifybooleanprovider args; stack config via config.getObjectnoVerify the SSL/TLS certificate for the Portainer endpoint