diff options
| author | Ghanshyam Mann <gmann@ghanshyammann.com> | 2020-12-24 20:28:51 -0600 |
|---|---|---|
| committer | Lingxian Kong <anlin.kong@gmail.com> | 2020-12-26 05:30:18 +0000 |
| commit | bcb8992f995468fddfc1da472f74f346b7acd7f4 (patch) | |
| tree | 21b788741481fb16409e94d81f72ef1cb7c9d2bc /doc | |
| parent | 3301e2e42c8fb2e26d9db60adf001194f83ef369 (diff) | |
| download | trove-bcb8992f995468fddfc1da472f74f346b7acd7f4.tar.gz | |
[goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:
1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.
2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.
Also replace policy.json to policy.yaml ref from doc and tests.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: I790409da69df8479ad2fe152b15c32ba45067c23
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/run_trove_in_production.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/source/admin/run_trove_in_production.rst b/doc/source/admin/run_trove_in_production.rst index 5cfde6b3..94bbce24 100644 --- a/doc/source/admin/run_trove_in_production.rst +++ b/doc/source/admin/run_trove_in_production.rst @@ -257,11 +257,19 @@ database group ``mysql+pymysql://root:password@127.0.0.1/trove?charset=utf8`` The cloud administrator also needs to provide a policy file -``/etc/trove/policy.json`` if the default API access policies don't satisfy the +``/etc/trove/policy.yaml`` if the default API access policies don't satisfy the requirement. To generate a sample policy file with all the default policies, run ``tox -egenpolicy`` in the repo folder and the new file will be located in ``etc/trove/policy.yaml.sample``. +.. warning:: + + JSON formatted policy file is deprecated since Trove 15.0.0 (Wallaby). + This `oslopolicy-convert-json-to-yaml`__ tool will migrate your existing + JSON-formatted policy file to YAML in a backward-compatible way. + +.. __: https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html + Initialize Trove Database ~~~~~~~~~~~~~~~~~~~~~~~~~ |