Merge branch '1.x' of github.com:codeenigma/ce-dev into 1.x

Author: gregharvey

README.md

@@ -16,7 +16,7 @@ A local stack based on Docker Compose and Ansible. It aims to be easy to use but
 - HTTPS support through [mkcert](https://github.com/FiloSottile/mkcert)
 - Built-in Unison sync to avoid bind mount slowness on Mac OS
 - Easily build and push ready made images from running containers for you project
-- Only defines a few simple commands, and defers to docker-compose and Ansible beyond that
+- Only defines a few simple commands, and defers to `docker compose` and Ansible beyond that
 
 ## [Documentation](https://codeenigma.github.io/ce-dev-docs/1.x/home/)
-## [Install](https://codeenigma.github.io/ce-dev-docs/1.x/install/)
+## [Install](https://codeenigma.github.io/ce-dev-docs/1.x/install/)

RELEASE

@@ -1,7 +1,2 @@
-1.1.23
-Changed credentials_handling to manual, to generate ce-dev and root as user/password instead of a random string.
-Using vendor/drush as drush instead of the phar file.
-Included lhci_run as role in the deploy step, with one tests for the homepage.
-Using full command paths to define pre/post_tasks
-Renamed the settings and drush templates inside ansible/web/site/default
-Removed the pre_tasks in provision.yml to uninstall nodejs 12.
+1.2.0
+Migrated to using docker compose v2 or higher.

docs/Commands.md

@@ -57,21 +57,21 @@ _See code: [src/commands/browse.ts](https://github.com/codeenigma/ce-dev/blob/v1
 
 ## `ce-dev build`
 
-Commit the existing containers as new docker images, and create a new docker-compose file referencing them.
+Commit the existing containers as new docker images, and create a new docker compose file referencing them.
 
 ```
 USAGE
   $ ce-dev build
 
 OPTIONS
-  -d, --destination=destination  [default: ce-dev.compose.prebuilt.yml] Path to the output docker-compose file, relative
+  -d, --destination=destination  [default: ce-dev.compose.prebuilt.yml] Path to the output docker compose file, relative
                                  to the project ce-dev folder.
 
   -h, --help                     show CLI help
 
   -r, --registry=registry        Docker registry to use. This overrides the one defined in the source compose template.
 
-  -t, --template=template        [default: ce-dev.compose.yml] Path to a docker-compose template file, relative to the
+  -t, --template=template        [default: ce-dev.compose.yml] Path to a docker compose template file, relative to the
                                  project ce-dev folder. WARNING: this must match the original one the project was
                                  constructed with.
 
@@ -151,7 +151,7 @@ _See code: [src/commands/deploy.ts](https://github.com/codeenigma/ce-dev/blob/v1
 
 ## `ce-dev destroy`
 
-Destroy project's containers using docker-compose kill.
+Destroy project's containers using docker compose kill.
 
 ```
 USAGE
@@ -194,7 +194,7 @@ USAGE
 OPTIONS
   -h, --help               show CLI help
 
-  -t, --template=template  [default: ce-dev.compose.prebuilt.yml] path to a docker-compose template file, relative to
+  -t, --template=template  [default: ce-dev.compose.prebuilt.yml] path to a docker compose template file, relative to
                            the project root
 
 EXAMPLE
@@ -231,7 +231,7 @@ OPTIONS
 
   -r, --registry=registry  Docker registry to use. This overrides the one defined in the source compose template.
 
-  -t, --template=template  [default: ce-dev.compose.prebuilt.yml] Path to a docker-compose template file, relative to
+  -t, --template=template  [default: ce-dev.compose.prebuilt.yml] Path to a docker compose template file, relative to
                            the project root. WARNING: this must match the original one the project was constructed with.
 
   -u, --username=username  Username to use to login against the Docker registry.
@@ -259,7 +259,7 @@ OPTIONS
 
   -r, --registry=registry  Docker registry to use. This overrides the one defined in the source compose template.
 
-  -t, --template=template  [default: ce-dev.compose.prebuilt.yml] Path to a docker-compose template file, relative to
+  -t, --template=template  [default: ce-dev.compose.prebuilt.yml] Path to a docker compose template file, relative to
                            the project root. WARNING: this must match the original one the project was constructed with.
 
   -u, --username=username  Username to use to login against the Docker registry.
@@ -292,7 +292,7 @@ _See code: [src/commands/shell.ts](https://github.com/codeenigma/ce-dev/blob/v1.
 
 ## `ce-dev start`
 
-Spin up containers using docker-compose and update /etc/hosts file.
+Spin up containers using docker compose and update /etc/hosts file.
 
 ```
 USAGE

docs/GettingStarted.md

@@ -1,6 +1,6 @@
 # Getting started
 
-Note: this tutorial always refers to `docker` and `docker-compose`, never to `sudo docker` and `sudo docker-compose`, for readability. Adapt the commands accordingly for your setup.
+Note: this tutorial always refers to `docker` and `docker compose`, never to `sudo docker` and `sudo docker compose`, for readability. Adapt the commands accordingly for your setup.
 We also use indifferently "host", "host machine", "laptop" or "workstation" to refer to the machine you're using ce-dev on; and "guest", "container" or "service" to refer to running containers. It will still work the same whether you actually use a laptop or not 😉
 
 ## Quickstart

docs/Install.md

@@ -13,17 +13,17 @@ We also assume common utilities are present:
 
 #### Docker
 
-Follow the installation instructions for your distro from https://docs.docker.com/engine/install/. It is generally straightforward, except for users of [Fedora 31 and above](https://duckduckgo.com/?q=docker+fedora+32).
+Follow the installation instructions for your distro from https://docs.docker.com/engine/install/. It is generally straightforward, except for users of [Fedora - more information here](https://fedoramagazine.org/docker-and-fedora-35/).
 
 **_Shall I `sudo docker` or `docker`?_**
 Most setup instructions you will find online instruct you to [add your user to the "docker" group](https://docs.docker.com/engine/install/linux-postinstall/) to be able to call docker as a standard user.
 There is a [non-neglectable risk](https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface) with that approach, even though it is far more convenient than being prompted for your password each and every step.
 
-By default, ce-dev will assume you went the "safe" way and use `sudo docker` or `sudo docker-compose`, but you can change that in your [global configuration](userconfig).
+By default, ce-dev will assume you went the "safe" way and use `sudo docker` or `sudo docker compose`, but you can change that in your [global configuration](userconfig).
 
 #### Docker Compose
 
-Follow the installation instruction for your distro from https://docs.docker.com/compose/install/.
+You will need Docker Compose v2 or higher. Linux users should install the `docker-compose-plugin` package from the Docker repository, if you do not have `docker compose` already: https://docs.docker.com/compose/install/linux/#install-using-the-repository
 
 #### mkcert
 
@@ -92,6 +92,7 @@ Be sure to allow enough resources for it to run smoothly. There's no magic rule,
 - Be generous on RAM, but do not allocate it all for Docker. If you do not set a limit and you run a resource hungry service, everything, including processes on the hosts (think Electron apps, Chrome and the like, and by cascade the Docker processes themselves) will end up swapping and being ultra slow. 8GB or 10GB out of 16GB should be reasonable values.
 - Do not throttle CPU usage (ie, allocate them all). Or, go the other way round and allocate only one. This seems contradictory, but it looks like it behave diffently based on your hardware and/or OS version. In certain cases, containers seem to be unable to make use of more than one core anyway, so allocating more than one ends up being counter-productive as it will impede processes on the host.
 - Make sure you have enough disk space allocated for the VM Disk image. This again will vary on usage, but with a dozen of projects that have a 10GB database each, you're already well over 100GB. On the other hand, **_you can always grow the virtual disk afterward, but you can NOT shrink it without destroying all containers and volumes_**, so you can start small and grow it as needed if you encounter some "no space left on device/disk full" errors.
+- You might want to turn on the "Use Rosetta for x86/amd64 emulation on Apple Silicon" option in Docker under "Features in development". This speeds up the emulation significantly.
 
 [![Docker Desktop setting pane](uploads/docker-mac-settings.png)](uploads/docker-mac-settings.png)
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "ce-dev",
   "description": "Local Stack wrapper tool",
-  "version": "1.1.23",
+  "version": "1.2.0",
   "author": " @pm98zz-c",
   "bin": {
     "ce-dev": "./bin/run"

src/base-cmd-abstract-docker-images.ts

@@ -8,7 +8,7 @@ export default abstract class DockerImagesCmd extends BaseCmd {
     help: flags.help({char: 'h'}),
     template: flags.string({
       char: 't',
-      description: 'Path to a docker-compose template file, relative to the project root. WARNING: this must match the original one the project was constructed with.',
+      description: 'Path to a docker compose template file, relative to the project root. WARNING: this must match the original one the project was constructed with.',
       default: 'ce-dev.compose.prebuilt.yml',
     }),
     username: flags.string({

src/base-cmd-abstract.ts

@@ -249,7 +249,7 @@ export default abstract class BaseCmd extends Command {
    *
    * @param file
    * Path to a file to parse
-   * @returns Parsed docker-compose declaration.
+   * @returns Parsed docker compose declaration.
    */
   protected loadComposeConfig(file: string): ComposeConfig {
     // @todo Check config is valid.

src/commands/build.ts

@@ -7,7 +7,7 @@ import ux from 'cli-ux'
 
 const fspath = require('path')
 export default class BuildCmd extends BaseCmd {
-  static description = 'Commit the existing containers as new docker images, and create a new docker-compose file referencing them.'
+  static description = 'Commit the existing containers as new docker images, and create a new docker compose file referencing them.'
 
   static examples = [
     '$ ce-dev build --template example.compose.yml',
@@ -17,12 +17,12 @@ export default class BuildCmd extends BaseCmd {
     help: flags.help({char: 'h'}),
     template: flags.string({
       char: 't',
-      description: 'Path to a docker-compose template file, relative to the project ce-dev folder. WARNING: this must match the original one the project was constructed with.',
+      description: 'Path to a docker compose template file, relative to the project ce-dev folder. WARNING: this must match the original one the project was constructed with.',
       default: 'ce-dev.compose.yml',
     }),
     destination: flags.string({
       char: 'd',
-      description: 'Path to the output docker-compose file, relative to the project ce-dev folder.',
+      description: 'Path to the output docker compose file, relative to the project ce-dev folder.',
       default: 'ce-dev.compose.prebuilt.yml',
     }),
     registry: flags.string({

src/commands/destroy.ts

@@ -5,7 +5,7 @@ import {flags} from '@oclif/command'
 import ux from 'cli-ux'
 
 export default class DestroyCmd extends BaseCmd {
-  static description = 'Destroy project\'s containers using docker-compose kill.'
+  static description = 'Destroy project\'s containers using docker compose kill.'
 
   static examples = [
     '$ ce-dev destroy',
@@ -39,13 +39,13 @@ export default class DestroyCmd extends BaseCmd {
   }
 
   /**
-   * Wrapper around docker-compose.
+   * Wrapper around docker compose.
    */
   private down(): void {
-    ux.action.start('Killing containers with docker-compose kill')
+    ux.action.start('Killing containers with docker compose kill')
     execSync(this.dockerComposeBin + ' -p ' + this.activeProjectInfo.project_name + ' kill', {cwd: this.ceDevDir, stdio: 'inherit'})
     ux.action.stop()
-    ux.action.start('Remove containers and anonymous volumes with docker-compose rm')
+    ux.action.start('Remove containers and anonymous volumes with docker compose rm')
     execSync(this.dockerComposeBin + ' -p ' + this.activeProjectInfo.project_name + ' rm -v --force', {cwd: this.ceDevDir, stdio: 'inherit'})
     ux.action.stop()
   }