Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update service for production #8

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 12 additions & 7 deletions .github/workflows/workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
if: ${{ vars.RUN_CICD == 'true' }}
steps:
- name: Clone repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Lint Python app
uses: swiss-ai-center/common-code/.github/actions/lint-python-app@main
Expand All @@ -78,7 +78,7 @@ jobs:
if: ${{ vars.RUN_CICD == 'true' }}
steps:
- name: Clone repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Test Python app
uses: swiss-ai-center/common-code/.github/actions/test-python-app@main
Expand All @@ -89,10 +89,10 @@ jobs:
release:
needs: test
runs-on: ubuntu-latest
if: ${{ vars.RUN_CICD == 'true' && success() && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/prod') && (vars.DEPLOY_DEV == 'true' || vars.DEPLOY_PROD == 'true') }}
if: ${{ vars.RUN_CICD == 'true' && success() && github.ref == 'refs/heads/main' && (vars.DEPLOY_DEV == 'true' || vars.DEPLOY_PROD == 'true') }}
steps:
- name: Clone repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Build and push Docker image to GitHub
id: build-and-push-docker-image-to-github
Expand All @@ -111,7 +111,7 @@ jobs:
if: ${{ vars.RUN_CICD == 'true' && success() && github.ref == 'refs/heads/main' && vars.DEPLOY_DEV == 'true' }}
steps:
- name: Clone repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Get service Docker image SHA tag
shell: bash
Expand All @@ -134,6 +134,11 @@ jobs:
engine-announce-retries: ${{ env.DEV_ENGINE_ANNOUNCE_RETRIES }}
engine-announce-retry-delay: ${{ env.DEV_ENGINE_ANNOUNCE_RETRY_DELAY }}

- name: Remove unnecessary keys from configuration files
uses: swiss-ai-center/common-code/.github/actions/remove-unnecessary-keys-from-kubernetes-configuration-files@main
with:
configuration-files-location: ./kubernetes

- name: Deploy service on the Kubernetes cluster
uses: swiss-ai-center/common-code/.github/actions/execute-command-on-kubernetes-cluster@main
with:
Expand All @@ -150,10 +155,10 @@ jobs:
deploy-prod:
needs: release
runs-on: ubuntu-latest
if: ${{ vars.RUN_CICD == 'true' && success() && github.ref == 'refs/heads/prod' && vars.DEPLOY_PROD == 'true' }}
if: ${{ vars.RUN_CICD == 'true' && success() && github.ref == 'refs/heads/main' && vars.DEPLOY_PROD == 'true' }}
steps:
- name: Clone repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Get service Docker image SHA tag
shell: bash
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Base image
FROM python:3.10
FROM python:3.11

# Install all required packages to run the model
# TODO: 1. Add any additional packages required to run your model
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ some categories and as there is simply a larger cardinality in the number of cla

1. Create and activate the virtual environment:
```sh
python3.10 -m venv .venv
python3.11 -m venv .venv
source .venv/bin/activate
```

Expand Down
2 changes: 1 addition & 1 deletion development.Dockerfile
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Base image
FROM python:3.10
FROM python:3.11
4 changes: 3 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ services:
echo '.venv exists and is not empty';
else
echo '.venv does not exist or is empty';
python3.10 -m venv .venv;
python3.11 -m venv .venv;
fi &&
# Activate the virtual environment
source .venv/bin/activate &&
Expand All @@ -23,6 +23,8 @@ services:
environment:
- ENGINE_URLS=["http://host.docker.internal:8080"]
- SERVICE_URL=http://host.docker.internal:${SERVICE_PORT}
extra_hosts:
- "host.docker.internal:host-gateway"
ports:
- ${SERVICE_PORT}:9090
working_dir: /workspaces/service
Expand Down
25 changes: 14 additions & 11 deletions kubernetes/ingress.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,23 @@ kind: Ingress
metadata:
name: my-service-ingress
annotations:
cert-manager.io/issuer: "letsencrypt"
nginx.ingress.kubernetes.io/proxy-body-size: "16m"
nginx.org/client-max-body-size: "16m"
spec:
ingressClassName: nginx
rules:
- host: my-service.example.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: my-service-service
port:
number: 80
- host: my-service.example.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: my-service-service
port:
number: 80
tls:
- hosts:
- my-service.example.com
- my-service.example.com
secretName: my-service-example-com-tls-cert
116 changes: 56 additions & 60 deletions requirements-all.txt
Original file line number Diff line number Diff line change
@@ -1,88 +1,84 @@
absl-py==2.1.0
aiobotocore==2.4.1
aiofiles==22.1.0
aiohttp==3.9.1
aiobotocore==2.12.1
aiofiles==23.2.1
aiohttp==3.9.3
aioitertools==0.11.0
aiosignal==1.3.1
annotated-types==0.6.0
anyio==4.2.0
anyio==4.3.0
astunparse==1.6.3
async-timeout==4.0.3
attrs==23.2.0
botocore==1.27.59
cachetools==5.3.2
certifi==2023.11.17
botocore==1.34.51
certifi==2024.2.2
charset-normalizer==3.3.2
click==8.1.7
coverage==7.4.0
dnspython==2.5.0
email-validator==2.1.0.post1
exceptiongroup==1.2.0
fastapi==0.108.0
flake8==5.0.4
flatbuffers==23.5.26
coverage==7.4.4
dnspython==2.6.1
email_validator==2.1.1
fastapi==0.110.0
flake8==7.0.0
flatbuffers==24.3.25
frozenlist==1.4.1
gast==0.5.4
google-auth==2.26.2
google-auth-oauthlib==1.2.0
google-pasta==0.2.0
grpcio==1.60.0
grpcio==1.62.1
h11==0.14.0
h5py==3.10.0
httpcore==0.16.3
httpx==0.23.1
httpcore==1.0.4
httpx==0.27.0
idna==3.6
ImageHash==4.3.1
iniconfig==2.0.0
jmespath==1.0.1
keras==2.15.0
libclang==16.0.6
Markdown==3.5.2
MarkupSafe==2.1.4
keras==3.1.1
libclang==18.1.1
Markdown==3.6
markdown-it-py==3.0.0
MarkupSafe==2.1.5
mccabe==0.7.0
ml-dtypes==0.2.0
multidict==6.0.4
numpy==1.26.3
oauthlib==3.2.2
mdurl==0.1.2
ml-dtypes==0.3.2
multidict==6.0.5
namex==0.0.7
numpy==1.26.4
opt-einsum==3.3.0
packaging==23.2
optree==0.11.0
packaging==24.0
pillow==10.2.0
pip==24.0
pip-chill==1.0.3
pluggy==1.3.0
protobuf==4.23.4
pyasn1==0.5.1
pyasn1-modules==0.3.0
pycodestyle==2.9.1
pydantic==2.5.3
pydantic-settings==2.1.0
pydantic_core==2.14.6
pyflakes==2.5.0
pytest==7.2.0
pytest-asyncio==0.20.3
pytest-cov==4.0.0
pytest-httpserver==1.0.6
python-dateutil==2.8.2
python-dotenv==0.21.0
pluggy==1.4.0
protobuf==4.25.3
pycodestyle==2.11.1
pydantic==2.6.4
pydantic-settings==2.2.1
pydantic_core==2.16.3
pyflakes==3.2.0
Pygments==2.17.2
pytest==8.1.1
pytest-asyncio==0.23.5.post1
pytest-cov==4.1.0
pytest_httpserver==1.0.10
python-dateutil==2.9.0.post0
python-dotenv==1.0.1
PyWavelets==1.5.0
PyYAML==6.0
PyYAML==6.0.1
requests==2.31.0
requests-oauthlib==1.3.1
rfc3986==1.5.0
rsa==4.9
rich==13.7.1
scipy==1.12.0
setuptools==65.5.0
six==1.16.0
sniffio==1.3.0
starlette==0.29.0
tensorboard==2.15.1
sniffio==1.3.1
starlette==0.36.3
tensorboard==2.16.2
tensorboard-data-server==0.7.2
tensorflow==2.15.0
tensorflow-estimator==2.15.0
tensorflow-io-gcs-filesystem==0.34.0
tensorflow==2.16.1
tensorflow-io-gcs-filesystem==0.36.0
termcolor==2.4.0
tomli==2.0.1
typing_extensions==4.9.0
urllib3==1.26.18
uvicorn==0.19.0
Werkzeug==2.3.6
wrapt==1.14.1
typing_extensions==4.10.0
urllib3==2.0.7
uvicorn==0.28.0
Werkzeug==3.0.1
wheel==0.43.0
wrapt==1.16.0
yarl==1.9.4
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
common-code[test] @ git+https://github.com/swiss-ai-center/common-code.git@main
imagehash==4.3.1
pip-chill==1.0.3
tensorflow==2.15.0
tensorflow==2.16.1
18 changes: 10 additions & 8 deletions tests/test_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def unreachable_engine_instance_fixture(httpserver: HTTPServer):
def app_with_reachable_engine_instance(reachable_engine_instance: HTTPServer):
def get_settings_override():
settings = get_settings()
settings.engine_urls = reachable_engine_instance.url_for("")
settings.engine_urls = [reachable_engine_instance.url_for("")]
settings.engine_announce_retries = 2
settings.engine_announce_retry_delay = 1
settings.max_tasks = 2
Expand All @@ -83,7 +83,7 @@ def get_settings_override():
def app_with_unreachable_engine_instance(unreachable_engine_instance: HTTPServer):
def get_settings_override():
settings = get_settings()
settings.engine_urls = unreachable_engine_instance.url_for("")
settings.engine_urls = [unreachable_engine_instance.url_for("")]
settings.engine_announce_retries = 2
settings.engine_announce_retry_delay = 1
settings.max_tasks = 2
Expand Down Expand Up @@ -111,10 +111,11 @@ def test_announce_to_reachable_engine(
# This is not a good way to test the app as any other warnings will make the test
# passes.
warning_logs_found = False
# for record in caplog.records:
# if record.levelname == "WARNING":
# warning_logs_found = True
# break
for record in caplog.records:
if record.levelname == "WARNING":
if "Failed to notify the engine" in record.message:
warning_logs_found = True
break

assert not warning_logs_found

Expand All @@ -134,8 +135,9 @@ def test_announce_to_unreachable_engine(
warning_logs_found = False
for record in caplog.records:
if record.levelname == "WARNING":
warning_logs_found = True
break
if "Failed to notify the engine" in record.message:
warning_logs_found = True
break

assert warning_logs_found

Expand Down
Loading