Skip to main content

Lightweight TOSCA orchestrator

Project description

xOpera TOSCA orchestrator

xOpera orchestration tool compliant with TOSCA YAML v1.3 in the making.

CircleCI GitHub deployments GitHub release (latest by date) GitHub contributors GitHub top language GitHub code size in bytes PyPI Test PyPI PyPI - License PyPI - Python Version PyPI - Wheel PyPI - Downloads

Aspect Information
Tool name opera
Read the docs (Sphinx) https://xlab-si.github.io/xopera-docs/
Orchestration standard OASIS TOSCA v1.3
Automation tools and actuators Ansible

Table of Contents

Introduction

opera aims to be a lightweight orchestrator compliant with OASIS TOSCA. The current compliance is with the TOSCA Simple Profile in YAML v1.3. The documentation for the tool is available on GitHub pages. Opera implements TOSCA standard with Ansible automation tool where Ansible playbooks can be used as orchestration actuators.

Prerequisites

opera requires python 3 and a virtual environment. In a typical modern Linux environment, we should already be set. In Ubuntu, however, we might need to run the following commands:

$ sudo apt update
$ sudo apt install -y python3-venv python3-wheel python-wheel-common

Installation and Quickstart

opera in action

The orchestration tool is available on PyPI as a package named opera. Apart from the latest production version, you can also find the latest opera develop version (available on Test PyPI instance), which includes pre-releases so that you will be able to test the latest features before they are officially released.

The simplest way to test opera is to install it into virtual environment:

$ mkdir ~/opera && cd ~/opera
$ python3 -m venv .venv && . .venv/bin/activate
(.venv) $ pip install opera

To test if everything is working as expected, we can now clone xOpera's GitHub repository and try to deploy a hello-world service:

(.venv) $ git clone git@github.com:xlab-si/xopera-opera.git
(.venv) $ cd xopera-opera/examples/hello
(.venv) $ opera deploy service.yaml

If nothing went wrong, new empty file has been created at /tmp/playing-opera/hello/hello.txt.

To delete the created directory, we can undeploy our stuff by running:

(.venv) $ opera undeploy

And that is it.

Common examples

This part focuses on different common ways of usage for opera orchestration tool.

OpenStack client setup

Because using OpenStack modules from Ansible playbooks is quite common, we can install opera with all required OpenStack libraries by running:

(.venv) $ pip install -U opera[openstack]

Before we can actually use the OpenStack functionality, we also need to obtain the OpenStack credentials. If we log into OpenStack and navigate to the Access & Security -> API Access page, we can download the rc file with all required information.

At the start of each session (e.g., when we open a new command line console), we must source the rc file by running:

(venv) $ . openstack.rc

After we enter the password, we are ready to start using the OpenStack modules in playbooks that implement life cycle operations.

Other resources and services

The table below show other important resources that are connected to opera.

Resource Link
xopera-api https://github.com/xlab-si/xopera-api/
radon-xopera-saas-plugin https://github.com/radon-h2020/radon-xopera-saas-plugin

Acknowledgement

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant Agreements No. 825040 (RADON) and No. 825480 (SODALITE).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for opera, version 0.6.4
Filename, size File type Python version Upload date Hashes
Filename, size opera-0.6.4-py3-none-any.whl (92.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size opera-0.6.4.tar.gz (703.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page