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 seleccionas 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.

En esta guía de inicio rápido, se muestra cómo crear e implementar una app que muestra un mensaje corto. La aplicación de muestra usa la versión más reciente de Node.js. Puedes usar la misma muestra de código para Node.js 18 y versiones posteriores si especificas la versión en tu archivo app.yaml.

La muestra de código para la versión 16.0 y anteriores de Node.js está disponible en GitHub.

Antes de comenzar

  1. Accede a tu cuenta de Google Cloud. 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.
  2. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  4. Habilita Cloud Build API.

    Habilita la API

  5. Instala Google Cloud CLI.
  6. Para inicializar la CLI de gcloud, ejecuta el siguiente comando:

    gcloud init
  7. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  8. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  9. Habilita Cloud Build API.

    Habilita la API

  10. Instala Google Cloud CLI.
  11. Para inicializar la CLI de gcloud, ejecuta el siguiente comando:

    gcloud init

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.

  2. Instala los siguientes requisitos:

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 productos y servicios de Google Cloud 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.

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

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.

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 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. Por ejemplo: --version [YOUR_VERSION_ID].
    • Incluye la marca --project para especificar un ID del proyecto de Google Cloud alternativo al que inicializaste como predeterminado en la herramienta de gcloud. Por 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.

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

    gcloud app browse
    En el ejemplo anterior, PROJECT_ID representa el ID del proyecto de Google Cloud.

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.

Realiza una limpieza

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

  1. En la consola de Google Cloud, ve a la página Administrar recursos.

    Ir a Administrar recursos

  2. En la lista de proyectos, elige el proyecto que 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 implementar y desarrollar apps en 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.

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 archivo app.yaml 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: ubuntu22
    # 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
    

    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": "^8.0.0",
        "mocha": "^10.0.0",
        "supertest": "^6.0.0"
      }
    }
    

    En el ejemplo anterior, el archivo package.json 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.