...
This guide provides instructions for installing and configuring the Smart Data Transaction for CPS blueprint, and also includes recommended hardware and software requirements for the blueprint. The guide describes a minimal installation of the blueprint consisting of a single "master" node and two "edge" nodes, with directions on how the number of nodes can be modified as needed.
How to Use This Document
This document assumes the reader is familiar with basic UNIX command line utilities and Kubernetes. Familiarity with Ansible and Docker may also be useful.
Start by reviewing the deployment architecture and requirements in the following sections, then follow the steps in the Installation section to set up the software and start it running. Confirm the services are functioning as expected by following the instructions in the Verifying the Setup section. The later sections in this document
Deployment Architecture
Pre-Installation Requirements
Hardware Requirements
Network Requirements
Software Prerequisites
Installation
...
Creating the Settings Files
Installation
Setting Up the Deploy Node
Preparing the Master Node
Creating the Docker Registry
Preparing Edge Nodes
Starting the Cluster
Adding Edge Nodes to the Cluster
Starting EdgeX
...
Verifying the Setup
as defined the Akraino validation feature project plus any additional testing specific to the blue print
Developer Guide and Troubleshooting
Uninstall Guide
Troubleshooting
Maintenance
...
Blue Print Package Maintenance
- Software maintenance
- Hardware maintenance
Developer Guide and Troubleshooting
Changing Configuration
Debugging Failures
Reporting a Bug
Uninstall Guide
Stopping EdgeX
Removing Edge Nodes
Stopping Kubernetes
Stopping the Docker Registry
Uninstalling Software Components
Removing Configuration and Temporary Data
Troubleshooting
Confirming Node and Service Status
Accessing Logs
Maintenance
Accessing EdgeX Service Configuration
Stopping and Restarting EdgeX Services
Stopping and Restarting the Kubernetes Cluster
Adding and Removing Edge Nodes
Updating the Software
Rebuilding Custom Services
...
License
The software provided as part of the Smart Data Transaction for CPS blueprint is licensed under the Apache License, Version 2.0 (the "License");
...
The synchronization application is linked with the following packages when compiled:
| Package | License Type | License URL |
|---|
githubcomhashicorpgo-hcloggithubcomhashicorpgo-hclogblobmattncolorablemattncolorablemattngo-isattymattngo-isattyhashicorp/golang-lru/simplelruMPL-2.0hashicorpgolang-lru/simplelrumitchellh/consulstructureMITmitchellh/consulstructurebitbucketorg/bertimus9/systemstatMITbitbucketorg/bertimus9/systemstat/src/master/diegoholiveira/jsonlogicdiegoholiveira/jsonlogic/google/uuidBSD-3-Clausegoogle/uuidhashicorpimmutableradixMPLhashicorpimmutableradix/mitchellh/reflectwalkMITmitchellh/reflectwalkplayground/universal-translatorMITplayground/universaltranslator/x448/float16MITx448/float16hashicorperrwrapMPL-2.0hashicorperrwrapgomoduleredigoApache-2.0gomoduleredigomitchellhcopystructuremitchellhcopystructurefxamacker/cbor/v2fxamackercbor/v2go-kit/kit/logMITgo-kitkit/loggo-logfmtlogfmtMITgo-logfmtlogfmtpelletier/tomlApache-2.0/pelletiertomlhashicorpgocleanhttpMPL-2.0/hashicorpcleanhttpfatihcolorfatihcolor.mdhashicorp/rootcertsMPL.0/hashicorprootcertseclipse/paho.mqtt.golangeclipse/paho.mqtt.golanggolangorgxcrypto/sha33pkg.go.dev/golang.org/x/crypto/sha3?tab=licensespebbezmq4BSD-Clausepebbezmq4.txtcom/edgexfoundry/go-mod-core-contracts/v2Apacheedgexfoundry/go-mod-core-contracts/v2playground/localesMITplayground/localesleodidournleodidournedgexfoundrymodbootstrap/v2Apacheedgexfoundrymodbootstrap/v2serfcoordinateserfcoordinatemitchellhmapstructureMITmitchellhmapstructuregorillawebsocketBSD-Clausegorillawebsocket.com/edgexfoundry/app-functions-sdk-go/v2/internal/etmMITedgexfoundry/app-functions-sdk-gov2/internal/etmedgexfoundryapp-functions-sdk-go/v2Apache-2.0edgexfoundryapp-functions-sdk-go/v2edgexfoundrymod-secrets/v2Apache-2.0edgexfoundrymod-secrets/v2hashicorp/consul/apiMPL-2.0hashicorpconsul/apigolangorgxsysBSD-3-Clausepkg.go.dev/golang.org/x/sys?tab=licensescenkaltibackoffcenkaltibackoffgorillamuxBSD-3-Clausegorillamuxgo-redis/redis/v7BSD-2-Clausego-redisredis/v7go-playground/validator/v10MITgo-playgroundvalidator/v10golangorgxtextBSD-3-Clausepkggo.dev/golang.org/x/text?tab=licensesarmongo-metricsarmongo-metricsgithubcomedgexfoundry/go-mod-registry/v2Apache-2.0githubcomedgexfoundry/go-mod-registry/blob/master/v2/LICENSEgithub.com/hashicorp/go-multierror | MPL-2.0githubcom/hashicorp/go-multierror/blob/master/LICENSEgithub.com/edgexfoundry/go-mod-messaging/v2 | Apache-2.0githubcom/edgexfoundry/go-mod-messaging/blob/master/v2/LICENSEnetnetLoRa Device Service
The LoRa device service is linked with the following packages when compiled:
License URLhashicorpgolanglru/simplelruMPL-2.0hashicorpgolanglru/simplelruhashicorperrwrapMPL-2.0hashicorperrwrapgolangorgx/textpkg.go.dev/golang.org/x/text?tab=licensesgomodsecretsgomodsecretsgorillawebsocketBSD2-Clause| https://github.com/gorilla/websocket/blob/master/LICENSE | github.com/armon/go-metrics | MITarmonmetricshashicorp/serf/coordinateMPLhashicorp/serfcoordinate/tarm/serialBSD-3-Clausetarm/seriallogfmtlogfmtMITlogfmt/logfmtbootstrapbootstrap/eclipse/paho.mqtt.golangBSD-3-Clauseeclipse/paho.mqtt.golanghashicorpgo-cleanhttpMPL-2.0hashicorpgo-cleanhttpgolangorgxnetBSD-3-Clausepkg.go.dev/golang.org/x/net?tab=licenses/edgexfoundrymod-registry/v2Apache-2.0/edgexfoundrymod-registryv2gorillamuxBSD-3-Clausegorillamuxedgexfoundry/go-mod-core-contracts/v2Apache-2.0edgexfoundry/go-mod-core-contracts/v2validator/v10validator/v10hashicorpgorootcertsMPL-2.0hashicorpgorootcertsgopkg.in/yaml.v3yamlyamlv3google/uuid3googleuuidpelletiergo-tomlApache-2.0pelletiergo-tomlx448/float16MITx448float16fatihcolorMITfatihcolor.mdgolangorgxsysBSD-3-Clausepkggo.dev/golang.org/x/sys?tab=licensesimmutable-radixMPL-2.0immutable-radixedgexfoundrydevicesdkgo/v2Apacheedgexfoundrydevicesdkgo/v2gokitkit/logMITgokit/kitlogedgexfoundrymod-messaging/v2Apacheedgexfoundrymod-messaging/v2edgexfoundrymod-configuration/v2Apacheedgexfoundrymod-configuration/v2mitchellhcopystructureMITmitchellhcopystructurebitbucketorgbertimus9systemstatbitbucketorgbertimus9systemstatsrchashicorpmultierrorMPL-2.0hashicorpmultierrorpebbezmq4BSD-2-Clausepebbezmq4.txtmattngo-colorablemattngo-colorablemapstructuremapstructureOneOfOnexxhashApache-2.0OneOfOnexxhashgo-playground/universal-translatorgo-playground/universal-translatorleodidogo-urnMIT | leodidogo-urngolangorgx/cryptosha33pkg.go.dev/golang.org/x/crypto/sha3?tab=licensesredis/redis/v7BSD-Clauseredisredis//v7mitchellhconsulstructureMITmitchellhconsulstructurecenkaltibackoffcenkaltibackoffgithubcommitchellhreflectwalkMITgithubcommitchellhreflectwalkblob/master/LICENSEgithub.com/fxamacker/cbor/v2 | MITgithubcomfxamackercbor/blob/master/v2/LICENSEgithub.com/go-playground/locales | MITgithubcom/-playground/locales/blob/master/LICENSEgithub.com/hashicorp/go-hclog | MITgithubcom/hashicorp/go-hclog/blob/master/LICENSEgithub.com/mattn/go-isattymattn/isattymaster References
Definitions, Acronyms and Abbreviations