ee84ba0b8f
1. Add dockerfile 2. Modify gunicorn config Change-Id: I99d233908b3f21e5e0a4cd739ee7702839a8fb46 |
||
---|---|---|
container | ||
docs/api | ||
etc | ||
libs | ||
skyline | ||
tools/git_config | ||
.dockerignore | ||
.flake8 | ||
.gitignore | ||
.gitmodules | ||
.gitreview | ||
.zuul.yaml | ||
LICENSE | ||
Makefile | ||
README-zh_CN.md | ||
README.md | ||
alembic.ini | ||
mypy.ini | ||
poetry.lock | ||
poetry.toml | ||
pyproject.toml |
README.md
Skyline API
English | 简体中文
Quick Start
Dependent tools
- make >= 3.82
- poetry >= 1.1.0 (Installation Guide)
Development mode
Support Linux & Mac OS (Recommend Linux OS) (Because uvloop & cython)
-
Installing dependency packages
make install
-
Set skyline.yaml config file
Maybe you should change the params with your real environment as followed:
- database_url (you can set sqlite:////tmp/skyline.db to use sqlite) - default_region - keystone_url - system_project - system_project_domain - system_user_domain - system_user_name - system_user_password
cp etc/skyline.yaml.sample etc/skyline.yaml export OS_CONFIG_DIR=$(pwd)/etc
-
Init skyline database
make db_sync
-
Run server
$ poetry run uvicorn --reload --reload-dir libs/skyline-apiserver/skyline_apiserver --port 28000 --log-level debug skyline_apiserver.main:app INFO: Uvicorn running on http://127.0.0.1:28000 (Press CTRL+C to quit) INFO: Started reloader process [154033] using statreload INFO: Started server process [154037] INFO: Waiting for application startup. INFO: Application startup complete.
You can now access the online API documentation: http://127.0.0.1:28000/docs