EdgeConnect parameters for Dynatrace Operator

Latest Dynatrace
7-min read

EdgeConnect enables Dynatrace apps and workflows to interact securely with your systems. EdgeConnect is available as a Docker container and can run in any container runtime environment. This reference guide provides detailed information on how to configure the EdgeConnect custom resource within your Kubernetes environment.

The following table lists the minimum required Dynatrace Operator versions for each EdgeConnect API version.

DynaKube API version	Minimum Dynatrace Operator version
`v1alpha2`	1.3.0+
`v1alpha1`	All versions

`.spec`

The apiServer and oauth parameters are Required.
All other parameters are Optional.

Parameter	Description	Default value	Data type
`apiServer`	Location of the hostname of the Dynatrace API to connect to, including your specific environment UUID. Example: `ENVIRONMENT_ID.live.dynatrace.com`		string
`annotations`	Adds annotations to the EdgeConnect Pods.		map[string] string
`autoUpdate`	Enables automatic restarts of EdgeConnect Pods when a new version becomes available.	`true`	boolean
`customPullSecret`	Pull secret for your private registry.		string
`env`	Adds environment variables to the EdgeConnect Pods.		[]EnvVar
`hostRestrictions`	Restricts outgoing HTTP requests from your internal resources to specified hosts.		[]string
`imageRef`	Overrides the image automatically resolved from the fleet management endpoint. When not set, Dynatrace Operator resolves the EdgeConnect image automatically. Auto-resolution: Dynatrace Operator version 1.11.0+		Object
`labels`	Adds labels to the EdgeConnect Pods.		map[string]string
`nodeSelector`	Node selector to control the selection of nodes for the EdgeConnect Pods.		map[string]string
`oauth`	EdgeConnect uses the OAuth client to authenticate itself with the Dynatrace platform.		Object
`publicRegistryOverride`	Overrides the public registry host used for automatic image resolution. Specify one of the registry hosts listed in Supported public registries, for example, `public.ecr.aws` or `registry-1.docker.io`. Dynatrace Operator version 1.11.0+		string
`replicas`	Number of replicas for your EdgeConnect.	1	int
`resources`	Defines resource requests and limits for single Pods.		ResourceRequirements
`tolerations`	Specifies tolerations for your EdgeConnect.		[]Toleration
`topologySpreadConstraints`	Sets topology spread constraints for the EdgeConnect Pods.		[]TopologySpreadConstraint
`hostPatterns`	Specifies a list of host patterns for requests to be managed by the EdgeConnect instance. This field is mandatory and only used when `.spec.oauth.provisioner` is set to `true`.	empty	[]string
`caCertsRef`	Adds custom root certificate from a ConfigMap. Ensure the certificate is located under the `certs` directory within your ConfigMap.	empty	string
`serviceAccountName`	Name of Kubernetes `ServiceAccount` that allows EdgeConnect to access the Kubernetes API.	`dynatrace-edgeconnect`	string
`kubernetesAutomation`	Configures Kubernetes Automation.		Object

`.spec.oauth`

resource, endpoint, clientSecret parameters are Required.

Parameter	Description	Default value	Data type
`clientSecret`	Name of the secret containing the OAuth client ID/secret.		string
`endpoint`	Token endpoint URL of Dynatrace SSO.		string
`resource`	URN identifying your account. The URN is provided when creating the OAuth client.		string
`provisioner`	Enables EdgeConnect provisioning. This requires the `.spec.hostPatterns` field to be configured.	`false`	bool

`.spec.imageRef`

All parameters are Optional.

Parameter	Description	Default value	Data type
`repository`	Custom EdgeConnect image repository.	`docker.io/dynatrace/edgeconnect`	string
`tag`	Specifies version of the EdgeConnect image to use.	`latest`	string
`digest`	Pins the image to a content-addressable digest in `<algorithm>:<hex>` format (for example, `sha256:…`). When set, `tag` is ignored. Dynatrace Operator version 1.10.0+	No default (optional)	string
`pullPolicy`	Specifies pull policy for the EdgeConnect image. Dynatrace Operator version 1.9.0+	No default (optional)	string

`.spec.proxy`

All parameters are Optional.

Parameter	Description	Default value	Data type
`authRef`	Secret name containing the username and password used for authentication with the proxy, using the basic HTTP authentication scheme.	empty	string
`host`	Server address (hostname or IP address) of the proxy.	empty	string
`noProxy`	Represents the `NO_PROXY` or `no_proxy` environment variable. It specifies a string containing comma-separated values specifying hosts that should be excluded from proxying.	empty	string
`port`	Port of the proxy.	empty	integer

`.spec.kubernetesApiAutomation`

Parameter	Description	Default value	Data type
`enabled`	Enables Kubernetes Automation.	`false`	bool