Skip to content

Commit 34a6529

Browse files
committed
docs: Explain campaign scheduling
Expand documentation to explain how campaign scheduling works. Signed-off-by: Omar <omar.brbutovic@secomind.com>
1 parent c1b6860 commit 34a6529

5 files changed

Lines changed: 7 additions & 6 deletions

File tree

REUSE.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SPDX-PackageDownloadLocation = "https://github.com/edgehog-device-manager/edgeho
66
[[annotations]]
77
path = "backend/docs/images/**"
88
precedence = "aggregate"
9-
SPDX-FileCopyrightText = "2021-2023 SECO Mind Srl"
9+
SPDX-FileCopyrightText = "2021-2026 SECO Mind Srl"
1010
SPDX-License-Identifier = "Apache-2.0"
1111

1212
[[annotations]]
14.8 KB
Loading
3.34 KB
Loading

backend/docs/pages/containers/deployment_campaigns.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!---
2-
Copyright 2025 SECO Mind Srl
2+
Copyright 2025-2026 SECO Mind Srl
33
44
SPDX-License-Identifier: Apache-2.0
55
-->
@@ -34,11 +34,12 @@ When creating a Deployment Campaign, the following information must be provided:
3434
- **Release**: The target release to deploy or operate on.
3535
- **Target Release** (`upgrade` only): The new release version to upgrade to.
3636
- **Channel**: The target Channel for the Deployment Campaign. All devices in this channel will be targeted.
37+
- **Scheduled Time** (optional): The time at which the campaign should start executing. If not provided, the campaign will start immediately upon creation.
3738
- **[Deployment Mechanism](#deployment-mechanism)** properties.
3839

3940
The Deployment Campaign information can be provided using the form, and pressing the "Create" button saves the Deployment Campaign.
4041

41-
Once created, the Deployment Campaign will start executing operations towards the devices, and its progress can be checked from the Edgehog Dashboard or through Edgehog GraphQL API.
42+
Once created, the Deployment Campaign will begin executing operations towards the devices at the scheduled time (or immediately if no scheduled time is provided). Its progress can be checked from the Edgehog Dashboard or through Edgehog GraphQL API.
4243

4344
Note that the campaign will "snapshot" the Devices belonging to the Channel when it's started, and will target only those. If additional Devices are added to the Channel _after_ the Deployment Campaign is created, they won't be included in this campaign and will require a separate campaign to be started.
4445

backend/docs/pages/ota_updates/update_campaigns.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!---
2-
Copyright 2023 SECO Mind Srl
2+
Copyright 2023-2026 SECO Mind Srl
33
44
SPDX-License-Identifier: Apache-2.0
55
-->
@@ -36,13 +36,13 @@ When creating an Update Campaign, the following information must be provided
3636

3737
- Base Image: the target Base Image for the Update Campaign.
3838
- Channel: the target Channel for the Update Campaign.
39+
- Scheduled Time (optional): the time at which the campaign should start executing. If not provided, the campaign will start immediately upon creation.
3940
- [Roll-out Mechanism](#roll-out-mechanism) properties.
4041

4142
The Update Campaign information can be provided using the form, and pressing the "Create" button saves
4243
the Update Campaign.
4344

44-
Once created, the Update Campaign will start rolling out updates towards the devices, and its
45-
progress can be checked from the Edgehog Dashboard or through Edgehog GraphQL API.
45+
Once created, the Update Campaign will begin rolling out updates towards the devices at the scheduled time (or immediately if no scheduled time is provided). Its progress can be checked from the Edgehog Dashboard or through Edgehog GraphQL API.
4646

4747
Note that the campaign will "snapshot" the Devices belonging to the Channel when it's
4848
started, and will target only those. If additional Devices are added to the Channel (either

0 commit comments

Comments
 (0)