package openstack

import "k8s.io/kubernetes/Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack"

Index

Variables

var (
	ErrNoAuthURL  = fmt.Errorf("Environment variable OS_AUTH_URL needs to be set.")
	ErrNoUsername = fmt.Errorf("Environment variable OS_USERNAME needs to be set.")
	ErrNoPassword = fmt.Errorf("Environment variable OS_PASSWORD needs to be set.")
)

ErrNoAuthUrl, ErrNoUsername, and ErrNoPassword errors indicate of the required OS_AUTH_URL, OS_USERNAME, or OS_PASSWORD environment variables, respectively, remain undefined. See the AuthOptions() function for more details.

Functions

func AuthOptionsFromEnv

func AuthOptionsFromEnv() (gophercloud.AuthOptions, error)

AuthOptions 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

NewBlockStorageV1 creates a ServiceClient that may be used to access the v1 block storage service.

func NewCDNV1

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

NewComputeV2 creates a ServiceClient that may be used with the v2 compute package.

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

NewNetworkV2 creates a ServiceClient that may be used with the v2 network package.

func NewObjectStorageV1

NewObjectStorageV1 creates a ServiceClient that may be used with the v1 object storage package.

func NewOrchestrationV1

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.

Source Files

auth_env.go client.go endpoint_location.go

Directories

PathSynopsis
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/blockstorage
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/blockstorage/v1
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/blockstorage/v1/apiversionsPackage apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/blockstorage/v1/snapshotsPackage snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/blockstorage/v1/volumesPackage volumes provides information and interaction with volumes in the OpenStack Block Storage service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/blockstorage/v1/volumetypesPackage volumetypes provides information and interaction with volume types in the OpenStack Block Storage service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/cdn
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/cdn/v1
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/cdn/v1/basePackage base provides information and interaction with the base API resource in the OpenStack CDN service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/cdn/v1/flavorsPackage flavors provides information and interaction with the flavors API resource in the OpenStack CDN service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/cdn/v1/serviceassetsPackage serviceassets provides information and interaction with the serviceassets API resource in the OpenStack CDN service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/cdn/v1/servicesPackage services provides information and interaction with the services API resource in the OpenStack CDN service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/common
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/common/extensionsPackage extensions provides information and interaction with the different extensions available for an OpenStack service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensionsPackage extensions provides information and interaction with the different extensions available for the OpenStack Compute service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/bootfromvolume
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/defsecrules
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/diskconfigPackage diskconfig provides information and interaction with the Disk Config extension that works with the OpenStack Compute service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/floatingipPackage floatingip provides the ability to manage floating ips through nova-network
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/keypairsPackage keypairs provides information and interaction with the Keypairs extension for the OpenStack Compute service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/secgroups
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/servergroupsPackage servergroups provides the ability to manage server groups
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/startstopPackage startstop provides functionality to start and stop servers that have been provisioned by the OpenStack Compute service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/tenantnetworksPackage tenantnetworks provides the ability for tenants to see information about the networks they have access to
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/extensions/volumeattachPackage volumeattach provides the ability to attach and detach volumes to instances
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/flavorsPackage flavors provides information and interaction with the flavor API resource in the OpenStack Compute service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/imagesPackage images provides information and interaction with the image API resource in the OpenStack Compute service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/compute/v2/serversPackage servers provides information and interaction with the server API resource in the OpenStack Compute service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v2
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v2/extensionsPackage extensions provides information and interaction with the different extensions available for the OpenStack Identity service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v2/extensions/admin
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v2/extensions/admin/rolesPackage roles provides functionality to interact with and control roles on the API.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v2/tenantsPackage tenants provides information and interaction with the tenants API resource for the OpenStack Identity service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v2/tokensPackage tokens provides information and interaction with the token API resource for the OpenStack Identity service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v2/users
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v3
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v3/endpointsPackage endpoints provides information and interaction with the service endpoints API resource in the OpenStack Identity service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v3/servicesPackage services provides information and interaction with the services API resource for the OpenStack Identity service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/identity/v3/tokensPackage tokens provides information and interaction with the token API resource for the OpenStack Identity service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/apiversionsPackage apiversions provides information and interaction with the different API versions for the OpenStack Neutron service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/common
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/externalPackage external provides information and interaction with the external extension for the OpenStack Networking service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/fwaasPackage fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/fwaas/firewalls
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/fwaas/policies
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/fwaas/rules
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/layer3Package layer3 provides access to the Layer-3 networking extension for the OpenStack Neutron service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/layer3/floatingips
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/layer3/routers
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/lbaasPackage lbaas provides information and interaction with the Load Balancer as a Service extension for the OpenStack Networking service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/lbaas/members
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/lbaas/monitors
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/lbaas/pools
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/lbaas/vips
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/providerPackage provider gives access to the provider Neutron plugin, allowing network extended attributes.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/securityPackage security contains functionality to work with security group and security group rules Neutron resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/security/groups
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/extensions/security/rules
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/networksPackage networks contains functionality for working with Neutron network resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/portsPackage ports contains functionality for working with Neutron port resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/networking/v2/subnetsPackage subnets contains functionality for working with Neutron subnet resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/objectstorage
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/objectstorage/v1
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/objectstorage/v1/accountsPackage accounts contains functionality for working with Object Storage account resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/objectstorage/v1/containersPackage containers contains functionality for working with Object Storage container resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/objectstorage/v1/objectsPackage objects contains functionality for working with Object Storage object resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration/v1
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration/v1/apiversionsPackage apiversions provides information and interaction with the different API versions for the OpenStack Heat service.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration/v1/buildinfoPackage buildinfo provides build information about heat deployments.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration/v1/stackeventsPackage stackevents provides operations for finding, listing, and retrieving stack events.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration/v1/stackresourcesPackage stackresources provides operations for working with stack resources.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration/v1/stacksPackage stacks provides operation for working with Heat stacks.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/orchestration/v1/stacktemplatesPackage stacktemplates provides operations for working with Heat templates.
Godeps/_workspace/src/github.com/rackspace/gophercloud/openstack/utils
Version
v0.19.3
Published
Jun 22, 2015
Platform
windows/amd64
Imports
7 packages
Last checked
2 minutes ago

Tools for package owners.