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>
This commit is contained in:
Kristal Dale
@@ -1,83 +0,0 @@
|
||||
=================
|
||||
Deployment Guides
|
||||
=================
|
||||
|
||||
Deployment guides for StarlingX are release-specific.
|
||||
The following list provides help on choosing the correct deployment guide:
|
||||
|
||||
- The "current" release is the most recent officially released version of StarlingX.
|
||||
|
||||
.. "Current" deployment guides moved to Installation and Deployment Guides.
|
||||
|
||||
- The "latest" release is the forthcoming version under development.
|
||||
Following are the latest deployment guides:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
latest/aio_duplex_computes/index
|
||||
|
||||
.. All other "Latest" deployment guides moved to Installation and Deployment Guides.
|
||||
|
||||
- Following are deployment guides for past StartlingX releases that have
|
||||
been archived:
|
||||
|
||||
* Currently, no archived deployment guides exist.
|
||||
|
||||
|
||||
.. Steps you must take when a new release of the installer and developer guides occurs:
|
||||
|
||||
.. 1. Archive the "current" release:
|
||||
1. Rename the "current" folder to the release name using the <Year_Month> convention (e.g. 2018_10).
|
||||
2. Get inside your new folder (i.e. the old "current" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/<Year_Month>/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to /<Year_Month> and use Git to grep for
|
||||
the "current" string (i.e. 'git grep "current" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to the actual archived string "<Year_Month>".
|
||||
Be sure to scrub all files for the "current" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
2. Add the new "current" release:
|
||||
1. Rename the existing "latest" folders to "current". This assumes that "latest" represented
|
||||
the under-development release that just officially released.
|
||||
2. Get inside your new folder (i.e. the old "latest" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to the "current" directory and use Git to grep for
|
||||
the "latest" string (i.e. 'git grep "latest" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to "current".
|
||||
Be sure to scrub all files for the "latest" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
4. Because the "current" release is now available, make sure to update these pages:
|
||||
- index
|
||||
- installation guide
|
||||
- developer guide
|
||||
- release notes
|
||||
3. Create a new "latest" release, which are the installation and developer guides under development:
|
||||
1. Copy your "current" folders and rename them "latest".
|
||||
2. Make sure the new files have the correct version in the page title and intro
|
||||
sentence (e.g. '2019.10.rc1 Installation Guide').
|
||||
3. Make sure all files in new "latest" link to the correct versions of supporting
|
||||
docs. You do this through the doc link, so that it resolves to the top of the page
|
||||
(e.g. :doc:`/installation_guide/latest/index`)
|
||||
4. Make sure the new release index is labeled with the correct version name
|
||||
(e.g .. _index-2019-05:)
|
||||
5. Add the archived version to the toctree on this page. You want all possible versions
|
||||
to build.
|
||||
6. Since you are adding a new version ("latest") *before* it is available
|
||||
(e.g. to begin work on new docs), make sure page text still directs user to the
|
||||
"current" release and not to the under development version of the manuals.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
==========================================
|
||||
All-in-one duplex with up to four computes
|
||||
==========================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005009>`__
|
||||
|
||||
@@ -23,13 +23,6 @@ Sections
|
||||
releasenotes/index
|
||||
developer_resources/index
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
deployment_guides/index
|
||||
installation_guide/index
|
||||
|
||||
|
||||
--------
|
||||
Projects
|
||||
--------
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
===================
|
||||
Installation Guides
|
||||
===================
|
||||
|
||||
Installation steps for StarlingX are release-specific.
|
||||
The following list provides help on choosing the correct installation steps:
|
||||
|
||||
- The "current" release is the most recent officially released version of StarlingX:
|
||||
|
||||
.. "Current" installation guide moved to Installation and Deployment Guides.
|
||||
|
||||
- The "latest" release is the forthcoming version under development:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
/installation_guide/latest/index
|
||||
|
||||
- The "archived" installation documents are as follows:
|
||||
|
||||
* Currently, no archived installation documents exist.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.. Steps you must take when a new release of the installer and developer guides occurs:
|
||||
|
||||
.. 1. Archive the "current" release:
|
||||
1. Rename the "current" folder to the release name using the <Year_Month> convention (e.g. 2018_10).
|
||||
2. Get inside your new folder (i.e. the old "current" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/<Year_Month>/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to /<Year_Month> and use Git to grep for
|
||||
the "current" string (i.e. 'git grep "current" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to the actual archived string "<Year_Month>".
|
||||
Be sure to scrub all files for the "current" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
2. Add the new "current" release:
|
||||
1. Rename the existing "latest" folders to "current". This assumes that "latest" represented
|
||||
the under-development release that just officially released.
|
||||
2. Get inside your new folder (i.e. the old "latest" folder) and update all links in the *.rst
|
||||
files to use the new path (e.g. :doc:`Libvirt/QEMU </installation_guide/latest/installation_libvirt_qemu>`
|
||||
becomes
|
||||
:doc:`Libvirt/QEMU </installation_guide/current/installation_libvirt_qemu>`
|
||||
3. You might want to change your working directory to the "current" directory and use Git to grep for
|
||||
the "latest" string (i.e. 'git grep "latest" *'). For each applicable occurence, make
|
||||
the call whether or not to convert the string to "current".
|
||||
Be sure to scrub all files for the "latest" string in both the "installation_guide"
|
||||
and "developer_guide" folders downward.
|
||||
4. Because the "current" release is now available, make sure to update these pages:
|
||||
- index
|
||||
- installation guide
|
||||
- developer guide
|
||||
- release notes
|
||||
3. Create a new "latest" release, which are the installation and developer guides under development:
|
||||
1. Copy your "current" folders and rename them "latest".
|
||||
2. Make sure the new files have the correct version in the page title and intro
|
||||
sentence (e.g. '2019.10.rc1 Installation Guide').
|
||||
3. Make sure all files in new "latest" link to the correct versions of supporting
|
||||
docs. You do this through the doc link, so that it resolves to the top of the page
|
||||
(e.g. :doc:`/installation_guide/latest/index`)
|
||||
4. Make sure the new release index is labeled with the correct version name
|
||||
(e.g .. _index-2019-05:)
|
||||
5. Add the archived version to the toctree on this page. You want all possible versions
|
||||
to build.
|
||||
6. Since you are adding a new version ("latest") *before* it is available
|
||||
(e.g. to begin work on new docs), make sure page text still directs user to the
|
||||
"current" release and not to the under development version of the manuals.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
================================================
|
||||
Additional OpenStack Services Installation Guide
|
||||
================================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
Linked Story does not yet exist.
|
||||
|
||||
.. `Linked Story <https://storyboard.openstack.org/#!/story/2005181>`__
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
==================================================
|
||||
All-in-one Duplex with Computes Installation Guide
|
||||
==================================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005177>`__
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
====================================
|
||||
Distributed Cloud Installation Guide
|
||||
====================================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005181>`__
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 100 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 107 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 104 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 89 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 79 KiB |
@@ -1,341 +0,0 @@
|
||||
==============================
|
||||
Installation guide stx.2019.05
|
||||
==============================
|
||||
|
||||
This is the installation guide for the "current" StarlingX software
|
||||
(i.e. the most recently released version).
|
||||
If this is not the installation guide you want to use, see the
|
||||
:doc:`available installation guides </installation_guide/index>`.
|
||||
|
||||
------------
|
||||
Introduction
|
||||
------------
|
||||
|
||||
You can install StarlingX in the following:
|
||||
|
||||
- **Bare metal**: Real deployments of StarlingX are only supported on
|
||||
physical servers.
|
||||
- **Virtual environment**: Only used for evaluation or
|
||||
development purposes.
|
||||
|
||||
StarlingX installed in virtual environments has two options:
|
||||
|
||||
.. "Latest" libvirt qemu moved to Installation and Deployment Guides - upcoming.
|
||||
|
||||
- Libvirt QEMU
|
||||
- VirtualBox
|
||||
|
||||
------------
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Different use cases require different configurations.
|
||||
|
||||
**********
|
||||
Bare metal
|
||||
**********
|
||||
|
||||
The minimum requirements for the physical servers where StarlingX might
|
||||
be deployed include:
|
||||
|
||||
- **Controller hosts**
|
||||
|
||||
- Minimum processor:
|
||||
|
||||
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8
|
||||
cores/socket
|
||||
|
||||
- Minimum memory: 64 GB
|
||||
- Hard drives:
|
||||
|
||||
- Primary hard drive with a minimum 500 GB for OS and system databases.
|
||||
- Secondary hard drive with a minimum 500 GB for persistent VM storage.
|
||||
|
||||
- Two physical Ethernet interfaces: OAM and MGMT network.
|
||||
- USB boot support.
|
||||
- PXE boot support.
|
||||
|
||||
- **Storage hosts**
|
||||
|
||||
- Minimum processor:
|
||||
|
||||
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8
|
||||
cores/socket.
|
||||
|
||||
- Minimum memory: 64 GB.
|
||||
- Hard drives:
|
||||
|
||||
- Primary hard drive with a minimum 500 GB for OS.
|
||||
- One or more additional hard drives for CEPH OSD storage.
|
||||
- Optionally, one or more SSD or NVMe drives for CEPH journals.
|
||||
|
||||
- One physical Ethernet interface: MGMT network
|
||||
- PXE boot support.
|
||||
|
||||
- **Compute hosts**
|
||||
|
||||
- Minimum processor:
|
||||
|
||||
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8
|
||||
cores/socket.
|
||||
|
||||
- Minimum memory: 32 GB.
|
||||
- Hard drives:
|
||||
|
||||
- Primary hard drive with a minimum 500 GB for OS.
|
||||
- One or more additional hard drives for ephemeral VM storage.
|
||||
|
||||
- Two or more physical Ethernet interfaces: MGMT network and one or more
|
||||
provider networks.
|
||||
- PXE boot support.
|
||||
|
||||
- **All-In-One Simplex or Duplex, controller + compute hosts**
|
||||
|
||||
- Minimum processor:
|
||||
|
||||
- Typical hardware form factor:
|
||||
|
||||
- Dual-CPU Intel® Xeon® E5 26xx family (SandyBridge) 8 cores/socket
|
||||
- Low cost / low power hardware form factor
|
||||
|
||||
- Single-CPU Intel Xeon D-15xx family, 8 cores
|
||||
|
||||
- Minimum memory: 64 GB.
|
||||
- Hard drives:
|
||||
|
||||
- Primary hard drive with a minimum 500 GB SDD or NVMe.
|
||||
- Zero or more 500 GB disks (min. 10K RPM).
|
||||
|
||||
- Network ports:
|
||||
|
||||
**NOTE:** Duplex and Simplex configurations require one or more data
|
||||
ports.
|
||||
The Duplex configuration requires a management port.
|
||||
|
||||
- Management: 10GE (Duplex only)
|
||||
- OAM: 10GE
|
||||
- Data: n x 10GE
|
||||
|
||||
The recommended minimum requirements for the physical servers are
|
||||
described later in each StarlingX deployment guide.
|
||||
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
NVMe drive as boot drive
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To use a Non-Volatile Memory Express (NVMe) drive as the boot drive for any of
|
||||
your nodes, you must configure your host and adjust kernel parameters during
|
||||
installation:
|
||||
|
||||
- Configure the host to be in UEFI mode.
|
||||
- Edit the kernel boot parameter. After you are presented with the StarlingX
|
||||
ISO boot options and after you have selected the preferred installation option
|
||||
(e.g. Standard Configuration / All-in-One Controller Configuration), press the
|
||||
TAB key to edit the kernel boot parameters. Modify the **boot_device** and
|
||||
**rootfs_device** from the default **sda** so that it is the correct device
|
||||
name for the NVMe drive (e.g. "nvme0n1").
|
||||
|
||||
::
|
||||
|
||||
vmlinuz rootwait console=tty0 inst.text inst.stage2=hd:LABEL=oe_iso_boot
|
||||
inst.ks=hd:LABEL=oe_iso_boot:/smallsystem_ks.cfg boot_device=nvme0n1
|
||||
rootfs_device=nvme0n1 biosdevname=0 usbcore.autosuspend=-1 inst.gpt
|
||||
security_profile=standard user_namespace.enable=1 initrd=initrd.img
|
||||
|
||||
|
||||
*******************
|
||||
Virtual environment
|
||||
*******************
|
||||
|
||||
The recommended minimum requirements for the workstation that hosts the
|
||||
virtual machine(s) where StarlingX is deployed includes the following:
|
||||
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Virtual machine requirements
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Virtual machine requirements would depend on what kind of deployment is
|
||||
being done, for example an all-in-one Simplex (AIO-SX) deployment, and
|
||||
also what virtualization technology is being used. As well, it would
|
||||
depend on how long the installation was running, as this example uses
|
||||
thin qcow2 disks (which would fill up over time, but initially use much
|
||||
less than the virtual size).
|
||||
|
||||
.. "Latest" libvirt qemu moved to Installation and Deployment Guides - upcoming.
|
||||
|
||||
For example, in a
|
||||
Libvirt/QEMU
|
||||
environment, and an AIO-SX mode, the following are required when using the
|
||||
setup scripts and default XML definition file.
|
||||
|
||||
- Memory: 18GB RAM
|
||||
- Cores: 6
|
||||
- Hard Disk: 3 thin qcow2 images
|
||||
|
||||
- Disk0: 600GB virtual size
|
||||
|
||||
- Disk1: 200GB virtual size
|
||||
|
||||
- Disk2: 200GB virtual size
|
||||
|
||||
- Network: 4 virtual network adapters
|
||||
|
||||
These are only examples but provide a rough idea of what virtual resources
|
||||
would be required. It may be possible to reduce these requirements and still
|
||||
have a working proof of concept virtual machine environment.
|
||||
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
Hardware requirements
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
<<<<<<< HEAD
|
||||
Suggested workstation resources are a computer with:
|
||||
=======
|
||||
A workstation computer with the following:
|
||||
>>>>>>> 88a4c36... Installation Guides: General edit.
|
||||
|
||||
- Processor: x86_64 only supported architecture with BIOS enabled
|
||||
hardware virtualization extensions
|
||||
- Cores: 8 (4 with careful monitoring of CPU load)
|
||||
- Memory: Minimum 32 GB RAM
|
||||
- Hard Disk: 500 GB HDD
|
||||
- Network: Two network adapters with active Internet connection
|
||||
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
Software requirements
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
A workstation computer with the following:
|
||||
|
||||
- Newly installed Ubuntu 16.04 LTS 64-bit operating system
|
||||
- If applicable, proxy settings
|
||||
- Git
|
||||
- KVM/VirtManager
|
||||
- Libvirt library
|
||||
- QEMU full-system emulation binaries
|
||||
- stx-tools project
|
||||
- StarlingX ISO image
|
||||
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Deployment environment setup
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This section describes how to set up the workstation computer that
|
||||
hosts the virtual machine or machine where StarlingX is deployed.
|
||||
|
||||
''''''''''''''''''''''''''''''
|
||||
Updating your operating system
|
||||
''''''''''''''''''''''''''''''
|
||||
|
||||
Before proceeding with the build, ensure your OS is current. You will
|
||||
first need to update the local database list of available packages:
|
||||
|
||||
::
|
||||
|
||||
$ sudo apt-get update
|
||||
|
||||
'''''''''''''''''''''''''
|
||||
Install stx-tools project
|
||||
'''''''''''''''''''''''''
|
||||
|
||||
Clone the stx-tools project. Usually, you want to clone the
|
||||
stx-tools repository under your user’s home directory.
|
||||
|
||||
::
|
||||
|
||||
$ cd $HOME
|
||||
$ git clone https://git.starlingx.io/stx-tools
|
||||
|
||||
|
||||
''''''''''''''''''''''''''''''''''''''''
|
||||
Installing requirements and dependencies
|
||||
''''''''''''''''''''''''''''''''''''''''
|
||||
|
||||
Navigate to the stx-tools installation libvirt directory:
|
||||
|
||||
::
|
||||
|
||||
$ cd $HOME/stx-tools/deployment/libvirt/
|
||||
|
||||
|
||||
Install the required packages:
|
||||
|
||||
::
|
||||
|
||||
$ bash install_packages.sh
|
||||
|
||||
|
||||
''''''''''''''''''''''
|
||||
Disabling the firewall
|
||||
''''''''''''''''''''''
|
||||
|
||||
Unload the firewall and disable it during boot:
|
||||
|
||||
::
|
||||
|
||||
$ sudo ufw disable
|
||||
Firewall stopped and disabled on system startup
|
||||
$ sudo ufw status
|
||||
Status: inactive
|
||||
|
||||
|
||||
-------------------------------
|
||||
Getting the StarlingX ISO image
|
||||
-------------------------------
|
||||
|
||||
Follow the instructions from the :doc:`/contributor/build_guides/latest/index` to build a
|
||||
StarlingX ISO image.
|
||||
|
||||
**********
|
||||
Bare metal
|
||||
**********
|
||||
|
||||
A bootable USB flash drive containing StarlingX ISO image.
|
||||
|
||||
|
||||
*******************
|
||||
Virtual environment
|
||||
*******************
|
||||
|
||||
Copy the StarlingX ISO Image to the stx-tools deployment libvirt project
|
||||
directory:
|
||||
|
||||
::
|
||||
|
||||
$ cp <starlingx iso image> $HOME/stx-tools/deployment/libvirt/
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
aio_duplex_computes
|
||||
additional_os_services
|
||||
multi_region
|
||||
dist_cloud
|
||||
|
||||
.. "Latest" libvirt qemu moved to Installation and Deployment Guides - upcoming.
|
||||
|
||||
------------------
|
||||
Deployment options
|
||||
------------------
|
||||
|
||||
- All-in-one
|
||||
|
||||
.. "Latest" aio simplex and aio duplex moved to Installation and Deployment Guides - upcoming.
|
||||
|
||||
|
||||
- AIO Simplex
|
||||
- AIO Duplex
|
||||
- :doc:`StarlingX Cloud Duplex with Computes </deployment_guides/latest/aio_duplex_computes/index>`
|
||||
|
||||
- Standard controller
|
||||
|
||||
.. "Latest" Controller and Dedicated storage moved to Installation and Deployment Guides - upcoming.
|
||||
|
||||
- Others
|
||||
|
||||
.. "Latest" multi region and dist cloud moved to Installation and Deployment Guides - upcoming.
|
||||
|
||||
- :doc:`Additional OpenStack services <additional_os_services>`
|
||||
|
||||
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
===============================
|
||||
Multi-Region Installation Guide
|
||||
===============================
|
||||
|
||||
This topic is coming soon.
|
||||
|
||||
.. Linked Story does not yet exist.
|
||||
|
||||
`Linked Story <https://storyboard.openstack.org/#!/story/2005180>`__
|
||||
|
||||
Reference in New Issue
Block a user