Ghanshyam Mann
0cc7cbc36d
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 convert manila/tests/policy.json to manila/tests/policy.yaml using oslopolicy-convert-json-to-yaml tool and 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: I3748313912b2527c43c9b16a6ba3e3ccd4cf5221
58 lines
1.9 KiB
Python
58 lines
1.9 KiB
Python
# Copyright (c) 2018 NEC, Corp.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import sys
|
|
|
|
from oslo_config import cfg
|
|
from oslo_upgradecheck import common_checks
|
|
from oslo_upgradecheck import upgradecheck
|
|
|
|
from manila.i18n import _
|
|
|
|
|
|
class Checks(upgradecheck.UpgradeCommands):
|
|
|
|
"""Various upgrade checks should be added as separate methods in this class
|
|
|
|
and added to _upgrade_checks tuple.
|
|
"""
|
|
|
|
def _check_placeholder(self):
|
|
# This is just a placeholder for upgrade checks, it should be
|
|
# removed when the actual checks are added
|
|
return upgradecheck.Result(upgradecheck.Code.SUCCESS)
|
|
|
|
# The format of the check functions is to return an
|
|
# oslo_upgradecheck.upgradecheck.Result
|
|
# object with the appropriate
|
|
# oslo_upgradecheck.upgradecheck.Code and details set.
|
|
# If the check hits warnings or failures then those should be stored
|
|
# in the returned Result's "details" attribute. The
|
|
# summary will be rolled up at the end of the check() method.
|
|
_upgrade_checks = (
|
|
# In the future there should be some real checks added here
|
|
(_('Placeholder'), _check_placeholder),
|
|
(_('Policy File JSON to YAML Migration'),
|
|
(common_checks.check_policy_json, {'conf': cfg.CONF})),
|
|
)
|
|
|
|
|
|
def main():
|
|
return upgradecheck.main(
|
|
cfg.CONF, project='manila', upgrade_command=Checks())
|
|
|
|
|
|
if __name__ == '__main__':
|
|
sys.exit(main())
|