Skip to content

Commit

Permalink
Merge pull request #65 from thin-edge/docs-add-notes-on-podman-settings
Browse files Browse the repository at this point in the history
docs: add notes about podman gateway alias
  • Loading branch information
reubenmiller authored Jan 31, 2025
2 parents 9435430 + e99ac3b commit 2536ae6
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,16 @@ Self updates can be done by using `container` type.
**Pre-requisites**
* container is attached to the bridge network
* container has an extra host configured for the docker network (e.g. `--add-host=host.docker.internal:host-gateway`)
* ssh daemon has a listener on the container bridge network (e.g. typically `172.17.0.1`)
* **docker only** container has an extra host configured for the docker network (e.g. `--add-host=host.docker.internal:host-gateway`)
* ssh daemon has a listener on the container bridge network (e.g. typically `172.17.0.1` for docker, though you can check by running `ifconfig` and getting the ipv4 address of the docker or podman network adapter)
* Either your ssh keys have been added to the device, or allows password authentication
After the pre-requisites are met, you can easily access your device using the following steps:
1. Create a Cloud Remote Access PASSTHROUGH configuration for the device
**docker**
```sh
c8y remoteaccess configurations create-passthrough \
--device device01 \
Expand All @@ -69,6 +71,16 @@ After the pre-requisites are met, you can easily access your device using the fo
--name device-host
```
**podman**
```sh
c8y remoteaccess configurations create-passthrough \
--device device01 \
--hostname host.containers.internal \
--port 22 \
--name device-host
```
2. Connect to the device using ssh
```sh
Expand Down

7 comments on commit 2536ae6

@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
19 0 2 19 100 5m43.109246999s

Passed Tests

Name ⏱️ Duration Suite
Ignore Containers Marked With A Specific Label 22.598 s Container
Grace period to allow container to startup 5.031 s Operations
Service is up 0.136 s Operations
Get Logfile Request 2.346 s Operations
Get Configuration File 4.664 s Operations
Set Configuration File 2.447 s Operations
Execute Shell Command 2.345 s Operations
Install application using docker compose 15.296 s Operations
Get Container Logs 2.350 s Operations
Get Container Logs without explicit container name 2.348 s Operations
Get Container Logs For Non-existent container 2.360 s Operations
Trigger self update via local command 21.657 s Self-Update
Self update should only update if there is a new image 17.275 s Self-Update
Self update using software update operation 98.871 s Self-Update
Rollback when trying to install a non-tedge based image 17.506 s Self-Update
Self update using software update operation using Container type 105.585 s Self-Update
Cloud Connection is Online 0.144 s Telemetry
Service status 0.230 s Telemetry
Sends measurements 2.441 s Telemetry

@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
19 0 2 19 100 5m46.193465s

Passed Tests

Name ⏱️ Duration Suite
Ignore Containers Marked With A Specific Label 23.290 s Container
Grace period to allow container to startup 5.030 s Operations
Service is up 0.133 s Operations
Get Logfile Request 2.355 s Operations
Get Configuration File 4.661 s Operations
Set Configuration File 2.451 s Operations
Execute Shell Command 2.342 s Operations
Install application using docker compose 15.281 s Operations
Get Container Logs 2.350 s Operations
Get Container Logs without explicit container name 2.341 s Operations
Get Container Logs For Non-existent container 2.362 s Operations
Trigger self update via local command 21.445 s Self-Update
Self update should only update if there is a new image 19.095 s Self-Update
Self update using software update operation 98.553 s Self-Update
Rollback when trying to install a non-tedge based image 19.281 s Self-Update
Self update using software update operation using Container type 105.366 s Self-Update
Cloud Connection is Online 0.141 s Telemetry
Service status 0.231 s Telemetry
Sends measurements 2.441 s Telemetry

@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
20 0 1 20 100 8m2.792569999s

Passed Tests

Name ⏱️ Duration Suite
Ignore Containers Marked With A Specific Label 25.088 s Container
Grace period to allow container to startup 5.029 s Operations
Service is up 0.130 s Operations
Get Logfile Request 2.341 s Operations
Get Configuration File 4.652 s Operations
Set Configuration File 2.450 s Operations
Execute Shell Command 2.359 s Operations
Install application using docker compose 17.380 s Operations
Get Container Logs 2.338 s Operations
Get Container Logs without explicit container name 2.347 s Operations
Get Container Logs For Non-existent container 2.339 s Operations
Update From Legacy Versions 137.373 s Self-Update-Compat
Trigger self update via local command 24.341 s Self-Update
Self update should only update if there is a new image 19.878 s Self-Update
Self update using software update operation 102.387 s Self-Update
Rollback when trying to install a non-tedge based image 20.376 s Self-Update
Self update using software update operation using Container type 109.130 s Self-Update
Cloud Connection is Online 0.139 s Telemetry
Service status 0.239 s Telemetry
Sends measurements 2.449 s Telemetry

@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
20 0 1 20 100 8m8.589608s

Passed Tests

Name ⏱️ Duration Suite
Ignore Containers Marked With A Specific Label 25.789 s Container
Grace period to allow container to startup 5.028 s Operations
Service is up 0.143 s Operations
Get Logfile Request 2.371 s Operations
Get Configuration File 4.694 s Operations
Set Configuration File 2.471 s Operations
Execute Shell Command 2.363 s Operations
Install application using docker compose 15.346 s Operations
Get Container Logs 2.362 s Operations
Get Container Logs without explicit container name 2.357 s Operations
Get Container Logs For Non-existent container 2.361 s Operations
Update From Legacy Versions 138.741 s Self-Update-Compat
Trigger self update via local command 24.958 s Self-Update
Self update should only update if there is a new image 19.023 s Self-Update
Self update using software update operation 104.567 s Self-Update
Rollback when trying to install a non-tedge based image 20.351 s Self-Update
Self update using software update operation using Container type 112.774 s Self-Update
Cloud Connection is Online 0.150 s Telemetry
Service status 0.243 s Telemetry
Sends measurements 2.468 s Telemetry

@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
20 0 1 20 100 8m26.593732s

Passed Tests

Name ⏱️ Duration Suite
Ignore Containers Marked With A Specific Label 28.301 s Container
Grace period to allow container to startup 5.028 s Operations
Service is up 0.193 s Operations
Get Logfile Request 4.696 s Operations
Get Configuration File 5.036 s Operations
Set Configuration File 2.701 s Operations
Execute Shell Command 2.531 s Operations
Install application using docker compose 18.202 s Operations
Get Container Logs 4.702 s Operations
Get Container Logs without explicit container name 4.705 s Operations
Get Container Logs For Non-existent container 2.529 s Operations
Update From Legacy Versions 138.665 s Self-Update-Compat
Trigger self update via local command 25.468 s Self-Update
Self update should only update if there is a new image 20.765 s Self-Update
Self update using software update operation 103.266 s Self-Update
Rollback when trying to install a non-tedge based image 23.624 s Self-Update
Self update using software update operation using Container type 112.896 s Self-Update
Cloud Connection is Online 0.205 s Telemetry
Service status 0.355 s Telemetry
Sends measurements 2.695 s Telemetry

@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
20 0 1 20 100 8m32.567331999s

Passed Tests

Name ⏱️ Duration Suite
Ignore Containers Marked With A Specific Label 28.773 s Container
Grace period to allow container to startup 5.027 s Operations
Service is up 0.186 s Operations
Get Logfile Request 2.513 s Operations
Get Configuration File 4.997 s Operations
Set Configuration File 2.674 s Operations
Execute Shell Command 2.508 s Operations
Install application using docker compose 18.141 s Operations
Get Container Logs 4.666 s Operations
Get Container Logs without explicit container name 4.670 s Operations
Get Container Logs For Non-existent container 2.512 s Operations
Update From Legacy Versions 141.720 s Self-Update-Compat
Trigger self update via local command 25.886 s Self-Update
Self update should only update if there is a new image 21.285 s Self-Update
Self update using software update operation 105.849 s Self-Update
Rollback when trying to install a non-tedge based image 24.150 s Self-Update
Self update using software update operation using Container type 113.707 s Self-Update
Cloud Connection is Online 0.200 s Telemetry
Service status 0.371 s Telemetry
Sends measurements 2.707 s Telemetry

@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
20 0 1 20 100 8m35.695645s

Passed Tests

Name ⏱️ Duration Suite
Ignore Containers Marked With A Specific Label 28.302 s Container
Grace period to allow container to startup 5.029 s Operations
Service is up 0.196 s Operations
Get Logfile Request 4.702 s Operations
Get Configuration File 5.049 s Operations
Set Configuration File 2.705 s Operations
Execute Shell Command 2.538 s Operations
Install application using docker compose 20.519 s Operations
Get Container Logs 4.705 s Operations
Get Container Logs without explicit container name 4.702 s Operations
Get Container Logs For Non-existent container 2.533 s Operations
Update From Legacy Versions 141.095 s Self-Update-Compat
Trigger self update via local command 25.440 s Self-Update
Self update should only update if there is a new image 21.111 s Self-Update
Self update using software update operation 106.104 s Self-Update
Rollback when trying to install a non-tedge based image 24.486 s Self-Update
Self update using software update operation using Container type 113.150 s Self-Update
Cloud Connection is Online 0.208 s Telemetry
Service status 0.371 s Telemetry
Sends measurements 2.721 s Telemetry

Please sign in to comment.