Difference between revisions of "HOWTO15 How to configure the Federated Cloud BDII"
Line 1: | Line 1: | ||
{{Template:Op menubar}} {{Template:Doc_menubar}} {{TOC_right}} | |||
= Purpose = | [[Category:Operations_Manuals]] | ||
= Purpose = | |||
This page provides instructions on how to configure the Federated Cloud Production resource-BDII. | This page provides instructions on how to configure the Federated Cloud Production resource-BDII. | ||
= Installation = | = Installation = | ||
Packages for the cloud-info-provider are available at [https://appdb.egi.eu/store/software/cloud.info.provider EGI's AppDB]. | Packages for the cloud-info-provider are available at [https://appdb.egi.eu/store/software/cloud.info.provider EGI's AppDB]. You will need to install also the following packages: | ||
You will need to install also the following packages: | |||
== RHEL/CentOS/ScientificLinux == | *bdii (available in EPEL repo) | ||
*python-novaclient (only if using OpenStack provider) | |||
== RHEL/CentOS/ScientificLinux == | |||
*Add EPEL repository according to the instructions at https://fedoraproject.org/wiki/EPEL | |||
*Add the cloud-info-provider repository to yum: | |||
wget http://repository.egi.eu/community/software/cloud.info.provider/0.x/releases/repofiles/sl-6-x86_64.repo \ | wget http://repository.egi.eu/community/software/cloud.info.provider/0.x/releases/repofiles/sl-6-x86_64.repo \ | ||
-O /etc/yum.repos.d/cloud-info-provider.repo | |||
* Install the package | |||
*Install the package | |||
yum install cloud-info-provider-service | yum install cloud-info-provider-service | ||
== For Debian/Ubuntu 6/7/8 == | == For Debian/Ubuntu 6/7/8 == | ||
*Add AppDB's repository: | |||
sudo wget http://repository.egi.eu/community/software/cloud.info.provider/0.x/releases/repofiles/ubuntu-precise-amd64.list \ | sudo wget http://repository.egi.eu/community/software/cloud.info.provider/0.x/releases/repofiles/ubuntu-precise-amd64.list \ | ||
-O /etc/apt/sources.list.d/cloud-info-provider.list | |||
* Add AppDB key: | |||
*Add AppDB key: | |||
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E2E992EB352D3E14 | sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E2E992EB352D3E14 | ||
* Install the package | |||
*Install the package | |||
sudo apt-get update | sudo apt-get update | ||
sudo apt-get install python-cloud-info-provider | sudo apt-get install python-cloud-info-provider | ||
= Configuration = | = Configuration = | ||
Use one of the template files in <code>/etc/cloud-info-provider</code> as basis for creating your own YAML file with the static information of your resources. E.g: | |||
cp /etc/cloud-info-provider/sample.openstack.yaml /etc/cloud-info-provider/bdii.yaml | cp /etc/cloud-info-provider/sample.openstack.yaml /etc/cloud-info-provider/bdii.yaml | ||
Each middleware has its own options to fetch the dynamic information, check the <code>--help</code> option for more information. Some additional notes are given in the following sections. | Each middleware has its own options to fetch the dynamic information, check the <code>--help</code> option for more information. Some additional notes are given in the following sections. | ||
== General == | |||
*Site name will be fetched from <code>site</code> -> <code>name</code> in the template file. Set it to the name defined in GOCDB. Alternatively, the site name can be fetched from /etc/glite-info-static/site/site.cfg (or by the file set with the --glite-site-info-static option) | |||
* Site name will be fetched from <code>site</code> - | |||
== OpenNebula + rOCCI == | == OpenNebula + rOCCI == | ||
* | *Use the <code>--middleware opennebularocci</code> option to activate this provider | ||
* | *You need to specify connection parameters to the OpenNebula XML-RPC interface: | ||
**<code>--on-auth</code> parameter should contain the authorization parameters for an existing user with full read permissions on the image disks. If the user has been created with the <code>core</code> driver, this parameter shall be set to <code><username>:<password></code>. | |||
**<code>--on-rpcxml-endpoint</code> shall contain the address of the RPCv2 endpoint. Usually it is <code><nowiki>http://<hostname>:2633/RPC2</nowiki></code>. If not on a secure network, it is suggested to provide this interface via https, since the <code>on-auth</code> parameter will be sent in clear text to the server. | |||
* | *Compute templates can be gathered in two ways: directly from rOCCI configuration, by setting up the <code>--rocci-template-dir</code> option pointing to the rOCCI configuration folder or manually by placing them in the configuration file. One option does not preclude the other and the resulting templates will be the merge of the two. | ||
*OS templates can be filtered so only vmcatcher ones are published with the <code>--vmcatcher-images</code> option. | |||
== OpenStack == | |||
* Use the <code>--middleware openstack</code> option to activate this provider | *Use the <code>--middleware openstack</code> option to activate this provider | ||
* The OpenStack provider uses python-novaclient (needs to be installed separately) | *The OpenStack provider uses python-novaclient (needs to be installed separately) | ||
** <code>--os-username</code>, <code>--os-password</code>, <code>--auth-tenant-name</code>, <code>--os-auth-url</code>, <code>--os-cacert</code>, <code>--insecure</code> options to the cloud-provider allow to set the connection parameters. Alternatively you can use environment variables (e.g. <code>OS_USERNAME</code>) as with other OpenStack clients | **<code>--os-username</code>, <code>--os-password</code>, <code>--auth-tenant-name</code>, <code>--os-auth-url</code>, <code>--os-cacert</code>, <code>--insecure</code> options to the cloud-provider allow to set the connection parameters. Alternatively you can use environment variables (e.g. <code>OS_USERNAME</code>) as with other OpenStack clients | ||
** <code>--insecure</code> should not be used in production! | **<code>--insecure</code> should not be used in production! | ||
* Be sure that keystone contains the OCCI endpoint, otherwise it will not be published by the BDII. You can check this via the command <code>keystone service-list</code>. To create a new service and endpoint, you can run | *Be sure that keystone contains the OCCI endpoint, otherwise it will not be published by the BDII. You can check this via the command <code>keystone service-list</code>. To create a new service and endpoint, you can run | ||
<pre> | <pre>keystone service-create --name occi_api --type occi --description 'Nova OCCI Service' | ||
keystone service-create --name occi_api --type occi --description 'Nova OCCI Service' | |||
keystone endpoint-create --service_id | keystone endpoint-create --service_id <service-id> --region RegionOne --publicurl http://$HOSTNAME:8787/ \ | ||
--internalurl http://$HOSTNAME:8787/ --adminurl http://$HOSTNAME:8787/ | --internalurl http://$HOSTNAME:8787/ --adminurl http://$HOSTNAME:8787/ | ||
</pre> | </pre> | ||
where the ''service-id'' is the one obtained from <code>keystone service-list</code>. | where the ''service-id'' is the one obtained from <code>keystone service-list</code>. | ||
* By default, the provider script will filter images without marketplace uri defined into the marketplace or vmcatcher_event_ad_mpuri property. If you want to list all the images templates (included local snapshots), set the variable 'require_marketplace_id: false' under 'compute' - | *By default, the provider script will filter images without marketplace uri defined into the marketplace or vmcatcher_event_ad_mpuri property. If you want to list all the images templates (included local snapshots), set the variable 'require_marketplace_id: false' under 'compute' -> 'images' -> 'defaults' in the YAML configuration file. | ||
== Create the provider == | == Create the provider == | ||
* Create the file <code>/var/lib/bdii/gip/provider/cloud-info-provider</code> that calls the provider with the correct options for your site, for example: | *Create the file <code>/var/lib/bdii/gip/provider/cloud-info-provider</code> that calls the provider with the correct options for your site, for example: | ||
<pre> | <pre>#!/bin/sh | ||
#!/bin/sh | |||
cloud-info-provider-service --yaml /etc/cloud-info-provider/openstack.yaml \ | cloud-info-provider-service --yaml /etc/cloud-info-provider/openstack.yaml \ | ||
--middleware openstack \ | --middleware openstack \ | ||
--os-username | --os-username <username> --os-password <passwd> \ | ||
--os-tenant-name | --os-tenant-name <tenant> --os-auth-url <url> | ||
</pre> | </pre> | ||
* Give execution permission: | *Give execution permission: | ||
chmod +x /var/lib/bdii/gip/provider/cloud-info-provider | chmod +x /var/lib/bdii/gip/provider/cloud-info-provider | ||
* and test it: | |||
*and test it: | |||
/var/lib/bdii/gip/provider/cloud-info-provider | /var/lib/bdii/gip/provider/cloud-info-provider | ||
* That should return the complete LDIF describing your site. Now you can start the bdii service | |||
*That should return the complete LDIF describing your site. Now you can start the bdii service | |||
service bdii start | service bdii start | ||
* And check that the information is being published | |||
*And check that the information is being published | |||
ldapsearch -x -h localhost -p 2170 -b o=glue | ldapsearch -x -h localhost -p 2170 -b o=glue | ||
== Add your resource BDII to the site-BDII == | == Add your resource BDII to the site-BDII == | ||
Add your cloud-info-provider to your site-BDII by adding a new URL like this: | Add your cloud-info-provider to your site-BDII by adding a new URL like this: | ||
ldap:// | ldap://<cloud-info-provier-hostname>:2170/GLUE2GroupID=cloud,o=glue | ||
Check how to set up your Site-BDII at [[MAN01 How to publish Site Information]] for information on how to add the URL. | Check how to set up your Site-BDII at [[MAN01 How to publish Site Information]] for information on how to add the URL. | ||
== Alternative: use your cloud-provider as site-BDII == | == Alternative: use your cloud-provider as site-BDII == | ||
{{Template:Block-comment | {{Template:Block-comment | ||
Line 114: | Line 129: | ||
}} | }} | ||
If you don't have an existing site-BDII and you want to generate both the resource information and the site information with the cloud-bdii-provider you can add in the /var/lib/bdii/gip/provider/cloud-info-provider the <code>--full-bdii-info</code> option to the cloud-info-provider-service. The YAML file must contain all your site information as described in the templates. | If you don't have an existing site-BDII and you want to generate both the resource information and the site information with the cloud-bdii-provider you can add in the /var/lib/bdii/gip/provider/cloud-info-provider the <code>--full-bdii-info</code> option to the cloud-info-provider-service. The YAML file must contain all your site information as described in the templates. | ||
[[Category:Technology]] [[Category:Fedcloud-tf]] |
Revision as of 14:31, 11 May 2015
Main | EGI.eu operations services | Support | Documentation | Tools | Activities | Performance | Technology | Catch-all Services | Resource Allocation | Security |
Documentation menu: | Home • | Manuals • | Procedures • | Training • | Other • | Contact ► | For: | VO managers • | Administrators |
Purpose
This page provides instructions on how to configure the Federated Cloud Production resource-BDII.
Installation
Packages for the cloud-info-provider are available at EGI's AppDB. You will need to install also the following packages:
- bdii (available in EPEL repo)
- python-novaclient (only if using OpenStack provider)
RHEL/CentOS/ScientificLinux
- Add EPEL repository according to the instructions at https://fedoraproject.org/wiki/EPEL
- Add the cloud-info-provider repository to yum:
wget http://repository.egi.eu/community/software/cloud.info.provider/0.x/releases/repofiles/sl-6-x86_64.repo \ -O /etc/yum.repos.d/cloud-info-provider.repo
- Install the package
yum install cloud-info-provider-service
For Debian/Ubuntu 6/7/8
- Add AppDB's repository:
sudo wget http://repository.egi.eu/community/software/cloud.info.provider/0.x/releases/repofiles/ubuntu-precise-amd64.list \ -O /etc/apt/sources.list.d/cloud-info-provider.list
- Add AppDB key:
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys E2E992EB352D3E14
- Install the package
sudo apt-get update sudo apt-get install python-cloud-info-provider
Configuration
Use one of the template files in /etc/cloud-info-provider
as basis for creating your own YAML file with the static information of your resources. E.g:
cp /etc/cloud-info-provider/sample.openstack.yaml /etc/cloud-info-provider/bdii.yaml
Each middleware has its own options to fetch the dynamic information, check the --help
option for more information. Some additional notes are given in the following sections.
General
- Site name will be fetched from
site
->name
in the template file. Set it to the name defined in GOCDB. Alternatively, the site name can be fetched from /etc/glite-info-static/site/site.cfg (or by the file set with the --glite-site-info-static option)
OpenNebula + rOCCI
- Use the
--middleware opennebularocci
option to activate this provider
- You need to specify connection parameters to the OpenNebula XML-RPC interface:
--on-auth
parameter should contain the authorization parameters for an existing user with full read permissions on the image disks. If the user has been created with thecore
driver, this parameter shall be set to<username>:<password>
.--on-rpcxml-endpoint
shall contain the address of the RPCv2 endpoint. Usually it ishttp://<hostname>:2633/RPC2
. If not on a secure network, it is suggested to provide this interface via https, since theon-auth
parameter will be sent in clear text to the server.
- Compute templates can be gathered in two ways: directly from rOCCI configuration, by setting up the
--rocci-template-dir
option pointing to the rOCCI configuration folder or manually by placing them in the configuration file. One option does not preclude the other and the resulting templates will be the merge of the two.
- OS templates can be filtered so only vmcatcher ones are published with the
--vmcatcher-images
option.
OpenStack
- Use the
--middleware openstack
option to activate this provider
- The OpenStack provider uses python-novaclient (needs to be installed separately)
--os-username
,--os-password
,--auth-tenant-name
,--os-auth-url
,--os-cacert
,--insecure
options to the cloud-provider allow to set the connection parameters. Alternatively you can use environment variables (e.g.OS_USERNAME
) as with other OpenStack clients--insecure
should not be used in production!
- Be sure that keystone contains the OCCI endpoint, otherwise it will not be published by the BDII. You can check this via the command
keystone service-list
. To create a new service and endpoint, you can run
keystone service-create --name occi_api --type occi --description 'Nova OCCI Service' keystone endpoint-create --service_id <service-id> --region RegionOne --publicurl http://$HOSTNAME:8787/ \ --internalurl http://$HOSTNAME:8787/ --adminurl http://$HOSTNAME:8787/
where the service-id is the one obtained from keystone service-list
.
- By default, the provider script will filter images without marketplace uri defined into the marketplace or vmcatcher_event_ad_mpuri property. If you want to list all the images templates (included local snapshots), set the variable 'require_marketplace_id: false' under 'compute' -> 'images' -> 'defaults' in the YAML configuration file.
Create the provider
- Create the file
/var/lib/bdii/gip/provider/cloud-info-provider
that calls the provider with the correct options for your site, for example:
#!/bin/sh cloud-info-provider-service --yaml /etc/cloud-info-provider/openstack.yaml \ --middleware openstack \ --os-username <username> --os-password <passwd> \ --os-tenant-name <tenant> --os-auth-url <url>
- Give execution permission:
chmod +x /var/lib/bdii/gip/provider/cloud-info-provider
- and test it:
/var/lib/bdii/gip/provider/cloud-info-provider
- That should return the complete LDIF describing your site. Now you can start the bdii service
service bdii start
- And check that the information is being published
ldapsearch -x -h localhost -p 2170 -b o=glue
Add your resource BDII to the site-BDII
Add your cloud-info-provider to your site-BDII by adding a new URL like this:
ldap://<cloud-info-provier-hostname>:2170/GLUE2GroupID=cloud,o=glue
Check how to set up your Site-BDII at MAN01 How to publish Site Information for information on how to add the URL.
Alternative: use your cloud-provider as site-BDII
Warning:
This configuration fails to publish GlueSchema 1.3 information! Your site will fail NAGIOS tests!
Warning:
Don't use this!
If you don't have an existing site-BDII and you want to generate both the resource information and the site information with the cloud-bdii-provider you can add in the /var/lib/bdii/gip/provider/cloud-info-provider the --full-bdii-info
option to the cloud-info-provider-service. The YAML file must contain all your site information as described in the templates.