API === On this page ------------ * :ref:`intro_api` * :ref:`oasis_api` * :ref:`deployment_api` * :ref:`links_api` | .. _intro_api: Introduction: ************* An evaluation version of the Oasis platform and using can be deployed using the `Oasis evaluation repository `_. This includes a Jupyter notebook that illustrates the basic operation of the API, using the Python API client. The interactive API schema references are: * :doc:`platform_v2` — the current Platform v2 REST API * :doc:`platform_v1` — the legacy Platform v1 REST API This is useful for more technical users who are looking to create their own UI or integrate Oasis with an existing system. Each page renders the full OpenAPI schema with descriptions and examples. | .. _oasis_api: Oasis API ********* The Oasis Platform release now includes a full API for operating catastrophe models and a general consolidation of the platform architecture. Windows SQL server is no longer a strict requirement. The platform can be run via docker containers on a single machine or, if required, scaled up to run on a cluster. Docker support is the main requirement for running the platform. A Linux based installation is the main focus of this example deployment. Running the install script from this repository automates install process of the OasisPlatform API v1, User Interface and example PiWind model. The **Oasis API** is the components of the Oasis platform that manages all the elements of the plaform that are required to build, run, and test models. The diagram below shows how the **Oasis API** sits behind the :doc:`/explanation/Oasis-UI`, that you use to operate your catastrophe models. *Oasis docker componets*: | .. image:: /_static/images/platform/oasis_containers.png :width: 600 :align: center :alt: Oasis docker componets | .. _deployment_api: API deployment in the Oasis Enterprise Platform *********************************************** The **Oasis Enterprise Platform** is an open source `Kubernetes `_ based, cloud computing cluster, which is deployable in `Microsoft Azure `_ via `Helm charts `_ and `Bicep scripts `_ to setup the Azure cloud services. The diagram below sets out the **Oasis Enterprise Platform** architecture: .. image:: /_static/images/platform/diag_oasis_components.png :width: 600 :align: center :alt: Oasis Enterprise Platform Architecture | .. _links_api: Links for further information ***************************** There is more information availible in the `Oasis GitHub `_. This includes detailed walkthorughs on: | 1. Oasis implementation of `Microsoft Azure `_. This guide takes you through the `requirements `_ for using this platform, how to `setup the enviroment `_, how to `use the platform `_, how to `manage resource groups `_, `deployment without the pipeline `_, `securing the plaform `_, `troubleshooting `_, and it answers some additional `questions about the design `_. More information can be found `here `__. | 2. How to implement `Kubernetes `_. This guide takes you through `requirements `_, how to `build images `_, a `quick start `_ tutorial, how to `access the user interfaces `_, and introduction to `helm and customisation `_, `chart details `_, and `keycloak `_, and how to access `help scripts `_. More information can be found `here `__. | 3. How to deploy and manage the Oasis platform on a `Kubernetes `_ cluster. More information can be found `here `__. | 4. Oasis Worker Controller. This application controls the number of workers in a kubernetes cluster based on analyses currently running, worker deployments available and autoscaling configuration for each worker deployment. More information can be found `here `__.