Add a description for every policy rule

Registered by John Garbutt on 2017-02-13

We should ensure operators no longer need to read code to fully understand what each of the policy rules means.

Now default policy is in code, lets populate all the descriptions.

Blueprint information

Status:
Complete
Approver:
Matt Riedemann
Priority:
Medium
Drafter:
John Garbutt
Direction:
Approved
Assignee:
John Garbutt
Definition:
Approved
Series goal:
Accepted for pike
Implementation:
Implemented
Milestone target:
milestone icon pike-3
Started by
Matt Riedemann on 2017-03-15
Completed by
Matt Riedemann on 2017-07-18

Related branches

Sprints

Whiteboard

Remaining files:

nova/policies/extended_availability_zone.py
nova/policies/extended_server_attributes.py
nova/policies/extended_status.py
nova/policies/extended_volumes.py
nova/policies/fixed_ips.py
nova/policies/fping.py
nova/policies/hide_server_addresses.py
nova/policies/hosts.py
nova/policies/image_size.py
nova/policies/instance_actions.py
nova/policies/instance_usage_audit_log.py
nova/policies/ips.py
nova/policies/limits.py
nova/policies/multinic.py
nova/policies/networks.py
nova/policies/networks_associate.py
nova/policies/quota_class_sets.py

Gerrit topic: https://review.openstack.org/#q,topic:bp/policy-docs,n,z

Addressed by: https://review.openstack.org/433010
    Add polcy-docs spec

Gerrit topic: https://review.openstack.org/#q,topic:bp/policy-remove-scope-checks,n,z

Addressed by: https://review.openstack.org/445208
    Add description to policies in agents.py

Addressed by: https://review.openstack.org/434842
    POC: add descriptions to server tags

Addressed by: https://review.openstack.org/445230
    Add description to policies in aggregates.py

Addressed by: https://review.openstack.org/445238
    Add description to policies in assisted_volume_snapshots.py

Addressed by: https://review.openstack.org/440836
    Add description to policies to availability_zone

Addressed by: https://review.openstack.org/445252
    Add description to volumes_attachments.py

Addressed by: https://review.openstack.org/445637
    Add description to policies in volumes.py

Addressed by: https://review.openstack.org/445652
    Add descripiton to policies in virtual_interfaces.py

Gerrit topic: https://review.openstack.org/#q,topic:bp/policy-doc,n,z

Addressed by: https://review.openstack.org/443957
    Add description to policies in admin_password.py

Addressed by: https://review.openstack.org/440829
    Add description to policies in admin_actions.

Addressed by: https://review.openstack.org/447611
    Remove unused policy rule in admin_actions.py

Addressed by: https://review.openstack.org/447696
    Add description to policies in attach_interfaces.py

Addressed by: https://review.openstack.org/447698
    Refactor: remove _items() in nova/api/openstack/compute/attach_interfaces.py

Addressed by: https://review.openstack.org/447710
    Add description to policies in used_limits

Addressed by: https://review.openstack.org/447722
    Add description to policies in suspend_server.py

Addressed by: https://review.openstack.org/448224
    Add description to policies in cells.py

Addressed by: https://review.openstack.org/448260
    Add description to policies in cells_scheduler.py

Addressed by: https://review.openstack.org/448267
    Add description to policies in certificates.py

Addressed by: https://review.openstack.org/448271
    Add description to policies in cloudpipe.py

Addressed by: https://review.openstack.org/448468
    Add description to policies in lock_server.py

Addressed by: https://review.openstack.org/448650
    Add description to policies in baremetal_nodes.py

Addressed by: https://review.openstack.org/448663
    Add description to policies in console_auth_tokens.py

Addressed by: https://review.openstack.org/448681
    Add description to policies in deferred_delete.py

Addressed by: https://review.openstack.org/448682
    Add description to policies in create_backup.py

Addressed by: https://review.openstack.org/448683
    Add description to policies in consoles.py

Addressed by: https://review.openstack.org/448684
    Add description to policies in console_output.py

Addressed by: https://review.openstack.org/448461
    Add description to policies in keypairs.py

Addressed by: https://review.openstack.org/449478
    Add description to policies in pause_server.py

Addressed by: https://review.openstack.org/449486
    Add description to policies in server_groups.py

Addressed by: https://review.openstack.org/449714
    Add description to policies in tenant_networks.py

Addressed by: https://review.openstack.org/449742
    Add description to policies in simple_tenant_usage.py

Addressed by: https://review.openstack.org/449763
    Add description to nova/policies/shelve.py

Addressed by: https://review.openstack.org/449782
    Add description to policies in services.py

Addressed by: https://review.openstack.org/450059
    Add description to policies in evacuate.py and rescue.py

Addressed by: https://review.openstack.org/450527
    Add description to policies in flavor_extra_specs.py

Addressed by: https://review.openstack.org/450538
    Add description to policies in server_metadata.py

Addressed by: https://review.openstack.org/451271
    Add description to policies in admin_password.py

Addressed by: https://review.openstack.org/451294
    Add description to policies in hypervisors.py

Addressed by: https://review.openstack.org/451487
    Add description to policies in servers_migrations.py

Addressed by: https://review.openstack.org/451966
    Add description to policies in servers.py

Addressed by: https://review.openstack.org/452259
    Add description to policies in server_password.py

Addressed by: https://review.openstack.org/452263
    Add description to policies in server_external_events.py

Addressed by: https://review.openstack.org/452267
    Add description to policies in server_diagnostics.py

Addressed by: https://review.openstack.org/452309
    Add description to policies in security_groups.py

Addressed by: https://review.openstack.org/453748
    Add description to policies in security_group_default_rules.py

Addressed by: https://review.openstack.org/454372
    Add description to policies in remote_consoles.py

Addressed by: https://review.openstack.org/454383
    Add description to policies in quota_sets.py

Addressed by: https://review.openstack.org/460509
    Update description to policies in remaining flavor APIs

Addressed by: https://review.openstack.org/459727
    Add description to policies in migrations.py

Addressed by: https://review.openstack.org/461600
    Add description to policies in extended_az and extend_ser_attrs

Addressed by: https://review.openstack.org/461601
    Add description to policies in extended_status and extended_volumes

Gerrit topic: https://review.openstack.org/#q,topic:bp/blueprint,n,z

Addressed by: https://review.openstack.org/461721
    Add policy description for config_drive

Addressed by: https://review.openstack.org/461724
    Add policy description for os-fixed-ips

Addressed by: https://review.openstack.org/461728
    Add policy description for 'os-hide-server-addresses'

Addressed by: https://review.openstack.org/461732
    Add policy description for Servers IPs

Addressed by: https://review.openstack.org/461741
    Add policy description for instance-usage-audit-log

Addressed by: https://review.openstack.org/461747
    Add policy description for image size

Addressed by: https://review.openstack.org/461757
    Add policy description for instance actions

Addressed by: https://review.openstack.org/461763
    Add policy description for fping

Addressed by: https://review.openstack.org/461995
    Add policy description for extensions

Addressed by: https://review.openstack.org/461996
    Add policy description for os-quota-classes

Addressed by: https://review.openstack.org/460097
    Ensure sample policy help text correctly wrapped

Addressed by: https://review.openstack.org/465426
    Add policy description for 'limits'

Addressed by: https://review.openstack.org/465433
    Add policy description for multinic

Addressed by: https://review.openstack.org/465437
    Add policy description for server_usage

Addressed by: https://review.openstack.org/465443
    Add policy description for networks_associate

Addressed by: https://review.openstack.org/465452
    Add policy description for os-networks

Addressed by: https://review.openstack.org/465458
    Add policy description for os-host

Addressed by: https://review.openstack.org/465510
    WIP: Remove os_compute_api:os-server-groups policy

Addressed by: https://review.openstack.org/465505
    WIP: remove flavor policy

Addressed by: https://review.openstack.org/466471
    Update policy description for os-volumes

Addressed by: https://review.openstack.org/466596
    Deprecate unused policy from policy doc

Addressed by: https://review.openstack.org/472622
    Update policy descriptions for base.

Addressed by: https://review.openstack.org/472634
    WIP: Use oslo.polcy DocumentedRuleDefault

Addressed by: https://review.openstack.org/479773
    Remove 'create_rule_default'

Addressed by: https://review.openstack.org/479774
    Consistent policies

Addressed by: https://review.openstack.org/484646
    Fix indentation in policy doc

Now that https://review.openstack.org/#/c/472622/ is merged I'm going to consider this complete. -- mriedem 20170718

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.