From 46c1df8c6465df6144a8e2bf2a5777c933d1178f Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Mon, 25 Mar 2024 14:30:46 -0500 Subject: [PATCH 1/2] ENDOC-801 new env vars EntApp CRD --- .../docs/next/docs/reference/entandoapp-cr.md | 15 +++++++++------ .../docs/v7.3/docs/reference/entandoapp-cr.md | 15 +++++++++------ 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/vuepress/docs/next/docs/reference/entandoapp-cr.md b/vuepress/docs/next/docs/reference/entandoapp-cr.md index b0b60409bb..4dcf78c431 100644 --- a/vuepress/docs/next/docs/reference/entandoapp-cr.md +++ b/vuepress/docs/next/docs/reference/entandoapp-cr.md @@ -3,7 +3,7 @@ sidebarDepth: 2 --- # EntandoApp Custom Resource -The EntandoApp CR is the deployment of a Docker image that hosts the Entando and Java-based web application. Server-side components include the Entando App Engine, Entando Component Manager, Entando App Builder, and the user-facing application. +The EntandoApp CR is the deployment of a Docker image that hosts the Entando Java-based web application. Server-side components include the Entando App Engine, Entando Component Manager, Entando App Builder, and the user-facing application. Entando offers standard Tomcat, WildFly (deprecated), or EAP (deprecated) images for the application. @@ -25,13 +25,17 @@ spec: ## Specifications | Spec Name | Description | | :- | :- | -| `ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | -| `ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` | The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | +| `ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | +| `ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` |The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | | `ENTANDO_ECR_POSTINIT` | The configuration of the postinit process. | -| `ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` | The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | -| `spec.customServerImage`| Used to deploy the Docker image containing your custom Entando App. Follow these instructions on how to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| +| `ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` |The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | +| `spec.customServerImage`| The Docker image containing your custom Entando App. Follow these instructions to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| |`spec.dbms` | Allowed values are: MySQL, PostgreSQL (default), Oracle, or embedded. Oracle is only supported as an external database.| |`spec.ecrGitSshSecretName`| The configuration used by the Entando Component Manager to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| +|`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. These variables pass to all components, and can sometimes be used as a mechanism to override any of the default environment variables that need customization.| +|`spec.environmentVariablesAppBuilder`| Optional: A map of environment variables propagated only to the App Builder for customization. These variables work similar to the general spec but have precedence. | +|`spec.environmentVariablesAppEngine`| Optional: A map of environment variables propagated only to the App Engine for customization. These variables work similar to the general spec but have precedence. | +|`spec.environmentVariablesComponentManager`|Optional: A map of environment variables propagated only to the Component Manager for customization. These variables work similar to the general spec but have precedence. | |`spec.ingressPath`| Specifies the ingress path of the EntandoApp to be deployed. | |`spec.ingressHostName`| The hostname of the Kubernetes ingress to be created for the EntandoApp. EntandoPlugins linked to this app will also be made available on the host.| |`spec.replicas`| The number of replicas to be made available on the deployment.| @@ -40,4 +44,3 @@ spec: |`spec.standardServerImage`| `entando-de-app-tomcat` is the default image. This property and the `spec.customServerImage` are mutually exclusive. Refer to the [Docker image section](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#how-it-resolves-docker-images) to see how the Docker registry and versions are calculated.| |`spec.storageClass` | Name of the StorageClass to use for PersistentVolumeClaims created for this EntandoApp. For more information, go to [Kubernetes explanation of storage classes](https://kubernetes.io/docs/concepts/storage/storage-classes/).| |`spec.tlsSecretName` | The name of a standard Kubernetes [TLS Secret](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) that will be used for the resulting ingress. This is only required if the [globally configured TLS Secret](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#tls) for the operator is absent. | -|`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. These variables can sometimes be used as a mechanism to override any of the default environment variables that need customization.| \ No newline at end of file diff --git a/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md b/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md index b0b60409bb..4dcf78c431 100644 --- a/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md +++ b/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md @@ -3,7 +3,7 @@ sidebarDepth: 2 --- # EntandoApp Custom Resource -The EntandoApp CR is the deployment of a Docker image that hosts the Entando and Java-based web application. Server-side components include the Entando App Engine, Entando Component Manager, Entando App Builder, and the user-facing application. +The EntandoApp CR is the deployment of a Docker image that hosts the Entando Java-based web application. Server-side components include the Entando App Engine, Entando Component Manager, Entando App Builder, and the user-facing application. Entando offers standard Tomcat, WildFly (deprecated), or EAP (deprecated) images for the application. @@ -25,13 +25,17 @@ spec: ## Specifications | Spec Name | Description | | :- | :- | -| `ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | -| `ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` | The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | +| `ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | +| `ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` |The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | | `ENTANDO_ECR_POSTINIT` | The configuration of the postinit process. | -| `ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` | The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | -| `spec.customServerImage`| Used to deploy the Docker image containing your custom Entando App. Follow these instructions on how to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| +| `ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` |The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | +| `spec.customServerImage`| The Docker image containing your custom Entando App. Follow these instructions to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| |`spec.dbms` | Allowed values are: MySQL, PostgreSQL (default), Oracle, or embedded. Oracle is only supported as an external database.| |`spec.ecrGitSshSecretName`| The configuration used by the Entando Component Manager to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| +|`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. These variables pass to all components, and can sometimes be used as a mechanism to override any of the default environment variables that need customization.| +|`spec.environmentVariablesAppBuilder`| Optional: A map of environment variables propagated only to the App Builder for customization. These variables work similar to the general spec but have precedence. | +|`spec.environmentVariablesAppEngine`| Optional: A map of environment variables propagated only to the App Engine for customization. These variables work similar to the general spec but have precedence. | +|`spec.environmentVariablesComponentManager`|Optional: A map of environment variables propagated only to the Component Manager for customization. These variables work similar to the general spec but have precedence. | |`spec.ingressPath`| Specifies the ingress path of the EntandoApp to be deployed. | |`spec.ingressHostName`| The hostname of the Kubernetes ingress to be created for the EntandoApp. EntandoPlugins linked to this app will also be made available on the host.| |`spec.replicas`| The number of replicas to be made available on the deployment.| @@ -40,4 +44,3 @@ spec: |`spec.standardServerImage`| `entando-de-app-tomcat` is the default image. This property and the `spec.customServerImage` are mutually exclusive. Refer to the [Docker image section](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#how-it-resolves-docker-images) to see how the Docker registry and versions are calculated.| |`spec.storageClass` | Name of the StorageClass to use for PersistentVolumeClaims created for this EntandoApp. For more information, go to [Kubernetes explanation of storage classes](https://kubernetes.io/docs/concepts/storage/storage-classes/).| |`spec.tlsSecretName` | The name of a standard Kubernetes [TLS Secret](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) that will be used for the resulting ingress. This is only required if the [globally configured TLS Secret](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#tls) for the operator is absent. | -|`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. These variables can sometimes be used as a mechanism to override any of the default environment variables that need customization.| \ No newline at end of file From 1a10a1ae4b5b186100fc90584dc3f5e93eefd595 Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Tue, 26 Mar 2024 14:00:49 -0500 Subject: [PATCH 2/2] ENDOC-801 review edits --- .../docs/next/docs/reference/entandoapp-cr.md | 22 +++++++++---------- .../docs/v7.3/docs/reference/entandoapp-cr.md | 16 +++++++------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/vuepress/docs/next/docs/reference/entandoapp-cr.md b/vuepress/docs/next/docs/reference/entandoapp-cr.md index 4dcf78c431..075ca90c5f 100644 --- a/vuepress/docs/next/docs/reference/entandoapp-cr.md +++ b/vuepress/docs/next/docs/reference/entandoapp-cr.md @@ -23,16 +23,16 @@ spec: replicas: 1 ``` ## Specifications -| Spec Name | Description | -| :- | :- | -| `ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | -| `ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` |The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | -| `ENTANDO_ECR_POSTINIT` | The configuration of the postinit process. | -| `ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` |The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | -| `spec.customServerImage`| The Docker image containing your custom Entando App. Follow these instructions to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| -|`spec.dbms` | Allowed values are: MySQL, PostgreSQL (default), Oracle, or embedded. Oracle is only supported as an external database.| +|Spec Name| Description | +|:- |:- | +|`ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | +|`ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` |The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | +|`ENTANDO_ECR_POSTINIT` | The configuration of the postinit process. | +|`ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` |The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | +|`spec.customServerImage`| The Docker image containing your custom Entando App. Follow these instructions to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| +|`spec.dbms`| Allowed values are: MySQL, PostgreSQL (default), Oracle, or embedded. Oracle is only supported as an external database.| |`spec.ecrGitSshSecretName`| The configuration used by the Entando Component Manager to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| -|`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. These variables pass to all components, and can sometimes be used as a mechanism to override any of the default environment variables that need customization.| +|`spec.environmentVariables`| A set of environment variables mapped to the Docker images of the App Builder, App Engine, and Component Manager. They can be used as a mechanism to override any of the default environment variables that need customization.| |`spec.environmentVariablesAppBuilder`| Optional: A map of environment variables propagated only to the App Builder for customization. These variables work similar to the general spec but have precedence. | |`spec.environmentVariablesAppEngine`| Optional: A map of environment variables propagated only to the App Engine for customization. These variables work similar to the general spec but have precedence. | |`spec.environmentVariablesComponentManager`|Optional: A map of environment variables propagated only to the Component Manager for customization. These variables work similar to the general spec but have precedence. | @@ -42,5 +42,5 @@ spec: |`spec.resourceRequirements`| The minimum and maximum [resource allocation](../reference/custom-resources.md#general-resourcerequirements-specifications) for the Entando App Engine container.| |`spec.serviceAccountToUse`| The Kubernetes service account in the namespace of the EntandoApp used for the pods hosting the EntandoApps. The default is 'default'.| |`spec.standardServerImage`| `entando-de-app-tomcat` is the default image. This property and the `spec.customServerImage` are mutually exclusive. Refer to the [Docker image section](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#how-it-resolves-docker-images) to see how the Docker registry and versions are calculated.| -|`spec.storageClass` | Name of the StorageClass to use for PersistentVolumeClaims created for this EntandoApp. For more information, go to [Kubernetes explanation of storage classes](https://kubernetes.io/docs/concepts/storage/storage-classes/).| -|`spec.tlsSecretName` | The name of a standard Kubernetes [TLS Secret](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) that will be used for the resulting ingress. This is only required if the [globally configured TLS Secret](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#tls) for the operator is absent. | +|`spec.storageClass`| Name of the StorageClass to use for PersistentVolumeClaims created for this EntandoApp. For more information, go to [Kubernetes explanation of storage classes](https://kubernetes.io/docs/concepts/storage/storage-classes/).| +|`spec.tlsSecretName`| The name of a standard Kubernetes [TLS Secret](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) that will be used for the resulting ingress. This is only required if the [globally configured TLS Secret](https://github.com/entando-k8s/entando-k8s-controller-coordinator/blob/master/charts/entando-k8s-controller-coordinator/README.md#tls) for the operator is absent. | diff --git a/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md b/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md index 4dcf78c431..bfda7b37a9 100644 --- a/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md +++ b/vuepress/docs/v7.3/docs/reference/entandoapp-cr.md @@ -23,16 +23,16 @@ spec: replicas: 1 ``` ## Specifications -| Spec Name | Description | -| :- | :- | -| `ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | -| `ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` |The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | -| `ENTANDO_ECR_POSTINIT` | The configuration of the postinit process. | -| `ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` |The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | -| `spec.customServerImage`| The Docker image containing your custom Entando App. Follow these instructions to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| +|Spec Name| Description | +|:-| :- | +|`ENTANDO_ECR_DEAPP_REQUEST_RETRIES`| The number of times the Componenent Manager retries the component create/update process before quitting. Defaults to 3. | +|`ENTANDO_ECR_DEAPP_REQUEST_BACKOFF` |The number of seconds to wait before the next 'create' attempt is executed. Defaults to 5. | +|`ENTANDO_ECR_POSTINIT` | The configuration of the postinit process. | +|`ENTANDO_CONTAINER_REGISTRY_CREDENTIALS` |The configuration for authenticated [OCI registries](../../tutorials/curate/bundle-private-images.md). | +|`spec.customServerImage`| The Docker image containing your custom Entando App. Follow these instructions to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| |`spec.dbms` | Allowed values are: MySQL, PostgreSQL (default), Oracle, or embedded. Oracle is only supported as an external database.| |`spec.ecrGitSshSecretName`| The configuration used by the Entando Component Manager to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| -|`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. These variables pass to all components, and can sometimes be used as a mechanism to override any of the default environment variables that need customization.| +|`spec.environmentVariables`| A set of environment variables mapped to the Docker images of the App Builder, App Engine, and Component Manager. They can be used as a mechanism to override any of the default environment variables that need customization.| |`spec.environmentVariablesAppBuilder`| Optional: A map of environment variables propagated only to the App Builder for customization. These variables work similar to the general spec but have precedence. | |`spec.environmentVariablesAppEngine`| Optional: A map of environment variables propagated only to the App Engine for customization. These variables work similar to the general spec but have precedence. | |`spec.environmentVariablesComponentManager`|Optional: A map of environment variables propagated only to the Component Manager for customization. These variables work similar to the general spec but have precedence. |