quick start
HOW TO
Auth
App Management
Microservices
Deploying your first Node.js server to Skygear with pre-configured template
Introduction
Skygear offers pre-configured containerization templates so that developers can skip writing a Dockerfile when deploying. One of these templates is Node.js, which we will be using to write a microservice in this section.
Prerequisites
Before you start this section, please ensure you have
skycli installed and configured properly. If you haven't, follow this to set it up.Create a Skygear app
Create a directory called
nodeserver and go inside:1
$ mkdir nodeserver && cd $_
Copied!
Create app and scaffold it with skycli
Enter the
skycli app creation command and give the new app a name. It's better to prefix you app name with your name or preferred alias like your GitHub ID, since Skygear cluster is shared among everyone who has an account and it's likely someone has already taken the app name nodeserver.Upon app creation success, app information such as its API endpoint and key will be listed. They are essential for API calling which we will be performing at later stages. You can either jot them down now or find them at Skygear's Developer Portal.
1
$ skycli app create
2
? What is your app name? <your_name>-nodeserver
3
App name: <your_name>-nodeserver.
4
Creating app...
5
Your API endpoint: https://<your_name>-nodeserver.skygearapp.com/.
6
Your Client API Key: <API Key>.
7
Your Master API Key: <Master Key>.
8
Created app successfully!
Copied!
You will be asked a few questions on scaffolding the newly created app in your current directory.
Answer the first three questions with a Y:
1
? Do you want to scaffold your app now? Or you can do it later by `skycli app scaffold` command.
2
Scaffold now? (Y/n) Y
Copied!
1
? You're about to initialze a Skygear app in this directory: <your-local-directory>
2
Confirm? (Y/n) Y
Copied!
1
? All files in <your-local-directory> would be DELETED. Confirm? (Y/n) Y
Copied!
Pick
<your_name>-nodeserver:1
? Select an app to be associated with the directory: (Use arrow keys)
2
❯ <your_name>-nodeserver
Copied!
Select template
Node.js Express:1
? Select template: (Use arrow keys)
2
Empty
3
❯ Node.js Express
4
Node.js MongoDB Blog App
5
Node.js React/Express Fortune App
Copied!
A success message will then be displayed:
1
Success! Initialized "Node.js Express" template for <your_name>-nodeserver in <your-local-directory>.
Copied!
Some explanations just before deploying
Your directory should now look like this:
1
.
2
├── README.md
3
├── frontend
4
│ ├── index.js
5
│ └── package.json
6
└── skygear.yaml
Copied!
A
skygear.yaml is always needed in order to deploy. It's a configuration file carrying information about the deployment. Let's have a look at the one created by our Node.js Express template:./skygear.yaml
1
app: <your_name>-nodeserver # your Skygear app name
2
3
api_version: v2.1
4
5
deployments:
6
- name: frontend # an arbitrary name of the service
7
type: http-service # type of the service
8
context: frontend # root directory of your source code
9
template: nodejs:12 # pre-configured template
10
path: / # the path for the service
11
port: 8080 # the listening port of the service
Copied!
The Skygear app name to be linked with this deployment is specified at line 1. A microservice named
frontend is declared at line 4, with its properties lying underneath. Line 6 tells Skygear where the source code lies, while line 8 defines the endpoint to reach the service.Skygear runs on an actual Kubernetes cluster which is container-based, still you might already notice there exists no Dockerfile in the directory frontend. This is because we have used a pre-configured template to build our Node.js program, as displayed at line 7. With a valid value given to the configuration filed
template, you don't need to provide a Dockerfile anymore.Deploy the Skygear app
Ensure you are at the root of
nodeserver where skygear.yaml lies, run:1
$ skycli app deploy
Copied!
Wait for the deployment to complete.
Test it out
Simply curl it:
1
$ curl https://<your_name>-nodeserver.skygearapp.com/
2
Hello, world!
Copied!
Useful tips
- To exclude deploying specific files, create a
.skyignorefile. It works the same as.dockerignore. - To deploy service on runtimes other than NodeJS, you can supply a custom
Dockerfileinstead. Learn about it here.