A Pulumi package for creating and managing OpenStack cloud resources.
Project description
OpenStack Resource Provider
The OpenStack resource provider for Pulumi lets you use OpenStack resources in your cloud programs. To use this package, please install the Pulumi CLI first.
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/openstack
or yarn
:
$ yarn add @pulumi/openstack
Python
To use from Python, install using pip
:
$ pip install pulumi_openstack
Go
To use from Go, use go get
to grab the latest version of the library
$ go get github.com/pulumi/pulumi-openstack/sdk/v4
.NET
To use from .NET, install using dotnet add package
:
$ dotnet add package Pulumi.Openstack
Configuration
The following configuration points are available:
openstack:authUrl
- (Optional) The Identity authentication URL. If omitted, theOS_AUTH_URL
environment variable is used.openstack:cloud
- (Optional) An entry in aclouds.yaml
file. See the OpenStackopenstacksdk
documentation for more information aboutclouds.yaml
files. If omitted, theOS_CLOUD
environment variable is used.openstack:region
- (Optional) The region of the OpenStack cloud to use. If omitted, theOS_REGION_NAME
environment variable is used. IfOS_REGION_NAME
is not set, then no region will be used. It should be possible to omit the region in single-region OpenStack environments, but this behavior may vary depending on the OpenStack environment being used.openstack:userName
- (Optional) The Username to login with. If omitted, theOS_USERNAME
environment variable is used.openstack:userId
- (Optional) The User ID to login with. If omitted, theOS_USER_ID
environment variable is used.openstack:applicationCredentialId
- (Optional) (Identity v3 only) The ID of an application credential to authenticate with. AnapplicationCredentialSecret
has to bet set along with this parameter. Can be set via theOS_APPLICATION_CREDENTIAL_ID
environment variable.openstack:applicationCredentialName
- (Optional) (Identity v3 only) The name of an application credential to authenticate with. Conflicts with theapplicationCredentialName
, requiresuserId
, oruserName
anduserDomainName
(oruserDomainId
) to be set. Can be set via theOS_APPLICATION_CREDENTIAL_NAME
environment variable.openstack:applicationCredentialSecret
- (Optional) (Identity v3 only) The secret of an application credential to authenticate with. Required byapplicationCredentialId
orapplicationCredentialName
. Can be set via theOS_APPLICATION_CREDENTIAL_SECRET
environment variable.openstack:tenantId
- (Optional) The ID of the Tenant (Identity v2) or Project (Identity v3) to login with. If omitted, theOS_TENANT_ID
orOS_PROJECT_ID
environment variables are used.openstack:tenantName
- (Optional) The Name of the Tenant (Identity v2) or Project (Identity v3) to login with. If omitted, theOS_TENANT_NAME
orOS_PROJECT_NAME
environment variable are used.openstack:password
- (Optional) The Password to login with. If omitted, theOS_PASSWORD
environment variable is used.openstack:token
- (Optional) A token is an expiring, temporary means of access issued via the Keystone service. By specifying a token, you do not have to specify a username/password combination, since the token was already created by a username/password out of band of the provider. If omitted, theOS_TOKEN
orOS_AUTH_TOKEN
environment variables are used.openstack:userDomainName
- (Optional) The domain name where the user is located. If omitted, theOS_USER_DOMAIN_NAME
environment variable is checked.openstack:userDomainId
- (Optional) The domain ID where the user is located. If omitted, theOS_USER_DOMAIN_ID
environment variable is checked.openstack:projectDomainName
- (Optional) The domain name where the project is located. If omitted, theOS_PROJECT_DOMAIN_NAME
environment variable is checked.openstack:projectDomainId
- (Optional) The domain ID where the project is located. If omitted, theOS_PROJECT_DOMAIN_ID
environment variable is checked.openstack:domainId
- (Optional) The ID of the Domain to scope to (Identity v3). If omitted, theOS_DOMAIN_ID
environment variable is checked.openstack:domainName
- (Optional) The Name of the Domain to scope to (Identity v3). If omitted, theOS_DOMAIN_NAME
environment variable is checked.openstack:defaultDomain
- (Optional) The ID of the Domain to scope to if no other domain is specified (Identity v3). If omitted, the environment variableOS_DEFAULT_DOMAIN
is checked or a default value ofdefault
will be used.openstack:insecure
- (Optional) Trust self-signed SSL certificates. If omitted, theOS_INSECURE
environment variable is used.openstack:cacertFile
- (Optional) Specify a custom CA certificate when communicating over SSL. You can specify either a path to the file or the contents of the certificate. If omitted, theOS_CACERT
environment variable is used.openstack:cert
- (Optional) Specify client certificate file for SSL client authentication. You can specify either a path to the file or the contents of the certificate. If omitted theOS_CERT
environment variable is used.openstack:key
- (Optional) Specify client private key file for SSL client authentication. You can specify either a path to the file or the contents of the key. If omitted theOS_KEY
environment variable is used.openstack:endpointType
- (Optional) Specify which type of endpoint to use from the service catalog. It can be set using theOS_ENDPOINT_TYPE
environment variable. If not set, public endpoints is used.openstack:endpointOverrides
- (Optional) A set of key/value pairs that can override an endpoint for a specified OpenStack service. Setting an override requires you to specify the full and complete endpoint URL. This might also invalidate any region you have set, too. Please use this at your own risk.openstack:swauth
- (Optional) Set totrue
to authenticate against Swauth, a Swift-native authentication system. If omitted, theOS_SWAUTH
environment variable is used. You must also setusername
to the Swauth/Swift username such asusername:project
. Set thepassword
to the Swauth/Swift key. Finally, setauth_url
as the location of the Swift service. Note that this will only work when used with the OpenStack Object Storage resources.openstack:userOctavia
- (Optional) If set totrue
, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron).openstack:disableNoCacheHeader
- (Optional) If set totrue
, the HTTPCache-Control: no-cache
header will not be added by default to all API requests. If omitted this header is added to all API requests to force HTTP caches (if any) to go upstream instead of serving cached responses.openstack:delayedAuth
- (Optional) If set totrue
, OpenStack authorization will be perfomed, when the service provider client is called.openstack:allowReauth
- (Optional) If set totrue
, OpenStack authorization will be perfomed automatically, if the initial auth token get expired. This is useful, when the token TTL is low or the overall provider execution time expected to be greater than the initial token TTL.
Reference
For further information, please visit the OpenStack provider docs or for detailed reference documentation, please visit the API docs.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pulumi_openstack-4.1.0a1720853279.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b63fc5ac794bfb5eccb9509494df5503904785d17e5da6b7b50a35f713c47965 |
|
MD5 | 1bcc46596945fcbf8d08f51eba924583 |
|
BLAKE2b-256 | 17aca4369244ac8576cd75a295ab3ab1a950d97c356d6098317e6d8b27cfd006 |
Hashes for pulumi_openstack-4.1.0a1720853279-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e7fb7caecfa4208ba7deb68e76a0c1698818ba373001c40f69f18ab42e50233 |
|
MD5 | 7cd33a156a1a0e0d7d398bd1b90cd7c5 |
|
BLAKE2b-256 | 42cd1214f3ce7795c3e86860505d14ab0c377e8f534e6b631a85f29d2ef66be8 |