VIP Local Development Environment requirements

To successfully work with the VIP Local Development Environment, some dependencies must be installed and maintained on the user’s local machine.

To create and manage a VIP Local Development Environment, the user’s local machine must meet the following requirements:

• VIP-CLI is installed and is updated to the most current version.
• The latest version of Docker Engine and Docker Compose is installed.
  • For Debian-Based Linux distributions: docker-compose may need to be installed with: sudo apt-get install docker-compose.
• For macOS users: Xcode Command Line Tools are installed.
  Xcode can be installed by running the command: xcode-select --install.
• For Windows users: WSL should be set to version 2 for Windows Docker Desktop compatibility. All vip dev-env commands should be made from the chosen distribution app’s command line, or by targeting a WSL installation in Microsoft Terminal. Additional considerations for running git commands and making edits to a locally cloned GitHub repository will be required when working across Windows and Linux file systems.

Docker requirements

The VIP Local Development Environment utilizes Docker Engine and Docker Compose. For the VIP Local Development Environment to work as expected, both of these components must be installed on a local machine and maintained at their latest version.

Docker Desktop

Docker Engine and Docker Compose are commonly installed on a local machine by installing the Docker Desktop application. Depending on the size of an organization, installing Docker Desktop may require a paid subscription.

Alternatives to Docker Desktop

As an alternative, Docker Engine and Docker Compose can be installed separately.

• Windows: The Chocolatey package manager can be used to install Docker Engine and install Docker Compose.
• macOS and Linux:
  1. Use the Homebrew package manager to install Docker, install Docker Compose, and install Colima.
  2. Symlink the Colima socket to the default socket path: sudo ln -sf $HOME/.colima/default/docker.sock /var/run/docker.sock
  3. Start Colima: colima start --vm-type=vz --mount-type virtiofs