元数据服务

Rancher通过我们的元数据基础设施服务为您的服务和容器提供数据。该数据可用于管理运行的Docker实例，以通过基于HTTP的API直接访问的元数据服务的形式。这些数据可以包括在创建Docker容器、Rancher服务或运行时数据时的静态信息，比如相同服务中的对等容器的发现信息。

使用Rancher的元数据服务，您可以使用Rancher管理网络执行任何容器，并检索Rancher中的容器的信息。元数据可以与容器、容器所在的服务或堆栈或容器所在的主机相关。元数据是JSON格式的。

容器可以通过多种方式在Rancher管理网络中启动。阅读更多关于网络在Rancher中的工作原理。

如何获取元数据

从Rancher UI中，您可以通过从容器的下拉列表中选择Execute Shell来执行到容器的shell。通过悬停在容器上可以找到下拉。

要获取元数据，您将运行一个curl命令。

# 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命令中，我们强烈建议您使用特定版本，但也可以选择latest。

注意：当我们对我们的latest版本进行更改时，返回的数据可能会在任何版本中更改，并与您的代码不兼容。

元数据服务的版本是基于日期。

版本差异

V1 vs. V2

钻孔时下降到容器中使用在结束的HTTP路径/services/<service-name>/containers或/stacks/<stack-name>/services/<service-name>/containers，V1返回容器名称（一个或多个）和V2返回容器对象（一个或多个）。更多信息与元数据服务的V2一起提供。

Example

在Rancher中，有一个堆栈被调用foostack，它包含一个叫做barservice3个容器的服务。

# Using V1 returns only container names of the service
$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-07-25/services/barservice/containers'
["foostack_barservice_1", "foostack_barservice_2", "foostack_barservice_1"]

# Using V2 returns container objects of the service
$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/services/barservice/containers'
[{"create_index":1, "health_state":null,"host_uuid":...
...
# Lists all metadata for all containers of the service
...
...}]

# Using V2, you can drill down to a specific container's 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":...
...
# Lists all metadata for all containers of the service
...
...}]

# Using /stacks/<service-name>, you can drill down to services and containers

# Using V1 returns only container names of the service
$ 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"]

# Using V2 returns container objects of the service
$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/stacks/foostack/services/barservice/containers'
[{"create_index":1, "health_state":null,"host_uuid":...
...
# Lists all metadata for all containers of the service
...
...}]

明文与JSON

元数据可以以明文或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 will not provide a new line, so single values will be on same line as the command prompt
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 can use either the index or name to go get the values
$ curl 'http://rancher-metadata/2015-12-19/services'
0=Example
# You can either user the index or name as a path
$ curl 'http://rancher-metadata/2015-12-19/services/0'
$ curl 'http://rancher-metadata/2015-12-19/services/Example'

JSON

可以通过向Accept: application/jsoncurl命令添加头来检索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'
# Retrieve the metadata for another service in the stack
$ curl --header 'Accept: application/json' 'http://rancher-metadata/2015-12-19/services/<service-name>'

元数据字段

Container

Service

Stack

Host

向用户添加用户元数据

Rancher允许用户将自己的元数据添加到服务中。目前，这只有通过Rancher Compose才能支持，元数据是rancher-compose.yml文件的一部分。在metadata密钥中，yaml将被解析为JSON格式以供元数据服务使用。

例 rancher-compose.yml

service:
  # Scale of service
  scale: 3
  # User added metadata
  metadata:
    example:
      name: hello
      value: world
    example2:
      foo: bar

之后，服务就到了，你可以在使用元数据服务发现的元数据.../self/service/metadata或.../services/<service_id>/metadata。.../services/<service_id>/metadata.

JSON Query

$ curl --header 'Accept: application/json' 'http://rancher-metadata/latest/self/service/metadata'
{"example":{"name":"hello","value":"world"},"example2":{"foo":"bar"}}

Plaintext Queries

$ 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 will not provide a new line, so single values will be on same line as the command prompt
hello$root@<container_id>