microCMS

複数環境(開発環境)

microCMSにはすでに本番運用等を開始している際に、開発者がAPIスキーマ等の変更を行うことにリスクがあるような状況に対応するための複数環境機能をご用意しております。

またこれから運用を開始する際にも、開発環境と本番環境を分けておきたい場合にお使いいただけます。

この機能をお使いいただくことで本番環境に影響を与えることなく機能追加や修正を行うことが可能です。
(ご利用できるプランについては料金表の「複数環境管理」欄をご参照ください)

コンテンツ入稿者によるコンテンツの事前確認(画面プレビュー)については、本機能の対象外で、別途下書き保存とdraftKeyを用いて解決いただけます。
画面プレビューについて詳しくはこちらをご覧ください。

画面プレビューの設定方法は?
https://help.microcms.io/ja/knowledge/how-to-implement-preview

機能の概要

複数環境機能では「本番環境」のコンテンツやメディアを複製した環境を作成できます。
開発時など、本番以外のウェブサイトやアプリでは複製した環境側のAPIを利用することで本番環境には一切の影響なく安全に作業を行うことが可能です。
また複製した環境側のAPIスキーマ等の変更も本番環境には影響しないため、機能追加や編集などの際にも安全に作業を進めることができます。


複数環境機能の使い方

まず、環境を作成するには管理画面内の環境メニューを開きます。



「新規作成」ボタンを押すと環境作成ダイアログが表示されます。



環境の作成時には環境名(任意の文字列)と、コンテンツのコピー範囲を指定します。
コンテンツのコピー範囲には以下の3パターンがあります。

  • すべてコピーする
  • 公開済みのコンテンツのみをコピーする
  • コピーしない


詳細は後述しますが、作成した環境内では全てのユーザーが「管理者権限」を持ちます。
そのため下書き中コンテンツなど、本来は閲覧されるべきでない情報が本番環境に含まれる場合にはコピー範囲を絞って環境作成を行ってください。

上記を入力後、「作成する」ボタンを押すことで環境を作成できます。
作成済みの環境は設定画面で確認できます。環境名の変更、環境の削除もこの画面内にて可能です。



なお環境のコピー元となるのは、本番環境のみとなります。ステージング環境→開発環境、ステージング環境→本番環境の様なコピーを行うことはできません。

新規にサービスを開発する際は、本番環境をベースに構築を進めていただき、リリース後に必要となったタイミングで別環境を作成することを推奨しています。
確認用の環境構築の考え方に関するブログ記事もございますので、あわせてご活用ください。

microCMSでステージング環境を構築する手法3選
https://blog.microcms.io/building-staging-environment
Information

作成した環境を、本番利用することは想定しておりません。今後のアップデートにおいて、影響が出る可能性がございます。本番利用にあたっては、本番環境をご利用ください。

仕様

環境の詳細な仕様は以下の通りです。

  • 新環境にはランダム文字列付きの別のサブドメインが割り当てられます(例:本番環境 example, 作成した環境 example-0htwv5q6lmdmk0ze4l8o)。
  • サービス配下の全API、全コンテンツ、全画像がコピーされます(コンテンツのコピー範囲は指定可能)。
  • APIキーは別のものが発行されます。
  • APIのパスに変化はありません(ドメイン部分は変更はあります)。
  • レビュー機能は利用可能ですが、レビュー内容は本番環境から引き継がれません。
  • Webhookの設定は可能ですが、本番環境からは引き継がれません。
  • ロール機能は一切使用できません。複製した環境側では全員が管理者とほぼ同等の権限となります。
  • カスタムステータスの設定はコピーされますが、コンテンツにセットされたカスタムステータスはコピーされません。
  • コンテンツの更新履歴はコピーされません。
  • メンバーの追加、削除はできません。本番環境のメンバーと常に同期されます。
  • データ転送量、WRITEリクエスト数は全環境分が合算されます。
  • 環境内でのAPIの作成数は無制限です。APIの作成個数には計上されません。
  • コンテンツのインポートは上限100件までとなります。
  • 最大で10環境まで作成可能です。

環境名の変更

環境名の変更を行うには、環境設定の右側の3点リーダーのアイコンをクリック→「環境を編集する」を選択します。
編集画面にて、環境名の編集ができます。



編集できるのは、管理者権限を持ったメンバーのみです。

環境の削除

環境名の変更と同じく、3点リーダーのアイコンをクリック→「環境を削除」から削除できます。
削除できるのは、管理者権限もしくは環境の削除権限を持ったメンバーのみです。