Commit Graph

344 Commits

Author SHA1 Message Date
Kevin Putnam a95c1eede9 Merge pull request #530 from mvincerx/mv-swupd-guide
@MCamp859, @castulo , @mvincerx Thanks for all the work on this PR. Merging. If you catch anything new, we can submit a new PR.
2019-06-10 18:17:42 -04:00
Mikko Ylinen f874f783c2 Kubernetes doc updates (#531)
* kubernetes: update CNI instructions

CRI-O now supports multiple CNI binary paths and Clear Linux by default
uses /usr/libexec/cni AND /opt/bin/cni so there's no need to give
these instructions anymore.

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>

* kubernetes: add RuntimeClass instructions for Kata Containers

Clarify how to enable Kata Containers via RuntimeClass (which is now
enabled by default in Clear Linux kubernetes).

Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2019-06-07 12:03:00 -07:00
Michael Vincerra 7a00983771 Replaces swupd verify and related flag commands per @castulo.
- Closes #522
- Deprecates use of:
 `swupd verify`
 `swupd verify --fix`
 `swupd verify --install`
 `-m / --manifest`

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-06 15:31:47 -07:00
michael vincerra 843abc3ef7 Adds redis tutorial with systemctl service check, 2 example use cases (#525)
* Adds redis tutorial with systemctl service check; add 2 example use cases.
- Closes #519

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

Refine intro and add development examples.

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

Revise wording intro; add hyperlinks in Example 2.

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

Correct description of client libraries.

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

Correct spacing; add note to define syntax behavior.

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

Respond to reviewer's feedback. Revise wording. Add docker command.

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

Apply wording revisions for clarity.

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

Edit for squash.

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

* Resolve build error to avoid duplicate ref's.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-06 14:26:40 -07:00
Beth Dean be8aa2c024 Add link to quantization tools for model conversion (#529) 2019-06-06 07:04:00 -07:00
michael vincerra 1d284eee71 Removes multi-boot tutorial; deferred until further technical review. (#526)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-06-04 09:29:20 -07:00
puneetse 90bf8f6256 Add updating section to NVIDIA doc (#501) 2019-05-23 16:19:02 -07:00
Beth Dean 206bf71728 Add introductory text and link to benchmark results (#494) 2019-05-17 13:19:17 -07:00
Mary Camp 046cfd2bd2 Completed TCS editorial review (#490)
* Completed TCS editorial review

* Resolved feedback.

Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-05-16 14:40:12 -07:00
michael vincerra 2ea2d5f14d Revises title and all internal refs to Data Analytics Ref Stack. (#488)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-14 10:02:13 -07:00
puneetse b198747958 Update NVIDIA driver documentation to include openGL support (#474)
* Update NVIDIA installer command to isolate files and support OpenGL

* Update source/clear-linux/tutorials/nvidia.rst

Co-Authored-By: puneetse <22071208+puneetse@users.noreply.github.com>

* Elaborate on not using swupd verify with NVIDIA

* Add compat32-libdir

Some installation flows don't work without explicitly setting compat-libdir when compat-prefix is specified.

* Add note about drivers not being updated automatially.
2019-05-13 19:37:14 -07:00
Beth Dean 603207ea43 Add DARS v1 tutorial (#486)
* Add DARS getting started tutorial

* Update links to live DARS images

* updating link text in bash cmd

* Fix formatting & link ref

* Corrects sphinx directives; revises intro and other para for readability.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-13 18:31:22 -07:00
michael vincerra 5ff59f975d Revise to incorporate new GUI installer and screenshots. (#477)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Creates live desktop installation instructions based on clear-29180-0502-live-desktop.iso.
- Renames dir from bare-metal-install-beta to bare-metal-install-desktop
- Creates and assigns new screenshots for UI
- Re-links default ref from tutorials, etc. to bare-metal-install-desktop

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

Revise per developer feedback on PR.

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

Revises Finish Installation steps. Correct scale Figures 1-3.

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

Revises intro para.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-09 14:27:21 -07:00
michael vincerra 5b20941aeb Creates bare-metal-install-server; replaces bare-metal-install. (#476)
- Revises majority of figures.
- Revises User Manager to Manage User
- Revise all other submenus per release: clear-29180-0502-live-server.iso

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

Revises para under Install CL| on your target system.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-05-09 13:40:30 -07:00
Beth Dean 00cd2b705c Add release note links for V3 release (#472) 2019-05-06 13:14:47 -07:00
Kevin Putnam 680eadb806 Fixed incorrectly formed link that was resulting 404 (#471)
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
2019-05-03 09:26:34 -07:00
Beth Dean 0333167a97 Add steps for using Jupyter Notebook to tutorial. (#463)
* Add instructions for using Jupyter Notebook

* Update Jupyter Notebook steps and add screenshots
2019-04-26 15:42:49 -07:00
michael vincerra 8897dbb6cd kata: removes configuration step /etc/systemd/system/docker.service.d/50-runtime .conf (#459)
* Removes configuration /etc/systemd/system/docker.service.d/50-runtime.conf
- 50-runtime.conf file automatically created on CL builds > 27000
- Adds Troubleshooting, and adds prev manual conf option
- Closes #453

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

Revises kata.rst adding Troubleshooting link to change devicemapper for production.

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

* Revise to ../50-runtime.conf

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

* Replace storage driver devicemapper with overlay2; add note.

- kata: add note re options of storage drivers.

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

* Remove grep runtime bc of errors; assign bullets to troubleshooting.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-23 09:57:13 -07:00
michael vincerra 8ab6ddfcea yubikey: Add sudo in second command to reload udev rules. (#460)
- Closes #458

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-16 14:48:17 -07:00
michael vincerra 9a4df878ed Add tut on how to connect to Win share using CL Nautilus (#430)
* Adds smb-desktop for samba sharing from CL Gnome desktop.

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

Add tut on how to connect to Win share with Nautilus on CL.

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

Add toc reference.

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

* Adds missing `_` leading space before file name; root cause image failure. (#431)

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

* Remove older unused openssh-server ref from toctree. (#432)

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

* updating dd command to add sync for Linux section (#425)

* Add document on installing proprietary NVIDIA drivers (#429)

* Add document on using YubiKey with U2F  (#416)

* Add document on using YubiKey with U2F

* Add yubikey doc to tutorials TOC

* Update all links to the download website to use the CDN (#434)

Update all links pointing at https://download.clearlinux.org to use
the CDN, i.e. https://cdn.download.clearlinux.org

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>

* Move autoproxy content to updated guide template (#417)

* first draft revision of autoproxy guide with guide template

* removed related topics as there is currently nothing that qualifies

* restructured a bit more to match guide template; removed autoproxy_about.txt and autoproxy_guide.txt as they are no longer needed

* made changes recommended by @mvincerx

* minor corrections based on feedback

* Update to the swupd Guide (#409)

* partial commit to save work

* latest changes

* replaced out of date swupd-guide.rst with contents of swupd-temp.rst; removed swupd-temp.rst

* changed page ref to swupd-guide from swupd; too many existing dependencies

* Added descriptions of manifests and delta packs from How to Clear

* fixed typo

* changed header organization slightly and removed unnecessary text formatting

* updated a couple headers to make more sense

* numerous cosmetic and readability changes based on full render review

* changes to description section based on updated swupd concept page

* updates based on feedback

* updates based on technical review

* removed swupd-search.rst; updated maintenance.rst toc tree after removal; updated references in developer-workstation.rst and kernel-module.rst that linked to swupd-search.rst

* Bootable USB (#436)

* bootable-usb: Add extra caution about unmount

Not unmounting an USB partition before an image is burned could cause
file system checksum errors leading to other issues (including kernel
panics) when trying to boot from the USB drive. This commit adds an extra
caution note to warn the users about the possible issues they could find
when this step is not followed correctly.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>

* bootable-usb: Add o_sync to the dd command

Update the example 'dd' command to burn an image, by adding the 'oflag=sync'
option. This allows to reduce the flashing time in conjunction with the
recommended 'bs=4M', enables a more accurate progress indicator, and allows
to remove the additional sync command, while preserving some cache
optimizations.

Signed-off-by: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia@intel.com>

* Revises intro to add expl of CIFS/SMB in context; removes empty ref.

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

* Adds smb-desktop for samba sharing from CL Gnome desktop.

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

Add tut on how to connect to Win share with Nautilus on CL.

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

Add toc reference.

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

Revises intro to add expl of CIFS/SMB in context; removes empty ref.

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

* Revise intro per feedback; corrects hidden indent error; adds note.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-15 10:00:45 -07:00
michael vincerra 306081763f Revise, simplify prefaces to guides' and tutorials' landing pages. (#452)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Closes #446.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-12 17:12:07 -07:00
Beth Dean 4188e47810 fixing typo in authenticity (#451) 2019-04-09 10:35:30 -07:00
Beth Dean 14e4dadca7 cleaning up bash commands to make copy/paste cleaner (#441)
* cleaning up bash commands to make copy/paste cleaner

* adding sudo to a swupd command example
2019-04-04 17:00:04 -07:00
michael vincerra cc9196f920 k8s tut: Add new section on cloud native setup automation. (#435)
* Add new section on cloud native setup automation.

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

* Revise repo URL.

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

* Revises new section per reviewer feedback.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-04-04 12:29:42 -07:00
Geoffroy Van Cutsem 8a6d69b82e Update all links to the download website to use the CDN (#434)
Update all links pointing at https://download.clearlinux.org to use
the CDN, i.e. https://cdn.download.clearlinux.org

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-03-20 14:31:30 -07:00
puneetse 96fa0b1a9e Add document on using YubiKey with U2F (#416)
* Add document on using YubiKey with U2F

* Add yubikey doc to tutorials TOC
2019-03-20 10:43:26 -07:00
puneetse 3fe3bc533a Add document on installing proprietary NVIDIA drivers (#429) 2019-03-20 09:32:10 -07:00
Beth Dean cbb8b26534 rework of telemetry guide & tutorials (#423)
* rework of telemetry guide & tutorials

* adding reference section

* source/clear-linux/guides/telemetrics/telem-guide.rst

* adds missing URL & link to telemetrics.rst

* deleting redundant files

* moving figure files & updating tutorial landing page links

* updating links to png files

* updating links in concept & getting started pages
2019-03-14 16:26:47 -07:00
Beth Dean 2a95b25526 dlrs tutorial update (#410)
* adding pytorch section

* updated doc

Minor nits and corrections

* scripts: Code Block rst parser

Signed-off-by: John Andersen <john.s.andersen@intel.com>

* limited to bash code blocks and added description to the header

* added ability to create a list of code blocks to parse

* adding pytorch section

* updating PyTorch image link & name

* updating docker image link and adding PyTorch benchmarking link

* Sphinx syntax corrections; reorganizes contents/toctree; line-edits.

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

* updating link to PyTorch benchmarks
2019-03-05 07:40:47 -08:00
michael vincerra 105845dd25 Merge pull request #393 from mvincerx/mv-kubernetes-02
k8s: Replaces content in Install pod network add-on w symlinks.
2019-02-12 08:31:41 -08:00
michael vincerra b62e43b210 Merge pull request #386 from MCamp859/mc-greengrass-edits
Minor text edits for branding, punctuation, and TM symbol in title.
2019-02-11 13:23:01 -08:00
Michael Vincerra 78b56df417 Revises note in `Install Kubernetes and CRI runtimes."
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-11 12:09:57 -08:00
Michael Vincerra cea34f2cc3 Merge branch 'master' into mv-kubernetes-02
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-11 11:01:26 -08:00
Michael Vincerra f67cf636d7 Adds back notes on Weave Net and flannel.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-11 10:56:17 -08:00
Michael Vincerra 339b4543c2 Revises and reformats note on motd.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-08 17:18:13 -08:00
Michael Vincerra e04eeec536 Removes line sudo systemctl restart kubelet; deprecated.
- Closes Issue #388

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-08 12:41:57 -08:00
Michael Vincerra 546bab0a96 Revises symlink for loop to point to: opt/cni/bin
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-08 12:26:52 -08:00
michael vincerra 44a8e3dbfe Merge pull request #376 from mvincerx/kubernetes-bp
Adds kubernetes-bp and organizes in new kubernetes folder.
2019-02-08 12:08:52 -08:00
Michael Vincerra 905e87ac50 Adds back note in Update control plane; omits optional only.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-08 11:10:37 -08:00
Michael Vincerra d7f3b3d243 Shortens title. :)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-08 10:36:45 -08:00
Michael Vincerra 355179a487 Replaces content in Install pod network add-on w symlinks.
- Provides bash script to manage default plugin_dir
- Closes #392

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-08 10:24:36 -08:00
Michael Vincerra 56c5a4e5a3 Deletes note re if 'motd' appears, postpone kubelet restart.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-08 09:52:13 -08:00
Michael Vincerra 2036d492b1 Adds :glob: to toctree for new kubernetes subsection.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 11:53:24 -08:00
Michael Vincerra 625104a309 Edits Prereq's for brevity.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 11:34:05 -08:00
Michael Vincerra 0d7641aaa5 - kubernetes: Revises headers to omit CL
- Adds new kubernetes/kubernetes to tutorials toctree

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 11:21:55 -08:00
Michael Vincerra ad4206dd39 Applies edits to Headers, Prereq's, and word choice.
- kubernetes: Adds Next steps at end.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-02-07 09:58:59 -08:00
MCamp859 2350b5378d Incorporated review feedback.
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-02-06 17:02:15 -05:00
MCamp859 57db5fe424 Minor text edits for branding, punctuation, and TM symbol in title.
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2019-02-04 11:34:30 -05:00
Qi Zheng a5f8bf686a dlrs.rst: Updates DLRS tutorial
The ksonnet was added to CL bundle cloud-native-basic, no need
manually install anymore.

Signed-off-by: Qi Zheng <qi.zheng@intel.com>
2019-02-01 10:35:18 +08:00
Michael Vincerra 62ffa17315 Revises intro, providing rationale; simplifies steps.
- Note: Further testing still required to validate use case.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-01-31 09:50:38 -08:00