5 .. versionadded:: Jewel
7 A single zone configuration typically consists of one zone group containing one
8 zone and one or more `ceph-radosgw` instances where you may load-balance gateway
9 client requests between the instances. In a single zone configuration, typically
10 multiple gateway instances point to a single Ceph storage cluster. However, Kraken
11 supports several multi-site configuration options for the Ceph Object Gateway:
13 - **Multi-zone:** A more advanced configuration consists of one zone group and
14 multiple zones, each zone with one or more `ceph-radosgw` instances. Each zone
15 is backed by its own Ceph Storage Cluster. Multiple zones in a zone group
16 provides disaster recovery for the zone group should one of the zones experience
17 a significant failure. In Kraken, each zone is active and may receive write
18 operations. In addition to disaster recovery, multiple active zones may also
19 serve as a foundation for content delivery networks.
21 - **Multi-zone-group:** Formerly called 'regions', Ceph Object Gateway can also
22 support multiple zone groups, each zone group with one or more zones. Objects
23 stored to zones in one zone group within the same realm as another zone
24 group will share a global object namespace, ensuring unique object IDs across
25 zone groups and zones.
27 - **Multiple Realms:** In Kraken, the Ceph Object Gateway supports the notion
28 of realms, which can be a single zone group or multiple zone groups and
29 a globally unique namespace for the realm. Multiple realms provide the ability
30 to support numerous configurations and namespaces.
32 Replicating object data between zones within a zone group looks something
35 .. image:: ../images/zone-sync2.png
38 For additional details on setting up a cluster, see `Ceph Object Gateway for
39 Production <https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/2/html/ceph_object_gateway_for_production/>`__.
41 Functional Changes from Infernalis
42 ==================================
44 In Kraken, you can configure each Ceph Object Gateway to
45 work in an active-active zone configuration, allowing for writes to
48 The multi-site configuration is stored within a container called a
49 "realm." The realm stores zone groups, zones, and a time "period" with
50 multiple epochs for tracking changes to the configuration. In Kraken,
51 the ``ceph-radosgw`` daemons handle the synchronization,
52 eliminating the need for a separate synchronization agent. Additionally,
53 the new approach to synchronization allows the Ceph Object Gateway to
54 operate with an "active-active" configuration instead of
57 Requirements and Assumptions
58 ============================
60 A multi-site configuration requires at least two Ceph storage clusters,
61 preferably given a distinct cluster name. At least two Ceph object
62 gateway instances, one for each Ceph storage cluster.
64 This guide assumes at least two Ceph storage clusters in geographically
65 separate locations; however, the configuration can work on the same
66 site. This guide also assumes two Ceph object gateway servers named
67 ``rgw1`` and ``rgw2``.
69 A multi-site configuration requires a master zone group and a master
70 zone. Additionally, each zone group requires a master zone. Zone groups
71 may have one or more secondary or non-master zones.
73 In this guide, the ``rgw1`` host will serve as the master zone of the
74 master zone group; and, the ``rgw2`` host will serve as the secondary zone
75 of the master zone group.
77 See `Pools`_ for instructions on creating and tuning pools for Ceph
81 Configuring a Master Zone
82 =========================
84 All gateways in a multi-site configuration will retrieve their
85 configuration from a ``ceph-radosgw`` daemon on a host within the master
86 zone group and master zone. To configure your gateways in a multi-site
87 configuration, choose a ``ceph-radosgw`` instance to configure the
88 master zone group and master zone.
93 A realm contains the multi-site configuration of zone groups and zones
94 and also serves to enforce a globally unique namespace within the realm.
96 Create a new realm for the multi-site configuration by opening a command
97 line interface on a host identified to serve in the master zone group
98 and zone. Then, execute the following:
102 # radosgw-admin realm create --rgw-realm={realm-name} [--default]
108 # radosgw-admin realm create --rgw-realm=movies --default
110 If the cluster will have a single realm, specify the ``--default`` flag.
111 If ``--default`` is specified, ``radosgw-admin`` will use this realm by
112 default. If ``--default`` is not specified, adding zone-groups and zones
113 requires specifying either the ``--rgw-realm`` flag or the
114 ``--realm-id`` flag to identify the realm when adding zone groups and
117 After creating the realm, ``radosgw-admin`` will echo back the realm
118 configuration. For example:
123 "id": "0956b174-fe14-4f97-8b50-bb7ec5e1cf62",
125 "current_period": "1950b710-3e63-4c41-a19e-46a715000980",
129 .. note:: Ceph generates a unique ID for the realm, which allows the renaming
130 of a realm if the need arises.
132 Create a Master Zone Group
133 --------------------------
135 A realm must have at least one zone group, which will serve as the
136 master zone group for the realm.
138 Create a new master zone group for the multi-site configuration by
139 opening a command line interface on a host identified to serve in the
140 master zone group and zone. Then, execute the following:
144 # radosgw-admin zonegroup create --rgw-zonegroup={name} --endpoints={url} [--rgw-realm={realm-name}|--realm-id={realm-id}] --master --default
150 # radosgw-admin zonegroup create --rgw-zonegroup=us --endpoints=http://rgw1:80 --rgw-realm=movies --master --default
152 If the realm will only have a single zone group, specify the
153 ``--default`` flag. If ``--default`` is specified, ``radosgw-admin``
154 will use this zone group by default when adding new zones. If
155 ``--default`` is not specified, adding zones will require either the
156 ``--rgw-zonegroup`` flag or the ``--zonegroup-id`` flag to identify the
157 zone group when adding or modifying zones.
159 After creating the master zone group, ``radosgw-admin`` will echo back
160 the zone group configuration. For example:
165 "id": "f1a233f5-c354-4107-b36c-df66126475a6",
173 "hostnames_s3webzone": [],
176 "placement_targets": [],
177 "default_placement": "",
178 "realm_id": "0956b174-fe14-4f97-8b50-bb7ec5e1cf62"
184 .. important:: Zones must be created on a Ceph Object Gateway node that will be
187 Create a new master zone for the multi-site configuration by opening a
188 command line interface on a host identified to serve in the master zone
189 group and zone. Then, execute the following:
193 # radosgw-admin zone create --rgw-zonegroup={zone-group-name} \
194 --rgw-zone={zone-name} \
196 --endpoints={http://fqdn}[,{http://fqdn}]
203 # radosgw-admin zone create --rgw-zonegroup=us --rgw-zone=us-east \
205 --endpoints={http://fqdn}[,{http://fqdn}]
208 .. note:: The ``--access-key`` and ``--secret`` aren’t specified. These
209 settings will be added to the zone once the user is created in the
212 .. important:: The following steps assume a multi-site configuration using newly
213 installed systems that aren’t storing data yet. DO NOT DELETE the
214 ``default`` zone and its pools if you are already using it to store
215 data, or the data will be deleted and unrecoverable.
217 Delete Default Zone Group and Zone
218 ----------------------------------
220 Delete the ``default`` zone if it exists. Make sure to remove it from
221 the default zone group first.
225 # radosgw-admin zonegroup remove --rgw-zonegroup=default --rgw-zone=default
226 # radosgw-admin period update --commit
227 # radosgw-admin zone delete --rgw-zone=default
228 # radosgw-admin period update --commit
229 # radosgw-admin zonegroup delete --rgw-zonegroup=default
230 # radosgw-admin period update --commit
232 Finally, delete the ``default`` pools in your Ceph storage cluster if
235 .. important:: The following step assumes a multi-site configuration using newly
236 installed systems that aren’t currently storing data. DO NOT DELETE
237 the ``default`` zone group if you are already using it to store
242 # rados rmpool default.rgw.control default.rgw.control --yes-i-really-really-mean-it
243 # rados rmpool default.rgw.data.root default.rgw.data.root --yes-i-really-really-mean-it
244 # rados rmpool default.rgw.gc default.rgw.gc --yes-i-really-really-mean-it
245 # rados rmpool default.rgw.log default.rgw.log --yes-i-really-really-mean-it
246 # rados rmpool default.rgw.users.uid default.rgw.users.uid --yes-i-really-really-mean-it
251 The ``ceph-radosgw`` daemons must authenticate before pulling realm and
252 period information. In the master zone, create a system user to
253 facilitate authentication between daemons.
257 # radosgw-admin user create --uid="{user-name}" --display-name="{Display Name}" --system
263 # radosgw-admin user create --uid="synchronization-user" --display-name="Synchronization User" --system
265 Make a note of the ``access_key`` and ``secret_key``, as the secondary
266 zones will require them to authenticate with the master zone.
268 Finally, add the system user to the master zone.
272 # radosgw-admin zone modify --rgw-zone=us-east --access-key={access-key} --secret={secret}
273 # radosgw-admin period update --commit
278 After updating the master zone configuration, update the period.
282 # radosgw-admin period update --commit
284 .. note:: Updating the period changes the epoch, and ensures that other zones
285 will receive the updated configuration.
287 Update the Ceph Configuration File
288 ----------------------------------
290 Update the Ceph configuration file on master zone hosts by adding the
291 ``rgw_zone`` configuration option and the name of the master zone to the
296 [client.rgw.{instance-name}]
306 rgw frontends = "civetweb port=80"
312 On the object gateway host, start and enable the Ceph Object Gateway
317 # systemctl start ceph-radosgw@rgw.`hostname -s`
318 # systemctl enable ceph-radosgw@rgw.`hostname -s`
320 Configure Secondary Zones
321 =========================
323 Zones within a zone group replicate all data to ensure that each zone
324 has the same data. When creating the secondary zone, execute all of the
325 following operations on a host identified to serve the secondary zone.
327 .. note:: To add a third zone, follow the same procedures as for adding the
328 secondary zone. Use different zone name.
330 .. important:: You must execute metadata operations, such as user creation, on a
331 host within the master zone. The master zone and the secondary zone
332 can receive bucket operations, but the secondary zone redirects
333 bucket operations to the master zone. If the master zone is down,
334 bucket operations will fail.
339 Using the URL path, access key and secret of the master zone in the
340 master zone group, pull the realm to the host. To pull a non-default
341 realm, specify the realm using the ``--rgw-realm`` or ``--realm-id``
342 configuration options.
346 # radosgw-admin realm pull --url={url-to-master-zone-gateway} --access-key={access-key} --secret={secret}
348 If this realm is the default realm or the only realm, make the realm the
353 # radosgw-admin realm default --rgw-realm={realm-name}
358 Using the URL path, access key and secret of the master zone in the
359 master zone group, pull the period to the host. To pull a period from a
360 non-default realm, specify the realm using the ``--rgw-realm`` or
361 ``--realm-id`` configuration options.
365 # radosgw-admin period pull --url={url-to-master-zone-gateway} --access-key={access-key} --secret={secret}
368 .. note:: Pulling the period retrieves the latest version of the zone group
369 and zone configurations for the realm.
371 Create a Secondary Zone
372 -----------------------
374 .. important:: Zones must be created on a Ceph Object Gateway node that will be
377 Create a secondary zone for the multi-site configuration by opening a
378 command line interface on a host identified to serve the secondary zone.
379 Specify the zone group ID, the new zone name and an endpoint for the
380 zone. **DO NOT** use the ``--master`` or ``--default`` flags. In Kraken,
381 all zones run in an active-active configuration by
382 default; that is, a gateway client may write data to any zone and the
383 zone will replicate the data to all other zones within the zone group.
384 If the secondary zone should not accept write operations, specify the
385 ``--read-only`` flag to create an active-passive configuration between
386 the master zone and the secondary zone. Additionally, provide the
387 ``access_key`` and ``secret_key`` of the generated system user stored in
388 the master zone of the master zone group. Execute the following:
392 # radosgw-admin zone create --rgw-zonegroup={zone-group-name}\
393 --rgw-zone={zone-name} --endpoints={url} \
394 --access-key={system-key} --secret={secret}\
395 --endpoints=http://{fqdn}:80 \
402 # radosgw-admin zone create --rgw-zonegroup=us --rgw-zone=us-west \
403 --access-key={system-key} --secret={secret} \
404 --endpoints=http://rgw2:80
406 .. important:: The following steps assume a multi-site configuration using newly
407 installed systems that aren’t storing data. **DO NOT DELETE** the
408 ``default`` zone and its pools if you are already using it to store
409 data, or the data will be lost and unrecoverable.
411 Delete the default zone if needed.
415 # radosgw-admin zone delete --rgw-zone=default
417 Finally, delete the default pools in your Ceph storage cluster if
422 # rados rmpool default.rgw.control default.rgw.control --yes-i-really-really-mean-it
423 # rados rmpool default.rgw.data.root default.rgw.data.root --yes-i-really-really-mean-it
424 # rados rmpool default.rgw.gc default.rgw.gc --yes-i-really-really-mean-it
425 # rados rmpool default.rgw.log default.rgw.log --yes-i-really-really-mean-it
426 # rados rmpool default.rgw.users.uid default.rgw.users.uid --yes-i-really-really-mean-it
428 Update the Ceph Configuration File
429 ----------------------------------
431 Update the Ceph configuration file on the secondary zone hosts by adding
432 the ``rgw_zone`` configuration option and the name of the secondary zone
433 to the instance entry.
437 [client.rgw.{instance-name}]
447 rgw frontends = "civetweb port=80"
453 After updating the master zone configuration, update the period.
457 # radosgw-admin period update --commit
459 .. note:: Updating the period changes the epoch, and ensures that other zones
460 will receive the updated configuration.
465 On the object gateway host, start and enable the Ceph Object Gateway
470 # systemctl start ceph-radosgw@rgw.`hostname -s`
471 # systemctl enable ceph-radosgw@rgw.`hostname -s`
473 Check Synchronization Status
474 ----------------------------
476 Once the secondary zone is up and running, check the synchronization
477 status. Synchronization copies users and buckets created in the master
478 zone to the secondary zone.
482 # radosgw-admin sync status
484 The output will provide the status of synchronization operations. For
489 realm f3239bc5-e1a8-4206-a81d-e1576480804d (earth)
490 zonegroup c50dbb7e-d9ce-47cc-a8bb-97d9b399d388 (us)
491 zone 4c453b70-4a16-4ce8-8185-1893b05d346e (us-west)
492 metadata sync syncing
493 full sync: 0/64 shards
494 metadata is caught up with master
495 incremental sync: 64/64 shards
496 data sync source: 1ee9da3e-114d-4ae3-a8a4-056e8a17f532 (us-east)
498 full sync: 0/128 shards
499 incremental sync: 128/128 shards
500 data is caught up with source
502 .. note:: Secondary zones accept bucket operations; however, secondary zones
503 redirect bucket operations to the master zone and then synchronize
504 with the master zone to receive the result of the bucket operations.
505 If the master zone is down, bucket operations executed on the
506 secondary zone will fail, but object operations should succeed.
512 Checking the Sync Status
513 ------------------------
515 Information about the replication status of a zone can be queried with::
517 $ radosgw-admin sync status
518 realm b3bc1c37-9c44-4b89-a03b-04c269bea5da (earth)
519 zonegroup f54f9b22-b4b6-4a0e-9211-fa6ac1693f49 (us)
520 zone adce11c9-b8ed-4a90-8bc5-3fc029ff0816 (us-2)
521 metadata sync syncing
522 full sync: 0/64 shards
523 incremental sync: 64/64 shards
524 metadata is behind on 1 shards
525 oldest incremental change not applied: 2017-03-22 10:20:00.0.881361s
526 data sync source: 341c2d81-4574-4d08-ab0f-5a2a7b168028 (us-1)
528 full sync: 0/128 shards
529 incremental sync: 128/128 shards
530 data is caught up with source
531 source: 3b5d1a3f-3f27-4e4a-8f34-6072d4bb1275 (us-3)
533 full sync: 0/128 shards
534 incremental sync: 128/128 shards
535 data is caught up with source
537 Changing the Metadata Master Zone
538 ---------------------------------
540 .. important:: Care must be taken when changing which zone is the metadata
541 master. If a zone has not finished syncing metadata from the current master
542 zone, it will be unable to serve any remaining entries when promoted to
543 master and those changes will be lost. For this reason, waiting for a
544 zone's ``radosgw-admin sync status`` to catch up on metadata sync before
545 promoting it to master is recommended.
547 Similarly, if changes to metadata are being processed by the current master
548 zone while another zone is being promoted to master, those changes are
549 likely to be lost. To avoid this, shutting down any ``radosgw`` instances
550 on the previous master zone is recommended. After promoting another zone,
551 its new period can be fetched with ``radosgw-admin period pull`` and the
552 gateway(s) can be restarted.
554 To promote a zone (for example, zone ``us-2`` in zonegroup ``us``) to metadata
555 master, run the following commands on that zone::
557 $ radosgw-admin zone modify --rgw-zone=us-2 --master
558 $ radosgw-admin zonegroup modify --rgw-zonegroup=us --master
559 $ radosgw-admin period update --commit
561 This will generate a new period, and the radosgw instance(s) in zone ``us-2``
562 will send this period to other zones.
564 Failover and Disaster Recovery
565 ==============================
567 If the master zone should fail, failover to the secondary zone for
570 1. Make the secondary zone the master and default zone. For example:
574 # radosgw-admin zone modify --rgw-zone={zone-name} --master --default
576 By default, Ceph Object Gateway will run in an active-active
577 configuration. If the cluster was configured to run in an
578 active-passive configuration, the secondary zone is a read-only zone.
579 Remove the ``--read-only`` status to allow the zone to receive write
580 operations. For example:
584 # radosgw-admin zone modify --rgw-zone={zone-name} --master --default \
587 2. Update the period to make the changes take effect.
591 # radosgw-admin period update --commit
593 3. Finally, restart the Ceph Object Gateway.
597 # systemctl restart ceph-radosgw@rgw.`hostname -s`
599 If the former master zone recovers, revert the operation.
601 1. From the recovered zone, pull the period from the current master
606 # radosgw-admin period pull --url={url-to-master-zone-gateway} \
607 --access-key={access-key} --secret={secret}
609 2. Make the recovered zone the master and default zone.
613 # radosgw-admin zone modify --rgw-zone={zone-name} --master --default
615 3. Update the period to make the changes take effect.
619 # radosgw-admin period update --commit
621 4. Then, restart the Ceph Object Gateway in the recovered zone.
625 # systemctl restart ceph-radosgw@rgw.`hostname -s`
627 5. If the secondary zone needs to be a read-only configuration, update
632 # radosgw-admin zone modify --rgw-zone={zone-name} --read-only
634 6. Update the period to make the changes take effect.
638 # radosgw-admin period update --commit
640 7. Finally, restart the Ceph Object Gateway in the secondary zone.
644 # systemctl restart ceph-radosgw@rgw.`hostname -s`
646 Migrating a Single Site System to Multi-Site
647 ============================================
649 To migrate from a single site system with a ``default`` zone group and
650 zone to a multi site system, use the following steps:
652 1. Create a realm. Replace ``<name>`` with the realm name.
656 # radosgw-admin realm create --rgw-realm=<name> --default
658 2. Rename the default zone and zonegroup. Replace ``<name>`` with the
659 zonegroup or zone name.
663 # radosgw-admin zonegroup rename --rgw-zonegroup default --zonegroup-new-name=<name>
664 # radosgw-admin zone rename --rgw-zone default --zone-new-name us-east-1 --rgw-zonegroup=<name>
666 3. Configure the master zonegroup. Replace ``<name>`` with the realm or
667 zonegroup name. Replace ``<fqdn>`` with the fully qualified domain
668 name(s) in the zonegroup.
672 # radosgw-admin zonegroup modify --rgw-realm=<name> --rgw-zonegroup=<name> --endpoints http://<fqdn>:80 --master --default
674 4. Configure the master zone. Replace ``<name>`` with the realm,
675 zonegroup or zone name. Replace ``<fqdn>`` with the fully qualified
676 domain name(s) in the zonegroup.
680 # radosgw-admin zone modify --rgw-realm=<name> --rgw-zonegroup=<name> \
681 --rgw-zone=<name> --endpoints http://<fqdn>:80 \
682 --access-key=<access-key> --secret=<secret-key> \
685 5. Create a system user. Replace ``<user-id>`` with the username.
686 Replace ``<display-name>`` with a display name. It may contain
691 # radosgw-admin user create --uid=<user-id> --display-name="<display-name>"\
692 --access-key=<access-key> --secret=<secret-key> --system
694 6. Commit the updated configuration.
698 # radosgw-admin period update --commit
700 7. Finally, restart the Ceph Object Gateway.
704 # systemctl restart ceph-radosgw@rgw.`hostname -s`
706 After completing this procedure, proceed to `Configure a Secondary
707 Zone <#configure-secondary-zones>`__ to create a secondary zone
708 in the master zone group.
711 Multi-Site Configuration Reference
712 ==================================
714 The following sections provide additional details and command-line
715 usage for realms, periods, zone groups and zones.
720 A realm represents a globally unique namespace consisting of one or more
721 zonegroups containing one or more zones, and zones containing buckets,
722 which in turn contain objects. A realm enables the Ceph Object Gateway
723 to support multiple namespaces and their configuration on the same
726 A realm contains the notion of periods. Each period represents the state
727 of the zone group and zone configuration in time. Each time you make a
728 change to a zonegroup or zone, update the period and commit it.
730 By default, the Ceph Object Gateway does not create a realm
731 for backward compatibility with Infernalis and earlier releases.
732 However, as a best practice, we recommend creating realms for new
738 To create a realm, execute ``realm create`` and specify the realm name.
739 If the realm is the default, specify ``--default``.
743 # radosgw-admin realm create --rgw-realm={realm-name} [--default]
749 # radosgw-admin realm create --rgw-realm=movies --default
751 By specifying ``--default``, the realm will be called implicitly with
752 each ``radosgw-admin`` call unless ``--rgw-realm`` and the realm name
753 are explicitly provided.
755 Make a Realm the Default
756 ~~~~~~~~~~~~~~~~~~~~~~~~
758 One realm in the list of realms should be the default realm. There may
759 be only one default realm. If there is only one realm and it wasn’t
760 specified as the default realm when it was created, make it the default
761 realm. Alternatively, to change which realm is the default, execute:
765 # radosgw-admin realm default --rgw-realm=movies
767 .. note:: When the realm is default, the command line assumes
768 ``--rgw-realm=<realm-name>`` as an argument.
773 To delete a realm, execute ``realm delete`` and specify the realm name.
777 # radosgw-admin realm delete --rgw-realm={realm-name}
783 # radosgw-admin realm delete --rgw-realm=movies
788 To get a realm, execute ``realm get`` and specify the realm name.
792 #radosgw-admin realm get --rgw-realm=<name>
798 # radosgw-admin realm get --rgw-realm=movies [> filename.json]
800 The CLI will echo a JSON object with the realm properties.
805 "id": "0a68d52e-a19c-4e8e-b012-a8f831cb3ebc",
807 "current_period": "b0c5bbef-4337-4edd-8184-5aeab2ec413b",
811 Use ``>`` and an output file name to output the JSON object to a file.
816 To set a realm, execute ``realm set``, specify the realm name, and
817 ``--infile=`` with an input file name.
821 #radosgw-admin realm set --rgw-realm=<name> --infile=<infilename>
827 # radosgw-admin realm set --rgw-realm=movies --infile=filename.json
832 To list realms, execute ``realm list``.
836 # radosgw-admin realm list
841 To list realm periods, execute ``realm list-periods``.
845 # radosgw-admin realm list-periods
850 To pull a realm from the node containing the master zone group and
851 master zone to a node containing a secondary zone group or zone, execute
852 ``realm pull`` on the node that will receive the realm configuration.
856 # radosgw-admin realm pull --url={url-to-master-zone-gateway} --access-key={access-key} --secret={secret}
861 A realm is not part of the period. Consequently, renaming the realm is
862 only applied locally, and will not get pulled with ``realm pull``. When
863 renaming a realm with multiple zones, run the command on each zone. To
864 rename a realm, execute the following:
868 # radosgw-admin realm rename --rgw-realm=<current-name> --realm-new-name=<new-realm-name>
870 .. note:: DO NOT use ``realm set`` to change the ``name`` parameter. That
871 changes the internal name only. Specifying ``--rgw-realm`` would
872 still use the old realm name.
877 The Ceph Object Gateway supports multi-site deployments and a global
878 namespace by using the notion of zone groups. Formerly called a region
879 in Infernalis, a zone group defines the geographic location of one or more Ceph
880 Object Gateway instances within one or more zones.
882 Configuring zone groups differs from typical configuration procedures,
883 because not all of the settings end up in a Ceph configuration file. You
884 can list zone groups, get a zone group configuration, and set a zone
890 Creating a zone group consists of specifying the zone group name.
891 Creating a zone assumes it will live in the default realm unless
892 ``--rgw-realm=<realm-name>`` is specified. If the zonegroup is the
893 default zonegroup, specify the ``--default`` flag. If the zonegroup is
894 the master zonegroup, specify the ``--master`` flag. For example:
898 # radosgw-admin zonegroup create --rgw-zonegroup=<name> [--rgw-realm=<name>][--master] [--default]
901 .. note:: Use ``zonegroup modify --rgw-zonegroup=<zonegroup-name>`` to modify
902 an existing zone group’s settings.
904 Make a Zone Group the Default
905 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
907 One zonegroup in the list of zonegroups should be the default zonegroup.
908 There may be only one default zonegroup. If there is only one zonegroup
909 and it wasn’t specified as the default zonegroup when it was created,
910 make it the default zonegroup. Alternatively, to change which zonegroup
911 is the default, execute:
915 # radosgw-admin zonegroup default --rgw-zonegroup=comedy
917 .. note:: When the zonegroup is default, the command line assumes
918 ``--rgw-zonegroup=<zonegroup-name>`` as an argument.
920 Then, update the period:
924 # radosgw-admin period update --commit
926 Add a Zone to a Zone Group
927 ~~~~~~~~~~~~~~~~~~~~~~~~~~
929 To add a zone to a zonegroup, execute the following:
933 # radosgw-admin zonegroup add --rgw-zonegroup=<name> --rgw-zone=<name>
935 Then, update the period:
939 # radosgw-admin period update --commit
941 Remove a Zone from a Zone Group
942 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
944 To remove a zone from a zonegroup, execute the following:
948 # radosgw-admin zonegroup remove --rgw-zonegroup=<name> --rgw-zone=<name>
950 Then, update the period:
954 # radosgw-admin period update --commit
959 To rename a zonegroup, execute the following:
963 # radosgw-admin zonegroup rename --rgw-zonegroup=<name> --zonegroup-new-name=<name>
965 Then, update the period:
969 # radosgw-admin period update --commit
974 To delete a zonegroup, execute the following:
978 # radosgw-admin zonegroup delete --rgw-zonegroup=<name>
980 Then, update the period:
984 # radosgw-admin period update --commit
989 A Ceph cluster contains a list of zone groups. To list the zone groups,
994 # radosgw-admin zonegroup list
996 The ``radosgw-admin`` returns a JSON formatted list of zone groups.
1001 "default_info": "90b28698-e7c3-462c-a42d-4aa780d24eda",
1007 Get a Zone Group Map
1008 ~~~~~~~~~~~~~~~~~~~~
1010 To list the details of each zone group, execute:
1014 # radosgw-admin zonegroup-map get
1016 .. note:: If you receive a ``failed to read zonegroup map`` error, run
1017 ``radosgw-admin zonegroup-map update`` as ``root`` first.
1022 To view the configuration of a zone group, execute:
1026 radosgw-admin zonegroup get [--rgw-zonegroup=<zonegroup>]
1028 The zone group configuration looks like this:
1033 "id": "90b28698-e7c3-462c-a42d-4aa780d24eda",
1036 "is_master": "true",
1041 "hostnames_s3website": [],
1042 "master_zone": "9248cab2-afe7-43d8-a661-a40bf316665e",
1045 "id": "9248cab2-afe7-43d8-a661-a40bf316665e",
1052 "bucket_index_max_shards": 0,
1053 "read_only": "false"
1056 "id": "d1024e59-7d28-49d1-8222-af101965a939",
1061 "log_meta": "false",
1063 "bucket_index_max_shards": 0,
1064 "read_only": "false"
1067 "placement_targets": [
1069 "name": "default-placement",
1073 "default_placement": "default-placement",
1074 "realm_id": "ae031368-8715-4e27-9a99-0c9468852cfe"
1080 Defining a zone group consists of creating a JSON object, specifying at
1081 least the required settings:
1083 1. ``name``: The name of the zone group. Required.
1085 2. ``api_name``: The API name for the zone group. Optional.
1087 3. ``is_master``: Determines if the zone group is the master zone group.
1088 Required. **note:** You can only have one master zone group.
1090 4. ``endpoints``: A list of all the endpoints in the zone group. For
1091 example, you may use multiple domain names to refer to the same zone
1092 group. Remember to escape the forward slashes (``\/``). You may also
1093 specify a port (``fqdn:port``) for each endpoint. Optional.
1095 5. ``hostnames``: A list of all the hostnames in the zone group. For
1096 example, you may use multiple domain names to refer to the same zone
1097 group. Optional. The ``rgw dns name`` setting will automatically be
1098 included in this list. You should restart the gateway daemon(s) after
1099 changing this setting.
1101 6. ``master_zone``: The master zone for the zone group. Optional. Uses
1102 the default zone if not specified. **note:** You can only have one
1103 master zone per zone group.
1105 7. ``zones``: A list of all zones within the zone group. Each zone has a
1106 name (required), a list of endpoints (optional), and whether or not
1107 the gateway will log metadata and data operations (false by default).
1109 8. ``placement_targets``: A list of placement targets (optional). Each
1110 placement target contains a name (required) for the placement target
1111 and a list of tags (optional) so that only users with the tag can use
1112 the placement target (i.e., the user’s ``placement_tags`` field in
1115 9. ``default_placement``: The default placement target for the object
1116 index and object data. Set to ``default-placement`` by default. You
1117 may also set a per-user default placement in the user info for each
1120 To set a zone group, create a JSON object consisting of the required
1121 fields, save the object to a file (e.g., ``zonegroup.json``); then,
1122 execute the following command:
1126 # radosgw-admin zonegroup set --infile zonegroup.json
1128 Where ``zonegroup.json`` is the JSON file you created.
1130 .. important:: The ``default`` zone group ``is_master`` setting is ``true`` by
1131 default. If you create a new zone group and want to make it the
1132 master zone group, you must either set the ``default`` zone group
1133 ``is_master`` setting to ``false``, or delete the ``default`` zone
1136 Finally, update the period:
1140 # radosgw-admin period update --commit
1142 Set a Zone Group Map
1143 ~~~~~~~~~~~~~~~~~~~~
1145 Setting a zone group map consists of creating a JSON object consisting
1146 of one or more zone groups, and setting the ``master_zonegroup`` for the
1147 cluster. Each zone group in the zone group map consists of a key/value
1148 pair, where the ``key`` setting is equivalent to the ``name`` setting
1149 for an individual zone group configuration, and the ``val`` is a JSON
1150 object consisting of an individual zone group configuration.
1152 You may only have one zone group with ``is_master`` equal to ``true``,
1153 and it must be specified as the ``master_zonegroup`` at the end of the
1154 zone group map. The following JSON object is an example of a default
1162 "key": "90b28698-e7c3-462c-a42d-4aa780d24eda",
1164 "id": "90b28698-e7c3-462c-a42d-4aa780d24eda",
1167 "is_master": "true",
1172 "hostnames_s3website": [],
1173 "master_zone": "9248cab2-afe7-43d8-a661-a40bf316665e",
1176 "id": "9248cab2-afe7-43d8-a661-a40bf316665e",
1183 "bucket_index_max_shards": 0,
1184 "read_only": "false"
1187 "id": "d1024e59-7d28-49d1-8222-af101965a939",
1192 "log_meta": "false",
1194 "bucket_index_max_shards": 0,
1195 "read_only": "false"
1198 "placement_targets": [
1200 "name": "default-placement",
1204 "default_placement": "default-placement",
1205 "realm_id": "ae031368-8715-4e27-9a99-0c9468852cfe"
1209 "master_zonegroup": "90b28698-e7c3-462c-a42d-4aa780d24eda",
1222 To set a zone group map, execute the following:
1226 # radosgw-admin zonegroup-map set --infile zonegroupmap.json
1228 Where ``zonegroupmap.json`` is the JSON file you created. Ensure that
1229 you have zones created for the ones specified in the zone group map.
1230 Finally, update the period.
1234 # radosgw-admin period update --commit
1239 Ceph Object Gateway supports the notion of zones. A zone defines a
1240 logical group consisting of one or more Ceph Object Gateway instances.
1242 Configuring zones differs from typical configuration procedures, because
1243 not all of the settings end up in a Ceph configuration file. You can
1244 list zones, get a zone configuration and set a zone configuration.
1249 To create a zone, specify a zone name. If it is a master zone, specify
1250 the ``--master`` option. Only one zone in a zone group may be a master
1251 zone. To add the zone to a zonegroup, specify the ``--rgw-zonegroup``
1252 option with the zonegroup name.
1256 # radosgw-admin zone create --rgw-zone=<name> \
1257 [--zonegroup=<zonegroup-name]\
1258 [--endpoints=<endpoint>[,<endpoint>] \
1259 [--master] [--default] \
1260 --access-key $SYSTEM_ACCESS_KEY --secret $SYSTEM_SECRET_KEY
1262 Then, update the period:
1266 # radosgw-admin period update --commit
1271 To delete zone, first remove it from the zonegroup.
1275 # radosgw-admin zonegroup remove --zonegroup=<name>\
1278 Then, update the period:
1282 # radosgw-admin period update --commit
1284 Next, delete the zone. Execute the following:
1288 # radosgw-admin zone delete --rgw-zone<name>
1290 Finally, update the period:
1294 # radosgw-admin period update --commit
1296 .. important:: Do not delete a zone without removing it from a zone group first.
1297 Otherwise, updating the period will fail.
1299 If the pools for the deleted zone will not be used anywhere else,
1300 consider deleting the pools. Replace ``<del-zone>`` in the example below
1301 with the deleted zone’s name.
1303 .. important:: Only delete the pools with prepended zone names. Deleting the root
1304 pool, such as, ``.rgw.root`` will remove all of the system’s
1307 .. important:: Once the pools are deleted, all of the data within them are deleted
1308 in an unrecoverable manner. Only delete the pools if the pool
1309 contents are no longer needed.
1313 # rados rmpool <del-zone>.rgw.control <del-zone>.rgw.control --yes-i-really-really-mean-it
1314 # rados rmpool <del-zone>.rgw.data.root <del-zone>.rgw.data.root --yes-i-really-really-mean-it
1315 # rados rmpool <del-zone>.rgw.gc <del-zone>.rgw.gc --yes-i-really-really-mean-it
1316 # rados rmpool <del-zone>.rgw.log <del-zone>.rgw.log --yes-i-really-really-mean-it
1317 # rados rmpool <del-zone>.rgw.users.uid <del-zone>.rgw.users.uid --yes-i-really-really-mean-it
1322 To modify a zone, specify the zone name and the parameters you wish to
1327 # radosgw-admin zone modify [options]
1329 Where ``[options]``:
1331 - ``--access-key=<key>``
1332 - ``--secret/--secret-key=<key>``
1335 - ``--endpoints=<list>``
1337 Then, update the period:
1341 # radosgw-admin period update --commit
1346 As ``root``, to list the zones in a cluster, execute:
1350 # radosgw-admin zone list
1355 As ``root``, to get the configuration of a zone, execute:
1359 # radosgw-admin zone get [--rgw-zone=<zone>]
1361 The ``default`` zone looks like this:
1365 { "domain_root": ".rgw",
1366 "control_pool": ".rgw.control",
1367 "gc_pool": ".rgw.gc",
1369 "intent_log_pool": ".intent-log",
1370 "usage_log_pool": ".usage",
1371 "user_keys_pool": ".users",
1372 "user_email_pool": ".users.email",
1373 "user_swift_pool": ".users.swift",
1374 "user_uid_pool": ".users.uid",
1375 "system_key": { "access_key": "", "secret_key": ""},
1376 "placement_pools": [
1377 { "key": "default-placement",
1378 "val": { "index_pool": ".rgw.buckets.index",
1379 "data_pool": ".rgw.buckets"}
1387 Configuring a zone involves specifying a series of Ceph Object Gateway
1388 pools. For consistency, we recommend using a pool prefix that is the
1389 same as the zone name. See
1390 `Pools <http://docs.ceph.com/docs/master/rados/operations/pools/#pools>`__
1391 for details of configuring pools.
1393 To set a zone, create a JSON object consisting of the pools, save the
1394 object to a file (e.g., ``zone.json``); then, execute the following
1395 command, replacing ``{zone-name}`` with the name of the zone:
1399 # radosgw-admin zone set --rgw-zone={zone-name} --infile zone.json
1401 Where ``zone.json`` is the JSON file you created.
1403 Then, as ``root``, update the period:
1407 # radosgw-admin period update --commit
1412 To rename a zone, specify the zone name and the new zone name.
1416 # radosgw-admin zone rename --rgw-zone=<name> --zone-new-name=<name>
1418 Then, update the period:
1422 # radosgw-admin period update --commit
1424 Zone Group and Zone Settings
1425 ----------------------------
1427 When configuring a default zone group and zone, the pool name includes
1428 the zone name. For example:
1430 - ``default.rgw.control``
1432 To change the defaults, include the following settings in your Ceph
1433 configuration file under each ``[client.radosgw.{instance-name}]``
1436 +-------------------------------------+-----------------------------------+---------+-----------------------+
1437 | Name | Description | Type | Default |
1438 +=====================================+===================================+=========+=======================+
1439 | ``rgw_zone`` | The name of the zone for the | String | None |
1440 | | gateway instance. | | |
1441 +-------------------------------------+-----------------------------------+---------+-----------------------+
1442 | ``rgw_zonegroup`` | The name of the zone group for | String | None |
1443 | | the gateway instance. | | |
1444 +-------------------------------------+-----------------------------------+---------+-----------------------+
1445 | ``rgw_zonegroup_root_pool`` | The root pool for the zone group. | String | ``.rgw.root`` |
1446 +-------------------------------------+-----------------------------------+---------+-----------------------+
1447 | ``rgw_zone_root_pool`` | The root pool for the zone. | String | ``.rgw.root`` |
1448 +-------------------------------------+-----------------------------------+---------+-----------------------+
1449 | ``rgw_default_zone_group_info_oid`` | The OID for storing the default | String | ``default.zonegroup`` |
1450 | | zone group. We do not recommend | | |
1451 | | changing this setting. | | |
1452 +-------------------------------------+-----------------------------------+---------+-----------------------+
1453 | ``rgw_num_zone_opstate_shards`` | The maximum number of shards for | Integer | ``128`` |
1454 | | keeping inter-zone group | | |
1455 | | synchronization progress. | | |
1456 +-------------------------------------+-----------------------------------+---------+-----------------------+
1459 .. _`Pools`: ../pools