Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add New Getting Started on Google Cloud Page #139

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions docs/getting-started/gcp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
layout: docs-getting-started
title: Running on Google Cloud Platform (GCP)
slug: gcp
toc: toc-user-guide.html
redirect_from:
- /docs/platforms/gcp
---

This guide takes you through the steps to get Node-RED running on an GCP
Virtual Machine instance.

#### Create the base image

1. Log in to the [Google Cloud Platform Console](https://console.cloud.google.com/)

1. Select your project.

1. Click `VPC network` >> `VPC networks` >> `Firewall rules` >> `CREATE FIREWALL RULE`

new `Create a firewall rule` with the options set as:
- Name: node-red-editor
- Network: default
- Priority: 1010
- Direction of traffic: Ingress
- Action on match: Allow
- Targets: ALL Instances in the network
- Source filter: IP ranges
- Source IP ranges: 0.0.0.0/0
- Protocols and ports: Specified protocols and ports
- tcp: 1880

Click `Create` on the Settings page.

1. Click `Compute Engine` >> `VM instances` >> `Create`

Give your machine info
- Name: node-red-instance
- Region: us-central1
- Zone: us-central1-a
- Machine configuration
- Machine family
- General-purpose
- Series
- N1
- Machine type
- f1-micro
- Boot disk
- Ubuntu 18.04 LTS

Click `Create` on the Settings page, then the instance will start to be created.

After a couple of minutes your instance will be running. In the console
you can find your instance's IP address as `External IP`.

#### Setup Node-RED

The next task is to log into the instance then install node.js and Node-RED.

Log into your instance using the authentication details you specified in the
previous stage.

Once logged in you need to install node.js and Node-RED using manual install.

[NodeSource Node.js Binary Distributions](https://github.com/nodesource/distributions#manual-installation)

Remove the old PPA if it exists

sudo add-apt-repository -y -r ppa:chris-lea/node.js
sudo rm -f /etc/apt/sources.list.d/chris-lea-node_js-*.list
sudo rm -f /etc/apt/sources.list.d/chris-lea-node_js-*.list.save

Add the NodeSource package signing key

curl -sSL https://deb.nodesource.com/gpgkey/nodesource.gpg.key | sudo apt-key add -

Add the desired NodeSource repository

VERSION=node_10.x
DISTRO="$(lsb_release -s -c)"
echo "deb https://deb.nodesource.com/$VERSION $DISTRO main" | sudo tee /etc/apt/sources.list.d/nodesource.list
echo "deb-src https://deb.nodesource.com/$VERSION $DISTRO main" | sudo tee -a /etc/apt/sources.list.d/nodesource.list

Update package lists and install Node.js

sudo apt-get update
sudo apt-get install nodejs

Install Node-RED

sudo apt-get install build-essential
sudo npm install -g node-red


At this point you can test your instance by running `node-red`. *Note*: you may
get some errors regarding the Serial node - that's to be expected and can be
ignored.

Once started, you can access the editor at `http://<your-instance-ip>:1880/`.

To get Node-RED to start automatically whenever your instance is restarted, you
can use pm2:

sudo npm install -g pm2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you not use the systemd scripts we already have documented ? - or indeed the Linux install scripts which work on Debian/Ubuntu also ?

Copy link
Author

@iganari iganari Nov 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dceejay

Thank you for checking.
Check it myself!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dceejay

I'm Sorry for the late comment and late check.

I wrote a document referring to Azure document

Please tell me the documentation of systemd scripts.

thank you.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dceejay

Thank you a lots !
I will check now!

pm2 start `which node-red` -- -v
pm2 save
pm2 startup

*Note:* this final command will prompt you to run a further command - make sure you do as it says.
12 changes: 12 additions & 0 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,15 @@ such as a Raspberry Pi or in the cloud and follow the guides below.
</div>
</a>
</div>

<div class="post-preview">
<a href="gcp">
<div class="post-header">
<img src="/images/platform-cloud.png">
<h2>Google Cloud Platform</h2>
</div>
<div class="post-content">
Running on an Virtual Machine on Google infrastructure
</div>
</a>
</div>