Skip to content

Commit

Permalink
Merge pull request #40 from thin-edge/dev-update-instructions
Browse files Browse the repository at this point in the history
dev: update development instructions
  • Loading branch information
reubenmiller authored Nov 6, 2024
2 parents 3f7638e + 89f77d7 commit 53ddcf7
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,30 @@ After the project pre-requisites have been installed, you can start the containe
TEDGE_C8Y_OPERATIONS_AUTO_LOG_UPLOAD=always
```

2. Init the device certificate (stored under `./device-cert) and upload it to Cumulocity IoT
2. Activate your Cumulocity session using go-c8y-cli

```sh
set-session
```

**Note**

Your go-c8y-cli session profile needs to have the following setting set (and you will have to run `set-session` again afterwards):

```sh
c8y settings update session.alwaysIncludePassword true
# Then re-activate the session
set-session
```

3. Init the device certificate (stored under `./device-cert) and upload it to Cumulocity IoT
```sh
just init
```
3. Start the container (using docker compose)
4. Start the container (using docker compose)
```sh
# using the justfile task
Expand Down
5 changes: 5 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ start *ARGS: build-local
stop *ARGS:
docker compose down {{ARGS}}

# Stop the compose project and delete any resources
stop-all *ARGS:
docker compose --profile init down -v {{ARGS}}
docker compose --profile service down -v {{ARGS}}

# Enabling running cross platform tools when building container images
build-setup:
docker run --privileged --rm tonistiigi/binfmt --install all
Expand Down

1 comment on commit 53ddcf7

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
12 0 1 12 100 1m17.110708999s

Passed Tests

Name ⏱️ Duration Suite
Grace period to allow container to startup 5.002 s Operations
Get Logfile Request 2.332 s Operations
Get Configuration File 4.628 s Operations
Execute Shell Command 2.307 s Operations
Install application using docker compose 21.409 s Operations
Get Container Logs 2.329 s Operations
Trigger self update via local command 11.386 s Self-Update
Self update should only update if there is a new image 2.324 s Self-Update
Self update using software update operation 22.627 s Self-Update
Cloud Connection is Online 0.112 s Telemetry
Service status 0.215 s Telemetry
Sends measurements 2.439 s Telemetry

Please sign in to comment.