Takos Docs

テーマ切替

環境変数 ​

アプリ全体の環境変数を spec.env で宣言的に管理する。デプロイ後の URL やリソース ID をテンプレート変数で自動注入できる。

基本 ​

yaml
env:
  required:
    - TAKOS_ACCESS_TOKEN
  inject:
    PUBLIC_URL: "https://example.com"
field説明
required必須環境変数のリスト。デプロイ時に未設定ならエラー
injectテンプレート変数を使って値を自動注入

テンプレート変数 ​

inject の値には {{...}} 形式のテンプレート変数を使える。デプロイ後にシステムが実際の値に解決し、Worker / Container に環境変数として注入する。

yaml
env:
  inject:
    BROWSER_API_URL: "{{routes.browser-api.url}}"
    EXECUTOR_API_URL: "{{routes.executor-api.url}}"
    DB_ID: "{{resources.main-db.id}}"
    SERVICE_IP: "{{services.my-api.ipv4}}"

参照できる値 ​

テンプレート解決例説明
{{routes.<name>.url}}https://app.takos.jp/sessionルートのフル URL
{{routes.<name>.domain}}app.takos.jpルートのドメイン
{{routes.<name>.path}}/sessionルートのパス
{{containers.<name>.port}}8080CF Container のポート
{{services.<name>.ipv4}}203.0.113.42常設サービスの割当 IPv4
{{services.<name>.port}}3000常設サービスのポート
{{workers.<name>.url}}https://host.workers.devワーカーの URL
{{resources.<name>.id}}abc-123リソース ID

存在しない名前を参照するとバリデーションエラーになる。

使用例: 常設サービスの IP を注入 ​

常設サービスの ipv4 を他の Worker から参照する例。

yaml
services:
  api-server:
    dockerfile: Dockerfile
    port: 3000
    ipv4: true

env:
  inject:
    API_PORT: "{{services.api-server.port}}"
    API_IP: "{{services.api-server.ipv4}}"

{{services.api-server.port}} はデプロイ時に 3000 に解決される。

Worker 固有の環境変数 ​

特定の Worker だけに環境変数を設定することもできる。

yaml
workers:
  web:
    build: ...
    env:
      PUBLIC_APP_NAME: Notes Assistant
      NODE_ENV: production

spec.env はアプリ全体、workers.<name>.env は特定の Worker にだけ適用される。

次のステップ ​

  • Routes --- ルートの定義方法
  • Workers --- Worker の定義方法