Docker로 Consul KV 구성하는 방법

튜토리얼
Docker Ubuntu

소개

HashiCorp의 Consul는 현대 DevOps 환경에서 다양한 기능을 수행하는 유용한 도구입니다. 이를 서비스 DISCOVERY, 健壮性 ckeck, 로드 balancing 및 특이히 분산 KeY-VALUE (KV) 스토어로 널리 사용합니다. Consul의 KV 스토어는 동적 구성 데이터, 기능 flags, secrets, 및 metadata를 하이 availability, 일관성을 보장하는 인프RASTRUCTURE 내에서 동적으로 서비스에서 사용할 수 있는 방식으로 보관하는 것에 완벽합니다. Docker을 사용하여 Consul의 KV 스토어를 구성하면 빠른 세팅과 isolate 환경을 얻을 수 있습니다. 이를 테스트와 개발에서 理想한 것입니다.

이 자습서는 Docker를 사용하여 Consul의 KV 스토어를 설정하고 구성하는 과정을 guided 할 것입니다. 결과적으로, Docker에서 실제 기능이 완전한 Consul 인스턴스가 실행되고, KV 쌍이 구성되어 있고 액세스 할 수 있습니다. 이 세팅은 분산 시스템에서 서비스 구성과 상태 관리에 필요합니다.

사전 요구 사항

시작하기 전에는 다음과 같은 것을 확인하십시오 :

  • DigitalOcean 云 계정.
  • Ubuntu 서버를 실행하고 루트 권한을 갖지 않은 sudo 사용자를 가지고 있으며, 활성화 된 방화벽을 갖추고 있습니다. 이러한 조건을 만족시키는 방법에 대한 지침은 다음 목록에 있는 여러분의 분리 정보에 따라 시작하여 우리의 기본 서버 세팅 가이드를 遵循하십시오. Ubuntu의 지원되는 버전을 사용하여 작업하십시오.
  • Ubuntu Droplet에 Docker이 설치되었습니다. 이러한 도커 Installation and Usage Guide를 遵循하십시오.
  • Linux 명령行工具에 慣れている 것입니다. 명령行에 대한 소개 또는 다시 배우는 것이 필요하면 이곳의 Linux Command Line Primer Guide를 访问하십시오.
  • Docker 명령어 및 컨테이너 관리에 대한 기본 지식을 갖추었습니다.

Step 1 — Pulling the Consul Docker Image

Docker Hub에서 공식 Consul 이미지를 풀어 봅니다. 이 이미지는 HashiCorp에 의해 관리되며 Consul를 실행하기 위해 필요한 모든 것을 포함합니다.

Ubuntu Droplet의 콘솔에 로그인하고 다음을 실행합니다.:

docker pull hashicorp/consul:latest

Output
latest: Pulling from hashicorp/consul
c8bcd218a73d: Pull complete 
5f1ac8227c2a: Pull complete 
c51fd79d429a: Pull complete 
91eff479bde6: Pull complete 
4dfcc18e51db: Pull complete 
3e2a8bf39bf9: Pull complete 
bd9ddc54bea9: Pull complete 
2054d291fb84: Pull complete 
Digest: sha256:e244c64df77ab3586f177f1692e98575086eb40343dc82a6320f5e79543490eb
Status: Downloaded newer image for hashicorp/consul:latest
docker.io/hashicorp/consul:latest

스텝 2 — Consul 컨테이너 실행

Consul 이미지가 다운로드 되었으면 새로운 Consul 컨테이너를 시작할 수 있습니다. 이 컨테이너는 Consul 서버로 사용되며 KV 스토어와 interact with를 permits you to interact with the KV store.

컨테이너를 시작하려면 다음 명령을 실행합니다:

docker run -d --name=consul-server -e 

Output
CONSUL_BIND_INTERFACE=eth0 -p 8500:8500 -p 8600:8600/udp hashicorp/consul
c893b6707686bce8434213975a75c936b834cf25fc84d10b407a11c4fa8ca8ba

-d 컨테이너를 배경 모드로(bg) 실행합니다.

  • --name=consul-server 컨테이너에 이름을 지정합니다.
  • -e CONSUL_BIND_INTERFACE=eth0 Consul가 bind 해야하는 network interface를 설정합니다. 이것은 적절한 네트워크 통신을 위해 필요합니다.
  • -p 8500:8500 Consul web UI와 API 포트를 호스트에 매핑합니다.
  • -p 8600:8600/udp service discovery 用的 DNS 서비스 포트를 매핑합니다.
  • 이 단계는 的核心 Consul 서비스를 설정하는 것이 중요합니다. 이를 통해 KV 스토어를 구성할 수 있습니다.

이번 단계가 중요합니다.

스텝 3 — Consul 설치 확인

Consul가 正確하게 실행 중인지 확인하고 Consul UI에 접근하기 위해서는 컨테이너 상태를 확인해야 합니다.

퍼스트, docker ps 명령을 실행하여 모두 실행 중인 컨테이너 목록을 列出하고 컨사이클 컨테이너가 실행 중인지 확인합니다.

❯ docker ps                                                                                                      
CONTAINER ID   IMAGE              COMMAND                  CREATED          STATUS          PORTS                                                                                    NAMES
c893b6707686   hashicorp/consul   "docker-entrypoint.s…"   51 seconds ago   Up 50 seconds   8300-8302/tcp, 8600/tcp, 8301-8302/udp, 0.0.0.0:8500->8500/tcp, 0.0.0.0:8600->8600/udp   consul-server

이제, 컨사이클이 存 Scientifically 하는지 확인하고, 웹 브라우저를 OPEN하고 http://localhost:8500으로 이동하여 컨사이클 UI를 보여 주는지 확인합니다.

이 확인 단계는 第五 단계에서 KV 스토어에 데이터를 저장하기 전에 Your Consul instance is running without any issues 를 확인하는 重要性를 가지고 있습니다.

第四步 — 방화벽 구성 (옵셕)

Your Consul instance needs to be accessed externally (e.g., from other nodes in a cluster), you must adjust your firewall settings to allow traffic on the necessary ports.

For example, if you’re running Consul on a cloud instance, you may need to allow inbound traffic on ports 8500 (HTTP API) and 8600 (DNS). The specific commands will vary based on your firewall solution (UFW, iptables, etc.).

This step ensures that your Consul instance is accessible from other machines, which is essential for distributed configurations.

第五步 — 键值对 저장

Consul이 실행 중이면 KV 스토어를 사용하여 configurations 데이터를 저장할 수 있습니다. Consul CLI나 웹 UI를 사용하여 キー-値 쌍을 추가할 수 있습니다.

CLI를 사용하여 키-값 쌍을 저장하려면 다음과 같은 명령을 실행합니다:

docker exec -it consul-server consul kv put config/db_host 
192.168.1.100
Success! Data written to: config/db_host

docker exec -it consul-server consul kv put config/db_port 3306         
Success! Data written to: config/db_port

이 명령어는 다음과 같은 일을 합니다:

  • -it – 로컬 시스템から 컨테이너로 인터랙티브 터미널을 실행합니다.
  • consul kv put – kv put 명령어는 give 경로 KV 스토어에 데이터를 기록합니다.
  • config/db_host – 값을 저장하는 경로입니다.
  • 192.168.1.100 – 값입니다.

웹 UI를 사용하여,

  1. Consul UI로 이동하세요 (http://localhost:8500).
  2. “Key/Value” 탭을 클릭하세요.
  3. 새 키를 생성하기 위해 “Create”를 클릭하세요.
  4. 키(예: config/db_host)와 값(예: 192.168.1.100)를 입력하세요.

이러한 명령과 동작은 서비스가 실시간에 동적으로 액세스할 수 있는 중요한 구성 데이터를 저장합니다.

Step 6 — 키-값 쌍 조회

KV 쌍을 저장한 다음, 그들이 正しく 저장되었는지 여부를 확인하기 위해 조회하는 것이 중요합니다.

CLI를 사용하여 다음 명령을 사용하여 값을 조회합니다:

docker exec -it consul-server consul kv get config/db_host     
192.168.1.100

웹 UI를 사용하여,

  1. Consul UI 中的 “Key/Value” 标签页로 가십시오.
  2. 생성하신 키를 찾으십시오. 그리고 그 키에 클릭하여 보관된 값을 보십시오.

KV 쌍을 가져오는 과정은 자신의 데이터가 correct하게 보관되고 액세스 가능한지 확인하는 필수적인 단계입니다.

第七步 — 使用 Docker 卷持久化数据

Docker 컨테이너는 기본적으로 영구적이 아닌 것을意味하는 ephemeral로, 컨테이너를 제거하면 내부에 보관된 모든 데이터가 사라집니다. Consul KV 데이터를 보관하려면 Docker 卷를 사용해야 합니다.

  1. 현재 Consul 컨테이너를 중지하고 제거하십시오:
docker stop consul-server 
docker rm consul-server

이제, 컨테이너를 확인하면 Consul 컨테이너가 더 이상 실행되고 있지 않을 것입니다.

docker ps 
CONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES

2. Docker 卷를 연결한 새로운 Consul 컨테이너를 실행하십시오:

docker run -d --name=consul-server -e 

Output
CONSUL_BIND_INTERFACE=eth0 -p 8500:8500 -p 8600:8600/udp -v consul_data:/consul/data hashicorp/consul
2d2a7d3ff1911c2283e70506d68391a5cbf9c935a2ae447bfb8fa21481989ef1

docker ps 

Output
CONTAINER ID   IMAGE              COMMAND                  CREATED         STATUS         PORTS                                                                                    NAMES
2d2a7d3ff191   hashicorp/consul   "docker-entrypoint.s…"   5 seconds ago   Up 4 seconds   8300-8302/tcp, 8600/tcp, 8301-8302/udp, 0.0.0.0:8500->8500/tcp, 0.0.0.0:8600->8600/udp   consul-server

`-v consul_data:/consul/data` 옵션은 Docker 卷을 컨테이너에 마ount하여 KV 스토어가 컨테이너 재시작 사이에 보관되는 것을 Ensure합니다.

第八步 — Consul 시작을 자동화하는 방법 (선택적)

생산 배포 시에는 Docker Compose를 사용하여 Consul 컨테이너의 시작을 자동화하는 것이 좋습니다. Docker Compose는 다수의 컨테이너를 사용하는 Docker 응용 프로그램을 간단하게 관리하고 서비스를 관리하는 것을 简単하게 도와줍니다.

다음과 같은 내용으로 docker-compose.yml 파일을 생성합니다.

docker-compose,yml
services:
  consul:
    image: hashicorp/consul:latest
    environment:
      - CONSUL_BIND_INTERFACE=eth0
    volumes:
      - consul_data:/consul/data 
    ports:
      - "8500:8500"
      - "8600:8600/udp"
    restart: always
volumes:
  consul_data:

그 다음, 다음 명령을 실행합니다. 

docker-compose up -d

Output
[+] Running 2/2
 ✔ Network work_default     Created                                                                                                           0.0s 
 ✔ Container consul-server  Started                                                                                                           0.1s 

docker ps

Output
WARN[0000] /Users/anandhkumar/work/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion 
NAME            IMAGE                     COMMAND                  SERVICE   CREATED          STATUS          PORTS
work-consul-1   hashicorp/consul:latest   "docker-entrypoint.s…"   consul    40 seconds ago   Up 11 seconds   8300-8302/tcp, 8600/tcp, 8301-8302/udp, 0.0.0.0:8500->8500/tcp, 0.0.0.0:8600->8600/udp

이 명령은 Consul을 자동으로 시작하고 실패하면 다시 시작하도록 하여 생산用途에 적절한 健壮性을 제공합니다.

단계 9 — 정리

Consul 인스턴스를 사용하고 있었다면, Docker 환경을 정리하여 자원을 释放해야 합니다.

Consul 컨테이너를 중지하고 제거하는 것을 하고 있습니다. 

docker stop consul-server   
docker rm consul-server
docker ps

output
CONTAINER ID   IMAGE     COMMAND   CREATED   STATUS    PORTS     NAMES

Consul을 사용하지 않는다면 Docker 이미지도 제거할 수 있습니다. 

docker rmi hashicorp/consul  

output
hashicorp/consul@sha256:e244c64df77ab3586f177f1692e98575086eb40343dc82a6320f5e79543490eb
Deleted: sha256:eff8ccb509560987755a70df8d6c0b9410538d503d99498ae1ea9f48066b0439
Deleted: sha256:b5e6402bbb78eb061d538505a30300ef7f612104eaf0f11b17839a9b29bc5603
Deleted: sha256:1c61ada2ad8074615120d13bd805260d766ae8424cafbda4bded529d6a204d6f
Deleted: sha256:9b36da670e2a59f1d81c6e3c9d55906c576b384df51272977e5a9caea7131e74
Deleted: sha256:8c6e52c441c246f60ca146b71204b7d6511df75fa87a0dc0a0f91141964e8fd9
Deleted: sha256:1fce18208235de2be3c419764ec1d469229af5387447d21649c841632c653cef
Deleted: sha256:68e0a114c9c35b9aa8cac31fa32b27f886361bc85fcc63f34e882e9128f33a14
Deleted: sha256:3da5b888208a9b19694bfeaf8c74a432b50f44542d717c9e1f3ab273e505855a
Deleted: sha256:dea73e9287e6e2f3b7f9fcac4f20767d7badeefa24e52f990f1674e98abfa1a3
Deleted: sha256:201fa22d1f4c7d6e7ec43135c63b2260f303f4864f5eb43569faaa1731628799

정리는 開発 환경을 整潔하게 유지하고 Docker 자원을 unnecessarily 소모하지 않도록 도와줍니다.

결론

이 튜토리얼에서는 Docker를 사용하여 Consul KV 스토어를 세팅하고 configurations. With these steps, you can now use Consul to dynamically manage configuration data in your distributed systems, leveraging the power of Docker for easy deployment and management.

Source:
https://www.digitalocean.com/community/tutorials/how-to-configure-consul-kv-using-docker