Setting up Docker and Docker Compose for Foundry Single-container Installation

HCL Volt MX Volt MX Tips
, , ,
1

Installing Prerequisites for Foundry Sigle Container Deployment

This page provides step-by-step instructions for installing the required components for deploying our product using Docker and Docker Compose. Will create sperate blog for setting up external Databases. Follow the guidelines based on your operating system.

1. Prerequisites

Before proceeding with the installation, refer to the official product documentation for the exact versions of Docker, Docker Compose, and the supported database that are compatible with this release of the product.

Please refer to the Official Foundry Documentation to get the versions supported by foundry.
Using incompatible versions may lead to deployment issues or unexpected behavior.

2. Installation Steps by Operating System

Windows

  1. Install Docker Desktop:

    • Download and install Docker Desktop from Docker’s official site.
    • Enable Windows Subsystem for Linux 2 (WSL 2) during installation.

  2. Install Docker Compose:

    • Docker Compose is included with Docker Desktop. Verify:
      docker-compose --version

macOS

  1. Install Docker Desktop:

  2. Verify Docker Compose:

    • Docker Compose is included with Docker Desktop. Verify:
      docker-compose --version

Linux (Ubuntu/Debian-based systems)

  1. Install Docker:

    sudo apt-get update
sudo apt-get install -y docker.io
    • Verify installation:
      docker --version

  2. Install Docker Compose:

    sudo curl -L "https://github.com/docker/compose/releases/download/v2.0.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
    • Verify installation:
      docker-compose --version

Note: If you are using different flavor of linux please refer to Docker’s Official Site.

3. Useful Tips

  • Run Docker Without Root (Linux):
    Add your user to the docker group:

    sudo usermod -aG docker $USER

    Log out and back in to apply changes.

  • Disk Space Management:

    • Monitor available space, especially for large images:
      docker system df
    • Clean up unused Docker resources:
      docker system prune

  • Common Ports:

    • Docker: Ensure ports like 8080 or 5432 are not blocked.
    • Database: Ensure the firewall allows connections to your database port.

4. Verify Installation

Run the following to confirm everything is installed and working:

docker --version
docker-compose --version

5. Next Steps

Once prerequisites are installed: