[Openstack-docs] Target audience

Randy_Perryman at Dell.com Randy_Perryman at Dell.com
Mon May 19 21:43:20 UTC 2014


Hi,

I like your breakdown.  I propose a little more granular proposal on the Operations side.  Breaking them down to Operations, Installation and Security :


Operations Guide
Cloud Administrator Guide 
Admin User Guide

This guide is targeted for the day to day operations of an OpenStack cloud system
------------------------ 
Configuration Reference
HA Guide
Install Guide

These guides target cloud administrators who sets up an OpenStack cloud and configures the OpenStack services.
------------------------ 
Security Guide

This guide is targeted for the Security Administrator of a cloud team and can be referenced to harden existing OpenStack deployments or to evaluate the security controls of OpenStack cloud providers.

------------------------
-Randy


P.S. I opened a bug - HA guide does not have an abstract.



-----Original Message-----
From: Andreas Jaeger [mailto:aj at suse.com] 
Sent: Monday, May 19, 2014 4:41 PM
To: openstack-docs at lists.openstack.org
Subject: [Openstack-docs] Target audience

We had some discussion about target audience for each guide at the OpenStack summit and Anne filed this bug:
https://bugs.launchpad.net/openstack-manuals/+bug/1319394 . As a first step, I've went over all guides and categorized them according to target audience and then copied all the current abstracts together. Is the following accurate?

Andreas

Overview of personas/target audience:

Operations Guide
Cloud Administrator Guide
Configuration Reference
HA Guide
Install Guide
Security Guide
Admin User Guide

These guides target cloud administrators who sets up an OpenStack cloud and configures the OpenStack services.

End User Guide
Image Guide

These guide targets users using an OpenStack cloud.

CLI Reference

This guide targets both cloud administrators and users using an OpenStack cloud.

Not covered personas:

Developer writing applications running in an OpenStack Cloud.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Detailed information - copy of current abstract:

Install Guide

The OpenStack® system consists of several key projects that you install separately but that work together depending on your cloud needs. These projects include Compute, Identity Service, Networking, Image Service, Block Storage, Object Storage, Telemetry, Orchestration, and Database. You can install any of these projects separately and configure them stand-alone or as connected entities. This guide shows you how to install OpenStack by using packages on openSUSE through the Open Build Service Cloud repository. Explanations of configuration options and sample configuration files are included.


Operations Guide

This book provides information about designing and operating OpenStack clouds.

Cloud Administrator Guide

OpenStack offers open source software for cloud administrators to manage and troubleshoot an OpenStack cloud.

Configuration Reference

This document is for system administrators who want to look up configuration options. It contains lists of configuration options available with OpenStack and uses auto-generation to generate options and the descriptions from the code for each project. It includes sample configuration files.

HA Guide

No abstract given.

Security Guide

This book provides best practices and conceptual information about securing an OpenStack cloud.

Admin User Guide

OpenStack is an open source cloud computing platform for public and private clouds. A series of interrelated projects deliver a cloud infrastructure solution. This guide shows OpenStack admin users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard or OpenStack client commands.


End User Guide

OpenStack is an open-source cloud computing platform for public and private clouds. A series of interrelated projects deliver a cloud infrastructure solution. This guide shows OpenStack end users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.

Image Guide

This guide describes how to obtain, create, and modify virtual machine images that are compatible with OpenStack.

CLI Reference

This guide documents the OpenStack command-line clients.

--
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126

_______________________________________________
Openstack-docs mailing list
Openstack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs



More information about the Openstack-docs mailing list