Skip to content
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.

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

Service-level agreements #2452

Open
wants to merge 53 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 36 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
e0c6c3a
feat: Platform SLA
eickler Sep 18, 2024
3a7911d
docs: Added changelog entry for platform SLA
eickler Sep 18, 2024
0eb05e9
fix: Added product and company tags
eickler Sep 19, 2024
0a31d89
fix: Sentence capitalization
eickler Sep 24, 2024
aebed88
fix: Link to MS SLA
eickler Sep 24, 2024
7df38e9
Change from platforms to base platform
nneuerburg Sep 30, 2024
729e98f
Focussed service description section.
eickler Oct 8, 2024
da2ee7d
Added credit commitment from SAG
eickler Oct 8, 2024
27ab1a3
Fixes from Beate
eickler Oct 8, 2024
ec3a4b6
Fixed from Beate
eickler Oct 8, 2024
e9660aa
Consistent usage of "Customer"
eickler Oct 8, 2024
130aced
More capitalization nightmare
eickler Oct 8, 2024
7302802
Further capitalization
eickler Oct 8, 2024
a14297e
Added region information for backups
eickler Oct 15, 2024
2ac0548
feat: Own section at incorrect location ...
eickler Oct 15, 2024
56ecf02
Moving quotas, adding support
eickler Oct 16, 2024
48dc780
Straight copy of support docs
eickler Oct 17, 2024
e692331
Consolidated into one document
eickler Oct 17, 2024
4906550
Tuning and corrections
eickler Oct 17, 2024
6f7b247
Typo
eickler Oct 17, 2024
64a1289
Update content/terms-and-conditions/service-level-bundle/support-sla.md
eickler Oct 18, 2024
397870d
Update content/terms-and-conditions/service-level-bundle/support-sla.md
eickler Oct 18, 2024
1a63ddb
Update content/terms-and-conditions/service-level-bundle/support-sla.md
eickler Oct 18, 2024
fd0d028
Update content/terms-and-conditions/service-level-bundle/support-sla.md
eickler Oct 18, 2024
2ca6315
Update content/terms-and-conditions/service-level-bundle/support-sla.md
eickler Oct 18, 2024
05b82a3
Update support-sla.md
eickler Oct 18, 2024
27518ca
Clarification added
eickler Oct 21, 2024
7ef4a7e
Text moved from PR #2263
eickler Oct 21, 2024
9f44153
Link fixes
eickler Oct 21, 2024
50f69bc
Removed duplicate limits page
eickler Oct 21, 2024
9a1ab08
Added quota disclaimer
eickler Oct 21, 2024
ef3a24f
Added a disclaimer regarding pre-GA/preview features
eickler Oct 22, 2024
b8a89ad
Merge branch 'develop' into platform-sla
eickler Nov 7, 2024
21d16f6
Merge branch 'develop' into platform-sla
eickler Nov 7, 2024
434957a
Moving to the new sector
eickler Nov 7, 2024
79c4d83
Merge branch 'develop' into platform-sla
eickler Nov 7, 2024
ddc8811
Added release process description
eickler Nov 8, 2024
5809ecf
Merge branch 'develop' into platform-sla
eickler Nov 8, 2024
22ed8aa
Update content/service-terms/quotas.md
eickler Nov 8, 2024
e13c21a
Update content/service-terms/quotas.md
eickler Nov 8, 2024
a41d612
Update content/service-terms/quotas.md
eickler Nov 8, 2024
e42e19c
Update content/service-terms/service-level-bundle/microservices-sla.md
eickler Nov 8, 2024
9500ce2
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
5071c3d
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
216cc4c
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
451e524
Smaller fixes, added previews
eickler Nov 8, 2024
e01667c
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
a881ea0
Added link to support SLA
eickler Nov 8, 2024
847f0df
Merge remote-tracking branch 'refs/remotes/origin/platform-sla' into …
eickler Nov 8, 2024
141d5ef
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
13fafb6
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
072bf1a
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
4328de5
Update content/service-terms/service-level-bundle/platform-sla.md
eickler Nov 8, 2024
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
date: 2024-09-23
title: Service-level agreement for Platforms
change_type:
- value: change-2c7RdTdXo4
label: Improvement
product_area: Platform services
component:
- value: component-9vjGQz8Ag
label: Core platform
build_artifact:
- value: tc-QHwMfWtBk7
label: cumulocity
---
The [Service-level agreement for Platforms](/concepts/platform-sla/) now provides a more precise definition on how {{< company-c8y >}} manages the {{< product-c8y-iot >}} platform service for your tenants and what might be possible limitations and responsibilities that you should be aware of.
28 changes: 0 additions & 28 deletions content/concepts/limits.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,19 @@ See the list of single operations in the **Single operations** tab.

Single operations can have one of the following four statuses:

| Status | Description |
| :----- | :---------- |
| Status | Description |
| :--------- | :------------------------------------------------------------------------------- |
| PENDING | The operation has just been created and is waiting for the device to pick it up. |
| EXECUTING | The operation has been picked up by the device and is being executed. |
| SUCCESSFUL | The operation has been successfully executed by the device. |
| FAILED | The operation could not be executed by the device. |
| EXECUTING | The operation has been picked up by the device and is being executed. |
| SUCCESSFUL | The operation has been successfully executed by the device. |
| FAILED | The operation could not be executed by the device. |

In each row, the following information for an operation is provided:

| Info | Description |
| :----- | :---------- |
| Status | One of PENDING, EXECUTING, SUCCESSFUL, FAILED (see above). |
| Name | Name of the operation. |
| Info | Description |
| :----- | :-------------------------------------------------------------------------------------- |
| Status | One of PENDING, EXECUTING, SUCCESSFUL, FAILED (see above). |
| Name | Name of the operation. |
| Device | The name of the device. Clicking the name leads you to the detailed view of the device. |

Clicking a row expands it and displays further details on the operation.
Expand Down Expand Up @@ -102,34 +102,34 @@ Bulk operations have an operation type and status.

You can add bulk operations of the following operation types with the [bulk operation wizard](#to-add-a-bulk-operation-using-the-wizard):

| Operation type | Description |
| :---------------------- | :---------- |
| Configuration update | The bulk operation updates the configuration of the selected devices. |
| Firmware update | The bulk operation updates the firmware on the selected devices. |
| Software update | The bulk operation updates the software on the selected devices. |
| Apply device profile | The bulk operation applies a device profile on the selected devices. |
| Operation type | Description |
| :------------------- | :-------------------------------------------------------------------- |
| Configuration update | The bulk operation updates the configuration of the selected devices. |
| Firmware update | The bulk operation updates the firmware on the selected devices. |
| Software update | The bulk operation updates the software on the selected devices. |
| Apply device profile | The bulk operation applies a device profile on the selected devices. |

Bulk operations can have other operation types as well, for example when you [schedule a single operation as bulk operation](#to-schedule-a-single-operation-as-bulk-operation) and the single operation has a different operation type.

Bulk operations can have one of the following statuses:

| Status | Description |
| :---------------------- | :---------- |
| Status | Description |
| :---------------------- | :--------------------------------------------------------------------------- |
| SCHEDULED | The bulk operation has been created and is on hold until the scheduled time. |
| EXECUTING | The bulk operation is being executed. |
| CANCELED | The bulk operation was created but canceled before the scheduled time. |
| COMPLETED WITH FAILURES | The bulk operation completed with failures for some devices. |
| COMPLETED SUCCESSFULLY | The bulk operation has been successfully executed on all devices. |
| EXECUTING | The bulk operation is being executed. |
| CANCELED | The bulk operation was created but canceled before the scheduled time. |
| COMPLETED WITH FAILURES | The bulk operation completed with failures for some devices. |
| COMPLETED SUCCESSFULLY | The bulk operation has been successfully executed on all devices. |

In each row, the following information for a bulk operation is provided:

| Info | Description |
| :----- | :---------- |
| Status | One of SCHEDULED, EXECUTING, CANCELED, COMPLETED WITH FAILURES, COMPLETED SUCCESSFULLY (see above). |
| Name | Name of the operation. |
| Progress bar | Only for executing and completed bulk operations. Shows the operation's progress in percent. |
| Info | Description |
| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Status | One of SCHEDULED, EXECUTING, CANCELED, COMPLETED WITH FAILURES, COMPLETED SUCCESSFULLY (see above). |
| Name | Name of the operation. |
| Progress bar | Only for executing and completed bulk operations. Shows the operation's progress in percent. |
| Start and finish dates | Only for executing and completed bulk operations. For executing bulk operations, the finish date is an approximation based on the bulk operation settings. |
| Refresh button | Only for executing bulk operations. Updates the progress bar. |
| Refresh button | Only for executing bulk operations. Updates the progress bar. |

Clicking the arrow button at the right in a row expands the row and displays further details on the bulk operation.

Expand Down Expand Up @@ -227,9 +227,9 @@ This may be useful if the operation is generally a success, but contains operati
**Calculation of completion percentage**

The completion percentage is determined by comparing the total number of initiated operations to the number of operations that have reached a final state (success or failure). The total count is established at operation creation and remains static thereafter. This static value may lead to inaccuracies in the completion percentage if the overall number of operations subsequently changes.
{{< /c8y-admon-info >}}

* **Operation removal**: Operations can be implicitly removed when their associated devices are deleted. This deletion goes unaccounted for in the completion percentage calculation.
* **Operation addition**: Retrying failed operations can introduce new entries without modifying the original total count. This again results in a misrepresentation of the completion percentage.

The completion percentage is calculated based on the information available at the time an operation is created and further changes are not applied.
{{< /c8y-admon-info >}}
2 changes: 1 addition & 1 deletion content/sector/terms_conditions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -469,4 +469,4 @@ svg: '<svg
</svg>'
---

Find a collection of various legal documents, such as our Privacy Notice and Imprint, and documentation-related details.
Find the Cumulocity service terms, legal notices and documentation-related information here.
12 changes: 12 additions & 0 deletions content/service-terms-card.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Service terms
bundlefolder: service-terms
icon: "c8y-icon c8y-icon-notification"
type: root
layout: redirect
sector:
- terms_conditions
weight: 5
---

Information on the terms and conditions for using {{< product-c8y-iot >}}, including service-level agreements.
4 changes: 4 additions & 0 deletions content/service-terms/_index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Terms and Conditions
layout: redirect
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
title: Compatibility policy
layout: bundle
sector:
- getting_started
- terms_conditions
aliases:
- /concepts-introduction/
- /concepts/compatibility-policy/
weight: 95
---

Expand Down
77 changes: 77 additions & 0 deletions content/service-terms/quotas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: Service Quotas
eickler marked this conversation as resolved.
Show resolved Hide resolved
layout: bundle
sector:
- terms_conditions
weight: 100
aliases:
- /concepts/limits/
---

Your {{< product-c8y-iot >}} service includes so-called ``quotas``. These quotas ensure that the service operates within the guarantees of the {{< product-c8y-iot >}} service-level agreements.
eickler marked this conversation as resolved.
Show resolved Hide resolved

The following types of quotas are used:

* **Hard**: Services enforce this quota so that it cannot be exceeded.
* **Soft**: Services are guaranteed to operate within the specified service-level agreements as long as the quotas are not exceeded; however, exceeding the quotas may result in a degraded user experience and no assurance of meeting the service-level agreements.
<!-- * **Configurable**: Services enforce this quota, but a change of the quota may be requested through technical support. A change in the quota may impact the service price.-->

The quotas listed here reflect the maximum values for the cloud subscriptions unless indicated otherwise. If you're unsure whether a specific cloud service quota is sufficient for your use case, we recommend reaching out to your sales contact to discuss your needs and explore potential options. Some quotas may be adjustable through professional services, depending on the system dimensioning and your specific requirements. For edge deployments, please consult the [{{< product-c8y-iot >}} Edge documentation](/edge).
eickler marked this conversation as resolved.
Show resolved Hide resolved

### Platform

#### General

| Quota | Type | Value |
| ------------- | ---- | ----: |
| Tenant amount | Soft | 2000 |

#### Microservices

| Quota | Type | Value |
| -------------------------------------------------------------------------------------------------- | ---- | -----: |
| [Microservice name length](/microservice-sdk/general-aspects/#packing) | Hard | 23 |
| [Microservice image size](/standard-tenant/ecosystem/#to-add-a-microservice-as-custom-application) | Hard | 500 MB |
| [Threads in a microservice](/microservice-sdk/general-aspects/#images-and-containers) | Hard | 10240 |
| [Retained log size](/standard-tenant/ecosystem/#log-files) | Hard | 35 MB |


### Domain model

| Quota | Type | Value |
| -------------------------------------------------------------------- | ---- | ----: |
| [Document size](/concepts/domain-model/#fragments) | Hard | 16 MB |
| [Document size](/concepts/domain-model/#fragments) | Soft | 1 MB |
| [Array size within document](/concepts/domain-model/#fragments) | Soft | 1000 |
| [Children of an inventory object](/concepts/domain-model/#fragments) | Soft | 1000 |


### REST API

| Quota | Type | Value |
| ---------------------------- | ---- | --------: |
| Maximum API request duration | Hard | 5 minutes |

### Realtime APIs

| Quota | Type | Value |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | -------: |
| [MQTT message size](/device-integration/mqtt/) | Hard | 16 KB |
| [Notifications 2.0 message backlog](/change-logs/?#cumulocity-undefined-advance-notice-of-reduced-storage-limits-for-notifications-2.0-and-microservice-based-data-broker) | Hard | 25 MB |
| [Notifications 2.0 time-to-live](/change-logs/?#cumulocity-undefined-advance-notice-of-reduced-storage-limits-for-notifications-2.0-and-microservice-based-data-broker) | Hard | 36 hours |
| [Microservice-based data broker message backlog](/change-logs/?#cumulocity-undefined-advance-notice-of-reduced-storage-limits-for-notifications-2.0-and-microservice-based-data-broker) | Hard | 50 MB |
| [Microservice-based data broker time-to-live](/change-logs/?#cumulocity-undefined-advance-notice-of-reduced-storage-limits-for-notifications-2.0-and-microservice-based-data-broker) | Hard | 36 hours |

### Applications and services

| Quota | Type | Value |
| --------------------------------------------------------------------------------------------- | ---- | ----: |
| [Devices shown on the Cockpit home page map](/cockpit/home-dashboard/) | Hard | 100 |
| [Data points in a graph](/device-management-application/viewing-device-details/#measurements) | Hard | 5000 |

### Protocols

| Quota | Type | Value |
| ---------------------------------------------------------------------------------------------- | ---- | ----: |
| [File size for LWM2M bulk registration](/protocol-integration/lwm2m/#bulk-device-registration) | Hard | 10 MB |
| [Concurrent pending LWM2M operations](/protocol-integration/lwm2m/#device-operations-handling) | Hard | 10 |
4 changes: 4 additions & 0 deletions content/service-terms/service-level-bundle/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Service-level agreements
headless: true
---
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: Service-level agreement
title: Microservice hosting service-level agreement
layout: bundle
sector:
- app_enablement
weight: 90
weight: 20
aliases:
- /microservice-sdk/microservices-sla/
- /microservices-sla/
---

<h3 style="margin-top: -1em; padding-top: 0">for Microservices hosting on the {{< product-c8y-iot >}} Microservices platform</h3>

**This Agreement** is made between {{< company-c8y >}} ("Provider") and the Customer ("Customer") who utilizes {{< product-c8y-iot >}} Microservices ("Service", “Container-as-a-Service") for deploying Customer Microservices ("Microservices") on {{< product-c8y-iot >}} cloud instances.
eickler marked this conversation as resolved.
Show resolved Hide resolved

### Service description
Expand Down Expand Up @@ -59,10 +58,11 @@ Customer acknowledges the following limitations and constraints in using Service
* {{< product-c8y-iot >}} may block large capacity requests occurring in a brief period.
* In case of doubt, please [contact product support](/additional-resources/contacting-support/) for bounds and larger capacity requirements (for example, onboarding a single-tenant Microservice with many customers).
* **Security and performance management**: Provider may stop or remove Microservices in case of a severe security or performance impact to {{< product-c8y-iot >}}. Customers are expressly prohibited from engaging in any destructive activities on the {{< product-c8y-iot >}} production infrastructure. This includes penetration testing, performance testing, stress testing, or any other activities that may compromise the integrity, performance, or security of our systems.
* **Quotas** as [documented](/terms-and-conditions/limits/).

### Service availability

Service availability of {{< product-c8y-iot >}} Microservices follows the [general service terms](https://www.softwareag.cloud/site/sla/cumulocity-iot.html) of {{< product-c8y-iot >}}.
Service availability of {{< product-c8y-iot >}} Microservices follows the [general service terms](/terms-and-conditions/service-level/#platform-sla) of {{< product-c8y-iot >}}.

### Support and maintenance

Expand Down
Loading