Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ USERS_SERVICE_SCHEME=http
USERS_SERVICE_HOST=badgerdoc-users
USERS_SERVICE_PORT=8080

### Veeva plugin configuration

VEEVA_VAULT_HOST=
VEEVA_VAULT_USERNAME=
VEEVA_VAULT_PASSWORD=


# Web configuration

WEB_CORS=*
Expand Down
7 changes: 5 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
_DOCKER_ ?= docker

# Build all microservices
build_all: build_base build_base_3.12 build_nginx build_annotation build_users build_jobs build_keycloak build_assets build_web build_processing build_taxonomy build_ml_server build_inference clean
build_all: build_base build_base_3.12 build_nginx build_annotation build_users build_jobs build_keycloak build_assets build_web build_processing build_taxonomy build_ml_server build_inference build_core clean

# Build only BadgerDoc microservices
build_badgerdoc: build_base build_base_3.12 build_annotation build_users build_jobs build_assets build_web build_processing build_taxonomy build_ml_server build_inference clean
build_badgerdoc: build_base build_base_3.12 build_annotation build_users build_jobs build_assets build_web build_processing build_taxonomy build_ml_server build_inference build_core clean

build_base:
mkdir -p build_dir
Expand Down Expand Up @@ -35,6 +35,9 @@ build_annotation:
build_users:
${_DOCKER_} build --target build users/ -t badgerdoc_users

build_core:
${_DOCKER_} build --target build core/ -t badgerdoc_core

build_processing:
${_DOCKER_} build --target build processing/ -t badgerdoc_processing

Expand Down
24 changes: 24 additions & 0 deletions core/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
ARG base_image=818863528939.dkr.ecr.eu-central-1.amazonaws.com/badgerdoc/python_base_3.12:0.2.0
FROM ${base_image} as build

WORKDIR /opt/core

COPY core ./core
COPY alembic alembic
COPY pyproject.toml poetry.lock version.txt alembic.ini ./

RUN : \
&& apt-get update \
&& apt-get install -y build-essential \
&& :

RUN : \
&& python3 -m pip install --upgrade pip \
&& pip install poetry>=1.7.1 \
&& poetry config virtualenvs.create false \
&& poetry install --no-root --only main \
&& :

CMD alembic upgrade head && uvicorn core.main:app --root-path $ROOT_PATH --host 0.0.0.0 --port 8080
EXPOSE 8080

119 changes: 119 additions & 0 deletions core/alembic.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# A generic, single database configuration.

[alembic]
# path to migration scripts
# Use forward slashes (/) also on windows to provide an os agnostic path
script_location = alembic

# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
# Uncomment the line below if you want the files to be prepended with date and time
# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
# for all available tokens
# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s

# sys.path path, will be prepended to sys.path if present.
# defaults to the current working directory.
prepend_sys_path = .

# timezone to use when rendering the date within the migration file
# as well as the filename.
# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
# Any required deps can installed by adding `alembic[tz]` to the pip requirements
# string value is passed to ZoneInfo()
# leave blank for localtime
# timezone =

# max length of characters to apply to the "slug" field
# truncate_slug_length = 40

# set to 'true' to run the environment during
# the 'revision' command, regardless of autogenerate
# revision_environment = false

# set to 'true' to allow .pyc and .pyo files without
# a source .py file to be detected as revisions in the
# versions/ directory
# sourceless = false

# version location specification; This defaults
# to .//versions. When using multiple version
# directories, initial revisions must be specified with --version-path.
# The path separator used here should be the separator specified by "version_path_separator" below.
# version_locations = %(here)s/bar:%(here)s/bat:.//versions

# version path separator; As mentioned above, this is the character used to split
# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
# Valid values for version_path_separator are:
#
# version_path_separator = :
# version_path_separator = ;
# version_path_separator = space
# version_path_separator = newline
#
# Use os.pathsep. Default configuration used for new projects.
version_path_separator = os

# set to 'true' to search source files recursively
# in each "version_locations" directory
# new in Alembic version 1.10
# recursive_version_locations = false

# the output encoding used when revision files
# are written from script.py.mako
# output_encoding = utf-8

# sqlalchemy.url = driver://user:pass@localhost/dbname


[post_write_hooks]
# post_write_hooks defines scripts or Python functions that are run
# on newly generated revision scripts. See the documentation for further
# detail and examples

# format using "black" - use the console_scripts runner, against the "black" entrypoint
# hooks = black
# black.type = console_scripts
# black.entrypoint = black
# black.options = -l 79 REVISION_SCRIPT_FILENAME

# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
# hooks = ruff
# ruff.type = exec
# ruff.executable = %(here)s/.venv/bin/ruff
# ruff.options = check --fix REVISION_SCRIPT_FILENAME

# Logging configuration
[loggers]
keys = root,sqlalchemy,alembic

[handlers]
keys = console

[formatters]
keys = generic

[logger_root]
level = WARNING
handlers = console
qualname =

[logger_sqlalchemy]
level = WARNING
handlers =
qualname = sqlalchemy.engine

[logger_alembic]
level = INFO
handlers =
qualname = alembic

[handler_console]
class = StreamHandler
args = (sys.stderr,)
level = NOTSET
formatter = generic

[formatter_generic]
format = %(levelname)-5.5s [%(name)s] %(message)s
datefmt = %H:%M:%S
1 change: 1 addition & 0 deletions core/alembic/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration.
94 changes: 94 additions & 0 deletions core/alembic/env.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
import os
from logging.config import fileConfig

from sqlalchemy import engine_from_config, pool

from alembic import context

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config

# Interpret the config file for Python logging.
# This line sets up loggers basically.
if config.config_file_name is not None:
fileConfig(config.config_file_name)

# add your model's MetaData object here
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
target_metadata = None

# other values from the config, defined by the needs of env.py,
# can be acquired:
# my_important_option = config.get_main_option("my_important_option")
# ... etc.

config.set_main_option(
"sqlalchemy.url",
"postgresql+psycopg2://{0}:{1}@{2}:{3}/{4}".format(
os.environ.get("POSTGRES_USER"),
os.environ.get("POSTGRES_PASSWORD"),
os.environ.get("POSTGRES_HOST"),
os.environ.get("POSTGRES_PORT"),
os.environ.get("POSTGRES_DB"),
),
)


def run_migrations_offline() -> None:
"""Run migrations in 'offline' mode.

This configures the context with just a URL
and not an Engine, though an Engine is acceptable
here as well. By skipping the Engine creation
we don't even need a DBAPI to be available.

Calls to context.execute() here emit the given string to the
script output.

"""
url = config.get_main_option("sqlalchemy.url")
context.configure(
url=url,
target_metadata=target_metadata,
literal_binds=True,
dialect_opts={"paramstyle": "named"},
compare_type=True,
version_table="alembic_revision_core",
)

with context.begin_transaction():
context.run_migrations()


def run_migrations_online() -> None:
"""Run migrations in 'online' mode.

In this scenario we need to create an Engine
and associate a connection with the context.

"""
connectable = engine_from_config(
config.get_section(config.config_ini_section, {}),
prefix="sqlalchemy.",
poolclass=pool.NullPool,
)

with connectable.connect() as connection:
context.configure(
connection=connection,
target_metadata=target_metadata,
compare_type=True,
version_table="alembic_revision_core",
)

with context.begin_transaction():
context.run_migrations()


if context.is_offline_mode():
run_migrations_offline()
else:
run_migrations_online()
28 changes: 28 additions & 0 deletions core/alembic/script.py.mako
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
"""${message}

Revision ID: ${up_revision}
Revises: ${down_revision | comma,n}
Create Date: ${create_date}

"""
from typing import Sequence, Union

from alembic import op
import sqlalchemy as sa
${imports if imports else ""}

# revision identifiers, used by Alembic.
revision: str = ${repr(up_revision)}
down_revision: Union[str, None] = ${repr(down_revision)}
branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}


def upgrade() -> None:
"""Upgrade schema."""
${upgrades if upgrades else "pass"}


def downgrade() -> None:
"""Downgrade schema."""
${downgrades if downgrades else "pass"}
51 changes: 51 additions & 0 deletions core/alembic/versions/378dee280325_.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
"""empty message

Revision ID: 378dee280325
Revises:
Create Date: 2025-06-05 15:51:15.939395

"""

from typing import Sequence, Union

import sqlalchemy as sa

from alembic import op

# revision identifiers, used by Alembic.
revision: str = "378dee280325"
down_revision: Union[str, None] = None
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:
"""Upgrade schema."""
op.create_table(
"core_plugins",
sa.Column("id", sa.Integer(), nullable=False, autoincrement=True),
sa.Column("tenant", sa.String(), nullable=False),
sa.Column("name", sa.String(32), nullable=False),
sa.Column("version", sa.String(16), nullable=False),
sa.Column("menu_name", sa.String(16), nullable=False),
sa.Column("description", sa.String(10_000), nullable=True),
sa.Column("url", sa.String(256), nullable=False),
sa.Column(
"is_iframe", sa.Boolean(), nullable=False, server_default="false"
),
sa.Column(
"is_autoinstalled",
sa.Boolean(),
nullable=False,
server_default="false",
),
sa.PrimaryKeyConstraint("id"),
sa.UniqueConstraint(
"name", "version", name="uq_core_plugins_name_version"
),
)


def downgrade() -> None:
"""Downgrade schema."""
op.drop_table("core_plugins")
32 changes: 32 additions & 0 deletions core/core/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import logging
import os

from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware

from core.routes import menus, plugins

ROOT_PATH = os.getenv("ROOT_PATH", "")
KEYCLOAK_SYSTEM_USER_SECRET = os.getenv("KEYCLOAK_SYSTEM_USER_SECRET", "")

with open("version.txt", "r") as f:
__version__ = f.read().strip()

app = FastAPI(title="core", root_path=ROOT_PATH, version=__version__)
logger = logging.getLogger(__name__)
logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))


KEYCLOAK_HOST = os.getenv("KEYCLOAK_HOST")

if WEB_CORS := os.getenv("WEB_CORS", ""):
app.add_middleware(
CORSMiddleware,
allow_origins=WEB_CORS.split(","),
allow_methods=["*"],
allow_headers=["*"],
)


app.include_router(menus.router)
app.include_router(plugins.router)
Loading
Loading