Installation du portail de services pour les développeurs

Portail des services pour les développeurs version 4.16.09

Avant de procéder à l'installation, 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 noyau Drupal ou dans des modules non personnalisés, vos modifications seront écrasées. Cela inclut, entre autres, toutes les modifications que vous avez pu apporter dans le fichier .htaccess. Vous devez partir du principe que tout élément situé en dehors du répertoire /sites appartient à Drupal. Le fichier robots.txt constitue une exception à cette règle. Si ce fichier se trouve à la racine du Web, il sera conservé. Avant de poursuivre l'installation, effectuez une sauvegarde de l'intégralité de votre répertoire racine Web 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. Télécharger le package Developer Channel Services

Accédez à http://community.apigee.com/content/apigee-customer-support et sélectionnez "Se connecter à votre portail d'assistance" pour demander le fichier .tar des services de canaux pour les développeurs de l'une des deux manières suivantes:

  • Demandez l'accès au répertoire de téléchargement Edge for Private Cloud.
  • Demandez une URL du fichier .tar des services de canaux pour les développeurs.

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 correspondent à l'adresse e-mail de l'administrateur.

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 à la suivante :
{
"createAt" : 1348689232699, "createBy" : "last"










3. 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 Red Hat Enterprise Linux (RHEL), supprimez les packages PHP à l'aide de la commande suivante:

yum remove <package-name>

4. Installez Developer Channel Services à l'aide du script d'installation automatisé

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

Sur un serveur avec une connexion Internet:

Pour installer les services de canaux pour développeurs sur un serveur avec une connexion Internet:

  1. Connectez-vous au serveur en tant que super-utilisateur ou racine.
  2. Créez un répertoire pour les fichiers d'installation, par exemple portal.
  3. Accédez au nouveau répertoire du portail (CD) et téléchargez le fichier DeveloperServices_x.y.z.tar de Developer Channel Services, 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 <paste link here>
  4. Extrayez le contenu du fichier .tar Developer Channel Services à l'aide de la commande suivante:
    > tar -xvf <tar file>
  5. CD vers DeveloperServices-4.x.y.z.
  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 que super-utilisateur ou racine.
  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 de Developer Channel Services, où x.y.z correspond au numéro de version du portail.
  4. Extrayez le contenu du fichier .tar de Developer Channel Services à l'aide de la commande suivante:
    > tar -xvf <tar file>
  5. CD vers DeveloperServices-4.x.y.z.
  6. Créez le fichier .tar.gz du portail à l'aide de la commande suivante:
    > ./non-networked-install.sh

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

Pour installer Developer Channel Services sur un serveur sans connexion Internet:

      1. Connectez-vous au serveur en tant que super-utilisateur ou racine.
      2. Créez un répertoire pour les fichiers d'installation, par exemple portal.
      3. du CD au répertoire du portail.
      4. Dans le répertoire portal, copiez le fichier .tar.gz que vous avez créé pour l'installation sans réseau (dans la procédure ci-dessus).
      5. Extrayez le contenu du fichier .tar.gz à l'aide de la commande suivante:
        > tar -xvf <tar file>
      6. 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

      Une grande partie de la configuration du portail est effectuée sans que vous ayez à intervenir, comme l'installation du module Drupal et la création du contenu par défaut. Vous êtes invité à configurer la base de données, le point de terminaison Edge et à créer un nouvel 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 une adresse IP ou un DNS spécifique configuré, 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 déjà enregistré auprès de votre serveur DNS, afin que vous n'ayez pas à 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 Conditions requises pour le 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é par le 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 un utilisateur administrateur nommé "admin" par défaut. Veillez donc à ne pas utiliser "admin" comme nom d'utilisateur.
        Si vous ignorez cette étape, vous pouvez toujours utiliser Drush pour créer un administrateur, comme décrit ci-dessous à la section 4. Créez un compte administrateur.
        1. Nom et pré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 de l'administrateur.

      6. Créer un administrateur (facultatif)

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

      1. d'un CD vers votre répertoire drupal_root/sites/default. L'emplacement standard du répertoire racine Drupal est /var/www/html:
        > cd <drupal_root>/sites/default
      2. Assurez-vous de disposer d'autorisations en é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'

        Correspond à /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 administrateur, en remplaçant les commandes dans "< >" par vos valeurs:
        > drush user-create<username> --mail email-address>" --password="{password>"
        > drush user-add-role Administrateur <nom d'utilisateur>
      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 lors 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.

      Exécutez 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, exécutez 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 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

      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.

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

      Si vous déployez le portail sur un serveur de production, vous devez prendre des mesures 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 root à localhost et 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 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. Ils ne nécessitent donc pas les 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.

      9. Installer mod_ssl pour assurer la compatibilité avec 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, installez mod_ssl à l'aide de la commande suivante:

      > yum install mod_ssl

      Pour plus d'informations sur la configuration du portail pour l'utilisation de SSL, consultez la page http://apigee.com/docs/developer-services/content/using-ssl-portal.

      10. 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.

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

      11. 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.

      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 recevez des URL incorrectes sur votre site pour une autre raison, vous pouvez définir $base_url dans le fichier settings.php du portail des développeurs, qui se trouve par défaut dans le répertoire /var/www/html/sites/default.