LoginSignup
12
21

More than 3 years have passed since last update.

docker-composeのコマンドとオプション

Posted at

はじめに参考記事
http://docs.docker.jp/compose/reference/overview.html
https://docs.docker.com/compose/reference/

こちらに書いてあるものを参考にしています。より正確なものが見たい方は上記リンクから飛んでください。

また、英語に抵抗がない方はこちらから確認しても良いでしょう

$ docker-compose -h

基本的な使い方

docker-compose [-f=<引数>...] [オプション] [コマンド] [引数...]

このようにオプション、コマンド、引数の順番でdocker-composeの後ろにつけます。

オプション

-f, --file ファイル名
ファイル指定をするオプションです。デフォルトでは現在いるディレクトリのdocker-compose.ymlがファイルに指定されます。

-p, --project--name プロジェクト名
プロジェクト名は現在いるディレクトリがデフォルトになりますが、明示的に指定することもできます。

H, --host ホスト
接続先のデーモンやソケットを指定することができます。

他にもいくつかあるので気になる人は調べてみてください。

コマンド

何を扱うコマンドなのかが曖昧になりがちだと思ったので、何を扱うかは太字にしました。

build

サービスの構築、または再構築を行なう
--compress ビルドコンテキストを圧縮します
--no-cache キャッシュを利用しません
--pull 最新のイメージをpullします
--parallel 並行してイメージをbuildします

create

サービスの作成
※このコマンドは廃止されました

down

コンテナイメージボリュームを停止させ、削除します
--rmi type イメージを削除します。typeにはall,localを指定します
-v, --volumes volumesで宣言した名前付きvolumeを移動します
--remove-orphans サービスで定義されていないコンテナを削除します
--timeout タイムアウトする秒数を指定することができます

events

コンテナからのイベントを表示することができます。
--jsonをつけることでjsonオブジェクトを出力します

kill

コンテナを強制終了します

log

サービスからのログを出力します
--no-color モノクロで出力します
-f, --follow 最新のログを追います
-t, --timestamps タイムスタンプを表示します

pause

サービスを一時停止します

port

ポートに割り当てる公開用ポートを表示します

ps

コンテナの一覧を表示します。--aで停止したコンテナを表示します
-q, --quiet idのみを表示します
--services サービスを表示します
-a 停止した全てのコンテナを表示します

pull

サービスで使われているイメージを取得します
--ignore-pull-failures pullが可能なものはpullし失敗したものは無視します
--no-parallel 並行したpullを無効にします
-q, --quiet プロセスを出力しない
--include-deps 依存関係を持つイメージもpullします

restart

サービスを再起動します

rm

停止しているコンテナを削除します
-f, --force 確認しません
-s, --stop コンテナが止まっていない場合止めてから削除します
-v 匿名のvolumeを削除します

run

一度だけコマンドを実行します
-d, --detach コンテナをバックグラウンドで実行する
--name コンテナに名前を振り分ける
--entrypoint イメージのエントリポイントを上書きします
-e 環境変数を設定します
-u, --user 指定したuserとして実行します
--no-deps 開始しないサービスを指定します
--rm 実行後コンテナを削除します
-v, --volume ボリュームをバインドマウントします

scale

サービス用のコンテナの数を指定します ※このコマンドは廃止されました

start

サービスを開始します

stop

サービスを停止します

unpause

サービスを再開させます

up

コンテナを作成し、開始します
-d, --detach バックグランドで実行します
--quiet-pull 進行状況を出力しない
--no-deps 開始しないサービスを指定します
--always-recreate-deps 依存コンテナを再作成します
--no-recreate 既にコンテナがない場合は作成しません
--build コンテナを起動する前にイメージをビルドします
--abort-on-container-exit コンテナを全て停止します
-V、-renew-anon-volumes 匿名volumeを再作成します
--remove-orphans 定義されていないサービスのコンテナを削除します

最後に

オプションの量により、コマンドの重要度がわかりますね。
また、この記事は全てを網羅したわけではありません
https://docs.docker.com/compose/reference/
こちらがより正確ですので、ここにはない記述はここからお探しください。

少しでも何かの参考にしていただけたら嬉しいです。また、駆け出しdockerマンですので、間違った点や、直した方が良い表現などがありましたら教えていただけると嬉しいです。

12
21
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
12
21