How to scaffold, run, debug, test, and deploy a LoopBack 4 application using Appsody CLI #4215

emonddr · 2019-11-26T18:59:31Z

How to use the nodejs-loopback stack and the Appsody CLI
to scaffold, run, debug, and test a LoopBack 4 application locally,
and how to deploy this application to the IBM Cloud.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

npm test passes on your machine
New tests added or existing tests modified to cover all changes
Code conforms with the style guide
API Documentation in code was updated
Documentation in /docs/site was updated
Affected artifact templates in packages/cli were updated
Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

emonddr · 2019-11-26T19:00:44Z

This is where I'm thinking we should place this document:

dhmlau

Thanks for putting this together!
Besides the comment, I have one more question: would we be showing up how to connect with other databases in a LB4 application as well? I thought you were looking into it.

dhmlau · 2019-11-26T19:13:56Z

docs/site/Appsody-LoopBack.md

+The template application is only a starting point. Let's build a proper, basic
+LoopBack 4 application.
+
+Let's build the


I wonder if we need this section because it's the same as the todo tutorial.
I can see the advantage of having all the instructions in one place without clicking other docs. However, my concern of having duplicating the content here is if there's any change in the prompts, we need to update it in 2 places. Personally, I'd like to see this tutorial to be more focus on the specific things we need to do when deploying Apposody.

Todo also talks about the geoservice. We don't need that. Also. The todo doc is out of date in terms of prompts. We can replace this Building your application section with `follow the Todo tutorial starting with 'Add model' and do not do 'Adding geo-service'.

I was trying to avoid any relational database stuff because I wanted to avoid talking about setting up a database on IBM Cloud.

Raymond's changes to the structure/documentation of the shopping cart application was geared to show how to deploy an app docker container, a mongo container, and a redis container to a kubernetes cluster. So I figured this was sufficient.

With Appsody, using the nodejs-loopback stack ( a template of a loopback app), it is very simple to run/debug/test/stop and app locally. And very simple to deploy to kubernetes. Before deploying to kubernetes, we would need to change the db url in the datasource json.

@dhmlau , we can start with this, and then provide a follow-up in the future for dealing with a relational database

sure. as the first step, I'm fine with just using the in-memory database.

emonddr · 2019-11-26T19:21:05Z

As I was preparing this document, I came across these issues : #4216 .

I also came across other issues that @raymondfeng fixed in this PR : appsody/stacks#488 .
Particularly : https://github.com/appsody/stacks/blob/master/incubator/nodejs-loopback/image/project/src/index.ts#L21 . We needed this line because the LB4 appsody application could not find the project/data/db.json file for the in memory database.

dhmlau · 2019-11-29T02:57:44Z

@mhdawson, this might be a good candidate for QuickLab for the upcoming conferences.

bajtos

Awesome 👏

docs/site/Appsody-LoopBack.md

mhdawson · 2019-11-29T17:11:45Z

@joesepi, what do you think in terms of quicklab. Probably too late for NodeJSInteractive since it's only a couple week away (correct me if I'm wrong on this front), but could be a good option for the standard set we use for next year.

emonddr · 2019-12-02T16:30:34Z

A fix was provided for #4216 by @raymondfeng . Thanks, Raymond :)

raymondfeng · 2019-12-02T18:25:39Z

docs/site/Appsody-LoopBack.md

@@ -0,0 +1,990 @@
+---
+lang: en
+title: 'Deploying to Cloud with Appsody'


The title should be Developing and Deploying LoopBack Applications with Appsody.

raymondfeng · 2019-12-02T18:26:19Z

docs/site/Appsody-LoopBack.md

+permalink: /doc/en/lb4/Appsody-LoopBack.html
+---
+
+## LoopBack 4 & Appsody


The header can be ## Introduction or ## Overview.

Choosing Overview.

raymondfeng · 2019-12-02T18:28:40Z

docs/site/Appsody-LoopBack.md

+
+[Appsody](https://appsody.dev/docs#welcome-to-appsody) is designed to help
+develop containerized applications for the cloud.
+


Should we mention https://kabanero.io/?

Should we mention https://kabanero.io/?

@raymondfeng , how do we want to mention it? I downloaded and used the appsody CLI with homebrew. I didn't use kabanero.

My initial thought was to make our users aware that Kabanero is a broader offering that uses Appsody for cloud native app dev/dep.

raymondfeng · 2019-12-02T18:29:29Z

docs/site/Appsody-LoopBack.md

+
+We're going to show you how to scaffold, run, stop, debug, and test a LoopBack 4
+application locally. Then we're going to show you how to build and deploy this
+application to the [IBM Cloud](https://www.ibm.com/cloud).


Seeing We're going to show you twice. Can we use a different phrase?

We're going to show you how to scaffold, run, stop, debug, and test a LoopBack 4 application locally. Then, you'll learn how to build and deploy this application to the [IBM Cloud](https://www.ibm.com/cloud).

raymondfeng · 2019-12-02T18:30:17Z

docs/site/Appsody-LoopBack.md

+7. Now that all the dependencies have been installed, it is a perfect time to
+   open your favourite IDE editor on this project.
+
+   In my case, I using VS Code.


using -> use.

raymondfeng · 2019-12-02T18:31:14Z

docs/site/Appsody-LoopBack.md

+   npm install
+   ```
+
+7. Now that all the dependencies have been installed, it is a perfect time to


it is a perfect time to -> it's ready to or let's?

raymondfeng · 2019-12-02T18:34:01Z

docs/site/Appsody-LoopBack.md

+The template application is only a starting point. Let's build a proper, basic
+LoopBack 4 application.
+
+Let's build the


Seeing let's build twice.

"
The template application is only a starting point.

Let's build a proper, basic LoopBack 4 application.

We'll use the todo list application from the Todo Tutorial as an example.
"

raymondfeng · 2019-12-02T18:34:57Z

docs/site/Appsody-LoopBack.md

+   ![lb4appsody_template_files_2.png](./imgs/lb4appsody_template_files_2.png)
+
+10. This basic application only defines one API endpoint `'/ping'` in the file
+    **src/controllers/ping.controller.ts**


We can mention the initial application is very much similar as the one generated by lb4 app command but it's going to be a loaded by a facade that sets up health/metrics for cloud native observability.

raymondfeng · 2019-12-02T18:37:11Z

docs/site/Appsody-LoopBack.md

+We will run, test, debug, and stop this application **locally** in the next
+section.
+
+## Running/Testing/Debugging/Stopping a LoopBack 4 Application Locally using Appsody


We probably should mention the watch capability - as we make changes to the project locally, the application can be redeployed to a docker container as we go.

We probably should mention the watch capability - as we make changes to the project locally, the application can be redeployed to a docker container as we go.

@raymondfeng , I mention this in the sentence: By default, 'File watching' is **enabled** when you run the command 'appsody run'. This means you can change a file in your project, and then Appsody builds/runs a new Docker container for you automatically.

raymondfeng · 2019-12-02T18:39:28Z

docs/site/sidebars/lb4_sidebar.yml

@@ -187,6 +187,11 @@ children:
        url: deploying-with-pm2-and-nginx.html
        output: 'web, pdf'

+      - title: 'Deploying to Cloud with Appsody'


Updating title as well

raymondfeng · 2019-12-02T18:40:02Z

Let's somehow use or add a new diagram for https://appsody.dev/static/2f908188a17e5e471158534326fc5665/0a44b/appsody_flow.png?

emonddr · 2019-12-02T19:30:12Z

It is best to view the commit

with this option in github:

It will show that one-liners were added here and there by the editor.

Viewing it the normal way makes it look like big sections went missing (not sure why)

raymondfeng · 2019-12-02T23:11:51Z

@emonddr Please fix the formatting - see https://travis-ci.com/strongloop/loopback-next/jobs/262349584

raymondfeng · 2019-12-02T23:12:44Z

docs/site/sidebars/lb4_sidebar.yml

@@ -10,799 +10,766 @@
 title: LoopBack 4
 url: index.html
 children:
-


Please revert the formatting changes and only leave your addition using the current format.

emonddr · 2019-12-03T13:16:15Z

@emonddr Please fix the formatting

Ok I will revert. I spoke to @jannyHou about this yesterday. How my editor automatically wants to reformat the YML. Not sure why that is. But I will revert.

… cli Use the 'nodejs-loopback' stack and the Appsody CLI to scaffold, run, debug, and test a LoopBack 4 application locally, and how to deploy this application to Kubernetes on the IBM Cloud.

jannyHou · 2019-12-03T18:37:03Z

docs/site/Appsody-LoopBack.md

+### Stopping a LoopBack 4 Application Locally using Appsody
+
+If your application is currently running under Appsody control, you can stop it
+with `Ctrl+C`, or by running the command `'appsody stop'` from another terminal.


what if I have multiple apps started by appsody run, would this command stop all of them? Is it possible to provide a container name as argument to specify which one to stop?

what if I have multiple apps started by appsody run, would this command stop all of them? Is it possible to provide a container name as argument to specify which one to stop?

Good question. But out of scope for this article. More for Appsody FAQ.

But from what I understand and observe, the .appsody-config.yaml file in your project directory (e.g. appsodyLB4Todo) has a project-name value:

project-name: appsodylb4todo stack: appsody/nodejs-loopback:0.1

When appsody run is executed (from inside directory appsodylb4todo), it starts a docker container named

appsodylb4todo-dev

To do: appsody stop, you must also be inside the directory appsodylb4todo .

Then it stops and removes this container.

So, if you have multiple apps started from separate project directories, and they have unique project directory names, you should be fine.

to do: appsody stop, you must also be inside the directory appsodylb4todo .

Magic! Now I understand how the run and stop cmd finds the app. thanks for explanation!

emonddr requested review from bajtos and raymondfeng as code owners November 26, 2019 18:59

dhmlau reviewed Nov 26, 2019

View reviewed changes

dhmlau added this to the Dec 2019 milestone Nov 27, 2019

dhmlau added CloudNative Cloud native enablement Docs labels Nov 29, 2019

bajtos reviewed Nov 29, 2019

View reviewed changes

docs/site/Appsody-LoopBack.md Outdated Show resolved Hide resolved

agnes512 mentioned this pull request Dec 2, 2019

Monthly Milestone - Dec 2019 🌲⛄️🎁 #4236

Closed

19 tasks

raymondfeng reviewed Dec 2, 2019

View reviewed changes

emonddr force-pushed the dremond_appsody_lb4_doc branch from 28ef135 to 957c0d2 Compare December 3, 2019 14:29

docs: scaffold, run, and deploy a loopback 4 application with appsody…

7c84404

… cli Use the 'nodejs-loopback' stack and the Appsody CLI to scaffold, run, debug, and test a LoopBack 4 application locally, and how to deploy this application to Kubernetes on the IBM Cloud.

emonddr force-pushed the dremond_appsody_lb4_doc branch from 957c0d2 to 7c84404 Compare December 3, 2019 14:30

raymondfeng approved these changes Dec 3, 2019

View reviewed changes

jannyHou reviewed Dec 3, 2019

View reviewed changes

jannyHou approved these changes Dec 3, 2019

View reviewed changes

emonddr merged commit a869184 into master Dec 3, 2019

emonddr deleted the dremond_appsody_lb4_doc branch December 3, 2019 20:22


		[Appsody](https://appsody.dev/docs#welcome-to-appsody) is designed to help
		develop containerized applications for the cloud.

How to scaffold, run, debug, test, and deploy a LoopBack 4 application using Appsody CLI #4215

How to scaffold, run, debug, test, and deploy a LoopBack 4 application using Appsody CLI #4215

Conversation

emonddr commented Nov 26, 2019 • edited Loading

Checklist

emonddr commented Nov 26, 2019

dhmlau left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emonddr commented Nov 26, 2019

dhmlau commented Nov 29, 2019

bajtos left a comment

Choose a reason for hiding this comment

mhdawson commented Nov 29, 2019

emonddr commented Dec 2, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raymondfeng Dec 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emonddr Dec 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raymondfeng commented Dec 2, 2019

emonddr commented Dec 2, 2019 • edited Loading

raymondfeng commented Dec 2, 2019

Choose a reason for hiding this comment

emonddr commented Dec 3, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jannyHou Dec 3, 2019 • edited Loading

Choose a reason for hiding this comment

emonddr commented Nov 26, 2019 •

edited

Loading

raymondfeng Dec 2, 2019 •

edited

Loading

emonddr Dec 2, 2019 •

edited

Loading

emonddr commented Dec 2, 2019 •

edited

Loading

jannyHou Dec 3, 2019 •

edited

Loading