openstack

Documentation

Overview

A Pulumi package for creating and managing OpenStack cloud resources.

Index

• func PkgVersion() (semver.Version, error)
• type Provider
  • func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, ...) (*Provider, error)
  • func (*Provider) ElementType() reflect.Type
  • func (i *Provider) ToProviderOutput() ProviderOutput
  • func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
• type ProviderArgs
  • func (ProviderArgs) ElementType() reflect.Type
• type ProviderInput
• type ProviderOutput
  • func (ProviderOutput) ElementType() reflect.Type
  • func (o ProviderOutput) ToProviderOutput() ProviderOutput
  • func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

Functions

func PkgVersion

func PkgVersion() (semver.Version, error)

PkgVersion uses reflection to determine the version of the current package.

Types

type Provider

type Provider struct {
	pulumi.ProviderResourceState

	// Application Credential ID to login with.
	ApplicationCredentialId pulumi.StringPtrOutput `pulumi:"applicationCredentialId"`
	// Application Credential name to login with.
	ApplicationCredentialName pulumi.StringPtrOutput `pulumi:"applicationCredentialName"`
	// Application Credential secret to login with.
	ApplicationCredentialSecret pulumi.StringPtrOutput `pulumi:"applicationCredentialSecret"`
	// The Identity authentication URL.
	AuthUrl pulumi.StringPtrOutput `pulumi:"authUrl"`
	// A Custom CA certificate.
	CacertFile pulumi.StringPtrOutput `pulumi:"cacertFile"`
	// A client certificate to authenticate with.
	Cert pulumi.StringPtrOutput `pulumi:"cert"`
	// An entry in a `clouds.yaml` file to use.
	Cloud pulumi.StringPtrOutput `pulumi:"cloud"`
	// The name of the Domain ID to scope to if no other domain is specified. Defaults to `default` (Identity v3).
	DefaultDomain pulumi.StringPtrOutput `pulumi:"defaultDomain"`
	// The ID of the Domain to scope to (Identity v3).
	DomainId pulumi.StringPtrOutput `pulumi:"domainId"`
	// The name of the Domain to scope to (Identity v3).
	DomainName   pulumi.StringPtrOutput `pulumi:"domainName"`
	EndpointType pulumi.StringPtrOutput `pulumi:"endpointType"`
	// A client private key to authenticate with.
	Key pulumi.StringPtrOutput `pulumi:"key"`
	// Password to login with.
	Password pulumi.StringPtrOutput `pulumi:"password"`
	// The ID of the domain where the proejct resides (Identity v3).
	ProjectDomainId pulumi.StringPtrOutput `pulumi:"projectDomainId"`
	// The name of the domain where the project resides (Identity v3).
	ProjectDomainName pulumi.StringPtrOutput `pulumi:"projectDomainName"`
	// The OpenStack region to connect to.
	Region pulumi.StringPtrOutput `pulumi:"region"`
	// The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
	TenantId pulumi.StringPtrOutput `pulumi:"tenantId"`
	// The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
	TenantName pulumi.StringPtrOutput `pulumi:"tenantName"`
	// Authentication token to use as an alternative to username/password.
	Token pulumi.StringPtrOutput `pulumi:"token"`
	// The ID of the domain where the user resides (Identity v3).
	UserDomainId pulumi.StringPtrOutput `pulumi:"userDomainId"`
	// The name of the domain where the user resides (Identity v3).
	UserDomainName pulumi.StringPtrOutput `pulumi:"userDomainName"`
	// Username to login with.
	UserId pulumi.StringPtrOutput `pulumi:"userId"`
	// Username to login with.
	UserName pulumi.StringPtrOutput `pulumi:"userName"`
}

The provider type for the openstack package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// If set to `false`, OpenStack authorization won't be perfomed automatically, if the initial auth token get expired.
	// Defaults to `true`
	AllowReauth pulumi.BoolPtrInput
	// Application Credential ID to login with.
	ApplicationCredentialId pulumi.StringPtrInput
	// Application Credential name to login with.
	ApplicationCredentialName pulumi.StringPtrInput
	// Application Credential secret to login with.
	ApplicationCredentialSecret pulumi.StringPtrInput
	// The Identity authentication URL.
	AuthUrl pulumi.StringPtrInput
	// A Custom CA certificate.
	CacertFile pulumi.StringPtrInput
	// A client certificate to authenticate with.
	Cert pulumi.StringPtrInput
	// An entry in a `clouds.yaml` file to use.
	Cloud pulumi.StringPtrInput
	// The name of the Domain ID to scope to if no other domain is specified. Defaults to `default` (Identity v3).
	DefaultDomain pulumi.StringPtrInput
	// If set to `false`, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults
	// to `true`.
	DelayedAuth pulumi.BoolPtrInput
	// If set to `true`, the HTTP `Cache-Control: no-cache` header will not be added by default to all API requests.
	DisableNoCacheHeader pulumi.BoolPtrInput
	// The ID of the Domain to scope to (Identity v3).
	DomainId pulumi.StringPtrInput
	// The name of the Domain to scope to (Identity v3).
	DomainName pulumi.StringPtrInput
	// Outputs very verbose logs with all calls made to and responses from OpenStack
	EnableLogging pulumi.BoolPtrInput
	// A map of services with an endpoint to override what was from the Keystone catalog
	EndpointOverrides pulumi.MapInput
	EndpointType      pulumi.StringPtrInput
	// Trust self-signed certificates.
	Insecure pulumi.BoolPtrInput
	// A client private key to authenticate with.
	Key pulumi.StringPtrInput
	// How many times HTTP connection should be retried until giving up.
	MaxRetries pulumi.IntPtrInput
	// Password to login with.
	Password pulumi.StringPtrInput
	// The ID of the domain where the proejct resides (Identity v3).
	ProjectDomainId pulumi.StringPtrInput
	// The name of the domain where the project resides (Identity v3).
	ProjectDomainName pulumi.StringPtrInput
	// The OpenStack region to connect to.
	Region pulumi.StringPtrInput
	// Use Swift's authentication system instead of Keystone. Only used for interaction with Swift.
	Swauth pulumi.BoolPtrInput
	// The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.
	TenantId pulumi.StringPtrInput
	// The name of the Tenant (Identity v2) or Project (Identity v3) to login with.
	TenantName pulumi.StringPtrInput
	// Authentication token to use as an alternative to username/password.
	Token pulumi.StringPtrInput
	// If set to `true`, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron).
	UseOctavia pulumi.BoolPtrInput
	// The ID of the domain where the user resides (Identity v3).
	UserDomainId pulumi.StringPtrInput
	// The name of the domain where the user resides (Identity v3).
	UserDomainName pulumi.StringPtrInput
	// Username to login with.
	UserId pulumi.StringPtrInput
	// Username to login with.
	UserName pulumi.StringPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput