apiserver

Documentation

Index

• Constants
• Variables
• func AdminFacadeDetails() []facade.Details
• func AllFacades() *facade.Registry
• func DescribeFacades(registry *facade.Registry) []params.FacadeVersions
• func IsAnonymousFacade(facadeName string) bool
• func IsControllerFacade(facadeName string) bool
• func IsMethodAllowedDuringMigration(facadeName, methodName string) bool
• func IsMethodAllowedDuringUpgrade(facadeName, methodName string) bool
• func IsModelFacade(facadeName string) bool
• func NewAllWatcher(context facade.Context) (facade.Facade, error)
• func RepackageAndUploadCharm(st *state.State, archive *charm.CharmArchive, curl *charm.URL) error
• type CharmsHTTPHandler
  • func (h *CharmsHTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Collector
  • func NewMetricsCollector() *Collector
  • func (c *Collector) Collect(ch chan<- prometheus.Metric)
  • func (c *Collector) Describe(ch chan<- *prometheus.Desc)
• type EntitiesWatcher
• type ExecEmbeddedCommandFunc
• type FailableHandlerFunc
• type Hub
• type LogSinkConfig
  • func DefaultLogSinkConfig() LogSinkConfig
  • func (cfg LogSinkConfig) Validate() error
• type Logger
• type Pinger
  • func NewPinger(st *state.State, resources facade.Resources, authorizer facade.Authorizer) (Pinger, error)
• type Queue
• type ResourcesBackend
• type ResourcesHandler
  • func (h *ResourcesHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)
• type RestHTTPHandler
  • func (h *RestHTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Server
  • func NewServer(cfg ServerConfig) (*Server, error)
  • func (srv *Server) Dead() <-chan struct{}
  • func (srv *Server) GetAuditConfig() auditlog.Config
  • func (srv *Server) Kill()
  • func (srv *Server) Report() map[string]interface{}
  • func (srv *Server) Stop() error
  • func (srv *Server) Wait() error
• type ServerConfig
  • func (c ServerConfig) Validate() error
• type SharedHub
• type SrvAllWatcher
  • func (aw *SrvAllWatcher) Next() (params.AllWatcherNextResults, error)
  • func (w *SrvAllWatcher) Stop() error
• type SrvModelSummaryWatcher
  • func NewModelSummaryWatcher(context facade.Context) (*SrvModelSummaryWatcher, error)
  • func (w *SrvModelSummaryWatcher) Next() (params.SummaryWatcherNextResults, error)
  • func (w *SrvModelSummaryWatcher) Stop() error
• type UnitResourcesHandler
  • func (h *UnitResourcesHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)

Constants

const (
	// MetricLabelEndpoint defines a constant for the APIConnections and
	// PingFailureCount Labels
	MetricLabelEndpoint = "endpoint"

	// MetricLabelModelUUID defines a constant for the PingFailureCount and
	// LogWriteCount Labels
	// Note: prometheus doesn't allow hyphens only underscores
	MetricLabelModelUUID = "model_uuid"

	// MetricLabelState defines a constant for the state Label
	MetricLabelState = "state"

	// MetricLabelHost defines a host constant for the Requests Label
	MetricLabelHost = "host"

	// MetricLabelStatus defines a status constant for the Requests Label
	MetricLabelStatus = "status"
)

const (
	// ApplyLeaseTimeout is the maximum upper bound of waiting for applying a
	// command to the lease. This should never trigger, as the underlying system
	// has other underlying shorter timeouts that should never grow to this
	// timeout. This stop gap is to ensure that we never block leases.
	ApplyLeaseTimeout = time.Second * 10
)

Variables

var MaintenanceNoLoginError = errors.New("login failed - maintenance in progress")

var MetricAPIConnectionsLabelNames = []string{
	MetricLabelEndpoint,
}

MetricAPIConnectionsLabelNames defines a series of labels for the APIConnections metric.

var MetricLogLabelNames = []string{
	MetricLabelModelUUID,
	MetricLabelState,
}

MetricLogLabelNames defines a series of labels for the LogWrite and LogRead metric

var MetricPingFailureLabelNames = []string{
	MetricLabelModelUUID,
	MetricLabelEndpoint,
}

MetricPingFailureLabelNames defines a series of labels for the PingFailure metric.

var MetricTotalRequestsLabelNames = []string{
	MetricLabelModelUUID,
	MetricLabelHost,
}

MetricTotalRequestsLabelNames defines a series of labels for the TotalRequests metric.

var MetricTotalRequestsWithStatusLabelNames = []string{
	MetricLabelModelUUID,
	MetricLabelHost,
	MetricLabelStatus,
}

MetricTotalRequestsWithStatusLabelNames defines a series of labels for the TotalRequests metric.

Functions

func AdminFacadeDetails

func AdminFacadeDetails() []facade.Details

AdminFacadeDetails returns information on the Admin facade provided at login time. The Facade field of the returned slice elements will be nil.

func AllFacades

func AllFacades() *facade.Registry

AllFacades returns a registry containing all known API facades.

This will panic if facade registration fails, but there is a unit test to guard against that.

func DescribeFacades

func DescribeFacades(registry *facade.Registry) []params.FacadeVersions

DescribeFacades returns the list of available Facades and their Versions

func IsAnonymousFacade

func IsAnonymousFacade(facadeName string) bool

IsAnonymousFacade reports whether the given facade name can be accessed using an anonymous connection.

func IsControllerFacade

func IsControllerFacade(facadeName string) bool

IsControllerFacade reports whether the given facade name can be accessed using a controller connection.

func IsMethodAllowedDuringMigration

func IsMethodAllowedDuringMigration(facadeName, methodName string) bool

func IsMethodAllowedDuringUpgrade

func IsMethodAllowedDuringUpgrade(facadeName, methodName string) bool

func IsModelFacade

func IsModelFacade(facadeName string) bool

IsModelFacade reports whether the given facade name can be accessed using a model connection.

func NewAllWatcher

func NewAllWatcher(context facade.Context) (facade.Facade, error)

NewAllWatcher returns a new API server endpoint for interacting with a watcher created by the WatchAll and WatchAllModels API calls.

func RepackageAndUploadCharm

func RepackageAndUploadCharm(st *state.State, archive *charm.CharmArchive, curl *charm.URL) error

RepackageAndUploadCharm expands the given charm archive to a temporary directory, repackages it with the given curl's revision, then uploads it to storage, and finally updates the state.

Types

type CharmsHTTPHandler

type CharmsHTTPHandler struct {
	PostHandler FailableHandlerFunc
	GetHandler  FailableHandlerFunc
}

CharmsHTTPHandler creates is a http.Handler which serves POST requests to a PostHandler and GET requests to a GetHandler.

TODO(katco): This is the beginning of inverting the dependencies in this callstack by splitting out the serving mechanism from the modules that are processing the requests. The next step is to publically expose construction of a suitable PostHandler and GetHandler whose goals should be clearly called out in their names, (e.g. charmPersitAPI for POSTs).

To accomplish this, we'll have to make the httpContext type public so that we can pass it into these public functions.

After we do this, we can then test the individual funcs/structs without standing up an entire HTTP server. I.e. actual unit tests. If you're in this area and can, please chisel away at this problem and update this TODO as needed! Many thanks, hacker!

TODO(stickupkid): This handler is terrible, we could implement a middleware pattern to handle discreet logic and then pass it on to the next in the pipeline.

As usual big methods lead to untestable code and it causes testing pain.

func (*CharmsHTTPHandler) ServeHTTP

func (h *CharmsHTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Collector

type Collector struct {
	TotalConnections prometheus.Counter

	LoginAttempts      prometheus.Gauge
	APIConnections     *prometheus.GaugeVec
	APIRequestDuration *prometheus.SummaryVec

	PingFailureCount *prometheus.CounterVec

	LogWriteCount *prometheus.CounterVec
	LogReadCount  *prometheus.CounterVec

	TotalRequests         *prometheus.CounterVec
	TotalRequestErrors    *prometheus.CounterVec
	TotalRequestsDuration *prometheus.SummaryVec
}

Collector is a prometheus.Collector that collects metrics based on apiserver status.

func NewMetricsCollector

func NewMetricsCollector() *Collector

NewMetricsCollector returns a new Collector.

func (*Collector) Collect

func (c *Collector) Collect(ch chan<- prometheus.Metric)

Collect is part of the prometheus.Collector interface.

func (*Collector) Describe

func (c *Collector) Describe(ch chan<- *prometheus.Desc)

Describe is part of the prometheus.Collector interface.

type EntitiesWatcher

type EntitiesWatcher interface {
	state.StringsWatcher

	// MapChanges maps the received strings to their according tag strings.
	// The EntityFinder interface representing state or a mock has to be
	// upcasted into the needed sub-interface of state for the real mapping.
	MapChanges(in []string) ([]string, error)
}

EntitiesWatcher defines an interface based on the StringsWatcher but also providing a method for the mapping of the received strings to the tags of the according entities.

type ExecEmbeddedCommandFunc

type ExecEmbeddedCommandFunc func(ctx *cmd.Context, store jujuclient.ClientStore, whitelist []string, cmdPlusArgs string) int

ExecEmbeddedCommandFunc defines a function which runs a named Juju command with the whitelisted sub commands.

type FailableHandlerFunc

type FailableHandlerFunc func(http.ResponseWriter, *http.Request) error

type Hub

type Hub interface {
	Publish(string, interface{}) (func(), error)
}

Hub defines the publish method that the handler uses to publish messages on the centralhub of the apiserver.

type LogSinkConfig

type LogSinkConfig struct {
	// DBLoggerBufferSize is the capacity of the database logger's buffer.
	DBLoggerBufferSize int

	// DBLoggerFlushInterval is the amount of time to allow a log record
	// to sit in the buffer before being flushed to the database.
	DBLoggerFlushInterval time.Duration

	// RateLimitBurst defines the number of log messages that will be let
	// through before we start rate limiting.
	RateLimitBurst int64

	// RateLimitRefill defines the rate at which log messages will be let
	// through once the initial burst amount has been depleted.
	RateLimitRefill time.Duration
}

LogSinkConfig holds parameters to control the API server's logsink endpoint behaviour.

func DefaultLogSinkConfig

func DefaultLogSinkConfig() LogSinkConfig

DefaultLogSinkConfig returns a LogSinkConfig with default values.

func (LogSinkConfig) Validate

func (cfg LogSinkConfig) Validate() error

Validate validates the logsink endpoint configuration.

type Logger

type Logger interface {
	Errorf(string, ...interface{})
	Debugf(string, ...interface{})
	Tracef(string, ...interface{})
	IsTraceEnabled() bool
}

type Pinger

type Pinger interface {
	Ping()
	Stop() error
}

pinger describes a resource that can be pinged and stopped.

func NewPinger

func NewPinger(st *state.State, resources facade.Resources, authorizer facade.Authorizer) (Pinger, error)

NewPinger returns an object that can be pinged by calling its Ping method. If this method is not called frequently enough, the connection will be dropped.

type Queue

type Queue interface {
	// Enqueue will add an operation to the queue. As this is a blocking queue, any
	// additional enqueue operations will block and wait for subsequent operations
	// to be completed.
	// The design of this is to ensure that people calling this will have to
	// correctly handle backing off from enqueueing.
	Enqueue(queue.Operation)
}

Queue is a blocking queue to guard access and to serialize raft applications, allowing for client side backoff.

type ResourcesBackend

type ResourcesBackend interface {
	// OpenResource returns the identified resource and its content.
	OpenResource(applicationID, name string) (resource.Resource, io.ReadCloser, error)

	// GetResource returns the identified resource.
	GetResource(applicationID, name string) (resource.Resource, error)

	// GetPendingResource returns the identified resource.
	GetPendingResource(applicationID, name, pendingID string) (resource.Resource, error)

	// SetResource adds the resource to blob storage and updates the metadata.
	SetResource(applicationID, userID string, res charmresource.Resource, r io.Reader, _ state.IncrementCharmModifiedVersionType) (resource.Resource, error)

	// UpdatePendingResource adds the resource to blob storage and updates the metadata.
	UpdatePendingResource(applicationID, pendingID, userID string, res charmresource.Resource, r io.Reader) (resource.Resource, error)
}

ResourcesBackend is the functionality of Juju's state needed for the resources API.

type ResourcesHandler

type ResourcesHandler struct {
	StateAuthFunc     func(*http.Request, ...string) (ResourcesBackend, state.PoolHelper, names.Tag, error)
	ChangeAllowedFunc func(*http.Request) error
}

ResourcesHandler is the HTTP handler for client downloads and uploads of resources.

func (*ResourcesHandler) ServeHTTP

func (h *ResourcesHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)

ServeHTTP implements http.Handler.

type RestHTTPHandler

type RestHTTPHandler struct {
	GetHandler FailableHandlerFunc
}

RestHTTPHandler creates is a http.Handler which serves ReST requests.

func (*RestHTTPHandler) ServeHTTP

func (h *RestHTTPHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is defined on handler.Handler.

type Server

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

Server holds the server side of the API.

func NewServer

func NewServer(cfg ServerConfig) (*Server, error)

NewServer serves API requests using the given configuration.

func (*Server) Dead

func (srv *Server) Dead() <-chan struct{}

Dead returns a channel that signals when the server has exited.

func (*Server) GetAuditConfig

func (srv *Server) GetAuditConfig() auditlog.Config

GetAuditConfig returns a copy of the current audit logging configuration.

func (*Server) Kill

func (srv *Server) Kill()

Kill implements worker.Worker.Kill.

func (*Server) Report

func (srv *Server) Report() map[string]interface{}

Report is shown in the juju_engine_report.

func (*Server) Stop

func (srv *Server) Stop() error

Stop stops the server and returns when all running requests have completed.

func (*Server) Wait

func (srv *Server) Wait() error

Wait implements worker.Worker.Wait.

type ServerConfig

type ServerConfig struct {
	Clock         clock.Clock
	PingClock     clock.Clock
	Tag           names.Tag
	DataDir       string
	LogDir        string
	Hub           *pubsub.StructuredHub
	Presence      presence.Recorder
	Mux           *apiserverhttp.Mux
	Authenticator httpcontext.LocalMacaroonAuthenticator

	// MultiwatcherFactory is used by the API server to create
	// multiwatchers. The real factory is managed by the multiwatcher
	// worker.
	MultiwatcherFactory multiwatcher.Factory

	// StatePool is the StatePool used for looking up State
	// to pass to facades. StatePool will not be closed by the
	// server; it is the callers responsibility to close it
	// after the apiserver has exited.
	StatePool *state.StatePool

	// Controller is the in-memory representation of the models
	// in the controller. It is kept up to date with an all model
	// watcher and the modelcache worker.
	Controller *cache.Controller

	// UpgradeComplete is a function that reports whether or not
	// the if the agent running the API server has completed
	// running upgrade steps. This is used by the API server to
	// limit logins during upgrades.
	UpgradeComplete func() bool

	// PublicDNSName is reported to the API clients who connect.
	PublicDNSName string

	// AllowModelAccess holds whether users will be allowed to
	// access models that they have access rights to even when
	// they don't have access to the controller.
	AllowModelAccess bool

	// NewObserver is a function which will return an observer. This
	// is used per-connection to instantiate a new observer to be
	// notified of key events during API requests.
	NewObserver observer.ObserverFactory

	// RegisterIntrospectionHandlers is a function that will
	// call a function with (path, http.Handler) tuples. This
	// is to support registering the handlers underneath the
	// "/introspection" prefix.
	RegisterIntrospectionHandlers func(func(string, http.Handler))

	// LogSinkConfig holds parameters to control the API server's
	// logsink endpoint behaviour. If this is nil, the values from
	// DefaultLogSinkConfig() will be used.
	LogSinkConfig *LogSinkConfig

	// GetAuditConfig holds a function that returns the current audit
	// logging config. The function may return updated values, so
	// should be called every time a new login is handled.
	GetAuditConfig func() auditlog.Config

	// LeaseManager gives access to leadership and singular claimers
	// and checkers for use in API facades.
	LeaseManager lease.Manager

	// MetricsCollector defines all the metrics to be collected for the
	// apiserver
	MetricsCollector *Collector

	// ExecEmbeddedCommand is a function which creates an embedded Juju CLI instance.
	ExecEmbeddedCommand ExecEmbeddedCommandFunc

	// RaftOpQueue is used by the API to apply operations to the raft
	// instance.
	RaftOpQueue Queue
}

ServerConfig holds parameters required to set up an API server.

func (ServerConfig) Validate

func (c ServerConfig) Validate() error

Validate validates the API server configuration.

type SharedHub

type SharedHub interface {
	Publish(topic string, data interface{}) (func(), error)
	Subscribe(topic string, handler interface{}) (func(), error)
}

SharedHub represents the methods of the pubsub.StructuredHub that are used. The context uses an interface to allow mocking of the hub.

type SrvAllWatcher

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

SrvAllWatcher defines the API methods on a state.Multiwatcher. which watches any changes to the state. Each client has its own current set of watchers, stored in resources. It is used by both the AllWatcher and AllModelWatcher facades.

func (*SrvAllWatcher) Next

func (aw *SrvAllWatcher) Next() (params.AllWatcherNextResults, error)

Next will return the current state of everything on the first call and subsequent calls will

func (*SrvAllWatcher) Stop

func (w *SrvAllWatcher) Stop() error

Stop stops the watcher.

type SrvModelSummaryWatcher

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

SrvModelSummaryWatcher defines the API methods on a ModelSummaryWatcher.

func NewModelSummaryWatcher

func NewModelSummaryWatcher(context facade.Context) (*SrvModelSummaryWatcher, error)

NewModelSummaryWatcher returns a new API server endpoint for interacting with a watcher created by the WatchModelSummaries and WatchAllModelSummaries API calls.

func (*SrvModelSummaryWatcher) Next

func (w *SrvModelSummaryWatcher) Next() (params.SummaryWatcherNextResults, error)

Next will return the current state of everything on the first call and subsequent calls will return just those model summaries that have changed.

func (*SrvModelSummaryWatcher) Stop

func (w *SrvModelSummaryWatcher) Stop() error

Stop stops the watcher.

type UnitResourcesHandler

type UnitResourcesHandler struct {
	NewOpener func(*http.Request, ...string) (resource.Opener, state.PoolHelper, error)
}

UnitResourcesHandler is the HTTP handler for unit agent downloads of resources.

func (*UnitResourcesHandler) ServeHTTP

func (h *UnitResourcesHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)

ServeHTTP implements http.Handler.