From ff3fff7c379e221f3fd1d32f169e178575109da6 Mon Sep 17 00:00:00 2001 From: Artur Pedziwilk <artur.pedziwilk@id.ethz.ch> Date: Mon, 13 May 2024 20:03:41 +0200 Subject: [PATCH] rename openbis-server to openbis-app Signed-off-by: Artur Pedziwilk <artur.pedziwilk@id.ethz.ch> --- .../docker/environments.md | 19 +++++------------- .../system-documentation/docker/quickstart.md | 4 ++-- .../docker/release-cycle.md | 2 +- docs/system-documentation/docker/usage.md | 20 +++++++++---------- 4 files changed, 18 insertions(+), 27 deletions(-) diff --git a/docs/system-documentation/docker/environments.md b/docs/system-documentation/docker/environments.md index 2c0c7ddc423..cf387808d17 100644 --- a/docs/system-documentation/docker/environments.md +++ b/docs/system-documentation/docker/environments.md @@ -1,21 +1,12 @@ # Environments -## Production +## Production, testing and development -### openbis-server - https://hub.docker.com/r/openbis/openbis-server +### openbis-app - https://hub.docker.com/r/openbis/openbis-server  -The **openbis-server** image is designed and supported for deploying openBIS in production. +The **openbis-app** image is designed and supported for deploying openBIS in production, testing and development environments. The openBIS service running in container named **openbis-app** can be connected to a [containerized PostgreSQL database](usage.md) or to any managed or cloud-native PostgreSQL service. -A reverse HTTP proxy is required in front, which can be also [set up as a container](usage.md), as an independent ingress controller, or as a cloud-based content delivery service. -We recommend to orchestrate all containers using Docker Compose, for which we're providing [examples](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/tree/master/hub/openbis-server/compose) to use as a template. - - -## Development - -### debian-openbis - https://hub.docker.com/r/openbis/debian-openbis - - - -For deveoplment purposes, it is possible to follow the production setup outlined above. To ease up development, rapid testing and debugging, we recommend to use the **debian-openbis** image, which provides an all-in-one container. Note that this setup is **not** optimized for persisting data, and should not be used for running services in production. +A reverse HTTP proxy is required in front. It can be [set up as a container](usage.md), as an independent ingress controller, or as a cloud-based content delivery service. +We recommend to orchestrate all containers using Docker Compose, for which we're providing [examples](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/tree/master/hub/openbis-app/compose) to use as a template. diff --git a/docs/system-documentation/docker/quickstart.md b/docs/system-documentation/docker/quickstart.md index 3942cfcef55..7975b68ade1 100644 --- a/docs/system-documentation/docker/quickstart.md +++ b/docs/system-documentation/docker/quickstart.md @@ -40,10 +40,10 @@ $ docker run --detach \ -e OPENBIS_HOME="/home/openbis" \ -e OPENBIS_LOG="/var/log/openbis" \ -e OPENBIS_FQDN="local.openbis.ch" \ - openbis/openbis-server:latest; + openbis/openbis-app:20.10.7; ``` -Run ingress container. +Run local ingress container. ``` $ docker run --detach \ --name openbis-ingress \ diff --git a/docs/system-documentation/docker/release-cycle.md b/docs/system-documentation/docker/release-cycle.md index 0fbbcfd9cb4..04173a04fc3 100644 --- a/docs/system-documentation/docker/release-cycle.md +++ b/docs/system-documentation/docker/release-cycle.md @@ -1,3 +1,3 @@ # Release Cycle -The official **openbis-server** images available on [Docker Hub](https://hub.docker.com/r/openbis/) are tagged by major release published on the [openBIS download page](https://unlimited.ethz.ch/display/openbis/Production+Releases) with the latest bugfix patches included. The official openBIS installation package is based on the latest official image of [Ubuntu LTS Linux](https://releases.ubuntu.com). In addition, all containers are rebuilt and republished at least on a monthly basis to include operating system patches. +The official **openbis-app** images available on [Docker Hub](https://hub.docker.com/r/openbis/) are tagged by major release published on the [openBIS download page](https://unlimited.ethz.ch/display/openbis/Production+Releases) with the latest bugfix patches included. The official openBIS installation package is based on the latest official image of [Ubuntu LTS Linux](https://releases.ubuntu.com). In addition, all containers are rebuilt and republished at least on a monthly basis to include operating system patches. diff --git a/docs/system-documentation/docker/usage.md b/docs/system-documentation/docker/usage.md index 2f05a0205a1..67f1072f9fa 100644 --- a/docs/system-documentation/docker/usage.md +++ b/docs/system-documentation/docker/usage.md @@ -11,8 +11,8 @@ Our recommendation is to run openBIS within a **three-container setup**, in part | Container | Image | Port | Description | | ----------|------ | ---- | ----------- | |`openbis-db`|`postgres15`|`5432/tcp`|PostgreSQL database listens on port 5432 and accepts connection from openbis-app.| -|`openbis-app`|`openbis-server`|`8080/tcp`|Java Virtual Machine with openBIS Application Server listens on port 8080.| -|`openbis-app`|`openbis-server`|`8081/tcp`|Java Virtual Machine with openBIS Data Store Server listens on port 8081.| +|`openbis-app`|`openbis-app`|`8080/tcp`|Java Virtual Machine with openBIS Application Server listens on port 8080.| +|`openbis-app`|`openbis-app`|`8081/tcp`|Java Virtual Machine with openBIS Data Store Server listens on port 8081.| |`openbis-ingress`|`apache2`|`443/tcp`|Apache HTTP server listens on port 443 and is configured as reverse proxy to ports 8080 and 8081.| @@ -20,7 +20,7 @@ Our recommendation is to run openBIS within a **three-container setup**, in part Docker Compose is a tool for defining and running multi-container applications. It simplifies the control of the entire openBIS service, making it easy to control the application workflow in a single, comprehensible YAML configuration file, allows to create, start and stop all services by issuing a single command. -We are providing a basic [docker-compose.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-server/compose/docker-compose.yml), which is ready to use. +We are providing a basic [docker-compose.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-app/compose/docker-compose.yml), which is ready to use. To run the application navigate to the sub-directory where you've downloaded the `docker-compose.yml` to and then execute ``` @@ -122,7 +122,7 @@ $ docker run --detach \ -e OPENBIS_HOME="/home/openbis" \ -e OPENBIS_LOG="/var/log/openbis" \ -e OPENBIS_FQDN="openbis.domain" \ - openbis/openbis-server:latest; + openbis/openbis-app:20.10.7; ``` The state of the running application container can be inspected by fetching the container logs: @@ -175,8 +175,8 @@ An **ingress container** acts as reverse proxy and performs Transport Layer Secu ### Nginx In order to use nginx as an ingress container, it is required to deploy the following files, as provided on our [source repository](source-repositories.md): -- [docker-compose-nginx.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-server/compose/docker-compose-nginx.yml) -- [nginx config](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-server/compose/nginx/my-nginx.conf), to be placed in sub-directory `nginx` +- [docker-compose-nginx.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-app/compose/docker-compose-nginx.yml) +- [nginx config](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-app/compose/nginx/my-nginx.conf), to be placed in sub-directory `nginx` To run the application, you need to: - have docker and docker-compose installed @@ -186,8 +186,8 @@ To run the application, you need to: ### Apache httpd In order to use apache-httpd as an ingress container, it is required to deploy the following files, as provided on our [source repository](source-repositories.md): -- [docker-compose-httpd.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-server/compose/docker-compose-httpd.yml) -- [apache-httpd config](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-server/compose/httpd/my-httpd.conf), to be placed in sub-directory `httpd` +- [docker-compose-httpd.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-app/compose/docker-compose-httpd.yml) +- [apache-httpd config](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-app/compose/httpd/my-httpd.conf), to be placed in sub-directory `httpd` To run the application, you need to: - have docker and docker-compose installed @@ -197,8 +197,8 @@ To run the application, you need to: ### HAProxy In order to use haproxy as an ingress container, it is required to deploy the following files, as provided on our [source repository](source-repositories.md): -- [docker-compose-haproxy.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-server/compose/docker-compose-haproxy.yml) -- [haproxy config](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-server/compose/haproxy/my-haproxy.conf), to be placed in sub-directory `haproxy` +- [docker-compose-haproxy.yml](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-app/compose/docker-compose-haproxy.yml) +- [haproxy config](https://sissource.ethz.ch/sispub/openbis-continuous-integration/-/blob/master/hub/openbis-app/compose/haproxy/my-haproxy.conf), to be placed in sub-directory `haproxy` To run the application, you need to: - have docker and docker-compose installed -- GitLab