openstack-manuals/doc/common/ch_using_openstack_overview.xml
Anne Gentle ab6b5f6b2f Adds a paragraph about the intended audience
- For each audience, end user and admin user, add
a paragraph in the first section about who the book
is intended for.
- Also edited Conventions and Doc History sections

Change-Id: I89fdbd9b62515357e434b7a27cc26455e1541efc
2014-07-19 09:05:50 -05:00

57 lines
3.6 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="openstack_user_guide">
<title>How can I <phrase audience="enduser">use</phrase><phrase
audience="adminuser">administer</phrase> an OpenStack
cloud?</title>
<?dbhtml stop-chunking?>
<para audience="enduser">As an OpenStack cloud end user, you can provision your own resources
within the limits set by administrators.</para>
<para audience="adminuser">As an OpenStack cloud administrative user, you can manage tenants,
known as <glossterm baseform="project">projects</glossterm>, users, services, images,
flavors, and quotas.</para>
<para>The examples in this guide show you how to perform tasks by using the following
methods:</para>
<itemizedlist>
<listitem>
<para>OpenStack dashboard. Use this web-based graphical interface, code named <link
xlink:href="https://github.com/openstack/horizon/">horizon</link>, to view,
create, and manage resources<phrase audience="adminuser"> and
services</phrase>.</para>
</listitem>
<listitem>
<para>OpenStack command-line clients. Each core OpenStack project has a command-line
client that you can use to run simple commands to view, create, and manage
resources<phrase audience="adminuser"> and services</phrase> in a cloud and
automate tasks by using scripts.</para>
</listitem>
</itemizedlist>
<para>You can modify these examples for your specific use cases.</para>
<para>In addition to these ways of interacting with a cloud, you can access the OpenStack APIs
directly or indirectly through <link xlink:href="http://curl.haxx.se/">cURL</link> commands
or open SDKs. You can automate access or build tools to manage resources and services by
using the native OpenStack APIs or the EC2 compatibility API.</para>
<para>To use the OpenStack APIs, it helps to be familiar with HTTP/1.1, RESTful web services,
the OpenStack services, and JSON or XML data serialization formats.</para>
<section xml:id="audience">
<title>Who should read this book?</title>
<para audience="enduser">This book is written for anyone who uses virtual machines and cloud
resources to develop software or perform research. You should have years of experience
with Linux-based tool sets and be comfortable using both GUI and CLI based tools. While
this book includes some information about using Python to create and manage cloud
resources, Python knowledge is not a pre-requisite for reading this book.</para>
<para audience="adminuser">This book is written for administrators who maintain and secure
an OpenStack cloud installation to serve end users' needs. You should have years of
experience with Linux-based tools for system administration. You should also be familiar
with OpenStack basics, such as managing projects and users, troubleshooting, performing
backup and recovery, and monitoring. For more information, see the <link
xlink:href="http://docs.openstack.org/ops"><citetitle>OpenStack Operations
Guide</citetitle></link>.</para>
</section>
<xi:include href="../common/section_conventions.xml"/>
<xi:include href="../common/section_dochistory.xml"/>
</preface>