external

Documentation

Index

• Constants
• type Server
  • func NewServer(cfg ServerConfig, cl client.Client) Server
• type ServerConfig
  • func ServerConfigFromEnv() ServerConfig
• type StandardConfig
• type TLSConfig
  • func TLSConfigFromEnv() TLSConfig
• type WebhookReceiver
  • func NewReceiver(ctx context.Context, c client.Client, baseURL string, project string, ...) (WebhookReceiver, error)

Constants

const (
	GithubSecretDataKey = "secret"
)

Types

type Server

type Server interface {
	Serve(ctx context.Context, l net.Listener) error
}

func NewServer

func NewServer(cfg ServerConfig, cl client.Client) Server

type ServerConfig

type ServerConfig struct {
	StandardConfig
	TLSConfig               *TLSConfig
	BaseURL                 string
	ClusterSecretsNamespace string
}

func ServerConfigFromEnv

func ServerConfigFromEnv() ServerConfig

type StandardConfig

type StandardConfig struct {
	GracefulShutdownTimeout time.Duration `envconfig:"GRACEFUL_SHUTDOWN_TIMEOUT" default:"30s"`
}

type TLSConfig

type TLSConfig struct {
	CertPath string `envconfig:"TLS_CERT_PATH" required:"true"`
	KeyPath  string `envconfig:"TLS_KEY_PATH" required:"true"`
}

func TLSConfigFromEnv

func TLSConfigFromEnv() TLSConfig

type WebhookReceiver

type WebhookReceiver interface {

	// GetDetails returns the details of the WebhookReceiver in the form of
	// kargoapi.WebhookReceiverDetails.
	GetDetails() kargoapi.WebhookReceiverDetails
	// contains filtered or unexported methods
}

WebhookReceiver is an interface for components that handle inbound webhooks.

func NewReceiver

func NewReceiver(
	ctx context.Context,
	c client.Client,
	baseURL string,
	project string,
	secretsNamespace string,
	cfg kargoapi.WebhookReceiverConfig,
) (WebhookReceiver, error)

NewReceiver returns an appropriate implementation of WebhookReceiver based on the provided kargoapi.WebhookReceiverConfig.