Ceph 对象网关配置参考

下列的选项可加入 Ceph 配置文件（一般是 ceph.conf ）的 [client.radosgw.{instance-name}] 段下，这些选项可能 有默认值.如果你没有指定，自就会自动使用默认值。

rgw data

rgw enable apis

rgw cache enabled

rgw cache lru size

rgw socket path

rgw host

rgw port

rgw dns name

rgw script uri

rgw request uri

rgw print continue

rgw remote addr param

rgw op thread timeout

rgw op thread suicide timeout

rgw thread pool size

rgw num rados handles

rgw num control oids

rgw init timeout

rgw mime types file

rgw gc max objs

rgw gc obj min wait

rgw gc processor max time

rgw gc processor period

rgw s3 success create obj status

rgw resolve cname

rgw obj stripe size

rgw extended http attrs

rgw exit timeout secs

rgw get obj window size

rgw get obj max req size

rgw relaxed s3 bucket names

rgw list buckets max chunk

rgw override bucket index max shards

rgw num zone opstate shards

rgw opstate ratelimit sec

rgw curl wait timeout ms

rgw copy obj progress

rgw copy obj progress every bytes

rgw admin entry

rgw content length compat

region （域组）

Ceph 从 v0.67 版开始，通过 region 概念支持 Ceph 对象网关联盟部署和统一的命名空间。 region 定义了位于一或多个域内的 Ceph 对象网关实例的地理位置。

region 的配置不同于一般配置过程，因为不是所有的配置都放在 Ceph 配置文件中。从 Ceph 0.67 版开始，你可以列出所有 region 、获取 region 配置以及设置 region 配置。

列出所有 region

Ceph 集群可包含一系列 region ，可用下列命令列出所有 region

sudo radosgw-admin regions list

radosgw-admin 命令会返回 JSON 格式的 region 列表。

{ "default_info": { "default_region": "default"},
  "regions": [
        "default"]}

获取 region-map

要获取各 region 的详细情况，可执行：

sudo radosgw-admin region-map get

Note

如果你得到了 failed to read region map 错误，先试试 sudo radosgw-admin region-map update 。

获取单个 region

要查看某 region 的配置，执行：

radosgw-admin region get [--rgw-region=<region>]

default 这个 region 的配置大致如此：

{"name": "default",
 "api_name": "",
 "is_master": "true",
 "endpoints": [],
 "hostnames": [],
 "master_zone": "",
 "zones": [
   {"name": "default",
    "endpoints": [],
    "log_meta": "false",
    "log_data": "false"}
  ],
 "placement_targets": [
   {"name": "default-placement",
    "tags": [] }],
 "default_placement": "default-placement"}

设置一个 region

定义 region 需创建一个 JSON 对象、并提供必需的参数：

1. name: region 名字，必需。
2. api_name: 此 region 的 API 名字，可选。
3. is_master: 决定着此 region 是否为主 region ，必需。注：只能有一个主 region 。
4. endpoints: region 内的所有结点列表。例如，你可以用多个域名指向同一 region 区，记得在斜杠前加反斜杠进行转义（ \/ ）。也可以给结点指定端口号（ fqdn:port ），可选。
5. hostnames: region 内所有主机名的列表。例如，这样你就可以在同一 region 内使用多个域名了。可选配置。此列表会自动包含 rgw dns name 配置。更改此配置后需重启所有 radosgw 守护进程。
6. master_zone: region 的主域，可选。若未指定，则选择默认域。注：每个 region 只能有一个主域。
7. zones: region 内所有域的列表。各个域都有名字（必需的）、一系列结点（可选的）、以及网关是否要记录元数据和数据操作（默认不记录）。
8. placement_targets: 放置目标列表（可选）。每个放置目标都包含此放置目标的名字（必需）、还有一个标签列表（可选），这样只有带这些标签的用户可以使用此放置目标（即用户信息中的 placement_tags 字段）。
9. default_placement: 对象索引及数据的默认放置目标，默认为 default-placement 。你可以在用户信息里给各用户设置一个用户级的默认放置目标。

要配置一个 region ，需创建一个包含必需字段的 JSON 对象，把它存入文件（如 region.json ），然后执行下列命令：

sudo radosgw-admin region set --infile region.json

其中 region.json 是你创建的 JSON 文件。

Important

默认 region default 的 is_master 字段值默认为 true 。如果你想新建一 region 并让它作为主 region ，那你必须把 default region 的 is_master 设置为 false ，或者干脆删除 default region 。

最后，更新 region map。

sudo radosgw-admin region-map update

配置 region map

配置 region map的过程包括创建含一或多个 region 的 JSON 对象，还有设置集群的主 region master_region 。 region map内的各 region 都由键/值对组成，其中 key 选项等价于单独配置 region 时的 name 选项， val 是包含单个 region 完整配置的 JSON 对象。

你可以只有一个 region ，其 is_master 设置为 true ，而且必须在 region map末尾设置为 master_region 。下面的 JSON 对象是默认 region map的实例。

{ "regions": [
     { "key": "default",
       "val": { "name": "default",
       "api_name": "",
       "is_master": "true",
       "endpoints": [],
       "hostnames": [],
       "master_zone": "",
       "zones": [
         { "name": "default",
           "endpoints": [],
           "log_meta": "false",
            "log_data": "false"}],
            "placement_targets": [
              { "name": "default-placement",
                "tags": []}],
                "default_placement": "default-placement"
              }
          }
       ],
   "master_region": "default"
}

要配置一个 region map，执行此命令：

sudo radosgw-admin region-map set --infile regionmap.json

其中 regionmap.json 是创建的 JSON 文件。确保你创建了 region map里所指的那些域。最后，更新此map。

sudo radosgw-admin regionmap update

Zones

从 Ceph v0.67 版起， Ceph 对象网关支持zone概念，它是一或多个 Ceph 对象网关实例组成的逻辑组。

zone的配置不同于典型配置过程，因为并非所有配置都位于 Ceph 配置文件内。从 0.67 版起，你可以列出所有zone、获取zone配置、设置zone配置。

列出所有zone

要列出某集群内的所有zone，执行：

sudo radosgw-admin zone list

获取单个zone

要获取某一zone的配置，执行：

sudo radosgw-admin zone get [--rgw-zone=<zone>]

default 这个默认zone的配置大致如此：

{ "domain_root": ".rgw",
  "control_pool": ".rgw.control",
  "gc_pool": ".rgw.gc",
  "log_pool": ".log",
  "intent_log_pool": ".intent-log",
  "usage_log_pool": ".usage",
  "user_keys_pool": ".users",
  "user_email_pool": ".users.email",
  "user_swift_pool": ".users.swift",
  "user_uid_pool": ".users.uid",
  "system_key": { "access_key": "", "secret_key": ""},
  "placement_pools": [
      {  "key": "default-placement",
         "val": { "index_pool": ".rgw.buckets.index",
                  "data_pool": ".rgw.buckets"}
      }
    ]
  }

配置zone

配置zone时需指定一系列的 Ceph 对象网关存储池。为保持一致性，我们建议用region名作为存储池名字的前缀。存储池配置见存储池。

要配置起一个zone，需创建包含存储池的 JSON 对象、并存入文件（如 zone.json ）；然后执行下列命令，把 {zone-name} 替换为zone名称：

sudo radosgw-admin zone set --rgw-zone={zone-name} --infile zone.json

其中， zone.json 是你创建的 JSON 文件。

region 和 zone 选项

你可以在 Ceph 配置文件中的各实例 [client.radosgw.{instance-name}] 段下设置下列选项。

New in version v.67.

rgw zone

New in version v.67.

rgw region

New in version v.67.

rgw default region info oid

存储池

Ceph zone会映射一系列 Ceph 存储集群的存储池。

手动创建存储池与自动生成的存储池对比

如果你给 Ceph 对象网关的用户 key 分配了写权限，此网关就有能力自动创建存储池。这样虽然便捷，但 Ceph 对象存储集群的 PG 数会是默认值（此值也许不太理想）或者 Ceph 配置文件中的自定义配置。如果你想让 Ceph 对象网关自动创建存储池，确保 PG 数的默认值要合理。详情见存储池配置，关于创建存储池见集群存储池。

Ceph 对象网关的默认 zone 的默认存储池有：

• .rgw
• .rgw.control
• .rgw.gc
• .log
• .intent-log
• .usage
• .users
• .users.email
• .users.swift
• .users.uid

你应该能够清晰地判断某个 zone 会怎样访问各存储池。你可以为每个 zone 创建一系列存储池，或者让多个 zone 共用同一系列的存储池。作为最佳实践，我们建议分别位于各 region 中的主 zone 和第二 zone 都要有各自的一系列存储池。为某个域创建存储池时，建议默认存储池名以 region 名和 zone 名作为前缀，例如：

• .region1-zone1.domain.rgw
• .region1-zone1.rgw.control
• .region1-zone1.rgw.gc
• .region1-zone1.log
• .region1-zone1.intent-log
• .region1-zone1.usage
• .region1-zone1.users
• .region1-zone1.users.email
• .region1-zone1.users.swift
• .region1-zone1.users.uid

Ceph 对象网关会把 bucket 索引（ index_pool ）和 bucket 数据（ data_pool ）存储到归置存储池，这些可以重叠——也就是你可以把索引和数据存入同一存储池。索引存储池的默认归置地是 .rgw.buckets.index ，数据存储池的默认归置地是 .rgw.buckets ，给 zone 指定存储池的方法见Zones。

Deprecated since version v.67.

rgw cluster root pool

New in version v.67.

rgw region root pool

New in version v.67.

rgw zone root pool

Swift 选项

rgw enforce swift acls

rgw swift token expiration

rgw swift url

rgw swift url prefix

rgw swift auth url

rgw swift auth entry

日志记录选项

rgw log nonexistent bucket

rgw log object name

rgw log object name utc

rgw usage max shards

rgw usage max user shards

rgw enable ops log

rgw enable usage log

rgw ops log rados

rgw ops log socket path

rgw ops log data backlog

rgw usage log flush threshold

rgw usage log tick interval

rgw intent log object name

rgw intent log object name utc

rgw data log window

rgw data log changes size

rgw data log num shards

rgw data log obj prefix

rgw replica log obj prefix

rgw md log max shards

Keystone 选项

rgw keystone url

rgw keystone admin token

rgw keystone accepted roles

rgw keystone token cache size

rgw keystone revocation interval

rgw keystone verify ssl