Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nwesterhausen/total-compose-cli
Bash cli script to simplify running docker-compose on multiple docker-compose files, spread across many directories.
https://github.com/nwesterhausen/total-compose-cli
bash bash-script cli docker docker-compose
Last synced: 6 days ago
JSON representation
Bash cli script to simplify running docker-compose on multiple docker-compose files, spread across many directories.
- Host: GitHub
- URL: https://github.com/nwesterhausen/total-compose-cli
- Owner: nwesterhausen
- License: mit
- Created: 2021-08-30T13:28:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-02T17:47:40.000Z (7 months ago)
- Last Synced: 2024-12-29T02:35:03.290Z (8 days ago)
- Topics: bash, bash-script, cli, docker, docker-compose
- Language: Shell
- Homepage:
- Size: 81.1 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# total-compose-cli
total-compose is a docker-compose helper which lets you specify docker-compose.yml files using
keywords (names) and do so from the comfort of $HOME regardless of where the compose file
is at.
total-compose started as a hardcoded shell script but this is the attempt to make it generic and
usable by other people (and by myself on other machines). You can run the install script or
manually install. See the [installation](#installation) section for details on what happens during
the installation.
To read its config, total-compose will use [`yq`](http://mikefarah.github.io/yq/)
to parse and understand what commands you give it. Because docker will already be present,
by default, `yq` is invoked using `docker run --rm -v "${$CONFDIR}":/workdir mikefarah/yq`.
`$CONFDIR` is the directory container the config file, so by default is `~/.total-compose`.
The way total-compose calls `yq` can be modified by editing the `$YQ` variable in the
`total-compose` file.
## Installation
Run the `install.sh` script. Here's what it does:
1. checks that `docker`, `docker-compose`, and `git` are installed
Note: These must be set up ahead of time.
[docker-ce](https://docs.docker.com/engine/install/)
[docker-compose](https://docs.docker.com/compose/install/)
2. clones this repository to `~/.total-compose`
3. links the `total-compose.sh` script to a discovered bin folder in either `~/bin` or `~/.local/bin`
Note: If neither of those directories exist, either create one of them and add
it to your $PATH in .profile or manually link the total-compose.sh into a location
you can call it from.
## Additional Requirements
Running total-compose requires your user be a member of the docker group, otherwise
you will need to run total-compose as a superuser or other user with permissions on
the docker daemon.
## Usage
```
total-compose v1.0.0
Usage: total-compose [options] [servicegroup] [action]
Valid option flags:
-c, --config= Path of config file if not using ~/.total-compose/config.yaml
--no-color Disable color output
To see valid actions, run 'docker-compose help'.
servicegroup must not match a docker-compose subcommand and must match one of the
defined names in the config file. If it doesn't match a name in the config file,
it becomes part of the 'action' parameter.
total-compose simplifies calling docker-compose on the compose files specified in
the config file. Any command you can perform with docker-compose can be performed
with this tool. This tool calls 'docker-compose -f FILE_LOCATION [action]' depending
on which service name you provided. If no action is provided, this will check
current status for the services in the docker-compose file. (docker-compose ps)
Config used: config.yaml in /home/nwest/.total-compose
The following service stacks were read from the configuration file:
who ~/whoami/docker-compose.yml
Simple whoami service which sits and answers with whoami.
```
### Example
I have a [repository](https://github.com/nwesterhausen/compose-repo/tree/main) of compose files
and the config file I used with total-compose to manage composing in bulk.
```yaml
# ~/.total-compose/config.yaml
services:
- name: who
location: ~/whoami/docker-compose.yml
description: Simple whoami service which sits and answers with whoami.
assume-yes: false
```
```
nwest@ubuntu-server:~$ total-compose who config
CONFIG: Using config.yaml in /home/nwest/.total-compose.
who: /home/nwest/whoami/docker-compose.yml
services:
whoami:
image: traefik/whoami
version: '3.9'
nwest@ubuntu-server:~$ total-compose
CONFIG: Using config.yaml in /home/nwest/.total-compose.
No command specified, by default 'ps' will be passed to docker-compose
is not defined in config, passing it through to docker-compose
Confirm that you want to apply the action to all stacks (y/n)? y
Will execute same docker-compose command for all service stacks.
Performing this command on all services:
docker-compose ps
who: /home/nwest/whoami/docker-compose.yml
Name Command State Ports
------------------------------------------
whoami_whoami_1 /whoami Up 80/tcp
nwest@ubuntu-server:~$ total-compose who down
CONFIG: Using config.yaml in /home/nwest/.total-compose.
who: /home/nwest/whoami/docker-compose.yml
Stopping whoami_whoami_1 ... done
Removing whoami_whoami_1 ... done
Removing network whoami_default
```