Allow different concurrent development environments on a single machine

[jifox]

Environment

• Python version: 3.8.5
• Nautobot version: 57c8b8f1e8cc (v1.0.4b1)

Proposed Functionality

The project_name specified within "invoke" should be taken into account when building the docker image with invoke build

Use Case

As a developer I want to be able to have different development environments on the developers machine (different projects).

The problem with the current invoke build version ist, that the container image name will not be affected by the docker-compose --project-name ... parameter because it is fully specified as image name in docker-compose.yml file. Thus overwriting the image of all the other project when invoke build is executed.

services:
  nautobot:
    build:
      args:
        PYTHON_VER: "${PYTHON_VER}"
      context: ../
      dockerfile: docker/Dockerfile
      target: dev
    image: "networktocode/nautobot-dev-py${PYTHON_VER}:local"
    ports:
      - "8000:8080"
    depends_on:
      - postgres

Database Changes

None

External Dependencies

None

[glennmatthews]

Good suggestion! I think fixing this may be a bit more involved than just adding the project_name; we also need to consider making it possible to override the exposed ports (8080 and 4444) by each running development environment.

[itdependsnetworks]

Is some of this better supported with a docker-compose-override.yml that the invoke command looks for and proper documentation? This is a pattern we have used before, but not sure it exactly fits here.

[jifox]

I see that using the docker-compose-override.yml override method will solve my problems.

As I can see one can specifiy the override filename with the compose_override_file: "docker-compose.override.yml" in invoke.yml file

For me this solves all my needs and I'm proceeding by creating project specific override.yml files.

[jedelman8]

@jifox looks like we're good to close as you were able to move forward with overrides?

[jifox]

@jedelman8 Yes, you're right.

[glennmatthews]

I'll close this then - thanks! FYI there are some workflow changes here in 1.1.x - if you get a chance to review #782, it would be appreciated!