docker renameコマンドの使い方(実例で解説)

docker renameコマンド解説

 本記事はDocker ver24.0.7の環境で確認しています。

 このコマンドは、コンテナに設定したコンテナ名を変更することが可能です。

 コンテナ名は、コンテナの生成時もしくは起動時に、「--name」オプションにて設定することが可能なコンテナ毎の識別名です。

 設定しなかった場合は、Dockerにて自動的に名前が設定されます。

 変更するコンテナ名は、Dockerホスト内ではユニーク(重複しない状態)でなければいけません。

docker renameコマンドのフォーマットとオプション

フォーマット

docker rename [ 現在のコンテナ名 ] [ 新しいコンテナ名 ]

主なオプション一覧

オプション概説
なし

コマンド例

$ docker rename testvm testvm-rename

docker renameコマンドの主な使い方

 以下で実例をまじえたコマンドの使い方を解説していきたいと思います。

実例では、Ubuntuの公式イメージにより起動したコンテナ(testvm)を使用します。

コンテナは「docker run -dit --init --name testvm ubuntu」で起動します。

※「--rm」オプションを付けておりませんので、ご利用後はコンテナ削除をお忘れなく。

基本事項の解説

 冒頭でふれましたが、コンテナには名前を付けることができます。その名前で各コンテナを操作します。

 コンテナ作成時、もしくは起動時に名前を付けることができるのですが、指定しなかった場合は、ランダムな名前が付きます。

 docker renameは、その名前を変更するコマンドになります。

 名前は、コンテナの状態が実行中や停止中、一時停止中でも変更可能です。

実行中のコンテナの名前を変更する

 Dockerホスト内に実行中のコンテナtestvmがあります。

$ docker ps
CONTAINER ID  IMAGE   COMMAND     CREATED        STATUS        PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 5 minutes ago  Up 5 minutes         testvm

 このコンテナの名前を「testvm-rename」に変えてみます。

$ docker rename testvm testvm-rename

 docker psコマンドで確認しましょう。

$ docker ps
CONTAINER ID  IMAGE   COMMAND     CREATED        STATUS        PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 7 minutes ago  Up 7 minutes         testvm-rename

 「testvm-rename」に変更されていることが確認できました。

停止中のコンテナの名前を変更する

 停止しているコンテナの名前も変更可能です。

 実行中のコンテナtestvm-renameを停止します。

$ docker ps
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                     PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 24 minutes ago  Up 8 minutes                      testvm-rename
$ docker stop testvm-rename
testvm-rename
$ docker ps -a
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                     PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 25 minutes ago  Exited (0) 3 seconds ago          testvm-rename

 停止中のコンテナtestvm-renameの名前を「testvm」に変更してみます。

$ docker rename testvm-rename testvm

 docker psコマンドで確認します。

$ docker ps -a
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                     PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 28 minutes ago  Exited (137) 3 minutes ago        testvm

 念のため、コンテナを起動して、コンテナ内でシェルを起動しました。

$ docker start testvm
testvm
$ docker ps
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                     PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 30 minutes ago  Up 5 seconds                      testvm
$ docker exec -it testvm bash
[root@1c60ef31a3f9 /]#

 コンテナ内で起動したシェルのプロンプトが表示されることが確認できました。

一時停止中のコンテナの名前を変更する

 念のため、一時停止中のコンテナの名前も変更してみます。

 実行中のコンテナtestvmをdocker pauseコマンドで一時停止します。

$ docker ps
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                 PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 38 minutes ago  Up 7 minutes                  testvm
$ docker pause testvm
testvm
$ docker ps -a
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                 PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 38 minutes ago  Up 7 minutes (Paused)         testvm

 コンテナtestvmが一時停止状態になりました。(上の赤字部分でわかります)

 一時停止中のコンテナtestvmの名前を「testvm-rename3」に変更します。

$ docker rename testvm testvm-rename3

 docker psコマンドで確認したところです。

$ docker ps -a
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                 PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 41 minutes ago  Up 11 minutes (Paused)        testvm-rename3

 コンテナ名がtestvm-rename3に変更されました。

 念のため、コンテナの一時停止を解除して、コンテナ内でシェルを起動します。

$ docker unpause testvm-rename3
testvm-rename3
$ docker ps -a
CONTAINER ID  IMAGE   COMMAND     CREATED         STATUS                 PORTS  NAMES
1c60ef31a3f9  ubuntu  "/bin/bash" 45 minutes ago  Up 15 minutes                 testvm-rename3
$ docker exec -it testvm-rename3 bash
[root@1c60ef31a3f9 /]#

 コンテナ内で起動したシェルのプロンプトが表示されることが確認できました。

おわりに

  以上でdocker renameコマンドの紹介を終わります。

 ご指摘、ご要望などが御座いましたらコメントいただけるとうれしいです。

 他のDockerコマンドの実例付紹介記事は、本サイト内の別記事「Dockerのコマンドの一覧(オリジナルな実例付き)」をご参照ください。

 ご訪問ありがとうございました!

コメント