config

Documentation

Index

• type CacheSyncConfig
• type Config
• type EventHandlerConfig
• type FrontendDeployerConfig
• type HealthCheckerConfig
• type NotificationsConfig
• type ProviderDeploymentCLI
• type SyncConfig
• type TargetGroupGranterConfig

Types

type CacheSyncConfig

type CacheSyncConfig struct {
	TableName        string `env:"COMMONFATE_TABLE_NAME,required"`
	LogLevel         string `env:"LOG_LEVEL,default=info"`
	Region           string `env:"AWS_REGION,required"`
	AccessHandlerURL string `env:"COMMONFATE_ACCESS_HANDLER_URL,default=http://0.0.0.0:9092"`
}

type Config

type Config struct {
	Host              string `env:"COMMONFATE_HOST,default=0.0.0.0:8080"`
	LogLevel          string `env:"LOG_LEVEL,default=info"`
	DynamoTable       string `env:"COMMONFATE_TABLE_NAME,required"`
	CognitoUserPoolID string `env:"COMMONFATE_COGNITO_USER_POOL_ID,required"`
	Region            string `env:"AWS_REGION,required"`
	AdminGroup        string `env:"COMMONFATE_ADMIN_GROUP,required"`
	FrontendURL       string `env:"COMMONFATE_FRONTEND_URL,required"`
	AccessHandlerURL  string `env:"COMMONFATE_ACCESS_HANDLER_URL,default=http://0.0.0.0:9092"`
	GovernanceURL     string `env:"COMMONFATE_GOVERNANCE_URL,default=0.0.0.0:8889"`
	RunAccessHandler  bool   `env:"COMMONFATE_RUN_ACCESS_HANDLER,default=true"`
	MockAccessHandler bool   `env:"COMMONFATE_MOCK_ACCESS_HANDLER,default=false"`
	SentryDSN         string `env:"COMMONFATE_SENTRY_DSN"`
	EventBusArn       string `env:"COMMONFATE_EVENT_BUS_ARN,required"`
	EventBusSource    string `env:"COMMONFATE_EVENT_BUS_SOURCE,required"`
	IdpProvider       string `env:"COMMONFATE_IDENTITY_PROVIDER,required"`
	DeploymentSuffix  string `env:"COMMONFATE_DEPLOYMENT_SUFFIX"`
	// This should be an instance of deploy.FeatureMap which is a specific json format for this
	// Use deploy.UnmarshalFeatureMap to unmarshal this data into a FeatureMap
	IdentitySettings              string `env:"COMMONFATE_IDENTITY_SETTINGS,default={}"`
	PaginationKMSKeyARN           string `env:"COMMONFATE_PAGINATION_KMS_KEY_ARN,required"`
	AccessHandlerExecutionRoleARN string `env:"COMMONFATE_ACCESS_HANDLER_EXECUTION_ROLE_ARN,required"`
	RemoteConfigURL               string `env:"COMMONFATE_ACCESS_REMOTE_CONFIG_URL"`
	RemoteConfigHeaders           string `env:"COMMONFATE_REMOTE_CONFIG_HEADERS"`
	// a regex string that is used to filter the identity groups that are returned from the IDP
	IdentityGroupFilter   string `env:"COMMONFATE_IDENTITY_GROUP_FILTER"`
	NoAuthEmail           string `env:"NO_AUTH_EMAIL"`
	StateMachineARN       string `env:"COMMONFATE_GRANTER_V2_STATE_MACHINE_ARN"`
	AutoApprovalLambdaArn string `env:"COMMONFATE_AUTO_APPROVAL_LAMBDA_ARN"`
}

type EventHandlerConfig

type EventHandlerConfig struct {
	LogLevel    string `env:"LOG_LEVEL,default=info"`
	DynamoTable string `env:"COMMONFATE_TABLE_NAME,required"`
}

type FrontendDeployerConfig

type FrontendDeployerConfig struct {
	LogLevel                             string `env:"LOG_LEVEL,default=info"`
	Region                               string `env:"AWS_REGION,required"`
	CFReleasesBucket                     string `env:"CF_RELEASES_BUCKET,required"`
	CFReleasesFrontendAssetsObjectPrefix string `env:"CF_RELEASES_FRONTEND_ASSET_OBJECT_PREFIX,required"`
	FrontendBucket                       string `env:"COMMONFATE_FRONTEND_BUCKET,required"`
	UserPoolID                           string `env:"COMMONFATE_COGNITO_USER_POOL_ID,required"`
	CognitoClientID                      string `env:"COMMONFATE_COGNITO_CLIENT_ID,required"`
	UserPoolDomain                       string `env:"COMMONFATE_USER_POOL_DOMAIN,required"`
	FrontendDomain                       string `env:"COMMONFATE_FRONTEND_DOMAIN,required"`
	CloudFrontDistributionID             string `env:"COMMONFATE_CLOUDFRONT_DISTRIBUTION_ID,required"`
	APIURL                               string `env:"COMMONFATE_API_URL,required"`
	CLIAppClientID                       string `env:"COMMONFATE_CLI_CLIENT_ID,required"`
}

type HealthCheckerConfig

type HealthCheckerConfig struct {
	TableName string `env:"COMMONFATE_TABLE_NAME,required"`
	LogLevel  string `env:"LOG_LEVEL,default=info"`
	Region    string `env:"AWS_REGION,required"`
}

type NotificationsConfig

type NotificationsConfig struct {
	LogLevel    string `env:"LOG_LEVEL,default=info"`
	DynamoTable string `env:"COMMONFATE_TABLE_NAME,required"`
	FrontendURL string `env:"COMMONFATE_FRONTEND_URL,required"`
	// This should be an instance of deploy.FeatureMap which is a specific json format for this
	// Use deploy.UnmarshalFeatureMap to unmarshal this data into a FeatureMap
	NotificationsConfig string `env:"COMMONFATE_NOTIFICATIONS_SETTINGS,default={}"`
	RemoteConfigURL     string `env:"COMMONFATE_ACCESS_REMOTE_CONFIG_URL"`
	RemoteConfigHeaders string `env:"COMMONFATE_REMOTE_CONFIG_HEADERS"`
}

type ProviderDeploymentCLI

type ProviderDeploymentCLI struct {
	LogLevel         string `env:"COMMONFATE_LOG_LEVEL,default=info"`
	Host             string `env:"COMMONFATE_CLI_HOST,default=0.0.0.0:9000"`
	LocalFrontendURL string `env:"COMMONFATE_CLI_LOCAL_FRONTEND_URL,default=http://localhost:9000"`
	Debug            bool   `env:"COMMONFATE_CLI_DEBUG"`
	CommonFateAPIURL string `env:"COMMONFATE_HOST,default=http://0.0.0.0:8080"`
}

type SyncConfig

type SyncConfig struct {
	TableName   string `env:"COMMONFATE_TABLE_NAME,required"`
	IdpProvider string `env:"COMMONFATE_IDENTITY_PROVIDER,required"`
	UserPoolId  string `env:"COMMONFATE_COGNITO_USER_POOL_ID,required"`
	LogLevel    string `env:"LOG_LEVEL,default=info"`
	// This should be an instance of deploy.FeatureMap which is a specific json format for this
	// Use deploy.UnmarshalFeatureMap to unmarshal this data into a FeatureMap
	IdentitySettings    string `env:"COMMONFATE_IDENTITY_SETTINGS,default={}"`
	IdentityGroupFilter string `env:"COMMONFATE_IDENTITY_GROUP_FILTER"`
}

type TargetGroupGranterConfig

type TargetGroupGranterConfig struct {
	LogLevel       string `env:"LOG_LEVEL,default=info"`
	EventBusArn    string `env:"COMMONFATE_EVENT_BUS_ARN"`
	EventBusSource string `env:"COMMONFATE_EVENT_BUS_SOURCE"`
	DynamoTable    string `env:"COMMONFATE_TABLE_NAME,required"`
}