Automatic deployment on-prem from zip archives
Project description
Source Code: https://gitlab.com/fholmer/adop
License: BSD License
Summary
Automatic deployment on-prem from zip archives.
Warning
This is an alpha release. Not ready for production.
Docs
Not available yet. Scheduled for beta release.
Installation
Open command line and and install using pip:
> pip install adopUsage
adop is available as console script and library module
> adop -h
> python -m adop -hPrint general help
> adop -hHelp on serving rest api
> adop serve-api -hServe rest api on http://127.0.0.1:8000
> adop serve-apiFind the generated access token
Windows
> type work/adop.ini | findstr tokenLinux
$ cat work/adop.ini | grep token
Test rest api with curl
> curl -H "Token: paste-token-here" http://127.0.0.1:8000/api/v1/testUpload and deploy a zip-library:
> curl -H "Content-Type: application/zip" -H "Root: mylib" -H "Token: T" --data-binary @work/mylib.zip http://127.0.0.1:8000/api/v1/deploy/zipZip file layout
Zip files with exactly one root directory are valid and can be distributed. The root directory name must be unique if many zip files are to be distributed.
Example of a valid zip file layout:
/mylib
/README.rst
/main.py
/mypackage1
/__init__.py
/__main__.py
/mypackage2
/__init__.py
/__main__.pyFollowing layout is not valid:
/README.rst
/mylib1
/__init__.py
/__main__.py
/mylib2
/__init__.py
/__main__.pyAPI
Description |
result |
method |
endpoint |
|---|---|---|---|
Check that the API is up |
json |
GET |
/api/v1/test |
Sha sum for all deployed zipfiles |
json |
GET |
/api/v1/state |
Sha sum for given deployed root |
json |
GET |
/api/v1/state/<root> |
Start auto-fetch routine if enabled |
json |
GET |
/api/v1/trigger/fetch |
Download zipfile of given root |
zip |
GET |
/api/v1/download/zip/<root> |
Upload and deploy a zipfile |
json*1 |
POST |
/api/v1/deploy/zip |
Upload a zipfile without deploying it |
json*1 |
POST |
/api/v1/upload/zip |
Deploy a pre uploaded zip-file |
json*1 |
GET |
/api/v1/deploy/zip |
Zipfile unpacking progress |
json |
GET |
/api/v1/progress |
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
