Installation du portail de services pour les développeurs

Portail des services pour les développeurs v. 4.16.09

Avant d'installer l'application, vérifiez les points suivants :

• 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 cette page.
• Yum est installé.
• Vous sauvegardez les installations existantes. Si vous avez modifié du code dans le cœur de Drupal ou dans des modules non personnalisés, vos modifications seront écrasées. Cela inclut, entre autres, les modifications que vous avez pu apporter à .htaccess. Vous devez supposer que tout ce qui se trouve en dehors du répertoire /sites appartient à Drupal. Le fichier robots.txt fait exception à cette règle. S'il existe à la racine Web, il sera conservé. Avant de procéder à l'installation, sauvegardez l'intégralité du répertoire racine Web de Drupal. L'emplacement d'installation par défaut est /var/www/html, mais vous l'avez peut-être modifié au moment de l'installation. Après avoir suivi les étapes d'installation décrites ci-dessous, vous pouvez restaurer vos personnalisations à partir de la sauvegarde.

Suivez ces étapes pour installer le portail Developer Channel Services.

1. Obtenir le bundle Developer Channel Services

Accédez à la page http://community.apigee.com/content/apigee-customer-support et sélectionnez "Login to your Support Portal" (Se connecter à votre portail d'assistance) pour demander le fichier .tar des services de canal des développeurs de l'une des deux manières suivantes :

• Demandez l'accès au répertoire de téléchargement d'Edge for Private Cloud.
• Demandez une URL pour le fichier .tar des services Developer Channel.

2. 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} https://{hostname}:8080/v1/organizations/{ORGNAME}

Où EMAIL et PASSWORD sont l'adresse e-mail et le mot de passe de l'administrateur pour 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 la suivante : https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

Si l'opération réussit, cette commande 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"
}

3. Supprimer les 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 l'installation. Si des versions de PHP antérieures à la version 7.0 existent, 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 Red Hat Enterprise Linux (RHEL), supprimez les packages PHP à l'aide de la commande suivante :

yum remove <package-name>

4. Installer les services du canal de développement à l'aide du script d'installation automatisé

Utilisez l'une des procédures suivantes pour installer le portail, selon que vous l'installez sur un serveur avec ou sans connexion Internet.

Sur un serveur disposant d'une connexion Internet :

Pour installer Developer Channel Services sur un serveur disposant d'une connexion Internet :

1. Connectez-vous au serveur en tant qu'utilisateur racine ou super-utilisateur.
2. Créez un répertoire pour les fichiers d'installation, par exemple portal.
3. Accédez au nouveau répertoire portal et téléchargez le fichier DeveloperServices_x.y.z.tar des services de canaux pour les développeurs, où x.y.z correspond au numéro de version du portail.
   
   Vous pouvez télécharger un fichier à partir du lien qui vous a été envoyé par Apigee dans un navigateur ou en le copiant, puis en l'ajoutant à la commande cURL suivante :
   > curl -kOL <coller le lien ici>
4. Extrayez le contenu du fichier .tar des services Developer Channel à l'aide de la commande suivante :
   > tar -xvf <tar file>
5. Accédez au répertoire DeveloperServices-4.x.y.z à l'aide de la commande cd.
6. Exécutez le script d'installation à l'aide de la commande suivante :
   > ./networked-install.sh
7. Répondez aux invites.

Sur un serveur sans connexion Internet :

Commencez par créer un script d'installation hors réseau sur un système disposant d'une connexion Internet :

1. Connectez-vous à un système disposant d'une connexion Internet en tant qu'utilisateur racine ou super-utilisateur.
2. Créez un répertoire pour les fichiers d'installation, par exemple portal_tar.
3. Accédez au répertoire portal_tar et téléchargez le fichier DeveloperServices_x.y.z.tar des services de canaux pour les développeurs, où x.y.z correspond au numéro de version du portail.
4. Extrayez le contenu du fichier .tar des services de canaux pour les développeurs à l'aide de la commande suivante :
   > tar -xvf <tar file>
5. Accédez au répertoire DeveloperServices-4.x.y.z à l'aide de la commande cd.
6. Créez le fichier .tar.gz du portail à l'aide de la commande :
   > ./non-networked-install.sh

Un nouveau fichier .tar.gz est créé pour l'installation hors réseau.

1. Connectez-vous au serveur en tant qu'utilisateur racine ou super-utilisateur.
2. Créez un répertoire pour les fichiers d'installation, par exemple portal.
3. Accédez au répertoire portal à l'aide de la commande cd.
4. Copiez le fichier .tar.gz que vous avez créé pour l'installation hors réseau (dans la procédure ci-dessus) dans le répertoire portal.
5. Extrayez le contenu du fichier .tar.gz à l'aide de la commande suivante :
   > tar -xvf <tar file>
6. Accédez au répertoire créé par la commande tar.
7. Définissez les autorisations sur le script install-from-rpm-bundle.sh :
   > chmod 755 install-from-rpm-bundle.sh
8. Exécutez le script install-from-rpm-bundle.sh à l'aide de la commande suivante :
   > ./install-from-rpm-bundle.sh
9. Répondez aux invites.

5. Configurer votre portail des développeurs

La majeure partie de la configuration du portail s'effectue sans que vous n'ayez à intervenir, comme l'installation du module Drupal et la création de contenu par défaut. Vous êtes invité à configurer la base de données, à configurer le point de terminaison Edge et à créer un utilisateur administrateur.

Pour configurer votre portail des développeurs :

1. Accédez à l'URL du serveur dans un navigateur, par exemple :
   http://localhost. Si vous avez configuré une adresse IP ou un DNS spécifique, accédez à http://IP_address ou http://DNS_name.
   
   Vous êtes redirigé vers la page de configuration de la base de données du profil Apigee.
   
   Remarque : En règle générale, vous avez déjà configuré un nom d'hôte et l'avez enregistré auprès de votre serveur DNS afin de ne pas avoir à utiliser http://localhost.
2. Configurez la connexion à la base de données. Si la base de données se trouve sur une machine distante, développez la section Options avancées et saisissez les informations de connexion à cette machine, puis sélectionnez Enregistrer et continuer.
3. Configurez la connexion au point de terminaison Apigee en saisissant les informations suivantes, puis sélectionnez Enregistrer.
   Pour en savoir plus sur ces valeurs, consultez la section "Informations requises avant de commencer l'installation" de la page Exigences du portail des services pour les développeurs.
   1. Organisation de l'API Management
   2. URL du point de terminaison de l'API Management
   3. Utilisateur authentifié du point de terminaison
   4. Mot de passe des utilisateurs authentifiés
4. Configurez l'utilisateur administrateur en saisissant les informations suivantes, puis sélectionnez "Enregistrer". Notez que Drupal crée par défaut un utilisateur administrateur nommé "admin". N'utilisez donc pas "admin" comme nom d'utilisateur.
   Si vous ignorez cette étape, vous pouvez toujours utiliser Drush pour créer un administrateur, comme décrit à l'étape 4 ci-dessous. Créer un administrateur
   1. Prénom et nom du développeur
   2. Nom d'utilisateur du portail des développeurs
   3. Mot de passe
   4. Adresse e-mail
5. Une fois l'installation terminée, définissez les autorisations sur le fichier settings.php :
   > chmod 640 /var/www/html/sites/default/settings.php
6. Accédez à la page d'accueil du portail à l'adresse http://localhost/ ou au nom DNS de votre portail.
7. Connectez-vous au portail à l'aide des identifiants administrateur.

6. Créer un administrateur (facultatif)

Utilisez Drush pour créer un utilisateur avec accès administrateur pour votre installation Developer Channel Services. Drupal crée automatiquement un administrateur nommé "admin" par défaut. N'utilisez donc pas "admin" comme nom d'utilisateur.

1. Accédez au répertoire drupal_root/sites/default à l'aide de la commande cd. L'emplacement standard du répertoire racine Drupal est /var/www/html :
   > cd <drupal_root>/sites/default
2. Assurez-vous de disposer des autorisations d'écriture sur les fichiers Drupal privés :
   > drush vget file_private_path
   
   Cette commande renvoie le chemin d'accès aux fichiers Drupal privés, par exemple :
   file_private_path: 'sites/default/private'
   
   Correspondant à /var/www/html/sites/default/private/. Utilisez la commande suivante pour vous assurer que ce répertoire est accessible en écriture par le propriétaire et le groupe :
   chmod -R g+w dirPathAndName
   chmod -R o+r dirPathAndName
3. Saisissez les commandes suivantes pour créer un utilisateur administrateur, en remplaçant les commandes entre "< >" par vos valeurs :
   > drush user-create <username> --mail="<email-address>" --password="<password>"
   > drush user-add-role Administrator <username>
4. Connectez-vous au portail des développeurs en tant qu'administrateur à l'aide du nom d'utilisateur et du mot de passe spécifiés ci-dessus.

5. Définir le mot de passe racine MySQL

Si vous avez installé MySQL dans le cadre de l'installation du portail, le script d'installation laisse le mot de passe racine MySQL défini sur sa valeur par défaut, qui est vide.

Utilisez la commande suivante pour définir le mot de passe racine :

> mysqladmin -u root password NEWPASSWORD

Si vous avez déjà défini le mot de passe racine et que vous souhaitez le modifier, utilisez la commande suivante :

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

Vous devez également mettre à jour le mot de passe dans le fichier /var/www/html/sites/default/settings.php.

6. Assurez-vous que le module Update manager 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 Update manager (Gestionnaire de mises à jour). Si ce n'est pas le cas, activez-la.

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

> drush pm-info update

Utilisez l'option de menu Reports > Available Updates > Settings (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 vérification des mises à jour.

7. Déployer sur un serveur de production (facultatif)

Si vous déployez le portail sur un serveur de production, vous devez effectuer des étapes de sécurité supplémentaires, y compris :

1. Exécutez le script suivant pour sécuriser votre installation MySQL :
   > /usr/bin/mysql_secure_installation
   
   Ce script définit le mot de passe racine et vous permet de limiter l'accès racine à l'hôte local, ainsi que de supprimer les bases de données de test et l'utilisateur anonyme créés par défaut. L'exécution de ce script est vivement recommandée pour les serveurs de production.
2. Si les règles de votre entreprise l'exigent, activez et configurez SELinux.

8. 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 Drupal interne 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 Drupal Solr sur le portail.

Pour activer les modules Drupal Solr, procédez comme suit :

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

9. Installer mod_ssl pour prendre en charge HTTPS (facultatif)

Le module mod_ssl est utilisé par le serveur HTTP Apache pour diffuser des pages Web via HTTPS. Si vous souhaitez utiliser HTTPS, exécutez la commande suivante pour installer mod_ssl :

> yum install mod_ssl

Pour en savoir plus sur la configuration du portail pour utiliser SSL, consultez http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Installer SmartDocs (facultatif)

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

Pour en savoir plus sur SmartDocs, consultez Utiliser SmartDocs pour documenter des API.

11. Et maintenant ?

Après avoir installé le portail des services pour les développeurs, vous devez le configurer et le personnaliser en fonction de vos besoins spécifiques. La documentation sur le site Web d'Apigee contient toutes les informations sur la configuration, l'application de styles et la gestion d'un portail. Accédez à la documentation sur 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 trouverez plus d'informations :