gophercloud

package module
v0.0.0-...-d5be3fe Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2016 License: Apache-2.0 Imports: 13 Imported by: 0

README ¶

Gophercloud: an OpenStack SDK for Go

Build Status Coverage Status

Gophercloud is an OpenStack Go SDK.

How to install

Before installing, you need to ensure that your GOPATH environment variable is pointing to an appropriate directory where you want to install Gophercloud:

mkdir $HOME/go
export GOPATH=$HOME/go

To protect yourself against changes in your dependencies, we highly recommend choosing a dependency management solution for your projects, such as godep. Once this is set up, you can install Gophercloud as a dependency like so:

go get github.com/gophercloud/gophercloud

# Edit your code to import relevant packages from "github.com/gophercloud/gophercloud"

godep save ./...

This will install all the source files you need into a Godeps/_workspace directory, which is referenceable from your own source files when you use the godep go command.

Getting started

Credentials

Because you'll be hitting an API, you will need to retrieve your OpenStack credentials and either store them as environment variables or in your local Go files. The first method is recommended because it decouples credential information from source code, allowing you to push the latter to your version control system without any security risk.

You will need to retrieve the following:

  • username
  • password
  • a valid Keystone identity URL

For users that have the OpenStack dashboard installed, there's a shortcut. If you visit the project/access_and_security path in Horizon and click on the "Download OpenStack RC File" button at the top right hand corner, you will download a bash file that exports all of your access details to environment variables. To execute the file, run source admin-openrc.sh and you will be prompted for your password.

Authentication

Once you have access to your credentials, you can begin plugging them into Gophercloud. The next step is authentication, and this is handled by a base "Provider" struct. To get one, you can either pass in your credentials explicitly, or tell Gophercloud to use environment variables:

import (
  "github.com/gophercloud/gophercloud"
  "github.com/gophercloud/gophercloud/openstack"
  "github.com/gophercloud/gophercloud/openstack/utils"
)

// Option 1: Pass in the values yourself
opts := gophercloud.AuthOptions{
  IdentityEndpoint: "https://my-openstack.com:5000/v2.0",
  Username: "{username}",
  Password: "{password}",
}

// Option 2: Use a utility function to retrieve all your environment variables
opts, err := openstack.AuthOptionsFromEnv()

Once you have the opts variable, you can pass it in and get back a ProviderClient struct:

provider, err := openstack.AuthenticatedClient(opts)

The ProviderClient is the top-level client that all of your OpenStack services derive from. The provider contains all of the authentication details that allow your Go code to access the API - such as the base URL and token ID.

Provision a server

Once we have a base Provider, we inject it as a dependency into each OpenStack service. In order to work with the Compute API, we need a Compute service client; which can be created like so:

client, err := openstack.NewComputeV2(provider, gophercloud.EndpointOpts{
  Region: os.Getenv("OS_REGION_NAME"),
})

We then use this client for any Compute API operation we want. In our case, we want to provision a new server - so we invoke the Create method and pass in the flavor ID (hardware specification) and image ID (operating system) we're interested in:

import "github.com/gophercloud/gophercloud/openstack/compute/v2/servers"

server, err := servers.Create(client, servers.CreateOpts{
  Name:      "My new server!",
  FlavorRef: "flavor_id",
  ImageRef:  "image_id",
}).Extract()

The above code sample creates a new server with the parameters, and embodies the new resource in the server variable (a servers.Server struct).

Backwards-Compatibility Guarantees

None. Vendor it and write tests covering the parts you use.

Contributing

See the contributing guide.

Help and feedback

If you're struggling with something or have spotted a potential bug, feel free to submit an issue to our bug tracker.

Documentation ¶

Overview ¶

Package gophercloud provides a multi-vendor interface to OpenStack-compatible clouds. The library has a three-level hierarchy: providers, services, and resources.

Provider structs represent the service providers that offer and manage a collection of services. Examples of providers include: OpenStack, Rackspace, HP. These are defined like so: 

opts := gophercloud.AuthOptions{
  IdentityEndpoint: "https://my-openstack.com:5000/v2.0",
  Username: "{username}",
  Password: "{password}",
  TenantID: "{tenant_id}",
}

provider, err := openstack.AuthenticatedClient(opts)

Service structs are specific to a provider and handle all of the logic and operations for a particular OpenStack service. Examples of services include: Compute, Object Storage, Block Storage. In order to define one, you need to pass in the parent provider, like so: 

opts := gophercloud.EndpointOpts{Region: "RegionOne"}

client := openstack.NewComputeV2(provider, opts)

Resource structs are the domain models that services make use of in order to work with and represent the state of API resources: 

server, err := servers.Get(client, "{serverId}").Extract()

Intermediate Result structs are returned for API operations, which allow generic access to the HTTP headers, response body, and any errors associated with the network transaction. To turn a result into a usable resource struct, you must call the Extract method which is chained to the response, or an Extract function from an applicable extension: 

result := servers.Get(client, "{serverId}")

// Attempt to extract the disk configuration from the OS-DCF disk config
// extension:
config, err := diskconfig.ExtractGet(result)

All requests that enumerate a collection return a Pager struct that is used to iterate through the results one page at a time. Use the EachPage method on that Pager to handle each successive Page in a closure, then use the appropriate extraction method from that request's package to interpret that Page as a slice of results: 

err := servers.List(client, nil).EachPage(func (page pagination.Page) (bool, error) {
  s, err := servers.ExtractServers(page)
  if err != nil {
    return false, err
  }

  // Handle the []servers.Server slice.

  // Return "false" or an error to prematurely stop fetching new pages.
  return true, nil
})

This top-level package contains utility functions and data types that are used throughout the provider and service packages. Of particular note for end users are the AuthOptions and EndpointOpts structs.

Index ¶

Constants ¶

View Source 
const DefaultUserAgent = "gophercloud/2.0.0"

DefaultUserAgent is the default User-Agent string set in the request header.

View Source 
const RFC3339Milli = "2006-01-02T15:04:05.999999Z"

RFC3339Milli describes a common time format used by some API responses.

View Source 
const RFC3339MilliNoZ = "2006-01-02T15:04:05.999999"
View Source 
const RFC3339NoZ = "2006-01-02T15:04:05"

RFC3339NoZ is the time format used in Heat (Orchestration).

Variables ¶

This section is empty.

Functions ¶

func BuildHeaders ¶ 

func BuildHeaders(opts interface{}) (map[string]string, error)

BuildHeaders is an internal function to be used by request methods in individual resource packages.

It accepts an arbitrary tagged structure and produces a string map that's suitable for use as the HTTP headers of an outgoing request. Field names are mapped to header names based in "h" tags. 

type struct Something {
  Bar string `h:"x_bar"`
  Baz int    `h:"lorem_ipsum"`
}

instance := Something{
  Bar: "AAA",
  Baz: "BBB",
}

will be converted into: 

map[string]string{
  "x_bar": "AAA",
  "lorem_ipsum": "BBB",
}

Untagged fields and fields left at their zero values are skipped. Integers, booleans and string values are supported.

func BuildQueryString ¶ 

func BuildQueryString(opts interface{}) (*url.URL, error)

BuildQueryString is an internal function to be used by request methods in individual resource packages.

It accepts a tagged structure and expands it into a URL struct. Field names are converted into query parameters based on a "q" tag. For example: 

type struct Something {
   Bar string `q:"x_bar"`
   Baz int    `q:"lorem_ipsum"`
}

instance := Something{
   Bar: "AAA",
   Baz: "BBB",
}

will be converted into "?x_bar=AAA&lorem_ipsum=BBB".

The struct's fields may be strings, integers, or boolean values. Fields left at their type's zero value will be omitted from the query.

func BuildRequestBody ¶ 

func BuildRequestBody(opts interface{}, parent string) (map[string]interface{}, error)

BuildRequestBody builds a map[string]interface from the given `struct`. If parent is not the empty string, the final map[string]interface returned will encapsulate the built one

func ExtractNextURL ¶ 

func ExtractNextURL(links []Link) (string, error)

ExtractNextURL is an internal function useful for packages of collection resources that are paginated in a certain way.

It attempts to extract the "next" URL from slice of Link structs, or "" if no such URL is present.

func IDSliceToQueryString ¶ 

func IDSliceToQueryString(name string, ids []int) string

IDSliceToQueryString takes a slice of elements and converts them into a query string. For example, if name=foo and slice=[]int{20, 40, 60}, then the result would be `?name=20&name=40&name=60'

func IntToPointer ¶ 

func IntToPointer(i int) *int

IntToPointer is a function for converting integers into integer pointers. This is useful when passing in options to operations.

func IntWithinRange ¶ 

func IntWithinRange(val, min, max int) bool

IntWithinRange returns TRUE if an integer falls within a defined range, and FALSE if not.

func MaybeInt ¶ 

func MaybeInt(original int) *int

MaybeInt is an internal function to be used by request methods in individual resource packages.

Like MaybeString, it accepts an int that may or may not be a zero value, and returns either a pointer to its address or nil. It's intended to hint that the JSON serializer should omit its field.

func MaybeString ¶ 

func MaybeString(original string) *string

MaybeString is an internal function to be used by request methods in individual resource packages.

It takes a string that might be a zero value and returns either a pointer to its address or nil. This is useful for allowing users to conveniently omit values from an options struct by leaving them zeroed, but still pass nil to the JSON serializer so they'll be omitted from the request body.

func NormalizePathURL ¶ 

func NormalizePathURL(basePath, rawPath string) (string, error)

NormalizePathURL is used to convert rawPath to a fqdn, using basePath as a reference in the filesystem, if necessary. basePath is assumed to contain either '.' when first used, or the file:// type fqdn of the parent resource. e.g. myFavScript.yaml => file://opt/lib/myFavScript.yaml

func NormalizeURL ¶ 

func NormalizeURL(url string) string

NormalizeURL is an internal function to be used by provider clients.

It ensures that each endpoint URL has a closing `/`, as expected by ServiceClient's methods.

func WaitFor ¶ 

func WaitFor(timeout int, predicate func() (bool, error)) error

WaitFor polls a predicate function, once per second, up to a timeout limit. It usually does this to wait for a resource to transition to a certain state. Resource packages will wrap this in a more convenient function that's specific to a certain resource, but it can also be useful on its own.

Types ¶

type AuthOptions ¶ 

type AuthOptions struct {
	// IdentityEndpoint specifies the HTTP endpoint that is required to work with
	// the Identity API of the appropriate version. While it's ultimately needed by
	// all of the identity services, it will often be populated by a provider-level
	// function.
	IdentityEndpoint string `json:"-"`

	// Username is required if using Identity V2 API. Consult with your provider's
	// control panel to discover your account's username. In Identity V3, either
	// UserID or a combination of Username and DomainID or DomainName are needed.
	Username string `json:"username,omitempty"`
	UserID   string `json:"id,omitempty"`

	Password string `json:"password,omitempty"`

	// At most one of DomainID and DomainName must be provided if using Username
	// with Identity V3. Otherwise, either are optional.
	DomainID   string `json:"id,omitempty"`
	DomainName string `json:"name,omitempty"`

	// The TenantID and TenantName fields are optional for the Identity V2 API.
	// Some providers allow you to specify a TenantName instead of the TenantId.
	// Some require both. Your provider's authentication policies will determine
	// how these fields influence authentication.
	TenantID   string `json:"tenantId,omitempty"`
	TenantName string `json:"tenantName,omitempty"`

	// AllowReauth should be set to true if you grant permission for Gophercloud to
	// cache your credentials in memory, and to allow Gophercloud to attempt to
	// re-authenticate automatically if/when your token expires.  If you set it to
	// false, it will not cache these settings, but re-authentication will not be
	// possible.  This setting defaults to false.
	//
	// NOTE: The reauth function will try to re-authenticate endlessly if left unchecked.
	// The way to limit the number of attempts is to provide a custom HTTP client to the provider client
	// and provide a transport that implements the RoundTripper interface and stores the number of failed retries.
	// For an example of this, see here: https://github.com/rackspace/rack/blob/1.0.0/auth/clients.go#L311
	AllowReauth bool `json:"-"`

	// TokenID allows users to authenticate (possibly as another user) with an
	// authentication token ID.
	TokenID string `json:"-"`
}

AuthOptions stores information needed to authenticate to an OpenStack cluster. You can populate one manually, or use a provider's AuthOptionsFromEnv() function to read relevant information from the standard environment variables. Pass one to a provider's AuthenticatedClient function to authenticate and obtain a ProviderClient representing an active session on that provider.

Its fields are the union of those recognized by each identity implementation and provider.

func (AuthOptions) CanReauth ¶ 

func (opts AuthOptions) CanReauth() bool

func (AuthOptions) ToTokenV2CreateMap ¶ 

func (opts AuthOptions) ToTokenV2CreateMap() (map[string]interface{}, error)

ToTokenV2CreateMap allows AuthOptions to satisfy the AuthOptionsBuilder interface in the v2 tokens package

func (*AuthOptions) ToTokenV3CreateMap ¶ 

func (opts *AuthOptions) ToTokenV3CreateMap(scope map[string]interface{}) (map[string]interface{}, error)

func (*AuthOptions) ToTokenV3ScopeMap ¶ 

func (opts *AuthOptions) ToTokenV3ScopeMap() (map[string]interface{}, error)

type Availability ¶ 

type Availability string

Availability indicates to whom a specific service endpoint is accessible: the internet at large, internal networks only, or only to administrators. Different identity services use different terminology for these. Identity v2 lists them as different kinds of URLs within the service catalog ("adminURL", "internalURL", and "publicURL"), while v3 lists them as "Interfaces" in an endpoint's response. 

const (
	// AvailabilityAdmin indicates that an endpoint is only available to
	// administrators.
	AvailabilityAdmin Availability = "admin"

	// AvailabilityPublic indicates that an endpoint is available to everyone on
	// the internet.
	AvailabilityPublic Availability = "public"

	// AvailabilityInternal indicates that an endpoint is only available within
	// the cluster's internal network.
	AvailabilityInternal Availability = "internal"
)

type BaseError ¶ 

type BaseError struct {
	DefaultErrString string
	Info             string
}

BaseError is an error type that all other error types embed.

func (BaseError) Error ¶ 

func (e BaseError) Error() string

type EnabledState ¶ 

type EnabledState *bool

EnabledState is a convenience type, mostly used in Create and Update operations. Because the zero value of a bool is FALSE, we need to use a pointer instead to indicate zero-ness. 

var (
	Enabled  EnabledState = &iTrue
	Disabled EnabledState = &iFalse
)

Convenience vars for EnabledState values.

type EndpointLocator ¶ 

type EndpointLocator func(EndpointOpts) (string, error)

EndpointLocator is an internal function to be used by provider implementations.

It provides an implementation that locates a single endpoint from a service catalog for a specific ProviderClient based on user-provided EndpointOpts. The provider then uses it to discover related ServiceClients.

type EndpointOpts ¶ 

type EndpointOpts struct {
	// Type [required] is the service type for the client (e.g., "compute",
	// "object-store"). Generally, this will be supplied by the service client
	// function, but a user-given value will be honored if provided.
	Type string

	// Name [optional] is the service name for the client (e.g., "nova") as it
	// appears in the service catalog. Services can have the same Type but a
	// different Name, which is why both Type and Name are sometimes needed.
	Name string

	// Region [required] is the geographic region in which the endpoint resides,
	// generally specifying which datacenter should house your resources.
	// Required only for services that span multiple regions.
	Region string

	// Availability [optional] is the visibility of the endpoint to be returned.
	// Valid types include the constants AvailabilityPublic, AvailabilityInternal,
	// or AvailabilityAdmin from this package.
	//
	// Availability is not required, and defaults to AvailabilityPublic. Not all
	// providers or services offer all Availability options.
	Availability Availability
}

EndpointOpts specifies search criteria used by queries against an OpenStack service catalog. The options must contain enough information to unambiguously identify one, and only one, endpoint within the catalog.

Usually, these are passed to service client factory functions in a provider package, like "rackspace.NewComputeV2()".

func (*EndpointOpts) ApplyDefaults ¶ 

func (eo *EndpointOpts) ApplyDefaults(t string)

ApplyDefaults is an internal method to be used by provider implementations.

It sets EndpointOpts fields if not already set, including a default type. Currently, EndpointOpts.Availability defaults to the public endpoint.

type Err400er ¶ 

type Err400er interface {
	Error400(ErrUnexpectedResponseCode) error
}

Err400er is the interface resource error types implement to override the error message from a 400 error.

type Err401er ¶ 

type Err401er interface {
	Error401(ErrUnexpectedResponseCode) error
}

Err401er is the interface resource error types implement to override the error message from a 401 error.

type Err404er ¶ 

type Err404er interface {
	Error404(ErrUnexpectedResponseCode) error
}

Err404er is the interface resource error types implement to override the error message from a 404 error.

type Err405er ¶ 

type Err405er interface {
	Error405(ErrUnexpectedResponseCode) error
}

Err405er is the interface resource error types implement to override the error message from a 405 error.

type Err408er ¶ 

type Err408er interface {
	Error408(ErrUnexpectedResponseCode) error
}

Err408er is the interface resource error types implement to override the error message from a 408 error.

type Err429er ¶ 

type Err429er interface {
	Error429(ErrUnexpectedResponseCode) error
}

Err429er is the interface resource error types implement to override the error message from a 429 error.

type Err500er ¶ 

type Err500er interface {
	Error500(ErrUnexpectedResponseCode) error
}

Err500er is the interface resource error types implement to override the error message from a 500 error.

type Err503er ¶ 

type Err503er interface {
	Error503(ErrUnexpectedResponseCode) error
}

Err503er is the interface resource error types implement to override the error message from a 503 error.

type ErrAPIKeyProvided ¶ 

type ErrAPIKeyProvided struct{ BaseError }

ErrAPIKeyProvided indicates that an APIKey was provided but can't be used.

func (ErrAPIKeyProvided) Error ¶ 

func (e ErrAPIKeyProvided) Error() string

type ErrDefault400 ¶ 

type ErrDefault400 struct {
	ErrUnexpectedResponseCode
}

ErrDefault400 is the default error type returned on a 400 HTTP response code.

func (ErrDefault400) Error ¶ 

func (e ErrDefault400) Error() string

type ErrDefault401 ¶ 

type ErrDefault401 struct {
	ErrUnexpectedResponseCode
}

ErrDefault401 is the default error type returned on a 401 HTTP response code.

func (ErrDefault401) Error ¶ 

func (e ErrDefault401) Error() string

type ErrDefault404 ¶ 

type ErrDefault404 struct {
	ErrUnexpectedResponseCode
}

ErrDefault404 is the default error type returned on a 404 HTTP response code.

func (ErrDefault404) Error ¶ 

func (e ErrDefault404) Error() string

type ErrDefault405 ¶ 

type ErrDefault405 struct {
	ErrUnexpectedResponseCode
}

ErrDefault405 is the default error type returned on a 405 HTTP response code.

func (ErrDefault405) Error ¶ 

func (e ErrDefault405) Error() string

type ErrDefault408 ¶ 

type ErrDefault408 struct {
	ErrUnexpectedResponseCode
}

ErrDefault408 is the default error type returned on a 408 HTTP response code.

func (ErrDefault408) Error ¶ 

func (e ErrDefault408) Error() string

type ErrDefault429 ¶ 

type ErrDefault429 struct {
	ErrUnexpectedResponseCode
}

ErrDefault429 is the default error type returned on a 429 HTTP response code.

func (ErrDefault429) Error ¶ 

func (e ErrDefault429) Error() string

type ErrDefault500 ¶ 

type ErrDefault500 struct {
	ErrUnexpectedResponseCode
}

ErrDefault500 is the default error type returned on a 500 HTTP response code.

func (ErrDefault500) Error ¶ 

func (e ErrDefault500) Error() string

type ErrDefault503 ¶ 

type ErrDefault503 struct {
	ErrUnexpectedResponseCode
}

ErrDefault503 is the default error type returned on a 503 HTTP response code.

func (ErrDefault503) Error ¶ 

func (e ErrDefault503) Error() string

type ErrDomainIDOrDomainName ¶ 

type ErrDomainIDOrDomainName struct{ BaseError }

ErrDomainIDOrDomainName indicates that a username was provided, but no domain to scope it. It may also indicate that both a DomainID and a DomainName were provided at once.

func (ErrDomainIDOrDomainName) Error ¶ 

func (e ErrDomainIDOrDomainName) Error() string

type ErrDomainIDWithToken ¶ 

type ErrDomainIDWithToken struct{ BaseError }

ErrDomainIDWithToken indicates that a DomainID was provided, but token authentication is being used instead.

func (ErrDomainIDWithToken) Error ¶ 

func (e ErrDomainIDWithToken) Error() string

type ErrDomainIDWithUserID ¶ 

type ErrDomainIDWithUserID struct{ BaseError }

ErrDomainIDWithUserID indicates that a DomainID was provided, but unnecessary because a UserID is being used.

func (ErrDomainIDWithUserID) Error ¶ 

func (e ErrDomainIDWithUserID) Error() string

type ErrDomainNameWithToken ¶ 

type ErrDomainNameWithToken struct{ BaseError }

ErrDomainNameWithToken indicates that a DomainName was provided, but token authentication is being used instead.s

func (ErrDomainNameWithToken) Error ¶ 

func (e ErrDomainNameWithToken) Error() string

type ErrDomainNameWithUserID ¶ 

type ErrDomainNameWithUserID struct{ BaseError }

ErrDomainNameWithUserID indicates that a DomainName was provided, but unnecessary because a UserID is being used.

func (ErrDomainNameWithUserID) Error ¶ 

func (e ErrDomainNameWithUserID) Error() string

type ErrEndpointNotFound ¶ 

type ErrEndpointNotFound struct {
	BaseError
}

ErrEndpointNotFound is returned when no available endpoints match the provided EndpointOpts. This is also generally returned by provider service factory methods, and usually indicates that a region was specified incorrectly.

func (ErrEndpointNotFound) Error ¶ 

func (e ErrEndpointNotFound) Error() string

type ErrErrorAfterReauthentication ¶ 

type ErrErrorAfterReauthentication struct {
	BaseError
	ErrOriginal error
}

ErrErrorAfterReauthentication is the error type returned when reauthentication succeeds, but an error occurs afterword (usually an HTTP error).

func (ErrErrorAfterReauthentication) Error ¶ 

func (e ErrErrorAfterReauthentication) Error() string

type ErrInvalidInput ¶ 

type ErrInvalidInput struct {
	ErrMissingInput
	Value interface{}
}

ErrInvalidInput is an error type used for most non-HTTP Gophercloud errors.

func (ErrInvalidInput) Error ¶ 

func (e ErrInvalidInput) Error() string

type ErrMissingInput ¶ 

type ErrMissingInput struct {
	BaseError
	Argument string
}

ErrMissingInput is the error when input is required in a particular situation but not provided by the user

func (ErrMissingInput) Error ¶ 

func (e ErrMissingInput) Error() string

type ErrMissingPassword ¶ 

type ErrMissingPassword struct{ BaseError }

ErrMissingPassword indicates that no password was provided and no token is available.

func (ErrMissingPassword) Error ¶ 

func (e ErrMissingPassword) Error() string

type ErrMultipleResourcesFound ¶ 

type ErrMultipleResourcesFound struct {
	BaseError
	Name         string
	Count        int
	ResourceType string
}

ErrMultipleResourcesFound is the error when trying to retrieve a resource's ID by name and multiple resources have the user-provided name.

func (ErrMultipleResourcesFound) Error ¶ 

func (e ErrMultipleResourcesFound) Error() string

type ErrResourceNotFound ¶ 

type ErrResourceNotFound struct {
	BaseError
	Name         string
	ResourceType string
}

ErrResourceNotFound is the error when trying to retrieve a resource's ID by name and the resource doesn't exist.

func (ErrResourceNotFound) Error ¶ 

func (e ErrResourceNotFound) Error() string

type ErrResult ¶ 

type ErrResult struct {
	Result
}

ErrResult is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.

It represents results that only contain a potential error and nothing else. Usually, if the operation executed successfully, the Err field will be nil; otherwise it will be stocked with a relevant error. Use the ExtractErr method to cleanly pull it out.

func (ErrResult) ExtractErr ¶ 

func (r ErrResult) ExtractErr() error

ExtractErr is a function that extracts error information, or nil, from a result.

type ErrScopeDomainIDOrDomainName ¶ 

type ErrScopeDomainIDOrDomainName struct{ BaseError }

ErrScopeDomainIDOrDomainName indicates that a domain ID or Name was required in a Scope, but not present.

func (ErrScopeDomainIDOrDomainName) Error ¶ 

func (e ErrScopeDomainIDOrDomainName) Error() string

type ErrScopeDomainName ¶ 

type ErrScopeDomainName struct{ BaseError }

ErrScopeDomainName indicates that a DomainName was provided alone in a Scope.

func (ErrScopeDomainName) Error ¶ 

func (e ErrScopeDomainName) Error() string

type ErrScopeEmpty ¶ 

type ErrScopeEmpty struct{ BaseError }

ErrScopeEmpty indicates that no credentials were provided in a Scope.

func (ErrScopeEmpty) Error ¶ 

func (e ErrScopeEmpty) Error() string

type ErrScopeProjectIDAlone ¶ 

type ErrScopeProjectIDAlone struct{ BaseError }

ErrScopeProjectIDAlone indicates that a ProjectID was provided with other constraints in a Scope.

func (ErrScopeProjectIDAlone) Error ¶ 

func (e ErrScopeProjectIDAlone) Error() string

type ErrScopeProjectIDOrProjectName ¶ 

type ErrScopeProjectIDOrProjectName struct{ BaseError }

ErrScopeProjectIDOrProjectName indicates that both a ProjectID and a ProjectName were provided in a Scope.

func (ErrScopeProjectIDOrProjectName) Error ¶ 

func (e ErrScopeProjectIDOrProjectName) Error() string

type ErrServiceNotFound ¶ 

type ErrServiceNotFound struct {
	BaseError
}

ErrServiceNotFound is returned when no service in a service catalog matches the provided EndpointOpts. This is generally returned by provider service factory methods like "NewComputeV2()" and can mean that a service is not enabled for your account.

func (ErrServiceNotFound) Error ¶ 

func (e ErrServiceNotFound) Error() string

type ErrTenantIDProvided ¶ 

type ErrTenantIDProvided struct{ BaseError }

ErrTenantIDProvided indicates that a TenantID was provided but can't be used.

func (ErrTenantIDProvided) Error ¶ 

func (e ErrTenantIDProvided) Error() string

type ErrTenantNameProvided ¶ 

type ErrTenantNameProvided struct{ BaseError }

ErrTenantNameProvided indicates that a TenantName was provided but can't be used.

func (ErrTenantNameProvided) Error ¶ 

func (e ErrTenantNameProvided) Error() string

type ErrTimeOut ¶ 

type ErrTimeOut struct {
	BaseError
}

ErrTimeOut is the error type returned when an operations times out.

func (ErrTimeOut) Error ¶ 

func (e ErrTimeOut) Error() string

type ErrUnableToReauthenticate ¶ 

type ErrUnableToReauthenticate struct {
	BaseError
	ErrOriginal error
}

ErrUnableToReauthenticate is the error type returned when reauthentication fails.

func (ErrUnableToReauthenticate) Error ¶ 

func (e ErrUnableToReauthenticate) Error() string

type ErrUnexpectedResponseCode ¶ 

type ErrUnexpectedResponseCode struct {
	BaseError
	URL      string
	Method   string
	Expected []int
	Actual   int
	Body     []byte
}

ErrUnexpectedResponseCode is returned by the Request method when a response code other than those listed in OkCodes is encountered.

func (ErrUnexpectedResponseCode) Error ¶ 

func (e ErrUnexpectedResponseCode) Error() string

type ErrUnexpectedType ¶ 

type ErrUnexpectedType struct {
	BaseError
	Expected string
	Actual   string
}

ErrUnexpectedType is the error when an unexpected type is encountered

func (ErrUnexpectedType) Error ¶ 

func (e ErrUnexpectedType) Error() string

type ErrUserIDWithToken ¶ 

type ErrUserIDWithToken struct{ BaseError }

ErrUserIDWithToken indicates that a UserID was provided, but token authentication is being used instead.

func (ErrUserIDWithToken) Error ¶ 

func (e ErrUserIDWithToken) Error() string

type ErrUsernameOrUserID ¶ 

type ErrUsernameOrUserID struct{ BaseError }

ErrUsernameOrUserID indicates that neither username nor userID are specified, or both are at once.

func (ErrUsernameOrUserID) Error ¶ 

func (e ErrUsernameOrUserID) Error() string

type ErrUsernameWithToken ¶ 

type ErrUsernameWithToken struct{ BaseError }

ErrUsernameWithToken indicates that a Username was provided, but token authentication is being used instead.

func (ErrUsernameWithToken) Error ¶ 

func (e ErrUsernameWithToken) Error() string

type HeaderResult ¶ 

type HeaderResult struct {
	Result
}

HeaderResult is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.

It represents a result that only contains an error (possibly nil) and an http.Header. This is used, for example, by the objectstorage packages in openstack, because most of the operations don't return response bodies, but do have relevant information in headers.

func (HeaderResult) ExtractInto ¶ 

func (r HeaderResult) ExtractInto(to interface{}) error

ExtractHeader will return the http.Header and error from the HeaderResult. 

header, err := objects.Create(client, "my_container", objects.CreateOpts{}).ExtractHeader()

type IPVersion ¶ 

type IPVersion int

IPVersion is a type for the possible IP address versions. Valid instances are IPv4 and IPv6 

const (
	// IPv4 is used for IP version 4 addresses
	IPv4 IPVersion = 4
	// IPv6 is used for IP version 6 addresses
	IPv6 IPVersion = 6
)

type JSONRFC1123 ¶ 

type JSONRFC1123 time.Time

func (*JSONRFC1123) UnmarshalJSON ¶ 

func (jt *JSONRFC1123) UnmarshalJSON(data []byte) error

type JSONRFC3339Milli ¶ 

type JSONRFC3339Milli time.Time

func (*JSONRFC3339Milli) UnmarshalJSON ¶ 

func (jt *JSONRFC3339Milli) UnmarshalJSON(data []byte) error

type JSONRFC3339MilliNoZ ¶ 

type JSONRFC3339MilliNoZ time.Time

func (*JSONRFC3339MilliNoZ) UnmarshalJSON ¶ 

func (jt *JSONRFC3339MilliNoZ) UnmarshalJSON(data []byte) error

type JSONRFC3339NoZ ¶ 

type JSONRFC3339NoZ time.Time

func (*JSONRFC3339NoZ) UnmarshalJSON ¶ 

func (jt *JSONRFC3339NoZ) UnmarshalJSON(data []byte) error

type JSONUnix ¶ 

type JSONUnix time.Time

func (*JSONUnix) UnmarshalJSON ¶ 

func (jt *JSONUnix) UnmarshalJSON(data []byte) error
type Link struct {
	Href string `json:"href"`
	Rel  string `json:"rel"`
}

Link is an internal type to be used in packages of collection resources that are paginated in a certain way.

It's a response substructure common to many paginated collection results that is used to point to related pages. Usually, the one we care about is the one with Rel field set to "next".

type ProviderClient ¶ 

type ProviderClient struct {
	// IdentityBase is the base URL used for a particular provider's identity
	// service - it will be used when issuing authenticatation requests. It
	// should point to the root resource of the identity service, not a specific
	// identity version.
	IdentityBase string

	// IdentityEndpoint is the identity endpoint. This may be a specific version
	// of the identity service. If this is the case, this endpoint is used rather
	// than querying versions first.
	IdentityEndpoint string

	// TokenID is the ID of the most recently issued valid token.
	TokenID string

	// EndpointLocator describes how this provider discovers the endpoints for
	// its constituent services.
	EndpointLocator EndpointLocator

	// HTTPClient allows users to interject arbitrary http, https, or other transit behaviors.
	HTTPClient http.Client

	// UserAgent represents the User-Agent header in the HTTP request.
	UserAgent UserAgent

	// ReauthFunc is the function used to re-authenticate the user if the request
	// fails with a 401 HTTP response code. This a needed because there may be multiple
	// authentication functions for different Identity service versions.
	ReauthFunc func() error

	Debug bool
}

ProviderClient stores details that are required to interact with any services within a specific provider's API.

Generally, you acquire a ProviderClient by calling the NewClient method in the appropriate provider's child package, providing whatever authentication credentials are required.

func (*ProviderClient) AuthenticatedHeaders ¶ 

func (client *ProviderClient) AuthenticatedHeaders() map[string]string

AuthenticatedHeaders returns a map of HTTP headers that are common for all authenticated service requests.

func (*ProviderClient) Request ¶ 

func (client *ProviderClient) Request(method, url string, options *RequestOpts) (*http.Response, error)

Request performs an HTTP request using the ProviderClient's current HTTPClient. An authentication header will automatically be provided.

type RequestOpts ¶ 

type RequestOpts struct {
	// JSONBody, if provided, will be encoded as JSON and used as the body of the HTTP request. The
	// content type of the request will default to "application/json" unless overridden by MoreHeaders.
	// It's an error to specify both a JSONBody and a RawBody.
	JSONBody interface{}
	// RawBody contains an io.Reader that will be consumed by the request directly. No content-type
	// will be set unless one is provided explicitly by MoreHeaders.
	RawBody io.Reader
	// JSONResponse, if provided, will be populated with the contents of the response body parsed as
	// JSON.
	JSONResponse interface{}
	// OkCodes contains a list of numeric HTTP status codes that should be interpreted as success. If
	// the response has a different code, an error will be returned.
	OkCodes []int
	// MoreHeaders specifies additional HTTP headers to be provide on the request. If a header is
	// provided with a blank value (""), that header will be *omitted* instead: use this to suppress
	// the default Accept header or an inferred Content-Type, for example.
	MoreHeaders map[string]string
	// ErrorContext specifies the resource error type to return if an error is encountered.
	// This lets resources override default error messages based on the response status code.
	ErrorContext error
}

RequestOpts customizes the behavior of the provider.Request() method.

type Result ¶ 

type Result struct {
	// Body is the payload of the HTTP response from the server. In most cases,
	// this will be the deserialized JSON structure.
	Body interface{}

	// Header contains the HTTP header structure from the original response.
	Header http.Header

	// Err is an error that occurred during the operation. It's deferred until
	// extraction to make it easier to chain the Extract call.
	Err error
}

Result is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.

It acts as a base struct that other Result types, returned from request functions, can embed for convenience. All Results capture basic information from the HTTP transaction that was performed, including the response body, HTTP headers, and any errors that happened.

Generally, each Result type will have an Extract method that can be used to further interpret the result's payload in a specific context. Extensions or providers can then provide additional extraction functions to pull out provider- or extension-specific information as well.

func (Result) ExtractInto ¶ 

func (r Result) ExtractInto(to interface{}) error

ExtractInto allows users to provide an object into which `Extract` will extract the `Result.Body`. This would be useful for OpenStack providers that have different fields in the response object than OpenStack proper.

func (Result) PrettyPrintJSON ¶ 

func (r Result) PrettyPrintJSON() string

PrettyPrintJSON creates a string containing the full response body as pretty-printed JSON. It's useful for capturing test fixtures and for debugging extraction bugs. If you include its output in an issue related to a buggy extraction function, we will all love you forever.

type ServiceClient ¶ 

type ServiceClient struct {
	// ProviderClient is a reference to the provider that implements this service.
	*ProviderClient

	// Endpoint is the base URL of the service's API, acquired from a service catalog.
	// It MUST end with a /.
	Endpoint string

	// ResourceBase is the base URL shared by the resources within a service's API. It should include
	// the API version and, like Endpoint, MUST end with a / if set. If not set, the Endpoint is used
	// as-is, instead.
	ResourceBase string

	Microversion string
}

ServiceClient stores details required to interact with a specific service API implemented by a provider. Generally, you'll acquire these by calling the appropriate `New` method on a ProviderClient.

func (*ServiceClient) Delete ¶ 

func (client *ServiceClient) Delete(url string, opts *RequestOpts) (*http.Response, error)

Delete calls `Request` with the "DELETE" HTTP verb.

func (*ServiceClient) Get ¶ 

func (client *ServiceClient) Get(url string, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Get calls `Request` with the "GET" HTTP verb.

func (*ServiceClient) Patch ¶ 

func (client *ServiceClient) Patch(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Patch calls `Request` with the "PATCH" HTTP verb.

func (*ServiceClient) Post ¶ 

func (client *ServiceClient) Post(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Post calls `Request` with the "POST" HTTP verb.

func (*ServiceClient) Put ¶ 

func (client *ServiceClient) Put(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Put calls `Request` with the "PUT" HTTP verb.

func (*ServiceClient) ResourceBaseURL ¶ 

func (client *ServiceClient) ResourceBaseURL() string

ResourceBaseURL returns the base URL of any resources used by this service. It MUST end with a /.

func (*ServiceClient) ServiceURL ¶ 

func (client *ServiceClient) ServiceURL(parts ...string) string

ServiceURL constructs a URL for a resource belonging to this provider.

type UserAgent ¶ 

type UserAgent struct {
	// contains filtered or unexported fields
}

UserAgent represents a User-Agent header.

func (*UserAgent) Join ¶ 

func (ua *UserAgent) Join() string

Join concatenates all the user-defined User-Agend strings with the default Gophercloud User-Agent string.

func (*UserAgent) Prepend ¶ 

func (ua *UserAgent) Prepend(s ...string)

Prepend prepends a user-defined string to the default User-Agent string. Users may pass in one or more strings to prepend.

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
acceptance
clients
Package clients contains functions for creating OpenStack service clients for use in acceptance tests.
 Package clients contains functions for creating OpenStack service clients for use in acceptance tests.
openstack
Package openstack contains common functions that can be used across all OpenStack components for acceptance testing.
 Package openstack contains common functions that can be used across all OpenStack components for acceptance testing.
openstack/blockstorage/v1
Package v1 contains common functions for creating block storage based resources for use in acceptance tests.
 Package v1 contains common functions for creating block storage based resources for use in acceptance tests.
openstack/blockstorage/v2
Package v2 contains common functions for creating block storage based resources for use in acceptance tests.
 Package v2 contains common functions for creating block storage based resources for use in acceptance tests.
openstack/blockstorage/v2/extensions
Package extensions contains common functions for creating block storage resources that are extensions of the block storage API.
 Package extensions contains common functions for creating block storage resources that are extensions of the block storage API.
openstack/compute/v2
Package v2 contains common functions for creating compute-based resources for use in acceptance tests.
 Package v2 contains common functions for creating compute-based resources for use in acceptance tests.
openstack/db/v1
openstack/identity/v2
Package v2 contains common functions for creating identity-based resources for use in acceptance tests.
 Package v2 contains common functions for creating identity-based resources for use in acceptance tests.
openstack/identity/v3
openstack/networking/v2
openstack/networking/v2/extensions
openstack/networking/v2/extensions/fwaas
openstack/networking/v2/extensions/lbaas
openstack/networking/v2/extensions/lbaas_v2
openstack/networking/v2/extensions/portsbinding
openstack/objectstorage/v1
openstack/orchestration/v1
tools
blockstorage/v1/apiversions
Package apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder.
 Package apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder.
blockstorage/v1/apiversions/testing
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.
blockstorage/v1/snapshots/testing
blockstorage/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.
blockstorage/v1/volumes/testing
This 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
 This 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/volumetypes
Package volumetypes provides information and interaction with volume types in the OpenStack Block Storage service.
 Package volumetypes provides information and interaction with volume types in the OpenStack Block Storage service.
blockstorage/v1/volumetypes/testing
blockstorage/v2/extensions/volumeactions
Package volumeactions provides information and interaction with volumes in the OpenStack Block Storage service.
 Package volumeactions provides information and interaction with volumes in the OpenStack Block Storage service.
blockstorage/v2/extensions/volumeactions/testing
blockstorage/v2/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.
blockstorage/v2/volumes/testing
cdn/v1/base
Package base provides information and interaction with the base API resource in the OpenStack CDN service.
 Package base provides information and interaction with the base API resource in the OpenStack CDN service.
cdn/v1/base/testing
cdn/v1/flavors
Package flavors provides information and interaction with the flavors API resource in the OpenStack CDN service.
 Package flavors provides information and interaction with the flavors API resource in the OpenStack CDN service.
cdn/v1/flavors/testing
cdn/v1/serviceassets
Package serviceassets provides information and interaction with the serviceassets API resource in the OpenStack CDN service.
 Package serviceassets provides information and interaction with the serviceassets API resource in the OpenStack CDN service.
cdn/v1/serviceassets/testing
cdn/v1/services
Package services provides information and interaction with the services API resource in the OpenStack CDN service.
 Package services provides information and interaction with the services API resource in the OpenStack CDN service.
cdn/v1/services/testing
common/extensions
Package extensions provides information and interaction with the different extensions available for an OpenStack service.
 Package extensions provides information and interaction with the different extensions available for an OpenStack service.
common/extensions/testing
compute/v2/extensions
Package extensions provides information and interaction with the different extensions available for the OpenStack Compute service.
 Package extensions provides information and interaction with the different extensions available for the OpenStack Compute service.
compute/v2/extensions/bootfromvolume
compute/v2/extensions/bootfromvolume/testing
compute/v2/extensions/defsecrules
compute/v2/extensions/defsecrules/testing
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.
compute/v2/extensions/diskconfig/testing
compute/v2/extensions/floatingips
Package floatingips provides the ability to manage floating ips through nova-network
 Package floatingips provides the ability to manage floating ips through nova-network
compute/v2/extensions/floatingips/testing
compute/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.
compute/v2/extensions/keypairs/testing
compute/v2/extensions/networks
Package network provides the ability to manage nova-networks
 Package network provides the ability to manage nova-networks
compute/v2/extensions/networks/testing
compute/v2/extensions/quotasets
Package quotasets provides information and interaction with QuotaSet extension for the OpenStack Compute service.
 Package quotasets provides information and interaction with QuotaSet extension for the OpenStack Compute service.
compute/v2/extensions/quotasets/testing
compute/v2/extensions/schedulerhints
Package schedulerhints enables instances to provide the OpenStack scheduler hints about where they should be placed in the cloud.
 Package schedulerhints enables instances to provide the OpenStack scheduler hints about where they should be placed in the cloud.
compute/v2/extensions/schedulerhints/testing
compute/v2/extensions/secgroups
compute/v2/extensions/secgroups/testing
compute/v2/extensions/servergroups
Package servergroups provides the ability to manage server groups
 Package servergroups provides the ability to manage server groups
compute/v2/extensions/servergroups/testing
compute/v2/extensions/startstop
Package startstop provides functionality to start and stop servers that have been provisioned by the OpenStack Compute service.
 Package startstop provides functionality to start and stop servers that have been provisioned by the OpenStack Compute service.
compute/v2/extensions/startstop/testing
compute/v2/extensions/tenantnetworks
Package tenantnetworks provides the ability for tenants to see information about the networks they have access to
 Package tenantnetworks provides the ability for tenants to see information about the networks they have access to
compute/v2/extensions/tenantnetworks/testing
compute/v2/extensions/testing
compute/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
compute/v2/extensions/volumeattach/testing
Package testing holds fixtures (which imports testing), so that importing volumeattach package does not inadvertently import testing into production code More information here: https://github.com/gophercloud/gophercloud/issues/473
 Package testing holds fixtures (which imports testing), so that importing volumeattach package does not inadvertently import testing into production code More information here: https://github.com/gophercloud/gophercloud/issues/473
compute/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.
compute/v2/flavors/testing
compute/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.
compute/v2/images/testing
compute/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.
compute/v2/servers/testing
db/v1/configurations
Package configurations provides information and interaction with the configuration API resource in the Rackspace Database service.
 Package configurations provides information and interaction with the configuration API resource in the Rackspace Database service.
db/v1/configurations/testing
db/v1/databases
Package flavors provides information and interaction with the database API resource in the OpenStack Database service.
 Package flavors provides information and interaction with the database API resource in the OpenStack Database service.
db/v1/databases/testing
db/v1/datastores
Package datastores provides information and interaction with the datastore API resource in the Rackspace Database service.
 Package datastores provides information and interaction with the datastore API resource in the Rackspace Database service.
db/v1/datastores/testing
db/v1/flavors
Package flavors provides information and interaction with the flavor API resource in the OpenStack Database service.
 Package flavors provides information and interaction with the flavor API resource in the OpenStack Database service.
db/v1/flavors/testing
db/v1/instances
Package instances provides information and interaction with the instance API resource in the OpenStack Database service.
 Package instances provides information and interaction with the instance API resource in the OpenStack Database service.
db/v1/instances/testing
db/v1/users
Package users provides information and interaction with the user API resource in the OpenStack Database service.
 Package users provides information and interaction with the user API resource in the OpenStack Database service.
db/v1/users/testing
identity/v2/extensions
Package extensions provides information and interaction with the different extensions available for the OpenStack Identity service.
 Package extensions provides information and interaction with the different extensions available for the OpenStack Identity service.
identity/v2/extensions/admin/roles
Package roles provides functionality to interact with and control roles on the API.
 Package roles provides functionality to interact with and control roles on the API.
identity/v2/extensions/admin/roles/testing
identity/v2/extensions/testing
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.
identity/v2/tenants/testing
identity/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.
identity/v2/tokens/testing
identity/v2/users
identity/v2/users/testing
identity/v3/endpoints
Package endpoints provides information and interaction with the service endpoints API resource in the OpenStack Identity service.
 Package endpoints provides information and interaction with the service endpoints API resource in the OpenStack Identity service.
identity/v3/endpoints/testing
identity/v3/extensions/trusts
identity/v3/extensions/trusts/testing
identity/v3/roles
Package roles provides information and interaction with the roles API resource for the OpenStack Identity service.
 Package roles provides information and interaction with the roles API resource for the OpenStack Identity service.
identity/v3/roles/testing
identity/v3/services
Package services provides information and interaction with the services API resource for the OpenStack Identity service.
 Package services provides information and interaction with the services API resource for the OpenStack Identity service.
identity/v3/services/testing
identity/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.
identity/v3/tokens/testing
networking/v2/apiversions
Package apiversions provides information and interaction with the different API versions for the OpenStack Neutron service.
 Package apiversions provides information and interaction with the different API versions for the OpenStack Neutron service.
networking/v2/apiversions/testing
networking/v2/common
networking/v2/extensions
networking/v2/extensions/external
Package external provides information and interaction with the external extension for the OpenStack Networking service.
 Package external provides information and interaction with the external extension for the OpenStack Networking service.
networking/v2/extensions/external/testing
networking/v2/extensions/fwaas
Package fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service.
 Package 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/firewalls/testing
networking/v2/extensions/fwaas/policies
networking/v2/extensions/fwaas/policies/testing
networking/v2/extensions/fwaas/rules
networking/v2/extensions/fwaas/rules/testing
networking/v2/extensions/layer3
Package layer3 provides access to the Layer-3 networking extension for the OpenStack Neutron service.
 Package layer3 provides access to the Layer-3 networking extension for the OpenStack Neutron service.
networking/v2/extensions/layer3/floatingips
networking/v2/extensions/layer3/floatingips/testing
networking/v2/extensions/layer3/routers
networking/v2/extensions/layer3/routers/testing
networking/v2/extensions/lbaas
Package lbaas provides information and interaction with the Load Balancer as a Service extension for the OpenStack Networking service.
 Package 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/members/testing
networking/v2/extensions/lbaas/monitors
networking/v2/extensions/lbaas/monitors/testing
networking/v2/extensions/lbaas/pools
networking/v2/extensions/lbaas/pools/testing
networking/v2/extensions/lbaas/vips
networking/v2/extensions/lbaas/vips/testing
networking/v2/extensions/lbaas_v2
Package lbaas_v2 provides information and interaction with the Load Balancer as a Service v2 extension for the OpenStack Networking service.
 Package 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/listeners/testing
networking/v2/extensions/lbaas_v2/loadbalancers
networking/v2/extensions/lbaas_v2/loadbalancers/testing
networking/v2/extensions/lbaas_v2/monitors
networking/v2/extensions/lbaas_v2/monitors/testing
networking/v2/extensions/lbaas_v2/pools
networking/v2/extensions/lbaas_v2/pools/testing
networking/v2/extensions/portsbinding
Package portsbinding provides information and interaction with the port binding extension for the OpenStack Networking service.
 Package portsbinding provides information and interaction with the port binding extension for the OpenStack Networking service.
networking/v2/extensions/portsbinding/testing
networking/v2/extensions/provider
Package provider gives access to the provider Neutron plugin, allowing network extended attributes.
 Package provider gives access to the provider Neutron plugin, allowing network extended attributes.
networking/v2/extensions/provider/testing
networking/v2/extensions/security
Package security contains functionality to work with security group and security group rules Neutron resources.
 Package security contains functionality to work with security group and security group rules Neutron resources.
networking/v2/extensions/security/groups
networking/v2/extensions/security/groups/testing
networking/v2/extensions/security/rules
networking/v2/extensions/security/rules/testing
networking/v2/extensions/testing
networking/v2/networks
Package networks contains functionality for working with Neutron network resources.
 Package networks contains functionality for working with Neutron network resources.
networking/v2/networks/testing
networking/v2/ports
Package ports contains functionality for working with Neutron port resources.
 Package ports contains functionality for working with Neutron port resources.
networking/v2/ports/testing
networking/v2/subnets
Package subnets contains functionality for working with Neutron subnet resources.
 Package subnets contains functionality for working with Neutron subnet resources.
networking/v2/subnets/testing
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.
objectstorage/v1/accounts/testing
objectstorage/v1/containers
Package containers contains functionality for working with Object Storage container resources.
 Package containers contains functionality for working with Object Storage container resources.
objectstorage/v1/containers/testing
objectstorage/v1/objects
Package objects contains functionality for working with Object Storage object resources.
 Package objects contains functionality for working with Object Storage object resources.
objectstorage/v1/objects/testing
objectstorage/v1/swauth
objectstorage/v1/swauth/testing
orchestration/v1/apiversions
Package apiversions provides information and interaction with the different API versions for the OpenStack Heat service.
 Package apiversions provides information and interaction with the different API versions for the OpenStack Heat service.
orchestration/v1/apiversions/testing
orchestration/v1/buildinfo
Package buildinfo provides build information about heat deployments.
 Package buildinfo provides build information about heat deployments.
orchestration/v1/buildinfo/testing
orchestration/v1/stackevents
Package stackevents provides operations for finding, listing, and retrieving stack events.
 Package stackevents provides operations for finding, listing, and retrieving stack events.
orchestration/v1/stackevents/testing
orchestration/v1/stackresources
Package stackresources provides operations for working with stack resources.
 Package stackresources provides operations for working with stack resources.
orchestration/v1/stackresources/testing
orchestration/v1/stacks
Package stacks provides operation for working with Heat stacks.
 Package stacks provides operation for working with Heat stacks.
orchestration/v1/stacks/testing
orchestration/v1/stacktemplates
Package stacktemplates provides operations for working with Heat templates.
 Package stacktemplates provides operations for working with Heat templates.
orchestration/v1/stacktemplates/testing
testing
utils
utils/testing
Package pagination contains utilities and convenience structs that implement common pagination idioms within OpenStack APIs.
 Package pagination contains utilities and convenience structs that implement common pagination idioms within OpenStack APIs.
testing
Package testhelper container methods that are useful for writing unit tests.
 Package testhelper container methods that are useful for writing unit tests.
client
fixture

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.