Go tool that migrates devices from Google IoT Core registries to ClearBlade device table
This tool is designed to move devices after you have already enabled the ClearBlade offering in the Google Cloud marketplace and have connected your project. If you haven't done that already, refer the folowing documents to -
This tool allows multiple CLI flags for starting the migration. See the below chart for available start options as well as their defaults.
| Name | CLI Flag | Default | Required |
|---|---|---|---|
| Path to ClearBlade Service Account File (see here for more info) | cbServiceAccount |
N/A | Yes |
| ClearBlade Registry Name | cbRegistryName |
N/A | Yes |
| ClearBlade Registry Region | cbRegistryRegion |
<gcpRegistryRegion> |
No |
| Google IoT Core Registry Name | gcpRegistryName |
N/A | Yes |
| Google IoT Core Registry Region | gcpRegistryRegion |
N/A | Yes |
| GCP Service account file path | gcpServiceAccount |
N/A | Yes |
| Device to migrate CSV file path | devicesCsv |
N/A | No |
| Update public keys for existing devices | updatePublicKeys |
true |
No |
| Store Config Version History | configHistory |
false |
No |
| Skip Migrating Latest Config | skipConfig |
false |
No |
Create a service account by following this guide
Install & run the latest binary from https://github.com/ClearBlade/clearblade-iot-core-migration/releases.
clearblade-iot-core-migration -cbServiceAccount <JSON_FILE_PATH> -cbRegistryName <CB_IOT_CORE_REGISTRY> -cbRegistryRegion <CB_PROJECT_REGION> -gcpServiceAccount <JSON_FILE_PATH> -gcpRegistryName <IOT_CORE_REGISTRY> -gcpRegistryRegion <GCP_PROJECT_REGION>
You will be prompted to enter a devices CSV file path that would be used to migrate devices specified in the CSV file. You can skip this step by pressing enter and by default all devices from the registry will be migrated.
Note - We recommend you to use linux or darwin binaries. It's unlikely but possible something could fail during the migration. A failed_devices CSV file will be created at the end of this migration. Please submit this file to the ClearBlade Support and we will ensure 100% success
Running this tool in a GCloud instance in the same region as your registry will speed up the migration process.
When migrating GATEWAYS the tool checks that bound DEVICES exist, creates those DEVICES if they don't exist and binds them to the GATEWAYS.
Rerunning the tool against previously migrated DEVICES and GATEWAYS will UPDATE them, if needed, and skip them if not. This includes updating GATEWAY to DEVICE associations (bindings).
The tool was written in Go and therefore requires Go to be installed (https://golang.org/doc/install). In order to compile the tool for execution, the following steps need to be performed:
- Retrieve the migration tool source code
git clone git@github.com:ClearBlade/clearblade-iot-core-migration.git
- Navigate to the clearblade-iot-core-migration directory
cd clearblade-iot-core-migration
- Compile the tool for your needed architecture and OS
GOARCH=arm GOARM=5 GOOS=linux go build
In order to release a new version, the following steps need to be performed:
- Commit and push your changes to the master branch
- Add a new tag to the new commit
git tag -m "Release v1.0.0" v1.0.0 <commit_id>
- Push tags
git push --tags
- Goreleaser and github actions will take care of releasing new binaries
If you have any questions or errors using this tool, please feel free to open tickets on our IoT Core Support Desk