microCMS

複数環境(ステージング環境)

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

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

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

microCMSドキュメント
https://document.microcms.io/faq/bv-dhc-07

機能の概要

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


複数環境機能の使い方

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



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



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

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


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

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


2環境以上の作成について

本番環境を除いた1環境分の作成については現状のBusinessプラン内に含まれています。
作成したステージング環境の削除は可能で、例えば新規機能開発のたびに新環境を作成→削除を繰り返すといった運用も可能です。

一方で同時に複数の環境が欲しい場合や、開発者ごとに環境を作成したいような場合には、アドオン追加で10環境分まで作成可能となります。
詳しくは料金ページをご覧ください。

仕様

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

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