Personnaliser une solution de lancement du portail des développeurs Apigee sur Cloud Marketplace

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Cette page décrit les options permettant de personnaliser, de gérer et de sécuriser votre solution Apigee Developer Portal Kickstart. Une fois déployés, tous les composants des services Cloud utilisés par le portail peuvent généralement être personnalisés conformément à la documentation Google Cloud standard. Les sections ci-dessous fournissent des options de configuration et des consignes de production spécifiques à la solution de portail.

Se connecter à Apigee ou Apigee hybrid

Pour utiliser la solution Apigee Developer Portal Kickstart avec une organisation Apigee ou Apigee hybrid, vous devez déployer le portail sur le projet Google Cloud utilisé lors du provisionnement d'Apigee. Lors du déploiement, le compte de service est créé avec le rôle Apigee Developer Admin. Ce rôle est requis pour les appelants de compte de service vers les API Apigee.

Configurer HTTPS pour le portail

Dans la configuration de lancement du déploiement du portail, vous pouvez choisir de configurer HTTPS pour votre portail. Les options de configuration de la case à cocher incluent les éléments suivants :

Décochée	Le script de déploiement n'active pas automatiquement le protocole TLS. TLS peut être configuré manuellement après le déploiement à l'aide de Cloud Load Balancing. Il s'agit de l'option par défaut.
Coché	Le package de déploiement active TLS, provisionne une adresse IP, configure un nom de domaine, et demande un certificat SSL à l'aide de nip.io. L'utilisation de nip.io n'est pas approuvée par Google, mais elle est proposée en tant qu'option pratique pour tester les déploiements. En sélectionnant cette option, vous acceptez les conditions d'utilisation de nip.io.

Utiliser Cloud SQL avec CMEK

L'instance Cloud SQL du portail est créée dans la région que vous choisissez lors de la configuration du lancement. Par défaut, Google chiffre les données au repos à l'aide de clés de chiffrement gérées par Google. Pour chiffrer les données stockées dans l'instance Cloud SQL à l'aide d'une clé de chiffrement gérée par le client (CMEK), suivez les étapes décrites dans la page Utiliser les clés de chiffrement gérées par le client.

Gérer Cloud SQL

Pour gérer l'instance Cloud SQL après le déploiement :

Accédez à la page Instances Cloud SQL.
Sélectionnez une instance à modifier en cliquant sur son nom.
Cliquez sur Modifier.
Pour en savoir plus sur les paramètres de configuration, consultez la page Modifier les instances.

Configurer et mettre à jour des groupes d'instances gérés

Un groupe d'instances géré (MIG) est un ensemble d'instances de machines virtuelles (VM) qui peuvent être gérées en tant qu'entité unique. Vous pouvez rendre vos charges de travail évolutives et hautement disponibles en tirant parti des services de MIG automatisés, comme l'autoscaling, l'autoréparation, le déploiement régional (multizone) et la mise à jour automatique.

Pour configurer vos MIG après le déploiement, procédez comme suit :

Accédez à la page Instances de VM.
Sélectionnez une instance à modifier en cliquant sur son nom.
Cliquez sur Modifier.
Consultez la page Créer et gérer des MIG régionaux pour en savoir plus sur les paramètres de configuration.

De nouvelles images de VM pour les solutions Apigee Developer Portal Kickstart seront publiées régulièrement. Les clients peuvent suivre la procédure décrite sur la page Mettre à jour des instances dans un groupe d'instances géré pour remplacer ou redémarrer les instances d'un groupe d'instances géré afin d'utiliser la dernière image.

Activer une adresse IP privée avec VPC Service Controls

Pour activer une adresse IP privée pour votre instance Cloud SQL, procédez comme suit :

Vérifiez que l'accès aux services privés est disponible sur votre réseau VPC. Consultez la page Configurer l'accès aux services privés pour obtenir la liste détaillée des étapes requises.
Cloud Deployment Manager n'est pas compatible avec VPC Service Controls. Pour activer Deployment Manager pour les déploiements de votre portail dans VPC Service Controls, ajoutez le compte de service Cloud Deployment Manager afin d'autoriser les appels vers les API protégées par VPC Service Controls.

Personnaliser le code du portail

Si des personnalisations sont apportées au code du portail ou aux scripts de démarrage après le déploiement, ces modifications doivent être exportées et sauvegardées dans Filestore pour éviter leur perte lors de toute mise à jour de l'image de base de la solution de lancement du portail des développeurs Apigee.

Par exemple, si de nouveaux modules Drupal sont installés sur une instance Compute Engine, créez une sauvegarde en procédant comme suit :

Exécutez /opt/apigee/scripts/export-code.sh pour exporter les modifications.
Le script copie les fichiers exportés dans l'instance Filestore installée dans /mnt/fileshare/portalname/.
Redémarrez les instances du groupe d'instances géré pour déclencher la prise en compte des modifications dans le groupe. Le script de démarrage détecte automatiquement si une sauvegarde de code existe, charge les modifications, corrige les autorisations liées aux fichiers et applique le fichier settings.php.
Mettez à jour le cœur et les modules Drupal à l'aide de composer update. Les mises à jour d'Apigee pour l'image de base ne fournissent que des mises à jour du système d'exploitation, des correctifs PHP et des mises à jour Nginx. Toutes les mises à jour du module et du cœur Drupal sont gérées par le client et doivent être appliquées manuellement.

Pour ajouter des personnalisations au script de démarrage, créez un script dans /mnt/fileshare/$PORTAL_NAME/custom-startup-script.sh.

Si vous installez des packages PHP, exécutez la commande service supervisor restart pour appliquer les modifications.

Créer des sauvegardes

La création de sauvegardes régulières est recommandée pour votre solution de lancement du portail des développeurs Apigee. Pour connaître la procédure détaillée, consultez les pages suivantes :

Configurer un portail pour une utilisation en production

Pour configurer votre portail en vue d'une utilisation en production, procédez comme suit :

Base de données Cloud SQL	Vérifiez ou modifiez le type de machine de la base de données. Désactivez l'adresse IP publique de la base de données et configurez l'adresse IP privée. Activez les sauvegardes automatiques de la base de données. Activez la haute disponibilité pour la base de données.
Filestore	Activez les sauvegardes pour Filestore.
Cloud Load Balancing	Activez Cloud CDN pour mettre en cache le contenu statique. Ajoutez un certificat SSL personnalisé si cela est préféré.
Groupes d'instances gérés	Ajustez le nombre minimal et maximal d'instances requis pour le trafic de production. REMARQUE : Les types de machines ne peuvent pas être modifiés après le déploiement initial du portail.
Authentification	Supprimez la restriction d'accès de l'authentification de base HTTP sur votre site. Exécutez les commandes suivantes pour rendre votre site de portail accessible au public : gcloud beta runtime-config configs variables set site_basic_auth/enabled 0 \ --is-text --config-name=`PORTAL_NAME` --project=`GCP_PROJECT_NAME` gcloud beta compute instance-groups managed rolling-action \ replace `INSTANCE_GROUP_ID` --region=`GCP_REGION` \ --replacement-method=substitute --project=`GCP_PROJECT_NAME`

Étape suivante

Obtenez plus d'informations sur les ressources d'assistance de la solution de lancement du portail des développeurs Apigee.