install

Documentation

Index

• func BootstrapConfigRevision(platform PlatformConfig, shared SharedComputeConfig) string
• func ReadManifest(name string) ([]byte, error)
• func RenderManifest(name string, vals TemplateValues) ([]byte, error)
• type PlatformConfig
  • func (c PlatformConfig) Enabled() bool
• type SharedComputeConfig
  • func (c SharedComputeConfig) IsSet() bool
• type TemplateValues

Functions

func BootstrapConfigRevision

func BootstrapConfigRevision(platform PlatformConfig, shared SharedComputeConfig) string

BootstrapConfigRevision changes when a pod restart is required to load updated Secret-backed bootstrap configuration. It reveals none of the stored credentials.

func ReadManifest

func ReadManifest(name string) ([]byte, error)

func RenderManifest

func RenderManifest(name string, vals TemplateValues) ([]byte, error)

Types

type PlatformConfig

type PlatformConfig struct {
	BaseDomain         string
	TLSEnabled         bool
	CloudflareAPIToken string
	ACMEEnvironment    string
}

func (PlatformConfig) Enabled

func (c PlatformConfig) Enabled() bool

type SharedComputeConfig

type SharedComputeConfig struct {
	ClusterAPIURL string
	ClusterCAData string
	ClusterToken  string
}

func (SharedComputeConfig) IsSet

func (c SharedComputeConfig) IsSet() bool

type TemplateValues

type TemplateValues struct {
	DBPassword     string
	JWTSecret      string
	EncryptionKey  string
	AdminEmail     string
	AdminPassword  string
	Domain         string
	APIServerImage string
	DBWorkloadType string
	StackUID       string
	TLSEnabled     bool
	Platform       PlatformConfig
	SharedCompute  SharedComputeConfig
	// GitHub OAuth login credentials; empty leaves login disabled.
	GitHubClientID     string
	GitHubClientSecret string
	// Platform-wide GitHub App; empty leaves each org creating its own.
	GitHubAppID            string
	GitHubAppSlug          string
	GitHubAppPrivateKey    string
	GitHubAppWebhookSecret string
}