Skip to content

Commit

Permalink
Maestro 0.8.0
Browse files Browse the repository at this point in the history
Signed-off-by: Maxime Petazzoni <[email protected]>
  • Loading branch information
mpetazzoni committed Mar 4, 2021
1 parent 85266e5 commit a727e85
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 15 deletions.
28 changes: 17 additions & 11 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,51 +12,57 @@ contains the path to your ``maestro-ng`` repository clone and using
.. code::
$ maestro -h
usage: maestro [-h] [-f FILE] [-v]
{status,pull,start,stop,restart,logs,deptree} ...
usage: maestro-ng [-h] [-f FILE] [-v]
{status,start,stop,restart,pull,clean,logs,deptree} ...
Maestro, Docker container orchestrator.
Maestro-Ng v0.8.0, Docker container orchestrator.
positional arguments:
{status,pull,start,stop,restart,logs,deptree}
{status,start,stop,restart,pull,clean,logs,deptree}
status display container status
pull pull images from repository
pull pull container images from registry
start start services and containers
stop stop services and containers
kill kill services and containers
restart restart services and containers
clean remove stopped containers
logs show logs from a container
deptree show the dependency tree
complete shell auto-completion helper
optional arguments:
-h, --help show this help message and exit
-f FILE, --file FILE read environment description from FILE (use - for
stdin, defaults to ./maestro.yaml)
-f FILE, --file FILE read environment description from FILE (use - for stdin, defaults to ./maestro.yaml)
-v, --version show program version and exit
You can then get help on each individual command with:

.. code::
$ maestro start -h
usage: maestro start [-h] [-c LIMIT] [-d] [-i] [-r] [thing [thing ...]]
usage: maestro-ng start [-h] [-c LIMIT] [-d] [-i] [-r | --reuse]
[-C CONTAINER_FILTER] [-S SHIP_FILTER]
[thing ...]
Start services and containers
positional arguments:
thing container(s) or service(s) to display
thing container(s) or service(s) to act on
optional arguments:
-h, --help show this help message and exit
-c LIMIT, --concurrency LIMIT
limit how many containers can be acted on at the same
time to LIMIT
limit how many containers can be acted on at the same time
-d, --with-dependencies
include dependencies
-i, --ignore-dependencies
ignore dependency order
-r, --refresh-images force refresh of container images from registry
--reuse reuse existing container if it exists
-C CONTAINER_FILTER, --container-filter CONTAINER_FILTER
filter for container names (fnmatch semantics)
-S SHIP_FILTER, --ship-filter SHIP_FILTER
filter for container names by ship name (fnmatch semantics)
By default, Maestro will read the environment description configuration
from the ``maestro.yaml`` file in the current directory. You can
Expand Down
6 changes: 3 additions & 3 deletions maestro/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ def create_parser():
filterable = argparse.ArgumentParser(add_help=False)
filterable.add_argument(
'-C', '--container-filter',
help='filter for container names. Uses fnmatch semantics')
help='filter for container names (fnmatch semantics)')
filterable.add_argument(
'-S', '--ship-filter',
help='filter for container names by ship name. Uses fnmatch semantics')
help='filter for container names by ship name (fnmatch semantics)')

expandable = argparse.ArgumentParser(add_help=False)
expandable.add_argument(
Expand Down Expand Up @@ -123,7 +123,7 @@ def create_parser():
parents=[common, concurrent, expandable, filterable],
name='kill',
description='Kill services and containers',
help='kills the services and containers')
help='kill services and containers')

# restart
subparser = subparsers.add_parser(
Expand Down
2 changes: 1 addition & 1 deletion maestro/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
# Copyright (C) 2015-2018 SignalFx, Inc.

name = 'maestro-ng'
version = '0.7.5'
version = '0.8.0'

0 comments on commit a727e85

Please sign in to comment.