Skip to content

Commit ff45b2a

Browse files
committed
added instructions to deploy IoT Starter app
1 parent 9f5ac48 commit ff45b2a

13 files changed

+94
-9
lines changed

additionalResources/COMMAND_LINE_ACCESS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
***
33
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)
44
***
5-
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [**Command line access**](COMMAND_LINE_ACCESS.md)
5+
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [IoT Starter App](IOT_STARTER_APP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [**Command line access**](COMMAND_LINE_ACCESS.md)
66
***
77

88
# Additional Resources - Command Line Access to a Raspberry Pi
@@ -110,6 +110,6 @@ Hit **open** to start the connection. If you get a warning about the identity h
110110
***
111111
*Quick links :*
112112
***
113-
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [**Command line access**](COMMAND_LINE_ACCESS.md)
113+
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [IoT Starter App](IOT_STARTER_APP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [**Command line access**](COMMAND_LINE_ACCESS.md)
114114
***
115115
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)

additionalResources/HEADERLESS_SETUP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
***
33
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)
44
***
5-
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [**Headerless Setup**](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
5+
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [IoT Starter App](IOT_STARTER_APP.md) - [**Headerless Setup**](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
66
***
77

88
# Additional Resources - Headerless setup
@@ -62,6 +62,6 @@ One further action needs to be taken during the initial setup. When you run the
6262
***
6363
*Quick links :*
6464
***
65-
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [**Headerless Setup**](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
65+
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [IoT Starter App](IOT_STARTER_APP.md) - [**Headerless Setup**](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
6666
***
6767
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
*Quick links :*
2+
***
3+
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)
4+
***
5+
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [**IoT Starter App**](IOT_STARTER_APP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
6+
***
7+
8+
In part 3 you will be working on the IBM cloud. You will send sensor data aver the mesh network into the IBM Cloud. The IBM IoT Platform will receive the data over a secure connection, then an application deployed on the cloud will receive the data.
9+
10+
In order to prepare for part 3 you need to deploy a starter application on the cloud and add in the IBM IoT platform service. Follow the instructions below to complete this.
11+
12+
### Step 1 - Accessing the cloud and selecting an appropriate space
13+
14+
[Login](https://cloud.ibm.com) to your cloud account, if not already logged in.
15+
16+
If you haven't previously used any of the Cloud Foundry locations you will need to create a **space** to be able to work in the chosen location. To do this from the top menu select *Manage* -> *Account* -> *Cloud Foundry Orgs* then click on your mail address to configure your organisation. Click to **Add a space** then select the region and provide a name for the space.
17+
18+
If you are working in a lite account you are restricted to a single Cloud Foundry space and are unable to create additional spaces in different regions unless you upgrade your account.
19+
20+
Lite accounts have resource restrictions, so to be able to deploy the starter application you may need to delete any resources already deployed.
21+
22+
### Step 2 - Deploy a Starter Application
23+
24+
- open up the Catalog using the top menu, then select **Web and Applications** from the left menu
25+
- select the **Software** tab
26+
- select the **Node-RED App**
27+
28+
![Catalog](../images/catalog.png)
29+
30+
- in the screen presented press the **Create app** button
31+
- in the Create app screen optionally enter an App name (or you can simple accept the name provided) and select a region to deploy the Cloudant NoSQL database to - ideally this should be the same region you have your Cloud Foundry space in.
32+
- press the **Create** button to create the App definition
33+
34+
![Create App](../images/createApp.png)
35+
36+
- wait until the Cloudant service has been deployed
37+
- press the **Create Service +** button, then select the Internet of Things section and press the **Next** button
38+
- select the Internet of Things Platform then press the **Next** button
39+
- choose the closest region, ensure the Lite pricing plan is selected then press Create to add the Internet of Things Platform to your application
40+
- press **Deploy you app**
41+
42+
![Deploy App](../images/deployApp.png)
43+
44+
- ensure IBM Cloud Foundry is the deployment target (this is the only option for lite accounts)
45+
- press **New** to create an IBM Cloud API key, accept the defaults in the popup and press **OK**
46+
- select the Memory allocation per instance to 256 MB
47+
- ensure the host name is valid, if not modify it until any errors are cleared
48+
- select the region closest to you to deploy the toolchain
49+
- press **Create** to generate the toolchain for your application
50+
51+
![App Details](../images/appDetails.png)
52+
53+
The Starter Application is now deploying by running the newly created toolchain.
54+
55+
Please leave this to deploy - now is a good time to go for a break or move onto [part 1](../part1/README.md)
56+
57+
### Step 3 - Check deployment status
58+
59+
- open the main menu ![menu](../images/menu.png)(Top left of web console UI)
60+
- select Resource list
61+
- select your application from the Cloud Foundry apps section to launch the application overview page
62+
63+
![App Details](../images/resourceList.png)
64+
65+
On the overview page you should see:
66+
67+
- the app is awake, which shows the deployment was successful and the application is running
68+
- the link to open the application
69+
- the connections to the Cloudant database and IoT platform services
70+
- link to access toolchain
71+
72+
![App Overview](../images/appOverview.png)
73+
74+
***
75+
*Quick links :*
76+
***
77+
**Resources** - [Setup](PREREQUISITES_AND_SETUP.md) - [**IoT Starter App**](IOT_STARTER_APP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
78+
***
79+
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)

additionalResources/PREREQUISITES_AND_SETUP.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
***
33
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)
44
***
5-
**Resources** - [**Setup**](PREREQUISITES_AND_SETUP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
5+
**Resources** - [**Setup**](PREREQUISITES_AND_SETUP.md) - [IoT Starter App](IOT_STARTER_APP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
66
***
77

88
# Additional Resources - Prerequisites and setup
@@ -93,9 +93,11 @@ To complete [part 3](/part3/README.md) you need to have an IBM Cloud account. T
9393

9494
To sign up for the IBM cloud follow [this link](https://cloud.ibm.com/login)
9595

96+
You also need to deploy an Internet of Things starter application. Follow [these instructions](IOT_STARTER_APP.md) to deploy the application into your account.
97+
9698
***
9799
*Quick links :*
98100
***
99-
**Resources** - [**Setup**](PREREQUISITES_AND_SETUP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
101+
**Resources** - [**Setup**](PREREQUISITES_AND_SETUP.md) - [IoT Starter App](IOT_STARTER_APP.md) - [Headerless Setup](HEADERLESS_SETUP.md) - [Command line access](COMMAND_LINE_ACCESS.md)
100102
***
101103
[Home](/README.md) - [Part 1](/part1/README.md) - [Part 2](/part2/README.md) - [Part 3](/part3/README.md) - [**Resources**](/additionalResources/README.md)

additionalResources/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,19 @@ This section provides additional information, will get you up to speed with the
99

1010
## Prerequisites and setup
1111

12-
Before you start the workshop you need to have the required hardware and software installed and have your IBM public cloud account. Full details can be found on the [Setup](/additionalResources/PREREQUISITES_AND_SETUP.md) page.
12+
Before you start the workshop you need to have the required hardware and software installed and have your IBM public cloud account. Full details can be found on the [Setup](PREREQUISITES_AND_SETUP.md) page
13+
14+
## IOT Starter App
15+
16+
In part 3 you will send sensor data across the mesh network to the IBM Cloud. You have to deploy an IoT starter application on the IBM cloud to receive the data. Full instructions to deploy the application and the IBM IoT platform can be found [here](IOT_STARTER_APP.md)
1317

1418
## Headerless setup
1519

16-
When setting up a Raspberry Pi you need to access the Pi to do the initial setup. This is usually done by connecting a keyboard, mouse and monitor to the Pi. However, it is possible to setup the pi using a computer without needing to connect the keyboard, mouse and monitor. This is known as a headerless setup. Full details can be found on doing a headerless setup on [this page](/additionalResources/HEADERLESS_SETUP.md)
20+
When setting up a Raspberry Pi you need to access the Pi to do the initial setup. This is usually done by connecting a keyboard, mouse and monitor to the Pi. However, it is possible to setup the pi using a computer without needing to connect the keyboard, mouse and monitor. This is known as a headerless setup. Full details can be found on doing a headerless setup on [this page](HEADERLESS_SETUP.md)
1721

1822
## Command line access to a Raspberry Pi
1923

20-
Throughout the workshop you need to get access to the command line of the Raspberry Pi board that make up the mesh network. [this page](COMMAND_LINE_ACCESS.md) provides information how to do this from Linux, MacOS and Windows systems.
24+
Throughout the workshop you need to get access to the command line of the Raspberry Pi board that make up the mesh network. [this page](COMMAND_LINE_ACCESS.md) provides information how to do this from Linux, MacOS and Windows systems
2125

2226
***
2327
*Quick links :*

images/appDetails.png

157 KB
Loading

images/appOverview.png

141 KB
Loading

images/catalog.png

155 KB
Loading

images/createApp.png

58.8 KB
Loading

images/deployApp.png

89.5 KB
Loading

0 commit comments

Comments
 (0)