There are TBD sections as well as large portions of
good information. This is iteration 1 of the guide, so
I suggest we merge this and work from there. I mean merge,
if this one passess peer review for the existing chapters.
Change-Id: I0fc184b9bca466ee3bd458db1641eca4a9e93738
Because of (probable) copy-pasting error Zabbix server section is twice
present in Index menu. Zabbix server deployment section is a part of Fuel
Infrastructure docs, so it shouldn't be visible on the topt level.
Closes-Bug: 1568880
Change-Id: I9966a33d150b3766fde18d248919433e13fe1616
Signed-off-by: Lesya Novaselskaya <onovaselskaya@mirantis.com>
The docs content are synced from fuel-web/docs before final
migration.
Implements: blueprints.launchpad.net/fuel/+spec/fuel-docs-migration
Change-Id: If9a03c29036a212568d573069488d4197913a226
This commit moves all the contents fromfuel-web/docs excluding api
docs. UML defenitions are temporary commented out
Change-Id: Id6b064a26f938ead76aef5dee64a0e1f27537e1e
* Add tox.ini, setup.cfg and setup.py to allow docs building
using tox and setuptools
* Set doc/build as an output dir in setup.cfg to allow doc
publishing by gate-fuel-docs-docs job
* Add '.tox' and '*egg' paths to exclude_patterns in conf.py
* Add stub index.rst with basic info and link to the web verstion
of the docs to fix building of manpages
* Add '.tox' dir to .gitignore
Change-Id: Iaec750d6035bd0e30c10a12142be35514df1fb15
Summary for Guides should be reworked
in 'how-to' format to provide better
search experience.
This commit also replaces a direct URL with
clickable 'YouTube channel' and turns software.
mirantis.com into clickable 'Mirantis website'.
Change-Id: Ic70c653b68d42a9d1062044d7a778afeb02fc17a
Closes-Bug: 1452195
This RST file will act as a landing page, forwarding
users to the required issues:
- development
- common installation instructions
- plugin-specific instructions
Related-Bug: 1447025
Change-Id: Ie26bed57b5d5150922cb7c7e36b288eb19b14734
Since Fuel 6.0 supports Pluggable architecture,
a separate Guide is created to describe the following:
* how to install a plugin
* example plugins
* how to create a plugin
* how plugin UI elements should look like
Links to plug-in-related CRs:
* Certification issue (to be posted to Plug-in DevGuide): https://review.openstack.org/#/c/140421/
* User Guide instructions for installing plug-ins: https://review.openstack.org/#/c/130506/
* Update Terminology articles https://review.openstack.org/#/c/140350/
Change-Id: I78668b7bdc0e1b4f09244146a789bb12c921100c
Closes-Bug: 1397889
This moves the "What is Mirantis OpenStack" information from
the Release Notes to the index.rst file; it plays out as three
items in the main panel of the docs landing page,
all of which are links to articles in the Terminology Reference
with a brief bit of supporting text.
The information is similar to what was in the Release Notes
but I made a few modifications to merge info with existing
info in the Terminology Guide.
The terminology/fuel.rst article now has a paragraph about
plug-ins. This needs links to the developer and user docs
after that is merged.
Change-Id: Ib3721d72f2630d139448405ecd0b2977b371a2ba
This commit includes changes to the infrastructure files
and a draft of the "Intro" page for the doc plus some skeletal
pages for review. It also includes a README.md file with
instructions for creating a new page and template files that
can be copied to begin a new page.
See https://blueprints.launchpad.net/fuel/+spec/config-file-reference
for more information.
Change-Id: I660ddc28acb4da70e62a5cfe85ec91d0e213c07d
I restructured the Release Notes to more closely match
the style of the Community Release Notes: instead of having
long lists of all resolved issues and known issues, the issues
are grouped by topic and include links to the Community Release
Notes for each component (if any) and list of new features and
resolved issues as well as known issues.
I then divided the 5.1 Known Issues up by these sections, since
most of these issues will be either Resolved or Known Issues for
6.0 and it gives us a chance to see how this might all play out.
The Component Versions (nee "Supported Software") is moved to the
Release Notes from the Planning Guide.
Also created the terminology/juno article stub.
Also includes updates to the infrastructure files to produce 6.0
documentation.
Change-Id: Iff9571d0de11d78dd66a259ea485afec9a237649
Additional cleanups:
* Removed duplicated explanation of Ceilometer
performance considerations for MongoDB database backend from the
terminology page and left it in the user guide where it belongs.
* pt_archiver code fragment width reduced to fit inside page margins in
PDF.
* toctree and preface removed from pdf_relnotes.rst.
Release notes are left referring 5.0.1, that will have to be addressed
in a separate commit.
Change-Id: Ife0d774c54c603a9eb8881649bf7cbdd8345e67d
index.rst -- fixed "Pre-Installation" string and modified description
so it doesn't say "you must execute" for the Planning Guide.
pre-install
- 0010-intro -- moved virtualbox piece to end; small edits
- 4000-planning-summary - small edit, deleted "Prepare logical network
diagram" line since we have no info for that
- 4200-net-topology -- fixed typos
- 4300-linux-distro -- added link to "VLAN splinters" in user-guide
- 4400-nodes-roles
- added link to "Assigning nodes to roles" in user-guide
- fixed bad link to virtualbox-top
- reworded lead in to larger list of nodes
- augmented note about not running Ceph OSD on controllers with
a note to not run Ceph OSD and Ceph Mon on same storage node.
ref-arch
- storage/0000-storage-intro had tag with _; changed to -
- logical-setup/0400-storage-nodes linked to the tag in storage/0000-*
so I fixed that. Found a couple typos in the file so fixed those
and added links to Ceph, Cinder, and Swift articles in terminology.
terminology
- bonding -- links to ovs, user guide instructions
- ceilometer -- link to mongodb article
- ceph -- added info about Ceph Mon and Ceph OSD not running on same server
- compute nodes -- link to ref-arch section
user-guide
- 2000-deploy-new -- added info about remote control utility in response
to Miroslav comment https://review.openstack.org/#/c/95386.
- " " -- added link to vcenter-term on Hypervisor page
Note that the number of PDF build errors has escalated significantly.
This is also the case for Jenkins builds done last night and this morning.
I think it is related to issues with xrefs to titles. I will continue
to investigate.
Change-Id: Iceecab3fee095b8eb5d1b9139c6faa8faa5f7fad
This replaces 94510
Changes for new intro:
- pre-install -- 0010-intro text is replaced with new material
- user-guide -- 0000-intro text is replaced with new material
- install-guide -- deleted 0000-intro-header and the contents of
the 0000-intro subdirectory (they were deleted in 94510 because
they are no longer needed)
This also pulls install-guide out of the build. This is necessary
to make the 5.0 release and is not a permanent change so unused
files such as those in the contents/ and pdf/ directories have
not been removed:
- contents.rst
- index.rst
- install-guide.rst
- pdf/conf.py -- had to delete the install-guide line
Modified some top-level *.rst files trying to resolve build and
xref issues -- some of these tags had _ rather than - which causes
problems.
Change-Id: I9ab382034caf2ecb7aaa9c552d10552e97be89cf
I started with the "Preparing the MOS Deployment" table
The hardware setup steps have been moved to the Install Guide in another CM
Added a few issues that were not spelled out
Set up separate sections to hold the discussions for each issue.
"Network Topologies" cross-references architectural information in ref-arch
* Andrey Danin provided the "advice"
* Restructuring the network docs became necessary to make this work. To whit:
For Neutron, various structural modifications were required;
no substantive content modifications were made
* Added a couple headers and tags to ref-arch for Neutron topologies
* Deleted files from pre-install/0051-network-plan/topology:
* 0710-neutron-topologies.rst -- header only, no longer required
* 0720-neutron-vlan.rst -- duplicates info in ref-arch/neutron-intro/\
0210-vlan.rst; this had a couple sentences at the end that weren't in
ref-arch so I moved those over
* 0730-neutron-gre.rst -- duplicates info in ref-arch/neutron-intro/\
0220-gre.rst; this had a couple sentences at the end that weren't in
ref-arch so I moved those over
* 0760-neutron-vlan-plan.rst and 0780-neutron-gre-plan.rst were pulled
into ref-arch/0260-neutron-config.rst. Yes, this leaves one file with
three headers in it but, when we deal with the content, these pieces
need to be considered together
* pre-install/0051-network-plan/topology/0700-neutron.rst just sourced the
above files so is deleted
For Nova, moved the nova-network topology info from pre-install to ref-arch
to parallel the Neutron section we set up there.
* The following files from pre-installation/0051-network-plan/topology/nova
are now in reference-architecture/nova-intro and sourced from the
6070-nova-topologies.rst file in reference-architecture. Section titles
are also modified to include "Nova-network" to improve readability:
- 0620-nova-flat-dhcp.rst
- 0630-nova-vlan.rst
- 0659-nova-net-plan.rst
- 0660-nova-plan-flatdhcp.rst
- 0680-plan-vlan.rst
- [ignore 0650-nova-assign-networks-to-nics.rst -- it is going to User Guide]
* Other files from this directory are disposed of as follows:
- 0610-nova-topologies -- sourced ino ref-arch/6070-nova-topologies.rst
(top file of nova section in ref-arch)
- 0650-nova-assign-networks-to-nics.rst -- material is obsolete and done
better in other files now included in user-guide.
* The following files from pre-install/0051-network-plan/0100-netconfig-options are deleted:
- 0100-netconfig-options (header/intro info no longer needed)
- 0110- (info pulled into
- 0200 - sourced files below it that are moved and sourced elsewhere
The same sections that discussed the topologies had information about
routers and switches. I'm not exactly sure where the best place is
for this but, for now, I'm putting it in ref-arch right after the write-up
about Public and Floating IPs. Alas, that is in a different commit, and
that other commit creates a sub-directory where these files should go.
So, for now, I created two files in the main ref-arch directory; I will
move these into the proper place after everything is merged.
* 6030-router is based on install-guide/0070-networks/350-router.rst,
with content also pulled in from pre-install/0051-network-plan/topology/\
0900-routing-req.rst. I did some rewriting but the content is unchanged.
This includes a bunch of Fuel screen shots that I think are superfluous
but I need to compare them to the rewritten User Guide; I may need to do
some moving or xref'ing of information.
* 6034-switch.rst is renamed from install-guide/0070-networks/
300-switch-config.rst. I did a bit of editing but the content is
unchanged.
* I had to tag the files with sample switch configurations so I could
link to them. I also prefaced each of those titles with either "Nova-network"
or "Neutron".
* After the above, the following files are deleted:
* pre-install/0051-network-plan/topology/0900-routing-req (included in
new routing document)
* pre-install/0051-network-plan/0200-topology-include.rst -- included files
that are deleted or moved
* pre-install/0051-network-plan.rst -- included files that are deleted
or moved
ref-arch/0030-cluster-sizing.rst is deleted; its content was pulled into
pre-install/nodes-roles.rst. I added a bit of intro material; the substantive
content is unchanged.
pages/pre-install-guide/4000-plan0summary.rst was a bogus file; is deleted
At Patch 6, I deleted the screen shots from 0060-quick-start-instart-fuel;
this info doesn't belong here anyhow. I also right-aligned the diagrams in
the Examples and fixed the header levels for the examples at the end of the
document.
Change-Id: Ia4e68200bea2166d48d7691f80cc921459a337ff
I did a wee bit of wordsmithing but the content is unchanged.
A section that used to be in the FAQ duplicated instructions to select
promiscuous mode, which is in the main instructions, so I deleted it.
Change-Id: I1d8e10f7c2ef37069d1c55c7b2b18368b39a8c31
List of major releases is removed from preface.rst: the intention of this table
is to track revisions of documentation for the current major release.
Change-Id: If0d87ccfdcb9b312174a6e1ddeefa03dd38f253f
Note that this document needs a lot of xrefs added and it includes
some xrefs that aren't in the prefered :ref: format. These will be
resolved but I don't want to pull all the docs that need tags into
this commit so will do that separately.
Change-Id: I35974a294f947f12106c7943e0c89df6c86347ad
Andreas Jaeger