Documentation

Index

Constants

View Source
const (
	TypePING  = "PING"
	TypeTCP   = "TCP"
	TypeHTTP  = "HTTP"
	TypeHTTPS = "HTTPS"
)

    Constants that represent approved monitoring types.

    Variables

    This section is empty.

    Functions

    func List

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

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

      Types

      type CreateOpts

      type CreateOpts struct {
      	// Required for admins. Indicates the owner of the VIP.
      	TenantID string
      
      	// Required. The type of probe, which is PING, TCP, HTTP, or HTTPS, that is
      	// sent by the load balancer to verify the member state.
      	Type string
      
      	// Required. The time, in seconds, between sending probes to members.
      	Delay int
      
      	// Required. Maximum number of seconds for a monitor to wait for a ping reply
      	// before it times out. The value must be less than the delay value.
      	Timeout int
      
      	// Required. Number of permissible ping failures before changing the member's
      	// status to INACTIVE. Must be a number between 1 and 10.
      	MaxRetries int
      
      	// Required for HTTP(S) types. URI path that will be accessed if monitor type
      	// is HTTP or HTTPS.
      	URLPath string
      
      	// Required for HTTP(S) types. The HTTP method used for requests by the
      	// monitor. If this attribute is not specified, it defaults to "GET".
      	HTTPMethod string
      
      	// Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S)
      	// monitor. You can either specify a single status like "200", or a range
      	// like "200-202".
      	ExpectedCodes string
      
      	AdminStateUp *bool
      }

        CreateOpts contains all the values needed to create a new health monitor.

        type CreateResult

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

          CreateResult represents the result of a create operation.

          func Create

            Create is an operation which provisions a new health monitor. There are different types of monitor you can provision: PING, TCP or HTTP(S). Below are examples of how to create each one.

            Here is an example config struct to use when creating a PING or TCP monitor:

            CreateOpts{Type: TypePING, Delay: 20, Timeout: 10, MaxRetries: 3} CreateOpts{Type: TypeTCP, Delay: 20, Timeout: 10, MaxRetries: 3}

            Here is an example config struct to use when creating a HTTP(S) monitor:

            CreateOpts{Type: TypeHTTP, Delay: 20, Timeout: 10, MaxRetries: 3,

            HttpMethod: "HEAD", ExpectedCodes: "200"}
            

            func (CreateResult) Extract

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

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

              type DeleteResult

              type DeleteResult struct {
              	gophercloud.ErrResult
              }

                DeleteResult represents the result of a delete operation.

                func Delete

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

                  type GetResult

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

                    GetResult represents the result of a get operation.

                    func Get

                      Get retrieves a particular health monitor based on its unique ID.

                      func (GetResult) Extract

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

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

                        type ListOpts

                        type ListOpts struct {
                        	ID            string `q:"id"`
                        	TenantID      string `q:"tenant_id"`
                        	Type          string `q:"type"`
                        	Delay         int    `q:"delay"`
                        	Timeout       int    `q:"timeout"`
                        	MaxRetries    int    `q:"max_retries"`
                        	HTTPMethod    string `q:"http_method"`
                        	URLPath       string `q:"url_path"`
                        	ExpectedCodes string `q:"expected_codes"`
                        	AdminStateUp  *bool  `q:"admin_state_up"`
                        	Status        string `q:"status"`
                        	Limit         int    `q:"limit"`
                        	Marker        string `q:"marker"`
                        	SortKey       string `q:"sort_key"`
                        	SortDir       string `q:"sort_dir"`
                        }

                          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 floating IP attributes you want to see returned. SortKey allows you to sort by a particular network attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

                          type Monitor

                          type Monitor struct {
                          	// The unique ID for the VIP.
                          	ID string
                          
                          	// Owner of the VIP. Only an administrative user can specify a tenant ID
                          	// other than its own.
                          	TenantID string `json:"tenant_id" mapstructure:"tenant_id"`
                          
                          	// The type of probe sent by the load balancer to verify the member state,
                          	// which is PING, TCP, HTTP, or HTTPS.
                          	Type string
                          
                          	// The time, in seconds, between sending probes to members.
                          	Delay int
                          
                          	// The maximum number of seconds for a monitor to wait for a connection to be
                          	// established before it times out. This value must be less than the delay value.
                          	Timeout int
                          
                          	// Number of allowed connection failures before changing the status of the
                          	// member to INACTIVE. A valid value is from 1 to 10.
                          	MaxRetries int `json:"max_retries" mapstructure:"max_retries"`
                          
                          	// The HTTP method that the monitor uses for requests.
                          	HTTPMethod string `json:"http_method" mapstructure:"http_method"`
                          
                          	// The HTTP path of the request sent by the monitor to test the health of a
                          	// member. Must be a string beginning with a forward slash (/).
                          	URLPath string `json:"url_path" mapstructure:"url_path"`
                          
                          	// Expected HTTP codes for a passing HTTP(S) monitor.
                          	ExpectedCodes string `json:"expected_codes" mapstructure:"expected_codes"`
                          
                          	// The administrative state of the health monitor, which is up (true) or down (false).
                          	AdminStateUp bool `json:"admin_state_up" mapstructure:"admin_state_up"`
                          
                          	// The status of the health monitor. Indicates whether the health monitor is
                          	// operational.
                          	Status string
                          }

                            Monitor represents a load balancer health monitor. A health monitor is used to determine whether or not back-end members of the VIP's pool are usable for processing a request. A pool can have several health monitors associated with it. There are different types of health monitors supported:

                            PING: used to ping the members using ICMP. TCP: used to connect to the members using TCP. HTTP: used to send an HTTP request to the member. HTTPS: used to send a secure HTTP request to the member.

                            When a pool has several monitors associated with it, each member of the pool is monitored by all these monitors. If any monitor declares the member as unhealthy, then the member status is changed to INACTIVE and the member won't participate in its pool's load balancing. In other words, ALL monitors must declare the member to be healthy for it to stay ACTIVE.

                            func ExtractMonitors

                            func ExtractMonitors(page pagination.Page) ([]Monitor, error)

                              ExtractMonitors accepts a Page struct, specifically a MonitorPage struct, and extracts the elements into a slice of Monitor structs. In other words, a generic collection is mapped into a relevant slice.

                              type MonitorPage

                              type MonitorPage struct {
                              	pagination.LinkedPageBase
                              }

                                MonitorPage is the page returned by a pager when traversing over a collection of health monitors.

                                func (MonitorPage) IsEmpty

                                func (p MonitorPage) IsEmpty() (bool, error)

                                  IsEmpty checks whether a PoolPage struct is empty.

                                  func (MonitorPage) NextPageURL

                                  func (p MonitorPage) NextPageURL() (string, error)

                                    NextPageURL is invoked when a paginated collection of monitors 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 UpdateOpts

                                    type UpdateOpts struct {
                                    	// Required. The time, in seconds, between sending probes to members.
                                    	Delay int
                                    
                                    	// Required. Maximum number of seconds for a monitor to wait for a ping reply
                                    	// before it times out. The value must be less than the delay value.
                                    	Timeout int
                                    
                                    	// Required. Number of permissible ping failures before changing the member's
                                    	// status to INACTIVE. Must be a number between 1 and 10.
                                    	MaxRetries int
                                    
                                    	// Required for HTTP(S) types. URI path that will be accessed if monitor type
                                    	// is HTTP or HTTPS.
                                    	URLPath string
                                    
                                    	// Required for HTTP(S) types. The HTTP method used for requests by the
                                    	// monitor. If this attribute is not specified, it defaults to "GET".
                                    	HTTPMethod string
                                    
                                    	// Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S)
                                    	// monitor. You can either specify a single status like "200", or a range
                                    	// like "200-202".
                                    	ExpectedCodes string
                                    
                                    	AdminStateUp *bool
                                    }

                                      UpdateOpts contains all the values needed to update an existing virtual IP. Attributes not listed here but appear in CreateOpts are immutable and cannot be updated.

                                      type UpdateResult

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

                                        UpdateResult represents the result of an update operation.

                                        func Update

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

                                          func (UpdateResult) Extract

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

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