Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mchmarny/buttons
How to use Flic buttons with Clud Run on GCP
https://github.com/mchmarny/buttons
cloud cloudrun flic iot pubsub
Last synced: 3 months ago
JSON representation
How to use Flic buttons with Clud Run on GCP
- Host: GitHub
- URL: https://github.com/mchmarny/buttons
- Owner: mchmarny
- License: apache-2.0
- Created: 2019-05-31T12:12:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T02:28:41.000Z (over 1 year ago)
- Last Synced: 2024-06-21T20:03:18.106Z (5 months ago)
- Topics: cloud, cloudrun, flic, iot, pubsub
- Language: Go
- Homepage:
- Size: 5.03 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cloud-run - Flic buttons
README
# How to use Flic buttons with Cloud Run on GCP
A co-worker recently told me about [flic.io](https://flic.io/) buttons. These button caught my attention because they can include triggers for single, double, or hold click and can be easily wired up to all kinds of actions.
I instantly thought of of a few really interesting applications. To start with though, I wanted to create a simple service that would allow me to push the custom data defined on each button over HTTP to Cloud PubSub. That in turn would then connect me to the many more actuation options through GCP APIs and services that connect to Cloud PugSub.
I went ahead and ordered [4-pack](https://flic.io/shop/flic-4pack) of Flic buttons and chose [Cloud Run](https://cloud.google.com/run/) to implement my `buttons` service.
In this demo I will illustrate how to:
* Deploy Cloud Run service that will persist sent data to Cloud PubSub
* and, how to configure Flic buttons to send data to Cloud Run service
## Easy Deploy
You can deploy `buttons` service in Cloud Run with a single... wait for it... click of a button. Just click on the "Run on Google Cloud" bellow and follow the prompts in Cloud Shell. When done, go to the [Configuring Flic Button](#configuring-flic-button) section to finish configuring your Flic buttons.
[](https://console.cloud.google.com/cloudshell/editor?shellonly=true&cloudshell_image=gcr.io/cloudrun/button&cloudshell_git_repo=https://github.com/mchmarny/buttons.git)
## Manual Deploy (the harder way)
### Prerequisites
* Configured gcloud CLI (Cloud SDK) for your operating system ([how-to](https://cloud.google.com/sdk/gcloud/)) with default application credentials:
* `gcloud auth application-default login`
* Enabled GCP APIs for Cloud PubSub and Cloud Run
* `gcloud services enable pubsub.googleapis.com`
* `gcloud services enable run.googleapis.com`
### Cloud PubSub Topic
To store the data sent from each button action, first, we need to create a Cloud PubSub topic named `clicks`
```shell
gcloud pubsub topics create clicks
```
That should result with
```shell
Created topic [projects/YOUR_PROJECT_ID/topics/clicks].
```
### Cloud Run Service
Next deploy the generic Cloud Run service called `buttons`. The code for that service is in this repository for you to review. There is already a public image available (see below), but if you want to, you can build your own copy with this command:
```shell
gcloud builds submit --tag gcr.io/YOUR_PROJECT_ID/buttons:0.1.2
```
> For more information on how to build images using Cloud Build see [here](https://cloud.google.com/run/docs/quickstarts/build-and-deploy). You can skip the build step and use the already pre-built public image located at `gcr.io/knative-samples/buttons:0.1.2`
Before we deploy the Cloud Run service we have to create a `secret` which will be used to ensure that only data from your button will be accepted. To do that, replace the `your-long-and-super-secret-string` string below with something more secure and define it as an environment variable using this command:
```shell
export SECRET="your-long-and-super-secret-string"
```
> For more secure way to defining secrets in Cloud Run environment variables you can use the [berglas](https://github.com/GoogleCloudPlatform/berglas) library.
Now that we have the `SECRET` defined, you can deploy the Cloud Run service. A couple of flags worth highlighting in the bellow command:
* `concurrency` - the button service is thread safe and doesn't store any internal state so we can turn the concurrency to maximum. More on concurrency [here](https://cloud.google.com/run/docs/about-concurrency)
* `allow-unauthenticated` - By default Cloud Run creates private services which can't be accessed by anonymous users. Since our buttons don't support more complex authentication scheme, we will expose the Cloud Run service to the public and validate each request using `token` string in request header. More on allowing public access [here](https://cloud.google.com/run/docs/authenticating/public)
```shell
gcloud beta run deploy buttons \
--region=us-central1 \
--concurrency=80 \
--allow-unauthenticated \
--image=gcr.io/knative-samples/buttons:0.1.2 \
--update-env-vars="SECRET=${SECRET}"
```
The response from the above command should look something like this
```shell
Deploying container to Cloud Run service [buttons] in project [YOUR_PROJECT_ID] region [us-central1]
✓ Deploying... Done.
✓ Creating Revision...
✓ Routing traffic...
✓ Setting IAM Policy...
Done.
Service [buttons] revision [buttons-00001] has been deployed and is serving traffic at https://buttons-*******-uc.a.run.app
```
You should be able to see that service in Cloud Run service list
```shell
$: gcloud beta run services list
SERVICE REGION LATEST REVISION SERVING REVISION LAST DEPLOYED BY LAST DEPLOYED AT
✔ buttons us-central1 buttons-00001 buttons-00001 mchmarny@*****.com 2019-06-01T00:10:06.059Z
```
You can also test the deployed service using `curl`. Just make sure you replace the `***` part of the URL with the actual `URL` returned by the above command.
```shell
curl -H "content-type: application/json" -H "token: ${SECRET}" \
-d '{ "version": "v0.1.0", "type": "button", "color": "white", "click": 1 }' \
-X POST https://buttons-*******-uc.a.run.app
```
You can always find the URL of your `buttons` service by executing the following command
```shell
gcloud beta run services describe buttons --region us-central1 --format 'value(status.domain)'
```
## Configuring Flic Button
To setup Flic buttons on your device follow the [quick start instructions](https://start.flic.io/). Each one of the Flic buttons come with many [pre-programmed actions](https://flic.io/all-functions). To execute above configured Cloud Run service though we will use the `Internet Request` action.
To do that you will need to select one of your buttons on your device, expand the `Advanced` category, and configure an action for either `single`, `double`, or `hold` click.
That will get you to the `HTTP Internet Request` action configuration screen
Few parameters to configure here:
| Parameter | Description |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| **URL** | Enter the full URL of the Cloud Run Service |
| **Method** | Select `POST` |
| **Content Type** | Enter `application/json` |
| **Body** | Enter your JSON message to send to the service (e.g. `{ "type": "button", "color": "white", "click": 1 }`) |
| **HTTP Header** | Kye: `token`, Value: the value of the previously defined `SECRET`. Make sure you click the `Insert` button to "save" the header parameter |
When done entering the above parameters, click `Done` in upper right corner to save the entire action. Now your Flic button is configured for use with Cloud Run.
## Demo
Assuming all the above deployment steps were completed successfully, you should be able to click the button and see the following in GCP service:
1. **Cloud Run UI in service log**
1. **Cloud Run UI metrics charts**
3. **Stackdriver PubSub topic (`clikc`) metric chart**
## Summary
Hopefully this demo gave you an idea on how to connect your Flic buttons and many other IoT devices to Cloud Run service. With the basic implementation in place we can start working on more creative solutions next.
## Disclaimer
This is my personal project and it does not represent my employer. I take no responsibility for issues caused by this code. I do my best to ensure that everything works, but if something goes wrong, my apologies is all you will get.