The Observatory Static Data Services is the server component of the Observatory Support Tools. It provides the web services used by the OSO tools such as PPT and ODT.The idea of OSD is to provide a single source of truth that is used to configure the science domain behavior of each tool.
To clone this repository, run
git clone --recurse-submodules git@gitlab.com:ska-telescope/ost/ska-ost-osd.git
To refresh the GitLab Submodule, execute below commands:
git submodule update --recursive --remote
git submodule update --init --recursive
Install dependencies with Poetry and activate the virtual environment
poetry install
poetry shell
To build a new Docker image for the OSD, run
make oci-build
Execute the test suite and lint the project with:
make python-test
make python-lint
To run a helm chart unit tests to verify helm chart configuration:
helm plugin install https://github.com/helm-unittest/helm-unittest.git
make k8s-chart-test
Install the Helm umbrella chart into a Kubernetes cluster with ingress enabled:
make k8s-install-chart
The Swagger UI should be available external to the cluster at `http://<KUBE_HOST>/<KUBE_NAMESPACE>/osd/api/<MAJOR_VERSION>/ui/ and the API accesible via the same URL.
If using minikube, KUBE_HOST can be found by running minikube ip.
KUBE_NAMESPACE is the namespace the chart was deployed to, likely ska-ost-osd
To uninstall the chart, run
make k8s-uninstall-chart
This is a very crucial part for OSD, without this some functionality may break and exceptions and errors will be raised.
Failing to run this command before releasing a new version may cause test cases to fail. This command ensures all necessary pre-release checks and configurations are properly set up.
Run Below command from Command line.
make osd-pre-release
There are 3 different environments which are defined through the standard pipeline templates. They need to be manually triggered in the Gitlab UI.
dev- a temporary (4 hours) deployment from a feature branch, using the artefacts built in the branch pipelineintegration- a permanent deployment from the main branch, using the latest version of the artefacts built in the main pipelinestaging- a permanent deployment of the latest published artefact from CAR
To find the URL for the environment, see the 'info' job of the CICD pipeline stage, which should output the URL alongside the status of the Kubernetes pods.
Generally the API URL should be available at https://k8s.stfc.skao.int/$KUBE_NAMESPACE/osd/api/v1
To start the Flask server run the following command in a terminal bash prompt
python src/ska_ost_osd/rest/wsgi.py
Alternatively use the following command
make rest
To turn semantic validation off/on in real-time user need to create environment variable into helm charts. This will allow user to control semantic validation in real-time.
The purpose of this environment variable, is likely to control whether semantic validation should be performed in the program. By using an environment variable, the behavior can be easily changed without modifying the code itself, which is useful for different deployment environments or testing scenarios.
Setting the environment variable:
from os import environ
VALIDATION_STRICTNESS = environ.get("VALIDATION_STRICTNESS", "2")
User can turn off the semantic validation by running below command.
export VALIDATION_STRICTNESS="1"
Add the validation_strictness environment variable into values.yaml file in your chart directory
This allows users to configure the value when installing or upgrading the chart.
validation_strictness: 2
Add path of environment variable into environment.yaml file.
VALIDATION_STRICTNESS: {{.Values.validation_strictness | quote }}
Install charts
make k8s-install-chart
Documentation can be found in the docs folder. To build docs, install the
documentation specific requirements:
pip3 install sphinx sphinx-rtd-theme recommonmark sphinxcontrib-openapi mistune==0.8.4
and build the documentation (will be built in docs/build folder) with
make docs-build html