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-528 Add OKD 4.8 work-around comment on PDA page #539

Merged
merged 3 commits into from
Jul 25, 2022
Merged

ENDOC-528 Add OKD 4.8 work-around comment on PDA page #539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
213b981
ENDOC-528
Jul 21, 2022
bd13854
ENDOC-528 fix and clarify
Jul 22, 2022
5791ea7
ENDOC-528 explicit mention of error
Jul 25, 2022
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/next/tutorials/solution/pda-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ sidebarDepth: 2

## Introduction

The Entando Process Driven Applications (PDA) plugin is engineered to provide a rich and full-featured user experience while facilitating the management and completion of business processes and automation. This solution template includes:
The Entando Process Driven Applications (PDA) plugin is engineered to provide a rich and full-featured user experience while facilitating the management and implementation of business processes and automation. This solution template includes:

- A general purpose UX layer created from micro frontends that can be implemented for any business process or task engine. The UX layer can serve data via the included Entando integration adapter or by implementing a set of interfaces on the server side.
- A Spring Boot microservice backend providing a pluggable interface for the injection of underlying processes or automation toolkits. The interfaces and steps for creating a new PDA backend implementation are described in further detail [here](./pda-technical-guide.md).

This tutorial will guide you through installing the PDA plugin using the Entando Component Repository (ECR) and an Entando Bundle. This exercise demonstrates the scope of process automation enabled by integrating the following:
The following tutorial installs the PDA plugin via the Entando Component Repository (ECR) and an Entando Bundle. It demonstrates the scope of process automation enabled by integrating:

- Custom Micro Frontends (MFEs)
- Backend for Frontend (BFF) microservice
Expand Down
40 changes: 38 additions & 2 deletions vuepress/docs/v7.0/tutorials/solution/pda-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ sidebarDepth: 2

## Introduction

The Entando Process Driven Applications (PDA) plugin is engineered to provide a rich and full-featured user experience while facilitating the management and completion of business processes and automation. This solution template includes:
The Entando Process Driven Applications (PDA) plugin is engineered to provide a rich and full-featured user experience while facilitating the management and implementation of business processes and automation. This solution template includes:

- A general purpose UX layer created from micro frontends that can be implemented for any business process or task engine. The UX layer can serve data via the included Entando integration adapter or by implementing a set of interfaces on the server side.
- A Spring Boot microservice backend providing a pluggable interface for the injection of underlying processes or automation toolkits. The interfaces and steps for creating a new PDA backend implementation are described in further detail [here](./pda-technical-guide.md).

This tutorial will guide you through installing the PDA plugin using the Entando Component Repository (ECR) and an Entando Bundle. This exercise demonstrates the scope of process automation enabled by integrating the following:
The following tutorial installs the PDA plugin via the Entando Component Repository (ECR) and an Entando Bundle. It demonstrates the scope of process automation enabled by integrating:

- Custom Micro Frontends (MFEs)
- Backend for Frontend (BFF) microservice
Expand Down Expand Up @@ -56,6 +56,42 @@ ent ecr deploy --repo="https://github.com/entando-samples/entando-process-driven

## Configuration

::: warning
---

<details><summary>Configuration error on OpenShift 4.8</summary>

An incomplete role definition prevents Entando 7 from configuring the PDA Plugin connections on RedHat OpenShift 4.8. As a workaround, update the entando-plugin Role by adding the missing rules below.
Copy link
Collaborator

Choose a reason for hiding this comment

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

isn't this supposed to have the bit about circumventing the connection error? otherwise everything else looked fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i reworded it... "circumventing" (my word choice) sounded not quite right; it implies dodging something that's an inevitability. "workaround" is standard language for a quick and dirty - and temporary - fix. but explicitly calling out that something will error gives off an unfinished, amateur vibe, instead of finessing the inferences like in the revision.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree that the mention of an error is not necessarily a good thing but sometimes I think the meaning starts to get a bit vague. In this case, it is understandable but not crystal clear.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good point


``` yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: entando-plugin
rules:
- apiGroups:
- entando.org
resources:
- entandoplugins
verbs:
- get
- update
- apiGroups:
- ""
resources:
- secrets
verbs:
- create
- get
- delete
- update
```

</details>

---
:::

Follow the steps below to configure service permissions and connections.

1. [Login to your Keycloak instance](../../docs/consume/identity-management.md#logging-into-your-keycloak-instance) as an admin.
Expand Down