89 Commits

Author SHA1 Message Date
Rafael Falcao
75b4f9f0b4 Update stx-openstack related docs with armada deprecation
Since armada (deprecated) is being replaced by FluxCD in the
stx-openstack application [1], it is needed to also replace
the mentions of Armada in the stx-openstack related docs to
FluxCD.

[1] - https://review.opendev.org/c/starlingx/openstack-armada-app/+/862516

Signed-off-by: Rafael Falcao <rafael.vieirafalcao@windriver.com>
Change-Id: I0b2959630c970b51979db5eaefa81d59db477125
2022-10-28 15:50:00 -03:00
Ron Stone
4868e1c226 Spelling and typo fixes
Based on sphinx spellchecker testing/refinement.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ibfe9b6d7bc8bf044a7fff0ac7e362e4067b17989
2022-08-16 16:19:27 -04:00
Zuul
92452b6e04 Merge "relocate /www to /var/www" 2022-08-03 17:46:22 +00:00
Bin Qian
5aea066fc8 relocate /www to /var/www
Relocate writable /www to /var/www

Story: 2009101
Task: 43477

Change-Id: Ie6bf6a6504bca9f98e994fb2eb34f9522dc363fb
Depends-on: https://review.opendev.org/c/starlingx/metal/+/810023
Signed-off-by: Bin Qian <bin.qian@windriver.com>
2022-08-03 17:17:06 +00:00
Ron Stone
cf66f5d279 Armada Deprecation and Replacement
First pass - generic updates only. (command input/output to be done)
Address patchset 1 review comments.
Replace examples using openstack with metrics server
Remove DS app from application-list output
Additional migration to FluxCD (snmp, auditd)
Minor textual change.
Fix merge conflict.
Revert install r5 change.

Story: 2009138
Task: 45238

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia40ff45f12ec7b7ffa859e0d8bb5535303870d83
2022-06-29 10:40:56 -04:00
Elisamara Aoki Goncalves
366277308c Remove Telemetry Services from docs (pick r6)
Temporarily commented out anything related to the Telemetry Services as this may be required in the future.

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: Iffb7874b1d8ba940b07fd1e43358d0dba4ed624e
2022-04-06 17:17:22 +00:00
Zuul
77dace0f1c Merge "Revert "relocate /www to /var/www"" 2021-12-16 19:04:37 +00:00
Bin Qian
6996357d4f Revert "relocate /www to /var/www"
This reverts commit 6b497721c9a7bc69e5a1595fee0060f8e8c9ad7e.

Reason for revert: revert as this change is not applicable for stx.6.0. Will merge to master branch when stx6.0 is branched for the doc repo

Change-Id: Ibc903257914890fbd4c7996696c2930622062039
2021-12-16 16:48:19 +00:00
Zuul
8bf08bf4cf Merge "relocate /www to /var/www" 2021-12-15 22:12:09 +00:00
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
MCamp859
68e5519300 Fix Build Guide step for building packages.
Change "generate-local-repo.sh" to "generate-centos-repo.sh"

Closes-Bug: 1946118

Change-Id: I7048d4b6d3be1f0a3cad2f8cf430ab1f948eb230
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-10-09 18:05:55 -04:00
Bin Qian
6b497721c9 relocate /www to /var/www
Relocate writable /www to /var/www

Story: 2009101
Task: 43477
Depends-on: https://review.opendev.org/c/starlingx/metal/+/810023
Change-Id: I1965bb9f6bdb679399b75b9f107649a6ac74d95a
Signed-off-by: Bin Qian <bin.qian@windriver.com>
2021-09-29 14:17:56 -04:00
Zuul
8dfd83fd08 Merge "Introduce the Test Plan Section in git commit message." 2021-09-22 19:56:08 +00:00
Scott Little
2877e95b34 fix BUILD_IS_SLOW typo
Signed-off-by: Scott Little <scott.little@windriver.com>
Change-Id: Ic15382ed06635355df2a6c20dbfb5f90d42638e3
2021-09-21 13:39:03 -04: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
Ramaswamy Subramanian
7878aacc77 Introduce the Test Plan Section in git commit message.
The guidance for adding test details as a comment in the review is
removed.  It's replaced with instructions to include the test details
in the commit message.  Additional considerations for test based on
code changes in specific repositories are added.

Added instructions for including '-x' option when cherry-picking code.

Change-Id: Ic23386b15fc1b2fdb1664921f317322584018eac
Signed-off-by: Ramaswamy Subramanian <ramaswamy.subramanian@windriver.com>
2021-08-31 14:31:44 -04:00
egoncalv
c12cf2bc59 Replaced relase version to nn.nn
Solved building and merge conflict problem.

Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: I9272fa6246bd60ace6a5f7ba64fdb4181b1e4721
2021-06-14 20:16:28 -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
Zuul
4f069ce8f6 Merge "Editorial updates to SDO Rendezvous guide" 2021-04-20 16:00:53 +00:00
Zuul
8ff7a105b5 Merge "Add backup and restore guide for rook provisioned system" 2021-04-13 11:35:28 +00:00
MCamp859
b33eb76aa7 Editorial updates to SDO Rendezvous guide
Follow on to review 777038.
Text edits to align with format of other STX guides.

Change-Id: Id2bce5690e62a9d7e9dcc3295dead3b24264478c
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-04-07 11:38:00 -04:00
Poornima
e6965ea9da Recipe for integrating SDO RV service on Starlingx
This patch describes step by step details for enabling
SDO-RV service on starlingx5.0

Story: 2008117
Task: 41866

Change-Id: I955a8d95b4c31b018fc0818e26daf35bdf3bb469
Signed-off-by: Poornima <poornima.y.n@intel.com>
2021-04-07 01:13:17 +05:30
Zuul
4c41786955 Merge "Introduce system restore-complete command" 2021-02-01 15:26:07 +00:00
MCamp859
76b43204ee Update paths in Layered Build Guide & Reference
Changed mirror paths in the layered build guide and layered build
reference to remove hard-coded references to stx-r1, pike, and
cgcs-centos.
Added review comments.

These edits are a follow-on to Build Guide review: 757932

Closes-Bug: 1883760

Change-Id: I898e3bf387fb28a5c2e9f76713cf50fa19ce8fe6
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-01-22 17:25:22 -05:00
MCamp859
c6f5466952 Introduce system restore-complete command
Update backup & restore guide

Closes-Bug: 1912485

Change-Id: Idc3f6fd86cdf6c1dbe7bd646ac57c625fbdd67fd
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-01-20 21:27:43 -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
7dc67dd376 Update paths in Layered Build Guide (Chinese)
Changed mirror paths in this guide to remove hard-coded references to
stx-r1, pike, and cgcs-centos.

This edit is a follow-on to Build Guide review:
https://review.opendev.org/#/c/757932/

Similar changes to the Layered Build Guide & Ref (English) are in:
https://review.opendev.org/#/c/762761/

Change-Id: I904423cbdca152b1fd31c3b7143f641d23182e66
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-11-15 11:50:20 -05:00
MCamp859
6edc10617f Fix restore instructions
Corrected subheadings in platform restore section.

Closes-Bug: 1901002

Change-Id: I3755aaec2eebd3249a1b54a3ce39c8bde3e5effc
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-10-23 12:30:49 -04:00
Saul Wold
86365c6761 remove pike from mirror path name
StarlingX has moved beyond the OpenStack pike release and will
be following master and the latest release, so don't include
OpenStack release names.

Remove 'cgcs-' and 'tis-' elements from several paths and command
names.  Also replace 'stx-r1' with 'stx' in various paths.

Story: 2006387
Task: 41102
Depends-On: https://review.opendev.org/#/c/687401
Depends-On: https://review.opendev.org/#/c/687403
Change-Id: Ic9c4f73d11f864aeb72d6cd0c63553b67b9a39e1
Signed-off-by: Scott Little <scott.little@windriver.com>
2020-10-22 11:47:53 -04:00
Martin, Chen
ed4d3037ea Add backup and restore guide for rook provisioned system
Change-Id: Id0398b024fc2842dcd159e24940b366407d630ac
Signed-off-by: Martin, Chen <haochuan.z.chen@intel.com>
2020-09-03 09:01:55 +08:00
Mihail-Laurentiu Trica
76ed91f817 Update instructions for TSN
Updated instructions where possible and added detailed instructions where missing

Story: 2006746
Task: 40368

Change-Id: Ic83b30273be31b3a51d1c60b12f46cb90bf20c64
Signed-off-by: Mihail-Laurentiu Trica <mihail-laurentiu.trica@intel.com>
2020-07-20 05:59:12 +00:00
Zuul
6f1da776de Merge "Update Docker image build with builder options" 2020-07-14 06:19:53 +00:00
Zuul
5fed870012 Merge "Add packaging reference" 2020-07-13 14:31:24 +00:00
Zuul
d61c9875b3 Merge "Add a guide about how to enable OPC UA" 2020-07-07 21:18:45 +00:00
Matt Peters
9017528715 Update Docker image build with builder options
Adds the documentation for the image directives files for
the docker builder.  The options provide optional configuration
that can be used to specify the docker source context and build
directives.

Story: 2006537
Task: 40291
Change-Id: I5fcd3acaad8e603d1d10a72b94d2b4e0a5870f4e
Signed-off-by: Matt Peters <matt.peters@windriver.com>
2020-07-07 14:45:49 -05:00
MCamp859
f437f037b6 Add packaging reference
Closes-Bug: 1883327

Change-Id: I8045bf88d613adee73a01fceb645874e26c157ec
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-07 12:17:08 -04:00
Zuul
579746ed4b Merge "Build Guide changes as per stx3.0 code" 2020-07-06 11:24:35 +00:00
Poornima
462f2c9167 Build Guide changes as per stx3.0 code
We made the following changes to match the stx3.0 code:

1.Checkout stx3.0 tools project
2.Update folder structure for downloaded packages
3.Change user permission for mirror folder
4.Corrections in Build installer

Closes-Bug: 1884921

Change-Id: I1c1c2c0c791aaa611aa13bf29d3196d20c8f60f7
Signed-off-by: Poornima <poornima.y.n@intel.com>
2020-07-06 22:33:12 +05:30
Yi Wang
dd98b22b93 Add a guide about how to enable OPC UA
The project open62541 is used as an example. In this article,
it includes:

* How to build a container image with OPC UA client&server
* How to deploy the client&server to StarlingX

Story: 2007846
Task: 40138

Change-Id: I27b8b458bd967edc32273b22c9e8d870d96a8b99
Signed-off-by: Yi Wang <yi.c.wang@intel.com>
2020-07-06 16:04:54 +08:00
Shuicheng Lin
081065da69 Add instruction and config file for tsn switch and node
Also change back Kata to "--privileged" mode to avoid failure
due to lack of permission.

Story: 2006746
Task: 40253

Change-Id: I120468a12b708997d46ebf77fda39b6d2eb5fd9e
Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
2020-07-03 14:19:01 +08:00
Zuul
b839bf0b8f Merge "Describe how to check build dependencies" 2020-07-02 18:26:48 +00:00
Zuul
c4edec7ba7 Merge "Add a Chinese document about layer build" 2020-07-01 14:47:03 +00:00
Zuul
0e65d6e2a8 Merge "Add command to build STX OpenStack application" 2020-06-29 14:08:35 +00:00
Zuul
f37da2a3ef Merge "Build guide for Layered build" 2020-06-26 02:05:35 +00:00
Zuul
0c3264d43b Merge "Update build avoidance section of build guide" 2020-06-25 21:18:46 +00:00
MCamp859
0c261936b3 Describe how to check build dependencies
Add 'build-pkgs --dep-test <pkg>' details to code submission guidelines.

Closes-Bug: 1883325

Change-Id: Id2df2d1c6c6132d81a4b7448ea73cb75be440392
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-06-21 22:03:13 -04:00
MCamp859
c85622a705 Add command to build STX OpenStack application
Closes-Bug: 1881898

Change-Id: I2287672b2ea46fe4efff2b9886b8a77c5c8292c2
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-06-18 20:22:46 -04:00
Poornima
79a84abac3 Build guide for Layered build
Added step by step guidelines for users to do layered build.

Story: 2007223

Change-Id: I25326cab06dd1fab743a946bfd92c9240f93bb25
Signed-off-by: Poornima <poornima.y.n@intel.com>
2020-06-17 21:06:09 +00:00
Yong Fu
c89cb7dbbe Add a Chinese document about layer build
This is a Chinese document introducing layer build.

Change-Id: I073cf3a0004402481e2d7c563ad33536ac76c998
Signed-off-by: Yong Fu <fuyong@neusoft.com>
2020-06-12 17:42:43 +08:00
Zuul
ac28a04426 Merge "Add instruction to enable Kata for docker" 2020-06-11 16:55:46 +00:00