diff options
Diffstat (limited to 'docs/FAQ')
| -rw-r--r-- | docs/FAQ/faq.rst | 129 | ||||
| -rw-r--r-- | docs/FAQ/how-to-build-customized-iso.rst | 260 | ||||
| -rw-r--r-- | docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst | 13 | ||||
| -rw-r--r-- | docs/FAQ/how-to-deploy-without-internet-access.rst | 17 | ||||
| -rw-r--r-- | docs/FAQ/index.rst | 15 |
5 files changed, 0 insertions, 434 deletions
diff --git a/docs/FAQ/faq.rst b/docs/FAQ/faq.rst deleted file mode 100644 index 177ff0bb..00000000 --- a/docs/FAQ/faq.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) - - -What is Compass4nfv -=================== - -Compass4nfv is an installer project based on open source project Compass, -which provides automated deployment and management of OpenStack and other distributed systems. -It can be considered as what the LiveCD to a single box for a pool of servers – bootstrapping -the server pool. - -see more information, please visit - -`OPNFV Compass4nfv project page <https://wiki.opnfv.org/compass4nfv>`_ - -`COMPASS Home Page <http://www.syscompass.org/>`_ - -What's the additional setting in switch if use the default network configuration -================================================================================ - -Here is the Compass4nfv default network configration file: -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 -eth1's switch for access. - -How to deal with installation failure caused by setting pxe and reset nodes failed -================================================================================== - -At first, please make sure that deployed nodes' ipmi network can access from Jumphost and -IPMI user/pass is correct. - -Compass4nfv supports IPMI 1.0 or IPMI 2.0 to control your nodes, so you can set it according your IPMI -version in dha.yml. - -.. code-block:: yaml - - ipmiVer: '2.0' - -How to deal with installation failure caused by "The Server quit without updating PID file" -=========================================================================================== - -If you see "The Server quit without updating PID file" in installation print log, it is caused by -mgmt network can't access from each deployed nodes, so you need to check your switch setting whether -an additional tagged VLAN is added if uses default network configuration. - -How to set OpenStack Dashboard login user and password -====================================================== - -It uses admin/console as the default user/pass for OpenStack Dashboard, and you can set it in below file: -compass4nfv/deploy/conf/base.conf - -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/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 controller nodes after deployment -=============================================== - -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 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 - - export MANAGEMENT_IP_START=${MANAGEMENT_IP_START:-'10.1.0.50'} - - -.. code-block:: console - - - +-------------+ - | | - +----------+ host1 | - | | | - | +-------------+ - | - +---------+ | +-------------+ - | | install | | | - | Compass +---------------+----------+ host2 | - | | network | | | - +---+VM+--+ | +-------------+ - +--------------------+ | - | | | +-------------+ - | Jumphost | | | | - | | +----------+ host3 | - +--------------------+ | | - +-------------+ - - -Where is OpenStack RC file -========================== - -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 -======================================================== - -.. code-block:: bash - - source deploy/network.sh && save_network_info - -References -========== -For more information on the Compass4nfv FAQ, please visit - -`COMPASS FAQ WIKI Page <https://wiki.opnfv.org/compass4nfv_faq>`_ - diff --git a/docs/FAQ/how-to-build-customized-iso.rst b/docs/FAQ/how-to-build-customized-iso.rst deleted file mode 100644 index c0bf4083..00000000 --- a/docs/FAQ/how-to-build-customized-iso.rst +++ /dev/null @@ -1,260 +0,0 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. - -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 -------------------------------------- - -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: - -.. code-block:: bash - - packages_noarch: - - {targeted packages1} - - {targeted packages2} - - {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. - -Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : - -.. code-block:: bash - - --- - packages: - - {targeted Ubuntu/RedHat packages1} - - {targeted Ubuntu/RedHat packages2} - - {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 -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 - sudo: True - 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. - -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. - - Example: - -.. code-block:: bash - - - hosts: controller/all/compute/ha - remote_user: root - sudo: True - roles: - - database - - mq - - keystone - - nova-controller - - neutron-controller - - {newrole} - -Please pay attention to the first line "hosts" by which Compass4nfv deploys {newrole} on which baremetals/VMs. - -Also please pay attention to the position inserted as Compass4nfv deploys the packages in the order as list. - -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. - -centos7-juno-ppa.tar.gz is OpenStack Juno version for Centos7. - -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). - -CENTOS7_JUNO_PPA is packages path for Centos, TRUSTY_JUNO_PPA is packages path for Ubuntu - -.. code-block:: bash - - CENTOS7_JUNO_PPA=/compass4nfv/work/repo/centos7-juno-ppa.tar.gz - - 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 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. - - Example: - -.. code-block:: bash - - #!/bin/bash - apt-get update - apt-get install -y build-essential fakeroot debhelper \ - autoconf automake bzip2 libssl-dev \ - openssl graphviz python-all procps \ - python-qt4 python-zopeinterface \ - python-twisted-conch libtool wget - - pushd . - cd /tmp - wget http://openvswitch.org/releases/openvswitch-2.3.1.tar.gz - tar -zxvf openvswitch-2.3.1.tar.gz - cd openvswitch-2.3.1 - DEB_BUILD_OPTIONS='parallel=8 nocheck' fakeroot debian/rules binary - cd - - 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 . - -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: - -.. code-block:: bash - - packages_noarch: - - {targeted packages1} - - {targeted packages2} - - {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. - -Add the packages' names as following in the "Debian.yml" and/or "RedHat.yml" : - -.. code-block:: bash - - packages: - - {targeted Ubuntu/RedHat packages1} - - {targeted Ubuntu/RedHat packages2} - - {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, -you can add a new section as the following:: - - - hosts: all/controller/compute/ha - remote_user: root - sudo: True - 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. - -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. - - Example: - -.. code-block:: bash - - - hosts: controller - remote_user: root - sudo: True - roles: - - database - - mq - - keystone - - nova-controller - - neutron-controller - - {newrole} - -Please pay attention to the first line "hosts" by which Compass4nfv deploys {newrole} on which baremetals/VMs. - -Also please pay attention to the position inserted as Compass4nfv deploys the packages in the order as list. - -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. - -centos7-juno-ppa.tar.gz is OpenStack Juno version for Centos7. - -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). - -CENTOS7_JUNO_PPA is packages path for Centos, TRUSTY_JUNO_PPA is packages path for Ubuntu - -.. code-block:: bash - - CENTOS7_JUNO_PPA=/compass4nfv/work/repo/centos7-juno-ppa.tar.gz - - 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. 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 deleted file mode 100644 index 986bd79a..00000000 --- a/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. - -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. - -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 deleted file mode 100644 index e91f110b..00000000 --- a/docs/FAQ/how-to-deploy-without-internet-access.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. - -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. - -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. - diff --git a/docs/FAQ/index.rst b/docs/FAQ/index.rst deleted file mode 100644 index d116e26b..00000000 --- a/docs/FAQ/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International Licence. -.. http://creativecommons.org/licenses/by/4.0 - -========================================================= -OPNFV(Colorado) Compass4nfv Frequently Asked Questions -========================================================= - -.. 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 - faq.rst |