Cloudkeeper-ONE

OpenStack backend for Cloudkeeper

What does Cloudkeeper-OS do?

Cloudkeeper-OS is able to manage OpenStack CMF - upload, update and remove images and templates representing EGI AppDB appliances. Cloudkeeper-OS runs as a server listening for gRPC communication usually from core Cloudkeeper component.

Requirements

TODO

Installation

From PyPi

TODO

From source (development only)

Installation from source should never be your first choice! However, if you wish to contribute to our project, this is the right way to start.

Development environment

Cloudkeeper-OS dependencies and packaging are managed via Poetry. Poetry has to be installed in order to install dependencies and run tests and linter checks.

To build and install the bleeding edge version from master

git clone git://github.com/the-cloudkeeper-project/cloudkeeper-os.git
cd cloudkeeper-os
poetry install
poetry run invoke test && poetry run invoke acceptance

Cloudkeeper-OS uses Invoke to run tests and linter checks. There are currently two tasks available:

• test - running tests
• acceptance - running various linters and security checks

If you want to know what exactly these tasks do, take a look at tasks.py.

Configuration

TODO

Usage

Start server ex.:

poetry run cloudkeeper-os --openstack-identity-endpoint=http://147.251.253.3/identity --openstack-auth-type=v3password --openstack-username=<name> --openstack-password=<password> --openstack-user-domain-name=default --openstack-project-name=demo --openstack-region-name=RegionOne -d

Contributing

1. Fork it ( https://github.com/the-cloudkeeper-project/cloudkeeper-os/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Acknowledgements

This work is co-funded by the EOSC-hub project (Horizon 2020) under Grant number 777536.