27 Commits

Author SHA1 Message Date
MCamp859
4252738a07 Replace stx with prefix substitution (3 of 3)
3rd review in a group to change instances of
stx-openstack to |prefix|-openstack
This group includes old guides for configuration, operations, and
developer resources.
Fixed issue with * in 1 file.

Change-Id: I188fd9bef38a012a1eaf7334a2f5d9fe55e7c75d
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-11-16 14:53:39 -05:00
Ron Stone
2b62f49a9d Fix symlinks
Changed paths to avoid '..', which breaks symlinks in newer versions of sphinx.
Consolidated installation include files under /_includes. Prefixed r5 versions with 'r5_'
Moved files that are used up/down, but at different paths under /shared/_includes
and /shared/figures
Move two include files to /_includes
Moved addtional images to /shared/figures/... Required for DS platform builds.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia38f4205c5803b3d1fc043e6c59617c34a4e5cbd
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-09-02 13:31:45 +00:00
egoncalv
1a2b9390b8 Added page to WRCP docs under Admin Tasks
Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: I018058f55e31f2c37a22f68e4fb76db9617ff276
2021-08-16 09:34:37 -03:00
egoncalv
cd1f0e68ff Inclusive Language Updates
Patch 1: Worked on Bart and Mary's comments.

Patch 2: Worked on Bart's comments.

Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: Ida78101e923dbce32a1c17ba45becb4b62f17c4d
2021-06-11 17:18:40 -03:00
Juanita-Balaraj
63cd4f5fdc CephFS RWX Support in Host-based Ceph
Incorporated patchset 1 review comments
Updated patchset 5 review comments
Updated patchset 6 review comments
Fixed merge conflicts
Updated patchset 8 review comments

Change-Id: Icd7b08ab69273f6073b960a13cf59905532f851a
Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
2021-05-03 16:39:45 -04:00
Zuul
dfbe3ef3b8 Merge "Add Distributed guide" 2021-04-20 15:48:26 +00:00
Martin, Chen
03ede40f2f Migration guide
Small edits to fix format of numbered steps.
Resolved merge conflict.

Change-Id: If6e3edb5e4f0e2a2ae5fb636a82796029c773d1d
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-04-12 12:03:39 -04:00
Rafael Jardim
96760528b1 Add Distributed guide
Some reorganization to accomodate up/down variances.
Fixed merge conflicts
Incorporated patchset 7 review comments

Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com>
Change-Id: I7356e81526a94c0249526b44ce667f789245f6e2
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 08:18:08 -04:00
MCamp859
9a46dfae30 Edited guides to fix HTML output
Fixed indents in 2 files to correct HTML output.
Also fixed 1 typo.

Change-Id: I376c50073a4424bce997e29bc41428f72c0349a3
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-02-08 13:36:50 -05:00
Juanita-Balaraj
0c4aa91ca4 Updated Patch Set 5 to include review comments
Changed name of file to:
admin-application-commands-and-helm-overrides.rst

Updated Strings.txt

Updated formatting issues:
installing-and-running-cpu-manager-for-kubernetes.rst

Updated Patch Set 4 to include review comments

Admin Tasks Updated

Changed name of include file to:
isolating-cpu-cores-to-enhance-application-performance.rest

Change-Id: I0b354dda3c7f66da3a5d430839b5007a6a19cfad
Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
Signed-off-by: Stone <ronald.stone@windriver.com>
Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
2021-01-11 23:40:36 -05:00
MCamp859
c1c9f5b26e Editorial updates on Ceph Cluster Migration guide
Follow on to review 723291.
Text edits to align with format of other STX guides.
Also alphasorted Operations index list.

Change-Id: I7311c696070ab95a11e6396f109d310d74495948
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Signed-off-by: Martin, Chen <haochuan.z.chen@intel.com>
2020-07-20 13:43:48 +08:00
MCamp859
0c793580c3 Describe K8S NodePorts restrictions
Closes-Bug: 1874823

Change-Id: Ia45aab96bc7aa512c941d555d052edde9a925417
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-07 16:28:13 -04:00
Zuul
34102368c1 Merge "Add a document about rook migration" 2020-05-26 17:36:21 +00:00
MCamp859
42fb8da68f Add Kata Containers guide
Added new guide to Configuration area of documentation.

Story: 2006145

Task: 38484

Closes-Bug: 1873109

Change-Id: Ie516b78c45eb8021ca1d6f2268c96e37c662cf65
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
2020-05-26 08:31:35 +00:00
Martin, Chen
e00143e3f3 Add a document about rook migration
This document introduces the process for deployed StarlingX
system to migrate from ceph cluster to rook-ceph containerized
cluster

Story: 2005527
Task: 39561

Change-Id: Ib81720124fca7513f7e4a0edb893af3ac7fe6816
Signed-off-by: Martin, Chen <haochuan.z.chen@intel.com>
2020-05-25 14:09:19 +08:00
Kristal Dale
13f33b85ef Update use of 'compute' node to 'worker' node
Per recent updates, updating use of 'compute' node to be
'worker' node. StarlingX uses worker nodes, and a 'compute' node
is a specialization of a worker node (OpenStack compute label applied).

- Update narrative text to use worker node
- Update shell scripts to use NODE instead of COMPUTE

Updated non-versioned content and R3 installation guides.

Change-Id: Ia3c5d354468f18efb79c823e5bfddf17e34998a9
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-02-06 13:21:47 -08:00
Zuul
a3d9480d77 Merge "Add doc for k8s intel gpu device plugin under operations" 2019-12-18 20:40:52 +00:00
MCamp859
ec62ca3cda Add operation doc for Docker Reg Mgmt
This operation guide describes Docker registry tasks to be completed on
controller nodes.

Patchset 3: Updates and additional content per feedback. Replaced
CLI descriptions with link to CLI ref (and update CLI ref with additional info)
Patchset 4: Fix typo and move general info link to overview.

Story: 2006881
Tasks: 37490, 37509, 37510

Includes reviewer comment and removes possible upstream urls.

Change-Id: I5d167adbd7c4141cd765e4dc5a962fbc45a2e13e
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-17 09:48:06 -08:00
SidneyAn
cc14f92647 Add doc for k8s intel gpu device plugin under operations
Patchset 3: reST formatting, minor grammar and capitalization, typo
Patchset 6: minor grammar edits
Patchset 7: Wording updates per feedback

Story: 2005937
Task: 37644

Change-Id: I65c5fd9be894b5de5132af43daba202496b6654e
Signed-off-by: SidneyAn <ran1.an@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-16 14:01:33 -08:00
Kristal Dale
904759a156 K8s cluster guide: Minor edits for grammar
Minor edits for consistency with other docs and grammar fixes.

Change-Id: I1f06263010b2f7d20e3d74cca77d223a96ab1352
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-11 10:30:56 -08:00
Kristal Dale
a2a02ea798 Add content for K8s cluster guide
- Overview section
- Interface section

Story: 2006880
Task: 37492

Change-Id: I5cb7aa7c0599c26a3ba0a4eaf56383521f9f5d9e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-10 16:40:20 -08:00
Zuul
764f75b279 Merge "Add operation doc for TSN" 2019-12-04 00:25:50 +00:00
Huifeng Le
9b8f26f120 Add operation doc for TSN
This operation guide will introduce how to deploy and run TSN application
in STX virtual machine workload.

Patchset 3: Added reST and doc formatting for readability and consistency in
docs. Also: capitalization, spelling, and grammar.

Story: 2006885
Task: 37487

Change-Id: If48c7154b6aa4a938b8216c2c2ed7a322a20ecd8
Co-authored-by: Yizhou Xu <yizhoux.xu@intel.com>
Signed-off-by: Huifeng Le <huifeng.le@intel.com>
Signed-off-by: MCamp859 <maryx.camp@intel.com>
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-02 16:48:40 -08:00
Mingyuan Qi
d252a8c9f8 Add doc for k8s qat device plugin under operations
Story: 2005514
Task: 37610

Change-Id: Iaeb79f500c9a90d589eef4d7dd5e528abfc8adb7
Signed-off-by: Mingyuan Qi <mingyuan.qi@intel.com>
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-11-26 15:02:20 -05:00
Kristal Dale
33e5ad0462 Update R3 stub pages
- Rename upgrade stub page to 'Move to New Version of StarlingX'
- Add stub page for Time Sensitive Networking

Change-Id: I3ce9fb71f44728a272975e008b786502d2fa80f8
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-11-20 14:52:01 -08:00
Kristal Dale
c9da107411 Move dev resource guides
- Remove the patching stub page as content already exists
- Move the Upgrade stub page into dev resources

Change-Id: I7b1b606142538c53b90c438efee3960598a9ad57
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-11-19 13:50:23 -08:00
Kristal Dale
22f4e7843e Add nav sections/folders for config guides and admin guides
- New nav section: Configuration, topic specific config guides
- New nav section: Operation Guides, task specific guides
- New nav item: CLI Reference
- Sections organized by general, kubernetes, openstack
- Stubb pages added for all top level topics in sections, with
  link to associated StoryBoard story

Change-Id: I59f58adbb27bf4d65755cddc40a8ec565fb949f1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-11-15 16:38:53 -08:00