summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/stack-domain-users.rst4
-rw-r--r--doc/source/configuration/sample_policy.rst8
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