Debian Codegraph @

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

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