Installation du portail de services pour les développeurs

Edge pour Private Cloud version 4.17.01

Avant de procéder à l'installation, vérifiez les points suivants:

  • Vous installez Postgres avant d'installer le portail. Vous pouvez soit installer Postgres dans le cadre de l'installation d'Edge, soit installer Postgres de manière autonome pour une utilisation par le portail.
    • Si vous installez Postgres de façon autonome, elle peut se trouver sur le même nœud que le portail.
    • Si vous vous connectez à Postgres qui est installé avec Edge et que Postgres est configuré en mode maître/veille, spécifiez l'adresse IP du serveur Postgres maître.
  • Vous effectuez l'installation sur la version 64 bits d'une version compatible de Red Hat Enterprise Linux, CentOS ou Oracle. Consultez la liste des versions compatibles sur la page Logiciels et versions compatibles.
  • Yum est installé.

Présentation de l'installation

Après avoir installé Edge l'utilitaire apigee-setup sur un nœud, utilisez-le pour installer le portail sur le nœud. L'utilitaire apigee-setup se présente sous la forme suivante:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Transmettez à l'utilitaire apigee-setup un fichier de configuration contenant les informations sur l'installation. S'il manque les informations requises dans le fichier de configuration, l'utilitaire apigee-setup vous invite à les saisir sur la ligne de commande.

La seule condition requise est que le fichier de configuration soit accessible ou lisible par l'utilisateur "apigee".

Par exemple, exécutez la commande suivante pour installer le portail:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

Pour plus d'informations, reportez-vous à la section Installer l'utilitaire de configuration d'Apigee Edge.

Créer un fichier de configuration

Vous trouverez ci-dessous un exemple de fichier de configuration silencieuse pour une installation de portail. Modifiez ce fichier si nécessaire pour votre configuration. Utilisez l'option -f pour setup.sh afin d'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=pWord 
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=pWord 

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

# You must configure the SMTP server used by the portal. 
# 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 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# 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=yourEmailPassword

1. Tester votre connexion à Apigee Edge

Testez votre connexion au serveur de gestion Edge en exécutant la commande cURL suivante à partir d'une invite de commande sur le serveur de 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}

EMAIL et PASSWORD correspondent à l'adresse e-mail et au mot de passe de l'administrateur de ORGNAME.

Veillez à spécifier le nom d'hôte et le numéro de port spécifiques à votre installation 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 demande est la suivante: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

Si l'opération réussit, cette commande 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. Suppression des versions de PHP antérieures à la version 7.0

Le script d'installation recherche des versions de PHP antérieures à la version 7.0 sur le système avant de démarrer 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

Pour CentOS et RedHat Enterprise Linux (RHEL), supprimez les packages PHP à l'aide de la commande suivante:

yum remove <package-name>

3. Installer Postgres

Le portail nécessite l'installation de Postgres avant que vous puissiez l'installer. Vous pouvez soit installer Postgres dans le cadre de l'installation d'Edge, soit installer Postgres de manière autonome pour une utilisation par le portail.

  • Si vous vous connectez à Postgres qui est installé dans Edge et que Postgres est configuré en mode maître/veille, spécifiez l'adresse IP du serveur Postgres maître.
  • Si vous installez Postgres de façon autonome, elle peut se trouver sur le même nœud que le portail.

Pour plus d'informations sur l'installation de Postgres dans le cadre de l'installation d'Edge, consultez Installer les composants Edge sur un nœud.

Pour installer la version autonome de Postgres, procédez comme suit:

  1. Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide de la procédure Internet ou non Internet. Pour plus d'informations, reportez-vous à la section Installer l'utilitaire de configuration d'Edge apigee-setup.
  2. Créez un fichier de configuration pour Postgres, comme indiqué ci-dessous:

    # Pod et région de Postgres. Utilisez les valeurs par défaut indiquées ci-dessous.
    MP_POD=gateway
    REGION=dc-1

    # Définissez le mot de passe Postgres. La valeur par défaut est "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 configFile

    L'option "-p pdb" indique l'installation de Postgres.

    Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".

4. Installer le portail

Pour installer le portail:

  1. Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide de la procédure Internet ou non Internet. Pour plus d'informations, reportez-vous à la section Installer l'utilitaire de configuration d'Edge apigee-setup.
  2. Assurez-vous d'avoir installé Postgres, soit de manière autonome, soit dans le cadre de l'installation d'Edge.
  3. Dans l'invite de commande, exécutez le script de configuration:
    > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    L'option "-p dp" indique l'installation du portail.

    Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".
  4. Accédez à la page d'accueil du portail à l'adresse http://localhost:8079 ou au nom DNS de votre portail.
  5. Connectez-vous au portail à l'aide des identifiants d'administrateur que vous avez définis dans le fichier de configuration.

5. Assurez-vous que le module du gestionnaire de mises à jour est activé

Pour recevoir des notifications de mises à jour Drupal, assurez-vous que le module du gestionnaire de mises à jour Drupal est activé. Dans le menu Drupal, sélectionnez Modules et faites défiler jusqu'au module Update manager (Gestionnaire de mises à jour). S'il n'est pas activé, activez-le.

Une fois la fonctionnalité activée, vous pouvez voir les mises à jour disponibles à l'aide de 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 des développeurs est installé dans /opt/apigee/apigee-drupal. Par conséquent, vous devez d'abord remplacer le répertoire par /opt/apigee/apigee-drupal 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 de vous envoyer un e-mail lorsque des mises à jour sont disponibles et de définir la fréquence de recherche des mises à jour.

6. Configurer le moteur de recherche Apache Solar (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 n'ont donc pas besoin des modules Drupal Solr.

Si vous décidez d'utiliser Solr comme moteur de recherche, vous devez l'installer localement sur votre serveur, puis activer et configurer les modules Drupal Solr 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 Framework Apache Solr et le module de recherche Apache Solr.
  4. Enregistrez les modifications.
  5. Configurez Solr comme décrit à l'adresse https://drupal.org/node/1999280.

7. Installer SmartDocs (facultatif)

SmartDocs vous permet de documenter vos API sur le portail de services pour les développeurs de manière à rendre la documentation 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 Installer SmartDocs.

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

8. Quelles sont les prochaines étapes ?

Après avoir installé le portail de services pour les développeurs, vous devez le configurer et le personnaliser en fonction de vos besoins spécifiques. La documentation disponible sur le site Web Apigee contient toutes les informations sur la configuration, l'attribution de styles et la gestion d'un portail. Accédez à la documentation à l'adresse http://apigee.com/docs/developer-services/content/what-developer-portal.

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 où vous pouvez trouver plus d'informations:

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 obtiennent-ils un accès immédiat au portail ou doivent-ils être validés par un administrateur ? Ce processus contrôle également la façon dont un administrateur du portail est informé de la création d'un compte.

Configuration de 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 qu'un développeur perd son mot de passe.

Ajouter et gérer des comptes utilisateur

Ajoutez une page de 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'enregistrer, définissez les autorisations et les rôles utilisés par le portail.

Ajouter des articles de blog et de forum

Le portail prend en charge les blogs et les forums organisés en fils de discussion. Définissez les autorisations requises pour afficher, ajouter, modifier et supprimer des articles de blog et de forum.

Assurez-vous de sauvegarder la base de données

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

Remarque: Le module de sauvegarde et de migration n'est pas compatible avec les bases de données Postgres.

Consultez également la section Effectuer une sauvegarde.

Définir 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, ce qui devrait fonctionner correctement sans aucune autre configuration dans une configuration de base.

Si vous configurez un équilibreur de charge ou si vous obtenez des URL incorrectes sur votre site pour une autre raison, vous pouvez définir $base_url dans le fichier settings.php du portail de développement, qui se trouve par défaut dans le répertoire /opt/apigee/apigee-drupal/sites/default.

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 rubriques de développement de modules de Drupal et placez-le dans le répertoire /sites/all/modules.