ceph/doc/man/8/rgw-policy-check.rst
Marcus Watts 28864311d3 rgw: added rgw-policy-check
rgw-policy-check - a program to do syntax checking on bucket policy.
This program just reads the policy into memory, so it is not
checking anything except syntax.

Signed-off-by: Marcus Watts <mwatts@redhat.com>

rgw: Fix return value of `rgw-policy-check`

Signed-off-by: Adam C. Emerson <aemerson@redhat.com>

rgw: Use ceph initialization in `rgw-policy-check`

Specifically so we can pull in the options from `ceph.conf` and similar.

Signed-off-by: Adam C. Emerson <aemerson@redhat.com>
2022-12-13 16:41:52 -05:00

56 lines
1.4 KiB
ReStructuredText

:orphan:
===================================================
rgw-policy-check -- verify syntax of bucket policy
===================================================
.. program:: rgw-policy-check
Synopsis
========
| **rgw-policy-check**
-t *tenant* [ *filename* ... ]
Description
===========
This program reads one or more files containing bucket policy
and determines if it is syntactically correct.
It does not check to see if the policy makes sense;
it only checks to see if the file would be accepted
by the policy parsing logic inside
:program:`radsogw`.
More than one filename may be specified. If no files are
given, the program will read from stdin.
On success, the program will say nothing. On failure,
the program will emit a error message indicating the
problem. The program will terminate with non-zero exit
status if one or more policies could not be read or parsed.
Options
=======
.. option: -t *tenant*
Specify *tenant* as the tenant. This is required by the
policy parsing logic and is used to construct the internal
state representation of the policy.
Availability
============
**rgw-policy-check** is part of Ceph, a massively scalable, open-source,
distributed storage system. Please refer to the Ceph documentation at
http://ceph.com/docs for more information.
See also
========
:doc:`radosgw <radosgw>`\(8)
.. _Bucket Policies: ../../radosgw/bucketpolicy.rst