顯示具有 docker-compose 標籤的文章。 顯示所有文章
顯示具有 docker-compose 標籤的文章。 顯示所有文章

2023年2月9日 星期四

使用 docker-compose 建立 Redis Cluster

 先建立如下的資料結構:

專案目錄名為 "Redis Cluster Test",
裡面放了 docker-compose 所需的 docker-compose.yml 檔和一個名為 redis 的資料夾,
在 redis 的資料夾中放置 Redis node 所需的 redis.conf 客制設定檔
和 docker service 的 Dockerfile 設定檔。

以下是各檔的內容 (以 Redis Cluster Test 為專案根目錄):

/redis/Dockerfile:
FROM redis
COPY redis.conf /usr/local/etc/redis/redis.conf 
CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ]
裡面把 redis.conf 放至 Docker container 中,並指定了使用 redis.conf 執行 redis-server 啟動 Redis 服務。

/redis/redis.conf:
cluster-enabled yes
裡面的內容很簡單,只有一行,使用 cluster-enabled yes 開啟 Cluster 功能。

/docker-compose.yml:
version: '3.4'
services:
    redis-node-1:
        build: ./redis 
        container_name: redis-node-1
        ports: 
            - 6379:6379 
            - 16379:16379 
        entrypoint: [redis-server, /usr/local/etc/redis/redis.conf, --port,"6379", --cluster-announce-ip, "<your server IP or hostname>"]
    redis-node-2:
        build: ./redis 
        container_name: redis-node-2
        ports: 
            - 6380:6380 
            - 16380:16380
        entrypoint: [redis-server, /usr/local/etc/redis/redis.conf, --port,"6380", --cluster-announce-ip, "<your server IP or hostname>"]
    redis-node-3:
        build: ./redis 
        container_name: redis-node-3
        ports: 
            - 6381:6381 
            - 16381:16381 
        entrypoint: [redis-server, /usr/local/etc/redis/redis.conf, --port,"6381", --cluster-announce-ip, "<your server IP or hostname>"]
    redis-node-4:
        build: ./redis 
        container_name: redis-node-4
        ports: 
            - 6382:6382 
            - 16382:16382 
        entrypoint: [redis-server, /usr/local/etc/redis/redis.conf, --port,"6382", --cluster-announce-ip, "<your server IP or hostname>"]
    redis-node-5:
        build: ./redis  
        container_name: redis-node-5
        ports: 
            - 6383:6383 
            - 16383:16383 
        entrypoint: [redis-server, /usr/local/etc/redis/redis.conf, --port,"6383", --cluster-announce-ip, "<your server IP or hostname>"]
    redis-node-6:
        build: ./redis  
        container_name: redis-node-6
        ports: 
            - 6384:6384 
            - 16384:16384 
        entrypoint: [redis-server, /usr/local/etc/redis/redis.conf, --port,"6384", --cluster-announce-ip, "<your server IP or hostname>"]
    redis-cluster-creator:
        image: redis
        container_name: redis-cluster-creator
        entrypoint: [/bin/sh, -c, 'echo "yes" | redis-cli --cluster create host.docker.internal:6379 host.docker.internal:6380 host.docker.internal:6381 host.docker.internal:6382 host.docker.internal:6383 host.docker.internal:6384 --cluster-replicas 1']
        depends_on: 
          - redis-node-1 
          - redis-node-2
          - redis-node-3 
          - redis-node-4
          - redis-node-5 
          - redis-node-6
在 docker-compose.yml 中,設置了 6 個 Redis node 作為 Redis Cluster 之用,
6 個 Redis node 全部都是使用同一個 Dockerfile 和 redis.conf 所建構出來的,
這邊要注意的是 ports 需要向外開放兩個 port,
第一個 port 是用來跟 client 端通信的,例如 6379、6380 等,這是我們平常要登入 Redis 時會用到的 port,暫且稱做 client port 好了。
第二個 port 官方名字叫做 Cluster bus port, 是用來讓 Redis node 跟 node 之間通信用的,預設為 client port 再加上 10000,不過也可以在 redis.conf 檔裡用 cluster-port 參數來修改,
可參考官方的說明: Scaling with Redis Cluster 。

<your server IP or hostname> 請用 docker 所在的 server host IP 或 hostname 來取代,
測試時可用 host.docker.internal (在 docker container 中可用此 hostname 連上 server host) 來測試 (實務上請用真正的 IP 或 hostname)。

redis-cluster-creator 只是一個用來執行完 Redis Cluster 設置建立 Cluster 後就關掉的 docker service,
使用 depends_on 等待各 Redis node 啟動完成後,便會執行以下命令:
echo "yes" | redis-cli --cluster create host.docker.internal:6379 host.docker.internal:6380 host.docker.internal:6381 host.docker.internal:6382 host.docker.internal:6383 host.docker.internal:6384 --cluster-replicas 1

以上命令相當於是先執行了
redis-cli --cluster create host.docker.internal:6379 host.docker.internal:6380 host.docker.internal:6381 host.docker.internal:6382 host.docker.internal:6383 host.docker.internal:6384 --cluster-replicas 1

再執行手動輸入的 yes,因為 redis-cli --cluster create 執行中會詢問
Can I set the above configuration? (type 'yes' to accept): 
需要手動輸入 yes 才能繼續下去。

redis-cli --cluster create 是建立 cluster 的指令,它將各 Redis node 連結起來成為 Cluster,
參數意義如下:
redis-cli --cluster create <node-1 IP or hostname:<port> <node-2 IP or hostname:<port> ....<可多個 Redis node>...... --cluster-replicas <一個 Redis master node 要有幾個依附的 Redis slave node>

它會自己選擇哪些要做為 Redis master node,哪些要做為 Redis slave node。

參考資料:

  1. Redis - Official Image | Docker Hub
  2. Redis configuration file example | Redis
  3. Scaling with Redis Cluster
  4. Redis|用 Docker 架設 Redis Cluster

2021年3月30日 星期二

Linux - Docker 和 docker-compose 的好用指令記錄 - 學習紀錄

使用 Linux Ubuntu 為例子。

# 安裝 docker 
apt-get install docker.io 
--------------------------------------------------------------

Docker 好用指令 :

# 觀看 Docker 啟動狀態
service docker status

# 啟動 Docker
start docker

# 關閉 Docker
stop docker

# 重啟 Docker
restart docker

----------------------- Image 相關 --------------------
#搜尋 image (映像檔)
docker search {關鍵字}
Ex: docker search ubuntu

# 例出所有 image
docker images

# 下載 XXX image (如要下載最新版,version (在 docker 中又稱 tag) 可省略)
docker pull {image 名}:{version}
Ex: docker pull tomcat:9.0

# 刪除 Image
docker rmi {某個 images}

----------------------- Volume 相關 --------------------
# 建立一個具名 Volume (不給名字會自動幫你建一個亂數名字的 Volume)
docker volume create {自己取的 Volume 名字}

# 列出所有**具名**的 Volume 的資訊,非具名的 Volume 不會在這顯示
(例如在 run container 時直接用 -v {宿主機路徑}:{container 路徑} 指定的 Volume)
docker volume list

# 列出特定 Volume 的詳細資訊
docker volume inspect {Volume 名字}

# 移除 Volume
docker volume rm {Volume 名字}

----------------------- Container 相關 --------------------
# ps [-a] :(process stauts ??) 例出所有運行中的 container (容器),如果要列出全部 (包含非運行的)的 container,可以加上 -a
docker ps
docker ps -a

# rm :(remove) 刪除某 container
docker rm {某 container 的 id 或 name}

# 查看某個 container 的 log
docker logs XXX

# 開啟一個或多個已停止的 container
docker start {container} {container} ......

# 停止關閉某個 container
docker stop XXX

# 重啟某個 container (等同 docker stop + docker start)
docker restart XXX

# cp : 從宿主機複制檔案或資料夾到 container,或從 container 複制檔案或資料夾到 宿主機,container 的路徑前面要加 container 名,並用冒號 (:) 分隔
docker cp {來源路徑} {目標路徑}
Ex: docker cp /home/xxx xxContainer:/user/...

# exec : 在已運行的 container 上執行命令
docker exec {參數} {某個container} {命令}
Ex: docker exec -it mysql bash

#其他可選參數:
# -w : work directory,可設定一開始所在的 container 內部 path
docker exec -w {container 中的路徑} {某個 contenr} {命令}
Ex: docker exec -i -w /some/path/inside/container tomcat pwd
像述指令也可用 bash -c "cd ... && ..." 如以下方法達成:
docker exec -i tomcat bash -c "cd /some/path/inside/container && pwd"

----------------------- 運行 Container 相關 --------------------
# 以 image 建立 container
docker create {image}

# 以 XXX images 運行 container
docker run XXX

# docker run 的各種參數 :

# --name :為要運行的 container 取名
docker run --name {自己取的名字} {某個 image}

# -p : (expose 的縮寫),暴露 container 的 port 並對應到指定的宿主機的 port,
docker run -p {宿主機的port}:{container 的 port} XXX
Ex: docker run -p 8081:8080 tomcat

# -i -t 或 --interactive --tty 或 -it :(stdin和 pueudo-tty 功能的組合) 運行 container 並進入 command line 互動介面
-t:attach時Container的螢幕會接到原來的螢幕上。
-i:attach時鍵盤輸入會被Container接手
docker run -i -t XXX
#或
docker run -it XXX

#離開互動介面
exit

# -d :Detached 的縮寫,以分離模式運行 container,進行背景常駐執行,即不進入 Container 的 命令提示界面,例如像 Daemon 這種常駐程式
docker run -d ubuntu /bin/sh -c "while true; do echo hello world; sleep 1; done"

# -v 或 --volume :分享資料夾,可掛載宿主機 (指運行 Docker 的 Linux) 的某資料夾路徑到 container 的某資料夾路徑,用於持久化檔案,避免檔案因 container 關閉而消失,有幾種寫法

# (掛載特定宿主機資料夾路徑 或 某具名 Volume) 到 container 資料夾路徑
docker -v {宿主機資料夾路徑 或 某具名 Volume}:{container 資料夾路徑}
Ex: docker -v /home/tomcat:/usr/local/tomcat/webapps

--rm : (clean up),可在 container exit 後自動刪除 container 
docker run -it --rm -p 8888:8080 tomcat:9.0

----------------------- Image 的輸出與導入 save/load 和 Container 的輸出與導入 export/import 相關 --------------------

#輸出 Docker Image 成檔案
docker save --output {要輸出的 Docker Image 檔案位置} {imageName:tag}
範例:
docker save --output /usr/local/my-images/postgres-16-image.tar postgres:16

#將 Dcoker Image tar 檔導入成 Docker Image
docker load --input {被輸出的 Docker Image 檔案位置}
範例:
docker load --input /usr/local/my-images/postgres-16-image.tar

#輸出 Docker Container 成檔案
docker export --output="{要輸出的 Docker Container 檔案位置}" {Container Name}
範例:
docker export --output="latest.tar" some_container
#將 Dcoker Container 檔導入成 Docker Container,可以重新指定 Container name, tag
docker import {被輸出的 Docker Container 檔案位置}
範例:
docker import /path/to/exampleimage.tgz
cat exampleimage.tgz | docker import - exampleimagelocal:new

參考:

----------------------------------------------
在 Container 中,可用
host.docker.internal
做為 domain  來連至本地端,
此法僅適於 Docker Desktop for Windows,並且通常為開發測試時使用

好用連結:

---------------------- docker-compose 好用指令 ---------------------------------------------------------------
#docker-compose 的指令在 Linux 上的指令是 docker compose。

#docker-compose 可以用 --project-directory 設定要啟動 docker compose project 的資料夾位置,這樣就不用一定要先用 cd 指令移到 docker compose project 位置。

#docker-compose 可以用 -f 設定要啟動 docker compose project 要用的 docker-compose.yml 設定檔位置,這樣就不用一定要先用 cd 指令移到 docker compose project 位置,docker-compose.yml 也不一定要放在 docker compose project 的資料夾內。


範例:
docker-compose --project-directory ./xxx/xxx/xxx -f  ./yyy/yyy/yyy/docker-compose.yml up -d --build

# 依據 docker-compose.yml 的設定 重新 build image 並 start service (如果已經 start 就重新 start) 某個 service
docker-compose up -d --build --force-recreate --no-deps <service 名稱>
參考: