constants

Documentation

Index

• Constants
• Variables
• func ManagedFinalizers() []string
• func Namespace() (string, bool)
• func NamespaceWithDefault(def string) string
• func NewProfileIntegration(name, version string) (string, string)
• func NewProfileIntegrationFeature(name, feature string) string
• type Version
  • func (v Version) Is(other Version) bool
  • func (v Version) IsCompatible(other Version) bool
  • func (v Version) IsV1Compatible() bool
  • func (v Version) IsV2Compatible() bool
  • func (v Version) String() string

Constants

const (
	ArangoDBExitCodeInvalidArgument         = 3
	ArangoDBExitCodeUpgradeRequired         = 11
	ArangoDBExitCodeUpgradeFailedCompaction = 30

	ContainerExitCodeSegmentationFault = 139
)

const (
	ArangoHeaderAsyncIDKey = "x-arango-async-id"
	ArangoHeaderAsyncKey   = "x-arango-async"
	ArangoHeaderAsyncValue = "store"
)

const (
	EnvOperatorNodeName       = "MY_NODE_NAME"
	EnvOperatorNodeNameArango = "NODE_NAME"
	EnvOperatorPodName        = "MY_POD_NAME"
	EnvOperatorPodNamespace   = "MY_POD_NAMESPACE"
	EnvOperatorCoreContainer  = "MY_POD_CORE_CONTAINER"
	EnvOperatorPodIP          = "MY_POD_IP"

	EnvOperatorNodeNameEnv       util.EnvironmentVariable = EnvOperatorNodeName
	EnvOperatorNodeNameArangoEnv util.EnvironmentVariable = EnvOperatorNodeNameArango
	EnvOperatorPodNameEnv        util.EnvironmentVariable = EnvOperatorPodName
	EnvOperatorPodNamespaceEnv   util.EnvironmentVariable = EnvOperatorPodNamespace
	EnvOperatorCoreContainerEnv  util.EnvironmentVariable = EnvOperatorCoreContainer
	EnvOperatorPodIPEnv          util.EnvironmentVariable = EnvOperatorPodIP

	EnvArangoJobSAName = "ARANGOJOB_SA_NAME"

	PathMountServiceAccount          = "/var/run/secrets/kubernetes.io/serviceaccount"
	PathMountServiceAccountNamespace = PathMountServiceAccount + "/namespace"

	EnvArangoLicenseKey          = "ARANGO_LICENSE_KEY"          // Contains the License Key for the Docker Image
	EnvArangoSyncMonitoringToken = "ARANGOSYNC_MONITORING_TOKEN" // Constains monitoring token for ArangoSync servers

	SecretEncryptionKey = "key"        // Key in a Secret.Data used to store an 32-byte encryption key
	SecretKeyToken      = "token"      // Key inside a Secret used to hold a JWT or monitoring token
	SecretKeyV2Token    = "token-v2"   // Key inside a Secret used to hold a License in V2 Format
	SecretKeyV2License  = "license-v2" // Key inside a Secret used to hold a License in V2 Format

	SecretCACertificate = "ca.crt" // Key in Secret.data used to store a PEM encoded CA certificate (public key)
	SecretCAKey         = "ca.key" // Key in Secret.data used to store a PEM encoded CA private key

	SecretTLSKeyfile = "tls.keyfile" // Key in Secret.data used to store a PEM encoded TLS certificate in the format used by ArangoDB (`--ssl.keyfile`)

	SecretUsername = "username" // Key in Secret.data used to store a username used for basic authentication
	SecretPassword = "password" // Key in Secret.data used to store a password used for basic authentication

	SecretCredentialsAccessKey = "accessKey" // Key in Secret used to store an S3 API access key
	SecretCredentialsSecretKey = "secretKey" // Key in Secret used to store an S3 API secret key

	SecretCredentialsServiceAccount = "serviceAccount" // Key in Secret used to store an GCS ServiceAccount File

	SecretAccessPackageYaml = "accessPackage.yaml" // Key in Secret.data used to store a YAML encoded access package

	FinalizerDeplRemoveChildFinalizers = "database.arangodb.com/remove-child-finalizers" // Finalizer added to ArangoDeployment, indicating the need to remove finalizers from all children
	FinalizerDeplReplStopSync          = "replication.database.arangodb.com/stop-sync"   // Finalizer added to ArangoDeploymentReplication, indicating the need to stop synchronization
	FinalizerPodAgencyServing          = "agent.database.arangodb.com/agency-serving"    // Finalizer added to Agents, indicating the need for keeping enough agents alive
	FinalizerPodDrainDBServer          = "dbserver.database.arangodb.com/drain"          // Finalizer added to DBServers, indicating the need for draining that dbserver
	FinalizerPodGracefulShutdown       = "database.arangodb.com/graceful-shutdown"       // Finalizer added to All members, indicating the need for graceful shutdown
	FinalizerPVCMemberExists           = "pvc.database.arangodb.com/member-exists"       // Finalizer added to PVCs, indicating the need to keep is as long as its member exists
	FinalizerDelayPodTermination       = "pod.database.arangodb.com/delay"               // Finalizer added to Pod, delays termination

	AnnotationShutdownManagedContainer      = "shutdown.arangodb.com/managed"
	AnnotationShutdownContainer             = "container.shutdown.arangodb.com"
	AnnotationShutdownCoreContainer         = "core.shutdown.arangodb.com"
	AnnotationShutdownCoreContainerModeWait = "wait"

	AnnotationEnforceAntiAffinity = "database.arangodb.com/enforce-anti-affinity" // Key of annotation added to PVC. Value is a boolean "true" or "false"

	BackupLabelRole      = "backup/role"
	MLLabelRole          = "ml/role"
	AnalyticsLabelRole   = "analytics/role"
	NetworkingLabelRole  = "networking/role"
	PlatformLabelRole    = "platform/role"
	SchedulerLabelRole   = "scheduler/role"
	AppsLabelRole        = "apps/role"
	ClusterSyncLabelRole = "clustersync/role"
	LabelRole            = "role"
	LabelRoleLeader      = "leader"
)

const (
	EnvoyRouteHeader = "arangodb-platform-route"

	EnvoyInventoryConfigDestination = "/_inventory"
	EnvoyIdentityDestination        = "/_identity"
	EnvoyLoginDestination           = "/_login"
	EnvoyLogoutDestination          = "/_logout"

	EnvoyIntegrationSidecarFilterName = "envoy.filters.http.ext_authz"

	EnvoyIntegrationSidecarCluster = "integration_sidecar"

	EnvoyIntegrationSidecarClusterHTTP = "integration_sidecar_http"
)

const (
	DefaultEnvoyUpstreamTimeout = time.Minute
	MaxEnvoyUpstreamTimeout     = time.Hour
	MinEnvoyUpstreamTimeout     = time.Duration(0)

	ConfigMapChecksumKey = "CHECKSUM"

	ArangoGatewayExecutor = "/usr/local/bin/envoy"

	GatewayConfigChecksum    = "gateway.checksum"
	GatewayConfigFileName    = "gateway.yaml"
	GatewayConfigChecksumENV = "GATEWAY_CONFIG_CHECKSUM"

	GatewayVolumeMountDir = "/etc/gateway/core/"
	GatewayVolumeName     = "gateway"

	GatewayLDSVolumeMountDir = "/etc/gateway/lds/"
	GatewayLDSVolumeName     = "gateway-lds"

	GatewayCDSVolumeMountDir = "/etc/gateway/cds/"
	GatewayCDSVolumeName     = "gateway-cds"

	MemberConfigVolumeMountDir = "/etc/gateway/member/"
	MemberConfigVolumeName     = "member-config"

	MemberAuthVolumeMountDir = "/etc/gateway/auth/"
	MemberAuthVolumeName     = "member-auth"
)

const (
	HelmLabelBase             = "platform.arangodb.com"
	HelmLabelInstallationBase = "installation." + HelmLabelBase

	HelmLabelArangoDBManaged = HelmLabelInstallationBase + "/managed"

	HelmLabelArangoDBChart = HelmLabelInstallationBase + "/chart"

	HelmLabelArangoDBDeployment = HelmLabelInstallationBase + "/deployment"

	HelmLabelArangoDBService = HelmLabelInstallationBase + "/service"

	// HelmLabelArangoDBType set to platform or service
	HelmLabelArangoDBType = HelmLabelInstallationBase + "/type"

	HelmLabelTag = HelmLabelBase + "/tag"
)

const (
	ProfilesIntegrationAuthn    = "authn"
	ProfilesIntegrationAuthz    = "authz"
	ProfilesIntegrationSched    = "sched"
	ProfilesIntegrationEnvoy    = "envoy"
	ProfilesIntegrationStorage  = "storage"
	ProfilesIntegrationShutdown = "shutdown"
	ProfilesIntegrationMeta     = "meta"
)

const (
	ProfilesIntegrationV0 = "v0"
	ProfilesIntegrationV1 = "v1"
	ProfilesIntegrationV2 = "v2"
	ProfilesIntegrationV3 = "v3"
)

const (
	MyContainerNameEnv util.EnvironmentVariable = "MY_CONTAINER_NAME"
)

const ProfileGroup = "profiles.arangodb.com"

const ProfilesAnnotationApplied = ProfileGroup + "/applied"

const ProfilesAnnotationChecksum = ProfileGroup + "/checksum"

const ProfilesAnnotationProfiles = ProfileGroup + "/profiles"

const ProfilesApplyLabel = ProfileGroup + "/apply"

const ProfilesDeployment = ProfileGroup + "/deployment"

const (
	ProfilesExtensionEnabled = "enabled"
)

const ProfilesIntegrationPrefix = "integration." + ProfileGroup

const ProfilesList = ProfileGroup + "/profiles"

const (
	RecentTerminationsKeepPeriod = time.Minute * 30
)

Variables

var INTEGRATION_SERVICE_ADDRESS util.EnvironmentVariable = "INTEGRATION_SERVICE_ADDRESS"

Functions

func ManagedFinalizers

func ManagedFinalizers() []string

func Namespace

func Namespace() (string, bool)

func NamespaceWithDefault

func NamespaceWithDefault(def string) string

func NewProfileIntegration

func NewProfileIntegration(name, version string) (string, string)

func NewProfileIntegrationFeature

func NewProfileIntegrationFeature(name, feature string) string

Types

type Version

type Version string

const (
	VersionV1Alpha1 Version = "v1alpha1"
	VersionV1Beta1  Version = "v1beta1"
	VersionV1       Version = "v1"

	VersionV2Alpha1 Version = "v2alpha1"
)

func (Version) Is

func (v Version) Is(other Version) bool

func (Version) IsCompatible

func (v Version) IsCompatible(other Version) bool

func (Version) IsV1Compatible

func (v Version) IsV1Compatible() bool

func (Version) IsV2Compatible

func (v Version) IsV2Compatible() bool

func (Version) String

func (v Version) String() string