rancher

Documentation

Index

• type APIConfiguration
• type MetadataConfiguration
• type Provider
  • func (p *Provider) Init(constraints types.Constraints) error
  • func (p *Provider) Provide(configurationChan chan<- types.ConfigMessage, pool *safe.Pool) error

Types

type APIConfiguration

type APIConfiguration struct {
	Endpoint  string `description:"Rancher server API HTTP(S) endpoint"`
	AccessKey string `description:"Rancher server API access key"`
	SecretKey string `description:"Rancher server API secret key"`
}

APIConfiguration contains configuration properties specific to the Rancher API provider.

type MetadataConfiguration

type MetadataConfiguration struct {
	IntervalPoll bool   `description:"Poll the Rancher metadata service every 'rancher.refreshseconds' (less accurate)"`
	Prefix       string `description:"Prefix used for accessing the Rancher metadata service"`
}

MetadataConfiguration contains configuration properties specific to the Rancher metadata service provider.

type Provider

type Provider struct {
	provider.BaseProvider     `mapstructure:",squash" export:"true"`
	APIConfiguration          `mapstructure:",squash" export:"true"` // Provide backwards compatibility
	API                       *APIConfiguration                      `description:"Enable the Rancher API provider" export:"true"`
	Metadata                  *MetadataConfiguration                 `description:"Enable the Rancher metadata service provider" export:"true"`
	Domain                    string                                 `description:"Default domain used"`
	RefreshSeconds            int                                    `description:"Polling interval (in seconds)" export:"true"`
	ExposedByDefault          bool                                   `description:"Expose services by default" export:"true"`
	EnableServiceHealthFilter bool                                   `description:"Filter services with unhealthy states and inactive states" export:"true"`
}

Provider holds configurations of the provider.

func (*Provider) Init

func (p *Provider) Init(constraints types.Constraints) error

Init the provider

func (*Provider) Provide

func (p *Provider) Provide(configurationChan chan<- types.ConfigMessage, pool *safe.Pool) error

Provide allows either the Rancher API or metadata service provider to seed configuration into Traefik using the given configuration channel.