Commit 565bf18a authored by Adrian DC's avatar Adrian DC
Browse files

chore: document #160: mention sockets are enabled by dind services

parent 9ce62570

README.md

+2 −2
Changes for README.md: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ is the common and unique interface between GitLab CI and gitlabci-local. 
| --settings         | Show the current settings path and contents |



| Pipeline arguments |                                                                                                 |

| ------------------ | --------------------------------------------------------------------------------------- |

| ------------------ | ----------------------------------------------------------------------------------------------- |

| -p, --pipeline     | Automatically run pipeline stages rather than jobs                                              |

| -q, --quiet        | Hide jobs execution context                                                                     |

| -c CONFIGURATION   | Path to the .gitlab-ci.yml configuration file or folder                                         |
@@ -70,7 +70,7 @@ is the common and unique interface between GitLab CI and gitlabci-local. 
| -E ENGINE          | Force a specific engine (or define CI_LOCAL_ENGINE)<br>Default list: auto,podman,docker         |

| -H, --host         | Run all jobs on the host rather than containers                                                 |

| -r, --real-paths   | Mount real folder paths in the container (Linux only)                                           |

| -S, --sockets      | Mount engine sockets for nested containers                                              |

| -S, --sockets      | Mount engine sockets for nested containers<br>(Enabled by default with services: docker:\*dind) |

| -v VOLUME          | Mount VOLUME or HOST:TARGET in containers                                                       |

| -w WORKDIR         | Override the container's working path                                                           |

gitlabci_local/cli/main.py

+4 −2
Changes for gitlabci_local/cli/main.py: 4 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -80,8 +80,10 @@ def main(): 
                       help='Run all jobs on the host rather than containers')

    group.add_argument('-r', '--real-paths', dest='real_paths', action='store_true',

                       help='Mount real folder paths in the container (Linux only)')

    group.add_argument('-S', '--sockets', dest='sockets', action='store_true',

                       help='Mount engine sockets for nested containers')

    group.add_argument(

        '-S', '--sockets', dest='sockets', action='store_true', help=

        'Mount engine sockets for nested containers\n(Enabled by default with services: docker:*dind)'

    )

    group.add_argument('-v', dest='volume', action='append',

                       help='Mount VOLUME or HOST:TARGET in containers')

    group.add_argument('-w', dest='workdir',