kubernetesagentparams

package
v0.84.2 Latest Latest
Warning

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

Go to latest
Published: Oct 6, 2026 License: Apache-2.0 Imports: 7 Imported by: 4

Documentation

Index

Constants

View Source
const (
	DatadogHelmRepo = "https://helm.datadoghq.com"
)

Variables

This section is empty.

Functions

func WithAgentFullImagePath

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

WithAgentFullImagePath sets the full path of the agent image to use.

func WithAgentVersion added in v0.84.0

func WithAgentVersion(version string) func(*Params) error

WithAgentVersion sets the agent version to deploy, used as the image tag when no full image path is provided. A full image path (WithAgentFullImagePath) takes precedence. The version is used verbatim as the tag: FIPS/OTel then only select the repository and JMX has no effect at all, so pass a version that already carries the suffix the variant needs (e.g. "7.55.0-fips", "7.55.0-jmx") when combining this with WithFIPS/WithJMX.

func WithBaseName added in v0.84.0

func WithBaseName(baseName string) func(*Params) error

WithBaseName sets the base name used to derive the Helm release and Pulumi resource names for the Agent installation. Use it to deploy several Agent installations in the same cluster without resource name collisions.

func WithClusterAgentFullImagePath

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

WithClusterAgentFullImagePath sets the full path of the agent image to use.

func WithClusterAgentVersion added in v0.84.0

func WithClusterAgentVersion(version string) func(*Params) error

WithClusterAgentVersion sets the cluster agent version to deploy, used as the image tag when no full image path is provided. A full image path (WithClusterAgentFullImagePath) takes precedence. Used verbatim, as WithAgentVersion.

func WithClusterName

func WithClusterName(clusterName pulumi.StringInput) func(*Params) error

WithClusterName sets the name of the cluster. Should only be used if you know what you are doing. Must no be necessary in most cases. Mainly used to set the clusterName when the agent is installed on Kind clusters. Because the agent is not able to detect the cluster name. It takes a pulumi.StringInput as input to be able to use either a plain string (via pulumi.String()) or a pulumi output.

func WithDeployWindows

func WithDeployWindows() func(*Params) error

WithDeployWindows sets the flag to deploy the agent on Windows.

func WithDualShipping

func WithDualShipping() func(*Params) error

DualShipping enables dual shipping. By default the agent is configured to send data only to the fakeintake and not dddev (the fakeintake will forward payloads to dddev). With that flag data will be sent to the fakeintake and also to dddev.

func WithFIPS

func WithFIPS() func(*Params) error

func WithFakeintake

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

WithFakeintake configures the Agent to use the given fake intake.

func WithGKEAutopilot

func WithGKEAutopilot() func(*Params) error

func WithGPUMonitoring added in v0.76.0

func WithGPUMonitoring() func(*Params) error

WithGPUMonitoring enables GPU monitoring in the agent.

func WithHelmChartPath

func WithHelmChartPath(chartPath string) func(*Params) error

WithHelmChartPath specifies the remote chart name or local chart path to use for the agent installation.

func WithHelmChartVersion added in v0.79.0

func WithHelmChartVersion(version string) func(*Params) error

WithHelmChartVersion overrides the Helm chart version for this installation. Use this to pin a specific chart version without changing the global framework default.

func WithHelmRepoURL

func WithHelmRepoURL(repoURL string) func(*Params) error

WithHelmRepoURL specifies the remote Helm repo URL to use for the agent installation.

func WithHelmValues

func WithHelmValues(values string) func(*Params) error

WithHelmValues adds helm values to the agent installation. If used several times, the helm values are merged together If the same values is defined several times the latter call will override the previous one.

func WithHostname added in v0.77.0

func WithHostname(hostname string) func(*Params) error

WithHostname sets the hostname of the agent.

func WithJMX

func WithJMX() func(*Params) error

func WithKubernetesUseEndpointSlices added in v0.78.0

func WithKubernetesUseEndpointSlices() func(*Params) error

func WithNamespace

func WithNamespace(namespace string) func(*Params) error

WithNamespace sets the namespace to deploy the agent to.

func WithOTelAgent

func WithOTelAgent() func(*Params) error

func WithOTelAgentGateway added in v0.75.0

func WithOTelAgentGateway() func(*Params) error

func WithOTelConfig

func WithOTelConfig(config string) func(*Params) error

func WithOTelGatewayConfig added in v0.75.0

func WithOTelGatewayConfig(config string) func(*Params) error

func WithOpenShiftControlPlaneMonitoring added in v0.82.0

func WithOpenShiftControlPlaneMonitoring() func(*Params) error

WithOpenShiftControlPlaneMonitoring configures OpenShift control plane monitoring.

func WithPulumiResourceOptions

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

WithPulumiDependsOn sets the resources to depend on.

func WithStackIDTag added in v0.78.0

func WithStackIDTag(stackID pulumi.StringInput) func(*Params) error

WithStackIDTag sets the stackid tag on the agent using a pulumi.StringInput.

func WithTags

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

func WithTimeout added in v0.77.0

func WithTimeout(timeoutSeconds int) func(*Params) error

WithTimeout sets the timeout for Helm operations in seconds

func WithWindowsImage added in v0.77.0

func WithWindowsImage() func(*Params) error

func WithoutLogsContainerCollectAll

func WithoutLogsContainerCollectAll() func(*Params) error

WithoutLogsContainerCollectAll disables collection of logs from all containers by default.

Types

type Option

type Option = func(*Params) error

type Params

type Params struct {
	// BaseName is the base name used to derive the Helm release and Pulumi resource
	// names for this Agent installation. It defaults to "dda". Override it (e.g. via
	// WithBaseName) when deploying multiple Agent installations in the same cluster to
	// avoid resource name collisions.
	BaseName string
	// AgentFullImagePath is the full path of the docker agent image to use.
	AgentFullImagePath string
	// ClusterAgentFullImagePath is the full path of the docker cluster agent image to use.
	ClusterAgentFullImagePath string
	// AgentImageTag is the agent image tag (e.g. a version like "7.55.0") to use when no
	// full image path is given. Ignored when AgentFullImagePath is set. See
	// WithAgentVersion.
	AgentImageTag string
	// ClusterAgentImageTag is the cluster agent image tag to use when no full image path
	// is given. Ignored when ClusterAgentFullImagePath is set. See WithClusterAgentVersion.
	ClusterAgentImageTag string
	// Namespace is the namespace to deploy the agent to.
	Namespace string
	// Hostname is the hostname of the agent.
	Hostname string
	// HelmRepoURL is the Helm repo URL to use for the agent installation.
	HelmRepoURL string
	// HelmChartPath is the Helm chart path to use for the agent installation.
	HelmChartPath string
	// HelmValues is the Helm values to use for the agent installation.
	HelmValues pulumi.AssetOrArchiveArray
	// PulumiDependsOn is a list of resources to depend on.
	PulumiResourceOptions []pulumi.ResourceOption
	// FakeIntake is the fake intake to use for the agent installation.
	FakeIntake *fakeintake.Fakeintake
	// DeployWindows is a flag to deploy the agent on Windows.
	DeployWindows bool
	// DisableLogsContainerCollectAll is a flag to disable collection of logs from all containers by default.
	DisableLogsContainerCollectAll bool
	// DualShipping is a flag to enable dual shipping.
	DualShipping bool
	// OTelAgent is a flag to deploy the OTel agent.
	OTelAgent bool
	// OTelAgentGateway is a flag to deploy the OTel agent with gateway enabled.
	OTelAgentGateway bool
	// OTelConfig is the OTel configuration to use for the agent installation.
	OTelConfig string
	// OTelGatewayConfig is the OTel configuration to use for the gateway collector installation.
	OTelGatewayConfig string
	// GKEAutopilot is a flag to deploy the agent with only GKE Autopilot compatible values.
	GKEAutopilot bool
	// FIPS is a flag to deploy the agent with FIPS agent image.
	FIPS bool
	// JMX is a flag to deploy the agent with JMX agent image.
	JMX bool
	// WindowsImage is a flag to use Windows-compatible image (multi-arch with Windows).
	WindowsImage bool
	// TimeoutSeconds is the timeout for Helm operations in seconds (default: 300)
	TimeoutSeconds int
	// HelmChartVersion overrides the default Helm chart version for this installation.
	// When empty, the framework default HelmVersion is used.
	HelmChartVersion string
	// OpenShiftControlPlaneMonitoring enables OpenShift control plane monitoring setup.
	OpenShiftControlPlaneMonitoring bool
}

func NewParams

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

Jump to

Keyboard shortcuts

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