From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Fri, 23 May 2025 07:29:05 +0000 (+0700) Subject: doc/radosgw: Cosmetic improvements in cloud-transition.rst X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=863d57de735b3ad2d22adf065d86a92fc6b57261;p=ceph.git doc/radosgw: Cosmetic improvements in cloud-transition.rst Indent text that should belong to list items so they are formatted as list items. Add missing full stop for a few sentences. Move "the" outside of inline preformatted. Format S3 API operation name with inline preformatted which seems common. Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com> --- diff --git a/doc/radosgw/cloud-transition.rst b/doc/radosgw/cloud-transition.rst index 1d1d27f95d85e..86564be7f012c 100644 --- a/doc/radosgw/cloud-transition.rst +++ b/doc/radosgw/cloud-transition.rst @@ -24,12 +24,12 @@ Cloud Storage Class Tier Type * ``tier-type`` (string) -The type of remote cloud service that will be used to transition objects. -The below tier types are supported: + The type of remote cloud service that will be used to transition objects. + The below tier types are supported: -* ``cloud-s3`` : Regular S3 compatible object store service + * ``cloud-s3`` : Regular S3 compatible object store service. -* ``cloud-s3-glacier`` : S3 Glacier or Tape storage services + * ``cloud-s3-glacier`` : S3 Glacier or Tape storage services. Cloud Storage Class Tier Configuration @@ -59,66 +59,66 @@ Cloud Transition Specific Configurables * ``access_key`` (string) -The remote cloud S3 access key. + The remote cloud S3 access key. * ``secret`` (string) -The secret key for the remote cloud S3 service. + The secret key for the remote cloud S3 service. * ``endpoint`` (string) -URL of remote cloud S3 service. + URL of remote cloud S3 service. * ``region`` (string) -The remote cloud S3 service region name. + The remote cloud S3 service region name. * ``host_style`` (path | virtual) -Type of host style to be used when accessing the remote cloud S3 service (default: ``path``). + Type of host style to be used when accessing the remote cloud S3 service (default: ``path``). * ``acls`` (array) -Contains a list of ``acl_mappings``. + Contains a list of ``acl_mappings``. * ``acl_mapping`` (container) -Each ``acl_mapping`` structure contains ``type``, ``source_id``, and ``dest_id``. These -define the ACL mutation to be done on each object. An ACL mutation makes it possible to -convert a source userid to a destination userid. + Each ``acl_mapping`` structure contains ``type``, ``source_id``, and ``dest_id``. These + define the ACL mutation to be done on each object. An ACL mutation makes it possible to + convert a source userid to a destination userid. * ``type`` (id | email | uri) -ACL type: ``id`` defines userid, ``email`` defines user by email, -and ``uri`` defines user by ``uri`` (group). + ACL type: ``id`` defines userid, ``email`` defines user by email, + and ``uri`` defines user by ``uri`` (group). * ``source_id`` (string) -ID of user in the source zone. + ID of user in the source zone. * ``dest_id`` (string) -ID of user on the destination. + ID of user on the destination. * ``target_path`` (string) -A string that defines how the target path is constructed. The target path -specifies a prefix to which the source bucket-name/object-name is appended. -If not specified the ``target_path`` created is ``rgwx-${zonegroup}-${storage-class}-cloud-bucket``. + A string that defines how the target path is constructed. The target path + specifies a prefix to which the source bucket-name/object-name is appended. + If not specified the ``target_path`` created is ``rgwx-${zonegroup}-${storage-class}-cloud-bucket``. -For example: ``target_path = rgwx-archive-${zonegroup}/`` + For example: ``target_path = rgwx-archive-${zonegroup}/`` * ``target_storage_class`` (string) -A string that defines the target storage class to which the object transitions. -If not specified, the object is transitioned to the ``STANDARD`` storage class. + A string that defines the target storage class to which the object transitions. + If not specified, the object is transitioned to the ``STANDARD`` storage class. * ``retain_head_object`` (true | false) -If ``true``, the metadata of the object transitioned to the cloud service is retained. -If ``false`` (default), the object is deleted after the transition. -This option is ignored for current-versioned objects. For more details, -refer to the "Versioned Objects" section below. + If ``true``, the metadata of the object transitioned to the cloud service is retained. + If ``false`` (default), the object is deleted after the transition. + This option is ignored for current-versioned objects. For more details, + refer to the "Versioned Objects" section below. S3 Specific Configurables @@ -135,17 +135,17 @@ when accessing cloud services:: * ``multipart_sync_threshold`` (integer) -Objects this size or larger will be transitioned to the cloud using multipart upload. + Objects this size or larger will be transitioned to the cloud using multipart upload. * ``multipart_min_part_size`` (integer) -Minimum part size to use when transitioning objects using multipart upload. + Minimum part size to use when transitioning objects using multipart upload. How to Configure ~~~~~~~~~~~~~~~~ -See :ref:`adding_a_storage_class` for how to configure storage-class for a zonegroup. The cloud transition requires a creation of a special storage class with tier type defined as ``cloud-s3`` or ``cloud-s3-glacier`` +See :ref:`adding_a_storage_class` for how to configure storage-class for a zonegroup. The cloud transition requires a creation of a special storage class with tier type defined as ``cloud-s3`` or ``cloud-s3-glacier``. .. note:: If you have not performed previous :ref:`Multisite Configuration `, a ``default`` zone and zonegroup are created for you, and changes @@ -352,7 +352,7 @@ attributes are added to the objects being transitioned: * ``x-rgw-cloud-keep-attrs`` : ``true`` / ``false`` If set to default ``true``, the cloud service should map and store all - ``the x-amz-meta-*`` attributes. If it cannot, then the operation should fail. + the ``x-amz-meta-*`` attributes. If it cannot, then the operation should fail. If set to ``false``, the cloud service can ignore such attributes and just store the object data being sent. @@ -422,8 +422,8 @@ The objects transitioned to cloud can now be restored. For more information, ref Future Work ----------- -* Send presigned redirect or read-through the objects transitioned to cloud +* Send presigned redirect or read-through the objects transitioned to cloud. -* Support s3:RestoreObject operation on cloud transitioned objects. +* Support ``s3:RestoreObject`` operation on cloud transitioned objects. * Support transition to other cloud providers (like Azure).