diff options
| -rw-r--r-- | docs/etc/conf.py | 34 | ||||
| -rw-r--r-- | docs/etc/opnfv-logo.png | bin | 2829 -> 0 bytes | |||
| -rw-r--r-- | docs/how-to-use-compass4nfv/documentation-compass4nfv.rst | 179 | ||||
| -rw-r--r-- | docs/how-to-use-compass4nfv/index.rst | 31 | ||||
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 86 | ||||
| -rw-r--r-- | docs/how-to-use-docs/index.rst | 30 | ||||
| -rw-r--r-- | docs/index.rst | 13 |
7 files changed, 132 insertions, 241 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index 00660351..00000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,34 +0,0 @@ -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV: Template documentation config' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png Binary files differdeleted file mode 100644 index 1519503e..00000000 --- a/docs/etc/opnfv-logo.png +++ /dev/null diff --git a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst index 90b8b8df..c9e40dd7 100644 --- a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst +++ b/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst @@ -1,19 +1,14 @@ .. 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 -| -| + Prerequisite ============ 1. One jumpserver installed with Ubuntu14.04. -2. If baremetal is targeted deployment environment, we suggest the environment as the following topology picture, jumpserver and baremetal need 3 ethernet ports, one ports(External/Tenant) connects to one switch, and two ports(IPMI/BMC, PXE/Installation) connects to another switch. +2. If baremetal is targeted deployment environment, we suggest the environment as the following topology picture, +jumpserver and baremetal need 3 ethernet ports, one ports(External/Tenant) connects to one switch, +and two ports (IPMI/BMC, PXE/Installation) connects to another switch. .. image:: compass4nfv_network_topology.png :height: 400 @@ -21,7 +16,8 @@ Prerequisite :alt: OPNFV :align: left -If jumpserver doesn't have enough ethernet ports, two ports is also acceptable(IPMI/BMC and PXE/Installation run through one ethernet port). +If jumpserver doesn't have enough ethernet ports, two ports is +also acceptable(IPMI/BMC and PXE/Installation run through one ethernet port). If switches are not enough, one switch with 2 VLANs is also acceptable. @@ -38,7 +34,9 @@ If switches are not enough, one switch with 2 VLANs is also acceptable. 6. Please don't git clone compass4nfv in the root directory. -Attention: Compass4nfv does stick on the OPNFV communities' Operating System version requirement. For Brahmaputra, Ubuntu14.04 or newer and Centos7.0 or newer are requested, so the targeted deployment environment will be installed on Ubuntu14.04 or Centos7.1. +Attention: Compass4nfv does stick on the OPNFV communities' Operating System version requirement. +For Brahmaputra, Ubuntu14.04 or newer and Centos7.0 or newer are requested, +so the targeted deployment environment will be installed on Ubuntu14.04 or Centos7.1. @@ -48,19 +46,24 @@ How to build a customized ISO If you want to use Compass4nfv official ISO to deploy the environment, you can jump over this section. -This section indicates how to add additional packages and how to build a new compass4nfv ISO file so that Compass4nfv would install the additional packages automatically during the deployment. +This section indicates how to add additional packages and how to build a new compass4nfv ISO file +so that Compass4nfv would install the additional packages automatically during the deployment. * Approach 1 ----- apt/yum installation: -1. Confirm the targeted packages could be installed via apt-get(Ubuntu) and yum(Centos), you can verify on your own environment first by commands "apt-get install {targeted packages}" on Ubuntu and "yum install {targeted packages}" on Centos. +1. Confirm the targeted packages could be installed via apt-get(Ubuntu) and yum(Centos), +you can verify on your own environment first by commands +"apt-get install {targeted packages}" on Ubuntu and "yum install {targeted packages}" on Centos. -2. Create a new role folder ({newrole}) in the compass4nfv/deploy/adapters/ansible/roles/, create a new folder named "vars" in the new role folder({newrole}), and create a file named "main.yml" and add "---" at the head of this file. +2. Create a new role folder ({newrole}) in the compass4nfv/deploy/adapters/ansible/roles/, +create a new folder named "vars" in the new role folder({newrole}), +and create a file named "main.yml" and add "---" at the head of this file. -3. If the targeted packages names are same in both Ubuntu and Centos, you just need edit main.yml. +3. If the targeted packages names are same in both Ubuntu and Centos, you just need edit main.yml. Add the packages' names as following: @@ -73,7 +76,8 @@ Add the packages' names as following: ... -4. If the targeted packages' names are different in Ubuntu and Centos, you need create "Debian.yml" and/or "RedHat.yml" in the same folder as "main.yml" and add "---" at the head of the files. +4. If the targeted packages' names are different in Ubuntu and Centos, +you need create "Debian.yml" and/or "RedHat.yml" in the same folder as "main.yml" and add "---" at the head of the files. Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : @@ -90,7 +94,10 @@ Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : Also you can refer "compass4nfv/deploy/adapters/ansible/roles/glance/vars" as example. -5.1 Add the new role to ansible so that Compass4nfv will install the packages during the deployment : "enter compass4nfv/deploy/adapters/ansible/openstack_juno/" and edit HA-ansible-multinodes.yml and/or single-controller.yml, add {newrole} at an appropriate position, please be aware of that compass4nfv deploys the roles in the order as list in HA-ansible-multinodes.yml/single-controller.yml, you can add a new section as the following:: +5.1 Add the new role to ansible so that Compass4nfv will install the packages during the deployment : +"enter compass4nfv/deploy/adapters/ansible/openstack_juno/" and edit HA-ansible-multinodes.yml and/or single-controller.yml, +add {newrole} at an appropriate position, please be aware of that compass4nfv deploys the roles +in the order as list in HA-ansible-multinodes.yml/single-controller.yml, you can add a new section as the following:: - hosts: all/controller/compute/ha remote_user: root @@ -98,19 +105,23 @@ Also you can refer "compass4nfv/deploy/adapters/ansible/roles/glance/vars" as ex roles: - {newrole} -The first line "hosts" of the section means compass4nfv will deploy {newrole} on which baremetals/VMs, "all" means it deploys on all baremetals/VMs, "controller" means it deploys on all controller and so on. - +The first line "hosts" of the section means compass4nfv will deploy {newrole} on which baremetals/VMs, +"all" means it deploys on all baremetals/VMs, "controller" means it deploys on all controller and so on. + Also you can refer "glance" position in HA-ansible-multinodes.yml and single-controller.yml. Attention - "HA-ansible-multinodes.yml" deploys controllers backup targeted environment and 3 controllers in backup mode + 2 compute by default;. + "HA-ansible-multinodes.yml" deploys controllers backup targeted environment +and 3 controllers in backup mode + 2 compute by default;. "single-controller.yml" deploys 1 controller + 4 compute. -5.2 Or insert the new role into the existing section at an appropriate position in HA-ansible-multinodes.yml and single-controller.yml. +5.2 Or insert the new role into the existing section at an appropriate position in +HA-ansible-multinodes.yml and single-controller.yml. Example: + .. code-block:: bash - hosts: controller/all/compute/ha @@ -134,7 +145,8 @@ Also you can refer "glance" position as example in HA-ansible-multinodes.yml and 6. Run compass4nfv/build/make_repo.sh. -7. After 6 finishs, please check "compass4nfv/work/repo/" folder, if files as following exist in the folder, that means building packages successfully. +7. After 6 finishs, please check "compass4nfv/work/repo/" folder, +if files as following exist in the folder, that means building packages successfully. centos7-juno-ppa.tar.gz is OpenStack Juno version for Centos7. @@ -143,7 +155,8 @@ trusty-juno-ppa.tar.gz is OpenStack Juno version for Ubuntu14.04. trusty-kilo-ppa.tar.gz is OpenStack Kilo version for Ubuntu14.04. -8. Edit compass4nfv/build/build.conf, find CENTOS7_JUNO_PPA and TRUSTY_JUNO_PPA items, modify these 2 items as local paths(if you just want deploy with one operating system, you just modify one item). +8. Edit compass4nfv/build/build.conf, find CENTOS7_JUNO_PPA and TRUSTY_JUNO_PPA items, +modify these 2 items as local paths(if you just want deploy with one operating system, you just modify one item). CENTOS7_JUNO_PPA is packages path for Centos, TRUSTY_JUNO_PPA is packages path for Ubuntu @@ -154,7 +167,8 @@ CENTOS7_JUNO_PPA is packages path for Centos, TRUSTY_JUNO_PPA is packages path f TRUSTY_JUNO_PPA=/compass4nfv/work/repo/trusty-juno-ppa.tar.gz -9. Run compass4nfv/build.sh to build a new ISO, after finished, if there is a new ISO file compass.iso in the "compass4nfv/work/building" folder, that means building iso successfully. +9. Run compass4nfv/build.sh to build a new ISO, after finished, if there is a new ISO file compass.iso +in the "compass4nfv/work/building" folder, that means building iso successfully. @@ -162,10 +176,13 @@ CENTOS7_JUNO_PPA is packages path for Centos, TRUSTY_JUNO_PPA is packages path f * Approach 2 ---- source installation -This section indicates to install packages from source codes. If the targeted packages could not be installed from apt-get and yum but from source codes, please refer this section. +This section indicates to install packages from source codes. If the targeted packages could not be +installed from apt-get and yum but from source codes, please refer this section. -1. Enter folder "compass4nfv/build/arch/Debian" or "compass4nfv/build/arch/RedHat" that depend on operating system you want to install package, create a bash(.sh) file which includes all the commands which install the packages from source codes. +1. Enter folder "compass4nfv/build/arch/Debian" or "compass4nfv/build/arch/RedHat" that depend on +operating system you want to install package, create a bash(.sh) file +which includes all the commands which install the packages from source codes. Example: @@ -189,13 +206,17 @@ This section indicates to install packages from source codes. If the targeted pa cp -f *.deb /var/cache/apt/archives/ popd -Please pay attention to the last second sentence, all the compiled packages need to be copied to the "/var/cache/apt/archives/"(Ubuntu) folder, and for Centos, the folder is ... to be continued . +Please pay attention to the last second sentence, all the compiled packages need to be +copied to the "/var/cache/apt/archives/"(Ubuntu) folder, and for Centos, the folder is ... to be continued . -2. Add a new role so that Compass4nfv will install the packages during the deployment, create a new role folder ({newrole}) in the "compass4nfv/deploy/adapters/ansible/roles/", create a new folder named "vars" in the new role folder({newrole}), and create a file named "main.yml" and add "---" at the head of this file. +2. Add a new role so that Compass4nfv will install the packages during the deployment, +create a new role folder ({newrole}) in the "compass4nfv/deploy/adapters/ansible/roles/", +create a new folder named "vars" in the new role folder({newrole}), +and create a file named "main.yml" and add "---" at the head of this file. -3. If the packages' names are same in both Ubuntu and Centos, you just need edit main.yml. +3. If the packages' names are same in both Ubuntu and Centos, you just need edit main.yml. Add the packages' names as following: @@ -208,7 +229,9 @@ Add the packages' names as following: ... -4. If the targeted packages' names are different in Ubuntu and Centos, you need create "Debian.yml" and/or "RedHat.yml" in the same folder as "main.yml" and add "---" at the head of the files. +4. If the targeted packages' names are different in Ubuntu and Centos, +you need create "Debian.yml" and/or "RedHat.yml" in the same folder as "main.yml" +and add "---" at the head of the files. Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : @@ -224,7 +247,10 @@ Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : Also you can refer "compass4nfv/deploy/adapters/ansible/roles/glance/vars" as example. -5.1 Enter "compass4nfv/deploy/adapters/ansible/openstack_juno/" and edit HA-ansible-multinodes.yml and/or single-controller.yml, add {newrole} at an appropriate position, please be aware of that compass4nfv deploys the roles in the order as list in HA-ansible-multinodes.yml/single-controller.yml, you can add a new section as the following:: +5.1 Enter "compass4nfv/deploy/adapters/ansible/openstack_juno/" and edit HA-ansible-multinodes.yml +and/or single-controller.yml, add {newrole} at an appropriate position, please be aware of that compass4nfv +deploys the roles in the order as list in HA-ansible-multinodes.yml/single-controller.yml, +you can add a new section as the following:: - hosts: all/controller/compute/ha remote_user: root @@ -232,19 +258,23 @@ Also you can refer "compass4nfv/deploy/adapters/ansible/roles/glance/vars" as ex roles: - {newrole} -The first line "hosts" of the section means compass4nfv will deploy {newrole} on which baremetals/VMs, "all" means it deploys on all baremetals/VMs, "controller" means it deploys on all controller and so on. - +The first line "hosts" of the section means compass4nfv will deploy {newrole} on which baremetals/VMs, +"all" means it deploys on all baremetals/VMs, "controller" means it deploys on all controller and so on. + Also you can refer "glance" position in HA-ansible-multinodes.yml and single-controller.yml. Attention - "HA-ansible-multinodes.yml" deploys controllers backup targeted environment and 3 controllers in backup mode + 2 compute by default. + "HA-ansible-multinodes.yml" deploys controllers backup targeted environment and +3 controllers in backup mode + 2 compute by default. "single-controller.yml" deploys 1 controller + 4 compute. -5.2 Or insert the new role into the existing section at an appropriate position in HA-ansible-multinodes.yml and single-controller.yml. +5.2 Or insert the new role into the existing section at an appropriate position +in HA-ansible-multinodes.yml and single-controller.yml. Example: + .. code-block:: bash - hosts: controller @@ -270,7 +300,8 @@ Also you can refer "glance" position as example in HA-ansible-multinodes.yml and -7. After 6 finishs, please check "compass4nfv/work/repo/" folder, if files as following exist in the folder, that means building packages successfully. +7. After 6 finishs, please check "compass4nfv/work/repo/" folder, +if files as following exist in the folder, that means building packages successfully. centos7-juno-ppa.tar.gz is OpenStack Juno version for Centos7. @@ -280,7 +311,8 @@ trusty-kilo-ppa.tar.gz is OpenStack Kilo version for Ubuntu14.04. -8. Edit compass4nfv/build/build.conf, find CENTOS7_JUNO_PPA and TRUSTY_JUNO_PPA items, modify these 2 items as local paths(if you just want deploy with one operating system, you just modify one item). +8. Edit compass4nfv/build/build.conf, find CENTOS7_JUNO_PPA and TRUSTY_JUNO_PPA items, +modify these 2 items as local paths(if you just want deploy with one operating system, you just modify one item). CENTOS7_JUNO_PPA is packages path for Centos, TRUSTY_JUNO_PPA is packages path for Ubuntu @@ -292,11 +324,12 @@ CENTOS7_JUNO_PPA is packages path for Centos, TRUSTY_JUNO_PPA is packages path f -9. Run compass4nfv/build.sh to build a new ISO, after finished, if there is a new ISO file compass.iso in the "compass4nfv/work/building" folder, that means building ISO successfully. +9. Run compass4nfv/build.sh to build a new ISO, after finished, if there is a new ISO file compass.iso +in the "compass4nfv/work/building" folder, that means building ISO successfully. -* Approach 3 ---- autonomous packages installation +* Approach 3 ---- autonomous packages installation package installed, to be continued... @@ -305,7 +338,8 @@ package installed, to be continued... How to deploy baremetal and VMs =============================== -Before deployment, there are some network configuration to be checked based on your reality network topology. Compass4nfv network configuration file is "compass4nfv/deploy/conf/network_cfg.yaml". +Before deployment, there are some network configuration to be checked based on your reality network topology. +Compass4nfv network configuration file is "compass4nfv/deploy/conf/network_cfg.yaml". Based on current default network configuration, the hosts(controller,compute) network is as following picture. @@ -314,8 +348,6 @@ Based on current default network configuration, the hosts(controller,compute) ne :width: 700 :alt: OPNFV :align: left -| -| network_cfg.yaml @@ -377,25 +409,30 @@ network_cfg.yaml -"br-prv" is a bridge created by OpenvSwitch, "mgmt" "storage" and "external" are VLAN. +"br-prv" is a bridge created by OpenvSwitch, "mgmt" "storage" and "external" are VLAN. -"mgmt" "stoarge" and "br-prv" can locate on any ethernet port("interface") as long as the host can communicate with other hosts via this ethernet. +"mgmt" "stoarge" and "br-prv" can locate on any ethernet port("interface") +as long as the host can communicate with other hosts via this ethernet. "external" must locate on "br-prv". -"mgmt" "storage" and "external" could be set subnet as you like , but must be in different subnets and "vlan_tag" also must be different. +"mgmt" "storage" and "external" could be set subnet as you like, +but must be in different subnets and "vlan_tag" also must be different. Also check the following items in file "compass4nfv/deploy/conf/base.conf" .. code-block:: bash - + export INSTALL_IP=${INSTALL_IP:-10.1.0.12} export INSTALL_MASK=${INSTALL_MASK:-255.255.255.0} export INSTALL_GW=${INSTALL_GW:-10.1.0.1} -Item "INSTALL_IP" is used to install baremetal/VM during deployment. Compass4nfv on jumpserver creates a bridge with IP address "INSTALL_GW" and all baremetal/VM deployments are via this subnet. Please don't set this item as the same subnet as any other ip configuration in the jumpserver. +Item "INSTALL_IP" is used to install baremetal/VM during deployment. +Compass4nfv on jumpserver creates a bridge with IP address "INSTALL_GW" and +all baremetal/VM deployments are via this subnet. Please don't set this item +as the same subnet as any other ip configuration in the jumpserver. @@ -404,13 +441,16 @@ Item "INSTALL_IP" is used to install baremetal/VM during deployment. Compass4nfv * Deploy baremetal in HA mode: -1. (optional) If you have built a new ISO before and want to use the new ISO, please edit compass4nfv/deploy/conf/base.conf file, modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso +1. (optional) If you have built a new ISO before and want to use the new ISO, +please edit compass4nfv/deploy/conf/base.conf file, +modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso 2. Edit compass4nfv/deploy/conf/baremetal_cluster_general.yml, to be continued... -3. Edit compass4nfv/deploy/conf/base.conf, modify the item "export OM_NIC=${OM_NIC:-eth3}" as the install network ethernet port based your jumpserver. +3. Edit compass4nfv/deploy/conf/base.conf, modify the item "export OM_NIC=${OM_NIC:-eth3}" +as the install network ethernet port based your jumpserver. 4. Run compass4nfv/deploy.sh baremetal_cluster_general @@ -421,13 +461,17 @@ Item "INSTALL_IP" is used to install baremetal/VM during deployment. Compass4nfv * Deploy baremetal in Single mode: -1. (optional) If you have built a new ISO before and want to use the new ISO, please edit compass4nfv/deploy/conf/base.conf file, modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso +1. (optional) If you have built a new ISO before and want to use the new ISO, +please edit compass4nfv/deploy/conf/base.conf file, modify the item "ISO_URL" +as export ISO_URL=file:///compass4nfv/work/building/compass.iso -2. Edit compass4nfv/deploy/conf/baremetal_five.yml , change items [name, mac, ipmiUser, ipmiPass, ipmiIp, roles] based on the baremetal to be deployed. +2. Edit compass4nfv/deploy/conf/baremetal_five.yml , change items +[name, mac, ipmiUser, ipmiPass, ipmiIp, roles] based on the baremetal to be deployed. -3. Edit compass4nfv/deploy/conf/base.conf, modify the item "export OM_NIC=${OM_NIC:-eth3}" as the install network ethernet port based your jumpserver. +3. Edit compass4nfv/deploy/conf/base.conf, modify the item +"export OM_NIC=${OM_NIC:-eth3}" as the install network ethernet port based your jumpserver. 4. Run compass4nfv/deploy.sh baremetal_five @@ -438,10 +482,14 @@ Item "INSTALL_IP" is used to install baremetal/VM during deployment. Compass4nfv * Deploy VMs in HA mode: -1. (optional) If you have built a new ISO before and want to use the new ISO, please edit compass4nfv/deploy/conf/base.conf file, modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso +1. (optional) If you have built a new ISO before and want to use the new ISO, +please edit compass4nfv/deploy/conf/base.conf file, modify the item +"ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso -2. (Optional) Edit compass4nfv/deploy/conf/virtual_cluster.yml, change items [name, roles] as you want, also you could reduce or add hosts sections as you want. And 3 controller in HA mode and 2 compute will be deployed without changing this yml file. +2. (Optional) Edit compass4nfv/deploy/conf/virtual_cluster.yml, change items [name, roles] as you want, +also you could reduce or add hosts sections as you want. +And 3 controller in HA mode and 2 compute will be deployed without changing this yml file. 3. Run compass4nfv/deploy.sh virtual_cluster or Run compass4nfv/deploy.sh . @@ -452,10 +500,14 @@ Item "INSTALL_IP" is used to install baremetal/VM during deployment. Compass4nfv * Deploy baremetal in Single mode: -1. (optional) If you have built a new ISO before and want to use the new ISO, please edit compass4nfv/deploy/conf/base.conf file, modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso +1. (optional) If you have built a new ISO before and want to use the new ISO, +please edit compass4nfv/deploy/conf/base.conf file, +modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso -2. (Optional) Edit compass4nfv/deploy/conf/virtual_five.yml, change items [name, roles] as you want, also you could reduce or add hosts sections as you want. And 3 controller in HA mode and 2 compute will be deployed without changing this yml file. +2. (Optional) Edit compass4nfv/deploy/conf/virtual_five.yml, change items [name, roles] as you want, +also you could reduce or add hosts sections as you want. +And 3 controller in HA mode and 2 compute will be deployed without changing this yml file. 3. Run compass4nfv/deploy.sh virtual_five . @@ -472,10 +524,16 @@ How to deploy without internet access ===================================== -If you have created your own ISO file(compass.iso), you realy could deploy without internet access, edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path (export ISO_URL=file:///compass4nfv/work/building/compass.iso). Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access. +If you have created your own ISO file(compass.iso), you realy could deploy without internet access, +edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path +(export ISO_URL=file:///compass4nfv/work/building/compass.iso). +Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access. -Also you can download compass.iso first from OPNFV artifacts repository (http://artifacts.opnfv.org/, search compass4nfv and select an appropriate ISO file) via wget or curl. After this, edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path. Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access. +Also you can download compass.iso first from OPNFV artifacts repository +(http://artifacts.opnfv.org/, search compass4nfv and select an appropriate ISO file) via wget or curl. +After this, edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path. +Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access. @@ -498,12 +556,13 @@ 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 +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 diff --git a/docs/how-to-use-compass4nfv/index.rst b/docs/how-to-use-compass4nfv/index.rst deleted file mode 100644 index dd6ee003..00000000 --- a/docs/how-to-use-compass4nfv/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. 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 -| -| -Compass4nfv Documentation -========================= - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 4 - - documentation-compass4nfv.rst - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst deleted file mode 100644 index afcf7581..00000000 --- a/docs/how-to-use-docs/documentation-example.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. 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| diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst deleted file mode 100644 index 36710b32..00000000 --- a/docs/how-to-use-docs/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. 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 - -Example Documentation table of contents -======================================= - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 4 - - documentation-example.rst - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..f4a5bdeb --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,13 @@ +********************* +Compass4nfv Project +********************* + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + how-to-use-compass4nfv/documentation-compass4nfv.rst + how-to-use-compass4nfv/compass4nfv_host_network.png + how-to-use-compass4nfv/compass4nfv_network_topology.png |
