moved patching guide into operations
Change-Id: Icb950fa9ef1956b7e68b4c15c69355a5936d04e2
This commit is contained in:
Meg McRoberts
parent
9e7c830e70
commit
24081d2b38
|
|
@ -18,6 +18,5 @@ Documentation
|
|||
operations
|
||||
reference-architecture
|
||||
release-notes
|
||||
openstack-patch-quick-ref
|
||||
frequently-asked-questions
|
||||
eula
|
||||
|
|
|
|||
|
|
@ -1,13 +0,0 @@
|
|||
.. index Table of Contents
|
||||
|
||||
|
||||
.. toctree:: Table of Contents
|
||||
:maxdepth: 2
|
||||
|
||||
.. include:: /pages/openstack-patch-quick-ref/0010-intro.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0020-identify-files.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0030-obtain-patch.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0040-distribute-patch.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0050-apply-patch.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0060-restart-services.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0070-rollback-patch.rst
|
||||
|
|
@ -7,3 +7,4 @@
|
|||
|
||||
.. include:: /pages/preface/preface.rst
|
||||
.. include:: /pages/operations/0000-intro.rst
|
||||
.. include:: /pages/operations/9500-patching.rst
|
||||
|
|
|
|||
|
|
@ -44,11 +44,6 @@ The following Mirantis OpenStack documentation is available in PDF:
|
|||
The Release Notes provide general information about new features,
|
||||
fixed issues, and known limitations in Mirantis OpenStack |version|.
|
||||
|
||||
* `OpenStack Patching Quick Reference Guide <pdf/Mirantis-OpenStack-4.1-OpenStack-Patch-Quick-Ref.pdf>`_
|
||||
|
||||
Patching OpenStack nodes is a manual process, and this document describes the
|
||||
basic steps required to patch one or more OpenStack components.
|
||||
|
||||
Download Mirantis OpenStack
|
||||
---------------------------
|
||||
You can download the Mirantis OpenStack ISO, IMG, and VirtualBox scripts at http://software.mirantis.com
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
.. index:: OpenStack-Patch Guide
|
||||
.. _OS-Patch_Guide:
|
||||
|
||||
========================================
|
||||
OpenStack Patching Quick Reference Guide
|
||||
========================================
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 3
|
||||
|
||||
.. include:: /pages/openstack-patch-quick-ref/0010-intro.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0020-identify-files.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0030-obtain-patch.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0032-github-com.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0033-git-openstack.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0034-local-git.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0040-distribute-patch.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0050-apply-patch.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0060-restart-services.rst
|
||||
.. include:: /pages/openstack-patch-quick-ref/0070-rollback-patch.rst
|
||||
|
|
@ -10,3 +10,4 @@ Operations Guide
|
|||
:depth: 2
|
||||
|
||||
.. include:: /pages/operations/0000-intro.rst
|
||||
.. include:: /pages/operations/9500-patching.rst
|
||||
|
|
|
|||
|
|
@ -0,0 +1,16 @@
|
|||
.. index:: OpenStack-Patch Guide
|
||||
.. _OS-Patch_Guide:
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 2
|
||||
|
||||
.. include:: /pages/operations/patch/0010-intro.rst
|
||||
.. include:: /pages/operations/patch/0020-identify-files.rst
|
||||
.. include:: /pages/operations/patch/0030-obtain-patch.rst
|
||||
.. include:: /pages/operations/patch/0032-github-com.rst
|
||||
.. include:: /pages/operations/patch/0033-git-openstack.rst
|
||||
.. include:: /pages/operations/patch/0034-local-git.rst
|
||||
.. include:: /pages/operations/patch/0040-distribute-patch.rst
|
||||
.. include:: /pages/operations/patch/0050-apply-patch.rst
|
||||
.. include:: /pages/operations/patch/0060-restart-services.rst
|
||||
.. include:: /pages/operations/patch/0070-rollback-patch.rst
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
.. index:: Introduction
|
||||
.. index:: Patching, OpenStack
|
||||
|
||||
.. _Intro:
|
||||
|
||||
Introduction
|
||||
============
|
||||
Applying a Patch
|
||||
================
|
||||
|
||||
A patch file is a representation of the difference in the code between
|
||||
two points in time, many times resulting from a discovered defect or
|
||||
|
|
@ -23,4 +23,4 @@ OpenStack components. The high level sections in this guide are:
|
|||
|
||||
#. Restart the services
|
||||
|
||||
#. Roll back a patch (optional)
|
||||
#. Roll back a patch (optional)
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
.. _IdFile:
|
||||
|
||||
Identify files to be patched
|
||||
============================
|
||||
----------------------------
|
||||
|
||||
Identifying files or components to be patched usually involves investigating
|
||||
change logs for new OpenStack releases or git commit messages. You can find
|
||||
|
|
@ -14,4 +14,4 @@ for your problem.
|
|||
|
||||
For example, looking at the Release Notes for the 2013.1.4 OpenStack Grizzly
|
||||
bugfix update, you can drill into the `List of OpenStack Compute (Nova) bugs fixed in the 2013.1.4 release <https://launchpad.net/nova/grizzly/2013.1.4>`_ and
|
||||
find that an `Incorrect host stats reported by VMware VCDriver <https://bugs.launchpad.net/bugs/1190515>`_ issue has been resolved.
|
||||
find that an `Incorrect host stats reported by VMware VCDriver <https://bugs.launchpad.net/bugs/1190515>`_ issue has been resolved.
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
.. _ObtPatch:
|
||||
|
||||
Obtain a patch
|
||||
==============
|
||||
--------------
|
||||
|
||||
You can obtain patches in three different ways:
|
||||
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
github.com method
|
||||
-----------------
|
||||
+++++++++++++++++
|
||||
|
||||
To generate a patch file from a github commit, simply add ``.patch`` at the
|
||||
end of your commit URL.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
git.openstack.org method
|
||||
------------------------
|
||||
++++++++++++++++++++++++
|
||||
|
||||
Using the git.openstack.org web interface, find a commit. Navigate to the
|
||||
"commit" tab and download the patch file named ``(patch)``.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
Local git repository method
|
||||
---------------------------
|
||||
+++++++++++++++++++++++++++
|
||||
|
||||
First, you will need to fetch repository data `using git <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_.
|
||||
|
||||
|
|
@ -3,11 +3,11 @@
|
|||
.. _DistPatch:
|
||||
|
||||
Distribute a patch
|
||||
==================
|
||||
------------------
|
||||
|
||||
Regardless of the method used to obtain the patch, after you download
|
||||
the patch, transfer the patch to every node in the OpenStack environment
|
||||
where you want to apply the fix. The simplest way to do this is to use ssh.
|
||||
For example::
|
||||
|
||||
$ scp file01.patch node1:/tmp
|
||||
$ scp file01.patch node1:/tmp
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
.. _ApplyPatch:
|
||||
|
||||
Apply a patch
|
||||
==============
|
||||
-------------
|
||||
|
||||
To apply the fix, first change the directory to the one that
|
||||
corresponds to your operating system. The OpenStack source code
|
||||
|
|
@ -44,4 +44,4 @@ we’re patching nova.::
|
|||
File to patch: /usr/share/pyshared/nova/baserpc.py
|
||||
patching file /usr/share/pyshared/nova/baserpc.py
|
||||
|
||||
.. note:: Ignore the message “can’t find file to patch at input line XX”. The reason it occurs is that the patch is not aware of the filesystem layout.
|
||||
.. note:: Ignore the message “can’t find file to patch at input line XX”. The reason it occurs is that the patch is not aware of the filesystem layout.
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
.. _RestartSvc:
|
||||
|
||||
Restart the services
|
||||
====================
|
||||
--------------------
|
||||
|
||||
Once the files are patched, restart all appropriate OpenStack services.
|
||||
If you patch nova, for example, restart all nova services running on a
|
||||
|
|
@ -15,4 +15,4 @@ given host with the following commands::
|
|||
|
||||
At this point, all of your services should be back up and running. You
|
||||
can now perform your sanity or functional tests against the patched
|
||||
environment to confirm that it is working as expected.
|
||||
environment to confirm that it is working as expected.
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
.. _RollbackPatch:
|
||||
|
||||
Roll back a patch
|
||||
=================
|
||||
-----------------
|
||||
|
||||
You can roll back a patch by simply reinstalling your files from the backup
|
||||
or, if you chose the ``-b`` option, by using the patch commands’ ``-R`` flag. Again,
|
||||
|
|
@ -27,4 +27,4 @@ please ignore the missing file errors.::
|
|||
|--- /usr/share/pyshared/nova/baserpc.py 2013-10-17 14:15:04.000000000 +0000
|
||||
--------------------------
|
||||
File to patch: /usr/share/pyshared/nova/baserpc.py
|
||||
patching file /usr/share/pyshared/nova/baserpc.py
|
||||
patching file /usr/share/pyshared/nova/baserpc.py
|
||||
|
|
@ -23,6 +23,5 @@ pdf_documents = [
|
|||
('pdf/pdf_operations', u'Mirantis-OpenStack-4.1-OperationsGuide', u'Operations Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_reference', u'Mirantis-OpenStack-4.1-ReferenceArchitecture', u'Reference Architecture', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_preinstall', u'Mirantis-OpenStack-4.1-Pre-InstallationGuide', u'Pre-Installation Guide', u'2014, Mirantis Inc.'),
|
||||
('pdf/pdf_patch', u'Mirantis-OpenStack-4.1-OpenStack-Patch-Quick-Ref', u'OpenStack Patching Quick Reference Guide', u'2014, Mirantis Inc.')
|
||||
# (master_doc, project, project, copyright),
|
||||
]
|
||||
|
|
|
|||
Loading…
Reference in New Issue