-
Notifications
You must be signed in to change notification settings - Fork 8
Home
Welcome to the OpenRiskNet wiki!
This is the main resource for developer documentation in the OpenRiskNet project.
This type of support is available on OpenRiskNet Helpdesk
The OpenRiskNet VRE is based on OpenShift OKD, a community distribution of Kubernetes that powers RedHat OpenShift.
As well as the community (open source) distribution, RedHat offer subscription-based services of the platform, described here.
Currently the OpenRiskNet project has production and development clusters of OpenShift, running as a courtesy on the Swedish Science Cloud (SCC) in the UPPMAX and HPC2N regions with the consoles available at the following URLs: -
These clusters were crafted by hand using the OpenShift installation guide and related Ansible playbooks but for future VREs the formation of the cluster has been encapsulated by the OpenRiskNet OKD Orchestrator, a convenient utility designed to simplify the creation of OpenShift OKD compute environments.
The OKD Orchestrator allows you to define the topology of your cluster using deployment configurations that are designed to simplify and automate cluster formation. The configurations are YAML files that the orchestrator interprets, uses to create your compute instances and deploy and finally configure OpenShift OKD v3.11.
The orchestrator contains two example cluster definitions and initial support for AWS and Bare Metal cluster hardware. Comprehensive documentation can be found in the repository's GitHib Pages.
OpenRiskNet applications are deployed into the VRE using container images that are managed by OpenShift YAML-based template files that describe the application's Pod (container image) its Services (and external Routes if required) and any persistent storage.
Eventually services should be installed using either the Template Broker (TSB) or Ansible Broker (ASB). For the time-being applications are deployed by individual groups using their own template files.
- Working with Docker
- Working with OpenShift, including a suite of Recipes for getting started, different types of OpenShift Environments, and various Deployments, which are infrastructure or end-user applications that can be deployed to an OpenRiskNet Virtual Research Environment (VRE).
- CI-CD-environment: Description of the Continuous Integration / Continuous Deployment environment
- Development-Guidelines
- Glossary of the terms used in the project
- Tips-and-tricks
OpenRiskNet is defining a mechanism for describing services and data that facilitates inter-operability between services deployed to an OpenRiskNet VRE. The mechanism for this is to:
- Define OpenAPI 3.0 (previously known as Swagger) descriptors for REST web services, supplemented with JSON-LD annotations that enhance those ontological descriptions with semantic meaning.
- Annotate your service's and/or route's OpenShift deployment template with annotations that describes it as an OpenRiskNet compliant service which will result in it being recognised by the OpenRiskNet registry, incorporated into the list of available services and being searchable with semantic queries (e.g. for services that generate a particular type of output).
- Writing OpenAPI and JSON-LD descriptors
- Annotating your service to make it discoverable
- Annotating API to make it queryable
This work is described in the following deliverable reports to the EU:
- D2.1 - Development infrastructure online
- D2.2 - Initial API version provided to providers of services.
- D2.3 - Report on deployment of virtual infrastructures with service discovery and container orchestration
- D2.4 - Final API available for internal and external service providers. Note: this report is not yet approved and only available to project members.