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.

Sign up for GitHub

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

ENDOC-801 7.3.1-new env vars EntApp CRD #827

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

ENDOC-801 7.3.1-new env vars EntApp CRD #827

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46c1df8
ENDOC-801 new env vars EntApp CRD
jyunmitch Mar 25, 2024
1a10a1a
ENDOC-801 review edits
jyunmitch Mar 26, 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
22 changes: 11 additions & 11 deletions vuepress/docs/next/docs/reference/entandoapp-cr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.|
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@w-caffiero-entando, Is this better? can you approve this PR if this is okay?

|`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. |
Expand All @@ -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. |
16 changes: 8 additions & 8 deletions vuepress/docs/v7.3/docs/reference/entandoapp-cr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Loading