Edge pour Private Cloud version 4.17.01
Avant d'installer l'application, vérifiez les points suivants:
- Vous devez installer Postgres avant d'installer le portail. Vous pouvez installer Postgres lors de l'installation d'Edge ou installer Postgres de manière autonome pour l'utiliser par le portail.
- Si vous installez Postgres de manière autonome, il 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. Pour connaître la liste des versions compatibles, consultez la section Logiciels et versions compatibles.
- Yum est installé.
Présentation de l'installation
Après avoir installé l'utilitaire apigee-setup sur un nœud, utilisez-le pour installer le portail sur le nœud. L'utilitaire apigee-setup se présente sous 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 les informations sur l'installation. Si des informations requises sont manquantes dans le fichier de configuration, l'utilitaire apigee-setup vous invite à les saisir sur la ligne de commande.
La seule condition requise est que le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".
Par exemple, exécutez la commande suivante pour installer le portail:
> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig
Pour en savoir plus, consultez Installer l'utilitaire apigee-setup pour Edge.
Créer un fichier de configuration
Vous trouverez ci-dessous un exemple de fichier de configuration silencieux pour une installation de portail. Modifiez ce fichier selon vos besoins. Utilisez l'option -f dans setup.sh pour 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 et au 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. 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 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. Supprimer les versions antérieures à PHP 7.0
Le script d'installation recherche les versions antérieures à la version 7.0 de PHP sur le système avant de commencer l'installation. Si des versions antérieures à la version 7.0 de PHP 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 RedHat Enterprise Linux (RHEL), supprimez les paquets PHP à l'aide de la commande suivante:
yum remove <package-name>
3. Installer Postgres
Vous devez installer Postgres avant de pouvoir installer le portail. Vous pouvez installer Postgres lors de l'installation d'Edge ou installer Postgres de manière autonome pour l'utiliser par le portail.
- Si vous vous connectez à Postgres installé dans Edge et que Postgres est configuré en mode maître/en attente, spécifiez l'adresse IP du serveur Postgres maître.
- Si vous installez Postgres de manière autonome, il 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:
- Installez l'utilitaire apigee-setup Edge sur le nœud à l'aide de la procédure Internet ou hors connexion. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup Edge.
- Créez un fichier de configuration pour Postgres, comme indiqué ci-dessous:
# Le pod et la 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 - À 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" spécifie l'installation de Postgres.
Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee".
4. Installer le portail
Pour installer le portail:
- Installez l'utilitaire Edge apigee-setup sur le nœud à l'aide de la procédure Internet ou hors Internet. Pour en savoir plus, consultez Installer l'utilitaire apigee-setup Edge.
- Assurez-vous d'avoir installé Postgres, soit en tant que version autonome, soit lors de l'installation d'Edge.
- À 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" spécifie l'installation du portail.
Le fichier de configuration doit être accessible ou lisible par l'utilisateur "apigee". - Accédez à la page d'accueil du portail à l'adresse http://localhost:8079 ou au nom DNS de votre portail.
- Connectez-vous au portail à l'aide des identifiants d'administrateur que vous avez définis dans le fichier de configuration.
5. Vérifier que le module Gestionnaire de mises à jour 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 et faites défiler la page jusqu'au module Gestionnaire de mises à jour. Si ce n'est pas le cas, activez-la.
Une fois activée, vous pouvez voir les mises à jour disponibles en utilisant l'élément de menu Rapports > Mises à jour disponibles. 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 des développeurs est installé à l'emplacement /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 le répertoire par défaut, accédez à votre répertoire d'installation.
Utilisez l'élément de menu 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 recherche de 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 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 Solr Drupal sur le portail.
Pour activer les modules Drupal Solr:
- Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
- Sélectionnez Modules dans le menu Drupal.
- Activez le module Apache Solr Framework et le module Apache Solr Search.
- Enregistrez les modifications.
- Configurez Solr comme décrit sur https://drupal.org/node/1999280.
7. Installer SmartDocs (facultatif)
SmartDocs vous permet de mettre à disposition la documentation de vos API sur le portail de services dédiés aux développeurs de manière 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 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.
Vous devez également activer SmartDocs sur le portail. Pour en savoir plus sur SmartDocs, consultez Utiliser SmartDocs pour documenter des API.
8. Et maintenant ?
Une fois le portail des services pour les développeurs installé, 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 à 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 pour en savoir plus:
|
Tâche |
Description |
|
Le thème définit l'apparence du portail, y compris les couleurs, le style et d'autres aspects visuels. |
|
|
La page d'accueil comprend le menu principal, le message de bienvenue, l'en-tête, le pied de page et le titre. |
|
|
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 manière dont un administrateur du portail est averti lorsqu'un compte est créé. |
|
|
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'un développeur perd son mot de passe. |
|
|
Ajoutez une page des conditions d'utilisation que les développeurs doivent accepter avant d'être autorisés à accéder au portail. |
|
|
Le portail implémente un modèle d'autorisation basé sur les rôles. Avant d'autoriser les développeurs à s'inscrire, définissez les autorisations et les rôles utilisés par le portail. |
|
|
Le portail est compatible avec les blogs et les forums thématiques. Définissez les autorisations requises pour afficher, ajouter, modifier et supprimer des posts de blog et de forum. |
|
|
Assurez-vous de sauvegarder vos bases de données |
Assurez-vous de sauvegarder la base de données Drupal. Notez que chaque installation étant différente, c'est à vous de déterminer la meilleure façon de sauvegarder la base de données. Remarque: Le module de sauvegarde et de migration n'est pas compatible avec les bases de données Postgres. Consultez également la page Effectuer une sauvegarde. |
|
Configurer 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, qui devrait fonctionner correctement sans aucune autre configuration dans une 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 de développement, qui se trouve par défaut dans le répertoire /opt/apigee/apigee-drupal/sites/default. |
| Développement personnalisé | Vous pouvez également étendre les fonctionnalités de votre portail avec du code personnalisé en dehors de votre thème. Pour ce faire, créez votre propre module Drupal comme décrit dans les rubriques sur le développement de modules de Drupal et placez-le dans le répertoire /sites/all/modules. |