title: metadata服务

title: metadata服务

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/<version>/<path>

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

Metadata 的版本

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

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

metadata 的版本是基于日期的。

版本变化

V1 vs. V2

当通过 http 请求访问路径 /services/<service-name>/containers或者/stacks/<stack-name>/services/<service-name>/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/<service-name>，可以访问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_index
dns/
dns_search/
external_id
health_check_hosts/
health_state
host_uuid
hostname
ips/
labels/
memory_reservation
milli_cpu_reservation
name
network_from_container_uuid
network_uuid
ports/
primary_ip
primary_mac_address
service_index
service_name
stack_name
stack_uuid
start_count
state
system
uuid
$ curl 'http://rancher-metadata/2015-12-19/self/container/name'
# Note: Curl 不会返回新的行，只有一个数据时返回会输出在同一行
Default_Example_1$root@<container_id>
$ curl 'http://rancher-metadata/2015-12-19/self/container/label/io.rancher.stack.name'
Default$root@<container_id>
# 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/<service-name>'

Metadata 属性

容器

服务

应用

主机

为服务添加用户自定义 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/<service_id>/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'
name
value
$ curl 'http://rancher-metadata/latest/self/service/metadata/example/name'
# # Note: Curl 不会返回新的行，只有一个数据时返回会输出在同一行
hello$root@<container_id>