Installer le portail

Edge pour Private Cloud v4.18.05

Avant d'installer le portail de services pour les développeurs Apigee (ou simplement le portail), vérifiez les points suivants:

1. Vous installez Postgres avant d'installer le portail. Vous pouvez soit installer Postgres d'installer Edge, ou d'installer Postgres en version autonome pour une utilisation par le portail.
   • Si vous installez la version autonome de Postgres, celle-ci 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. Consultez la liste des versions compatibles à l'adresse Logiciels et versions compatibles
3. Yum est installé.

Le programme d'installation n'inclut que les modules fournis par Drupal qui sont requis par le Portail Apigee Developer Services (ou simplement le portail). Pour plus d'informations sur l'installation d'autres modules auxquels vous avez contribué, consultez Extension de Drupal 7

Présentation de l'installation

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

1. Tester votre connexion
2. Supprimer les versions de PHP antérieures à la version 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 effectuer les opérations suivantes : définir le protocole utilisé par le serveur SMTP connecté au portail. Cette propriété a été obsolète.

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

Créer un fichier de configuration de portail

Vous trouverez ci-dessous un exemple de fichier de configuration silencieuse pour l'installation d'un portail. Modifier ce fichier selon les besoins de votre configuration. Utilisez l'option -f pour setup.sh pour inclure ceci .

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 votre connexion entre le serveur sur lequel vous allez installer le portail et l'appareil Edge de gestion 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 du administrateur pour ORGNAME.

Veillez à spécifier le nom d'hôte et le numéro de port spécifiques à votre installation d'Edge. 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 à celle-ci:

{
  "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 vérifie la présence de versions de PHP antérieures à la version 7.0 sur le système avant de lancer le 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 packages PHP à l'aide de la commande suivante:

yum remove package_name

Si vous ne savez pas si PHP est installé sur votre serveur, utilisez la commande suivante:

rpm -qa | grep -i php

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 ou installez la version autonome de Postgres portail.

• Si vous vous connectez à Postgres installé dans le cadre d'Edge et que Postgres est configuré dans 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 plus d'informations sur l'installation de Postgres dans le cadre de l'installation d'Edge, consultez Installez les composants Edge sur un nœud.

Pour installer la version autonome de Postgres:

1. Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide du sur Internet ou hors Internet. Voir Installez l'utilitaire de configuration Edge Apigee pour en savoir plus.
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 d'installation 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 être accessible ou lisible par "apigee" utilisateur.

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. Installer l'utilitaire Edge apigee-setup 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. Dans 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 Créez un fichier de configuration du portail.
   • -p dp indique 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 portail. fichier de configuration.
3. Sélectionnez Rapports > d'état dans le menu Drupal pour vous assurer peuvent consulter l'état actuel du portail.
4. Vérifiez que la connexion au serveur de gestion a été établie. Si ce n'est pas le cas: <ph type="x-smartling-placeholder">
   </ph>
   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 est établie, vous avez terminé. Si la connexion échoue, continuez.
   3. Vérifiez les paramètres du point de terminaison et d'authentification: <ph type="x-smartling-placeholder">
      </ph>
      • 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é du point de terminaison:l'administrateur de l'organisation nom d'utilisateur.
      • Mot de passe de l'utilisateur authentifié: le mot de passe de l'administrateur de l'organisation mot de passe.

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

      Ces valeurs doivent correspondre à ms_IP_or_DNS, email et password valeurs utilisées à l'étape 1: Testez votre connexion à Apigee Edge Le nom d'utilisateur et le mot de passe doivent également correspondre aux valeurs de l'USER_NAME et USER_PWD dans fichier de configuration d'intégration, ou les identifiants de tout utilisateur dont le rôle est l'administrateur de l'organisation.

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

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 est activé. Dans le menu Drupal, sélectionnez Modules et faites défiler vers le bas Gestionnaire de mises à jour. Si ce n'est pas le cas, activez-la.

Une fois les mises à jour activées, vous pouvez les consulter en cliquant sur Rapports > Disponible Mises à jour. 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é à l'adresse /opt/apigee/apigee-drupal/wwwroot. Par conséquent, vous devez d'abord remplacer le répertoire par /opt/apigee/apigee-drupal/wwwroot avant en exécutant la commande. Si vous n'avez pas installé le portail dans le répertoire par défaut, accédez à votre d'installation.

Utilisez le menu Rapports > Mises à jour disponibles > Élément de menu "Paramètres" à configurer au module de vous envoyer un e-mail lorsque des mises à jour sont disponibles et de définir la fréquence de vérification 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 n'utilisent donc pas nécessitent 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 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 Apache Solr Framework et Apache Solr de recherche.
4. Enregistrez les modifications.
5. Configurez Solr comme décrit sur la page https://drupal.org/node/1999280.

7. Installer SmartDocs (facultatif)

SmartDocs vous permet de documenter vos API sur le portail de manière à rendre documentation de l'API entièrement interactive. Toutefois, pour utiliser SmartDocs avec le portail, vous devez au préalable installer SmartDocs sur Edge.

• Si vous connectez le portail à une installation Edge Cloud, SmartDocs est déjà et qu'aucune configuration supplémentaire n'est nécessaire.
• Si vous connectez le portail à une installation Edge pour Private Cloud, vous devez vous assurer que SmartDocs est installé sur Edge. Pour plus d'informations sur l'installation de Edge et SmartDocs, voir Installez SmartDocs.

Vous devez également activer SmartDocs sur le portail. Pour plus d'informations sur SmartDocs, consultez Utilisation de SmartDocs pour documenter API.

8. Configurez les Module JQuery Update pour les installations hors Internet (facultatif)

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

Pour configurer le module JQuery Update afin 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 > Développement > JQuery Update dans le menu Drupal.
3. Cliquez sur Performances dans le panneau de navigation de gauche.
4. Dans le menu déroulant "JQuery and JQuery UI CDN" (CDN de l'interface utilisateur JQuery et JQuery), sélectionnez None (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 où vous pouvez trouver plus d'informations: