IM Service Installation

Prerequisites

IM needs at least Python 2.7 (Python 3.6 or higher recommended) to run, as well as the next libraries:

  • The RADL parser. (Since IM version 1.5.3, it requires RADL version 1.1.0 or later).
  • The TOSCA parser. A TOSCA YAML Spec 1.0 Parser.
  • paramiko, ssh2 protocol library for python (version 1.14 or later).
  • PyYAML, a YAML parser.
  • suds, a full-featured SOAP library.
  • Netaddr, A Python library for representing and manipulating network addresses.
  • Requests, A Python library for access REST APIs.

Also, IM uses Ansible (2.4 or later) to configure the infrastructure nodes.

These components are usually available from the distribution repositories.

Finally, check the next values in the Ansible configuration file ansible.cfg, (usually found in /etc/ansible):

[defaults]
transport  = smart
host_key_checking = False
nocolor = 1
become_user      = root
become_method    = sudo

[paramiko_connection]

record_host_keys=False

[ssh_connection]

# Only in systems with OpenSSH support to ControlPersist
ssh_args = -o ControlMaster=auto -o ControlPersist=900s
# In systems with older versions of OpenSSH (RHEL 6, CentOS 6, SLES 10 or SLES 11)
#ssh_args =
pipelining = True

Optional Packages

  • The Bottle framework is used for the REST API. It is typically available as the ‘python-bottle’ package.
  • The CherryPy Web framework, is needed for the REST API. It is typically available as the ‘python-cherrypy’ or ‘python-cherrypy3’ package. In newer versions (9.0 and later) the functionality has been moved the cheroot library it can be installed using pip.
  • apache-libcloud 3.0 or later is used in the LibCloud, OpenStack, EGI and GCE connectors.
  • boto 2.29.0 or later is used as interface to Amazon EC2. It is available as package named python-boto in Debian based distributions. It can also be downloaded from boto GitHub repository. Download the file and copy the boto subdirectory into the IM install path.
  • pyOpenSSL is needed to secure the REST API with SSL certificates (see REST_SSL). pyOpenSSL can be installed using pip.
  • The Python interface to MySQL, is needed to access MySQL server as IM data backend. It is typically available as the package ‘python-mysqldb’ or ‘MySQL-python’ package. In case of using Python 3 use the PyMySQL package, available as the package ‘python3-pymysql’ on debian systems or PyMySQL package in pip.
  • The Python interface to MongoDB, is needed to access MongoDB server as IM data backend. It is typically available as the package ‘python-pymongo’ package in most distributions or pymongo package in pip.
  • The Azure Python SDK, is needed by the Azure connector. It is available as the package ‘azure’ at the pip repository.
  • The VMware vSphere API Python Bindings are needed by the vSphere connector. It is available as the package ‘pyvmomi’ at the pip repository.

Installation

From Pip

First you need to install pip tool and some packages needed to compile some of the IM requirements. To install them in Debian and Ubuntu based distributions, do:

$ apt update
$ apt install gcc python3-dev libffi-dev libssl-dev python3-pip sshpass python-pysqlite2 python-requests

In Red Hat based distributions (RHEL, CentOS, Amazon Linux, Oracle Linux, Fedora, etc.), do:

$ yum install epel-release
$ yum install which gcc python3-devel libffi-devel openssl-devel python3-pip sshpass default-libmysqlclient-dev

Then you only have to call the install command of the pip tool with the IM package:

$ pip install IM

You can also install an specific branch of the Github repository:

$ pip install git+https://github.com/grycap/im.git@master

Pip will also install the, non installed, pre-requisites needed. So Ansible 2.4 or later will be installed in the system. Some of the optional packages are also installed please check if some of IM features that you need requires to install some of the packages of section “Optional Packages”.

You must also remember to modify the ansible.cfg file setting as specified in the “Prerequisites” section.

Configuration

If you want the IM Service to be started at boot time, do

  1. Update the value of the variable IMDAEMON in /etc/init.d/im file to the path where the IM im_service.py file is installed (e.g. /usr/local/im/im_service.py), or set the name of the script file (im_service.py) if the file is in the PATH (pip puts the im_service.py file in the PATH as default):

    $ sudo sed -i 's/`IMDAEMON=.*/`IMDAEMON=/usr/local/IM-0.1/im_service.py'/etc/init.d/im

  2. Register the service.

To do the last step on a Debian based distributions, execute:

$ sudo sysv-rc-conf im on

if the package ‘sysv-rc-conf’ is not available in your distribution, execute:

$ sudo update-rc.d im start 99 2 3 4 5 . stop 05 0 1 6 .

For Red Hat based distributions:

$ sudo chkconfig im on

Alternatively, it can be done manually:

$ ln -s /etc/init.d/im /etc/rc2.d/S99im
$ ln -s /etc/init.d/im /etc/rc3.d/S99im
$ ln -s /etc/init.d/im /etc/rc5.d/S99im
$ ln -s /etc/init.d/im /etc/rc1.d/K05im
$ ln -s /etc/init.d/im /etc/rc6.d/K05im

IM reads the configuration from $IM_PATH/etc/im.cfg, and if it is not available, does from /etc/im/im.cfg. There is a template of im.cfg at the directory etc on the tarball. The IM reads the values of the im section. The options are explained next.

Basic Options

DATA_FILE

Full path to the data file. (Removed in version IM version 1.5.0. Use only DATA_DB.) The default value is /etc/im/inf.dat.

DATA_DB

The URL to access the database to store the IM data. It can be a MySQL DB: ‘mysql://username:password@server/db_name’, SQLite: ‘sqlite:///etc/im/inf.dat’ or MongoDB: ‘mongodb://username:password@server/db_name’, The default value is sqlite:///etc/im/inf.dat.

USER_DB

Full path to the IM user DB json file. To restrict the users that can access the IM service. Comment it or set a blank value to disable user check. The default value is empty. JSON format of the file:

{
        "users": [
                {
                        "username": "user1",
                        "password": "pass1"
                },
                {
                        "username": "user2",
                        "password": "pass2"
                }
        ]
}
MAX_SIMULTANEOUS_LAUNCHES

Maximum number of simultaneous VM launch operations. In some versions of python (prior to 2.7.5 or 3.3.2) it can raise an error (‘Thread’ object has no attribute ‘_children’). See https://bugs.python.org/issue10015. In this case set this value to 1

The default value is 1.

MAX_VM_FAILS

Number of attempts to launch a virtual machine before considering it an error. The default value is 3.

VM_INFO_UPDATE_FREQUENCY

Maximum frequency to update the VM info (in secs) The default value is 10.

VM_INFO_UPDATE_ERROR_GRACE_PERIOD

Maximum time that a VM status maintains the current status in case of connection failure with the Cloud provider (in secs). If the time is over this value the status is set to ‘unknown’. This value must be always higher than VM_INFO_UPDATE_FREQUENCY. The default value is 120.

WAIT_RUNNING_VM_TIMEOUT

Timeout in seconds to get a virtual machine in running state. The default value is 1800.

WAIT_SSH_ACCCESS_TIMEOUT

(New in version IM version 1.5.1.) Timeout in seconds to wait a virtual machine to get the SSH access active once it is in running state. The default value is 300.

LOG_FILE

Full path to the log file. The default value is /var/log/im/inf.log.

LOG_FILE_MAX_SIZE

Maximum size in KiB of the log file before being rotated. The default value is 10485760.

BOOT_MODE

This flag set the IM boot mode. It can be: 0 (Normal) standard IM operation, 1 (ReadOnly) only read operations are allowed, 2 (ReadDelete) only read and delete operations are allowed. The default value is 0.

Default Virtual Machine Options

DEFAULT_VM_MEMORY

Default principal memory assigned to a virtual machine. The default value is 512.

DEFAULT_VM_MEMORY_UNIT

Unit used in DEFAULT_VM_MEMORY. Allowed values: K (KiB), M (MiB) and G (GiB). The default value is M.

DEFAULT_VM_CPUS

Default number of CPUs assigned to a virtual machine. The default value is 1.

DEFAULT_VM_CPU_ARCH

Default CPU architecture assigned to a virtual machine. Allowed values: i386 and x86_64. The default value is x86_64.

DEFAULT_VM_NAME

Default name of virtual machines. The default value is vnode-#N#.

DEFAULT_DOMAIN

Default domain assigned to a virtual machine. The default value is localdomain.

VERIFI_SSL

Verify SSL hosts in CloudConnectors connections If you set it to True you must assure the CA certificates are installed correctly The default value is False.

Contextualization

CONTEXTUALIZATION_DIR

Full path to the IM contextualization files. The default value is /usr/share/im/contextualization.

RECIPES_DIR

Full path to the Ansible recipes directory. The default value is CONTEXTUALIZATION_DIR/AnsibleRecipes.

RECIPES_DB_FILE

Full path to the Ansible recipes database file. The default value is CONTEXTUALIZATION_DIR/recipes_ansible.db.

MAX_CONTEXTUALIZATION_TIME

Maximum time in seconds spent on contextualize a virtual machine before throwing an error. The default value is 7200.

REMOTE_CONF_DIR

Directory to copy all the ansible related files used in the contextualization. The default value is /tmp/.im.

PLAYBOOK_RETRIES

Number of retries of the Ansible playbooks in case of failure. The default value is 1.

CHECK_CTXT_PROCESS_INTERVAL

Interval to update the state of the contextualization process in the VMs (in secs). Reducing this time the load of the IM service will decrease in contextualization steps, but may introduce some overhead time. The default value is 5.

CONFMAMAGER_CHECK_STATE_INTERVAL

Interval to update the state of the processes of the ConfManager (in secs). Reducing this time the load of the IM service will decrease in contextualization steps, but may introduce some overhead time. The default value is 5.

UPDATE_CTXT_LOG_INTERVAL

Interval to update the log output of the contextualization process in the VMs (in secs). The default value is 20.

VM_NUM_USE_CTXT_DIST

Number of VMs in an infrastructure that will use the distributed version of the Ctxt Agent The default value is 30.

XML-RPC API

XMLRCP_PORT

Port number where IM XML-RPC API is available. The default value is 8899.

XMLRCP_ADDRESS

IP address where IM XML-RPC API is available. The default value is 0.0.0.0 (all the IPs).

XMLRCP_SSL

If True the XML-RPC API is secured with SSL certificates. The default value is False.

XMLRCP_SSL_KEYFILE

Full path to the private key associated to the SSL certificate to access the XML-RPC API. The default value is /etc/im/pki/server-key.pem.

XMLRCP_SSL_CERTFILE

Full path to the public key associated to the SSL certificate to access the XML-RPC API. The default value is /etc/im/pki/server-cert.pem.

XMLRCP_SSL_CA_CERTS

Full path to the SSL Certification Authorities (CA) certificate. The default value is /etc/im/pki/ca-chain.pem.

VMINFO_JSON

Return the VM information of function GetVMInfo in RADL JSON instead of plain RADL (Added in IM version 1.5.2) The default value is False.

REST API

ACTIVATE_REST

If True the REST API is activated. The default value is False.

REST_PORT

Port number where REST API is available. The default value is 8800.

REST_ADDRESS

IP address where REST API is available. The default value is 0.0.0.0 (all the IPs).

REST_SSL

If True the REST API is secured with SSL certificates. The default value is False.

REST_SSL_KEYFILE

Full path to the private key associated to the SSL certificate to access the REST API. The default value is /etc/im/pki/server-key.pem.

REST_SSL_CERTFILE

Full path to the public key associated to the SSL certificate to access the REST API. The default value is /etc/im/pki/server-cert.pem.

REST_SSL_CA_CERTS

Full path to the SSL Certification Authorities (CA) certificate. The default value is /etc/im/pki/ca-chain.pem.

OPENID CONNECT OPTIONS

OIDC_ISSUERS

List of OIDC issuers supported. It must be a coma separated string of OIDC issuers URLs. The default value is ''.

OIDC_AUDIENCE

If set the IM will check that the string defined here appear in the “aud” claim of the OpenID access token The default value is ''.

OIDC_CLIENT_ID

OIDC client ID of the IM service. Only needed in case of setting OIDC_SCOPES. The default value is ''.

OIDC_CLIENT_SECRET

OIDC secret of the IM service. Only needed in case of setting OIDC_SCOPES. The default value is ''.

OIDC_SCOPES

List of scopes that must appear in the token request to access the IM service. Client ID and Secret must be provided to make it work. The default value is ''.

FORCE_OIDC_AUTH

If True the IM will force the users to pass a valid OIDC token. The default value is False.

NETWORK OPTIONS

PRIVATE_NET_MASKS

List of networks assumed as private. The IM use it to distinguish private from public networks. IM considers IPs not in these subnets as Public IPs. It must be a coma separated string of the network definitions (using CIDR) (without spaces). The default value is '10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,192.0.0.0/24,169.254.0.0/16,100.64.0.0/10,198.18.0.0/15'.

HA MODE OPTIONS

INF_CACHE_TIME

Time (in seconds) the IM service will maintain the information of an infrastructure in memory. Only used in case of IM in HA mode. This value has to be set to a similar value set in the expire value in the stick-table in the HAProxy configuration.

OpenNebula connector Options

The configuration values under the OpenNebula section:

TEMPLATE_CONTEXT

Text to add to the CONTEXT section of the ONE template (except SSH_PUBLIC_KEY) The default value is ''.

TEMPLATE_OTHER

Text to add to the ONE Template different to NAME, CPU, VCPU, MEMORY, OS, DISK and CONTEXT The default value is GRAPHICS = [type="vnc",listen="0.0.0.0"].

Logging Configuration

IM uses Python logging library (see the documentation). You have two options to configure it: use the configuration variables at the IM configuration file or use the file /etc/im/logging.conf.

The configuration variables are the following:

LOG_LEVEL

Set the level of the log messages: DEBUG, INFO, WARNING, ERROR, CRITICAL The default value is 'INFO'.

LOG_FILE

Set the destination file of the log messages. The default value is '/var/log/im/im.log'.

LOG_FILE_MAX_SIZE

Set the maximum file size of the log file. It will be rotated when size exceed this size, with a default depth of 3 files. The default value is '10485760'.

If you need to specify more advanced details of the logging configuration you have to use the file /etc/im/logging.conf. For example to set a syslogd server as the destination of the log messages:

[handler_fileHandler]
class=logging.handlers.SysLogHandler
level=INFO
formatter=simpleFormatter
args=(('<syslog_ip>', 514),)
[formatter_simpleFormatter]
format=%(asctime)s - %(hostname)s - %(name)s - %(levelname)s - %(message)s
datefmt=

Vault Configuration

From version 1.10.7 the IM service supports reading authorization data from a Vault server. These values are used by the REST API enabling to use Bearer authentication header and get the all the credential values from the configured Vault server.

VAULT_URL

URL to the Vault server API. The default value is ''.

VAULT_PATH

Configured path of the KV (ver 1) secret. The default value is 'credentials/'.

VAULT_ROLE

Configured role with the correct permissions to read the credentials secret store. There is no default value, so the default value configured in the JWT authentication method will be used.

Vault server must configured with the JWT authentication method enabled, setting you OIDC issuer, e.g. using the EGI Checkin issuer, and setting im as the default role:

vault write auth/jwt/config \
   oidc_discovery_url="https://aai.egi.eu/oidc/" \
   default_role="im"

A KV (v1) secret store must be enabled setting the desired path. In this example the default vaule credentials is used:

vault secrets enable -version=1 -path=credentials kv

Also a policy must be created to enable the users to manage only their own credentials:

vault policy write manage-imcreds - <<EOF
path "credentials/{{identity.entity.id}}" {
capabilities = [ "create", "read", "update", "delete", "list" ]
}
EOF

And finally the im role to assign the policy to the JWT users:

vault write auth/jwt/role/im - <<EOF
{
"role_type": "jwt",
"policies": ["manage-imcreds"],
"token_explicit_max_ttl": 60,
"user_claim": "sub",
"bound_claims": {
   "sub": "*"
},
"bound_claims_type": "glob"
}
EOF

These set of commands are only an example of how to configure the Vault server to be accesed by the IM. Read Vault documentation for more details.

The authentication data must be stored using one item per line in the Authorization File, setting as key value the id of the item and all the auth line (in JSON format) as the value, e.g. An auth line like that:

id = one; type = OpenNebula; host = oneserver:2633; username = user; password = pass

Must be stored in the vault KV secrect, setting one as key and this content as value:

{"id": "one", "type": "OpenNebula", "host": "oneserver:2633", "username": "user", "password": "pass"}

In all the auth lines where an access token is needed it must not be set and the IM will replace it with then access token used to authenticate with the IM itself.

Virtual Machine Tags

Name of the tags that IM will add in the VMs with username, infrastructure ID, URL of the IM service, and IM name comment or leave empty not to set them

VM_TAG_USERNAME

Name of the tag to set the IM username as tag in the IM created VMs.

VM_TAG_INF_ID

Name of the tag to set the IM infrastructure ID as tag in the IM created VMs.

VM_TAG_IM_URL

Name of the tag to set the IM URL as tag in the IM created VMs.

VM_TAG_IM

Name of the tag to set the IM string ('es.grycap.upv.im'`) as tag in the IM created VMs.

IM in high availability mode

From version 1.5.0 the IM service can be launched in high availability (HA) mode using a set of IM instances behind a HAProxy load balancer. Currently only the REST API can be used in HA mode. It is a experimental issue currently it is not intended to be used in a production installation.

This is an example of the HAProxy configuration file:

global
    tune.bufsize 131072
defaults
    timeout connect 600s
    timeout client 600s
    timeout server 600s

    frontend http-frontend
        mode http
        bind *:8800
        default_backend imbackend

    backend imbackend
        mode http
        balance roundrobin
        option httpchk GET /version
        stick-table type string len 32 size 30k expire 60m
        stick store-response hdr(InfID)
        acl inf_id path -m beg /infrastructures/
        stick on path,field(3,/) if inf_id

    server im-8801 10.0.0.1:8801 check
    server im-8802 10.0.0.1:8802 check
    ...

See more details of HAProxy configuration at HAProxy Documentation.

Also the INF_CACHE_TIME variable of the IM config file must be set to a time in seconds lower or equal to the time set in the stick-table expire value (in the example 60m). So for this example INF_CACHE_TIME must be set to less than or equals to 3600.

Purgue IM DB

The IM service does not remove deleted infrastructures from DB for provenance purposes. In case that you want to remove old deleted infrastructures from the DB to reduce its size you can use the delete_old_infs script. It will delete from DB all the infrastructures created before a specified date:

python delete_old_infs.py <date>