loadbalancers

package
Version: v0.21.0 Latest Latest
Warning

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

Go to latest
Published: Sep 14, 2021 License: Apache-2.0 Imports: 6 Imported by: 26

Documentation

Overview

Package loadbalancers provides information and interaction with Load Balancers of the LBaaS v2 extension for the OpenStack Networking service.

Example to List Load Balancers

listOpts := loadbalancers.ListOpts{
	Provider: "haproxy",
}

allPages, err := loadbalancers.List(networkClient, listOpts).AllPages()
if err != nil {
	panic(err)
}

allLoadbalancers, err := loadbalancers.ExtractLoadBalancers(allPages)
if err != nil {
	panic(err)
}

for _, lb := range allLoadbalancers {
	fmt.Printf("%+v\n", lb)
}

Example to Create a Load Balancer

createOpts := loadbalancers.CreateOpts{
	Name:         "db_lb",
	AdminStateUp: gophercloud.Enabled,
	VipSubnetID:  "9cedb85d-0759-4898-8a4b-fa5a5ea10086",
	VipAddress:   "10.30.176.48",
	FlavorID:     "60df399a-ee85-11e9-81b4-2a2ae2dbcce4",
	Provider:     "haproxy",
	Tags:         []string{"test", "stage"},
}

lb, err := loadbalancers.Create(networkClient, createOpts).Extract()
if err != nil {
	panic(err)
}

Example to Create a fully populated Load Balancer

createOpts := loadbalancers.CreateOpts{
	Name:         "db_lb",
	AdminStateUp: gophercloud.Enabled,
	VipSubnetID:  "9cedb85d-0759-4898-8a4b-fa5a5ea10086",
	VipAddress:   "10.30.176.48",
	FlavorID:     "60df399a-ee85-11e9-81b4-2a2ae2dbcce4",
	Provider:     "haproxy",
	Tags:         []string{"test", "stage"},
	Listeners: []listeners.CreateOpts{{
		Protocol:     "HTTP",
		ProtocolPort: 8080,
		Name:         "redirect_listener",
		L7Policies: []l7policies.CreateOpts{{
			Name:        "redirect-example.com",
			Action:      l7policies.ActionRedirectToURL,
			RedirectURL: "http://www.example.com",
			Rules: []l7policies.CreateRuleOpts{{
				RuleType:    l7policies.TypePath,
				CompareType: l7policies.CompareTypeRegex,
				Value:       "/images*",
			}},
		}},
		DefaultPool: &pools.CreateOpts{
			LBMethod: pools.LBMethodRoundRobin,
			Protocol: "HTTP",
			Name:     "example pool",
			Members: []pools.BatchUpdateMemberOpts{{
				Address:      "192.0.2.51",
				ProtocolPort: 80,
			},},
			Monitor: &monitors.CreateOpts{
				Name:           "db",
				Type:           "HTTP",
				Delay:          3,
				MaxRetries:     2,
				Timeout:        1,
			},
		},
	}},
}

lb, err := loadbalancers.Create(networkClient, createOpts).Extract()
if err != nil {
	panic(err)
}

Example to Update a Load Balancer

lbID := "d67d56a6-4a86-4688-a282-f46444705c64"
name := "new-name"
updateOpts := loadbalancers.UpdateOpts{
	Name: &name,
}
lb, err := loadbalancers.Update(networkClient, lbID, updateOpts).Extract()
if err != nil {
	panic(err)
}

Example to Delete a Load Balancers

deleteOpts := loadbalancers.DeleteOpts{
	Cascade: true,
}

lbID := "d67d56a6-4a86-4688-a282-f46444705c64"

err := loadbalancers.Delete(networkClient, lbID, deleteOpts).ExtractErr()
if err != nil {
	panic(err)
}

Example to Get the Status of a Load Balancer

lbID := "d67d56a6-4a86-4688-a282-f46444705c64"
status, err := loadbalancers.GetStatuses(networkClient, LBID).Extract()
if err != nil {
	panic(err)
}

Example to Get the Statistics of a Load Balancer

lbID := "d67d56a6-4a86-4688-a282-f46444705c64"
stats, err := loadbalancers.GetStats(networkClient, LBID).Extract()
if err != nil {
	panic(err)
}

Example to Failover a Load Balancers

lbID := "d67d56a6-4a86-4688-a282-f46444705c64"

err := loadbalancers.Failover(networkClient, lbID).ExtractErr()
if err != nil {
	panic(err)
}

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func List

List returns a Pager which allows you to iterate over a collection of load balancers. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.

Default policy settings return only those load balancers that are owned by the project who submits the request, unless an admin user submits the request.

Types

type CreateOpts

type CreateOpts struct {
	// Human-readable name for the Loadbalancer. Does not have to be unique.
	Name string `json:"name,omitempty"`

	// Human-readable description for the Loadbalancer.
	Description string `json:"description,omitempty"`

	// Providing a neutron port ID for the vip_port_id tells Octavia to use this
	// port for the VIP. If the port has more than one subnet you must specify
	// either the vip_subnet_id or vip_address to clarify which address should
	// be used for the VIP.
	VipPortID string `json:"vip_port_id,omitempty"`

	// The subnet on which to allocate the Loadbalancer's address. A project can
	// only create Loadbalancers on networks authorized by policy (e.g. networks
	// that belong to them or networks that are shared).
	VipSubnetID string `json:"vip_subnet_id,omitempty"`

	// The network on which to allocate the Loadbalancer's address. A tenant can
	// only create Loadbalancers on networks authorized by policy (e.g. networks
	// that belong to them or networks that are shared).
	VipNetworkID string `json:"vip_network_id,omitempty"`

	// ProjectID is the UUID of the project who owns the Loadbalancer.
	// Only administrative users can specify a project UUID other than their own.
	ProjectID string `json:"project_id,omitempty"`

	// The IP address of the Loadbalancer.
	VipAddress string `json:"vip_address,omitempty"`

	// The administrative state of the Loadbalancer. A valid value is true (UP)
	// or false (DOWN).
	AdminStateUp *bool `json:"admin_state_up,omitempty"`

	// The UUID of a flavor.
	FlavorID string `json:"flavor_id,omitempty"`

	// The name of an Octavia availability zone.
	// Requires Octavia API version 2.14 or later.
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The name of the provider.
	Provider string `json:"provider,omitempty"`

	// Listeners is a slice of listeners.CreateOpts which allows a set
	// of listeners to be created at the same time the Loadbalancer is created.
	//
	// This is only possible to use when creating a fully populated
	// load balancer.
	Listeners []listeners.CreateOpts `json:"listeners,omitempty"`

	// Pools is a slice of pools.CreateOpts which allows a set of pools
	// to be created at the same time the Loadbalancer is created.
	//
	// This is only possible to use when creating a fully populated
	// load balancer.
	Pools []pools.CreateOpts `json:"pools,omitempty"`

	// Tags is a set of resource tags.
	Tags []string `json:"tags,omitempty"`
}

CreateOpts is the common options struct used in this package's Create operation.

func (CreateOpts) ToLoadBalancerCreateMap

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

ToLoadBalancerCreateMap builds a request body from CreateOpts.

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToLoadBalancerCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder allows extensions to add additional parameters to the Create request.

type CreateResult

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

CreateResult represents the result of a create operation. Call its Extract method to interpret it as a LoadBalancer.

func Create

Create is an operation which provisions a new loadbalancer based on the configuration defined in the CreateOpts struct. Once the request is validated and progress has started on the provisioning process, a CreateResult will be returned.

func (CreateResult) Extract

func (r CreateResult) Extract() (*LoadBalancer, error)

Extract is a function that accepts a result and extracts a loadbalancer.

type DeleteOpts

type DeleteOpts struct {
	// Cascade will delete all children of the load balancer (listners, monitors, etc).
	Cascade bool `q:"cascade"`
}

DeleteOpts is the common options struct used in this package's Delete operation.

func (DeleteOpts) ToLoadBalancerDeleteQuery

func (opts DeleteOpts) ToLoadBalancerDeleteQuery() (string, error)

ToLoadBalancerDeleteQuery formats a DeleteOpts into a query string.

type DeleteOptsBuilder

type DeleteOptsBuilder interface {
	ToLoadBalancerDeleteQuery() (string, error)
}

DeleteOptsBuilder allows extensions to add additional parameters to the Delete request.

type DeleteResult

type DeleteResult struct {
	gophercloud.ErrResult
}

DeleteResult represents the result of a delete operation. Call its ExtractErr method to determine if the request succeeded or failed.

func Delete

Delete will permanently delete a particular LoadBalancer based on its unique ID.

type FailoverResult

type FailoverResult struct {
	gophercloud.ErrResult
}

FailoverResult represents the result of a failover operation. Call its ExtractErr method to determine if the request succeeded or failed.

func Failover

func Failover(c *gophercloud.ServiceClient, id string) (r FailoverResult)

Failover performs a failover of a load balancer.

type GetResult

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

GetResult represents the result of a get operation. Call its Extract method to interpret it as a LoadBalancer.

func Get

func Get(c *gophercloud.ServiceClient, id string) (r GetResult)

Get retrieves a particular Loadbalancer based on its unique ID.

func (GetResult) Extract

func (r GetResult) Extract() (*LoadBalancer, error)

Extract is a function that accepts a result and extracts a loadbalancer.

type GetStatusesResult

type GetStatusesResult struct {
	gophercloud.Result
}

GetStatusesResult represents the result of a GetStatuses operation. Call its Extract method to interpret it as a StatusTree.

func GetStatuses

func GetStatuses(c *gophercloud.ServiceClient, id string) (r GetStatusesResult)

GetStatuses will return the status of a particular LoadBalancer.

func (GetStatusesResult) Extract

func (r GetStatusesResult) Extract() (*StatusTree, error)

Extract is a function that accepts a result and extracts the status of a Loadbalancer.

type ListOpts

type ListOpts struct {
	Description        string   `q:"description"`
	AdminStateUp       *bool    `q:"admin_state_up"`
	ProjectID          string   `q:"project_id"`
	ProvisioningStatus string   `q:"provisioning_status"`
	VipAddress         string   `q:"vip_address"`
	VipPortID          string   `q:"vip_port_id"`
	VipSubnetID        string   `q:"vip_subnet_id"`
	VipNetworkID       string   `q:"vip_network_id"`
	ID                 string   `q:"id"`
	OperatingStatus    string   `q:"operating_status"`
	Name               string   `q:"name"`
	FlavorID           string   `q:"flavor_id"`
	AvailabilityZone   string   `q:"availability_zone"`
	Provider           string   `q:"provider"`
	Limit              int      `q:"limit"`
	Marker             string   `q:"marker"`
	SortKey            string   `q:"sort_key"`
	SortDir            string   `q:"sort_dir"`
	Tags               []string `q:"tags"`
	TagsAny            []string `q:"tags-any"`
	TagsNot            []string `q:"not-tags"`
	TagsNotAny         []string `q:"not-tags-any"`
}

ListOpts allows the filtering and sorting of paginated collections through the API. Filtering is achieved by passing in struct field values that map to the Loadbalancer attributes you want to see returned. SortKey allows you to sort by a particular attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

func (ListOpts) ToLoadBalancerListQuery

func (opts ListOpts) ToLoadBalancerListQuery() (string, error)

ToLoadBalancerListQuery formats a ListOpts into a query string.

type ListOptsBuilder

type ListOptsBuilder interface {
	ToLoadBalancerListQuery() (string, error)
}

ListOptsBuilder allows extensions to add additional parameters to the List request.

type LoadBalancer

type LoadBalancer struct {
	// Human-readable description for the Loadbalancer.
	Description string `json:"description"`

	// The administrative state of the Loadbalancer.
	// A valid value is true (UP) or false (DOWN).
	AdminStateUp bool `json:"admin_state_up"`

	// Owner of the LoadBalancer.
	ProjectID string `json:"project_id"`

	// UpdatedAt and CreatedAt contain ISO-8601 timestamps of when the state of the
	// loadbalancer last changed, and when it was created.
	UpdatedAt time.Time `json:"-"`
	CreatedAt time.Time `json:"-"`

	// The provisioning status of the LoadBalancer.
	// This value is ACTIVE, PENDING_CREATE or ERROR.
	ProvisioningStatus string `json:"provisioning_status"`

	// The IP address of the Loadbalancer.
	VipAddress string `json:"vip_address"`

	// The UUID of the port associated with the IP address.
	VipPortID string `json:"vip_port_id"`

	// The UUID of the subnet on which to allocate the virtual IP for the
	// Loadbalancer address.
	VipSubnetID string `json:"vip_subnet_id"`

	// The UUID of the network on which to allocate the virtual IP for the
	// Loadbalancer address.
	VipNetworkID string `json:"vip_network_id"`

	// The unique ID for the LoadBalancer.
	ID string `json:"id"`

	// The operating status of the LoadBalancer. This value is ONLINE or OFFLINE.
	OperatingStatus string `json:"operating_status"`

	// Human-readable name for the LoadBalancer. Does not have to be unique.
	Name string `json:"name"`

	// The UUID of a flavor if set.
	FlavorID string `json:"flavor_id"`

	// The name of an Octavia availability zone if set.
	AvailabilityZone string `json:"availability_zone"`

	// The name of the provider.
	Provider string `json:"provider"`

	// Listeners are the listeners related to this Loadbalancer.
	Listeners []listeners.Listener `json:"listeners"`

	// Pools are the pools related to this Loadbalancer.
	Pools []pools.Pool `json:"pools"`

	// Tags is a list of resource tags. Tags are arbitrarily defined strings
	// attached to the resource.
	Tags []string `json:"tags"`
}

LoadBalancer is the primary load balancing configuration object that specifies the virtual IP address on which client traffic is received, as well as other details such as the load balancing method to be use, protocol, etc.

func ExtractLoadBalancers

func ExtractLoadBalancers(r pagination.Page) ([]LoadBalancer, error)

ExtractLoadBalancers accepts a Page struct, specifically a LoadbalancerPage struct, and extracts the elements into a slice of LoadBalancer structs. In other words, a generic collection is mapped into a relevant slice.

func (*LoadBalancer) UnmarshalJSON added in v0.4.0

func (r *LoadBalancer) UnmarshalJSON(b []byte) error

type LoadBalancerPage

type LoadBalancerPage struct {
	pagination.LinkedPageBase
}

LoadBalancerPage is the page returned by a pager when traversing over a collection of load balancers.

func (LoadBalancerPage) IsEmpty

func (r LoadBalancerPage) IsEmpty() (bool, error)

IsEmpty checks whether a LoadBalancerPage struct is empty.

func (LoadBalancerPage) NextPageURL

func (r LoadBalancerPage) NextPageURL() (string, error)

NextPageURL is invoked when a paginated collection of load balancers has reached the end of a page and the pager seeks to traverse over a new one. In order to do this, it needs to construct the next page's URL.

type Stats

type Stats struct {
	// The currently active connections.
	ActiveConnections int `json:"active_connections"`

	// The total bytes received.
	BytesIn int `json:"bytes_in"`

	// The total bytes sent.
	BytesOut int `json:"bytes_out"`

	// The total requests that were unable to be fulfilled.
	RequestErrors int `json:"request_errors"`

	// The total connections handled.
	TotalConnections int `json:"total_connections"`
}

type StatsResult

type StatsResult struct {
	gophercloud.Result
}

StatsResult represents the result of a GetStats operation. Call its Extract method to interpret it as a Stats.

func GetStats

func GetStats(c *gophercloud.ServiceClient, id string) (r StatsResult)

GetStats will return the shows the current statistics of a particular LoadBalancer.

func (StatsResult) Extract

func (r StatsResult) Extract() (*Stats, error)

Extract is a function that accepts a result and extracts the status of a Loadbalancer.

type StatusTree

type StatusTree struct {
	Loadbalancer *LoadBalancer `json:"loadbalancer"`
}

StatusTree represents the status of a loadbalancer.

type UpdateOpts

type UpdateOpts struct {
	// Human-readable name for the Loadbalancer. Does not have to be unique.
	Name *string `json:"name,omitempty"`

	// Human-readable description for the Loadbalancer.
	Description *string `json:"description,omitempty"`

	// The administrative state of the Loadbalancer. A valid value is true (UP)
	// or false (DOWN).
	AdminStateUp *bool `json:"admin_state_up,omitempty"`

	// Tags is a set of resource tags.
	Tags *[]string `json:"tags,omitempty"`
}

UpdateOpts is the common options struct used in this package's Update operation.

func (UpdateOpts) ToLoadBalancerUpdateMap

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

ToLoadBalancerUpdateMap builds a request body from UpdateOpts.

type UpdateOptsBuilder

type UpdateOptsBuilder interface {
	ToLoadBalancerUpdateMap() (map[string]interface{}, error)
}

UpdateOptsBuilder allows extensions to add additional parameters to the Update request.

type UpdateResult

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

UpdateResult represents the result of an update operation. Call its Extract method to interpret it as a LoadBalancer.

func Update

func Update(c *gophercloud.ServiceClient, id string, opts UpdateOpts) (r UpdateResult)

Update is an operation which modifies the attributes of the specified LoadBalancer.

func (UpdateResult) Extract

func (r UpdateResult) Extract() (*LoadBalancer, error)

Extract is a function that accepts a result and extracts a loadbalancer.

Directories

Path Synopsis
loadbalancers unit tests
loadbalancers unit tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL