What is the correct process to configure openmediavault-compose?

chente · Dec 27th 2023

I am doing some tests in OMV7 and I encounter this when configuring compose, I seem to remember that in OMV6 it did not give this error.

What I do is:

- Create shared folders for Compose Files, Data and Docker.

- Copy the absolute path of the Docker shared folder to the Docker field

- Select the shared folders created for Compose Files and Data

- Press the Save button

- Accept changes in Salt

It gives me the following error:

Code

          ID: docker
    Function: service.running
      Result: False
     Comment: Failed to start docker.service: Unit docker.service not found.
     Started: 14:58:59.468130
    Duration: 55.126 ms
     Changes:

Complete error:

Code

Failed to execute command 'export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin; export LANG=C.UTF-8; export LANGUAGE=; omv-salt deploy run --no-color compose 2>&1' with exit code '1': debian:
----------
          ID: /etc/systemd/system/docker.service.d/waitAllMounts.conf
    Function: file.managed
      Result: True
     Comment: File /etc/systemd/system/docker.service.d/waitAllMounts.conf updated
     Started: 14:58:58.472471
    Duration: 2.111 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: systemd_daemon_reload_docker
    Function: cmd.run
        Name: systemctl daemon-reload
      Result: True
     Comment: Command "systemctl daemon-reload" run
     Started: 14:58:58.475294
    Duration: 267.106 ms
     Changes:
              ----------
              pid:
                  94138
              retcode:
                  0
              stderr:
              stdout:
----------
          ID: configure_etc_docker_dir
    Function: file.directory
        Name: /etc/docker
      Result: True
     Comment:
     Started: 14:58:58.742516
    Duration: 0.936 ms
     Changes:
              ----------
              /etc/docker:
                  ----------
                  directory:
                      new
----------
          ID: /etc/docker/daemon.json
    Function: file.serialize
      Result: True
     Comment: File /etc/docker/daemon.json updated
     Started: 14:58:58.743531
    Duration: 2.088 ms
     Changes:
              ----------
              diff:
                  New file
----------
          ID: docker
    Function: service.running
      Result: False
     Comment: Failed to start docker.service: Unit docker.service not found.
     Started: 14:58:59.468130
    Duration: 55.126 ms
     Changes:
----------
          ID: create_usr_local_bin_dir
    Function: file.directory
        Name: /usr/local/bin
      Result: True
     Comment: The directory /usr/local/bin is in the correct state
     Started: 14:58:59.523367
    Duration: 0.708 ms
     Changes:
----------
          ID: /usr/local/bin/docker-compose
    Function: file.symlink
      Result: True
     Comment: Created new symlink /usr/local/bin/docker-compose -> /usr/libexec/docker/cli-plugins/docker-compose
     Started: 14:58:59.524163
    Duration: 1041.215 ms
     Changes:
              ----------
              new:
                  /usr/local/bin/docker-compose
----------
          ID: configure_compose_global_env_file
    Function: file.managed
        Name: /srv/dev-disk-by-uuid-04cfa6db-70d0-4f0c-aa72-fa9d8a7c30d9/compose/global.env
      Result: True
     Comment: File /srv/dev-disk-by-uuid-04cfa6db-70d0-4f0c-aa72-fa9d8a7c30d9/compose/global.env updated
     Started: 14:59:00.567168
    Duration: 82.384 ms
     Changes:
              ----------
              diff:
                  New file
              group:
                  root
----------
          ID: docker_install_packages
    Function: pkg.installed
      Result: True
     Comment: The following packages were installed/updated: docker-ce
     Started: 14:59:01.195405
    Duration: 14770.536 ms
     Changes:
              ----------
              containerd.io:
                  ----------
                  new:
                      1.6.26-1
                  old:
              docker-ce:
                  ----------
                  new:
                      5:24.0.7-1~debian.12~bookworm
                  old:
              docker-ce-cli:
                  ----------
                  new:
                      5:24.0.7-1~debian.12~bookworm
                  old:
----------
          ID: docker_compose_install_packages
    Function: pkg.installed
      Result: True
     Comment: 2 targeted packages were installed/updated.
              The following packages were already installed: containerd.io, docker-ce-cli
     Started: 14:59:15.970307
    Duration: 6923.549 ms
     Changes:
              ----------
              docker-buildx-plugin:
                  ----------
                  new:
                      0.11.2-1~debian.12~bookworm
                  old:
              docker-compose-plugin:
                  ----------
                  new:
                      2.21.0-1~debian.12~bookworm
                  old:
----------
          ID: docker_purged_packages
    Function: pkg.purged
      Result: True
     Comment: None of the targeted packages are installed or partially installed
     Started: 14:59:22.897965
    Duration: 1.027 ms
     Changes:
----------
          ID: configure_compose_scheduled_backup
    Function: file.managed
        Name: /etc/cron.d/omv-compose-backup
      Result: True
     Comment: File /etc/cron.d/omv-compose-backup updated
     Started: 14:59:22.900244
    Duration: 108.057 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: configure_compose_scheduled_update
    Function: file.managed
        Name: /etc/cron.d/omv-compose-update
      Result: True
     Comment: File /etc/cron.d/omv-compose-update updated
     Started: 14:59:23.008392
    Duration: 76.746 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: configure_compose_scheduled_prune
    Function: file.managed
        Name: /etc/cron.d/omv-compose-prune
      Result: True
     Comment: File /etc/cron.d/omv-compose-prune updated
     Started: 14:59:23.085230
    Duration: 77.471 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644

Summary for debian
-------------
Succeeded: 13 (changed=11)
Failed:     1
-------------
Total states run:     14
Total run time:   23.409 s
[ERROR   ] The named service docker is not available
[ERROR   ] Command '/bin/systemd-run' failed with return code: 5
[ERROR   ] stderr: Running scope as unit: run-r83246cdc28cd40b09d2d67727c56ccb6.scope
Failed to stop docker.service: Unit docker.service not loaded.
[ERROR   ] retcode: 5
[ERROR   ] Command '/bin/systemd-run' failed with return code: 5
[ERROR   ] stderr: Running scope as unit: run-r90a69cbbb6534481b4b29cf8bfde4ff3.scope
Failed to start docker.service: Unit docker.service not found.
[ERROR   ] retcode: 5
[ERROR   ] Failed to start docker.service: Unit docker.service not found.

OMV\ExecException: Failed to execute command 'export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin; export LANG=C.UTF-8; export LANGUAGE=; omv-salt deploy run --no-color compose 2>&1' with exit code '1': debian:
----------
          ID: /etc/systemd/system/docker.service.d/waitAllMounts.conf
    Function: file.managed
      Result: True
     Comment: File /etc/systemd/system/docker.service.d/waitAllMounts.conf updated
     Started: 14:58:58.472471
    Duration: 2.111 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: systemd_daemon_reload_docker
    Function: cmd.run
        Name: systemctl daemon-reload
      Result: True
     Comment: Command "systemctl daemon-reload" run
     Started: 14:58:58.475294
    Duration: 267.106 ms
     Changes:
              ----------
              pid:
                  94138
              retcode:
                  0
              stderr:
              stdout:
----------
          ID: configure_etc_docker_dir
    Function: file.directory
        Name: /etc/docker
      Result: True
     Comment:
     Started: 14:58:58.742516
    Duration: 0.936 ms
     Changes:
              ----------
              /etc/docker:
                  ----------
                  directory:
                      new
----------
          ID: /etc/docker/daemon.json
    Function: file.serialize
      Result: True
     Comment: File /etc/docker/daemon.json updated
     Started: 14:58:58.743531
    Duration: 2.088 ms
     Changes:
              ----------
              diff:
                  New file
----------
          ID: docker
    Function: service.running
      Result: False
     Comment: Failed to start docker.service: Unit docker.service not found.
     Started: 14:58:59.468130
    Duration: 55.126 ms
     Changes:
----------
          ID: create_usr_local_bin_dir
    Function: file.directory
        Name: /usr/local/bin
      Result: True
     Comment: The directory /usr/local/bin is in the correct state
     Started: 14:58:59.523367
    Duration: 0.708 ms
     Changes:
----------
          ID: /usr/local/bin/docker-compose
    Function: file.symlink
      Result: True
     Comment: Created new symlink /usr/local/bin/docker-compose -> /usr/libexec/docker/cli-plugins/docker-compose
     Started: 14:58:59.524163
    Duration: 1041.215 ms
     Changes:
              ----------
              new:
                  /usr/local/bin/docker-compose
----------
          ID: configure_compose_global_env_file
    Function: file.managed
        Name: /srv/dev-disk-by-uuid-04cfa6db-70d0-4f0c-aa72-fa9d8a7c30d9/compose/global.env
      Result: True
     Comment: File /srv/dev-disk-by-uuid-04cfa6db-70d0-4f0c-aa72-fa9d8a7c30d9/compose/global.env updated
     Started: 14:59:00.567168
    Duration: 82.384 ms
     Changes:
              ----------
              diff:
                  New file
              group:
                  root
----------
          ID: docker_install_packages
    Function: pkg.installed
      Result: True
     Comment: The following packages were installed/updated: docker-ce
     Started: 14:59:01.195405
    Duration: 14770.536 ms
     Changes:
              ----------
              containerd.io:
                  ----------
                  new:
                      1.6.26-1
                  old:
              docker-ce:
                  ----------
                  new:
                      5:24.0.7-1~debian.12~bookworm
                  old:
              docker-ce-cli:
                  ----------
                  new:
                      5:24.0.7-1~debian.12~bookworm
                  old:
----------
          ID: docker_compose_install_packages
    Function: pkg.installed
      Result: True
     Comment: 2 targeted packages were installed/updated.
              The following packages were already installed: containerd.io, docker-ce-cli
     Started: 14:59:15.970307
    Duration: 6923.549 ms
     Changes:
              ----------
              docker-buildx-plugin:
                  ----------
                  new:
                      0.11.2-1~debian.12~bookworm
                  old:
              docker-compose-plugin:
                  ----------
                  new:
                      2.21.0-1~debian.12~bookworm
                  old:
----------
          ID: docker_purged_packages
    Function: pkg.purged
      Result: True
     Comment: None of the targeted packages are installed or partially installed
     Started: 14:59:22.897965
    Duration: 1.027 ms
     Changes:
----------
          ID: configure_compose_scheduled_backup
    Function: file.managed
        Name: /etc/cron.d/omv-compose-backup
      Result: True
     Comment: File /etc/cron.d/omv-compose-backup updated
     Started: 14:59:22.900244
    Duration: 108.057 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: configure_compose_scheduled_update
    Function: file.managed
        Name: /etc/cron.d/omv-compose-update
      Result: True
     Comment: File /etc/cron.d/omv-compose-update updated
     Started: 14:59:23.008392
    Duration: 76.746 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644
----------
          ID: configure_compose_scheduled_prune
    Function: file.managed
        Name: /etc/cron.d/omv-compose-prune
      Result: True
     Comment: File /etc/cron.d/omv-compose-prune updated
     Started: 14:59:23.085230
    Duration: 77.471 ms
     Changes:
              ----------
              diff:
                  New file
              mode:
                  0644

Summary for debian
-------------
Succeeded: 13 (changed=11)
Failed:     1
-------------
Total states run:     14
Total run time:   23.409 s
[ERROR   ] The named service docker is not available
[ERROR   ] Command '/bin/systemd-run' failed with return code: 5
[ERROR   ] stderr: Running scope as unit: run-r83246cdc28cd40b09d2d67727c56ccb6.scope
Failed to stop docker.service: Unit docker.service not loaded.
[ERROR   ] retcode: 5
[ERROR   ] Command '/bin/systemd-run' failed with return code: 5
[ERROR   ] stderr: Running scope as unit: run-r90a69cbbb6534481b4b29cf8bfde4ff3.scope
Failed to start docker.service: Unit docker.service not found.
[ERROR   ] retcode: 5
[ERROR   ] Failed to start docker.service: Unit docker.service not found. in /usr/share/php/openmediavault/system/process.inc:247
Stack trace:
#0 /usr/share/php/openmediavault/engine/module/serviceabstract.inc(62): OMV\System\Process->execute()
#1 /usr/share/openmediavault/engined/rpc/config.inc(178): OMV\Engine\Module\ServiceAbstract->deploy()
#2 [internal function]: Engined\Rpc\Config->applyChanges()
#3 /usr/share/php/openmediavault/rpc/serviceabstract.inc(122): call_user_func_array()
#4 /usr/share/php/openmediavault/rpc/serviceabstract.inc(149): OMV\Rpc\ServiceAbstract->callMethod()
#5 /usr/share/php/openmediavault/rpc/serviceabstract.inc(622): OMV\Rpc\ServiceAbstract->OMV\Rpc\{closure}()
#6 /usr/share/php/openmediavault/rpc/serviceabstract.inc(146): OMV\Rpc\ServiceAbstract->execBgProc()
#7 /usr/share/openmediavault/engined/rpc/config.inc(199): OMV\Rpc\ServiceAbstract->callMethodBg()
#8 [internal function]: Engined\Rpc\Config->applyChangesBg()
#9 /usr/share/php/openmediavault/rpc/serviceabstract.inc(122): call_user_func_array()
#10 /usr/share/php/openmediavault/rpc/rpc.inc(86): OMV\Rpc\ServiceAbstract->callMethod()
#11 /usr/sbin/omv-engined(535): OMV\Rpc\Rpc::call()
#12 {main}

Display More

After that error I can press the Reinstall docker button and everything works normally. But in OMV6 I don't remember this being like that.

Has anything changed in OMV7? I seem to remember that the procedure was like this and it did not give this error.

ryecoaaron · Dec 27th 2023

Quote from chente

Has anything changed in OMV7? I seem to remember that the procedure was like this and it did not give this error.

I didn't change anything but I have seen this on the forum for OMV 6.x and previous versions though. I will have to try to recreate and see if there is something I can optimize.

chente · Dec 27th 2023

OK thanks

ryecoaaron · Dec 27th 2023

I'm guessing it happens because the daemon.json file is created after installing the packages. The package installation starts the service in the default location if the daemon.json file doesn't exist. I can reverse the order and it might help.

chente · Dec 27th 2023

Would that cause the default installation to /var/lib/docker and then relocation? That would not be desirable.

Although it's better than having a error.

ryecoaaron · Dec 27th 2023

Quote from chente

Would that cause the default installation to /var/lib/docker and then relocation? That would not be desirable.

Actually that is what it is doing now on systems that don't have docker installed. I am looking at improving it right now.

chente · Dec 27th 2023

ok, let me know if you want me to do tests.

ryecoaaron · Dec 27th 2023

Quote from chente

let me know if you want me to do tests.

I tested it on a fresh install but here is the package - https://omv-extras.org/testing…ult-compose_7.0.3_all.deb

chente · Dec 27th 2023

Quote from ryecoaaron

I tested it on a fresh install but here is the package - https://omv-extras.org/testing…ult-compose_7.0.3_all.deb

It works perfect. Docker installed without errors in its correct location and the /var/lib/docker folder does not exist in rootfs after configuration.

ryecoaaron · Dec 27th 2023

7.0.3 is in the repo.

nicochat1988 · Dec 28th 2023

Hi,

I guess this also may occur for 6.x :

Thread

Failed to execute command 'export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin;

Hi,

Following this guide :

forum.openmediavault.org/index.php?thread/48003/
I get an error at step 12 when trying to define compose setting.

(Code, 183 lines)

nicochat1988

Dec 27th 2023

chente · Dec 28th 2023

Quote from nicochat1988

I guess this also may occur for 6.x :

Probably yes. But don't worry, if you need to press the Reinstall docker button you can do it and everything will be fine. You will simply have the /var/lib/docker folder in rootfs with some useless files but it does not affect you at all. This will no longer happen in OMV7.

chente · Dec 28th 2023

In fact, I just saw that I wrote it like this in the documentation a long time ago, I will have to change that text, it is no longer necessary to press that button. https://wiki.omv-extras.org/do…ins:docker_compose#docker

Edit: It is already modified.

nicochat1988 · Dec 28th 2023

Thanks.

So this mean that the system thinks docker is not enabled but it is in fact ?

I am not sure I understand what you mean by :

You will simply have the /var/lib/docker folder.

If do not change the default docker path (/var/lib/docker) and if I have the error message and if I do not press Reinstall docker, I guess it will be fine. Or am I missing something ?

chente · Dec 28th 2023

It is advisable to have docker installed on a different drive than rootfs for several reasons. Among them, when reinstalling you will not lose data. Also the docker folder could fill your rootfs. Additionally, if you have OMV installed on a pendrive you will avoid excessive writing. Etc.

That's why the plugin allows you to change the default location /var/lib/docker to another location.

If you prefer to leave docker in its default location simply do not modify that field.

When you have everything configured, press the Reinstall Docker button and everything will work with the parameters you have configured, don't worry about anything else.

nicochat1988 · Dec 28th 2023

Thanks

What is the correct process to configure openmediavault-compose?

chente Dec 27th 2023

chente Dec 27th 2023

Participate now!