Installation du portail de services pour les développeurs

Developer Services Portal v. 4.16.09

Avant 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. Pour consulter la liste des versions compatibles, cliquez ici.
  • Yum est installé.
  • Vous sauvegardez les installations existantes. Si vous avez modifié du code dans Drupal Core ou dans un module non personnalisé, vos modifications seront écrasées. Cela inclut, entre autres, toute modification que vous avez apportée à .htaccess. Vous devez partir du principe que tout le contenu en dehors du répertoire /sites appartient à Drupal. Le fichier robots.txt constitue une exception à cette règle. S'il existe à la racine du fichier 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 effectué les étapes d'installation décrites ci-dessous, vous pouvez restaurer vos personnalisations à partir de la sauvegarde.

Suivez la procédure ci-dessous pour installer le portail des développeurs sur les services de distribution.

1. Télécharger le lot de services pour les développeurs

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

  • Demandez l'accès au répertoire de téléchargement Edge pour le cloud privé.
  • Demandez une URL vers le fichier .tar des services de canaux de développeur.

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 de portail:
> curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

Où EMAIL et PASSWORD sont associés à l'adresse e-mail et ORG

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














3. Supprimer les versions de PHP antérieures à la version 7.0

Le script d'installation recherche les versions de PHP antérieures à la version 7.0 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 de distribution pour les développeurs à l'aide du script d'installation automatisé

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

Sur un serveur connecté à Internet:

Pour installer les Services de canaux de développement sur un serveur avec connexion Internet:

  1. Connectez-vous au serveur en mode racine ou super-utilisateur.
  2. Créez un répertoire pour les fichiers d'installation, par exemple portal.
  3. Dans le nouveau répertoire du portail, 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 est 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 de développement pour les développeurs avec la commande suivante:
    > tar -xvf <tar file 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épondre 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 avec une connexion Internet en mode root ou en tant que super-utilisateur.
  2. Créez un répertoire pour les fichiers d'installation, tel que portal_tar.
  3. CD vers le 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 de développeur à 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 sur le 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 les services de canaux de développement sur un serveur sans connexion Internet:

      1. Connectez-vous au serveur en mode racine ou super-utilisateur.
      2. Créez un répertoire pour les fichiers d'installation, par exemple portal.
      3. CD vers le répertoire portal.
      4. Copiez le fichier .tar.gz que vous avez créé pour l'installation sans réseau (voir la procédure ci-dessus) dans le répertoire portal.
      5. Extrayez le contenu du fichier .tar.gz avec la commande suivante:
        > tar -xvf <tar file>
      6. CD vers le 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 intervention de votre part, comme l'installation du module Drupal et la création de contenu par défaut. Vous êtes invité à configurer une base de données, à configurer le point de terminaison Edge et à créer un 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: Généralement, vous avez déjà configuré un nom d'hôte et l'avez enregistré auprès de votre serveur DNS pour ne pas avoir à utiliser http://localhost.
      2. Configurer la connexion à la base de données Si la base de données se trouve sur un ordinateur distant, développez la section Options avancées et saisissez les informations de connexion à cet ordinateur, 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" sur la page Conditions requises pour utiliser 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é du point de terminaison
        4. Mot de passe des utilisateurs authentifiés
      4. Configurez l'administrateur en saisissant les informations suivantes, puis sélectionnez "Enregistrer". Notez que Drupal crée un compte administrateur nommé "admin" par défaut. Par conséquent, n'utilisez pas "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 dans la section 4. Créez un compte administrateur.
        1. Prénom et nom du développeur
        2. Nom d'utilisateur du portail du développeur
        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 pour créer un compte administrateur pour votre installation de Channel Services pour les développeurs. Drupal crée automatiquement un administrateur nommé "admin" par défaut. Par conséquent, n'utilisez pas "admin" comme nom d'utilisateur.

      1. 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/private/private/. Exécutez la commande suivante pour vous assurer que ce propriétaire et le groupe peuvent écrire dans le répertoire:
        chmod -R g+w dirPathAndName
        chmod -R o+r dirPathAndName
      3. Saisissez les commandes suivantes pour créer un compte administrateur, en remplaçant les commandes suivantes entre les valeurs "< >" par vos valeurs:
        > drush user-create <username> --mail="<email-address>" --password="<mot de passe>"
        > drush user-add-role Administrateur <nomdutilisateur>
      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.

      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 du gestionnaire de mises à jour est activé

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

      Une fois la fonctionnalité activée, vous pouvez afficher les mises à jour disponibles via 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 de sorte qu'il vous envoie un e-mail lorsque des mises à jour sont disponibles, et pour 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 effectuer des étapes de sécurité supplémentaires, par exemple:

      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 au seul localhost, et de supprimer les bases de données de test et l'utilisateur anonyme créé par défaut. L'exécution de ce script est vivement recommandée pour les serveurs de production.
      2. Si vos règles d'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 de modules Drupal Solr.

      Si vous décidez d'utiliser Solr comme moteur de recherche, vous devez installer Solr en local 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 le module 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 assurer la compatibilité avec HTTPS (facultatif)

      Le module mod_ssl est utilisé par le serveur HTTP Apache pour diffuser les pages Web via HTTPS. Si vous souhaitez utiliser HTTPS, installez mod_ssl à l'aide de la commande suivante:

      > yum install mod_ssl

      Pour en savoir plus sur la configuration du portail afin qu'il utilise 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 de services pour les développeurs de manière à rendre la documentation des 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 pour le cloud privé, vous devez vous assurer que SmartDocs est installé sur Edge. Pour savoir comment installer Edge et SmartDocs, consultez Installer SmartDocs.

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

      11. Quelles sont les prochaines étapes ?

      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, le style 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 pouvez effectuer après l'installation, et inclut des liens vers la documentation Apigee, où vous trouverez plus d'informations:

      Tâche

      Description

      Personnaliser le thème

      Le thème définit l'apparence du portail, y compris ses couleurs, ses styles 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'inscription détermine la façon dont les nouveaux développeurs créent 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 de portail est averti lorsqu'un compte est créé.

      Configurer 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 lorsqu'il 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 pour pouvoir 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 de permettre aux développeurs de s'inscrire, définissez les autorisations et les rôles utilisés par le portail.

      Ajouter des articles de blog et de forum

      Le portail est compatible avec les blogs et les forums organisés en fils de discussion. Définissez les autorisations nécessaires pour afficher, ajouter, modifier et supprimer des articles de blog et de forum.

      Assurez-vous d'effectuer des sauvegardes de bases de données

      Assurez-vous de sauvegarder la base de données Drupal. Étant donné que chaque installation est différente, il vous incombe 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 sur 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. Celui-ci devrait fonctionner correctement sans 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 des développeurs, qui se trouve par défaut dans le répertoire /var/www/html/sites/default.