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>
Removed duplicate entry in conf.py for version and release
variables. Set both version and release to empty string, so
that the string above left nav renders only the project name.
Story: 2004900
Task: 29220
Change-Id: I7dbbbd78dc33841baec32ef1d48a5ab3dc1fd860
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Remove static search reference from REST API reference page until
such time as it is needed in the stx-docs repo. Static search will
search only the repo, and not other reps (which may be misleading).
Change-Id: If0fb4468cdbc88eced379573378c849a61836d4b
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
"Mad" is a legacy name used for StarlingX deployments, let's change
to "Stx".
Story: 2004794
Task: 29033
Depends-On: https://review.openstack.org/#/c/612826
Change-Id: I6aa98d86c6929d453f351ad9ccc5bf0bf83385fe
Co-authored-by: Saul Wold <sgw@linux.intel.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Include ISO image location at CENGN’s StarlingX mirror.
Change-Id: I455494f15b1cc3a722c0623c031b5ccc35b40581
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Up to 4x Compute Nodes can be added the the AIO-Duplex Deployment:
- Limited to 4x Compute Nodes as the Controller Function on the AIO
Controllers has only a portion of the processing power of the
overall server.
- Virtual machines can be scheduled on either of the AIO Controller Nodes
and/or the Compute Nodes.
- Allows a capacity growth path for someone starting with an AIO-Duplex
deployment.
Note. "Compute" personality is still referenced due to upcoming changes how
versioning is handle at documentation level, once the implementation is in
place, personality will be modified to "Worker".
Story: 2004780
Task: 28913
Change-Id: I50526dea07ec34f1d01bfbb4cbed34ba2f2366fd
Co-authored-by: Greg Waines <greg.waines@windriver.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
The current building process involves a serie of steps that can be simplified
in order to do the process/experience more user friendly for our end users:
- Unification of Docker files into one allows to build base container via a
single make call.
- Remove the copy of git configuration file since it will be generated.
Based on the unification to one Dockerfile, our Developer Guide
new "flow" is:
- Prepare Base Docker Image
- Build "base image"
- Build the CentOS Mirror Repository
- Run container from "base image"
- Get mirror files
- Create StarlingX Packages
- Run container from "base image"
- Get StarlingX source code
- Build StarlingX packages
- Build StarlingX ISO
Story: 2003712
Task: 28010
Change-Id: I5776a7c515a7f2f1f3355644092b1d0a913f1ee8
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Under section Installation Requirements and Dependencies on
Developer Guide:
- create a user
- add the user to Docker group
Closes-Bug: 1799611
Change-Id: I39e95b096bdf12f8ed76237066fc9a3f17cadcdb
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Before creating a storage function (an OSD) in Storage-0, at least 2
unlocked and enabled hosts with monitors are required:
- Controller-0
- Controller-1
Change-Id: Iba2d1e14d0feba2bc57e2c4fafc8dcb38358fc9d
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
