Merge remote-tracking branch 'origin/main' into develop

Author: Mateusz Czeladka

.env.docker-compose-profile-mid-level

@@ -3,7 +3,7 @@ API_DB_POOL_MAX_COUNT=150
 
 DB_POSTGRES_MAX_CONNECTIONS=300
 DB_POSTGRES_SHARED_BUFFERS=4GB
-DB_POSTGRES_EFFECTIVE_CACHE_SIZE=16GB
+DB_POSTGRES_EFFECTIVE_CACHE_SIZE=8GB
 DB_POSTGRES_WORK_MEM=64MB
 DB_POSTGRES_MAINTENANCE_WORK_MEM=512MB
 DB_POSTGRES_WAL_BUFFERS=512MB

README.md

@@ -1,5 +1,7 @@
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=cardano-foundation_cardano-rosetta-java&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=cardano-foundation_cardano-rosetta-java)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=cardano-foundation_cardano-rosetta-java&metric=coverage)](https://sonarcloud.io/summary/new_code?id=cardano-foundation_cardano-rosetta-java)
+[![Build](https://github.com/cardano-foundation/cardano-rosetta-java/actions/workflows/feature-mvn-build.yaml/badge.svg)](https://github.com/cardano-foundation/cardano-rosetta-java/actions/workflows/feature-mvn-build.yaml)
+[![License](https://img.shields.io:/github/license/cardano-foundation/cardano-rosetta-java?label=license)](https://github.com/cardano-foundation/cardano-rosetta-java/blob/master/LICENSE)
+![Discord](https://img.shields.io/discord/1022471509173882950)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=cardano-foundation_cardano-rosetta-java&metric=coverage)](https://sonarcloud.io/summary/overall?id=cardano-foundation_cardano-rosetta-java)
 [![FOSSA Status](https://app.fossa.com/api/projects/custom%2B45571%2Fgithub.com%2Fcardano-foundation%2Fcardano-rosetta-java.svg?type=shield&issueType=license)](https://app.fossa.com/projects/custom%2B45571%2Fgithub.com%2Fcardano-foundation%2Fcardano-rosetta-java?ref=badge_shield&issueType=license)
 
 ## What the project is about?
@@ -42,7 +44,7 @@ The default config is focused on mainnet. If you want to test this on other Card
     git clone https://github.com/cardano-foundation/cardano-rosetta-java
     cd cardano-rosetta-java
     docker build -t rosetta-java -f ./docker/Dockerfile .
-    docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8082:8082 -d rosetta-java
+    docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -d rosetta-java
 ```
 Detailed explanation can be found in the [Wiki](https://github.com/cardano-foundation/cardano-rosetta-java/wiki/3.-Getting-Started-with-Docker).
 
@@ -81,13 +83,13 @@ Default is `online`.
 For every Release we provide pre-built docker images stored in the DockerHub Repositories of the Cardano Foundation ([DockerHub](https://hub.docker.com/orgs/cardanofoundation/repositories))
 To start it use the following command:
 ```bash
-    docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8082:8082 -d cardanofoundation/cardano-rosetta-java:1.2.5
+    docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -d cardanofoundation/cardano-rosetta-java:1.2.6
 ```
 Changes to the configuration can be made by adjusting the `docker/.env.dockerfile` file. For more information on the environment variables, please refer to the [Wiki](https://github.com/cardano-foundation/cardano-rosetta-java/wiki/5.-Environment-Variables).
 
 If you want to use the `cardano-submit-api` you can additionally expose port `8090`. It can then be used to submit raw cbor transaction (API documentation here: [Link](https://input-output-hk.github.io/cardano-rest/submit-api/))
 ```bash
-    docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8090:8090 -p 8082:8082 -d cardanofoundation/cardano-rosetta-java:1.2.6
+    docker run --name rosetta -v {CUSTOM_MOUNT_PATH}:/node --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8090:8090 -p 8082:8082 --shm-size=4g -d cardanofoundation/cardano-rosetta-java:1.2.6
 ```
 ### Docker compose
 If needed we also provide all components needed to run Rosetta in a docker-compose file.
@@ -100,7 +102,7 @@ This will start:
 
 ### Entry level hardware profile
 ```bash
-   docker-compose --env-file .env.docker-compose --env-file .env.docker-compose-profile-entry-level -f docker-compose.yaml up -d 
+   docker-compose --env-file .env.docker-compose --env-file .env.docker-compose-profile-mid-level -f docker-compose.yaml up -d 
 ```
 
 ### A complete list of hardware profiles:

docker-compose-indexer.yaml

@@ -43,7 +43,7 @@ services:
 
   db:
     image: ${DB_IMAGE_NAME}:${DB_IMAGE_TAG}
-    shm_size: 30g
+    shm_size: 4g
     ports:
       - ${DB_PORT}:${DB_PORT}
     command: [

docker/.env.docker-profile-mid-level

@@ -3,7 +3,7 @@ API_DB_POOL_MAX_COUNT=150
 
 DB_POSTGRES_MAX_CONNECTIONS=300
 DB_POSTGRES_SHARED_BUFFERS=4GB
-DB_POSTGRES_EFFECTIVE_CACHE_SIZE=16GB
+DB_POSTGRES_EFFECTIVE_CACHE_SIZE=8GB
 DB_POSTGRES_WORK_MEM=64MB
 DB_POSTGRES_MAINTENANCE_WORK_MEM=512MB
 DB_POSTGRES_WAL_BUFFERS=512MB

docker/entrypoint.sh

@@ -119,7 +119,7 @@ configure_postgres() {
         echo "Make sure to pass an additional --env-file parameter when running the container."
         echo ""
         echo "Example Docker run command for an 'entry_level' hardware profile:"
-        echo "docker run --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8082:8082 -d cardanofoundation/cardano-rosetta-java:latest"
+        echo "docker run --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -d cardanofoundation/cardano-rosetta-java:latest"
         echo ""
         exit 1
     fi

docker/readme.md

@@ -16,7 +16,7 @@ The build can take up to 1.5 hours.
 
 ### 2. Run
 ````
-docker run --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8082:8082 -d {image_name}:latest
+docker run --env-file ./docker/.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -d {image_name}:latest
 ````
 You need to specify the path to the environment variables file and open the port.
 
@@ -56,28 +56,28 @@ PG_VERSION=14
 
 ### 5. Volume with Cardano node data
 ````
-docker run --env-file .\docker\.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8082:8082 -v {custom_folder}:/node/db -d {image_name}:latest
+docker run --env-file .\docker\.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 -v {custom_folder}:/node/db --shm-size=4g -d {image_name}:latest
 ````
 If you want to use already existing cardano data, you can mount the data volume to the ``/node/db`` folder inside the container to prevent loading during initialization.
 
 ### 6. Volume with Postgres data
 ````
-docker run --env-file .\docker\.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8082:8082 -v {custom_folder}:/node/postgres -d {image_name}:latest
+docker run --env-file .\docker\.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 -v {custom_folder}:/node/postgres --shm-size=4g -d {image_name}:latest
 ````
 
 You can mount a volume with Postgres node data to ``/node/postgres`` point to use already existed data.  
 If the mounted volume does not contain the database or empty, new database will be created there.
 
 ### 7. Volume with custom network configurations
 ````
-docker run --env-file .\docker\.env.dockerfile --env-file ./docker/.env.docker-profile-entry-level -p 8082:8082 -v {custom_folder}:/networks -d {image_name}:latest
+docker run --env-file .\docker\.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 -v {custom_folder}:/networks --shm-size=4g -d {image_name}:latest
 ````
 The cardano node configuration jsons are stored in the ``config`` folder and copied into the image on build.  
 If you want to use a custom configuration without rebuilding the image, we can mount a volume with configs to ``/networks`` folder inside the container.
 
 ### 8. Synchronization mode
 ````
-docker run -e SYNC=true --env-file .\docker\.env.dockerfile -p 8082:8082 -d {image_name}:latest
+docker run -e SYNC=true --env-file .\docker\.env.dockerfile --env-file ./docker/.env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -d {image_name}:latest
 ````
 The container can be started in synchronization mode. In this case, the container will verify chunks and synchronize all nodes when it is started and run ``Rosseta Api`` after that  
 To start it you need to change the ``SYNC`` variable in ``.env.dockerfile`` or by adding the ``-e SYNC=true`` key when starting the container.  

docs/docs/getting-started/docker.md

@@ -89,7 +89,7 @@ The default values:
 ### 2. How to run the container
 
 ```
-docker run --env-file ./docker/.env.dockerfile --env-file .env.docker-profile-entry-level -p 8082:8082 -it {image_name}:latest
+docker run --env-file ./docker/.env.dockerfile --env-file .env.docker-profile-mid-level -p 8082:8082 -it {image_name}:latest
 ```
 
 You need to specify the path to the environment variables file and open the port. The standard Port for the API is `8082`.
@@ -99,7 +99,7 @@ It is recommended to use a fully synced node, otherwise it can lead to instabili
 To mount Node data into the container use the following command:
 
 ```
-docker run --env-file ./docker/.env.dockerfile --env-file .env.docker-profile-entry-level -p 8082:8082 -v {node_snapshot}:/node/db -it {image_name}:latest
+docker run --env-file ./docker/.env.dockerfile --env-file .env.docker-profile-mid-level -p 8082:8082 --shm-size=4g -v {node_snapshot}:/node/db -it {image_name}:latest
 ```
 
 Relevant datapathes within the container:
@@ -114,7 +114,7 @@ Relevant datapathes within the container:
 The synchronization mode is to for users who don't have a fully synced node and need to start from scratch without using a snapshot.
 
 ```
-docker run -e SYNC=true --env-file .\docker\.env.dockerfile -p 8082:8082 -d {image_name}:latest
+docker run -e SYNC=true --env-file .\docker\.env.dockerfile -p 8082:8082 --shm-size=4g -d {image_name}:latest
 ```
 
 The container can be started in synchronization mode. In this case, the container will verify chunks and synchronize the node, when it reaches the tip, the API is started automatically.