cinder/doc/source/admin
Ghanshyam Mann 325001045c [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
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 project side
via warning in doc and format releasenotes.

1st item if already done by cinder in Stein so this commit
only cover the 2nd item.

Since oslo.policy 3.6.0, by default oslo policy will
fallback to existing policy.json file to give operator some
time to migrate it to new default policy.yaml. But cinder
already changed the default value to policy.yaml long back
since Stein so no need to fallback to default JSON file. To
do that it disable this fallback via flag to oslo.policy.

Also convert the tests/unit/policy.json to policy.yaml file.

Additionally, made some corrections to outdated documentation
when removing references to a "policy.json" file.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Co-Authored-By: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: Iaf8a454e60d1e4b66981b61175f89203cc15e439
2020-12-11 18:31:04 -06:00
..
blockstorage-accelerate-image-compression.rst Add doc page for accelerate image compression 2019-09-23 11:37:28 +08:00
blockstorage-api-throughput.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
blockstorage-availability-zone-type.rst Support availability-zone type 2018-05-17 12:09:12 +00:00
blockstorage-backup-disks.rst TrivialFix: Delete word ‘I’ in admin/blockstorage-backup-disks.rst 2017-12-06 10:04:59 +08:00
blockstorage-basic-volume-qos.rst Add documentation page for basic volume quality of service 2018-06-12 22:57:51 +00:00
blockstorage-boot-from-volume.rst Fix link error in 'Boot from volume' doc 2018-02-09 15:14:27 +08:00
blockstorage-capacity-based-qos.rst Capacity based QoS doc 2020-09-03 15:15:56 +05:30
blockstorage-consistency-groups.rst [goal] Deprecate the JSON formatted policy file 2020-12-11 18:31:04 -06:00
blockstorage-driver-filter-weighing.rst Improve documentation of goodness/filter function 2019-02-25 11:37:51 +00:00
blockstorage-get-capabilities.rst Fix doc output examples 2018-10-09 11:23:35 +00:00
blockstorage-groups.rst Small doc updates: canonical URLs, rally doc, etc 2019-06-04 17:57:16 +02:00
blockstorage-image-volume-cache.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
blockstorage-lio-iscsi-support.rst Use new target_* options in documentation 2019-03-01 09:52:41 +00:00
blockstorage-manage-volumes.rst Docs: Make links more robust 2019-08-10 10:49:23 +02:00
blockstorage-multi-backend.rst doc: fixes typo in multi backend configration doc 2019-12-18 21:16:32 +05:30
blockstorage-nfs-backend.rst Update install docs to match default NFS config 2019-02-05 15:09:44 -06:00
blockstorage-over-subscription.rst [Doc] Fix typos 2019-01-11 16:49:53 +08:00
blockstorage-ratelimit-volume-copy-bandwidth.rst Fix doc: s/cgroup-bin/cgroup-tools/ 2020-05-01 13:25:11 +02:00
blockstorage-troubleshoot.rst Remove Dell EMC PS Series Driver 2020-01-23 11:19:22 -06:00
blockstorage-volume-backed-image.rst Remove Glance v1 API support 2017-09-08 17:13:14 -05:00
blockstorage-volume-backups-export-import.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
blockstorage-volume-backups.rst Merge "Support modern compression algorithms in cinder backup" 2020-09-04 16:13:42 +00:00
blockstorage-volume-migration.rst Docs: Make links more robust 2019-08-10 10:49:23 +02:00
blockstorage-volume-multiattach.rst [goal] Deprecate the JSON formatted policy file 2020-12-11 18:31:04 -06:00
blockstorage-volume-number-weigher.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
generalized_filters.rst Doc8: Stop skipping D001: Line too long 2019-02-19 16:51:56 -06:00
index.rst Add doc page for accelerate image compression 2019-09-23 11:37:28 +08:00
README.rst [Docs] Add documentation contribution docs 2017-08-10 15:52:46 -05:00
ts-cinder-config.rst docs: fixes wrong config file reference 2020-06-10 17:37:47 +05:30
ts-duplicate-3par-host.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-failed-attach-vol-after-detach.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-failed-attach-vol-no-sysfsutils.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-failed-connect-vol-FC-SAN.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-HTTP-bad-req-in-cinder-vol-log.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-multipath-warn.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-no-emulator-x86-64.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-non-existent-host.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00
ts-non-existent-vlun.rst Migrate the blockstorage admin-guide to Cinder 2017-07-08 12:44:49 -05:00

Cinder Administration Documentation (source/admin)

Introduction:

This directory is intended to hold any documentation that relates to how to run or operate Cinder. Previously, this content was in the admin-guide section of openstack-manuals.

The full spec for organization of documentation may be seen in the OS Manuals Migration Spec <https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html>.