From 93a1f5621d7cbb3dbd6d1ab4c724dd67991a737b Mon Sep 17 00:00:00 2001
From: Kevin Putnam <kevin.putnam@intel.com>
Date: Mon, 2 Jul 2018 12:33:39 -0700
Subject: [PATCH] added the changes swupd guide file

---
 .../guides/maintenance/swupd-guide.rst        | 169 ++++++++++++++++++
 1 file changed, 169 insertions(+)
 create mode 100644 source/clear-linux/guides/maintenance/swupd-guide.rst

diff --git a/source/clear-linux/guides/maintenance/swupd-guide.rst b/source/clear-linux/guides/maintenance/swupd-guide.rst
new file mode 100644
index 00000000..2a25fc6d
--- /dev/null
+++ b/source/clear-linux/guides/maintenance/swupd-guide.rst
@@ -0,0 +1,169 @@
+.. _swupd-guide:
+
+swupd guide
+###########
+
+*swupd* manages the software update capability of |CLOSIA|. It can check for
+valid system updates and, if found, download and install them. It can also
+perform verification of the system software. 
+
+|CL| uses :ref:`bundles-about<bundles>` as the base abstraction for
+installing functionality on top of the core operating system. Use the `swupd`
+tool to install and remove bundles.
+
+.. contents:: 
+   :local:
+   :depth: 2
+
+.. _man_swupd:
+
+For a full listing of commands and options please see the man page in |CL|
+
+.. code-block:: bash
+
+   man swupd
+
+OS Update and Verification
+**************************
+
+|CL| is designed to promote a regular update cadence. `swupd` helps to
+make sure that process is simple and secure.
+
+OS Info
+=======
+
+Current OS version and update server info:
+
+.. code-block:: bash
+
+   swupd info
+
+.. code-block:: console
+   Installed version: 23330
+   Version URL:       https://download.clearlinux.org/update/
+   Content URL:       https://cdn.download.clearlinux.org/update/
+
+Disable Automatic Updates
+=========================
+
+|CL| updates are automatic by default but can be toggled to occur only 
+on demand. Disable automatic updates:
+
+.. code-block:: bash
+
+   sudo swupd autoupdate --disable
+
+To re-enable automatic updates use the `--enable` flag.
+
+Check for Updates
+=================
+
+.. code-block:: bash
+
+   sudo swupd check-update
+
+Perform a Manual Update
+=======================
+
+You can update to a specific verion or accept the
+latest as the default with no arguments.
+
+Initiate a manual update:
+
+.. code-block:: bash
+
+   sudo swupd update -m 23330
+
+Output from a successful update:
+
+.. code-block:: console
+
+   Update started.
+   Version on server (23330) is not newer than system version (23330)
+   Update complete. System already up-to-date at version 23330
+
+System Software Verification
+============================
+
+`swupd` can determine whether system directories and files have been added
+to, overwritten, removed, or modified (eg., permissions).
+
+.. code-block:: bash
+
+   sudo swupd verify
+
+All directories that are watched by `swupd` are verified according to 
+the manifest data and hash mismatches are flagged as follows:
+
+.. code-block:: console
+
+   Verifying version 23300
+   Verifying files
+      ...0%
+   Hash mismatch for file: /usr/bin/chardetect   
+   ...
+   ...
+   Hash mismatch for file: /usr/lib/python3.6/site-packages/urllib3/util/wait.py
+      ...100%
+   Inspected 237180 files
+      423 files did not match
+   Verify successful
+
+In this case, python packages that were installed on top of the default
+install were flagged as mismatched. `swupd` can be directed to ignore
+or fix issues based on :ref:`command line options <man_swupd>`. 
+
+Fixing Hash Mixmatches
+======================
+
+`swupd` can correct any issues it detects. Additional directives can be
+added including a white list of directories that will be ignored, if
+desired.
+
+The following command will repair issues, remove unknown items, and ignore files or directories matching `/usr/lib/python`:
+
+.. code-block:: bash
+
+   sudo swupd verify --fix --picky --picky-whitelist=/usr/lib/python 
+
+Bundles
+*******
+
+Listing installed bundles
+=========================
+
+You can list all of the bundles currently installed on the system
+
+.. code-block:: bash
+
+   sudo swupd bundle-list --all 
+
+Finding a bundle containing a binary
+====================================
+
+Run the following to display a list of bundles that contain a particular
+binary. Note that it may be present in multiple bundles:
+
+.. code-block:: bash
+
+   swupd search -b <binary you want> 
+
+Adding a bundle
+===============
+
+Start by selecting a bundle from the list of :ref:`available-bundles`. In
+this example we're adding dev-utils-dev, which is useful for development.
+
+.. code-block:: bash
+
+   sudo swupd bundle-add dev-utils-dev
+
+Removing a bundle
+=================
+
+Dependencies common to other bundles will not be removed
+
+.. code-block:: bash
+
+   sudo swupd bundle-remove dev-utils-dev
+