Skip to content

Commit 26dba66

Browse files
Seo-yulSeo-yul
authored
[ko] Translate /docs/tasks/debug/debug-cluster/crictl into Korean (#36690)
* Translate content/ko/docs/tasks/debug/debug-cluster/crictl.md into Apply suggestions from code review Co-authored-by: Seokho Son <[email protected]> rebase dev-1.25-ko.1 * Apply suggestions from code review criti-tools -> cri-tools 와 자연스러운 표현 Co-authored-by: Seokho Son <[email protected]>
1 parent 7a15727 commit 26dba66

File tree

1 file changed

+378
-0
lines changed
  • content/ko/docs/tasks/debug/debug-cluster

1 file changed

+378
-0
lines changed

‎content/ko/docs/tasks/debug/debug-cluster/crictl.md

Lines changed: 378 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,378 @@
1+
---
2+
# reviewers:
3+
# - Random-Liu
4+
# - feiskyer
5+
# - mrunalp
6+
title: crictl로 쿠버네티스 노드 디버깅하기
7+
content_type: task
8+
weight: 30
9+
---
10+
11+
12+
<!-- overview -->
13+
14+
{{< feature-state for_k8s_version="v1.11" state="stable" >}}
15+
16+
`crictl`은 CRI-호환 컨테이너 런타임에 사용할 수 있는 커맨드라인 인터페이스이다.
17+
쿠버네티스 노드에서 컨테이너 런타임과 애플리케이션을 검사하고
18+
디버그하는 데 사용할 수 있다.
19+
`crictl`과 그 소스는 [cri-tools](https://github.com/kubernetes-sigs/cri-tools) 저장소에서 호스팅한다.
20+
21+
## {{% heading "prerequisites" %}}
22+
23+
`crictl`은 CRI 런타임이 있는 리눅스 운영체제를 필요로 한다.
24+
25+
<!-- steps -->
26+
27+
## crictl 설치하기
28+
29+
cri-tools [릴리스 페이지](https://github.com/kubernetes-sigs/cri-tools/releases)에서
30+
다양한 아키텍처 별로 압축된 `crictl` 아카이브(archive)를 다운로드할 수 있다.
31+
설치된 쿠버네티스 버전에 해당하는 버전을 다운로드한다.
32+
`/usr/local/bin/`와 같은 시스템 경로의 위치에
33+
압축을 푼다.
34+
35+
## 일반적인 사용법
36+
37+
`crictl` 커맨드에는 여러 하위 커맨드와 런타임 플래그가 있다.
38+
자세한 내용은 `crictl help` 또는 `crictl <subcommand> help`를 참조한다.
39+
40+
아래 내용 중 하나를 통해 `crictl`의 엔드포인트를 설정할 수 있다.
41+
42+
* `--runtime-endpoint`와 `--image-endpoint` 플래그 설정.
43+
* `CONTAINER_RUNTIME_ENDPOINT`와 `IMAGE_SERVICE_ENDPOINT` 환경 변수
44+
설정.
45+
* 구성 파일 `/etc/crictl.yaml`에 엔드포인트 설정.
46+
다른 파일을 지정하기 위해서는 `crictl`을 실행할 때 `--config=PATH_TO_FILE` 플래그를 사용한다.
47+
48+
{{<note>}}
49+
엔드포인트를 설정하지 않으면,
50+
`crictl`이 알려진 엔드포인트 목록에 연결을 시도하므로 성능에 영향을 줄 수 있다.
51+
{{</note>}}
52+
53+
서버에 연결할 때 구성 파일에서 `timeout` 또는 `debug` 값을 명시하거나,
54+
`--timeout` 그리고 `--debug` 커맨드라인 플래그를 사용하여
55+
타임아웃 값을 지정하고 디버깅을 활성화하거나 비활성화할 수 있다.
56+
57+
현재 구성을 보거나 편집하려면 `/etc/crictl.yaml`의 내용을 보거나 편집한다.
58+
예를 들어,
59+
`containerd` 컨테이너 런타임 사용 시 구성은 아래와 유사하다.
60+
61+
```
62+
runtime-endpoint: unix:///var/run/containerd/containerd.sock
63+
image-endpoint: unix:///var/run/containerd/containerd.sock
64+
timeout: 10
65+
debug: true
66+
```
67+
68+
`crictl`에 대해 자세히 알고 싶다면,
69+
[`crictl` 문서](https://github.com/kubernetes-sigs/cri-tools/blob/master/docs/crictl.md)를 참조한다.
70+
71+
## crictl 커맨드 예시
72+
73+
아래 예시를 통해 `crictl` 커맨드와 출력을 확인해보자.
74+
75+
{{< warning >}}
76+
구동 중인 쿠버네티스 클러스터에서 `crictl`을 사용하여 파드 샌드박스(sandbox)나 컨테이너를 만들게 되면,
77+
결국에는 kubelet이 그것들을 삭제하게 된다.
78+
`crictl`은 일반적인 워크플로우 툴이 아니라 디버깅에 유용한 툴임을 명심해야 한다.
79+
{{< /warning >}}
80+
81+
### 파드 목록 조회
82+
83+
모든 파드의 목록 조회
84+
85+
```shell
86+
crictl pods
87+
```
88+
89+
출력은 다음과 유사하다.
90+
91+
```
92+
POD ID CREATED STATE NAME NAMESPACE ATTEMPT
93+
926f1b5a1d33a About a minute ago Ready sh-84d7dcf559-4r2gq default 0
94+
4dccb216c4adb About a minute ago Ready nginx-65899c769f-wv2gp default 0
95+
a86316e96fa89 17 hours ago Ready kube-proxy-gblk4 kube-system 0
96+
919630b8f81f1 17 hours ago Ready nvidia-device-plugin-zgbbv kube-system 0
97+
```
98+
99+
이름으로 파드의 목록 조회
100+
101+
```shell
102+
crictl pods --name nginx-65899c769f-wv2gp
103+
```
104+
105+
출력은 다음과 유사하다.
106+
107+
```
108+
POD ID CREATED STATE NAME NAMESPACE ATTEMPT
109+
4dccb216c4adb 2 minutes ago Ready nginx-65899c769f-wv2gp default 0
110+
```
111+
112+
레이블로 파드의 목록 조회
113+
114+
```shell
115+
crictl pods --label run=nginx
116+
```
117+
118+
출력은 다음과 유사하다.
119+
120+
```
121+
POD ID CREATED STATE NAME NAMESPACE ATTEMPT
122+
4dccb216c4adb 2 minutes ago Ready nginx-65899c769f-wv2gp default 0
123+
```
124+
125+
### 이미지 목록 조회
126+
127+
모든 이미지의 목록 조회
128+
129+
```shell
130+
crictl images
131+
```
132+
133+
출력은 다음과 유사하다.
134+
135+
```
136+
IMAGE TAG IMAGE ID SIZE
137+
busybox latest 8c811b4aec35f 1.15MB
138+
k8s-gcrio.azureedge.net/hyperkube-amd64 v1.10.3 e179bbfe5d238 665MB
139+
k8s-gcrio.azureedge.net/pause-amd64 3.1 da86e6ba6ca19 742kB
140+
nginx latest cd5239a0906a6 109MB
141+
```
142+
143+
저장소로 이미지 목록 조회
144+
145+
```shell
146+
crictl images nginx
147+
```
148+
149+
출력은 다음과 유사하다.
150+
151+
```
152+
IMAGE TAG IMAGE ID SIZE
153+
nginx latest cd5239a0906a6 109MB
154+
```
155+
156+
이미지의 IDs 목록만 조회
157+
158+
```shell
159+
crictl images -q
160+
```
161+
162+
출력은 다음과 유사하다.
163+
164+
```
165+
sha256:8c811b4aec35f259572d0f79207bc0678df4c736eeec50bc9fec37ed936a472a
166+
sha256:e179bbfe5d238de6069f3b03fccbecc3fb4f2019af741bfff1233c4d7b2970c5
167+
sha256:da86e6ba6ca197bf6bc5e9d900febd906b133eaa4750e6bed647b0fbe50ed43e
168+
sha256:cd5239a0906a6ccf0562354852fae04bc5b52d72a2aff9a871ddb6bd57553569
169+
```
170+
171+
### 컨테이너 목록 조회
172+
173+
모든 컨테이너 목록 조회
174+
175+
```shell
176+
crictl ps -a
177+
```
178+
179+
출력은 다음과 유사하다.
180+
181+
```
182+
CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT
183+
1f73f2d81bf98 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 7 minutes ago Running sh 1
184+
9c5951df22c78 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 8 minutes ago Exited sh 0
185+
87d3992f84f74 nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f 8 minutes ago Running nginx 0
186+
1941fb4da154f k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a 18 hours ago Running kube-proxy 0
187+
```
188+
189+
실행 중인 컨테이너 목록 조회
190+
191+
```shell
192+
crictl ps
193+
```
194+
195+
출력은 다음과 유사하다.
196+
197+
```
198+
CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT
199+
1f73f2d81bf98 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 6 minutes ago Running sh 1
200+
87d3992f84f74 nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f 7 minutes ago Running nginx 0
201+
1941fb4da154f k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a 17 hours ago Running kube-proxy 0
202+
```
203+
204+
### 실행 중인 컨테이너 안에서 명령 실행
205+
206+
```shell
207+
crictl exec -i -t 1f73f2d81bf98 ls
208+
```
209+
210+
출력은 다음과 유사하다.
211+
212+
```
213+
bin dev etc home proc root sys tmp usr var
214+
```
215+
216+
### 컨테이너의 로그 조회
217+
218+
모든 컨테이너의 로그 조회
219+
220+
```shell
221+
crictl logs 87d3992f84f74
222+
```
223+
224+
출력은 다음과 유사하다.
225+
226+
```
227+
10.240.0.96 - - [06/Jun/2018:02:45:49 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
228+
10.240.0.96 - - [06/Jun/2018:02:45:50 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
229+
10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
230+
```
231+
232+
최신 `N`개 줄의 로그만 조회
233+
234+
```shell
235+
crictl logs --tail=1 87d3992f84f74
236+
```
237+
238+
출력은 다음과 유사하다.
239+
240+
```
241+
10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
242+
```
243+
244+
### 파드 샌드박스 실행
245+
246+
`crictl`을 사용하여 파드 샌드박스를 실행하는 것은 컨테이너 런타임 디버깅에 유용하다.
247+
구동 중인 쿠버네티스 클러스터에서
248+
이러한 샌드박스는 kubelet에 의해서 결국 중지 및 삭제된다.
249+
250+
1. 다음과 같은 JSON 파일 생성한다.
251+
252+
```json
253+
{
254+
"metadata": {
255+
"name": "nginx-sandbox",
256+
"namespace": "default",
257+
"attempt": 1,
258+
"uid": "hdishd83djaidwnduwk28bcsb"
259+
},
260+
"log_directory": "/tmp",
261+
"linux": {
262+
}
263+
}
264+
```
265+
266+
2. `crictl runp` 커맨드를 사용하여 JSON을 적용하고 샌드박스를 실행한다.
267+
268+
```shell
269+
crictl runp pod-config.json
270+
```
271+
272+
결과로 샌드박스의 ID가 반환될 것이다.
273+
274+
### 컨테이너 생성
275+
276+
`crictl`을 사용하여 컨테이너를 만드는 것은 컨테이너 런타임 디버깅에 유용하다.
277+
구동 중인 쿠버네티스 클러스터에서
278+
이러한 샌드박스는 kubelet에 의해서 결국 중지 및 삭제된다.
279+
280+
1. busybox 이미지 가져오기
281+
282+
```shell
283+
crictl pull busybox
284+
```
285+
```none
286+
Image is up to date for busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47
287+
```
288+
289+
2. 파드와 컨테이너 구성(config) 생성
290+
291+
**파드 구성**:
292+
293+
```json
294+
{
295+
"metadata": {
296+
"name": "busybox-sandbox",
297+
"namespace": "default",
298+
"attempt": 1,
299+
"uid": "aewi4aeThua7ooShohbo1phoj"
300+
},
301+
"log_directory": "/tmp",
302+
"linux": {
303+
}
304+
}
305+
```
306+
307+
**컨테이너 구성**:
308+
309+
```json
310+
{
311+
"metadata": {
312+
"name": "busybox"
313+
},
314+
"image":{
315+
"image": "busybox"
316+
},
317+
"command": [
318+
"top"
319+
],
320+
"log_path":"busybox.log",
321+
"linux": {
322+
}
323+
}
324+
```
325+
326+
3. 이전에 생성한 파드의 ID 및 컨테이너 구성 파일과 파드 구성 파일을 커맨드 인자로 전달하여,
327+
컨테이너를 생성한다.
328+
결과로 컨테이너의 ID가 반환될 것이다.
329+
330+
```shell
331+
crictl create f84dd361f8dc51518ed291fbadd6db537b0496536c1d2d6c05ff943ce8c9a54f container-config.json pod-config.json
332+
```
333+
334+
4. 모든 컨테이너의 목록을 조회하여
335+
새로 생성된 컨테이너의 상태가 `Created`임을 확인한다.
336+
337+
```shell
338+
crictl ps -a
339+
```
340+
341+
출력은 다음과 유사하다.
342+
343+
```
344+
CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT
345+
3e025dd50a72d busybox 32 seconds ago Created busybox 0
346+
```
347+
348+
### 컨테이너 시작하기
349+
350+
컨테이너를 시작하기 위해서 컨테이너 ID를 `crictl start`에 인자로 전달한다.
351+
352+
```shell
353+
crictl start 3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60
354+
```
355+
356+
출력은 다음과 유사하다.
357+
358+
```
359+
3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60
360+
```
361+
362+
컨테이너의 상태가 `Running`임을 확인한다.
363+
364+
```shell
365+
crictl ps
366+
```
367+
출력은 다음과 유사하다.
368+
369+
```
370+
CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT
371+
3e025dd50a72d busybox About a minute ago Running busybox 0
372+
```
373+
374+
## {{% heading "whatsnext" %}}
375+
376+
* [`crictl` 더 알아보기](https://github.com/kubernetes-sigs/cri-tools).
377+
* [`docker` CLI 커맨드를 `crictl`로 매핑하기](/docs/reference/tools/map-crictl-dockercli/).
378+

0 commit comments

Comments
 (0)