blocknami / blocknami-container-cardano-node

Blocknami Container Image for Cardano Node

Cardano Node package by Blocknami

What is Cardano Node

Cardano Node is an and the core component that underpins the Cardano blockchain network.

Overview of Cardano Node

Trademarks: This software listing is packaged by Blocknami. The respective trademarks mentioned int he offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

$ [docker|podman] run --name cardano-node blocknami/cardano-node:latest

Why use Blocknami Images?

• Blocknami tracks upstream source changes and promptly publishes new versions of this image using automated systems.
• With Blocknami images the latest bug fixes and features are available as soon as possible.
• Blocknami container use the same components and configuration approach - making it easy to switch between formats based on your project needs.
• Our images are based on three distributions
  • Alpine
    • Popular minimalist container image
  • UBI
    • Enterprise level security patching from Red Hat AND
  • minideb OR
  • Debian Slim
• Blocknami container images are released on a regular basis with the latest distribution packages available.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers:

• Docker docs
• Podman docs
• Bitnami docs

Supported tags and respective Containerfile links

• 1.34, 1.34-alpine-3, 1.34, 1.34.1, 1.34.1-alpine-3-r1, latest (1/alpine-3/Containerfile)
• 1.34, 1.34-debian-11, 1.34, 1.34.1, 1.34.1-debian-11-r1, latest (1/debian-11/Containerfile)
• 1.34, 1.34-ubi-9, 1.34, 1.34.1, 1.34.1-ubi-9-r1, latest (1/ubi-9/Containerfile)

Subscribe to project updates by watching the blocknami/cardano-node GitHub repo.

Get this image

The recommended way to get the Blocknami Cardano Node container image is to pull the prebuilt image from on of the following registries:

• Docker Hub Registry.
• Red Hat Quay.io Registry

Using docker or podman cli with Docker Hub:

$ [docker|podman] pull docker.io/blocknami/cardano-node:latest

Using docker or podman cli to pull from a specific registry:

$ [docker|podman] pull quay.io/blocknami/cardano-node:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

$ [docker|podman] pull docker.io/blocknami/cardano-node:[TAG]

If you wish, you can also build the image yourself.

$ [docker|podman] build -t blocknami/cardano-node:latest 'https://github.com/blocknami/blocknami-container-cardano-node.git#master:1/ubi-9'

Persisting the blockchain database

If you remove the container all your data and configurations will be lost, and the next time you run the image the blockchain data will be re-syncrhonized. To avoid the loss of data and re-synchronization, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the /blocknami/cardano-node path. If the mounted directory is empty, it will be initialized on the first run.

$ docker run \
    -v /path/to/cardano-node-db-persistence:/blocknami/cardano-node \
    blocknami/cardano-node:latest

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

Connecting to other containers

The Cardano Node running inside a container can easily be accessed by other application containers.

• Docker container networking
• Podman container networking

Containers attached to the same network can communicate with each other using the container name as the hostname.

Using the Command Line

In this example, we will create a Cardano Wallet (client) instance that will connect to the Cardano Node (serer) instance that is running on the same docker or podman network as the client.

Step 1: Create a network

$ [docker|podman] network create app-tier --driver bridge

Step 2: Launch the PostgreSQL server instance

Use the --network app-tier argument to the docker run command to attach the PostgreSQL container to the app-tier network.

$ [docker|podman] run -d --name cardano-node \
    --network app-tier \
    blocknami/cardano-node:latest

Step 3: Launch your PostgreSQL client instance

Finally we create a new container instance to launch the wallet and connect to the node created in the previous step:

$ [docker|podman] run -it --rm \
    --network app-tier \
    blocknami/cardano-node:latest cardano-node -h cardano-node -U cardano

Notable Changes

None

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

• Host OS and version
• Docker version (docker version)
• Output of docker info
• Version of this container
• The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Copyright © 2022 Blocknami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.