v1

type AgentMode string

type AgentOperatorState string

type AgentPodSpec struct {
	// agent.pod.annotations are additional annotations to be added to the agent pods.
	// +kubebuilder:validation:Optional
	Annotations map[string]string `json:"annotations,omitempty"`

	// agent.pod.labels are additional labels to be added to the agent pods.
	// +kubebuilder:validation:Optional
	Labels map[string]string `json:"labels,omitempty"`

	// agent.pod.tolerations are tolerations to influence agent pod assignment.
	// +kubebuilder:validation:Optional
	Tolerations []coreV1.Toleration `json:"tolerations,omitempty"`

	// agent.pod.affinity are affinities to influence agent pod assignment.
	// https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
	// +kubebuilder:validation:Optional
	Affinity coreV1.Affinity `json:"affinity,omitempty"`

	// agent.pod.priorityClassName is the name of an existing PriorityClass that should be set on the agent pods
	// https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
	// +kubebuilder:validation:Optional
	PriorityClassName string `json:"priorityClassName,omitempty"`

	// Override Agent resource requirements to e.g. give the Agent container more memory.
	coreV1.ResourceRequirements `json:",inline"`
}

type BackendSpec struct {
	// +kubebuilder:validation:Required
	EndpointHost string `json:"endpointHost"`
	// +kubebuilder:validation:Required
	EndpointPort string `json:"endpointPort"`
	// +kubebuilder:validation:Required
	Key string `json:"key"`
}

type BaseAgentSpec struct {
	// Set agent mode, possible options are APM, INFRASTRUCTURE or AWS. KUBERNETES should not be used but instead enabled via
	// `kubernetes.deployment.enabled: true`.
	// +kubebuilder:validation:Optional
	Mode AgentMode `json:"mode,omitempty"`

	// Key is the secret token which your agent uses to authenticate to Instana's servers.
	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Agent Key",xDescriptors={"urn:alm:descriptor:io.kubernetes:Secret"}
	// +kubebuilder:validation:Optional
	Key string `json:"key,omitempty"`

	// The DownloadKey, sometimes known as "sales key", that allows you to download software from Instana. It might be needed to
	// specify this in addition to the Key.
	// +kubebuilder:validation:Optional
	DownloadKey string `json:"downloadKey,omitempty"`

	// Rather than specifying the Key and optionally the DownloadKey, you can "bring your
	// own secret" creating it in the namespace in which you install the `instana-agent` and
	// specify its name in the `KeysSecret` field. The secret you create must contain a field called `key` and optionally one
	// called `downloadKey`, which contain, respectively, the values you'd otherwise set in `.agent.key` and `agent.downloadKey`.
	// +kubebuilder:validation:Optional
	KeysSecret string `json:"keysSecret,omitempty"`

	// ListenAddress is the IP addresses the Agent HTTP server will listen on. Normally this will just be localhost (`127.0.0.1`),
	// the pod public IP and any container runtime bridge interfaces. Set `listenAddress: *` for making the Agent listen on all
	// network interfaces.
	// +kubebuilder:validation:Optional
	ListenAddress string `json:"listenAddress,omitempty"`

	// EndpointHost is the hostname of the Instana server your agents will connect to.
	// +kubebuilder:validation:Required
	EndpointHost string `json:"endpointHost"`

	// EndpointPort is the port number (as a String) of the Instana server your agents will connect to.
	// +kubebuilder:validation:Required
	EndpointPort string `json:"endpointPort"`

	// These are additional backends the Instana agent will report to besides
	// the one configured via the `agent.endpointHost`, `agent.endpointPort` and `agent.key` setting.
	// +kubebuilder:validation:Optional
	AdditionalBackends []BackendSpec `json:"additionalBackends,omitempty"`

	// TLS for end-to-end encryption between the Instana Agent and clients accessing the Agent.
	// The Instana Agent does not yet allow enforcing TLS encryption, enabling makes it possible for clients to 'opt-in'.
	// So TLS is only enabled on a connection when requested by the client.
	// +kubebuilder:validation:Optional
	TlsSpec `json:"tls,omitempty"`

	// Override the container image used for the Instana Agent pods.
	// +kubebuilder:validation:Optional
	ImageSpec `json:"image,omitempty"`

	// Control how to update the Agent DaemonSet
	// +kubebuilder:validation:Optional
	UpdateStrategy appV1.DaemonSetUpdateStrategy `json:"updateStrategy,omitempty"`

	// Override Agent Pod specific settings such as annotations, labels and resources.
	// +kubebuilder:validation:Optional
	Pod AgentPodSpec `json:"pod,omitempty"`

	// proxyHost sets the INSTANA_AGENT_PROXY_HOST environment variable.
	// +kubebuilder:validation:Optional
	ProxyHost string `json:"proxyHost,omitempty"`
	// proxyPort sets the INSTANA_AGENT_PROXY_PORT environment variable.
	// +kubebuilder:validation:Optional
	ProxyPort string `json:"proxyPort,omitempty"`
	// proxyProtocol sets the INSTANA_AGENT_PROXY_PROTOCOL environment variable.
	// +kubebuilder:validation:Optional
	ProxyProtocol string `json:"proxyProtocol,omitempty"`
	// proxyUser sets the INSTANA_AGENT_PROXY_USER environment variable.
	// +kubebuilder:validation:Optional
	ProxyUser string `json:"proxyUser,omitempty"`
	// proxyPassword sets the INSTANA_AGENT_PROXY_PASSWORD environment variable.
	// +kubebuilder:validation:Optional
	ProxyPassword string `json:"proxyPassword,omitempty"`
	// proxyUseDNS sets the INSTANA_AGENT_PROXY_USE_DNS environment variable.
	// +kubebuilder:validation:Optional
	ProxyUseDNS bool `json:"proxyUseDNS,omitempty"`

	// Use the `env` field to set additional environment variables for the Instana Agent, for example:
	// env:
	//   INSTANA_AGENT_TAGS: dev
	// +kubebuilder:validation:Optional
	Env map[string]string `json:"env,omitempty"`

	// Supply Agent configuration e.g. for configuring certain Sensors.
	// +kubebuilder:validation:Optional
	ConfigurationYaml string `json:"configuration_yaml,omitempty"`
	// Mount in a ConfigMap with Agent configuration. Alternative to the `configuration_yaml` field.
	// +kubebuilder:validation:Optional
	Configuration ConfigurationSpec `json:"configuration,omitempty"`

	// RedactKubernetesSecrets sets the INSTANA_KUBERNETES_REDACT_SECRETS environment variable.
	// +kubebuilder:validation:Optional
	RedactKubernetesSecrets string `json:"redactKubernetesSecrets,omitempty"`

	// Host sets a host path to be mounted as the Agent Maven repository (mainly for debugging or development purposes)
	// +kubebuilder:validation:Optional
	Host HostSpec `json:"host,omitempty"`

	// Override for the Maven repository URL when the Agent needs to connect to a locally provided Maven repository 'proxy'
	// Alternative to `Host` for referencing a different Maven repo.
	// +kubebuilder:validation:Optional
	MvnRepoUrl string `json:"instanaMvnRepoUrl,omitempty"`
	// Custom agent charts url.
	// +kubebuilder:validation:Optional
	ChartsUrl string `json:"charts_url,omitempty"`
}

type ConfigurationSpec struct {
	// When setting this to true, the Helm chart will automatically look up the entries
	// of the default instana-agent ConfigMap, and mount as agent configuration files
	// under /opt/instana/agent/etc/instana all entries with keys that match the
	// 'configuration-*.yaml' scheme
	// +kubebuilder:validation:Optional
	AutoMountConfigEntries bool `json:"autoMountConfigEntries,omitempty"`
}

type Create struct {
	// +kubebuilder:validation:Optional
	Create bool `json:"create,omitempty"`
}

type Enabled struct {
	// +kubebuilder:validation:Optional
	Enabled bool `json:"enabled,omitempty"`
}

type HostSpec struct {
	// +kubebuilder:validation:Optional
	Repository string `json:"repository,omitempty"`
}

type ImageSpec struct {
	// Name is the name of the container image of the Instana agent.
	// +kubebuilder:validation:Optional
	Name string `json:"name,omitempty"`

	// Digest (a.k.a. Image ID) of the agent container image. If specified, it has priority over `agent.image.tag`,
	// which will then be ignored.
	// +kubebuilder:validation:Optional
	Digest string `json:"digest,omitempty"`

	// Tag is the name of the agent container image; if `agent.image.digest` is specified, this property is ignored.
	// +kubebuilder:validation:Optional
	Tag string `json:"tag,omitempty"`

	// PullPolicy specifies when to pull the image container.
	// +kubebuilder:validation:Optional
	PullPolicy string `json:"pullPolicy,omitempty"`

	// PullSecrets allows you to override the default pull secret that is created when `agent.image.name` starts with
	// "containers.instana.io". Setting `agent.image.pullSecrets` prevents the creation of the default "containers-instana-io" secret.
	// +kubebuilder:validation:Optional
	PullSecrets []PullSecretSpec `json:"pullSecrets,omitempty"`
}

type InstanaAgent struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   InstanaAgentSpec   `json:"spec,omitempty"`
	Status InstanaAgentStatus `json:"status,omitempty"`
}

type InstanaAgentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []InstanaAgent `json:"items"`
}

type InstanaAgentSpec struct {
	// Agent deployment specific fields.
	// +kubebuilder:validation:Required
	Agent BaseAgentSpec `json:"agent"`

	// Name of the cluster, that will be assigned to this cluster in Instana. Either specifying the 'cluster.name' or 'zone.name'
	// is mandatory.
	Cluster Name `json:"cluster,omitempty"`

	// Name of the zone in which the host(s) will be displayed on the map. Optional, but then 'cluster.name' must be specified.
	Zone Name `json:"zone,omitempty"`

	// Set to `True` to indicate the Operator is being deployed in a OpenShift cluster. Provides a hint so that RBAC etc is
	// configured correctly.
	// +kubebuilder:validation:Optional
	OpenShift bool `json:"openshift,omitempty"`

	// Specifies whether RBAC resources should be created.
	// +kubebuilder:validation:Optional
	Rbac Create `json:"rbac,omitempty"`

	// Specifies whether to create the instana-agent `Service` to expose within the cluster. The Service can then be used e.g.
	// for the Prometheus remote-write, OpenTelemetry GRCP endpoint and other APIs.
	// Note: Requires Kubernetes 1.17+, as it uses topologyKeys.
	// +kubebuilder:validation:Optional
	Service Create `json:"service,omitempty"`

	// Enables the OpenTelemetry gRPC endpoint on the Agent. If true, it will also apply `service.create: true`.
	// +kubebuilder:validation:Optional
	OpenTelemetry OpenTelemetry `json:"opentelemetry,omitempty"`

	// Enables the Prometheus endpoint on the Agent. If true, it will also apply `service.create: true`.
	// +kubebuilder:validation:Optional
	Prometheus `json:"prometheus,omitempty"`

	// Specifies whether a ServiceAccount should be created (default `true`), and possibly the name to use.
	// +kubebuilder:validation:Optional
	ServiceAccountSpec `json:"serviceAccount,omitempty"`

	// Specify a PodSecurityPolicy for the Instana Agent Pods. If enabled requires `rbac.create: true`.
	// +kubebuilder:validation:Optional
	PodSecurityPolicySpec `json:"podSecurityPolicy,omitempty"`

	// Allows for installment of the Kubernetes Sensor as separate pod. Which allows for better tailored resource settings
	// (mainly memory) both for the Agent pods and the Kubernetes Sensor pod.
	// +kubebuilder:validation:Optional
	KubernetesSpec `json:"kubernetes,omitempty"`

	// +kubebuilder:validation:Optional
	K8sSensor K8sSpec `json:"k8s_sensor,omitempty"`

	// Specifying the PinnedChartVersion allows for 'pinning' the Helm Chart used by the Operator for installing the Agent
	// DaemonSet. Normally the Operator will always install and update to the latest Helm Chart version.
	// The Operator will check and make sure no 'unsupported' Chart versions can be selected.
	// +kubebuilder:validation:Optional
	PinnedChartVersion string `json:"pinnedChartVersion,omitempty"`

	ConfigurationFiles          map[string]string `json:"config.files,omitempty"`
	AgentZoneName               string            `json:"agent.zone.name,omitempty"`
	AgentKey                    string            `json:"agent.key,omitempty"`
	AgentEndpointHost           string            `json:"agent.endpoint.host,omitempty"`
	AgentEndpointPort           uint16            `json:"agent.endpoint.port,omitempty"`
	AgentClusterRoleName        string            `json:"agent.clusterRoleName,omitempty"`
	AgentClusterRoleBindingName string            `json:"agent.clusterRoleBindingName,omitempty"`
	AgentServiceAccountName     string            `json:"agent.serviceAccountName,omitempty"`
	AgentSecretName             string            `json:"agent.secretName,omitempty"`
	AgentDaemonSetName          string            `json:"agent.daemonSetName,omitempty"`
	AgentConfigMapName          string            `json:"agent.configMapName,omitempty"`
	AgentRbacCreate             bool              `json:"agent.rbac.create,omitempty"`
	AgentImageName              string            `json:"agent.image,omitempty"`
	AgentImagePullPolicy        string            `json:"agent.imagePullPolicy,omitempty"`
	AgentCpuReq                 resource.Quantity `json:"agent.cpuReq,omitempty"`
	AgentCpuLim                 resource.Quantity `json:"agent.cpuLimit,omitempty"`
	AgentMemReq                 resource.Quantity `json:"agent.memReq,omitempty"`
	AgentMemLim                 resource.Quantity `json:"agent.memLimit,omitempty"`
	AgentDownloadKey            string            `json:"agent.downloadKey,omitempty"`
	AgentRepository             string            `json:"agent.host.repository,omitempty"`
	AgentTlsSecretName          string            `json:"agent.tls.secretName,omitempty"`
	AgentTlsCertificate         string            `json:"agent.tls.certificate,omitempty"`
	AgentTlsKey                 string            `json:"agent.tls.key,omitempty"`
	OpenTelemetryEnabled        bool              `json:"opentelemetry.enabled,omitempty"`
	ClusterName                 string            `json:"cluster.name,omitempty"`
	AgentEnv                    map[string]string `json:"agent.env,omitempty"`
}

type InstanaAgentStatus struct {
	Status     AgentOperatorState `json:"status,omitempty"`
	Reason     string             `json:"reason,omitempty"`
	LastUpdate metav1.Time        `json:"lastUpdate,omitempty"`

	OldVersionsUpdated bool `json:"oldVersionsUpdated,omitempty"`

	ConfigMap       ResourceInfo            `json:"configmap,omitempty"`
	DaemonSet       ResourceInfo            `json:"daemonset,omitempty"`
	LeadingAgentPod map[string]ResourceInfo `json:"leadingAgentPod,omitempty"`
}

type K8sSpec struct {
	// +kubebuilder:validation:Optional
	DeploymentSpec KubernetesDeploymentSpec `json:"deployment,omitempty"`
	// +kubebuilder:validation:Optional
	ImageSpec ImageSpec `json:"image,omitempty"`
}

type KubernetesDeploymentSpec struct {
	// Specify if separate deployment of the Kubernetes Sensor should be enabled.
	Enabled `json:",inline"`

	// Specify the number of replicas for the Kubernetes Sensor.
	// +kubebuilder:validation:Optional
	Replicas int `json:"replicas,omitempty"`

	// Override pod resource requirements for the Kubernetes Sensor pods.
	// +kubebuilder:validation:Optional
	Pod coreV1.ResourceRequirements `json:"pod,omitempty"`
}

type KubernetesSpec struct {
	// +kubebuilder:validation:Optional
	DeploymentSpec KubernetesDeploymentSpec `json:"deployment,omitempty"`
}

type Name struct {
	// +kubebuilder:validation:Optional
	Name string `json:"name,omitempty"`
}

type OpenTelemetry struct {
	// Deprecated setting for backwards compatibility
	Enabled `json:",inline"`

	// +kubebuilder:validation:Optional
	GRPC Enabled `json:"grpc,omitempty"`

	// +kubebuilder:validation:Optional
	HTTP Enabled `json:"http,omitempty"`
}

type PodSecurityPolicySpec struct {
	// Specifies whether a PodSecurityPolicy should be authorized for the Instana Agent pods.
	// Requires `rbac.create` to be `true` as well.
	Enabled `json:",inline"`
	// The name of an existing PodSecurityPolicy you would like to authorize for the Instana Agent pods.
	// If not set and `enable` is true, a PodSecurityPolicy will be created with a name generated using the fullname template.
	Name `json:",inline"`
}

type Prometheus struct {
	// +kubebuilder:validation:Optional
	RemoteWrite Enabled `json:"remoteWrite,omitempty"`
}

type PullSecretSpec struct {
	Name `json:",inline"`
}

type ResourceInfo struct {
	Name string `json:"name"`
	UID  string `json:"uid"`
}

type ServiceAccountSpec struct {
	// Specifies whether a ServiceAccount should be created.
	Create `json:",inline"`

	// Name of the ServiceAccount. If not set and `create` is true, a name is generated using the fullname template.
	Name `json:",inline"`
}

type TlsSpec struct {
	// secretName is the name of the secret that has the relevant files.
	// +kubebuilder:validation:Optional
	SecretName string `json:"secretName,omitempty"`
	// certificate (together with key) is the alternative to an existing Secret. Must be base64 encoded.
	// +kubebuilder:validation:Optional
	Certificate string `json:"certificate,omitempty"`
	// key (together with certificate) is the alternative to an existing Secret. Must be base64 encoded.
	// +kubebuilder:validation:Optional
	Key string `json:"key,omitempty"`
}