diff options
| author | Ghanshyam Mann <gmann@ghanshyammann.com> | 2020-12-13 12:36:17 -0600 |
|---|---|---|
| committer | ricolin <ricolin@ricolky.com> | 2021-06-17 01:35:45 +0800 |
| commit | 157f358057c3e12158ee4ba354566c2ad5a9ecb5 (patch) | |
| tree | a2e855b16101a8a8fa29471036455e88fcd3f745 /doc | |
| parent | f341395a4672ac913dc73d084a6f78cc0394e288 (diff) | |
| download | heat-157f358057c3e12158ee4ba354566c2ad5a9ecb5.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 code.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: I1aa12bcd2638390f25d57ce8abeeec248121dc02
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/stack-domain-users.rst | 4 | ||||
| -rw-r--r-- | doc/source/configuration/sample_policy.rst | 8 |
2 files changed, 10 insertions, 2 deletions
diff --git a/doc/source/admin/stack-domain-users.rst b/doc/source/admin/stack-domain-users.rst index fa869d943..4818554d2 100644 --- a/doc/source/admin/stack-domain-users.rst +++ b/doc/source/admin/stack-domain-users.rst @@ -124,7 +124,7 @@ The following steps are run during stack creation: perspective) to the stack owners project. The users who are created in the stack domain are still assigned the ``heat_stack_user`` role, so the API surface they can access is limited through - the :file:`policy.json` file. + the :file:`policy.yaml` file. For more information, see :keystone-doc:`OpenStack Identity documentation <>`. @@ -133,7 +133,7 @@ The following steps are run during stack creation: retrieved. Details are retrieved from the database for both the stack owner's project (the default API path to the stack) and the stack domain project, subject to the - :file:`policy.json` restrictions. + :file:`policy.yaml` restrictions. This means there are now two paths that can result in the same data being retrieved through the Orchestration API. diff --git a/doc/source/configuration/sample_policy.rst b/doc/source/configuration/sample_policy.rst index 78814abe8..0b9ce0976 100644 --- a/doc/source/configuration/sample_policy.rst +++ b/doc/source/configuration/sample_policy.rst @@ -2,6 +2,14 @@ Heat Sample Policy ================== +.. warning:: + + JSON formatted policy file is deprecated since Heat 17.0.0 (Xena). + 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 + The following is a sample heat policy file that has been auto-generated from default policy values in code. If you're using the default policies, then the maintenance of this file is not necessary, and it should not be copied into |