metadata服务

2023-05-02 07:07| 来源: 网络整理| 查看: 265

Rancher 通过基础设施中的 Metadata 服务为服务和容器提供数据。这些数据用来管理运行中的 docker 实例。这些数据可以通过调用基于 HTTP 的 API 来访问。这些数据包括创建容器，服务时的静态数据，也包括运行时数据，例如:在同一个服务里的其他容器的相关信息。

通过 Rancher 的 Metadata 服务，您可以进到任何使用 Rancher 托管网络的容器的命令行中，并查看运行在 Rancher 中的容器的信息。通过 Metadata 服务您可以获取容器，服务，容器所在的应用，容器所在的主机。Metadata 是 JSON 格式的。

有多种方式可以将容器运行在 Rancher 托管网络中。Rancher 网络的原理详见网络相关文档。

如何获取 Metadata#

通过 Rancher UI，您可以通过容器的下拉菜单的执行命令行进入运行命令界面。在鼠标悬停在容器上时，会显示容器名和右侧的下拉菜单。

您可以通过 curl 命令获取 metadata 信息。

# If curl is not installed, install it$ apt-get install curl# Basic curl command to obtain a plaintext response$ curl http://rancher-metadata//

curl 请求的路径取决于您想要获取的 metadata 信息和格式。

Metadata路径描述容器self/container提供运行命令的容器的 metadata 信息容器所在服务self/service提供运行命令的容器对应服务的 metadata 信息容器所在应用self/stack提供运行命令的容器对应应用的 metadata 信息容器所在主机self/host提供运行命令的容器对应主机的 metadata 信息其他容器containers提供所有容器的 metadata 信息。在纯文本格式时，提供了带上索引序号的所有容器。在 JSON 格式，提供了所有容器的所有 metadata 信息。使用序号或者名字。都可以获取指定容器的 metadata 信息。其他服务services提供了所有服务的 metadata 信息。在纯文本格式时，提供了带上索引序号的所有服务。在 JSON 格式，提供了所有服务的所有 metadata 信息。在路径中使用序号或者名字，都可以获取指定服务的 metadata 信息。当访问容器详细信息时，在 V1 (2015-07-25)只返回容器名称，但是在 V2 (2015-12-19)，容器实例也会返回。其他应用stacks/提供了所有应用的 metadata 信息。在纯文本格式，提供了带上索引序号的所有应用。在 JSON 格式，提供了所有应用的所有 metadata 信息。使用序号或者名字。都可以获取指定容器的 metadata 信息。在路径中使用序号或者名字，都可以获取指定应用的 metadata 信息。当访问 container 详细信息时，在 V1 (2015-07-25)只返回容器名称，但是在 V2 (2015-12-19)，容器实例也会返回。Metadata 的版本#

在curl命令中，我们强烈建议使用确定的版本号，但是您也可以选者latest。

注意: 因为latest版本会包含最新的代码变动，各个版本的返回的数据可能不同，需要确认是否和您之前的代码能够兼容。

metadata 的版本是基于日期的。

Version ReferenceVersionV22015-12-19V12015-07-25版本变化#V1 vs. V2#

当通过 http 请求访问路径 /services//containers或者/stacks//services//containers时, V1 返回容器名称，V2 返回容器实例。更多详细信息在 V2 metadata 服务中提供。

范例#

在 Rancher 中，名为foostack的应用包含一个有三个容器的服务 barservice。

# 在V1只返回service的container names$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-07-25/services/barservice/containers'["foostack_barservice_1", "foostack_barservice_2", "foostack_barservice_1"] # 在V2中返回service的container objects$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/services/barservice/containers'[{"create_index":1, "health_state":null,"host_uuid":......# 获取service中所有容器的metadata信息......}] # 在V2，可以获取指定的container object$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/services/barservice/containers/foostack_barservice_1'[{"create_index":1, "health_state":null,"host_uuid":......# 获取service中所有容器的metadata信息......}] # 通过路径 /stacks/，可以访问services和containers # 使用V1只返回service的container names$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-07-25/stacks/foostack/services/barservice/containers'["foostack_barservice_1", "foostack_barservice_2", "foostack_barservice_1"] # 使用V2返回service的container objects$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/stacks/foostack/services/barservice/containers'[{"create_index":1, "health_state":null,"host_uuid":......# 获取service中所有容器的metadata信息......}]纯文本 vs JSON#

Metadata 返回有纯文本和 JSON 两种格式，根据需要选择相应格式.

纯文本#

通过 curl 命令，会获得请求路径的纯文本格式返回。您可以通过从第一层路径开始，层层推进，找到您需要的信息。

$ curl 'http://rancher-metadata/2015-12-19/self/container'create_indexdns/dns_search/external_idhealth_check_hosts/health_statehost_uuidhostnameips/labels/memory_reservationmilli_cpu_reservationnamenetwork_from_container_uuidnetwork_uuidports/primary_ipprimary_mac_addressservice_indexservice_namestack_namestack_uuidstart_countstatesystemuuid$ curl 'http://rancher-metadata/2015-12-19/self/container/name'# Note: Curl 不会返回新的行，只有一个数据时返回会输出在同一行Default_Example_1$root@$ curl 'http://rancher-metadata/2015-12-19/self/container/label/io.rancher.stack.name'Default$root@# Arrays可以通过序号或者名字访问$ curl 'http://rancher-metadata/2015-12-19/services'0=Example# 使用序号或者名字$ curl 'http://rancher-metadata/2015-12-19/services/0'$ curl 'http://rancher-metadata/2015-12-19/services/Example'JSON#

JSON 格式的返回可以通过在 curl 命令中增加 header Accept: application/json

$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/self/container'$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/self/stack'# 获取stack中另一个service的信息$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/services/'Metadata 属性#容器#属性描述create_index容器启动的序号例如 2 代表的是服务中启动的第二个容器。注意: Create_index 不会被重用。如果您的服务包含两个容器，删除了第二个容器，下一个启动的容器的create_index会是 3，即使服务中只包含 2 个容器dns容器的 DNS 服务器。dns_search容器的搜索域。external_id在主机上的 Docker 容器 ID。health_check_hosts列出运行健康检查的主机的的 UUIDs。health_state开启健康检查的容器的健康状态健康检查。host_uuidRancher Server 分配给主机的唯一标识。hostname容器的 hostname。ips支持多 NIC 时的 IP 列表labels容器标签列表。格式为key:value。memory_reservation容器可以使用内存的软限制。milli_cpu_reservation容器可以使用 CPU 的软限制，值为正整数，1 代表 1/1000CPU。所以，1000 代表 1 个 CPU，500 代表半个 CPU。name容器的名字。network_from_container_uuid容器网络来源的容器 UUID。network_uuidRancher 分配的网络唯一标识ports列出容器使用的端口。格式为: hostIP:publicIP:privateIP[/protocol].primary_ip容器 IPprimary_mac_address容器的 MAC 地址service_index服务中容器名称的最后一个数字service_name服务名称(如果存在)stack_name服务所在的应用的名称(如果存在)stack_uuidRancher 分配的应用的唯一标识start_count容器启动的次数state容器状态system容器是否是 Rancher基础设施服务uuidRancher 分配容器唯一标识服务#属性描述containers列出服务中的容器名称create_index服务中最后启动的容器的序号例如 2 代表的是服务中启动的第二个容器。注意: Create_index 不会被重用。如果您的服务包含 2 个容器，删除了第二个容器，下一个启动的容器的create_index会是 3，即使服务中只包含 2 个容器expose对主机暴露，但是不对外暴露的端口external_ips内部服务的 IP 列表fqdn服务的全称域名health_check服务的健康检查配置hostname内部服务的 CNAMEkindRancher 的服务类型labels服务标签列表，格式为 key:value.lb_config负载均衡的配置metadata用户添加的 metadataname服务名称ports服务使用的端口。格式hostIP:publicIP:privateIP[/protocol].primary_service_name主服务名，如果有从服务scale服务中容器的规模数量sidekicks从容器服务的名称列表stack_name服务所在的应用的名称stack_uuidRancher 分配的应用的唯一标识system是否是基础设施服务uuidRancher 分配的服务的唯一标识应用#属性描述environment_name应用所在的环境的名字environment_uuidRancher 分配的环境的唯一标识name应用名称services应用中的服务列表system应用是否为基础设施服务uuidRancher 分配的应用的唯一标识主机#属性描述agent_ipRancher Agent 的 IP，例如 CATTLE_AGENT_IP环境变量值。hostname主机的名称labels主机标签列表。格式为key:value.local_storage_mb主机的存储大小，单位为 MBmemory主机的内存大小，单位为 MBmilli_cpu主机的 CPU。数值为整数，1 代表 1/1000 的 cpu。所以，1000 代表 1 CPU.name主机的名称uuidRancher 分配的主机的唯一标识为服务添加用户自定义 Metadata#

Rancher 支持为服务添加用户 metadata。现在只支持通过Rancher Compose添加，metadata 是rancher-compose.yml的一部分。metadatakey 对应的部分，yaml 会被转化成在 metadata-service 中使用的 JSON 格式

Example rancher-compose.yml#service: # Scale of service scale: 3 # User added metadata metadata: example: value: world example2: foo: bar

服务启动后，可以使用 metadata 服务在.../self/service/metadata或者.../services//metadata看到 metadata 数据

按照 JSON 格式查询#$ curl --header 'Accept: application/json' 'http://rancher-metadata/latest/self/service/metadata'{"example":{"name":"hello","value":"world"},"example2":{"foo":"bar"}} 按照纯文本格式查询#$ curl 'http://rancher-metadata/latest/self/service/metadata'example/$ curl 'http://rancher-metadata/latest/self/service/metadata/example'namevalue$ curl 'http://rancher-metadata/latest/self/service/metadata/example/name'# # Note: Curl 不会返回新的行，只有一个数据时返回会输出在同一行hello$root@

【本文地址】

公司简介

联系我们