adding installation instructions

JIRA: APEX-35

Change-Id: Iebbf85bd59844716961c27bb81ff7bbda2d1a1bf

3 files changed, 91 insertions, 2 deletions

diff --git a/build/Makefile b/build/Makefile
index 1a99637e..f503e1f6 100644
--- a/build/Makefile
+++ b/build/Makefile
@@ -110,6 +110,7 @@ rpm:
 	tar -u --xform="s:brbm1-net.xml:opnfv-apex-$(RPMVERS)/build/brbm1-net.xml:" --file=opnfv-apex.tar brbm1-net.xml
 	tar -u --xform="s:default-pool.xml:opnfv-apex-$(RPMVERS)/build/default-pool.xml:" --file=opnfv-apex.tar default-pool.xml
 	tar -u --xform="s:instackenv-virt.json:opnfv-apex-$(RPMVERS)/build/instackenv-virt.json:" --file=opnfv-apex.tar instackenv-virt.json
+	tar -u --xform="s:instackenv.json.example:opnfv-apex-$(RPMVERS)/build/instackenv.json.example:" --file=opnfv-apex.tar instackenv.json.example
 	tar -u --xform="s:stack/deploy-ramdisk-ironic.initramfs:opnfv-apex-$(RPMVERS)/build/stack/deploy-ramdisk-ironic.initramfs:" --file=opnfv-apex.tar stack/deploy-ramdisk-ironic.initramfs
 	tar -u --xform="s:stack/deploy-ramdisk-ironic.kernel:opnfv-apex-$(RPMVERS)/build/stack/deploy-ramdisk-ironic.kernel:" --file=opnfv-apex.tar stack/deploy-ramdisk-ironic.kernel
 	tar -u --xform="s:stack/ironic-python-agent.initramfs:opnfv-apex-$(RPMVERS)/build/stack/ironic-python-agent.initramfs:" --file=opnfv-apex.tar stack/ironic-python-agent.initramfs
diff --git a/build/instackenv.json.example b/build/instackenv.json.example
new file mode 100644
index 00000000..949e07d5
--- /dev/null
+++ b/build/instackenv.json.example
@@ -0,0 +1,69 @@
+{
+  "nodes": [
+    {
+      "cpu": "24",
+      "memory": "64220",
+      "disk": "40",
+      "arch": "x86_64",
+      "mac": [
+        "b8:ca:3a:63:8b:58"
+      ],
+      "pm_type": "pxe_ipmitool",
+      "pm_addr": "10.1.8.70",
+      "pm_user": "root"
+      "pm_password": "password",
+    },
+    {
+      "cpu": "24",
+      "memory": "64220",
+      "disk": "40",
+      "arch": "x86_64",
+      "mac": [
+        "b8:ca:3a:63:87:88"
+      ],
+      "pm_type": "pxe_ipmitool",
+      "pm_addr": "10.1.8.73",
+      "pm_user": "root"
+      "pm_password": "password",
+    },
+    {
+      "cpu": "24",
+      "memory": "64220",
+      "disk": "40",
+      "arch": "x86_64",
+      "mac": [
+        "b8:ca:3a:63:87:10"
+      ],
+      "pm_type": "pxe_ipmitool",
+      "pm_addr": "10.1.8.74",
+      "pm_user": "root"
+      "pm_password": "password",
+    },
+    {
+      "cpu": "24",
+      "memory": "64220",
+      "disk": "40",
+      "arch": "x86_64",
+      "mac": [
+        "B8:CA:3A:63:87:48"
+      ],
+      "pm_type": "pxe_ipmitool",
+      "pm_addr": "10.1.8.76",
+      "pm_user": "root"
+      "pm_password": "password",
+    },
+    {
+      "cpu": "24",
+      "memory": "64220",
+      "disk": "40",
+      "arch": "x86_64",
+      "mac": [
+        "B8:CA:3A:63:8B:18"
+      ],
+      "pm_type": "pxe_ipmitool",
+      "pm_addr": "10.1.8.78",
+      "pm_user": "root"
+      "pm_password": "password",
+    }
+  ]
+}
diff --git a/build/opnfv-apex.spec b/build/opnfv-apex.spec
index 29cede8a..546a92a5 100644
--- a/build/opnfv-apex.spec
+++ b/build/opnfv-apex.spec
@@ -1,5 +1,5 @@
 Name:		opnfv-apex
-Version:	2.2
+Version:	2.3
 Release:	%{release}
 Summary:	RDO Manager disk images for deployment
 
@@ -9,7 +9,7 @@ URL:		https://gerrit.opnfv.org/gerrit/apex.git
 Source0:	opnfv-apex.tar.gz
 
 BuildArch:	noarch
-BuildRequires:	openvswitch qemu-kvm
+BuildRequires:	openvswitch qemu-kvm python-docutils
 Requires:	openvswitch qemu-kvm bridge-utils libguestfs-tools
 
 %description
@@ -22,6 +22,8 @@ to deploy an OpenStack overcloud.
 
 
 %build
+rst2html docs/installation-instructions/installation-instructions.rst docs/installation-instructions.html
+rst2html docs/release-notes/index.rst docs/release-notes.html
 
 %install
 mkdir -p %{buildroot}%{_bindir}/
@@ -44,6 +46,7 @@ install build/opendaylight.yaml %{buildroot}%{_var}/opt/opnfv/
 install build/opendaylight.patch %{buildroot}%{_var}/opt/opnfv/
 
 install build/instackenv-virt.json %{buildroot}%{_var}/opt/opnfv/
+install build/instackenv.json.example %{buildroot}%{_var}/opt/opnfv/
 install build/stack/deploy-ramdisk-ironic.initramfs %{buildroot}%{_var}/opt/opnfv/stack/
 install build/stack/deploy-ramdisk-ironic.kernel %{buildroot}%{_var}/opt/opnfv/stack/
 install build/stack/ironic-python-agent.initramfs %{buildroot}%{_var}/opt/opnfv/stack/
@@ -53,6 +56,13 @@ install build/stack/overcloud-full.initrd %{buildroot}%{_var}/opt/opnfv/stack/
 install build/stack/overcloud-full.qcow2 %{buildroot}%{_var}/opt/opnfv/stack/
 install build/stack/overcloud-full.vmlinuz %{buildroot}%{_var}/opt/opnfv/stack/
 
+mkdir -p %{buildroot}%{_docdir}/opnfv/
+install LICENSE.rst %{buildroot}%{_docdir}/opnfv/
+install docs/installation-instructions/index.rst %{buildroot}%{_docdir}/opnfv/installation-instructions.rst
+install docs/installation-instructions.html %{buildroot}%{_docdir}/opnfv/
+install docs/release-notes/index.rst %{buildroot}%{_docdir}/opnfv/release-notes.rst
+install docs/release-notes.html %{buildroot}%{_docdir}/opnfv/
+
 %files
 %{_bindir}/opnfv-deploy
 %{_bindir}/opnfv-clean
@@ -68,6 +78,7 @@ install build/stack/overcloud-full.vmlinuz %{buildroot}%{_var}/opt/opnfv/stack/
 %{_var}/opt/opnfv/opendaylight.yaml
 %{_var}/opt/opnfv/opendaylight.patch
 %{_var}/opt/opnfv/instackenv-virt.json
+%{_var}/opt/opnfv/instackenv.json.example
 %{_var}/opt/opnfv/stack/deploy-ramdisk-ironic.initramfs
 %{_var}/opt/opnfv/stack/deploy-ramdisk-ironic.kernel
 %{_var}/opt/opnfv/stack/ironic-python-agent.initramfs
@@ -76,8 +87,16 @@ install build/stack/overcloud-full.vmlinuz %{buildroot}%{_var}/opt/opnfv/stack/
 %{_var}/opt/opnfv/stack/overcloud-full.initrd
 %{_var}/opt/opnfv/stack/overcloud-full.qcow2
 %{_var}/opt/opnfv/stack/overcloud-full.vmlinuz
+%doc %{_docdir}/opnfv/LICENSE.rst
+%doc %{_docdir}/opnfv/installation-instructions.rst
+%doc %{_docdir}/opnfv/installation-instructions.html
+%doc %{_docdir}/opnfv/release-notes.rst
+%doc %{_docdir}/opnfv/release-notes.html
+
 
 %changelog
+* Fri Nov 20 2015 Dan Radez <dradez@redhat.com> - 2.3-1
+- Adding documentation
 * Thu Nov 12 2015 Dan Radez <dradez@redhat.com> - 2.2-1
 - OpenDaylight and Network Isolation support
 * Wed Oct 21 2015 Dan Radez <dradez@redhat.com> - 2.1-1