加载中

Elastic Agent 环境变量

在容器化环境中运行时,使用环境变量配置 Elastic Agent。本页中的变量按操作类型分组

为了限制需要设置的环境变量数量,可以使用以下常用变量。这些变量可用于所有 Elastic Agent 操作,但优先级低于特定于操作的环境变量。

例如,当使用相同的 Elasticsearch 和 Kibana 凭据来准备 Kibana 中的 Fleet 插件、配置 Fleet Server 和注册 Elastic Agent 时,这些常用变量非常有用。

设置 描述

ELASTICSEARCH_HOST
(string) 用于通信的 Elasticsearch 主机。

默认值: http://elasticsearch:9200

ELASTICSEARCH_USERNAME
(string) 连接到 Kibana 并检索 Fleet 的 service_token 时使用的基本身份验证用户名。

默认值:

ELASTICSEARCH_PASSWORD
(string) 连接到 Kibana 并检索 Fleet 的 service_token 时使用的基本身份验证密码。

默认值:

ELASTICSEARCH_API_KEY
(string) 用于向 Elasticsearch 进行身份验证的 API 密钥。

默认值:

ELASTICSEARCH_CA
(string) 证书颁发机构的路径。

默认情况下,Elastic Agent 使用其运行所在操作系统中的受信任证书颁发机构 (CA) 列表。如果为您的节点证书签名的证书颁发机构不在主机系统的受信任证书颁发机构列表中,请使用此配置添加包含您的 CA 证书的 .pem 文件的路径。

默认值: ""

KIBANA_HOST
(string) Kibana 主机。

默认值: http://kibana:5601

KIBANA_USERNAME
(string) 连接到 Kibana 以检索 service_token 时使用的基本身份验证用户名。

默认值: elastic

KIBANA_PASSWORD
(string) 连接到 Kibana 以检索 service_token 时使用的基本身份验证密码。

默认值: changeme

KIBANA_CA
(string) 证书颁发机构的路径。

默认情况下,Elastic Agent 使用其运行所在操作系统中的受信任证书颁发机构 (CA) 列表。如果为您的节点证书签名的证书颁发机构不在主机系统的受信任证书颁发机构列表中,请使用此配置添加包含您的 CA 证书的 .pem 文件的路径。

默认值: ""

ELASTIC_NETINFO
(bool) 当为 false 时,禁用 add_host_metadata 处理器中的 netinfo.enabled 参数。对于 host.ip 和 host.mac 字段索引大小会增加的大规模设置,建议将其设置为 false

默认情况下,Elastic Agent 初始化 add_host_metadata 处理器。netinfo.enabled 参数定义将 IP 地址和 MAC 地址作为 host.iphost.mac 字段进行摄入。有关更多信息,请参阅 add_host_metadata

默认值: "false"

用于在 Kibana 中准备 Fleet 插件的设置。

设置 描述

KIBANA_FLEET_HOST
(string) 要在其上启用 Fleet 的 Kibana 主机。设置时覆盖 FLEET_HOST

默认值: http://kibana:5601

KIBANA_FLEET_USERNAME
(string) 连接到 Kibana 并检索 service_token 以启用 Fleet 时使用的基本身份验证用户名。设置时覆盖 ELASTICSEARCH_USERNAME

默认值: elastic

KIBANA_FLEET_PASSWORD
(string) 连接到 Kibana 并检索 service_token 以启用 Fleet 时使用的基本身份验证密码。设置时覆盖 ELASTICSEARCH_PASSWORD

默认值: changeme

KIBANA_FLEET_CA
(string) 证书颁发机构的路径。设置时覆盖 KIBANA_CA

默认情况下,Elastic Agent 使用其运行所在操作系统中的受信任证书颁发机构 (CA) 列表。如果为您的节点证书签名的证书颁发机构不在主机系统的受信任证书颁发机构列表中,请使用此配置添加包含您的 CA 证书的 .pem 文件的路径。

默认值: ""

用于在此 Elastic Agent 上引导 Fleet Server 的设置。部署中至少需要一个 Fleet Server。

设置 描述

FLEET_SERVER_ENABLE
(int) 设置为 1 以在此 Elastic Agent 上引导 Fleet Server。设置为 1 时,这也会自动强制进行 Fleet 注册。

默认值:

FLEET_SERVER_ELASTICSEARCH_HOST
(string) Fleet Server 用于通信的 Elasticsearch 主机。设置时覆盖 ELASTICSEARCH_HOST

默认值: http://elasticsearch:9200

FLEET_SERVER_ELASTICSEARCH_CA
(string) 证书颁发机构的路径。设置时覆盖 ELASTICSEARCH_CA

默认情况下,Elastic Agent 使用其运行所在操作系统中的受信任证书颁发机构 (CA) 列表。如果为您的节点证书签名的证书颁发机构不在主机系统的受信任证书颁发机构列表中,请使用此配置添加包含您的 CA 证书的 .pem 文件的路径。

默认值: ""

FLEET_SERVER_ES_CERT
(string) Fleet Server 用于连接到 Elasticsearch 的相互 TLS 客户端证书的路径。

默认值: ""

FLEET_SERVER_ES_CERT_KEY
(string) Fleet Server 用于连接到 Elasticsearch 的相互 TLS 私钥的路径。

默认值: ""

FLEET_SERVER_INSECURE_HTTP
(bool) 当为 true 时,Fleet Server 通过不安全或未验证的 HTTP 暴露。不建议将其设置为 true

默认值: false

FLEET_SERVER_SERVICE_TOKEN
(string) 如果启用了 KIBANA_FLEET_SETUP,则用于与 Elasticsearch 和 Kibana 通信的服务令牌。如果同时指定了服务令牌值和服务令牌路径,则该值可用于设置,并将路径传递给容器中的 Agent。

默认值:

FLEET_SERVER_SERVICE_TOKEN_PATH
(string) 如果启用了 KIBANA_FLEET_SETUP,则用于与 Elasticsearch 和 Kibana 通信的服务令牌文件的路径。如果同时指定了服务令牌值和服务令牌路径,则该值可用于设置,并将路径传递给容器中的 Agent。

默认值:

FLEET_SERVER_POLICY_NAME
(string) Fleet Server 用于自身的策略名称。设置时覆盖 FLEET_TOKEN_POLICY_NAME

默认值:

FLEET_SERVER_POLICY_ID
(string) Fleet Server 用于自身的策略 ID。

FLEET_SERVER_HOST
(string) Fleet Server HTTP 的绑定主机。覆盖策略中定义的主机。

默认值:

FLEET_SERVER_PORT
(string) Fleet Server HTTP 的绑定端口。覆盖策略中定义的端口。

默认值:

FLEET_SERVER_CERT
(string) 用于 HTTPS 的证书路径。

默认值:

FLEET_SERVER_CERT_KEY
(string) 用于 HTTPS 的证书的私钥路径。

默认值:

FLEET_SERVER_CERT_KEY_PASSPHRASE
(string) 加密私钥文件的私钥密码短语的路径。

默认值:

FLEET_SERVER_CLIENT_AUTH
(string) 以下之一:noneoptionalrequired。Fleet Server 的客户端 mTLS 连接的客户端身份验证选项。如果指定 optionalrequired,则使用 CA 验证客户端证书。

默认值: none

FLEET_SERVER_ELASTICSEARCH_CA_TRUSTED_FINGERPRINT
(string) 用于自签名 Elasticsearch 证书的证书颁发机构的 SHA-256 指纹 (hash)。此指纹用于验证 Fleet Server 和 Elastic Agent 启动用于通信的所有输入所呈现的自签名证书。使用自签名证书和 Elasticsearch 时需要此标志。

默认值: ""

FLEET_DAEMON_TIMEOUT
(duration) 设置此值以指示 Fleet Server 在引导过程中将等待 Elastic Agent 多久。

FLEET_SERVER_TIMEOUT
(duration) 设置此值以指示 Elastic Agent 将等待 Fleet Server 报告健康状态多久。

用于将 Elastic Agent 注册到 Fleet Server 的设置。

设置 描述

ELASTIC_AGENT_CERT
(string) Elastic Agent 用于连接到 Fleet Server 的相互 TLS 客户端证书的路径。

ELASTIC_AGENT_CERT_KEY
(string) Elastic Agent 用于连接到 Fleet Server 的相互 TLS 私钥的路径。

ELASTIC_AGENT_CERT_KEY_PASSPHRASE
(string) 包含 Elastic Agent 用于连接到 Fleet Server 的相互 TLS 私钥密码短语的文件的路径。该文件必须只包含密码短语的字符,没有换行符或其他不可打印字符。

此选项仅在 --elastic-agent-cert-key 已加密且需要密码短语才能使用时使用。

ELASTIC_AGENT_TAGS
(string) 应用于 Fleet 管理的 Elastic Agent 的逗号分隔的标签列表。您可以使用这些标签来过滤 Fleet 中的 Agent 列表。

FLEET_ENROLL
(bool) 设置为 1 以将 Elastic Agent 注册到 Fleet Server。

默认值: false

FLEET_FORCE
(bool) 设置为 true 以强制覆盖当前的 Elastic Agent 配置,无需提示确认。在使用自动化软件或脚本部署时,此标志很有用。

默认值: false

FLEET_URL
(string) 用于注册 Fleet Server 的 URL。

默认值: ""

FLEET_ENROLLMENT_TOKEN
(string) 用于注册的令牌。

默认值: ""

FLEET_TOKEN_NAME
(string) 用于从 Kibana 获取令牌的令牌名称。

默认值: ""

FLEET_TOKEN_POLICY_NAME
(string) 用于从 Kibana 获取令牌的令牌策略名称。

默认值: false

FLEET_CA
(string) 证书颁发机构的路径。设置时覆盖 ELASTICSEARCH_CA

默认情况下,Elastic Agent 使用其运行所在操作系统中的受信任证书颁发机构 (CA) 列表。如果为您的节点证书签名的证书颁发机构不在主机系统的受信任证书颁发机构列表中,请使用此配置添加包含您的 CA 证书的 .pem 文件的路径。

默认值: false

FLEET_INSECURE
(bool) 当为 true 时,Elastic Agent 通过不安全或未验证的 HTTP 与 Fleet Server 通信。不建议将其设置为 true

默认值: false

KIBANA_FLEET_HOST
(string) 要在其上启用 Fleet 的 Kibana 主机。设置时覆盖 FLEET_HOST

默认值: http://kibana:5601

KIBANA_FLEET_USERNAME
(string) 连接到 Kibana 并检索 service_token 以启用 Fleet 时使用的基本身份验证用户名。设置时覆盖 ELASTICSEARCH_USERNAME

默认值: elastic

KIBANA_FLEET_PASSWORD
(string) 连接到 Kibana 并检索 service_token 以启用 Fleet 时使用的基本身份验证密码。设置时覆盖 ELASTICSEARCH_PASSWORD

默认值: changeme

KIBANA_FLEET_CA
(string) 证书颁发机构的路径。设置时覆盖 KIBANA_CA

默认情况下,Elastic Agent 使用其运行所在操作系统中的受信任证书颁发机构 (CA) 列表。如果为您的节点证书签名的证书颁发机构不在主机系统的受信任证书颁发机构列表中,请使用此配置添加包含您的 CA 证书的 .pem 文件的路径。

默认值: ""
© . All rights reserved.