diff --git a/_images/errataPatching.png b/_images/errataPatching.png new file mode 100644 index 000000000..d04e84f5b Binary files /dev/null and b/_images/errataPatching.png differ diff --git a/_images/patchingRepos.png b/_images/patchingRepos.png new file mode 100644 index 000000000..bfdc6d1f1 Binary files /dev/null and b/_images/patchingRepos.png differ diff --git a/contents/contents-operations.rst b/contents/contents-operations.rst index 01bee3b93..7b4329cd9 100644 --- a/contents/contents-operations.rst +++ b/contents/contents-operations.rst @@ -38,5 +38,6 @@ .. include:: /pages/operations/isoUSB-ops.rst .. include:: /pages/operations/external-ubuntu-ops.rst .. include:: /pages/operations/empty-role.rst -.. include:: /pages/operations/streamlined-patching.rst +.. include:: /pages/operations/configuring-repos-ops.rst +.. include:: /pages/operations/patching-ops.rst diff --git a/contents/contents-user.rst b/contents/contents-user.rst index 9936a2609..a6f7d921a 100644 --- a/contents/contents-user.rst +++ b/contents/contents-user.rst @@ -12,4 +12,4 @@ .. include:: /pages/user-guide/9000-role-operations.rst .. include:: /pages/user-guide/cli.rst .. include:: /pages/user-guide/vmware-integration-notes.rst -.. include:: /pages/user-guide/streamlined-patching-ug.rst +.. include:: /pages/user-guide/patching-ug.rst diff --git a/pages/operations/configuring-repos-ops.rst b/pages/operations/configuring-repos-ops.rst new file mode 100644 index 000000000..1218b7b73 --- /dev/null +++ b/pages/operations/configuring-repos-ops.rst @@ -0,0 +1,47 @@ +.. _configuring-repos-ops: + +Configuring repositories +======================== + +By default, your environments will have the configuration of the +repositories that point to the Mirantis update and security +repository mirrors. There is also an 'Auxiliary' repository configured +on the Fuel Master node which can be used to deliver packages +to the nodes. + +.. image:: /_images/patchingRepos.png + +To change the list of repositories, you will need to +amend the three fields which contain the required information +for the repositories configuration depending on the +distribution you install. + +For CentOS +---------- + +:: + + |repo-name|repo-baseurl|repo-priority| + +e.g + +:: + + my-repo http://my-domain.local/repo 10 + +For Ubuntu +---------- + +:: + + |repo-name|apt-sources-list-string|repo-priority| + + my-repo deb http://my-domain.local/repo trusty main 1200 + +Repository priorities +--------------------- + +For information on repository priorities read the following: + +* Ubuntu: `PinningHowto `_ +* CentOS: `yum-plugin-priorities `_ diff --git a/pages/operations/patching-ops.rst b/pages/operations/patching-ops.rst new file mode 100644 index 000000000..97fc964b8 --- /dev/null +++ b/pages/operations/patching-ops.rst @@ -0,0 +1,56 @@ +.. _patching-ops: + +Applying patches +================ + +.. note:: + The primary user of the the patching feature is + the Linux system administrator. If you are not confident enough, + you may want to skip this. + +With the patching feature in Mirantis OpenStack 6.1 you can +now keep your environment up-to-date in a customized fashion without +the need to upgrade to the latest version. + +.. note:: + The patching feature is introduced in + Mirantis OpenStack 6.1 and will not work in older releases. + +There are two types of officially supported updates: + +1. Bugfix updates -- These are released in an aggregated form and + consist of bug fixes and security updates. The bugfix updates + are run through our internal testing to ensure that they work + without breaking each other. +2. Security updates -- These are released as soon as they are available. + +Patching prerequisites +---------------------- + +* Make sure you are registered at at the `official Mirantis website `_. + Once you are registered, you will receive regular email notifications + on the available patches in an aggregate form. Once you receive the email, + you can click on the patching items listed there. This will lead you to + the `errata portal `_. + +* Make sure you have the repositories configured correctly as + described in :ref:`Configuring repositories`. + +* At the portal you will see a list of all the available patches. + Each patching item will have detailed instructions on how to + download and apply each of them. + +Applying the patches +-------------------- + +Each patch item listed at the the `errata portal `_ +will have the exact commands you need to run to download and apply +the patch -- usually ``yum`` or ``apt-get``, followed by restarting +the associated service. The listed commands need to be executed on +every node that you need to patch. + +In addition to the patch itself, Mirantis will also provide steps to verify that the patch was applied successfully. + +See below for an example. + +.. image:: /_images/errataPatching.png diff --git a/pages/operations/streamlined-patching.rst b/pages/operations/streamlined-patching.rst deleted file mode 100644 index 506d2b8ba..000000000 --- a/pages/operations/streamlined-patching.rst +++ /dev/null @@ -1,93 +0,0 @@ -.. _streamlined-patching-ops: - -Applying streamlined patching -============================= - -.. note:: - The primary user of the the streamlined patching feature is - the Linux system administrator. If you are not confident enough, - you may want to skip this. - -With the streamlined patching feature in Mirantis OpenStack 6.1 you can -now keep your environment up-to-date in a customized fashion without -the need to upgrade to the latest version. - -.. note:: - The streamlined patching feature is introduced in - Mirantis OpenStack 6.1 and will not work in older releases. - -There are two types of officially supported updates: - -1. Bugfix updates -- These are released in an aggregated form and - consist of bug fixes and security updates. The bugfix updates - are run through our internal testing to ensure that they work - without breaking each other. -2. Security updates -- These are released as soon as they are available. - -Streamlined patching prerequisites ----------------------------------- - -* Make sure you are registered at at the `official Mirantis website `_. - Once you are registered, you will receive regular email notifications - on the available patches in an aggregate form. Once you receive the email, - you can click on the patching items listed there. This will lead you to - the `errata portal `_. - -* At the portal you will see a list of all the available patches. - Each patching item will have detailed instructions on how to - download and apply each of them. - -* Make sure you have the repositories configured correctly as - described below. - -Configuring repositories ------------------------- - -By default, your environments will have the configuration of the -repositories that point to the Mirantis update and security -repository mirrors. There is also an 'Auxiliary' repository configured -on the Fuel Master node which can be used to deliver packages -to the nodes. - -To change the list of repositories, you will need to -amend the three fields which contain the required information -for the repositories configuration depending on the -distribution you install. - -For CentOS -++++++++++ - -:: - - |repo-name|repo-baseurl|repo-priority| - -e.g - -:: - - my-repo http://my-domain.local/repo 10 - -For Ubuntu -++++++++++ - -:: - - |repo-name|apt-sources-list-string|repo-priority| - -my-repo deb http://my-domain.local/repo trusty main 1200 - -Additional information -++++++++++++++++++++++ - -For additional information read the following: - -* Ubuntu: `PinningHowto `_ -* CentOS: `yum-plugin-priorities `_ - -Applying the patches --------------------- - -Each patch item listed at the the `errata portal `_ -will have the exact commands you need to run to download and apply -the patch -- usually ``yum`` or ``apt-get``. -The listed commands need to be executed on every node that you need to patch. diff --git a/pages/release-notes/v6-1/new-features/patch-openstack.rst b/pages/release-notes/v6-1/new-features/patch-openstack.rst index 36a2fd244..a0a788554 100644 --- a/pages/release-notes/v6-1/new-features/patch-openstack.rst +++ b/pages/release-notes/v6-1/new-features/patch-openstack.rst @@ -1,17 +1,17 @@ -Streamlined patching -++++++++++++++++++++ +Patching +++++++++ -The streamlined patching feature introduced in Mirantis OpenStack 6.1 +The patching feature introduced in Mirantis OpenStack 6.1 is the process of delivering product updates to users which can be applied using standard Linux commands (e.g. ``apt-get`` and ``yum``). -The streamlined patching feature allows you to keep your +The patching feature allows you to keep your environment up-to-date in a customized fashion without the need to upgrade to the latest version. -For your user experience and how-to see :ref:`Applying streamlined patching`. +For your user experience and how-to see :ref:`Applying patches`. .. note:: - The streamlined patching feature is introduced in + The patching feature is introduced in Mirantis OpenStack 6.1 and will not work in older releases. diff --git a/pages/user-guide/patching-ug.rst b/pages/user-guide/patching-ug.rst new file mode 100644 index 000000000..b709a4550 --- /dev/null +++ b/pages/user-guide/patching-ug.rst @@ -0,0 +1,8 @@ + +.. _patching-ug: + + +Patching +-------- + +For your user experience and how-to see :ref:`Applying patches`. diff --git a/pages/user-guide/streamlined-patching-ug.rst b/pages/user-guide/streamlined-patching-ug.rst deleted file mode 100644 index dc306578d..000000000 --- a/pages/user-guide/streamlined-patching-ug.rst +++ /dev/null @@ -1,8 +0,0 @@ - -.. _streamlined-patching-ug: - - -Streamlined patching --------------------- - -For your user experience and how-to see :ref:`Applying streamlined patching`.