User Tools

Site Tools


compass4nfv-plugin-integration-api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
compass4nfv-plugin-integration-api [2015/11/27 07:50]
shuai chen created
compass4nfv-plugin-integration-api [2015/12/03 00:50] (current)
shuai chen
Line 5: Line 5:
  
 =====How to Integrate 3rd party project into Compass4nfv===== =====How to Integrate 3rd party project into Compass4nfv=====
-1. Create a role: every component in Compass4nfv is a role, it's in the directory "​compass4nfv/​deploy/​adapters/​ansible/​roles",​ you can create a role named your project in this directory. ​(1.png)+Prerequisite:​ 
 +You need a server installed by Ubuntu14.04 with at least 100G storage and 16G Ram, and download Compass, execute  
 +git clone https://​gerrit.opnfv.org/​gerrit/​compass4nfv ​  , pay attention not in the "​root"​ folder. 
 + 
 + 
 +1. Create a role: every component in Compass4nfv is a role, it's in the directory "​compass4nfv/​deploy/​adapters/​ansible/​roles",​ you can create a role named your project in this directory. 
 +  
 +{{:​Compass4nfv Plug-in Integration API document ​1.png?500|}} 
  
-(2.png) 
 2. Create a "​files"​ folder in your role directory: store some files that need to be used during the installation and provision in the directory "​compass4nfv/​deploy/​adapters/​ansible/​roles/​{your component}/​files"​. 2. Create a "​files"​ folder in your role directory: store some files that need to be used during the installation and provision in the directory "​compass4nfv/​deploy/​adapters/​ansible/​roles/​{your component}/​files"​.
  
Line 17: Line 24:
  
 6. Create a "​vars"​ folder in your role directory: store some .yml scripts with variables that need to be used during installation and provision in the directory "​compass4nfv/​deploy/​adapters/​ansible/​roles/​{your component}/​vars"​ 6. Create a "​vars"​ folder in your role directory: store some .yml scripts with variables that need to be used during installation and provision in the directory "​compass4nfv/​deploy/​adapters/​ansible/​roles/​{your component}/​vars"​
 +
 +ODL role as an example
 +
 +{{:​Compass4nfv Plug-in Integration API document 2.png?​500|}}
  
  
Line 22: Line 33:
  
  
-7. Add the component role to the deploy scripts, in the "​compass4nfv/​deploy/​adapters/​ansible/​openstack"​ directory, there are "​single-controller.yml"​ and "​HA-ansible-multinodes.yml"​ available, "​single-controller.yml"​ is for one controller and 4 compute, "​HA-ansible-multinodes.yml"​ is for 3 controller in HA mode and 2 compute. ​(4.png)+7. Add the component role to the deploy scripts, in the "​compass4nfv/​deploy/​adapters/​ansible/​openstack"​ directory, ​ 
 + 
 +{{:​Compass4nfv Plug-in Integration API document 3.png?​500|}} 
 + 
 +there are "​single-controller.yml"​ and "​HA-ansible-multinodes.yml"​ available, "​single-controller.yml"​ is for one controller and 4 compute, "​HA-ansible-multinodes.yml"​ is for 3 controller in HA mode and 2 compute. ​ 
 + 
 +{{:​Compass4nfv Plug-in Integration API document ​4.png?300|}}
  
 item "​hosts"​ means which hosts will be deployed. item "​hosts"​ means which hosts will be deployed.
 item "​roles"​ include all the components will be deployed on the "​hosts"​ above. item "​roles"​ include all the components will be deployed on the "​hosts"​ above.
 you can insert your component role into the existing role list also could create a new block to include your component role like odl and onos.  you can insert your component role into the existing role list also could create a new block to include your component role like odl and onos. 
 +
 +{{:​Compass4nfv Plug-in Integration API document 5.png?​300|}}
 +
 +
compass4nfv-plugin-integration-api.1448610632.txt.gz · Last modified: 2015/11/27 07:50 by shuai chen