Le modèle Esri arcgis-notebook-server-ha.template.json Amazon Web Services (AWS) CloudFormation crée un site ArcGIS Notebook Server sur plusieurs instances Linux Amazon Elastic Compute Cloud (EC2) pour assurer la haute disponibilité.
Les instances EC2 sont déployées dans un groupe de mise à l’échelle automatique AWS, ce qui offre des avantages tels que la planification de la capacité en fonction de certains critères, une meilleure tolérance aux erreurs, une meilleure disponibilité et une meilleure gestion des coûts.
Les sites ArcGIS Notebook Server sur AWS ne sont pris en charge que sur les instances Linux.
Dans le cas de versions de système d’exploitation spécifiques, reportez-vous à la rubrique Systèmes d’exploitation pris en charge lors de l’utilisation de CloudFormation pour le déploiement d’ArcGIS sur AWS.
Ce modèle crée l’architecture suivante dans Amazon Web Services:
Licence :
Certaines icônes du diagramme sont utilisées avec l’autorisation de Amazon Web Services.
Conditions requises
Les prérequis peuvent être regroupés en fonction des éléments (par exemple, fichiers et comptes) que vous devez vous procurer et des tâches que vous devez effectuer avant d’exécuter le modèle CloudFormation.
Éléments requis
Vous avez besoin des éléments suivants avant d’exécuter ce modèle :
- Un compte Amazon Web Services.
Le compte doit avoir accès aux services AWS de base tels que CloudFormation, Amazon Elastic Compute Cloud (EC2), Amazon Virtual Private Cloud (VPC), Amazon Simple Storage Service (S3), Systems Manager, Amazon CloudWatch, Lambda, AWS Identity and Access Management (IAM), Amazon DynamoDB, Secrets Manager, AWS Certificate Manager et Amazon Relational Database Service (RDS).
- Un fichier de licence ArcGIS Notebook Server (.ecp ou .prvc).
- Un fichier de certificat SSL (au format .pfx) et le mot de passe correspondant.
Le certificat doit provenir d’une autorité de certification.
- Si vous créez un déploiement sur des instances Ubuntu EC2 dans AWS GovCloud, il vous faut un ID AMI. Si vous souhaitez utiliser l’instance Ubuntu AMI canonique de base, suivez les instructions figurant dans Modèles Esri Amazon Web Services CloudFormation pour identifier l’ID.
- Un Amazon Virtual Private Cloud (VPC) et des sous-réseaux.
Les composants du même déploiement ArcGIS Enterprise doivent tous s’exécuter sur le même VPC. Si votre portail existe, utilisez le VPC et les sous-réseaux que vous avez utilisés pour le portail. Si vous n’avez pas encore créé de portail et ne disposez pas d’un VPC existant, vous pouvez utiliser l’un des modèles CloudFormation suivants pour créer un VPC : VPC avec deux sous-réseaux publics ou VPC avec deux sous-réseaux publics et privés avec une passerelle NAT.
- Le modèle CloudFormation arcgis-notebook-server-ha.template.json.
Tâches requises
Effectuez les tâches suivantes avant d’exécuter ce modèle :
- Préparez un paquet Amazon Simple Storage Service (S3) de déploiement sur le compte AWS. Spécifiez le nom du paquet dans le modèle au lancement de la pile.
- Créez un paquet ou utilisez un paquet S3 existant. Vous devez être le propriétaire du paquet.
- Chargez le fichier d’autorisation ArcGIS Notebook Server dans le paquet.
- Chargez le fichier de certificat SSL dans le paquet.
- Configurez des mots de passe dans AWS Secrets Manager (facultatif mais recommandé).
Vous pouvez configurer les mots de passe des comptes (par exemple, le nom d’utilisateur de l’administrateur du site et le mot de passe de l’utilisateur arcgis Windows) dans AWS Secrets Manager. Vous obtenez alors un nom de ressource Amazon (ARN) secret. Utilisez l’ARN à la place d’un mot de passe dans les paramètres de modèle lorsque vous lancez une pile. Si vous n’utilisez pas AWS Secrets Manager pour stocker des mots de passe, vous devez saisir les mots de passe en texte brut dans le paramètre de modèle au lancement de la pile.
Remarque :
Lorsque vous créez un ARN secret dans AWS Secrets Manager pour un mot de passe à utiliser avec des modèles Esri CloudFormation, vous devez utiliser le type de secret Other types of secrets (Autres types de secret) et l’option Plaintext (Texte brut). Pour plus d’informations sur la création d’un nom de ressource Amazon pour les mots de passe, voir AWS CloudFormation et ArcGIS.
- Configurez un DNS (Domain Name System).
Vous devez disposer d’un nom de domaine complet pour le site ArcGIS Notebook Server. Ce nom de domaine doit exister avant que vous ne lanciez cette pile et doit pouvoir être résolu. Contactez votre service informatique si vous ne savez pas comment vous procurer un nom de domaine complet et configurer un DNS.
Si vous utilisez un équilibreur de charge élastique (ELB) dans votre déploiement ArcGIS Notebook Server (facultatif), vous devez créer l’ELB avant de créer le site ArcGIS Notebook Server. Seuls les équilibreurs de charge d’application sont pris en charge. Vous pouvez utiliser le modèle d’équilibreur de charge d’application pour créer l’équilibreur de charge.
- En cas de déploiement sur une instance Red Hat Enterprise Linux Server EC2, vous devez installer et configurer Docker. Consultez le guide d’installation ArcGIS Notebook Server Linux pour obtenir des instructions.
Conseil :
Par défaut, CloudFormation supprime les ressources partiellement créées si la création de la pile échoue. Cela est utile car les déploiements inutilisables sont alors supprimés de votre déploiement, mais il peut être difficile d’en corriger les problèmes. Pour conserver la pile dans son état d’échec, désactivez l’option de création de pile CloudFormation Rollback on failure (Restauration en cas d’échec) avant de lancer la pile. Pour plus d’informations, reportez-vous à la rubrique Définition d’options AWS CloudFormation de l’aide AWS.
Paramètres
Reportez-vous aux tableaux ci-dessous pour obtenir la description des paramètres utilisés dans ce modèle CloudFormation. Les tableaux sont regroupés par type de paramètre.
Amazon EC2 Configuration
| Nom de paramètre | Obligatoire ou non | Description du paramètre |
|---|---|---|
EC2 Instance AMI ID | Facultatif | Vous pouvez laisser la valeur de ce paramètre vide. Dans ce cas, le modèle CloudFormation utilisera l’ID Amazon Machine Image (AMI) le plus récent pour Ubuntu Server 22.04 LTS. Remarque :Vous ne pouvez pas laisser ce paramètre vide si vous effectuez le déploiement dans AWS GovCloud sur une plateforme Linux. Consultez les modèles Esri Amazon Web Services CloudFormation pour savoir comment vous procurer l’ID de l’image Ubuntu AMI de base auprès de Canonical. Si vous procédez au déploiement sur un système d’exploitation Linux pris en charge autre que Ubuntu, vous trouverez l’ID de l’image AMI avec AWS Management Console. Pour utiliser votre propre image AMI personnalisée, saisissez l’ID de l’image AMI de l’une des manières suivantes :
Si vous utilisez une image AMI personnalisée, vérifiez qu’elle respecte les conditions suivantes :
|
EC2 Instance Keypair Name | Requis | Sélectionnez un nom de paire de clés EC2 pour autoriser l’accès à distance aux instances EC2. |
Amazon VPC Configuration
| Nom de paramètre | Obligatoire ou non | Description du paramètre |
|---|---|---|
VPC ID | Requis | Sélectionnez un ID VPC. Remarque :Tous les composants de ArcGIS Enterprise qui font partie du même déploiement doivent être déployés dans le même VPC. Si vous devez créer un VPC, vous pouvez utiliser l’un des exemples de modèle VPC : VPC avec sous-réseaux publics ou VPC avec sous-réseaux publics et privés et passerelle NAT. |
Subnet ID 1 | Requis | Sélectionnez un ID de sous-réseau. L’ID de sous-réseau choisi doit se trouver dans le VPC sélectionné ci-dessus. Si vous avez utilisé un modèle CloudFormation Esri pour créer le VPC, vous pouvez obtenir l’ID du sous-réseau dans les paramètres en sortie du modèle. |
Subnet ID 2 | Requis | Sélectionnez un second ID de sous-réseau. Cet ID doit être différent du premier ID de sous-réseau. L’ID de sous-réseau choisi doit se trouver dans le VPC spécifié pour le déploiement. Si vous avez utilisé un modèle CloudFormation Esri pour créer le VPC, vous pouvez obtenir l’ID du sous-réseau dans les paramètres en sortie du modèle. |
Domain Name System (DNS) Configuration
| Nom de paramètre | Obligatoire ou non | Description du paramètre |
|---|---|---|
ArcGIS Notebook Server Site Domain Name | Requis | Indiquez le nom de domaine complet du site ArcGIS Notebook Server. Le nom de domaine doit exister et pouvoir être résolu. Contactez votre administrateur informatique en cas de doute sur le nom de domaine à utiliser. |
Elastic Load Balancer DNS Name | Facultatif | Pour utiliser un ELB avec le site, spécifiez une valeur pour un nom d’application ou de DNS ELB. Il doit s’agir d’un ELB existant. Si vous ne voulez pas utiliser un équilibreur de charge élastique, ou si vous préférez le configurer vous-même plus tard, laissez la valeur de ce paramètre vide. Pour obtenir le nom DNS de l’équilibreur de charge élastique, accédez à la section Load Balancers (Équilibreurs de charge) du service Amazon EC2 dans AWS Management Console ou, si vous avez utilisé un modèle CloudFormation Esri pour créer l’équilibreur de charge élastique, vous pouvez trouver ce nom dans les paramètres en sortie du modèle. Les noms DNS d’équilibreur de charge élastique valides se terminent par .elb.amazonaws.com. |
ArcGIS Notebook Server Configuration
| Nom de paramètre | Obligatoire ou non | Description du paramètre |
|---|---|---|
EC2 Instance Type | Requis | Spécifiez un type d’instance EC2. La valeur par défaut est m5.2xlarge. Il s’agit du type d’instance allant être utilisé pour les machines ArcGIS Notebook Server. Les instances EC2 seront configurées dans un groupe de mise à l’échelle automatique AWS. Ces instances se joindront au site ArcGIS Notebook Server en accédant au magasin de configuration ArcGIS Notebook Server. |
EC2 Instance Root Drive Disk Space | Requis | Il s’agit de la taille de l’espace disque du lecteur racine pour les instances ArcGIS Notebook Server EC2. Indiquez la taille du lecteur racine en Go. La valeur par défaut est 100 Go. La valeur minimale est 100 Go. La valeur maximale est 1 024 Go. |
Number of EC2 Instances | Requis | Indiquez le nombre d’instances EC2 qui feront partie du site. La valeur par défaut est 2. La valeur maximale est 10. La valeur minimale est 1. Les instances EC2 seront configurées dans un groupe de mise à l’échelle automatique AWS. Reportez-vous à la section Considérations ci-dessous pour obtenir des informations sur le redimensionnement d’un groupe de mise à l’échelle automatique. |
Deployment Bucket Name | Requis | Indiquez le nom du paquet Amazon S3 qui contient les fichiers de licence de logiciels et les certificats SSL. Ce paquet doit exister et contenir le fichier de licence et le certificat SSL pour votre déploiement. Vous devez être le propriétaire du paquet, et celui-ci doit appartenir au même compte AWS que votre déploiement. |
License File Name | Requis | Indiquez le nom de clé d’objet du fichier d’autorisation ArcGIS Notebook Server. Vous devez charger le fichier de licence (fichier .ecp ou .prvc) dans le paquet de déploiement avant de lancer cette pile. Pour obtenir le nom de clé d’objet du fichier, accédez à celui-ci dans le paquet de déploiement dans la console Amazon S3. Exemples : notebook.prvc ou resources/licenses/server/notebook.prvc. Les noms de fichier de licence sont sensibles à la casse. Veillez à entrer le nom correct. |
License Level | Requis | Sélectionnez le niveau de licence ArcGIS Notebook Server. Les options sont les suivantes :
|
Site Administrator User Name | Requis | Indiquez un nom d’utilisateur pour l’administrateur de site principal du site ArcGIS Notebook Server. Ce nom doit comporter un minimum de 6 caractères, alphanumériques ou traits de soulignement, et doit commencer par une lettre. |
Site Administrator User Password | Requis | Indiquez un mot de passe pour l’administrateur principal du site ArcGIS Notebook Server. Vous pouvez entrer un mot de passe en texte simple ou l’ARN de votre ID secret AWS Secrets Manager. Pour plus d’informations sur la création d’un nom de ressource Amazon pour les mots de passe, voir AWS CloudFormation et ArcGIS. Le mot de passe doit comporter un minimum de 8 caractères alphanumériques ; le point (.) est également autorisé. Le mot de passe ne peut pas contenir d’autres caractères spéciaux, ni des espaces. |
Configuration Store Type | Requis | Sélectionnez le type de magasin de configuration de ArcGIS Notebook Server. La valeur par défaut est FileSystem.
Remarque :Même si vous sélectionnez CloudStore, un serveur de fichiers distinct est créé pour héberger les répertoires partagés ArcGIS Notebook Server. |
ArcGIS File Server Instance Type | Requis | Sélectionnez un type d’instance EC2 pour le serveur de fichiers ArcGIS. Le type d’instance par défaut est m5.2xlarge. |
ArcGIS File Server EC2 Instance Root Drive Disk Space | Requis | Espace disque du lecteur racine pour l’instance EC2 du serveur de fichiers ArcGIS. Indiquez la taille du lecteur racine en Go. La valeur par défaut est 200 Go. La valeur minimale est 100 Go. La valeur maximale est 1 024 Go. |
Web Adaptor Name | Requis | Saisissez un nom d’adaptateur Web pour le site ArcGIS Notebook Server. L’accès au site ArcGIS Notebook Server s’effectue via une URL au format https://<fully qualified domain name>/<web adaptor name>. Ce nom doit commencer par une lettre et ne doit contenir que des caractères alphanumériques. |
SSL Certificate File Name | Requis | Fournissez un certificat SSL d’une autorité de certification (fichier .pfx). Vous devez charger le certificat dans le paquet de déploiement avant de lancer cette pile. Pour obtenir le nom de clé d’objet du fichier, accédez à celui-ci dans le paquet de déploiement dans la console AWS S3, par exemple, domainname.pfx ou resources/sslcerts/domainname.pfx. |
SSL Certificate Password | Requis | Indiquez le mot de passe pour le certificat SSL. Vous pouvez entrer un mot de passe en texte simple ou l’ARN de votre ID secret AWS Secrets Manager. Pour plus d’informations sur la création d’un nom de ressource Amazon pour les mots de passe, voir AWS CloudFormation et ArcGIS. |
Sorties
Une fois votre pile créée, les paramètres en sortie ci-dessous s’affichent dans l’onglet Outputs (Sorties) de la pile CloudFormation dans AWS Management Console.
| Nom en sortie | Description de la sortie |
|---|---|
DeploymentLogsURL | URL où sont stockés les journaux de déploiement de Amazon CloudWatch. Consultez ces journaux à des fins de dépannage en cas d’échec du déploiement. |
ServerAdminURL | URL du répertoire administrateur ArcGIS Notebook Server. |
ServerServicesURL | L’URL de services ArcGIS Notebook Server. Vous pouvez utiliser cette URL comme paramètre en entrée dans le modèle de serveur fédéré. |
StopStackFunctionName | URL de la fonction Stop Stack Lambda. Vous pouvez utiliser cette fonction lambda pour arrêter toutes les instances EC2 de la pile. |
StartStackFunctionName | URL de la fonction Start Stack Lambda. Vous pouvez utiliser cette fonction lambda pour démarrer toutes les instances EC2 de la pile que vous avez arrêtées précédemment. |
Éléments à prendre en compte
Les aspects suivants sont des points importants à prendre en compte après la création d’une pile CloudFormation contenant des déploiements ArcGIS :
- Dans les déploiements ArcGIS Notebook Server haute disponibilité, les instances EC2 sont configurées dans un groupe de mise à l’échelle automatique AWS. Une fois le site ArcGIS Notebook Server créé, vous pouvez ajouter plus de machines (instances EC2) au site en ajustant la taille du groupe de mise à l’échelle automatique. Utilisez AWS Management Console pour augmenter la capacité du groupe de mise à l’échelle automatique afin d’ajouter des machines. Pour supprimer des machines, réduisez la capacité. Reportez-vous à la documentation de AWS pour savoir comment modifier les limites de capacité d’un groupe de mise à l’échelle automatique afin d’ajouter ou de supprimer des machines sur un site ArcGIS Notebook Server.
Conseil :
Pour trouver le groupe de mise à l’échelle automatique AWS créé pour une pile CloudFormation, examinez l’onglet Resources (Ressources) de la pile CloudFormation associée. L’ID logique de la ressource est AutoScalingGroup.
Bien qu’il soit techniquement possible de redéfinir la taille du groupe de mise à l’échelle automatique AWS sur zéro, conservez au moins une instance s’exécutant dans ce groupe, sans quoi le site ArcGIS Notebook Server risque de ne pas fonctionner correctement.
Une fois que vous avez changé la capacité du groupe, jusqu’à une heure peut être nécessaire pour ajouter des machines ou jusqu’à 15 minutes pour en supprimer. Une fois la modification appliquée, utilisez l’API d’administration de ArcGIS Server pour vérifier que le nombre de machines sur le site ArcGIS Server a augmenté ou diminué de manière appropriée.
- Le magasin de configuration du site ArcGIS Notebook Server est stocké dans un compartiment S3 et dans Amazon DynamoDB. Les unités de capacité de provision DynamoDB sont définies sur les valeurs suivantes :
- Unités de capacité de lecture : 250 tables
- Unités de capacité d’écriture : 25 tables
Les tests Esri indiquent que ces paramètres fonctionnent bien pour publier environ 500 services. Vous pouvez modifier ces paramètres dans AWS Management Console pour diminuer les unités et réduire le coût ou augmenter les unités pour prendre plus de services en charge. Gardez à l’esprit que certaines fonctionnalités, telles que la publication, échoueront si vous ne disposez pas d’une capacité suffisante.
- Ne supprimez aucune ressource AWS créée par ce modèle CloudFormation. Si vous souhaitez savoir quelles ressources AWS ont été créées par ce modèle, reportez-vous à l’onglet Resources (Ressources) de cette pile dans la AWS Management Console. Chaque ressource créée par un modèle Esri CloudFormation possède également des balises de métadonnées. Toutefois, certaines des ressources n’affichent pas de balises dans la AWS Management Console.
- Si vous utilisez AWS Secrets Manager pour les mots de passe, comme le mot de passe de l’administrateur de site ou le mot de passe de l’utilisateur arcgis Windows et que vous modifiez ces mots de passe ultérieurement (après la création du déploiement), veillez à mettre à jour les valeurs ARN AWS Secrets Manager appropriées avec les mots de passe à jour.
- Si vous utilisez un équilibreur de charge d’application dans votre déploiement, vous pouvez ajuster le délai d’inactivité de cet équilibreur après la création du déploiement. Il se peut que vous deviez, par exemple, augmenter le délai d’inactivité pour faire en sorte que les opérations qui durent longtemps se terminent sur toutes les machines du déploiement. Ajustez le délai d’inactivité de l’équilibreur de charge d’application dans AWS Management Console.
- Vous pouvez utiliser les fonctions AWS Lambda figurant dans vos sorties de pile (répertoriées dans la section Sorties de cette page) pour arrêter les instances EC2 de cette pile qui ne sont pas utilisées et les redémarrer lorsque cela est nécessaire. Ces fonctions sont utiles pour gérer les coûts.
Lorsque vous exécutez la fonction Lambda pour arrêter les instances EC2 dans le déploiement, ces dernières renvoient un message indiquant qu’elles sont arrêtées. Toutefois, si les instances participent à un groupe de mise à l’échelle automatique, la fonction doit également les détacher du groupe. Ce processus peut prendre jusqu’à 10 minutes. Attendez donc au moins 10 minutes avant d’exécuter la fonction de démarrage Lambda pour relancer le déploiement.
Remarque :
Vous devez utiliser les fonctions Lambda pour arrêter et démarrer des instances EC2 appartenant à un groupe de mise à l’échelle automatique. Les groupes de mise à l’échelle automatique ajoutent des machines en fonction de la capacité définie pour eux ; si vous utilisez AWS Management Console pour arrêter des instances EC2 dans un groupe de mise à l’échelle automatique, de nouvelles instances sont ajoutées.
Dépannage
Si des erreurs se produisent lors de la création de cette pile CloudFormation, reportez-vous à la rubrique Résoudre les problèmes de déploiement ArcGIS dans AWS.
Vous avez un commentaire à formuler concernant cette rubrique ?