diff options
Diffstat (limited to 'src/ceph/doc/dev/radosgw')
| -rw-r--r-- | src/ceph/doc/dev/radosgw/admin/adminops_nonimplemented.rst | 495 | ||||
| -rw-r--r-- | src/ceph/doc/dev/radosgw/index.rst | 13 | ||||
| -rw-r--r-- | src/ceph/doc/dev/radosgw/s3_compliance.rst | 304 | ||||
| -rw-r--r-- | src/ceph/doc/dev/radosgw/usage.rst | 84 |
4 files changed, 0 insertions, 896 deletions
diff --git a/src/ceph/doc/dev/radosgw/admin/adminops_nonimplemented.rst b/src/ceph/doc/dev/radosgw/admin/adminops_nonimplemented.rst deleted file mode 100644 index e579bd5..0000000 --- a/src/ceph/doc/dev/radosgw/admin/adminops_nonimplemented.rst +++ /dev/null @@ -1,495 +0,0 @@ -================== - Admin Operations -================== - -An admin API request will be done on a URI that starts with the configurable 'admin' -resource entry point. Authorization for the admin API duplicates the S3 authorization -mechanism. Some operations require that the user holds special administrative capabilities. -The response entity type (XML or JSON) may be specified as the 'format' option in the -request and defaults to JSON if not specified. - -Get Object -========== - -Get an existing object. NOTE: Does not require owner to be non-suspended. - -Syntax -~~~~~~ - -:: - - GET /{admin}/bucket?object&format=json HTTP/1.1 - Host {fqdn} - -Request Parameters -~~~~~~~~~~~~~~~~~~ - -``bucket`` - -:Description: The bucket containing the object to be retrieved. -:Type: String -:Example: ``foo_bucket`` -:Required: Yes - -``object`` - -:Description: The object to be retrieved. -:Type: String -:Example: ``foo.txt`` -:Required: Yes - -Response Entities -~~~~~~~~~~~~~~~~~ - -If successful, returns the desired object. - -``object`` - -:Description: The desired object. -:Type: Object - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -``NoSuchObject`` - -:Description: Specified object does not exist. -:Code: 404 Not Found - -Head Object -=========== - -Verify the existence of an object. If the object exists, -metadata headers for the object will be returned. - -Syntax -~~~~~~ - -:: - - HEAD /{admin}/bucket?object HTTP/1.1 - Host {fqdn} - -Request Parameters -~~~~~~~~~~~~~~~~~~ - -``bucket`` - -:Description: The bucket containing the object to be retrieved. -:Type: String -:Example: ``foo_bucket`` -:Required: Yes - -``object`` - -:Description: The object to be retrieved. -:Type: String -:Example: ``foo.txt`` -:Required: Yes - -Response Entities -~~~~~~~~~~~~~~~~~ - -None. - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -``NoSuchObject`` - -:Description: Specified object does not exist. -:Code: 404 Not Found - -Get Zone Info -============= - -Get cluster information. - -Syntax -~~~~~~ - -:: - - GET /{admin}/zone&format=json HTTP/1.1 - Host {fqdn} - - -Response Entities -~~~~~~~~~~~~~~~~~ - -If successful, returns cluster pool configuration. - -``zone`` - -:Description: Contains current cluster pool configuration. -:Type: Container - -``domain_root`` - -:Description: root of all buckets. -:Type: String -:Parent: ``cluster`` - -``control_pool`` - -:Description: -:Type: String -:Parent: ``cluster`` - -``gc_pool`` - -:Description: Garbage collection pool. -:Type: String -:Parent: ``cluster`` - -``log_pool`` - -:Description: Log pool. -:Type: String -:Parent: ``cluster`` - -``intent_log_pool`` - -:Description: Intent log pool. -:Type: String -:Parent: ``cluster`` - -``usage_log_pool`` - -:Description: Usage log pool. -:Type: String -:Parent: ``cluster`` - -``user_keys_pool`` - -:Description: User key pool. -:Type: String -:Parent: ``cluster`` - -``user_email_pool`` - -:Description: User email pool. -:Type: String -:Parent: ``cluster`` - -``user_swift_pool`` - -:Description: Pool of swift users. -:Type: String -:Parent: ``cluster`` - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -None. - -Example Response -~~~~~~~~~~~~~~~~ - -:: - - HTTP/1.1 200 - Content-Type: application/json - - { - "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" - } - - - -Add Placement Pool -================== - -Make a pool available for data placement. - -Syntax -~~~~~~ - -:: - - PUT /{admin}/pool?format=json HTTP/1.1 - Host {fqdn} - - -Request Parameters -~~~~~~~~~~~~~~~~~~ - -``pool`` - -:Description: The pool to be made available for data placement. -:Type: String -:Example: ``foo_pool`` -:Required: Yes - -``create`` - -:Description: Creates the data pool if it does not exist. -:Type: Boolean -:Example: False [False] -:Required: No - -Response Entities -~~~~~~~~~~~~~~~~~ - -TBD. - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -TBD. - -Remove Placement Pool -===================== - -Make a pool unavailable for data placement. - -Syntax -~~~~~~ - -:: - - DELETE /{admin}/pool?format=json HTTP/1.1 - Host {fqdn} - - -Request Parameters -~~~~~~~~~~~~~~~~~~ - -``pool`` - -:Description: The existing pool to be made available for data placement. -:Type: String -:Example: ``foo_pool`` -:Required: Yes - -``destroy`` - -:Description: Destroys the pool after removing it from the active set. -:Type: Boolean -:Example: False [False] -:Required: No - -Response Entities -~~~~~~~~~~~~~~~~~ - -TBD. - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -TBD. - -List Available Data Placement Pools -=================================== - -List current pools available for data placement. - -Syntax -~~~~~~ - -:: - - GET /{admin}/pool?format=json HTTP/1.1 - Host {fqdn} - - -Response Entities -~~~~~~~~~~~~~~~~~ - -If successful, returns a list of pools available for data placement. - -``pools`` - -:Description: Contains currently available pools for data placement. -:Type: Container - - - -List Expired Garbage Collection Items -===================================== - -List objects scheduled for garbage collection. - -Syntax -~~~~~~ - -:: - - GET /{admin}/garbage?format=json HTTP/1.1 - Host {fqdn} - -Request Parameters -~~~~~~~~~~~~~~~~~~ - -None. - -Response Entities -~~~~~~~~~~~~~~~~~ - -If expired garbage collection items exist, a list of such objects -will be returned. - -``garbage`` - -:Description: Expired garbage collection items. -:Type: Container - -``object`` - -:Description: A container garbage collection object information. -:Type: Container -:Parent: ``garbage`` - -``name`` - -:Description: The name of the object. -:Type: String -:Parent: ``object`` - -``expired`` - -:Description: The date at which the object expired. -:Type: String -:Parent: ``object`` - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -TBD. - -Manually Processes Garbage Collection Items -=========================================== - -List objects scheduled for garbage collection. - -Syntax -~~~~~~ - -:: - - DELETE /{admin}/garbage?format=json HTTP/1.1 - Host {fqdn} - -Request Parameters -~~~~~~~~~~~~~~~~~~ - -None. - -Response Entities -~~~~~~~~~~~~~~~~~ - -If expired garbage collection items exist, a list of removed objects -will be returned. - -``garbage`` - -:Description: Expired garbage collection items. -:Type: Container - -``object`` - -:Description: A container garbage collection object information. -:Type: Container -:Parent: ``garbage`` - -``name`` - -:Description: The name of the object. -:Type: String -:Parent: ``object`` - -``expired`` - -:Description: The date at which the object expired. -:Type: String -:Parent: ``object`` - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -TBD. - -Show Log Objects -================ - -Show log objects - -Syntax -~~~~~~ - -:: - - GET /{admin}/log?format=json HTTP/1.1 - Host {fqdn} - -Request Parameters -~~~~~~~~~~~~~~~~~~ - -``object`` - -:Description: The log object to return. -:Type: String: -:Example: ``2012-10-11-09-4165.2-foo_bucket`` -:Required: No - -Response Entities -~~~~~~~~~~~~~~~~~ - -If no object is specified, returns the full list of log objects. - -``log-objects`` - -:Description: A list of log objects. -:Type: Container - -``object`` - -:Description: The name of the log object. -:Type: String - -``log`` - -:Description: The contents of the log object. -:Type: Container - -Special Error Responses -~~~~~~~~~~~~~~~~~~~~~~~ - -None. - -Standard Error Responses -======================== - -``AccessDenied`` - -:Description: Access denied. -:Code: 403 Forbidden - -``InternalError`` - -:Description: Internal server error. -:Code: 500 Internal Server Error - -``NoSuchUser`` - -:Description: User does not exist. -:Code: 404 Not Found - -``NoSuchBucket`` - -:Description: Bucket does not exist. -:Code: 404 Not Found - -``NoSuchKey`` - -:Description: No such access key. -:Code: 404 Not Found diff --git a/src/ceph/doc/dev/radosgw/index.rst b/src/ceph/doc/dev/radosgw/index.rst deleted file mode 100644 index 5f77609..0000000 --- a/src/ceph/doc/dev/radosgw/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -======================================= - RADOS Gateway developer documentation -======================================= - -.. rubric:: Contents - -.. toctree:: - :maxdepth: 1 - - - usage - Admin Ops Nonimplemented <admin/adminops_nonimplemented> - s3_compliance diff --git a/src/ceph/doc/dev/radosgw/s3_compliance.rst b/src/ceph/doc/dev/radosgw/s3_compliance.rst deleted file mode 100644 index b6b0d85..0000000 --- a/src/ceph/doc/dev/radosgw/s3_compliance.rst +++ /dev/null @@ -1,304 +0,0 @@ -=============================== -Rados Gateway S3 API Compliance -=============================== - -.. warning:: - This document is a draft, it might not be accurate - ----------------------- -Naming code reference ----------------------- - -Here comes a BNF definition on how to name a feature in the code for referencing purpose : :: - - name ::= request_type "_" ( header | operation ) ( "_" header_option )? - - request_type ::= "req" | "res" - - header ::= string - - operation ::= method resource - - method ::= "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD" - - resource ::= string - - header_option ::= string - ----------------------- -Common Request Headers ----------------------- - -S3 Documentation reference : http://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html - -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Header | Supported? | Code Links | Tests links | -+======================+============+=========================================================================================================+=============+ -| Authorization | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1962 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L2051 | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Content-Length | Yes | | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Content-Type | Yes | | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Content-MD5 | Yes | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1249 | | -| | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1306 | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Date | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_auth_s3.cc#L164 | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Expect | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest.cc#L1227 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L802 | | -| | | https://github.com/ceph/ceph/blob/76040d90f7eb9f9921a3b8dcd0f821ac2cd9c492/src/rgw/rgw_main.cc#L372 | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Host | ? | | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| x-amz-date | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_auth_s3.cc#L169 | | -| | | should take precedence over DATE as mentioned here -> | | -| | | http://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| x-amz-security-token | No | | | -+----------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ - ------------------------ -Common Response Headers ------------------------ - -S3 Documentation reference : http://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html - -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Header | Supported? | Code Links | Tests links | -+=====================+============+=========================================================================================================+=============+ -| Content-Length | Yes | | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Connection | ? | | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Date | ? | | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| ETag | Yes | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1312 | | -| | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1436 | | -| | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L2222 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L118 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L268 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L516 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1336 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1486 | | -| | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1548 | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Server | No | | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| x-amz-delete-marker | No | | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| x-amz-id-2 | No | | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| x-amz-request-id | Yes | https://github.com/ceph/ceph/commit/b711e3124f8f73c17ebd19b38807a1b77f201e44 | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| x-amz-version-id | No | | | -+---------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ - -------------------------- -Operations on the Service -------------------------- - -S3 Documentation reference : http://docs.aws.amazon.com/AmazonS3/latest/API/RESTServiceOps.html - -+------+-----------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Type | Operation | Supported? | Code links | Tests links | -+======+===========+============+=========================================================================================================+=============+ -| GET | Service | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L2094 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1676 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L185 | | -+------+-----------+------------+---------------------------------------------------------------------------------------------------------+-------------+ - ---------------------- -Operations on Buckets ---------------------- - -S3 Documentation reference : http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketOps.html - -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| Type | Operation | Supported? | Code links | Tests links | -+========+========================+============+============================================================================================================+=============+ -| DELETE | Bucket | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1728 | | -| | | | https://github.com/ceph/ceph/blob/e91042171939b6bf82a56a1015c5cae792d228ad/src/rgw/rgw_rest_bucket.cc#L250 | | -| | | | https://github.com/ceph/ceph/blob/e91042171939b6bf82a56a1015c5cae792d228ad/src/rgw/rgw_rest_bucket.cc#L212 | | -| | | | https://github.com/ceph/ceph/blob/25948319c4d256c4aeb0137eb88947e54d14cc79/src/rgw/rgw_bucket.cc#L856 | | -| | | | https://github.com/ceph/ceph/blob/25948319c4d256c4aeb0137eb88947e54d14cc79/src/rgw/rgw_bucket.cc#L513 | | -| | | | https://github.com/ceph/ceph/blob/25948319c4d256c4aeb0137eb88947e54d14cc79/src/rgw/rgw_bucket.cc#L286 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L461 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| DELETE | Bucket cors | ? | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1731 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1916 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| DELETE | Bucket lifecycle | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| DELETE | Bucket policy | ? | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| DELETE | Bucket tagging | ? | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| DELETE | Bucket website | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1676 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L185 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket acl | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1697 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1728 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1344 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket cors | ? | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1698 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1845 | | -| | | | https://github.com/ceph/ceph/blob/76040d90f7eb9f9921a3b8dcd0f821ac2cd9c492/src/rgw/rgw_main.cc#L345 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket lifecycle | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket location | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket policy | ? | https://github.com/ceph/ceph/blob/e91042171939b6bf82a56a1015c5cae792d228ad/src/rgw/rgw_rest_bucket.cc#L232 | | -| | | | https://github.com/ceph/ceph/blob/e91042171939b6bf82a56a1015c5cae792d228ad/src/rgw/rgw_rest_bucket.cc#L58 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket logging | ? | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1695 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L287 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket notification | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket tagging | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket Object versions | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket requestPayment | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket versionning | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | Bucket website | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| GET | List Multipart uploads | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1701 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest.cc#L877 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L2355 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L2363 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| HEAD | Bucket | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1713 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1689 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L826 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L834 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1725 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L382 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L437 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L901 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L945 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket acl | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1721 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1354 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1373 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1739 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1753 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket cors | ? | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1723 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1398 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1858 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1866 | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket lifecycle | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket policy | ? | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket logging | ? | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket notification | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket tagging | ? | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket requestPayment | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket versionning | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Bucket website | No | | | -+--------+------------------------+------------+------------------------------------------------------------------------------------------------------------+-------------+ - ---------------------- -Operations on Objects ---------------------- - -S3 Documentation reference : http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectOps.html - -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| Type | Operation | Supported? | Code links | Tests links | -+=========+===========================+============+=========================================================================================================+=============+ -| DELETE | Object | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1796 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1516 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1524 | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| DELETE | Multiple objects | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1739 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1616 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1626 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1641 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1667 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1516 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1524 | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| GET | Object | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1767 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L71 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L397 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L424 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L497 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L562 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L626 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L641 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L706 | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| GET | Object acl | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| GET | Object torrent | No | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| HEAD | Object | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1777 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L71 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L397 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L424 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L497 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L562 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L626 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L641 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L706 | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| OPTIONS | Object | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1814 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1418 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1951 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1968 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1993 | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| POST | Object | Yes | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1742 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L631 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L694 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L700 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L707 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L759 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L771 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L781 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L795 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L929 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1037 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1059 | | -| | | | https://github.com/ceph/ceph/blob/8a2eb18494005aa968b71f18121da8ebab48e950/src/rgw/rgw_rest_s3.cc#L1134 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1344 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1360 | | -| | | | https://github.com/ceph/ceph/blob/b139a7cd34b4e203ab164ada7a8fa590b50d8b13/src/rgw/rgw_op.cc#L1365 | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| POST | Object restore | ? | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Object | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Object acl | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Object copy | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Initate multipart upload | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Upload Part | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Upload Part copy | ? | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Complete multipart upload | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | Abort multipart upload | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ -| PUT | List parts | Yes | | | -+---------+---------------------------+------------+---------------------------------------------------------------------------------------------------------+-------------+ diff --git a/src/ceph/doc/dev/radosgw/usage.rst b/src/ceph/doc/dev/radosgw/usage.rst deleted file mode 100644 index 6c856fc..0000000 --- a/src/ceph/doc/dev/radosgw/usage.rst +++ /dev/null @@ -1,84 +0,0 @@ -============================ -Usage Design Overview -============================ - - - - -Testing -------- - -The current usage testing does the following: - -Following these operations: - - - Create a few buckets - - Remove buckets - - Create a bucket - - Put object - - Remove object - -Test: - -1. Verify that 'usage show' with delete_obj category isn't empty after no more than 45 seconds (wait to flush) -2. Check the following - - - 'usage show' - - - does not error out - - num of entries > 0 - - num of summary entries > 0 - - for every entry in categories check successful_ops > 0 - - check that correct uid in the user summary - - - - 'usage show' with specified uid (--uid=<uid>') - - - num of entries > 0 - - num of summary entries > 0 - - for every entry in categories check successful_ops > 0 - - check that correct uid in the user summary - - - 'usage show' with specified uid and specified categories (create_bucket, - put_obj, delete_obj, delete_bucket) - - - for each category: - - does not error out - - num of entries > 0 - - user in user summary is correct user - - length of categories entries under user summary is exactly 1 - - name of category under user summary is correct name - - successful ops for the category > 0 - - - 'usage trim' with specified uid - - does not error - - check following 'usage show' shows complete usage info cleared for user - - -Additional required testing: - - - test multiple users - - Do the same as in (2), with multiple users being set up. - - - test with multiple buckets (> 1000 * factor, e.g., 2000) - - Create multiple buckets, put objects in each. Account the number written data and verify - that usage reports show the expected number (up to a certain delta). - - - verify usage show with a date/time range - - Take timestamp of the beginning of the test, and the end of the test. Round timestamps to the - nearest hour (downward from start of test, upward from the end of test). List data starting - at end-time, make sure that no data is being shown. List data ending at start-time, make sure - that no data is shown. List data beginning at start-time, make sure that correct data is - displayed. List data ending end end-time, make sure that correct data is displayed. List - data beginning in begin-time, ending in end-time, make sure that correct data is displayed. - - - verify usage trim with a date/time range - - Take timestamp of the beginning of the test, and the end of the test. Round timestamps to the - nearest hour (downward from start of test, upward from the end of test). Trim data starting - at end-time, make sure that no data has been trimmed. Trim data ending at start-time, make sure - that no data has been trimmed. Trim data beginning in begin-time, ending in end-time, make sure - that all data has been trimmed. |