prow

Documentation

Index

• Variables
• type Client
  • func New(endpoint *url.URL, client *http.Client) *Client
  • func NewFromString(endpoint string, client *http.Client) (*Client, error)
  • func (c Client) Up(appName, namespace string, out io.Writer, ...) error
  • func (c Client) UpFromDir(appName, namespace string, out io.Writer, appDir string, rawVals []byte) error
  • func (c *Client) Version() (*version.Version, error)

Variables

var (
	// ErrChartNotExist is returned when no chart/ directory exists during "prow up."
	ErrChartNotExist = errors.New("chart/ does not exist. Please create it using 'prow create' before calling 'prow up'")
	// ErrDockerfileNotExist is returned when no Dockerfile exists during "prow up."
	ErrDockerfileNotExist = errors.New("Dockerfile does not exist. Please create it using 'prow create' before calling 'prow up'")
)

Types

type Client

type Client struct {
	HTTPClient *http.Client
	Endpoint   *url.URL
	// OptionWait specifies whether or not to wait for all resources to be ready on `prow up`
	OptionWait bool
}

Client manages client side of the prow-prowd protocol. It wraps an *http.Client with a url Endpoint and common headers to send on every request.

func New

func New(endpoint *url.URL, client *http.Client) *Client

New returns a new Client with a given a URL and an optional client.

func NewFromString

func NewFromString(endpoint string, client *http.Client) (*Client, error)

NewFromString returns a new Client given a string URL and an optional client.

func (Client) Up

func (c Client) Up(appName, namespace string, out io.Writer, buildContext, chartReader io.ReadCloser, rawVals []byte) error

Up uploads the build context and chart to prowd, then writes messages from prowd to out. appName specifies the Helm release to create/update, and namespace specifies which namespace to deploy the application into.

func (Client) UpFromDir

func (c Client) UpFromDir(appName, namespace string, out io.Writer, appDir string, rawVals []byte) error

UpFromDir prepares the contents of appDir to create a build context and chart archive, then calls Up().

func (*Client) Version

func (c *Client) Version() (*version.Version, error)

Version returns the server version.