一、前置知識(shí)

在進(jìn)入具體操作之前，我們需要了解一些背景知識(shí)：

1. Docker：Docker 是一個(gè)開源的容器化平臺(tái)，它允許開發(fā)者將應(yīng)用程序及其依賴項(xiàng)打包到一個(gè)輕量級(jí)的容器中，從而使應(yīng)用程序可以在任何地方一致地運(yùn)行。
2. Docker Compose：Docker Compose 是一個(gè)用于定義和運(yùn)行多容器 Docker 應(yīng)用的工具。通過(guò) Docker Compose 文件（通常命名為 docker-compose.yml），可以在一個(gè)文件中定義多個(gè)服務(wù)，并通過(guò)一條命令啟動(dòng)這些服務(wù)。
3. One API：One API 是一個(gè) API 網(wǎng)關(guān)平臺(tái)，它能夠幫助開發(fā)人員更輕松地管理 API 請(qǐng)求，提供統(tǒng)一的 API 接口、請(qǐng)求路由以及安全管理。

二、使用 Docker Compose 部署 One API

在 Docker Compose 中，我們可以定義 One API 服務(wù)和其相關(guān)的配置。以下是一個(gè)典型的 docker-compose.yml 配置：

one-api:
  container_name: one-api
  image: one-api:latest
  restart: always
  command: --log-dir /app/logs
  ports:
    - "3000:3000"
  volumes:
    - ./volumes/one-api/data:/data
    - ./volumes/one-api/logs:/app/logs
    - ./volumes/data-gym-cache:/tmp/data-gym-cache
  environment:
    - SQL_DSN=root:test2024@tcp(111.18.9.111:3306)/oneapi
    - SESSION_SECRET=random_string
    - TZ=Asia/Shanghai
  depends_on:
    mysql:
      condition: service_healthy
  healthcheck:
    test:
      [
        "CMD-SHELL",
        "wget -q -O - http://localhost:3000/api/status | grep -o '\"success\":\\s*true' | awk -F: '{print $2}'",
      ]
    interval: 30s
    timeout: 10s
    retries: 3

以上 docker-compose.yml 文件定義了一個(gè)名為 one-api 的服務(wù)，并設(shè)置了其依賴、端口、環(huán)境變量等配置項(xiàng)。下面我們?cè)敿?xì)解析該配置文件的各部分內(nèi)容。

1. container_name: 設(shè)置容器名稱為 one-api，方便通過(guò)名字快速識(shí)別和管理容器。

2. image: 指定了容器使用的鏡像 one-api:latest，即 One API 的最新版本。

3. restart: 設(shè)置為 always，意味著無(wú)論容器退出的原因是什么，Docker 都會(huì)自動(dòng)重啟容器，以確保服務(wù)的持續(xù)可用性。

4. command: 通過(guò)命令 --log-dir /app/logs，將日志目錄指定為 /app/logs。

5. ports: 將主機(jī)的 3000 端口映射到容器的 3000 端口，這樣我們可以通過(guò) http://localhost:3000 訪問(wèn) One API 服務(wù)。

6. volumes: 定義了多個(gè)數(shù)據(jù)卷，以便持久化存儲(chǔ)數(shù)據(jù)和日志：

   • ./volumes/one-api/data:/data：將本地 ./volumes/one-api/data 目錄掛載到容器中的 /data 目錄，用于存儲(chǔ)持久化數(shù)據(jù)。
   • ./volumes/one-api/logs:/app/logs：將日志文件掛載到本地 ./volumes/one-api/logs，便于日志管理和分析。
   • ./volumes/data-gym-cache:/tmp/data-gym-cache：將緩存數(shù)據(jù)存放在 ./volumes/data-gym-cache。

7. environment: 定義了幾個(gè)環(huán)境變量：

   • SQL_DSN：用于連接數(shù)據(jù)庫(kù)的 DSN 配置，格式為 user:password@tcp(host:port)/dbname。
   • SESSION_SECRET：設(shè)置會(huì)話密鑰，用于加密和驗(yàn)證會(huì)話。
   • TZ：時(shí)區(qū)設(shè)置為 Asia/Shanghai，確保日志時(shí)間等信息符合本地時(shí)區(qū)。

8. depends_on: 該配置用于聲明服務(wù)之間的依賴關(guān)系。例如，One API 依賴于 MySQL 數(shù)據(jù)庫(kù)，depends_on 配置確保 MySQL 數(shù)據(jù)庫(kù)在 One API 啟動(dòng)前處于健康狀態(tài)。

9. healthcheck: 定義了健康檢查的命令和時(shí)間間隔：

   • test：健康檢查的命令，使用 wget 請(qǐng)求 One API 的狀態(tài)接口，檢測(cè)返回結(jié)果中是否包含 "success": true。
   • interval、timeout 和 retries 分別設(shè)置健康檢查的間隔、超時(shí)和重試次數(shù)。

啟動(dòng)服務(wù)

運(yùn)行以下命令啟動(dòng)服務(wù)：

docker-compose up -d

該命令會(huì)在后臺(tái)啟動(dòng)服務(wù)，并自動(dòng)根據(jù) docker-compose.yml 文件中的配置，完成 One API 容器的初始化和啟動(dòng)。

三、使用 Docker Run 命令直接運(yùn)行 One API 容器

如果不想使用 Docker Compose，我們還可以使用 docker run 命令來(lái)直接啟動(dòng) One API 容器：

docker run -d \
  --name one-api \
  --restart always \
  -p 3000:3000 \
  -v $(pwd)/volumes/one-api/data:/data \
  -v $(pwd)/volumes/one-api/logs:/app/logs \
  -v $(pwd)/volumes/data-gym-cache:/tmp/data-gym-cache \
  -e SQL_DSN=root:test2024@tcp(111.18.9.111:3306)/oneapi \
  -e SESSION_SECRET=random_string \
  -e TZ=Asia/Shanghai \
  --health-cmd="wget -q -O - http://localhost:3000/api/status | grep -o '\"success\":\\s*true' | awk -F: '{print $2}'" \
  --health-interval=30s \
  --health-timeout=10s \
  --health-retries=3 \
  one-api:latest \
  --log-dir /app/logs

命令參數(shù)解析

1. -d：表示在后臺(tái)運(yùn)行容器。
2. –name：指定容器的名稱為 one-api。
3. –restart always：設(shè)置容器自動(dòng)重啟。
4. -p 3000:3000：映射端口，與 Docker Compose 配置一致。
5. -v：掛載卷，與 Docker Compose 中的卷配置一致。
6. -e：設(shè)置環(huán)境變量。
7. –health-cmd、–health-interval、–health-timeout 和 –health-retries：健康檢查配置。

到此這篇關(guān)于在Docker環(huán)境中部署和運(yùn)行One API的操作方法的文章就介紹到這了,更多相關(guān)Docker部署和運(yùn)行One API內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論