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 implementas 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

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Build API.

   Enable the API

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

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

   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

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Build API.

   Enable the API

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    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.

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

Nota: Dos ubicaciones, que se llaman europe-west y us-central en los comandos de App Engine y en la consola de Google Cloud, 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 consola de Google Cloud. 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 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 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.

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

Precaución: Borrar un proyecto tiene las siguientes consecuencias:
• Se borra todo en el proyecto. 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 ID personalizados de proyectos. Cuando creaste este proyecto, es posible que hayas creado un ID del proyecto personalizado que desees utilizar en el futuro. Para conservar las URL que utilizan el ID del proyecto, como una URL appspot.com, borra los recursos seleccionados dentro del proyecto en lugar de borrar todo el proyecto.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

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

• 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 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
  

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