Ron Stone
2022-04-06 12:19:00 -04:00
parent d768ea339f
commit c803a69aa2
146 changed files with 139 additions and 125 deletions

View File

@@ -1,3 +0,0 @@
{
"restructuredtext.confPath": ""
}

0
doc/source/_includes/project-networks.rest Executable file → Normal file
View File

View File

@@ -4,4 +4,4 @@ For instructions on how to access StarlingX Kubernetes see
:ref:`kubernetes_access`.
For instructions on how to install and access StarlingX OpenStack see
:doc:`/deploy_install_guides/r5_release/openstack/index`.
:doc:`/deploy_install_guides/r5_release/openstack/index-install-r5-os-bf0f49699241`.

0
doc/source/_includes/vm-network-interface-options.rest Executable file → Normal file
View File

0
doc/source/_vendor/vendor_strings.txt Executable file → Normal file
View File

View File

@@ -1,4 +1,4 @@
.. _admintasks-index:
.. _index-admintasks-768a6e9aaeff:
===========
Admin Tasks
@@ -18,7 +18,7 @@ of common administrative tasks.
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-admintasks-kub-ebc55fefc368
-------------------
StarlingX OpenStack
@@ -34,4 +34,4 @@ openstack-compute host basis.
.. toctree::
:maxdepth: 2
openstack/index
openstack/index-admintasks-os-22bdf545d2f2

View File

@@ -1,11 +1,11 @@
.. _admintasks-kubernetes-index:
.. _index-admintasks-kub-ebc55fefc368:
.. include:: /_includes/toc-title-admintasks-kub.rest
.. only:: partner
.. include:: /admintasks/index.rst
.. include:: /admintasks/index-admintasks-768a6e9aaeff.rst
:start-after: kub-begin
:end-before: kub-end

View File

@@ -4,7 +4,7 @@
.. only:: partner
.. include:: /admintasks/index.rst
.. include:: /admintasks/index-admintasks-768a6e9aaeff.rst
:start-after: os-begin
:end-before: os-end

View File

@@ -1,3 +1,5 @@
.. _index-backup-1b466179efc3:
==================
Backup and Restore
==================
@@ -11,7 +13,7 @@ Kubernetes
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-backup-kub-699e0d16c076
---------
OpenStack
@@ -22,4 +24,4 @@ OpenStack
.. toctree::
:maxdepth: 2
openstack/index
openstack/index-backup-os-2b4f93282ec4

View File

@@ -1,3 +1,5 @@
.. _index-backup-kub-699e0d16c076:
.. Backup and Restore file, created by
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
You can adapt this file completely to your liking, but it should at least

View File

@@ -1,3 +1,4 @@
.. _index-backup-os-2b4f93282ec4:
.. include:: /_includes/toc-title-backup-kub.rest

View File

@@ -78,10 +78,10 @@ Docs organization
Documentation for StarlingX is organized into the following sections:
:doc:`/introduction/index`
:doc:`/introduction/index-intro-27197f27ad41`
Overview of the StarlingX project.
:doc:`/deploy_install_guides/index`
:doc:`/deploy_install_guides/index-install-e083ca818006`
Release-specific installation and deployment guides.
:doc:`/configuration/index`

View File

@@ -1,6 +1,5 @@
..
.. _datanet_index:
.. _index-datanet-e316bf6c2f6a:
=============
Data Networks
@@ -20,7 +19,7 @@ are attached to node data, pci-sriov and pci-passthrough interfaces.
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-datanet-kub-500ef820efd8
---------
@@ -37,4 +36,4 @@ and pci-passthrough interfaces attach to.
.. toctree::
:maxdepth: 2
openstack/index
openstack/index-datanet-os-aff0f5fbfb86

View File

@@ -1,12 +1,11 @@
..
.. _datanet_kubernetes_index:
.. _index-datanet-kub-500ef820efd8:
.. include:: /_includes/toc-title-datanet-kub.rest
.. only:: partner
.. include:: /datanet/index.rst
.. include:: /datanet/index-datanet-e316bf6c2f6a.rst
:start-after: kub-begin
:end-before: kub-end

View File

@@ -1,13 +1,7 @@
.. _datanet_openstack_index:
.. _index-datanet-os-aff0f5fbfb86:
.. include:: /_includes/toc-title-datanet-os.rest
.. only:: partner
.. include:: /datanet/index.rst
:start-after: os-begin
:end-before: os-end
.. toctree::
:maxdepth: 1

View File

@@ -1,4 +1,4 @@
.. _deployment-index:
.. _index-deploy-da06a98b83b1:
=========================
Deployment Configurations
@@ -30,4 +30,4 @@ A variety of |prod-long| deployment configuration options are supported.
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-deploy-kub-844a2a88f529

View File

@@ -1,4 +1,4 @@
.. _deploy-kubernetes-index:
.. _index-deploy-kub-844a2a88f529:
.. only:: starlingx
@@ -7,7 +7,7 @@
.. only:: partner
.. include:: /deploy/index.rst
.. include:: /deploy/index-deploy-da06a98b83b1.rst
:start-after: kub-begin
:end-before: kub-end

View File

@@ -1,3 +1,5 @@
.. _index-install-e083ca818006:
===================
Installation Guides
===================
@@ -17,7 +19,7 @@ StarlingX R5.0 is the most recent supported release of StarlingX.
.. toctree::
:maxdepth: 1
r5_release/index
r5_release/index-install-r5-ca4053cb3ab9

View File

@@ -11,8 +11,7 @@ StarlingX R1.0 Installation
Installation of the current :ref:`latest_release` is recommended.
This is the installation guide for the StarlingX R1.0 release. If this is not
the installation guide you want to use, see the :doc:`available installation
guides </deploy_install_guides/index>`.
the installation guide you want to use, see the :ref:`index-install-e083ca818006`.
------------
Introduction

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

@@ -278,8 +278,7 @@ Console usage:
For details on how to specify installation parameters such as rootfs device
and console port, see :ref:`config_install_parms`.
Follow the :doc:`StarlingX Installation and Deployment Guides </deploy_install_guides/index>`
to continue.
Follow the :ref:`index-install-e083ca818006` instructions to continue.
* Ensure that boot priority on all VMs is changed using the commands in the "Set
the boot priority" step above.

View File

@@ -1,3 +1,5 @@
.. _index-install-r5-distcloud-8164d5952ac5:
===================================
Distributed Cloud Installation R5.0
===================================

View File

@@ -1,10 +1,13 @@
.. _index-install-r5-ca4053cb3ab9:
===========================
StarlingX R5.0 Installation
===========================
StarlingX provides a pre-defined set of standard
:doc:`deployment configurations </introduction/deploy_options>`. Most deployment options may
be installed in a virtual environment or on bare metal.
:doc:`deployment configurations </introduction/deploy_options>`.
Most deployment options may be installed in a virtual
environment or on bare metal.
-----------------------------------------------------
Install StarlingX Kubernetes in a virtual environment
@@ -114,7 +117,7 @@ Install StarlingX Distributed Cloud on bare metal
.. toctree::
:maxdepth: 1
distributed_cloud/index
distributed_cloud/index-install-r5-distcloud-8164d5952ac5
-----------------
Access Kubernetes
@@ -132,5 +135,5 @@ Access StarlingX OpenStack
.. toctree::
:maxdepth: 1
openstack/index
openstack/index-install-r5-os-bf0f49699241

View File

@@ -1,3 +1,5 @@
.. _index-install-r5-os-bf0f49699241:
===================
StarlingX OpenStack
===================

View File

@@ -278,7 +278,7 @@ Console usage:
For details on how to specify installation parameters such as rootfs device
and console port, see :ref:`config_install_parms`.
Follow the :doc:`StarlingX Installation and Deployment Guides </deploy_install_guides/index>`
Follow the :ref:`index-install-e083ca818006`
to continue.
* Ensure that boot priority on all VMs is changed using the commands in the "Set

View File

@@ -1,5 +1,5 @@
.. _dist-cloud-index:
.. _index-dist-cloud-f5dbeb16b976:
=================
Distributed Cloud
@@ -16,5 +16,5 @@ distributed network of |prod| systems.
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-dist-cloud-kub-95bef233eef0

View File

@@ -1,11 +1,11 @@
.. _dist-cloud-kubernetes-index:
.. _index-dist-cloud-kub-95bef233eef0:
.. include:: /_includes/toc-title-dc-kub.rest
.. only:: partner
.. include:: /dist_cloud/index.rst
.. include:: /dist_cloud/index-dist-cloud-f5dbeb16b976.rst
:start-after: kub-begin
:end-before: kub-end

View File

@@ -3,6 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _index-fault-98d5f50a9b8c:
================
Fault Management
================
@@ -18,7 +20,7 @@ StarlingX Kubernetes
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-fault-kub-f45ef76b6f16
-------------------
StarlingX OpenStack
@@ -37,4 +39,4 @@ that are monitored and reported for the |prod-os| application through the
.. toctree::
:maxdepth: 2
openstack/index
openstack/index-fault-os-a1a5cae095b3

View File

@@ -1,10 +1,10 @@
.. _fault-mgmt-kubernetes-index:
.. _index-fault-kub-f45ef76b6f16:
.. include:: /_includes/toc-title-fm-kub.rest
.. only:: partner
.. include:: /fault-mgmt/index.rst
.. include:: /fault-mgmt/index-fault-98d5f50a9b8c.rst
:start-after: kub-begin
:end-before: kub-end

View File

@@ -1,12 +1,7 @@
.. _fault-mgmt-openstack-index:
.. _index-fault-os-a1a5cae095b3:
.. include:: /_includes/toc-title-fm-os.rest
.. only:: partner
.. include:: /fault-mgmt/index.rst
:start-after: os-begin
:end-before: os-end
.. toctree::
:maxdepth: 1
@@ -34,4 +29,4 @@ OpenStack customer log messages
openstack-customer-log-messages-270s-virtual-machines
openstack-customer-log-messages-401s-services
openstack-customer-log-messages-700s-virtual-machines
openstack-customer-log-messages-700s-virtual-machines

View File

@@ -1,5 +1,5 @@
.. _guest-integration-index:
.. _index-guest-ef8c9a20bf6c:
=================
@@ -21,7 +21,7 @@ applications are able to receive |PTP| status notifications from
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-guest-kub-5c89ec07e141
-------------------------
OpenStack VNF integration
@@ -38,4 +38,4 @@ application on |prod-os|.
.. toctree::
:maxdepth: 2
openstack/index
openstack/index-guest-os-17b56b5745b6

View File

@@ -1,10 +1,10 @@
.. _guest-kubernetes-index:
.. _index-guest-kub-5c89ec07e141:
.. include:: /_includes/toc-title-guest-kub.rest
.. only:: partner
.. include:: /guest_integration/index.rst
.. include:: /guest_integration/index-guest-ef8c9a20bf6c.rst
:start-after: kub-begin
:end-before: kub-end

View File

@@ -1,10 +1,10 @@
.. _guest-openstack-index:
.. _index-guest-os-17b56b5745b6:
.. include:: /_includes/toc-title-guest-os.rest
.. only:: partner
.. include:: /guest_integration/index.rst
.. include:: /guest_integration/index-guest-ef8c9a20bf6c.rst
:start-after: os-begin
:end-before: os-end

32
doc/source/index.rst Executable file → Normal file
View File

@@ -37,7 +37,7 @@ Learn more about StarlingX:
.. toctree::
:maxdepth: 2
introduction/index
introduction/index-intro-27197f27ad41
-------------------------
Deployment configurations
@@ -46,7 +46,7 @@ Deployment configurations
.. toctree::
:maxdepth: 2
deploy/index
deploy/index-deploy-da06a98b83b1
--------
Planning
@@ -55,7 +55,7 @@ Planning
.. toctree::
:maxdepth: 2
planning/index
planning/index-planning-332af0718d15
-------------------
Installation guides
@@ -64,7 +64,7 @@ Installation guides
.. toctree::
:maxdepth: 2
deploy_install_guides/index
deploy_install_guides/index-install-e083ca818006
--------
Security
@@ -73,7 +73,7 @@ Security
.. toctree::
:maxdepth: 2
security/index
security/index-security-84d0d8aa401b
--------------------
@@ -83,7 +83,7 @@ System configuration
.. toctree::
:maxdepth: 2
system_configuration/index
system_configuration/index-sysconf-d511820651f0
-------------
@@ -93,7 +93,7 @@ Data networks
.. toctree::
:maxdepth: 2
datanet/index
datanet/index-datanet-e316bf6c2f6a
---------------
Node management
@@ -102,7 +102,7 @@ Node management
.. toctree::
:maxdepth: 2
node_management/index
node_management/index-node-mgmt-cd0f9d8eaee6
-------
Storage
@@ -111,7 +111,7 @@ Storage
.. toctree::
:maxdepth: 2
storage/index
storage/index-storage-6cd708f1ada9
----------------
@@ -121,7 +121,7 @@ Fault management
.. toctree::
:maxdepth: 2
fault-mgmt/index
fault-mgmt/index-fault-98d5f50a9b8c
------------------
@@ -131,7 +131,7 @@ Backup and restore
.. toctree::
:maxdepth: 2
backup/index
backup/index-backup-1b466179efc3
-------
@@ -141,7 +141,7 @@ Updates
.. toctree::
:maxdepth: 2
updates/index
updates/index-updates-e3b970bb69ce
-----------
@@ -151,7 +151,7 @@ Admin tasks
.. toctree::
:maxdepth: 2
admintasks/index
admintasks/index-admintasks-768a6e9aaeff
----------
@@ -161,7 +161,7 @@ User tasks
.. toctree::
:maxdepth: 2
usertasks/index
usertasks/index-usertasks-b18b379ab832
-----------------
@@ -171,7 +171,7 @@ Guest integration
.. toctree::
:maxdepth: 2
guest_integration/index
guest_integration/index-guest-ef8c9a20bf6c
---------
@@ -191,7 +191,7 @@ Distributed Cloud
.. toctree::
:maxdepth: 2
dist_cloud/index
dist_cloud/index-dist-cloud-f5dbeb16b976
-----------------
Deprecated guides

View File

@@ -1,3 +1,5 @@
.. _index-intro-27197f27ad41:
============
Introduction
============

View File

@@ -1,3 +1,5 @@
.. _index-node-mgmt-cd0f9d8eaee6:
===============
Node Management
===============
@@ -40,7 +42,7 @@ Complete instructions for adding a worker node are provided in the
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-node-mgmt-kub-5ff5993b9c60
---------
OpenStack
@@ -62,4 +64,4 @@ Add an OpenStack compute node
.. toctree::
:maxdepth: 2
openstack/index
openstack/index-node-mgmt-os-ccb47338adbc

View File

@@ -1,11 +1,11 @@
.. _node-mgmt-kubernetes-index:
.. _index-node-mgmt-kub-5ff5993b9c60:
.. include:: /_includes/toc-title-node-kub.rest
.. only:: partner
.. include:: /node_management/index.rst
.. include:: /node_management/index-node-mgmt-cd0f9d8eaee6.rst
:start-after: kub-begin
:end-before: kub-end

View File

@@ -1,11 +1,11 @@
.. _node-mgmt-openstack-index:
.. _index-node-mgmt-os-ccb47338adbc:
.. include:: /_includes/toc-title-node-os.rest
.. only:: partner
.. include:: /node_management/index.rst
.. include:: /node_management/index-node-mgmt-cd0f9d8eaee6.rst
:start-after: os-begin
:end-before: os-end

View File

@@ -111,8 +111,8 @@ Edge cloud platform
*******************
#. Install STX environment: follow the instructions from the
:doc:`Installation Guides </deploy_install_guides/index>` to install one
STX environment (for example STX AIO).
:ref:`index-install-e083ca818006` to install one STX environment (for
example STX AIO).
#. Prepare a :abbr:`VM (Virtual Machine)` image. Create image ``tsn_ubuntu_19_04.img``
based on Ubuntu 19.04 with the required binaries shown below.

0
doc/source/planning/.vscode/settings.json vendored Executable file → Normal file
View File

0
doc/source/planning/figures/eag1565612501060.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

0
doc/source/planning/figures/fqq1554387160841.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

0
doc/source/planning/figures/gnc1565626763250.jpeg Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 108 KiB

After

Width:  |  Height:  |  Size: 108 KiB

0
doc/source/planning/figures/jow1404333560781.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 105 KiB

After

Width:  |  Height:  |  Size: 105 KiB

0
doc/source/planning/figures/jrh1581365123827.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 43 KiB

0
doc/source/planning/figures/noc1581364555316.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

0
doc/source/planning/figures/rld1581365711865.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

0
doc/source/planning/figures/rsn1565611176484.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

0
doc/source/planning/figures/sye1565216249447.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

0
doc/source/planning/figures/uac1581365928043.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

0
doc/source/planning/figures/vzz1565620523528.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

0
doc/source/planning/figures/xjf1565612136985.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

0
doc/source/planning/figures/zpk1486667625575.png Executable file → Normal file
View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

@@ -1,3 +1,5 @@
.. _index-planning-332af0718d15:
.. Planning file, created by
sphinx-quickstart on Thu Sep 3 15:14:59 2020.
You can adapt this file completely to your liking, but it should at least
@@ -26,7 +28,7 @@ installation planning.
.. toctree::
:maxdepth: 2
kubernetes/index
kubernetes/index-planning-kub-913bd621ac0f
---------
OpenStack
@@ -42,4 +44,4 @@ requires additional network, storage, security and resource planning.
.. toctree::
:maxdepth: 2
openstack/index
openstack/index-planning-os-e815f964d279

View File

View File

0
doc/source/planning/kubernetes/dns-and-ntp-servers.rst Executable file → Normal file
View File

View File

0
doc/source/planning/kubernetes/hard-drive-options.rst Executable file → Normal file
View File

View File

@@ -1,10 +1,10 @@
.. _planning_kubernetes_index:
.. _index-planning-kub-913bd621ac0f:
.. include:: /_includes/toc-title-planning-kub.rest
.. only:: partner
.. include:: /planning/index.rst
.. include:: /planning/index-planning-332af0718d15.rst
:start-after: kub-begin
:end-before: kub-end

0
doc/source/planning/kubernetes/l2-access-switches.rst Executable file → Normal file
View File

View File

View File

View File

View File

View File

View File

View File

View File

View File

View File

0
doc/source/planning/kubernetes/the-ethernet-mtu.rst Executable file → Normal file
View File

View File

0
doc/source/planning/kubernetes/the-storage-network.rst Executable file → Normal file
View File

0
doc/source/planning/kubernetes/tpm-planning.rst Executable file → Normal file
View File

View File

View File

View File

View File

0
doc/source/planning/openstack/ethernet-interfaces.rst Executable file → Normal file
View File

View File

View File

View File

@@ -1,11 +1,11 @@
.. _planning-openstack-index:
.. _index-planning-os-e815f964d279:
.. include:: /_includes/toc-title-planning-os.rest
.. only:: partner
.. include:: /planning/index.rst
.. include:: /planning/index-planning-332af0718d15.rst
:start-after: os-begin
:end-before: os-end

Some files were not shown because too many files have changed in this diff Show More