Crea una app de Node.js en el entorno flexible de App Engine

Crea una app de Node.js en el entorno flexible de App Engine

ID de región

REGION_ID es un código abreviado que Google asigna en función de la región que eliges cuando creas la app. El código no corresponde a un país ni a una provincia, aunque algunos ID de región puedan parecer similares a los códigos de país y provincia que se suelen usar. En el caso de las apps creadas después de febrero de 2020, REGION_ID.r se incluye en las URL de App Engine. En el caso de las apps existentes creadas antes de esta fecha, el ID de región es opcional en la URL.

Obtén más información acerca de los ID de región.

Aceptar

Nota: Si vas a implementar un nuevo servicio web de Node.js en Google Cloud, te recomendamos que comiences con Cloud Run.

En esta guía de inicio rápido, se muestra cómo crear e implementar una app que muestra un mensaje corto. Puedes usar la aplicación de muestra en esta guía de inicio rápido para cualquier versión compatible de Node.js, especificando la versión del entorno de ejecución y el sistema operativo en tu archivo app.yaml.

Antes de comenzar

Accede a tu Google Cloud cuenta de. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Instala Google Cloud CLI.

Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Instala Google Cloud CLI.

Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

Roles obligatorios

Si quieres obtener los permisos que necesitas para completar esta guía de inicio rápido, pídele a tu administrador que te otorgue los siguientes roles de IAM:

• Administrador de App Engine (roles/appengine.appAdmin) en el proyecto
• Editor de Cloud Build (roles/cloudbuild.builds.editor) en el proyecto
• Administrador de objetos de almacenamiento (roles/storage.objectAdmin) en el proyecto
• Visualizador de registros (roles/logging.viewer) en el proyecto
• Usuario de la cuenta de servicio (roles/iam.serviceAccountUser) en la cuenta de servicio
• Pídele a tu administrador que otorgue los siguientes roles para la cuenta de servicio predeterminada de App Engine:
  • Lector de Artifact Registry (roles/artifactregistry.reader) en el proyecto
  • Cuenta de servicio de Cloud Build (roles/cloudbuild.builds.builder) en el proyecto
  • Visualizador de objetos de almacenamiento (roles/storage.objectViewer) en el proyecto

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

Requisitos previos adicionales

1. Inicializa tu app de App Engine con el proyecto y selecciona su región:

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   Cuando se te solicite, selecciona la región en la que deseas ubicar tu aplicación de App Engine.

   Precaución: No podrás cambiar la región de una aplicación una vez configurada.

2. Instala lo siguiente en tu máquina local:

   • Descarga y, luego, instala Git.
   • Prepara tu entorno para el desarrollo en Node.js.

Ubicaciones de App Engine

App Engine es regional, lo que significa que la infraestructura que ejecuta las apps se encuentra en una región específica, y Google la administra para que esté disponible de forma redundante en todas las zonas dentro de esa región.

El cumplimiento de tus requisitos de latencia, disponibilidad o durabilidad debe ser un factor principal para seleccionar la región en la que se ejecutan las apps. Por lo general, puedes seleccionar la región más cercana a la de los usuarios de la app, pero debes considerar las ubicaciones en las que App Engine está disponible y las ubicaciones de los otros Google Cloud productos y servicios que usa la app. Usar servicios en varias ubicaciones puede afectar la latencia de la app y sus precios.

No puedes cambiar la región de una app una vez configurada.

Nota: Dos ubicaciones, que se llaman europe-west y us-central en los comandos de App Engine y en la Google Cloud consola, se denominan europe-west1 y us-central1, respectivamente, en otra documentación de Google.

Si ya creaste una aplicación de App Engine, puedes ver su región mediante una de las siguientes opciones:

• Ejecuta el comando gcloud app describe.

• Abre el Panel de App Engine en la Google Cloud consola. La región aparece cerca de la parte superior de la página.

Aceptar

Esta guía de inicio rápido muestra una aplicación de Node.js simple que se escribió con el marco de trabajo Express.js.

Importante: Si deseas obtener la mejor experiencia en Windows, ejecuta npm install -g npm para actualizar a la versión más reciente del administrador de paquetes de Node.js (npm). La versión más reciente de npm instala dependencias en una estructura de directorios plana, por lo que es poco probable que las instalaciones superen la extensión máxima para los nombres de ruta de Windows, que corresponde a 255 caracteres. Si prefieres continuar usando una versión más antigua de npm, puedes mover el proyecto a la raíz de tu disco, por ejemplo, C:\, a fin de reducir la longitud de las rutas de acceso.

Descarga la app de Hello World

Creamos una app de Hello World simple para App Engine a fin de que puedas familiarizarte con rapidez con la implementación de una app en la. Google Cloud

1. Clona el repositorio de la app Hello World de muestra al equipo local.

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
   

   De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.

2. Cambia al directorio que contiene el código de muestra.

      cd nodejs-docs-samples/appengine/hello-world/flexible/
   

Ejecuta Hello World en tu máquina local

1. Instala las dependencias de este proyecto.

   npm install
   

   Si usas Yarn, ejecuta lo siguiente:

   yarn install
   

2. Ejecuta la secuencia de comandos de inicio.

   npm start
   

   Si usas Yarn, ejecuta lo siguiente:

   yarn start
   

3. Visualiza la app en tu navegador web:

   • Si usas Cloud Shell, en la barra de herramientas, haz clic en Vista previa web  y selecciona Vista previa en el puerto 8080 en su lugar.

   • Si no usas Cloud Shell, ingresa la siguiente dirección:

   http://localhost:8080

El mensaje de Hello World de la aplicación de muestra se ve en la página. En la ventana de la terminal, presiona Ctrl + C para salir del servidor web.

Implemente y ejecute Hello World en App Engine

Para implementar la app en el entorno flexible de App Engine, haz lo siguiente:

1. Implementa la app de Hello World mediante la ejecución del siguiente comando desde el directorio hello-world/flexible/:

   gcloud app deploy

   Obtén más información sobre las marcas opcionales.

   Marcas comunes del comando de gcloud

   • Incluye la marca --version para especificar un ID que identifique esa versión de la app de forma única . De lo contrario, se generará uno para que lo uses. Ejemplo: --version [YOUR_VERSION_ID]
   • Incluye la marca --project para especificar un ID del proyecto alternativo al que inicializaste como predeterminado en la herramienta de gcloud. Google Cloud Ejemplo: --project [YOUR_PROJECT_ID]

   Ejemplo:

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   Para obtener más información sobre la implementación de la app desde la línea de comandos, consulta Prueba e implementa la app. Para obtener una lista de todas las marcas de comandos, consulta la referencia de gcloud app deploy.

   Aceptar
   Nota: Durante la implementación, se usa npm install de forma predeterminada para instalar dependencias, a menos que exista un archivo yarn.lock y no se incluya en la sección skip_files del archivo app.yaml, en cuyo caso se usará yarn install --production. Para provocar que la compilación vuelva a ser npm install, borra el archivo yarn.lock o agrega yarn.lock a la sección skip_files de tu archivo app.yaml.

2. Inicia tu navegador para ver la app en https://PROJECT_ID.REGION_ID.r.appspot.com

   gcloud app browse

   donde PROJECT_ID representa el ID de tu Google Cloud proyecto.

Esta vez, la página que muestra el mensaje Hello World se envía mediante un servidor web que se ejecuta en una instancia de App Engine.

¡Felicitaciones! Implementaste la primera aplicación de App Engine en el entorno flexible de App Engine.

Si encontraste algún error cuando implementaste la aplicación, consulta las sugerencias para solucionar problemas.

Consulta las secciones siguientes para obtener información sobre la limpieza y vínculos a los próximos pasos que podrías realizar.

Limpia

Para evitar que se apliquen cargos a la cuenta, puedes borrar el Google Cloud proyecto y detener la facturación de todos los recursos que usa.

Precaución: Borrar un proyecto tiene estas consecuencias:
• Se borra todo su contenido. Si usaste un proyecto existente para las tareas de este documento, cuando lo borres, también se borrará cualquier otro trabajo que hayas realizado en el proyecto.
• Se pierden los IDs personalizados de los proyectos. Cuando creaste este proyecto, es posible que hayas creado un ID personalizado del proyecto que desees utilizar en el futuro. Para conservar las URLs que usan el ID del proyecto, como una appspot.com URL, borra los recursos seleccionados dentro del proyecto, en lugar de todo el proyecto.
1. En la Google Cloud consola, ve a la página Administrar recursos.

   Ir a Administrar recursos

2. En la lista de proyectos, elige el proyecto que tú quieres borrar y haz clic en Borrar.
3. En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

¿Qué sigue?

Conoce toda la plataforma

Ahora que sabes cómo es el desarrollo y la implementación de aplicaciones de App Engine, puedes explorar el resto de Google Cloud. Ya instalaste Google Cloud CLI, que te brinda las herramientas para interactuar con productos como Cloud SQL, Cloud Storage, Firestore y muchos otros.

Aprende sobre el entorno flexible de App Engine

Aquí hay algunos temas para ayudarte a continuar tu aprendizaje sobre App Engine.

• Descripción general de App Engine
• Solicita enrutamiento
• Administra solicitudes
• Administra instancias

Revisión del código de Hello World

Hello World es la aplicación de App Engine más simple que pueda existir, dado que solo contiene un servicio, una versión y todo el código se ubica dentro del directorio raíz de la app. En esta sección, se describe cada archivo de la app en detalle.

app.js

El archivo app.js contiene el código de JavaScript para iniciar un servidor y responder a las solicitudes.

El siguiente código responde a las solicitudes de clientes web con el mensaje “Hello World”, mediante un servidor que se ejecuta en el puerto 8080.

const express = require('express');

const app = express();

app.get('/', (req, res) => {
  res.status(200).send('Hello, world!').end();
});

// Start the server
const PORT = parseInt(process.env.PORT) || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

app.yaml

El app.yaml archivo describe la siguiente configuración para tu app:

• Configura env: flex, lo que indica que tu app usa el entorno flexible de App Engine.

• Especifica el entorno de ejecución que usa la app.

  runtime: nodejs
  env: flex
  runtime_config:
    operating_system: ubuntu24
  # This sample incurs costs to run on the App Engine flexible environment.
  # The settings below are to reduce costs during testing and are not appropriate
  # for production use. For more information, see:
  # https://cloud.google.com/appengine/docs/flexible/nodejs/configuring-your-app-with-app-yaml
  manual_scaling:
    instances: 1
  resources:
    cpu: 1
    memory_gb: 0.5
    disk_size_gb: 10
  

  • Para obtener más información sobre cómo funciona el entorno de ejecución de Node.js, consulta Entorno de ejecución de Node.js.

  • Para obtener más detalles sobre cómo diseñar tu app a fin de aprovechar las versiones y los servicios, consulta Descripción general de App Engine.

  • Para saber más sobre las opciones de configuración de App Engine, consulta Configura tu app con app.yaml.

  package.json

  package.json se usa para especificar las dependencias de la app, la versión del nodo y el inicio de la app.

  {
    "name": "appengine-hello-world",
    "description": "Simple Hello World Node.js sample for Google App Engine Flexible Environment.",
    "version": "0.0.2",
    "private": true,
    "license": "Apache-2.0",
    "author": "Google Inc.",
    "repository": {
      "type": "git",
      "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
    },
    "engines": {
      "node": ">=16.0.0"
    },
    "scripts": {
      "start": "node app.js",
      "test": "c8 mocha -p -j 2 --exit test/*.test.js"
    },
    "dependencies": {
      "express": "^4.17.1"
    },
    "devDependencies": {
      "c8": "^10.0.0",
      "mocha": "^10.0.0",
      "supertest": "^7.0.0"
    }
  }
  

  En el ejemplo anterior, el package.json archivo especifica que la app usa la versión 18 y posteriores de Node.js y depende de express. Si deseas obtener más información para instalar y ejecutar tu app, consulta la documentación del entorno de ejecución de Node.js.