36 Commits

Author SHA1 Message Date
Mark Horn 7069fd70a1 guides: Add new Kubernetes migration guide (#1220)
* guides: Add new Kubernetes migration guide

This guide provide direction in upgrade Kubernetes from the
1.17.x release up to the 1.19.x release due to Clear missing
the 1.18.x release.

Signed-off-by: Mark D Horn <mark.d.horn@intel.com>

* Corrects reST syntax for proper display of code-blocks, - For correct indentation levels when substeps appear - To correct "For each of the other notes..." to "nodes..." - To use list-table to show kubeadm component configs - To retitle ref label to "_kubernetes_migration", prev not unique - TBD: Waiting on actual hyperlinks, not prev included.

Signed-off-by: michael vincerra <michael.vincerra@intel.com>

* guides: Fix the links for k8s-migration

- Rename the new guide
- Fix references and links
- Fix formatting

Signed-off-by: Mark D Horn <mark.d.horn@intel.com>

* Corrects copyright value in conf.py.

Signed-off-by: michael vincerra <michael.vincerra@intel.com>

Co-authored-by: michael vincerra <michael.vincerra@intel.com>
2021-02-25 17:39:56 -08:00
KJM 4f0b8c2c81 fix typo (#1204)
"it's" changed to "its" to correctly represent possessive form
2020-07-20 10:26:37 -07:00
Kristal Dale 552db8b0f5 Update TM&B in guides section of docs (#1187)
* Update TM&B in guides section of docs

- Add disclaimers for Intel trademarks
- Update/correct product names in text per Intel guidance

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Fix syntax/indent errors.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* - Add link back in (accidental removal) (dlrs-inference.rst) - Minor language clarifications
(compatible-kernels.rst) - Correct missed trademark (performance.rst)

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* - Correct product name in dlrs-inference.rst (confirmed with original author)
- Correct product name in dbrs.rst (confirmed with original author)
- Correct product name in compatible-kernels.rst

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Add in missing (r) in dbrs.rst

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-06-16 10:59:01 -07:00
bktan8 f4670e50bf Update "Proxy Configuration" tutorial (#1165)
Closes #1125

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-05-20 10:02:12 -07:00
Kristal Dale b3d262ffe6 Performance doc (#1149)
* Performance doc

New doc providing an outline of the approach and tactics used by CL
for performance optimizations.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Edits and clarification based on feedback.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* - Fix typo
- Update Overview formatting for readability

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* - Replace 'hardware' with 'Intel architecture' for consistency with
About page.
- Added required TM&B disclaimer.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-05-06 17:47:42 -07:00
michael vincerra acb0f8e2db Align Hyper-V docs to align w change from hyper.vhdx to azure-hyperv.vhd. (#1145)
- Remove images azure-docker, azure-machine-learning, and hyperv.
- Closes #1141
- Revises from Hyper-V Gen 2 to Gen 1, with relative changes to settings.
- Replaces figure 3 because Gen 1 settings are different from Gen 2
- Revises image type to remove previous default `hyperv.vhdx`,
  a Gen 2 image -- no longer supported.
- Respond to reviewer feedback; fix typos.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-04-29 17:04:08 -07:00
bktan8 df2078fab1 Minor updates to swupd 3rd-party (#1129)
Closes #1096

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-04-20 11:31:30 -07:00
michael vincerra 2ffff6fa9e Adds swupd-3rd-party option; removes instruction on Docker. (#1050)
- Use of Docker with mixer is now deprecated.
- Recreates grid table as list-table for future maintenance.
- Adds new section, Bundle definition files, for illustration
- Revises builder.conf in References, removing docker path.
- Updates mixer builder.conf to VERSION 1.2.
- Fix typo in filepath for LOCAL_RPM_DIR in builder.conf.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-03-30 17:02:59 -07:00
bktan8 c740464e73 Minor updates to the Stateless doc. (#1094)
Closes #1089

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-25 09:15:32 -07:00
Kevin Putnam cdb5531bcc Fixed broken links: (#1087)
Added escape character so they aren't turned into links:
guides/clear/mixer.rst:1127:
   [broken] http:/
guides/clear/swupd-3rd-party.rst:61:
   [broken] http:/

Pointed to containers and bundles that still exist:
guides/maintenance/developer-workstation.rst:58:
   [broken] https://clearlinux.org/software/docker/machine-learning/
guides/maintenance/developer-workstation.rst:187:
   [broken] https://clearlinux.org/software/bundle/web-server-basic
guides/maintenance/developer-workstation.rst:193:
   [broken] https://clearlinux.org/software/bundle/database-basic

Unable to fix - this document doesn't appear to exist. Recommend removing reference.
guides/stacks/dbrs.rst:41:
   [broken] https://clearlinux.org/news-blogs/database-reference-stack-dbrs-v2-now-available

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2020-03-20 11:20:23 -07:00
bktan8 2417f133c6 Create, Install, and Manage 3rd-party Bundles (#1075)
Closes #528

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-19 17:43:25 -07:00
bktan8 c5db9bbaa7 Update unattended installation doc and deprecate ister doc. (#1079)
Closes #1052

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2020-03-18 19:18:02 -07:00
Adeel Mujahid 83b12c65fd Fix typo: s/bundle <search term>/search <term>/ (#1025) 2020-02-07 12:44:25 -08:00
bktan8 77d7631e37 Update mixer build image to use clr-installer. (#1015)
* Update mixer build image to use clr-installer.

Closes #1006

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>

* Reverts Example 7 to recent master, omitting Tutorials header, etc.
- Reason: Separate branches not sync'ed based on upstream master

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Adds line in Example 4 to assure Example 2 is known prereq.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

* Simplify sentence.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Co-authored-by: michael vincerra <37549381+mvincerx@users.noreply.github.com>
2020-02-05 10:59:47 -08:00
Kristal Dale 1dc3d59bc4 Minor edit to mixer guide for clarity (#1007)
In Example 7:
- Remove 'tutorial' subsection as it was not clear that it was an example of the
advanced example of manual format bump.
- Roll existing tutorial content under 'advanced' as it is the advanced example.
- Result is a basic and advance example for Example 7: execute format bump

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-31 12:49:19 -08:00
michael vincerra c913639121 Prepends mixer build commands with sudo for successful execution. (#979)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2020-01-07 14:27:32 -08:00
bktan8 8ca656b901 iPXE updated to use clr-installer. (#932)
ister and icis deprecated.

See also: https://github.com/clearlinux/clr-bundles/issues/171
Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
2019-11-21 15:39:14 -08:00
Kevin Putnam d4cb55239f Restore Tl telem (#794) (#916)
* Tl telem (#794)

* update telemetry opt-in requirement

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>

* update telemetry docs for opt-in changes

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Update telemetry guide

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* telemetry typo and bundle name update

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Spelling correction line 186

Signed-off-by: DougTW <doug.martin@intel.com>

* Formatting revisions:
-Removed EOL spaces
- broke lines longer than 78 characters
- re-wrapped text as needed

Signed-off-by: DougTW <doug.martin@intel.com>

* Minor editorial changes to telemetrics.rst

Signed-off-by: DougTW <doug.martin@intel.com>

* Fixes based on feedback.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-11-13 11:20:38 -08:00
Marcos Simental 7f61f94836 guides/clear/stateless: specify /usr/local as user owned (#912)
besides /var, /etc, /opt and /home, users are allowed to make
local installations in /usr/local without getting swupd
operations to remove such content.

be excplicit about /usr/local in the stateless guide.

Relates to https://github.com/clearlinux/distribution/issues/1475

Signed-off-by: Simental Magana, Marcos <marcos.simental.magana@intel.com>
2019-11-13 09:37:32 -08:00
michael vincerra 1688e2241a Revert "Tl telem (#794)" (#861)
This reverts commit 1bc2804b1b.
2019-10-14 12:33:16 -07:00
Tom Leavitt 1bc2804b1b Tl telem (#794)
* update telemetry opt-in requirement

Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com>

* update telemetry docs for opt-in changes

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Update telemetry guide

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* telemetry typo and bundle name update

Signed-off-by: Tom Leavitt <thomas.p.leavitt@intel.com>

* Spelling correction line 186

Signed-off-by: DougTW <doug.martin@intel.com>

* Formatting revisions:
-Removed EOL spaces
- broke lines longer than 78 characters
- re-wrapped text as needed

Signed-off-by: DougTW <doug.martin@intel.com>

* Minor editorial changes to telemetrics.rst

Signed-off-by: DougTW <doug.martin@intel.com>
2019-10-10 13:14:48 -07:00
Kristal Dale 265469c584 Correct example commands in autoproxy guide (#838)
* Correct example commands in autoproxy guide

- Fix example commands that were split into two snippets (should be one)
- Spelling corrections and minor edits for readability

Fixes #795

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Minor edits to improve clarity with
 output samples.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>

* Add sudo to commands that require it.

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-07 15:50:32 -07:00
puneetse 2f0a056995 Add document on firmware (#824)
Adds a new document on firmware laoding and a reference to it from the stateless document.
2019-10-03 07:36:40 -07:00
Kevin Putnam d671e584aa Adds youTube video tutorial for autospec to guide page. (#835)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-10-02 13:40:06 -07:00
michael vincerra 7861c356db Add Example 5 for updating an existing package in autospec. (#827)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-27 23:46:32 +02:00
michael vincerra 87930e2f2b Adds Example 6 and 7 to show how to remove a bundle and do a format bump. (#770)
- Subdivides prev Example 3 into two:
  - Create an update for the mix
  - Build an image
- Adds subsection Format Bump to explain its purpose and swupd protocols
- Adds Figure 1 and new _figures/mixer dir to illustrate Format Bump
- Modifies some commands to clarify intent, purpose
- Closes #507 

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-09-20 17:37:22 -07:00
Kevin Putnam 49efe4f7bc Fixes several links that were failing
* Added one link to whitelist (nvidia downloads)
* Added "/" to download images link
* Updated to swupd update link

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-09-13 10:14:05 -07:00
Kevin Putnam 62e82d3cc5 Had to update .po files.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-29 17:32:59 -07:00
Kevin Putnam b1e039e870 A small change.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-29 17:16:21 -07:00
Kevin Putnam 1605650039 Fixed a warning that was occurring due to a link reference in the English version of the docs. Changed to inline.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-29 17:13:46 -07:00
michael vincerra 3b70eb23d5 Corrects swupd search command. (#715)
- Removes `bundle-add`
- Removes [-b] flag; deprecated

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-08-08 20:11:24 -07:00
Kristal Dale 3a18501f30 Minor revisions on wording and spacing.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-08 13:46:02 -07:00
Kristal Dale a8aa87ec9d Remove redundant content + associated clean up
- Remove concepts (content migrated to Clear guides)
- Remove reference for bundle commands (quick ref in swupd guide)
- Moved bundle about page to Clear guide
- Updated links to concepts page, to instead link to the associated guide

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-07 16:54:15 -07:00
Kristal Dale bc2bd3537c Minor grammatical updates requested in support of upcoming translated content.
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-06 17:17:57 -07:00
Kevin Putnam bff6f34e06 Moved images to subdirectories in _figures for easier management.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-08-05 15:22:28 -07:00
Kevin Putnam ac7d52e512 Create about page and move Clear Linux specific content to guides/clear.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-07-29 12:51:04 -07:00