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 uses Pantheon, a website management service, for hosting cloud-based versions of the Developer Services portal. Pantheon is designed to work with Drupal to let you develop, test, and publish your portal in a secure environment. The following sections describe how to use Pantheon to develop and manage your portal.

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.

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

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

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

Accessing the Pantheon dashboard

When Apigee sends you the URL of your portal, you also receive the URL of the Pantheon Dashboard: https://dashboard.getpantheon.com/.

When you first log in to the Pantheon dashboard, you land on the Sites page, shown below:

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

Select the image of your site (for example apigeedocs) to open the dashboard for that site:

Managing your environments

On the Pantheon dashboard there are three environments listed across the top of the page: Dev, Test, and Live. Each are described in the following table.

Environment

説明

Dev

The Dev environment is connected to your Git repo. Any changes you push to Git show up immediately in the Dev environment.

The URL to this site is in the form below, where org_name is the name of your organization:

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

Test

The Test environment is for testing your latest code with a copy of data from the Live environment. This environment is where you test code changes before pushing it to the Live environment.

The URL to this site is in the form below, where org_name is the name of your organization:

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

Live

The Live environment is your production environment that you make accessible to your customers.

The URL to this site is in the form below, where org_name is the name of your 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/

Developing your portal content

The following sections describe how to develop your portal content.

In addition, refer to the following sections for more details about customizing your portal.

実行したい操作

実行できる操作

詳細情報

サイトの外観の変更

Basic - Use the Appearance menu entry on the portal site to make changes, such as modify the logo and site colors.

See Customize the appearance

Advanced - To make modifications to the complete look and feel of the site, extend the Apigee Responsive theme.

See Customizing the theme

サイト機能の動作の変更

Basic - Use the admin settings on the portal to change/configure the way the site behaves.

See the Apigee documentation starting here

Advanced - Create a custom module to change any behavior of the site.

See Creating custom modules in the Drupal documentation

Overview of the Git repository

The Git repository for your Drupal code contains all of your portal code and is organized using the following structure.

Note: Only modify content within the /sites/all directory. If you modify content that is outside of the /sites/all directory, you will have issues when upgrading to new versions and may experience merge conflicts when checking in changes to Git.

Folder in Git repo

説明

/profiles/apigee

Apigee maintained modules and themes, including:

  • /profiles/apigee/modules/contrib: Drupal contrib modules maintained by Apigee
  • /profiles/apigee/themes/contrib: Drupal contrib themes maintained by Apigee
  • /profiles/apigee/modules/custom: Custom modules created by Apigee
  • /profiles/apigee/themes/custom: Custom themes created by Apigee

Note: Do not modify content in the /profiles/apigee directory or you will have issues when upgrading to new versions and may experience merge conflicts when checking in changes to Git. For Drupal best practices, see Never hack core.

/sites/all

Your custom Drupal modules and themes. For information about managing the content in this folder, see Adding custom modules and themes and Overriding Drupal profile modules and themes.

Note: Only modify content within the /sites/all directory.

Accessing your code

In order to access your code repository in Git, you need to perform the tasks described in the following sections:

Enabling SSH access to your server

Before you can use Git to manage your Drupal code, you must enable SSH to access your server by uploading an SSH key to Pantheon.

To enable SSH access to your server:

  1. Log in to Pantheon at https://dashboard.getpantheon.com/.
  2. On the dashboard, select Account.
  3. Select SSH Keys in the menu on the left.
  4. Add your key and select Add key
    If you need help, select the Learn how to generate an SSH Key link.

Accessing your code repository in Git

Note: See Overview of the Git repository for an overview of the Git repository structure.

To access your code repository in Git:

  1. Log into the Pantheon dashboard.
  2. メインの「Sites」ページでポータルのアイコンを選択します。 
  3. The URL of the Git repo appears on the page to the right of Connection Mode, as shown in the previous figure.
  4. Copy the URL of your Git repo and clone it to your local development environment by using the command:
    > git clone gitURL sitename
    For example: 
    > git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~/repository.git devportal

Any code changes that you push to the Git repo appear immediately in the Dev environment of your portal. 

Deploying code to your portal environments

To code to your portal environments:

  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」です。この記事は、サイトの開発、テスト、プッシュの方法について概説します。 

Adding custom modules and themes

You can expand the functionality of the portal by adding your own custom modules and themes to the folders listed in the following table.

Note: Only modify content within the /sites/all directory. If you modify content that is outside of the /sites/all directory, you may experience merge conflicts when checking in changes to Git.

Module/Theme Folder in Git repository More information (Drupal documentation)
Custom modules sites/all/modules/custom Creating custom modules
Custom themes sites/all/themes テーマのカスタマイズ
Theming Drupal 7

After adding the custom module or theme in the Dev environment, you can deploy it to Test for testing, and then to the Live environment for production, as described in Deploying code to your portal environments.

Overriding Drupal profile modules and themes

The modules and themes in the following directories override the Drupal profile modules and themes maintained and distributed by Apigee in /profiles/apigee. See Overview of your Git repository.

If you wish to use the Drupal profile modules and themes maintained by Apigee in the /profiles/apigee folder, then you will need to remove any duplicate modules and themes that you added to this folder.

Module/Theme Folder in Git repository More information (Drupal documentation)
Drupal Contributed modules sites/all/modules/contrib Contributed modules

Note: Drupal contributed modules in this directory override equivalent modules maintained and distributed by Apigee in /profiles/apigee/modules. Remove any duplicate modules that you added to this folder if you wish to use the Apigee maintained Drupal profile modules.

Drupal Contributed themes sites/all/themes Contributed themes

Note: Drupal contributed themes in this directory override equivalent modules maintained and distributed by Apigee in /profiles/apigee/themes. Remove any duplicate modules that you added to this folder if you wish to use the Apigee maintained profile themes.

 

ポータルのセキュリティ保護

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

Applying an Apigee update to your portal

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

You should check for updates on a regular basis and apply them as necessary. You can subscribe to Apigee release and Pantheon status updates, as described in Subscribing to status updates.

一般的に 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 にプッシュします。 

Migrating your custom features

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

For code in the Git repo, you can use the process described in Deploying code to your portal environments to migrate the code from Dev to Test to Live.

If you have created any custom configurations, use one of the following methods to migrate them:

Method 説明
Export your configuration to code Many common configurations are "exportable" to code using the Features module. For example, views, panels, image cache, and so on.
Implement hook_update_N() function Drupal manages database and configuration changes by using the hook_update_N() function.

If you have a custom module, you can:

  • Add hook_update_N() functions to your module's .install file to process your changes.
  • Deploy these changes along with your code.
  • Run update.php to migrate the changes in the Stage and Prod environments.
  •  

See also Using the Pantheon Workflow which provides an overview of how to develop, test, and push your site. Included in that article is the section on Configuration Management.

Configuring a custom domain

The domain names that Apigee provides for a portal default to apigee.io, as described in Managing your environments, which may not be what you want to expose to your customers.

Paid portal plans can configure a custom domain name for the portal (Developer, or free accounts, cannot create a custom domain). To use a custom domain create a CNAME in your DNS and point your domain to edge.apigee.getpantheon.com.

The instructions on the Pantheon dashboard specify to use CNAME edge.live.getpantheon.com, but this is incorrect. Make sure you use to edge.apigee.getpantheon.com.

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

  1.  次の DNS 設定を構成します。
    developer.mytech.com. 3600 IN CNAME edge.apigee.getpantheon.com
    DNS のこの変更がすべてのクライアントデバイスに対して有効になるまで、最大 48 時間かかることがあります。
  2. Use the Domains / SSL menu entry on the left side of the dashboard to add this domain to your Pantheon dashboard for the Live environment only.
    In most cases, you only configure DNS for the Live environment, not for Dev and Test. You should not use the Dev or Test environments for production.

For more information, see the Pantheon documentation here

ポータル管理者の追加

When you receive the email from Apigee that your portal is ready, Apigee will have already configured the list of portal administrators. You can see that list by selecting the Team link in the upper-right side of the site dashboard. 

To add additional administrators, contact Apigee Customer Support

Subscribing to status updates

You can subscribe to Apigee release and status updates at status.apigee.com. Click Subscribe to Updates, enter your contact information, such as email address, when prompted, and click Subscribe. On the email notification management page, ensure that Developer Portal is selected, toggle other notification settings as required, and click Update Preferences.

You can subscribe to Pantheon status updates and incident reports, such as when an outage occurs, at http://status.getpantheon.com. Click on the Subscribe to Updates link so sign up.

Help or comments?