To align AIO Simplex and Duplex deployment and installation guide content,
we are moving common sections to separate files and including them as
external document fragments:
- Uninstalling Deleting OpenStack
- Bring down OpenStack Services
- Delete OpenStack application definition
- Horizon Access
- Platform Horizon
- Containerized OpenStack Horizon
Filename and section name were rename from
additional_setup_instructions
to
uninstalling_deleting_openstack
Change-Id: I2c73153f55ddfead75c76cac6a42bfed409b9343
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Removed old deploy_guides and installation_guide folders and leftover pages as
followup to consolidation of deployment and installation guides into
deploy_install_guides.
Change-Id: I5d1d0abb4e75ef8fadf439aa7b4572831d9e469e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Updated links in index to use toctrees so that Sphinx can resolve URLs correctly.
- Moved docs linked from new Installation and Deployment Guides page into same
deploy_install_guides folder.
- Updated broken links resulting from file moves.
- Removed extra folders for consistency between versions.
- Updated a couple page titles to use new R2.0 version convention.
Change-Id: Ib57a79d27411e2818569e0ded87fa393dff10075
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* Amended to make punctuation consistent.
I have re-organized the main TOC so that the new
combined install/deploy manuals comes after the StarlingX
introduction. I have hidden (for now) the older install
and deploy manuals.
Finally, I have updated the landing pages for the install/
deploy guides and the operation guides to an agreed upon
format that separates out latest, upcoming, and archived
releases.
Change-Id: Ia18f0438152d6cb1fa7ae3e9712eb3df8f5a2862
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Use a working clone URL for the tools Git repository in the AIO
duplex install guide, matching the one used in the simplex guide.
Change-Id: Id98367dcec4e8f1a82bb76adb8f4cde6fa001764
I have modified the docs repo such that the landing pages
for original installation guides and deployment guides now
list the merged deploy_install_guides AIO-SX and AIO-DX
manuals instead of the older ones that are being replaced.
Links on the landing pages at this point for the original
controller_storage deployment guide and for the original
"blanket" installation manual still exist. The reason I
left the one for the "blanket" installation guide is because
if someone clicks on that, there exists further links to
deployment information (guides) at the bottom. Those links
have been modified to point to the AIO-SX and AIO-DX
deploy_install_guides. The link for the controller_storage
deployment manual still goes to the original.
Once we get remaining combo manuals merged, we can further
modify these landing pages to where we eventually do not
have any manuals in the installation guides and
deployment guides area.
Change-Id: I7b436226c307b9bc803cc14d48712fb92c39975a
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Add the initial content for the Deployment options doc. This content is
a mildly reformated version of the same concept from the Intro/concepts.rst
document. I have added a bit more guidance as to which option to select
and why it is important.
Change-Id: If02c70e62eaedbf8692d10cb89884d30f7e72d14
Story: 2005006
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
Draft of the combined deployment and installation
instructions for the AIO-DX StarlingX configuration.
Applied review comments from Tee Ngo and Al Bailey.
Changed "tailf" to "tail -f" per Al Bailey review.
I placed new/updated information from the AIO-DX wiki that
was updated by Tee Ngo.
I addressed Bart Wensley and Bob Churches comments.
* Leaving section on "Set Ceph pool replication" for now.
* Removed section on "Providernetworking setup (pre-Stein).
* Removed the note in the "Providernetworking setup:
Network Segment Ranges (Stein)" section.
* Removed the "Bring Down Services" section.
Patch 13: Removed the "Set Ceph pool replication" section.
Also, removed "Stein" per Al Bailey.
Change-Id: I196b2a309257b4fa8b8cceb079bbaadcd97a9257
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
I replaced the configuration process that used config_controller
with the Ansible bootstrap playbook method.
Change-Id: I978194eb45428258c940f38281962856bda2cb64
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
This change is the first round of new documents and cleanup of
the "StarlingX" Introduction section of the documentation.
* Created a new "Product Introduction" document.
* Added a new "Consuming StarlingX" document.
* Added a new "Key Concepts" document.
* And cleaned up some of the other document names to make them
fit in the TOC text box.
Story: 2005002
Change-Id: Ibe2023028c749a18fd83e610519350cf9058127d
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
The repo has been renamed to "tools". I have removed all
occurrences of "stx-tools". This addresses one of Erich
Cordoba's review comments.
Change-Id: Ia613a72b6438d4944feab2d5f6880e9f62198b7d
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
First draft of the combined deployment and installation
instructions for the AIO-SX StarlingX configuration.
Change-Id: Ib5bb6753aa1ed384c87e44b3c4d88945f2ed187a
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Edits to try and conform to OpenStack writing standards.
I corrected all areas of the files.
Change-Id: Ibf360d19d25ee91cb0071e14dbec719ce4a50ec1
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
There are code changes in progress to change the default
controller login from wrsroot to sysadmin. This change
updates the documentation to reflect the code change.
Depends-on: 1887464a20fc17d66529caea03be2b445156f9426
Story: 2004716
Task: 30928
Change-Id: I4521a3fd3b1a47264412910ea9e6ef0c03f82588
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
I find that in workshops dealing with end users they are often
slightly confused with the information in the current docs around
what kind of resources they might need to run a virtual machine
based AIO-SX mode. This commit is just an attempt to alleviate
some concerns when they see hardware requirements like 64GB or
32GB, etc.
Change-Id: I45d851f853811596ec4c10a4c67584fd80219937
Signed-off-by: curtis <curtis@serverascode.com>
Changes included updating the StarlingX docs landing
page to conform to a new list of available documents
as follows:
* StarlingX Introduction
* Deployment Guides
* Installation Guides
* Developer resources
* Operation Guides
* Project Specifications
* REST API Reference
* Release Notes
* Contribute
So-called "dead-end" links have an explanation of content
coming. Any destination associated with an existing story
ID have the link to the story for reference.
The existence of a "current" and "latest" Developer
Guides resulted in the top-level list of doc resources
including both the "Developer Guides" and
"Developer Resources" bullets. Ideally, the Developer
Guides would be included as part of the "Developer
Resources" area. For "latest" they are. However, for
"current" I left them alone since the 2018.10 release
is out there. This organization can settle out as more
releases launch.
Finally, I did not focus on the writing aspect for this
PR. That part can be cleaned up going forward.
Change-Id: I0442e948d5d9a41add9eb3bdde8882c157a8f752
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.
This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.
This update should result in no functional change.
For more information see the thread at
http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html
Change-Id: I2c959c9a214f85f3b355938bd7c9683629061542
The "2018.10" tag was removed from Download source code
since this has to use master manifest.
From current/index.rst file, the suggestion to use master
manifest was removed due to this is covered in the other
guide.
Depends-on: https://review.openstack.org/#/c/643631
Change-Id: I3cd0e984368a8ed79bb3227978f3fc795dcf8273
Signed-off-by: Hayde Martinez <hayde.martinez.landa@intel.com>
These changes implement the versioning scheme for
Installation and Developer Guides for StarlingX.
These guides are release-specific. Consequently, we
need to make archived, current, and latest versions
of the manuals available as StarlingX releases evolve.
We implemented a two-fold directory structure to keep
the "current" and "latest" versions of the manuals in
the forefront. "Current" indicates the newest,
officially released version. "Latest" indicates the
current+1 release (i.e. the release under development).
Aside from "current" and "latest", the list of archived
versions will grow by one with each release.
Changes involved the following:
* Establishing "current" and "latest" directories
from what existed.
* Updating of intro material and links to be appropriate
for either "current" or "latest".
* Update of the writer instructions for adding a new
release of the install and developer manuals.
material to reflect the folder's new name.
*
Change-Id: I37eee44c31202ac391deebec3348f1e305dbd5ab
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
For both installation and developer guides:
- Move 2018_10 into versioned sub folder
- Add latest version (copy of 2018_10) to latest folder (to be updated for next release)
- Update intro to each versioned guide
- Update relative links (version specific) for each version
- Update all references to version, to use standard format of stx.Year.Mo
- Cleaned up headings to use sentence casing per OpenStack guidelines
- Cleaned up capitalization: standardize capitalization for terms, only capitalize official
names/terms, casing consistent with command line examples
Change-Id: Id5fd0a78a1d81fdf8c63d132f2d4c50f9ed2f2bf
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Changed value for environment variable MYUNAME
on localrc example file due to old "$USER" reference
takes different values when used in host and when
used inside build container.
Change-Id: Iedcf4edd5ef6dd919757d8f5315a01b0bbfea70d
Signed-off-by: Hayde Martinez <hayde.martinez.landa@intel.com>
The four links in the "Deployment Options" section of the
StarlingX Installation Guide point to "not quite ready"
instructions for simplex, duplex, cloud with controller
storage, and cloud with dedicated storage. I have created
a NOTE at the beginning of these four sections so the reader
can be routed to the wiki instructions, which are up to date.
Change-Id: I42c67d0e4e1f60021abcc3273c71c5b8f1d37568
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
We need a diagram, description of major components and
why-I-would-use-this for each Deployment option:
- Dedicated Storage Deployment Diagram
- Dedicated Storage Deployment Description
Story: 2004780
Task: 29566
Depends-On: https://review.openstack.org/#/c/634080
Change-Id: If95246df7df6597512bfc2d17062810a65c5d860
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
We need a diagram, description of major components and
why-I-would-use-this for each Deployment option:
- Controller Storage Deployment Diagram
- Controller Storage Deployment Description
Story: 2004780
Task: 29565
Depends-On: https://review.openstack.org/#/c/634080
Change-Id: Id2a18e253a7371c9fedd38326719f21664696773
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
We need a diagram, description of major components and
why-I-would-use-this for each Deployment option:
- Simplex Deployment Diagram
- Simplex Deployment Description
Story: 2004780
Task: 29219
Depends-On: https://review.openstack.org/#/c/634080
Change-Id: Ib1076f904150ce5cec054e2b187c7f9224eb1909
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
We need a diagram, description of major components and
why-I-would-use-this for each Deployment option:
- Terminology allows to have a common understanding of
StarlingX deployment diagrams and descriptions.
- Added as a definition list
Story: 2004780
Task: 29218
Change-Id: Iece7c33ac6aecf9690658e1763da1e6e4acfd311
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
API Reference content has been added for stx-update:
- Add link and pages for API Ref and main page.
The project-specific docs are published independently so we need
to maintain the links into those subtrees, for the api-ref (/api-ref/stx-*).
This change was introduced and then reverted due to this abandoned
commit:
https://review.openstack.org/#/c/605278/
Reason was a confussion during the split of old API into the new
API scheme.
Depends-On: https://review.openstack.org/#/c/634994/
Change-Id: I3a4bd5e98cf7077cf4c3abe037d1a0f6d8c69fcf
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
