Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add DD_AGENT_IPC_* env vars #1604

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add DD_AGENT_IPC_* env vars #1604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions api/datadoghq/v2alpha1/envvar.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ const (
DDSystemProbeExternal = "DD_SYSTEM_PROBE_EXTERNAL"
DDSystemProbeSocket = "DD_SYSPROBE_SOCKET"
DDTags = "DD_TAGS"
DDAgentIpcPort = "DD_AGENT_IPC_PORT"
DDAgentIpcConfigRefreshInterval = "DD_AGENT_IPC_CONFIG_REFRESH_INTERVAL"

// otelcollector core agent configs
DDOtelCollectorCoreConfigEnabled = "DD_OTELCOLLECTOR_ENABLED"
DDOtelCollectorCoreConfigExtensionURL = "DD_OTELCOLLECTOR_EXTENSION_URL"
Expand Down
20 changes: 20 additions & 0 deletions internal/controller/datadogagent/feature/otelcollector/feature.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,25 @@ func (o otelCollectorFeature) ManageNodeAgent(managers feature.PodTemplateManage
managers.Port().AddPortToContainer(apicommon.OtelAgent, port)
}

// (todo: mackjmr): remove this once IPC port is enabled by default. Enabling this port is required to fetch the API key from
// core agent when secrets backend is used.
agentIpcPortEnvVar := &corev1.EnvVar{
Name: v2alpha1.DDAgentIpcPort,
Value: "5009",
}
agentIpcConfigRefreshIntervalEnvVar := &corev1.EnvVar{
Name: v2alpha1.DDAgentIpcConfigRefreshInterval,
Value: "60",
}
// don't set env var if it was already set by user.
mergeFunc := func(current, newEnv *corev1.EnvVar) (*corev1.EnvVar, error) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this can be tested by the current test framework, as the env vars added via WithEnvVars helper don't make it into container env vars.

e.g.

		{
			Name: "otel agent user provided ipc port",
			DDA: testutils.NewDatadogAgentBuilder().
				WithOTelCollectorEnabled(true).
				WithEnvVars([]corev1.EnvVar{
					{
						Name:  v2alpha1.DDAgentIpcPort,
						Value: "3333",
					},
				}).
				Build(),
			WantConfigure:        true,
			WantDependenciesFunc: testExpectedDepsCreatedCM,
			Agent: testExpectedAgent(apicommon.OtelAgent, defaultExpectedPorts, defaultLocalObjectReferenceName,
				expectedEnvVars{
					agent_ipc_port: expectedEnvVar{
						present: true,
						value:   "3333",
					},
					agent_ipc_refresh: expectedEnvVar{
						present: true,
						value:   "60",
					},
				},
			),
		},

will fail.

return current, nil
}
for _, container := range []apicommon.AgentContainerName{apicommon.CoreAgentContainerName, apicommon.OtelAgent} {
managers.EnvVar().AddEnvVarToContainerWithMergeFunc(container, agentIpcPortEnvVar, mergeFunc)
managers.EnvVar().AddEnvVarToContainerWithMergeFunc(container, agentIpcConfigRefreshIntervalEnvVar, mergeFunc)
}

var enableEnvVar *corev1.EnvVar
if o.coreAgentConfig.enabled != nil {
if *o.coreAgentConfig.enabled {
Expand Down Expand Up @@ -201,6 +220,7 @@ func (o otelCollectorFeature) ManageNodeAgent(managers feature.PodTemplateManage
Value: *o.coreAgentConfig.extension_url,
})
}

return nil
}

Expand Down
61 changes: 60 additions & 1 deletion internal/controller/datadogagent/feature/otelcollector/feature_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ type expectedPorts struct {
}

type expectedEnvVars struct {
agent_ipc_port expectedEnvVar
agent_ipc_refresh expectedEnvVar
enabled expectedEnvVar
extension_timeout expectedEnvVar
extension_url expectedEnvVar
Expand All @@ -43,13 +45,32 @@ var (
}
defaultLocalObjectReferenceName = "-otel-agent-config"
defaultExpectedEnvVars = expectedEnvVars{
agent_ipc_port: expectedEnvVar{
present: true,
value: "5009",
},
agent_ipc_refresh: expectedEnvVar{
present: true,
value: "60",
},
enabled: expectedEnvVar{
present: true,
value: "true",
},
extension_timeout: expectedEnvVar{},
extension_url: expectedEnvVar{},
}

onlyIpcEnvVars = expectedEnvVars{
agent_ipc_port: expectedEnvVar{
present: true,
value: "5009",
},
agent_ipc_refresh: expectedEnvVar{
present: true,
value: "60",
},
}
)

func Test_otelCollectorFeature_Configure(t *testing.T) {
Expand Down Expand Up @@ -135,7 +156,7 @@ func Test_otelCollectorFeature_Configure(t *testing.T) {
Build(),
WantConfigure: true,
WantDependenciesFunc: testExpectedDepsCreatedCM,
Agent: testExpectedAgent(apicommon.OtelAgent, defaultExpectedPorts, defaultLocalObjectReferenceName, expectedEnvVars{}),
Agent: testExpectedAgent(apicommon.OtelAgent, defaultExpectedPorts, defaultLocalObjectReferenceName, onlyIpcEnvVars),
},
{
Name: "otel agent coreconfig extensionTimeout",
Expand All @@ -147,6 +168,14 @@ func Test_otelCollectorFeature_Configure(t *testing.T) {
WantConfigure: true,
WantDependenciesFunc: testExpectedDepsCreatedCM,
Agent: testExpectedAgent(apicommon.OtelAgent, defaultExpectedPorts, defaultLocalObjectReferenceName, expectedEnvVars{
agent_ipc_port: expectedEnvVar{
present: true,
value: "5009",
},
agent_ipc_refresh: expectedEnvVar{
present: true,
value: "60",
},
extension_timeout: expectedEnvVar{
present: true,
value: "13",
Expand All @@ -163,6 +192,14 @@ func Test_otelCollectorFeature_Configure(t *testing.T) {
WantConfigure: true,
WantDependenciesFunc: testExpectedDepsCreatedCM,
Agent: testExpectedAgent(apicommon.OtelAgent, defaultExpectedPorts, defaultLocalObjectReferenceName, expectedEnvVars{
agent_ipc_port: expectedEnvVar{
present: true,
value: "5009",
},
agent_ipc_refresh: expectedEnvVar{
present: true,
value: "60",
},
extension_url: expectedEnvVar{
present: true,
value: "https://localhost:1234",
Expand All @@ -180,6 +217,14 @@ func Test_otelCollectorFeature_Configure(t *testing.T) {
WantConfigure: true,
WantDependenciesFunc: testExpectedDepsCreatedCM,
Agent: testExpectedAgent(apicommon.OtelAgent, defaultExpectedPorts, defaultLocalObjectReferenceName, expectedEnvVars{
agent_ipc_port: expectedEnvVar{
present: true,
value: "5009",
},
agent_ipc_refresh: expectedEnvVar{
present: true,
value: "60",
},
extension_url: expectedEnvVar{
present: true,
value: "https://localhost:1234",
Expand Down Expand Up @@ -254,6 +299,20 @@ func testExpectedAgent(agentContainerName apicommon.AgentContainerName, expected
// check env vars
wantEnvVars := []*corev1.EnvVar{}

if expectedEnvVars.agent_ipc_port.present {
wantEnvVars = append(wantEnvVars, &corev1.EnvVar{
Name: v2alpha1.DDAgentIpcPort,
Value: expectedEnvVars.agent_ipc_port.value,
})
}

if expectedEnvVars.agent_ipc_refresh.present {
wantEnvVars = append(wantEnvVars, &corev1.EnvVar{
Name: v2alpha1.DDAgentIpcConfigRefreshInterval,
Value: expectedEnvVars.agent_ipc_refresh.value,
})
}

if expectedEnvVars.enabled.present {
wantEnvVars = append(wantEnvVars, &corev1.EnvVar{
Name: v2alpha1.DDOtelCollectorCoreConfigEnabled,
Expand Down
Loading