admin

Documentation

Index

• func AdminCmd(ch *cmdutil.Helper) *cobra.Command
• func PingCmd(ch *cmdutil.Helper) *cobra.Command
• func StartCmd(ch *cmdutil.Helper) *cobra.Command
• func SwitchCmd(ch *cmdutil.Helper) *cobra.Command
• type Config

Functions

func AdminCmd

func AdminCmd(ch *cmdutil.Helper) *cobra.Command

AdminCmd represents the admin command

func PingCmd

func PingCmd(ch *cmdutil.Helper) *cobra.Command

func StartCmd

func StartCmd(ch *cmdutil.Helper) *cobra.Command

StartCmd starts an admin server. It only allows configuration using environment variables.

func SwitchCmd

func SwitchCmd(ch *cmdutil.Helper) *cobra.Command

Types

type Config

type Config struct {
	DatabaseDriver           string                 `default:"postgres" split_words:"true"`
	DatabaseURL              string                 `split_words:"true"`
	Jobs                     []string               `split_words:"true"`
	HTTPPort                 int                    `default:"8080" split_words:"true"`
	GRPCPort                 int                    `default:"9090" split_words:"true"`
	DebugPort                int                    `split_words:"true"`
	LogLevel                 zapcore.Level          `default:"info" split_words:"true"`
	MetricsExporter          observability.Exporter `default:"prometheus" split_words:"true"`
	TracesExporter           observability.Exporter `default:"" split_words:"true"`
	ExternalURL              string                 `default:"http://localhost:8080" split_words:"true"`
	ExternalGRPCURL          string                 `envconfig:"external_grpc_url"`
	FrontendURL              string                 `default:"http://localhost:3000" split_words:"true"`
	SessionKeyPairs          []string               `split_words:"true"`
	AllowedOrigins           []string               `default:"*" split_words:"true"`
	AuthDomain               string                 `split_words:"true"`
	AuthClientID             string                 `split_words:"true"`
	AuthClientSecret         string                 `split_words:"true"`
	GithubAppID              int64                  `split_words:"true"`
	GithubAppName            string                 `split_words:"true"`
	GithubAppPrivateKey      string                 `split_words:"true"`
	GithubAppWebhookSecret   string                 `split_words:"true"`
	GithubClientID           string                 `split_words:"true"`
	GithubClientSecret       string                 `split_words:"true"`
	ProvisionerSpec          string                 `split_words:"true"`
	SigningJWKS              string                 `split_words:"true"`
	SigningKeyID             string                 `split_words:"true"`
	EmailSMTPHost            string                 `split_words:"true"`
	EmailSMTPPort            int                    `split_words:"true"`
	EmailSMTPUsername        string                 `split_words:"true"`
	EmailSMTPPassword        string                 `split_words:"true"`
	EmailSenderEmail         string                 `split_words:"true"`
	EmailSenderName          string                 `split_words:"true"`
	EmailBCC                 string                 `split_words:"true"`
	RedisURL                 string                 `default:"" split_words:"true"`
	ActivitySinkType         string                 `default:"" split_words:"true"`
	ActivitySinkPeriodMs     int                    `default:"1000" split_words:"true"`
	ActivityMaxBufferSize    int                    `default:"1000" split_words:"true"`
	ActivitySinkKafkaBrokers string                 `default:"" split_words:"true"`
	ActivityUISinkKafkaTopic string                 `default:"" split_words:"true"`
}

Config describes admin server config derived from environment variables. Env var keys must be prefixed with RILL_ADMIN_ and are converted from snake_case to CamelCase. For example RILL_ADMIN_HTTP_PORT is mapped to Config.HTTPPort.