メインコンテンツまでスキップ

Environments

Squid は作業用に dev と prod の 2 つの environment を提供します。​

新しい application を作成すると、Squid は dev environment と prod environment を自動的に setup します。development と testing には dev environment を使用します。prod environment は application を live にする準備ができたときに使用します。

Identifier

ResourceShared
App ID✓
Region✓
Organization✓
Developer ID✓
API Keys×

Entity

ResourceShared
AI Agents×
Connectors×
Secrets×
Built-in database×
Backend deployments×

Environments と Connectors​

Squid Console で app の dev version と prod version を切り替えると、それぞれに異なる connector set があることに気付きます。 production app の functionality に不要な変更が加わることを防ぐため、dev environment と prod environment の connector は sync されません。Squid app に connector を追加する際は、目的の environment に追加していることを確認してください。

ベストプラクティス

dev environment は connector の development version に接続してください。これにより、application の production version を変更せずに functionality を構築・test できます。

dev environment と prod environment の両方で、指定 connector に同じ connector ID を選択すると、code 内の variable を変更することなく dev で開発してから prod に push できます。

dev environment は、prod environment の application とは別の完全な backend application です。

Environment の選択​

Console の Environment​

console で connector を追加または管理する前に、正しい environment にいることを確認してください。Squid Console で environment を切り替えるには、console 上部の environment name を選択し、表示する environment を選択します。

Console の Environment

Development 中の Environment​

default では、.env file の environmentId と apiKey は dev に設定されているため、これらの flag を指定せずに command を実行すると、command は dev environment を default とします。

app の frontend で environment を変更するには、Squid context で適切な environmentId value を使用します。

<SquidContextProvider
  options={{
    appId: 'YOUR_APP_ID',
    region: 'YOUR_REGION', // example: 'us-east-1.aws'
    environmentId: 'dev', // or 'prod'
  }}
>
  <App />
</SquidContextProvider>

主な Environment Variable​

「envar」とも呼ばれる environment variable は、development environment と production environment の両方で application を構成・運用するために不可欠です。

  • SQUID_APP_ID: 一意の Squid application identifier。（command line では --appId）
  • SQUID_REGION: 'us-east-1.aws' などの region を指定します。（command line では --region）
  • SQUID_ENVIRONMENT_ID: 作業 environment を 'dev' または 'prod' で指定します。（command line では --environmentId）
  • SQUID_API_KEY: API access 用の key。environment ごとに異なります。（command line では --apiKey）
  • SQUID_DEVELOPER_ID: Squid backend をローカルで実行するために必要です。.env file または Squid Console で確認できます。（command line では --squidDeveloperId）

Netlify や GitHub Actions などの tool を使用した automated deployment では、これらの environment variable を deployment machine 上または deployment tool の configuration 内で直接設定することを推奨します。この方法により、API Key などの sensitive information をより安全に管理できます。

deployment machine または process に variable を設定することで、development configuration と production configuration を明確に分離することもできます。

Security に関する考慮事項​

API Key などの sensitive variable は慎重に扱ってください。security risk を避けるため、client-side code に公開してはいけません。このような critical information は、常に server 上または保護された environment variable 内で安全に管理してください。

Console で Envar を確認する​

管理を容易にするため、Squid Console から environment variable を copy できます。この feature は、development と deployment の両方で variable を正確に設定するのに役立ちます。 Squid Console の Show env vars button は、これらの variable に access する便利な tool です。

local development 用の .env file を生成するために、"Create .env file" button をクリックすることもできます。