跳转到： 导航, 搜索

Blueprint-os-user-docs

目录

总结

该蓝图描述了一个为 OpenStack 用户创建文档的计划。什么是 OpenStack 用户？OpenStack 用户在现有的云上执行任务。OpenStack 用户可能是希望列出可用资源（如镜像和服务器）并创建和管理资源的人。或者，OpenStack 用户可能是新兴的 OpenStack 开发者：希望构建在云上运行的 Web 应用程序的人。

该文档将提供 OpenStack 云的概念性概述，并使用户能够进行身份验证、启动服务器、列出资源（如实例、网络、卷等）、删除资源、访问实例控制台以及配置 VNC 等操作。

该文档将为用户提供与 OpenStack 云交互的清晰路线图，通过使用仪表板和客户端命令，然后通过 cURL 命令或开放 SDK 使用 API 来进行操作。

计划中的文档包括

文档 目的
OpenStack 终端用户指南 向终端用户介绍云概念、常见任务以及与云交互的方式。

通过示例，向用户展示如何在 OpenStack 云中通过以下方式执行任务

  • Horizon 仪表板
  • OpenStack 命令行客户端

在附录（或附录）中，提供参考信息，使用户能够通过 OpenStack 命令行客户端命令执行任务。

OpenStack 管理员用户指南 向管理员用户介绍管理任务以及与云交互的方式。

通过示例，向管理员用户展示如何在 OpenStack 云中通过以下方式执行管理任务

  • Horizon 仪表板
  • OpenStack 命令行客户端

内容将在两个用户指南之间共享。

这些文档将部分源自现有文档，并减少冗余，提高可用性、清晰度和一致性。

该蓝图与 蓝图重构文档 相关。

蓝图 - OpenStack 终端用户指南

受众：通过 Horizon 仪表板或 OpenStack 命令行客户端执行任务的 OpenStack 云终端用户。此外，还包括使用 OpenStack API 创建应用程序的开发者。

路线图：用户通过使用 Horizon 仪表板和 OpenStack 命令行客户端来了解云计算。然后，他们使用 OpenStack API 创建可扩展的应用程序。

产品信息： Havana, 2013.1

包含通用词汇表？ 是

目的:

  • 解释 OpenStack 云概念并描述如何使用 OpenStack 云。
  • 包括命令行工具和凭据、如何使用 Horizon 仪表板以及如何创建镜像。

资料来源:

第一章：概述

对 OpenStack 云的一到两段描述。对 OpenStack 项目的描述。说明本书的目标 - 概念、设置和教程。

第一节：OpenStack 云概念

描述用户需要了解才能使用云的主要概念。

第二节：如何与 OpenStack 云交互

描述您可以与云交互的方式

Horizon 仪表板

https://openstack.org/software/openstack-dashboard/

OpenStack 命令行客户端

提供对 OpenStack 命令参考的交叉引用。基于：http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/novaclient.html

带有嵌入式 API 调用的 cURL 命令

基于：http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/curl.html

OpenStack APIs

讨论使用 API 的方式 - cURL？SDK？语言绑定？

第三节：常见用户任务

  • 启动、列出和删除服务器
  • 列出和删除镜像 - 指向有关创建镜像的新书
  • 负载均衡 xx
  • 创建一个隔离网络
  • 访问实例的控制台
  • 配置 VNC
  • 创建、附加和分离卷

第四节：如何使用本指南中的教程

基于：http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/ch_how_examples_work.html


为各种用例提供教程。使用不同的方法在每个教程中，以便用户了解可能性。

第二章：OpenStack 仪表板教程

管理镜像

启动实例

配置对实例的访问

管理实例

管理卷

第三章：OpenStack 命令行客户端教程

OpenStack 命令 - 概述

OpenStack RC 文件

创建镜像

启动实例

配置对实例的访问

在您的云上运行 Wordpress 博客

方法： nova 客户端

  1. 安装 nova 客户端
  2. 设置用户
  3. 获取应用程序服务器的镜像
  4. 启动服务器实例
  5. 安装 Wordpress 及其依赖项。

来源：https://docs.openstack.org/grizzly/openstack-compute/admin/content/running-elastic-web-app-cloud.html 提供指向安装信息的命令参考和其他书籍的指针

在您的云上存储大型照片或视频

方法： swift 客户端和 Cyberduck 应用程序

  1. 安装 swift 客户端
  2. 设置对 OpenStack 对象存储的安全访问
  3. 安装并配置 Cyberduck 以连接到 OpenStack 对象存储
  4. 将文件复制到云

来源：https://docs.openstack.org/grizzly/openstack-object-storage/admin/content/storing-large-photos-or-videos-on-the-cloud.html

创建并将卷附加到您的实例

方法： cinder 和 nova 客户端 用例？ https://docs.openstack.org/grizzly/openstack-block-storage/admin/content/block_storage_overview.html#managing-volumes

创建一个隔离网络

方法： nova 和 quantum 客户端 用例？ https://docs.openstack.org/grizzly/openstack-network/admin/content/basic_operations.html

附录 A. OpenStack 命令参考

目的

  • 描述命令行客户端及其子命令以及所需的和可选的参数。
  • 编写脚本以从代码自动生成命令和命令参数。
  • 使用条件标签生成此书籍的两个版本：一个包含管理员命令，另一个不包含。



资料来源

结果

现在从代码自动生成：https://review.openstack.org/#/c/69942/

蓝图 - OpenStack 管理员用户指南

受众：通过 Horizon 仪表板或 OpenStack 命令行客户端执行任务的 OpenStack 云管理员用户。此外，还包括使用 OpenStack API 创建应用程序的开发者。


产品信息： Havana, 2013.1

包含通用词汇表？ 是

目的:

  • 解释您可以在 OpenStack 云上执行的管理员任务。
  • 包括命令行工具和凭据、如何使用 Horizon 仪表板以及如何创建镜像。
  • 包括云应用程序架构图。

资料来源:

第一章：概述

对 OpenStack 云的一到两段描述。对 OpenStack 项目的描述。带有几句话解释的架构图。说明本书的目标 - 概念、设置和教程。

第一节：OpenStack 云概念

描述用户需要了解才能使用云的主要概念。


第二节：如何与 OpenStack 云交互

描述您可以与云交互的方式

Horizon 仪表板

https://openstack.org/software/openstack-dashboard/
为每个选项添加简短描述（由于这些选项很多，聚合和 hypervisor 不太可能包含在教程中）。

OpenStack 命令行客户端

提供对 OpenStack 命令参考的交叉引用。基于：http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/novaclient.html

带有嵌入式 API 调用的 cURL 命令

基于：http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/curl.html

OpenStack APIs

讨论使用 API 的方式 - cURL？SDK？语言绑定？

第三节：常见管理员用户任务

  • OpenStack RC 文件
  • 管理项目和用户（包括组、域和角色）
  • 管理镜像
  • 管理风味 (Flavors)
  • 设置配额（包括新的 Neutron 配额）。
  • 迁移服务器
  • 管理网络和路由器（即使我们无法在此版本中包含操作方法，也应确认此任务）

第四节：如何使用本指南中的教程

基于：http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/ch_how_examples_work.html

为各种用例提供教程。使用不同的方法在每个教程中，以便用户了解可能性。

第二章：OpenStack 仪表板教程

管理项目和用户

管理镜像

管理风味 (Flavors)

设置配额

迁移服务器

管理网络和路由器

第三章：OpenStack 命令行客户端教程

OpenStack RC 文件

管理项目和用户

管理镜像

管理风味 (Flavors)

设置配额

迁移服务器

管理网络和路由器

附录 A. OpenStack 命令参考

目的

  • 仅管理员命令
  • 描述命令行客户端及其子命令以及所需的和可选的参数。
  • 编写脚本以从代码自动生成命令和命令参数。
  • 使用条件标签生成此书籍的两个版本：一个包含管理员命令，另一个不包含。


结果

现在从代码自动生成：https://review.openstack.org/#/c/69942/

资料来源

从 "https://wiki.openstack.org/w/index.php?title=Blueprint-os-user-docs&oldid=40775" 检索