diff options
| -rw-r--r-- | docs/FAQ/faq.rst | 21 | ||||
| -rw-r--r-- | docs/FAQ/how-to-build-customized-iso.rst | 42 | ||||
| -rw-r--r-- | docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst | 7 | ||||
| -rw-r--r-- | docs/FAQ/how-to-deploy-without-internet-access.rst | 11 | ||||
| -rw-r--r-- | docs/FAQ/how-to-integrate-plugins.rst | 7 | ||||
| -rw-r--r-- | docs/FAQ/index.rst | 6 |
6 files changed, 30 insertions, 64 deletions
diff --git a/docs/FAQ/faq.rst b/docs/FAQ/faq.rst index feae4142..177ff0bb 100644 --- a/docs/FAQ/faq.rst +++ b/docs/FAQ/faq.rst @@ -21,7 +21,9 @@ What's the additional setting in switch if use the default network configuration ================================================================================ Here is the Compass4nfv default network configration file: -compass4nfv/deploy/conf/network_cfg.yaml +compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml +OR +compass4nfv_FAQ/deploy/conf/vm_environment/huawei-virtual1/network.yml It uses a VLAN network for mgmt and storage networks that are share one NIC(eth1) as a default network configuration. So you need add an additional tagged VLAN (101) and VLAN (102) on @@ -58,25 +60,26 @@ How to visit OpenStack Dashboard You can visit OpenStack Dashboard by URL: http://{puclib_vip}/horizon -The public virtual IP is configured in "compass4nfv/deploy/conf/network_cfg.yaml", defined as below: +The public virtual IP is configured in "compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml" +or "compass4nfv_FAQ/deploy/conf/vm_environment/huawei-virtual1/network.yml", defined as below: .. code-block:: yaml public_vip: ip: 192.168.50.240 -How to access BM nodes after deployment -======================================= +How to access controller nodes after deployment +=============================================== -1. First you should login Compass VM via ssh command on Jumphost by default user/pass root/root. +1. First you should login Compass VM via ssh command on Jumphost by default user/pass root/root. The default login IP of Compass VM is configured in "compass4nfv/deploy/conf/base.conf", defined as below: .. code-block:: bash export MGMT_IP=${MGMT_IP:-192.168.200.2} -2. Then you can login the BM nodes (host1-3) by default user/pass root/root via the install network IPs -which are configured in "compass4nfv/deploy/conf/base.conf", defined as below: +2. Then you can login the controller nodes (host1-3) by default user/pass root/root via the install +network IPs which are configured in "compass4nfv/deploy/conf/base.conf", defined as below: .. code-block:: bash @@ -108,8 +111,8 @@ which are configured in "compass4nfv/deploy/conf/base.conf", defined as below: Where is OpenStack RC file ========================== -It is located /opt/admin-openrc.sh in each BM node as default. Please source it first if you want to use -OpenStack CLI. +It is located /opt/admin-openrc.sh in each controller node as default. Please source it first if you +want to use OpenStack CLI. How to recovery network connection after Jumphost reboot ======================================================== diff --git a/docs/FAQ/how-to-build-customized-iso.rst b/docs/FAQ/how-to-build-customized-iso.rst index 37b5c72b..c0bf4083 100644 --- a/docs/FAQ/how-to-build-customized-iso.rst +++ b/docs/FAQ/how-to-build-customized-iso.rst @@ -5,24 +5,20 @@ 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. - -* Approach 1 ----- apt/yum installation: - +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. - 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. Add the packages' names as following: @@ -35,7 +31,6 @@ Add the packages' names as following: - {targeted packages3} ... - 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. @@ -50,10 +45,8 @@ Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : - {targeted Ubuntu/RedHat packages3} ... - 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 @@ -70,7 +63,6 @@ The first line "hosts" of the section means compass4nfv will deploy {newrole} 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;. @@ -101,10 +93,8 @@ Also please pay attention to the position inserted as Compass4nfv deploys the pa Also you can refer "glance" position as example in HA-ansible-multinodes.yml and single-controller.yml. - 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. @@ -130,16 +120,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. - - - -* Approach 2 ---- source installation - +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. - 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. @@ -169,13 +155,11 @@ which includes all the commands which install the packages from source codes. 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. - 3. If the packages' names are same in both Ubuntu and Centos, you just need edit main.yml. Add the packages' names as following: @@ -203,10 +187,8 @@ Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : - {targeted Ubuntu/RedHat packages3} ... - 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, @@ -223,13 +205,11 @@ The first line "hosts" of the section means compass4nfv will deploy {newrole} 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. "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. @@ -254,12 +234,8 @@ Also please pay attention to the position inserted as Compass4nfv deploys the pa Also you can refer "glance" position as example in HA-ansible-multinodes.yml and single-controller.yml. - - 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. @@ -269,8 +245,6 @@ 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). @@ -282,13 +256,5 @@ 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. - - - -* Approach 3 ---- autonomous packages installation - -package installed, to be continued... diff --git a/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst b/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst index f12d38d0..986bd79a 100644 --- a/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst +++ b/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst @@ -3,8 +3,11 @@ How to deploy while Jumphost cannot access internet =================================================== -If your Jumphost cannot access internet, don't worry, you can definitely deploy compass without internet access. +If your Jumphost cannot access internet, don't worry, you can definitely deploy compass without +internet access. -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. Then copy the compass.iso and the compass4nfv repository to your Jumphost and editor the ISO_URL to your local path. +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. Then copy the compass.iso +and the compass4nfv repository to your Jumphost and editor the ISO_URL to your local path. After that you can deploy compass without internet access. diff --git a/docs/FAQ/how-to-deploy-without-internet-access.rst b/docs/FAQ/how-to-deploy-without-internet-access.rst index 6bfcb3de..e91f110b 100644 --- a/docs/FAQ/how-to-deploy-without-internet-access.rst +++ b/docs/FAQ/how-to-deploy-without-internet-access.rst @@ -6,13 +6,12 @@ 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. - +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. - - +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. diff --git a/docs/FAQ/how-to-integrate-plugins.rst b/docs/FAQ/how-to-integrate-plugins.rst deleted file mode 100644 index 8e810d7d..00000000 --- a/docs/FAQ/how-to-integrate-plugins.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. - -How to integrate plugins -======================== - -tbd - diff --git a/docs/FAQ/index.rst b/docs/FAQ/index.rst index 7b349d0e..36408d0d 100644 --- a/docs/FAQ/index.rst +++ b/docs/FAQ/index.rst @@ -5,10 +5,12 @@ OPNFV(Colorado) Compass4nfv Frequently Asked Questions ========================================================= -Contents: - .. toctree:: :numbered: :maxdepth: 4 + how-to-build-customized-iso.rst + how-to-deploy-while-jumphost-cannot-access-internet.rst + how-to-deploy-without-internet-access.rst + how-to-integrate-plugins.rst faq.rst |