Skip to content
GitLab
Commit 01029ef7 authored by Dan Radez's avatar Dan Radez
Browse files

adding installation instructions 

JIRA: APEX-35

Change-Id: Iebbf85bd59844716961c27bb81ff7bbda2d1a1bf
parent 0d387f6e
Expand all Hide whitespace changes
Inline Side-by-side
build/Makefile
View file @ 01029ef7
......@@ -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
......
build/instackenv.json.example 0 → 100644
View file @ 01029ef7
{
"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",
}
]
}
build/opnfv-apex.spec
View file @ 01029ef7
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
......
ci/deploy.sh
View file @ 01029ef7
......@@ -174,7 +174,7 @@ function setup_instack_vm {
#add the instack brbm1 interface
virsh attach-interface --domain instack --type network --source brbm1 --model rtl8139 --config --live
sleep 1
ssh -T ${SSH_OPTIONS[@]} "root@$UNDERCLOUD" "if ! ip a s eth2 | grep 192.168.37.1 > /dev/null; then ip a a 192.168.37.252/24 dev eth2; ip link set up dev eth2; fi"
ssh -T ${SSH_OPTIONS[@]} "root@$UNDERCLOUD" "if ! ip a s eth2 | grep 192.168.37.1 > /dev/null; then ip a a 192.168.37.1/24 dev eth2; ip link set up dev eth2; fi"
# ssh key fix for stack user
ssh -T ${SSH_OPTIONS[@]} "root@$UNDERCLOUD" "restorecon -r /home/stack"
......
docs/etc/conf.py
View file @ 01029ef7
......@@ -18,7 +18,7 @@ master_doc = 'index'
pygments_style = 'sphinx'
html_use_index = False
pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
pdf_documents = [('index', u'Apex', u'Apex Project', u'OPNFV')]
pdf_fit_mode = "shrink"
pdf_stylesheets = ['sphinx','kerning','a4']
#latex_domain_indices = False
......@@ -28,7 +28,7 @@ latex_elements = {
'printindex': '',
}
project = u'OPNFV: Template documentation config'
project = u'Apex: OPNFV Installer'
copyright = u'%s, OPNFV' % datetime.date.today().year
version = u'1.0.0'
release = u'1.0.0'
docs/how-to-use-docs/documentation-example.rst deleted 100644 → 0
View file @ 0d387f6e
.. two dots create a comment. please leave this logo at the top of each of your rst files.
.. image:: ../etc/opnfv-logo.png
:height: 40
:width: 200
:alt: OPNFV
:align: left
.. these two pipes are to seperate the logo from the first title
|
|
How to create documentation for your OPNFV project
==================================================
this is the directory structure of the docs/ directory that can be found in the root of your project directory
.. code-block:: bash
./etc
./etc/opnfv-logo.png
./etc/conf.py
./how-to-use-docs
./how-to-use-docs/documentation-example.rst
./how-to-use-docs/index.rst
To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
This index file must refence your other rst files.
* Here is an example index.rst
.. code-block:: bash
Example Documentation table of contents
=======================================
Contents:
.. toctree::
:numbered:
:maxdepth: 4
documentation-example.rst
Indices and tables
==================
* :ref:`search`
Revision: _sha1_
Build date: |today|
The Sphinx Build
================
When you push documentation changes to gerrit a jenkins job will create html documentation.
* Verify Jobs
For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
* Merge jobs
Once you are happy with the look of your documentation you can submit the patchset the merge job will
copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
Here are some quick examples of how to use rst markup
This is a headline::
here is some code, note that it is indented
links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
* Bulleted Items
**this will be bold**
.. code-block:: bash
echo "Heres is a code block with bash syntax highlighting"
Leave these at the bottom of each of your documents they are used internally
Revision: _sha1_
Build date: |today|
docs/how-to-use-docs/index.rst → docs/installation-instructions/index.rst
View file @ 01029ef7
......@@ -9,8 +9,8 @@
:alt: OPNFV
:align: left
Example Documentation table of contents
=======================================
Apex Table of Contents
======================
Contents:
......@@ -18,7 +18,7 @@ Contents:
:numbered:
:maxdepth: 4
documentation-example.rst
installation-instructions.rst
Indices and tables
==================
......
docs/installation-instructions/installation-instructions.rst 0 → 100644
View file @ 01029ef7
This diff is collapsed.
docs/release-notes/index.rst 0 → 100644
View file @ 01029ef7
.. OPNFV Release Engineering documentation, created by
sphinx-quickstart on Tue Jun 9 19:12:31 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. image:: ../etc/opnfv-logo.png
:height: 40
:width: 200
:alt: OPNFV
:align: left
Apex Table of Contents
======================
Contents:
.. toctree::
:numbered:
:maxdepth: 4
release-notes.rst
Indices and tables
==================
* :ref:`search`
Revision: _sha1_
Build date: |today|
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment