dockeragentparams

package
v0.82.0-devel Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 12, 2026 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithAdditionalFakeintake

func WithAdditionalFakeintake(fakeintake *fakeintake.Fakeintake) func(*Params) error

func WithAgentServiceEnvVariable

func WithAgentServiceEnvVariable(key string, value pulumi.Input) func(*Params) error

WithAgentServiceEnvVariable set an environment variable in the docker compose agent service's environment.

func WithEnvironmentVariables

func WithEnvironmentVariables(environmentVariables pulumi.StringMap) func(*Params) error

func WithExtraComposeInlineManifest

func WithExtraComposeInlineManifest(cpms ...docker.ComposeInlineManifest) func(*Params) error

WithExtraComposeInlineManifest adds extra docker.ComposeInlineManifest

func WithExtraComposeManifest

func WithExtraComposeManifest(name string, content pulumi.StringInput) func(*Params) error

WithExtraComposeManifest adds a docker.ComposeInlineManifest

func WithExtraVolumes

func WithExtraVolumes(volumes ...string) func(*Params) error

WithExtraVolumes adds extra bind-mount volumes (host:container[:opts]) to the agent container.

func WithFIPS

func WithFIPS() func(*Params) error

WithFIPS makes the image FIPS enabled

func WithFakeintake

func WithFakeintake(fi *fakeintake.Fakeintake) func(*Params) error

WithFakeintake installs the fake intake and configures the Agent to use it, including Remote Config. The agent is pointed at fakeintake's RC endpoint and given the TUF root JSON derived from fakeintake's global signing key so it can verify signed payloads without any extra provisioner options.

This option is overwritten by `WithIntakeHostname`.

func WithFullImagePath

func WithFullImagePath(fullImagePath string) func(*Params) error

func WithImageTag

func WithImageTag(agentImageTag string) func(*Params) error

func WithIntake

func WithIntake(url string) func(*Params) error

WithIntake configures the agent to use the given url as intake. The url must be a valid Datadog intake, with a SSL valid certificate

To use a fakeintake, see WithFakeintake.

This option is overwritten by `WithFakeintake`.

func WithJMX

func WithJMX() func(*Params) error

WithJMX makes the image be the one with Java installed

func WithLogs

func WithLogs() func(*Params) error

WithLogs enables the log agent

func WithPulumiDependsOn

func WithPulumiDependsOn(resources ...pulumi.ResourceOption) func(*Params) error

func WithRepository

func WithRepository(repository string) func(*Params) error

func WithTags

func WithTags(tags []string) func(*Params) error

func WithV3MetricsDisabled

func WithV3MetricsDisabled() func(*Params) error

WithV3MetricsDisabled forces the Agent onto the V2 series intake API by setting DD_USE_V3_API_SERIES_ENABLED=false. V3 is the default, so this opts back out in order to exercise the V2 wire format and /api/v2/series routing.

func WithWindowsImage added in v0.77.0

func WithWindowsImage() func(*Params) error

WithWindowsImage makes the image Windows-compatible (multi-arch with Windows)

Types

type Option

type Option = func(*Params) error

type Params

type Params struct {
	// FullImagePath is the full path of the docker agent image to use.
	// It has priority over ImageTag and Repository.
	FullImagePath string
	// ImageTag is the docker agent image tag to use.
	ImageTag string
	// Repository is the docker repository to use.
	Repository string
	// JMX is true if the JMX image is needed
	JMX bool
	// WindowsImage is true if Windows-compatible image is needed
	WindowsImage bool
	// AgentServiceEnvironment is a map of environment variables to set in the docker compose agent service's environment.
	AgentServiceEnvironment pulumi.Map
	// ExtraComposeManifests is a list of extra docker compose manifests to add beside the agent service.
	ExtraComposeManifests []docker.ComposeInlineManifest
	// ExtraAgentVolumes are extra bind-mount volumes (host:container[:opts]) added to the agent service.
	ExtraAgentVolumes []string
	// EnvironmentVariables is a map of environment variables to set with the docker-compose context
	EnvironmentVariables pulumi.StringMap
	// PulumiDependsOn is a list of resources to depend on.
	PulumiDependsOn []pulumi.ResourceOption
	// FIPS is true if FIPS image is needed.
	FIPS bool
}

func NewParams

func NewParams(e config.Env, options ...Option) (*Params, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL