La plantilla Esri arcgis-notebook-server-singlemachine.template.json Amazon Web Services (AWS) CloudFormation crea un sitio de ArcGIS Notebook Server en una sola instancia de Linux Amazon Elastic Compute Cloud (EC2).
Los sitios de ArcGIS Notebook Server solo son compatibles con instancias de Linux.
Para conocer las versiones de sistemas operativos específicas, consulte Sistemas operativos compatibles al utilizar CloudFormation para la implementación de ArcGIS en AWS.
Esta plantilla crea la siguiente arquitectura en Amazon Web Services:
Licencia:
*Algunos iconos de los diagramas de este tema se usan con permiso de Amazon Web Services.
Requisitos previos
Los requisitos previos se pueden agrupar por elementos (como archivos y cuentas) que debe obtener y las tareas que debe realizar antes de ejecutar la plantilla de CloudFormation.
Elementos requeridos
Antes de ejecutar esta plantilla, necesitará lo siguiente:
- Una cuenta de Amazon Web Services.
La cuenta debe tener acceso a servicios básicos de AWS, tales como 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 y Amazon Relational Database Service (RDS).
- Un archivo de certificado SSL (en formato .pfx) y la contraseña correspondiente.
El certificado debe provenir de una autoridad de certificación.
- Un Amazon Virtual Private Cloud (VPC) y subredes.
Todos los componentes de la misma implementación de ArcGIS Enterprise deben ejecutarse en el mismo VPC. Si su portal existe, utilice la misma subred y VPC que utilizó para el portal. Si todavía no ha creado un portal y no tiene ningún VPC existente, puede utilizar una de las siguientes plantillas de CloudFormation para crear una VPC: VPC con dos subredes públicas o VPC con dos subredes públicas y privadas con una NAT Gateway.
- Un archivo de licencia de ArcGIS Notebook Server (.ecp o .prvc).
- Si crea una implementación en instancias de Ubuntu EC2 en AWS GovCloud, necesita un Id. de AMI. Si desea utilizar la base canónica Ubuntu AMI, siga las instrucciones que se indican en las plantillas de Esri Amazon Web Services CloudFormation para identificar el Id.
- La plantilla de arcgis-notebook-server-singlemachine.template.json CloudFormation.
Tareas requeridas
Complete las siguientes tareas antes de ejecutar esta plantilla:
- Prepare un bucket de implementación de Amazon Simple Storage Service (S3) en su cuenta de AWS. Especifique el nombre del bucket en la plantilla cuando inicie la pila.
- Cree un bucket o utilice un bucket existente de S3. Usted debe ser propietario del bucket.
- Cargue el archivo de autorización de ArcGIS Notebook Server en el bucket.
- Cargue el archivo de certificado SSL en el bucket de implementación.
- Configurar un sistema de nombres de dominio (DNS).
Debe tener un nombre de dominio totalmente calificado para el sitio de ArcGIS Notebook Server. Este nombre de dominio debe existir antes de iniciar esta pila y debe poder resolverse. Póngase en contacto con su departamento de TI si tiene dudas de cómo obtener un nombre de dominio totalmente calificado y configurar un DNS.
Cree una IP elástica (EIP).
Utilice AWS Management Console para crear la dirección IP elástica.
- Si implementó en una instancia EC2 de Red Hat Enterprise Linux Server, debe instalar y configurar Docker. Consulte la Guía de instalación de ArcGIS Notebook Server en Linux para obtener instrucciones.
- Configure contraseñas en AWS Secrets Manager (opcional pero recomendable).
Puede configurar las contraseñas de las cuentas como el nombre de usuario del administrador del sitio y la contraseña de usuario de Windows arcgis en AWS Secrets Manager. Con ello, obtendrá un Amazon Resource Name (ARN) secreto. Utilice ARN en lugar de una contraseña en los parámetros de la plantilla al iniciar una pila. Si no utiliza AWS Secrets Manager para almacenar contraseñas, debe escribir contraseñas en texto sin formato en el parámetro de plantilla al iniciar la pila.
Nota:
Al crear un ARN secreto en AWS Secrets Manager para una contraseña que se utilizará con las plantillas de Esri CloudFormation, debe utilizar el tipo de secreto Otros tipos de secretos y utilizar la opción Texto sin formato. Para obtener más información acerca de cómo crear un Amazon Resource Name para contraseñas, consulte AWS CloudFormation y ArcGIS.
Sugerencia:
De forma predeterminada, CloudFormation elimina los recursos creados parcialmente si se produce un error en la creación de la pila. Resulta útil porque elimina las implementaciones inutilizables de su cuenta, pero puede dificultar la solución de problemas. Para conservar la pila en su estado fallido, deshabilite la opción de creación de pila de CloudFormation Reversión en caso de error antes de iniciar la pila. Consulte Configurar las opciones de AWS CloudFormation en la ayuda de AWS para obtener más información.
Parámetros
Consulte las siguientes tablas para obtener descripciones de los parámetros utilizados en esta plantilla de CloudFormation. Las tablas están agrupadas por tipo de parámetro.
Amazon EC2 Configuration
| Nombre del parámetro | Necesario o no | Descripción del parámetro |
|---|---|---|
EC2 Instance AMI ID | Opcional | Puede dejar este valor de parámetro vacío. Si lo hace, la plantilla CloudFormation utilizará el Id. de Amazon Machine Image (AMI) más reciente para Ubuntu Server 20.0.4 LTS. Nota:No puede dejar este parámetro vacío si implementa en AWS GovCloud en una plataforma Linux. Consulte las plantillas de Esri Amazon Web Services CloudFormation para obtener instrucciones sobre cómo buscar el Id. para la base AMI de Ubuntu de Canonical. Si realiza la implementación en un sistema operativo Linux compatible distinto de Ubuntu, puede encontrar el Id. de AMI utilizando AWS Management Console. Si desea utilizar su propia AMI personalizada, puede escribir el Id. de AMI mediante una de las siguientes opciones:
Si utiliza una AMI personalizada, asegúrese de que cumple los siguientes requisitos:
|
EC2 Instance Keypair Name | Requerido | Elija el nombre del par de claves EC2 para permitir el acceso remoto a instancias de EC2. |
Elastic IP Address Allocation ID | Requerido | Proporcione el Id. de asignación de una dirección IP elástica en este formato, eipalloc-XXXXXXXX. Necesita una dirección IP elástica para asignar el nombre de dominio del sitio a la dirección IP elástica y acceder a la instancia de EC2 a través de RDP/SSH desde fuera del entorno AWS. |
Amazon VPC Configuration
| Nombre del parámetro | Necesario o no | Descripción del parámetro |
|---|---|---|
VPC ID | Requerido | Elija un Id. de VPC. Nota:Todos los componentes de ArcGIS Enterprise que forman parte de la misma implementación se deben implementar en la misma VPC. Si necesita crear un VPC, puede utilizar una de las plantillas de muestra de VPC: VPC con subredes públicas o VPC con subredes públicas y privadas y una puerta de enlace de NAT. |
Subnet ID 1 | Requerido | Elija un Id. de subred. El Id. de subred que seleccione debe estar dentro de VPC que seleccionó anteriormente. Si utilizó una plantilla de Esri CloudFormation para crear el VPC, puede obtener el Id. de subred de los parámetros de salida de esa plantilla. |
Domain Name System (DNS) Configuration
| Nombre del parámetro | Necesario o no | Descripción del parámetro |
|---|---|---|
ArcGIS Notebook Server Site Domain Name | Requerido | Proporcione el nombre de dominio totalmente calificado para el sitio de ArcGIS Notebook Server. El nombre de dominio debe existir y debe poder resolverse. Póngase en contacto con su administrador de TI si tiene dudas sobre el nombre de dominio que debe utilizar. |
ArcGIS Notebook Server Configuration
| Nombre del parámetro | Necesario o no | Descripción del parámetro |
|---|---|---|
EC2 Instance Type | Requerido | Especifique un tipo de instancia EC2. El valor predeterminado es m5.2xlarge. Este es el tipo de instancia que se utilizará para el equipo de ArcGIS Notebook Server. Esta instancia de EC2 se configurará con la función de recuperación automática de AWS. |
EC2 Instance Root Drive Disk Space | Requerido | Este es el tamaño del espacio en disco de la unidad raíz para la instancia de ArcGIS Notebook Server EC2. Proporcione el tamaño de la unidad raíz en GB. El valor predeterminado es 100 GB. El mínimo es de 100 GB. El máximo es de 1024 GB. |
Deployment Bucket Name | Requerido | Proporcione el nombre del bucket de Amazon S3 que contiene sus archivos de licencia de software y certificados SSL. Este bucket ya debe existir y contener el archivo de licencia y el certificado SSL para su implementación. Usted debe ser el propietario del bucket y este debe residir en la misma cuenta de AWS que su implementación. |
License File Name | Requerido | Proporcione el nombre de clave de objeto del archivo de autorización ArcGIS Notebook Server. Debe cargar el archivo de licencia de (archivo .ecp o .prvc) en el bucket de implementación antes de iniciar esta pila. Puede obtener el nombre de clave del objeto de archivo yendo al archivo en el bucket de implementación en la consola Amazon S3. Algunos ejemplos son notebook.prvc o resources/licenses/server/notebook.prvc. Los nombres de archivo de licencia distinguen entre mayúsculas y minúsculas. Asegúrese de haber escrito correctamente el nombre. |
License Level | Requerido | Elija el nivel de licencia ArcGIS Notebook Server. Las opciones son las siguientes:
|
Site Administrator User Name | Requerido | Proporcione un nombre de usuario para el administrador principal del sitio de ArcGIS Notebook Server. El nombre debe tener 6 o más caracteres alfanuméricos o con guion bajo (_) y debe comenzar por una letra. |
Site Administrator User Password | Requerido | Proporcione una contraseña para el administrador principal del sitio de ArcGIS Notebook Server. Puede escribir una contraseña de texto sin formato o el ARN de su Id. secreto desde AWS Secrets Manager. Para obtener más información acerca de cómo crear un Amazon Resource Name para contraseñas, consulte AWS CloudFormation y ArcGIS. La contraseña debe tener 8 o más caracteres alfanuméricos y también puede contener puntos (.). La contraseña no puede contener otros caracteres especiales ni espacios. |
Configuration Store Type | Requerido | Elija el tipo de almacén de configuración de ArcGIS Notebook Server. El valor predeterminado es FileSystem.
Nota:Incluso si elige CloudStore, se crea un servidor de archivos separado para alojar los directorios compartidos de ArcGIS Notebook Server. |
Web Adaptor Name | Requerido | Escriba un nombre de Web Adaptor para el sitio de ArcGIS Notebook Server. El acceso al sitio de ArcGIS Notebook Server será a través de una dirección URL con el formato https://<fully qualified domain name>/<web adaptor name>. El nombre debe comenzar con una letra y solo debe contener caracteres alfanuméricos. |
SSL Certificate File Name | Requerido | Proporcione un certificado SSL de una autoridad de certificación (archivo .pfx). Debe cargar el certificado en el bucket de implementación antes de iniciar esta pila. Puede obtener el nombre de clave del objeto de archivo yendo al archivo en el bucket de implementación en la consola AWS S3, por ejemplo, domainname.pfx o resources/sslcerts/domainname.pfx. |
SSL Certificate Password | Requerido | Proporcione una contraseña para el certificado SSL. Puede escribir una contraseña de texto sin formato o el ARN de su Id. secreto desde AWS Secrets Manager. Para obtener información acerca de cómo crear un Amazon Resource Name para contraseñas, consulte AWS CloudFormation y ArcGIS. |
Salidas
Cuando su pila se crea correctamente, puede ver los siguientes parámetros de salida en la pestaña Salidas de la pila CloudFormation en AWS Management Console.
| Nombre de salida | Descripción de salida |
|---|---|
DeploymentLogsURL | Esta es la dirección URL de los registros de Amazon CloudWatch en los que se almacenan todos los registros de implementación. Puede consultar estos registros para solucionar problemas si falla su implementación. |
ServerAdminURL | La dirección URL del directorio del administrador de ArcGIS Notebook Server. |
ServerServicesURL | La URL de los servicios de ArcGIS Notebook Server. Puede usar esta URL como un parámetro de entrada en la plantilla del servidor federado. |
StopStackFunctionName | Esta es la URL de la función Detener pila de lambda. Puede utilizar esta función lambda para detener todas las instancias de EC2 de la pila. |
StartStackFunctionName | Esta es la URL de la función Iniciar pila de lambda. Puede utilizar esta función lambda para iniciar todas las instancias de EC2 en la pila que detuvo anteriormente. |
Consideraciones
Estos son puntos importantes a tener en cuenta después de crear una pila de CloudFormation que contenga implementaciones de ArcGIS:
- El almacén de configuración del sitio de ArcGIS Notebook Server está almacenado en un bucket de S3 y en Amazon DynamoDB. Las unidades de capacidad de provisión de DynamoDB se establecen en:
- Unidades de capacidad de lectura = 250 tablas
- Unidades de capacidad de escritura = 25 tablas
Las pruebas de Esri revelan que esta configuración funciona bien para publicar aproximadamente 500 servicios. Puede editar esta configuración en AWS Management Console para reducir las unidades y reducir el coste o aumentar las unidades para dar cabida a más servicios. Tenga en cuenta que algunas funcionalidades, como la publicación, fallarán si no tiene suficiente capacidad.
- No elimine ningún recurso de AWS creado por esta plantilla de CloudFormation. Si desea saber qué recursos de AWS se han creado mediante esta plantilla, consulte la pestaña Recursos de esta pila en AWS Management Console. Cada recurso creado por una plantilla de Esri CloudFormation también tiene etiquetas de metadatos. Sin embargo, algunos de los recursos no muestran etiquetas en AWS Management Console.
- Puede utilizar las funciones de AWS Lambda que aparecen en las salidas de su pila (enumeradas en la sección Salidas de esta página) para detener las instancias de EC2 de esta pila cuando no se utilicen y volver a iniciarlas cuando sea necesario. Estas funciones son útiles para ayudarle a administrar costes.
Cuando se ejecuta la función Lambda para detener las instancias de EC2 en la implementación, la función devuelve un mensaje que indica que las instancias están paradas. Sin embargo, si las instancias participan en un grupo Escalado automático, la función también deberá desconectar las instancias del grupo. Este proceso puede requerir incluso 10 minutos en completarse. Por lo tanto, espere al menos 10 minutos antes de ejecutar la función de inicio de Lambda para reiniciar la implementación.
- Si utiliza AWS Secrets Manager para contraseñas, como la contraseña de usuario de administrador del sitio o la contraseña de usuario de arcgis Windows y, a continuación, (después de crear la implementación) cambia esas contraseñas, asegúrese de actualizar el ARN AWS Secrets Manager adecuado con las contraseñas actualizadas.
Solucionar problemas
Si observa algún fallo al crear esta pila de CloudFormation, consulte Solucionar problemas de implementaciones de ArcGIS en AWS.