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)

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"
)

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 (
	OperatorRollingUpdateMaxUnavailable = "RADIXOPERATOR_APP_ROLLING_UPDATE_MAX_UNAVAILABLE"
	OperatorRollingUpdateMaxSurge       = "RADIXOPERATOR_APP_ROLLING_UPDATE_MAX_SURGE"
)

Environment variables that define default rolling update parameters for containers

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