server

Documentation

Index

• Constants
• type CSServer
  • func New() *CSServer
  • func (cs *CSServer) Run()
• type ContainershipCustomClaim
• type HandlerFunc

Constants

const (
	// TerminateRole is the role a containership jwt token needs to be signed
	// with to be authenticated to make a request to the /terminate route
	TerminateRole = "terminate"
)

Types

type CSServer

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

CSServer defines the server

func New

func New() *CSServer

New creates a new server

func (*CSServer) Run

func (cs *CSServer) Run()

Run is exported for main agent to start server, which is what containership uses to talk with the cluster

type ContainershipCustomClaim

type ContainershipCustomClaim struct {
	Metadata struct {
		Roles []string `json:"https://containership.io/roles"`
	} `json:"metadata"`
	jwt.StandardClaims
}

ContainershipCustomClaim allows us to reference custom properties in the claim of a JWT

type HandlerFunc

type HandlerFunc func(http.Handler) http.Handler

HandlerFunc defines the function signature for a middleware function