Skip to content

docs: Rename Cumulocity IoT to Cumulocity #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reubenmiller merged 1 commit into from
Feb 20, 2025
Merged

docs: Rename Cumulocity IoT to Cumulocity #133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The instructions assume that you are using thin-edge.io >= 1.0.0
### What will be deployed to the device?

* A service called `tedge-container-plugin`. This provides the monitoring of the containers
* The following software management plugins which is called when installing and removing containers/container groups via Cumulocity IoT
* The following software management plugins which is called when installing and removing containers/container groups via Cumulocity
* `container` - Deploy a single container (`docker run xxx` equivalent)
* `container-group` - Deploy one or more container as defined by a `docker-compose.yaml` file (`docker compose up` equivalent), or an archive (gzip or zip)

Expand Down Expand Up @@ -42,18 +42,18 @@ The following linux package formats are provided on the releases page and also i

The following features are supported by the plugin:

* Install/remove containers via the Cumulocity IoT software interface
* Install/remove containers via the Cumulocity software interface
* Install multiple containers as one group using a `docker-compose.yaml` file or an archive container a `docker-compose.yaml` file
* Monitor container states (e.g. up/down) via Cumulocity IoT Services (only supported from tedge >= 1.0.0)
* Download container images via Cumulocity IoT binaries if a URL is provided
* Monitor container states (e.g. up/down) via Cumulocity Services (only supported from tedge >= 1.0.0)
* Download container images via Cumulocity binaries if a URL is provided
* Support for multiple container engines (docker, podman)


## Documentation

### Install/remove single containers

Containers can be installed and removed via the Cumulocity IoT Software Management interface in the Device Management Application.
Containers can be installed and removed via the Cumulocity Software Management interface in the Device Management Application.

The software package is modeled so that each software name corresponds to one container instance. Upon installation of a software item, the container uses the `version` field as the source of the container image/tag which is used to create the container. The software package can include an optional `url` referring to an exported container image in the gzip (compressed tarball) format (e.g. the image that you get when running `docker save <my_image> --output <my_image>.tar.gz`).

Expand Down
Loading