EdgeConnect parameters for Dynatrace Operator

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.

v1alpha1

v1alpha2

.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. Comma-separated list.

string

imageRef

Overrides the default image.

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

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 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

.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

.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

scheme

Proxy scheme (http or https).

empty

string

.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 default image.

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

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 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

.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

scheme

Proxy scheme (http or https).

empty

string

.spec.kubernetesApiAutomation

Parameter

Description

Default value

Data type

enabled

Enables Kubernetes Automation.

false

bool