bc8e3704db
File location changes to support DS flattend Install TOC Add minitocs and remove duplicate include directive Convert images to figures and add captions Incorporate server prep. steps Add links to post-install steps. Inline overview and HW topics in procs. Patchset 1 review updates. Rework to reuse some StX install content in partner context and some partner install content in StX context. Conditionalize ipv6_note Share aio_duplex_extend Conditionalize Openstack prod name Add HW requirement includes for worker and storage nodes. Link worker and stor reqs to DX, StD and Dedicated install topics. Fix comment notation Correct for duplicate strings in output Updates and additions based on GW review Make ansible_install_time_only note available DS. Move link target from r6 > r7 Temporarily restore alarms to satisfy build Migrate DX flattening to new layout Additional HW requirements to DX, Std and Dedicated tables. Migrate Standard flattening to new layout Roll this-ver forward to r7 Migrate Dedicated Storage flattening to new layout Address review comments. Standardize HW requirement tables Support horizontally conditionalized inline content Address additional review comments Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I14c8a1e51f6b6ceff69be063a654b4aadb7d3b8c
124 lines
4.0 KiB
Plaintext
Executable File
124 lines
4.0 KiB
Plaintext
Executable File
.. Common string substitutions for brand customization and consistency.
|
|
.. NOTE: Do not use underscores in these substitution names.
|
|
.. For more information, see
|
|
.. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
|
|
|
|
.. Organization name
|
|
.. |org| replace:: StarlingX
|
|
|
|
.. Short and long product names such as "StarlingX" and "Acme Co. StarlingX"
|
|
.. |prod| replace:: StarlingX
|
|
.. |prod-long| replace:: StarlingX
|
|
.. |prod-os| replace:: StarlingX OpenStack
|
|
.. |prod-dc| replace:: Distributed Cloud
|
|
.. |prod-p| replace:: StarlingX Platform
|
|
.. |prod-hor| replace:: Horizon
|
|
.. |prod-hor-long| replace:: |prod-hor| Web Interface
|
|
.. |os-prod-hor-long| replace:: OpenStack |prod-hor-long|
|
|
.. |os-prod-hor| replace:: OpenStack |prod-hor|
|
|
.. |prod-img| replace:: http://mirror.starlingx.cengn.ca/mirror/starlingx/
|
|
.. |prod-abbr| replace:: StX
|
|
|
|
.. Guide names; will be formatted in italics by default.
|
|
.. |node-doc| replace:: :title:`StarlingX Node Configuration and Management`
|
|
.. |planning-doc| replace:: :title:`StarlingX Planning`
|
|
.. |sec-doc| replace:: :title:`StarlingX Security`
|
|
.. |inst-doc| replace:: :title:`StarlingX Installation`
|
|
.. |stor-doc| replace:: :title:`StarlingX Storage Configuration and Management`
|
|
.. |intro-doc| replace:: :title:`StarlingX Introduction`
|
|
.. |fault-doc| replace:: :title:`StarlingX Fault Management`
|
|
.. |sysconf-doc| replace:: :title:`StarlingX System Configuration`
|
|
.. |backup-doc| replace:: :title:`StarlingX Backup and Restore`
|
|
.. |deploy-doc| replace:: :title:`StarlingX Deployment Configurations`
|
|
.. |distcloud-doc| replace:: :title:`StarlingX Distributed Cloud`
|
|
.. |usertasks-doc| replace:: :title:`StarlingX User Tasks`
|
|
.. |admintasks-doc| replace:: :title:`StarlingX Administrator Tasks`
|
|
.. |datanet-doc| replace:: :title:`StarlingX Data Networks`
|
|
.. |os-intro-doc| replace:: :title:`OpenStack Introduction`
|
|
.. |updates-doc| replace:: :title:`StarlingX Updates and Upgrades`
|
|
|
|
.. Name of downloads location
|
|
|
|
.. |dnload-loc| replace:: a StarlingX mirror
|
|
|
|
.. File name prefix, as in stx-remote-cli-<version>.tgz. May also be
|
|
used in sample domain names etc.
|
|
|
|
.. |prefix| replace:: stx
|
|
.. |l-prefix| replace:: |prefix|
|
|
|
|
.. space character. Needed for padding in tabular output. Currently
|
|
used where |prefix| replacement is a length shorter than 3.
|
|
To insert a space, use "replace:: \ \" (with two spaces)
|
|
To insert no spaces, use "replace:: \"
|
|
|
|
.. |s| replace:: \
|
|
|
|
.. product capabilities
|
|
|
|
.. |max-workers| replace:: 99
|
|
|
|
.. Product name used in patch file names
|
|
|
|
.. |pn| replace:: STLX
|
|
|
|
.. versioning
|
|
|
|
.. StarlingX (|prod|)
|
|
|
|
.. |prod-ver| replace:: |this-ver|
|
|
|
|
.. Version at which we cut over to Deb.
|
|
.. |deb-release-ver| replace:: release 8.0
|
|
|
|
.. StX OpenStack (|prod-os|)
|
|
|
|
.. |prod-os-ver| replace:: |prod-ver|
|
|
|
|
|
|
.. Product version used in patch file names
|
|
|
|
.. |pvr| replace:: 00004
|
|
|
|
.. |release-caveat| replace:: This is a pre-release feature and may not function as described in |prod| 5 documentation.
|
|
|
|
..
|
|
.. Misc
|
|
..
|
|
|
|
.. |installer-image-name| replace:: bootimage
|
|
|
|
.. |OVS-DPDK| replace:: |OVS|-|DPDK|
|
|
.. |ovs-dpdk| replace:: ovs-dpdk
|
|
|
|
.. |vswitch-label| replace:: openvswitch=enabled
|
|
|
|
.. |registry-url| replace:: https://hub.docker.com/layers
|
|
|
|
.. |only-target| replace:: StarlingX
|
|
|
|
.. |bare-metal| replace:: bare metal
|
|
|
|
.. |reg-string| replace:: public open source registries
|
|
|
|
..
|
|
.. Custom refs
|
|
..
|
|
|
|
|
|
.. Used in installing-a-subcloud-without-redfish-platform-management-service.rst
|
|
because target lable differs here/partner contexts.
|
|
|
|
.. |_link-inst-book| replace:: :ref:`Installation guide <index-install-e083ca818006>`
|
|
|
|
|
|
.. Debian Tech Preview
|
|
|
|
.. |deb-prev-prods| replace:: |prod|
|
|
.. |deb-510-kernel-release| replace:: release 6.0
|
|
.. |deb-eval-release| replace:: release 7.0
|
|
.. |deb-production-release| replace:: release 8.0
|
|
.. |deb-install-step-change| replace:: \
|
|
.. |deb-dup-std-na| replace:: Duplex, and standard configurations are not available.
|
|
.. |deb-update-iso| replace:: \
|