✔ kubectl Command (명령어)

Kubernetes는 kubectl 이라는 CLI를 통해 Kubernetes 및 클러스터 관리, 디버그 및 트러블 슈팅들을 할 수 있습니다.

• 자세한 내용을 알고 싶으면 kubectl 치트 시트를 참고하세요

kubectl 명령어는 기본적으로 아래와 같은 형태로 커맨드 라인에 입력하여 사용할 수 있습니다.

$ kubectl [command] [type] [name] [flags]

• command : 자원에 실행하려는 동작

  • create : 생성
  • ge` : 정보 가져오기
  • describe : 자세한 상태 정보
  • delete : 삭제

• type : 자원 타입

  • pod : Pod
  • service : 서비스

• name : 자원 이름

• flag : 옵션

명령어 실습 전 사전 작업

• 아마 처음 kubectl을 사용하게 된다면 아래와 같은 에러 메세지를 띄울 것입니다.

[root@nasa-master ~]# kubectl get pod
The connection to the server 10.146.0.6:6443 was refused - did you specify the right host or port?

• 위와 같은 경우는 현재 실행 권한이 없는 경우로 아래의 명령어를 진행하면 작동 가능합니다.

mkdir -p $HOME/.kube
sudo cp -i /etc/kubernetes/admin.conf $HOME/.kube/config
sudo chown $(id -u):$(id -g) $HOME/.kube/config

• 일반 사용자 권한에 추가 (root권한에서 환경변수 등록)

export KUBECONFIG=/etc/kubernetes/admin.conf

• kubelet 재시작

[root@nasa-master ~]# systemctl restart kubelet
[root@nasa-master ~]# 

• 이제 정상적으로 명령어 사용이 가능합니다.

[root@nasa-master ~]# kubectl get node
NAME          STATUS   ROLES    AGE   VERSION
nasa-master   Ready    master   23d   v1.15.5
nasa-node1    Ready    <none>   23d   v1.15.5
nasa-node2    Ready    <none>   23d   v1.15.5
nasa-node3    Ready    <none>   23d   v1.15.5

kubectl 기본 사용법

• 에코 서버(클라이언트가 전송해주는 데이터를 그대로 되돌려 전송하는 서버)를 동작시켜보죠 먼저 아래 명령어를 통해서 nasaehco라는 pod를 하나 생성하겠습니다.

$ kubectl run nasaecho --generator=run-pod/v1 --image="k8s.gcr.io/echoserver:1.10" --port=8080

[root@nasa-master ~]# kubectl run nasaecho --generator=run-pod/v1 --image="k8s.gcr.io/echoserve
r:1.10" --port=8080
pod/nasaecho created
[root@nasa-master ~]# 

간단히 설명하면 run 명령어는 클러스터에 특정 이미지를 가지고 pod를 생성하는 명령어 입니다.

$ kubectl run [생성할 POD 이름] --generator=[Repolication Controller 지정] --image=[사용할 이미지] --port=[포트정보]

• k8s.gcr.io는 구글의 Container Registry에서 가져오겠다는 의미입니다. –generator : Replication Controller를 지정합니다.

아래 명령어를 입력하면 pod 들의 정보를 볼 수 있습니다.

$ kubectl get pods

[root@nasa-master ~]# kubectl get pod
NAME       READY   STATUS    RESTARTS   AGE
nasaecho   1/1     Running   0          4m12s
[root@nasa-master ~]# 

각각의 의미는

• NAME : Pod 이름
• READY : 0/1(생성되었지만 사용 준비 X) / 1/1(생성되었지만 사용 준비 O)
• STATUS : Running (실행) / Terminating / ContainerCreating
• RESTARTS : 재시작 횟수
• AGE : 생성 후 지난 시간

이제 명령어를 통해서 만들어진 nasaecho pod의 서비스를 생성하도록 하겠습니다.

$ kubectl expose pod nasaecho --type=NodePort

[root@nasa-master ~]# kubectl expose pod nasaecho --type=NodePort
service/nasaecho exposed

아래 명령어로 현재 만들어진 서비스 정보들을 확인할 수 있습니다.

$ kubectl get services

[root@nasa-master ~]# kubectl get service
NAME         TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)          AGE
kubernetes   ClusterIP   10.96.0.1        <none>        443/TCP          23d
nasaecho     NodePort    10.109.171.229   <none>        8080:30880/TCP   5m3s

각각의 의미는

• NAME : 서비스 이름
• TYPE : 서비스 타입
• Cluster IP : 서비스에 클러스터 IP (내부 IP)를 할당합니다.
• Load Balancer : 외부 IP를 가진 로드밸런서를 할당합니다.
• Node Port : 클러스터 IP 뿐만 아니라 노드의 IP 및 포트를 통해서 접근을 할 수 있습니다.
• External Name : 외부 서비스를 Kubernetes 내부에서 호출하고자 할 때 사용할 수 있습니다.
• CLUSTER-IP : 클러스터 안에서 사용하는 IP
• EXTERNAL-IP : 외부 IP
• PORT(S) : 서비스에 접속하는 포트
• AGE : 생성 후 지난 시간

로컬서버의 8080 포트를 에코 서버의 8080포트로 포트 포워딩 해주기 위한 명령어

$ kubectl port-forward svc/nasaecho 8080:8080

[root@nasa-master ~]# kubectl port-forward svc/nasaecho 8080:8080
Forwarding from 127.0.0.1:8080 -> 8080
Forwarding from [::1]:8080 -> 8080

curl http://localhost:8080 으로 데이터를 땡겨오면 정상적이다!

에코 서버의 실행 중 로그를 수집하려면 아래 명령어를 입력하면 확인할 수 있습니다.

$ kubectl logs -f echoserver

[root@nasa-master ~]# kubectl logs -f nasaecho
Generating self-signed cert
Generating a 2048 bit RSA private key
.......+++
..+++
writing new private key to '/certs/privateKey.key'
-----
Starting nginx
127.0.0.1 - - [16/Sep/2020:04:57:55 +0000] "GET / HTTP/1.1" 200 414 "-" "curl/7.29.0"
127.0.0.1 - - [16/Sep/2020:04:58:27 +0000] "GET / HTTP/1.1" 200 414 "-" "curl/7.29.0"
127.0.0.1 - - [16/Sep/2020:04:58:40 +0000] "GET / HTTP/1.1" 200 414 "-" "curl/7.29.0"

만들어진 nasaecho pod를 지워보도록 하겠습니다.

$ kubectl delete pod echoserver

[root@nasa-master ~]# kubectl delete pod nasaecho
pod "nasaecho" deleted
[root@nasa-master ~]# kubectl get pod
No resources found.

• 정상적으로 삭제 되었고 get명령으로 확인결과 pod가 없어졌습니다.

pod가 삭제되었으니 이번에는 서비스 또한 삭제해보겠습니다

[root@nasa-master ~]# kubectl delete svc nasaecho
service "nasaecho" deleted
[root@nasa-master ~]# 
[root@nasa-master ~]# kubectl get svc
NAME         TYPE        CLUSTER-IP   EXTERNAL-IP   PORT(S)   AGE
kubernetes   ClusterIP   10.96.0.1    <none>        443/TCP   23d

이와 같이 간단한 실습으로 간단한 사용법에 대해서 알아보았습니다.

치트시트 내용 정리

✌ 명령어[COMMAND] 종류

kubectl의 명령어 종류와 문법을 간략히 설명합니다.

👌 리소스[RESOURCE] 종류

• kubectl에 적용 가능한 Kubernetes 리소스 종류와 단축어 리스트 입니다.

Output 옵션

• kubectl으로 얻은 정보들을 file로 저장하기를 원할 수 있죠. 이때 아래와 같은 옵션으로 추출 가능합니다.

kubectl [command] [TYPE] [NAME] -o=<output_format>

output_format으로 아래와 같은 format들을 지원.

output 옵션 예제

$ kubectl get pod web-pod-13je7 -o=yaml

• 다음의 명령은 단일 파드에 대한 세부 정보를 YAML 형식의 오브젝트로 출력한다.

kubectl 예제

kubectl create

// example-service.yaml 파일이름의 서비스를 생성합니다.
$ kubectl create -f example-service.yaml
    
// example-controller.yaml 파일이름의 RC를 생성합니다.
$ kubectl create -f example-controller.yaml

kubectl get

// pod list를 출력
$ kubectl get pods

// pod list(+ 추가적인 정보 node 이름 등)를 출력
$ kubectl get pods -o wide

// 특정 <rc-name>의 정보를 출력
$ kubectl get replicationcontroller <rc-name>

// 모든 rc, service들 정보를 출력
$ kubectl get rc,services

// 모든 ds(daemon sets)에 대한 정보를 출력(uninitialized ds도 포함)
$ kubectl get ds --include-uninitialized

// 특정 node(server01)에 배포된 pod 정보를 출력
$ kubectl get pods --field-selector=spec.nodeName=server01

kubectl describe

// 특정 <node-name>의 node 정보 출력
$ kubectl describe nodes <node-name>

// 특정 <pod-name>의 pod 정보 출력
$ kubectl describe pods/<pod-name>

// 특정 <rc-name>의 rc가 제어하는 pod들 정보 출력
$ kubectl describe pods <rc-name>

// 모든 pod 정보 출력(uninitialized pod은 제외)
$ kubectl describe pods --include-uninitialized=false

kubectl delete

// pod.yaml로 선언된 pod들을 제거
$ kubectl delete -f pod.yaml

// 특정 <label-name>이 정의된 pod, service들 제거
$ kubectl delete pods,services -l name=<label-name>

// 특정 <label-name>이 정의된 pod, service들 제거(uninitialized pod, service 포함)
$ kubectl delete pods,services -l name=<label-name> --include-uninitialized

// 모든 pod 
$ kubectl delete pods --all

kubectl exec

// 특정 <pod-name>을 가진 pod의 첫번째 container에 'date' 라는 명령어 호출
$ kubectl exec <pod-name> date

// 특정 <pod-name>을 가진 pod의 특정 <container-name>이라는 이름의 container에 'date' 라는 명령어 호출
$ kubectl exec <pod-name> -c <container-name> date

// 특정 <pod-name>을 가진 pod의 첫번째 container에 bash shell실행 
$ kubectl exec -ti <pod-name> /bin/bash

kubectl logs

// 특정 <pod-name> 이름을 가진 pod의 로그 조회
$ kubectl logs <pod-name>

// 특정 <pod-name> 이름을 가진 pod의 로그 tail -f 조회
$ kubectl logs -f <pod-name>