Alert.png The wiki is deprecated and due to be decommissioned by the end of September 2022.
The content is being migrated to other supports, new updates will be ignored and lost.
If needed you can get in touch with EGI SDIS team using operations @ egi.eu.

Difference between revisions of "Fedcloud-tf:WorkGroups:Scenario8:Configuration"

From EGIWiki
Jump to navigation Jump to search
(Redirected page to MAN10)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Register an image with the EGI.eu Marketplace  ==
#REDIRECT[[MAN10]]
 
(''Modified version of instructions compiled by Boris Parak. The original version can be found [http://meta.cesnet.cz/wiki/FedCloudDocumentation:How_to_upload_images_to_the_EGI.eu_Marketplace here]'')
 
=== Install and configure stratuslab-cli-tools  ===
 
This part is very straight-forward, we need ''stratuslab-cli-tools''. So
 
cd ~
mkdir stratuslab
cd stratuslab
wget http://repo.stratuslab.eu:8081/content/repositories/centos-6.2-releases/eu/stratuslab/pkgs/stratuslab-cli-user-pkg/2.2/stratuslab-cli-user-pkg-2.2.tar.gz
tar xvf stratuslab-cli-user-pkg-2.2.tar.gz
 
and then conclude the installation process by appending the following to ''~/.bashrc''
 
# STRATUSLAB-CLI-TOOLS
export PATH=$PATH:~/stratuslab/bin
export PYTHONPATH=$PYTHONPATH:~/stratuslab/lib/stratuslab/python
 
RPMs for the client are also available from the StratusLab yum repositories, see http://yum.stratuslab.eu/. Packages are provided for CentOS 6.2, OpenSuse 12.1 and Fedora 16.
 
=== Get demo images  ===
 
There are two images required for the demo. Each resource provider should upload a metadata entry for each. The first is the BNCweb image, which is available from https://appliance-repo.egi.eu/images/base/egi-bncweb/1.0/egi-bncweb.img. The second is a plain Debian 6 image (https://appliance-repo.egi.eu/images/base/Debian-6.0.5-x86_64-base/1.0/debian-6.0.5-x86_64-base.img).
 
=== Upload the image into your cloud  ===
 
==== appliance Repo  ====
 
Here are the steps for uploading an image to the appliance repo, which you can register to the EGI Marketplace as described below (ref?): The server uses the fedloud.egi.eu voms for authentication. You can register here (https://perun.metacentrum.cz/perun-registrar-cert/?vo=fedcloud.egi.eu). You will also need the hellasgrid-ca-chain.pem file so that curl can verify the server's certificate.
 
1. Create the directory where you want to place your image:
 
  curl --cacert ~/path/to/hellasgrid-ca-chain.pem --cert client.pem -X MKCOL https://appliance-repo.egi.eu/images/base/SL-5.7-x86_64-base
curl --cacert ~/path/to/hellasgrid-ca-chain.pem --cert client.pem -X MKCOL https://appliance-repo.egi.eu/images/base/SL-5.7-x86_64-base/1.0
 
2. upload the image:
 
  curl --cacert /path/to/hellasgrid-ca-chain.pem -T /path/to/image --cert client.pem https://appliance-repo.egi.eu/images/base/SL-5.5-x86_64-base/1.0/
 
NOTES:
 
Curl assumes that your cert.pem file contains your private key and certificate concatenated, if that not the case you will get a ""curl: (58) unable to set private key file: /file" error. A workaround is to create separate files for the private key and certificate. For example you can create the files using your pkcs12 certificate using openssl:
 
  openssl pkcs12 -in MULTICERT.p12 -out client.pem -clcerts -nokeys
openssl pkcs12 -in MULTICERT.p12 -out key.pem -nocerts
 
and issue the curl commands by:
 
  curl --cacert ~/path/to/hellasgrid-ca-chain.pem --key key.pem --cert client.pem
 
e.g.
 
  curl --cacert ~/path/to/hellasgrid-ca-chain.pem --key key.pem --cert client.pem -X MKCOL https://appliance-repo.egi.eu/images/base/SL-5.7-x86_64-base
 
You can generate the hellasgrid-ca-chain.pem file by:
 
#wget http://repository.egi.eu/sw/production/cas/1/current/repo-files/EGI-trustanchors.repo | mv EGI-trustanchors.repo /etc/yum.repos/
#yum install  yum install ca_HellasGrid-CA-2006 ca_HellasGrid-Root
#cat /etc/grid-security/certificates/HellasGrid-Root.pem /etc/grid-security/certificates/HellasGrid-CA-2006.pem > /path/to/new/hellasgrid-ca-chain.pem
 
==== Other  ====
 
This step is different for every cloud platform. For instance, in OpenNebula v3.4+ you can use Sunstone GUI to upload images directly, in previous versions you have to upload the image to the frontend and then register it.
 
Sice FedCloud-TF will be using OCCI to access the cloud, you must provide a location of the image that is OCCI-compatible. To find the right link you can browse through all the storage elements registered in your OCCI server
 
https://occi.host:port/storage/
 
checking the ''occi.core.title'' attribute for the right name. You should end up with something like
 
https://occi.host:port/storage/a39a1d08-bff8-5a62-ba68-a1cd76bb4511
 
=== Build the metadata  ===
 
The EGI.eu Marketplace stores only metadata which points to the image, provide basic information and integrity verification. Since RDF is not the most user-friendly format, we can use ''stratus-build-metadata'' to generate a template
 
stratus-build-metadata --author='##YOUR_NAME##' --type=base --os=Ubuntu --os-version=11.04 --os-arch=x86_64 \
--image-version=1.0 --hypervisor=xen --format=raw --comment='BNCWeb appliance for the OGF35 demo available at ##YOUR_SITE##' \
--compression=none --location='https://occi.host:port/storage/a39a1d08-bff8-5a62-ba68-a1cd76bb4511' egi-bncweb.img
 
'''Note:''' stratus-build-metadata needs the image to compute checksums, you can download it here [https://appliance-repo.egi.eu/images/base/egi-bncweb/1.0/egi-bncweb.img egi-bncweb.img]
 
=== Modify the metadata  ===
 
Now we can check/modify the metadata, the most important elements are ''dcterms:valid'' and ''dcterms:title''.
 
The correct format for ''dcterms:title'' is ''EGI-##IMAGE_NAME##-##SITE_NAME##''. This field will need to be manually added to the metadata file. You can also modify the validity date as required.
 
'''Metadata from the EGI.eu Marketplace cannot be removed, it can only expire.''' It is also possible to ''deprecate'' an entry. This might be necessary, if for example, a security issue is detected with the image, or if you simply wish to no longer endorse the image. Instructions for the stratus-deprecate-image command can be found [http://stratuslab.eu/doku.php/ref-doc:user-cli#stratus-deprecate-metadata here].
<pre>&lt;?xml version="1.0" encoding="UTF-8" standalone="no"?&gt;
&lt;rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:dcterms="http://purl.org/dc/terms/"
    xmlns:slterms="http://mp.stratuslab.eu/slterms#"
    xmlns:slreq="http://mp.stratuslab.eu/slreq#"
    xml:base="http://mp.stratuslab.eu/"&gt;
 
    &lt;rdf:Description rdf:about="#DtRwHZzoo1xFKtk-iL51t6RNQ9Q"&gt;
 
        &lt;dcterms:identifier&gt;DtRwHZzoo1xFKtk-iL51t6RNQ9Q&lt;/dcterms:identifier&gt;
 
        &lt;slreq:bytes&gt;14680064000&lt;/slreq:bytes&gt;
 
        &lt;slreq:checksum rdf:parseType="Resource"&gt;
            &lt;slreq:algorithm&gt;MD5&lt;/slreq:algorithm&gt;
            &lt;slreq:value&gt;144fff2477673aa1d883f0a3ba89f273&lt;/slreq:value&gt;
        &lt;/slreq:checksum&gt;
        &lt;slreq:checksum rdf:parseType="Resource"&gt;
            &lt;slreq:algorithm&gt;SHA-1&lt;/slreq:algorithm&gt;
            &lt;slreq:value&gt;3b51c07673a28d7114ab64fa22f9d6de91350f50&lt;/slreq:value&gt;
        &lt;/slreq:checksum&gt;
        &lt;slreq:checksum rdf:parseType="Resource"&gt;
            &lt;slreq:algorithm&gt;SHA-256&lt;/slreq:algorithm&gt;
            &lt;slreq:value&gt;8bde348c81e5a2aa5aa51b8d39a30ad137d0482decd5960cd95594d224a45bdd&lt;/slreq:value&gt;
        &lt;/slreq:checksum&gt;
        &lt;slreq:checksum rdf:parseType="Resource"&gt;
            &lt;slreq:algorithm&gt;SHA-512&lt;/slreq:algorithm&gt;
            &lt;slreq:value&gt;e780f2aa6922bc7cfdaae4a5e410f6b499bef5c83314bcd760b082b625860834c4942de9d096c7aa83cdad0411c47686f2e7d0fcc65f816475f6525db28b236d&lt;/slreq:value&gt;
        &lt;/slreq:checksum&gt;
 
        &lt;slreq:endorsement rdf:parseType="Resource"/&gt;
 
        &lt;dcterms:title&gt;EGI-BNCweb-##YOUR_SITE##&lt;/dcterms:title&gt;
        &lt;dcterms:type&gt;base&lt;/dcterms:type&gt;
        &lt;slterms:kind&gt;machine&lt;/slterms:kind&gt;
 
        &lt;slterms:os&gt;Ubuntu&lt;/slterms:os&gt;
        &lt;slterms:os-version&gt;11.04&lt;/slterms:os-version&gt;
        &lt;slterms:os-arch&gt;x86_64&lt;/slterms:os-arch&gt;
        &lt;slterms:version&gt;1.0&lt;/slterms:version&gt;
        &lt;dcterms:compression&gt;none&lt;/dcterms:compression&gt;
        &lt;slterms:location&gt;https://occi.host:port/storage/a39a1d08-bff8-5a62-ba68-a1cd76bb4511&lt;/slterms:location&gt;
 
        &lt;dcterms:format&gt;raw&lt;/dcterms:format&gt;
 
        &lt;dcterms:creator&gt;##YOUR_NAME##&lt;/dcterms:creator&gt;
 
        &lt;dcterms:created&gt;2012-06-12T12:36:25Z&lt;/dcterms:created&gt;
        &lt;dcterms:valid&gt;2012-06-14T12:36:25Z&lt;/dcterms:valid&gt;
 
        &lt;dcterms:description&gt;BNCWeb appliance for the OGF35 demo available at ##YOUR_SITE##&lt;/dcterms:description&gt;
 
        &lt;slterms:hypervisor&gt;xen&lt;/slterms:hypervisor&gt;
 
        &lt;dcterms:publisher&gt;##YOUR_SITE##&lt;/dcterms:publisher&gt;
       
    &lt;/rdf:Description&gt;
&lt;/rdf:RDF&gt;
</pre>
{{Template:Block-comment
| name=Notice
| text=These fields should be checked: ''&lt;dcterms:title&gt;EGI-BNCweb-##YOUR_SITE##&lt;/dcterms:title&gt;'' ''&lt;dcterms:creator&gt;##YOUR_NAME##&lt;/dcterms:creator&gt;'' ''&lt;dcterms:description&gt;BNCWeb appliance for the OGF35 demo available at ##YOUR_SITE##&lt;/dcterms:description&gt;'' and ''&lt;dcterms:publisher&gt;##YOUR_SITE##&lt;/dcterms:publisher&gt;''
}}
 
<br>
 
==== Modify Metadata (OCCI 1.1 servers)  ====
 
{{Template:Block-comment
| name=Warning
| text=These changes are required for TF2012 demo.
}}
 
&lt;slterms:location&gt;https://occi.host:port/storage/##STORAGE ID##&lt;/slterms:location&gt;
&lt;dcterms:requires&gt;https://occi.host:port/network/##NETWORK ID##&lt;/dcterms:requires&gt;
 
*'''Optional:'''
 
Set &lt;dcterms:valid&gt; field to be used until TF demo:
 
&lt;dcterms:valid&gt;2012-10-02T09:55:00Z&lt;/dcterms:valid&gt;
 
==== Modify Metadata (rOCCI or OCCI OpenStack servers)  ====
 
{{Template:Block-comment
| name=Warning
| text=These changes are required for TF2012 demo
}}
 
<br>
 
&lt;dcterms:requires&gt;https://rocci.host:port&lt;/dcterms:requires&gt;
 
*'''Optional:'''
 
Set &lt;dcterms:valid&gt; field to be used until TF demo:
 
&lt;dcterms:valid&gt;2012-10-02T09:55:00Z&lt;/dcterms:valid&gt;
 
<br>
 
=== Sign the metadata  ===
 
To establish the origin of the image, we have to sign the metadata with a personal certificate (ideally the one registered with EGI.eu). '''Before''' doing this you should familiarise yourself with the [https://documents.egi.eu/public/ShowDocument?docid=771 EGI Security Policy for the Endorsement and Operation of Virtual Machine Images].
 
stratus-sign-metadata --p12-cert=##FULL_PATH_TO_usercred.p12## egi-bncweb.xml
 
=== Register the metadata with the EGI.eu Marketplace  ===
 
And to complete the process, we have to upload the metadata to the EGI.eu Marketplace with ''stratus-upload-metadata''
 
stratus-upload-metadata --marketplace-endpoint=marketplace.egi.eu egi-bncweb.xml
 
or manually at
 
http://marketplace.egi.eu/upload
 
=== Howto update and change old metadata  ===
 
To update uploaded metadata just modify the metadata file, sign it again, and then upload. It is basically the same procedure as uploading new metadata. Only the most recent entry for a particular image identifier/email address is displayed.
 
== [https://github.com/hepix-virtualisation/vmcatcher VMcatcher] ==
 
VMcatcher allows users to subscribe to virtual machine Virtual Machine image lists, cache the images referenced to in the Virtual Machine Image List, validate the images list with x509 based public key cryptography, and validate the images against sha512 hashes in the images lists and provide events for further applications to process updates or expiries of virtual machine images without having to further validate the images.
 
=== Installation & Usage  ===
Please refer to vmcatcher documentation [https://github.com/hepix-virtualisation/vmcatcher here]
 
=== Event Handlers  ===
 
==== OpenNebula  ====
 
[https://github.com/grid-admin/vmcatcher_eventHndlExpl_ON vmcatcher_eventHndlExpl_ON] is a VMcatcher event handler for OpenNebula to store or disable images based on VMcatcher response. The easy way to install ''vmcatcher_eventHndlExpl_ON'' is including yokel repository. As example for SL6:
 
# cat /etc/yum.repos.d/yokel_sl6_production.repo   
                                                                                                                                 
[yokel_sl6_production]                                                                                                                                                                                       
name=yokel_sl6_production                                                                                                                                                                                     
baseurl=http://www.yokel.org/pub/software/local/production/rpm/scientific/6/x86_64/                                                                                                                           
enabled=1                                                                                                                                                                                                     
gpgcheck=0                                                                                                                                                                                                   
 
*And then install vmcatcher_eventHndlExpl_ON package:
 
# yum install vmcatcher_eventHndlExpl_ON
*The new package includes a cron script available from /usr/share/doc/vmcatcher-(version)/examples/vmcatcher-cron.cfg:
 
export VMCATCHER_RDBMS="sqlite:////var/lib/one/vmcatcher.db"
export VMCATCHER_CACHE_DIR_CACHE="/var/lib/one/cache"
export VMCATCHER_CACHE_DIR_DOWNLOAD="/var/lib/one/cache/partial"
export VMCATCHER_CACHE_DIR_EXPIRE="/var/lib/one/cache/expired"
export VMCATCHER_CACHE_EVENT="python /usr/bin/vmcatcher_eventHndlExpl_ON"
#50 */6 * * *    oneadmin  (/usr/bin/vmcatcher_subscribe -U; /usr/bin/vmcatcher_cache  ) >> /var/log/vmcatcher.log 2>&1
 
*Use this cron script as template to execute vmcatcher regularly. (uncomment line 6 and put vmcatcher-cron.cfg into /etc/cron.d directory)
 
''NOTES:''
 
*vmcatcher_cache must be executed as oneadmin user.
*Environment variables can be used to set default values but the command line options will override any set environment options. Set these env variables for oneadmin user: VMCATCHER_RDBMS, VMCATCHER_CACHE_DIR_CACHE, VMCATCHER_CACHE_DIR_DOWNLOAD, VMCATCHER_CACHE_DIR_EXPIRE and VMCATCHER_CACHE_EVENT.
*vmcatcher_eventHndlExpl_ON generates ON image templates. These templates are available from $VMCATCHER_CACHE_DIR_CACHE/templates (templates nomenclature $VMCATCHER_EVENT_DC_IDENTIFIER.one)
*The new ON images include ''VMCATCHER_EVENT_DC_IDENTIFIER = &lt;VMCATCHER_UUID&gt;'' tag. This tag is used to identify Fedcloud VM images.
*VMcatcher expired images are set as disabled by ON. It is up to the RP to remove disabled images or assign the new ones to a specific ON group or user.
 
==== OpenStack  ====
 
vmcatcher may be branched to Openstack Glance catalog using [https://github.com/EGI-FCTF/glancepush glancepush] tool. Basically:
 
#glancepush-vmcatcher uses vmcatcher's event handler to signal glancepush that a new image was updated in vmcatcher's cache
#glancepush uploads the new image to glance in a quarantined zone (only the configured tenant will have access to the image)
#glancepush instanciates a VM with the new image
#glancepush pass policy compliance tests inside the VM (no hardcoded secrets, packages up to date...)
#if the tests pass, the image will be released publicly in the catalog or stalled otherwise.
 
Please read the full documentation [https://github.com/EGI-FCTF/glancepush/wiki here]. The binaries for glancepush and glancepush-vmcatcher are located [ftp://ftp.in2p3.fr/ccin2p3/egi-acct-osdriver/ IN2P3-CC ftp repository]
 
=== Links  ===
 
[https://github.com/hepix-virtualisation/vmcatcher VMcatcher]
 
[http://grid.desy.de/vm/hepix/vwg/doc/html/index.shtml HEPIX Virtualisation Working Group]
 
[http://grid.desy.de/vm/hepix/vwg/doc/html/imagetransfer/imagetransfer.shtml Part&nbsp;IV.&nbsp;Virtual Machine Image Transfer]
 
[https://github.com/robertord/Fedcloud/blob/master/vmcatcher_eventHndlExpl_ON github OpenNebula VMcatcher event handler]

Latest revision as of 15:18, 11 May 2015

Redirect to: