Installer le portail

Edge pour Private Cloud v4.19.01

Avant d'installer le portail Apigee Developer Services (ou simplement le portail), assurez-vous que:

  1. Vous devez installer Postgres avant d'installer le portail. Vous pouvez installer Postgres lors de l'installation d'Edge ou installer Postgres de manière autonome pour l'utiliser par le portail.
    • Si vous installez Postgres de manière autonome, il peut se trouver sur le même nœud que le portail.
    • Si vous vous connectez à Postgres installé dans le cadre d'Edge et que Postgres est configuré en mode maître/veille, spécifiez l'adresse IP du serveur Postgres maître.
  2. Vous effectuez l'installation sur la version 64 bits d'une version compatible de Red Hat Enterprise Linux, CentOS ou Oracle. Pour connaître la liste des versions compatibles, consultez la section Logiciels compatibles et versions compatibles.
  3. Yum est installé.

L'installateur n'inclut que les modules Drupal qui sont requis par le portail des services pour les développeurs Apigee (ou simplement le portail). Pour en savoir plus sur l'installation des autres modules auxquels vous avez contribué, consultez la page Extending Drupal 7.

Présentation de l'installation

Pour installer le portail, procédez comme suit. Chacune de ces étapes est décrite plus en détail dans les sections suivantes.

  1. Tester votre connexion
  2. Supprimer les versions antérieures à PHP 7.0
  3. Installer Postgres
  4. Installer le portail
  5. Vérifier que le Gestionnaire de mises à jour est activé
  6. (Facultatif) Configurer Apache Solr
  7. (Facultatif) Installer SmartDocs
  8. (Facultatif) Configurer JQuery

Abandon de la propriété SMTPSSL

Dans les versions précédentes, vous utilisiez la propriété SMTPSSL pour définir le protocole utilisé par le serveur SMTP connecté au portail. Cette propriété est maintenant obsolète.

Vous utilisez désormais la propriété SMTP_PROTOCOL au lieu de la propriété SMTPSSL pour définir le protocole utilisé par le serveur SMTP connecté au portail. Les valeurs valides sont "standard", "ssl" ou "tls".

Créer un fichier de configuration du portail

Vous trouverez ci-dessous un exemple de fichier de configuration silencieux pour une installation de portail. Modifiez ce fichier si nécessaire pour votre configuration. Utilisez l'option -f avec setup.sh pour inclure ce fichier.

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres.
PG_NAME=devportal

# Specify the Postgres admin credentials.
# The portal connects to Postgres by using the 'apigee' user.
# If you changed the Postgres password from the default of 'postgres'
# then set PG_PWD accordingly.
# If connecting to a Postgres node installed with Edge,
# contact the Edge sys admin to get these credentials.
PG_USER=apigee
PG_PWD=postgres

# The IP address of the Postgres server.
# If it is installed on the same node as the portal, specify that IP.
# If connecting to a remote Postgres server,specify its IP address.
PG_HOST=$IP1

# The Postgres user credentials used by the portal
# to access the Postgres database,
# This account is created if it does not already exist.
DRUPAL_PG_USER=drupaladmin
DRUPAL_PG_PASS=portalSecret

# Specify 'postgres' as the database.
DEFAULT_DB=postgres

# Specify the Drupal admin account details.
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin.
# The installer creates this user on the portal.
DEVPORTAL_ADMIN_FIRSTNAME=firstName
DEVPORTAL_ADMIN_LASTNAME=lastName
DEVPORTAL_ADMIN_USERNAME=userName
DEVPORTAL_ADMIN_PWD=PORTAL_ADMIN_PASSWORD
DEVPORTAL_ADMIN_EMAIL=foo@bar.com

# Edge connection details.
# If omitted, you can set them in the portal UI.
# Specify the Edge organization associated with the portal.
EDGE_ORG=edgeOrgName

# Specify the URL of the Edge management API.
# For a Cloud based installation of Edge, the URL is:
# https://api.enterprise.apigee.com/v1
# For a Private Cloud installation, it is in the form:
# http://ms_IP_or_DNS:8080/v1 or
# https://ms_IP_or_DNS:TLSport/v1
MGMT_URL=https://api.enterprise.apigee.com/v1

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword.
# The portal uses this information to connect to Edge.
DEVADMIN_USER=orgAdmin@myCorp.com
DEVADMIN_PWD=ORG_ADMIN_PASSWORD

# The PHP port.
# If omitted, it defaults to 8888.
PHP_FPM_PORT=8888

# Optionally configure the SMTP server used by the portal.
# If you do, the properties SMTPHOST and SMTPPORT are required.
# The others are optional with a default value as notated below.
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com.
SMTPHOST=smtp.gmail.com

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# SMTP port (usually 25).
# The value can be different based on the selected encryption protocol.
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS.
SMTPPORT=25

# Username used for SMTP authentication, defaults is blank.
SMTPUSER=your@email.com

# Password used for SMTP authentication, default is blank.
SMTPPASSWORD=YOUR_EMAIL_PASSWORD

1. Tester votre connexion à Apigee Edge

Testez la connexion entre le serveur sur lequel vous allez installer le portail et le serveur de gestion Edge en exécutant la commande curl suivante sur le serveur du portail:

curl -u EMAIL:PASSWORD http://ms_IP_or_DNS:8080/v1/organizations/ORGNAME

ou :

curl -u EMAIL:PASSWORD https://ms_IP_or_DNS:TLSPort/v1/organizations/ORGNAME

Où EMAIL et PASSWORD sont l'adresse e-mail et le mot de passe de l'administrateur du domaine ORGNAME.

Veillez à spécifier le nom d'hôte et le numéro de port spécifiques à votre installation d'Edge. Le port 8080 est le port par défaut utilisé par Edge. Si vous vous connectez à une organisation dans le cloud, l'URL de la requête est https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

Si l'opération réussit, curl renvoie une réponse semblable à la suivante:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. Supprimer les versions antérieures à PHP 7.0

Le script d'installation recherche les versions antérieures à la version 7.0 de PHP sur le système avant de commencer l'installation. S'il existe des versions de PHP antérieures à la version 7.0, le message d'avertissement suivant s'affiche:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

Supprimez les paquets PHP à l'aide de la commande suivante:

yum remove package_name

Si vous n'êtes pas sûr que PHP est installé sur votre serveur, utilisez la commande suivante:

rpm -qa | grep -i php

Notez que le portail utilise la version PHP 4.18.01-0.0.49. Il ne doit pas correspondre au numéro de version d'Apigee Edge pour Private Cloud.

3. Installer Postgres

Le portail nécessite l'installation de Postgres avant de pouvoir installer le portail. Vous pouvez soit installer Postgres dans le cadre de l'installation d'Edge, soit installer la version autonome de Postgres qui sera utilisée par le portail.

  • Si vous vous connectez à Postgres installé dans le cadre d'Edge et que Postgres est configuré en mode maître/veille, spécifiez l'adresse IP du serveur Postgres maître.
  • Si vous installez la version autonome de Postgres, celle-ci peut se trouver sur le même nœud que le portail.

Pour en savoir plus sur l'installation de Postgres lors de l'installation d'Edge, consultez la section Installer les composants Edge sur un nœud.

Pour installer Postgres de manière autonome:

  1. Installez l'utilitaire apigee-setup Edge sur le nœud à l'aide de la procédure Internet ou hors connexion. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup Edge.
  2. Créez un fichier de configuration Postgres, comme illustré dans l'exemple suivant : 
    # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
HOSTIP=$(hostname -i)

# The pod and region of Postgres. Use the default values shown below.
MP_POD=gateway
REGION=dc-1

# Set the Postgres password. The default value is 'postgres'.
PG_PWD=postgres
  3. Dans l'invite de commande, exécutez le script de configuration pour installer Postgres : 
    /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

    L'option -p pdb spécifie d'installer Postgre. Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".

4. Installer le portail

Avant de pouvoir installer le portail, assurez-vous d'avoir effectué les opérations suivantes, comme décrit dans la section 3. Installez Postgres :

  1. Installez l'utilitaire apigee-setup Edge sur le nœud du portail.
  2. Installer Postgres, soit la version autonome de Postgres, soit l'installation d'Edge

Pour installer le portail:

  1. À l'invite de commande, exécutez le script setup : 
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Où :

    • configFile est le fichier de configuration du portail, comme décrit dans la section Créer un fichier de configuration de portail.
    • -p dp demande au script setup d'installer le portail.

Pour vérifier que l'installation du portail a réussi:

  1. Accédez à la page d'accueil du portail à l'adresse http://localhost:8079 ou au nom DNS de votre portail.
  2. Connectez-vous au portail à l'aide des identifiants d'administrateur que vous avez définis dans le fichier de configuration du portail.
  3. Sélectionnez Rapports > Rapport d'état dans le menu Drupal pour vous assurer de voir l'état actuel du portail.
  4. Assurez-vous que la connexion au serveur de gestion a réussi. Si ce n'est pas le cas :
    1. Accédez à la page "Configuration de la connexion" du portail (par exemple, http://portal_IP:8079/admin/config/devconnect).
    2. Cliquez sur le bouton Tester la connexion. Si la connexion aboutit, vous avez terminé. Si la connexion échoue, continuez.
    3. Vérifiez les paramètres du point de terminaison et de l'authentification :
      • URL du point de terminaison de l'API Management:vérifiez que le protocole (HTTP ou HTTPS), le nom IP ou DNS et le numéro de port sont corrects. Par exemple : 
        http://10.10.10.10:8080/v1
      • Utilisateur authentifié par le point de terminaison:nom d'utilisateur de l'administrateur de l'organisation.
      • Mot de passe de l'utilisateur authentifié: mot de passe de l'administrateur de l'organisation.

      Les valeurs par défaut reflètent les paramètres du fichier de configuration du portail que vous avez créé lors du processus d'installation.

      Ces valeurs doivent correspondre aux valeurs ms_IP_or_DNS, email et password que vous avez utilisées à l'étape 1: Tester votre connexion à Apigee Edge. Le nom d'utilisateur et le mot de passe doivent également correspondre aux valeurs des propriétés USER_NAME et USER_PWD du fichier de configuration d'intégration, ou aux identifiants de tout utilisateur ayant le rôle d'administrateur de l'organisation.

    4. Une fois connecté au serveur de gestion, cliquez sur le bouton Save configuration (Enregistrer la configuration) en bas de la page pour enregistrer vos modifications.

5. Vérifier que le module Gestionnaire de mises à jour est activé

Pour recevoir des notifications de mises à jour Drupal, assurez-vous que le module Drupal Update Manager est activé. Dans le menu Drupal, sélectionnez Modules, puis faites défiler la page jusqu'au module Gestionnaire de mises à jour. Si ce n'est pas le cas, activez-la.

Une fois activée, vous pouvez voir les mises à jour disponibles en utilisant l'élément de menu Rapports > Mises à jour disponibles. Vous pouvez également utiliser la commande Drush suivante:

drush pm-info update

Vous devez exécuter cette commande à partir du répertoire racine du site. Par défaut, le portail est installé sous /opt/apigee/apigee-drupal/wwwroot. Par conséquent, vous devez d'abord remplacer le répertoire par /opt/apigee/apigee-drupal/wwwroot avant d'exécuter la commande. Si vous n'avez pas installé le portail dans le répertoire par défaut, accédez à votre répertoire d'installation.

Utilisez l'élément de menu Rapports > Mises à jour disponibles > Paramètres pour configurer le module afin qu'il vous envoie un e-mail lorsque des mises à jour sont disponibles et pour définir la fréquence de recherche de mises à jour.

6. Configurer le moteur de recherche Apache Solr (facultatif)

Par défaut, les modules Drupal qui se connectent au moteur de recherche Apache Solr sont désactivés lorsque vous installez le portail. La plupart des portails utilisent le moteur de recherche interne Drupal et ne nécessitent donc pas les modules Drupal Solr.

Si vous décidez d'utiliser Solr comme moteur de recherche, vous devez installer Solr localement sur votre serveur, puis activer et configurer les modules Solr Drupal sur le portail.

Pour activer les modules Drupal Solr:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Modules dans le menu Drupal.
  3. Activez le module Apache Solr Framework et le module Apache Solr Search.
  4. Enregistrez les modifications.
  5. Configurez Solr comme décrit sur https://drupal.org/node/1999280.

7. Installer SmartDocs (facultatif)

SmartDocs vous permet de documenter vos API sur le portail de sorte que la documentation de l'API soit entièrement interactive. Toutefois, pour utiliser SmartDocs avec le portail, vous devez d'abord installer SmartDocs sur Edge.

  • Si vous connectez le portail à une installation Edge Cloud, SmartDocs est déjà installé et aucune configuration supplémentaire n'est nécessaire.
  • Si vous connectez le portail à une installation Edge pour le cloud privé, vous devez vous assurer que SmartDocs est installé sur Edge. Pour en savoir plus sur l'installation d'Edge et de SmartDocs, consultez la section Installer SmartDocs.

Vous devez également activer SmartDocs sur le portail. Pour en savoir plus sur les SmartDocs, consultez la section Utiliser SmartDocs pour documenter les API.

8. Configurer le module de mise à jour jQuery pour les installations hors connexion (facultatif)

Si vous installez et utilisez le module de mise à jour JQuery dans une installation hors connexion, vous devez configurer le module pour qu'il utilise la version locale de JQuery. Si vous configurez le module pour qu'il utilise un CDN pour une installation hors connexion, il tentera d'accéder au CDN et entraînera des retards dans le chargement de la page. Pour en savoir plus sur le module de mise à jour jQuery, consultez la page https://www.drupal.org/project/jquery_update.

Pour configurer le module de mise à jour JQuery pour qu'il utilise la version locale de JQuery:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Configuration > Development > JQuery Update dans le menu Drupal.
  3. Cliquez sur Performances dans le panneau de navigation de gauche.
  4. Dans le menu déroulant du CDN JQuery et JQuery UI, sélectionnez Aucun.
  5. Cliquez sur Enregistrer la configuration.

9. Étapes suivantes

Le tableau suivant répertorie certaines des tâches les plus courantes que vous effectuez après l'installation, et inclut des liens vers la documentation Apigee pour en savoir plus:

Tâche Description

Personnaliser le thème

Le thème définit l'apparence du portail, y compris les couleurs, le style et d'autres aspects visuels.

Personnaliser l'apparence

La page d'accueil comprend le menu principal, le message de bienvenue, l'en-tête, le pied de page et le titre.

Ajouter et gérer des comptes utilisateur

Le processus d'enregistrement contrôle la manière dont les nouveaux développeurs enregistrent un compte sur le portail. Par exemple, les nouveaux développeurs ont-ils un accès immédiat au portail ou doivent-ils être validés par un administrateur ? Ce processus contrôle également la manière dont un administrateur du portail est averti lorsqu'un compte est créé.

Configurer la messagerie

Le portail envoie des e-mails en réponse à certains événements. Par exemple, lorsqu'un nouveau développeur s'inscrit sur le portail et lorsqu'un développeur perd son mot de passe.

Ajouter et gérer des comptes utilisateur

Ajoutez une page des conditions d'utilisation que les développeurs doivent accepter avant d'être autorisés à accéder au portail.

Ajouter et gérer des comptes utilisateur

Le portail implémente un modèle d'autorisation basé sur les rôles. Avant d'autoriser les développeurs à s'inscrire, définissez les autorisations et les rôles utilisés par le portail.

Ajouter des articles de blog et de forum

Le portail est compatible avec les blogs et les forums thématiques. Définissez les autorisations requises pour afficher, ajouter, modifier et supprimer des posts de blog et de forum.

Assurez-vous de sauvegarder vos bases de données

Assurez-vous de sauvegarder la base de données Drupal. Notez que chaque installation étant différente, il vous appartient de déterminer la meilleure façon de sauvegarder la base de données.

Consultez également Effectuer une sauvegarde.

Configurer un nom d'hôte

Si vous ne configurez pas de nom d'hôte dans votre serveur DNS, vous pouvez toujours accéder au site via l'adresse IP du serveur. Si vous souhaitez utiliser un nom d'hôte, vous pouvez configurer le DNS pour le serveur, qui devrait fonctionner correctement sans aucune autre configuration dans une configuration de base.

Si vous configurez un équilibreur de charge ou que vous obtenez des URL incorrectes sur votre site pour une autre raison, vous pouvez définir $base_url pour Drupal en procédant comme suit:

  1. Créez le répertoire /opt/apigee/data/apigee-drupal-devportal/sites/default/includes s'il n'existe pas.
  2. Créez un fichier nommé settings.php dans ce répertoire.
  3. Ajoutez le code suivant au fichier settings.php : 
    /**
* Base URL (optional).
*
* If Drupal is generating incorrect URLs on your site, which could
* be in HTML headers (links to CSS and JS files) or visible links
* on pages (such as in menus), uncomment the Base URL statement
* below (remove the leading hash sign) and fill in the absolute URL
* to your Drupal installation.
*
* You might also want to force users to use a given domain.
* See the .htaccess file for more information.
*
* Examples:
*   $base_url = 'http://www.example.com';
*   $base_url = 'http://www.example.com:8888';
*   $base_url = 'http://www.example.com/drupal';
*   $base_url = 'https://www.example.com:8888/drupal';
*
* It is not allowed to have a trailing slash; Drupal will add it
* for you.
*/
# $base_url = 'http://www.example.com/';  // NO trailing slash!
$base_url = ‘http://www.example.com’;
  4. Remplacez la dernière ligne $base_url par le nom d'hôte de votre site.
  5. Enregistrez le fichier.

Notez que vous pouvez placer n'importe quel autre paramètre de /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php dans ce fichier.

Pour en savoir plus sur la propriété $base_url, consultez les ressources suivantes:
Développement personnalisé Vous pouvez également étendre les fonctionnalités de votre portail avec du code personnalisé en dehors de votre thème. Pour ce faire, créez votre propre module Drupal comme décrit dans les sujets de développement de modules de Drupal, puis placez le module dans le répertoire /sites/all/modules.