From 718d3679a82d121329bb34edea69e96782f4011b Mon Sep 17 00:00:00 2001 From: Kendall Nelson Date: Tue, 16 Apr 2019 18:15:56 -0700 Subject: [PATCH] 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 --- doc/source/common/events.rst | 13 +++++++ doc/source/operators/index.rst | 5 +-- doc/source/operators/participate.rst | 35 +++++++++++-------- doc/source/operators/resources.rst | 52 ++++++++++++++++++++++++++++ 4 files changed, 89 insertions(+), 16 deletions(-) create mode 100644 doc/source/operators/resources.rst diff --git a/doc/source/common/events.rst b/doc/source/common/events.rst index d67047b..78cc63f 100644 --- a/doc/source/common/events.rst +++ b/doc/source/common/events.rst @@ -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 `_ 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. + diff --git a/doc/source/operators/index.rst b/doc/source/operators/index.rst index 7b1a224..3bc2073 100644 --- a/doc/source/operators/index.rst +++ b/doc/source/operators/index.rst @@ -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 diff --git a/doc/source/operators/participate.rst b/doc/source/operators/participate.rst index cc932a4..8e0f4b3 100644 --- a/doc/source/operators/participate.rst +++ b/doc/source/operators/participate.rst @@ -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 `_ -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 `_ -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 `_. -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 -`_. -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` diff --git a/doc/source/operators/resources.rst b/doc/source/operators/resources.rst new file mode 100644 index 0000000..97bcb36 --- /dev/null +++ b/doc/source/operators/resources.rst @@ -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 `_ 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 `_ explains how +to 'obtain, create and modify vm images that are compatible with OpenStack.' + +Operations Guide +================ +`The Operations Guide `_ 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 `_ 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 +`_. +Operators can share their configuration files to help others, and review +how others setup and tune their configurations. +