Skip to content
Snippets Groups Projects
Commit 0882e3e3 authored by Benguria Elguezabal, Gorka's avatar Benguria Elguezabal, Gorka
Browse files

y3

parent 0b0bb8c5
No related branches found
No related tags found
No related merge requests found
Pipeline #138967 failed
Showing with 2157 additions and 126 deletions
.DS_Store 0 → 100644
File added
.git/
.gitignore
**/__pycache__
.mypy_cache
.pytest_cache
*~
*.code-workspace
.vscode
name: Docker Image CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
-
name: Login to Docker Hub
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
-
name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
-
name: Build and push
uses: docker/build-push-action@v4
with:
context: .
file: ./Dockerfile
push: true
tags: ${{ secrets.DOCKERHUB_USERNAME }}/doml-model-checker:latest
name: Pages
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@v2
- uses: actions/checkout@master
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: Build and Commit
uses: sphinx-notes/pages@v2
with:
requirements_path: ./docs/requirements.txt
- name: Push changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
\ No newline at end of file
*~ # Byte-compiled / optimized / DLL files
*__pycache__* __pycache__/
.vscode *.py[cod]
docs/_build *$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
\ No newline at end of file
include:
- project: piacere/private/t23-ci-setup
ref: main
file:
- gitlab-ci-scripts/utils.gitlab-ci.yml
# Image tag variables generation job -------------
# Stage: variable-generation ---------------------
- gitlab-ci-scripts/generate-variables.gitlab-ci.yml
# Downstream t23-ci-setup pipeline trigger job ---
# Stage: integration-tests-publish-deploy --------
- gitlab-ci-scripts/trigger-downstream.gitlab-ci.yml
variables:
# ------------------------
# Component image tag data
# ------------------------
COMPONENT_WP: wp4
DMC_IMAGE_NAME: dmc
# ------------------------------------------
# Space-separated component image abbreviation list
# used to generate image tags and related variables.
# It is also passed to the downstream integration tests,
# publication and deployment pipeline
# ------------------------------------------
IMAGE_NAMES: "$DMC_IMAGE_NAME"
stages:
- variable-generation
- build
- security
- functional-tests
- integration-tests-publish-deploy
# Build jobs ----------------------
build-temp-dmc:
stage: build
variables:
TMP_IMAGE: "$TMP_IMAGE_DMC"
DOCKERFILE_PATH: "."
trigger: !reference [.trigger-build]
rules:
- if: $CI_COMMIT_BRANCH =~ /^y3/
# Security job ------------------------
security-trivy-dmc:
stage: security
variables:
TMP_IMAGE: "$TMP_IMAGE_DMC"
trigger: !reference [.trigger-security-trivy]
needs:
- job: build-temp-dmc
- job: generate-variables
artifacts: true
rules:
- if: $CI_COMMIT_BRANCH =~ /^y3/
# functional tests job ------------------------
run-functional-tests:
image: $DOCKER_IMAGE
stage: functional-tests
services:
- $DOCKER_DIND_IMAGE
variables:
TESTS_CONTAINER_NAME: functional-tester
before_script:
- !reference [.artifactory-login]
script:
# Tests assume port 8080, while the Dockerfile CMD runs the server on port 80.
# Thus, we need to override the command so that the server is run on port 8080.
- docker run --name $TESTS_CONTAINER_NAME -d -e "UVICORN_PORT=8080" $TMP_IMAGE_DMC
# Install everything required for the tests.
- docker exec -i $TESTS_CONTAINER_NAME /bin/bash -c
"pip install -r requirements.txt"
# Run the tests.
- docker exec -i $TESTS_CONTAINER_NAME /bin/bash -c "python -m pytest tests/test_mc_openapi.py -n auto"
# Stop the tests container.
- docker stop $TESTS_CONTAINER_NAME
needs:
- job: build-temp-dmc
- job: generate-variables
artifacts: true
tags:
- docker
rules:
- if: $CI_COMMIT_BRANCH =~ /^y3/
# Issue Title
- [ ] The model is satisfied when it shouldn't (or viceversa)
- [ ] There's an issue with the model checker
- [ ] There's an error with the DOMLR (DSL for requirements)
## Files
To investigate your issue, I need:
- The DOML version you're targeting
- The PIACERE IDE version you are using
- A link to DOML model in question
- The error message (screenshot or copy-n-paste it)
- Any other information you think it's useful
## Description
piacere-dmc
3.11.6
\ No newline at end of file
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
\ No newline at end of file
FROM python:3.9.12-bullseye FROM python:3.11.3-buster AS requirements-stage
COPY . /opt/mc_openapi WORKDIR /code
RUN useradd -mU mc COPY ./requirements.txt /code/requirements.txt
USER mc
ENV PATH="/home/mc/.local/bin:${PATH}"
RUN pip install -r /opt/mc_openapi/requirements.txt
WORKDIR /opt/mc_openapi
CMD ["uwsgi", "--http", ":80", "--yaml", "uwsgi_config.yaml"] RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
COPY ./mc_openapi /code/mc_openapi
COPY ./tests /code/tests
EXPOSE 80
CMD ["uvicorn", "mc_openapi.api:app", "--proxy-headers", "--host", "0.0.0.0", "--port", "80"]
# PIACERE Model Checker REST API server # DOML Model Checker
[![Documentation Status](https://readthedocs.org/projects/piacere-model-checker/badge/?version=latest)](https://piacere-model-checker.readthedocs.io/en/latest/?badge=latest)
This project is packaged with [Poetry](https://python-poetry.org/). ## Description of the component
## Build and Run The DOML Model Checker is a component of the [PIACERE](https://www.piacere-project.eu/) framework in charge of checking the correctness and consistency of [DOML](https://www.piacere-doml.deib.polimi.it/) models.
Build with It consists of a web server exposing a REST API that receives a DOML model in XMI format (also called DOMLX) and provides as output a result detailing whether the model satisfies a set of internal requirements, and in case of negative results, what elements are in violation and how to fix the issue.
It also bundles a Cloud Service Provider (CSP) Compatibility tool that can provide the compatibility results of a model against common Cloud Service Providers.
## Installation
### Setup
Activate the Python Virtual Environment with:
```sh ```sh
poetry install source .venv/bin/activate
``` ```
then run with Install the required packages with:
```sh ```sh
poetry run python -m mc_openapi pip install -r requirements.txt
``` ```
Run tests with: ### Run the model checker web server
```sh ```sh
poetry run python -m pytest python -m mc_openapi
``` ```
## Run with uWSGI ### Run with Uvicorn
The project may be run with [Uvicorn](https://www.uvicorn.org/) as follows:
```sh
uvicorn --port 8080 --host 0.0.0.0 --interface wsgi --workers 2 mc_openapi.app_config:app
```
### Run tests
The project may be run with [uWSGI](https://uwsgi-docs.readthedocs.io/) as follows: Run tests with:
```sh ```sh
uwsgi --http :8080 --yaml uwsgi_config.yaml python -m pytest
``` ```
## Run with Docker ### Run with Docker
First, build the docker image with the usual First, build the docker image with the usual
```sh ```sh
...@@ -35,17 +50,33 @@ And then run it with ...@@ -35,17 +50,33 @@ And then run it with
```sh ```sh
docker run -d wp4/dmc docker run -d wp4/dmc
``` ```
The uWSGI server will be running and listening on port 80 of the container. The Uvicorn server will be running and listening on port `8080` of the container.
To use it locally, you may bind it with port `8080` of `localhost`
by adding `-p 127.0.0.1:8080:8080/tcp` to the `docker run` command.
## Documentation
You can read the latest version at [readthedocs.io](https://piacere-model-checker.readthedocs.io/en/latest/)
### Building the Documentation
The documentation has been written in [Sphinx](https://www.sphinx-doc.org/)
and covers both usage through the PIACERE IDE and the REST APIs.
If you want to build the documentation manually, run:
```sh
cd docs
make html
```
## REST APIs The documentation will be generated in `docs/_build`.
The OpenAPI definition of the REST APIs is in `mc_openapi/openapi/model_checker.yaml`. ## License
This work is licensed under the Apache License 2.0.
The APIs can also be browsed with [Swagger UI](https://swagger.io/tools/swagger-ui/) by appending `/ui/` to the API HTTP address. ## Contact
For APIs usage examples, you may look into the tests, in `tests/test_mc_openapi.py`. andrea.franchini@polimi.it
Two DOML examples in XMI format are sent to the server.
One of them is correct (`tests/doml/nginx-openstack_v2.domlx`), and the server answers with `"sat"` (meaning the requirements are satisfied), and the other one contains an error (`tests/doml/nginx-openstack_v2_wrong.domlx`), so the server answers with `"unsat"`.
**Note:** for the time being, the `model` field of the POST request's body accepts any XML object. This will be changed to the DOML XMI schema when possible. ## Acknowledgement
This project has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant
Agreement No. 101000162 (PIACERE).
appnope==0.1.3 ; python_version >= "3.9" and python_version < "4.0" and platform_system == "Darwin" or python_version >= "3.9" and python_version < "4.0" and sys_platform == "darwin"
asttokens==2.0.5 ; python_version >= "3.9" and python_version < "4.0"
atomicwrites==1.4.1 ; python_version >= "3.9" and python_version < "4.0" and sys_platform == "win32"
attrs==22.1.0 ; python_version >= "3.9" and python_version < "4.0"
backcall==0.2.0 ; python_version >= "3.9" and python_version < "4.0"
certifi==2022.6.15 ; python_version >= "3.9" and python_version < "4"
cffi==1.15.1 ; python_version >= "3.9" and python_version < "4.0" and implementation_name == "pypy"
charset-normalizer==2.1.0 ; python_version >= "3.9" and python_version < "4"
colorama==0.4.5 ; python_version >= "3.9" and python_version < "4.0" and sys_platform == "win32" or python_version >= "3.9" and python_version < "4.0" and platform_system == "Windows"
colorful==0.5.4 ; python_version >= "3.9" and python_version < "4.0"
debugpy==1.6.2 ; python_version >= "3.9" and python_version < "4.0"
decorator==5.1.1 ; python_version >= "3.9" and python_version < "4.0"
entrypoints==0.4 ; python_version >= "3.9" and python_version < "4.0"
executing==0.9.1 ; python_version >= "3.9" and python_version < "4.0"
idna==3.3 ; python_version >= "3.9" and python_version < "4"
iniconfig==1.1.1 ; python_version >= "3.9" and python_version < "4.0"
ipykernel==6.15.1 ; python_version >= "3.9" and python_version < "4.0"
ipython==8.4.0 ; python_version >= "3.9" and python_version < "4.0"
jedi==0.18.1 ; python_version >= "3.9" and python_version < "4.0"
jupyter-client==7.3.4 ; python_version >= "3.9" and python_version < "4.0"
jupyter-core==4.11.1 ; python_version >= "3.9" and python_version < "4.0"
matplotlib-inline==0.1.3 ; python_version >= "3.9" and python_version < "4.0"
nest-asyncio==1.5.5 ; python_version >= "3.9" and python_version < "4.0"
packaging==21.3 ; python_version >= "3.9" and python_version < "4.0"
parso==0.8.3 ; python_version >= "3.9" and python_version < "4.0"
pexpect==4.8.0 ; python_version >= "3.9" and python_version < "4.0" and sys_platform != "win32"
pickleshare==0.7.5 ; python_version >= "3.9" and python_version < "4.0"
pluggy==1.0.0 ; python_version >= "3.9" and python_version < "4.0"
prettyprinter==0.18.0 ; python_version >= "3.9" and python_version < "4.0"
prompt-toolkit==3.0.30 ; python_version >= "3.9" and python_version < "4.0"
psutil==5.9.1 ; python_version >= "3.9" and python_version < "4.0"
ptyprocess==0.7.0 ; python_version >= "3.9" and python_version < "4.0" and sys_platform != "win32"
pure-eval==0.2.2 ; python_version >= "3.9" and python_version < "4.0"
py==1.11.0 ; python_version >= "3.9" and python_version < "4.0"
pycparser==2.21 ; python_version >= "3.9" and python_version < "4.0" and implementation_name == "pypy"
pygments==2.12.0 ; python_version >= "3.9" and python_version < "4.0"
pyparsing==3.0.9 ; python_version >= "3.9" and python_version < "4.0"
pytest==6.2.5 ; python_version >= "3.9" and python_version < "4.0"
python-dateutil==2.8.2 ; python_version >= "3.9" and python_version < "4.0"
pywin32==304 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.9" and python_version < "4.0"
pyzmq==23.2.0 ; python_version >= "3.9" and python_version < "4.0"
requests==2.28.1 ; python_version >= "3.9" and python_version < "4"
six==1.16.0 ; python_version >= "3.9" and python_version < "4.0"
stack-data==0.3.0 ; python_version >= "3.9" and python_version < "4.0"
toml==0.10.2 ; python_version >= "3.9" and python_version < "4.0"
tornado==6.2 ; python_version >= "3.9" and python_version < "4.0"
traitlets==5.3.0 ; python_version >= "3.9" and python_version < "4.0"
urllib3==1.26.11 ; python_version >= "3.9" and python_version < "4"
wcwidth==0.2.5 ; python_version >= "3.9" and python_version < "4.0"
docs/PIACERE_logo.png

3.13 KiB

...@@ -13,17 +13,17 @@ ...@@ -13,17 +13,17 @@
# import os # import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath('.')) # sys.path.insert(0, os.path.abspath('.'))
import sphinx_rtd_theme # import sphinx_rtd_theme
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'DOML Model Checker' project = 'DOML Model Checker'
copyright = '2022, Michele Chiari and Michele De Pascalis' copyright = '2022, Michele Chiari, Michele De Pascalis, Andrea Franchini'
author = 'Michele Chiari and Michele De Pascalis' author = 'Michele Chiari, Michele De Pascalis, Andrea Franchini'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '1.0.0' release = '2.5.2'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
...@@ -32,7 +32,7 @@ release = '1.0.0' ...@@ -32,7 +32,7 @@ release = '1.0.0'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'sphinx_rtd_theme' # 'sphinx_rtd_theme'
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
...@@ -41,7 +41,7 @@ templates_path = [] ...@@ -41,7 +41,7 @@ templates_path = []
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'requirements.txt']
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
...@@ -49,8 +49,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -49,8 +49,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'sphinx_rtd_theme' # html_theme = 'sphinx_rtd_theme'
html_theme = 'furo'
html_logo = "PIACERE_logo.png"
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
DOML Model Checker's documentation DOML Model Checker Documentation
================================== ==================================
The DOML Model Checker is a component of the `PIACERE`_ framework The DOML Model Checker is a component of the `PIACERE`_ framework
...@@ -15,9 +15,12 @@ in charge of checking the correctness and consistency of `DOML`_ models. ...@@ -15,9 +15,12 @@ in charge of checking the correctness and consistency of `DOML`_ models.
:caption: Contents: :caption: Contents:
installation installation
tests
usage usage
writing-requirements
requirements requirements
restapis restapis
reference_index
.. ..
Indices and tables Indices and tables
...@@ -28,8 +31,8 @@ in charge of checking the correctness and consistency of `DOML`_ models. ...@@ -28,8 +31,8 @@ in charge of checking the correctness and consistency of `DOML`_ models.
* :ref:`search` * :ref:`search`
This project has received funding from the European Union's Horizon 2020 *This project has received funding from the European Union's Horizon 2020
research and innovation programme under grant agreement No. 101000162. research and innovation programme under grant agreement No. 101000162.*
.. _PIACERE: https://www.piacere-project.eu/ .. _PIACERE: https://www.piacere-project.eu/
......
Installation Installation
============ ************
The DOML Model Checker receives user inputs through its REST APIs. The model checker can be run in two configurations, *REST API* and *CLI*.
In this guide we illuestrate saveral ways of setting up the server for these APIs.
First, you'll need to install the dependencies to run this tool.
Build and run locally for testing Installing the dependencies
--------------------------------- ===========================
1. Clone/download the model checker repository.
This project is packaged with `Poetry`_, which we assume you have already 2. Setting up a Python virtual environment is recommended. You can run the following command to create it::
`installed <https://python-poetry.org/docs/#installation>`_ into your system.
python -m venv .venv
Build with:: # Remember to activate it! e.g.:
source .venv/bin/activate
poetry install 3. Install the dependencies with::
then run with:: pip install -r requirements.txt
poetry run python -m mc_openapi Run locally for testing
-----------------------
Run with::
this command serves the APIs through a `Flask`_ instance, python -m mc_openapi
which is suitable for testing, but not recommended for production.
You may read the API specification generated by `Swagger-UI`_ by
pointing your browser to http://127.0.0.1:8080/ui/.
Then, run tests with::
poetry run python -m pytest
This command serves the APIs through a `Flask`_ instance,
which is suitable for testing, but not recommended for production.
Run locally with uWSGI Run locally with Uvicorn
---------------------- ------------------------
The project may be run with `uWSGI`_, The project may be run with `Uvicorn`_,
which is better-suited for production environments, as follows:: which is better-suited for production environments, as follows::
uwsgi --http :8080 -w mc_openapi.app_config -p 4 uvicorn --port 8080 --host 0.0.0.0 --interface wsgi --workers 2 mc_openapi.app_config:app
You may also configure Uvicorn using environment variables
with the prefix ``UVICORN_``.
For example, if you want to run the server with 4 workers,
set the environment variable ``UVICORN_WORKERS`` to ``4``.
Run with Docker Run with Docker
--------------- ---------------
...@@ -53,19 +55,21 @@ And then run it with:: ...@@ -53,19 +55,21 @@ And then run it with::
docker run -d wp4/dmc docker run -d wp4/dmc
The uWSGI server will be running and listening on port 80 of the container. The Uvicorn server will be running and listening on port 80 of the container.
To use it locally, you may e.g. bind it with port 8080 of ``localhost``
by adding ``-p 127.0.0.1:8080:80/tcp`` to the ``docker run`` command.
REST API Endpoints
==================
You may read the API specification generated by `Swagger-UI`_ at http://127.0.0.1:8080/ui/.
Building the Documentation Building the Documentation
-------------------------- ==========================
The documentation has been written in `Sphinx`_. The documentation has been written in `Sphinx`_.
To build it, type:: To build it manually, run::
poetry shell
and then::
cd docs cd docs
make html make html
...@@ -73,9 +77,8 @@ and then:: ...@@ -73,9 +77,8 @@ and then::
The documentation will be generated in ``docs/_build``. The documentation will be generated in ``docs/_build``.
.. _Poetry: https://python-poetry.org/
.. _Flask: https://flask.palletsprojects.com/ .. _Flask: https://flask.palletsprojects.com/
.. _Swagger-UI: https://swagger.io/tools/swagger-ui/ .. _Swagger-UI: https://swagger.io/tools/swagger-ui/
.. _uWSGI: https://uwsgi-docs.readthedocs.io/ .. _Uvicorn: https://www.uvicorn.org/
.. _Docker: https://www.docker.com/ .. _Docker: https://www.docker.com/
.. _Sphinx: https://www.sphinx-doc.org/ .. _Sphinx: https://www.sphinx-doc.org/
DOML Reference
==============
For a comprehensive list of all the classes, attributes and associations supported in the DOML Model Checker and DOMLR, please consult one of the following pages.
:doc:`Reference for DOML v2.0 <reference_v2.0>`
-----------------------------------------------
:doc:`Reference for DOML v2.1 <reference_v2.1>`
-----------------------------------------------
:doc:`Reference for DOML v2.2 <reference_v2.2>`
-----------------------------------------------
:doc:`Reference for DOML v2.2.1 <reference_v2.2.1>`
---------------------------------------------------
:doc:`Reference for DOML v2.3 <reference_v2.3>`
-----------------------------------------------
:doc:`Reference for DOML v3.0 <reference_v3.0>`
-----------------------------------------------
:doc:`Reference for DOML v3.1 <reference_v3.1>`
-----------------------------------------------
DOML v2.0 Reference
=============================
commons
^^^^^^^
.. _v2.0_commons_BProperty:
BProperty
"""""""""
*Inherits from* :ref:`Property <v2.0_commons_Property>`
* Attributes:
* ``value`` [Boolean]
.. _v2.0_commons_Configuration:
Configuration
"""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``deployments`` → Deployment [0..*]
.. _v2.0_commons_DOMLElement:
DOMLElement
"""""""""""
* Associations:
* ``annotations`` → Property [0..*]
* Attributes:
* ``name`` [String]
* ``description`` [String]
.. _v2.0_commons_Deployment:
Deployment
""""""""""
* Associations:
* ``component`` → ApplicationComponent [1..1]
* ``node`` → InfrastructureElement [1..1]
.. _v2.0_commons_FProperty:
FProperty
"""""""""
*Inherits from* :ref:`Property <v2.0_commons_Property>`
* Attributes:
* ``value`` [String]
.. _v2.0_commons_IProperty:
IProperty
"""""""""
*Inherits from* :ref:`Property <v2.0_commons_Property>`
* Attributes:
* ``value`` [Integer]
.. _v2.0_commons_Property:
Property
""""""""
* Associations:
* ``reference`` → DOMLElement [0..1]
* Attributes:
* ``key`` [String]
.. _v2.0_commons_SProperty:
SProperty
"""""""""
*Inherits from* :ref:`Property <v2.0_commons_Property>`
* Attributes:
* ``value`` [String]
application
^^^^^^^^^^^
.. _v2.0_application_ApplicationComponent:
ApplicationComponent
""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
.. _v2.0_application_ApplicationLayer:
ApplicationLayer
""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``components`` → ApplicationComponent [0..*]
.. _v2.0_application_DBMS:
DBMS
""""
*Inherits from* :ref:`SoftwareComponent <v2.0_application_SoftwareComponent>`
.. _v2.0_application_SaaS:
SaaS
""""
*Inherits from* :ref:`ApplicationComponent <v2.0_application_ApplicationComponent>`
* Associations:
* ``exposedInterfaces`` → SoftwareInterface [0..*]
* Attributes:
* ``licenseCost`` [String]
.. _v2.0_application_SaaSDBMS:
SaaSDBMS
""""""""
*Inherits from* :ref:`SaaS <v2.0_application_SaaS>`
.. _v2.0_application_SoftwareComponent:
SoftwareComponent
"""""""""""""""""
*Inherits from* :ref:`ApplicationComponent <v2.0_application_ApplicationComponent>`
* Associations:
* ``exposedInterfaces`` → SoftwareInterface [0..*]
* ``consumedInterfaces`` → SoftwareInterface [0..*]
* Attributes:
* ``isPersistent`` [Boolean]
* ``licenseCost`` [String]
* ``configFile`` [String]
.. _v2.0_application_SoftwareInterface:
SoftwareInterface
"""""""""""""""""
*Inherits from* :ref:`ApplicationComponent <v2.0_application_ApplicationComponent>`
* Attributes:
* ``endPoint`` [String]
infrastructure
^^^^^^^^^^^^^^
.. _v2.0_infrastructure_AutoScalingGroup:
AutoScalingGroup
""""""""""""""""
*Inherits from* :ref:`ComputingGroup <v2.0_infrastructure_ComputingGroup>`
* Associations:
* ``machineDefinition`` → VirtualMachine [1..1]
* ``deploymentNetwork`` → Network [0..1]
* ``securityGroup`` → SecurityGroup [0..1]
* Attributes:
* ``min`` [Integer]
* ``max`` [Integer]
* ``loadBalancer`` [String]
.. _v2.0_infrastructure_ComputingGroup:
ComputingGroup
""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``groupedNodes`` → ComputingNode [0..*]
.. _v2.0_infrastructure_ComputingNode:
ComputingNode
"""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.0_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* ``location`` → Location [0..1]
* ``credentials`` → Credentials [0..1]
* ``group`` → ComputingGroup [0..1]
* Attributes:
* ``architecture`` [String]
* ``os`` [String]
* ``memory_mb`` [Integer]
* ``memory_kb`` [Integer]
* ``storage`` [String]
* ``cpu_count`` [Integer]
* ``cost`` [Integer]
.. _v2.0_infrastructure_ComputingNodeGenerator:
ComputingNodeGenerator
""""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Attributes:
* ``uri`` [String]
* ``kind`` [GeneratorKind]
.. _v2.0_infrastructure_Container:
Container
"""""""""
*Inherits from* :ref:`ComputingNode <v2.0_infrastructure_ComputingNode>`
* Associations:
* ``generatedFrom`` → ContainerImage [0..1]
* ``hosts`` → ComputingNode [0..*]
.. _v2.0_infrastructure_ContainerImage:
ContainerImage
""""""""""""""
*Inherits from* :ref:`ComputingNodeGenerator <v2.0_infrastructure_ComputingNodeGenerator>`
* Associations:
* ``generatedContainers`` → Container [0..*]
.. _v2.0_infrastructure_Credentials:
Credentials
"""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
.. _v2.0_infrastructure_ExtInfrastructureElement:
ExtInfrastructureElement
""""""""""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.0_infrastructure_InfrastructureElement>`
.. _v2.0_infrastructure_FunctionAsAService:
FunctionAsAService
""""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.0_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* Attributes:
* ``cost`` [Integer]
.. _v2.0_infrastructure_InfrastructureElement:
InfrastructureElement
"""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
.. _v2.0_infrastructure_InfrastructureLayer:
InfrastructureLayer
"""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``nodes`` → ComputingNode [0..*]
* ``generators`` → ComputingNodeGenerator [0..*]
* ``storages`` → Storage [0..*]
* ``faas`` → FunctionAsAService [0..*]
* ``credentials`` → Credentials [0..*]
* ``groups`` → ComputingGroup [0..*]
* ``securityGroups`` → SecurityGroup [0..*]
* ``networks`` → Network [0..*]
.. _v2.0_infrastructure_InternetGateway:
InternetGateway
"""""""""""""""
*Inherits from* :ref:`NetworkInterface <v2.0_infrastructure_NetworkInterface>`
.. _v2.0_infrastructure_KeyPair:
KeyPair
"""""""
*Inherits from* :ref:`Credentials <v2.0_infrastructure_Credentials>`
* Attributes:
* ``user`` [String]
* ``keyfile`` [String]
* ``algorithm`` [String]
* ``bits`` [Integer]
.. _v2.0_infrastructure_Location:
Location
""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Attributes:
* ``region`` [String]
* ``zone`` [String]
.. _v2.0_infrastructure_Network:
Network
"""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``connectedIfaces`` → NetworkInterface [0..*]
* ``igws`` → InternetGateway [0..*]
* ``subnets`` → Subnet [0..*]
* Attributes:
* ``protocol`` [String]
* ``address_lb`` [Integer]
* ``address_ub`` [Integer]
.. _v2.0_infrastructure_NetworkInterface:
NetworkInterface
""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.0_infrastructure_InfrastructureElement>`
* Associations:
* ``belongsTo`` → Network [0..1]
* ``associated`` → SecurityGroup [0..1]
* Attributes:
* ``endPoint`` [Integer]
* ``speed`` [String]
.. _v2.0_infrastructure_PhysicalComputingNode:
PhysicalComputingNode
"""""""""""""""""""""
*Inherits from* :ref:`ComputingNode <v2.0_infrastructure_ComputingNode>`
.. _v2.0_infrastructure_Rule:
Rule
""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Attributes:
* ``kind`` [String]
* ``protocol`` [String]
* ``fromPort`` [Integer]
* ``toPort`` [Integer]
* ``cidr`` [String]
.. _v2.0_infrastructure_SecurityGroup:
SecurityGroup
"""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``rules`` → Rule [0..*]
* ``ifaces`` → NetworkInterface [0..*]
.. _v2.0_infrastructure_Storage:
Storage
"""""""
*Inherits from* :ref:`InfrastructureElement <v2.0_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* Attributes:
* ``label`` [String]
* ``size_gb`` [Integer]
* ``cost`` [Integer]
.. _v2.0_infrastructure_Subnet:
Subnet
""""""
*Inherits from* :ref:`Network <v2.0_infrastructure_Network>`
* Associations:
* ``connectedTo`` → Network [0..1]
.. _v2.0_infrastructure_Swarm:
Swarm
"""""
*Inherits from* :ref:`ComputingGroup <v2.0_infrastructure_ComputingGroup>`
* Associations:
* ``roles`` → SwarmRole [0..*]
.. _v2.0_infrastructure_SwarmRole:
SwarmRole
"""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``nodes`` → ComputingNode [0..*]
* Attributes:
* ``kind`` [String]
.. _v2.0_infrastructure_UserPass:
UserPass
""""""""
*Inherits from* :ref:`Credentials <v2.0_infrastructure_Credentials>`
* Attributes:
* ``username`` [String]
* ``password`` [String]
.. _v2.0_infrastructure_VMImage:
VMImage
"""""""
*Inherits from* :ref:`ComputingNodeGenerator <v2.0_infrastructure_ComputingNodeGenerator>`
* Associations:
* ``generatedVMs`` → VirtualMachine [0..*]
.. _v2.0_infrastructure_VirtualMachine:
VirtualMachine
""""""""""""""
*Inherits from* :ref:`ComputingNode <v2.0_infrastructure_ComputingNode>`
* Associations:
* ``generatedFrom`` → VMImage [0..1]
* Attributes:
* ``sizeDescription`` [String]
concrete
^^^^^^^^
.. _v2.0_concrete_ComputingGroup:
ComputingGroup
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.0_concrete_ConcreteElement>`
* Associations:
* ``maps`` → ComputingGroup [1..1]
.. _v2.0_concrete_ConcreteElement:
ConcreteElement
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Attributes:
* ``configurationScript`` [String]
.. _v2.0_concrete_ConcreteInfrastructure:
ConcreteInfrastructure
""""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``providers`` → RuntimeProvider [0..*]
.. _v2.0_concrete_ContainerImage:
ContainerImage
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.0_concrete_ConcreteElement>`
* Associations:
* ``maps`` → ContainerImage [0..1]
.. _v2.0_concrete_FunctionAsAService:
FunctionAsAService
""""""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.0_concrete_ConcreteElement>`
* Associations:
* ``maps`` → FunctionAsAService [0..1]
.. _v2.0_concrete_Network:
Network
"""""""
*Inherits from* :ref:`ConcreteElement <v2.0_concrete_ConcreteElement>`
* Associations:
* ``maps`` → Network [0..1]
.. _v2.0_concrete_RuntimeProvider:
RuntimeProvider
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.0_commons_DOMLElement>`
* Associations:
* ``vms`` → VirtualMachine [0..*]
* ``vmImages`` → VMImage [0..*]
* ``containerImages`` → ContainerImage [0..*]
* ``networks`` → Network [0..*]
* ``storages`` → Storage [0..*]
* ``faas`` → FunctionAsAService [0..*]
* ``group`` → ComputingGroup [0..*]
.. _v2.0_concrete_Storage:
Storage
"""""""
*Inherits from* :ref:`ConcreteElement <v2.0_concrete_ConcreteElement>`
* Associations:
* ``maps`` → Storage [0..1]
.. _v2.0_concrete_VMImage:
VMImage
"""""""
*Inherits from* :ref:`ConcreteElement <v2.0_concrete_ConcreteElement>`
* Associations:
* ``maps`` → VMImage [0..1]
.. _v2.0_concrete_VirtualMachine:
VirtualMachine
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.0_concrete_ConcreteElement>`
* Associations:
* ``maps`` → VirtualMachine [0..1]
DOML v2.1 Reference
=============================
commons
^^^^^^^
.. _v2.1_commons_BProperty:
BProperty
"""""""""
*Inherits from* :ref:`Property <v2.1_commons_Property>`
* Attributes:
* ``value`` [Boolean]
.. _v2.1_commons_Configuration:
Configuration
"""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``deployments`` → Deployment [0..*]
.. _v2.1_commons_DOMLElement:
DOMLElement
"""""""""""
* Associations:
* ``annotations`` → Property [0..*]
* Attributes:
* ``name`` [String]
* ``description`` [String]
.. _v2.1_commons_Deployment:
Deployment
""""""""""
* Associations:
* ``component`` → ApplicationComponent [1..1]
* ``node`` → InfrastructureElement [1..1]
.. _v2.1_commons_FProperty:
FProperty
"""""""""
*Inherits from* :ref:`Property <v2.1_commons_Property>`
* Attributes:
* ``value`` [String]
.. _v2.1_commons_IProperty:
IProperty
"""""""""
*Inherits from* :ref:`Property <v2.1_commons_Property>`
* Attributes:
* ``value`` [Integer]
.. _v2.1_commons_Property:
Property
""""""""
* Associations:
* ``reference`` → DOMLElement [0..1]
* Attributes:
* ``key`` [String]
.. _v2.1_commons_SProperty:
SProperty
"""""""""
*Inherits from* :ref:`Property <v2.1_commons_Property>`
* Attributes:
* ``value`` [String]
application
^^^^^^^^^^^
.. _v2.1_application_ApplicationComponent:
ApplicationComponent
""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
.. _v2.1_application_ApplicationLayer:
ApplicationLayer
""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``components`` → ApplicationComponent [0..*]
.. _v2.1_application_DBMS:
DBMS
""""
*Inherits from* :ref:`SoftwareComponent <v2.1_application_SoftwareComponent>`
.. _v2.1_application_SaaS:
SaaS
""""
*Inherits from* :ref:`ApplicationComponent <v2.1_application_ApplicationComponent>`
* Associations:
* ``exposedInterfaces`` → SoftwareInterface [0..*]
* Attributes:
* ``licenseCost`` [String]
.. _v2.1_application_SaaSDBMS:
SaaSDBMS
""""""""
*Inherits from* :ref:`SaaS <v2.1_application_SaaS>`
.. _v2.1_application_SoftwareComponent:
SoftwareComponent
"""""""""""""""""
*Inherits from* :ref:`ApplicationComponent <v2.1_application_ApplicationComponent>`
* Associations:
* ``exposedInterfaces`` → SoftwareInterface [0..*]
* ``consumedInterfaces`` → SoftwareInterface [0..*]
* Attributes:
* ``isPersistent`` [Boolean]
* ``licenseCost`` [String]
* ``configFile`` [String]
.. _v2.1_application_SoftwareInterface:
SoftwareInterface
"""""""""""""""""
*Inherits from* :ref:`ApplicationComponent <v2.1_application_ApplicationComponent>`
* Attributes:
* ``endPoint`` [String]
infrastructure
^^^^^^^^^^^^^^
.. _v2.1_infrastructure_AutoScalingGroup:
AutoScalingGroup
""""""""""""""""
*Inherits from* :ref:`ComputingGroup <v2.1_infrastructure_ComputingGroup>`
* Associations:
* ``machineDefinition`` → VirtualMachine [1..1]
* ``securityGroup`` → SecurityGroup [0..1]
* Attributes:
* ``min`` [Integer]
* ``max`` [Integer]
* ``loadBalancer`` [String]
.. _v2.1_infrastructure_ComputingGroup:
ComputingGroup
""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``groupedNodes`` → ComputingNode [0..*]
.. _v2.1_infrastructure_ComputingNode:
ComputingNode
"""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* ``location`` → Location [0..1]
* ``credentials`` → Credentials [0..1]
* ``group`` → ComputingGroup [0..1]
* Attributes:
* ``architecture`` [String]
* ``os`` [String]
* ``memory_mb`` [Integer]
* ``memory_kb`` [Integer]
* ``storage`` [String]
* ``cpu_count`` [Integer]
* ``cost`` [Integer]
.. _v2.1_infrastructure_ComputingNodeGenerator:
ComputingNodeGenerator
""""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Attributes:
* ``uri`` [String]
* ``kind`` [GeneratorKind]
.. _v2.1_infrastructure_Container:
Container
"""""""""
*Inherits from* :ref:`ComputingNode <v2.1_infrastructure_ComputingNode>`
* Associations:
* ``generatedFrom`` → ContainerImage [0..1]
* ``configs`` → ContainerConfig [0..*]
.. _v2.1_infrastructure_ContainerConfig:
ContainerConfig
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``host`` → ComputingNode [0..1]
* ``iface`` → NetworkInterface [0..1]
* Attributes:
* ``container_port`` [Integer]
* ``vm_port`` [Integer]
.. _v2.1_infrastructure_ContainerImage:
ContainerImage
""""""""""""""
*Inherits from* :ref:`ComputingNodeGenerator <v2.1_infrastructure_ComputingNodeGenerator>`
* Associations:
* ``generatedContainers`` → Container [0..*]
.. _v2.1_infrastructure_Credentials:
Credentials
"""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
.. _v2.1_infrastructure_ExtInfrastructureElement:
ExtInfrastructureElement
""""""""""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.1_infrastructure_InfrastructureElement>`
.. _v2.1_infrastructure_FunctionAsAService:
FunctionAsAService
""""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* Attributes:
* ``cost`` [Integer]
.. _v2.1_infrastructure_InfrastructureElement:
InfrastructureElement
"""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
.. _v2.1_infrastructure_InfrastructureLayer:
InfrastructureLayer
"""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``nodes`` → ComputingNode [0..*]
* ``generators`` → ComputingNodeGenerator [0..*]
* ``storages`` → Storage [0..*]
* ``faas`` → FunctionAsAService [0..*]
* ``credentials`` → Credentials [0..*]
* ``groups`` → ComputingGroup [0..*]
* ``securityGroups`` → SecurityGroup [0..*]
* ``networks`` → Network [0..*]
.. _v2.1_infrastructure_InternetGateway:
InternetGateway
"""""""""""""""
*Inherits from* :ref:`NetworkInterface <v2.1_infrastructure_NetworkInterface>`
.. _v2.1_infrastructure_KeyPair:
KeyPair
"""""""
*Inherits from* :ref:`Credentials <v2.1_infrastructure_Credentials>`
* Attributes:
* ``user`` [String]
* ``keyfile`` [String]
* ``algorithm`` [String]
* ``bits`` [Integer]
.. _v2.1_infrastructure_Location:
Location
""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Attributes:
* ``region`` [String]
* ``zone`` [String]
.. _v2.1_infrastructure_Network:
Network
"""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``connectedIfaces`` → NetworkInterface [0..*]
* ``igws`` → InternetGateway [0..*]
* ``subnets`` → Subnet [0..*]
* Attributes:
* ``protocol`` [String]
* ``addressRange`` [String]
* ``cidr`` [Integer]
.. _v2.1_infrastructure_NetworkInterface:
NetworkInterface
""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``belongsTo`` → Network [0..1]
* ``associated`` → SecurityGroup [0..1]
* Attributes:
* ``endPoint`` [Integer]
* ``speed`` [String]
.. _v2.1_infrastructure_PhysicalComputingNode:
PhysicalComputingNode
"""""""""""""""""""""
*Inherits from* :ref:`ComputingNode <v2.1_infrastructure_ComputingNode>`
.. _v2.1_infrastructure_Rule:
Rule
""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Attributes:
* ``kind`` [String]
* ``protocol`` [String]
* ``fromPort`` [Integer]
* ``toPort`` [Integer]
* ``cidr`` [String]
.. _v2.1_infrastructure_SecurityGroup:
SecurityGroup
"""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``rules`` → Rule [0..*]
* ``ifaces`` → NetworkInterface [0..*]
.. _v2.1_infrastructure_Storage:
Storage
"""""""
*Inherits from* :ref:`InfrastructureElement <v2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* Attributes:
* ``label`` [String]
* ``size_gb`` [Integer]
* ``cost`` [Integer]
.. _v2.1_infrastructure_Subnet:
Subnet
""""""
*Inherits from* :ref:`Network <v2.1_infrastructure_Network>`
* Associations:
* ``connectedTo`` → Network [0..1]
.. _v2.1_infrastructure_Swarm:
Swarm
"""""
*Inherits from* :ref:`ComputingGroup <v2.1_infrastructure_ComputingGroup>`
* Associations:
* ``roles`` → SwarmRole [0..*]
.. _v2.1_infrastructure_SwarmRole:
SwarmRole
"""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``nodes`` → ComputingNode [0..*]
* Attributes:
* ``kind`` [String]
.. _v2.1_infrastructure_UserPass:
UserPass
""""""""
*Inherits from* :ref:`Credentials <v2.1_infrastructure_Credentials>`
* Attributes:
* ``username`` [String]
* ``password`` [String]
.. _v2.1_infrastructure_VMImage:
VMImage
"""""""
*Inherits from* :ref:`ComputingNodeGenerator <v2.1_infrastructure_ComputingNodeGenerator>`
* Associations:
* ``generatedVMs`` → VirtualMachine [0..*]
.. _v2.1_infrastructure_VirtualMachine:
VirtualMachine
""""""""""""""
*Inherits from* :ref:`ComputingNode <v2.1_infrastructure_ComputingNode>`
* Associations:
* ``generatedFrom`` → VMImage [0..1]
* Attributes:
* ``sizeDescription`` [String]
concrete
^^^^^^^^
.. _v2.1_concrete_ComputingGroup:
ComputingGroup
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → ComputingGroup [1..1]
.. _v2.1_concrete_ConcreteElement:
ConcreteElement
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Attributes:
* ``configurationScript`` [String]
.. _v2.1_concrete_ConcreteInfrastructure:
ConcreteInfrastructure
""""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``providers`` → RuntimeProvider [0..*]
.. _v2.1_concrete_ContainerImage:
ContainerImage
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → ContainerImage [0..1]
.. _v2.1_concrete_FunctionAsAService:
FunctionAsAService
""""""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → FunctionAsAService [0..1]
.. _v2.1_concrete_Network:
Network
"""""""
*Inherits from* :ref:`ConcreteElement <v2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → Network [0..1]
* Attributes:
* ``address`` [Integer]
.. _v2.1_concrete_RuntimeProvider:
RuntimeProvider
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.1_commons_DOMLElement>`
* Associations:
* ``vms`` → VirtualMachine [0..*]
* ``vmImages`` → VMImage [0..*]
* ``containerImages`` → ContainerImage [0..*]
* ``networks`` → Network [0..*]
* ``storages`` → Storage [0..*]
* ``faas`` → FunctionAsAService [0..*]
* ``group`` → ComputingGroup [0..*]
.. _v2.1_concrete_Storage:
Storage
"""""""
*Inherits from* :ref:`ConcreteElement <v2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → Storage [0..1]
.. _v2.1_concrete_VMImage:
VMImage
"""""""
*Inherits from* :ref:`ConcreteElement <v2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → VMImage [0..1]
.. _v2.1_concrete_VirtualMachine:
VirtualMachine
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → VirtualMachine [0..1]
DOML v2.2.1 Reference
=============================
commons
^^^^^^^
.. _v2.2.1_commons_BProperty:
BProperty
"""""""""
*Inherits from* :ref:`Property <v2.2.1_commons_Property>`
* Attributes:
* ``value`` [Boolean]
.. _v2.2.1_commons_Configuration:
Configuration
"""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``deployments`` → Deployment [0..*]
.. _v2.2.1_commons_Credentials:
Credentials
"""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
.. _v2.2.1_commons_DOMLElement:
DOMLElement
"""""""""""
* Associations:
* ``annotations`` → Property [0..*]
* Attributes:
* ``name`` [String]
* ``description`` [String]
.. _v2.2.1_commons_DeployableElement:
DeployableElement
"""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
.. _v2.2.1_commons_Deployment:
Deployment
""""""""""
* Associations:
* ``component`` → DeployableElement [1..1]
* ``node`` → InfrastructureElement [1..1]
.. _v2.2.1_commons_FProperty:
FProperty
"""""""""
*Inherits from* :ref:`Property <v2.2.1_commons_Property>`
* Attributes:
* ``value`` [String]
.. _v2.2.1_commons_IProperty:
IProperty
"""""""""
*Inherits from* :ref:`Property <v2.2.1_commons_Property>`
* Attributes:
* ``value`` [Integer]
.. _v2.2.1_commons_KeyPair:
KeyPair
"""""""
*Inherits from* :ref:`Credentials <v2.2.1_commons_Credentials>`
* Attributes:
* ``user`` [String]
* ``keyfile`` [String]
* ``algorithm`` [String]
* ``bits`` [Integer]
.. _v2.2.1_commons_Property:
Property
""""""""
* Associations:
* ``reference`` → DOMLElement [0..1]
* Attributes:
* ``key`` [String]
.. _v2.2.1_commons_SProperty:
SProperty
"""""""""
*Inherits from* :ref:`Property <v2.2.1_commons_Property>`
* Attributes:
* ``value`` [String]
.. _v2.2.1_commons_Source:
Source
""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Attributes:
* ``entry`` [String]
* ``backend`` [String]
.. _v2.2.1_commons_UserPass:
UserPass
""""""""
*Inherits from* :ref:`Credentials <v2.2.1_commons_Credentials>`
* Attributes:
* ``username`` [String]
* ``password`` [String]
application
^^^^^^^^^^^
.. _v2.2.1_application_ApplicationComponent:
ApplicationComponent
""""""""""""""""""""
*Inherits from* :ref:`DeployableElement <v2.2.1_commons_DeployableElement>`
.. _v2.2.1_application_ApplicationLayer:
ApplicationLayer
""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``components`` → ApplicationComponent [0..*]
.. _v2.2.1_application_DBMS:
DBMS
""""
*Inherits from* :ref:`SoftwareComponent <v2.2.1_application_SoftwareComponent>`
.. _v2.2.1_application_SaaS:
SaaS
""""
*Inherits from* :ref:`ApplicationComponent <v2.2.1_application_ApplicationComponent>`
* Associations:
* ``exposedInterfaces`` → SoftwareInterface [0..*]
* Attributes:
* ``licenseCost`` [String]
.. _v2.2.1_application_SaaSDBMS:
SaaSDBMS
""""""""
*Inherits from* :ref:`SaaS <v2.2.1_application_SaaS>`
.. _v2.2.1_application_SoftwareComponent:
SoftwareComponent
"""""""""""""""""
*Inherits from* :ref:`ApplicationComponent <v2.2.1_application_ApplicationComponent>`
* Associations:
* ``exposedInterfaces`` → SoftwareInterface [0..*]
* ``consumedInterfaces`` → SoftwareInterface [0..*]
* ``src`` → Source [0..1]
* Attributes:
* ``isPersistent`` [Boolean]
* ``licenseCost`` [String]
.. _v2.2.1_application_SoftwareInterface:
SoftwareInterface
"""""""""""""""""
*Inherits from* :ref:`ApplicationComponent <v2.2.1_application_ApplicationComponent>`
* Attributes:
* ``endPoint`` [String]
infrastructure
^^^^^^^^^^^^^^
.. _v2.2.1_infrastructure_AutoScalingGroup:
AutoScalingGroup
""""""""""""""""
*Inherits from* :ref:`ComputingGroup <v2.2.1_infrastructure_ComputingGroup>`
* Associations:
* ``machineDefinition`` → VirtualMachine [1..1]
* ``securityGroup`` → SecurityGroup [0..1]
* Attributes:
* ``min`` [Integer]
* ``max`` [Integer]
* ``loadBalancer`` [String]
.. _v2.2.1_infrastructure_ComputingGroup:
ComputingGroup
""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``groupedNodes`` → ComputingNode [0..*]
.. _v2.2.1_infrastructure_ComputingNode:
ComputingNode
"""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* ``location`` → Location [0..1]
* ``credentials`` → Credentials [0..1]
* ``group`` → ComputingGroup [0..1]
* Attributes:
* ``architecture`` [String]
* ``os`` [String]
* ``memory_mb`` [Integer]
* ``memory_kb`` [Integer]
* ``storage`` [String]
* ``cpu_count`` [Integer]
* ``cost`` [Integer]
* ``disabledMonitorings`` [String]
.. _v2.2.1_infrastructure_ComputingNodeGenerator:
ComputingNodeGenerator
""""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Attributes:
* ``uri`` [String]
* ``kind`` [GeneratorKind]
.. _v2.2.1_infrastructure_Container:
Container
"""""""""
*Inherits from* :ref:`ComputingNode <v2.2.1_infrastructure_ComputingNode>`
* Associations:
* ``generatedFrom`` → ContainerImage [0..1]
* ``configs`` → ContainerConfig [0..*]
.. _v2.2.1_infrastructure_ContainerConfig:
ContainerConfig
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``host`` → ComputingNode [0..1]
* ``iface`` → NetworkInterface [0..1]
* Attributes:
* ``container_port`` [Integer]
* ``vm_port`` [Integer]
.. _v2.2.1_infrastructure_ContainerImage:
ContainerImage
""""""""""""""
*Inherits from* :ref:`ComputingNodeGenerator <v2.2.1_infrastructure_ComputingNodeGenerator>`
* Associations:
* ``generatedContainers`` → Container [0..*]
.. _v2.2.1_infrastructure_ExtInfrastructureElement:
ExtInfrastructureElement
""""""""""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.2.1_infrastructure_InfrastructureElement>`
.. _v2.2.1_infrastructure_FunctionAsAService:
FunctionAsAService
""""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* Attributes:
* ``cost`` [Integer]
.. _v2.2.1_infrastructure_InfrastructureElement:
InfrastructureElement
"""""""""""""""""""""
*Inherits from* :ref:`DeployableElement <v2.2.1_commons_DeployableElement>`
.. _v2.2.1_infrastructure_InfrastructureLayer:
InfrastructureLayer
"""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``nodes`` → ComputingNode [0..*]
* ``generators`` → ComputingNodeGenerator [0..*]
* ``storages`` → Storage [0..*]
* ``faas`` → FunctionAsAService [0..*]
* ``credentials`` → Credentials [0..*]
* ``groups`` → ComputingGroup [0..*]
* ``securityGroups`` → SecurityGroup [0..*]
* ``networks`` → Network [0..*]
* ``rules`` → MonitoringRule [0..*]
.. _v2.2.1_infrastructure_InternetGateway:
InternetGateway
"""""""""""""""
*Inherits from* :ref:`NetworkInterface <v2.2.1_infrastructure_NetworkInterface>`
* Attributes:
* ``address`` [String]
.. _v2.2.1_infrastructure_Location:
Location
""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Attributes:
* ``region`` [String]
* ``zone`` [String]
.. _v2.2.1_infrastructure_MonitoringRule:
MonitoringRule
""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Attributes:
* ``condition`` [String]
* ``strategy`` [String]
* ``strategyConfigurationString`` [String]
.. _v2.2.1_infrastructure_Network:
Network
"""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``connectedIfaces`` → NetworkInterface [0..*]
* ``gateways`` → InternetGateway [0..*]
* ``subnets`` → Subnet [0..*]
* Attributes:
* ``protocol`` [String]
* ``addressRange`` [String]
* ``cidr`` [Integer]
.. _v2.2.1_infrastructure_NetworkInterface:
NetworkInterface
""""""""""""""""
*Inherits from* :ref:`InfrastructureElement <v2.2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``belongsTo`` → Network [0..1]
* ``associated`` → SecurityGroup [0..1]
* Attributes:
* ``endPoint`` [Integer]
* ``speed`` [String]
.. _v2.2.1_infrastructure_PhysicalComputingNode:
PhysicalComputingNode
"""""""""""""""""""""
*Inherits from* :ref:`ComputingNode <v2.2.1_infrastructure_ComputingNode>`
.. _v2.2.1_infrastructure_Rule:
Rule
""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Attributes:
* ``kind`` [String]
* ``protocol`` [String]
* ``fromPort`` [Integer]
* ``toPort`` [Integer]
* ``cidr`` [String]
.. _v2.2.1_infrastructure_SecurityGroup:
SecurityGroup
"""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``rules`` → Rule [0..*]
* ``ifaces`` → NetworkInterface [0..*]
.. _v2.2.1_infrastructure_Storage:
Storage
"""""""
*Inherits from* :ref:`InfrastructureElement <v2.2.1_infrastructure_InfrastructureElement>`
* Associations:
* ``ifaces`` → NetworkInterface [0..*]
* Attributes:
* ``label`` [String]
* ``size_gb`` [Integer]
* ``cost`` [Integer]
.. _v2.2.1_infrastructure_Subnet:
Subnet
""""""
*Inherits from* :ref:`Network <v2.2.1_infrastructure_Network>`
* Associations:
* ``connectedTo`` → Network [0..*]
.. _v2.2.1_infrastructure_Swarm:
Swarm
"""""
*Inherits from* :ref:`ComputingGroup <v2.2.1_infrastructure_ComputingGroup>`
* Associations:
* ``roles`` → SwarmRole [0..*]
.. _v2.2.1_infrastructure_SwarmRole:
SwarmRole
"""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``nodes`` → ComputingNode [0..*]
* Attributes:
* ``kind`` [String]
.. _v2.2.1_infrastructure_VMImage:
VMImage
"""""""
*Inherits from* :ref:`ComputingNodeGenerator <v2.2.1_infrastructure_ComputingNodeGenerator>`
* Associations:
* ``generatedVMs`` → VirtualMachine [0..*]
.. _v2.2.1_infrastructure_VirtualMachine:
VirtualMachine
""""""""""""""
*Inherits from* :ref:`ComputingNode <v2.2.1_infrastructure_ComputingNode>`
* Associations:
* ``generatedFrom`` → VMImage [0..1]
* Attributes:
* ``sizeDescription`` [String]
concrete
^^^^^^^^
.. _v2.2.1_concrete_ComputingGroup:
ComputingGroup
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → ComputingGroup [1..1]
.. _v2.2.1_concrete_ConcreteElement:
ConcreteElement
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``refs`` → ConcreteElement [0..*]
* Attributes:
* ``configurationScript`` [String]
* ``preexisting`` [Boolean]
.. _v2.2.1_concrete_ConcreteInfrastructure:
ConcreteInfrastructure
""""""""""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``providers`` → RuntimeProvider [0..*]
.. _v2.2.1_concrete_ContainerImage:
ContainerImage
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → ContainerImage [0..1]
.. _v2.2.1_concrete_FunctionAsAService:
FunctionAsAService
""""""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → FunctionAsAService [0..1]
.. _v2.2.1_concrete_GenericResource:
GenericResource
"""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Attributes:
* ``type`` [String]
* ``gname`` [String]
.. _v2.2.1_concrete_Network:
Network
"""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → Network [0..1]
.. _v2.2.1_concrete_RuntimeProvider:
RuntimeProvider
"""""""""""""""
*Inherits from* :ref:`DOMLElement <v2.2.1_commons_DOMLElement>`
* Associations:
* ``resources`` → GenericResource [0..*]
* ``vms`` → VirtualMachine [0..*]
* ``vmImages`` → VMImage [0..*]
* ``containerImages`` → ContainerImage [0..*]
* ``networks`` → Network [0..*]
* ``storages`` → Storage [0..*]
* ``faas`` → FunctionAsAService [0..*]
* ``group`` → ComputingGroup [0..*]
.. _v2.2.1_concrete_Storage:
Storage
"""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → Storage [0..1]
.. _v2.2.1_concrete_VMImage:
VMImage
"""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → VMImage [0..1]
.. _v2.2.1_concrete_VirtualMachine:
VirtualMachine
""""""""""""""
*Inherits from* :ref:`ConcreteElement <v2.2.1_concrete_ConcreteElement>`
* Associations:
* ``maps`` → VirtualMachine [0..1]
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment