squadbase.yml

Squadbaseでは、アプリをデプロイする時の設定ファイルとしてYAML形式のファイルを使用します。 アプリのビルド方法とクラウド環境の設定を記述するとデプロイ時に設定が自動的に反映されます。

YAMLは通常はsquadbase.ymlという名前で保存されます。デプロイ時にSetting file pathを変更することでファイル名を変更することも可能です。 使用するランタイムやフレームワークによって設定する必要のある項目が異なります。

version: '1'
 
# Build Settings
build:
  framework: streamlit # streamlit | nextjs | morph
  runtime: python3.9 # python3.9, python3.10, python3.11, python3.12, node18, node20, node22
  package_manager: pip # pip, poetry, uv, npm, yarn, pnpm
  entrypoint: src/app.py # src/app.py
  # Custom dockerfile settings
  context: .
  build_args:
    ARG1: value1
    ARG2: value2
 
# Deployment Settings
deployment:
  provider: gcp
  aws:
    memory: 512
    timeout: 30
    provisioned_concurrency: 0
    ephemeral_storage: 512
  gcp:
    memory: 1Gi
    cpu: 1
    timeout: 300
    concurrency: 80
    min_instances: 0
    ephemeral_storage: 10Gi

Build

アプリのビルドに関する設定は、build: 以下に記述します。

Squadbaseでは、アプリのビルドにDockerをしています。frameworkで利用可能なフレームワークに関しては、開発者が自分でDockerfileを用意する必要はありません。 公式サポート以外のフレームワークを利用する場合や、パッケージのインストールなど環境のカスタマイズをしたい場合は用意したDockerfileを使用することもできます。

公式サポートのフレームワークを使用する

公式サポートのフレームワークを使用する場合には、以下の値を設定してビルドを行います。

カスタムDockerfileを使用する

アプリのルートにDockerfileが設定されている場合、Squadbaseはbuild:以下のフレームワークの設定値は使用せずに、Dockerfileを使用してビルドを行います。 contextとbuild_argsは自前のDockerfileを使用してビルドする時にのみ使用されます。

Deployment

アプリのデプロイに関する設定は、deployment: 以下に記述します。 providerで使用するクラウドプロバイダーを指定します。特に指定をしない場合は、gcpが使用されます。

AWS

GCP

課金体系

アプリの実行には、メモリベース、リクエストベース、CPUベースの3つの課金体系があります。 deploymentの項目で定義するコンピューティングのスペックに応じて実行時に課金がされます。

GB-秒,vCPU-秒は、メモリ,CPUをそれぞれ1GB,1vCPUで1秒間使用したときの課金額です。