draft

Documentation

Index

• type AppContext
• type Client
  • func NewClient(cfg *ClientConfig) *Client
  • func (c *Client) Results() <-chan *rpc.UpSummary
  • func (c *Client) Up(ctx context.Context, app *build.Context) error
  • func (c *Client) Version(ctx context.Context) (*version.Version, error)
• type ClientConfig
• type DockerAuth
• type RegistryAuth
• type RegistryConfig
• type Server
  • func NewServer(cfg *ServerConfig) *Server
  • func (s *Server) Serve(ctx context.Context) error
  • func (s *Server) Up(ctx context.Context, req *rpc.UpRequest) <-chan *rpc.UpSummary
• type ServerConfig

Types

type AppContext

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

AppContext contains state information carried across the various draft stage boundaries.

type Client

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

Client is the draft grpc client used to communicate with draftd

func NewClient

func NewClient(cfg *ClientConfig) *Client

NewClient takes ClientConfig and returns a Client

func (*Client) Results

func (c *Client) Results() <-chan *rpc.UpSummary

Results returns the summary of events from an invocation of `draft up`

func (*Client) Up

func (c *Client) Up(ctx context.Context, app *build.Context) error

Up uploads the build context and chart up to draftd, streaming results back to the client.

func (*Client) Version

func (c *Client) Version(ctx context.Context) (*version.Version, error)

Version gets server-side version information from draftd

type ClientConfig

type ClientConfig struct {
	ServerAddr string
	ServerHost string
	Stdout     io.Writer
	Stderr     io.Writer
	UseTLS     bool
	TLSConfig  *tls.Config
}

ClientConfig stores information about the draft server and where to send messages

and errors out

type DockerAuth

type DockerAuth map[string]RegistryAuth

DockerAuth is a container for the registry authentication credentials wrapped by the registry server name.

type RegistryAuth

type RegistryAuth struct {
	Username      string `json:"username"`
	Password      string `json:"password"`
	Email         string `json:"email"`
	RegistryToken string `json:"registrytoken"`
}

RegistryAuth is the registry authentication credentials

type RegistryConfig

type RegistryConfig struct {
	// Auth is the authorization token used to push images up to the registry.
	Auth string
	// URL is the URL of the registry (e.g. quay.io/myuser, docker.io/myuser, myregistry.azurecr.io)
	URL string
}

RegistryConfig specifies configuration for the image repository.

type Server

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

Server is a draft Server.

func NewServer

func NewServer(cfg *ServerConfig) *Server

NewServer returns a draft.Server initialized with the provided configuration.

func (*Server) Serve

func (s *Server) Serve(ctx context.Context) error

Serve starts draftd

func (*Server) Up

func (s *Server) Up(ctx context.Context, req *rpc.UpRequest) <-chan *rpc.UpSummary

Up handles incoming draft up requests and returns a stream of summaries or error.

Up implements rpc.UpHandler

type ServerConfig

type ServerConfig struct {
	ListenAddr     string
	IngressEnabled bool
	Basedomain     string // Basedomain is the basedomain used to construct the ingress rules
	Registry       *RegistryConfig
	Docker         *docker.Client
	Helm           helm.Interface
	Kube           k8s.Interface
	UseTLS         bool
	TLSConfig      *tls.Config
	Storage        storage.Store
}

ServerConfig specifies draft.Server configuration.