From cc456cc934d98986b35e0472062c559ca202af60 Mon Sep 17 00:00:00 2001 From: Arpit Patawat Date: Wed, 18 Dec 2024 00:18:31 +0530 Subject: [PATCH 1/3] update setup readme for missing root CA and realign the steps in correct order --- docs/SETUP.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/SETUP.md b/docs/SETUP.md index 281694720..f474c5f5e 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -49,13 +49,14 @@ Configure the following in your config file - privateKeyPath: Path to private key for the Thing - certificateFilePath: Path to Thing certificate -- thingName: Name of the Thing +- rootCaPath: Path to Amazon Root CA certificate - rootPath: Absolute path to the Greengrass rootpath directory +- thingName: Name of the Thing - awsRegion: The AWS region with the Thing - iotCredEndpoint: The IoT Core endpoint - iotDataEndpoint: The IoT Core endpoint -- posixUser: Colon separated user/group that generic components should run as - iotRoleAlias: The name of the role alias for accessing TES +- posixUser: Colon separated user/group that generic components should run as `posixUser` must be set to a valid user and group. If no colon and group is provided, the user's default group is used. If not running Greengrass as root, From 5fd6a67543b1bf3972612b2af5ffd4a5d16e8c8c Mon Sep 17 00:00:00 2001 From: Arpit Patawat Date: Wed, 18 Dec 2024 00:32:04 +0530 Subject: [PATCH 2/3] change the sample config to yaml extension and update missing documentation for copying the file --- docs/SETUP.md | 11 +++++++---- ..._nucleus_config.yml => sample_nucleus_config.yaml} | 0 2 files changed, 7 insertions(+), 4 deletions(-) rename docs/examples/{sample_nucleus_config.yml => sample_nucleus_config.yaml} (100%) diff --git a/docs/SETUP.md b/docs/SETUP.md index f474c5f5e..cb6c74d1a 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -38,12 +38,15 @@ Choose one or the other. To configure Greengrass, you will need a config YAML file, in the same format as the Classic nucleus config. An example config file is available in -[`doc/examples/sample_nucleus_config.yml`](examples/sample_nucleus_config.yml). +[`docs/examples/sample_nucleus_config.yaml`](examples/sample_nucleus_config.yaml). If this is the first time you are creating a GG device, please follow the instruction in the [TES setup instructions](./TES.md) to get a role alias, thing, certificate, private key, and endpoints for your device. -Make a copy of the [sample configuration](./examples/sample_nucleus_config.yml). +Make a copy of the [sample configuration](./examples/sample_nucleus_config.yaml) as `config.yaml`. +```sh +cp docs/examples/sample_nucleus_config.yaml ./config.yaml +``` Configure the following in your config file @@ -68,11 +71,11 @@ as `/etc/greengrass/config.yaml`, and/or in one or more files in The config daemon will initially load `/etc/greengrass/config.yaml` and then update the initial configuration with any other config files present in -`/etc/greengrass/config.d/` +`/etc/greengrass/config.d/`. Copy your configuration file to the above directory ( Note: you might need to run with `sudo` in case you are getting `permission denied` error) - ```sh mkdir -p /etc/greengrass -cp ./init_config.yml /etc/greengrass/config.yaml +cp ./config.yaml /etc/greengrass/config.yaml ``` ## Running the nucleus diff --git a/docs/examples/sample_nucleus_config.yml b/docs/examples/sample_nucleus_config.yaml similarity index 100% rename from docs/examples/sample_nucleus_config.yml rename to docs/examples/sample_nucleus_config.yaml From 1f6174a4cad076cbe0d916185b9e69f0d88fd705 Mon Sep 17 00:00:00 2001 From: Arpit Patawat Date: Wed, 18 Dec 2024 07:37:33 +0000 Subject: [PATCH 3/3] fix nix formatting issue --- docs/SETUP.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/SETUP.md b/docs/SETUP.md index cb6c74d1a..2180686ea 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -43,7 +43,9 @@ If this is the first time you are creating a GG device, please follow the instruction in the [TES setup instructions](./TES.md) to get a role alias, thing, certificate, private key, and endpoints for your device. -Make a copy of the [sample configuration](./examples/sample_nucleus_config.yaml) as `config.yaml`. +Make a copy of the [sample configuration](./examples/sample_nucleus_config.yaml) +as `config.yaml`. + ```sh cp docs/examples/sample_nucleus_config.yaml ./config.yaml ``` @@ -71,7 +73,9 @@ as `/etc/greengrass/config.yaml`, and/or in one or more files in The config daemon will initially load `/etc/greengrass/config.yaml` and then update the initial configuration with any other config files present in -`/etc/greengrass/config.d/`. Copy your configuration file to the above directory ( Note: you might need to run with `sudo` in case you are getting `permission denied` error) - +`/etc/greengrass/config.d/`. Copy your configuration file to the above directory +( Note: you might need to run with `sudo` in case you are getting +`permission denied` error) - ```sh mkdir -p /etc/greengrass