Server for storing service settings. Together with the client, it allows you to change application settings at runtime.
Table of contents:
This application is responsible for storing settings and providing an API for the client library. If you want to see the api of this service, follow the link after starting the service. Swagger will be available there.
It's very important for understanding who created / changed some settings when a team has the ability to change application settings in real time. Therefore, the database implements logging of all changes to the setting table. You can see them in the setting_history table. The logs contain information about users who made changes and when changes were made.
At the moment, WEB UI is not implemented, so now you need to edit the description of variables directly in the service database. You can do this in the settings table.
An example of a request to create a variable that will be used in some-service-name service:
INSERT INTO setting(name, value, value_type, service_name)
VALUES ('timeout', '1', 'int', 'some-service-name');With the help of the client, this variable can be get like this:
source = ConfigServerSrc(host='http://127.0.0.1:8080', service_name='some-service-name')
config = await RuntimeConfig.create(init_settings={}, source=source)
print(config.get('timeout'))If you want to change the value of a nested variable, then use the following query:
INSERT INTO setting(name, value, value_type, service_name)
VALUES ('db__timeout', '1', 'int', 'some-service-name');With the help of the client, this variable can be get like this:
source = ConfigServerSrc(host='http://127.0.0.1:8080', service_name='some-service-name')
config = await RuntimeConfig.create(init_settings={'db': {'timeout': 10}}, source=source)
print(config.db['timeout'])Available variable types:
- str
- int
- bool
- null
- json
docker-compose
-
Create a
.envfile with the necessary environment variables. An example of an.envfile can be found in.env.example. -
Copy docker-compose.yml.
-
Start the service and its dependencies.
docker compose up
Other
-
Define all environment variables necessary for the service to work. You can find them in
.env.example. -
Select a docker image with the latest version of the application. You can find docker images here.
-
Deploy postgres.
-
Apply all migrations to postgres. Run the following
alembic upgrade headcommand inside the docker image. -
Run the selected docker image. When starting, you need to pass the
serveargument, which means that the web application will be launched to process requests from client libraries.
An example command for building a docker image with an application of version 0.1.0
ver=0.1.0 make build-img
-
Install brew.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -
Add to
~/.zshrcand reopen console.# brew eval "$(/opt/homebrew/bin/brew shellenv)" export HOMEBREW_NO_ANALYTICS=1 # poetry export PATH="$HOME/.local/bin:$PATH" # pyenv export PYENV_ROOT="$HOME/.pyenv" export PATH="$PYENV_ROOT/bin:$PATH" eval "$(pyenv init --path)" # direnv eval "$(direnv hook zsh)" # Generates flags necessary for building from source C libraries export LDFLAGS="" export CPPFLAGS="" export PKG_CONFIG_PATH="" pkgs=(curl readline sqlite) for pkg in $pkgs; do pkg_dir="$HOMEBREW_PREFIX/opt/$pkg" lib_dir="$pkg_dir/lib" if [ -d "$lib_dir" ]; then export LDFLAGS="$LDFLAGS -L$lib_dir" fi include_dir="$pkg_dir/include" if [ -d "$include_dir" ]; then export CPPFLAGS="$CPPFLAGS -I$include_dir" fi pkg_config_dir="$lib_dir/pkgconfig" if [ -d "$pkg_config_dir" ]; then if [ "x$PKG_CONFIG_PATH" = "x" ]; then export PKG_CONFIG_PATH="$pkg_config_dir" else export PKG_CONFIG_PATH="PKG_CONFIG_PATH:$pkg_config_dir" fi fi done -
Install required software.
brew install wget direnv postgresql openssl [email protected] xz curl https://pyenv.run | bashbrew install --cask dockercurl -sSL https://install.python-poetry.org | python3.9 - poetry config virtualenvs.create falsepyenv install 3.10.8 -
Disable background postgres service.
/opt/homebrew/opt/postgresql/bin/postgres -D /opt/homebrew/var/postgres -
Create configuration files. After creating the .env file, set the variables in it to the values you need.
cp ./env.example ./.env cp ./envrc.example ./.envrc -
Reopen console and run
direnv allow. After executing this command, a virtual environment for python will be created. -
Install requirements.
poetry install -
Run tests to make sure the environment has been set up correctly.
make tests
-
Start postgres
docker compose -f docker-compose.dev.yml up db -
Run migrations
make migrate -
Start the service
python ./src/runtime_config/cli.py serve --reload
make up
The automatic generation of the migration is done by the following command (you need to be careful and check what was generated):
alembic revision --autogenerate -m <description>
Applying all migrations:
alembic upgrade head
Downgrade last migration:
alembic downgrade -1
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent