Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Pantheon の使用

Apigee では、Web サイト管理サービスの Pantheon を使用して、Developer Services ポータルのクラウドベースバージョンをホストしています。Pantheon では、Drupal と連動して、ポータルの開発、テスト、公開をセキュアな環境で行うことができます。

Acquia is provided as an alternative to customers that need to host the Developer Portal in the EU only due to EU regulations. Apigee uses Pantheon for hosting in the US. For more information about Acquia, see Working with Acquia.

When Apigee sends you the URL of your portal, you also receive the URL of the Pantheon Dashboard: https://dashboard.getpantheon.com/. A subset of the tasks that you can perform using the Pantheon Dashboard include:

  • Apigee からのソフトウェア更新の展開
  • サイトの Git repo のクローン作成 (カスタムコードの変更のため)
  • ポータルの開発、テスト、ライブ環境への公開
  • PHP エラーの検出と解決
  • ポータルのバックアップとリストア
  • セキュリティの適用
  • Manage Domain names and TLS/SSL

確認が必要な資料: Pantheon ドキュメント

このドキュメントでは、ポータルで Pantheon を使う方法を概説します。Pantheon の使い方の詳細については、Pantheon ドキュメントを参照してください。

Pantheon ドキュメントには、「Required Reading」ページが記載されており、多くの重要なドキュメントへのリンクが示されています。

Pantheon の更新情報の購読

停電時など、Pantheon によるインシデントの作成時または更新時にメール通知を受信するには、次のサイトで Pantheon の更新情報の購読を設定します。

http://status.getpantheon.com/

「Subscribe to Updates」リンクをクリックしてサインアップを行います。

初回ログイン時

https://dashboard.getpantheon.com/ で Pantheon に初めてログインする場合、以下のように「Sites」ページが表示されます。

ダッシュボードでは、サイトへのアクセス、アカウントの構成、その他の操作を実行できます。 

サイトの画像を選択して、そのサイトのダッシュボードを開きます。上の図では、サイトは apigeedocs です。

ポータル管理者の追加

ポータルの準備が整ったと Apigee からメールを受信する場合、Apigee はその時点ですでにポータル管理者のリストの構成を完了しています。サイトダッシュボードの右上で「Team」リンクを選択して、このリストを表示できます。 

その他の管理者を追加するには、Apigee カスタマサポートまでお問い合わせください。 

SSH キーのアップロードと Git repo のクローン作成

ポータルと関連付けられた Git repo にアクセスできるように、SSH キーを Pantheon にアップロードします。Git repo には、サイトのすべてのコードが含まれます。これは、新しいコードの追加や既存コードのカスタマイズでポータルを構成できることを表します。  

Git リポジトリではすべての Drupal および Apigee モジュールへのアクセス権が与えられますが、決してこれらのモジュールのコードを変更しないでください。sites/all フォルダでは、独自のカスタムモジュールとテーマの作成のみに限定してください。  

SSH キーのアップロード

  1. https://dashboard.getpantheon.com/ で Pantheon にログインします。
  2. ダッシュボードで「Account」を選択します。
  3. 左側のメニューで「SSH Keys」を選択します。
  4. キーを追加して「Add key」を選択します。
    ヘルプが必要な場合は、「Learn how to generate an SSH Key」リンクを選択します。

Git repo へのアクセス

  1. メインの「Sites」ページでポータルのアイコンを選択します。 
  2. 前述の図に示したように、ページでは Git repo の URL が「Connection Mode」の右側に表示されます。
  3. Git repo の URL をコピーして、次のコマンドを使用してローカルの開発環境にクローンを作成します。
    > git clone gitURLsitename
    例: 
    > git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~/repository.git devportal

Git repo にプッシュするコードのすべての変更は、ポータルの Dev 環境にすぐに表示されます。次のセクションでは、Dev 環境について説明します。  

実行したい操作

実行できる操作

詳細情報

サイトの外観の変更

基本: ポータルサイトで「Appearance」メニューエントリを使用して、ロゴ、サイトの色など外観を変更します。

外観のカスタマイズ」を参照

詳細設定: サイトの外観を全体的に変更するには、Apigee Responsive テーマを拡張します。

テーマのカスタマイズ」を参照

サイト機能の動作の変更

基本: ポータルで管理者設定を使用してサイトの動作を変更/構成します。

ここから Apigee ドキュメントを参照

詳細設定: カスタムモジュールを作成してサイトの動作を変更します。

Creating Drupal modules」を参照

ポータルサイトの開発

ポータルを開発するために、次のアクションを実行できます。 

  • 管理者インターフェイスまたはコードでのテーマのカスタマイズ
  • カスタムコードおよびモジュールの追加
  • バックアップの構成
  • ドメインの構成 
  • Configure TLS/SSL 
  • その他

サイトダッシュボードで最初に目に入る内容は、ページの上部にリストされる 3 つの環境です。

Environment

説明

Dev

Dev 環境は Git repo に接続されます。Git にプッシュするすべての変更は Dev 環境にすぐに表示されます。

このサイトへの URL は次の形式で表示されます。org_name は組織 (organization) の名前です。

http://dev-{org_name}.devportal.apigee.io/

Test

Test 環境の目的は、Live 環境から取得したデータコピーで最新のコードをテストすることです。この環境は、Live 環境にプッシュする前にコードの変更をテストする場所です。

このサイトへの URL は次の形式で表示されます。org_name は組織 (organization) の名前です。

http://test-{org_name}.devportal.apigee.io/

Live

Live 環境は、お客様がアクセスする実稼働環境です。

このサイトへの URL は次の形式で表示されます。org_name は組織 (organization) の名前です。

http://live-{org_name}.devportal.apigee.io/

For portals created prior to June 15, 2017 that have not been migrated, the URLs to your portal environments will be in the following form:

http://{environment}-{your-org-name}.devportal.apigee.com/

カスタムポータルドメインの構成

The table above shows the default URLs that Apigee creates for a portal. Note that by default the domain names contain "apigee.io." However, a domain name containing "apigee.io" may not be what you want to expose to your customers.

有料のポータルプランでは、ポータルに対してカスタムドメイン名を構成できます。無料アカウントであるデベロッパでは、カスタムドメインを作成できません。カスタムドメインを使用するには、DNS で CNAME を作成して、ドメインを edge.apigee.getpantheon.com にポイントします。

Pantheon Dashboard の手順では、CNAME に edge.live.getpantheon.com を使用するように指定されていますが、これは間違っています。edge.apigee.getpantheon.com を使用していることを確認してください。

例えば、Mytech という会社のカスタムドメインを構成するには、次の手順に従います。

  1.  次の DNS 設定を構成します。
    developer.mytech.com. 3600 IN CNAME edge.apigee.getpantheon.com
    DNS のこの変更がすべてのクライアントデバイスに対して有効になるまで、最大 48 時間かかることがあります。
  2. ダッシュボードの左側にある「Domains / SSL」メニューエントリを使用して、Live 環境専用の Pantheon Dashboard にこのドメインを追加します。
    多くの場合、Dev および Test ではなく Live 環境のみに DNS を構成します。実稼働には、Dev または Test 環境を使用しないでください。

詳細については、ここで Pantheon ドキュメントを参照してください。 

サイトに GIT コードの変更を適用

GIT コードの変更をサイトに適用する一般的な手順は次のとおりです。

  1. コードの更新を Git にプッシュすると、すぐに Dev 環境は更新されます。
  2. Pantheon にログインしてサイトを選択します。 
  3. Dev 環境を選択します。
  4. 左側のメニューで「</>Code」を選択して、コードの変更に関するメッセージを「Commit Log」に表示します。
  5. ページの上部で Test 環境を選択します。
    1. まだ DevTest にアップロードしていない場合、すぐに実行するようにメッセージで指示されます。 
    2. すでに Test 環境を使用している場合、メッセージが表示されて、展開の準備が整っている Dev からのコミットが存在すると通知されます。
  6. すでにサイトを Live 環境にプッシュした場合、3 番目のチェックボックスを任意にオンにして、ライブデータベースとデベロッパがアップロードした任意のファイルを Live から Test にコピーできます。Live 環境から入手した最新のデータでコードの変更をテストする場合は、この手順が効果的です。
  7. 「Deploy Code from Development」ボタンを選択します。
  8. Test 環境でポータルをテストします。 
  9. Dev 環境でコードを修正して、テストのためにファイルを Test に再びプッシュします。
  10. テストが完了したら、ページの上部で Live 環境を選択します。
    1. まだ Test を Live にアップロードしていない場合、すぐに実行するようにメッセージで指示されます。 
    2. すでに Live 環境を使用している場合、メッセージが表示されて、展開の準備が整っている Test からのコミットが存在すると通知されます。Dev から Test に展開した場合と同じ方法でこれらの変更を展開します。テストが完了したら、Live 環境にコードをプッシュします。 

参考資料 :

  • Pantheon は、このプロセスで参照できる「Going Live」の記事をいくつか提供しています。最も重要な記事の 1 つは、「Using the Pantheon Workflow」です。この記事は、サイトの開発、テスト、プッシュの方法について概説します。 

独自のモジュールの追加

独自のモジュールを追加することで、ポータルの機能性を拡張できます。モジュールを追加するには、Git repo で sites/all/modules/custom フォルダに追加します。Dev 環境でモジュールをテストした後、Test にプッシュし、次に実稼働のために Live 環境にプッシュできます。 

サイトのセキュリティ保護

DevTest、および Live 環境と関連付けられたポータルサイトは公開されており、デフォルトでアクセス可能になっています。これは、だれでもサイトの URL でアクセスできることを表しています。ただし、アカウントの登録またはサイトへのログインは実行できません。ユーザー登録の制御の詳細については、「ユーザーアカウントの追加と管理」を参照してください。

Dev および Test サイトは非公開にしたい、また Live サイトも開発が完了するまでは非公開にしたいと考える場合もあります。適切な資格情報を持つユーザーのみがアクセスできるように、Pantheon では、サイトをロックするユーザー名/パスワードの制御を追加しています。 

3 つの環境でロックを追加するには、対象の環境で左側にあるメニューの「Security」を選択します。詳細については、「Locking Your Site」を参照してください。

If you want to enable TLS/SSL for your site, see Using SSL on the portal

サイトの保守

サイトの保守では、次を含めて多くの作業を行います。

  • 更新のチェック
  • 最新の Apigee ポータルリリースでの更新
  • 更新のテスト
  • サイト (ファイル、コード、およびデータベース) のバックアップ
  • ユーザーおよび管理者の管理

Developer Services ポータルへの Apigee 更新の適用

Apigee がポータルの新リリースを公開すると、メッセージが Pantheon Dashboard に表示されます。 

ポータルの更新を通知する自動的なメカニズムはありません。更新を定期的に確認して、必要に応じて適用する必要があります。

一般的に Dev 環境に更新を適用して、次に独自のコードの変更をテストする場合と同じ方法でこれらの変更をテストします。例えば、Dev 環境を Test にプッシュし、Live から Test にライブデータをプッシュして更新をテストします。

環境の「Status」領域に、ダッシュボードの左側にある「Status」メニュー項目からアクセスすると、Drupal モジュールに使用できる更新があるかどうかを確認できます。これらの更新は無視してください。Apigee は、ユーザーのために Drupal モジュールの更新をポータルの次のリリースに自動的に組み込みます。

ユーザーに代わって Drupal モジュールを更新することを Apigee に許可すると、Apigee では最新のポータルコードに対してこれらの更新が確実にテストされます。通常の Apigee ポータルリリースサイクルを外れて Drupal モジュールを更新すると、予期せぬ問題が発生する可能性があります。

更新の適用

  1. Pantheon (https://dashboard.getpantheon.com/) にログインしてサイトを選択します。
  2. Dev 環境を選択します。
  3. 左側で「</>Code」メニューエントリを選択します。Apigee の更新が使用可能になると、これらの更新がリストされます。 
  4. 更新を適用します。
    1. 「Run update.php after pulling code」チェックボックスをオンにします。
    2. 可能な場合は「Clear caches after pulling code」チェックボックスをオンにします。 
    3. 「Deploy Code」ボタンを選択します。
  5. 更新が完了したら、ダッシュボードの左側で「Status」メニュー項目を選択します。
  6. 環境の「Status」領域には、次に示すようにデータベース更新のエラーが表示されることがあります。  

    環境でこのエラーが表示される場合は、データベースを手動で更新します。

    1. 管理者またはコンテンツ作成特権を持つユーザーとしてポータルにログインします。
    2. ポータルの左上で「Home」アイコン > 「Run updates」を選択します。
    3. 手順に従ってデータベースを更新します。
  7. 前述の手順で Test 環境にコードの変更をプッシュして、次に Live にプッシュします。 

カスタム機能の更新

カスタムのコードまたは機能をポータルに追加する場合、これらを保守する方法、Dev から TestLive 環境へ移行する方法を決める必要があります。 

Git repo 内のコードの場合、前述の手順に従って Dev から、TestLive へコードを移行できます。カスタムモジュールを作成する場合、次のいずれかの方法でモジュールを移行できます。

  • 構成のエクスポート
    共通の構成を「エクスポート可能」であることが増えています。例えば、Drupal ビューは簡単にコードにエクスポートされます。Features モジュールは、この手法で機能しています。エクスポートされた構成 (ビュー、パネル、イメージキャッシュなど) をサポートする
    システムを使用している場合、このモジュールを使用できます。
  • hook_update_N() の実装
    Drupal はデータベースと構成の変更を hook_update_N() 関数を使用して管理します。カスタムモジュールがある場合は、更新機能をモジュールの .install ファイルに追加して変更を処理できます。これらの変更は、コードとともに展開できます。次に、update.php を実行して、Test および Live 環境で変更することができます。
    例えば、ポータルの Git repo で profiles/apigee/modules/custom/devconnect/devconnect.install 内の devconnect_update_7423(&$sandbox) 関数を参照してください。

参考資料 :

  • 上記のリンクに加えて、サイトの開発、テスト、プッシュの方法について概説している記事「Using the Pantheon Workflow」を参照してください。この記事には、「Configuration Management」セクションが含まれます。

 

Help or comments?