From 69162bac41bdf26dfc54961e00c8eab5c88528be Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Wed, 2 May 2018 15:49:02 -0400 Subject: [PATCH] Migrate doc on how to install CP to RST Migrate the Common Packer install documentation into RST. Issue: RELENG-513 Change-Id: Ibe61a55e9e4857c33173d5c67bc88ed07d449420 Signed-off-by: Thanh Ha --- docs/index.rst | 2 ++ docs/install.rst | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 docs/install.rst diff --git a/docs/index.rst b/docs/index.rst index 2693120..63b58cb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,6 +8,8 @@ VM configuration. .. toctree:: :maxdepth: 1 + install + Indices and tables ================== diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..75963c2 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,38 @@ +##################### +Install Common Packer +##################### + +Deploy common-packer in the ci-management repository's packer directory as a +submodule. Installing, upgrading, and rolling back changes is simple via the +versioned git tags. + +#. Choose a common packer version to install + + .. code-block:: bash + + COMMON_PACKER_VERSION=v0.1.0 + +#. Clone common-packer into ci-management repo + + .. code-block:: bash + + cd packer/ + git submodule add https://github.com/lfit/releng-common-packer common-packer + + # Checkout the version of common-packer you wish to deploy + cd common-packer + git checkout $COMMON_PACKER_VERSION + +#. Commit common-packer version to the ci-managment repo + + .. code-block:: bash + + cd ../.. + git add packer/common-packer + git commit -sm "Install common-packer $COMMON_PACKER_VERSION" + +#. Push the patch to ci-management for review + + .. code-block:: bash + + git review -- 2.16.6