docs: update required docker version, add docker version check

Changelog.md

@@ -14,6 +14,18 @@
 ## Documentation
 -->
 
+# 2.3.7
+
+## Tool Updates
+
+* Updated Docker requirement to tested version: 27.3.1
+  * Added warning when Docker version is out of date.
+
+## Documentation
+
+* Updated documentation to reflect tested Docker version.
+* Updated documentation to stop using a branch of the DetSys Nix Installer.
+
 # 2.3.6
 
 ## Steps

default.nix

@@ -34,6 +34,7 @@
   yosysFull,
   # Python
   buildPythonPackage,
+  poetry-core,
   click,
   cloup,
   pyyaml,
@@ -50,7 +51,7 @@
   pyfakefs,
   rapidfuzz,
   ioplace-parser,
-  poetry-core,
+  semver,
 }: let
   yosys-env = (yosys.withPythonPackages.override {target = yosysFull;}) (ps:
     with ps; [
@@ -107,6 +108,7 @@
         klayout.pymod
         rapidfuzz
         ioplace-parser
+        semver
       ]
       ++ self.includedTools;
 

docs/source/getting_started/common/docker_installation/_common.md

@@ -58,7 +58,7 @@ Successful outputs will look like this:
 
 ```
 $ docker --version
-Docker version 20.10.16, build aa7e414fdc
+Docker version 27.3.1, build ce12230
 $ python3 --version
 Python 3.10.5
 $ python3 -m pip --version

docs/source/getting_started/common/docker_installation/index.md

@@ -1,8 +1,11 @@
 # Docker-based Installation
 
-For ease of installation, OpenLane offers the ability to transparently [Docker](<https://en.wikipedia.org/wiki/Docker_(software)>) containers.
+For ease of installation, OpenLane offers the ability to transparently use 
+[Docker](<https://en.wikipedia.org/wiki/Docker_(software)>) containers to run
+your flow.
 
-These containers include OpenLane's applications, binaries as well as all other required dependencies.
+These containers include OpenLane's binaries, scripts as well as any other
+dependencies.
 
 ```{toctree}
 :glob:

docs/source/getting_started/common/docker_installation/installation_linux.md

@@ -4,12 +4,14 @@
 
 For OpenLane you need a couple of tools installed:
 
-* Docker 19.03.12+
-  * Docker post-installation steps for running without root
-* Git 2.35+
+* Docker version 25.0.5+
+  * Docker post-installation steps for running without root.
+* Git version 2.35+
 * Python 3.8+ with pip and tkinter
 
-Please install all of these dependencies using your package manager. Please note that while alternative container services such as podman do work, they are not officially supported.
+Please install all of these dependencies using your package manager. Please note
+that while alternative container services such as podman do work, they are not
+officially supported and are best-effort.
 
 ### Installing Docker
 

docs/source/getting_started/common/nix_installation/installation_linux.md

@@ -30,7 +30,7 @@ $ sudo apt-get install -y curl
 After that, simply run this command:
 
 ```console
-$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix/pr/1145 | sh -s -- install --no-confirm --extra-conf "
+$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install --no-confirm --extra-conf "
     extra-substituters = https://openlane.cachix.org
     extra-trusted-public-keys = openlane.cachix.org-1:qqdwh+QMNGmZAuyeQJTH9ErW57OWSvdtuwfBKdS254E=
 "

docs/source/getting_started/common/nix_installation/installation_macos.md

@@ -15,7 +15,7 @@
 Simply run this (entire) command in `Terminal.app`:
 
 ```console
-$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix/pr/1145 | sh -s -- install --no-confirm --extra-conf "
+$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install --no-confirm --extra-conf "
     extra-substituters = https://openlane.cachix.org
     extra-trusted-public-keys = openlane.cachix.org-1:qqdwh+QMNGmZAuyeQJTH9ErW57OWSvdtuwfBKdS254E=
 "

docs/source/getting_started/common/nix_installation/installation_win.md

@@ -59,7 +59,7 @@ $ sudo apt-get install -y curl
 Then install Nix by running the following command:
 
 ```console 
-$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix/pr/1145 | sh -s -- install --no-confirm --extra-conf "
+$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install --no-confirm --extra-conf "
     extra-substituters = https://openlane.cachix.org
     extra-trusted-public-keys = openlane.cachix.org-1:qqdwh+QMNGmZAuyeQJTH9ErW57OWSvdtuwfBKdS254E=
 "

openlane/__main__.py

@@ -330,10 +330,11 @@ def cli_in_container(
             other_mounts=docker_mounts,
             tty=docker_tty,
         )
-    except ValueError as e:
-        print(e)
-    except Exception:
-        traceback.print_exc()
+    except Exception as e:
+        err(e)
+        ctx.exit(1)
+
+    ctx.exit(0)
 
 
 o = partial(option, show_default=True)

openlane/container.py

@@ -16,13 +16,15 @@
 import os
 import re
 import uuid
-import httpx
 import shlex
 import pathlib
 import tempfile
 import subprocess
 from typing import List, NoReturn, Sequence, Optional, Union, Tuple
 
+import httpx
+import semver
+
 from .common import mkdirp
 from .logging import err, info, warn
 from .env_info import OSInfo
@@ -170,6 +172,16 @@ def run_in_container(
     if osinfo.container_info is None:
         raise FileNotFoundError("No compatible container engine found.")
 
+    if osinfo.container_info.engine.lower() == "docker":
+        if semver.compare(osinfo.container_info.version, "25.0.5") < 0:
+            warn(
+                f"Your Docker engine version ({osinfo.container_info.version}) is out of date. You may encounter unexpected issues."
+            )
+    else:
+        warn(
+            f"Unsupported container engine '{osinfo.container_info.engine}'. You may encounter unexpected issues."
+        )
+
     if not ensure_image(image):
         raise ValueError(f"Failed to use image '{image}'.")
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openlane"
-version = "2.3.6"
+version = "2.3.7"
 description = "An infrastructure for implementing chip design flows"
 authors = ["Efabless Corporation and Contributors <donn@efabless.com>"]
 readme = "Readme.md"
@@ -26,6 +26,7 @@ klayout = ">=0.29.0,<0.30.0"
 rapidfuzz = ">=3.9.0,<4"
 ioplace-parser = ">=0.3.0,<0.5.0"
 yamlcore = "^0.0.2"
+semver = "^3.0.2"
 
 
 [tool.poetry.group.dev.dependencies]