Getting started with Node.js on Compute Engine

Run the app in Cloud Shell

If you clicked Go to Cloud Shell in the preceding section, Cloud Shell cloned the nodejs-getting-started repository to your instance. After the instance launches, your working directory is ~/cloudshell_open/nodejs-getting-started/gce. If you are not in this directory, see the steps in Before you begin.

1. Install dependencies:

   npm install
   

2. Run the app:

   npm start
   

3. In Cloud Shell, click Web preview , and select Preview on port 8080. This opens a new window with your running app.

To stop the local web server, press Control+C.

Set up Cloud Source Repositories

1. Enable the Cloud Source Repositories API.

   Enable the Cloud Source Repositories API

2. In the Google Cloud console, go to Cloud Source Repositories.

   Go to Cloud Source Repositories

3. Select Add repository.

   

4. Select Create new repository, and then click Continue.

5. In the Repository name field, enter new-repo.

6. In the Project field, enter the project ID of the project that you created or selected for this tutorial, and then click Continue.

7. Select Clone your repository to a local Git repository.

8. In Cloud Shell, return to root and clone the repository by following the instructions in the Google Cloud SDK tab, and keep this tab open.

   

9. Before completing the final step under the instructions, copy your app into your new repository in Cloud Shell:

   cd new-repo
   cp ../cloudshell_open/nodejs-getting-started/gce/app.js app.js
   cp ../cloudshell_open/nodejs-getting-started/gce/package.json package.json
   

10. Follow the remaining instructions in the Google Cloud SDK tab to commit your changes to your repository. Confirm that you have added your code to the repository by refreshing the browser and checking that your code was added to the repo new-repo.

Deploy to a single instance

This section walks you through running a single instance of your app on Compute Engine.

From Cloud Shell, you can deploy to a single Compute Engine instance virtual machine (VM) which runs your app.

Use a startup script to initialize an instance

You need a way to instruct your instance to download and run your code. An instance can have a startup script that runs whenever the instance is started or restarted.

Here is the startup script that is included in the Hello World sample app:

set -v


# Talk to the metadata server to get the project id
PROJECTID=$(curl -s "http://metadata.google.internal/computeMetadata/v1/project/project-id" -H "Metadata-Flavor: Google")
REPOSITORY="new-repo"

# Install logging monitor. The monitor will automatically pick up logs sent to
# syslog.
curl -s "https://storage.googleapis.com/signals-agents/logging/google-fluentd-install.sh" | bash
service google-fluentd restart &

# Install dependencies from apt
apt-get update
apt-get install -yq ca-certificates git build-essential supervisor

# Install nodejs
mkdir /opt/nodejs
curl https://nodejs.org/dist/v16.15.0/node-v16.15.0-linux-x64.tar.gz | tar xvzf - -C /opt/nodejs --strip-components=1
ln -s /opt/nodejs/bin/node /usr/bin/node
ln -s /opt/nodejs/bin/npm /usr/bin/npm

# Get the application source code from the Google Cloud Repository.
# git requires $HOME and it's not set during the startup script.
export HOME=/root
git config --global credential.helper gcloud.sh
git clone https://source.developers.google.com/p/${PROJECTID}/r/${REPOSITORY} /opt/app/new-repo

# Install app dependencies
cd /opt/app/new-repo
npm install

# Create a nodeapp user. The application will run as this user.
useradd -m -d /home/nodeapp nodeapp
chown -R nodeapp:nodeapp /opt/app

# Configure supervisor to run the node app.
cat >/etc/supervisor/conf.d/node-app.conf << EOF
[program:nodeapp]
directory=/opt/app/new-repo
command=npm start
autostart=true
autorestart=true
user=nodeapp
environment=HOME="/home/nodeapp",USER="nodeapp",NODE_ENV="production"
stdout_logfile=syslog
stderr_logfile=syslog
EOF

supervisorctl reread
supervisorctl update

# Application should now be running under supervisor

The startup script performs the following tasks:

• Installs the Cloud Logging agent. The agent automatically collects logs from syslog.

• Installs Supervisor to run the app as a daemon.

• Clones the app's source code from Cloud Source Repositories and installs dependencies.

• Configures Supervisor to run the app. Supervisor makes sure the app is restarted if it exits unexpectedly or is terminated by an admin or other process. It also sends the app's stdout and stderr to syslog to be collected by the Logging agent.

Create and configure a Compute Engine instance

1. Create a Compute Engine instance:

   Linux/macOS

   gcloud compute instances create my-app-instance \
       --image-family=debian-9 \
       --image-project=debian-cloud \
       --machine-type=g1-small \
       --scopes userinfo-email,cloud-platform \
       --metadata app-location=us-central1-f \
       --metadata-from-file startup-script=gce/startup-script.sh \
       --zone us-central1-f \
       --tags http-server
   

   Windows

   gcloud compute instances create my-app-instance ^
       --image-family=debian-9 ^
       --image-project=debian-cloud ^
       --machine-type=g1-small ^
       --scopes userinfo-email,cloud-platform ^
       --metadata-from-file startup-script=gce/startup-script.sh ^
       --zone us-central1-f ^
       --tags http-server
   

   Replace the zone with a development zone, for example us-central1-a. For more information on regions and zones, see Geography and regions.

   This creates a new instance, allows it to access Google Cloud services, and runs your startup script. The instance name is my-app-instance.

2. Check the progress of the instance creation:

   gcloud compute instances get-serial-port-output my-app-instance --zone YOUR_ZONE
   

   Replace YOUR_ZONE with the zone you deployed your instance to.

   When the startup script is complete, you see the following message:

   startup-script: INFO Finished running startup scripts.
   

3. Create a firewall rule to allow traffic to your instance:

   gcloud compute firewall-rules create default-allow-http-8080 \
       --allow tcp:8080 \
       --source-ranges 0.0.0.0/0 \
       --target-tags http-server \
       --description "Allow port 8080 access to http-server"
   

4. Get the external IP address of your instance:

   gcloud compute instances list
   

5. To see your app running, enter this URL in your browser:

   http://YOUR_INSTANCE_IP:8080
   

   Replace YOUR_INSTANCE_IP with the external IP address of your instance.

Manage and monitor an instance

You can use the Google Cloud console to monitor and manage your instance.

1. In the Google Cloud console, go to the VM instances page.

   Go to VM instances

2. In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
3. To view all of the logs generated by your Compute Engine resources, go to the Logs Explorer page. Go to Logs Explorer

   Cloud Logging is automatically configured to gather logs from various common services, including syslog.