# crictlによるKubernetesノードのデバッグ

LLMS index: [llms.txt](/llms.txt)

---

<!-- overview -->








  <div class="feature-state-notice feature-stable">
      <span class="feature-state-name">FEATURE STATE:</span>
      <code>Kubernetes v1.11 [stable]</code>
    </div>
  



`crictl`はCRI互換のコンテナランタイム用のコマンドラインインターフェースです。

これを使って、Kubernetesノード上のコンテナランタイムやアプリケーションの検査やデバッグを行うことができます。
`crictl`とそのソースコードは[cri-tools](https://github.com/kubernetes-sigs/cri-tools)リポジトリにホストされています。

## 始める前に


`crictl`にはCRIランタイムを搭載したLinuxが必要です。



<!-- steps -->

## crictlのインストール

cri-toolsの[リリースページ](https://github.com/kubernetes-sigs/cri-tools/releases)から、いくつかの異なるアーキテクチャ用の圧縮アーカイブ`crictl`をダウンロードできます。

お使いのKubernetesのバージョンに対応するバージョンをダウンロードしてください。
それを解凍してシステムパス上の`/usr/local/bin/`などの場所に移動します。

## 一般的な使い方

`crictl`コマンドにはいくつかのサブコマンドとランタイムフラグがあります。
詳細は`crictl help`または`crictl <subcommand> help`を参照してください。
`crictl`はデフォルトでは`unix:///var/run/dockershim.sock`に接続します。

他のランタイムの場合は、複数の異なる方法でエンドポイントを設定することができます:

- フラグ`--runtime-endpoint`と`--image-endpoint`の設定により
- 環境変数`CONTAINER_RUNTIME_ENDPOINT`と`IMAGE_SERVICE_ENDPOINT`の設定により
- 設定ファイル`--config=/etc/crictl.yaml`でエンドポイントの設定により

また、サーバーに接続する際のタイムアウト値を指定したり、デバッグを有効／無効にしたりすることもできます。
これには、設定ファイルで`timeout`や`debug`を指定するか、`--timeout`や`--debug`のコマンドラインフラグを使用します。

現在の設定を表示または編集するには、`/etc/crictl.yaml`の内容を表示または編集します。


```shell
cat /etc/crictl.yaml
runtime-endpoint: unix:///var/run/dockershim.sock
image-endpoint: unix:///var/run/dockershim.sock
timeout: 10
debug: true
```

## crictlコマンドの例

以下の例では、いくつかの`crictl`コマンドとその出力例を示しています。

<div class="alert alert-danger" role="note"><h4 class="alert-heading">警告:</h4>実行中のKubernetesクラスターに<code>crictl</code>を使ってポッドのサンドボックスやコンテナを作成しても、Kubeletは最終的にそれらを削除します。<code>crictl</code> は汎用のワークフローツールではなく、デバッグに便利なツールです。</div>


### podsの一覧

すべてのポッドをリストアップ:

```shell
crictl pods
```

出力はこのようになります:

```
POD ID              CREATED              STATE               NAME                         NAMESPACE           ATTEMPT
926f1b5a1d33a       About a minute ago   Ready               sh-84d7dcf559-4r2gq          default             0
4dccb216c4adb       About a minute ago   Ready               nginx-65899c769f-wv2gp       default             0
a86316e96fa89       17 hours ago         Ready               kube-proxy-gblk4             kube-system         0
919630b8f81f1       17 hours ago         Ready               nvidia-device-plugin-zgbbv   kube-system         0
```

Podを名前でリストアップします:

```shell
crictl pods --name nginx-65899c769f-wv2gp
```

出力はこのようになります:

```
POD ID              CREATED             STATE               NAME                     NAMESPACE           ATTEMPT
4dccb216c4adb       2 minutes ago       Ready               nginx-65899c769f-wv2gp   default             0
```

Podをラベルでリストアップします:

```shell
crictl pods --label run=nginx
```

出力はこのようになります:

```
POD ID              CREATED             STATE               NAME                     NAMESPACE           ATTEMPT
4dccb216c4adb       2 minutes ago       Ready               nginx-65899c769f-wv2gp   default             0
```

### イメージの一覧

すべてのイメージをリストアップします:

```shell
crictl images
```

出力はこのようになります:

```
IMAGE                                     TAG                 IMAGE ID            SIZE
busybox                                   latest              8c811b4aec35f       1.15MB
k8s-gcrio.azureedge.net/hyperkube-amd64   v1.10.3             e179bbfe5d238       665MB
k8s-gcrio.azureedge.net/pause-amd64       3.1                 da86e6ba6ca19       742kB
nginx                                     latest              cd5239a0906a6       109MB
```

イメージをリポジトリでリストアップします:

```shell
crictl images nginx
```

出力はこのようになります:

```
IMAGE               TAG                 IMAGE ID            SIZE
nginx               latest              cd5239a0906a6       109MB
```

イメージのIDのみをリストアップします:

```shell
crictl images -q
```

出力はこのようになります:

```
sha256:8c811b4aec35f259572d0f79207bc0678df4c736eeec50bc9fec37ed936a472a
sha256:e179bbfe5d238de6069f3b03fccbecc3fb4f2019af741bfff1233c4d7b2970c5
sha256:da86e6ba6ca197bf6bc5e9d900febd906b133eaa4750e6bed647b0fbe50ed43e
sha256:cd5239a0906a6ccf0562354852fae04bc5b52d72a2aff9a871ddb6bd57553569
```

### List containers

すべてのコンテナをリストアップします:

```shell
crictl ps -a
```

出力はこのようになります:

```
CONTAINER ID        IMAGE                                                                                                             CREATED             STATE               NAME                       ATTEMPT
1f73f2d81bf98       busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47                                   7 minutes ago       Running             sh                         1
9c5951df22c78       busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47                                   8 minutes ago       Exited              sh                         0
87d3992f84f74       nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f                                     8 minutes ago       Running             nginx                      0
1941fb4da154f       k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a   18 hours ago        Running             kube-proxy                 0
```

ランニングコンテナをリストアップします:

```
crictl ps
```

出力はこのようになります:

```
CONTAINER ID        IMAGE                                                                                                             CREATED             STATE               NAME                       ATTEMPT
1f73f2d81bf98       busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47                                   6 minutes ago       Running             sh                         1
87d3992f84f74       nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f                                     7 minutes ago       Running             nginx                      0
1941fb4da154f       k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a   17 hours ago        Running             kube-proxy                 0
```

### 実行中のコンテナでコマンドの実行

```shell
crictl exec -i -t 1f73f2d81bf98 ls
```

出力はこのようになります:

```
bin   dev   etc   home  proc  root  sys   tmp   usr   var
```

### コンテナログの取得

すべてのコンテナログを取得します:

```shell
crictl logs 87d3992f84f74
```

出力はこのようになります:

```
10.240.0.96 - - [06/Jun/2018:02:45:49 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
10.240.0.96 - - [06/Jun/2018:02:45:50 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
```

最新の`N`行のログのみを取得します:

```shell
crictl logs --tail=1 87d3992f84f74
```

出力はこのようになります:

```
10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
```

### Podサンドボックスの実行

`crictl`を使ってPodサンドボックスを実行することは、コンテナのランタイムをデバッグするのに便利です。
稼働中のKubernetesクラスターでは、サンドボックスは最終的にKubeletによって停止され、削除されます。

1. 以下のようなJSONファイルを作成します:

      ```json
      {
          "metadata": {
              "name": "nginx-sandbox",
              "namespace": "default",
              "attempt": 1,
              "uid": "hdishd83djaidwnduwk28bcsb"
          },
          "logDirectory": "/tmp",
          "linux": {
          }
      }
      ```

2. JSONを適用してサンドボックスを実行するには、`crictl runp`コマンドを使用します:

      ```shell
      crictl runp pod-config.json
      ```

      サンドボックスのIDが返されます。

### コンテナの作成

コンテナの作成に`crictl`を使うと、コンテナのランタイムをデバッグするのに便利です。
稼働中のKubernetesクラスターでは、サンドボックスは最終的にKubeletによって停止され、削除されます。

1. busyboxイメージをプルします:

      ```shell
      crictl pull busybox
      Image is up to date for busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47
      ```

2. Podとコンテナのコンフィグを作成します:

      **Pod config**:
      ```yaml
      {
          "metadata": {
              "name": "nginx-sandbox",
              "namespace": "default",
              "attempt": 1,
              "uid": "hdishd83djaidwnduwk28bcsb"
          },
          "log_directory": "/tmp",
          "linux": {
          }
      }
      ```

      **Container config**:
      ```yaml
      {
        "metadata": {
            "name": "busybox"
        },
        "image":{
            "image": "busybox"
        },
        "command": [
            "top"
        ],
        "log_path":"busybox.log",
        "linux": {
        }
      }
      ```

3. 先に作成されたPodのID、コンテナの設定ファイル、Podの設定ファイルを渡して、コンテナを作成します。コンテナのIDが返されます。

      ```shell
      crictl create f84dd361f8dc51518ed291fbadd6db537b0496536c1d2d6c05ff943ce8c9a54f container-config.json pod-config.json
      ```

4.  すべてのコンテナをリストアップし、新しく作成されたコンテナの状態が`Created`に設定されていることを確認します:

      ```shell
      crictl ps -a
      ```

      出力はこのようになります:
      ```
      CONTAINER ID        IMAGE               CREATED             STATE               NAME                ATTEMPT
      3e025dd50a72d       busybox             32 seconds ago      Created             busybox             0
      ```

### コンテナの起動

コンテナを起動するには、そのコンテナのIDを`crictl start`に渡します:

```shell
crictl start 3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60
```

出力はこのようになります:

```
3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60
```

コンテナの状態が「Running」に設定されていることを確認します:

```shell
crictl ps
```

出力はこのようになります:

```
CONTAINER ID        IMAGE               CREATED              STATE               NAME                ATTEMPT
3e025dd50a72d       busybox             About a minute ago   Running             busybox             0
```

<!-- discussion -->

詳しくは[kubernetes-sigs/cri-tools](https://github.com/kubernetes-sigs/cri-tools)をご覧ください。

## docker cliからcrictlへのマッピング

以下のマッピング表の正確なバージョンは、`docker cli v1.40`と`crictl v1.19.0`のものです。
この一覧はすべてを網羅しているわけではないことに注意してください。
たとえば、`docker cli`の実験的なコマンドは含まれていません。


<div class="alert alert-info" role="note"><h4 class="alert-heading">備考:</h4>CRICTLの出力形式はDocker CLIと似ていますが、いくつかのCLIでは列が欠けています。</div>


### デバッグ情報の取得



 





<table><caption style="display: none;">mapping from docker cli to crictl - retrieve debugging information</caption>
	<thead>
			<tr>
					<th>docker cli</th>
					<th>crictl</th>
					<th>説明</th>
					<th>サポートされていない機能</th>
			</tr>
	</thead>
	<tbody>
			<tr>
					<td><code>attach</code></td>
					<td><code>attach</code></td>
					<td>実行中のコンテナにアタッチ</td>
					<td><code>--detach-keys</code>, <code>--sig-proxy</code></td>
			</tr>
			<tr>
					<td><code>exec</code></td>
					<td><code>exec</code></td>
					<td>実行中のコンテナでコマンドの実行</td>
					<td><code>--privileged</code>, <code>--user</code>, <code>--detach-keys</code></td>
			</tr>
			<tr>
					<td><code>images</code></td>
					<td><code>images</code></td>
					<td>イメージのリストアップ</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>info</code></td>
					<td><code>info</code></td>
					<td>システム全体の情報の表示</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>inspect</code></td>
					<td><code>inspect</code>, <code>inspecti</code></td>
					<td>コンテナ、イメージ、タスクの低レベルの情報を返します</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>logs</code></td>
					<td><code>logs</code></td>
					<td>コンテナのログを取得します</td>
					<td><code>--details</code></td>
			</tr>
			<tr>
					<td><code>ps</code></td>
					<td><code>ps</code></td>
					<td>コンテナのリストアップ</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>stats</code></td>
					<td><code>stats</code></td>
					<td>コンテナのリソース使用状況をライブで表示</td>
					<td>Column: NET/BLOCK I/O, PIDs</td>
			</tr>
			<tr>
					<td><code>version</code></td>
					<td><code>version</code></td>
					<td>ランタイム(Docker、ContainerD、その他)のバージョン情報を表示します</td>
					<td> </td>
			</tr>
	</tbody>
</table>


### 変更を行います



 





<table><caption style="display: none;">mapping from docker cli to crictl - perform changes</caption>
	<thead>
			<tr>
					<th>docker cli</th>
					<th>crictl</th>
					<th>説明</th>
					<th>サポートされていない機能</th>
			</tr>
	</thead>
	<tbody>
			<tr>
					<td><code>create</code></td>
					<td><code>create</code></td>
					<td>新しいコンテナを作成します</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>kill</code></td>
					<td><code>stop</code> (timeout = 0)</td>
					<td>1つ以上の実行中のコンテナを停止します</td>
					<td><code>--signal</code></td>
			</tr>
			<tr>
					<td><code>pull</code></td>
					<td><code>pull</code></td>
					<td>レジストリーからイメージやリポジトリをプルします</td>
					<td><code>--all-tags</code>, <code>--disable-content-trust</code></td>
			</tr>
			<tr>
					<td><code>rm</code></td>
					<td><code>rm</code></td>
					<td>1つまたは複数のコンテナを削除します</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>rmi</code></td>
					<td><code>rmi</code></td>
					<td>1つまたは複数のイメージを削除します</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>run</code></td>
					<td><code>run</code></td>
					<td>新しいコンテナでコマンドを実行</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>start</code></td>
					<td><code>start</code></td>
					<td>停止した1つまたは複数のコンテナを起動</td>
					<td><code>--detach-keys</code></td>
			</tr>
			<tr>
					<td><code>stop</code></td>
					<td><code>stop</code></td>
					<td>実行中の1つまたは複数のコンテナの停止</td>
					<td> </td>
			</tr>
			<tr>
					<td><code>update</code></td>
					<td><code>update</code></td>
					<td>1つまたは複数のコンテナの構成を更新</td>
					<td><code>--restart</code>、<code>--blkio-weight</code>とその他</td>
			</tr>
	</tbody>
</table>


### crictlでのみ対応



 





<table><caption style="display: none;">mapping from docker cli to crictl - supported only in crictl</caption>
	<thead>
			<tr>
					<th>crictl</th>
					<th>説明</th>
			</tr>
	</thead>
	<tbody>
			<tr>
					<td><code>imagefsinfo</code></td>
					<td>イメージファイルシステムの情報を返します</td>
			</tr>
			<tr>
					<td><code>inspectp</code></td>
					<td>1つまたは複数のPodの状態を表示します</td>
			</tr>
			<tr>
					<td><code>port-forward</code></td>
					<td>ローカルポートをPodに転送します</td>
			</tr>
			<tr>
					<td><code>runp</code></td>
					<td>新しいPodを実行します</td>
			</tr>
			<tr>
					<td><code>rmp</code></td>
					<td>1つまたは複数のPodを削除します</td>
			</tr>
			<tr>
					<td><code>stopp</code></td>
					<td>稼働中の1つまたは複数のPodを停止します</td>
			</tr>
	</tbody>
</table>