constants

Documentation

Index

• Constants
• type CaptureOutputLocationEnvKey

Constants

const (
	CaptureOutputLocationEnvKeyHostPath              CaptureOutputLocationEnvKey = "HOSTPATH"
	CaptureOutputLocationEnvKeyPersistentVolumeClaim CaptureOutputLocationEnvKey = "PERSISTENT_VOLUME_CLAIM"
	CaptureOutputLocationEnvKeyS3Endpoint            CaptureOutputLocationEnvKey = "S3_ENDPOINT"
	CaptureOutputLocationEnvKeyS3Region              CaptureOutputLocationEnvKey = "S3_REGION"
	CaptureOutputLocationEnvKeyS3Bucket              CaptureOutputLocationEnvKey = "S3_BUCKET"
	CaptureOutputLocationEnvKeyS3Path                CaptureOutputLocationEnvKey = "S3_PATH"

	CaptureNameEnvKey           string = "CAPTURE_NAME"
	NodeHostNameEnvKey          string = "NODE_HOST_NAME"
	CaptureStartTimestampEnvKey string = "CAPTURE_START_TIMESTAMP"

	CaptureFilterEnvKey   string = "CAPTURE_FILTER"
	CaptureDurationEnvKey string = "CAPTURE_DURATION"
	CaptureMaxSizeEnvKey  string = "CAPTURE_MAX_SIZE"
	IncludeMetadataEnvKey string = "INCLUDE_METADATA"
	PacketSizeEnvKey      string = "CAPTURE_PACKET_SIZE"

	TcpdumpFilterEnvKey    string = "TCPDUMP_FILTER"
	TcpdumpRawFilterEnvKey string = "TCPDUMP_RAW_FILTER"
	NetshFilterEnvKey      string = "NETSH_FILTER"

	ApiserverEnvKey = "APISERVER"
)

Environment variables

const (
	CaptureHostPathVolumeName string = "hostpath"
	CapturePVCVolumeName      string = "pvc"

	// PersistentVolumeClaimVolumeMountPathLinux is the PVC volume mount path of container hosted on Linux node.
	PersistentVolumeClaimVolumeMountPathLinux string = "/mnt/azure"
	// PersistentVolumeClaimVolumeMountPathWin is the PVC volume mount path of container hosted on Windows node.
	PersistentVolumeClaimVolumeMountPathWin string = "D:"

	CaptureContainerEntrypoint    string = "./retina/captureworkload"
	CaptureContainerEntrypointWin string = "captureworkload.exe"

	CaptureAppname       string = "capture"
	CaptureContainername string = "capture"

	// CaptureOutputLocationBlobUploadSecretName is the name of the secret that stores the blob upload url.
	CaptureOutputLocationBlobUploadSecretName string = "capture-blob-upload-secret"
	// CaptureOutputLocationBlobUploadSecretPath is the path of the secret that stores the blob upload url.
	CaptureOutputLocationBlobUploadSecretPath string = "/etc/blob-upload-secret"
	// CaptureOutputLocationBlobUploadSecretKey is the key of the secret that stores the blob upload url.
	CaptureOutputLocationBlobUploadSecretKey string = "blob-upload-url"

	// CaptureOutputLocationS3UploadSecretName is the name of the secret that stores the s3 credentials.
	CaptureOutputLocationS3UploadSecretName string = "capture-s3-upload-secret" // #nosec G101
	// CaptureOutputLocationS3UploadSecretPath is the path of the secret that stores the s3 credentials.
	CaptureOutputLocationS3UploadSecretPath string = "/etc/s3-upload-secret" // #nosec G101
	// CaptureOutputLocationS3UploadAccessKeyID is the key of the secret that stores the s3 access key id.
	CaptureOutputLocationS3UploadAccessKeyID string = "s3-access-key-id"
	// CaptureOutputLocationS3UploadSecretAccessKey is the key of the secret that stores the s3 secret access key.
	CaptureOutputLocationS3UploadSecretAccessKey string = "s3-secret-access-key"

	// CaptureWorkloadImageName defines the official capture workload image repo and image name
	CaptureWorkloadImageName string = "ghcr.io/microsoft/retina/retina-agent"

	// DebugCaptureWorkloadImageName defines the capture workload image for testing and debugging
	DebugCaptureWorkloadImageName string = "ghcr.io/microsoft/retina/retina-agent"
)

Capture job specification

const ContainerSandboxMountPointEnvKey = "CONTAINER_SANDBOX_MOUNT_POINT"

ContainerSandboxMountPointEnvKey provides the absolute host path to the container volume.

Types

type CaptureOutputLocationEnvKey

type CaptureOutputLocationEnvKey string