Le modèle Esri arcgis-notebook-server-singlemachine.template.json Amazon Web Services (AWS) CloudFormation crée un site ArcGIS Notebook Server sur une seule instance Ubuntu Amazon Elastic Compute Cloud (EC2).
Les sites ArcGIS Notebook Server ne sont pris en charge que sur les instances Ubuntu.
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 certificat SSL (au format .pfx) et le mot de passe correspondant.
Le certificat doit provenir d’une autorité de certification.
- 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.
- Un fichier de licence ArcGIS Notebook Server (.ecp ou .prvc).
- 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.
- Le modèle CloudFormation.
Ouvrez et enregistrez une copie locale du modèle arcgis-notebook-server-singlemachine.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 votre 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 de déploiement.
- 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 associez une adresse IP élastique à ce déploiement (facultatif), vous devez créer l’adresse IP élastique avant d’exécuter ce modèle.
Vous pouvez utiliser AWS Management Console pour créer l’adresse IP élastique.
- 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 administrateur et le mot de passe d’utilisateur Windows arcgis) 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 des mots de passe, reportez-vous à AWS CloudFormation et ArcGIS.
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 | 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 utilise le dernier ID Amazon Machine Image (AMI) pour Ubuntu. Remarque :Vous ne pouvez pas laisser ce paramètre vide si vous effectuez le déploiement dans AWS sur un Ubuntu Server. Voir les modèles Esri Amazon Web Services CloudFormation pour savoir comment vous procurer l’ID de l’image AMI Ubuntu de base auprès de Canonical. La première fois que vous utilisez l’une des images AMI par défaut pour une version spécifique, vous devez accepter les conditions d’utilisation de AWS Marketplace. Si vous souhaitez utiliser votre propre image AMI personnalisée, vous pouvez entrer l’ID 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. |
Elastic IP Address Allocation ID | Facultatif | Indiquez l’ID d’allocation d’une adresse IP élastique au format suivant : eipalloc-XXXXXXXX. Vous aurez peut-être besoin d’une adresse IP élastique pour apparier le nom de domaine du site à l’adresse IP élastique et accéder à l’instance EC2 via RDP/SSH depuis l’extérieur de l’environnement AWS. Laissez ce paramètre vide si vous ne souhaitez pas attribuer d’adresse IP élastique à l’instance EC2. |
Amazon VPC Configuration
| Nom de paramètre | Obligatoire | 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. |
Domain Name System (DNS) Configuration
| Nom de paramètre | Obligatoire | 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. |
ArcGIS Notebook Server Configuration
| Nom de paramètre | Obligatoire | Description du paramètre |
|---|---|---|
EC2 Instance Type | Requis | Sélectionnez un type d’instance EC2. La valeur par défaut est m5.2xlarge. Il s’agit du type d’instance allant être utilisé pour la machine ArcGIS Notebook Server. Cette instance EC2 sera configurée avec la fonctionnalité de récupération automatique AWS. |
EC2 Instance Root Drive Disk Space | Requis | Il s’agit de la taille de l’espace disque du lecteur racine pour l’instance 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. |
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/109/server/notebook.prvc. Les noms de fichier de licence sont sensibles à la casse. Veillez à entrer le nom correct. |
License Level | Requis | Choisissez 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 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 trait de soulignement (_), l’arobase (@) et le point (.) sont autorisés. |
Web Adaptor Name | Facultatif | Si vous souhaitez utiliser ArcGIS Web Adaptor avec le site ArcGIS Notebook Server, entrez un nom d’adaptateur Web. L’accès au site ArcGIS Notebook Server se fait via une URL au format https://<fully qualified domain name>/<web adaptor name>. Ce nom doit commencer par une lettre et comporter uniquement des caractères alphanumériques. Laissez la valeur de ce paramètre vide si vous ne souhaitez pas utiliser ArcGIS Web Adaptor ; les URL du site auront alors le format https://<fully qualified domain name><PortNumber>/arcgis. |
SSL Certificate File Name | Facultatif | Si vous ajoutez un adaptateur Web au site, vous pouvez fournir un certificat SSL d’une autorité de certification (fichier .pfx). Si vous fournissez un fichier de certificat, vous devez le charger 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 . Exemples de nom de certificat : domainname.pfx pour un fichier de certificat stocké au niveau racine du paquet de déploiement ou resources/sslcerts/domainname.pfx pour un fichier de certificat stocké dans un dossier du paquet de déploiement. Si vous utilisez un adaptateur Web et que vous laissez la valeur de ce paramètre vide, un certificat autosigné généré automatiquement est utilisé pour l’adaptateur Web. |
SSL Certificate Password | Conditions | Indiquez un 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 :
- 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.
- 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.
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 ?