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-443 Auto install Hub sections #446

Merged
merged 4 commits into from
Mar 17, 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
11 changes: 7 additions & 4 deletions vuepress/docs/next/tutorials/solution/customer-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,14 @@ This tutorial covers:
* Use the Entando CLI command `ent check-env develop` to verify all dependencies.
* A Jira Service Management account.

### Automatic Install with Entando App Builder
### Automatic Install via the Entando Hub
Install the Customer Portal in two steps by integrating the Entando Hub into your App Builder.
1. From the left sidebar of your App Builder, go to the `Repository`. Select `Entando Hub` at the top right side of the page if it has already been configured. If not, enter `Entando Hub` and the API URL to initialize the Hub. It will now be available from this page at any time.
1. Log into your `App Builder` → `Repository` → `Select Registry` → choose `Entando Hub` if it has been configured.
1. If not, choose `New Registry`
2. In the pop-up window, enter `Entando Hub` and [https://hub.entando.com] for the URL, then `Save`
3. Click on the Hub in the Registry

2. From the Hub, deploy and `Install` the two Customer Portal bundles from the Catalog.
2. From the Hub Catalog, `Deploy` and `Install` the Customer Portal application first, then the content bundle.

3. To navigate to your CP:
* From the sidebar → `Page` → `Management`
Expand All @@ -50,7 +53,7 @@ ent bundler from-git -r https://github.com/nshaw/customerportal-content-bundle.g
```
2. Log into the App Builder.

3. Go to the `Repository` from the left sidebar. Two Customer Portal bundles will be visible there. `Install` the latest version of both bundles.
3. Go to the `Repository` from the left sidebar. Two Customer Portal bundles will be visible there. `Install` the Customer Portal application first, then the content bundle.

4. To navigate to your CP:
* From the sidebar → `Page` → `Management`
Expand Down
9 changes: 8 additions & 1 deletion vuepress/docs/next/tutorials/solution/entando-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,14 @@ The Hub is installed using the Entando Component Repository (ECR) and two Entand
- An Entando Application on any Kubernetes provider. Follow the [tutorials](../#operations) appropriate to your environment to install the Entando platform.
- The [ent command line tool](../../docs/reference/entando-cli.md#overview), installed and connected to your Kubernetes instance.

### Installation Steps
### Automatically Access the Hub from the App Builder
1. Login to your App Builder
2. Go to `Registry` → `Select Registry`
3. Choose `New Registry`
4. In the pop-up window, enter `Entando Hub` and [https://hub.entando.com] for the URL, then `Save`
5. Click on the Hub in the Registry

### Manual 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.

Expand Down
29 changes: 21 additions & 8 deletions vuepress/docs/next/tutorials/solution/install-standard-demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ sidebarDepth: 2

# Entando Standard Banking Demo

[[toc]]

## Introduction

This tutorial will guide you through installing a demo application using the Entando Component Repository (ECR) and a set of Entando
bundles. This solution template includes:

Expand All @@ -30,11 +26,28 @@ There are numerous assets installed as part of the Standard Banking Demo. Entand

### Prerequisites

- An Entando Application on any Kubernetes provider. Follow one of the [tutorials](../#operations) appropriate to your environment to install the Entando platform.
- A working instance of Entando running on Kubernetes. [Install Entando on any Kubernetes provider](../#operations) or see [Getting Started](../../docs/getting-started/) for more information.
- The ent command line tool, installed and connected to your Kubernetes instance.

### Installation Steps

### Automatic Install via the Entando Hub
Install the Standard Banking Demo by integrating the Entando Hub into your App Builder.
1. Log into your `App Builder` → `Repository` → `Select Registry` → choose `Entando Hub` if it has been configured.
1. If not, choose `New Registry`
2. In the pop-up window, enter `Entando Hub` and [https://hub.entando.com] for the URL, then `Save`
3. Click on the Hub in the Registry

2. From the Hub Catalog, `Deploy` and `Install` the four Standard Banking Demo bundles in this order:
1. `standard-demo-banking-bundle`
2. `standard-demo-customer-bundle`
3. `standard-demo-manage-users-bundle`
4. `standard-demo-content-bundle`

3. To navigate to the Standard Demo:
* From the sidebar → `Page` → `Management`
* Find `Home SD` in the page tree
* From the `Actions` pull-down menu → `View Published Page`

### Manual Install
1. Apply the definitions for the four bundles that comprise the Standard Banking Demo. You'll need to adjust the `-n entando` option in each command to match your namespace or project.
```
ent bundler from-git -d -r https://github.com/entando-samples/standard-demo-banking-bundle.git | ent kubectl apply -n entando -f -
Expand Down Expand Up @@ -74,7 +87,7 @@ You can now navigate to your application's home page using the home icon in the

**Option 2** Alternatively, you can view the Standard Banking Demo home page by going to `Pages → Management`, finding `Home SD` in the page tree, and clicking `View Published Page` from its actions.

![Homepage.png](./images/Homepage.png)
![Standard Banking Demo Homepage](./images/Homepage.png)

:::warning
(Entando 6.3.2) A cache issue impacting the first deployment of the `sd-content` bundle can prevent all widgets or MFEs from appearing on some pages, particularly the Dashboard page.
Expand Down
15 changes: 13 additions & 2 deletions vuepress/docs/next/tutorials/solution/pda-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,18 @@ There are numerous assets installed as part of the Entando PDA plugin. Entando B
- The ent command line tool, installed and connected to your Kubernetes instance.
- Red Hat PAM

### Installation Steps

### Automatic Install via the Entando Hub
1. Log into your `App Builder` → `Repository` → `Select Registry` → choose `Entando Hub` if it has been configured.
1. If not, choose `New Registry`
2. In the pop-up window, enter `Entando Hub` and [https://hub.entando.com] for the URL, then `Save`
3. Click on the Hub in the Registry

2. From the Hub Catalog, `Deploy` and `Install` the PDA bundle. It will take a few minutes to install.

3. To finish the tutorial, skip to Set up permissions to configure services below.

### Manual Install
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 @@ -44,7 +54,7 @@ ent bundler from-git -r https://github.com/entando-samples/entando-process-drive

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:
5. Set up permissions to configure the service:
- [Login to your Keycloak instance](../../docs/consume/identity-management.md#logging-into-your-keycloak-instance) as an admin.
- [Assign client roles](../../docs/consume/identity-management.md#authorization) to authorize permissions. Select `entando-pda-plugin-server` from `Client Roles` and `admin` from `Available Roles`.
- Log in to the App Builder and configure the PDA Connection.
Expand All @@ -58,6 +68,7 @@ ent bundler from-git -r https://github.com/entando-samples/entando-process-drive
- PDA Process Definition
- PDA Smart Inbox
- PDA Task Details


:::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.
Expand Down
2 changes: 1 addition & 1 deletion vuepress/docs/v6.3.2/tutorials/solution/landing-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Entando Application Composition Platform offers several Solution Templates t

Each open source Solution Template was built with Entando and can be used as-is, reviewed for common development practices, or leveraged as a useful starting point for a related application.

<!-- The following Solution Templates and other sets of components are available in the [public Entando Hub](https://hub.entando.com) for installation in a user environment, where turnkey functionality can be customized and extended. -->
The following Solution Templates and other sets of components are available in the [public Entando Hub](https://hub.entando.com) for installation in a user environment, where turnkey functionality can be customized and extended.

## Entando Customer Portal

Expand Down