diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 9efe337734..8861e51416 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -22,7 +22,6 @@ content/authentication @kowa-c8y @BeateRixen # Edge /content/edge* @bbyreddy @rthrippleton @BeateRixen /static/files/edge* @bbyreddy @rthrippleton @BeateRixen -/content/datahub/running-datahub-on-the-edge* @bbyreddy @rthrippleton @BeateRixen /content/streaming-analytics/ @BeateRixen @skom-c8y # 'block-reference-bundle' is automatically and frequently committed to - don't bother _too many_ CODEOWNERS diff --git a/content/change-logs/edge/edge-2025.0.0-datahub.md b/content/change-logs/edge/edge-2025.0.0-datahub.md index 066874d0d8..9cb0e9536d 100644 --- a/content/change-logs/edge/edge-2025.0.0-datahub.md +++ b/content/change-logs/edge/edge-2025.0.0-datahub.md @@ -16,4 +16,4 @@ version: 2025.0.0 --- {{< product-c8y-iot >}} Edge now supports installing and upgrading the {{< product-c8y-iot >}} DataHub Edge using the Edge operator. -For more details, see [Setting up DataHub Edge](/datahub/running-datahub-on-the-edge/#setting-up-datahub-edge). +For more details, see [DataHub](/edge-kubernetes/datahub). diff --git a/content/change-logs/edge/edge-2025.0.8-CIE-5487.md b/content/change-logs/edge/edge-2025.0.8-CIE-5487.md index de62ed70d3..35e8f6bafe 100644 --- a/content/change-logs/edge/edge-2025.0.8-CIE-5487.md +++ b/content/change-logs/edge/edge-2025.0.8-CIE-5487.md @@ -16,7 +16,7 @@ version: 2025.0.8 --- In previous versions of {{< product-c8y-iot >}} Edge, a race condition caused the Dremio component of DataHub to start up without authentication being configured, breaking almost all aspects of DataHub. This issue has now been fixed. -If you have a system that is suffering from this problem but otherwise functional, you do not need to do a fresh installation of Edge. Instead, disable DataHub in your current Edge installation, and then upgrade to the latest version of Edge. After the upgrade, re-enable DataHub, and the problem will be cleared up. See [Upgrading Edge](/edge-kubernetes/manage-edge/#version-upgrade) for instructions on upgrading. For disabling and enabling DataHub, see [More general configuration changes](edge-kubernetes/manage-edge/#more-general-configuration-changes). The value you will be changing in the Custom Resource looks like this: +If you have a system that is suffering from this problem but otherwise functional, you do not need to do a fresh installation of Edge. Instead, disable DataHub in your current Edge installation, and then upgrade to the latest version of Edge. After the upgrade, re-enable DataHub, and the problem will be cleared up. See [Upgrading Edge](/edge-kubernetes/manage-edge/#version-upgrade) for instructions on upgrading. For disabling and enabling DataHub, see [More general configuration changes](/edge-kubernetes/manage-edge/#more-general-configuration-changes). The value you will be changing in the Custom Resource looks like this: ``` dataHub: enabled: true diff --git a/content/datahub/datahub-overview-bundle/documentation-overview.md b/content/datahub/datahub-overview-bundle/documentation-overview.md index 69ae8511b7..21e410ce4f 100644 --- a/content/datahub/datahub-overview-bundle/documentation-overview.md +++ b/content/datahub/datahub-overview-bundle/documentation-overview.md @@ -14,7 +14,6 @@ For your convenience, here is an overview of the contents of this document: | [Setting up {{< product-c8y-iot >}} DataHub](/datahub/setting-up-datahub) | Set up {{< product-c8y-iot >}} DataHub and its components | | [Working with {{< product-c8y-iot >}} DataHub](/datahub/working-with-datahub) | Manage offloading pipelines and query the offloaded results | | [Operating {{< product-c8y-iot >}} DataHub](/datahub/operating-datahub) | Run administrative tasks | -| [Running {{< product-c8y-iot >}} DataHub on {{< product-c8y-iot >}} Edge](/datahub/running-datahub-on-the-edge) | Run the Edge edition of {{< product-c8y-iot >}} DataHub | | [Integrating {{< product-c8y-iot >}} DataHub with other products](/datahub/integrating-datahub-with-other-products) | Learn how to integrate {{< product-c8y-iot >}} DataHub with other products | The [change log](/change-logs/?component=.component-datahub) provides an overview on features, changes, and other relevant information. diff --git a/content/datahub/running-datahub-on-the-edge-bundle/datahub-edge-overview.md b/content/datahub/running-datahub-on-the-edge-bundle/datahub-edge-overview.md deleted file mode 100644 index bd0f5c3de8..0000000000 --- a/content/datahub/running-datahub-on-the-edge-bundle/datahub-edge-overview.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -weight: 10 -title: Cumulocity DataHub Edge overview -layout: redirect ---- - -### Documentation overview {#documentation-overview} - -The following sections will walk you through all the functionalities of {{< product-c8y-iot >}} DataHub Edge in detail. - -For your convenience, here is an overview of the contents: - -| Section | Content | -| ----- | ----- | -| [ {{< product-c8y-iot >}} DataHub Edge overview](/datahub/running-datahub-on-the-edge/#datahub-edge-overview) | Get an overview of {{< product-c8y-iot >}} DataHub Edge | -| [Setting up {{< product-c8y-iot >}} DataHub Edge](/datahub/running-datahub-on-the-edge/#setting-up-datahub-edge) | Set up {{< product-c8y-iot >}} DataHub Edge and its components | -| [Working with {{< product-c8y-iot >}} DataHub Edge](/datahub/running-datahub-on-the-edge/#working-with-datahub-edge) | Manage offloading pipelines and query the offloaded results | -| [Operating {{< product-c8y-iot >}} DataHub Edge](/datahub/running-datahub-on-the-edge/#operating-datahub-edge) | Run administrative tasks | - -### {{< product-c8y-iot >}} DataHub Edge at a glance {#datahub-edge-at-a-glance} -[{{< product-c8y-iot >}} Edge](/sector/edge_server) is the single-server variant of the {{< product-c8y-iot >}} platform, designed to run in factories on industrial PCs or local servers, that is, in the same site (“onsite”) in which the IoT assets are located. {{< product-c8y-iot >}} DataHub is available as an add-on to {{< product-c8y-iot >}} Edge. - -{{< product-c8y-iot >}} DataHub Edge offers the same functionality as the cloud-variant of {{< product-c8y-iot >}} DataHub, and is deployed similarly into a Kubernetes cluster. The significant difference is that processes and data are entirely local to your network, rather than in the cloud. You can define offloading pipelines, which regularly move data from the Operational Store of {{< product-c8y-iot >}} into a data lake. In the Edge setup, a NAS is used as data lake. Dremio, the internal engine of {{< product-c8y-iot >}} DataHub, can access the data lake and run analytical queries against its contents, using SQL as the query interface. - -#### {{< product-c8y-iot >}} DataHub Edge versus {{< product-c8y-iot >}} DataHub cloud deployments {#datahub-edge-versus-datahub-cloud-deployments} - -{{< product-c8y-iot >}} DataHub Edge uses the same software as {{< product-c8y-iot >}} DataHub, though in the following aspects these two variants differ: - -| Area | {{< product-c8y-iot >}} DataHub Edge | {{< product-c8y-iot >}} DataHub Cloud | -| ----- | ----- | ----- | ----- | -| High Availability | Depending on any underlying virtualization technology | Depending on the cloud deployment setup | -| Vertical scalability | Yes | Yes | -| Horizontal scalability | No | Yes | -| Upgrades with no downtime | No | No | -| Root access | No | Yes, if customer is hosting | -| Installation | Offline & Online | Online | -| Dremio cluster setup | 1 master, 1 executor | Minimum 1 master, 1 executor | -| Dremio container management | Kubernetes | Kubernetes | -| {{< product-c8y-iot >}} DataHub backend container management | Microservice in {{< product-c8y-iot >}} Edge | Microservice in {{< product-c8y-iot >}} Core | -| Data lakes | NAS | Azure Storage, S3, (NAS) | diff --git a/content/datahub/running-datahub-on-the-edge-bundle/index.html b/content/datahub/running-datahub-on-the-edge-bundle/index.html deleted file mode 100644 index b88c67ccc2..0000000000 --- a/content/datahub/running-datahub-on-the-edge-bundle/index.html +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Running Cumulocity DataHub on the Edge -headless: true ---- diff --git a/content/datahub/running-datahub-on-the-edge-bundle/operating-datahub-edge.md b/content/datahub/running-datahub-on-the-edge-bundle/operating-datahub-edge.md deleted file mode 100644 index 0ea1149f69..0000000000 --- a/content/datahub/running-datahub-on-the-edge-bundle/operating-datahub-edge.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -weight: 40 -title: Operating Cumulocity DataHub Edge -layout: redirect ---- - -Similar to the cloud variant, {{< product-c8y-iot >}} DataHub Edge UI allows you to check system information and view audit logs. See [Operating {{< product-c8y-iot >}} DataHub](/datahub/operating-datahub) for details. - -When managing {{< product-c8y-iot >}} DataHub Edge, the following standard tasks are additionally relevant. - -### Troubleshooting the system {#troubleshooting-the-system} - -If problems occur, you should follow these steps: - -- Perform a health check, see [Health check](#health-check) -- Check the log files, see [Log files](#log-files) - -If you need to contact [product support](/additional-resources/contacting-support/), include the diagnostic log archive. See [Accessing logs](/edge-kubernetes/edge-operations/#accessing-logs). - -#### Health check {#health-check} - -##### Check {{< product-c8y-iot >}} DataHub Edge backend status {#check-datahub-edge-backend-status} - -You can check the status of the backend in the **Administration** page of the {{< product-c8y-iot >}} DataHub UI. Alternatively you can query the `isalive` endpoint, which should produce an output similar to: - -```shell -curl --user admin:your_password https://edge_domain_name/service/datahub/isalive - -{ - "timestamp" : 1582204706844, - "version" : { - "versionId" : "10.6.0.0.337", - "build" : "202002200050", - "scmRevision" : "4ddbb70bf96eb82a2f6c5e3f32c20ff206907f43" - } -} -``` - -If the backend cannot be reached, you will get an error response. - -##### Check Dremio backend status {#check-dremio-backend-status} - -You can check the status of Dremio using the `server_status` endpoint: - -```shell -curl http://datahub-edge_domain_name/apiv2/server_status -"OK" -``` -Dremio is running if *OK* is returned. No response will be returned if it is not running or inaccessible. - -#### Log files {#log-files} - -Logs are available in the Administration application of {{< product-c8y-iot >}}. Navigate to **Ecosystem** > **Applications**, select the DataHub microservice from the application list and switch to the **Logs** tab. - -Dremio logs are available for each pod via kubectl, for example: -``` -kubectl -n c8yedge logs dremio-executor-0 -kubectl -n c8yedge logs dremio-master-0 -``` - -#### Cleanup of Dremio job history {#cleanup-of-dremio-job-history} - -Dremio maintains a history of job details and profiles, which can be inspected in Dremio's job log, that is, the **Jobs** page of the Dremio UI. This job history must be cleaned up regularly to free the resources necessary for storing it. - -Dremio is configured to perform the cleanup of job results automatically without downtime. The default value for the maximum age of stored job results is seven days. To change that value, a Dremio administrator must modify the support key *jobs.max.age_in_days*. The changes become effective within 24 hours or after restarting Dremio. See the corresponding [Dremio documentation](https://docs.dremio.com/current/help-support/support-settings/) for more details on support keys. diff --git a/content/datahub/running-datahub-on-the-edge-bundle/setting-up-datahub-edge-on-k8s.md b/content/datahub/running-datahub-on-the-edge-bundle/setting-up-datahub-edge-on-k8s.md deleted file mode 100644 index d2265b79a0..0000000000 --- a/content/datahub/running-datahub-on-the-edge-bundle/setting-up-datahub-edge-on-k8s.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -weight: 20 -title: Setting up Cumulocity DataHub Edge -layout: redirect ---- - -In this setup, {{< product-c8y-iot >}} DataHub is deployed into a Kubernetes environment using the Edge operator. The DataHub backend is run as a microservice within the {{< product-c8y-iot >}} platform. The Dremio master and executor are deployed as a set of Kubernetes pods. - -### Prerequisites {#prerequisites} - -#### Resource requirements {#resource-requirements} - -The resource requirements for running a bare {{< product-c8y-iot >}} Edge instance are described in [Prerequisites](/edge-kubernetes/installing-edge-on-k8/#prerequisites). -When {{< product-c8y-iot >}} DataHub Edge is deployed on top, the resource requirements change by the following additional amounts: - - * Recommended: 16 GB RAM, minimum: 10 GB RAM - * Recommended: 10 logical CPU cores, minimum: 6 logical CPU cores - * 100 GB of free disk space plus sufficient free disk space for the data lake contents. For more information about configuring the storage, see [Prerequisites](/edge-kubernetes/installing-edge-on-k8/#prerequisites). - - Hardware requirements for the host OS are excluded. - -### Setting up {{< product-c8y-iot >}} DataHub Edge {#setting-up-datahub-edge} -To install and configure DataHub Edge, update the `spec.dataHub` field in the Edge Custom Resource (CR) with the necessary configuration details for the Edge operator. After making the changes, apply the updated CR to deploy DataHub Edge. - -For more details on the `spec.dataHub` field, refer to [Edge Custom Resource - DataHub](/edge-kubernetes/edge-custom-resource-definition/#k8-edge-datahub). - -For additional guidance, see the [Install Edge](/edge-kubernetes/installing-edge-on-k8/) and [Modify Edge](/edge-kubernetes/manage-edge/#modify-edge) sections in the Edge documentation. - -In order to access Dremio, you must also make the domain ``datahub-`` resolvable, just as the configured domain name and ``management-`` were made resolvable in [Accessing Edge](/edge-kubernetes/installing-edge-on-k8/#accessing-edge). - -#### Using {{< product-c8y-iot >}} DataHub Edge {#using-datahub-edge} - -{{< product-c8y-iot >}} DataHub Edge behaves like the Cloud version. - -### Validation of the {{< product-c8y-iot >}} DataHub installation {#validation-of-the-datahub-edge-installation} - -If the product doesn't work as intended after the installation, go through the validation steps described below. - -{{< c8y-admon-info >}} -Substitute the namespace name *c8yedge* in the subsequent commands with the specific namespace name into which you installed Edge. -{{< /c8y-admon-info >}} - -#### MySQL {#mysql} - -You can monitor the startup of the MySQL pod ``datahub-mysql-0`` using: -```shell -kubectl get pods -n c8yedge datahub-mysql-0 --watch -``` -The result will be similar to: -``` -NAME READY STATUS RESTARTS AGE -datahub-mysql-0 1/1 Running 0 4m55s -``` - -When running the command: -```shell -kubectl get svc -n c8yedge -``` -The output will be similar to: -``` -NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE -mysql-client ClusterIP XXX.XXX.XXX.XXX 3306/TCP 10m -``` - -#### Dremio {#dremio} - -You can monitor the state of the Dremio pods "zk-0", "dremio-executor-0", and "dremio-master-0" using: -```shell -kubectl get pods -n c8yedge --watch -``` - -The status "Running" indicates that the pods have started successfully: - -``` -NAME READY STATUS RESTARTS AGE -... -zk-0 1/1 Running 0 6m34s -dremio-executor-0 1/1 Running 0 6m34s -dremio-master-0 1/1 Running 0 6m34s -``` - -When running the command: -```shell -kubectl get svc -n c8yedge -``` - -The output will be similar to: - -``` -NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE -dremio-client LoadBalancer XXX.XXX.XXX.XXX XXX.XXX.XXX.XXX 31010:XXXXX/TCP,9047:XXXXX/TCP,32010:XXXXX/TCP 9m33s -``` - -#### {{< product-c8y-iot >}} DataHub microservice {#datahub-microservice} - -When logged into the {{< product-c8y-iot >}} UI, the {{< product-c8y-iot >}} DataHub microservice is available under **Administration > Ecosystem > Microservices**. - -You can monitor the startup of the microservice pod "datahub-scope-edge-deployment-...." using: -```shell -kubectl get pods -n c8yedge --watch -``` - -The status "Running" indicates that the pod has started successfully: -``` -NAMESPACE NAME READY STATUS RESTARTS AGE -... -c8yedge datahub-scope-edge-deployment-XXXXXXXXXX-YYYYY 1/1 Running 0 16m -``` - -#### DataHub web application {#datahub-web-application} - -When logged into the {{< product-c8y-iot >}} UI, the {{< product-c8y-iot >}} DataHub web application is available under **Administration > Ecosystem > Applications**. -It should also be present in the usual {{< product-c8y-iot >}} application switcher. diff --git a/content/datahub/running-datahub-on-the-edge-bundle/working-with-datahub-edge.md b/content/datahub/running-datahub-on-the-edge-bundle/working-with-datahub-edge.md deleted file mode 100644 index 4056d1daa3..0000000000 --- a/content/datahub/running-datahub-on-the-edge-bundle/working-with-datahub-edge.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -weight: 30 -title: Working with Cumulocity DataHub Edge -layout: redirect ---- - -{{< product-c8y-iot >}} DataHub Edge offers the same set of functionality as the cloud variant. See [Working with {{< product-c8y-iot >}} DataHub](/datahub/working-with-datahub) for details on configuring and monitoring offloading jobs, querying offloaded {{< product-c8y-iot >}} data, and refining offloaded {{< product-c8y-iot >}} data. diff --git a/content/datahub/running-datahub-on-the-edge.md b/content/datahub/running-datahub-on-the-edge.md deleted file mode 100644 index b382d74fa8..0000000000 --- a/content/datahub/running-datahub-on-the-edge.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Running Cumulocity DataHub on Cumulocity Edge -weight: 60 -layout: bundle -sector: - - data_analytics ---- - -This section describes how to run {{< product-c8y-iot >}} DataHub on the {{< product-c8y-iot >}} Edge, the local version of {{< product-c8y-iot >}}. diff --git a/content/datahub/setting-up-datahub-bundle/setting-up-initial-configuration.md b/content/datahub/setting-up-datahub-bundle/setting-up-initial-configuration.md index 35b154667c..0bb97aa703 100644 --- a/content/datahub/setting-up-datahub-bundle/setting-up-initial-configuration.md +++ b/content/datahub/setting-up-datahub-bundle/setting-up-initial-configuration.md @@ -98,11 +98,7 @@ Value: Your key name, for example, `arn:aws:kms:eu-west-2:123456789012:key/071a8 **SSE-C**: The client specifies an base64-encoded AES-256 key to be used to encrypt and decrypt the data. **{{< product-c8y-iot >}} DataHub does not support this option.** ##### NAS {#nas} -**NAS** is a storage system mounted (NFS, SMB) directly into the Dremio cluster. It is only available for {{< product-c8y-iot >}} Edge installations. The following settings must be defined for this data lake: - -|Settings|Description| -|:---|:---| -|Mount path|The mount path refers to a path in the local Linux file system on both the coordinator and executor containers. By default, the file system of {{< product-c8y-iot >}} Edge is mounted into /datalake inside the containers. To use some other folder, you must map the folder into both containers, for example, to /datalake inside the containers.| +**NAS** is a storage system mounted (NFS, SMB) directly into the Dremio cluster. It is only available on {{< product-c8y-iot >}} Edge installations. #### Saving settings {#saving-settings} Once all settings are defined, click **Save** in the action bar to the right. During the save process, the following steps are automatically conducted: diff --git a/content/edge-kubernetes/datahub.md b/content/edge-kubernetes/datahub.md new file mode 100644 index 0000000000..5c4f2bcab7 --- /dev/null +++ b/content/edge-kubernetes/datahub.md @@ -0,0 +1,31 @@ +--- +weight: 80 +title: DataHub +layout: bundle +sector: + - edge_server +--- + +{{< product-c8y-iot >}} DataHub on Edge offers the same functionality as a cloud installation of {{< product-c8y-iot >}} DataHub, and is an optional component of Edge. The significant difference is that processes and data are entirely local to your network, rather than in the cloud. You can define offloading pipelines, which regularly move data from the Operational Store of {{< product-c8y-iot >}} into a data lake. In the Edge setup, a NAS or local disk is used as data lake. Dremio, the internal engine of {{< product-c8y-iot >}} DataHub, can access the data lake and run analytical queries against its contents, using SQL as the query interface. + +To learn more about DataHub in general, see [DataHub overview](/datahub/datahub-overview). As an end user, DataHub on Edge appears and behaves much the same as DataHub in a cloud installation, subject to the limitations in the comparison table later in this section. + +### Installing and using DataHub {#installing-and-using-datahub} + +DataHub is an optional component of Edge, and can be enabled by updating the `spec.dataHub` field in the Edge custom resource (CR). For more details on the `spec.messagingService` field, refer to [Edge custom resource - DataHub](/edge-kubernetes/edge-custom-resource-definition/#k8-edge-datahub). For general guidance on configuring Edge, see the [Install Edge](/edge-kubernetes/installing-edge-on-k8/) and [Modify Edge](/edge-kubernetes/manage-edge/#modify-edge) sections. + +The data lake and related storage will always be written to the host file system under the path `/datahub`, whatever is mounted there. You are expected to have a single shared NAS file system, such as NFS mounted at that path _on all nodes of the Kubernetes cluster that Edge is running on_. This is to ensure the resilience of your data lake contents. + +In order to access Dremio, you must also make the domain `datahub-` resolvable, just as the configured domain name and `management-` were made resolvable in [Accessing Edge](/edge-kubernetes/installing-edge-on-k8/#accessing-edge). + +### Comparison between DataHub Edge and DataHub Cloud {#comparison-between-datahub-edge-and-datahub-cloud} + +| Area | {{< product-c8y-iot >}} DataHub Edge | {{< product-c8y-iot >}} DataHub Cloud | +| ----- | ----- | ----- | ----- | +| High availability | Depending on any underlying virtualization technology | Depending on the cloud deployment setup | +| Vertical scalability | Yes | Yes | +| Horizontal scalability | No | Yes | +| Upgrades with no downtime | No | No | +| Installation | Offline & Online | Online | +| Dremio cluster setup | 1 master, 1 executor | Minimum 1 master, 1 executor | +| Data lakes | NAS or local disk | Azure Storage, S3, (NAS) | diff --git a/content/edge-kubernetes/installing-edge-on-k8-bundle/prerequisites.md b/content/edge-kubernetes/installing-edge-on-k8-bundle/prerequisites.md index 5fc4e4f26c..067f9a421b 100644 --- a/content/edge-kubernetes/installing-edge-on-k8-bundle/prerequisites.md +++ b/content/edge-kubernetes/installing-edge-on-k8-bundle/prerequisites.md @@ -6,8 +6,8 @@ layout: redirect |
Item
|Details| |:---|:---| -|Hardware|CPU: 6 cores
RAM: 10 GB
CPU Architecture: x86-64

An additional **2 CPU cores** and **4 GB RAM** are required if the {{< product-c8y-iot >}} Messaging Service is enabled, which is required for using the microservice-based data broker and Notifications 2.0.

**Info:** If you plan to install {{< product-c8y-iot >}} DataHub Edge, ensure your system meets the additional resource requirements outlined in the [DataHub Edge prerequisites](/datahub/running-datahub-on-the-edge/#prerequisites).

**Info:** These are the minimum system requirements for deploying Edge. If a custom microservice requires additional resources, you must allocate them on top of the minimum requirements. For example, if a microservice needs 2 CPU cores and 4 GB RAM, the Kubernetes node must have an additional 2 CPU cores and 4 GB RAM.

**Important:** MongoDB requires a CPU that supports AVX instructions. Ensure that the CPU type of the Kubernetes node supports AVX instructions. Use the command `lscpu` to check whether the CPU supports AVX instructions. AVX2 instructions are _not_ required. | -|Disk space|100 GB

An additional **15 GB** is required for Pulsar’s persistent message storage if the {{< product-c8y-iot >}} Messaging Service is enabled, which is required for using the microservice-based data broker and Notifications 2.0.

If you plan to install {{< product-c8y-iot >}} DataHub Edge, ensure your system meets the additional resource requirements outlined in the [DataHub Edge prerequisites](/datahub/running-datahub-on-the-edge/#prerequisites).

**Important**: This disk space will be consumed under a particular directory, depending on which Kubernetes distribution you are using, so the volume that you are sizing needs to be mounted over that directory. If you are using the **c8yedge** tool, this directory will be */var/lib/rancher/*.| +|Hardware|

CPU: 6 cores
RAM: 10 GB
CPU Architecture: x86-64

**{{< product-c8y-iot >}} Messaging Service** An additional **2 CPU cores** and **4 GB RAM** are required when enabled.

**{{< product-c8y-iot >}} DataHub** An additional **10 CPU cores** (or **6** at minimum) and **16 GB RAM** (or **10 GB** at minimum) are required when enabled.

**Info:** These are the minimum system requirements for deploying Edge. If a custom microservice requires additional resources, you must allocate them on top of the minimum requirements. For example, if a microservice needs 2 CPU cores and 4 GB RAM, the Kubernetes node must have an additional 2 CPU cores and 4 GB RAM.

**Important:** MongoDB requires a CPU that supports AVX instructions. Ensure that the CPU type of the Kubernetes node supports AVX instructions. Use the command `lscpu` to check whether the CPU supports AVX instructions. AVX2 instructions are _not_ required.| +|Disk space|

100 GB

**{{< product-c8y-iot >}} Messaging Service** An additional **15 GB** is required when enabled.

**{{< product-c8y-iot >}} DataHub** An additional **100 GB** is required when enabled

Most of this disk space will be consumed as Kubernetes Persistent Volumes, whose nature depends on which Kubernetes distribution you are using and the storage classes you have configured. If you are using the **c8yedge** tool, this space will be consumed under the directory */var/lib/rancher/*. However, DataHub's data lake contents will or should be written to a NAS location of your choice.

| |Edge license file|To request the license file for Edge, [contact product support](/additional-resources/contacting-support/)
In the email, you must include

- Your company name, under which the license has been bought

- The domain name (for example, myown.iot.com), where Edge will be reachable


For more information, see [Domain name validation for Edge license key generation](/edge-kubernetes/installing-edge-on-k8/#domain-name-validation-for-edge-license-key-generation).| |The Edge registry credentials|You will receive the Edge registry credentials along with the Edge license.| |TLS/SSL key and certificates|Optional.
TLS/SSL private key and domain certificates in PEM format.
Generate a TLS/SSL key pair and a Certificate Signing Request (CSR) following your organization's policies, specifying either a wildcard domain in the Common Name (CN) (for example, **.iot.com*) or listing required domains in the Subject Alternative Name (SAN) field, including the Edge tenant, {{< management-tenant >}}, and, if applicable, {{< product-c8y-iot >}} DataHub domains (for example, *myown.iot.com*, *management-myown.iot.com*, *datahub-myown.iot.com*).
Additionally, verify that the TLS/SSL certificate includes the complete certificate chain in the correct order.| diff --git a/content/edge-kubernetes/k8-edge-introduction-bundle/c8y-iot-edge-k8-operator.md b/content/edge-kubernetes/k8-edge-introduction-bundle/c8y-iot-edge-k8-operator.md index 773e528e55..7409d215a4 100644 --- a/content/edge-kubernetes/k8-edge-introduction-bundle/c8y-iot-edge-k8-operator.md +++ b/content/edge-kubernetes/k8-edge-introduction-bundle/c8y-iot-edge-k8-operator.md @@ -23,7 +23,7 @@ Features of Edge include: * [OPC UA](/device-integration/opcua/) with web-based UI for efficient connection management and seamless integration of industrial automation systems. * Easy installation and upgrades. * Microservice hosting, which allows to run server-side applications which may be used to extend the {{< product-c8y-iot >}} platform with customer-specific functionality (optional component). -* [DataHub](/edge-kubernetes/k8-edge-working-with-datahub/) for historical data storage and analytics (optional component). +* [DataHub](/datahub/datahub-overview/) for historical data storage and analytics (optional component). Kubernetes offers an efficient platform for deploying, scaling, and managing containerized applications using a centralized control plane. Given this, containers orchestrated by Kubernetes have become standard in contemporary IT, fitting a broad spectrum of deployment contexts. Edge capitalizes on these orchestration and management benefits, streamlining the operations of the Edge servers with other containerized applications in your deployment landscape. diff --git a/content/edge-kubernetes/k8-edge-working-with-datahub-bundle/datahub-edge.md b/content/edge-kubernetes/k8-edge-working-with-datahub-bundle/datahub-edge.md deleted file mode 100644 index 7bd8dcf2c0..0000000000 --- a/content/edge-kubernetes/k8-edge-working-with-datahub-bundle/datahub-edge.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -weight: 10 -title: Analytical querying with DataHub on Edge -layout: bundle -sector: - - edge_server ---- - -DataHub is an optional component of Edge. DataHub complements the ad-hoc querying of recent device data with analytical querying over long periods of time. For that purpose, data is moved from the Operational Store of Edge to a local data lake, with the data being stored in a concise and query-efficient format. DataHub allows you to run SQL queries against the data lake contents so that you can gain more insights into your device data. - -DataHub on Edge is the counterpart of DataHub, the variant for cloud deployments. To learn more about DataHub in general, see [DataHub overview](/datahub/datahub-overview). To learn more about DataHub on Edge, see [Running DataHub on the Edge](/datahub/running-datahub-on-the-edge/). diff --git a/content/edge-kubernetes/k8-edge-working-with-datahub-bundle/index.html b/content/edge-kubernetes/k8-edge-working-with-datahub-bundle/index.html deleted file mode 100644 index 84f055abd5..0000000000 --- a/content/edge-kubernetes/k8-edge-working-with-datahub-bundle/index.html +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Working with DataHub -headless: true ---- diff --git a/content/edge-kubernetes/k8-edge-working-with-datahub.md b/content/edge-kubernetes/k8-edge-working-with-datahub.md deleted file mode 100644 index b531309b90..0000000000 --- a/content/edge-kubernetes/k8-edge-working-with-datahub.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -weight: 80 -title: Working with DataHub -layout: bundle -sector: - - edge_server ---- diff --git a/content/edge-kubernetes/k8s-edge-messaging-service.md b/content/edge-kubernetes/k8s-edge-messaging-service.md index 5407e08e4c..c78c553b41 100644 --- a/content/edge-kubernetes/k8s-edge-messaging-service.md +++ b/content/edge-kubernetes/k8s-edge-messaging-service.md @@ -9,4 +9,4 @@ The {{< product-c8y-iot >}} Messaging Service is an optional component of the {{ To enable the Messaging Service in Edge, update the `spec.messagingService` field in the Edge custom resource (CR). After making the changes, apply the updated CR. For more details on the `spec.messagingService` field, refer to [Edge custom resource - Messaging Service](/edge-kubernetes/edge-custom-resource-definition/#messagingService). -For additional guidance, see the [Install Edge](/edge-kubernetes/installing-edge-on-k8/) and [Modify Edge](/edge-kubernetes/manage-edge/#modify-edge) sections in the Edge documentation. +For additional guidance, see the [Install Edge](/edge-kubernetes/installing-edge-on-k8/) and [Modify Edge](/edge-kubernetes/manage-edge/#modify-edge) sections.