跳转到： 导航, 搜索

Documentation/ReorganizeUserGuides

Pike 任务

  • 将管理指南内容移至项目存储库，由项目团队直接管理。

初始步骤

    • 用于跟踪过渡的 Wiki 页面 - 正在进行中 - Joe Robinson
    • 为管理指南设置 cookie cutter
    • 完成对管理员指南内容的选定清理和更新
    • 鼓励项目团队将现有内容移至项目团队存储库
    • 更新《文档贡献者指南》，使其包含设置项目管理员指南所需的步骤

中间步骤

    • 更新主索引文件以反映新结构
    • 编写基本管理员指南
    • 设置门禁作业，以便在索引文件补丁合并时发布管理员指南
    • 通知项目团队此方法发布项目特定管理员指南

Ocata 任务

  • 在用户指南和管理员指南中，将旧版命令替换为 OpenStack 客户端命令。

旧版到 OpenStack 命令转换表

用户指南旧版命令表

指南名称 文件名称 命令 变更详情 姓名 补丁与状态
User Guide backup-db-incremental.rst 46: $ trove backup-create $ trove backup-create 108: $ trove create guest2 10 --size 1 --backup BACKUP_ID 旧版 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 旧版 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 已更改 Allen, David Rabel 完成 https://review.openstack.org/#/c/389980 和 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 旧版和 OpenStack 命令 David Rabel, 142: $ nova meta volumeTwoImage set newmeta='my meta data' 完成 https://review.openstack.org/#/c/399691
User Guide cli-cheat-sheet.rst 第 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 旧版 Joe Robinson 完成 https://review.openstack.org/400603 和 https://review.openstack.org/405982 。08/12 - Swift 团队确认 Swift 命令尚无等效的 OpenStack 命令。
User Guide cli-nova-launch-instance-from-volume.rst 326 $ nova boot --flavor FLAVOR --image IMAGE_ID --swap 512 \ --ephemeral size=2 NAME 旧版 Joe Robinson, Caoyuan 完成 https://review.openstack.org/400603 和 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 旧版 Joe Robinson 完成 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 旧版命令, OpenStack 命令 Allen 进行中 https://review.openstack.org/#/c/404818
User Guide cli-nova-configure-access-security-for-instances.rst OpenStack 客户端 已更改
User Guide cli-change-the-size-of-your-server.rst 70: $ nova resize myCirrosServer 4 --poll 旧版
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 旧版
用户指南 cli-use-snapshots-to-migrate-instances.rst OpenStack caoyuan, yanghuichan https://review.openstack.org/#/c/408679/ - 已合并。 https://review.openstack.org/#/c/446853/
用户指南 create-db.rst 123: $ trove create mysql_instance_1 6 --size 5 --databases myDB, 147: $ trove list, 162: $ trove show INSTANCE_ID 旧版命令 Zhang Yan Xian 进行中 https://review.openstack.org/#/c/412713/
用户指南 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 \ 旧版和 OpenStack Zhang Yan Xian 进行中 https://review.openstack.org/#/c/413483
用户指南 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 旧版 name
用户指南 cli-reboot-an-instance.rst 75: $ nova rescue --rescue_image_ref IMAGE_ID SERVEl 旧版 name
用户指南 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 旧版 name
用户指南 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 旧版 name
用户指南 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 旧版 name
用户指南 Swift 文件 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 旧版 姓名 目前，Swift 团队无法为 Swift 服务创建 OpenStack 客户端命令。

管理员指南旧版命令表

指南名称 文件名称 命令 变更详情 姓名 补丁与状态
管理员指南 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 已更改 darrenc 完成 https://review.openstack.org/#/c/412294/
管理员指南 compute-live-migration-usage.rst nova list: 28. nova show: 52. nova live-migration: 212. nova live-migration: 219 旧版 完成
管理员指南 compute-manage-logs.rst nova get-serial-proxy: 196 旧版 完成
管理员指南 compute-node-down.rst nova reboot: 86. nova flavor-key: 130. nova boot: 137 已更改 Allen 完成 https://review.openstack.org/#/c/399844/
管理员指南 blockstorage-volume-number-weigher.rst 52: $ cinder type-create lvm, 58: $ cinder type-key lvm set, 71: $ cinder create --volume-type lvm 1 已更改 Allen 完成 https://review.openstack.org/#/c/409439
管理员指南 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 个旧版命令 Allen https://review.openstack.org/#/c/409447, 需要 $ cinder backup-reset-state 的 openstack 命令
管理员指南 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 已更改 Allen https://review.openstack.org/#/c/409454
管理员指南 support-compute.rst nova reset-state: 220. nova delete: 221. nova reset-state: 228 旧版 Darren 没有可用的替换 OSC 命令
管理员指南 networking-use.rst nova boot: 189, 243, 252, 261. 已更改 visnyei 完成 https://review.openstack.org/#/c/399487/
管理员指南 networking-adv-features.rst 路由器和网络命令 已更改 ankur-gupta-f https://review.openstack.org/#/c/407239/
管理员指南 networking-introduction.rst 端口设置命令 已更改 ankur-gupta-f https://review.openstack.org/#/c/407582/
管理员指南 networking-config-agents.rst 子网命令 已更改 ankur-gupta-f https://review.openstack.org/#/c/407598/
管理员指南 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 \ 旧版和 OpenStack Allen 进行中 https://review.openstack.org/#/c/413587
管理员指南 blockstorage-volume-migration.rst openstack volume show 已更改
管理员指南 cli-admin-manage-stacks.rst openstack stack resume, openstack suspend, openstack delete 已更改
管理员指南 cli-admin-manage-ip-addresses.rst nova floating-ip-bulk-list: 35. nova floating-ip-create: 68 74. nova floating-ip-delete: 101 107. 已更改 Darren 完成 https://review.openstack.org/#/c/412294/
管理员指南 cli-manage-flavors.rst nova flavor-access-add: 139. nova help flavor-key: 156. 旧版 Darren 没有可用的替换 OSC 命令
管理员指南 cli-nova-evacuate.rst nova host-list: 19. nova evacuate: 29 50. 旧版 Darren nova evacuate 没有可用的替换 OSC 命令 https://review.openstack.org/#/c/412685/
管理员指南 cli-nova-manage-services.rst nova service-list: 13, 40, 67. nova service-disable: 29. nova service-enable: 56. 旧版 Darren 进行中 https://review.openstack.org/#/c/412685/
管理员指南 cli-nova-migrate.rst nova list: 18. nova show: 25. nova migrate: 31. 已更改 Allen 进行中 https://review.openstack.org/#/c/406917
管理员指南 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. 旧版 Darren 进行中 https://review.openstack.org/#/c/412685/; 没有 OSC 命令可以替换 nova quota-update, nova quota-show 用于项目用户的配额值, nova absolute limits
管理员指南 cli-keystone-manage-services.rst openstack service list, openstack service create, openstack

service show, openstack project create service, openstack role add || 已更改

管理员指南 cli-manage-flavors.rst openstack flavor list, openstack flavor create, openstack help flavor create, openstack flavor delete 已更改
管理员指南 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 || 已更改

管理员指南 cli-nova-manage-projects-security.rst openstack security group list, security group rule list, security group list open, security group list global_http 已更改 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 || 已更改

管理员指南 cli-set-quotas.rst openstack project list, user list --project 已更改
管理员指南 cli-cinder-quotas.rst cinder quota-show, cinder quota-delete, cinder quota-update 旧版 Joe Robinson https://review.openstack.org/#/c/427030/
管理员指南 compute-arch.rst openstack image list, flavor list 已更改
管理员指南 compute-cpu-topologies.rst openstack flavor set, image set 已更改
管理员指南 compute-flavors.rst openstack flavor --help 已更改
管理员指南 compute-images-instances.rs openstack image list, flavor list 已更改
管理员指南 compute-manage-the-cloud.rst openstack help 已更改
管理员指南 compute-manage-volumes.rst openstack volume list 已更改
管理员指南 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 旧版和 OpenStack Allen. Chen。 完成 https://review.openstack.org/#/c/389980, https://review.openstack.org/#/c/405931, https://review.openstack.org/#/c/409453 一些 nova network 旧版命令。
管理员指南 compute-security.rst 137: $ nova boot --flavor m1.tiny --key-name, 130: $ nova flavor-key m1.tiny set 旧版和 OpenStack 命令 Chen 进行中 https://review.openstack.org/#/c/405931
管理员指南 telemetry-measurements.rst 56: $ nova boot --meta OpenStack 命令 Chen 进行中 https://review.openstack.org/#/c/405931
管理员指南 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 旧版命令 尚无 OpenStack 等效命令。
管理员指南 identity-concepts.rst openstack user create, project create acme, openstack --os-identity-api-version=3 domain create emea, openstack role create compute-user 已更改
管理员指南 networking-introduction.rst neutron port-update 行:187, port-create 行:180 2 个旧版命令 csatari 正在进行中
管理员指南 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 旧版命令 替换 neutron ext-list 行；其他命令没有可用的替换 OSC 命令。进行中 https://review.openstack.org/#/c/416243/ 和 https://review.openstack.org/#/c/427030/ - 已更改配额显示 <project id> 命令。
管理员指南 networking-adv-config.rst neutron-metering-agent 行:19 1 个旧版命令 没有可用的替换 OSC 命令
管理员指南 networking-adv-features.rst 第 214-894 行之间有许多 neutron 命令 可能需要与 neutron 团队讨论。 visny
管理员指南 networking-config-agents.rst neutron subnet create 行 98, 103, neutron agent-list, agent-show, agent-update, agent-delete 行: 477 482 491 497 5 个旧版命令 Darren 进行中 https://review.openstack.org/#/c/412685/; 没有 OSC 命令可以替换 neutron agent-update
管理员指南 networking-config-identity.rst openstack endpoint create, openstack role add 已更改 只有 $ quota show <project id> 命令 https://review.openstack.org/#/c/427030/
管理员指南 networking-use.rst openstack project list > neutron net-create 行:51, neutron security-group-rule-create 行:305,310, neutron net-create 行:128, neutron subnet-create 行:134 40 151 161, netron port-list 行:168 200 206, neutron port-update 行:212, neutron net-list 行:187 6 个旧版命令 visnyei 完成: https://review.openstack.org/#/c/399487/
管理员指南 orchestration-stack-domain-users.rst openstack --os-token $OS_TOKEN --os-url=$KS_ENDPOINT_V3 --os-\ 已更改
管理员指南 baremetal.rst openstack flavor show > ironic node-set-maintenance <IRONIC-NODE-UUID> off 行:153 ironic node-show <IRONIC-NODE-UUID> 行:130 2 个旧版命令 没有可用的替换 OSC 命令
管理员指南 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 个旧版命令 没有可用的替换 OSC 命令
管理员指南 shared-file-systems-share-networks.rst 63: $ manila share-network-create 91: $ manila share-network-list 旧版命令 name 进行中 https://review.openstack.org/#/c/416243

Newton 任务

  • 与操作指南协作检查重复内容
  • 检查缺失内容和过时内容 - 修复链接
  • 将新服务项目纳入用户指南 - 特别是那些在开发文档中包含可移至用户指南的信息的项目
  • IA 计划 - 一致性、链接、可查找性以及表格、代码片段、命名约定（使用贡献者指南）

IA 计划

基本 IA - 一致性和格式选择

Tables
  • Telemetry - 代码片段表格不适合页面。
  • 网络 - 使用网络部分 - 网络表格不一致
  • 使用 Rootwrap 保护 - 迁移实例 - 这些表格是代码片段 - 它们可以恢复为这种格式吗？
  • Flavours - 表格有粗体标题。并且有与这些标题相关的句子 - 显示主机使用统计信息：主机使用统计信息描述，并更改为粗体标题 - 管理员用户指南中设置 Flavours 的表格是否有效？
  • 设置 Flavours - 这些表格是否“有效”？它们是否帮助用户或管理员角色设置 Flavours？
  • Rootwrap - 迁移实例：这些表格是代码片段。它们可以替换为图像或适当的代码片段吗？
  • Nova-Networking - 配置计算以使用 IPv6 地址：地址表在不同指南之间的一致性。
Links between articles
  • 块存储
    • 迁移卷命令可以出现在最终用户指南中。努力将这些文章整合在一起。
  • 使用 Nova 网络
    • 云管理员指南引用了浮动 IP 地址，用户可以更改。用户指南中关于网络的部分需要重新组织以与此内容保持一致。
  • 构建模块
    • nova image-list 命令。将 nova 命令行客户端的内容与此处的最终用户指南链接起来。
Persona Clear up
  • 块存储
    • 备份和恢复卷：此过程是否是云管理员过程...此基本信息是否可以调整以适应用户指南。
Moving content
  • Networking
    • 为网络配置身份：此处出现了一个关于不将 Nova-network 与计算一起使用的说明，
    • 但需要更早出现 - 在介绍中 - 作为云管理员的警告。
    • 网络架构：此部分对架构的描述最好放在介绍之后。

块存储

    • 块存储：在这篇介绍中需要更早、更清晰地提到持久存储。
    • 限制卷复制带宽：重新组织指南，使此内容更接近有关移动和迁移块存储卷的信息（"volume_copy_bps_limit"）。

使用 Rootwrap 保护

    • 常见问题：指南中的常见问题与其他信息冲突。
    • 此处需要进行信息架构检查以重新处理此信息。
New Diagrams
  • 安全强化
    • 改进 OpenStack 与可信计算池的第二个图表。新图表需要标题，并与其他图表保持一致。

最新任务

  • 构建模块
    • 简介：此处指的是哪个基本操作系统。检查内容准确性。
  • 使用 nova-network 进行网络连接
    • VLAN 网络管理器：检查段落缩进。
  • Metadata
    • 根据发布说明，Liberty 到 Mitaka 元数据服务现在包含“project_id”。
    • 元数据需要 SME 检查其最新性。（Andrew Bogott、John Garbutt、Matthiew Gagne）
    • 元数据配置选项表描述：解决不同指南之间表格的一致性。
  • 使用 Rootwrap 保护
    • 配置选项 [默认]：SME 检查，并更改为更好的格式。可能需要代码片段
    • 灾难后恢复云：测试或让 SME 检查此程序。
    • 过滤器和良好函数中支持的操作：删除“注意”中的被动语态。
    • 图像卷缓存：删除被动语态。
  • Networking
  • 数据库

目前没有推荐的更改。

  • Baremetal

目前没有推荐的更改。

  • Orchestration

目前没有推荐的更改。

  • 遥测
    • 数据检索：代码片段表格需要适应页面。
    • 测量：确认 Liberty 版本中没有添加其他测量项。https://github.com/openstack/ceilometer/commit/43a50f9be884c731afc41a07442e2a8ddee6fc77 - 已添加 CPU 利用率检查，以及 Magnum 检查（"magnum 发送以下内容：名称: container.bay.memory_util, 类型: gauge, 单位: %, resource_id: bay id, source: notification, description: swarm bay 的内存利用率"）
  • 编排（Joseph Robinson）
    • 编排授权模型：此部分需要进行语法编辑。
    • 堆栈域用户：此部分也需要进行语法编辑。
    • 跨域资源共享：子部分“使用配置启用 CORS”需要进行编辑，将其改为一个过程而不是项目列表。
  • 跨项目功能

目前没有推荐的更改

任务存档 2.0

文件跟踪表

云管理员章节 管理员指南文件 已移动？（是/否） 内容已添加到文件，或已添加到 Toctree？（Toctree/文件）
仪表盘 dashboard.rst Yes
admin-guide-cloud/source/dashboard.rst dashboard_admin_manage_stacks.rst Yes 目录树
admin-guide-cloud/source/dashboard.rst dashboard_manage_flavors.rst Yes 目录树
admin-guide-cloud/source/dashboard.rst dashboard_manage_host_aggregates.rst Yes 目录树
admin-guide-cloud/source/dashboard.rst dashboard_manage_images.rst Yes 目录树
admin-guide-cloud/source/dashboard.rst dashboard_manage_instances.rst Yes 目录树
dashboard_manage_resources.rst Yes 目录树
dashboard_manage_services.rst Yes 目录树
admin-guide-cloud/source/dashboard.rst shared_file_systems_manage_shares_dashboard.rst（之前为：dashboard_manage_shares.rst） Yes 目录树
dashboard_manage_volumes.rst Yes 目录树
dashboard_set_quotas.rst Yes 目录树
dashboard_view_cloud_resources.rst Yes 目录树
dashboard_admin_manage_roles.rst Yes 目录树
doc/admin-guide-cloud/source/shared_file_systems_manage_shares_cli.rst shared_file_systems_manage_shares_cli.rst (以前是 cli_manage_shares.rst) Yes 目录树
doc/admin-guide-cloud/source/cli.rst
cli_manage_projects_users_and_roles.rst Yes 目录树
cli_admin_manage_environment.rst Yes 目录树
cli_admin_manage_ip_addresses.rst Yes 目录树
cli_admin_manage_stacks.rst Yes 目录树
cli_cinder_quotas.rst Yes 目录树
cli_cinder_scheduling.rst Yes 目录树
cli_keystone_manage_services.rst Yes 目录树
cli_manage_flavors.rst Yes 目录树
cli_manage_services.rst Yes 目录树
cli_manage_shares.rst Yes 目录树
cli_nova_evacuate.rst Yes 目录树
cli_nova_manage_services.rst Yes 目录树
cli_nova_migrate.rst Yes 目录树
cli_nova_numa_libvirt.rst Yes 目录树
cli_nova_specify_host.rst Yes 目录树
cli_set_compute_quotas.rst Yes 目录树
cli_set_quotas.rst Yes 目录树
analyzing-log-files-with-swift-cli.rst 重命名为 cli_analyzing-log-files-with-swift.rst Yes 目录树
networking_advanced_quotas.rst 重命名为 cli_networking_advanced_quotas.rst Yes 目录树
nova_cli_manage_projects_security.rst 重命名为 cli_nova_manage_projects_security.rst Yes 目录树
cli_overview.rst Yes 管理员用户指南 > cli.rst 目录树
cli_install_openstack_command_line_client.rst Yes 管理员用户指南 > cli.rst 目录树
cli_discover_version_number_for_a_client.rst Yes 管理员用户指南 > cli.rst 目录树
cli_set_environmental_variables_using_openstack_rc.rst Yes 管理员用户指南 > cli.rst 目录树
cli_manage_images.rst Yes 管理员用户指南 > cli.rst 目录树
cli_manage_volumes.rst Yes 管理员用户指南 > cli.rst 目录树


链接检查与更改

转换为 .rst 格式后，指向云管理员指南的链接（也请检查最终用户指南、管理员用户指南和安全指南链接 - URL 中的 "/content" 始终是错误的）已更改。这些都需要更新。下面是 OpenStack 文档项目列表，以及针对每个文档项目中链接的审查列表

文档/章节 姓名 パッチ URL 状态
openstack / 安装指南 Brian Moss https://review.openstack.org/#/c/217524/ 已合并
openstack / glance Andreas Jaeger https://review.openstack.org/#/c/216003/ 已合并
openstack / user-guide Tamara Johnston https://review.openstack.org/#/c/216909 已合并
openstack / user-guide-admin Brian Moss https://review.openstack.org/#/c/224415/ 已合并
openstack / networking-guide Brian Moss https://review.openstack.org/#/c/224416/ 已合并
stackforge / fuel-docs Brian Moss https://review.openstack.org/#/c/219069/ 已合并
openstack / cinder-specs Christian Berendt https://review.openstack.org/216116 审查中
openstack / nova-specs Christian Berendt https://review.openstack.org/#/c/216122/ 已合并
openstack / 培训指南 Brian Moss 等待创建新仓库 搁置
openstack / ironic-specs Brian Moss https://review.openstack.org/#/c/224940/ 已合并
openstack / ceilometer Brian Moss https://review.openstack.org/#/c/224942/ 已合并
openstack / api-site Emett Speer https://review.openstack.org/219944 已合并
openstack / ceilometer-specs Brian Moss https://review.openstack.org/#/c/224432/ 已合并
openstack / heat Brian Moss https://review.openstack.org/#/c/219071/ 已合并
openstack / governance - - 开放
stackforge / cookbook-openstack-network - - 开放
openstack / designate-specs - - 开放
openstack / docs-specs Emett Speer https://review.openstack.org/#/c/219936/ 已合并
stackforge / kolla - - 开放
stackforge / networking-midonet - - 开放
stackforge / driverlog - - 开放
stackforge / kolla - - 开放
openstack / neutron-specs Emett Speer https://review.openstack.org/219942 已合并
openstack / tripleo-image-elements Emett Speer https://review.openstack.org/219945 已合并
openstack-attic / object-api - - 不需要（attic 是只读的）
stackforge / fuel-plugin-lma-collector Brian Moss https://review.openstack.org/#/c/219525/ 已合并
openstack / openstackdocstheme Andreas Jaeger https://review.openstack.org/216121 已合并
stackforge / fuel-plugin-neutron-fwaas Brian Moss https://review.openstack.org/#/c/219527/ 审查中
stackforge / os-ansible-deployment Brian Moss https://review.openstack.org/#/c/219085/ 已合并
stackforge / fuel-specs - - 开放
openstack / swift Emett Speer https://review.openstack.org/219933 已合并
stackforge / compass-adapters - - 开放
openstack / ha-guide Andreas Jaeger https://review.openstack.org/215998 已合并
openstack / operations-guide Andreas Jaeger https://review.openstack.org/215996 已合并
openstack / api-site Andreas Jaeger https://review.openstack.org/216001 已合并
openstack / cinder Andreas Jaeger https://review.openstack.org/#/c/216006/ 已合并
openstack / security-doc Andreas Jaeger https://review.openstack.org/216004 已合并
openstack / admin-guide-cloud Andreas Jaeger https://review.openstack.org/#/c/216033/ 已合并
openstack / neutron Christian Berendt https://review.openstack.org/#/c/216125/ 已合并

使用 hound.openstack.org 在所有仓库中搜索字符串。


用户任务矩阵

任务 操作员 系统管理员 最终用户
规划安装 7 7 1
网络设置 10 10 1
创建项目 10 10 0
创建实例 10 10 2


云管理员指南 RST 转换

  • 在 2015 年温哥华设计峰会之后，OpenStack Docs 选定转换为 RST 格式的文档之一是《云管理员指南》。将该指南转换为 RST 格式现在是用户指南专业团队的一项任务和优先事项。
  • 转换完成后，我们可以重新组织《云管理员指南》、《管理员用户指南》和《最终用户指南》的内容。

附加信息

任务存档 1.0

  • 身份管理 (Joseph Robinson 完成)
    • 启动身份服务：将此内容移至另一部分，以减少存储库中的文件数量。
    • 通过身份进行外部身份验证：身份服务中的另一个较小的部分可以合并。
  • 仪表盘
    • 将管理员用户指南中的 Dashboard 内容合并到 Dashboard 章​​节，以创建一个新的 Dashboard 部分。两部分：第 1 部分（Joseph Robinson 完成）和第 2 部分（Gudrun Wolfgram 完成）
    • 检查 Liberty Dashboard 的更新和更改。（已完成 - Kato Tomoyuki）
  • 命令行
    • 在云管理员指南中创建一个 cli-index.rst 文件，并将管理员用户指南项传输到新位置。（G. Wolfgram）。两部分。第 1 部分和第 2 部分。
  • 计算 (Alexandra Settle)
    • AMPQ：介绍列表的冒号。将括号中的缩写字母大写 - 将 (ampq) 更改为 (AMPQ)。
    • 虚拟机监控程序：包含一个关于如何使用虚拟机监控程序的部分。
    • 租户、用户、角色：删除被动语态。链接到最终用户指南的“我如何使用云？”部分 - 创建和管理角色 - 重新组织此**内容以与云管理员指南内容保持一致。
  • EC2 兼容性 (Gudrun Wolfgram)
    • 删除被动语态。
    • 将此部分与 Liberty 安装指南进行比较。
  • 对象存储（完成 - Alexandra Settle - https://review.openstack.org/#/c/295622/）
    • 用户指南：《创建和管理对象容器》部分需要来自云管理员指南中《对象存储》介绍部分的内容。"...对象存储（代号 Swift）是用于使用集群创建冗余、可伸缩数据存储的开源软件..."
    • 对象存储特性 - 未提及容器，但用户指南提及此术语。编辑以保持一致性。
    • 组件：编辑被动语态的使用，并调整介绍组件的开头句子。
    • 环：在环图下方，编辑这些句子以修复逗号拼接。
    • 区域：提到了高可用性以及组件部分中已提及的其他组件。因此，不需要组件描述。编辑以避免重复。
    • 分区：编辑标点符号 - 逗号拼接
    • 更改块存储章节中的集群架构和环构建器部分。
    • 账户收割者：“在后台，账户收割者从已删除的账户中移除数据...”在此处编辑语法。
    • 对象存储监控 - 博客摘录。保留还是删除？此部分还需要语法审查。
  • 共享文件系统 (Joseph Robinson 完成)
    • 共享基本操作：“通用概念”编辑或澄清此短语。
    • 管理和取消管理共享：编辑某些句子中缺失的单词
    • 调整共享大小：此处也缺失单词。
    • 配额和限制：编辑动词主语一致性。
    • 一致性组：编辑动词主语一致性（“admin to admins”）。
    • 调度：编辑冠词和定冠词。
    • 网络 - 编辑缺失的单词。
    • 共享网络 - 编辑动词主语一致性
  • 镜像和实例 (Joseph Robinson 完成)
    • 使介绍与最终用户指南保持一致。
    • “此图显示了启动实例之前的系统状态”描述了图的各个部分。该段落不清楚。将修改扩展到其他图表。
    • 多路径调用失败退出：此故障排除部分采用了问题和解决方案标题架构，这对于云管理员指南的其他故障排除部分很有用。(Joseph Robinson)

过去已完成的任务

  • 删除目录中的重复项
    • 目录中重复出现多项。需要修复 RST 文件。（完成）
  • 将用户指南分离到不同的目录，同时保留一个公共目录以简化设置和编写：（完成）
  • 开发用户任务矩阵
  • 修改每份指南的摘要，以清晰地识别受众和目的。
    • 在指南中包含新的概述/描述性信息，如果这些信息缺失或需要更新。
  • 将云管理指南转换为 RST 格式（完成）
  • 将 Hot Guide 从最终用户指南移至 Heat 仓库（完成）
  • 减少指南之间内容的重复，将云管理员指南指向管理员用户指南，并将管理员用户指南指向最终用户指南，以便读者完成更多任务，这是摘要重写的一个合适步骤
  • 删除仪表板章节中任何不必要或不言自明的程序
  • 确定如何呈现任务的良好结构 - 仪表板、命令行或配置文件编辑
  • 更新仪表板（.jpg 等）的管理员和项目选项卡图像（完成）
  • 使指南中某些程序保持一致。有些有表格，有些有变量列表：（正在进行中）Joseph Robinson
    • 创建网络（正常变量列表）
    • 启动实例（粗体变量列表）
    • 管理堆栈和访问与安全（表格）
    • 管理对象（项目符号）
  • 程序步骤之间的间距不一致。例如：“将对象从一个容器复制到另一个容器的程序”和

用户指南“管理对象”部分中的“过程：创建不带文件的仅元数据对象”。（正在进行中）Darren Chan


会议存档

行动项目

  • 2015/10/15 星期四
    • 在 Mitaka 峰会前完成规范 - Joe - 已完成
  • 2015/10/01 星期四
    • 起草 M 版本规范
    • 完成 L 版本的次要项
  • 2015/03/09 星期四
    • Joe 为新的蓝图创建一个干净的开始，记录转换完成后工作项 - Joe - 已完成。
  • 2015/07/09 星期四
    • 列出我们在编辑时遇到的 RST 问题，以便我们可以展示我们的发现 - Joe - 完成
    • 联系核心评审员或 RST SME 获取如何解决这些问题的信息 - Alex - 完成
  • 2015/06/25 星期四
    • 更新下几次会议的日历和会议时间 - 改为每两周一次 - Joe
  • 2015/06/18 星期四
  • 2015/06/11 星期四
    • 更新了 Documentation/Migrate wiki 表格，其中云管理员指南中 Networking.xml 转换章节标记为“搁置” - Alex - 已完成
  • 2015/06/04 星期四
    • 发出云管理员指南仓库冻结的电子邮件请求。- Brian，Joe。- 已完成
    • 将 RST 转换链接到用户指南改进蓝图 - Brian - 已完成
    • 将 HOT 指南移至 heat 存储库 - Brian (https://bugs.launchpad.net/openstack-manuals/+bug/1461720) - 已完成
    • HowTo 全面修订讨论，以及初学者 HowTo。Brian - 这已由一个独立的团队承担

以前的议程

  • 2015/10/15 星期四
    • 文档规范 - 要包含什么，以及想法和建议
  • 2015/10/01 星期四
    • Liberty 版本的优先级 - 次要更改，可以作为低悬挂果实的错误项。审查用户、管理员用户和云管理员书籍。
    • 规范 - 正在进行中。
  • 2015/09/17 星期四
    • Liberty 版本的优先级 - 更新摘要、更新仪表板图像、一致性项目。
    • 带有圆点项的程序 - 更改为 :hlist: 角色，这将创建一个更短的列表 - 压缩信息，占用更少的空间。
    • 待更新的开发文档链接
  • 2015/09/03 星期四
    • 电子邮件更新 - 所有包含重要公告的电子邮件将在主题行中包含“[user guides]”两个单词。
    • 修复指南更改后的链接。有一个表格用于跟踪这些链接。大多数来源现在已更新。追查任何开发文档或其他项目链接
    • 开始工作项 - 仍然需要蓝图来跟踪错误。
  • 2015/08/19 星期四
    • 所有内容都已清点。开始转换为 .rst。关闭 .xml 并发布 .rst 版本 - Andreas 整理了所涉及的步骤列表。有几个步骤。他以安全指南为例。
    • 创建一个新的蓝图来存储工作项补丁。任何与更改用户、云管理员或管理员指南相关的错误，请搜索并将其添加到蓝图白板作为工作项 - 使用 Workitem 标签，后跟指向错误的链接。
    • "nova live migrations" 和 "nova zookeeper" .. todo 标记仍在文档中。我们可以将注释保留在文档中，然后将这些配置参考文件的链接作为工作项添加到列表中吗？
  • 2016/08/06 星期四
    • 用户任务矩阵 - 将此表作为审查用户指南的框架。请在审查指南时将任务添加到左列 - 检查程序以及它们要求受众执行的操作。任务对特定用户类型越重要，数字就越高。
    • 更改为 .rst - 我已开始审查 rst 文件中是否有遗留的待转换项目。
    • 任务列表 - 我已将文档规范中的任务列表添加到 Wiki 作为指南。Zhu.rong 已经采取了一步来重新组织内容。https://review.openstack.org/#/c/205800
  • 2015/07/23 星期四
    • https://review.openstack.org/#/c/199869/ - 就 bug 进度联系 zhanguoqing，以及他们是否需要协助
    • 用户指南公共文件 - 还有一些附加到云管理员指南的公共文件需要转换 - 决定我们是否应该跟进这些文件，并将它们添加到表格中。例如，support-compute.rst 现在在 compute toc 树中 - 添加剩余的公共文件
    • 转换后用户指南的方向 - 需要开始思考的事情，参考用户指南规范。(https://review.openstack.org/#/c/174647/)
  • 2015/07/09 星期四
    • 表格 - 列表表格是否正确构建 - 屏幕截图表格或 +-----+ 格式的代码段。
    • 任何转换点：pandoc 删除了一些标题 - 在审查期间重新添加。
  • 2015/06/25 星期四
    • RST 签入：是否有任何问题或讨论？
    • 是否有任何返回成员需要更新？
    • 是否有任何云管理员的 bug 需要标记、暂停或合并？
  • 2015/06/18 星期四
    • 上次会议的行动项目 - 已标记网络部分
    • 网络部分更新
    • 讨论任何过去的项目
  • 2015/06/11 星期四
    • 上次会议的行动项 - 都已完成或正在进行中。
    • 云管理员指南 RST 转换 - 暂停转换网络部分，因为这些部分可能完全删除
    • :option: 标记说明 - :orphan: 指令用于公共文件
    • 讨论任何过去的项目。
  • 2015/05/28 星期四
    • 云管理员指南 RST 转换现在是峰会后的优先事项。因此，这解决了

两周前关于该指南是否在我们的范围之内的问题。Wiki 上的 RST 迁移页面已添加任务跟踪表。

    • RST 转换任务跟踪页面现在有一个新标题。
    • 向有经验的作者提问 - 从这里开始怎么办？
  • IA 更新
    • 将虚拟机镜像指南重命名为云镜像指南
    • 管理员指南版本控制。其中一个考虑因素是为管理员指南添加版本控制
    • 将 Hot Guide 从最终用户指南移至 Heat 仓库
    • 重写操作方法部分，使文档易于阅读。这必须避免与基础设施手册重复。
取自 "https://wiki.openstack.org/w/index.php?title=Documentation/ReorganizeUserGuides&oldid=153831"