===========================
oslopolicy-policy-generator
===========================

.. program:: oslopolicy-policy-generator

Synopsis
--------

::

   oslopolicy-policy-generator [-h] [--config-dir DIR] [--config-file PATH]
                               [--namespace NAMESPACE]
                               [--output-file OUTPUT_FILE]

Description
-----------

The ``oslopolicy-policy-generator`` command can be used to generate a policy
file that shows the effective policy in use. This is generated by merging the
registered defaults and policies loaded from a configuration file.

Options
-------

.. include:: common/default-opts.rst

.. include:: common/enforcer-opts.rst

.. include:: common/generator-opts.rst

Examples
--------

The generate the effective policy file for a namespace called ``keystone``:

.. code-block:: bash

   oslopolicy-policy-generator --namespace keystone

To generate the effective policy file in JSON:

.. code-block:: bash

   oslopolicy-policy-generator --namespace keystone --format json

To generate the effective policy file and output directly to a file:

.. code-block:: bash

   oslopolicy-policy-generator \
     --namespace keystone \
     --format yaml \
     --output-file keystone-policy.yaml

To show the additional options and arguments supported by
``oslopolicy-policy-generator``:

.. code-block:: bash

   oslopolicy-policy-generator --help

See Also
--------

:program:`oslopolicy-sample-generator`, :program:`oslopolicy-list-redundant`,
:program:`oslopolicy-checker`

===========================
oslopolicy-policy-generator
===========================

.. program:: oslopolicy-policy-generator

Synopsis
--------

::

   oslopolicy-policy-generator [-h] [--config-dir DIR] [--config-file PATH]
                               [--namespace NAMESPACE]
                               [--output-file OUTPUT_FILE]

Description
-----------

The ``oslopolicy-policy-generator`` command can be used to generate a policy
file that shows the effective policy in use. This is generated by merging the
registered defaults and policies loaded from a configuration file.

Options
-------

.. include:: common/default-opts.rst

.. include:: common/enforcer-opts.rst

.. include:: common/generator-opts.rst

Examples
--------

The generate the effective policy file for a namespace called ``keystone``:

.. code-block:: bash

   oslopolicy-policy-generator --namespace keystone

To generate the effective policy file and output directly to a file:

.. code-block:: bash

   oslopolicy-policy-generator \
     --namespace keystone \
     --output-file keystone-policy.yaml

To show the additional options and arguments supported by
``oslopolicy-policy-generator``:

.. code-block:: bash

   oslopolicy-policy-generator --help

See Also
--------

:program:`oslopolicy-sample-generator`, :program:`oslopolicy-list-redundant`,
:program:`oslopolicy-checker`

Remove format option examples in policy generator
Remove format option examples in policy generator

As `--format` option was dropped in oslopolicy-policy-generator, remove
examples of the option in documentation.

Change-Id: I20f748dadecc15eaad6326a20a121cab4c1a995e
Signed-off-by: Yasufumi Ogawa <0cbdead7c4bf8da8f6bef3a7960478ac9af89f0a@gmail.com>
