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-609 remove quarkus and edit #634

Merged
merged 5 commits into from
Dec 12, 2022
Merged

ENDOC-609 remove quarkus and edit #634

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b5fe6b2
ENDOC-609 remove quarkus and edit
jyunmitch Nov 30, 2022
4bfa2fc
ENDOC-609 review edits
jyunmitch Dec 2, 2022
8c4dd2e
ENDOC-609 more edits
jyunmitch Dec 2, 2022
24c42e2
ENDOC-609 more review edits
jyunmitch Dec 6, 2022
3575e07
ENDOC-609 final review edit
jyunmitch Dec 7, 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
8 changes: 4 additions & 4 deletions vuepress/docs/next/docs/create/component-gen-tech.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
When generating a microservice or micro frontend using the Entando Component Generator, there are a number of technical choices that need to be made:

* Microservice code
* If you're considering non-Java based microservices, here are the [specifications of an Entando microservice](../curate/bundle-details.md#microservices-specifications), including information on the runtime contract required to use them.
* If you're considering microservices that are not based on Java, here are the [specifications of an Entando microservice](../curate/bundle-details.md#microservices-specifications), including information on the runtime contract required to use them.
* For a JavaScript example, see the Node.js microservice in the [API claim tutorial](../../tutorials/create/ms/add-api-claim.md).
* Database type
* Entando recommends standardizing your choice of database to simplify operational maintenance, but you do have the ability to use different databases for different microservices.
* Supported choices are none, embedded, MySQL, and Postgres. Enterprise customers can choose Oracle but should contact Entando Support for details.
* Development databases
* You can choose to utilize a full RDBMS or developers can utilize lightweight in-memory or on-disk databases with H2.
* Caching implementation
* When generating a microservice, you will be presented with the type of cache to inject into the services. It is recommended that the type be uniform for all the microservices in your application, but it can be customized on a per service basis if desired.
* When generating a microservice, you will be presented with the types of cache to inject into the services. It is recommended that the type be uniform for all microservices in your application, but it can be customized on a per-service basis if desired.
* Build system
* Determines the Java build tool to use when building your services
Copy link
Contributor

Choose a reason for hiding this comment

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

"Java build tool" is a kind of overkill, given the bullet header and "when building your services"; it also is a bit of a mouthful

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it adds a specificity to the type of tool so left as is. It is repetitive but thought necessary

* Supports Maven or Gradle
* Other technologies
* Users of the component generator can also decide to use other technologies from JHipster or the JHipster marketplace.
* There are many powerful technologies in the marketplace but it is up to the developer to integrate the chosen technology into their Entando application. Entando doesn't provide direct support for marketplace tech choices.
* Users of the Component Generator can also decide to use other technologies from JHipster or the JHipster marketplace.
* There are many powerful technologies in the marketplace but it is up to the developer to integrate the chosen technology into their Entando Application. Entando doesn't provide direct support for marketplace tech choices.
* Micro frontends
* Optionally, users can choose to generate micro frontends for entities generated via the blueprint.
Copy link
Contributor

Choose a reason for hiding this comment

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

...i thought the MFEs were the entities that were optionally generated? @nshaw? shouldn't this read "for microservices"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the entity is conference, isn't it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Line 22 is good as-is per conversation.

* The Entando Component Generator only provides micro frontends in React from the generation flow but developers can create and bundle micro frontends using other technologies as well.
Expand Down
20 changes: 10 additions & 10 deletions vuepress/docs/next/docs/reference/deployment-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This page provides an overview of the key Entando GitHub repositories with brief
of how these repositories are realized in a running Entando deployment. It also explores the architecture behind the Entando Platform and how its functions are structured.

## Entando Operator
The **Entando Operator** coordinates the installation and configuration of all the components of an Entando Application.
The **Entando Operator** coordinates the installation and configuration of all of the components of an Entando Application.

* GitHub: <https://github.com/entando-k8s/entando-k8s-controller-coordinator/>
* DockerHub: <https://hub.docker.com/repository/docker/entando/entando-k8s-controller-coordinator>

#### Customization
Use the [Entando Custom Resources](../consume/custom-resources.md) to extend the Platform.
Use the [Entando custom resources](../consume/custom-resources.md) to extend the Platform.
Copy link
Contributor

Choose a reason for hiding this comment

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

platform lowercase

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

that actually doesn't make sense because everything else with entando in front remains capitalized

Copy link
Contributor

Choose a reason for hiding this comment

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

no. the platform and operator are the exceptions, because those are general terms. the Component Manager and Component Generator are capitalized because these are entando-specific terms. the decision on platform/operator was made months ago and transferred to our glossary spreadsheet. it may also be in the team notes somewhere.

Copy link
Contributor

Choose a reason for hiding this comment

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

also Entando Component / component, Entando Plugin / plugin, Entando Content / content, Entando Page / page... it's actually a pretty extensive list


## Database Init Containers
During installation, an Entando Application needs to create and initialize several databases when deploying from a backup of your images.
Expand Down Expand Up @@ -50,9 +50,9 @@ A customized image can include:
* New APIs
* Legacy Entando plugins
* New database tables
* Other extensions to the entando-core
* Other extensions to the `entando-core`

It is recommended that microservices are used for most extensions to the Entando Platform. However, legacy
In most cases, microservices should be used to extend the platform. However, legacy
integrations, extensions to the CMS, and migrations from earlier Entando versions may require changes to the **entando-de-app**.

## App Builder
Expand All @@ -63,14 +63,14 @@ APIs](../consume/entando-apis.md). The Component Manager provides information ab
* DockerHub: <https://hub.docker.com/repository/docker/entando/app-builder/>

#### Customization
The App Builder is customized as part of many Entando implementations.
It can be customized via [configuration micro frontends](../../tutorials/create/mfe/widget-configuration.md) and with [Entando Platform Capabilities (EPCs)](../../tutorials/create/mfe/epc.md).
The **App Builder** is customized as part of many Entando implementations.
It can be customized via [configuration micro frontends](../../tutorials/create/mfe/widget-configuration.md) and [Entando Platform Capabilities (EPCs)](../../tutorials/create/mfe/epc.md).

## Entando Component Manager
The **Entando Component Manager** provides the link between the `entando-de-app`, or your custom core instance, and the Local Hub. It queries the Entando Kubernetes service to fetch available
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
bundles that have been deployed as custom resources inside the cluster.

The Component Manager also administers the relationships between an Entando Application and the
The **Component Manager** also administers the relationships between an Entando Application and the
installed plugins. This is seen in the plugin link custom resource in Kubernetes.
Copy link
Contributor

Choose a reason for hiding this comment

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

"plugin link custom resource" is so many modifiers... "custom resource for the plugin link"


* GitHub: <https://github.com/entando-k8s/entando-component-manager/>
Expand All @@ -96,10 +96,10 @@ The Keycloak image can be customized as part of an Entando implementation. Some

## Other Key Repositories
### entando-core
The **entando-core** project is a J2EE application that exposes APIs for the Entando CMS, including the admin console and the portal UI project that performs the server-side composition for pages rendered via an Entando Application. Note that only the composition is performed server-side. JavaScript code is rendered client-side. The entando-core is realized via an instance that includes the WAR files as dependencies, which are generated from the core build. In a default deployment, this is the `entando-de-app`.
The **entando-core** project is a J2EE application that exposes APIs for the Entando CMS, including the Admin Console and the Portal UI project that performs the server-side composition for pages rendered via an Entando Application. Note that only the composition is performed server-side. JavaScript code is rendered client-side. The **entando-core** is realized via an instance that includes the WAR files as dependencies, which are generated from the core build. In a default deployment, this is the `entando-de-app`.

* GitHub: <https://github.com/entando/entando-core/>
* DockerHub: None (deployed to maven central)
* DockerHub: None (deployed to Maven Central)

#### Customization
For users familiar with versions prior to Entando 6, there will be cases where the **entando-core** is customized.
Expand All @@ -119,7 +119,7 @@ functionality. However, most cases will use the more general App Builder extensi

### Entando Kubernetes Controllers
A number of controllers are available to the Entando Operator to manage installations and
components in an Entando cluster. These are small and lightweight images that execute as
components in an Entando Cluster. These are small and lightweight images that execute as
run-to-completion pods, managing the installation flow for different parts of the infrastructure. For more information on controllers, Entando custom
resources, and configuring your deployment, see
[Custom Resources](../consume/custom-resources.md).
Expand Down
31 changes: 19 additions & 12 deletions vuepress/docs/v7.1/docs/create/component-gen-tech.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,33 @@
# Component Generation Technologies

When generating a microservice using the Entando Component Generator there are a number of technical choices that need to be made
When generating a microservice or micro frontend using the Entando Component Generator, there are a number of technical choices that need to be made:

* Microservice code
* If you're considering non-Java based microservices, here are the [specifications of an Entando microservice](../curate/bundle-details.md#microservices-specifications), including information on the runtime contract required to use them.
* If you're considering microservices that are not based on Java, here are the [specifications of an Entando microservice](../curate/bundle-details.md#microservices-specifications), including information on the runtime contract required to use them.
* For a JavaScript example, see the Node.js microservice in the [API claim tutorial](../../tutorials/create/ms/add-api-claim.md).
* Database type
* Entando recommends standardizing your choice of database to simplify operational maintenance but you do have the ability to use different databases for different microservices.
* Supported choices are none, MySQL, and Postgres. Enterprise customers can choose Oracle but should contact Entando Support for details.
* Entando recommends standardizing your choice of database to simplify operational maintenance, but you do have the ability to use different databases for different microservices.
* Supported choices are none, embedded, MySQL, and Postgres. Enterprise customers can choose Oracle but should contact Entando Support for details.
* Development databases
* You can choose to utilize a full RDBMS or developers can utilize lightweight in memory or on disk databases with h2.
* You can choose to utilize a full RDBMS or developers can utilize lightweight in-memory or on-disk databases with H2.
* Caching implementation
* When generating a microservice you will be presented with the type of cache to inject into the services. It is recommended that this is a standard choice for all of the microservices in your application but can be customized on a per service basis if desired.
* When generating a microservice, you will be presented with the types of cache to inject into the services. It is recommended that the type be uniform for all microservices in your application, but it can be customized on a per-service basis if desired.
* Build system
* Determines the java build tool to use when building your services
* Supports maven or gradle
* Determines the Java build tool to use when building your services
* Supports Maven or Gradle
* Other technologies
* Users of the component generator can also decide to use other technologies from JHipster or from the JHipster marketplace.
* There are many powerful technologies in the marketplace but it is up to the developer to integrate any choices from the marketplace into their Entando application. Entando doesn't provide any direct support for marketplace tech choices.
* Users of the Component Generator can also decide to use other technologies from JHipster or the JHipster marketplace.
* There are many powerful technologies in the marketplace but it is up to the developer to integrate the chosen technology into their Entando Application. Entando doesn't provide direct support for marketplace tech choices.
* Micro frontends
* Users can optionally choose to generate micro frontends for entities generated via the blueprint.
* Optionally, users can choose to generate micro frontends for entities generated via the blueprint.
* The Entando Component Generator only provides micro frontends in React from the generation flow but developers can create and bundle micro frontends using other technologies as well.

If you want to try out these choices follow the tutorial on [creating Entando microservices and micro frontends using the component generator](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md).
## Next Steps

- [Create microservices and micro frontends using the Entando Component Generator](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)
- [Create a React micro frontend](../../tutorials/create/mfe/react.md)
- [Create an Angular micro frontend](../../tutorials/create/mfe/angular.md)
- [Create a microservice, then an API claim with which a micro frontend can call it](../../tutorials/create/ms/add-api-claim.md)



27 changes: 13 additions & 14 deletions vuepress/docs/v7.1/docs/reference/deployment-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This page provides an overview of the key Entando GitHub repositories with brief
of how these repositories are realized in a running Entando deployment. It also explores the architecture behind the Entando Platform and how its functions are structured.

## Entando Operator
The **Entando Operator** coordinates the installation and configuration of all the components of an Entando Application.
The **Entando Operator** coordinates the installation and configuration of all of the components of an Entando Application.

* GitHub: <https://github.com/entando-k8s/entando-k8s-controller-coordinator/>
* DockerHub: <https://hub.docker.com/repository/docker/entando/entando-k8s-controller-coordinator>

#### Customization
Use the [Entando Custom Resources](../consume/custom-resources.md) to extend the Platform.
Use the [Entando custom resources](../consume/custom-resources.md) to extend the Platform.

## Database Init Containers
During installation, an Entando Application needs to create and initialize several databases when deploying from a backup of your images.
Expand Down Expand Up @@ -50,27 +50,27 @@ A customized image can include:
* New APIs
* Legacy Entando plugins
* New database tables
* Other extensions to the entando-core
* Other extensions to the `entando-core`

It is recommended that most extensions to the Entando Platform are made in the microservices. However, legacy
In most cases, microservices should be used to extend the platform. However, legacy
integrations, extensions to the CMS, and migrations from earlier Entando versions may require changes to the **entando-de-app**.

## App Builder
The **App Builder** is the user-friendly frontend UI for the `entando-de-app`. A ReactJS application, it is served via node in the default deployment. In a quickstart deployment, the App Builder container is deployed in the EntandoApp multi-container pod. It communicates with the `entando-de-app` and the Entando Component Manager via [REST
APIs](../consume/entando-apis.md). The Component Manager provides information about bundles deployed to the Local Hub.
The **App Builder** is the user-friendly frontend UI for the `entando-de-app`. A ReactJS application, it is served via Node in the default deployment. It communicates with the `entando-de-app` and the Entando Component Manager via [REST
APIs](../consume/entando-apis.md). The Component Manager provides information about bundles deployed to the Local Hub.

* GitHub: <https://github.com/entando/app-builder/>
* DockerHub: <https://hub.docker.com/repository/docker/entando/app-builder/>

#### Customization
The App Builder is customized as part of many Entando implementations.
It can be customized via [configuration micro frontends](../../tutorials/create/mfe/widget-configuration.md) and with [Entando Platform Capabilities (EPCs)](../../tutorials/create/mfe/epc.md).
The **App Builder** is customized as part of many Entando implementations.
It can be customized via [configuration micro frontends](../../tutorials/create/mfe/widget-configuration.md) and [Entando Platform Capabilities (EPCs)](../../tutorials/create/mfe/epc.md).

## Entando Component Manager
The **Entando Component Manager** provides the link between the `entando-de-app`, or your custom core instance, and the Local Hub. It queries the Entando Kubernetes service to fetch available
bundles that have been deployed as custom resources inside the cluster.

The Component Manager also administers the relationships between an Entando Application and the
The **Component Manager** also administers the relationships between an Entando Application and the
installed plugins. This is seen in the plugin link custom resource in Kubernetes.

* GitHub: <https://github.com/entando-k8s/entando-component-manager/>
Expand All @@ -83,7 +83,7 @@ monitors the status of the installed EntandoApp.
* DockerHub: <https://hub.docker.com/repository/docker/entando/entando-k8s-service/>

## Keycloak
The **entando-keycloak** project is an extension of the base Keycloak image. It provides default themes for Entando, a customized realm and clients, and Oracle JDBC JARs for connecting to Oracle databases.
The **entando-keycloak** project is an extension of the base Keycloak images. It provides default themes for Entando, a customized realm and clients, and Oracle JDBC JARs for connecting to Oracle databases.
* GitHub: <https://github.com/entando/entando-keycloak/>
* DockerHub: <https://hub.docker.com/repository/docker/entando/entando-keycloak/>

Expand All @@ -96,11 +96,10 @@ The Keycloak image can be customized as part of an Entando implementation. Some

## Other Key Repositories
### entando-core
The **entando-core** project is a J2EE application that exposes APIs for the Entando CMS, including the admin console and the portal UI project that performs the server-side composition for pages rendered via an Entando Application. Note that only the composition is performed server side. JavaScript code is rendered client side. The entando-core is realized via an instance that includes the
WAR files generated from a core built as dependencies. In a default deployment, this is the `entando-de-app`.
The **entando-core** project is a J2EE application that exposes APIs for the Entando CMS, including the Admin Console and the Portal UI project that performs the server-side composition for pages rendered via an Entando Application. Note that only the composition is performed server-side. JavaScript code is rendered client-side. The **entando-core** is realized via an instance that includes the WAR files as dependencies, which are generated from the core build. In a default deployment, this is the `entando-de-app`.

* GitHub: <https://github.com/entando/entando-core/>
* DockerHub: None (deployed to maven central)
* DockerHub: None (deployed to Maven Central)

#### Customization
For users familiar with versions prior to Entando 6, there will be cases where the **entando-core** is customized.
Expand All @@ -120,7 +119,7 @@ functionality. However, most cases will use the more general App Builder extensi

### Entando Kubernetes Controllers
A number of controllers are available to the Entando Operator to manage installations and
components in an Entando cluster. These are small and lightweight images that execute as
components in an Entando Cluster. These are small and lightweight images that execute as
run-to-completion pods, managing the installation flow for different parts of the infrastructure. For more information on controllers, Entando custom
resources, and configuring your deployment, see
[Custom Resources](../consume/custom-resources.md).
Expand Down