starlingx/docs
Code Issues Proposed changes
2,627 Commits 16 Branches 24 Tags
3f18cb6eda
Commit Graph

70 Commits

Author SHA1 Message Date
Ngairangbam Mili
3f18cb6eda Fixed referenced links and other minor issue 
Change-Id: I1e237122b4cc05af92acebdb7f70dac1784fd067
Signed-off-by: Ngairangbam Mili <ngairangbam.mili@windriver.com>
 2024-11-26 16:21:35 +00:00
Zuul
323aa39fc7 Merge "Change patching to USM for B&R" 2024-11-25 15:33:19 +00:00
Suzana Fernandes
61e319ad97 Change patching to USM for B&R 
Change-Id: If303345eb1eecbc07952ed22728081fc543fa892
Signed-off-by: Suzana Fernandes <Suzana.Fernandes@windriver.com>
 2024-11-25 14:45:19 +00:00
Suzana Fernandes
a5372dfd8c B&R add new option ignore_kube_version_check_for_backup 
Change-Id: If9898f4e78d507a24d745e7f86e0d748421050fd
Signed-off-by: Suzana Fernandes <Suzana.Fernandes@windriver.com>
 2024-11-22 12:46:31 +00:00
Elisamara Aoki Gonçalves
564417258c Remove comment from docs 
Remove comment from Greg that is already addressed.

Change-Id: Ib5f0584fa41f8e556f6b89d8f48434bcadc5bd58
Signed-off-by: Elisamara Aoki Gonçalves <elisamaraaoki.goncalves@windriver.com>
 2024-11-18 13:26:35 +00:00
Ron Stone
be677421ae Fix build html warnings. 
Fix warnings generated by htmlCheck tox step.

Change-Id: I82e14ae3327c64ff33d9b79df34bf80d66b8f9e3
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
 2024-10-23 13:11:30 +00:00
Ngairangbam Mili
b30cbe2821 Incorrect procedure for using ansible vault for automated platform backup (dsr8mr3, dsr8mr2+) 
Fixed the instruction to use override_files_dir

Change-Id: I1bd59fb1f0e83cf2b3279087d884c87547e9611f
Signed-off-by: Ngairangbam Mili <ngairangbam.mili@windriver.com>
 2024-10-22 03:24:27 +00:00
Zuul
5849fe8527 Merge "Add new restore_extra_items option to restore" 2024-10-01 13:43:46 +00:00
Zuul
cd70f34f9e Merge "Platform Application Components Upversion - Vault" 2024-09-20 19:53:31 +00:00
Juanita Balaraj
ea14dcf605 Platform Application Components Upversion - Vault 
Updated Patchset 5 comments
Updated Patchset 4 comments
Updated Patchset 3 comments
Story: 2011073
Task: 50155

Change-Id: Id3bf0b1f06020f84f6fe384c5c7f5d05626e409d
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
 2024-09-20 19:01:56 +00:00
Ngairangbam Mili
33f2c22f23 Add new restore_extra_items option to restore 
Story: 2011180
Task: 51000

Change-Id: Iba38eff9d6b0bcf3d3f3e0c5c0c3bec8f9ea911d
Signed-off-by: Ngairangbam Mili <ngairangbam.mili@windriver.com>
 2024-09-13 08:23:21 +00:00
Juanita Balaraj
728516cbf9 Added Glossary Term for AIO Simplex Restore 
Added new glossary term Multi-host (legacy) restore
Fixed comments for https://review.opendev.org/c/starlingx/docs/+/924981

Change-Id: I0b43c90e296c50004c635dd96b7309b40139f6d9
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
 2024-09-09 22:09:16 +00:00
Suzana Fernandes
729b2533fa Recommendations regarding expired/invalid certificate in backup.(dsR8) 
Bug: 2077106

Change-Id: Iaaf157cc53f4cf3a42e249c184665739bc9e36a6
Signed-off-by: Suzana Fernandes <Suzana.Fernandes@windriver.com>
 2024-08-22 14:55:57 +00:00
Juanita Balaraj
f257cf8702 Legacy restore with patches does not trigger patching reboot (dsr8mr3, dsr8mr2+, r9) 
Updated Patchset 2 comments
Updated Patchset 1 comments

Change-Id: I63483f3da8e443709656115b218657b57626dc99
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
 2024-07-19 17:18:08 +00:00
Zuul
c8261287ce Merge "Password rules enhancement" 2024-06-17 14:08:53 +00:00
Zuul
6fd8fa12d4 Merge "Allow overriding overrides in backup during restore" 2024-06-17 14:08:52 +00:00
Elisamara Aoki Goncalves
76ab0651f7 Allow overriding overrides in backup during restore 
Closes-bug: 2067903

Change-Id: Ic04cbf1295fdbc5a3c05fc8467c79df7044c3b6e
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
 2024-06-14 18:19:25 +00:00
Ron Stone
7e4d9a9ecb Fix typo 
ommitted -> omitted
etc.

Change-Id: Ie2e655026a5ee7f5cdd56be0615d9f319ef7a800
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
 2024-06-13 14:30:58 +00:00
Elisamara Aoki Goncalves
f85f77229a Password rules enhancement 
Story: 2011084
Task: 50154

Change-Id: I34a70e6f2a68cb6617a16931f04edc92ccff0a93
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
 2024-06-12 17:06:59 +00:00
Ron Stone
547bc79e7d Spellcheck (r9, dsR9) 
Run spellcheck job and correct errors.
Fix malformed table

Change-Id: I15d30123ce246adcbdde5d0c9b05e3ff4a69abc0
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
 2024-06-11 17:27:22 +00:00
Zuul
575af0b0e8 Merge "Added Partial Disk (Transparent) Encryption Support via Software Encryption (LUKS) (r9, dsr8MR3)" 2024-04-25 14:35:45 +00:00
Juanita Balaraj
42e5038b57 Added Partial Disk (Transparent) Encryption Support via Software Encryption (LUKS) (r9, dsr8MR3) 
Added rest file for partner only updates
Added abbrev for LUKS
Added Note in the backup chapter

Change-Id: I2324655947a03b8cbe93bb4bbd130b05e9dd40a6
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
 2024-04-22 18:00:44 +00:00
Ron Stone
5c4a152b2c AIO-DX:[BnR] Ansible platform restore fails in TASK (dsMR2, dsRM3) 
Add clarifications on Ceph parameter usages
Patchset 1 review comments
Some generic clean-up of unclear language and punctuation
Formatting updates

Closes-bug: 2062014

Change-Id: I5bac66b3860a6f1473474bb64c7db4c71ca9273b
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
 2024-04-22 13:14:35 +00:00
Juanita Balaraj
95c6d4c517 Update for backup --ignore-health option (dsr8MR3, dsr8MR2) 
Story: 2010709

Change-Id: I4f9a0f04b98302719470f0e3693ef742dc46f1bb
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
 2024-04-01 17:40:11 +00:00
Ngairangbam Mili
4324ab7f3d Improve legacy restore steps and note differences (ds8) 
Change-Id: Iac330aec17a839197f251f4ec14676f21a7232ae
Signed-off-by: Ngairangbam Mili <ngairangbam.mili@windriver.com>
 2023-11-27 14:44:13 +00:00
Zuul
9ff4de99e7 Merge "Highlight in BnR Guide that excluding dirs is not supported for legacy BnR (dsR8)" 2023-10-06 13:35:05 +00:00
Elisamara Aoki Goncalves
ba01686f7a Fix broken links (dsR8) 
Fix and update links.

Change-Id: I868b64a8b347d7746f857543f3a75760954ddee9
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
 2023-10-05 21:27:32 +00:00
Elaine Fonaro
1e850fd0a7 Highlight in BnR Guide that excluding dirs is not supported for legacy BnR (dsR8) 
Updated Patch data warning.

Change-Id: I317cb6bd7d521072e3bb4517cfa5e1484abefd1c
Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com>
 2023-10-02 19:15:59 +00:00
Juanita Balaraj
45e4c0c1bb Updated Note for Optimized Restore 
Change-Id: I716dca277131c16508afee74e458a686d0251191
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
 2023-09-22 21:44:07 +00:00
Elaine Fonaro
561459599b Indentation error in Ansible inventory file example (r8, dsr8) 
- Fixed indentation in Ansible inventory file example

Change-Id: Ic6c34cb80755c67eba10bd419dceed90780bb809
Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com>
 2023-09-12 19:28:31 +00:00
Zuul
4bff49d719 Merge "Document the best practices, considerations, and recommendation for backups (dsR8)" 2023-08-31 16:58:45 +00:00
Elisamara Aoki Goncalves
861d50d31f Document the best practices, considerations, and recommendation for backups (dsR8) 
Addressing in master comments made in the CP https://review.opendev.org/c/starlingx/docs/+/891446

Change-Id: I72b8a847bb929af77b46aacc8f526b8f435f9c55
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
 2023-08-31 15:38:18 +00:00
Dinesh Neelapu
a62dd32048 Parameter to override registry FS backup name (BnR Guide). (r8, dsr8) 
Added the registry filesystem backup filename prefix.

Change-Id: Ib4d3d381c5bb4d1bb4c5bfa99c8344634d3f5840
Signed-off-by: Dinesh Neelapu <dinesh.neelapu@windriver.com>
 2023-08-30 13:41:10 +00:00
Elisamara Aoki Goncalves
b0085b6114 Add bullets (dsR8,dsR6) 
Adress comment in https://review.opendev.org/c/starlingx/docs/+/891363

Change-Id: I9ec645a64857cd18e0796909c586bb8a43eb1eff
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
 2023-08-16 14:01:07 +00:00
Zuul
edcc747523 Merge "Improve steps in backup and restore (r8,r6,dsR8,dsR6)" 2023-08-14 17:41:05 +00:00
Elisamara Aoki Goncalves
6c138a86cf Document the best practices, considerations, and recommendation for backups (r8,dsR8) 
Update Back Up System Data section.
Applied editorial fixes.

Change-Id: I72dc57a185ef40f9ca98ffa5fbd841d3ecdffa49
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
 2023-08-14 13:49:48 +00:00
Elisamara Aoki Goncalves
0c5950a87d Improve steps in backup and restore (r8,r6,dsR8,dsR6) 
Remove step 9 from Restore Platform System Data and Storage
Split example in Run Ansible Backup Playbook Locally on the Controller
Remove Postrequisites from Run Restore Playbook Locally on the Controller

Closes-bug: 2031318

Change-Id: Id3bfde9b7747bdbe17b4b541a915ccc2494d9602
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
 2023-08-14 13:41:16 +00:00
Elaine Fonaro
9082098c8d Insufficient /tmp space to hold restore data during subcloud restore (r8, dsr8, r7, dsr7, r6, dsr6, r5, dsr5) 
- Added a note warning for ansible_remote_tmp.
- Added an example.
- Remove subcloud name and replace with "subcloud1".

Change-Id: I2b786cd27a27134669b50c763eb3d15e096f11ab
Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com>
 2023-08-04 14:21:12 +00:00
Juanita Balaraj
265d21ee17 Updated Restore Operation steps (r8, dsr8) 
Updated Patchset 5 comments
Updated Includes file
Updated Patchset 4 comments
Added an additional note regarding storage space and transfer time.
Updated Patchset 2 comments and added the ``* exclude_dirs=/opt/patching/**/*` parameter.
Updated Patchset 1 comments
Change-Id: I929f8a707c06fd91b99e94bc14e199a79687c3a0
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
 2023-06-28 04:05:30 +00:00
Ron Stone
f125a8b892 Remove spurious escapes (r8,dsR8) 
This change addresses a long-standing issue in rST documentation imported from XML.
That import process added backslash escapes in front of various characters. The three
most common being '(', ')', and '_'.
These instances are removed.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id43a9337ffcd505ccbdf072d7b29afdb5d2c997e
 2023-03-01 11:19:04 +00:00
Elisamara Aoki Goncalves
f0373cd83a Step missing to specify ansible_ssh_user (r6,r7,dsR6,dsR7) 
Add step to specify ansible_ssh_user to run Ansible Backup Playbook Remotely

Closes-bug: 2003787

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I0772258c448503818b7211d81d9bc7682b9228ad
 2023-01-24 11:23:20 -03:00
Elisamara Aoki Goncalves
fd149454f2 Add requirement for node replacement 
Closes-bug: 2002434

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I0ca7643e754984489b4bfcaeba37b5d0478f455c
 2023-01-10 15:33:17 -03:00
Elisamara Aoki Goncalves
fb9e1fe6fd Update B&R docs 
Addressing comments in https://review.opendev.org/c/starlingx/docs/+/854255

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: Iaed99bf1801f788df877edb50a2b78556d66c9fb
 2022-12-21 19:50:52 -03:00
Elisamara Aoki Goncalves
e5609cba03 Platform backup and restore optimization 
Story: 2010117
Task: 46411

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I8483f9bbfdf3a848adbd225a54391c7de76d3752
 2022-12-21 17:38:45 -03:00
Zuul
e5c37f1a6b Merge "Centralized B&R" 2022-12-21 19:03:24 +00:00
Elisamara Aoki Goncalves
f8badacec0 Update B&R docs 
Add note and removed unnecessary text.
Fix optional modes items.
Move otpional item to correct place.
Fix indentation and rewrite item about on_box_data.
Remove duplicated items.
Move parameters to be under optional-extra-vars item.
Add list of restored items.
Fix typo.
Reworded sentences to improve understanding.

Closes-bug: 1994052

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I72af1baa22dafa1f69488d0caad6241e5686bd0b
 2022-12-20 22:45:19 -03:00
Elisamara Aoki Goncalves
375088f5fd Centralized B&R 
Create Backup and Restore using DCManager CLI
Move sections do distributed cloud
Delete older section Restoring a Subcloud from Backup Data Using DCManager CLI
Fix conflict

Story: 2010116
Task: 46548

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: Iba938731f1ab188e41c9ab1dea09badef37bfd5a
 2022-12-20 20:56:22 -03:00
Juanita-Balaraj
e3bbf0564a High Security Vulnerability Document Updates (r6, r6ds, r7, r7ds) 
Updated Patchset 7 comments
Fixed merge conflicts
Updated review comments from Patchset 4
Closes-Bug:1997909
Fixed build errors
Greg to review and provide inputs

Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
Change-Id: I2f630104813210f160fa56e7af7e9754a6d9236a
 2022-12-16 18:04:58 -05:00
Elisamara Aoki Goncalves
2818967e0b Update "Back Up System Data" to include the size limit (r6,r7,dsR6,dsR7) 
Closes-bug: 1999255

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: Ia5dce563e6fd9e16030186bac3b3217cf2470053
 2022-12-14 09:55:38 -03:00
Elisamara Aoki Goncalves
7e3c2df877 Back up data during a System upgrade (r6,r7,dsR6,dsR7) 
Update "Detailed contents of a system backup" list.
Move note to upgrade AIO-SX section.
Remove item.

Closes-bug: 1996533

Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I9b370590c5d3a0908bb0b588fbaa9855661af5db
 2022-11-15 10:30:44 -03:00