Skip to content

Commit bd00ab8

Browse files
committed
Update documentation to cover both nucleus
1 parent e65d51d commit bd00ab8

File tree

2 files changed

+34
-4
lines changed

2 files changed

+34
-4
lines changed

docs/BUILD.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,21 @@ components
6868
│ ├── secure-tunnel
6969
│ └── localproxy
7070
└── recipes
71-
└── aws.greengrass.SecureTunneling-1.0.0.yaml
71+
└── aws.greengrass.SecureTunneling-2.0.0.yaml
7272
```
7373

7474
### For cloud deployment
7575

7676
For Greengrass Cloud deployment, create a zip file with this structure:
7777

7878
```
79-
aws.greengrass.SecureTunneling-1.0.0.zip
79+
aws.greengrass.SecureTunneling-2.0.0.zip
8080
├── secure-tunnel
8181
└── localproxy
8282
```
8383

84+
and then you can upload the zip to a S3 bucket.
85+
8486
- `secure-tunnel`: Built binary from `./build/bin`
8587
- `localproxy`: Binary from [localproxy.md](localproxy.md)
8688
- Recipe: Component configuration file

docs/deployment.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,25 @@ Replace `<REGION>` and `<ACCOUNT-ID>` with your values.
4343

4444
## Local Deployment
4545

46+
### Greengrass Nucleus
47+
48+
Deploy using greengrass-cli:
49+
50+
```sh
51+
sudo /greengrass/v2/bin/greengrass-cli deployment create \
52+
--recipeDir components/recipes \
53+
--artifactDir components/artifacts \
54+
--merge "aws.greengrass.SecureTunneling=1.0.0"
55+
```
56+
57+
Verify deployment:
58+
59+
```sh
60+
tail -f /greengrass/v2/logs/greengrass.log
61+
```
62+
63+
### Greengrass Nucleus Lite
64+
4665
Deploy using ggl-cli:
4766

4867
```sh
@@ -55,7 +74,6 @@ Deploy using ggl-cli:
5574
Verify deployment:
5675

5776
```sh
58-
# Check nucleus logs for SUCCEEDED status
5977
journalctl -afu 'ggl.*'
6078
```
6179

@@ -72,7 +90,17 @@ for detailed guidance.
7290

7391
## Monitoring
7492

75-
Follow nucleus logs
93+
### Greengrass Nucleus
94+
95+
View logs in the Greengrass root directory:
96+
97+
```sh
98+
tail -f /greengrass/v2/logs/aws.greengrass.SecureTunneling.log
99+
```
100+
101+
### Greengrass Nucleus Lite
102+
103+
Follow nucleus logs:
76104

77105
```sh
78106
journalctl -afu 'ggl.*'

0 commit comments

Comments
 (0)