Operator Contrib Guide Expansion
There are a lot of operator guides that aren't mentioned in the current state of the operator guide. This patch adds those guides and does some reorganization to give things a better flow. Change-Id: I7c2713cbe59ba3f25adec60b0229d3c974950713 Story: 2003117 Task: 26368
This commit is contained in:
Kendall Nelson
parent
1ddee6b2a0
commit
718d3679a8
|
|
@ -14,6 +14,8 @@ This section allows you to:
|
|||
* Understand the differences between the different in-person OpenStack events
|
||||
* Know which events are valuable to you
|
||||
|
||||
.. _summit:
|
||||
|
||||
Open Infrastructure Summit
|
||||
--------------------------
|
||||
|
||||
|
|
@ -43,6 +45,8 @@ propose sessions for the upcoming event. After the CFP deadline the proposals
|
|||
go through a community vote after which a group of track chairs decide about
|
||||
the final content for each track.
|
||||
|
||||
.. _events-forum:
|
||||
|
||||
Forum
|
||||
+++++
|
||||
|
||||
|
|
@ -117,3 +121,12 @@ few hours long with a few presentations, discussion topics and some snacks.
|
|||
|
||||
Look for `meetups in your area <http://meetup.com/pro/osf>`_ and if you
|
||||
cannot find one you are welcome to organize one yourself!
|
||||
|
||||
Operators Meetup
|
||||
-------------------
|
||||
|
||||
Aside from the Forum, the other operator focused event is the operator
|
||||
meetup. You can read general information about it here :ref:`ops-meetup`.
|
||||
It's organized by the operator community biannually in locations all over
|
||||
the world.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,12 +7,13 @@ Operators' Contributor Guide
|
|||
:maxdepth: 2
|
||||
|
||||
/operators/introduction
|
||||
/operators/participate
|
||||
/common/communication
|
||||
/common/irc
|
||||
/common/accounts
|
||||
/common/communication
|
||||
/common/events
|
||||
/common/git
|
||||
/common/setup-gerrit
|
||||
/operators/participate
|
||||
/common/governance
|
||||
/common/releases
|
||||
/operators/resources
|
||||
|
|
|
|||
|
|
@ -4,13 +4,19 @@ Participating
|
|||
|
||||
Mailing List
|
||||
=============
|
||||
Operators have used a dedicated mailing list until November 2018. You
|
||||
Operators had previously used a dedicated mailing list until November 2018. You
|
||||
can read the `openstack.operators archive
|
||||
<http://lists.openstack.org/pipermail/openstack-operators/>`_
|
||||
which contain plenty of valuable information.
|
||||
Currently there is a `joint mailing list
|
||||
which contains plenty of valuable information.
|
||||
|
||||
To unify our community, we have replaced the operator and developer
|
||||
specific mailing lists with a `joint mailing list
|
||||
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>`_
|
||||
for developer and operator to subscribe.
|
||||
for developers and operators to subscribe to and converse on together.
|
||||
|
||||
.. note::
|
||||
To get more operator attention, prepend '[ops]' to your email subject lines.
|
||||
|
||||
More generic information about mailing lists can be found in the Communication
|
||||
page's :ref:`communication-mailing-lists` section.
|
||||
|
||||
|
|
@ -19,9 +25,15 @@ IRC Channels
|
|||
There is the #openstack-operators channel on Freenode IRC for live
|
||||
conversations and `Operators' team meeting
|
||||
<http://eavesdrop.openstack.org/#OpenStack_OSOps_Team>`_.
|
||||
On top of the #openstack-operators channel there are several others. More
|
||||
generic information about IRC channels can be found in the :ref:`irc-channels`
|
||||
section of the IRC page.
|
||||
On top of the #openstack-operators channel there are many others that you
|
||||
might find useful. More generic information about IRC channels can be found
|
||||
in the :ref:`irc-channels` section of the IRC page.
|
||||
|
||||
In the :ref:`setup-irc` section of this guide, there are instructions on how
|
||||
to setup a desktop client and register your irc nickname so that you can
|
||||
join these channels.
|
||||
|
||||
.. _ops-meetup:
|
||||
|
||||
Meet Ups
|
||||
========
|
||||
|
|
@ -36,10 +48,5 @@ with only a small number of presentations, with the following aims:
|
|||
interested parties
|
||||
3. Increase constructive, proactive involvement from those running clouds
|
||||
|
||||
Share and Learn From Real Configurations
|
||||
========================================
|
||||
Example configurations for various OpenStack services are provided in the `openstack/osops-example-configs
|
||||
repository
|
||||
<https://opendev.org/x/osops-example-configs/src/README.md>`_.
|
||||
Operators can share their configuration files to help others, and review how
|
||||
others setup and tune their configurations.
|
||||
There are other events relevant to operators besides just the meetup,
|
||||
:ref:`events-forum` and the rest of the :ref:`summit`
|
||||
|
|
|
|||
|
|
@ -0,0 +1,52 @@
|
|||
##########
|
||||
Resources
|
||||
##########
|
||||
|
||||
There are many resources available to operators. Some are maintained by the
|
||||
operator community while others are maintained by the upstream developers.
|
||||
Below are brief descriptions of guides to hopefully help you get to the
|
||||
information you need quicker!
|
||||
|
||||
.. note::
|
||||
If you find any issues with the guides, please file a bug! Better yet, fix the bug!
|
||||
On each page of the documentation there is a link in the top right corner to
|
||||
the place bugs are filed (could be Launchpad or StoryBoard depending on the
|
||||
repository).
|
||||
|
||||
The order the guides are presented in is the typical order they are needed in,
|
||||
but of course you should feel free to explore them in any order you like.
|
||||
|
||||
Architecture Guides
|
||||
=====================
|
||||
`The Architecture Guide <https://docs.openstack.org/arch-design/>`_ provides
|
||||
basic information about designing an OpenStack cloud. This guide discusses the
|
||||
basiscs, common use cases, and architecture design requirements.
|
||||
|
||||
Virtual Machine Image Guides
|
||||
=================================
|
||||
`The VM Image Guide <https://docs.openstack.org/image-guide/>`_ explains how
|
||||
to 'obtain, create and modify vm images that are compatible with OpenStack.'
|
||||
|
||||
Operations Guide
|
||||
================
|
||||
`The Operations Guide <https://docs.openstack.org/arch-design/>`_ is
|
||||
generally focused on what happens after day 1 of spinning up an
|
||||
OpenStack Cloud. It offers some basic setup infromation, but the
|
||||
majority of the content is about maintenence, troubleshooting, user
|
||||
facing capabilities, and scaling.
|
||||
|
||||
Security Guide
|
||||
===============
|
||||
`The Security Guide <https://docs.openstack.org/security-guide/>`_ provides information about ways
|
||||
to keep your cloud secure. It covers everything from identity and secrets
|
||||
management to per service security options (compute, networking, storage,
|
||||
messaging, etc)
|
||||
|
||||
Share and Learn From Real Configurations
|
||||
========================================
|
||||
Example configurations for various OpenStack services are provided in the
|
||||
`openstack/osops-example-configs repository
|
||||
<https://git.openstack.org/cgit/openstack/osops-example-configs/tree/README.md>`_.
|
||||
Operators can share their configuration files to help others, and review
|
||||
how others setup and tune their configurations.
|
||||
|
||||
Loading…
Reference in New Issue