1. Docs
2. Reference
3. API
4. @pulumi/openstack
5. config

Module config

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.

APIs

• allowReauth
• applicationCredentialId
• applicationCredentialName
• applicationCredentialSecret
• authUrl
• cacertFile
• cert
• cloud
• defaultDomain
• delayedAuth
• disableNoCacheHeader
• domainId
• domainName
• endpointOverrides
• endpointType
• insecure
• key
• maxRetries
• password
• projectDomainId
• projectDomainName
• region
• swauth
• tenantId
• tenantName
• token
• useOctavia
• userDomainId
• userDomainName
• userId
• userName

APIs

let allowReauth

let allowReauth: boolean | undefined =  __config.getObject<boolean>("allowReauth") || utilities.getEnvBoolean("OS_ALLOW_REAUTH");

If set to false, OpenStack authorization won’t be perfomed automatically, if the initial auth token get expired. Defaults to true

let applicationCredentialId

let applicationCredentialId: string | undefined =  __config.get("applicationCredentialId") || utilities.getEnv("OS_APPLICATION_CREDENTIAL_ID");

Application Credential ID to login with.

let applicationCredentialName

let applicationCredentialName: string | undefined =  __config.get("applicationCredentialName") || utilities.getEnv("OS_APPLICATION_CREDENTIAL_NAME");

Application Credential name to login with.

let applicationCredentialSecret

let applicationCredentialSecret: string | undefined =  __config.get("applicationCredentialSecret") || utilities.getEnv("OS_APPLICATION_CREDENTIAL_SECRET");

Application Credential secret to login with.

let authUrl

let authUrl: string | undefined =  __config.get("authUrl") || utilities.getEnv("OS_AUTH_URL");

The Identity authentication URL.

let cacertFile

let cacertFile: string | undefined =  __config.get("cacertFile") || utilities.getEnv("OS_CACERT");

A Custom CA certificate.

let cert

let cert: string | undefined =  __config.get("cert") || utilities.getEnv("OS_CERT");

A client certificate to authenticate with.

let cloud

let cloud: string | undefined =  __config.get("cloud") || utilities.getEnv("OS_CLOUD");

An entry in a clouds.yaml file to use.

let defaultDomain

let defaultDomain: string | undefined =  __config.get("defaultDomain") || (utilities.getEnv("OS_DEFAULT_DOMAIN") || "default");

The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).

let delayedAuth

let delayedAuth: boolean | undefined =  __config.getObject<boolean>("delayedAuth") || utilities.getEnvBoolean("OS_DELAYED_AUTH");

If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true.

let disableNoCacheHeader

let disableNoCacheHeader: boolean | undefined =  __config.getObject<boolean>("disableNoCacheHeader");

If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.

let domainId

let domainId: string | undefined =  __config.get("domainId") || utilities.getEnv("OS_DOMAIN_ID");

The ID of the Domain to scope to (Identity v3).

let domainName

let domainName: string | undefined =  __config.get("domainName") || utilities.getEnv("OS_DOMAIN_NAME");

The name of the Domain to scope to (Identity v3).

let endpointOverrides

let endpointOverrides: {[key: string]: any} | undefined =  __config.getObject<{[key: string]: any}>("endpointOverrides");

A map of services with an endpoint to override what was from the Keystone catalog

let endpointType

let endpointType: string | undefined =  __config.get("endpointType") || utilities.getEnv("OS_ENDPOINT_TYPE");

let insecure

let insecure: boolean | undefined =  __config.getObject<boolean>("insecure") || utilities.getEnvBoolean("OS_INSECURE");

Trust self-signed certificates.

let key

let key: string | undefined =  __config.get("key") || utilities.getEnv("OS_KEY");

A client private key to authenticate with.

let maxRetries

let maxRetries: number | undefined =  __config.getObject<number>("maxRetries");

How many times HTTP connection should be retried until giving up.

let password

let password: string | undefined =  __config.get("password") || utilities.getEnv("OS_PASSWORD");

Password to login with.

let projectDomainId

let projectDomainId: string | undefined =  __config.get("projectDomainId") || utilities.getEnv("OS_PROJECT_DOMAIN_ID");

The ID of the domain where the proejct resides (Identity v3).

let projectDomainName

let projectDomainName: string | undefined =  __config.get("projectDomainName") || utilities.getEnv("OS_PROJECT_DOMAIN_NAME");

The name of the domain where the project resides (Identity v3).

let region

let region: string | undefined =  __config.get("region") || utilities.getEnv("OS_REGION_NAME");

The OpenStack region to connect to.

let swauth

let swauth: boolean | undefined =  __config.getObject<boolean>("swauth") || utilities.getEnvBoolean("OS_SWAUTH");

Use Swift’s authentication system instead of Keystone. Only used for interaction with Swift.

let tenantId

let tenantId: string | undefined =  __config.get("tenantId") || utilities.getEnv("OS_TENANT_ID", "OS_PROJECT_ID");

The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.

let tenantName

let tenantName: string | undefined =  __config.get("tenantName") || utilities.getEnv("OS_TENANT_NAME", "OS_PROJECT_NAME");

The name of the Tenant (Identity v2) or Project (Identity v3) to login with.

let token

let token: string | undefined =  __config.get("token") || utilities.getEnv("OS_TOKEN", "OS_AUTH_TOKEN");

Authentication token to use as an alternative to username/password.

let useOctavia

let useOctavia: boolean | undefined =  __config.getObject<boolean>("useOctavia") || utilities.getEnvBoolean("OS_USE_OCTAVIA");

If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron).

let userDomainId

let userDomainId: string | undefined =  __config.get("userDomainId") || utilities.getEnv("OS_USER_DOMAIN_ID");

The ID of the domain where the user resides (Identity v3).

let userDomainName

let userDomainName: string | undefined =  __config.get("userDomainName") || utilities.getEnv("OS_USER_DOMAIN_NAME");

The name of the domain where the user resides (Identity v3).

let userId

let userId: string | undefined =  __config.get("userId") || utilities.getEnv("OS_USER_ID");

Username to login with.

let userName

let userName: string | undefined =  __config.get("userName") || utilities.getEnv("OS_USERNAME");

Username to login with.