Documentation
¶
Index ¶
- func AuthOptionsFromEnv() (gophercloud.AuthOptions, error)
- func Authenticate(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
- func AuthenticateV2(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
- func AuthenticateV3(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
- func AuthenticatedClient(options gophercloud.AuthOptions) (*gophercloud.ProviderClient, error)
- func NewBlockStorageV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
- func NewCDNV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
- func NewClient(endpoint string) (*gophercloud.ProviderClient, error)
- func NewComputeV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
- func NewDBV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
- func NewIdentityV2(client *gophercloud.ProviderClient) *gophercloud.ServiceClient
- func NewIdentityV3(client *gophercloud.ProviderClient) *gophercloud.ServiceClient
- func NewNetworkV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
- func NewObjectStorageV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
- func NewOrchestrationV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
- func V2EndpointURL(catalog *tokens2.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error)
- func V3EndpointURL(catalog *tokens3.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error)
- type ErrEndpointNotFound
- type ErrInvalidAvailabilityProvided
- type ErrMultipleMatchingEndpointsV2
- type ErrMultipleMatchingEndpointsV3
- type ErrNoAuthURL
- type ErrNoPassword
- type ErrNoUsername
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AuthOptionsFromEnv ¶
func AuthOptionsFromEnv() (gophercloud.AuthOptions, error)
AuthOptionsFromEnv fills out an identity.AuthOptions structure with the settings found on the various OpenStack OS_* environment variables. The following variables provide sources of truth: OS_AUTH_URL, OS_USERNAME, OS_PASSWORD, OS_TENANT_ID, and OS_TENANT_NAME. Of these, OS_USERNAME, OS_PASSWORD, and OS_AUTH_URL must have settings, or an error will result. OS_TENANT_ID and OS_TENANT_NAME are optional.
func Authenticate ¶
func Authenticate(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
Authenticate or re-authenticate against the most recent identity service supported at the provided endpoint.
func AuthenticateV2 ¶
func AuthenticateV2(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
AuthenticateV2 explicitly authenticates against the identity v2 endpoint.
func AuthenticateV3 ¶
func AuthenticateV3(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error
AuthenticateV3 explicitly authenticates against the identity v3 service.
func AuthenticatedClient ¶
func AuthenticatedClient(options gophercloud.AuthOptions) (*gophercloud.ProviderClient, error)
AuthenticatedClient logs in to an OpenStack cloud found at the identity endpoint specified by options, acquires a token, and returns a Client instance that's ready to operate. It first queries the root identity endpoint to determine which versions of the identity service are supported, then chooses the most recent identity service available to proceed.
func NewBlockStorageV1 ¶
func NewBlockStorageV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewBlockStorageV1 creates a ServiceClient that may be used to access the v1 block storage service.
func NewCDNV1 ¶
func NewCDNV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewCDNV1 creates a ServiceClient that may be used to access the OpenStack v1 CDN service.
func NewClient ¶
func NewClient(endpoint string) (*gophercloud.ProviderClient, error)
NewClient prepares an unauthenticated ProviderClient instance. Most users will probably prefer using the AuthenticatedClient function instead. This is useful if you wish to explicitly control the version of the identity service that's used for authentication explicitly, for example.
func NewComputeV2 ¶
func NewComputeV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewComputeV2 creates a ServiceClient that may be used with the v2 compute package.
func NewDBV1 ¶
func NewDBV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewDBV1 creates a ServiceClient that may be used to access the v1 DB service.
func NewIdentityV2 ¶
func NewIdentityV2(client *gophercloud.ProviderClient) *gophercloud.ServiceClient
NewIdentityV2 creates a ServiceClient that may be used to interact with the v2 identity service.
func NewIdentityV3 ¶
func NewIdentityV3(client *gophercloud.ProviderClient) *gophercloud.ServiceClient
NewIdentityV3 creates a ServiceClient that may be used to access the v3 identity service.
func NewNetworkV2 ¶
func NewNetworkV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewNetworkV2 creates a ServiceClient that may be used with the v2 network package.
func NewObjectStorageV1 ¶
func NewObjectStorageV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewObjectStorageV1 creates a ServiceClient that may be used with the v1 object storage package.
func NewOrchestrationV1 ¶
func NewOrchestrationV1(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)
NewOrchestrationV1 creates a ServiceClient that may be used to access the v1 orchestration service.
func V2EndpointURL ¶
func V2EndpointURL(catalog *tokens2.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error)
V2EndpointURL discovers the endpoint URL for a specific service from a ServiceCatalog acquired during the v2 identity service. The specified EndpointOpts are used to identify a unique, unambiguous endpoint to return. It's an error both when multiple endpoints match the provided criteria and when none do. The minimum that can be specified is a Type, but you will also often need to specify a Name and/or a Region depending on what's available on your OpenStack deployment.
func V3EndpointURL ¶
func V3EndpointURL(catalog *tokens3.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error)
V3EndpointURL discovers the endpoint URL for a specific service from a Catalog acquired during the v3 identity service. The specified EndpointOpts are used to identify a unique, unambiguous endpoint to return. It's an error both when multiple endpoints match the provided criteria and when none do. The minimum that can be specified is a Type, but you will also often need to specify a Name and/or a Region depending on what's available on your OpenStack deployment.
Types ¶
type ErrEndpointNotFound ¶
type ErrEndpointNotFound struct{ *gophercloud.BaseError }
func (ErrEndpointNotFound) Error ¶
func (e ErrEndpointNotFound) Error() string
type ErrInvalidAvailabilityProvided ¶
type ErrInvalidAvailabilityProvided struct{ *gophercloud.InvalidInputError }
func (ErrInvalidAvailabilityProvided) Error ¶
func (e ErrInvalidAvailabilityProvided) Error() string
type ErrMultipleMatchingEndpointsV2 ¶
type ErrMultipleMatchingEndpointsV2 struct {
*gophercloud.BaseError
// contains filtered or unexported fields
}
func (*ErrMultipleMatchingEndpointsV2) Error ¶
func (e *ErrMultipleMatchingEndpointsV2) Error() string
type ErrMultipleMatchingEndpointsV3 ¶
type ErrMultipleMatchingEndpointsV3 struct {
*gophercloud.BaseError
// contains filtered or unexported fields
}
func (*ErrMultipleMatchingEndpointsV3) Error ¶
func (e *ErrMultipleMatchingEndpointsV3) Error() string
type ErrNoAuthURL ¶
type ErrNoAuthURL struct{ *gophercloud.InvalidInputError }
func (*ErrNoAuthURL) Error ¶
func (e *ErrNoAuthURL) Error() string
type ErrNoPassword ¶
type ErrNoPassword struct{ *gophercloud.InvalidInputError }
func (*ErrNoPassword) Error ¶
func (e *ErrNoPassword) Error() string
type ErrNoUsername ¶
type ErrNoUsername struct{ *gophercloud.InvalidInputError }
func (*ErrNoUsername) Error ¶
func (e *ErrNoUsername) Error() string
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
blockstorage
|
|
|
v1/snapshots
Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
|
Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service. |
|
v1/volumes
Package volumes provides information and interaction with volumes in the OpenStack Block Storage service.
|
Package volumes provides information and interaction with volumes in the OpenStack Block Storage service. |
|
compute
|
|
|
v2/extensions/diskconfig
Package diskconfig provides information and interaction with the Disk Config extension that works with the OpenStack Compute service.
|
Package diskconfig provides information and interaction with the Disk Config extension that works with the OpenStack Compute service. |
|
v2/extensions/keypairs
Package keypairs provides information and interaction with the Keypairs extension for the OpenStack Compute service.
|
Package keypairs provides information and interaction with the Keypairs extension for the OpenStack Compute service. |
|
v2/extensions/volumeattach
Package volumeattach provides the ability to attach and detach volumes to instances
|
Package volumeattach provides the ability to attach and detach volumes to instances |
|
v2/flavors
Package flavors provides information and interaction with the flavor API resource in the OpenStack Compute service.
|
Package flavors provides information and interaction with the flavor API resource in the OpenStack Compute service. |
|
v2/images
Package images provides information and interaction with the image API resource in the OpenStack Compute service.
|
Package images provides information and interaction with the image API resource in the OpenStack Compute service. |
|
v2/servers
Package servers provides information and interaction with the server API resource in the OpenStack Compute service.
|
Package servers provides information and interaction with the server API resource in the OpenStack Compute service. |
|
db
|
|
|
identity
|
|
|
v2/tenants
Package tenants provides information and interaction with the tenants API resource for the OpenStack Identity service.
|
Package tenants provides information and interaction with the tenants API resource for the OpenStack Identity service. |
|
v2/tokens
Package tokens provides information and interaction with the token API resource for the OpenStack Identity service.
|
Package tokens provides information and interaction with the token API resource for the OpenStack Identity service. |
|
v3/tokens
Package tokens provides information and interaction with the token API resource for the OpenStack Identity service.
|
Package tokens provides information and interaction with the token API resource for the OpenStack Identity service. |
|
networking
|
|
|
v2/networks
Package networks contains functionality for working with Neutron network resources.
|
Package networks contains functionality for working with Neutron network resources. |
|
v2/ports
Package ports contains functionality for working with Neutron port resources.
|
Package ports contains functionality for working with Neutron port resources. |
|
v2/subnets
Package subnets contains functionality for working with Neutron subnet resources.
|
Package subnets contains functionality for working with Neutron subnet resources. |
|
objectstorage
|
|
|
v1/accounts
Package accounts contains functionality for working with Object Storage account resources.
|
Package accounts contains functionality for working with Object Storage account resources. |
|
v1/containers
Package containers contains functionality for working with Object Storage container resources.
|
Package containers contains functionality for working with Object Storage container resources. |
|
v1/objects
Package objects contains functionality for working with Object Storage object resources.
|
Package objects contains functionality for working with Object Storage object resources. |
|
orchestration
|
|
|
v1/buildinfo
Package buildinfo provides build information about heat deployments.
|
Package buildinfo provides build information about heat deployments. |
|
v1/stackevents
Package stackevents provides operations for finding, listing, and retrieving stack events.
|
Package stackevents provides operations for finding, listing, and retrieving stack events. |
|
v1/stackresources
Package stackresources provides operations for working with stack resources.
|
Package stackresources provides operations for working with stack resources. |
|
v1/stacks
Package stacks provides operation for working with Heat stacks.
|
Package stacks provides operation for working with Heat stacks. |
|
v1/stacktemplates
Package stacktemplates provides operations for working with Heat templates.
|
Package stacktemplates provides operations for working with Heat templates. |