summaryrefslogtreecommitdiffstats
path: root/doc/man/8/rgw-policy-check.rst
blob: 3f055711fc4e95e017ae365f50a38099fc8bb54b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
: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