Jump to: navigation, search

Difference between revisions of "Blueprint-os-user-docs"

(Summary)
(Blueprint - OpenStack Admin User Guide)
 
(88 intermediate revisions by the same user not shown)
Line 1: Line 1:
* '''Launchpad Entry''':  [https://blueprints.launchpad.net/openstack-manuals/+spec/blueprint-os-user-docs]
+
* '''Launchpad Entry''':  [https://blueprints.launchpad.net/openstack-manuals/+spec/blueprint-os-user-docs/ Design for OpenStack User Docs]
 
* '''Created''': Diane Fleming
 
* '''Created''': Diane Fleming
 
* '''Contributors''':  
 
* '''Contributors''':  
Line 5: Line 5:
 
== Summary ==
 
== Summary ==
  
This blueprint describes a plan to create the following documentation for OpenStack users:
+
This blueprint describes a plan to create documentation for OpenStack users. What is an OpenStack user? An OpenStack user performs tasks on an existing cloud. An OpenStack user might be someone who wants to list available resources, such as images and servers, and create and manage resources. Or an OpenStack user might be a budding OpenStack developer: Someone who wants to build web applications that run on a cloud.
  
* ''OpenStack User Guide''
+
This documentation will provide a conceptual overview of the OpenStack cloud, and it will enable users to authenticate, boot a server, list resources, such as instances, networks, volumes, and so on, delete resources, access a console for an instance, and configure VNC, among other tasks.
* ''OpenStack Command Reference''<br /><br />
 
  
These documents will provide a clear roadmap for users to interact with OpenStack clouds. <br />
+
This documentation will provide a clear roadmap for users to interact with OpenStack clouds by using the dashboard and client commands and then progress to using the APIs through cURL commands or open SDKs. <br />
  
Additionally, these documents will reduce redundancy and increase usability, clarity, and consistency in the existing documentation.<br />
+
The planned documentation includes:
<br />
+
{| class="wikitable"
The user guide will show users how to perform tasks in an OpenStack cloud through:<br />
+
|-
 +
! Document !! Purpose
 +
|-
 +
| OpenStack End User Guide || Introduces end users to cloud concepts, common tasks, and ways of interacting with the cloud. <br />
  
* The Horizon dashboard
+
Through examples, shows users how to perform tasks in an OpenStack cloud through:
* The OpenStack command-line clients
 
* Directly through the OpenStack APIs<br />
 
  
The command reference will enable users to perform tasks through OpenStack command-line client commands. <br />
+
* the Horizon dashboard
 +
* the OpenStack command-line clients
  
The tasks that users will be able to perform include:<br />
+
In an appendix (or appendices), provides reference information that enables users to perform tasks through OpenStack command-line client commands.
  
* Authenticate
+
|-
* Boot a server
+
| OpenStack Admin User Guide || Introduces admin users to administrative tasks, and ways of interacting with the cloud. <br />
* Create an image
 
* Create and attach a volume to a server
 
* Create an isolated network and attach it to a server
 
* List instances, networks, volumes, images, flavors, and other resources
 
* Delete resources
 
* Access a console for an instances
 
* Configure VNC
 
  
== Overview - OpenStack User Guide ==
+
Through examples, shows admin users how to perform administrative tasks in an OpenStack cloud through:
  
Introduces users to cloud concepts and common tasks.
+
* the Horizon dashboard
 +
* the OpenStack command-line clients
  
== Overview - OpenStack Command Reference ==
+
|}
  
Enables users to run OpenStack command-line client commands to interact with OpenStack clouds.
+
'''Content will be shared between the two user guides.'''
  
The tasks that users will be able to perform include:
+
These documents will be partially sourced from existing documentation, and will reduce redundancy and increase usability, clarity, and consistency.<br />
  
* Authenticate
+
This blueprint is related to [[Blueprint-restructure-documentation|Blueprint Restructure Documentation]].
* Boot a server
 
* Create an image
 
* Create and attach a volume to a server
 
* Create an isolated network and attach it to a server
 
* List instances, networks, volumes, images, flavors, and other resources
 
* Delete resources
 
* Access a console for an instances
 
* Configure VNC
 
  
== Deliverables ==
+
== Blueprint - OpenStack End User Guide ==
'''Audience''':  
+
'''Audience''': End users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients. Also, developers who create applications on top of OpenStack by using the OpenStack APIs.
* Users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients.  
 
* Developers who develop applications on top of OpenStack by using the OpenStack APIs.
 
<br />
 
'''Roadmap''':
 
* Users ramp up on cloud computing by using the Horizon dashboard and the OpenStack command-line clients.
 
* Then, they use the OpenStack APIs to create scalable applications.
 
 
<br />
 
<br />
 +
 +
'''Roadmap''': Users ramp up on cloud computing by using the Horizon dashboard and the OpenStack command-line clients. Then, they use the OpenStack APIs to create scalable applications.<br />
 +
 
'''Product info:''' Havana, 2013.1<br />
 
'''Product info:''' Havana, 2013.1<br />
  
 
'''Include common glossary?''' Yes <br />
 
'''Include common glossary?''' Yes <br />
  
=== OpenStack User Guide ===
+
'''Purpose''':
 +
 
 +
* Explain OpenStack cloud concepts and describe how to use an OpenStack cloud.
 +
* Include command-line tools and credentials, how to use Horizon dashboard, and how to create images.<br /><br />
 +
 
 +
'''Source  material''':
 +
 
 +
* [https://www.suse.com/documentation/suse_cloud10/book_cloud_user/?page=/documentation/suse_cloud10/book_cloud_user/data/book_cloud_user.html Suse End User Guide]
 +
* [http://training.rackspace.com/certification/rackspace-certified-technician-for-openstack/1/ Rackspace-sponsored OpenStack training]
 +
* [http://www.openstack.org/software/start/ OpenStack API Quick Start]
 +
* [http://docs.openstack.org/developer/openstack-projects.html Python Developer Documentation]
 +
* [http://docs.openstack.org/developer/language-bindings.html Language Bindings Documentation]
 +
* [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]
 +
* [http://docs.openstack.org/run/ OpenStack Administration Guides]
 +
* [http://docs.openstack.org/api/api-specs.html OpenStack API Specifications]
 +
* [http://docs.openstack.org/api/openstack-compute/programmer/content/ Programming OpenStack Compute API with Shell and Python]
 +
 
 +
=== CHAPTER 1: Overview ===
 +
One-to-two paragraph description of the OpenStack cloud.
 +
Descriptions of the OpenStack projects.
 +
State the goals of the book - concepts, set-up, and tutorials.
 +
 
 +
==== SECTION 1: OpenStack Cloud Concepts ====
 +
Describe the main concepts that a user needs to understand to use the cloud.
 +
* Authentication/Identity service -  http://www.openstack.org/software/openstack-shared-services/
 +
* Images, Image service - What’s an image? What’s a snapshot? http://www.openstack.org/software/openstack-shared-services/
 +
* Servers - What is a virtual machine? A hypervisor? A server personality?  What does it mean to boot a server? http://www.openstack.org/software/openstack-compute/. Also, http://docs.openstack.org/cli/quick-start/content/nova_client.html
 +
* Security groups - http://www.openstack.org/software/openstack-compute/
 +
* Floating IP addresses
 +
* Console log
 +
* Object and block storage - http://www.openstack.org/software/openstack-storage/ -  What storage can you attach to instances? Can I attach an ISO as if I'm mounting a CD/DVD? Backend Storage Devices, Users and Tenants (Projects), Volumes Snapshots and Backups.
 +
* Networking - http://www.openstack.org/software/openstack-networking/
 +
 
 +
==== SECTION 2: How to Interact with an OpenStack Cloud ====
 +
 
 +
Describe ways you can interact with a cloud: <br />
 +
 
 +
===== Horizon Dashboard =====
 +
http://www.openstack.org/software/openstack-dashboard/
 +
 
 +
===== OpenStack Command-line Clients  =====
 +
Provide x-ref to OpenStack Command Reference.
 +
Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/novaclient.html
 +
 
 +
=====  cURL Commands with Embedded API Calls =====
 +
 
 +
Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/curl.html
 +
 
 +
===== OpenStack APIs =====
 +
 
 +
Talk about ways to use the APIs – cURL? SDKs? Language bindings?
 +
 
 +
==== SECTION 3: Common User Tasks ====
 +
* Boot, list, and delete servers
 +
* List and delete images - point to new book about OpenStack Images for info about creating images
 +
* Load-balance xx
 +
* Create an isolated network
 +
* Access a console for an instance
 +
* Configure VNC
 +
* Create, attach, and detach a volume
 +
 
 +
==== SECTION 4: How to Use the Tutorials in this Guide ====
 +
 
 +
Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/ch_how_examples_work.html
 +
 
 +
 
 +
Provide tutorials for various use cases. Use different methods in each tutorial so user gets an idea of what’s possible.
 +
 
 +
=== CHAPTER 2: OpenStack Dashboard TUTORIALS ===
 +
 
 +
==== Managing Images ====
 +
==== Launching Instances ====
 +
==== Configuring Access to the Instances ====
 +
==== Managing Instances ====
 +
==== Managing Volumes ====
 +
 
 +
=== CHAPTER 3: OpenStack command-line client TUTORIALS ===
 +
 
 +
==== OpenStack Commands—Overview ====
 +
==== OpenStack RC File ====
 +
==== Creating Images ====
 +
==== Launching Instances ====
 +
==== Configuring Access to the Instance ====
 +
==== Run Your Wordpress Blog on Your Cloud ====
 +
'''Method:''' nova client
 +
# Install the nova client
 +
# Set up a user
 +
# Get images for your application servers
 +
# Spin up server instances
 +
# Install Wordpress and its dependencies.
 +
 
 +
Source from: http://docs.openstack.org/grizzly/openstack-compute/admin/content/running-elastic-web-app-cloud.html
 +
Provide pointers to installation information in Command Reference, and other books with more information
 +
==== Store Large Photos or Videos in Your Cloud ====
 +
'''Method:'''  swift client and Cyberduck application
  
'''Purpose'''
+
# Install swift client
 +
# Set up secure access to OpenStack Object Storage
 +
# Install and configuration Cyberduck to connect to OpenStack Object Storage
 +
# Copy files to the cloud
  
* Explain OpenStack cloud concepts and describe how to use an OpenStack cloud.  
+
Source from: http://docs.openstack.org/grizzly/openstack-object-storage/admin/content/storing-large-photos-or-videos-on-the-cloud.html
* Include command-line tools and credentials, how to use Horizon dashboard, and how to create images.
 
* Exclude Cloud application architecture.<br /><br />
 
  
'''Source  material'''
+
==== Create and Attach a Volume to Your Instance ====
 +
'''Method:''' cinder and nova clients
 +
Use case?
 +
http://docs.openstack.org/grizzly/openstack-block-storage/admin/content/block_storage_overview.html#managing-volumes
  
* OpenStack API Quick Start
+
==== Create an Isolated Network ====
* Python Developer Documentation
+
'''Method:''' nova and quantum clients
* Language Bindings Documentation
+
Use case?
* OpenStack Clients Guide
+
http://docs.openstack.org/grizzly/openstack-network/admin/content/basic_operations.html
* ''project'' devref/s
 
  
=== OpenStack Command Reference ===
+
=== APPENDIX A. OpenStack Command Reference ===
  
 
'''Purpose'''
 
'''Purpose'''
Line 90: Line 171:
 
* Write scripts to auto-generate command and command parameters from the code.
 
* Write scripts to auto-generate command and command parameters from the code.
 
* Use conditional tags to generate two versions of this book: One with admin commands, and one without.
 
* Use conditional tags to generate two versions of this book: One with admin commands, and one without.
* Exclude concepts (these go in the ''OpenStack User Guide'') or installation instructions (these go in the ''OpenStack Installation Guide'').<br /><br />
+
<br /><br />
  
 
'''Source  material'''
 
'''Source  material'''
  
* OpenStack Clients Guide
+
* [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]
== OpenStack User Guide - Blueprint ==
+
 
 +
'''Outcome'''
 +
 
 +
Now auto-generated from code: https://review.openstack.org/#/c/69942/
 +
 
 +
== Blueprint - OpenStack Admin User Guide ==
 +
'''Audience''': Admin users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients. Also, developers who create applications on top of OpenStack by using the OpenStack APIs.
 +
<br />
 +
 
 +
 
 +
'''Product info:''' Havana, 2013.1<br />
 +
 
 +
'''Include common glossary?''' Yes <br />
 +
 
 +
'''Purpose''':
 +
 
 +
* Explain admin tasks you can perform on an OpenStack cloud.
 +
* Include command-line tools and credentials, how to use Horizon dashboard, and how to create images.
 +
* Include Cloud application architecture diagram.<br /><br />
  
WORK-IN-PROGRESS...
+
'''Source  material''':
  
=== OpenStack Cloud Concepts ===
+
* [https://www.suse.com/documentation/suse_cloud10/book_cloud_admin/?page=/documentation/suse_cloud10/book_cloud_admin/data/book_cloud_admin.html#book_cloud_admin Suse User Guide for Admins]
 +
* [http://training.rackspace.com/certification/rackspace-certified-technician-for-openstack/1/ Rackspace-sponsored OpenStack training]
 +
* [http://www.openstack.org/software/start/ OpenStack API Quick Start]
 +
* [http://docs.openstack.org/developer/openstack-projects.html Python Developer Documentation]
 +
* [http://docs.openstack.org/developer/language-bindings.html Language Bindings Documentation]
 +
* [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]
 +
* [http://docs.openstack.org/run/ OpenStack Administration Guides]
 +
* [http://docs.openstack.org/api/api-specs.html OpenStack API Specifications]
 +
* [http://docs.openstack.org/api/openstack-compute/programmer/content/ Programming OpenStack Compute API with Shell and Python]
 +
* Chapter from Summer Long about quotas/neutron quotas
  
 +
=== CHAPTER 1: Overview ===
 +
One-to-two paragraph description of the OpenStack cloud.
 +
Descriptions of the OpenStack projects.
 +
Architecture diagram with few sentences of explanation.
 +
State the goals of the book - concepts, set-up, and tutorials.
 +
 +
==== SECTION 1: OpenStack Cloud Concepts ====
 
Describe the main concepts that a user needs to understand to use the cloud.
 
Describe the main concepts that a user needs to understand to use the cloud.
Authentication/Identity service
+
* Authentication/Identity service http://www.openstack.org/software/openstack-shared-services/
http://www.openstack.org/software/openstack-shared-services/
+
* Images, Image service - What’s an image? What’s a snapshot? http://www.openstack.org/software/openstack-shared-services/
Images, Image service
+
* Servers - What is a virtual machine? A hypervisor? A server personality?  What does it mean to boot a server? http://www.openstack.org/software/openstack-compute/. Also, http://docs.openstack.org/cli/quick-start/content/nova_client.html
What’s an image? What’s a snapshot?
+
* Security groups - http://www.openstack.org/software/openstack-compute/
http://www.openstack.org/software/openstack-shared-services/
+
* Floating IP addresses
Servers
+
* Console log
What is a virtual machine? A hypervisor? A server personality?  What does it mean to boot a server?
+
* Object and block storage - http://www.openstack.org/software/openstack-storage/ -  What storage can you attach to instances? Can I attach an ISO as if I'm mounting a CD/DVD? Backend Storage Devices, Users and Tenants (Projects), Volumes Snapshots and Backups.
http://www.openstack.org/software/openstack-compute/
+
* Networking - http://www.openstack.org/software/openstack-networking/
 +
 
 +
 
 +
==== SECTION 2: How to Interact with an OpenStack Cloud ====
 +
 
 +
Describe ways you can interact with a cloud: <br />
 +
 
 +
===== Horizon Dashboard =====
 +
http://www.openstack.org/software/openstack-dashboard/<br />
 +
Add brief description of each option (since quite a few of these, Aggregates and Hypervisors, won't be in the tutorials).<br />
 +
 
 +
===== OpenStack Command-line Clients  =====
 +
Provide x-ref to OpenStack Command Reference.
 +
Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/novaclient.html
 +
 
 +
=====  cURL Commands with Embedded API Calls =====
 +
 
 +
Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/curl.html
  
Security groups
+
===== OpenStack APIs =====
http://www.openstack.org/software/openstack-compute/
 
Floating IP addresses
 
Console log
 
Object and block storage
 
http://www.openstack.org/software/openstack-storage/
 
Networking
 
http://www.openstack.org/software/openstack-networking/
 
Dashboard, command-line clients, APIs, extensions
 
How to Interact with an OpenStack Cloud
 
Describe ways you can interact with a cloud:
 
OpenStack Command-line Clients
 
OpenStack APIs
 
 
Talk about ways to use the APIs – cURL? SDKs? Language bindings?
 
Talk about ways to use the APIs – cURL? SDKs? Language bindings?
Horizon Dashboard
 
http://www.openstack.org/software/openstack-dashboard/
 
  
Listing
+
==== SECTION 3: Common Admin User Tasks ====
Deleting/Terminating
+
 
Instance Console access
+
* OpenStack RC File
About console log
+
* Managing Projects and Users  (including groups, domains, and roles)
Configuring VNC
+
* Managing Images
How do I attach a volume?
+
* Managing Flavors
  (Details on doing these actions in user guide)
+
* Setting Quotas (including new Neutron quotas).
Attach/Detach volumes
+
* Migrating Servers
How do I save a running instance to an image?
+
* Managing Networks and Routers (even if we can't include howTos in this version, this task should probably be acknowledged)
Snapshots
+
 
 +
==== SECTION 4: How to Use the Tutorials in this Guide ====
 +
 
 +
Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/ch_how_examples_work.html
  
=== Common User Tasks ===
 
Boot, list, and delete servers
 
Configure VNC
 
Attach and detach volumes
 
Create, list, and delete images
 
Load-balance xx
 
=== Tutorials ===
 
 
Provide tutorials for various use cases. Use different methods in each tutorial so user gets an idea of what’s possible.
 
Provide tutorials for various use cases. Use different methods in each tutorial so user gets an idea of what’s possible.
==== Authenticate ====
 
Method: cURL commands with embedded API
 
==== Run Your Elastic Web Application on Your Cloud ====
 
Method: nova client
 
Set up a user, get images for your application servers, spin up server instances, install Wordpress and its dependencies.
 
http://docs.openstack.org/grizzly/openstack-compute/admin/content/running-elastic-web-app-cloud.html
 
  
==== Store Large Photos or Videos in Your Cloud ====
+
=== CHAPTER 2: OpenStack Dashboard Tutorials ===
Method: swift client and Cyberduck application
+
 
Set up secure access to OpenStack Object Storage, configure Cyberduck to connect to OpenStack Object Storage, and copy files to the cloud.
+
==== Managing Projects and Users ====
http://docs.openstack.org/grizzly/openstack-object-storage/admin/content/storing-large-photos-or-videos-on-the-cloud.html
+
==== Managing Images ====
 +
==== Managing Flavors ====
 +
==== Setting Quotas ====
 +
==== Migrating Servers ====
 +
==== Managing Networks and Routers ====
 +
 
 +
=== CHAPTER 3: OpenStack command-line client Tutorials ===
 +
 
 +
==== OpenStack RC File ====
 +
==== Managing Projects and Users ====
 +
==== Managing Images ====
 +
==== Managing Flavors ====
 +
==== Setting Quotas ====
 +
==== Migrating Servers ====
 +
==== Managing Networks and Routers ====
 +
 
 +
=== APPENDIX A. OpenStack Command Reference ===
 +
 
 +
'''Purpose'''
 +
* Admin commands only
 +
* Describe command-line clients and their subcommands and required and optional parameters.
 +
* Write scripts to auto-generate command and command parameters from the code.
 +
* Use conditional tags to generate two versions of this book: One with admin commands, and one without.
 +
 
 +
 
 +
'''Outcome'''
 +
 
 +
Now auto-generated from code: https://review.openstack.org/#/c/69942/
 +
<br /><br />
 +
 
 +
'''Source  material'''
 +
 
 +
* [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]

Latest revision as of 20:01, 29 January 2014

Contents

Summary

This blueprint describes a plan to create documentation for OpenStack users. What is an OpenStack user? An OpenStack user performs tasks on an existing cloud. An OpenStack user might be someone who wants to list available resources, such as images and servers, and create and manage resources. Or an OpenStack user might be a budding OpenStack developer: Someone who wants to build web applications that run on a cloud.

This documentation will provide a conceptual overview of the OpenStack cloud, and it will enable users to authenticate, boot a server, list resources, such as instances, networks, volumes, and so on, delete resources, access a console for an instance, and configure VNC, among other tasks.

This documentation will provide a clear roadmap for users to interact with OpenStack clouds by using the dashboard and client commands and then progress to using the APIs through cURL commands or open SDKs.

The planned documentation includes:

Document Purpose
OpenStack End User Guide Introduces end users to cloud concepts, common tasks, and ways of interacting with the cloud.

Through examples, shows users how to perform tasks in an OpenStack cloud through:

  • the Horizon dashboard
  • the OpenStack command-line clients

In an appendix (or appendices), provides reference information that enables users to perform tasks through OpenStack command-line client commands.

OpenStack Admin User Guide Introduces admin users to administrative tasks, and ways of interacting with the cloud.

Through examples, shows admin users how to perform administrative tasks in an OpenStack cloud through:

  • the Horizon dashboard
  • the OpenStack command-line clients

Content will be shared between the two user guides.

These documents will be partially sourced from existing documentation, and will reduce redundancy and increase usability, clarity, and consistency.

This blueprint is related to Blueprint Restructure Documentation.

Blueprint - OpenStack End User Guide

Audience: End users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients. Also, developers who create applications on top of OpenStack by using the OpenStack APIs.

Roadmap: Users ramp up on cloud computing by using the Horizon dashboard and the OpenStack command-line clients. Then, they use the OpenStack APIs to create scalable applications.

Product info: Havana, 2013.1

Include common glossary? Yes

Purpose:

  • Explain OpenStack cloud concepts and describe how to use an OpenStack cloud.
  • Include command-line tools and credentials, how to use Horizon dashboard, and how to create images.

Source material:

CHAPTER 1: Overview

One-to-two paragraph description of the OpenStack cloud. Descriptions of the OpenStack projects. State the goals of the book - concepts, set-up, and tutorials.

SECTION 1: OpenStack Cloud Concepts

Describe the main concepts that a user needs to understand to use the cloud.

SECTION 2: How to Interact with an OpenStack Cloud

Describe ways you can interact with a cloud:

Horizon Dashboard

http://www.openstack.org/software/openstack-dashboard/

OpenStack Command-line Clients

Provide x-ref to OpenStack Command Reference. Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/novaclient.html

cURL Commands with Embedded API Calls

Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/curl.html

OpenStack APIs

Talk about ways to use the APIs – cURL? SDKs? Language bindings?

SECTION 3: Common User Tasks

  • Boot, list, and delete servers
  • List and delete images - point to new book about OpenStack Images for info about creating images
  • Load-balance xx
  • Create an isolated network
  • Access a console for an instance
  • Configure VNC
  • Create, attach, and detach a volume

SECTION 4: How to Use the Tutorials in this Guide

Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/ch_how_examples_work.html


Provide tutorials for various use cases. Use different methods in each tutorial so user gets an idea of what’s possible.

CHAPTER 2: OpenStack Dashboard TUTORIALS

Managing Images

Launching Instances

Configuring Access to the Instances

Managing Instances

Managing Volumes

CHAPTER 3: OpenStack command-line client TUTORIALS

OpenStack Commands—Overview

OpenStack RC File

Creating Images

Launching Instances

Configuring Access to the Instance

Run Your Wordpress Blog on Your Cloud

Method: nova client

  1. Install the nova client
  2. Set up a user
  3. Get images for your application servers
  4. Spin up server instances
  5. Install Wordpress and its dependencies.

Source from: http://docs.openstack.org/grizzly/openstack-compute/admin/content/running-elastic-web-app-cloud.html Provide pointers to installation information in Command Reference, and other books with more information

Store Large Photos or Videos in Your Cloud

Method: swift client and Cyberduck application

  1. Install swift client
  2. Set up secure access to OpenStack Object Storage
  3. Install and configuration Cyberduck to connect to OpenStack Object Storage
  4. Copy files to the cloud

Source from: http://docs.openstack.org/grizzly/openstack-object-storage/admin/content/storing-large-photos-or-videos-on-the-cloud.html

Create and Attach a Volume to Your Instance

Method: cinder and nova clients Use case? http://docs.openstack.org/grizzly/openstack-block-storage/admin/content/block_storage_overview.html#managing-volumes

Create an Isolated Network

Method: nova and quantum clients Use case? http://docs.openstack.org/grizzly/openstack-network/admin/content/basic_operations.html

APPENDIX A. OpenStack Command Reference

Purpose

  • Describe command-line clients and their subcommands and required and optional parameters.
  • Write scripts to auto-generate command and command parameters from the code.
  • Use conditional tags to generate two versions of this book: One with admin commands, and one without.



Source material

Outcome

Now auto-generated from code: https://review.openstack.org/#/c/69942/

Blueprint - OpenStack Admin User Guide

Audience: Admin users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients. Also, developers who create applications on top of OpenStack by using the OpenStack APIs.


Product info: Havana, 2013.1

Include common glossary? Yes

Purpose:

  • Explain admin tasks you can perform on an OpenStack cloud.
  • Include command-line tools and credentials, how to use Horizon dashboard, and how to create images.
  • Include Cloud application architecture diagram.

Source material:

CHAPTER 1: Overview

One-to-two paragraph description of the OpenStack cloud. Descriptions of the OpenStack projects. Architecture diagram with few sentences of explanation. State the goals of the book - concepts, set-up, and tutorials.

SECTION 1: OpenStack Cloud Concepts

Describe the main concepts that a user needs to understand to use the cloud.


SECTION 2: How to Interact with an OpenStack Cloud

Describe ways you can interact with a cloud:

Horizon Dashboard

http://www.openstack.org/software/openstack-dashboard/
Add brief description of each option (since quite a few of these, Aggregates and Hypervisors, won't be in the tutorials).

OpenStack Command-line Clients

Provide x-ref to OpenStack Command Reference. Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/novaclient.html

cURL Commands with Embedded API Calls

Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/curl.html

OpenStack APIs

Talk about ways to use the APIs – cURL? SDKs? Language bindings?

SECTION 3: Common Admin User Tasks

  • OpenStack RC File
  • Managing Projects and Users (including groups, domains, and roles)
  • Managing Images
  • Managing Flavors
  • Setting Quotas (including new Neutron quotas).
  • Migrating Servers
  • Managing Networks and Routers (even if we can't include howTos in this version, this task should probably be acknowledged)

SECTION 4: How to Use the Tutorials in this Guide

Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/ch_how_examples_work.html

Provide tutorials for various use cases. Use different methods in each tutorial so user gets an idea of what’s possible.

CHAPTER 2: OpenStack Dashboard Tutorials

Managing Projects and Users

Managing Images

Managing Flavors

Setting Quotas

Migrating Servers

Managing Networks and Routers

CHAPTER 3: OpenStack command-line client Tutorials

OpenStack RC File

Managing Projects and Users

Managing Images

Managing Flavors

Setting Quotas

Migrating Servers

Managing Networks and Routers

APPENDIX A. OpenStack Command Reference

Purpose

  • Admin commands only
  • Describe command-line clients and their subcommands and required and optional parameters.
  • Write scripts to auto-generate command and command parameters from the code.
  • Use conditional tags to generate two versions of this book: One with admin commands, and one without.


Outcome

Now auto-generated from code: https://review.openstack.org/#/c/69942/

Source material