設定 Redash 執行個體

建立執行個體

對於基本部署,我們建議至少 4GB 的 RAM 和合理的 CPU 配置。隨著使用量增加,您可能需要額外的 RAM 和 CPU 效能來支援增加的背景工作程序和 API 程序。

若要建立執行個體,您有以下選項

  1. AWS EC2 AMI
  2. Google Compute Engine 映像檔
  3. 其他
  4. Docker

我們尚未更新 V10 的官方映像檔。但是,您可以部署 V8 執行個體並按照這些指示升級它。

下方有一個此過程的影片示範

AWS

使用我們建立的預先建置 AMI 啟動執行個體(對於小型部署,t2.small 應該足夠)

區域 AMI
us-east-1 ami-0d915a031cabac0e0
us-east-2 ami-0b97435028ca44fcc
us-west-1 ami-068d0753a46192935
us-west-2 ami-0c457f229774da543
eu-west-1 ami-046c6a0123bf94619
eu-west-2 ami-0dbe8ba0cd21ea12b
eu-west-3 ami-041bf9180061ce7ea
eu-central-1 ami-0f8184e6f30cc0c33
eu-north-1 ami-08dd1b893371bcaac
ap-south-1 ami-0ff23052091536db2
ap-southeast-1 ami-0527e82bae7c51958
ap-southeast-2 ami-0bae8773e653a32ec
ap-northeast-1 ami-060741a96307668be
ap-northeast-2 ami-0d991ac4f545a6b34
sa-east-1 ami-076f350d5a5ec448d
ca-central-1 ami-0071deaa12b66d1bf

(以上 AMI 的版本為:8.0.0)

啟動執行個體時,請務必使用安全群組,該群組僅允許連接埠上的輸入流量:22 (SSH)、80 (HTTP) 和 443 (HTTPS)。這些 AMI 基於 Ubuntu,因此您需要在使用 SSH 連接到執行個體時使用使用者 ubuntu

現在繼續「設定」。

Google Compute Engine

若要在 GCE 上開始使用,請在您的Cloud Shell中執行以下命令。

首先,您需要將 Redash 映像檔新增至您的帳戶

$ gcloud compute images create "redash-8-0-0" --source-uri gs://redash-images/redash.8.0.0-b32245-1.tar.gz

接下來,您需要使用此映像檔啟動執行個體。建議使用 n1-standard-1 機器類型。您可以使用以下命令啟動使用此映像檔的執行個體(您可能需要使用 --zone 參數指定執行個體的 區域

$ gcloud compute instances create redash --image redash-8-0-0

現在繼續「設定」。

其他

AWS 和 Google Compute Engine 映像檔是使用我們的 設定腳本建立的,該腳本旨在在許多現代 Linux 發行版上執行。您可以按原樣使用腳本,或將其用作藍圖來建立您自己的設定。

腳本的作用是

  1. 安裝 Docker 和 Docker Compose。
  2. 下載我們建議的 Docker Compose 設定並建立初始設定。
  3. 啟動所有項目。

請注意,腳本假設您是在「乾淨」的機器上執行它。如果您在用於其他目的的機器上執行此腳本,您可能需要根據您的需求調整它。

Docker

對於每個 Redash 版本,我們也會建立更新的 Docker 映像檔。我們的映像檔遵循最佳實務,可以在任何容器協調平台(如 Kubernetes、ECS 或僅使用 Docker Compose(我們在映像檔中使用))中使用。

如果您未使用我們的任何雲端映像檔,您必須手動設定 Redash 的 金鑰

  1. 在與您的 compose.yaml 檔案相同的資料夾中建立 .env
  2. 以 bash 語法撰寫任何敏感的環境變數
REDASH_SECRET_KEY=...
REDASH_COOKIE_SECRET=...
GOOGLE_CLIENT_ID=...

請勿將此檔案提交至版本控制。

對於開發環境設定,請參閱開發人員指南(其中也包括 Docker 相關的指示)。

若要執行 Redash,您需要數個 Redash 執行個體(API 伺服器和執行查詢的背景工作程序)以及 Redis 和 PostgreSQL。如果您不想要或無法使用我們的映像檔或設定腳本,您可以參閱 Docker Compose 設定,以了解您需要定義哪些服務。

設定

一旦您使用映像檔或腳本建立了執行個體,您應該會有一個正在執行的 Redash 執行個體,其中包含您開始所需的一切。Redash 應可使用您指派給它的伺服器 IP 或 DNS 名稱來使用。您可以將瀏覽器指向此位址。

在您繼續之前,它會要求您建立您的管理員帳戶。完成此操作後,您就可以開始使用 Redash。

Initial Setup Screen

在您使用 CLI 或繼續設定的其餘部分之前,請務必完成以 Web 為基礎的設定。

若要讓您的設定更完整,您還需要手動執行幾個步驟

郵件設定

為了讓系統能夠傳送電子郵件(使用者邀請、密碼重設、觸發警示時等等),您需要使用您使用的郵件伺服器設定 Redash。郵件伺服器設定是使用環境變數完成的。如果您使用的是我們的其中一個映像檔,您可以透過編輯 /opt/redash/env 檔案來完成此操作。

相關的設定變數為(請注意,並非所有變數都是必要的)

  • REDASH_MAIL_SERVER(預設值:localhost)
  • REDASH_MAIL_PORT(預設值:25)
  • REDASH_MAIL_USE_TLS(預設值:false)
  • REDASH_MAIL_USE_SSL(預設值:false)
  • REDASH_MAIL_USERNAME(預設值:None)
  • REDASH_MAIL_PASSWORD(預設值:None)
  • REDASH_MAIL_DEFAULT_SENDER(要從中傳送的電子郵件地址)

您還需要設定 REDASH_HOST 的值,這是您的 Redash 執行個體的基礎位址(DNS 名稱或 IP),包含協定,例如:https://demo.redash.io

更新設定後,重新啟動所有服務(使用 docker-compose up -d,執行 docker-compose restart 不足以讀取 env 檔案的變更)。若要測試電子郵件設定,您可以執行 docker-compose run --rm server manage send_test_mail

建議使用電子郵件服務,例如 Amazon SESMailgun 來寄送電子郵件,以確保傳遞成功。

Google OAuth 設定

如果您想使用 Google OAuth 來驗證使用者身分,您需要建立一個 Google 開發人員專案(請參閱說明),然後在 /opt/redash/env 檔案中加入所需的設定。

  • REDASH_GOOGLE_CLIENT_ID (Google OAuth 用戶端 ID)
  • REDASH_GOOGLE_CLIENT_SECRET (Google OAuth 用戶端密碼)

更新後,重新啟動 Web 伺服器 (docker-compose up -d server)。一旦啟用,Redash 將使用 Google OAuth 來驗證現有的使用者帳戶。若要啟用自動建立屬於特定網域名稱的使用者,您可以在設定頁面中加入此網域(或更多網域)。

其他設定選項

Redash 使用環境變數進行設定。如需完整的環境變數列表,請參閱設定文章

HTTPS

如果是生產環境設定,您應該強制執行 HTTPS,並確保您設定了 Cookie 金鑰(請參閱說明)。

安裝的健康檢查

安裝完成後,您可以呼叫 /ping API 端點來執行健康檢查。

RESPONSE
PONG.

如何升級?

建議在新版本發佈時進行升級,以從錯誤修復和新功能中獲益。請參閱這裡以獲取完整的升級說明。

    快速導覽