Documentation
¶
Index ¶
- Constants
- func WithAdditionalInstallParameters(parameters []string) func(*Params) error
- func WithAgentConfig(config string) func(*Params) error
- func WithFakeintake(fi *fakeintake.Fakeintake) func(*Params) error
- func WithFile(absolutePath string, content string, useSudo bool) func(*Params) error
- func WithFileWithPermissions(absolutePath string, content string, useSudo bool, ...) func(*Params) error
- func WithFlavor(flavor string) func(*Params) error
- func WithHostname(hostname string) func(*Params) error
- func WithIntakeHostname(scheme string, hostname string) func(*Params) error
- func WithIntegration(folderName string, content string) func(*Params) error
- func WithLatest() func(*Params) error
- func WithLatestNightly() func(*Params) error
- func WithLocalPackage(path string) func(*Params) error
- func WithLogs() func(*Params) error
- func WithMajorVersion(majorVersion string) func(*Params) error
- func WithPipeline(pipelineID string) func(*Params) error
- func WithPulumiResourceOptions(resources ...pulumi.ResourceOption) func(*Params) error
- func WithSecurityAgentConfig(config string) func(*Params) error
- func WithSkipAPIKeyInConfig() func(*Params) error
- func WithSystemProbeConfig(config string) func(*Params) error
- func WithTags(tags []string) func(*Params) error
- func WithTelemetry() func(*Params) error
- func WithV3MetricsDisabled() func(*Params) error
- func WithVersion(version string) func(*Params) error
- type FileDefinition
- type Option
- type PackageVersion
- type Params
Constants ¶
const ( StableChannel channel = "stable" BetaChannel channel = "beta" NightlyChannel channel = "nightly" )
const ( DefaultFlavor = BaseFlavor BaseFlavor = "datadog-agent" FIPSFlavor = "datadog-fips-agent" )
Agent flavor constants
PackageVersion.Flavor is in some cases passed directly to underlying install scripts, so this list is not exhaustive.
See PackageFlavor https://github.com/DataDog/agent-release-management/blob/main/generator/const.py
Variables ¶
This section is empty.
Functions ¶
func WithAdditionalInstallParameters ¶
WithAdditionalInstallParameters passes a list of parameters to the underlying installer
func WithAgentConfig ¶
WithAgentConfig sets the configuration of the Agent.
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 WithFile ¶
WithFile adds a file with contents to the install at the given path. This should only be used when the agent needs to be restarted after writing the file.
func WithFileWithPermissions ¶
func WithFileWithPermissions(absolutePath string, content string, useSudo bool, perms option.Option[perms.FilePermissions]) func(*Params) error
WithFileWithPermissions adds a file like WithFile but we can predefine the permissions of the file.
func WithFlavor ¶
WithFlavor use a specific flavor of the Agent. For example: `datadog-fips-agent`
See PackageFlavor https://github.com/DataDog/agent-release-management/blob/main/generator/const.py
func WithHostname ¶
WithHostname add hostname to the agent configuration
func WithIntakeHostname ¶
WithIntakeName configures the agent to use the given hostname as intake.
To use a fakeintake, see WithFakeintake.
This option is overwritten by `WithFakeintake`.
func WithIntegration ¶
WithIntegration adds the configuration for an integration.
func WithLatest ¶
WithLatest uses the latest Agent 7 version in the stable channel.
func WithLatestNightly ¶
func WithLocalPackage ¶
WithLocalPackage use a local package of the Agent
func WithMajorVersion ¶
WithMajorVersion specify the major version of the Agent
func WithPipeline ¶
WithPipeline use a specific version of the Agent by pipeline id
func WithPulumiResourceOptions ¶
func WithPulumiResourceOptions(resources ...pulumi.ResourceOption) func(*Params) error
func WithSecurityAgentConfig ¶
WithSecurityAgentConfig sets the configuration of the security-agent.
func WithSkipAPIKeyInConfig ¶
WithSkipAPIKeyInConfig does not add the API key in the Agent configuration file.
func WithSystemProbeConfig ¶
WithSystemProbeConfig sets the configuration of system-probe.
func WithTelemetry ¶
WithTelemetry enables the Agent telemetry go_expvar and openmetrics.
func WithV3MetricsDisabled ¶
WithV3MetricsDisabled forces the agent onto the V2 series intake API by setting 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 WithVersion ¶
WithVersion use a specific version of the Agent. For example: `6.39.0` or `7.41.0~rc.7-1`
Types ¶
type FileDefinition ¶
type PackageVersion ¶
type Params ¶
type Params struct {
Version PackageVersion
AgentConfig string
SystemProbeConfig string
SecurityAgentConfig string
Integrations map[string]*FileDefinition
Files map[string]*FileDefinition
ExtraAgentConfig []pulumi.StringInput
ResourceOptions []pulumi.ResourceOption
// This is a list of additional installer flags that can be used to pass installer-specific
// parameters like the MSI flags.
AdditionalInstallParameters []string
SkipAPIKeyInConfig bool
}
Source Files
Directories