Skip to content

Commit

Permalink
Deployed 18e8338 to v3.2 with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
ci-bot committed Nov 15, 2024
1 parent f5f1fdc commit 12a2674
Show file tree
Hide file tree
Showing 31 changed files with 225 additions and 218 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
#!/bin/sh

apk update && apk add chromium

npm run test
3 changes: 3 additions & 0 deletions v3.2/entrypoints/npm_tests.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/sh

npm run test
9 changes: 4 additions & 5 deletions v3.2/entrypoints/setup_git.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ then
DEFAULT_BRANCH=$(git remote show origin | sed -n '/HEAD branch/s/.*: //p')
git reset --hard origin/"${DEFAULT_BRANCH}"
git clean -fd
fi
if [ -n "${TAG}" ] && [ "${TAG}" != "$(git describe --tags)" ]
then
git stash
git checkout "${TAG}"
if [ -n "${TAG}" ]
then
git checkout "${TAG}"
fi
fi
158 changes: 98 additions & 60 deletions v3.2/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion v3.2/search/search_index.json

Large diffs are not rendered by default.

13 changes: 0 additions & 13 deletions v3.2/services/backend/compose.dev.yaml

This file was deleted.

1 change: 0 additions & 1 deletion v3.2/services/backend/compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ include:
- services/${BE_VERSION:-v4}/compose.yaml
- .${LDAP_ENABLED:+/services/${BE_VERSION:-v4}/}compose.ldap.yaml
- .${OIDC_ENABLED:+/services/${BE_VERSION:-v4}/}compose.oidc.yaml
- .${DEV:+/}compose.dev.yaml
8 changes: 4 additions & 4 deletions v3.2/services/backend/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -826,19 +826,19 @@ <h2 id="enable-additional-features">
</p>
<p>
Setting the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/.env">
BACKEND_HTTPS_URL and OIDC_ENABLED env variables
</a>
requires changing the OIDC configuration, either in the v3
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/compose.oidc.yaml">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/compose.oidc.yaml">
compose.oidc.yaml
</a>
and
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/providers.oidc.json">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/providers.oidc.json">
providers.oidc.json
</a>
, or the v4
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v4/config/.oidc.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v4/config/.oidc.env">
env file
</a>
.
Expand Down
10 changes: 5 additions & 5 deletions v3.2/services/backend/services/keycloak/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -814,11 +814,11 @@ <h2 id="configuration-options">
</h2>
<p>
The Keycloak configuration is set by the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/keycloak/config/.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/keycloak/config/.env">
.env file
</a>
and the realm created is in
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/keycloak/config/facility-realm.json">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/keycloak/config/facility-realm.json">
facility-realm.json file
</a>
.
Expand All @@ -842,7 +842,7 @@ <h2 id="default-configuration">
</h2>
<p>
The default configuration
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/keycloak/config/.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/keycloak/config/.env">
.env file
</a>
creates the
Expand Down Expand Up @@ -901,11 +901,11 @@ <h2 id="default-configuration">
</code>
(an array of strings).
The name of the claim can be configured either in
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/login-callbacks.js">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/login-callbacks.js">
login-callbacks.js
</a>
for v3 or with
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v4/config/.oidc.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v4/config/.oidc.env">
environment variables
</a>
for v4.
Expand Down
6 changes: 3 additions & 3 deletions v3.2/services/backend/services/ldap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ <h2 id="configuration-options">
</h2>
<p>
The OpenLDAP configuration is set by the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/ldap/config/.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/ldap/config/.env">
.env file
</a>
.
Expand All @@ -828,7 +828,7 @@ <h2 id="configuration-options">
</p>
<p>
You can add other users by editing the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/ldap/config/ldifs/02-users.ldif">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/ldap/config/ldifs/02-users.ldif">
ldif file
</a>
.
Expand All @@ -843,7 +843,7 @@ <h2 id="default-configuration">
</h2>
<p>
The default configuration
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/ldap/config/.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/ldap/config/.env">
.env file
</a>
creates the
Expand Down
6 changes: 4 additions & 2 deletions v3.2/services/backend/services/v3/compose.dev.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
services:
backend:
extends:
file: ${PWD}/services/compose.dev.yaml
service: node-app-from-local
environment:
NODE_ENV: development
volumes:
- ./config/settings.json:/home/node/app/test/config/settings.json
- ./config/datasources.dev.json:/config/datasources.1.json
- v3_dev:/home/node/app
- ./entrypoints/merge_json.sh:/docker-entrypoints/0.sh
- ${PWD}/entrypoints/npm_ci.sh:/docker-entrypoints/1.sh
- ./entrypoints/tests.sh:/docker-entrypoints/2.sh

volumes:
v3_dev:
Expand Down
24 changes: 12 additions & 12 deletions v3.2/services/backend/services/v3/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1029,7 +1029,7 @@ <h2 id="configuration-options">
The v3 backend configuration is set through files. What follows is a list of available options. Some configurations are very verbose and could be simplified, but v3 has reached end of life in favour of v4, thus there is no active development.
</p>
<h3 id="datasourcesjson">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/datasources.json">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/datasources.json">
datasources.json
</a>
<a class="headerlink" href="#datasourcesjson" title="Permanent link">
Expand All @@ -1039,17 +1039,17 @@ <h3 id="datasourcesjson">
<p>
It allows setting the connection to the underlying mongo database. It consists of two blocks:
It consists of two blocks, the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/datasources.json#L18-L21">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/datasources.json#L18-L21">
transient one
</a>
which should not be changed and the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/datasources.json#L6-L17">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/datasources.json#L6-L17">
mongo one
</a>
for which we list the options that can be configured.
</p>
<h4 id="mongo">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/datasources.json#L6-L17">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/datasources.json#L6-L17">
mongo
</a>
<a class="headerlink" href="#mongo" title="Permanent link">
Expand Down Expand Up @@ -1151,7 +1151,7 @@ <h4 id="mongo">
</tbody>
</table>
<h3 id="providersjson">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/providers.json">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/providers.json">
providers.json
</a>
<a class="headerlink" href="#providersjson" title="Permanent link">
Expand All @@ -1167,13 +1167,13 @@ <h3 id="providersjson">
</p>
<p>
Any file called providers*.json will be merged together by the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/entrypoints/merge_json.sh">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/entrypoints/merge_json.sh">
merge_json.sh
</a>
. This is done to allow better scoping of providers options.
</p>
<h4 id="local">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/providers.json#L2-L11">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/providers.json#L2-L11">
local
</a>
<a class="headerlink" href="#local" title="Permanent link">
Expand All @@ -1184,7 +1184,7 @@ <h4 id="local">
The only option available is to either enable or disable the local authentication. Remove the block if you want to disable that.
</p>
<h3 id="configlocaljs">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/config.local.js">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/config.local.js">
config.local.js
</a>
<a class="headerlink" href="#configlocaljs" title="Permanent link">
Expand All @@ -1195,7 +1195,7 @@ <h3 id="configlocaljs">
It allows setting backend-specific configurations. Here are the commonly changed options.
</p>
<h4 id="exports">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/config.local.js#L3-L39">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/config.local.js#L3-L39">
exports
</a>
<a class="headerlink" href="#exports" title="Permanent link">
Expand Down Expand Up @@ -1374,7 +1374,7 @@ <h2 id="default-configuration">
</h2>
<p>
In the default configuration folder
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config">
config
</a>
, the backend is set to use the
Expand All @@ -1399,7 +1399,7 @@ <h2 id="enable-additional-features">
archive mock
</a>
and
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/services/rabbitmq">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/services/rabbitmq">
rabbitmq
</a>
services are started and the backend is configured to connect to them.
Expand Down Expand Up @@ -1432,7 +1432,7 @@ <h2 id="enable-additional-features">
DEV=true
</code>
, since the v3 tests are supposed to run with an empty DB, the set DB is
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/config/datasources.dev.json">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/config/datasources.dev.json">
dacat_test
</a>
which is empty. If willing to use the seeded one later during development, just set
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
services:
archivemock:
environment:
GITHUB_REPO: https://github.com/SciCatProject/ScicatArchiveMock.git
extends:
file: ${PWD}/services/compose.dev.yaml
service: web-app
labels: !reset null
volumes:
- archivemock_dev:/job_mock
- ${PWD}/entrypoints/loop_entrypoints.sh:/usr/local/bin/loop_entrypoints.sh
- ${PWD}/entrypoints/infinite_loop.sh:/usr/local/bin/infinite_loop.sh
- ${PWD}/entrypoints/setup_git.sh:/docker-entrypoints/0.sh
entrypoint: loop_entrypoints.sh
command: infinite_loop.sh
healthcheck:
test: pgrep -f "/bin/sh /usr/local/bin/infinite_loop.sh"
user: root

volumes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -835,7 +835,7 @@ <h2 id="service-requirements">
</h2>
<ul>
<li>
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/services/rabbitmq">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/services/rabbitmq">
RabbitMQ
</a>
</li>
Expand All @@ -847,7 +847,7 @@ <h2 id="service-requirements">
</li>
</ul>
<h2 id="config-environment-variables">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/services/archivemock/config/.env">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/services/archivemock/config/.env">
Config
</a>
- Environment Variables
Expand Down Expand Up @@ -878,7 +878,7 @@ <h2 id="default-configuraiton">
admin
</code>
account, and to the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v3/services/rabbitmq">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v3/services/rabbitmq">
RabbitMQ
</a>
container with the
Expand Down
4 changes: 2 additions & 2 deletions v3.2/services/backend/services/v4/compose.base.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
services:
backend:
image: ghcr.io/scicatproject/backend-next:v4.6.6
image: ghcr.io/scicatproject/backend-next:v4.7.0
depends_on:
mongodb:
condition: service_started
volumes:
- ./config/functionalAccounts.json:/home/node/app/functionalAccounts.json
- ${PWD}/entrypoints/loop_entrypoints.sh:/usr/local/bin/loop_entrypoints.sh
- ./entrypoints/db_migration.sh:/docker-entrypoints/0.sh
- ./entrypoints/db_migration.sh:/docker-entrypoints/1.sh
entrypoint:
- loop_entrypoints.sh
- docker-entrypoint.sh
Expand Down
10 changes: 3 additions & 7 deletions v3.2/services/backend/services/v4/compose.dev.yaml
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
services:
backend:
image: !reset null
extends:
file: ${PWD}/services/compose.dev.yaml
service: node-app-from-remote
build:
context: https://github.com/SciCatProject/scicat-backend-next.git
target: dev
environment:
GITHUB_REPO: https://github.com/SciCatProject/scicat-backend-next.git
volumes:
- v4_dev:/home/node/app
- ${PWD}/entrypoints/setup_git.sh:/docker-entrypoints/2.sh
- ./config/functionalAccounts.dev.json:/home/node/app/functionalAccounts.json
- ./entrypoints/tests.sh:/docker-entrypoints/3.sh
env_file:
- ./config/.dev.env
healthcheck:
Expand Down
6 changes: 3 additions & 3 deletions v3.2/services/backend/services/v4/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ <h2 id="default-configuration">
</h2>
<p>
In the default configuration folder
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v4/config">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v4/config">
config
</a>
, the backend is set to use the
Expand All @@ -985,7 +985,7 @@ <h2 id="enable-additional-features">
ELASTIC_ENABLED
</code>
, the
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v4/services/elastic">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v4/services/elastic">
elastic search
</a>
service is started and the backend is configured to connect to them.
Expand Down Expand Up @@ -1022,7 +1022,7 @@ <h2 id="enable-additional-features">
--runInBand
</code>
, as
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.3/services/backend/services/v4/entrypoints/tests.sh">
<a href="https://github.com/SciCatProject/scicatlive/blob/v3.2.4/services/backend/services/v4/entrypoints/tests.sh">
here
</a>
, which makes the tests run sequentially, avoiding to fill the RAM which makes them freeze.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ services:
image: docker.elastic.co/elasticsearch/elasticsearch:8.16.0
volumes:
- esdata:/usr/share/elasticsearch/data
mem_limit: 1073741824
mem_limit: 1.5g
ulimits:
memlock:
soft: -1
Expand Down
29 changes: 29 additions & 0 deletions v3.2/services/compose.dev.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
services:
web-app:
entrypoint: loop_entrypoints.sh
command: infinite_loop.sh
healthcheck:
test: pgrep -f "/bin/sh /usr/local/bin/infinite_loop.sh"
retries: 10
labels:
- traefik.http.services.${APP}.loadbalancer.server.port=${DEV_PORT}
volumes:
# These volumes allow to run init scripts before running the service
- ${PWD}/entrypoints/loop_entrypoints.sh:/usr/local/bin/loop_entrypoints.sh
- ${PWD}/entrypoints/infinite_loop.sh:/usr/local/bin/infinite_loop.sh
- ${PWD}/entrypoints/setup_git.sh:/docker-entrypoints/0.sh
environment:
GITHUB_REPO: ${GITHUB_REPO:-}
node-app-from-local:
extends: web-app
volumes:
# This prevents git unpushed changes from being lost on container restart
- ${DEV_VOLUME:-${APP}}_dev:${WORKDIR:-/home/node/app}
# These allow to keep changes from npm install/build from Dockerfile CMDs
- ${WORKDIR:-/home/node/app}/dist
- ${WORKDIR:-/home/node/app}/node_modules
node-app-from-remote:
extends: node-app-from-local
image: ''
build:
context: ${GITHUB_REPO:-}
Loading

0 comments on commit 12a2674

Please sign in to comment.