Debian Codegraph @

doc/source/cli/oslopolicy-policy-generator.rst

raw
1 ===========================
2 oslopolicy-policy-generator
3 ===========================
4
5 .. program:: oslopolicy-policy-generator
6
7 Synopsis
8 --------
9
10 ::
11
12 oslopolicy-policy-generator [-h] [--config-dir DIR] [--config-file PATH]
13 [--namespace NAMESPACE]
14 [--output-file OUTPUT_FILE]
15
16 Description
17 -----------
18
19 The ``oslopolicy-policy-generator`` command can be used to generate a policy
20 file that shows the effective policy in use. This is generated by merging the
21 registered defaults and policies loaded from a configuration file.
22
23 Options
24 -------
25
26 .. include:: common/default-opts.rst
27
28 .. include:: common/enforcer-opts.rst
29
30 .. include:: common/generator-opts.rst
31
32 Examples
33 --------
34
35 The generate the effective policy file for a namespace called ``keystone``:
36
37 .. code-block:: bash
38
39 oslopolicy-policy-generator --namespace keystone
40
41 To generate the effective policy file and output directly to a file:
42
43 .. code-block:: bash
44
45 oslopolicy-policy-generator \
46 --namespace keystone \
47 --output-file keystone-policy.yaml
48
49 To show the additional options and arguments supported by
50 ``oslopolicy-policy-generator``:
51
52 .. code-block:: bash
53
54 oslopolicy-policy-generator --help
55
56 See Also
57 --------
58
59 :program:`oslopolicy-sample-generator`, :program:`oslopolicy-list-redundant`,
60 :program:`oslopolicy-checker`