defaults

Documentation

Index

• Constants
• func GetDefaultCPULimit() *resource.Quantity
• func GetDefaultCPURequest() *resource.Quantity
• func GetDefaultMemoryLimit() *resource.Quantity
• func GetDefaultMemoryRequest() *resource.Quantity
• func GetDefaultReadinessProbeInitialDelaySeconds() (int32, error)
• func GetDefaultReadinessProbePeriodSeconds() (int32, error)
• func GetDefaultRollingUpdateMaxSurge() (string, error)
• func GetDefaultRollingUpdateMaxUnavailable() (string, error)
• func GetMachineUserRoleName(appName string) string

Constants

const (
	// OperatorDNSZoneEnvironmentVariable The DNS zone used fro creating ingress of the cluster
	OperatorDNSZoneEnvironmentVariable = "DNS_ZONE"

	// OperatorAppAliasBaseURLEnvironmentVariable The base url for any app alias of the cluster
	OperatorAppAliasBaseURLEnvironmentVariable = "APP_ALIAS_BASE_URL"

	// OperatorClusterTypeEnvironmentVariable The type of cluster dev|playground|prod
	OperatorClusterTypeEnvironmentVariable = "RADIXOPERATOR_CLUSTER_TYPE"

	// DeploymentsHistoryLimitEnvironmentVariable Controls the number of RDs we can have in a environment
	DeploymentsHistoryLimitEnvironmentVariable = "RADIX_DEPLOYMENTS_PER_ENVIRONMENT_HISTORY_LIMIT"

	// JobsHistoryLimitEnvironmentVariable Controls the number of RJs we can have in a app namespace
	JobsHistoryLimitEnvironmentVariable = "RADIX_JOBS_PER_APP_HISTORY_LIMIT"

	// ClusternameEnvironmentVariable The name of the cluster
	ClusternameEnvironmentVariable = "RADIX_CLUSTERNAME"

	// ContainerRegistryEnvironmentVariable The name of the container registry
	ContainerRegistryEnvironmentVariable = "RADIX_CONTAINER_REGISTRY"

	// EnvironmentnameEnvironmentVariable The name of the environment for the application
	EnvironmentnameEnvironmentVariable = "RADIX_ENVIRONMENT"

	// PublicEndpointEnvironmentVariable The environment variable holding the public endpoint of the component
	PublicEndpointEnvironmentVariable = "RADIX_PUBLIC_DOMAIN_NAME"

	// CanonicalEndpointEnvironmentVariable Variable to hold the cluster spcific ingress
	CanonicalEndpointEnvironmentVariable = "RADIX_CANONICAL_DOMAIN_NAME"

	// RadixAppEnvironmentVariable The environment variable holding the name of the app
	RadixAppEnvironmentVariable = "RADIX_APP"

	// RadixComponentEnvironmentVariable The environment variable holding the name of the component
	RadixComponentEnvironmentVariable = "RADIX_COMPONENT"

	// RadixPortsEnvironmentVariable The environment variable holding the available ports of the component
	RadixPortsEnvironmentVariable = "RADIX_PORTS"

	// RadixPortNamesEnvironmentVariable The environment variable holding the available port names of the component
	RadixPortNamesEnvironmentVariable = "RADIX_PORT_NAMES"

	// RadixDNSZoneEnvironmentVariable The environment variable on a radix app giving the dns zone. Will be equal to OperatorDNSZoneEnvironmentVariable
	RadixDNSZoneEnvironmentVariable = "RADIX_DNS_ZONE"

	// RadixClusterTypeEnvironmentVariable The type of cluster dev|playground|prod. Will be equal to OperatorClusterTypeEnvironmentVariable
	RadixClusterTypeEnvironmentVariable = "RADIX_CLUSTER_TYPE"

	// ActiveClusternameEnvironmentVariable The name of the active cluster. If ActiveClusternameEnvironmentVariable == ClusternameEnvironmentVariable, this is the active cluster
	ActiveClusternameEnvironmentVariable = "RADIX_ACTIVE_CLUSTERNAME"

	// RadixCommitHashEnvironmentVariable Contains the commit id of the build
	RadixCommitHashEnvironmentVariable = "RADIX_GIT_COMMIT_HASH"

	// RadixRestartEnvironmentVariable Environment variable to indicate that a restart was triggered
	RadixRestartEnvironmentVariable = "RADIX_RESTART_TRIGGERED"

	// RadixConfigToMapEnvironmentVariable Points to the utility image for copying config file to map
	RadixConfigToMapEnvironmentVariable = "RADIX_CONFIG_TO_MAP"

	// RadixImageBuilderEnvironmentVariable Points to the image builder
	RadixImageBuilderEnvironmentVariable = "RADIX_IMAGE_BUILDER"

	// RadixImageScannerEnvironmentVariable Points to the image scanner
	RadixImageScannerEnvironmentVariable = "RADIX_IMAGE_SCANNER"
)

const (
	OperatorReadinessProbeInitialDelaySeconds = "RADIXOPERATOR_APP_READINESS_PROBE_INITIAL_DELAY_SECONDS"
	OperatorReadinessProbePeriodSeconds       = "RADIXOPERATOR_APP_READINESS_PROBE_PERIOD_SECONDS"
)

Environment variables that define default readiness probe parameters for containers

const (
	OperatorEnvLimitDefaultMemoryEnvironmentVariable        = "RADIXOPERATOR_APP_ENV_LIMITS_DEFAULT_MEMORY"
	OperatorEnvLimitDefaultCPUEnvironmentVariable           = "RADIXOPERATOR_APP_ENV_LIMITS_DEFAULT_CPU"
	OperatorEnvLimitDefaultRequestMemoryEnvironmentVariable = "RADIXOPERATOR_APP_ENV_LIMITS_DEFAULT_REQUEST_MEMORY"
	OperatorEnvLimitDefaultReqestCPUEnvironmentVariable     = "RADIXOPERATOR_APP_ENV_LIMITS_DEFAULT_REQUEST_CPU"
)

Environment variables that define default resources (limits and requests) for containers and environments See https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/memory-default-namespace/

const (
	// RadixGithubWebhookRoleName Name of the service account representing the webhook
	RadixGithubWebhookRoleName = "radix-github-webhook"

	// RadixAPIRoleName Name of the service account representing the Radix API
	RadixAPIRoleName = "radix-api"

	// AppAdminRoleName Name of role which grants access to manage the CI/CD of their applications
	AppAdminRoleName = "radix-app-admin"

	// AppAdminEnvironmentRoleName Name of role which grants access to manage their running Radix applications
	AppAdminEnvironmentRoleName = "radix-app-admin-envs"

	// PipelineRoleName Role to update the radix config from repo and execute the outer pipeline
	PipelineRoleName = "radix-pipeline"

	// PipelineRunnerRoleName Give radix-pipeline service account inside app namespace access to creating namespaces and make deployments through radix-pipeline-runner clusterrole
	PipelineRunnerRoleName = "radix-pipeline-runner"

	// ConfigToMapRunnerRoleName Role (service account name) of user to apply radixconfig to configmap
	ConfigToMapRunnerRoleName = "radix-config-to-map-runner"

	// MachineUserPostfix Role (service account) of machine user will be <appName--machine-user> in default namespace
	MachineUserPostfix = "machine-user"

	// PlatformUserRoleName Name of platform user cluster role
	PlatformUserRoleName = "radix-platform-user"
)

const (
	OperatorRollingUpdateMaxUnavailable = "RADIXOPERATOR_APP_ROLLING_UPDATE_MAX_UNAVAILABLE"
	OperatorRollingUpdateMaxSurge       = "RADIXOPERATOR_APP_ROLLING_UPDATE_MAX_SURGE"
)

Environment variables that define default rolling update parameters for containers

const (
	// BuildSecretPrefix All build secrets will be mounted with this prefix
	BuildSecretPrefix = "BUILD_SECRET_"

	// BuildSecretsName Name of the secret in the app namespace holding all build secrets
	BuildSecretsName = "build-secrets"

	// BuildSecretDefaultData When the build secrets hold radix_undefined, it means they have not been set yet
	BuildSecretDefaultData = "radix_undefined"
)

const PrivateImageHubSecretName = "radix-private-image-hubs"

PrivateImageHubSecretName name of private image hub secret - contain secret with all private image hubs credentials for an app

Functions

func GetDefaultCPULimit

func GetDefaultCPULimit() *resource.Quantity

GetDefaultCPULimit Gets the default container CPU limit defined as an environment variable

func GetDefaultCPURequest

func GetDefaultCPURequest() *resource.Quantity

GetDefaultCPURequest Gets the default container CPU request defined as an environment variable

func GetDefaultMemoryLimit

func GetDefaultMemoryLimit() *resource.Quantity

GetDefaultMemoryLimit Gets the default container memory limit defined as an environment variable

func GetDefaultMemoryRequest

func GetDefaultMemoryRequest() *resource.Quantity

GetDefaultMemoryRequest Gets the default container memory request defined as an environment variable

func GetDefaultReadinessProbeInitialDelaySeconds

func GetDefaultReadinessProbeInitialDelaySeconds() (int32, error)

GetDefaultReadinessProbeInitialDelaySeconds Gets the default readiness probe initial delay seconds defined as an environment variable

func GetDefaultReadinessProbePeriodSeconds

func GetDefaultReadinessProbePeriodSeconds() (int32, error)

GetDefaultReadinessProbePeriodSeconds Gets the default readiness probe period seconds defined as an environment variable

func GetDefaultRollingUpdateMaxSurge

func GetDefaultRollingUpdateMaxSurge() (string, error)

GetDefaultRollingUpdateMaxSurge Gets the default rolling update max surge defined as an environment variable

func GetDefaultRollingUpdateMaxUnavailable

func GetDefaultRollingUpdateMaxUnavailable() (string, error)

GetDefaultRollingUpdateMaxUnavailable Gets the default rolling update max unavailable defined as an environment variable

func GetMachineUserRoleName

func GetMachineUserRoleName(appName string) string

GetMachineUserRoleName Gets the name of the machine user for an app