Skip to content

Setup Your Development Environment

Building a microservice

Deploying a microservice

Making API requests to microservice

Modifying microservice

Get the device in your local Edge Cloud Engine cluster

Technical Glossary

Tutorials 

Overview     Guides     Reference   Samples   Libraries

Training

Using mimik Hybrid edgeCloud with AWS Greengrass

Application of mimik Decentralized edgeCloud Platform for Manufacturing

Cloud Decentralization & the Trustless Revolution

As networks choke, edge cloud is the saviour

Digital Freedom Manifesto

Support

Getting Started with mimik Edge Cloud Engine

Download 

Setup Your Development Envrionment
For new developers, we provide a simple ‘hello world’ template for you to get started with edge microservice development with express.js like API interfaces. To use it, clone the following GitHub repository.
git clone https://github.com/mimikgit/starter-microservice.git <folder name>
Building a microservice
Navigate to the folder of starter microservice that you have cloned, run the following command to install microservice dependencies :

Tab Content1 

Tab Content 2

Tab Content
npm i
Run the following command to build the image of the microservice.
npm run build

Run the following command to pack your image file in the folder that you specify under config/default.yml

npm run package
Deploying a microservice
In this section we will be using the Console/Terminal and TextEdit (as suggestion for Mac) or Visual Studio (as suggestton for PC) to run the appropriate commands.
Navigate to the build folder that specified under config/default.yml and run the following command to deploy the image to Edge Cloud Engine container runtime

Replace the with the edge Access token you obtained in Step 2.

curl -i -H ‘Authorization: Bearer ‘ -F ‘image=@microservice-v1.tar’ http://localhost:8083/mcm/v1/images 

Run the following command to start the container image with your environment variables:

curl -i -H “Authorization: Bearer ” -d “{\”name\”: \”microservice-v1\”, \”image\”: \”microservice-v1\”, \”env\”: {\”MCM.BASE_API_PATH\”: \”/sample/v1\”} }” http://localhost:8083/mcm/v1/containers

curl -i -H ‘Authorization: Bearer ‘ -d ‘{“name”: “microservice-v1”, “image”: “microservice-v1”, “env”: {“MCM.BASE_API_PATH”: “/sample/v1”} }’ http://localhost:8083/mcm/v1/containers 

Example Resonse:
The API endpoints of your starter microservice is followed by the MCM.BASE_API_PATH from your CURL response. Let’s copy it and use it for the next step. 

{
“created”: 1579560851322,
“env”: {
“MCM.BASE_API_PATH”: “/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/sample/v1”,
“MCM.WEBSOCKET_SUPPORT”: “false”
},
“id”: “xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-microservice-v1”,
“image”: “microservice-v1”,
“imageId”: “xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-microservice-v1”,
“name”: “microservice-v1”,
“state”: “started” // This response indicated the edge microservice is currently running!!!!
} 

Making API requests to microservice

You can get a response from your starter microservice simply by calling an HTTP API: Note: Replace the <MCM.BASE_API_PATH> with MCM.BASE_API_PATH from the response you get when you started your microservice from previous step. Hint: You can also make API request to your starter microservice from your web browser or an API client like Postman.
curl http://localhost:8083//
Expected response:

curl http://localhost:8083//

Hello World! 

Modifying microservice
You can program microservice to do all sorts of things, such as getting a list of Edge Cloud Engine-powered devices on your local network.
Navigate to the directory of starter microservice and navigate to src directory. Open the index.js file, go to the end of the file and add the following code to allow your microservice to retrieve your network’sEdge Cloud Engine linkLocal clustering information:

app.get(‘/localDevices’, (request, response) => {
context.http.request(({
url: ‘http://localhost:8083/mds/v1/nodes?clusters=linkLocal’,
success: function(r) {
if (!request.authorization) {
response.status = 403;
response.end(JSON.stringify({ ‘msg’: ‘missing bearer token’ }, 2, null));
return;
}
const authorization = request.authorization.split(‘ ‘);
if (authorization.length < 2) {
response.status = 403;
response.end(JSON.stringify({ ‘msg’: ‘missing bearer token’ }, 2, null));
return;
}
const token = authorization[1];
const nodes = JSON.parse(r.data);
const data = JSON.stringify(nodes.data);

context.edge.decryptEncryptedNodesJson({
type: ‘local’,
data,
token,
success: function(result) {
response.end(JSON.stringify(JSON.parse(result.data), null, 2));
},
error: function(err) {
response.end(err.message);
}
});
},
error: function(err) {
response.end(err.message);
}
}));
}); 

Save index.js, then repeat Step 4 to re-build and re-package your microservice, and Step 5 to deploy and start it. Hint: MCM.BASE_API_PATH will not change from re-deployment since it is associated to your project on mimik developer console.

{
“localLinkNetwork”: {
“localLinkNetworkId”: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”,
“nodes”: [ // array contains all the edge nodes within your local network.
{
“APIVersion”: “v1”,
“account”: {
“id”: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, // account ID of the edge node
“self”: “”
},
“addresses”: [
{
“type”: “local”,
“url”: {
“href”: “http://x.x.x.x:8083” // url of the edge node
}
}
],
“characteristics”: [
{
“name”: “cpu”,
“value”: “Intel(R) Core(TM) i7-8500U” // cpu of the edge node
},
{
“name”: “edgeVersion”,
“value”: “v2.2.0” // Edge Cloud Engine version on the edge node
},
{
“name”: “os”,
“value”: “linux” //operating system of the edge node
},
{
“name”: “totalPhysicalMemory”,
“value”: “2061750272” //total RAM in bits of the edge node
},
{
“name”: “totalStorage”,
“value”: “15784157184” //total Disk space in bits of the edge node
}
],
“id”: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”, // node ID of the edge node
“networkAddress”: “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”,
“rolesInCluster”: [
“superNodeLocalLinkNetwork” // the role of the edge node
],
“services”: [ // the edge microservices deployed on the edge node
{
“id”: “xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-microservice-v1”,
“serviceType”: “xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-microservice-v1”,
“tenant”: {
“id”: “”,
“self”: “”
}
}
],
“tenant”: {
“id”: “mimik|001”,
“self”: “”
}
}
]}
} 

Get the devices in your local Edge Cloud Engine cluster

Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.

Technical Glossary

Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.

Setup Your Development Environment

Building a microservice

Deploying a microservice

Making API requests to microservice

Modifying microservice

Get the device in your local Edge Cloud Engine cluster

Technical Glossary