server

Documentation

Index

• Variables
• func New(e *empire.Empire, options Options) http.Handler
• func NewAuthorizer(clientID, clientSecret, organization string, apiURL string) authorization.Authorizer
• type HealthHandler
  • func NewHealthHandler(e *empire.Empire) *HealthHandler
  • func (h *HealthHandler) ServeHTTPContext(_ context.Context, w http.ResponseWriter, r *http.Request) error
• type Options

Variables

var (
	DefaultOptions = Options{}

	// DefaultGitHubScopes is the default oauth scopes to obtain when getting an
	// authorization from GitHub.
	DefaultGitHubScopes = []string{
		"repo_deployment",
		"read:org",
	}
)

Functions

func New

func New(e *empire.Empire, options Options) http.Handler

func NewAuthorizer

func NewAuthorizer(clientID, clientSecret, organization string, apiURL string) authorization.Authorizer

NewAuthorizer returns a new Authorizer. If the client id is present, it will return a real Authorizer that talks to GitHub. If an empty string is provided, then it will just return a fake authorizer.

Types

type HealthHandler

type HealthHandler struct {
	// A function that returns true if empire is healthy.
	IsHealthy func() bool
}

HealthHandler is an http.Handler that returns the health of empire.

func NewHealthHandler

func NewHealthHandler(e *empire.Empire) *HealthHandler

NewHealthHandler returns a new HealthHandler using the IsHealthy method from an Empire instance.

func (*HealthHandler) ServeHTTPContext

func (h *HealthHandler) ServeHTTPContext(_ context.Context, w http.ResponseWriter, r *http.Request) error

type Options

type Options struct {
	GitHub struct {
		ClientID     string
		ClientSecret string
		Organization string
		ApiURL       string

		// Deployments
		Webhooks struct {
			Secret string
		}
		Deployments struct {
			Environment   string
			ImageTemplate string
			TugboatURL    string
		}
	}
}