127 Commits

Author SHA1 Message Date
Zuul
94010e733f Merge "initial creation Doc page Navigate Git Code story/2005184" 2019-09-18 19:49:29 +00:00
Dominig ar Foll Intel Open Source
783886f365 initial creation Doc page Navigate Git Code story/2005184
- Standardize formatting
- Minor grammatical edits
- Spelling

Change-Id: I2c0a491d1adf0584cd862d37d295765edefb4606
Signed-off-by: Dominig ar Foll Intel Open Source <dominig.arfoll@fridu.net>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-09-16 14:16:55 -07:00
Kristal Dale
e88de77176 Apply Ironic changes to current r2 guide
- Apply changes from review 679509 (includes correct changes,
  but applied to wrong version of the guide)
- Minor grammatical and formatting changes
- Added labels to bare metal standard guides for linking

Change-Id: Ia25eb15321e5099401db535630b8489a1303c91a
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-09-12 15:19:10 -07:00
Zuul
0f36aacf1b Merge "Initial commit for guide reorg - upcoming release" 2019-09-02 21:00:06 +00:00
Kristal Dale
5676e4fda4 Initial commit for guide reorg - upcoming release
- Migrated reorged content from wiki
- Naming, title, and capitalization consistency, minor rewording in sections
- Set up includes to reuse common content across pages
- Introduction: remove 'openstack users' and 'kubernetes users'
- Consolidate term definition into Key concepts page
- Archive R1, move R2 to current releast, set up for R3
- Remove stub pages for duplicate content, or content deferred to R3
- Rework intro and contribute pages for better readability
- Split Key concepts into two pages: Terms and Deployment Options
- Pass for grammar, punctuation, licensing, etc.
- Pull streamlined intro content into R2 install guides (from prev version)
- Added R2 release note page
- Update links to projects/project names to remove the "stx-"
- Add instructions for creating a bootable USB

Story: 2006315
Task: 36046

Change-Id: I38656fd382d1d9cf2969812c548fb7b2dc9dd31e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-09-02 20:47:44 +00:00
Kristal Dale
7edaf9f52e Update doc contribute guide and api ref page to use
updated repo/project names

- updated doc contribute guide to use updated project names
- updated doc contribute guide to remove explicit display of
  project directory structure (it has changed)
- update api ref landing page to use updated project names in URL

Change-Id: I05779f9ac0c465f6ed928bc68f333e37275dcb4d
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-28 16:38:49 -07:00
Zuul
f7bce640c8 Merge "Modify the git codebase address of the tools code" 2019-08-20 00:53:16 +00:00
Zuul
60896295d8 Merge "Modify the git codebase address of the tools code" 2019-08-20 00:53:15 +00:00
Zuul
a116c396d5 Merge "Optimization add the cluster-host interface and osd on storage hosts" 2019-08-20 00:53:08 +00:00
Fei Chao
7b89ed554b Modify the git codebase address of the tools code
Change-Id: I41961ba4dbe8b9cd4247edc8c8e8b28d89139608
2019-08-15 21:51:58 +08:00
Fei Chao
6139958479 Modify the git codebase address of the tools code
Change-Id: I6ced63f360b31ede89958ba02fdeb005c3a0e9cd
2019-08-15 21:29:23 +08:00
Fei Chao
895e2a3cb4 Optimization add the cluster-host interface and osd on storage hosts
Change-Id: Ie484ca6319622963cccf33d3ddedea387cee12e4
2019-08-15 16:57:34 +08:00
chenlx
a4936e18cd Fix typos command in AIO Duplex guide
Change-Id: Ic96691b527b7fe4b45bc36791c51f2117719d8d9
2019-08-15 16:27:01 +08:00
Fei Chao
2694116251 Optimize how to unlock storage nodes
Change-Id: I2db47f04d5ae1f365597c650b9d5bdace5beef0e
2019-08-09 17:12:55 +08:00
Zuul
54c6d38ebf Merge "Deploy Install Guides: AIO Duplex Extended" 2019-08-08 19:05:47 +00:00
Zuul
f822cda9d7 Merge "Added deployment_install dedicated_storage guide" 2019-08-08 19:05:46 +00:00
Abraham Arce
b927ea4cb3 Deploy Install Guides: AIO Duplex Extended
The All-In-One Duplex Extended deployment option extends the capacity
of the All-In-One Duplex deployment by adding up to four compute nodes
to the deployment.

The extended deployment option provides a capacity growth path for
someone starting with an All-In-One Duplex deployment.

Amended to add in comments from Greg Waines.

Depends-On: https://review.opendev.org/#/c/674799/

Story: 2005009
Task: 29485

Change-Id: I131fe72f7e298d6841f66ff7a6ccd3d197d7d2b1
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-08 11:30:30 -07:00
Scott Rifenbark
06ebad5151 Added deployment_install dedicated_storage guide
This manual is a combination of the existing common StarlingX
installation guide and the existing deployment guide for the
Dedicated Storage StarlingX configuration.

Ameded to add in Greg Waines comments.

Change-Id: If61b8c35ca8926fe9a7b7a7faee921488e69d119
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-08 11:01:35 -07:00
Zuul
17f14865ea Merge "Build Guide Latest: Tools Repository Name" 2019-08-07 19:52:01 +00:00
Abraham Arce
f3b72a2550 Deploy Install Guides: Misc Changes
AIO Duplex:

- Remove networks parameter from host-if-modify and add
  interface-network-assign command.

Controller Storage

- Fix a typo in the commands to create the volume group for Nova for
  computes.
- Remove acquiring Keystone administrative privileges after controller-0
  has been unlocked.
- Change the name of the server XML definition.

Common

- In section "Configure the host's vSwitch type", the "attention"
  message has been moved to the beggining of the section, to promptly
  notify the user OVS-DPDK is not supported in a virtual environment.

- Let the user know via the application-upload command, the complete
  name is required for the stx-openstack application tarball.

Change-Id: Id487171019482174cbd7febd37a5ee9c63e9b97a
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-08-06 18:17:18 -05:00
fpxie
1eec443c91 fix the command when assign IP for VM
Change-Id: I4726e949326399a262eb8e2f6745726df2903576
2019-08-05 16:54:52 +08:00
Zuul
cfc212e798 Merge "fix little problem when exec openstack cmd" 2019-08-02 18:08:33 +00:00
Zuul
a16d763c90 Merge "Deploy Install Guides: Standard with Ironic" 2019-08-02 17:01:40 +00:00
Mingyuan Qi
65102457a5 Deploy Install Guides: Standard with Ironic
Add Ironic deployment for standard configuration under the
Deployment and Installation Guides.

Story: 2004795
Task: 28942

Change-Id: I211182910352c9c2a986d0b7a35f945b828062e1
Co-authored-by: Mingyuan Qi <mingyuan.qi@intel.com>
Co-authored-by: Greg Waines <greg.waines@windriver.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-08-02 10:28:35 -05:00
fpxie
bfdc4a9f84 fix little problem when exec openstack cmd
Change-Id: I5d07b5890fd1bdcefded93de26bc8d3b4fb1dd29
2019-08-02 18:54:12 +08:00
Zuul
7ea6fd1668 Merge "Deploy Install Guides: AIO Simplex Errors / Issues" 2019-08-01 22:56:44 +00:00
Abraham Arce
796e370cc8 Deploy Install Guides: AIO Duplex Errors / Issues
To align AIO Duplex deployment and installation guide content,
we are taking 2 sources of information:

- [0] Launchpad 1836574
- [1] StarlingX wiki changes

These are the high level modifications:

- URL updated.
- Remove references to VirtualBox as our default virtual
  configuration in this guide is Libvirt/QEMU.
- Sync up documentation:
  - Rename titles
  - Extend Local playbook information.
  - Replace ifconfig command with ip command to setup
    external connectivity.
  - System command to configure OAM for controller-0.
  - Section "Configure the vSwitch type".
  - Section "Configure data interfaces".
  - Additional comments under section
    "Test for Ceph cluster operation".
  - Additional comment under section
    "Stage application for deployment".
  - Add information to verify the cluster endpoints.
  - Replace neutron command with openstack network
    command.
  - Rework section "Configure the host's vSwitch type".
- Make use of RST formatting directives (e.g. information):
  - Highlight configuration of NTP server and vSwitch type
    are only for Baremetal hardware.
- Remove documentation:
  - Partition extension for cgts-vg, since it is a
    config_controller method only.
  - Enablement of primary Ceph backend, already done.
  - Providernetworking setup (pre-Stein).

[0] https://bugs.launchpad.net/starlingx/+bug/1836574
[1] https://wiki.openstack.org/w/index.php?title=StarlingX%2FContainers%2FInstallationOnAIODX&type=revision&diff=171081&oldid=169806

Closes-Bug: 1836574
Depends-On: https://review.opendev.org/#/c/672191/

Change-Id: I8b0259b89a37b7da64ed5b232b958f7789ed94a8
Co-authored-by: Fei Chao <fchao@fiberhome.com>
Co-authored-by: Greg Waines <greg.waines@windriver.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-08-01 08:13:42 -05:00
Abraham Arce
02fa311224 Build Guide Latest: Tools Repository Name
OpenDev is community-run tools and infrastructure services for collaboratively
developing open source software [0]. A new structure has been assigned
including the new named "tools" repository which hosts the scripts to build
an StarlingX ISO image.

[0] http://lists.starlingx.io/pipermail/starlingx-discuss/2018-November/001821.html

Change-Id: Ie326347d3f4a0016d1093fc05a2eba61f02a052e
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-07-31 19:28:35 -05:00
Abraham Arce
69b4aae419 Deploy Install Guides: AIO Simplex Errors / Issues
To align AIO Simplex deployment and installation guide content,
we are taking 2 sources of information:

- [0] Launchpad 1836575
- [1] StarlingX wiki changes

These are the high level modifications:

- URLs updated.
- Remove references to VirtualBox as our default virtual
  configuration in this guide is Libvirt/QEMU.
- Sync up documentation:
  - Rename titles
  - Extend Local playbook information.
  - Replace ifconfig command with ip command to setup
    external connectivity.
  - System command to configure OAM for controller-0.
  - Section "Configure the vSwitch type".
  - Section "Configure data interfaces".
  - Additional comments under section
    "Test for Ceph cluster operation".
  - Additional comment under section
    "Stage application for deployment".
  - Add information to verify the cluster endpoints.
  - Replace neutron command with openstack network
    command.
  - Rework section "Configure the host's vSwitch type".
- Make use of RST formatting directives (e.g. information):
  - Highlight configuration of NTP server and vSwitch type
    are only for Baremetal hardware.
- Remove documentation:
  - Partition extension for cgts-vg, since it is a
    config_controller method only.
  - Enablement of primary Ceph backend, already done.
  - Setting Ceph pool replication before application
    applied (duplicated).
  - Providernetworking setup (pre-Stein).

[0] https://bugs.launchpad.net/starlingx/+bug/1836575
[1] https://wiki.openstack.org/w/index.php?title=StarlingX%2FContainers%2FInstallation&type=revision&diff=171080&oldid=169805

Closes-Bug: 1836575
Depends-On: https://review.opendev.org/#/c/672191/

Change-Id: If14dd9ba4e5d05a9e20ebecb04a3d5aec8cb7133
Co-authored-by: Fei Chao <fchao@fiberhome.com>
Co-authored-by: Greg Waines <greg.waines@windriver.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-07-31 19:22:29 -05:00
Zuul
69dfd59303 Merge "Added deployment_install contro_storage combo manual" 2019-07-31 16:14:38 +00:00
Scott Rifenbark
aa6ed76ff7 Added deployment_install contro_storage combo manual
This is the first draft concocted from the wiki and some
standard texts from the installation guides.

- Amended to handle review comments and undergo a
  comprehensive writing scrub.
- Amended to settle down on the possible number of computes.
  Greg says basically 10. Fixed a small typo XMS -> XML.
- Amended to fix the "XML" term.
- Also, added the "Setting up provider/tenant networking"
  section.  Finally, a really close scrup of all text.
- Amended to make some capitalization consistent.
- Amended to take care of some review comments from Greg Waines.
- Amended (June 27) for more review comments from Greg Waines.
- Amended July 8 to fix small typo
- Added review changes July 16.

Some of the following changes includes latest content added to the wiki [0]

Added section "NVMe drive as boot drive"
Added "attention" meesage to section "Set up the NTP server"
Changed sections:
  - Bootstrap controller-0
  - Configure the host's vSwitch type" based in Duplex review
    https://review.opendev.org/#/c/672192/
  - Adding Ceph OSDs to controllers
  - Using sysinv to bring up and take down the containerized OpenStack
    services
Added additional comments for sections:
  - Configure the host's vSwitch type" based in Duplex review
Reference to these files based in review
https://review.opendev.org/#/c/672191/:
  - uninstalling-deleting-openstack
  - horizon-access

Depends-On: https://review.opendev.org/#/c/672191/

Change-Id: I6c04ecca42395d84c7f66b94f7551964840eb437
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-07-30 19:27:56 -05:00
Abraham Arce
6d2236e3d6 Deploy Install Guides: AIO Common Sections
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>
2019-07-26 18:06:19 -05:00
Kristal Dale
ade04de812 Remove old Deploy and Installation folders/guides
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>
2019-07-17 12:56:13 -07:00
Kristal Dale
ab1b52fed7 Fix for broken links on Installation and Deployment Guides page(s)
- 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>
2019-07-10 11:19:35 -07:00
Scott Rifenbark
7795fe1342 Reorg of docs master TOC
* 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>
2019-07-10 11:46:07 +00:00
Zuul
278eb6ab0e Merge "fix spell error" 2019-07-10 11:28:23 +00:00
zhangyifan
8a8f4551ff fix spell error
Change-Id: I9aa4b3c2a74a8ab2fd66ce10688a8719303025b2
2019-07-01 15:10:58 +08:00
zhaodan
2439f90460 fix grammar end spell error
Change-Id: Iac05c49c665717e8b186a408e0f5f0e19b65581c
2019-06-27 09:17:14 +08:00
Jeremy Stanley
d790adbc1f Correct broken tools URL for AIO duplex install
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
2019-06-24 18:59:23 +00:00
Zuul
8a52426853 Merge "Reroute for latest AIO-SX AIO-DX install_deploy" 2019-06-13 20:17:36 +00:00
Scott Rifenbark
453ce67c9f Reroute for latest AIO-SX AIO-DX install_deploy
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>
2019-06-13 14:53:19 +00:00
Bruce Jones
fc063b75bc Add the initial content for the Deployment options document
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>
2019-06-10 11:04:01 -07:00
zhouyao
169f0bea77 Change get- to git.
Change-Id: I4fdd4f51221814e880a1054916aa571df473fe4c
2019-05-27 14:42:02 +08:00
Scott Rifenbark
699823bfc9 Added deployment_install AIO-DX combo manual
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>
2019-05-23 18:24:56 +00:00
Scott Rifenbark
5e8f25834f Ansible bootstrap playbook replaced config_controller
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>
2019-05-23 17:00:25 +00:00
Zuul
df171c4f27 Merge "Add introductory material to the StarlingX documentation" 2019-05-22 20:03:58 +00:00
Bruce Jones
98af589309 Add introductory material to the StarlingX documentation
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>
2019-05-20 12:31:48 -07:00
Scott Rifenbark
5d9cdbbe24 AIO-SX deploy_combo: "tools" -> "stx-tools"
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>
2019-05-20 07:04:43 -05:00
Scott Rifenbark
fbf5fe6469 Fixed two typos and a bad link.
Change-Id: I003298827f98cb5be7982ee035e7a28b537165a1
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-05-20 07:04:31 -05:00
Scott Rifenbark
03b01e5f12 Added deployment_install AIO-SX combo manual
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>
2019-05-20 07:04:17 -05:00