Add README for samples

Author: archigup

CMakeLists.txt

@@ -196,6 +196,9 @@ if(PROJECT_IS_TOP_LEVEL)
   if(BUILD_SAMPLES)
     file(GLOB SAMPLE_DIRS CONFIGURE_DEPENDS "samples/*")
     foreach(sample_dir ${SAMPLE_DIRS})
+      if(NOT IS_DIRECTORY ${sample_dir})
+        continue()
+      endif()
       get_filename_component(sample_name ${sample_dir} NAME_WLE)
       set_property(
         SOURCE ${sample_dir}/main.c

README.md

@@ -35,6 +35,9 @@ The following Greengrass v2 IPC operations are currently supported by this SDK:
 
 ## Sample Generic Components
 
+For deployment instructions, see the
+[samples deployment guide](samples/README.md).
+
 - [IoT Core MQTT Pub/Sub](samples/iot_core_mqtt/)
 - [Update State](samples/update_state/)
 - [Configuration Operations](samples/config/)

cpp/CMakeLists.txt

@@ -41,6 +41,9 @@ if(aws-greengrass-sdk-lite_IS_TOP_LEVEL)
   if(BUILD_SAMPLES)
     file(GLOB SAMPLE_DIRS CONFIGURE_DEPENDS "samples/*")
     foreach(sample_dir ${SAMPLE_DIRS})
+      if(NOT IS_DIRECTORY ${sample_dir})
+        continue()
+      endif()
       get_filename_component(sample_name ${sample_dir} NAME_WLE)
       set_property(
         SOURCE ${sample_dir}/main.cpp

misc/dictionary.txt

@@ -3,6 +3,7 @@ cbmc
 coverity
 dfcc
 EPOLLIN
+fileb
 ggipc
 greengrassv2
 iwyu

samples/README.md

@@ -0,0 +1,54 @@
+# Deploying Samples to Greengrass
+
+> **Note:** All deployment steps can be performed through the AWS Console. The
+> following are CLI instructions.
+
+## Prerequisites
+
+- Built samples (see [../docs/BUILD.md](../docs/BUILD.md))
+- AWS CLI configured with appropriate credentials
+- S3 bucket for component artifacts
+- Greengrass thing group
+
+## Deployment Steps
+
+### 1. Upload Sample Binary to S3
+
+```bash
+aws s3 cp result/bin/sample_<name> s3://YOUR_BUCKET/ggl-sdk-samples/sample_<name>
+```
+
+### 2. Update Recipe with S3 Location
+
+Copy the sample's `recipe.yml` and update the artifact URI:
+
+```bash
+cd samples/<sample_name>
+cp recipe.yml recipe-deploy.yml
+# Edit recipe-deploy.yml and replace:
+# URI: s3://EXAMPLE_BUCKET/sample_<name>
+# with:
+# URI: s3://YOUR_BUCKET/ggl-sdk-samples/sample_<name>
+```
+
+### 3. Create Component Version
+
+```bash
+aws greengrassv2 create-component-version \
+  --inline-recipe fileb://recipe-deploy.yml \
+  --region YOUR_REGION
+```
+
+### 4. Deploy to Thing Group
+
+```bash
+aws greengrassv2 create-deployment \
+  --target-arn "arn:aws:iot:YOUR_REGION:ACCOUNT_ID:thinggroup/YOUR_THING_GROUP" \
+  --deployment-name "SampleDeployment" \
+  --components '{
+    "COMPONENT_NAME": {
+      "componentVersion": "VERSION"
+    }
+  }' \
+  --region YOUR_REGION
+```

samples/subscribe_to_configuration_update/README.md

@@ -5,94 +5,56 @@ Greengrass component.
 
 ## Overview
 
-The sample subscribes to it's own configuration updates and prints notifications
+The sample subscribes to its own configuration updates and prints notifications
 whenever the configuration changes. This is useful for components that need to
 react to configuration changes in real-time.
 
-## Building
-
-Build the sample from the project root:
-
-```sh
-cmake -B build -D CMAKE_BUILD_TYPE=MinSizeRel -D BUILD_SAMPLES=ON
-make -C build -j$(nproc)
-```
-
-The binary will be available at
-`./build/bin/sample_subscribe_to_configuration_update`.
-
 ## Usage
 
 ### ⚠️ Important Notice ⚠️
 
 Always subscribe to configuration updates before calling GetConfiguration to
 ensure you don't miss any updates.
 
-### Deployment
+### Testing Configuration Updates
 
-Deploy this component using the provided `recipe.yml`. Update the S3 bucket
-location in the recipe before deployment.
+After deploying the component, update its configuration to trigger the
+subscription callback.
 
-### Step by Step guide
+**Using AWS Console:**
 
-1. Deploy the Component to your Greengrass device. A detailed guid can be found
-   [here](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html).
-
-2. Check the initial logs:
-
-   ```sh
-   journalctl -fau ggl.aws-greengrass-sdk-lite.samples.subscribe_to_configuration_update.service
+1. Navigate to AWS IoT Greengrass console
+2. Select `Deployments` and find the deployment targeting your thing group
+3. Click `Actions` > `Revise` > `Next` > `Next`
+4. Find `aws-greengrass-sdk-lite.samples.SubscribeToConfigurationUpdate` in the
+   component list
+5. Click `Configure component`
+6. Under `Configuration to merge`, add:
+   ```json
+   {
+     "test_str": "updated_value"
+   }
    ```
+7. Click `Confirm` > `Next` > `Deploy`
 
-3. Revise the deployment to update the `test_str` configuration value in the
-   `aws-greengrass-sdk-lite.samples.SubscribeToConfigurationUpdate` component
-   using the AWS Console:
-   - Navigate to AWS IoT Greengrass console
-   - Select `Deployments` and find the deployment targeting your device/group.
-   - Click `Actions` > `Revise` > `Revise Deployments` > `Next` > `Next`.
-   - Find `aws-greengrass-sdk-lite.samples.SubscribeToConfigurationUpdate` in
-     the component list
-   - Click `Configure component`
-   - Under `Configuration to merge`, add:
-
-     ```json
-     {
-       "test_str": "updated_value"
-     }
-     ```
-
-   - Click `Confirm` and then `Next` through the remaining steps
-   - Click `Deploy` to apply the changes
+**Using AWS CLI:**
 
-4. After the deployment completes, check the logs again. You should see the
-   callback triggered with a message indicating the configuration update was
-   received
-
-5. The callback handler will print the component name and key paths that were
-   updated
-
-The sample subscribes to the `test_str` key path. To subscribe to all
-configuration updates, use an empty key path list.
-
-#### Alternative: Using AWS CLI
-
-To update configuration using AWS CLI:
-
-```sh
+```bash
 aws greengrassv2 create-deployment \
-  --target-arn "arn:aws:iot:REGION:ACCOUNT_ID:thinggroup/THING_GROUP_NAME" \
+  --target-arn "arn:aws:iot:REGION:ACCOUNT_ID:thinggroup/YOUR_THING_GROUP" \
   --components '{
     "aws-greengrass-sdk-lite.samples.SubscribeToConfigurationUpdate": {
       "componentVersion": "VERSION",
       "configurationUpdate": {
         "merge": "{\"test_str\":\"updated_value\"}"
       }
     }
-  }'
+  }' \
+  --region YOUR_REGION
 ```
 
-Replace `REGION`, `ACCOUNT_ID`, `THING_GROUP_NAME`, and `VERSION` with your
-values.
+The sample subscribes to the `test_str` key path. To subscribe to all
+configuration updates, use an empty key path list.
 
 ## Known Issues