メインコンテンツに移動

amazee.ioにおけるRoutesの設定方法

amazee.ioにおけるRoutesの設定方法
目次

はじめに

Web開発において、Routes設定は非常に重要な要素です。特に、複雑なアプリケーションやシステムを開発する際には、適切なルーティングを導入することが不可欠です。本記事では、amazee.ioの開発において、開発部門の皆様が注意すべきRoutes設定について詳しく解説します。

Routesとは

Routesとは、Webアプリケーションにおいてユーザーからのリクエストを特定のエンドポイントに導くための設定を指します。これは、URLとそれに対応する処理をマッピングすることで実現されます。例えば、ユーザーがexample.comにアクセスした場合、そのリクエストが正しいサービスに到達するように設定することができます。Routes設定は、アプリケーションのパフォーマンス、セキュリティ、ユーザビリティに直結するため非常に重要です。

Routesの重要性

開発の効率化

Routes設定を適切に行うことで、開発チームは異なる環境(例えば、開発、ステージング、本番環境)間でのリクエストのルーティングを簡単に管理することができます。これにより、環境ごとの特定の設定が容易になります。

セキュリティの向上

適切なRoutes設定により不要なエンドポイントへのアクセスを防ぎ、セキュリティを向上させる助けとなります。また、Amazee.ioのルーティング設定では、TLS(Transport Layer Security)を簡単に導入[1]できます。

Routesの設定方法

基本的な設定例

Amazee.ioのRoutes設定は、.lagoon.ymlファイル[2] を使用して行います。以下は基本的な設定例です。


environments:
  dev:
    routes:
      - nginx:
          - example.com:
              tls-acme: true
              insecure: Redirect

この設定により、example.comにアクセスがあった場合に、dev環境にデプロイされたサービスが応答するようになります。

カスタマイズ

より複雑な設定も可能です。例えば、環境毎にドメインを設定する場合や、複数のドメインを扱う場合などです。以下は、複数の環境とドメインの設定例です。


environments:
  dev:
    routes:
      - nginx:
          - dev.example.com:
              tls-acme: true
              insecure: Redirect
  main:
    routes:
      - nginx:
          - example.com:
              tls-acme: true
              insecure: Redirect
          - www.example.com:
              tls-acme: true
              insecure: Redirect

Routes設定における注意点

環境ごとの設定

Routesを設定する際には、environments.[name].routes[3] の、nameにルーティングしたいLagoon上の環境名を指定する必要があります。これにより、環境ごとに適切なルーティングを設定することができます。

独自ドメインの設定

独自ドメインの取得は別途レジストラから行う必要があります。取得したドメインをamazee.ioインフラストラクチャにリンクするためには、DNSレコードの設定[4] が必要です。AレコードやCNAMEレコードの値をamazee.ioへ向けることでドメインを適切なサービスに紐付けます。

HTTPSの有効化

Amazee.ioでは、TLS(HTTPS)を簡単に有効化 できますが、設定が正しくないと通信が暗号化されず、セキュリティリスクが生じます。tls-acme: trueとすることで、Let's Encryptを利用して自動的にSSL証明書を取得し、HTTPS通信を有効化します。また、insecure: Redirectとすることで、HTTPでのアクセスをHTTPSにリダイレクトする設定を行います。

まとめ

Routes設定は、Webアプリケーションの機能性と信頼性に直結する重要な要素です。適切なRoutes設定を行うことで、ユーザーのリクエストがスムーズに処理され、開発プロセスが効率化され、セキュリティも向上します。詳細な設定や最新情報については、公式ドキュメント[5]を参照し、適切なRoutes設定を実現しましょう。

参考

[1] https://docs.lagoon.sh/ja/concepts-basics/lagoon-yml/#ssl-configuration-tls-acme
[2] https://docs.lagoon.sh/ja/concepts-basics/lagoon-yml/#lagoonyml
[3] https://docs.lagoon.sh/ja/concepts-basics/lagoon-yml/#environmentsnameroutes
[4] https://docs.lagoon.sh/ja/using-lagoon-the-basics/going-live/#dns
[5] https://docs.lagoon.sh/ja/