Travailler avec Acquia

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Apigee utilise Acquia, un service de gestion de sites Web, pour héberger les versions cloud du portail des services pour les développeurs. Acquia est conçu pour fonctionner avec Drupal afin que vous puissiez développer, tester et publier votre portail dans un environnement sécurisé.

Les sections suivantes décrivent comment utiliser Acquia pour développer et gérer votre portail.

Accéder à l'interface Acquia Cloud

Une fois votre compte Acquia Cloud configuré, vous pouvez accéder à votre portail via l'interface Acquia Cloud à l'adresse https://cloud.acquia.com/.

Lorsque vous vous connectez pour la première fois, la page Applications s'affiche, comme illustré dans la figure suivante.

La page "Applications" affiche toutes les applications auxquelles vous avez accès et qui sont hébergées sur Acquia Cloud. Une application est l'entité logicielle que vous gérez dans Acquia Cloud, par exemple votre site portail basé sur Drupal.

Les sections suivantes décrivent comment utiliser l'interface Acquia Cloud pour gérer le contenu de votre portail.

Pour en savoir plus sur l'interface Acquia Cloud, consultez les pages Se connecter à l'interface Acquia Cloud et Gérer les applications avec Acquia Cloud dans la documentation d'Acquia Cloud.

Gérer vos environnements

Accédez à l'interface Acquia Cloud et, sur la page "Applications", cliquez sur Gérer associé au site de votre portail pour accéder au tableau de bord.

Pour gérer votre workflow, trois environnements sont fournis pour développer, tester et publier votre portail, comme indiqué dans le tableau suivant. Votre portail est déployé dans chaque environnement, mais peut se trouver dans un état différent avec une branche de code ou un tag unique, une base de données, etc. Consultez la section Déployer du code sur les environnements de votre portail.

Environment Description URL par défaut
Dév Développez de nouvelles fonctionnalités et personnalisez votre portail. http://{application-name}xxxxxx.devcloud.acquia-sites.com/

application-name est le nom de votre application et xxxxxx est une chaîne unique de caractères utilisée pour différencier Dev et Stage.

Étape Testez le dernier code avant de le transférer vers l'environnement de production. http://{application-name}yyyyyy.devcloud.acquia-sites.com/

application-name est le nom de votre application et yyyyyy est une chaîne unique de caractères utilisée pour différencier Dev et Stage.

Prod Publiez votre portail en production (en ligne). http://{application-name}.devcloud.acquia-sites.com/

application-name est le nom de votre application.

Remarque:Consultez également la section Configurer un domaine personnalisé.

Pour plus d'informations, consultez la section Travailler avec des environnements dans la documentation d'Acquia Cloud.

Développer votre portail

Les sections suivantes décrivent comment développer votre portail.

De plus, reportez-vous aux sections suivantes pour en savoir plus sur la personnalisation de votre portail.

Pour...

Vous pouvez

En savoir plus

Modifier l'apparence du site

Basic : Utilisez l'entrée de menu Appearance (Apparence) sur le site du portail pour apporter des modifications, telles que le logo et les couleurs du site.

Consultez la section Personnaliser l'apparence.

Avancé : pour modifier l'apparence complète du site, développez le thème Apigee Responsive.

Consultez la section Personnaliser le thème.

Modifier le comportement des fonctionnalités du site

De base : Utilisez les paramètres d'administration du portail pour modifier/configurer le comportement du site.

Accédez à la documentation Apigee à partir de cette page.

Avancé : créez un module personnalisé pour modifier n'importe quel comportement du site.

Consultez la section Créer des modules personnalisés dans la documentation Drupal.

Présentation du dépôt Git

Le dépôt Git de votre code Drupal contient tout le code de votre portail. Il est organisé selon la structure suivante.

Remarque: Ne modifiez que le contenu du répertoire /sites/all. Si vous modifiez du contenu en dehors du répertoire /sites/all, vous rencontrerez des problèmes lors de la mise à niveau vers de nouvelles versions et pourrez rencontrer des conflits de fusion lors de la vérification des modifications apportées à Git.

Dossier du dépôt Git

Description

/profiles/apigee

Modules et thèmes gérés par Apigee, y compris:

  • /profiles/apigee/modules/contrib: modules de contrib Drupal gérés par Apigee
  • /profiles/apigee/themes/contrib: thèmes de contrib Drupal gérés par Apigee
  • /profiles/apigee/modules/custom: modules personnalisés créés par Apigee
  • /profiles/apigee/themes/custom: thèmes personnalisés créés par Apigee

Remarque: Ne modifiez pas le contenu du répertoire /profiles/apigee. Vous risqueriez de rencontrer des problèmes lors de la mise à niveau vers de nouvelles versions et de rencontrer des conflits de fusion lors de la vérification des modifications apportées à Git. Pour connaître les bonnes pratiques concernant Drupal, consultez Ne jamais hacker Core.

/sites/all

Vos modules et thèmes Drupal personnalisés. Pour en savoir plus sur la gestion du contenu de ce dossier, consultez Ajouter des modules et des thèmes personnalisés et Remplacer les modules et les thèmes de profil Drupal.

Remarque: Ne modifiez que le contenu du répertoire /sites/all.

Accéder à votre code

Pour accéder à votre dépôt de code dans Git, vous devez effectuer les tâches décrites dans les sections suivantes:

Consultez également la section Comment accéder au code source du portail des développeurs Drupal 7 ?

Activer l'accès SSH à votre serveur

Avant de pouvoir utiliser Git pour gérer votre code Drupal, vous devez activer SSH pour accéder à votre serveur. Pour plus d'informations, consultez la section Activer l'accès SSH dans la documentation d'Acquia Cloud.

Pour activer l'accès SSH:

  1. Connectez-vous à l'interface Acquia Accounts à l'adresse https://accounts.acquia.com.
  2. Cliquez sur Identifiants.
  3. Si vous y êtes invité, saisissez à nouveau votre mot de passe pour confirmer votre identité.
  4. Sous "Clés SSH", cliquez sur Ajouter une clé SSH.
  5. Saisissez les informations suivantes :
    Champ Description
    Pseudo Pseudo de la clé SSH. Le pseudo peut contenir des caractères alphanumériques et des traits de soulignement.
    Clé publique Clé publique.

    Pour plus d'informations sur la génération d'une clé publique SSH, consultez la section Générer une clé publique SSH dans la documentation Acquia Cloud.

  6. Cliquez sur Ajouter une clé.

Accéder à votre dépôt de code dans Git

Le dépôt Git contient tout le code de votre site de portail. Pour configurer votre portail, vous pouvez ajouter du code ou personnaliser un code existant. Pour plus d'informations, consultez la section Utiliser votre dépôt de code dans la documentation d'Acquia Cloud.

Pour accéder à votre dépôt de code dans le dépôt Git:

  1. Connectez-vous à l'interface d'Acquia Cloud à l'adresse https://cloud.acquia.com/.
  2. Sur la page "Applications", cliquez sur Gérer pour afficher les détails du portail.
  3. Cliquez sur Application Info (Informations sur l'application) dans la barre de navigation.

  4. Copiez la commande de clonage dans la boîte de dialogue "Informations sur l'application".
  5. Clonez le dépôt Git dans votre environnement local en exécutant l'une des commandes Git suivantes:

    Pour cloner le dépôt Git et créer une branche:

    > git clone --branch [branch] myportal@abcdef.devcloud.hosting.acquia.com:myportal.git [destination]

    Pour cloner le dépôt Git à partir de la branche master:

    > git clone myportal@abcdef.devcloud.hosting.acquia.com:myportal.git [destination]

  6. Répétez ces étapes lorsque vous êtes prêt à préproduire, valider et transférer vos modifications dans le dépôt Git à l'aide des commandes appropriées affichées dans la fenêtre "Application".

    Lorsque vous validez une branche dans votre dépôt, Acquia Cloud met à jour l'environnement exécutant cette branche de code. Vous pouvez déployer du code dans vos environnements de portail, comme décrit dans la section suivante.

Déployer du code dans les environnements de votre portail

Pour déployer, basculer ou rétablir du code dans un environnement de portail, déplacer votre code entre différents environnements ou en savoir plus sur la structure du dépôt et le workflow recommandé, consultez Travailler avec des sites sur Aquia Cloud dans la documentation d'Aquia Cloud. Lorsque vous déployez du nouveau code dans un environnement, vous devez exécuter update.php pour effectuer les mises à jour requises de la base de données.

Ajouter des modules et des thèmes personnalisés

Vous pouvez étendre les fonctionnalités du portail en ajoutant vos propres modules et thèmes personnalisés aux dossiers répertoriés dans le tableau suivant.

Remarque: Ne modifiez que le contenu du répertoire /sites/all. Si vous modifiez du contenu qui se trouve en dehors du répertoire /sites/all, vous pouvez rencontrer des conflits de fusion lorsque vous vérifiez des modifications apportées à Git.

Module/Thème Dossier du dépôt Git En savoir plus (documentation Drupal)
Modules personnalisés sites/all/modules/custom Créer des modules personnalisés
Thèmes personnalisés sites/all/themes Personnaliser le thème
Thématisation Drupal 7

Après avoir ajouté le module ou le thème personnalisé dans l'environnement Dev, vous pouvez le déployer sur Test à des fins de test, puis dans l'environnement Live pour la production, comme décrit dans la section Déployer du code dans vos environnements de portail.

Remplacement des modules et thèmes de profil Drupal

Les modules et les thèmes des répertoires suivants remplacent les modules et thèmes de profil Drupal gérés et distribués par Apigee dans /profiles/apigee. Consultez la section Présentation de votre dépôt Git.

Par exemple, vous pouvez remplacer un module de la distribution Apigee Drupal dans les scénarios suivants:

  • Vous souhaitez utiliser une version différente d'un module particulier.
  • Vous souhaitez implémenter une mise à jour de sécurité avant la prochaine version planifiée d'Apigee.
Module/Thème Dossier du dépôt Git En savoir plus (documentation Drupal)
Modules proposés par Drupal sites/all/modules/contrib

Remarque: Les modules stockés n'importe où sous /sites/all/modules remplacent les modules de distribution Apigee Drupal.

Modules associés

Remarque: Les modules fournis par Drupal dans ce répertoire remplacent les modules équivalents gérés et distribués par Apigee dans /profiles/apigee/modules. Supprimez tous les modules en double que vous avez ajoutés à ce dossier si vous souhaitez utiliser les modules de profil Drupal gérés par Apigee.

Thèmes proposés par Drupal sites/all/themes Thèmes ajoutés

Remarque: Les thèmes fournis par Drupal dans ce répertoire remplacent les modules équivalents gérés et distribués par Apigee dans /profiles/apigee/themes. Supprimez tous les modules en double que vous avez ajoutés à ce dossier si vous souhaitez utiliser les thèmes de profil gérés par Apigee.

Activer SSL

Pour activer l'accès sécurisé à votre site à l'aide de HTTPS, vous devez activer la technologie SSL.

Pour activer la technologie SSL :

  1. Obtenez un certificat SSL auprès d'une autorité de certification ou d'un fournisseur de certificats SSL. Consultez la section Activer SSL.
  2. Importez le certificat SSL sur la page SSL de l'interface Acquia Cloud. Consultez la page Gérer des certificats SSL.

Sécuriser l'environnement de production

Lorsque vous créez une application, vous pouvez gérer librement l'environnement de production et propager les modifications à partir des environnements de développement et de préproduction. Une fois votre contenu publié, vous pouvez verrouiller l'environnement de production pour éviter toute mise à jour non autorisée ou accidentelle du contenu. Pour plus d'informations, consultez la section Utiliser le mode Production pour protéger votre application active dans la documentation d'Acquia Cloud.

Pour sécuriser votre environnement de production:

  1. Connectez-vous à l'interface d'Acquia Cloud à l'adresse https://cloud.acquia.com/.
  2. Sur la page "Applications", cliquez sur Gérer pour afficher les détails de votre site de portail.
  3. Cliquez sur Prod pour afficher les détails de l'environnement de production.
  4. Cliquez sur Mode production dans la barre de navigation.
  5. Cliquez sur Activer pour activer le mode production.

Application des mises à jour de module et de thème au portail

Régulièrement, Apigee met automatiquement à jour les modules et les thèmes de votre portail vers la dernière version. Les mises à jour ne sont effectuées que dans l'environnement Dev et comportent des tags indiquant qu'elles doivent être migrées vers d'autres environnements de portail.

Si votre site ne fait pas partie de l'organisation de facturation Apigee Acquia (un nouveau site migré depuis un autre fournisseur d'hébergement vers votre propre organisation, par exemple), vous devez autoriser Apigee à accéder à votre dépôt Git pour recevoir automatiquement les mises à jour du portail de développement. Contactez l' assistance Apigee pour en savoir plus.

Si vous avez ajouté des modules ou des thèmes personnalisés, vous devrez les mettre à jour manuellement.

Le tableau suivant récapitule les étapes requises pour appliquer les mises à jour de module et de thème au portail.

Modules/Thèmes Description
Modules Apigee Edge

Apigee applique automatiquement les mises à jour à l'environnement Dev uniquement.

Après avoir testé les mises à jour, migrez-les des environnements Dev vers Stage, puis Prod, comme décrit dans la section Déployer du code dans les environnements de votre portail.

Thème Apigee Responsive

Apigee applique automatiquement les mises à jour à l'environnement Dev uniquement.

Après avoir testé les mises à jour, migrez-les des environnements Dev vers Stage, puis Prod, comme décrit dans la section Déployer du code dans les environnements de votre portail.

Core Drupal et modules associés

Apigee applique automatiquement les mises à jour à l'environnement Dev uniquement.

Après avoir testé les mises à jour, migrez-les des environnements Dev vers Stage, puis Prod, comme décrit dans la section Déployer du code dans les environnements de votre portail.

Modules et thèmes personnalisés

Si vous avez ajouté des modules et des thèmes personnalisés à votre portail, comme décrit dans la section Ajouter des modules et des thèmes personnalisés, vous devez installer les mises à jour manuellement.

Téléchargez la dernière version manuellement dans votre répertoire local ou utilisez Drush. Ensuite, préparez, validez et déployez les mises à jour dans le dépôt Git. Après avoir testé les mises à jour, migrez-les des environnements Dev vers Stage, puis Prod, comme décrit dans la section Déployer du code dans les environnements de votre portail.

Migrer vos fonctionnalités personnalisées

Si vous ajoutez du code ou des configurations personnalisés au portail, vous devez les gérer et les migrer des environnements Dev vers Stage vers Prod.

Pour le code dans le dépôt Git, vous pouvez suivre le processus décrit dans la section Déployer du code sur vos environnements de portail pour migrer le code de Dev vers Stage vers Prod.

Si vous avez créé des configurations personnalisées, utilisez l'une des méthodes suivantes pour les migrer:

Méthode Description
Exporter votre configuration dans le code De nombreuses configurations courantes sont "exportables" vers le code à l'aide du module Fonctionnalités. (vues, panneaux, cache d'images, etc.).
Implémenter la fonction hook_update_N() Drupal gère les modifications de la base de données et de la configuration à l'aide de la fonction hook_update_N().

Si vous disposez d'un module personnalisé, vous pouvez:

  • Ajoutez des fonctions hook_update_N() au fichier .install de votre module pour traiter vos modifications.
  • Déployez ces modifications avec votre code.
  • Exécutez update.php pour migrer les modifications apportées aux environnements de préproduction et de production.

Configurer un domaine personnalisé

Comme indiqué dans la section Gérer vos environnements, les noms de domaine par défaut des environnements de portail se terminent tous par acquia-sites.com. Nous vous recommandons de fournir un nom de domaine personnalisé, qui personnalise et reflète mieux l'objectif de votre site. Voici par exemple une alternative couramment utilisée :

https://developers.mycompany.com

Pour configurer un domaine personnalisé :

  1. Ajoutez votre domaine à l'environnement de votre site de portail. Consultez la section Gérer les domaines dans la documentation d'Acquia Cloud.
  2. Configurez votre domaine personnalisé auprès de votre fournisseur DNS en faisant pointer l'entrée d'enregistrement DNS de votre nom de domaine vers l'adresse IP publique (et non vers un domaine acquia-sites.com). Consultez la section Faire pointer les enregistrements DNS vers vos adresses IP publiques dans la documentation Acquia Cloud.

    Remarque: Ne définissez pas l'entrée CNAME du nom de domaine sur un domaine acquia-sites.com. Cela peut entraîner des problèmes de latence ou des interruptions de service sur votre site de portail.

Surveiller le portail avec Acquia Insight

Acquia Insight est un ensemble d'outils qui vous permet d'optimiser votre site portail en surveillant ses performances, sa sécurité et l'optimisation du référencement. Pour en savoir plus, consultez Acquia Insight.

Sauvegarder votre portail

Les tableaux suivants récapitulent les options disponibles pour la sauvegarde des composants de votre portail.

Composant Détails de la sauvegarde Plus d'infos dans Acquia Cloud Docs
Code
  • Le code est géré par un système de contrôle des versions et tagué chaque fois que vous effectuez un commit.
  • Synchronisez ou rétablissez une balise spécifique à tout moment.
Base de données
  • Des sauvegardes quotidiennes sont effectuées et conservées pendant trois jours.
  • Planifiez des sauvegardes automatiques et à la demande.
  • Des instantanés de sinistre internes de toutes les données sont réalisés toutes les heures.
Fichiers Effectuez des sauvegardes manuelles ou planifiez un job Cron.
Candidature complète Effectuez une sauvegarde manuelle avec Drush.
Système de fichiers Drupal Effectuez des sauvegardes manuelles en utilisant l'une des options suivantes :
  • Copiez vos fichiers à l'aide d'un client FTP ou d'outils de ligne de commande (rsync et scp).
  • Créez une archive compressée à l'aide de Drush.

Remarque:Le module Sauvegarde et migration n'est pas pris en charge sur Acquia Cloud. Pour en savoir plus, consultez la section Module Sauvegarde et migration non pris en charge sur Acquia Cloud.

Afficher les notifications d'activité

Vous pouvez afficher les notifications d'activité pour suivre les actions importantes qui se produisent sur votre site portail, telles que l'installation ou la copie de code entre les environnements, les mises à jour et sauvegardes de bases de données, les modifications de serveur, etc. Pour en savoir plus, consultez la section Afficher les notifications d'activité dans la documentation d'Acquia Cloud.

Pour afficher la liste des notifications:

  1. Connectez-vous à l'interface d'Acquia Cloud à l'adresse https://cloud.acquia.com/.
  2. Sur la page "Applications", cliquez sur Gérer pour afficher les détails de votre site de portail.
  3. Pour afficher les notifications les plus récentes, cliquez sur l'icône en forme de cloche en haut à droite de la barre de navigation.

  4. Cliquez sur la flèche à côté d'une notification pour afficher plus d'informations sur l'activité.

S'abonner aux mises à jour d'état

Vous pouvez vous abonner aux mises à jour de version et d'état d'Apigee à l'adresse status.apigee.com. Cliquez sur S'abonner aux mises à jour, saisissez vos coordonnées, telles que votre adresse e-mail, lorsque vous y êtes invité, puis cliquez sur S'abonner. Sur la page de gestion des notifications par e-mail, assurez-vous que l'option Developer Portal (Portail des développeurs) est sélectionnée, activez d'autres paramètres de notification si nécessaire, puis cliquez sur Update Preferences (Mettre à jour les préférences).

Vous pouvez vous abonner aux notifications d'état d'Acquia pour recevoir des notifications sur les interruptions de service, la maintenance d'urgence ou les mises à jour de sécurité apportées à la plate-forme. Pour vous abonner aux mises à jour d'Acquia Cloud:

  1. Accédez à la page État de l'acquisition.
  2. Cliquez sur S'abonner aux mises à jour.
  3. Sélectionnez la méthode que vous souhaitez utiliser pour recevoir des informations (e-mail, SMS, etc.).
  4. Sur la page "Notifications", sélectionnez les produits pour lesquels vous souhaitez recevoir des notifications d'état. Par exemple, Acquia Cloud Enterprise.
  5. Cliquez sur Mettre à jour les préférences.