Configure Host for IP Maestro
To prepare the host for IP Maestro deployment, you must have Docker and Docker Compose installed on it. The following sections describe the Docker verification and installation.
Docker Verification or Installation
IP Maestro uses Docker and Docker Compose to run and manage containers.
If Docker was previously installed with snap, it is recommended to remove it and have docker installation with apt only.
1. Execute the following command to check if Docker is installed with snap:
snap list
2. If Docker is present in the snap list, execute the following command to remove:
sudo snap remove --purge docker
Prerequisites
• Ensure that Docker, Docker Compose plugin and Wget are installed.
• Ensure that only one docker installation is running on the host.
Procedure
• Docker version must be 23.0.0 or above and Docker Compose version must be 2.20.2 or above.
• To validate the versions, execute the following commands:
docker version
docker compose version
If the above commands fail, refer to
Install Docker.
If the versions do not meet the requirements, refer to
Uninstall Old Versions.
Note: It is recommended to add the host user to the docker group in a post-installation step.
• Execute the sudo usermod -aG docker $USER command to eliminate the requirement to use sudo when executing docker commands and to add your user to the docker group.
Customize Docker IP Subnet and Bridge Network Settings
Docker Compose creates networks in the range 172.17.0.0/16 by default. However, there is a possibility of picking some other IP blocks, often in the 192.168.0.0/16 range. To avoid conflicts with the local environment, it is advised to specify a suitable IP block.
Follow the steps mentioned below before deploying IP Maestro:
Customize the IP subnet and bridge network settings for Docker Compose by modifying the daemon.json file as follows:
1. Open the daemon.json file
sudo nano /etc/docker/daemon.json
2. Add the configuration (if the file is empty)
"bip": "172.20.0.1/16",
"default-address-pools": [
{
"base": "172.21.0.0/16",
"size": 24
}
]
}
Here is the description of the commands used to add the configuration:
Command | Description |
bip | Sets the IP address of the Docker bridge network interface (docker0). |
default-address-pools | Defines the IP address pools for automatic network creation. |
base | The starting IP address of the pool. |
size | The subnet size (for example: 24 for a /24 subnet). |
3. Restart Docker
sudo systemctl restart docker
Important considerations:
• Deployment: The above steps must be done before IP Maestro deployment. If any deployment is already present, it must be shut down and brought up again.
• Subnet: The subnet you choose must be non-conflicting and not overlap with any other networks in your environment.
• IP Range: The size parameter in default-address-pools determines the size of the subnet. A smaller size (/24) provides more subnets with fewer addresses per subnet, while a larger size (/16) provides fewer subnets with more addresses per subnet.
To troubleshoot Docker installation related issues, refer to
Remove Old Docker Installation,
Remove Docker Snap Installation.