Skip to content

Commit

Permalink
Prequisites and storage for Messaging Service
Browse files Browse the repository at this point in the history
  • Loading branch information
bbyreddy committed Feb 3, 2025
1 parent 9b9312a commit 6aacb72
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ The Edge operator requests three PVCs, as outlined in the table below. Each of t
|75 GB|`mongod-data-edge-db-rs0-0`|Claimed by the MongoDB server to retain application data. The default size is 75 GB, but this value can be adjusted using the `spec.mongodb.resources.requests.storage` field in the Edge CR file.
|10 GB|`microservices-registry-data`|Claimed by the private docker registry to store microservice images.
|5 GB|`edge-logs`|Claimed by the Edge logging component to store the application and system logs.
|10 Gi|`pulsar-bookie-ledgers-pulsar-bookie-0`|Claimed by the Pulsar Bookkeeper Ledgers pod, which is deployed only when the Messaging Service is enabled (required for the microservice-based data broker and Notifications 2.0).
|2 Gi|`pulsar-bookie-journal-pulsar-bookie-0`|Claimed by the Pulsar Bookkeeper Journal pod, which is deployed only when the Messaging Service is enabled (required for the microservice-based data broker and Notifications 2.0).
|2 Gi|`pulsar-zookeeper-data-pulsar-zookeeper-0`|Claimed by the Pulsar Zookeeper pod, which is deployed only when the Messaging Service is enabled (required for the microservice-based data broker and Notifications 2.0).

To guarantee the retention of physical storage even after the PVC is deleted (for example, when Edge is deleted) and to enable future storage expansion if needed, it's crucial to configure the StorageClass and/or the PVs with the following settings:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ layout: redirect

|<div style="width:140px">Item</div>|Details|
|:---|:---|
|Hardware|CPU: 6 cores<br>RAM: 10 GB<br>CPU Architecture: x86-64 <p><p>**Info:** These are the minimum system requirements for deploying Edge. If a custom microservice requires additional resources, you must configure the system accordingly in addition to the minimum requirements. For example, if a custom microservice requires 2 CPU cores and 4 GB of RAM, then the Kubernetes node must have 8 CPU cores (6 cores for standard workloads + 2 cores for your microservice) and 14 GB of RAM (10 GB for standard workloads + 4 GB for your microservice). <br><br>**Important:** MongoDB requires a CPU that supports AVX instructions. Ensure that the CPU type of the Kubernetes node supports AVX instructions. Use the command `sudo lscpu` to check whether the CPU supports AVX instructions.|
|Hardware|CPU: 6 cores<br>RAM: 10 GB<br>CPU Architecture: x86-64 <p><p>**Info:** If the Messaging Service is enabled (required for the microservice-based data broker and Notifications 2.0), the Kubernetes node must have an additional 2 CPU cores and 4 GB RAM. <br><br>**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. <br><br>**Important:** MongoDB requires a CPU that supports AVX instructions. Ensure that the CPU type of the Kubernetes node supports AVX instructions. Use the command `sudo lscpu` to check whether the CPU supports AVX instructions.|
|Kubernetes|Version 1.25.x has been tested (with potential compatibility for subsequent versions) and is supported across the following platforms:<p style="margin: 0; padding-left: 2em;">- [Lightweight Kubernetes (K3s)](https://docs.k3s.io/installation). To enable the proper functioning of the Edge operator on K3s, you must install K3s with the following configuration options. For more information, see [Special instructions for K3s](/edge-kubernetes/installing-edge-on-k8/#special-instructions-for-k3s). <p style="margin: 0; padding-left: 2em;">- [Kubernetes (K8s)](https://kubernetes.io/docs/setup/)<p style="margin: 0; padding-left: 2em;">- [Amazon Elastic Kubernetes Service (EKS)](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html)<p style="margin: 0; padding-left: 2em;">- [Microsoft Azure Kubernetes Service (AKS)](https://learn.microsoft.com/en-us/azure/aks/learn/quick-kubernetes-deploy-portal?tabs=azure-cli) <p><p>**Info:** Edge on Kubernetes has undergone testing on the Kubernetes platforms mentioned above, using the Containerd, CRI-O, and Docker container runtimes. {{< c8y-admon-important >}} Edge on Kubernetes is tested and supported on single-node Kubernetes clusters. {{< /c8y-admon-important >}}|
|Helm version 3.x|Refer to [Installing Helm](https://helm.sh/docs/intro/install/) for the installation instructions.|
|Disk space|Three static Persistent Volumes (PV) or a StorageClass configured with dynamic provisioning to bind.<p style="margin: 0; padding-left: 2em;">- 75 GB for the Persistent Volume Claim (PVC) made for MongoDB (configurable through the Custom Resource).<p style="margin: 0; padding-left: 2em;">- 10 GB for the Persistent Volume Claim (PVC) made for the Private Registry to host custom microservices.<p style="margin: 0; padding-left: 2em;">- 5 GB for the Persistent Volume Claim (PVC) made for application logs.</p><br>For more information about configuring the storage, see [Configuring storage](/edge-kubernetes/installing-edge-on-k8/#configuring-storage).|
|Disk space|Three static Persistent Volumes (PV) or a StorageClass configured with dynamic provisioning to bind.<p style="margin: 0; padding-left: 2em;">- 75 GB for the Persistent Volume Claim (PVC) made for MongoDB (configurable through the Custom Resource).<p style="margin: 0; padding-left: 2em;">- 10 GB for the Persistent Volume Claim (PVC) made for the Private Registry to host custom microservices.<p style="margin: 0; padding-left: 2em;">- 5 GB for the Persistent Volume Claim (PVC) made for application logs.</p><p><p>If the Messaging Service is enabled (required for the microservice-based data broker and Notifications 2.0), an additional three static Persistent Volumes (PV) or a StorageClass configured with dynamic provisioning to bind, are required.<p style="margin: 0; padding-left: 2em;">- 10 Gi for the Persistent Volume Claim (PVC) made for Pulsar Bookkeeper Ledgers.<p style="margin: 0; padding-left: 2em;">- 2 Gi for the Persistent Volume Claim (PVC) made for Pulsar Bookkeeper Journal.<p style="margin: 0; padding-left: 2em;">- 2 Gi for the Persistent Volume Claim (PVC) made for Pulsar Zookeeper.</p><br>For more information about configuring the storage, see [Configuring storage](/edge-kubernetes/installing-edge-on-k8/#configuring-storage).|
|Edge license file|To request the license file for Edge, [contact product support](/additional-resources/contacting-support/)<br>In the email, you must include <p style="margin: 0; padding-left: 2em;">- Your company name, under which the license has been bought <p style="margin: 0; padding-left: 2em;">- The domain name (for example, myown.iot.com), where Edge will be reachable</p><br>For more information, see [Domain name validation for Edge license key generation](/edge/edge-installation/#domain-name-validation-for-edge-license-key-generation).|
|The Edge operator registry credentials|You will receive the Edge operator registry credentials along with the Edge license.|
|TLS/SSL key and certificates|Optional. TLS/SSL private key and domain certificates in PEM format.<br>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*).<br>Additionally, verify that the TLS/SSL certificate includes the complete certificate chain in the correct order.|
Expand Down

0 comments on commit 6aacb72

Please sign in to comment.