加载中

Elastic Agent 环境变量

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

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

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

设置 描述

ELASTICSEARCH_HOST
(字符串) 要与之通信的 Elasticsearch 主机。

默认值: http://elasticsearch:9200

ELASTICSEARCH_USERNAME
(字符串) 用于连接到 Kibana 并为 Fleet 检索 service_token 的基本身份验证用户名。

默认值: 无 (none)

ELASTICSEARCH_PASSWORD
(字符串) 用于连接到 Kibana 并为 Fleet 检索 service_token 的基本身份验证密码。

默认值: 无 (none)

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

默认值: 无 (none)

ELASTICSEARCH_CA
(字符串) 证书颁发机构 (CA) 的路径。

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

默认值: ""

KIBANA_HOST
(字符串) Kibana 主机。

默认值: http://kibana:5601

KIBANA_USERNAME
(字符串) 用于连接到 Kibana 以检索 service_token 的基本身份验证用户名。

默认值: elastic

KIBANA_PASSWORD
(字符串) 用于连接到 Kibana 以检索 service_token 的基本身份验证密码。

默认值: changeme

KIBANA_CA
(字符串) 证书颁发机构 (CA) 的路径。

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

默认值: ""

ELASTIC_NETINFO
(布尔值) 当为 false 时,关闭 add_host_metadata 处理程序的 netinfo.enabled 参数。对于 host.iphost.mac 字段索引大小会增加的大规模设置,请将此项设置为 false

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

默认值: "false"

STATE_PATH
(字符串) Elastic Agent 存储其应用程序数据(包括注册状态和日志游标)的目录路径。将其设置为挂载的卷路径,以便在容器重启之间保留代理状态。有关更多信息,请参阅 持久化代理状态 (Persist agent state)

默认值: /usr/share/elastic-agent/state

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

设置 描述

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

默认值: http://kibana:5601

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

默认值: elastic

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

默认值: changeme

KIBANA_FLEET_CA
(字符串) 证书颁发机构的路径。设置时会覆盖 KIBANA_CA

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

默认值: ""

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

设置 描述

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

默认值: 无 (none)

FLEET_SERVER_ELASTICSEARCH_HOST
(字符串) Fleet Server 用于与之通信的 Elasticsearch 主机。设置时会覆盖 ELASTICSEARCH_HOST

默认值: http://elasticsearch:9200

FLEET_SERVER_ELASTICSEARCH_CA
(字符串) 用于与 Elasticsearch 通信的证书颁发机构文件的路径。设置时会覆盖 ELASTICSEARCH_CA。这是使用 FLEET_SERVER_ELASTICSEARCH_CA_TRUSTED_FINGERPRINT 的另一种选择。

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

默认值: ""

FLEET_SERVER_ES_CERT
(字符串) Fleet Server 将用于连接到 Elasticsearch 的双向 TLS 客户端证书的路径。

默认值: ""

FLEET_SERVER_ES_CERT_KEY
(字符串) Fleet Server 将用于连接到 Elasticsearch 的双向 TLS 私钥的路径。

默认值: ""

FLEET_SERVER_INSECURE_HTTP
(布尔值) 当为 true 时,Fleet Server 通过不安全或未经验证的 HTTP 公开。除非必要,否则不要将其设置为 true

默认值: false

FLEET_SERVER_SERVICE_TOKEN
(字符串) 用于与 Elasticsearch 和 Kibana 通信的服务令牌。如果同时指定了服务令牌值和服务令牌路径,则该值可用于设置,并且该路径会被传递给容器中的代理。

默认值: 无 (none)

FLEET_SERVER_SERVICE_TOKEN_PATH
(字符串) 用于与 Elasticsearch 和 Kibana 通信的服务令牌文件的路径。如果同时指定了服务令牌值和服务令牌路径,则该值可用于设置,并且该路径会被传递给容器中的代理。

默认值: 无 (none)

FLEET_SERVER_POLICY_NAME
(字符串) Fleet Server 在自身上使用的策略名称。设置时会覆盖 FLEET_TOKEN_POLICY_NAME

默认值: 无 (none)

FLEET_SERVER_POLICY_ID
(字符串) Fleet Server 在自身上使用的策略 ID。

FLEET_SERVER_HOST
(字符串) Fleet Server HTTP 的绑定主机。会覆盖策略中定义的主机。

默认值: 无 (none)

FLEET_SERVER_PORT
(字符串) Fleet Server HTTP 的绑定端口。会覆盖策略中定义的端口。

默认值: 无 (none)

FLEET_SERVER_CERT
(字符串) 用于 HTTPS 的证书路径。

默认值: 无 (none)

FLEET_SERVER_CERT_KEY
(字符串) 用于 HTTPS 的证书私钥路径。

默认值: 无 (none)

FLEET_SERVER_CERT_KEY_PASSPHRASE
(字符串) 加密私钥文件的私钥密码路径。

默认值: 无 (none)

FLEET_SERVER_CLIENT_AUTH
(字符串) noneoptionalrequired 之一。Fleet Server 用于客户端 mTLS 连接的客户端身份验证选项。如果指定了 optionalrequired,则使用 CA 验证客户端证书。

默认值: none

FLEET_SERVER_ELASTICSEARCH_CA_TRUSTED_FINGERPRINT
(字符串) 在 TLS 握手期间由 Elasticsearch 发送的证书链中存在的证书颁发机构的 SHA-256 指纹(哈希)。如果在链中找到此证书,它将被添加到受信任的 CA 中。

这是使用 FLEET_SERVER_ELASTICSEARCH_CA 的另一种选择。有关更多信息,请参阅 使用证书指纹 (Using certificate fingerprints)

默认值: ""

FLEET_DAEMON_TIMEOUT
(持续时间) 设置以指示 Fleet Server 在引导过程中等待 Elastic Agent 的时间。

FLEET_SERVER_TIMEOUT
(持续时间) 设置以指示 Elastic Agent 等待 Fleet Server 签到为健康状态的时间。

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

设置 描述

ELASTIC_AGENT_CERT
(字符串) Elastic Agent 将用于连接到 Fleet Server 的双向 TLS 客户端证书的路径。

ELASTIC_AGENT_CERT_KEY
(字符串) Elastic Agent 将用于连接到 Fleet Server 的双向 TLS 私钥的路径。

ELASTIC_AGENT_CERT_KEY_PASSPHRASE
(字符串) 包含双向 TLS 私钥密码短语的文件的路径,该私钥由 Elastic Agent 用于连接到 Fleet Server。该文件必须仅包含密码短语的字符,不能有换行符或其他非打印字符。

仅当 --elastic-agent-cert-key 被加密且需要密码短语才能使用时,才会使用此选项。

ELASTIC_AGENT_ID
(字符串) 将 Elastic Agent 注册到 Fleet Server 时使用的唯一标识符(代理 ID)。在还原以前注册的代理时,或在代理无法在重新部署之间持久保存注册数据的无状态容器化环境中,此设置非常有用。

如果具有相同 ID 的代理已经注册到 Fleet 中,除非使用 FLEET_REPLACE_TOKEN 环境变量提供了有效的替换令牌,否则注册将失败。

默认值: ""

ELASTIC_AGENT_TAGS
(字符串) 要应用于 Fleet 管理的 Elastic Agents 的逗号分隔标签列表。您可以使用这些标签在 Fleet 中过滤代理列表。

FLEET_ENROLL
(布尔值) 设置为 1 以将 Elastic Agent 注册到 Fleet Server 中。

默认值: false

FLEET_FORCE
(布尔值) 设置为 true 以强制覆盖当前的 Elastic Agent 配置,而不提示进行确认。在使用自动化软件或脚本化部署时,此标志非常有用。

默认值: false

FLEET_URL
(字符串) 用于将 Fleet Server 注册到的 URL。

默认值: ""

FLEET_ENROLLMENT_TOKEN
(字符串) 用于注册的令牌。

默认值: ""

FLEET_REPLACE_TOKEN
(字符串) 在 Elastic Agent 注册到 Fleet Server 后,可用于替换它的令牌。首次使用特定代理 ID 注册代理时,必须提供 FLEET_REPLACE_TOKEN 环境变量。随后,可以通过使用相同的 ELASTIC_AGENT_IDFLEET_REPLACE_TOKEN 环境变量注册另一个代理来替换该代理。一旦被替换,原始代理将无法再与 Fleet 通信。

如果在没有替换令牌的情况下注册 Elastic Agent,则无法由具有相同 ID 的另一个代理替换它。该机制要求替换令牌与存储在 Fleet 中的哈希令牌匹配,从而防止意外或恶意的接管。

默认值: ""

FLEET_TOKEN_NAME
(字符串) 用于从 Kibana 获取令牌的令牌名称。

默认值: ""

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

默认值: false

FLEET_CA
(字符串) 证书颁发机构的路径。设置时会覆盖 ELASTICSEARCH_CA

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

默认值: false

FLEET_INSECURE
(布尔值) 当为 true 时,Elastic Agent 通过不安全或未经验证的 HTTP 与 Fleet Server 通信。除非必要,否则不要将其设置为 true

默认值: false

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

默认值: http://kibana:5601

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

默认值: elastic

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

默认值: changeme

KIBANA_FLEET_CA
(字符串) 证书颁发机构的路径。设置时会覆盖 KIBANA_CA

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

默认值: ""
© . This website operates independently and is not affiliated with or endorsed by Elasticsearch B.V. All brand names, logos, and trademarks are the property of their respective owners.