Difference between revisions of "Documentation/ReorganizeUserGuides"
(→Legacy to OpenStack command conversion table) |
(→Initial steps) |
||
(40 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | == Pike Tasks == | ||
+ | * Moving the Administration Guide content to project repositories, to be directly managed by the project team. | ||
+ | |||
+ | * A [https://wiki.openstack.org/wiki/Migrate_Administrator_Guide table for tracking the Admin Guide migration] is available on the OpenStack wiki. | ||
+ | |||
+ | === Initial steps === | ||
+ | ** Wiki page for tracking the transition - In Progress - Joe Robinson | ||
+ | ** Setup the cookie cutter for the Administration Guide | ||
+ | ** Complete select cleaning up and updates to the Admin Guide content | ||
+ | ** Encourage the project teams to move existing content to project team repositories | ||
+ | **Update the Documentation Contributor Guide to include the required steps to setup a project Administrator Guide | ||
+ | |||
+ | === Intermediate Steps === | ||
+ | **Update the Master Index File to reflect the new structure | ||
+ | **Write a base Administrator Guide | ||
+ | **Setup gate jobs to to publish the administrator guide when the Index File patch merges | ||
+ | **Notify project teams when this method publishing the project specific Administrator Guide | ||
+ | |||
== Ocata Tasks == | == Ocata Tasks == | ||
* Swap legacy commands for OpenStack client commands in the User Guide and Administrator Guide. | * Swap legacy commands for OpenStack client commands in the User Guide and Administrator Guide. | ||
Line 4: | Line 22: | ||
== Legacy to OpenStack command conversion table == | == Legacy to OpenStack command conversion table == | ||
− | User Guide Legacy Command Table | + | === User Guide Legacy Command Table === |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
!Guide Name !! File Name !! Commands !! Change details !! Name !! Patch & status | !Guide Name !! File Name !! Commands !! Change details !! Name !! Patch & status | ||
+ | |- | ||
+ | | User Guide ||backup-db-incremental.rst|| 46: $ trove backup-create $ trove backup-create 108: $ trove create guest2 10 --size 1 --backup BACKUP_ID || legacy || name || | ||
+ | |- | ||
+ | |User Guide ||backup-db.rst||33: $ trove list 54: $ trove backup-create INSTANCE_ID backup1 79: $ trove backup-list :92: $ trove backup-show BACKUP_ID :126: $ trove create guest2 10 --size 2 --backup BACKUP_ID :151: $ trove list :166: $ trove show INSTANCE_ID :192: $ trove database-list INSTANCE_ID :208: $ trove user-list INSTANCE_ID :231: $ trove delete INSTANCE_ID || legacy ||name || | ||
+ | |- | ||
+ | |User Guide ||cli-ceilometer.rst|| :91: $ ceilometer alarm-list, :103: $ ceilometer meter-list, :116: $ ceilometer sample-list -m cpu_util :127: $ ceilometer statistics -m cpu_util || || || | ||
|- | |- | ||
|User Guide || cli-nova-configure-access-security-for-instances.rst || nova secgroup-list-rules SECURITY_GROUP_NAME || Changed || Allen, David Rabel || Done https://review.openstack.org/#/c/389980, and https://review.openstack.org/#/c/399691 | |User Guide || cli-nova-configure-access-security-for-instances.rst || nova secgroup-list-rules SECURITY_GROUP_NAME || Changed || Allen, David Rabel || Done https://review.openstack.org/#/c/389980, and https://review.openstack.org/#/c/399691 | ||
Line 14: | Line 38: | ||
|User Guide || cli-cheat-sheet.rst || 262: $ nova secgroup-add-group-rule default default icmp -1 -1, 263: $ nova secgroup-add-group-rule default default tcp 22 22 || Legacy and OpenStack commands || David Rabel, 142: $ nova meta volumeTwoImage set newmeta='my meta data' || Done https://review.openstack.org/#/c/399691 | |User Guide || cli-cheat-sheet.rst || 262: $ nova secgroup-add-group-rule default default icmp -1 -1, 263: $ nova secgroup-add-group-rule default default tcp 22 22 || Legacy and OpenStack commands || David Rabel, 142: $ nova meta volumeTwoImage set newmeta='my meta data' || Done https://review.openstack.org/#/c/399691 | ||
|- | |- | ||
− | |User Guide||cli-cheat-sheet.rst part 2.|| | + | |User Guide||cli-cheat-sheet.rst part 2.||:154: $ nova meta volumeTwoImage set newmeta='my meta data' 372: $ swift stat, 373: $ swift stat ACCOUNT, 374: $ swift stat CONTAINER, 375: $ swift stat OBJECT, 381: $ swift list||Legacy||Joe Robinson||Done https://review.openstack.org/400603, and https://review.openstack.org/405982 . 08/12 - Swift team confirms Swift commands do not have equivalent OpenStack commands yet. |
|- | |- | ||
− | |User Guide||cli-nova-launch-instance-from-volume.rst|| | + | |User Guide||cli-nova-launch-instance-from-volume.rst|| 326 $ nova boot --flavor FLAVOR --image IMAGE_ID --swap 512 \ --ephemeral size=2 NAME ||Legacy||Joe Robinson, Caoyuan ||Done https://review.openstack.org/400603 and https://review.openstack.org/#/c/446341 |
|- | |- | ||
|User Guide||cli-nova-launch-instance-using-ISO-image.rst||95: $ cinder list, 110: $ cinder upload-to-image VOLUME_UUID IMAGE_NAME, 111: glance image-list||Legacy||Joe Robinson||Done https://review.openstack.org/400603 | |User Guide||cli-nova-launch-instance-using-ISO-image.rst||95: $ cinder list, 110: $ cinder upload-to-image VOLUME_UUID IMAGE_NAME, 111: glance image-list||Legacy||Joe Robinson||Done https://review.openstack.org/400603 | ||
Line 28: | Line 52: | ||
|User Guide||cli-manage-bare-metal-nodes.rst||54, 63: $ nova baremetal-node-create, 90: $ nova baremetal-interface-add, 110, 128: $ nova boot --image my-baremetal-image --flavor, 157: $ nova baremetal-node-show, 142: $ nova baremetal-node-list || Legacy || || | |User Guide||cli-manage-bare-metal-nodes.rst||54, 63: $ nova baremetal-node-create, 90: $ nova baremetal-interface-add, 110, 128: $ nova boot --image my-baremetal-image --flavor, 157: $ nova baremetal-node-show, 142: $ nova baremetal-node-list || Legacy || || | ||
|- | |- | ||
− | |User Guides|| || || || | + | |User Guides||cli-use-snapshots-to-migrate-instances.rst|| || OpenStack || caoyuan, yanghuichan || https://review.openstack.org/#/c/408679/ - merged. https://review.openstack.org/#/c/446853/ |
+ | |- | ||
+ | |User Guides||create-db.rst || 123: $ trove create mysql_instance_1 6 --size 5 --databases myDB, 147: $ trove list, 162: $ trove show INSTANCE_ID || Legacy commands || Zhang Yan Xian || In Progress https://review.openstack.org/#/c/412713/ | ||
+ | |- | ||
+ | |User Guides||cli-create-and-manage-networks.rst|| 15: $ neutron ext-list -c alias -c name, 87: $ neutron subnet-create net1 192.168.2.0/24 --name subnet1, 134: $ neutron router-create router1, 154: $ neutron router-gateway-set ROUTER NETWORK, 163: $ neutron router-interface-add ROUTER SUBNET, 175: $ neutron port-create net1 --fixed-ip ip_address=192.168.2.40, 208: $ neutron port-create net1, 242: $ neutron port-list --fixed-ips ip_address=192.168.2.2 \, :306: $ neutron port-list --fixed-ips ip_address=192.168.2.2 \ | ||
+ | || Legacy and OpenStack || Zhang Yan Xian || In Progress https://review.openstack.org/#/c/413483 | ||
+ | |- | ||
+ | |User Guides||cli-manage-shares|| 17: $ manila share-network-create \ :44: $ manila share-network-list:58: $ manila create NFS 1 \ :96: 337: 447: 492: 546: 591 $ manila show myshare : 141: 325: 391 $ manila list :152: $ manila share-export-location-list myshare : 167: 199 $ manila access-allow myshare ip 10.0.0.0/24 : 183: 215: 239 $ manila access-list myshare : 232: 233 $ manila access-deny myshare 0 :254: $ manila snapshot-create --name mysnapshot --description "My Manila snapshot" myshare :274:408:425 $ manila snapshot-list :288: $ manila create NFS 1 \ :385: $ manila delete mysharefromsnap :419: $ manila snapshot-delete mysnapshot :441: $ manila extend myshare 2 :540: $ manila shrink myshare 1|| legacy || name || | ||
|- | |- | ||
− | |User Guides|| || || || | + | |User Guides||cli-reboot-an-instance.rst ||75: $ nova rescue --rescue_image_ref IMAGE_ID SERVEl || legacy || name || |
|- | |- | ||
− | |User Guides|| || || || | + | |User Guides||set-up-clustering.rst || :55: $ trove cluster-create cluster1 mongodb "2.4" \ :82: $ trove cluster-show CLUSTER_ID, :112: $ trove cluster-instances CLUSTER_ID, :146: $ trove cluster-list, :160: $ trove cluster-delete CLUSTER_ID || legacy || name || |
|- | |- | ||
− | | | + | |User Guides||set-up-replication.rst || 46: $ trove create replica_1 6 --size=5 --datastore_version mysql-5.5 \, :58: $ trove show INSTANCE_ID_OF_REPLICA_1, :81: $ trove show INSTANCE_ID_OF_BASE_1, :109: $ trove detach-replica INSTANCE_ID_OF_REPLICA || legacy || name || |
|- | |- | ||
− | | | + | |User Guides ||manage-db-config.rst || :30: $ trove datastore-version-list mysql :44: $ trove configuration-parameter-list DATASTORE_VERSION_ID :99: $ trove configuration-create NAME VALUES --datastore DATASTORE_NAME :119: $ trove configuration-create group1 '{"sync_binlog" : 1}' --datastore mysql :140: $ mysql -u user7 -ppassword -h 172.16.200.2 myDB :164: $ trove list, :176: $ trove configuration-list, :194: $ trove configuration-attach DB_INSTANCE_ID CONFIG_GROUP_ID || legacy || name || |
|- | |- | ||
− | |Admin Guide || compute-manage-logs.rst || nova get-serial-proxy: 196 || Legacy || || | + | | User Guides || The Swift Files || cli-swift-create-containers.rst, cli-swift-manage-access-swift.rst, cli-swift-manage-objects.rst, cli-swift-pseudo-hierarchical-folders-directories.rst, cli-swift-serialized-response-formats.rst, cli-swift-set-object-versions.rst, cli-swift-static-website.rst || Legacy || Name || Currently, the swift team is unable to work on creating openstack client commands for the swift service. |
+ | |- | ||
+ | |} | ||
+ | |||
+ | === Admin Guide Legacy Command Table === | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | !Guide Name !! File Name !! Commands !! Change details !! Name !! Patch & status | ||
+ | |- | ||
+ | |Admin Guide || compute-configuring-migrations.rst || nova quota-defaults: 58 64. nova quota-class-update: 88 94. nova quota-show: 109 115. nova quota-update: 148 154. nova-quota-show: 155, 206, 212, 258. nova quota-update: 251 257. nova absolute limits: 295|| Changed|| darrenc || Done https://review.openstack.org/#/c/412294/ | ||
+ | |- | ||
+ | |Admin Guide || compute-live-migration-usage.rst || nova list: 28. nova show: 52. nova live-migration: 212. nova live-migration: 219 || Legacy || || Done | ||
+ | |- | ||
+ | |Admin Guide || compute-manage-logs.rst || nova get-serial-proxy: 196 || Legacy || || Done | ||
|- | |- | ||
| Admin Guide || compute-node-down.rst || nova reboot: 86. nova flavor-key: 130. nova boot: 137 || Changed || Allen || Done https://review.openstack.org/#/c/399844/ | | Admin Guide || compute-node-down.rst || nova reboot: 86. nova flavor-key: 130. nova boot: 137 || Changed || Allen || Done https://review.openstack.org/#/c/399844/ | ||
Line 45: | Line 90: | ||
|- | |- | ||
| Admin Guide || blockstorage-volume-backups.rst || 16: $ cinder backup-create [--incremental] [--force] VOLUME, 76: $ cinder backup-restore BACKUP_ID, 165: $ cinder backup-reset-state., 171: $ cinder backup-create [--incremental] [--force] \ || 1 legacy command || Allen || https://review.openstack.org/#/c/409447, openstack command for $ cinder backup-reset-state needed | | Admin Guide || blockstorage-volume-backups.rst || 16: $ cinder backup-create [--incremental] [--force] VOLUME, 76: $ cinder backup-restore BACKUP_ID, 165: $ cinder backup-reset-state., 171: $ cinder backup-create [--incremental] [--force] \ || 1 legacy command || Allen || https://review.openstack.org/#/c/409447, openstack command for $ cinder backup-reset-state needed | ||
− | |||
− | |||
|- | |- | ||
| Admin Guide || compute-live-migration-usage.rst || 28: $ openstack server list, 52: $ nova show d1df1b5a-70c4-4fed-98b7-423362f2c47c, 212: $ nova live-migration SERVER HOST_NAME, 219: $ nova live-migration d1df1b5a-70c4-4fed-98b7-423362f2c47c HostC || Changed || Allen || https://review.openstack.org/#/c/409454 | | Admin Guide || compute-live-migration-usage.rst || 28: $ openstack server list, 52: $ nova show d1df1b5a-70c4-4fed-98b7-423362f2c47c, 212: $ nova live-migration SERVER HOST_NAME, 219: $ nova live-migration d1df1b5a-70c4-4fed-98b7-423362f2c47c HostC || Changed || Allen || https://review.openstack.org/#/c/409454 | ||
|- | |- | ||
− | | Admin Guide || support-compute.rst || nova reset-state: 220. nova delete: 221. nova reset-state: 228 || Legacy || || | + | | Admin Guide || support-compute.rst || nova reset-state: 220. nova delete: 221. nova reset-state: 228 || Legacy || Darren || No replacement OSC commands available |
− | |||
− | |||
|- | |- | ||
| Admin Guide || networking-use.rst || nova boot: 189, 243, 252, 261. || Changed || visnyei || Done https://review.openstack.org/#/c/399487/ | | Admin Guide || networking-use.rst || nova boot: 189, 243, 252, 261. || Changed || visnyei || Done https://review.openstack.org/#/c/399487/ | ||
Line 62: | Line 103: | ||
| Admin Guide || networking-config-agents.rst || subnet commands || Changed || ankur-gupta-f || https://review.openstack.org/#/c/407598/ | | Admin Guide || networking-config-agents.rst || subnet commands || Changed || ankur-gupta-f || https://review.openstack.org/#/c/407598/ | ||
|- | |- | ||
− | |Admin Guide || blockstorage-get-capabilities.rst || | + | |Admin Guide || blockstorage-get-capabilities.rst || 36: $ cinder service-list, 50: $ cinder get-capabilities block1@ABC-driver, 90: $ cinder service-list, 103: $ cinder service-disable HOST_NAME BINARY_NAME, 109: $ cinder-manage service remove BINARY_NAME HOST_NAME, 251: $ cinder type-access-add --volume-type vol_Type2 --project-id \, 258, 271: $ cinder type-access-list --volume-type vol_Type2, 269: $ cinder type-access-remove --volume-type vol_Type2 --project-id \ || Legacy and OpenStack || Allen || In Progress https://review.openstack.org/#/c/413587 |
|- | |- | ||
|Admin Guide || blockstorage-volume-migration.rst || openstack volume show || Changed || || | |Admin Guide || blockstorage-volume-migration.rst || openstack volume show || Changed || || | ||
Line 68: | Line 109: | ||
|Admin Guide || cli-admin-manage-stacks.rst || openstack stack resume, openstack suspend, openstack delete || Changed || || | |Admin Guide || cli-admin-manage-stacks.rst || openstack stack resume, openstack suspend, openstack delete || Changed || || | ||
|- | |- | ||
− | |Admin Guide || cli-admin-manage-ip-addresses.rst || nova floating-ip-bulk-list: 35. nova floating-ip-create: 68 74. nova floating-ip-delete: 101 107. || | + | |Admin Guide || cli-admin-manage-ip-addresses.rst || nova floating-ip-bulk-list: 35. nova floating-ip-create: 68 74. nova floating-ip-delete: 101 107. || Changed || Darren || Done https://review.openstack.org/#/c/412294/ |
|- | |- | ||
− | |Admin Guide || cli-manage-flavors.rst || nova flavor-access-add: 139. nova help flavor-key: 156. || Legacy || || | + | |Admin Guide || cli-manage-flavors.rst || nova flavor-access-add: 139. nova help flavor-key: 156. || Legacy || Darren || No replacement OSC commands available |
|- | |- | ||
− | |Admin Guide || cli-nova-evacuate.rst || nova host-list: 19. nova evacuate: 29 50. || Legacy || || | + | |Admin Guide || cli-nova-evacuate.rst || nova host-list: 19. nova evacuate: 29 50. || Legacy || Darren || In progress | No replacement OSC command for nova evacuate https://review.openstack.org/#/c/412685/ |
|- | |- | ||
− | |Admin Guide || cli-nova-manage-services.rst || nova service-list: 13, 40, 67. nova service-disable: 29. nova service-enable: 56. || Legacy || || | + | |Admin Guide || cli-nova-manage-services.rst || nova service-list: 13, 40, 67. nova service-disable: 29. nova service-enable: 56. || Legacy || Darren || In progress https://review.openstack.org/#/c/412685/ |
|- | |- | ||
|Admin Guide || cli-nova-migrate.rst || nova list: 18. nova show: 25. nova migrate: 31. || Changed || Allen || In Progress https://review.openstack.org/#/c/406917 | |Admin Guide || cli-nova-migrate.rst || nova list: 18. nova show: 25. nova migrate: 31. || Changed || Allen || In Progress https://review.openstack.org/#/c/406917 | ||
|- | |- | ||
− | |Admin Guide || cli-set-compute-quotas.rst || nova quota-defaults: 58 64. nova quota-class-update: 88 94. nova quota-show: 109 115. nova quota-update: 148 154. nova-quota-show: 155, 206, 212, 258. nova quota-update: 251 257. nova absolute limits: 295. || Legacy || || | + | |Admin Guide || cli-set-compute-quotas.rst || nova quota-defaults: 58 64. nova quota-class-update: 88 94. nova quota-show: 109 115. nova quota-update: 148 154. nova-quota-show: 155, 206, 212, 258. nova quota-update: 251 257. nova absolute limits: 295. || Legacy || Darren || In progress https://review.openstack.org/#/c/412685/; No OSC commands to replace nova quota-update, nova quota-show for quota values for a project user, nova absolute limits |
|- | |- | ||
|Admin Guide || cli-keystone-manage-services.rst || openstack service list, openstack service create, openstack | |Admin Guide || cli-keystone-manage-services.rst || openstack service list, openstack service create, openstack | ||
Line 94: | Line 135: | ||
|- | |- | ||
|Admin Guide || cli-set-quotas.rst || openstack project list, user list --project || Changed | |Admin Guide || cli-set-quotas.rst || openstack project list, user list --project || Changed | ||
+ | |- | ||
+ | |Admin Guide || cli-cinder-quotas.rst || cinder quota-show, cinder quota-delete, cinder quota-update || Legacy || Joe Robinson || https://review.openstack.org/#/c/427030/ | ||
|- | |- | ||
|Admin Guide || compute-arch.rst || openstack image list, flavor list || Changed | |Admin Guide || compute-arch.rst || openstack image list, flavor list || Changed | ||
Line 112: | Line 155: | ||
|- | |- | ||
|Admin Guide||telemetry-measurements.rst||56: $ nova boot --meta || OpenStack Commands || Chen || In Progress https://review.openstack.org/#/c/405931 | |Admin Guide||telemetry-measurements.rst||56: $ nova boot --meta || OpenStack Commands || Chen || In Progress https://review.openstack.org/#/c/405931 | ||
+ | |- | ||
+ | |Admin Guide||telemetry-alarms.rst||132: $ ceilometer alarm-threshold-create --name cpu_hi \ 214: $ ceilometer alarm-combination-create --name meta \ 233: $ ceilometer alarm-list 273: $ ceilometer alarm-update --threshold 75 ALARM_ID 283: $ ceilometer alarm-state-get ALARM_ID 284: $ ceilometer alarm-state-set --state ok -a ALARM_ID 293: $ ceilometer alarm history ALARM_ID 313: $ ceilometer alarm-update --enabled False -a ALARM_ID 319: $ ceilometer alarm-delete ALARM_ID || Legacy commands || || No OpenStack equivalent commands yet. | ||
|- | |- | ||
|Admin Guide || identity-concepts.rst || openstack user create, project create acme, openstack --os-identity-api-version=3 domain create emea, openstack role create compute-user || Changed | |Admin Guide || identity-concepts.rst || openstack user create, project create acme, openstack --os-identity-api-version=3 domain create emea, openstack role create compute-user || Changed | ||
Line 117: | Line 162: | ||
|Admin Guide || networking-introduction.rst || neutron port-update line:187, port-create lines:180 || 2 legacy commands || csatari || In progress | |Admin Guide || networking-introduction.rst || neutron port-update line:187, port-create lines:180 || 2 legacy commands || csatari || In progress | ||
|- | |- | ||
− | |Admin Guide || cli-networking-advanced-quotas.rst || | + | |Admin Guide || cli-networking-advanced-quotas.rst || 141: $ neutron ext-show quotas, 170: $ neutron quota-list 236: $ neutron quota-update --tenant_id 256: $ neutron quota-update --tenant_id 280: $ neutron quota-update --tenant_id 301: $ neutron quota-update --tenant_id 324: $ neutron quota-delete --tenant_id || legacy commands || || Replace neutron ext-list line; no replacement OSC commands available for the others. In Progress https://review.openstack.org/#/c/416243/ and https://review.openstack.org/#/c/427030/ - changed quota show <project id> commands. |
|- | |- | ||
− | |Admin Guide || networking-adv-config.rst || neutron-metering-agent line:19 || 1 legacy command | + | |Admin Guide || networking-adv-config.rst || neutron-metering-agent line:19 || 1 legacy command || || No replacement OSC command available |
|- | |- | ||
− | |Admin Guide || networking-adv-features.rst || Many neutron commmands between lines 214-894 || May need discussion with the neutron team. || | + | |Admin Guide || networking-adv-features.rst || Many neutron commmands between lines 214-894 || May need discussion with the neutron team. || visny |
|- | |- | ||
− | |Admin Guide || networking-config-agents.rst || neutron subnet create line 98, 103, neutron agent-list, agent-show, agent-update, agent-delete lines: 477 482 491 497 || 5 legacy commands | + | |Admin Guide || networking-config-agents.rst || neutron subnet create line 98, 103, neutron agent-list, agent-show, agent-update, agent-delete lines: 477 482 491 497 || 5 legacy commands || Darren || In progress https://review.openstack.org/#/c/412685/; No OSC command to replace neutron agent-update |
|- | |- | ||
− | |Admin Guide || networking-config-identity.rst || openstack endpoint create, openstack role add || Changed | + | |Admin Guide || networking-config-identity.rst || openstack endpoint create, openstack role add || Changed || Just $ quota show <project id> commands https://review.openstack.org/#/c/427030/ |
|- | |- | ||
|Admin Guide || networking-use.rst || openstack project list > neutron net-create line:51, neutron security-group-rule-create lines:305,310 , neutron net-create line:128, neutron subnet-create lines:134 40 151 161, netron port-list lines:168 200 206, neutron port-update line:212, neutron net-list line:187 || 6 legacy commands || visnyei || Done: https://review.openstack.org/#/c/399487/ | |Admin Guide || networking-use.rst || openstack project list > neutron net-create line:51, neutron security-group-rule-create lines:305,310 , neutron net-create line:128, neutron subnet-create lines:134 40 151 161, netron port-list lines:168 200 206, neutron port-update line:212, neutron net-list line:187 || 6 legacy commands || visnyei || Done: https://review.openstack.org/#/c/399487/ | ||
Line 131: | Line 176: | ||
|Admin Guide || orchestration-stack-domain-users.rst || openstack --os-token $OS_TOKEN --os-url=$KS_ENDPOINT_V3 --os-\ || Changed | |Admin Guide || orchestration-stack-domain-users.rst || openstack --os-token $OS_TOKEN --os-url=$KS_ENDPOINT_V3 --os-\ || Changed | ||
|- | |- | ||
− | |Admin Guide || baremetal.rst || openstack flavor show > ironic node-set-maintenance <IRONIC-NODE-UUID> off line:153 ironic node-show <IRONIC-NODE-UUID> line:130 || 2 legacy commands | + | |Admin Guide || baremetal.rst || openstack flavor show > ironic node-set-maintenance <IRONIC-NODE-UUID> off line:153 ironic node-show <IRONIC-NODE-UUID> line:130 || 2 legacy commands || || no replacement OSC commands available |
+ | |- | ||
+ | |Admin Guide || baremetal-multitenancy.rst || ironic node-create -n $NAME --network-interface neutron --driver agent_ipmitool, ironic --ironic-api-version latest port-create -a $HW_MAC_ADDRESS \ || 2 legacy commands || || no replacement OSC commands available | ||
+ | |- | ||
+ | |Admin Guide || shared-file-systems-share-networks.rst || 63: $ manila share-network-create 91: $ manila share-network-list || legacy commands ||name|| In Progress https://review.openstack.org/#/c/416243 | ||
+ | |- | ||
+ | | || || || || || | ||
+ | |- | ||
+ | | || || || || || | ||
|- | |- | ||
− | | | + | | || || || || || |
|- | |- | ||
|} | |} |
Latest revision as of 10:32, 4 May 2017
Contents
Pike Tasks
- Moving the Administration Guide content to project repositories, to be directly managed by the project team.
- A table for tracking the Admin Guide migration is available on the OpenStack wiki.
Initial steps
- Wiki page for tracking the transition - In Progress - Joe Robinson
- Setup the cookie cutter for the Administration Guide
- Complete select cleaning up and updates to the Admin Guide content
- Encourage the project teams to move existing content to project team repositories
- Update the Documentation Contributor Guide to include the required steps to setup a project Administrator Guide
Intermediate Steps
- Update the Master Index File to reflect the new structure
- Write a base Administrator Guide
- Setup gate jobs to to publish the administrator guide when the Index File patch merges
- Notify project teams when this method publishing the project specific Administrator Guide
Ocata Tasks
- Swap legacy commands for OpenStack client commands in the User Guide and Administrator Guide.
Legacy to OpenStack command conversion table
User Guide Legacy Command Table
Guide Name | File Name | Commands | Change details | Name | Patch & status |
---|---|---|---|---|---|
User Guide | backup-db-incremental.rst | 46: $ trove backup-create $ trove backup-create 108: $ trove create guest2 10 --size 1 --backup BACKUP_ID | legacy | name | |
User Guide | backup-db.rst | 33: $ trove list 54: $ trove backup-create INSTANCE_ID backup1 79: $ trove backup-list :92: $ trove backup-show BACKUP_ID :126: $ trove create guest2 10 --size 2 --backup BACKUP_ID :151: $ trove list :166: $ trove show INSTANCE_ID :192: $ trove database-list INSTANCE_ID :208: $ trove user-list INSTANCE_ID :231: $ trove delete INSTANCE_ID | legacy | name | |
User Guide | cli-ceilometer.rst | :91: $ ceilometer alarm-list, :103: $ ceilometer meter-list, :116: $ ceilometer sample-list -m cpu_util :127: $ ceilometer statistics -m cpu_util | |||
User Guide | cli-nova-configure-access-security-for-instances.rst | nova secgroup-list-rules SECURITY_GROUP_NAME | Changed | Allen, David Rabel | Done https://review.openstack.org/#/c/389980, and https://review.openstack.org/#/c/399691 |
User Guide | cli-cheat-sheet.rst | 262: $ nova secgroup-add-group-rule default default icmp -1 -1, 263: $ nova secgroup-add-group-rule default default tcp 22 22 | Legacy and OpenStack commands | David Rabel, 142: $ nova meta volumeTwoImage set newmeta='my meta data' | Done https://review.openstack.org/#/c/399691 |
User Guide | cli-cheat-sheet.rst part 2. | :154: $ nova meta volumeTwoImage set newmeta='my meta data' 372: $ swift stat, 373: $ swift stat ACCOUNT, 374: $ swift stat CONTAINER, 375: $ swift stat OBJECT, 381: $ swift list | Legacy | Joe Robinson | Done https://review.openstack.org/400603, and https://review.openstack.org/405982 . 08/12 - Swift team confirms Swift commands do not have equivalent OpenStack commands yet. |
User Guide | cli-nova-launch-instance-from-volume.rst | 326 $ nova boot --flavor FLAVOR --image IMAGE_ID --swap 512 \ --ephemeral size=2 NAME | Legacy | Joe Robinson, Caoyuan | Done https://review.openstack.org/400603 and https://review.openstack.org/#/c/446341 |
User Guide | cli-nova-launch-instance-using-ISO-image.rst | 95: $ cinder list, 110: $ cinder upload-to-image VOLUME_UUID IMAGE_NAME, 111: glance image-list | Legacy | Joe Robinson | Done https://review.openstack.org/400603 |
User Guide | cli-manage-ip-addresses.rst | 36, 54: $ nova floating-ip-pool-list, 79, 94: $ nova floating-ip-create, 113, 119, 145: $ nova floating-ip-associate, 155: $ nova floating-ip-disassociate, 161: $ nova floating-ip-delete | Legacy commands, OpenStack commands | Allen | In Progress https://review.openstack.org/#/c/404818 |
User Guide | cli-nova-configure-access-security-for-instances.rst | OpenStack client | Changed | ||
User Guide | cli-change-the-size-of-your-server.rst | 70: $ nova resize myCirrosServer 4 --poll | Legacy | ||
User Guide | cli-manage-bare-metal-nodes.rst | 54, 63: $ nova baremetal-node-create, 90: $ nova baremetal-interface-add, 110, 128: $ nova boot --image my-baremetal-image --flavor, 157: $ nova baremetal-node-show, 142: $ nova baremetal-node-list | Legacy | ||
User Guides | cli-use-snapshots-to-migrate-instances.rst | OpenStack | caoyuan, yanghuichan | https://review.openstack.org/#/c/408679/ - merged. https://review.openstack.org/#/c/446853/ | |
User Guides | create-db.rst | 123: $ trove create mysql_instance_1 6 --size 5 --databases myDB, 147: $ trove list, 162: $ trove show INSTANCE_ID | Legacy commands | Zhang Yan Xian | In Progress https://review.openstack.org/#/c/412713/ |
User Guides | cli-create-and-manage-networks.rst | 15: $ neutron ext-list -c alias -c name, 87: $ neutron subnet-create net1 192.168.2.0/24 --name subnet1, 134: $ neutron router-create router1, 154: $ neutron router-gateway-set ROUTER NETWORK, 163: $ neutron router-interface-add ROUTER SUBNET, 175: $ neutron port-create net1 --fixed-ip ip_address=192.168.2.40, 208: $ neutron port-create net1, 242: $ neutron port-list --fixed-ips ip_address=192.168.2.2 \, :306: $ neutron port-list --fixed-ips ip_address=192.168.2.2 \ | Legacy and OpenStack | Zhang Yan Xian | In Progress https://review.openstack.org/#/c/413483 |
User Guides | cli-manage-shares | 17: $ manila share-network-create \ :44: $ manila share-network-list:58: $ manila create NFS 1 \ :96: 337: 447: 492: 546: 591 $ manila show myshare : 141: 325: 391 $ manila list :152: $ manila share-export-location-list myshare : 167: 199 $ manila access-allow myshare ip 10.0.0.0/24 : 183: 215: 239 $ manila access-list myshare : 232: 233 $ manila access-deny myshare 0 :254: $ manila snapshot-create --name mysnapshot --description "My Manila snapshot" myshare :274:408:425 $ manila snapshot-list :288: $ manila create NFS 1 \ :385: $ manila delete mysharefromsnap :419: $ manila snapshot-delete mysnapshot :441: $ manila extend myshare 2 :540: $ manila shrink myshare 1 | legacy | name | |
User Guides | cli-reboot-an-instance.rst | 75: $ nova rescue --rescue_image_ref IMAGE_ID SERVEl | legacy | name | |
User Guides | set-up-clustering.rst | :55: $ trove cluster-create cluster1 mongodb "2.4" \ :82: $ trove cluster-show CLUSTER_ID, :112: $ trove cluster-instances CLUSTER_ID, :146: $ trove cluster-list, :160: $ trove cluster-delete CLUSTER_ID | legacy | name | |
User Guides | set-up-replication.rst | 46: $ trove create replica_1 6 --size=5 --datastore_version mysql-5.5 \, :58: $ trove show INSTANCE_ID_OF_REPLICA_1, :81: $ trove show INSTANCE_ID_OF_BASE_1, :109: $ trove detach-replica INSTANCE_ID_OF_REPLICA | legacy | name | |
User Guides | manage-db-config.rst | :30: $ trove datastore-version-list mysql :44: $ trove configuration-parameter-list DATASTORE_VERSION_ID :99: $ trove configuration-create NAME VALUES --datastore DATASTORE_NAME :119: $ trove configuration-create group1 '{"sync_binlog" : 1}' --datastore mysql :140: $ mysql -u user7 -ppassword -h 172.16.200.2 myDB :164: $ trove list, :176: $ trove configuration-list, :194: $ trove configuration-attach DB_INSTANCE_ID CONFIG_GROUP_ID | legacy | name | |
User Guides | The Swift Files | cli-swift-create-containers.rst, cli-swift-manage-access-swift.rst, cli-swift-manage-objects.rst, cli-swift-pseudo-hierarchical-folders-directories.rst, cli-swift-serialized-response-formats.rst, cli-swift-set-object-versions.rst, cli-swift-static-website.rst | Legacy | Name | Currently, the swift team is unable to work on creating openstack client commands for the swift service. |
Admin Guide Legacy Command Table
Guide Name | File Name | Commands | Change details | Name | Patch & status |
---|---|---|---|---|---|
Admin Guide | compute-configuring-migrations.rst | nova quota-defaults: 58 64. nova quota-class-update: 88 94. nova quota-show: 109 115. nova quota-update: 148 154. nova-quota-show: 155, 206, 212, 258. nova quota-update: 251 257. nova absolute limits: 295 | Changed | darrenc | Done https://review.openstack.org/#/c/412294/ |
Admin Guide | compute-live-migration-usage.rst | nova list: 28. nova show: 52. nova live-migration: 212. nova live-migration: 219 | Legacy | Done | |
Admin Guide | compute-manage-logs.rst | nova get-serial-proxy: 196 | Legacy | Done | |
Admin Guide | compute-node-down.rst | nova reboot: 86. nova flavor-key: 130. nova boot: 137 | Changed | Allen | Done https://review.openstack.org/#/c/399844/ |
Admin Guide | blockstorage-volume-number-weigher.rst | 52: $ cinder type-create lvm, 58: $ cinder type-key lvm set, 71: $ cinder create --volume-type lvm 1 | Changed | Allen | Done https://review.openstack.org/#/c/409439 |
Admin Guide | blockstorage-volume-backups.rst | 16: $ cinder backup-create [--incremental] [--force] VOLUME, 76: $ cinder backup-restore BACKUP_ID, 165: $ cinder backup-reset-state., 171: $ cinder backup-create [--incremental] [--force] \ | 1 legacy command | Allen | https://review.openstack.org/#/c/409447, openstack command for $ cinder backup-reset-state needed |
Admin Guide | compute-live-migration-usage.rst | 28: $ openstack server list, 52: $ nova show d1df1b5a-70c4-4fed-98b7-423362f2c47c, 212: $ nova live-migration SERVER HOST_NAME, 219: $ nova live-migration d1df1b5a-70c4-4fed-98b7-423362f2c47c HostC | Changed | Allen | https://review.openstack.org/#/c/409454 |
Admin Guide | support-compute.rst | nova reset-state: 220. nova delete: 221. nova reset-state: 228 | Legacy | Darren | No replacement OSC commands available |
Admin Guide | networking-use.rst | nova boot: 189, 243, 252, 261. | Changed | visnyei | Done https://review.openstack.org/#/c/399487/ |
Admin Guide | networking-adv-features.rst | router and network commands | Changed | ankur-gupta-f | https://review.openstack.org/#/c/407239/ |
Admin Guide | networking-introduction.rst | port set commands | Changed | ankur-gupta-f | https://review.openstack.org/#/c/407582/ |
Admin Guide | networking-config-agents.rst | subnet commands | Changed | ankur-gupta-f | https://review.openstack.org/#/c/407598/ |
Admin Guide | blockstorage-get-capabilities.rst | 36: $ cinder service-list, 50: $ cinder get-capabilities block1@ABC-driver, 90: $ cinder service-list, 103: $ cinder service-disable HOST_NAME BINARY_NAME, 109: $ cinder-manage service remove BINARY_NAME HOST_NAME, 251: $ cinder type-access-add --volume-type vol_Type2 --project-id \, 258, 271: $ cinder type-access-list --volume-type vol_Type2, 269: $ cinder type-access-remove --volume-type vol_Type2 --project-id \ | Legacy and OpenStack | Allen | In Progress https://review.openstack.org/#/c/413587 |
Admin Guide | blockstorage-volume-migration.rst | openstack volume show | Changed | ||
Admin Guide | cli-admin-manage-stacks.rst | openstack stack resume, openstack suspend, openstack delete | Changed | ||
Admin Guide | cli-admin-manage-ip-addresses.rst | nova floating-ip-bulk-list: 35. nova floating-ip-create: 68 74. nova floating-ip-delete: 101 107. | Changed | Darren | Done https://review.openstack.org/#/c/412294/ |
Admin Guide | cli-manage-flavors.rst | nova flavor-access-add: 139. nova help flavor-key: 156. | Legacy | Darren | No replacement OSC commands available |
Admin Guide | cli-nova-evacuate.rst | nova host-list: 19. nova evacuate: 29 50. | Legacy | Darren | No replacement OSC command for nova evacuate https://review.openstack.org/#/c/412685/ |
Admin Guide | cli-nova-manage-services.rst | nova service-list: 13, 40, 67. nova service-disable: 29. nova service-enable: 56. | Legacy | Darren | In progress https://review.openstack.org/#/c/412685/ |
Admin Guide | cli-nova-migrate.rst | nova list: 18. nova show: 25. nova migrate: 31. | Changed | Allen | In Progress https://review.openstack.org/#/c/406917 |
Admin Guide | cli-set-compute-quotas.rst | nova quota-defaults: 58 64. nova quota-class-update: 88 94. nova quota-show: 109 115. nova quota-update: 148 154. nova-quota-show: 155, 206, 212, 258. nova quota-update: 251 257. nova absolute limits: 295. | Legacy | Darren | In progress https://review.openstack.org/#/c/412685/; No OSC commands to replace nova quota-update, nova quota-show for quota values for a project user, nova absolute limits |
Admin Guide | cli-keystone-manage-services.rst | openstack service list, openstack service create, openstack
service show, openstack project create service, openstack role add || Changed | |||
Admin Guide | cli-manage-flavors.rst | openstack flavor list, openstack flavor create, openstack help flavor create, openstack flavor delete | Changed | ||
Admin Guide | cli-manage-projects-users-and-roles.rst | openstack project list, project create, project set,
project show, project delete, openstack role list, user list, project list, role add, role list, role show, role remove || Changed | |||
Admin Guide | cli-nova-manage-projects-security.rst | openstack security group list, security group rule list, security group list open, security group list global_http | Changed | David Rabel | https://review.openstack.org/#/c/399691 |
Admin guide | cli-nova-specify-host.rst | openstack server create, availability zone list, host list,
hypervisor list || Changed | |||
Admin Guide | cli-set-quotas.rst | openstack project list, user list --project | Changed | ||
Admin Guide | cli-cinder-quotas.rst | cinder quota-show, cinder quota-delete, cinder quota-update | Legacy | Joe Robinson | https://review.openstack.org/#/c/427030/ |
Admin Guide | compute-arch.rst | openstack image list, flavor list | Changed | ||
Admin Guide | compute-cpu-topologies.rst | openstack flavor set, image set | Changed | ||
Admin Guide | compute-flavors.rst | openstack flavor --help | Changed | ||
Admin Guide | compute-images-instances.rs | openstack image list, flavor list | Changed | ||
Admin Guide | compute-manage-the-cloud.rst | openstack help | Changed | ||
Admin Guide | compute-manage-volumes.rst | openstack volume list | Changed | ||
Admin Guide | compute-networking-nova.rst | 165: nova network-create, 221: nova-manage fixed reserve. nova network-create public: 282, 294, 303. nova network-create first-net: 797. nova network-create second-net: 798. nova list: 805. nova boot: 842.t, 303: $ nova network-create public --fixed-range-v4 10.0.1.0/24 --vlan 100 | Legacy and Openstack | Allen. Chen. | Done https://review.openstack.org/#/c/389980, https://review.openstack.org/#/c/405931, https://review.openstack.org/#/c/409453 some nova network legacy commands. |
Admin Guide | compute-security.rst | 137: $ nova boot --flavor m1.tiny --key-name, 130: $ nova flavor-key m1.tiny set | Legacy and OpenStack commands | Chen | In Progress https://review.openstack.org/#/c/405931 |
Admin Guide | telemetry-measurements.rst | 56: $ nova boot --meta | OpenStack Commands | Chen | In Progress https://review.openstack.org/#/c/405931 |
Admin Guide | telemetry-alarms.rst | 132: $ ceilometer alarm-threshold-create --name cpu_hi \ 214: $ ceilometer alarm-combination-create --name meta \ 233: $ ceilometer alarm-list 273: $ ceilometer alarm-update --threshold 75 ALARM_ID 283: $ ceilometer alarm-state-get ALARM_ID 284: $ ceilometer alarm-state-set --state ok -a ALARM_ID 293: $ ceilometer alarm history ALARM_ID 313: $ ceilometer alarm-update --enabled False -a ALARM_ID 319: $ ceilometer alarm-delete ALARM_ID | Legacy commands | No OpenStack equivalent commands yet. | |
Admin Guide | identity-concepts.rst | openstack user create, project create acme, openstack --os-identity-api-version=3 domain create emea, openstack role create compute-user | Changed | ||
Admin Guide | networking-introduction.rst | neutron port-update line:187, port-create lines:180 | 2 legacy commands | csatari | In progress |
Admin Guide | cli-networking-advanced-quotas.rst | 141: $ neutron ext-show quotas, 170: $ neutron quota-list 236: $ neutron quota-update --tenant_id 256: $ neutron quota-update --tenant_id 280: $ neutron quota-update --tenant_id 301: $ neutron quota-update --tenant_id 324: $ neutron quota-delete --tenant_id | legacy commands | Replace neutron ext-list line; no replacement OSC commands available for the others. In Progress https://review.openstack.org/#/c/416243/ and https://review.openstack.org/#/c/427030/ - changed quota show <project id> commands. | |
Admin Guide | networking-adv-config.rst | neutron-metering-agent line:19 | 1 legacy command | No replacement OSC command available | |
Admin Guide | networking-adv-features.rst | Many neutron commmands between lines 214-894 | May need discussion with the neutron team. | visny | |
Admin Guide | networking-config-agents.rst | neutron subnet create line 98, 103, neutron agent-list, agent-show, agent-update, agent-delete lines: 477 482 491 497 | 5 legacy commands | Darren | In progress https://review.openstack.org/#/c/412685/; No OSC command to replace neutron agent-update |
Admin Guide | networking-config-identity.rst | openstack endpoint create, openstack role add | Changed | Just $ quota show <project id> commands https://review.openstack.org/#/c/427030/ | |
Admin Guide | networking-use.rst | openstack project list > neutron net-create line:51, neutron security-group-rule-create lines:305,310 , neutron net-create line:128, neutron subnet-create lines:134 40 151 161, netron port-list lines:168 200 206, neutron port-update line:212, neutron net-list line:187 | 6 legacy commands | visnyei | Done: https://review.openstack.org/#/c/399487/ |
Admin Guide | orchestration-stack-domain-users.rst | openstack --os-token $OS_TOKEN --os-url=$KS_ENDPOINT_V3 --os-\ | Changed | ||
Admin Guide | baremetal.rst | openstack flavor show > ironic node-set-maintenance <IRONIC-NODE-UUID> off line:153 ironic node-show <IRONIC-NODE-UUID> line:130 | 2 legacy commands | no replacement OSC commands available | |
Admin Guide | baremetal-multitenancy.rst | ironic node-create -n $NAME --network-interface neutron --driver agent_ipmitool, ironic --ironic-api-version latest port-create -a $HW_MAC_ADDRESS \ | 2 legacy commands | no replacement OSC commands available | |
Admin Guide | shared-file-systems-share-networks.rst | 63: $ manila share-network-create 91: $ manila share-network-list | legacy commands | name | In Progress https://review.openstack.org/#/c/416243 |
Newton Tasks
-
Work with the Ops Guide to check for duplicated content - Check for missing content and out of date content - fix links
- Bring new service projects into the User Guides - esp. projects that have info in dev docs that could be moved into the user guide
- IA plan - consistency, links, findability plus tables, code snippets, naming conventions (use contributor guide)
IA Plan
Basic IA - consistency and formatting choices
Tables
- Telemetry - code snippet tables don't fit the page.
- Networking - Use Networking Section - Networking tables are not consistent
- Secure with Rootwrap - Migrate instances - These tables were code snippets - can they be returned to this format?
- Flavours - Tables have bold heading. And sentences associated with these headings - Show Host Usage Statistics: Host usage statistics description, and change to bold headings - Are the tables in the Admin User Guide on setting flavors effective?
- Setting up flavours- are these tables "effective" Do they help user or admin personas set up flavours?
- Rootwrap - Migrate Instances: These tables were code snippets. Can they be replaced with images or appropriate code snippets?
- Nova-Networking - Configure Compute to use IPv6 addresses: Address table consistency across guides.
Links between articles
- Block Storage
- Migrate Volumes commands could appear in the End User Guide. Work to bring these articles together.
- Networking with Nova Network
- The Cloud Admin Guide references floating IP addresses, which users can change. The User Guide section on Networking will need reorganization to line up with this content.
- Building Blocks
- The nova image-list command. Link together the content on the nova command line client with the End User Guide here.
Persona Clear up
- Block Storage
- Back up and Restore volumes: Is this procedure a cloud admin procedure...Can this basic information be adapted to fit the User Guides.
Moving content
- Networking
- Configuring Identity for Networking: A note about not using Nova-network with compute appears here,
- but needs to appear earlier - the introduction - as a warning for cloud administrators.
- Networking Architecture: This section's description of architecture would be better placed following the introduction.
Block Storage
- Block Storage: persistent storage needs to be mentioned earlier and more clearly in this introduction.
- Rate-limit volume copy Bandwidth: Reorganize the guide such that this content appears closer to the information on moving and migrating block storage volumes ("volume_copy_bps_limit").
Secure with Rootwrap
- Frequently Asked Questions: An FAQ in the guide clashes with the other information.
- Information Architecture checkup needed here to rework this information.
New Diagrams
- Security Hardening
- Improve the OpenStack with Trusted Compute Pools Second diagram. a new diagram needs headings, and consistency with the other diagrams.
Up to Date Tasks
- Building Blocks
- Introduction: Clarify what base operating system is referred to here. Check content for accuracy.
- Networking with nova-network
- VLAN Network Manager: Check paragraph indentation.
- Metadata
- Liberty to Mitaka-metadata services now include 'project_id' according to release notes.
- Metadata needs an SME check for currency. (Andrew Bogott, John Garbutt, Matthiew Gagne)
- Description of metadata config options table: Address table consistency across guides.
- Secure with Rootwrap
- Configuration option [Default]: SME to check, and change to better format. Might need a code snippet
- Recover Cloud After disaster: Test or have SME check on this procedure.
- Supported Operations in filter and goodness functions: Remove passive voice in the Caution note.
- Image volume cache: Remove passive voice.
- Networking
- Reference network option plugins for ml2 http://docs.openstack.org/liberty/config-reference/ content/networking-options-plugins-ml2.html. See https://bugs.launchpad.net/openstack-manuals/+bug/1411624
- Database
No recommended changes currently.
- Baremetal
No recommended changes currently.
- Orchestration
No recommended changes currently.
- Telemetry
- Data Retrieval: The code snippet tables need to fit the page.
- Measurements: Confirm that no other measurement items are added from the Liberty release. https://github.com/openstack/ceilometer/commit/43a50f9be884c731afc41a07442e2a8ddee6fc77 - CPU util checks added, and Magnum checks ("magnum sends the following: name: container.bay.memory_util, type: gauge, unit: %, resource_id: bay id, source: notification, description: memory utilisation of swarm bay"
- Orchestration (Joseph Robinson)
- Orchestration Authorization Model: This section requires an edit for grammar.
- Stack domain users: Grammar Edits also required for this section.
- Cross-origin resource sharing: The sub-section "enabling CORS with configuration" needs an edit to change into a procedure rather than a list of items.
- Cross-project features
No recommended changes currently
Task Archive 2.0
File Tracking Table
Cloud Admin Chapter | Admin Guide File | Moved ? (Yes/No) | Content added to a file, or added to a Toctree ? (Toctree/File) |
---|---|---|---|
Dashboard | dashboard.rst | Yes | |
admin-guide-cloud/source/dashboard.rst | dashboard_admin_manage_stacks.rst | Yes | Toctree |
admin-guide-cloud/source/dashboard.rst | dashboard_manage_flavors.rst | Yes | Toctree |
admin-guide-cloud/source/dashboard.rst | dashboard_manage_host_aggregates.rst | Yes | Toctree |
admin-guide-cloud/source/dashboard.rst | dashboard_manage_images.rst | Yes | Toctree |
admin-guide-cloud/source/dashboard.rst | dashboard_manage_instances.rst | Yes | TocTree |
dashboard_manage_resources.rst | Yes | TocTree | |
dashboard_manage_services.rst | Yes | TocTree | |
admin-guide-cloud/source/dashboard.rst | shared_file_systems_manage_shares_dashboard.rst (previously: dashboard_manage_shares.rst) | Yes | TocTree |
dashboard_manage_volumes.rst | Yes | TocTree | |
dashboard_set_quotas.rst | Yes | TocTree | |
dashboard_view_cloud_resources.rst | Yes | TocTree | |
dashboard_admin_manage_roles.rst | Yes | TocTree | |
doc/admin-guide-cloud/source/shared_file_systems_manage_shares_cli.rst | shared_file_systems_manage_shares_cli.rst (previously cli_manage_shares.rst) | Yes | Toctree |
doc/admin-guide-cloud/source/cli.rst | |||
cli_manage_projects_users_and_roles.rst | Yes | Toctree | |
cli_admin_manage_environment.rst | Yes | Toctree | |
cli_admin_manage_ip_addresses.rst | Yes | Toctree | |
cli_admin_manage_stacks.rst | Yes | Toctree | |
cli_cinder_quotas.rst | Yes | Toctree | |
cli_cinder_scheduling.rst | Yes | Toctree | |
cli_keystone_manage_services.rst | Yes | Toctree | |
cli_manage_flavors.rst | Yes | Toctree | |
cli_manage_services.rst | Yes | Toctree | |
cli_manage_shares.rst | Yes | Toctree | |
cli_nova_evacuate.rst | Yes | Toctree | |
cli_nova_manage_services.rst | Yes | Toctree | |
cli_nova_migrate.rst | Yes | Toctree | |
cli_nova_numa_libvirt.rst | Yes | Toctree | |
cli_nova_specify_host.rst | Yes | Toctree | |
cli_set_compute_quotas.rst | Yes | Toctree | |
cli_set_quotas.rst | Yes | Toctree | |
analyzing-log-files-with-swift-cli.rst renamed to cli_analyzing-log-files-with-swift.rst | Yes | Toctree | |
networking_advanced_quotas.rst renamed to cli_networking_advanced_quotas.rst | Yes | Toctree | |
nova_cli_manage_projects_security.rst renamed to cli_nova_manage_projects_security.rst | Yes | Toctree | |
cli_overview.rst | Yes | Admin User Guide > cli.rst toctree | |
cli_install_openstack_command_line_client.rst | Yes | Admin User Guide > cli.rst toctree | |
cli_discover_version_number_for_a_client.rst | Yes | Admin User Guide > cli.rst toctree | |
cli_set_environmental_variables_using_openstack_rc.rst | Yes | Admin User Guide > cli.rst toctree | |
cli_manage_images.rst | Yes | Admin User Guide > cli.rst toctree | |
cli_manage_volumes.rst | Yes | Admin User Guide > cli.rst toctree |
Link checks and changes
After conversion to .rst format, links to the Cloud Admin Guide (please check also End User Guide, Admin User Guide, and Security Guide links - a "/content" in the URL is always wrong for these) from across the docs and projects have changed. These all need to be updated. Below is a list tracking the OpenStack doc project, and the reviews that target the links within each doc project:
Document/section | Name | Patch URL | Status |
---|---|---|---|
openstack / install guide | Brian Moss | https://review.openstack.org/#/c/217524/ | Merged |
openstack / glance | Andreas Jaeger | https://review.openstack.org/#/c/216003/ | Merged |
openstack / user-guide | Tamara Johnston | https://review.openstack.org/#/c/216909 | Merged |
openstack / user-guide-admin | Brian Moss | https://review.openstack.org/#/c/224415/ | Merged |
openstack / networking-guide | Brian Moss | https://review.openstack.org/#/c/224416/ | Merged |
stackforge / fuel-docs | Brian Moss | https://review.openstack.org/#/c/219069/ | Merged |
openstack / cinder-specs | Christian Berendt | https://review.openstack.org/216116 | On review |
openstack / nova-specs | Christian Berendt | https://review.openstack.org/#/c/216122/ | Merged |
openstack / training -guides | Brian Moss | Waiting for creation of new repos | On hold |
openstack / ironic-specs | Brian Moss | https://review.openstack.org/#/c/224940/ | Merged |
openstack / ceilometer | Brian Moss | https://review.openstack.org/#/c/224942/ | Merged |
openstack / api-site | Emett Speer | https://review.openstack.org/219944 | Merged |
openstack / ceilometer-specs | Brian Moss | https://review.openstack.org/#/c/224432/ | Merged |
openstack / heat | Brian Moss | https://review.openstack.org/#/c/219071/ | Merged |
openstack / governance | - | - | Open |
stackforge / cookbook-openstack-network | - | - | Open |
openstack / designate-specs | - | - | Open |
openstack / docs-specs | Emett Speer | https://review.openstack.org/#/c/219936/ | Merged |
stackforge / kolla | - | - | Open |
stackforge / networking-midonet | - | - | Open |
stackforge / driverlog | - | - | Open |
stackforge / kolla | - | - | Open |
openstack / neutron-specs | Emett Speer | https://review.openstack.org/219942 | Merged |
openstack / tripleo-image-elements | Emett Speer | https://review.openstack.org/219945 | Merged |
openstack-attic / object-api | - | - | not needed (attic is read-only) |
stackforge / fuel-plugin-lma-collector | Brian Moss | https://review.openstack.org/#/c/219525/ | Merged |
openstack / openstackdocstheme | Andreas Jaeger | https://review.openstack.org/216121 | Merged |
stackforge / fuel-plugin-neutron-fwaas | Brian Moss | https://review.openstack.org/#/c/219527/ | On review |
stackforge / os-ansible-deployment | Brian Moss | https://review.openstack.org/#/c/219085/ | Merged |
stackforge / fuel-specs | - | - | Open |
openstack / swift | Emett Speer | https://review.openstack.org/219933 | Merged |
stackforge / compass-adapters | - | - | Open |
openstack / ha-guide | Andreas Jaeger | https://review.openstack.org/215998 | Merged |
openstack / operations-guide | Andreas Jaeger | https://review.openstack.org/215996 | Merged |
openstack / api-site | Andreas Jaeger | https://review.openstack.org/216001 | Merged |
openstack / cinder | Andreas Jaeger | https://review.openstack.org/#/c/216006/ | Merged |
openstack / security-doc | Andreas Jaeger | https://review.openstack.org/216004 | Merged |
openstack / admin-guide-cloud | Andreas Jaeger | https://review.openstack.org/#/c/216033/ | Merged |
openstack / neutron | Christian Berendt | https://review.openstack.org/#/c/216125/ | Merged |
Use hound.openstack.org to search for strings in all repos.
User Task Matrix
Task | Operators | System Administrator | End Users |
---|---|---|---|
Planning Installations | 7 | 7 | 1 |
Networking Setup | 10 | 10 | 1 |
Creating Projects | 10 | 10 | 0 |
Creating Instances | 10 | 10 | 2 |
Cloud Admin Guide RST Conversion
- One of the OpenStack Docs selected for Conversion after the Vancouver 2015 design summit is the Cloud Admin Guide. Converting the guide to RST is now a task and a priority of the User Guide Speciality team.
- When conversion is complete, we can reorganize the content of the Cloud Admin Guide, Admin User Guide, and End User Guide.
Additional Information
Task Archive 1.0
- Identity Management (Joseph Robinson DONE)
- Start the identity Service: Move this content into another section to reduce the number of files in the repository.
- External authentication with Identity: Another smaller section in the identity service that can merge.
- Dashboard
- Merge Dashboard content from the Admin User Guide to the Dashboard chapter to create a new Dashboard section. Two halves: Part 1 (Joseph Robinson DONE) & part 2 (Gudrun Wolfgram DONE)
- Check Liberty Dashboard updates and changes. (DONE - Kato Tomoyuki)
- Command Line
- Create a cli-index.rst file in the Cloud Admin Guide, and transfer the admin user guide items into the new location. (G. Wolfgram). Two halves. Part 1 & Part 2.
- Compute (Alexandra Settle)
- AMPQ: introductory colons to introduce a list. Capitalize abbreviations in brackets - change (ampq) to (AMPQ).
- Hypervisors: Include a section on how-to use a hypervisor.
- Tenants, users, roles: remove passive voice. Link to the "How Can I Use The Cloud?" section of the End User Guide - Create and manage roles - reorganize this **content to align with the Cloud Admin Guide content.
- EC2 compatibility (Gudrun Wolfgram)
- Remove passive voice.
- Compare this section with the liberty installation guide.
- Object Storage (DONE - Alexandra Settle - https://review.openstack.org/#/c/295622/)
- User Guide: The Create and manage object containers section needs content from the introduction to the Object Storage section of the Cloud Admin. "...Object Storage (code-named swift is open source software for creating redundant, scalable data storage using clusters..."
- Object Storage Characteristics - Does not mention containers, but the User Guide mentions this term. Edit for Consistency.
- Components: Edit passive voice usage, and adjust the opening sentence introducing the components.
- Rings: Underneath the Ring diagram, edit these sentences for a comma splice.
- Zones: Mentions the high availability plus other components already mentioned in the Components section. So, Components description is not needed. Edit for repetition.
- Partitions: Edit for punctuation - Comma Splice
- Change the Cluster Architecture and Ring Builder Sections within the Block storage chapter.
- Account Reaper: "In the background, the account reaper removes data from deleted accounts..." Edit the syntax here.
- Object Storage Monitoring - Excerpt from a blog. Keep or remove? This section also needs a syntax review.
- Shared File System (Joseph Robinson DONE)
- Share basic operations: " General concepts " edit or clarify this phrase.
- Manage and unmanage share: Edit missing words in some sentences
- Resize a share: Also missing words here.
- Quotas and Limits: Edit verb subject agreement.
- Consistency group: Edit verb subject agreements ("admin to admins").
- Scheduling: Edit for article and definite articles.
- Networking - Edit for missing words.
- Share networks - Edit verb subject agreements
- Images and Instances (Joseph Robinson DONE)
- Align the introduction with the End User Guide.
- "This diagram shows the system state prior to launching an instance" Describe the parts of the diagram. The paragraph is not clear. Extend the modifications to the other diagrams.
- Multipath call failed exit: This Troubleshooting section recruits a Problem and Solution heading architecture useful for the other Troubleshooting sections of the Cloud Admin Guide. (Joseph Robinson)
Past, Completed Tasks:
- Remove duplication in table of contents
- Several items repeat in the table of contents. Repairs to the RST files are needed. (DONE)
- Separate User Guides in separate directories while keeping a common directory to simplify setup and writing: (DONE)
- Develop the User Task Matrix
- Rework the abstract for each guide to clearly identify audience and purpose.
- Include new overview/descriptive information in the guide where such information is missing or needs updating.
- Convert Cloud Administration Guide to RST (DONE)
- Move Hot Guide from End User Guide to Heat repo (DONE)
- Reduce duplication of content between the guides, pointing the Cloud Admin Guide to the Admin User Guide, and Admin User Guide to the End User Guide for readers to accomplish further tasks, which is a suitable step for the abstract rewrite
- Remove any unnecessary or self-explanatory procedures from the dashboard chapter
- Determine a good structure for how to present tasks - Dashboard, Command-line, or Config File edits
- Update the images (.jpg etc) of the dashboard for the Admin and Projects tabs (DONE)
- Bring consistency to certain procedures within the guide. Some have tables, while some have variable lists: (WORKING ON) Joseph Robinson
- Create Network (normal variable list)
- Launch Instance (variable list in bold)
- Manage stacks and Access & Security (tables)
- Manage objects (bullets)
- Spacing between steps in procedures are inconsistent. Example: "Procedure To Copy an Object From One Container to Another" and
"Procedure: To Create a Metadata-only object without a file" in the "Manage and Object" section of the User Guide. (WORKING ON) Darren Chan
Meeting Archive
Action Items
- Thursday 15/10/15
- Complete the Spec before Mitaka Summit - Joe - DONE
- Thursday 01/10/15
- Drafting Specification for M release
- Completing minor items for L release
- Thursday 09/03/15
- Joe to make a new blueprint for a clean start at logging the work items now conversion is over - Joe - DONE.
- Thursday 07/09/15
- List the RST issues we have run into for editing so we can present our findings - Joe - DONE
- Contact a core reviewer or RST SME for information on how to solve these issues - Alex - DONE
- Thursday 06/25/15
- Update Calendars and Meeting times for the next meetings - change to fortnight - Joe
- Thursday 06/18/15
- Thursday 06/11/15
- Updated Documentation/Migrate wiki table for Cloud Admin Guide with Networking.xml conversion chapters marked as "On Hold" - Alex - DONE
- Thursday 06/04/15
- Email out request for Cloud Admin Guide repository freeze. - Brian, Joe. - DONE
- Linking RST conversion to the User Guide improvement blueprints - Brian - DONE
- Move HOT guide to heat repository - Brian (https://bugs.launchpad.net/openstack-manuals/+bug/1461720) - DONE
- HowTo overhaul discussion, and HowTo for first timers. Brian - This has been taken on by a separate team
Previous agendas
- Thursday 12/11/15
- Change to IRC meetings and log meetings using MeetBot
- List meeting information in IRC meeting repo (similar to the Install Guide team)
- Maintain agenda only for next meeting
- Clean up our team page (https://wiki.openstack.org/wiki/User_Guides)
- Thursday 15/10/15
- Docs Spec - What to include, and thoughts and ideas
- Thursday 01/10/15
- Priority for Liberty release - minor changes, items that can be low hanging fruit bugs. Review User, Admin User, and Cloud Admin books.
- Spec - working on.
- Thursday 09/17/15
- Priority for Liberty release - Updating abstracts, Updating images of the dashboard, Consistency items.
- Procedures with dot point items - change to a :hlist: role, which creates a shorter list - compacting information, taking less space.
- Dev docs links to update
- Thursday03/09/15
- Email updates - all emails with important announcements will have " [user guides] " two words, in the subject line.
- Fixing Links with Guide changes. There is a table for tracking these links. Most sources are updated now. Chase down any devdocs or other project links
- Begin on work items - still need a blueprint to track bugs.
- Thursday19/8/15
- all the content is accounted for. Starting the change to .rst. Switching off the .xml and publishing the .rst version - Andreas has put together a list of the steps involved. There are several steps involved. He has used the security guide as an example.
- Create a new blueprint to store work item patches. Any related bugs on changing the user, cloud admin, or admin guides, please search and add these to the blueprint whiteboard as items to work on- use Workitem tag, followed by a link to the bug.
- "nova live migrations" and "nova zookeeper" .. todo markers are still in the docs. Can we keep the notes in the document, and then write links to these configuration reference files as a work item on the list?
- Thursday 06/08/16
- User Task Matrix - Use this table as a frame for reviewing the user guides. Please add tasks to the left column as you review the guides - check on procedures, and what they are asking the audience to do. The more important the tasks is to the particular user type, the higher the number.
- Change to .rst - I have started reviewing the rst files for any leftover items to convert.
- Task list - I have added the task list from the docs spec to the wiki as a guide. Zhu.rong has already taken a step to reorganise the content. https://review.openstack.org/#/c/205800
- Thursday 23/07/15
- https://review.openstack.org/#/c/199869/ - Contact zhanguoqing on the bug progress, and if they need assistance
- User Guide Common Files - some common files attached to the Cloud Admin Guide left to convert - Decide if we should follow these up, and add them to the table. support-compute.rst is in the compute toc tree now for example - add remaining common files
- Directions for user guides following conversion - something to start thinking about, referring to the user guide spec. (https://review.openstack.org/#/c/174647/)
- Thursday 07/09/15
- Tables - are the list tables building correctly - screen cap tables or code segments that were in +-----+ format.
- Any conversion points: pandoc cut out some headings - adding them back in during review.
- Thursday 06/25/15
- RST check in: any questions or discussions?
- Any returning members need an update?
- Any bugs for cloud admin to tag, pause, or merge?
- Thursday 06/18/15
- Action items from last meeting - networking sections tagged
- Networking sections updates
- Any past items to discuss
- Thursday 06/11/15
- Action items from last meeting - All either Done or Doing.
- Cloud Admin Guide RST Conversion - Hold off on converting networking sections, as these may be removed entirely
- :option: tagging note - :orphan: directive for common files
- Any past items to discuss.
- Thursday 06/04/15
- Cloud Admin Guide RST Conversion
- Cloud Admin Guide bugs: This one https://review.openstack.org/#/c/187339/5
- IA Update post conference.
- Thursday 05/28/15
- The Cloud Admin Guide RST Conversion is now a priority follow the summit. So this crosses off a question from
two weeks ago on whether the guide was in our scope. There is a task tracking table added to the RST migration page on the Wiki.
- There is now a new heading on the RST conversion task tracking page.
- Question for experienced writers - Where to start from here?
- IA Update:
- Rename the Virtual Machine Image Guide to the Cloud Image Guide
- Admin Guide versioning. One consideration is to add versioning to the Admin Guide
- Move Hot Guide from End User Guide to Heat repo
- Rewriting the How-To section, resulting in doc that has ease of readability. This must avoid duplication of the infra-manual.
- Thursday 05/14/15
- Will the scope include Cloud Admin Guide alongside the User and Admin Guides?
- The tasks tracking page is now active: https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides
- https://review.openstack.org/#/q/status:open+branch:master+topic:separate-user-guide,n,z : A list of patches to review as a priority to.