gophercloud: github.com/rackspace/gophercloud/openstack Index | Files | Directories

package openstack

import "github.com/rackspace/gophercloud/openstack"

Index

Package Files

auth_env.go client.go endpoint_location.go

Variables

var (
    ErrNoAuthURL  = fmt.Errorf("Environment variable OS_AUTH_URL needs to be set.")
    ErrNoUsername = fmt.Errorf("Environment variable OS_USERNAME, OS_USERID, or OS_TOKEN needs to be set.")
    ErrNoPassword = fmt.Errorf("Environment variable OS_PASSWORD or OS_TOKEN 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.

func AuthOptionsFromEnv Uses

func AuthOptionsFromEnv() (gophercloud.AuthOptions, error)

AuthOptionsFromEnv fills out an AuthOptions structure from the environment variables: OS_AUTH_URL, OS_USERNAME, OS_USERID, OS_PASSWORD, OS_TENANT_ID, OS_TENANT_NAME, OS_DOMAIN_ID, OS_DOMAIN_NAME, OS_TOKEN. It checks that (1) OS_AUTH_URL is set, (2) OS_USERNAME, OS_USERID, or OS_TOKEN is set, (3) OS_PASSWORD or OS_TOKEN is set.

func Authenticate Uses

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 Uses

func AuthenticateV2(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error

AuthenticateV2 explicitly authenticates against the identity v2 endpoint.

func AuthenticateV3 Uses

func AuthenticateV3(client *gophercloud.ProviderClient, options gophercloud.AuthOptions) error

AuthenticateV3 explicitly authenticates against the identity v3 service.

func AuthenticatedClient Uses

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 Uses

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 NewBlockStorageV2 Uses

func NewBlockStorageV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)

NewBlockStorageV2 creates a ServiceClient that may be used to access the v2 block storage service.

func NewCDNV1 Uses

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 Uses

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 Uses

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 Uses

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 NewIdentityAdminV2 Uses

func NewIdentityAdminV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)

func NewIdentityAdminV3 Uses

func NewIdentityAdminV3(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)

func NewIdentityV2 Uses

func NewIdentityV2(client *gophercloud.ProviderClient) *gophercloud.ServiceClient

NewIdentityV2 creates a ServiceClient that may be used to interact with the v2 identity service.

func NewIdentityV3 Uses

func NewIdentityV3(client *gophercloud.ProviderClient) *gophercloud.ServiceClient

NewIdentityV3 creates a ServiceClient that may be used to access the v3 identity service.

func NewImageServiceV2 Uses

func NewImageServiceV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)

NewImageServiceV2 creates a ServiceClient that may be used to access the v2 image service.

func NewNetworkV2 Uses

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 Uses

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 Uses

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 NewTelemetryV2 Uses

func NewTelemetryV2(client *gophercloud.ProviderClient, eo gophercloud.EndpointOpts) (*gophercloud.ServiceClient, error)

NewTelemetryV2 creates a ServiceClient that may be used to access the v2 telemetry service.

func V2EndpointURL Uses

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 Uses

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.

Directories

PathSynopsis
blockstorage/v1/apiversionsPackage apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder.
blockstorage/v1/snapshotsPackage snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
blockstorage/v1/volumesPackage volumes provides information and interaction with volumes in the OpenStack Block Storage service.
blockstorage/v1/volumes/testingThis is package created is to hold fixtures (which imports testing), so that importing volumes package does not inadvertently import testing into production code More information here: https://github.com/rackspace/gophercloud/issues/473
blockstorage/v1/volumetypesPackage volumetypes provides information and interaction with volume types in the OpenStack Block Storage service.
blockstorage/v2/extensions/volumeactionsPackage volumeactions provides information and interaction with volumes in the OpenStack Block Storage service.
blockstorage/v2/volumesPackage volumes provides information and interaction with volumes in the OpenStack Block Storage service.
cdn/v1/basePackage base provides information and interaction with the base API resource in the OpenStack CDN service.
cdn/v1/flavorsPackage flavors provides information and interaction with the flavors API resource in the OpenStack CDN service.
cdn/v1/serviceassetsPackage serviceassets provides information and interaction with the serviceassets API resource in the OpenStack CDN service.
cdn/v1/servicesPackage services provides information and interaction with the services API resource in the OpenStack CDN service.
common/extensionsPackage extensions provides information and interaction with the different extensions available for an OpenStack service.
compute/v2/extensionsPackage extensions provides information and interaction with the different extensions available for the OpenStack Compute service.
compute/v2/extensions/adminactionsPackage provides access to the "Admin Actions" of the Compute API, including migrations, live-migrations, reset-state, etc.
compute/v2/extensions/bootfromvolume
compute/v2/extensions/defsecrules
compute/v2/extensions/diskconfigPackage diskconfig provides information and interaction with the Disk Config extension that works with the OpenStack Compute service.
compute/v2/extensions/floatingipPackage floatingip provides the ability to manage floating ips through nova-network
compute/v2/extensions/keypairsPackage keypairs provides information and interaction with the Keypairs extension for the OpenStack Compute service.
compute/v2/extensions/networksPackage network provides the ability to manage nova-networks
compute/v2/extensions/quotasetsPackage quotasets provides information and interaction with QuotaSet extension for the OpenStack Compute service.
compute/v2/extensions/schedulerhintsPackage schedulerhints enables instances to provide the OpenStack scheduler hints about where they should be placed in the cloud.
compute/v2/extensions/secgroups
compute/v2/extensions/servergroupsPackage servergroups provides the ability to manage server groups
compute/v2/extensions/startstopPackage startstop provides functionality to start and stop servers that have been provisioned by the OpenStack Compute service.
compute/v2/extensions/tenantnetworksPackage tenantnetworks provides the ability for tenants to see information about the networks they have access to
compute/v2/extensions/volumeattachPackage volumeattach provides the ability to attach and detach volumes to instances
compute/v2/extensions/volumeattach/testingThis is package created is to hold fixtures (which imports testing), so that importing volumeattach package does not inadvertently import testing into production code More information here: https://github.com/rackspace/gophercloud/issues/473
compute/v2/flavorsPackage flavors provides information and interaction with the flavor API resource in the OpenStack Compute service.
compute/v2/imagesPackage images provides information and interaction with the image API resource in the OpenStack Compute service.
compute/v2/serversPackage servers provides information and interaction with the server API resource in the OpenStack Compute service.
identity/v2/extensionsPackage extensions provides information and interaction with the different extensions available for the OpenStack Identity service.
identity/v2/extensions/admin/rolesPackage roles provides functionality to interact with and control roles on the API.
identity/v2/tenantsPackage tenants provides information and interaction with the tenants API resource for the OpenStack Identity service.
identity/v2/tokensPackage tokens provides information and interaction with the token API resource for the OpenStack Identity service.
identity/v2/users
identity/v3/endpointsPackage endpoints provides information and interaction with the service endpoints API resource in the OpenStack Identity service.
identity/v3/extensionsPackage extensions provides information and interaction with the different extensions available for the OpenStack Identity v3 service.
identity/v3/extensions/trust
identity/v3/rolesPackage roles provides information and interaction with the roles API resource for the OpenStack Identity service.
identity/v3/servicesPackage services provides information and interaction with the services API resource for the OpenStack Identity service.
identity/v3/tokensPackage tokens provides information and interaction with the token API resource for the OpenStack Identity service.
imageservice/v2/images
imageservice/v2/members
networking/v2/apiversionsPackage apiversions provides information and interaction with the different API versions for the OpenStack Neutron service.
networking/v2/common
networking/v2/extensions
networking/v2/extensions/externalPackage external provides information and interaction with the external extension for the OpenStack Networking service.
networking/v2/extensions/fwaasPackage fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service.
networking/v2/extensions/fwaas/firewalls
networking/v2/extensions/fwaas/policies
networking/v2/extensions/fwaas/rules
networking/v2/extensions/layer3Package layer3 provides access to the Layer-3 networking extension for the OpenStack Neutron service.
networking/v2/extensions/layer3/floatingips
networking/v2/extensions/layer3/routers
networking/v2/extensions/lbaasPackage lbaas provides information and interaction with the Load Balancer as a Service extension for the OpenStack Networking service.
networking/v2/extensions/lbaas/members
networking/v2/extensions/lbaas/monitors
networking/v2/extensions/lbaas/pools
networking/v2/extensions/lbaas_v2Package lbaas_v2 provides information and interaction with the Load Balancer as a Service v2 extension for the OpenStack Networking service.
networking/v2/extensions/lbaas_v2/listeners
networking/v2/extensions/lbaas_v2/loadbalancers
networking/v2/extensions/lbaas_v2/monitors
networking/v2/extensions/lbaas_v2/pools
networking/v2/extensions/lbaas/vips
networking/v2/extensions/portsbindingPackage portsbinding provides information and interaction with the port binding extension for the OpenStack Networking service.
networking/v2/extensions/providerPackage provider gives access to the provider Neutron plugin, allowing network extended attributes.
networking/v2/extensions/securityPackage security contains functionality to work with security group and security group rules Neutron resources.
networking/v2/extensions/security/groups
networking/v2/extensions/security/rules
networking/v2/networksPackage networks contains functionality for working with Neutron network resources.
networking/v2/portsPackage ports contains functionality for working with Neutron port resources.
networking/v2/subnetsPackage subnets contains functionality for working with Neutron subnet resources.
objectstorage/v1/accountsPackage accounts contains functionality for working with Object Storage account resources.
objectstorage/v1/containersPackage containers contains functionality for working with Object Storage container resources.
objectstorage/v1/objectsPackage objects contains functionality for working with Object Storage object resources.
telemetry/v2/meters
utils

Package openstack imports 9 packages (graph) and is imported by 333 packages. Updated 2016-10-14. Refresh now. Tools for package owners.