constants

Documentation

Index

• Constants
• Variables
• func DefaultTolerations() []v1.Toleration

Constants

const (
	AnnotationDebugOutput = "logging.openshift.io/debug-output"

	// AnnotationEnableCollectorAsDeployment is to enable deploying the collector as a deployment
	// instead of a daemonset to support the HCP use case of using the collector for collecting
	// audit logs via a webhook.
	AnnotationEnableCollectorAsDeployment = "logging.openshift.io/dev-preview-enable-collector-as-deployment"

	// AnnotationVectorLogLevel is used to set the log level of vector.
	// Log level can be one of: trace, debug, info, warn, error, off.
	// CLO's default log level for vector is `warn`: https://issues.redhat.com/browse/LOG-3435
	AnnotationVectorLogLevel = "observability.openshift.io/log-level"

	// AnnotationOtlpOutputTechPreview is used to enable tech-preview of OTLP output and LokiStack with Otel data model
	AnnotationOtlpOutputTechPreview = "observability.openshift.io/tech-preview-otlp-output"

	AnnotationSecretHash = "observability.openshift.io/secret-hash"
)

const (
	ClientCertKey      = "tls.crt"
	ClientPrivateKey   = "tls.key"
	TrustedCABundleKey = "ca-bundle.crt"
	Passphrase         = "passphrase"

	ClientUsername = "username"
	ClientPassword = "password"

	SharedKey                    = "shared_key"            // fluent forward
	AWSSecretAccessKey           = "aws_secret_access_key" //nolint:gosec
	AWSAccessKeyID               = "aws_access_key_id"
	AWSRoleSessionName           = "cluster-logging" // identifier for role logging session
	AWSCredentialsKey            = "credentials"     // credrequest key to check for sts-formatted secret
	AWSWebIdentityRoleKey        = "role_arn"        // manual key to check for sts-formatted secret
	AWSRegionEnvVarKey           = "AWS_REGION"
	AWSRoleArnEnvVarKey          = "AWS_ROLE_ARN"
	AWSRoleSessionEnvVarKey      = "AWS_ROLE_SESSION_NAME"
	AWSWebIdentityTokenEnvVarKey = "AWS_WEB_IDENTITY_TOKEN_FILE" //nolint:gosec

	SplunkHECTokenKey = `hecToken`

	TokenKey          = "token"
	LogCollectorToken = "logcollector-token"

	SingletonName = "instance"
	OpenshiftNS   = "openshift-logging"

	InjectTrustedCABundleLabel = "config.openshift.io/inject-trusted-cabundle"

	//ServiceAccountSecretPath is the path to find the projected serviceAccount token and other SA secrets
	ServiceAccountSecretPath   = "/var/run/ocp-collector/serviceaccount"
	TrustedCABundleMountFile   = "tls-ca-bundle.pem"
	TrustedCABundleMountDir    = "/etc/pki/ca-trust/extracted/pem/"
	ElasticsearchFQDN          = "elasticsearch"
	ElasticsearchName          = "elasticsearch"
	VectorName                 = "vector"
	KibanaName                 = "kibana"
	LogfilesmetricexporterName = "logfilesmetricexporter"
	PodSecurityLabelEnforce    = "pod-security.kubernetes.io/enforce"
	PodSecurityLabelValue      = "privileged"
	// Disable gosec linter, complains "possible hard-coded secret"
	CollectorSecretsDir         = "/var/run/ocp-collector/secrets" //nolint:gosec
	ConfigMapBaseDir            = "/var/run/ocp-collector/config"
	CollectorName               = "collector"
	CollectorConfigSecretName   = "collector-config"
	CollectorMetricSecretName   = "collector-metrics"
	CollectorServiceAccountName = "logcollector"
	CollectorTrustedCAName      = "collector-trusted-ca-bundle"

	VectorImageEnvVar         = "RELATED_IMAGE_VECTOR"
	LogfilesmetricImageEnvVar = "RELATED_IMAGE_LOG_FILE_METRIC_EXPORTER"

	ContainerLogDir = "/var/log/containers"
	PodLogDir       = "/var/log/pods"

	// Annotation Names
	AnnotationServingCertSecretName = "service.beta.openshift.io/serving-cert-secret-name"

	ClusterLogging         = "cluster-logging"
	ClusterLoggingOperator = "cluster-logging-operator"

	OptimisticLockErrorMsg = "the object has been modified; please apply your changes to the latest version and try again"

	HTTPReceiverPort   = 8443
	HTTPFormat         = "kubeAPIAudit"
	SyslogReceiverPort = 10514

	VolumeNameTrustedCA = "trusted-ca"

	STDOUT = "stdout"
	STDERR = "stderr"
)

const (
	LabelK8sName      = "app.kubernetes.io/name"       // The name of the application (string)
	LabelK8sInstance  = "app.kubernetes.io/instance"   // A unique name identifying the instance of an application (string)
	LabelK8sVersion   = "app.kubernetes.io/version"    // The current version of the application (e.g., a semantic version, revision hash, etc.) (string)
	LabelK8sComponent = "app.kubernetes.io/component"  // The component within the architecture (string)
	LabelK8sPartOf    = "app.kubernetes.io/part-of"    // The name of a higher level application this one is part of (string)
	LabelK8sManagedBy = "app.kubernetes.io/managed-by" // The tool being used to manage the operation of an application (string)

	LabelLoggingServiceType      = "logging.observability.openshift.io/service-type"
	LabelLoggingInputServiceType = "logging.observability.openshift.io/input-service-type"

	ServiceTypeMetrics = "metrics"
	ServiceTypeInput   = "input"
)

Variables

var ExtraNoProxyList = []string{ElasticsearchFQDN}

Functions

func DefaultTolerations

func DefaultTolerations() []v1.Toleration