Go to file

Gao Hanxiang dfaf962aca feat: Add skyline-console to submodule When building a docker image, skyline-console is required, so add skyline-console as a git submodule. Change-Id: I429879dbfb93f48aacbe09966388f25a5afab43d		2021-07-19 02:46:39 +00:00
docs/api	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
etc	fix: Add sample yaml config file	2021-06-16 06:22:14 +00:00
libs	feat: Add skyline-console to submodule	2021-07-19 02:46:39 +00:00
src/skyline_apiserver	feat: Add skyline-config under libs	2021-07-07 16:14:11 +08:00
tests	refactor: Use __version__ instead of VERSION in constants	2021-07-01 15:26:43 +08:00
tools/git_config	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
.dockerignore	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
.flake8	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
.gitignore	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
.gitmodules	feat: Add skyline-console to submodule	2021-07-19 02:46:39 +00:00
.gitreview	Added .gitreview	2021-05-08 17:14:30 +00:00
.zuul.yaml	Add Zuul support for new repository	2021-05-10 12:47:51 +02:00
alembic.ini	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
LICENSE	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
Makefile	feat: Add skyline-config under libs	2021-07-07 16:14:11 +08:00
mypy.ini	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
poetry.lock	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
poetry.toml	feat: Add initial code of skyline-apiserver	2021-06-01 23:39:57 +08:00
pyproject.toml	feat: Add skyline-config under libs	2021-07-07 16:14:11 +08:00
README-zh_CN.md	fix: Add sample yaml config file	2021-06-16 06:22:14 +00:00
README.md	fix: Add sample yaml config file	2021-06-16 06:22:14 +00:00

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-apiserver.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-apiserver.yaml.sample etc/skyline-apiserver.yaml
export OS_CONFIG_DIR=$(pwd)/etc

Init skyline database
```
make db_sync
```

Run server

$ poetry run uvicorn --reload --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