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

[GRAFT][release/y2025] Remove SAG references for requesting license keys (#2779) #2786

Merged
merged 1 commit into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Expand Up @@ -10,7 +10,7 @@ This section defines the Edge deployment's configurations.
|:---|:---|:---|:---|:---|
|version|Yes|String| |Edge version to deploy.<br><br>For example, {{< c8y-edge-current-version >}}.0.0 for {{< c8y-edge-current-version-alt >}} and {{< c8y-edge-current-version >}}.0.1 for a fix-1 of {{< c8y-edge-current-version-alt >}}.
|domain|Yes|String||A fully qualified domain name. <p>For example, *myown.iot.com*. Here, you must have the Edge license for the domain name *iot.com* or *myown.iot.com*.
|licenseKey|Yes|String||Edge license key you received for the domain. <br>To request the license file for Edge, contact the logistics team for your region:<p style="margin: 0; padding-left: 2em;">- North and South America: LogisSrvus@softwareagusa.com <p style="margin: 0; padding-left: 2em;">- All Other Regions: LogisticsServiceCenterGER@softwareag.com </p><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).
|licenseKey|Yes|String||Edge license key you received for the domain. <br>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).
|company|Yes|String||Name of the "edge" tenant, for example, the company's name.
|tlsSecretName| No|String|The Edge operator generates and assigns self-signed TLS/SSL private key and certificates.|Name of the Kubernetes secret containing the TLS/SSL private key and certificates for the domain name specified in the `spec.domain` field. This secret must contain two keys:<p style="margin: 0; padding-left: 2em;">- **tls.key:** TLS/SSL private key in the PEM format.<br>Generate a TLS/SSL key pair and a Certificate Signing Request (CSR) according to your company policies, and submit it to your internal or external Certificate Authority (CA). When creating the CSR, in addition to providing the Common Name (CN), Organization (O), and other required details, you must specify the Subject Alternative Name (SAN) to request a multi-domain certificate. Ensure that the SAN includes the domain names for the "edge" tenant and {{< management-tenant >}}. If you plan to install {{< product-c8y-iot >}} DataHub, include its domain name as well. For instance, if your Edge domain is *myown.iot.com*, make sure *myown.iot.com*, *management.myown.iot.com*, and *datahub.myown.iot.com* are listed in the SAN field.</p><p style="margin: 0; padding-left: 2em;">- **tls.crt:** The TLS/SSL certificate chain associated with the private key in PEM format. It's essential to ensure the certificates are arranged in the correct sequence for TLS/SSL validation to succeed. The proper order of the certificate chain is:</p><p style="margin: 0; padding-left: 4em;">- **End-entity certificate:** This is the TLS/SSL certificate issued to your domain or server, sometimes referred to as the "leaf" or "server" certificate.</p><p style="margin: 0; padding-left: 4em;">- **Intermediate certificate(s):** These certificates link your end-entity certificate to the trusted root certificate. If there are multiple intermediate certificates, they must be ordered correctly as well.</p><p style="margin: 0; padding-left: 4em;">- **Root CA certificate:** This is the certificate for the Certificate Authority (CA) that is trusted by browsers and other clients. It's generally included last in the chain.</p> <p><p>For more information, see [TLS/SSL Secret](#tls-secret).<p><p>**Info:** The Edge operator retrieves this secret from the **`EDGE-CR-NAMESPACE`**. Ensure that this secret is created before initiating the Edge deployment or update process.
|email|Yes|String||Email used for the admin user.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,7 @@ c8yedge_registry_sync sync -v {{< c8y-edge-current-version >}}.0.1 -sr registry.
```

{{< c8y-admon-info >}}
To request the Edge registry credentials, contact the {{< company-c8y >}} logistics team for your region:
* North and South America: LogisSrvus@softwareagusa.com
* All Other Regions: LogisticsServiceCenterGER@softwareag.com
To request the Edge registry credentials, [contact product support](/additional-resources/contacting-support/).
{{< /c8y-admon-info >}}

### Update custom-environment-variables ConfigMap
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@ Enter password to access Edge operator registry:
```

{{< c8y-admon-info >}}
To request the Edge registry credentials, contact the {{< company-c8y >}} logistics team for your region:
* North and South America: LogisSrvus@softwareagusa.com
* All Other Regions: LogisticsServiceCenterGER@softwareag.com
To request the Edge registry credentials, [contact product support](/additional-resources/contacting-support/).
{{< /c8y-admon-info >}}

By default, the Edge operator is deployed within the **c8yedge** namespace. If you wish to install the Edge operator and Edge in a different namespace, you can specify it using the `-n` option in the installation script.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ layout: redirect
|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).|
|Edge license file|To request the license file for Edge, contact the logistics team for your region:<p style="margin: 0; padding-left: 2em;">- North and South America: LogisSrvus@softwareagusa.com <p style="margin: 0; padding-left: 2em;">- All Other Regions: LogisticsServiceCenterGER@softwareag.com </p><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).|
|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) according to your company policies, and submit it to your internal or external Certificate Authority (CA). When creating the CSR, in addition to providing the Common Name (CN), Organization (O), and other required details, you must specify the Subject Alternative Name (SAN) to request a multi-domain certificate. Ensure that the SAN includes the domain names for the "edge" tenant and {{< management-tenant >}}. If you plan to install {{< product-c8y-iot >}} DataHub, include its domain name as well. For instance, if your Edge domain is *myown.iot.com*, make sure *myown.iot.com*, *management.myown.iot.com*, and *datahub.myown.iot.com* are listed in the SAN field.<br>Additionally, verify that the TLS/SSL certificate includes the complete certificate chain in the correct order.|
|Connect Edge to the cloud|Optional. To connect and manage one or more Edge deployments from your {{< product-c8y-iot >}} cloud tenant, you will need an active {{< product-c8y-iot >}} {{< standard-tenant >}} with a subscription plan that includes the _advanced-software-mgmt_ microservice.|
Expand Down
2 changes: 1 addition & 1 deletion content/edge/edge-installation-bundle/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sector:
|:---|:---|
|**Hypervisor**|- The VMWare image is set with hardware version 13, which is compatible with ESXi 6.5, ESXi 6.7, ESXi 6.7 Update 2, ESXi 6.7 Update 3, ESXi 7.0, ESXi 7.0 Update 1, ESXi 7.0 Update 2, ESXi 7.0 Update 3, ESXi 8.0, ESXi 8.0 Update 1, and ESXi 8.0 Update 2. <br> - VMware Workstation Player 17.x and VMware Workstation Pro 17.x <br>- Hyper-V on Microsoft Windows 10 Enterprise, version 1809. The supported VM configuration version is 9.0.<br>**Important:** Ensure that you keep the virtualization platform updated and free from vulnerabilities by following the security advisories provided by the vendors of the hypervisor.
|**Edge appliance image**|To be downloaded from the [{{< c8y-resources-server >}}]({{< c8y-resources-server-link >}}), based on the target hypervisor. <br><br> For VMware (ESXi and Workstation Player), download all the 4 files:<br>- {{< product-c8y-iot >}} Edge - VMWare [Disc 1] (*version*)<br>- {{< product-c8y-iot >}} Edge - VMWare [Disc 2] (*version*)<br>- {{< product-c8y-iot >}} Edge - VMWare .mf (*version*)<br>- {{{< product-c8y-iot >}} Edge - VMWare .ovf (*version*)<br><br> For Hyper-V, download the ZIP file:<br>- {{< product-c8y-iot >}} Edge - HyperV (*version*)<br><br>The fixes for Edge:<br>- {{< product-c8y-iot >}} Edge (*version*) Update|
|**Edge license file**|To request the license file for Edge, contact the logistics team for your region:<br> - North and South America: LogisSrvus@softwareagusa.com <br>- All Other Regions: LogisticsServiceCenterGER@softwareag.com <br>In the email, you must include <br> - your company name, under which the license has been bought <br> - the domain name (for example, myedge.domain.com), where Edge will be reachable<br>For more information, see [Domain name validation for Edge license key generation](#domain-name-validation-for-edge-license-key-generation).|
|**Edge license file**|To request the license file for Edge, [contact product support](/additional-resources/contacting-support/)<br>In the email, you must include <br> - your company name, under which the license has been bought <br> - the domain name (for example, myedge.domain.com), where Edge will be reachable<br>For more information, see [Domain name validation for Edge license key generation](#domain-name-validation-for-edge-license-key-generation).|
|**SSL key and SSL certificate**|Optional. Use your internal or an external CA (Certification Authority) to generate these files. These files must not be password-protected. Ensure that the SSL certificate has the complete certificates chain in the right order.<br>**Info:** The .crt and .key files must be in the PEM format and the .key file must not be encrypted.|
|**DNS entry**|The DNS (Domain Name System) is used to resolve human readable host names like www.{{< domain-c8y >}} to machine readable IP addresses like 192.198.1.10. <br> If you want to connect to Edge appliance within your LAN, the DNS entry must be added for the domain name (URL under which Edge can be reached) with the IP address of the host.|
|**Edge cloud remote access**|To connect and manage one (or multiple) Edge appliances to your {{< product-c8y-iot >}} cloud tenant, you need an active {{< product-c8y-iot >}} {{< standard-tenant >}} with the Data Broker and Cloud Remote Access extensions.<br>**Info:** The Edge cloud remote access is an optional feature in Edge.|
Expand Down
Loading