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

Endoc 378 #397

Merged
merged 3 commits into from
Jan 27, 2022
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
4 changes: 2 additions & 2 deletions vuepress/docs/.vuepress/next.js
Original file line number Diff line number Diff line change
Expand Up @@ -300,8 +300,8 @@ module.exports = {
path: path + 'samples/customer-portal.md',
},
{
title: 'Hub',
path: path + 'samples/hub.md',
title: 'Entando Hub',
path: path + 'samples/entando-hub.md',
},
{
title: 'Process Driven Applications (PDA)',
Expand Down
4 changes: 2 additions & 2 deletions vuepress/docs/.vuepress/v632.js
Original file line number Diff line number Diff line change
Expand Up @@ -294,8 +294,8 @@ module.exports = {
path: path + 'samples/install-standard-demo.md',
},
{
title: 'Hub',
path: path + 'samples/hub.md',
title: 'Entando Hub',
path: path + 'samples/entando-hub.md',
},
{
title: 'Process Driven Applications (PDA)',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The Hub is installed using the Entando Component Repository (ECR) and two Entand
### Installation Steps

1. Apply the Custom Resource Definitions for the Hub component bundles. You'll need to adjust the `-n entando` option in each command to match your namespace or project.

```
ent bundler from-git -r https://github.com/entando-samples/entando-hub-application-bundle.git -d | ent kubectl apply -n entando -f -
```
Expand All @@ -43,15 +44,23 @@ ent bundler from-git -r https://github.com/entando-samples/entando-hub-content-b

3. Select `Repository` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below.

![hub-install.png](./hub-images/hub-install.png)
![install-bundles.png](./hub-images/install-bundles.png)

4. Select `Install` for each bundle, where order of installation is important. The `entando-hub-application` bundle must be installed first because it provides the `entando-hub` bundle with MFEs. It may take several minutes to download the Docker images for the microservices and install related assets.

4. Select `Install` for each bundle, where order of installation is important. The `entando-hub-bundle` will need to be installed first, as it provides the `entando-hub-content-bundle` with MFEs to set up each of the pages. An installation can take several minutes while the application downloads the Docker images for the microservices and installs the related assets.
:::warning
A cache issue impacting the first deployment of the `entando-hub` bundle can prevent all widgets or MFEs from appearing on some pages, particularly the Dashboard page.

:::warning
There is a cache issue when deploying the Hub bundles where not all widgets or MFEs initially appear on some pages, particularly the Dashboard page. Restarting the quickstart-server pod (which holds the Entando App Engine) will clear the cache. This is only necessary on the initial install.
To clear the cache, select `Administration` from the bottom of the left menu, then `Reload configuration`.

Alternatively, restarting the quickstart-server pod (which contains the Entando App Engine) will also clear the cache, and can be achieved with `ent k delete pod/<YOUR QUICKSTART-SERVER POD>`, e.g. `ent k delete pod/quickstart-server-deployment-5d785b997c-r4sc8`. It will take several minutes for the pod to redeploy after deletion.
:::

5. The Hub can be accessed from the App Builder by navigating to `Pages → Management`, finding `Hub Test` **change** in the page tree, and clicking `View Published Page` from its actions.
5. Setup permissions to configure the service:
- Login to Keycloak as an admin. To manage the required Keycloak instance, see [Entando Identity Management -- Keycloak](../../docs/reference/identity-management.md#logging-into-your-keycloak-instance).
- Go to `Users → admin → Role Mappings`, select `entandopsdh-entando-hub-catalog-server` as the `Client Role`, then add `eh-admin` to `Assigned Roles`.

6. Access the Hub from the App Builder by navigating to `Pages → Management`, finding `Entando Hub` in the page tree, and clicking `View Published Page` from its actions.

## Configuration

Expand Down Expand Up @@ -130,7 +139,7 @@ A single Spring Boot microservice provides two REST endpoints:
- The second provides methods that support the Entando App Builder integration (7.0.0+).

### Content
The Hub content bundle includes a custom template and a page preconfigured with the main Hub micro frontends.
The Hub content bundle (`entando-hub`) includes a custom template and a page preconfigured with the main Hub micro frontends.
Copy link
Collaborator

Choose a reason for hiding this comment

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

not a big deal, but is the main MFE a singular thing or plural?

Copy link
Member Author

Choose a reason for hiding this comment

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

Plural, there are 2 currently.


### Integration
The Entando App Builder should be configured using the endpoint `BASEURL/entando-hub-api/appbuilder/api`, where the BASEURL is the URL for the Entando Application.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vuepress/docs/next/tutorials/samples/hub-images/hub-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 9 additions & 3 deletions vuepress/docs/next/tutorials/samples/pda-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ There are numerous assets installed as part of the Entando PDA plugin. Entando B

### Installation Steps

1. Apply the definitions for the bundle that assembles the PDA plugin components. You'll need to adjust the `-n entando` option in each command to match your namespace or project.
1. Apply the Custom Resource Definition for the PDA plugin component bundle. You'll need to adjust the `-n entando` option in each command to match your namespace or project.
```
ent bundler from-git -r https://github.com/entando-samples/entando-process-driven-plugin-bundle.git -d | ent kubectl apply -n entando -f -
```
Expand All @@ -40,6 +40,8 @@ ent bundler from-git -r https://github.com/entando-samples/entando-process-drive

3. Select `Repository` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below.

![pda-install.png](./pda-images/pda-install.png)

4. Select `Install` to install the bundle. An installation can take several minutes while the application downloads the Linux images for the microservices and installs the related assets.

5. Setup permissions to configure the service:
Expand All @@ -57,8 +59,12 @@ ent bundler from-git -r https://github.com/entando-samples/entando-process-drive
- PDA Smart Inbox
- PDA Task Details

:::warning
There is a cache issue when deploying the PDA plugin bundle which means not all widgets or MFEs initially appear on some pages, particularly the Dashboard page. Restarting the quickstart-server pod (which holds the Entando App Engine) will clear the cache. This is only necessary on the initial install.
:::warning
A cache issue impacting the first deployment of the `entando-pda-plugin-bundle` can prevent all widgets or MFEs from appearing on some pages, particularly the Dashboard page.

To clear the cache, select `Administration` from the bottom of the left menu, then `Reload configuration`.

Alternatively, restarting the quickstart-server pod (which contains the Entando App Engine) will also clear the cache, and can be achieved with `ent k delete pod/<YOUR QUICKSTART-SERVER POD>`, e.g. `ent k delete pod/quickstart-server-deployment-5d785b997c-r4sc8`. It will take several minutes for the pod to redeploy after deletion.
:::

6. Utilization of the PDA plugin begins with the Smart Inbox, which can be accessed from the App Builder by navigating to `Pages → Management`, finding `PDA Smart Inbox` in the page tree, and clicking `View Published Page` from its actions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The Hub is installed using the Entando Component Repository (ECR) and two Entand
### Installation Steps

1. Apply the Custom Resource Definitions for the Hub component bundles. You'll need to adjust the `-n entando` option in each command to match your namespace or project.

```
ent bundler from-git -r https://github.com/entando-samples/entando-hub-application-bundle.git -d | ent kubectl apply -n entando -f -
```
Expand All @@ -43,15 +44,23 @@ ent bundler from-git -r https://github.com/entando-samples/entando-hub-content-b

3. Select `Repository` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below.

![hub-install.png](./hub-images/hub-install.png)
![install-bundles.png](./hub-images/install-bundles.png)

4. Select `Install` for each bundle, where order of installation is important. The `entando-hub-application` bundle must be installed first because it provides the `entando-hub` bundle with MFEs. It may take several minutes to download the Docker images for the microservices and install related assets.

4. Select `Install` for each bundle, where order of installation is important. The `entando-hub-bundle` will need to be installed first, as it provides the `entando-hub-content-bundle` with MFEs to set up each of the pages. An installation can take several minutes while the application downloads the Docker images for the microservices and installs the related assets.
:::warning
(Entando 6.3.2) A cache issue impacting the first deployment of the `entando-hub` bundle can prevent all widgets or MFEs from appearing on some pages, particularly the Dashboard page.

:::warning
(Entando 6.3.2) There is a cache issue when deploying the Hub bundles where not all widgets or MFEs initially appear on some pages, particularly the Dashboard page. Restarting the quickstart-server pod (which holds the Entando App Engine) will clear the cache. This is only necessary on the initial install.
To clear the cache, select `Administration` from the bottom of the left menu, then `Reload configuration`.

Alternatively, restarting the quickstart-server pod (which contains the Entando App Engine) will also clear the cache, and can be achieved with `ent k delete pod/<YOUR QUICKSTART-SERVER POD>`, e.g. `ent k delete pod/quickstart-server-deployment-5d785b997c-r4sc8`. It will take several minutes for the pod to redeploy after deletion.
:::

5. The Hub can be accessed from the App Builder by navigating to `Pages → Management`, finding `Hub Test` **change** in the page tree, and clicking `View Published Page` from its actions.
5. Setup permissions to configure the service:
- Login to Keycloak as an admin. To manage the required Keycloak instance, see [Entando Identity Management -- Keycloak](../../docs/reference/identity-management.md#logging-into-your-keycloak-instance).
- Go to `Users → admin → Role Mappings`, select `entandopsdh-entando-hub-catalog-server` as the `Client Role`, then add `eh-admin` to `Assigned Roles`.

6. Access the Hub from the App Builder by navigating to `Pages → Management`, finding `Entando Hub` in the page tree, and clicking `View Published Page` from its actions.

## Configuration

Expand Down Expand Up @@ -130,7 +139,7 @@ A single Spring Boot microservice provides two REST endpoints:
- The second provides methods that support the Entando App Builder integration (7.0.0+).

### Content
The Hub content bundle includes a custom template and a page preconfigured with the main Hub micro frontends.
The Hub content bundle (`entando-hub`) includes a custom template and a page preconfigured with the main Hub micro frontends.

### Integration
The Entando App Builder should be configured using the endpoint `BASEURL/entando-hub-api/appbuilder/api`, where the BASEURL is the URL for the Entando Application.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vuepress/docs/v6.3.2/tutorials/samples/hub-images/hub-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 9 additions & 3 deletions vuepress/docs/v6.3.2/tutorials/samples/pda-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ There are numerous assets installed as part of the Entando PDA plugin. Entando B

### Installation Steps

1. Apply the definitions for the bundle that assembles the PDA plugin components. You'll need to adjust the `-n entando` option in each command to match your namespace or project.
1. Apply the Custom Resource Definition for the PDA plugin component bundle. You'll need to adjust the `-n entando` option in each command to match your namespace or project.
```
ent bundler from-git -r https://github.com/entando-samples/entando-process-driven-plugin-bundle.git -d | ent kubectl apply -n entando -f -
```
Expand All @@ -40,6 +40,8 @@ ent bundler from-git -r https://github.com/entando-samples/entando-process-drive

3. Select `Repository` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below.

![pda-install.png](./pda-images/pda-install.png)

4. Select `Install` to install the bundle. An installation can take several minutes while the application downloads the Linux images for the microservices and installs the related assets.

5. Setup permissions to configure the service:
Expand All @@ -57,8 +59,12 @@ ent bundler from-git -r https://github.com/entando-samples/entando-process-drive
- PDA Smart Inbox
- PDA Task Details

:::warning
(Entando 6.3.2) There is a cache issue when deploying the PDA plugin bundle which means not all widgets or MFEs initially appear on some pages, particularly the Dashboard page. Restarting the quickstart-server pod (which holds the Entando App Engine) will clear the cache. This is only necessary on the initial install.
:::warning
(Entando 6.3.2) A cache issue impacting the first deployment of the `entando-pda-plugin-bundle` can prevent all widgets or MFEs from appearing on some pages, particularly the Dashboard page.

To clear the cache, select `Administration` from the bottom of the left menu, then `Reload configuration`.

Alternatively, restarting the quickstart-server pod (which contains the Entando App Engine) will also clear the cache, and can be achieved with `ent k delete pod/<YOUR QUICKSTART-SERVER POD>`, e.g. `ent k delete pod/quickstart-server-deployment-5d785b997c-r4sc8`. It will take several minutes for the pod to redeploy after deletion.
:::

6. Utilization of the PDA plugin begins with the Smart Inbox, which can be accessed from the App Builder by navigating to `Pages → Management`, finding `PDA Smart Inbox` in the page tree, and clicking `View Published Page` from its actions.
Expand Down