greengrass: Modularize plugin architecture

Restructure greengrass recipes to support a modular plugin
design, separating each plugin into its own recipe that can
inherit a common bbclass to install the plugin jar + config
fragment.

This allows easier extension with new plugins.

Signed-off-by: Mariam Elshakfy <[email protected]>

Author: mariam-elshakfy

classes/greengrass-common.inc

@@ -0,0 +1,4 @@
+# Common Greengrass definitions
+
+GG_BASENAME = "greengrass/v2"
+GG_ROOT = "${D}/${GG_BASENAME}"

classes/greengrass-plugin.bbclass

@@ -0,0 +1,31 @@
+# Common installation logic for AWS Greengrass plugins
+# Requires:
+#   PLUGIN_SRC_NAME  - JAR filename in ${UNPACKDIR}
+#   PLUGIN_NAME       - target filename under plugins/trusted
+
+require greengrass-common.inc
+
+inherit deploy
+
+S = "${UNPACKDIR}"
+
+do_install() {
+    # Install plugin jar
+    install -d ${GG_ROOT}/plugins
+    install -d ${GG_ROOT}/plugins/trusted
+    install --m 0755 ${UNPACKDIR}/${PLUGIN_SRC_NAME} \
+            ${GG_ROOT}/plugins/trusted/${PLUGIN_NAME}
+}
+
+do_deploy() {
+    # Configurations will be merged in greengrass-bin:do_install later,
+    # so make them shared.
+    if [ -e ${UNPACKDIR}/config.yaml.template ]; then
+        install -d ${DEPLOYDIR}/greengrass-plugin-fragments
+        cp "${UNPACKDIR}/config.yaml.template" "${DEPLOYDIR}/greengrass-plugin-fragments/${PLUGIN_NAME}.yaml"
+    fi
+}
+addtask deploy after do_install before do_populate_sysroot
+
+FILES:${PN} += "/${GG_BASENAME}/plugins/ \
+               "

recipes-iot/aws-iot-greengrass/greengrass-bin/config.yaml.template

@@ -5,18 +5,4 @@ services:
       awsRegion: "${AWS_DEFAULT_REGION}"
       runWithDefault:
         posixUser: "${PROXY_USER}"
-  aws.greengrass.FleetProvisioningByClaim:
-    configuration:
-      rootPath: "/greengrass/v2"
-      awsRegion: "${AWS_DEFAULT_REGION}"
-      iotDataEndpoint: "${IOT_DATA_ENDPOINT}"
-      iotCredentialEndpoint: "${IOT_CRED_ENDPOINT}"
-      iotRoleAlias: "${TE_ROLE_ALIAS}"
-      provisioningTemplate: "${FLEET_PROVISIONING_TEMPLATE_NAME}"
-      claimCertificatePath: "${CLAIM_CERT_PATH}"
-      claimCertificatePrivateKeyPath: "${CLAIM_KEY_PATH}"
-      rootCaPath: "${ROOT_CA_PATH}"
-      templateParameters:
-        ThingName: "${THING_NAME}_<unique>"
-        ThingGroupName: "${THING_GROUP_NAME}"
 ---

recipes-iot/aws-iot-greengrass/greengrass-bin_2.14.1.bb

@@ -3,11 +3,7 @@ DESCRIPTION = "The Greengrass nucleus component provides functionality for devic
 HOMEPAGE = "https://github.com/aws-greengrass/aws-greengrass-nucleus"
 LICENSE = "Apache-2.0"
 
-GG_BASENAME = "greengrass/v2"
-GG_ROOT = "${D}/${GG_BASENAME}"
-# GGV2_FLEETPROVISIONING_VERSION ?= "latest"
-GGV2_FLEETPROVISIONING_VERSION ?= "1.2.2"
-GGV2_FLEET_PROVISIONING_TEMPLATE_NAME ?= "GreengrassFleetProvisioningTemplate"
+require classes/greengrass-common.inc
 
 LIC_FILES_CHKSUM = "file://${UNPACKDIR}/greengrass-bin/LICENSE;md5=34400b68072d710fecd0a2940a0d1658"
 
@@ -16,35 +12,29 @@ DEPENDS += "gettext-native"
 # enable fleetprovisioning for testing by default to get test coverage
 PACKAGECONFIG ??= "${@bb.utils.contains('PTEST_ENABLED', '1', 'fleetprovisioning', '', d)}"
 
-# this is to make the PACKAGECONFIG QA check happy
-PACKAGECONFIG[fleetprovisioning] = ""
+PACKAGECONFIG[fleetprovisioning] = ",,greengrass-plugin-fleetprovisioning,greengrass-plugin-fleetprovisioning"
 
 SRC_URI = "\
     https://d2s8p88vqu9w66.cloudfront.net/releases/greengrass-${PV}.zip;subdir=greengrass-bin \
     file://greengrassv2-init.yaml \
     file://run-ptest \
+    file://config.yaml.template \
     "
 
 SRC_URI:append = " ${@bb.utils.contains('PACKAGECONFIG', 'fleetprovisioning', '\
-    https://d2s8p88vqu9w66.cloudfront.net/releases/aws-greengrass-FleetProvisioningByClaim/fleetprovisioningbyclaim-${GGV2_FLEETPROVISIONING_VERSION}.jar;name=fleetprovisioning;unpack=0 \
-    file://config.yaml.template \
-    file://replace_board_id.sh \
-    file://claim.pkey.pem \
-    file://claim.cert.pem \
-    file://claim.root.pem \
     file://loader.patch \
     file://greengrass.service.patch \
     ', '', d)}"
 
 SRC_URI[sha256sum] = "a7cbc3cee5d245bfac9c49a036a482884898edbeb2f1e6fb27d17e9321007ce8"
-SRC_URI[fleetprovisioning.sha256sum] = "1e7fdc625d4e1e7795d63f0e97981feecad526277bf211154505de145009e8c1"
 UPSTREAM_CHECK_REGEX ?= "releases/tag/v?(?P<pver>\d+(\.\d+)+)"
 
 UPSTREAM_CHECK_URI = "https://github.com/aws-greengrass/aws-greengrass-nucleus/tags"
 
 GG_USESYSTEMD = "${@bb.utils.contains('DISTRO_FEATURES', 'systemd', 'yes', 'no', d)}"
 
 inherit systemd useradd ptest pkgconfig
+DEPENDS:append = " yq-native"
 
 S = "${UNPACKDIR}/greengrass-bin"
 
@@ -76,7 +66,7 @@ do_install() {
     ln -s /${GG_BASENAME}/packages/artifacts-unarchived/aws.greengrass.Nucleus/${PV}/aws.greengrass.nucleus ${GG_ROOT}/alts/init/distro
 
     install -m 0440 ${S}/LICENSE                         ${GG_ROOT}
-    install -m 0640 ${S}/../greengrassv2-init.yaml          ${GG_ROOT}/config/config.yaml.clean
+    install -m 0640 ${S}/../greengrassv2-init.yaml       ${GG_ROOT}/config/config.yaml.clean
     install -m 0640 ${S}/bin/greengrass.service.template ${GG_ROOT}/packages/artifacts-unarchived/aws.greengrass.Nucleus/${PV}/aws.greengrass.nucleus/bin/greengrass.service.template
     install -m 0750 ${S}/bin/loader                      ${GG_ROOT}/packages/artifacts-unarchived/aws.greengrass.Nucleus/${PV}/aws.greengrass.nucleus/bin/loader
     install -m 0640 ${S}/conf/recipe.yaml                ${GG_ROOT}/packages/artifacts-unarchived/aws.greengrass.Nucleus/${PV}/aws.greengrass.nucleus/conf/recipe.yaml
@@ -90,37 +80,23 @@ do_install() {
     sed -i -e "s,REPLACE_WITH_GG_LOADER_FILE,/${GG_BASENAME}/alts/current/distro/bin/loader,g" ${D}${systemd_unitdir}/system/greengrass.service
     sed -i -e "s,REPLACE_WITH_GG_LOADER_PID_FILE,/var/run/greengrass.pid,g" ${D}${systemd_unitdir}/system/greengrass.service
 
-    if ${@bb.utils.contains('PACKAGECONFIG','fleetprovisioning','true','false',d)}; then
-
-        install -d ${GG_ROOT}/claim-certs
-        install -d ${GG_ROOT}/plugins
-        install -d ${GG_ROOT}/plugins/trusted
-        install -m 0440 ${UNPACKDIR}/claim.pkey.pem ${GG_ROOT}/claim-certs
-        install -m 0440 ${UNPACKDIR}/claim.cert.pem ${GG_ROOT}/claim-certs
-        install -m 0440 ${UNPACKDIR}/claim.root.pem ${GG_ROOT}/claim-certs
-
-        install -m 0740 ${UNPACKDIR}/fleetprovisioningbyclaim-${GGV2_FLEETPROVISIONING_VERSION}.jar ${GG_ROOT}/plugins/trusted/aws.greengrass.FleetProvisioningByClaim.jar
-
-        install -m 0755 ${UNPACKDIR}/replace_board_id.sh ${GG_ROOT}/config/
-
-        install -m 0640 ${UNPACKDIR}/config.yaml.template ${GG_ROOT}/config/config.yaml
-
-        AWS_DEFAULT_REGION=${GGV2_REGION} \
-        PROXY_USER=ggc_user:ggc_group \
-        IOT_DATA_ENDPOINT=${GGV2_DATA_EP} \
-        IOT_CRED_ENDPOINT=${GGV2_CRED_EP} \
-        TE_ROLE_ALIAS=${GGV2_TES_RALIAS} \
-        FLEET_PROVISIONING_TEMPLATE_NAME=${GGV2_FLEET_PROVISIONING_TEMPLATE_NAME} \
-        CLAIM_CERT_PATH=/${GG_BASENAME}/claim-certs/claim.cert.pem \
-        CLAIM_KEY_PATH=/${GG_BASENAME}/claim-certs/claim.pkey.pem \
-        ROOT_CA_PATH=/${GG_BASENAME}/claim-certs/claim.root.pem \
-        THING_NAME=${GGV2_THING_NAME} \
-        THING_GROUP_NAME=${GGV2_THING_GROUP} \
-        envsubst < ${UNPACKDIR}/config.yaml.template > ${GG_ROOT}/config/config.yaml
-    fi
+    # Install base config.yml
+    AWS_DEFAULT_REGION=${GGV2_REGION} \
+    PROXY_USER=ggc_user:ggc_group \
+    envsubst < ${UNPACKDIR}/config.yaml.template > ${GG_ROOT}/config/config.yaml
 }
 
-CONFFILES:${PN} += "/${GG_BASENAME}/config/config.yaml.clean"
+do_merge_config() {
+    # Merge config fragments
+    yq eval-all '. as $item ireduce ({}; . * $item)' \
+                "${GG_ROOT}/config/config.yaml" \
+                "${DEPLOY_DIR_IMAGE}/greengrass-plugin-fragments/"*.yaml \
+                > "${GG_ROOT}/config/config.yaml.tmp"
+
+    mv "${GG_ROOT}/config/config.yaml.tmp" "${GG_ROOT}/config/config.yaml"
+
+}
+addtask merge_config after do_install before do_package
 
 SYSTEMD_AUTO_ENABLE = "enable"
 SYSTEMD_SERVICE:${PN} = "greengrass.service"

recipes-iot/aws-iot-greengrass/greengrass-common.inc

@@ -0,0 +1,4 @@
+GG_BASENAME = "greengrass/v2"
+GG_ROOT = "${D}/${GG_BASENAME}"
+GG_CONFIG = "${GG_ROOT}/config"
+${GG_ROOT}/plugins = "${GG_ROOT}/plugins"

recipes-iot/aws-iot-greengrass/greengrass-bin/claim.cert.pem renamed to recipes-iot/aws-iot-greengrass/greengrass-plugin-fleetprovisioning/claim.cert.pem

@@ -0,0 +1,15 @@
+services:
+  aws.greengrass.FleetProvisioningByClaim:
+    configuration:
+      rootPath: "/greengrass/v2"
+      awsRegion: "${AWS_DEFAULT_REGION}"
+      iotDataEndpoint: "${IOT_DATA_ENDPOINT}"
+      iotCredentialEndpoint: "${IOT_CRED_ENDPOINT}"
+      iotRoleAlias: "${TE_ROLE_ALIAS}"
+      provisioningTemplate: "${FLEET_PROVISIONING_TEMPLATE_NAME}"
+      claimCertificatePath: "${CLAIM_CERT_PATH}"
+      claimCertificatePrivateKeyPath: "${CLAIM_KEY_PATH}"
+      rootCaPath: "${ROOT_CA_PATH}"
+      templateParameters:
+        ThingName: "${THING_NAME}_<unique>"
+        ThingGroupName: "${THING_GROUP_NAME}"