Installation du portail de services pour les développeurs

Edge pour Private Cloud version 4.17.01

Avant l'installation, vérifiez les points suivants:

• 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.
• 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 dans 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 ce pour installer le portail sur le nœud. L'utilitaire apigee-setup a la forme suivante:

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

Transmettez un fichier de configuration à l'utilitaire apigee-setup qui contient le des informations sur l'installation. Si le fichier de configuration ne contient pas les informations, la configuration apigee-setup vous invite à le saisir dans la ligne de commande.

La seule condition requise est que le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.

Par exemple, utilisez la commande suivante pour installer le portail:

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

Consultez la section Installer l'utilitaire de configuration Edge apigee. pour en savoir plus.

Créer un fichier de configuration

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 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 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 correspondent à l'adresse e-mail. l'adresse e-mail et le 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 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 demande est alors: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

Si la commande est bien exécutée, elle 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 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

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 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, voir Installer 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. Consultez la section Installer l'utilitaire de configuration Edge apigee pour plus encore.
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 d'installer Postgres.
   
   Le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.

4. Installer le portail

Pour installer le portail:

1. Installez l'utilitaire Edge apigee-setup sur au nœud à l'aide d'une procédure Internet ou hors Internet. Consultez la section Installer l'utilitaire de configuration Edge apigee pour plus encore.
2. Assurez-vous d'avoir installé Postgres, soit la version autonome de Postgres soit 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 d'installer le portail.
   
   Le fichier de configuration doit être accessible ou lisible par "apigee" utilisateur.
4. Accédez à la page d'accueil du portail à l'adresse http://localhost:8079 ou au nom DNS du votre portail.
5. Connectez-vous au portail à l'aide des identifiants d'administrateur que vous avez définis dans la 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 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é 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 par défaut, accédez à votre répertoire 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 services pour les développeurs 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 en savoir plus sur l'installation de Edge et SmartDocs, consultez la section Installer SmartDocs.

Vous devez également activer SmartDocs sur le portail. Pour plus d'informations sur les SmartDocs, consultez l'article Utiliser SmartDocs pour documenter API.

8. Et maintenant ?

Une fois que vous avez installé le portail de services pour les développeurs, les étapes suivantes consistent à configurer et à personnaliser en fonction de vos besoins spécifiques. La documentation sur le site Web d'Apigee contient toutes les des informations sur la configuration, le style 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: