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-782 add vars for paths #832

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ENDOC-782 add vars for paths #832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions vuepress/docs/next/tutorials/consume/cds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,20 @@ kubectl scale deploy/YOUR-APP-NAME-deployment --replicas=1 -n YOUR-NAMESPACE
```

5. Confirm the CDS is working by checking that digital assets are served from the `CDS_PUBLIC_URL`. This includes images displayed on the sample page created by the [Welcome Wizard](../../docs/compose/welcome-wizard.md).

## Options
### Customize Access to Static Resources
To customize the context of your static assets, use the following environment variables to define their paths. These are optional variables, and the 'internal' path is required only if the internal folder name is different from the public path.

**For the Primary Tenant**, add these variables with your values in the `EntandoApp` deployment:
``` yaml
- name: CDS_PUBLIC_PATH
value: /YOUR-PUBLIC-PATH
- name: CDS_INTERNAL_PUBLIC_SECTION
value: /YOUR-INTERNAL-PUBLIC-PATH
Copy link

Choose a reason for hiding this comment

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

I think it's better to tell what is the default value for each option

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@eugeniosant, aren't the default values just empty?

```
**For Secondary Tenants**, add these variables with your values in the [Tenant Configuration Secret](./multitenancy.md#tenant-configuration-secret):
``` JSON
"cdsPublicPath": "/YOUR-PUBLIC-PATH",
"cdsInternalPublicSection": "/YOUR-INTERNAL-PUBLIC-PATH",
```
7 changes: 5 additions & 2 deletions vuepress/docs/next/tutorials/consume/multitenancy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ kubectl apply -f YOUR-TENANT-NAME-INGRESS.yaml -n YOUR-NAMESPACE
```

#### Tenant Configuration Secret
A single Secret needs to be defined with the configuration for each of the tenants. If the `entando-tenants-secret.yaml` already exists, then it should be edited with the addition of a new JSON block for the tenant.
A single Secret needs to be defined with the configuration for each of the tenants. If `entando-tenants-secret.yaml` already exists, then it should be edited with the addition of a new JSON block for the tenant.

1. Download the template `entando-tenants-secret.yaml`:

Expand All @@ -145,6 +145,8 @@ A single Secret needs to be defined with the configuration for each of the tenan
```
kubectl apply -f entando-tenant-secret.yaml -n YOUR-NAMESPACE
```
Optional:
If a custom path is needed for static resources in secondary tenants, environment variables can be defined in the configuration Secret. For details, see the [CDS setup for Entando Multitenancy under Options](./cds.md#options).

### Configure the EntandoApp
The EntandoApp has to be configured just once to point to the `entando-tenants-secret.yaml`. When additional tenants are added, the EntandoApp deployment only needs to be restarted.
Expand Down Expand Up @@ -183,7 +185,7 @@ To create or adapt bundles for multitenant applications, environment variables c
* [Add a Registry to you Local Hub](../solution/entando-hub.md#add-a-catalog-registry)
* [Configure External DBMS for Microservices](./external-db-ms.md)

## Appendix
## Options
### Liquibase Options
Liquibase is the default for database management for multitenancy on Entando, but this process can be modified with the following methods.

Expand Down Expand Up @@ -222,3 +224,4 @@ Add these environment variables to the `entando-de-app-tomcat` deployment to cus
* For the Tomcat application server, use `TOMCAT_MAX_POST_SIZE` to configure connector maxPostSize; the default value is 209,715,200 bytes. Enter the value in bytes.

* For the application, use `FILE_UPLOAD_MAX_SIZE` to configure the upload limit; the default value is 52,428,800 bytes. Enter the value in bytes.

17 changes: 17 additions & 0 deletions vuepress/docs/v7.3/tutorials/consume/cds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,20 @@ kubectl scale deploy/YOUR-APP-NAME-deployment --replicas=1 -n YOUR-NAMESPACE
```

5. Confirm the CDS is working by checking that digital assets are served from the `CDS_PUBLIC_URL`. This includes images displayed on the sample page created by the [Welcome Wizard](../../docs/compose/welcome-wizard.md).

## Options
### Customize Access to Static Resources
To customize the context of your static assets, use the following environment variables to define their paths. These are optional variables, and the 'internal' path is required only if the internal folder name is different from the public path.

**For the Primary Tenant**, add these variables with your values in the `EntandoApp` deployment:
``` yaml
- name: CDS_PUBLIC_PATH
value: /YOUR-PUBLIC-PATH
Copy link

Choose a reason for hiding this comment

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

These options aren't present in 7.3 distribution (I see the folder v7.3)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@eugeniosant Will it be present for 7.3.1 and do you know if that's going to be released anytime soon?

- name: CDS_INTERNAL_PUBLIC_SECTION
value: /YOUR-INTERNAL-PUBLIC-PATH
```
**For Secondary Tenants**, add these variables with your values in the [Tenant Configuration Secret](./multitenancy.md#tenant-configuration-secret):
``` JSON
"cdsPublicPath": "/YOUR-PUBLIC-PATH",
"cdsInternalPublicSection": "/YOUR-INTERNAL-PUBLIC-PATH",
```
7 changes: 5 additions & 2 deletions vuepress/docs/v7.3/tutorials/consume/multitenancy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ kubectl apply -f YOUR-TENANT-NAME-INGRESS.yaml -n YOUR-NAMESPACE
```

#### Tenant Configuration Secret
A single Secret needs to be defined with the configuration for each of the tenants. If the `entando-tenants-secret.yaml` already exists, then it should be edited with the addition of a new JSON block for the tenant.
A single Secret needs to be defined with the configuration for each of the tenants. If `entando-tenants-secret.yaml` already exists, then it should be edited with the addition of a new JSON block for the tenant.

1. Download the template `entando-tenants-secret.yaml`:

Expand All @@ -145,6 +145,8 @@ A single Secret needs to be defined with the configuration for each of the tenan
```
kubectl apply -f entando-tenant-secret.yaml -n YOUR-NAMESPACE
```
Optional:
If a custom path is needed for static resources in secondary tenants, environment variables can be defined in the configuration Secret. For details, see the [CDS setup for Entando Multitenancy under Options](./cds.md#options).

### Configure the EntandoApp
The EntandoApp has to be configured just once to point to the `entando-tenants-secret.yaml`. When additional tenants are added, the EntandoApp deployment only needs to be restarted.
Expand Down Expand Up @@ -183,7 +185,7 @@ To create or adapt bundles for multitenant applications, environment variables c
* [Add a Registry to you Local Hub](../solution/entando-hub.md#add-a-catalog-registry)
* [Configure External DBMS for Microservices](./external-db-ms.md)

## Appendix
## Options
### Liquibase Options
Liquibase is the default for database management for multitenancy on Entando, but this process can be modified with the following methods.

Expand Down Expand Up @@ -222,3 +224,4 @@ Add these environment variables to the `entando-de-app-tomcat` deployment to cus
* For the Tomcat application server, use `TOMCAT_MAX_POST_SIZE` to configure connector maxPostSize; the default value is 209,715,200 bytes. Enter the value in bytes.

* For the application, use `FILE_UPLOAD_MAX_SIZE` to configure the upload limit; the default value is 52,428,800 bytes. Enter the value in bytes.

Loading