diff --git a/vuepress/docs/next/docs/README.md b/vuepress/docs/next/docs/README.md index bb11b8d914..3ef11e3184 100644 --- a/vuepress/docs/next/docs/README.md +++ b/vuepress/docs/next/docs/README.md @@ -10,16 +10,19 @@ only be available by building from source. # Entando Platform -Entando is the leading open source **Application Composition Platform** for Kubernetes. It enables parallel teams to accelerate development and innovation of business capabilities on a modern, cloud-native, and Kubernetes-native stack. +Entando is an open-source application composition platform (ACP) that streamlines the development of composable applications for the web. By implementing a modular architecture, the Platform enables parallel teams to accelerate development and innovation on a modern, cloud-native, and Kubernetes-native stack. + +With Entando’s distributed working environment, you can build applications composed of modular reusable components and manage them all from one platform. The system includes development and runtime tools, a component catalog, and a component orchestrator to support all aspects of the development lifecycle. -It is a distributed and composable environment in which components can be built, scaled and iterated independently, helping teams build agile applications that can adapt to change. ![Entando Platform Development Process](./getting-started/img/concepts.png) -On the Entando Platform, development of an application is organized into four stages: Create, Curate, Compose, and Consume. In the simplest terms, you create functional building blocks, curate them in a catalog, compose the blocks into an application, which is then consumed by a user. The Enterprise Architect oversees the process, defining business domains and mapping the capabilities for the building blocks. +Development on Entando can be organized into four stages: Create, Curate, Compose, and Consume. In the simplest terms, you create functional building blocks or bundles, curate them in a catalog, compose them into an application, which is then consumed by a user. The Enterprise Architect oversees the process, defining business domains and mapping capabilities for the building blocks. -## Create Components -Building a composable application on Entando involves designing and creating each independent component or building block. Developers can use the [Entando Component Generator](./create/component-gen-overview.md) and [Blueprint](./create/blueprint-features.md) to automate the building and packaging of projects using any technology they choose. The modular architecture of apps built on Entando means new business capabilities can be easily integrated without reworking existing systems. + + +## Create +Building a composable application begins with self-contained bundles, created from scratch or using existing code. With the freedom to choose the technologies and frameworks that meet their needs, developers can use the [Entando Component Generator](./create/component-gen-overview.md) and [Blueprint](./create/blueprint-features.md) to speed up the process. The composable methods of Entando mean innovations can be easily integrated without reworking existing systems. | Documentation | Tutorials | | :------------ | :--------- | @@ -27,31 +30,29 @@ Building a composable application on Entando involves designing and creating eac | [Entando Blueprint Feature](./create/blueprint-features.md) | [Microservices](../tutorials/create/ms/generate-microservices-and-micro-frontends.md) | | [Component Generation Technologies](./create/component-gen-tech.md) | [Build and Publish Project Bundles](../tutorials/create/pb/publish-project-bundle.md) | -## Curate and Share Components -On the Entando Platform, Curate and Share means development teams can bundle and share components within a central catalog. Multiple teams can collaborate on a single component or packaged business capabilities (PBCs) and share them across organizations and applications. They can test and assess components for readiness, manage and publish versions, and share metadata for continuous upgrades. +## Curate +In this stage, curators discover and organize components to share across teams and projects. The components can be sourced internally or from the [Entando Marketplace](https://entando.com/composable-platform/packaged-business-capabilities/) which offers a selection of pre-built solutions. Curators assess, publish, and share component features and metadata in a private or public hub, ensuring that it is discoverable. Centralizing these functions also makes is easier to govern the consistency of the reusable bundles. | Documentation | Tutorials | | :------------ | :-------- | -| [Bundle and Component Descriptors](./curate/bundle-details.md) | [Install Bundles from a Private Image Registry](../tutorials/curate/bundle-private-images.md) | -| [Filtering Bundles](./curate/bundle-filters.md) | [Install Bundle Microservices from a Private Image Registry](../tutorials/curate/ms-private-images.md) | -| [Customize Bundle Info in App Builder](./curate/bundle-presentation-config.md) | | -| [Bundle Version and Updates FAQ](./curate/bundle-versions-faq.md) | | -| [Bundle Uninstall](./curate/uninstall-flow.md) | | +| [Bundle Details](./curate/bundle-details.md) | [Install Bundles from a Private Image Registry](../tutorials/curate/bundle-private-images.md) | +| [Bundle Component Descriptors](./curate/bundle-component-details.md) | [Install Bundle Microservices from a Private Image Registry](../tutorials/curate/ms-private-images.md) | +| [Enterprise Entando Hub](./curate/hub-details.md) | | + -## Compose an Application -The Compose stage is centered around the [Entando App Builder](./compose/app-builder.md), a low-code composition user interface where an application can be assembled using the prebuilt modular templates, widgets, PBCs and others. The [Entando Component Manager](./compose/ecm-overview.md) and [Local Hub](./compose/local-hub-overview.md) are integrated into the App Builder to manage your components, providing speed and flexibility. +## Compose +The Compose stage involves assembling the bundles, packaged business capabilities (PBCs), templates and other resources into an application. Centered around the visual interface, the [Entando App Builder](./compose/app-builder.md), the Platform provides tooling to define the structure, layouts, and interactions between micro frontends within an application. This unified environment, with direct access to the Entando catalogs, leads to the creation of a more cohesive and seamless user experience across a complex application. | Documentation | Tutorials | | :------------ | :-------- | -| [Welcome Wizard](./compose/welcome-wizard.md) | [Page Management](../tutorials/compose/page-management.md) | +| [App Builder Welcome Wizard](./compose/welcome-wizard.md) | [Create and Manage a Page](../tutorials/compose/page-management.md) | | [Local Hub](./compose/local-hub-overview.md) | [Widgets and Fragments](../tutorials/compose/widgets-fragments.md) | -| [Entando App Builder](./compose/app-builder.md) | [Content Creation](../tutorials/compose/content-tutorial.md) | -| [Entando Component Manager](./compose/ecm-overview.md) | [Content Templates](../tutorials/compose/content-templates-tutorial.md) | +| [Entando Component Manager](./compose/ecm-overview.md) | [Content Templates](../tutorials/compose/content-templates-tutorial.md) | | | [Digital Assets](../tutorials/compose/digital-assets-tutorial.md) | -## Consume Applications -In the development lifecycle of an application, Consume is the execution stage where users interact with the app. On Entando, the modular design of components and services means they can be scaled individually, or as a whole, according to those interactions. Likewise, content can be updated, engine rules adapted, and upgrades carried out seamlessly. As a result, the development cycle is a continuous process with minimal disruptions and faster time to market. +## Consume +In the lifecycle of an application, Consume is the execution stage where users interact with the application, using browsers, mobile devices, and conversational interfaces. On Entando, the modular design of components and services means they can be scaled independently, governed consistently, and new features integrated uniformly, as user's needs change. Likewise, content can be updated, interactions improved, and upgrades carried out in a continuous process, with minimal disruptions and faster time to market. | Documentation | Tutorials | | :------------ | :-------- | diff --git a/vuepress/docs/next/docs/consume/identity-management.md b/vuepress/docs/next/docs/consume/identity-management.md index 3417bad140..4018a0f50f 100644 --- a/vuepress/docs/next/docs/consume/identity-management.md +++ b/vuepress/docs/next/docs/consume/identity-management.md @@ -35,7 +35,7 @@ Keycloak authorizes microservices using clients and roles. Authorizations are st Below are the steps to grant a user one or more roles for a specific client. This controls permissions when configuring the microservice. Note, when a microservice is installed in Entando, a corresponding client (and set of roles) is created within its plugin definition. 1. [Log in to Keycloak](#logging-into-your-keycloak-instance) ->For non-external Keycloak instances, it is [the base URL of your running Entando application](../getting-started/README.md#configure-access-to-your-cluster) followed by `/auth/`, e.g. http://YOUR-HOST-NAME/auth. In a standard Entando installation, the base URL can be verified with `kubectl get ingress/default-sso-in-namespace-ingress`. +>For non-external Keycloak instances, it is the base URL of your running Entando application followed by `/auth/`, e.g. http://YOUR-HOST-NAME/auth. In a standard Entando installation, the base URL can be verified with `kubectl get ingress/default-sso-in-namespace-ingress`. 2. Select `Users` from the left menu 3. Use the search box to find the appropriate user, e.g. "admin" 4. Click on the user ID diff --git a/vuepress/docs/next/docs/getting-started/README.md b/vuepress/docs/next/docs/getting-started/README.md index 18054f316a..30ea590484 100644 --- a/vuepress/docs/next/docs/getting-started/README.md +++ b/vuepress/docs/next/docs/getting-started/README.md @@ -9,27 +9,27 @@ You can set up Entando in two simple steps or install it manually to meet your s * [Automatic Install](#automatic-install): The fastest way to locally install and start up Entando in Kubernetes. * [Manual Install](#manual-install): Useful if you want a shared cluster or a custom local instance. ->Installation on ARM: +>Installation on Apple Silicon processors: To install Entando on Mac systems running ARM64 architecture, see this alternate [Getting Started](../../tutorials/getting-started/arm-install.md) guide. ## Automatic Install Automatically install Entando via the Entando command-line interface (CLI) and prepare a local developer environment with default settings. -The following steps launch an Ubuntu VM via Multipass, install Kubernetes, then deploy Entando to it. +The following steps launch an Ubuntu VM via Multipass, install Kubernetes, and then deploy Entando to it. -1. Install [Multipass](https://multipass.run/#install) +1. Install [Multipass](https://multipass.run/#install). -2. Install Entando into Kubernetes on Ubuntu using the [Entando CLI](entando-cli.md) +2. Install Entando into Kubernetes on Ubuntu using the [Entando CLI](entando-cli.md): curl -sL "https://get.entando.org" | ENTANDO_RELEASE="{{ $site.themeConfig.entando.fixpack.v73 }}" bash -3. The progress of the install is displayed on the console. Installation can take up to 10 minutes, depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To understand what the CLI does, review the manual steps. +3. The progress of the install is displayed on the console. Installation can take up to 10 minutes, depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To better understand what the CLI does, review the manual steps. 4. The URL to access the Entando App Builder will print to the console once the install completes. -5. Login with username:`admin` and password: `adminadmin`. Refer to [Login to Entando](#login-to-entando) for more information and next steps. +5. Log in with username:`admin` and password: `adminadmin`. Refer to [Log in to Entando](#log-in-to-entando) for more information and next steps. ## Manual Install -Manual installation allows you to configure a shared cluster or customize a local developer environment. The following learn-as-you-go approach provides a working knowledge of Kubernetes as you install Entando in a local environment. After downloading the necessary files, your instance of Kubernetes will be up and running in <60 seconds. +Manual installation allows you to configure a shared cluster or customize a local developer environment. The following learn-as-you-go approach provides additional context about the process in the highlighted text boxes. After downloading the necessary files, your instance of Kubernetes will be up and running in <60 seconds. This is a three stage process: @@ -43,20 +43,20 @@ Kubernetes is a container orchestrator designed to manage a server cluster. It r ### Install Kubernetes -#### Enable Hypervisor -::: tip Why a Hypervisor? -Hypervisors allow you to create and run VMs. Virtualization software that run on top of your operating system as "guests" are Type 2 hypervisors, e.g. VirtualBox or VMWare Workstation. Type 1 hypervisors run directly on your host machine. +#### 1. Enable a Hypervisor +::: tip Why a hypervisor? +Hypervisors allow you to create and run VMs. Virtualization software that runs on top of your operating system as a guest is a Type 2 hypervisor, like VirtualBox or VMWare Workstation. Type 1 hypervisors run directly on your host machine. ::: Install a Type 1 hypervisor for optimal performance. -**Mac:** Install `hyperkit` + - **Mac:** Install `hyperkit`: -``` bash -brew install hyperkit -``` + ``` bash + brew install hyperkit + ``` -**Windows:** [Install Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v?redirectedfrom=MSDN) + - **Windows:** [Install Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v?redirectedfrom=MSDN) --- @@ -74,32 +74,32 @@ Install a Type 2 hypervisor that runs on top of your operating system.
-#### Launch an Ubuntu VM +#### 2. Launch an Ubuntu VM ::: tip Why Multipass? Multipass is a cross-platform tool developed by the publishers of Ubuntu to create lightweight Ubuntu VMs in seconds. ::: -1. Install [Multipass](https://multipass.run/#install) + 1. Install [Multipass](https://multipass.run/#install) -2. Launch a VM + 2. Launch a VM: -``` bash -multipass launch --name quickstart --cpus 4 --mem 8G --disk 20G -``` + ``` bash + multipass launch --name quickstart --cpus 4 --mem 8G --disk 20G + ``` -3. Open a VM shell. (Note: on Windows, you may need to use `winpty multipass`) + 3. Open a VM shell (Note on Windows, you may need to use `winpty multipass`): -``` bash -multipass shell quickstart -``` + ``` bash + multipass shell quickstart + ``` ### Run Kubernetes ::: tip Why K3s? -K3s is a certified Kubernetes distribution designed for production workloads in resource-constrained environments. +K3s is a certified light-weight version of Kubernetes designed for production workloads in constrained environments. -It's packaged as a single <50MB binary that minimizes the dependencies and procedure required to install, run and auto-update a production Kubernetes cluster. +It's packaged as a single (<50MB) binary that minimizes dependencies and simplifies the procedures required to install, run, and update a production Kubernetes cluster. ::: 1. Install the version of `K3s` supported by Entando 7.3. Note that this may not be the latest version of Kubernetes. @@ -130,44 +130,43 @@ sudo kubectl get pods -A You now have a local instance of Kubernetes up and running. ::: -Now that Kubernetes is running, you can use kubectl to send commands directly to K3s from the host machine, rather than from within the VM. To set this up with the [ent CLI](entando-cli.md), run `ent attach-vm quickstart` and then use `ent kubectl` for any calls to K8s. Alternatively, see the K3s documentation to [access your cluster with kubectl](https://rancher.com/docs/k3s/latest/en/cluster-access/). +Now that Kubernetes is running, you can use kubectl to send commands directly to K3s from the host machine, rather than from within the VM. To set this up with the [ent CLI](entando-cli.md), run `ent attach-vm quickstart` and then use `ent kubectl` for any calls to Kubernetes. Alternatively, see the K3s documentation to [access your cluster with kubectl](https://rancher.com/docs/k3s/latest/en/cluster-access/). ### Prepare Kubernetes -To install Entando, we'll add `Custom Resources`, create a `Namespace` and configure external access to our cluster. - -#### Create a Namespace +To install Entando, add the `Custom Resources`, create a `Namespace`, and configure external access to your cluster. -::: tip What are Namespaces? -Kubernetes supports multiple virtual clusters backed by the same physical cluster. These virtual clusters are called [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). You can use namespaces to allocate resources and set CPU/memory limits for individual projects or teams. -::: +#### 1. Create a Namespace ``` bash sudo kubectl create namespace entando ``` +::: tip What are Namespaces? +Kubernetes supports multiple virtual clusters backed by the same physical cluster. These virtual clusters are called [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). You can use namespaces to allocate resources and set CPU/memory limits for individual projects or teams. +::: -#### Add Custom Resources +#### 2. Add Custom Resources ::: tip Why Custom Resources? -Standard resources in Kubernetes include `Pods`, which are groups of one or more containers, `Services` to call or access Pods, and `Ingresses` to enable external access to Services. +Standard resources in Kubernetes include `Pods` (groups of one or more containers), `Services` to call or access Pods, and `Ingresses` to enable external access to Services. -[Custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) let you store and retrieve structured data. Combining a custom resource with a custom controller allows you to define a desired state to automate how your applications or services run in a Kubernetes cluster. +[Custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) let you store and retrieve structured data. Combining a custom resource with a custom controller allows you to define a desired state to automate how your applications and services run in a Kubernetes cluster. ::: Examples of custom resources in Entando are the [Entando App Engine](../../docs/getting-started/concepts-overview.md#entando-app-engine) and the [Entando Identity Management System](../../docs/getting-started/concepts-overview.md#entando-identity-management-system). -From your Ubuntu shell +From your Ubuntu shell: -1. Install the cluster-scoped custom resource definitions (CRDs) +1. Install the cluster-scoped custom resource definition (CRD): sudo kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v73 }}/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml -2. Install the namespace-scoped custom resources +2. Install the namespace-scoped custom resource: sudo kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v73 }}/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml -#### Configure Access to Your Cluster +#### 3. Configure Access to Your Cluster ::: tip What about Networking? Entando sets up [`Ingresses`](https://kubernetes.io/docs/concepts/services-networking/ingress/) in Kubernetes to expose HTTP routes from outside the cluster to services within the cluster. This is used to access Entando from a local browser. @@ -175,29 +174,32 @@ Entando sets up [`Ingresses`](https://kubernetes.io/docs/concepts/services-netwo If you run into network issues during startup, or if you are using Windows for your local development instance, you'll need to [troubleshoot your network](../reference/local-tips-and-tricks.md#network-issues). Indications of network issues can include Entando failing to completely start or a working Entando instance failing to restart later. ::: -To set up external access to your cluster, replace YOUR-HOST-NAME with the fully qualified domain of your Ubuntu VM. +To set up external access to your cluster, determine the fully qualified domain of your Ubuntu VM for the `ingressHostName` value in the EntandoApp CRD. -- On Windows with Hyper-V, YOUR-HOST-NAME is the name of your VM followed by `.mshome.net`, e.g. `quickstart.mshome.net`. +- On Windows with Hyper-V, `ingressHostName` is the name of your VM followed by `.mshome.net`, e.g. `quickstart.mshome.net`. -- On Mac, Linux, or Windows without Hyper-V, you'll use a host name based on your VM's IP address. You can determine the IP address from within the VM with this command: +- On Mac, Linux, or Windows without Hyper-V, `ingressHostName` is your VM name, plus you VM's IP address, plus "nip.io". You can determine the IP address from within the VM with this command: ``` bash hostname -I | awk '{print $1}' ``` -- Your IP-based YOUR-HOST-NAME should follow this pattern: `quickstart.YOUR-IP.nip.io`, e.g. `quickstart.192.168.64.33.nip.io`. The suffix `.nip.io` makes use of the free [nip.io](https://nip.io/) DNS service so that any requests to this host name will resolve to your VM. The prefix `quickstart` is arbitrary so you can choose your own. + E.g.: For VM named `quickstart`, IP=`192.168.64.33` + `ingressHostName` = `quickstart.192.168.64.33.nip.io` + +The suffix `.nip.io` makes use of the free [nip.io](https://nip.io/) DNS service so that any requests to this host name will resolve to your VM. `quickstart` is arbitrary so you can choose your own VM name. -Now that you've determined YOUR-HOST-NAME, use it to configure the Entando Application. +Now that you've determined `ingressHostName`, use it to configure the Entando Application. 1. Download the template `entando-app.yaml`. curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v73 }}/dist/ge-1-1-6/samples/entando-app.yaml" -2. Modify `entando-app.yaml` to set the `ingressHostName` to YOUR-HOST-NAME. Examples: -- `ingressHostName`: quickstart.mshome.net -- `ingressHostName`: quickstart.192.168.63.33.nip.io +2. Modify `entando-app.yaml` with the `ingressHostName` found in the previous step. Examples: +- Windows machine: `ingressHostName`: quickstart.mshome.net +- Mac or Linux: `ingressHostName`: quickstart.192.168.63.33.nip.io ::: tip Embedded Databases To speed up the _Getting Started_ environment, embedded databases are used by default. -See this [Tutorial on Default Databases](../../tutorials/devops/default-database.md) for information on how to change your database connection, or you can modify the `dbms` setting in the `entando-app.yaml`. +See the [Tutorial on Default Databases](../../tutorials/devops/default-database.md) for information on how to change your database connection, or modify the `dbms` setting in the `entando-app.yaml`. ::: ::: tip Entando Operator @@ -209,7 +211,7 @@ To customize the ingress path of a deployment, refer to the [Configure the Entan ::: ### Deploy Entando -Deploy Entando by applying `entando-app.yaml` to your namespace. +1. Deploy Entando by applying `entando-app.yaml` to your namespace. ```sh sudo kubectl apply -f entando-app.yaml -n entando @@ -217,7 +219,7 @@ sudo kubectl apply -f entando-app.yaml -n entando --- -Use the `get pods --watch` command to observe Entando starting up. +2. Use the `get pods --watch` command to observe Entando starting up. ```sh sudo kubectl get pods -n entando --watch @@ -225,16 +227,16 @@ sudo kubectl get pods -n entando --watch
What does a successful startup look like? -- The `entando-operator` and `entando-k8s-service` start when you apply the namespace resources above, so they should already be in the `Running` status by the time you reach this point -- When you apply the `entando-app.yaml`, the `quickstart-deployer` starts and kicks off a series of deployments, beginning with the Keycloak deployment via the `default-sso-in-namespace-deployer` +- The `entando-operator` and `entando-k8s-service` start when you apply the namespace resources above, so they should already be in `Running` status by the time you reach this point. +- When you apply the `entando-app.yaml`, the `quickstart-deployer` starts and kicks off a series of deployments, beginning with the Keycloak deployment via the `default-sso-in-namespace-deployer`. **Jobs / Deployments** -- Some Pods, like `quickstart-deployer`, run to completion and then shutdown; they should eventually show `READY`: `0/1` and `STATUS`: `Completed` +- Some Pods, like `quickstart-deployer`, run to completion and then shutdown; they should eventually show `READY`: `0/1` and `STATUS`: `Completed`. - Other deployments, like `quickstart-ab-deployment` or `quickstart-deployment`, should eventually show `READY`: `1/1` and `STATUS`: `Running` **Lifecycle Events** -- Each line represents an event: `Pending`, `ContainerCreating`, `Running` or `Completed` -- Restarts should ideally be `0`; otherwise, there may be a resource problem (slow network, not enough CPU or memory, etc.) with your cluster, and Kubernetes is trying to self-heal +- Each line represents an event: `Pending`, `ContainerCreating`, `Running` or `Completed`. +- Restarts should ideally be `0`; otherwise, there may be a resource problem (slow network, not enough CPU or memory, etc.) with your cluster, and Kubernetes is trying to self-heal. - This is a partial history for a typical install. ``` shell-session NAME READY STATUS RESTARTS AGE @@ -330,10 +332,10 @@ pn-3c07adf0-fac54a9f-entando-app-builder-menu-bff-deploymep6j87 1/1 Runnin --- -The URL of your running Entando instance is http://YOUR-HOST-NAME/app-builder/. +The URL of your running Entando instance is http://ingressHostName/app-builder/. -- Example URL +- Example URL: ``` bash quickstart.192.168.64.33.nip.io/app-builder/ @@ -341,9 +343,9 @@ quickstart.192.168.64.33.nip.io/app-builder/ --- -## Login to Entando +## Log in to Entando -Now that you've installed Entando, login to the Entando App Builder. +Now that you've installed Entando, log in to the Entando App Builder. ![entando-login.png](./img/entando-login.png) @@ -368,8 +370,8 @@ Check out these resources to continue your journey with Entando! * **Try a Tutorial:** Take advantage of the [Learning Paths](../../tutorials/), which organize a few of the most popular tutorials by user type. -* **Dig Deeper into Entando Concepts:** Review the [Docs](../) sections to more deeply understand the Entando building blocks. +* **Dig Deeper into Entando Concepts:** Review the [Docs](../) sections to get a better understanding of the Entando building blocks. -* **Learn about the Quickstart Environment:** See the [Quickstart Tips](../reference/local-tips-and-tricks.md) for more information on how to manage your Getting Started or quickstart environment. +* **Learn about the Quickstart Environment:** See the [Quickstart Tips](../reference/local-tips-and-tricks.md) for more information on how to manage and troublshoot your quickstart environment. --- diff --git a/vuepress/docs/next/docs/getting-started/concepts-overview.md b/vuepress/docs/next/docs/getting-started/concepts-overview.md index 9a7db53a94..8e2b3d99e4 100644 --- a/vuepress/docs/next/docs/getting-started/concepts-overview.md +++ b/vuepress/docs/next/docs/getting-started/concepts-overview.md @@ -1,89 +1,94 @@ # Entando Architecture Concepts -Entando is an application composition platform that simplifies and accelerates enterprise modernization across on-prem and cloud infrastructures. It offers native support for Javascript app development, a micro frontend and microservice architecture, scalable app deployment, and automated container orchestration via Kubernetes. +Entando is an application composition platform (ACP) that simplifies and accelerates enterprise modernization across on-prem and cloud infrastructures. It offers native support for Javascript app development, a micro frontend and microservice architecture, scalable deployments, and automated container orchestration via Kubernetes. -This document explores the architecture of the Entando Platform and some notable runtime characteristics. +This document explores the conceptual architecture of the Platform and its runtime characteristics. ![entando-architecture](./img/entando-architecture.png) -- [Key Entando Concepts](#key-entando-concepts) +- [Key Concepts](#key-concepts) - [Entando Cluster Elements](#entando-cluster-elements) - [Entando Ingresses](#entando-ingresses) -> Note: A portal, website, web app, or mobile app built with Entando is called an Entando Application. -An Entando Application is an assembly of out-of-the-box and/or custom-built components running on the -Entando Platform. Entando components can be widgets, micro frontends, microservices, page templates, WCMS content or WCMS content types. -## Key Entando Concepts +## Key Concepts + +### Entando Application +A portal, website, web app, or mobile app built with Entando is called an Entando Application. +An Entando Application is an assembly of out-of-the-box and/or custom-built components, called bundles, running on the +Platform. Applications also consist of page templates, WCMS content, content types, and other assets. + +### Entando Bundle +An Entando Bundle is a packaged set of components and resources created for the Platform. They are the building blocks of any application built on Entando, consisting of micro frontends, microservices, services and other resources. The Entando Component Manager identifies and installs the bundles to the Local Hub. + +See also: [Bundle Details](../curate/bundle-details.md) + ### Entando App Builder -The [Entando App Builder](../compose/app-builder.md) is the frontend of the Entando Platform with which an Entando Application is created and customized. It hosts the Entando WCMS and provides a feature-rich, low-code user interface to configure and interact with components, design and create pages, manage content, and build modular applications. +The [Entando App Builder](../compose/app-builder.md) is the application composer of the Platform. It hosts the WCMS and provides a feature-rich, low-code user interface to find and configure components, design and create pages, manage content, and build composable applications. See also: [Widget Tutorial](../../tutorials/compose/widgets-fragments.md) ### Entando App Engine -The Entando App Engine is the core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications. It exposes the backend APIs used to deliver the page and content management interface of an Entando Application, assembles and coordinates components within the Entando App Builder, and provides the data access layer to persist pages and application design. +The Entando App Engine is the core runtime engine responsible for the primary out-of-the-box services required to develop applications. It exposes the backend APIs used to deliver the page and content management interface of an Entando Application, assembles and coordinates components within the App Builder, and provides the data access layer to persist pages and application design. See also: [APIs tutorial](../consume/entando-apis.md) ### Entando Component Generator -The Entando Component Generator implements a [JHipster](https://www.jhipster.tech/) blueprint to quickly and efficiently generate the skeleton of an Entando project using automation and templating. The generator provides advanced data modeling capabilities, including object relational mapping, and the autogeneration of micro frontends and microservices. The [Entando Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) fast-tracks development by creating the folders, files and infrastructure required by a project. +The Entando Component Generator implements a [JHipster](https://www.jhipster.tech/) blueprint to quickly generate the skeleton of an Entando bundle with automation and templating. The Generator provides advanced data modeling capabilities, including object relational mapping and dynamic creation of micro frontends and microservices. -See also: [Component Generation Technologies](../create/component-gen-tech.md) +See also: [Generate Microservices & Micro Frontends](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) ### Entando Identity Management System -[Entando Identity Management System](../consume/identity-management.md) is Entando's [Keycloak](https://www.keycloak.org/)-based user management and authentication system. It applies Single Sign On capabilities across multiple domains to connect service providers with identity providers. +[Entando Identity Management System](../consume/identity-management.md) is the Platform's [Keycloak](https://www.keycloak.org/)-based user management and authentication system. It applies Single Sign On capabilities across multiple domains to connect service providers with identity providers. See also: [Entando Authentication](../../tutorials/create/mfe/authentication.md) ### Entando Local Hub -The [Entando Local Hub](../compose/local-hub-overview.md) is the component repository of an Entando App Builder. The Entando Bundles available to the Entando Application are represented and can be deployed, installed, updated or versioned using the App Builder UI. +The [Local Hub](../compose/local-hub-overview.md) is the component repository of the App Builder. Bundles--the basic building block for composing applications on Entando--are catalogued and organized here. The Local Hub also provides direct access to bundles in the Entando Marketplace and the Enterprise Hub, if one exists for the organization, and can be deployed and installed from here. ### Entando WCMS -The Entando Web Content Management System (WCMS) is a lightweight content and digital asset management system. It manages widgets, HTML fragments, and other content types used in an Entando Application. +The Entando Web Content Management System (WCMS) is a lightweight content and digital asset management system. It manages widgets, HTML fragments, and other content types for an Entando Application. See also: [Content Types](../../tutorials/compose/content-types-tutorial), [Content Templates](../../tutorials/compose/content-templates-tutorial) and [Digital Assets](../../tutorials/compose/digital-assets-tutorial.md) ## Entando Cluster Elements -The following is an overview of the elements comprising an Entando Cluster. +The following is an overview of the elements comprising an Entando cluster. ### Architecture - Members of the Cluster -Below is a diagram of an Entando Cluster and depicts how the various elements interact with one another. Entando deploys this infrastructure on Kubernetes using the Entando Operator and controllers. Each element is associated with a custom resource definition (CRD) file, if applicable. +This is a diagram of an Entando cluster, depicting how the various elements interact with one another. Entando deploys this infrastructure on Kubernetes using the Entando Operator and controllers. Each element is associated with a custom resource definition (CRD) where applicable. -![Entando Cluster Architecture Diagram](./img/entando-architecture-v1.5.svg) +![Entando Cluster Architecture Diagram](./img/entando-cluster-arch.png) #### EntandoApp -The EntandoApp is comprised of the Entando App Builder, the Entando App Engine and the Entando Component Manager. Keycloak-based authorization and authentication enable these to interact with each other and other cluster elements. +The EntandoApp is comprised of the App Builder, App Engine and Component Manager. Keycloak-based authorization and authentication enable these to interact with each other and other cluster elements. + + #### Entando Component Manager -The purpose of the [Entando Component Manager](../compose/ecm-overview.md) is to: +The purpose of the [Entando Component Manager](../compose/ecm-overview.md) (ECM) is to: - Provide the functionality to deploy and install micro frontends and widgets - Manage the connections between an application and the installed microservices -It integrates the Local Hub into the App Builder to list the Entando Bundles accessible from the EntandoApp, provisioning bundle management services such as install, uninstall, upgrade, downgrade and versioning. The Entando Kubernetes integration service communicates with the cluster to supply these bundle services and is the only service, other than the Entando Operator, that can interact with the cluster and custom resources. +The ECM integrates the Local Hub into the App Builder, listing the bundles accessible from the EntandoApp, and managing their install, uninstall, upgrade, downgrade and tracking processes. The Entando Kubernetes integration service communicates with the cluster to supply these bundle services and is the only service, other than the Entando Operator, that can interact with the cluster and custom resources. #### Entando Kubernetes Service -The Entando Kubernetes integration service (`entando-k8s-service`) is a function of the Entando Cluster infrastructure custom resource, providing an abstraction layer between Entando microservices and the APIs exposed by Kubernetes. It supplies access points to several custom resources defined by Entando, in particular Entando Applications, Entando Plugins, Entando Bundles and Entando links. +The Entando Kubernetes integration service (`entando-k8s-service`) is a function of the Entando cluster infrastructure custom resource, providing an abstraction layer between Entando microservices and the APIs exposed by Kubernetes. It supplies access points to several custom resources defined by Entando, in particular Entando Applications, plugins, bundles and links. The `entando-k8s-service` is used to: - Provide a list of the available Entando Bundles to the Entando Component Manager - Deploy a microservice, or expose an already available microservice, during the installation of a bundle - Create a link between an EntandoApp and an EntandoPlugin to expose microservice APIs to the EntandoApp and micro frontends -#### Entando Bundle -An Entando Bundle is a packaged set of components and resources created for the Entando Platform. The Entando Component Manager identifies the bundles and can install their components to extend the functionality of an Entando Application. - -See also: [Local Hub Overview](../compose/local-hub-overview.md) - #### Entando Plugin -An Entando Plugin is a microservice that exposes APIs reusable by one or more Entando Applications. Plugin services are commonly accessible from micro frontends and can be quickly generated with the [Entando Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md). A blueprint-generated project can be used as-is in an Entando environment and provides Keycloak integration, a set of default micro frontends, and microservices exposed by the bundle. +An Entando Plugin is a microservice that exposes APIs reusable by one or more Entando Applications. Plugin services are commonly accessible from micro frontends and can be quickly generated with the [Entando Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md). This blueprint-generated project is customizable and provides Keycloak integration, a set of default micro frontends, and microservices exposing APIs. #### Keycloak -Keycloak is responsible for authorization and authentication on Entando. All members of an Entando Cluster interact with Keycloak to verify user and service authorization. +Keycloak is responsible for authorization and authentication. All members of an Entando cluster interact with Keycloak to verify users and service authorizations. ## Entando Ingresses -An ingress is a Kubernetes resource that exposes HTTP and HTTPS paths from outside an Entando Cluster to services within it. Traffic routing is controlled by rules defined on the ingress resource. +An ingress is a Kubernetes resource that exposes HTTP and HTTPS paths from outside a cluster to services within it. Traffic routing is controlled by rules defined in the ingress resource. When deploying a cluster, ingresses are generated for the resources that must be exposed to external services. The Entando Operator and custom resource controllers create the ingresses and set the correct paths and certificates. Entando implements Keycloak and EntandoApp ingresses. #### Keycloak Ingress @@ -99,8 +104,8 @@ The EntandoApp ingress is also used to link a microservice with an EntandoApp wh The table below lists the default paths exposed for each ingress. --++ @@ -142,5 +147,8 @@ A microservice under the same domain (ingress) as the EntandoApp is exposed usin Once the link between the EntandoApp and the microservice is created, the controller reads the link specification. It then automatically creates HTTP paths in the EntandoApp to expose the microservice in the same domain as the App Builder, App Engine and Component Manager. This allows micro frontend developers to reference the microservice using relative URLs. -See also: [Entando Deployment Structure](../reference/deployment-structure.md) and [Check Ingresses](../reference/check-ingress.md) +See also: +* [Entando Deployment Structure](../reference/deployment-structure.md) +* [Check Ingresses](../reference/check-ingress.md) +* [Entando Glossary](../reference/glossary.md) diff --git a/vuepress/docs/next/docs/getting-started/ent-api.md b/vuepress/docs/next/docs/getting-started/ent-api.md index d6334c5fcf..a4cffc09b5 100644 --- a/vuepress/docs/next/docs/getting-started/ent-api.md +++ b/vuepress/docs/next/docs/getting-started/ent-api.md @@ -5,11 +5,11 @@ sidebarDepth: 1 # API Management -An API claim informs the Entando Platform that a micro frontend (MFE) intends to use the API of a microservice (MS). This request can be sent within a single bundle or across bundles. The abstraction of an API claim eliminates the need to define and manage API endpoints, both in local development and within a running instance. +An API claim informs the Entando Platform that a micro frontend (MFE) intends to use the API of a microservice (MS), standardizing authentication across many services. This request can be sent within a single bundle or across bundles. The abstraction of an API claim eliminates the need to define and manage API endpoints, both in local development and within a running instance. ## Internal vs. External API Claim -An MFE can initiate both internal and external API claims. An internal claim specifies an MS API in the same bundle as the MFE, while an external claim specifies the MS API of another bundle in the same Kubernetes namespace. +An MFE can initiate both internal and external API claims. An internal claim connects an MS API in the same bundle as the MFE, while an external claim specifies the MS API of another bundle in the same Kubernetes namespace. The structure of internal and external API claims are as follows: @@ -33,7 +33,7 @@ The structure of internal and external API claims are as follows: ## API Claim Commands -Common operations associated with API claims are detailed below. To execute `ent bundle api` subcommands, the user must be connected to a running Entando instance (via `ent attach-*`) or the CLI will generate an authentication error. +Common operations associated with API claims are detailed below. To execute `ent bundle api` subcommands, the user must be connected to a running Entando instance (via [ent attach-vm](ent-profile.md)) or the CLI will generate an authentication error. | Command | Description | :- | :- @@ -61,12 +61,12 @@ Common operations associated with API claims are detailed below. To execute `ent ## Microservice URL Retrieval -To retrieve the URL of an MS declared through an API claim, add `systemParams.api[claimName].url` to the MFE JavaScript code so it can access that element of the config object. The `claimName` is chosen by the user when the API claim was defined. +To retrieve the URL of an MS declared through an API claim, add `systemParams.api[claimName].url` to the MFE JavaScript code so it can access that element of the config object. The `claimName` is chosen by the user when the API claim is defined. **Installed Bundles** -The configuration data of installed bundles are provided by the Entando instance. To render an MFE from an installed bundle, Entando injects a JSON object containing configuration details inside the "config" attribute of a custom HTML element, e.g. ``. +The configuration data of installed bundles are provided by the Entando instance. To render an MFE from an installed bundle, Entando injects a JSON object containing configuration details inside the `config` attribute of a custom HTML element, e.g. ``. **Local Bundles** diff --git a/vuepress/docs/next/docs/getting-started/ent-bundle.md b/vuepress/docs/next/docs/getting-started/ent-bundle.md index a962b031f2..a90710a19f 100644 --- a/vuepress/docs/next/docs/getting-started/ent-bundle.md +++ b/vuepress/docs/next/docs/getting-started/ent-bundle.md @@ -4,44 +4,45 @@ sidebarDepth: 2 # Bundle Management -The Entando Bundle CLI extends the functionality of **ent** through a dedicated bundle management system. The `ent bundle` command orchestrates the lifecycle of a project, packaging it into a convenient and recognizable docker-based bundle that can be inserted into any Entando Application. This composable approach takes advantage of a single project descriptor and repository, along with centralized [API management](ent-api.md) and [DB and Keycloak services](ent-svc.md). Common operations and the steps required to create an Entando Bundle are detailed below. +The Entando Bundle commands extend the functionality of **ent** through a dedicated bundle management system. The `ent bundle` set of subcommands orchestrate the lifecycle of a component, packing it into a convenient standardized docker-based bundle that can be used to build composable applications. This approach takes advantage of a single project descriptor, along with centralized [API management](ent-api.md) and [DB and Keycloak services](ent-svc.md). Common operations and the steps required to create an Entando Bundle are detailed below. -In addition, this document describes the series of `ent ecr` commands that manage bundle interactions with the [Entando Component Repository](../../docs/compose/local-hub-overview.md) (ECR). These are applicable to both docker-based bundles and their git-based predecessors (< Entando 7.1). Notable commands applicable to creating and deploying git-based bundles only are also discussed. +In addition, this document describes the series of `ent ecr` commands that manage bundle interactions with the [Entando Component Repository](../../docs/compose/local-hub-overview.md) (ECR). These are applicable to both docker-based bundles and their git-based predecessors (< Entando 7.1). Notable commands applicable to creating and deploying only git-based bundles are also discussed. ## Entando Bundle Development -The `ent bundle` CLI tool provides a streamlined process to govern the files, structure, and management of Entando bundles. The bundle development lifecycle consists of 6 stages, each corresponding to a subcommand: +The bundle development lifecycle consists of 6 stages, each corresponding to a subcommand of ent bundle: -- [Initialization](#initialization): `ent bundle init` initializes a new bundle project, either with the default files and folders or from an existing bundle in an Entando Hub. The bundle format relies on a single JSON descriptor as the project manifest. +- [Initialization](#initialization): `ent bundle init` launches a new bundle project, either with the default starter files and folders, or dynamically, from the catalog of an Entando Hub. The bundle format relies on a single JSON descriptor as the project manifest. -- [Build](#build): With the structure established, `ent bundle build` generates micro frontend (MFE) and microservice (MS) components. These are filtered by type and name and assigned version numbers. +- [Build](#build): With the structure established, `ent bundle build` generates micro frontend (MFE) and microservice (MS) components. These are filtered by type and name, and assigned version numbers. -- [Run](#run): `ent bundle run` and Keycloak integration enable components to be tested locally, external to an Entando cluster. +- [Run](#run): `ent bundle run` and Keycloak integration enable components to be tested locally, independent of an Entando cluster. -- [Package](#package): `ent bundle pack` generates the bundle artifacts, the bundle image and the microservice images. One image is created for each microservice while a single image is created for the bundle and micro frontends. +- [Package](#package): `ent bundle pack` generates the bundle artifacts and images for the bundle and each microservice. -- [Publish](#publish): `ent bundle publish` pushes the Docker images to a Docker repository, after which the bundle can be deployed and installed. +- [Publish](#publish): `ent bundle publish` pushes the images to a Docker repository, after which the bundle can be deployed and installed. -- [Deploy](#deploy): `ent bundle deploy` delivers a published bundle to the ECR of an Entando Application. The bundle custom resource is generated and tags are retrieved from Docker Hub. +- [Deploy](#deploy): `ent bundle deploy` delivers a published bundle to the ECR of the Entando Platform. The bundle custom resource is generated and tags are retrieved from Docker Hub. -- [Install](#install): `ent bundle install` applies the bundle to the Entando instance. It is then available in the App Builder for unlimited reuse within the application. +- [Install](#install): `ent bundle install` applies the bundle to the Entando instance. It is then available in the App Builder for unlimited reuse. -See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-simple-bundle.md) tutorial to see the full process. And for more information on Entando Bundle specifications, go to the [Bundle Details](../curate/bundle-details.md) page. +See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-simple-bundle.md) tutorial to follow the full process. And for more information on Entando Bundle specifications, go to the [Bundle Details](../curate/bundle-details.md) page. ## Docker-based Bundle Commands | Commands | Description | |:- |:- |`ent bundle build`| Build components (MFE, MS) with a selector | -|`ent bundle deploy`|Deploy a bundle to the Local Hub of an Entando Application +|`ent bundle convert --bundle-path [path1]` | Convert a git-based bundle to a Docker-based one | +|`ent bundle deploy`|Deploy a bundle to the Local Hub of an Entando Platform |`ent bundle generate-cr`| Generate the Entando Custom Resource for a bundle project | |`ent bundle help` | Display help for ent bundle | |`ent bundle info`| Show status information for the bundle project | |`ent bundle init`| Initialize the project folder structure and descriptor | -|`ent bundle install`| Install a bundle to the Local Hub of an Entando Application| +|`ent bundle install`| Install a bundle to the Local Hub of an Entando Platform| |`ent bundle list`| List the available bundle components | |`ent bundle mfe add` | Add a micro frontend | -| `ent bundle mfe rm` | Remove a micro frontend | +|`ent bundle mfe rm` | Remove a micro frontend | |`ent bundle ms add` | Add a microservice | |`ent bundle ms rm` | Remove a microservice | |`ent bundle run`| Run bundle components | @@ -54,25 +55,25 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si | Command | Description |:--|:-- |`ent bundle init [name]` | Initialize a new empty project with the default structure and files | -|`ent bundle init [name] --from-hub`| Initialize a bundle from the Entando Cloud Hub | +|`ent bundle init [name] --from-hub`| Initialize a bundle from the Entando Marketplace catalog | |`ent bundle init [name] --from-hub --hub-url=[url]` | Initialize a bundle from an enterprise Entando Hub | -|`ent bundle init [name] --from-hub --hub-url=[url] --hub-api-key=[]` | Initialize a bundle from a private Entando Hub with an API key| +|`ent bundle init [name] --from-hub --hub-url=[url] --hub-api-key=[]` | Initialize a bundle from a private enterprise Entando Hub with an API key| #### Init Command Details - Bundle names may only contain lowercase letters, numbers, periods(.) and dashes(-). They cannot start or end with periods or dashes. - `--from-hub`: This option leverages an existing bundle from an Entando Hub to jumpstart your project. The `ent bundle` tool will pull the package and rebuild the structure, which can then be customized locally. -- `--hub-url`: Use this option to specify a custom Entando Hub, else ent defaults to the Entando Cloud Hub +- `--hub-url`: Use this option to specify an enterprise Entando Hub, else ent defaults to the Entando Cloud Hub. -- `--hub-api-key`: This flag supplies the [Hub API key](../../tutorials/solution/entando-hub.md#create-a-private-catalog) to access a bundle from a private enterprise Entando Hub to copy it locally. +- `--hub-api-key`: This flag supplies the [Hub API key](../../tutorials/solution/entando-hub.md#create-a-private-catalog) to access a bundle from a private enterprise Hub. ### Micro Frontend and Microservice | Command| Descriptions |:--|:-- -|`ent bundle mfe add` --stack [stack-type] [name] | Add a React or Angular micro frontend | -|`ent bundle mfe add` --stack custom [name] | Add a custom stack micro frontend | +|`ent bundle mfe add --stack [stack-type] [name]` | Add a React or Angular micro frontend | +|`ent bundle mfe add --stack custom [name]` | Add a custom stack micro frontend | |`ent bundle ms add --stack [stack-type] [name]` | Add a Spring Boot or node microservice | -|`ent bundle ms add` --stack custom [name]` | Add a custom stack microservice | +|`ent bundle ms add --stack custom [name]` | Add a custom stack microservice | #### MFE and MS Command Details - `ent bundle mfe add --stack custom [name]` & `ent bundle ms add --stack custom [name]`: When a custom stack is used for any MFE or microservice, custom commands for the build, run, and pack functions are required under the Command spec in the bundle descriptor `entando.json`. In addition, a version number must be specified for each component. Because Entando can only parse information from a pom.xml or package.json, the custom commands are required to manage the bundle, and the version number is required to track Docker images. For an example, see the [Bundle Details](../curate/bundle-details.md#micro-frontends-sample-code) page. @@ -89,16 +90,16 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si #### Build Command Details - `ent bundle build`: - - The `build` command constructs the project files based on the `entando.json` descriptor. + - The `build` sub command constructs the project files based on the `entando.json` descriptor. - Component type and stack determines the build process, e.g. a React MFE executes an npm build. It can be customized in the command section of the `entando.json`. - All the components in the bundle are built in parallel. - A log file for each component is generated inside the .entando/logs directory of the project. - `--fail-fast`: - - Fail the command as soon as any subtask fails + - Fail the command as soon as any subtask fails. - `--max-parallel=`: - Maximum number of subtasks running simultaneously. The default value is 3. Setting `max-parallel=1` results in a sequential process. - `--stdout`: - - Print the subtask logs to the standard output (stdout) instead of individual log files. This is very useful in CI/CD pipelines. + - Print the subtask logs to the standard output (stdout) instead of individual log files. This is useful in CI/CD pipelines. ### Run | Command| Descriptions @@ -111,7 +112,7 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si #### Run Command Details - `ent bundle run`: - - The `run` command executes processes in accordance with the component type and stack, e.g `mvn spring-boot:run` for a Spring Boot microservice. It can be customized in the command section of the `entando.json`. + - The `run` subcommand executes processes in accordance with the component type and stack, e.g `mvn spring-boot:run` for a Spring Boot microservice. It can be customized in the command section of the `entando.json`. - All the components in the bundle run in parallel, with the logs printed to the standard output. - The `run` command can be used to run multiple microservices side by side without collision in local development, but in production, they must run on port 8081. @@ -128,13 +129,13 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si - `ent bundle pack`: - The artifacts generated for micro frontends and microservices are stored in their respective component folders. File format depends on component type, e.g. a React micro frontend may result in HTML, JavaScript and CSS files. - Once the artifacts are generated, a Docker image for each microservice is built using the Dockerfile located in the microservice's folder. If the Dockerfile is missing, the `pack` command exits with failure. - - The `pack` command executes either `mvn package` or `npm run build`, depending on the stack. These defaults can be overridden in the [custom command section](../curate/bundle-details.md#command-specification) of the bundle descriptor `entando.json`. + - The `pack` subcommand executes either `mvn package` or `npm run build`, depending on the stack. These defaults can be overridden in the [custom command section](../curate/bundle-details.md#command-specification) of the bundle descriptor `entando.json`. - `--fail-fast`: - Fail the command as soon as any subtask fails - `--max-parallel=`: - Maximum number of subtasks running simultaneously. The default value is 3. Setting `max-parallel=1` results in a sequential process. - `--stdout`: - - Print the subtask logs to the standard output (stdout) instead of individual log files. This is very useful in CI/CD pipelines. + - Print the subtask logs to the standard output (stdout) instead of individual log files. This is useful in CI/CD pipelines. - `--skip-docker-build`: - Allow the user to create a custom image build. The YAML descriptors and Dockerfile are created in the `.output` folder but no images are generated for the bundle and microservices. - `ent bundle images`: @@ -150,17 +151,17 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si ### Deploy | Command| Description |:--|:-- -|`ent bundle deploy`| Deploy a bundle to the Local Hub of an Entando Application | +|`ent bundle deploy`| Deploy a bundle to the Local Hub of the Entando Platform | ### Install | Command| Description |:--|:-- -|`ent bundle install`| Install a bundle in the Local Hub of an Entando Application | +|`ent bundle install`| Install a bundle in the Local Hub of the Entando Platform | #### Install Command Details -* `ent bundle install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components +* `ent bundle install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, this flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components. -### Convert v1 to v5 +### Convert v1 to v5 Bundle | Command| Descriptions |:--|:-- @@ -196,14 +197,14 @@ The following commands are applicable to both docker-based and git-based bundles |`ent ecr uninstall`| Uninstall a bundle | #### ECR Command Details -* `ent ecr get-bundle-id`: The unique identifier assigned to each bundle provides a mechanism to customize parameters and add security controls for bundle-specific resources +* `ent ecr get-bundle-id`: The unique identifier assigned to each bundle provides a mechanism to customize parameters and add security controls for bundle-specific resources. -* `ent ecr get-plugin-code`: To retrieve the unique identifier for each microservice +* `ent ecr get-plugin-code`: Retrieve the unique identifier for each microservice. * Docker-based bundles: `ent ecr get-plugin-code YOUR-ORG/YOUR-PLUGIN-NAME --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE` * Git-based bundles: `ent ecr get-plugin-code --auto --repo=[repository-url]` -* `ent ecr install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components +* `ent ecr install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components. ## Git-based Bundle Commands @@ -233,7 +234,7 @@ The following ent commands are used to manage git-based (< Entando 7.1) bundles. * `ent prj get-plugin-code`: Uniquely and safely identifies each bundle plugin and derived cloud-native resources -* `ent prj install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components +* `ent prj install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, this flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components * `ent bundler`: Provides an interactive mode to identify components to export. Point the bundler to existing environments to extract components and static assets into a custom bundle. This bundle can be used to migrate from one Entando environment to another (e.g. Dev to QA) or as a framework for building a new application. diff --git a/vuepress/docs/next/docs/getting-started/ent-diag.md b/vuepress/docs/next/docs/getting-started/ent-diag.md index a50c5839e2..42913cf639 100644 --- a/vuepress/docs/next/docs/getting-started/ent-diag.md +++ b/vuepress/docs/next/docs/getting-started/ent-diag.md @@ -4,24 +4,24 @@ sidebarDepth: 1 # Diagnostics and Troubleshooting -Diagnostic information is critical to analysis and troubleshooting, and the Entando CLI (ent) is a useful tool for debugging issues with an Entando instance. +Diagnostic information is critical for troubleshooting and analysis, and the Entando CLI (ent) provides several methods. | Command | Description -| :- | :- -| `ent app-info` | Display basic information about Kubernetes and Entando resources -| `ent bundle info` |Show status information for the bundle project| -| `ent --debug bundle "command"` |Enable debug mode| -| `ent diag` | Run diagnostics on the pods currently in an Entando namespace and prepare a diagnostic tar.gz -| `ent pod "command"` | Displays information related to a set of pods -| `ent pod grep --all "error\|fail"` | Locate error messages within EntandoApp pods +| :- | :---------------------------- | +|`ent app-info`| Display basic information about Kubernetes and Entando resources +|`ent bundle info`|Show status information for the bundle project| +|`ent --debug bundle "command"`|Enable debug mode| +|`ent diag`| Run diagnostics on the pods in the current Entando namespace and prepare a diagnostic tar.gz +|`ent pod "command"`| Display information related to a set of pods +|`ent pod grep --all "error\|fail"`| Locate error messages within EntandoApp pods ### Command Details -* `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command also generates diagnostics and returns log paths like the following: +* `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command generates this diagnostics data and returns log paths like the following: ``` > Collected diagdata available under "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000" for consultation > Collected diagdata available in archive "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000.tgz" ``` -* `ent pod "command"`: Analyzes pods in a cluster with commands like `describe`, `logs`, `shell`, `force-reload`, `port-forward`, and others. +* `ent pod "command"`: Administer pods in a cluster with subcommands like `describe`, `logs`, `shell`, `force-reload`, `port-forward`, and others. ### Log Files Log files for the `ent bundle build` and `pack` commands are generated for each component inside the .entando/logs directory. For single components and other processes, they are printed to the standard outputs. \ No newline at end of file diff --git a/vuepress/docs/next/docs/getting-started/ent-profile.md b/vuepress/docs/next/docs/getting-started/ent-profile.md index 71d6584f16..fbeb98c93b 100644 --- a/vuepress/docs/next/docs/getting-started/ent-profile.md +++ b/vuepress/docs/next/docs/getting-started/ent-profile.md @@ -3,17 +3,15 @@ sidebarDepth: 1 --- -# Profile and Configuration Management +# Profile Management -The [Entando CLI](entando-cli.md) can define a collection of configuration variables to fully describe an Entando instance. One or more profiles can be created to store configuration settings for a particular instance. A profile with this information is automatically generated for a quickstart application. +The [Entando CLI](entando-cli.md) manages one or more profile to store the configuration settings for a particular Entando instance. For a quickstart installation, a profile is automatically generated and can be edited for customization. A set of `ent profile` subcommands are available to manage the configurations and to switch between different Entando instances. -At minimum, a profile configuration must consist of the key-value pairs specifying the application name and namespace. To run the application, the Kubernetes connection must also be provided. Cloud Kubernetes tools typically create a Kube context, which can be linked to an Entando profile. +At a minimum, a profile must consist of the key-value pair specifying the application name and namespace. To run Entando, a Kubernetes context must be established and linked to an Entando profile. ## Profile Management -Common operations associated with profile management are detailed below. - -Note: The `ent profile` command is available to manage and switch between the configurations of different Entando instances. Refer to `ent profile first-use-readme` for additional information. +Refer to `ent profile first-use-readme` for additional information. | Command | Description | :- | :- @@ -31,17 +29,17 @@ Note: The `ent profile` command is available to manage and switch between the co **Command details:** -- `ent pro link`: Provides ent with instructions to connect to the Kubernetes containing the Entando Application. Alias of `ent attach-kubectx`. +- `ent pro link`: Provides ent with instructions to connect to the Kubernetes containing the EntandoApp. Alias of `ent attach-kubectx`. - `ent pro new`: Sets the minimal profile data and outputs next steps. - `ent pro use`: Initializes the global profile ent should use across shells. -- `source ent pro use`: Initializes the local profile ent should use within the current shell. Allows ent instances in different shells to simultaneously use different Kube contexts, kubeconfigs or custom commands. The quickstart script creates a profile named "qs--{vmname}" that is associated with the Entando Application it generates. +- `source ent pro use`: Initializes the local profile ent should use within the current shell. It allows ent instances in different shells to simultaneously use different Kube contexts, kubeconfigs or custom commands. The quickstart script creates a profile named "qs--{vmname}" that is associated with the EntandoApp. ## Configuration Management -The output of `ent config` is a key-value archive of configuration settings related to the current profile. The following commands and definitions are especially useful. +The output of `ent config` is a key-value archive of configurations defining the current profile. The following commands and definitions may be useful. ### Commands @@ -59,7 +57,7 @@ The output of `ent config` is a key-value archive of configuration settings rela | Key | Description |---|--- | ENTANDO_NAMESPACE | Stores the fallback namespace used by explicit or implicit runs of `ent kubectl` -| ENTANDO_APPNAME | Stores the Entando Application name related to the current profile +| ENTANDO_APPNAME | Stores the EntandoApp name related to the current profile | DESIGNATED_JAVA_HOME | Stores the path of the Java version used internally by ent diff --git a/vuepress/docs/next/docs/getting-started/ent-svc.md b/vuepress/docs/next/docs/getting-started/ent-svc.md index 2709e446db..ac51882e27 100644 --- a/vuepress/docs/next/docs/getting-started/ent-svc.md +++ b/vuepress/docs/next/docs/getting-started/ent-svc.md @@ -4,9 +4,9 @@ sidebarDepth: 1 # Auxiliary Services -Auxiliary services add capabilities to a local environment to accelerate application development. This is in contrast to developing on Kubernetes, where the equivalent services are either provisioned by the Entando Platform or are externally managed and pointed to by the application. +Auxiliary services add capabilities to a local environment for application development. This is in contrast to developing on Kubernetes, where the equivalent services are either provisioned by the Entando Platform or are externally managed and pointed to by the application. -To run auxiliary operations, a service must be enabled. When the Entando Bundle CLI enables a service, a default auxiliary configuration is generated and formatted as a Docker Compose YAML file in the bundle's 'svc' folder. Enabled services are listed under the 'svc' attribute in the bundle descriptor, `entando.json`. +To run auxiliary operations, a service must be enabled. When the Entando CLI enables a service for a bundle, a default auxiliary configuration is generated and formatted as a Docker Compose YAML file in the bundle's "svc" folder. Enabled services are listed under the `svc` attribute of the bundle descriptor `entando.json`. The following sections describe how Entando supports and implements auxiliary services. @@ -16,17 +16,17 @@ Three services are available out of the box: `mysql`, `postgresql` and `keycloak - `mysql` and `postgresql` obey the same naming convention - The username and password are derived from the bundle name, e.g. YOUR-BUNDLE has the username YOUR-BUNDLE-USER and the password YOUR-BUNDLE-PASSWORD - - A database is automatically created and given the bundle name, e.g. YOUR-BUNDLE + - A database is automatically created and given the name, e.g. YOUR-BUNDLE -- `keycloak` configures authentication for Entando - - The `keycloak` realm name is 'entando-dev' +- `keycloak` manages authentication for Entando + - The `keycloak` realm name is `entando-dev` - The console is accessible at *http://localhost:9080* with username: *admin*, password: *admin* - All roles and permissions are preset, based on the Keycloak realm-config file - - The `keycloak.yaml`, realm-config and user config files are located in the 'keycloak' folder inside 'svc' + - The `keycloak.yaml`, realm-config, and user config files are located in the "keycloak" folder inside "svc" ## Custom Services -A custom service can be added to a bundle's 'svc' folder as a Docker Compose YAML file. The file and service must have the same name, e.g. if the service filename is `mysql.yml`, then the service name must be `mysql`: +A custom service can be added to a bundle's "svc" folder as a Docker Compose YAML file. The file and service must have the same name, e.g. if the service filename is `mysql.yml`, then the service name must be `mysql`: ``` yaml version: '3.7' @@ -54,8 +54,8 @@ The subcommands of `ent bundle svc` are used to manage services. **Command details:** -- `svc logs`: The log of a running service will continue to update until exited via `Ctrl+C` +- `svc logs`: The log of a running service will continue to update until exited via `Ctrl+C`. -- `svc list`: Include the option `--available` to list all services located in the 'svc' bundle folder +- `svc list`: Include the option `--available` to list all services located in the "svc" bundle folder. - Auxiliary commands can operate on multiple services by listing each service name as an argument, e.g. `ent bundle svc start service_1 service_2`. The option `--all` applies the command to all enabled bundle services. \ No newline at end of file diff --git a/vuepress/docs/next/docs/getting-started/entando-cli.md b/vuepress/docs/next/docs/getting-started/entando-cli.md index e032ec799d..7bde158280 100644 --- a/vuepress/docs/next/docs/getting-started/entando-cli.md +++ b/vuepress/docs/next/docs/getting-started/entando-cli.md @@ -4,7 +4,7 @@ sidebarDepth: 1 # Entando CLI -The Entando Command Line Interface, **ent**, provides a set of commands that accelerate common tasks such as installing a new instance of Entando, building projects, creating and deploying bundles, and composing Entando Applications. This document covers the install, command list, and a few operations to start using the ent tool. +The Entando command line interface, **ent**, provides a set of commands that accelerate common tasks such as installing Entando, building projects, creating and deploying bundles, and composing Entando Applications. This document covers some basic commands to start using the ent tool. For specific topics, follow these links: 1. [Bundle Management](ent-bundle.md): `ent bundle` @@ -15,7 +15,7 @@ For specific topics, follow these links: ### Prerequisites -The basic requirements for the CLI vary with use case, as shown in the table below. +The requirements for ent functionality vary with each use case, shown in the table below. | Category | Prerequisite | :- | :- @@ -31,7 +31,7 @@ Install the current official release of the CLI: bash <(curl -L "https://get.entando.org/cli") --update --release="{{ $site.themeConfig.entando.fixpack.v73 }}" ->The automatic option in [Getting Started](../getting-started/) will install the CLI along with a quickstart Entando Application. +>The automatic option in [Getting Started](../getting-started/) will also install the CLI along with a quickstart Entando ACP. ## Command List Use `ent help` to review the list of available commands.\ @@ -39,8 +39,8 @@ Use `ent [command] --help` for command details. ``` > Available commands: - app-info => Displays information about an entando app - - bundle => Management of new generation entando bundles - - bundler => Export of resources from a running instance and generation old-generation bundle deployment CRs + - bundle => Management of entando bundles (v5 or higher) + - bundler => Export of resources from a running instance and older-generation bundle management - check-env => Checks the environment for required dependencies and settings - diag => Runs diagnostics and aggregates the related info in a .tgz file - ecr => Helper for managing the ECR @@ -50,7 +50,7 @@ Use `ent [command] --help` for command details. - kubectl => Helper for using kubectl in ent managed scenarios - pod => Displays information related to a set of pods - prj => Helper for managing the first generation of Entando bundle projects - - profile => Helps managing an EntandoApp + - profile => Helps manage the EntandoApp - quickstart => Helper for installing Entando instances locally - run-tests => Runs the internal tests @@ -77,16 +77,18 @@ TOPICS svc Manage auxiliary services COMMANDS - build Build bundle components - deploy Deploy a bundle to the Local Hub of an Entando Application + build Build the bundle components + deploy Generate the CR and deploy it to the currently attached EntandoApp generate-cr Generate the Entando Custom Resource (CR) for a bundle project - help Display help for ent bundle. + help Display help for ent bundle + images List the Docker images and their corresponding tags that are + included in the bundle info Show status information for the bundle project init Perform the scaffolding of a bundle project - install Install a bundle in the Local Hub of an Entando Application + install Install a bundle in the current directory to the currently attached EntandoApp list List the available components in the bundle pack Generate the bundle Docker images - publish Publish bundle Docker images + publish Publish the bundle Docker images run Run bundle components DEBUG MODE @@ -95,7 +97,7 @@ DEBUG MODE ``` ### Check the Environment -Verify dependencies required by your Entando installation: +Verify the dependencies required by your Entando installation: ``` bash ent check-env develop ``` @@ -107,16 +109,16 @@ To update ent to the latest version and check for dependencies: bash <(curl -L "https://get.entando.org/cli") --update ent check-env develop ``` ->Alternatively, to perform a clean install, delete the `~/.entando` directory via `rm -rf ~/.entando`. Then reinstall the CLI using the instructions above. This will also remove the private copies of JHipster, Entando Blueprint, etc. +>Alternatively, to perform a clean install, delete the `~/.entando` directory with the flags `rm -rf ~/.entando`. Then reinstall the CLI using the instructions above. This will also remove the private copies of JHipster, Entando Blueprint, etc. ### Enable Debug Mode -To utilize the debug mode for ent bundle commands: +To utilize the debug helper for ent bundle commands: ``` sh ent --debug bundle ``` ### Customize Quickstart -The `ent quickstart` command accepts parameters to customize your quickstart environment. These options allow you to modify specific properties of your VM, installation versions and databases. +The `ent quickstart` command accepts parameters to customize your quickstart environment. These options allow you to modify specific properties of the VM, installation versions, and databases. |Operation |Syntax|Description| |:--|:--|:--| diff --git a/vuepress/docs/next/docs/getting-started/img/entando-architecture-v1.5.svg b/vuepress/docs/next/docs/getting-started/img/entando-architecture-v1.5.svg deleted file mode 100644 index 0622d0bab7..0000000000 --- a/vuepress/docs/next/docs/getting-started/img/entando-architecture-v1.5.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Entando Quickstart Architecture
Entando Quickstart Architecture
User Interface
User Interface
User/Identity Admin
User/Identity Admin
Entando Identity Management
Entando Identity Management
Content
Content
App Admin
App Admin
App Users
App Users
App Builder UI
App Builder UI
Content
Content
MFE
MFE
Paths
Paths
/abc-plugin-ingress-path
/abc-plugin-ingress-path
/app-builder
/app-builder
/auth
/auth
/entando-de-app
/entando-de-app
/digital-exchange
/digital-exchange
Kubernetes Containers
Kubernetes Containers
Plugin/Microservice Container(s)
Plugin/Microservice...
abc-plugin-server-deployment
abc-plugin-server-dep...
App Builder
App Builder
Component Manager
Component Manager
App Engine
App Engine
APIs
APIs
Core
Core
CMS
CMS


quickstart-cm-deployment
quickstart-cm-deploy...
quickstart-deployment
quickstart-deploym...
Operator
Operator
entando-operator
entando-opera...

default-sso-in-namespace-deployment

default-sso-in-namespace-dep...
Keycloak Server
Keycloak Server
entando-k8s--service
entando-k8s--ser...
Kubernetes Service
Kubernetes Service
Note: The Operator listens for events within the Kubernetes cluster and performs actions accordingly, e.g. creating Entando pods during initial install, setting up plugin ingress and pods upon bundle installation from ECR, etc.
Note: The Operator listens for events within the Kubern...

quickstart-ab-deployment

quickstart-ab-deployment
Custom App UI
Custom App UI

Text is not SVG - cannot display \ No newline at end of file diff --git a/vuepress/docs/next/docs/getting-started/img/entando-architecture.png b/vuepress/docs/next/docs/getting-started/img/entando-architecture.png index 8943dda7c2..549c9bd5ba 100644 Binary files a/vuepress/docs/next/docs/getting-started/img/entando-architecture.png and b/vuepress/docs/next/docs/getting-started/img/entando-architecture.png differ diff --git a/vuepress/docs/next/docs/getting-started/img/entando-cluster-arch.png b/vuepress/docs/next/docs/getting-started/img/entando-cluster-arch.png new file mode 100644 index 0000000000..13281c8956 Binary files /dev/null and b/vuepress/docs/next/docs/getting-started/img/entando-cluster-arch.png differ diff --git a/vuepress/docs/next/docs/getting-started/landing-page.md b/vuepress/docs/next/docs/getting-started/landing-page.md index d588764807..42c5a13749 100644 --- a/vuepress/docs/next/docs/getting-started/landing-page.md +++ b/vuepress/docs/next/docs/getting-started/landing-page.md @@ -4,26 +4,26 @@ sidebarDepth: 2 # Entando Solution Templates -The Entando Application Composition Platform offers several Solution Templates to demonstrate various business capabilities and integrations: +The Entando ACP offers several Solution Templates to demonstrate various business capabilities and integrations: - [**Entando Customer Portal**](../../tutorials/solution/customer-portal.md) - [**Entando Hub**](../../tutorials/solution/entando-hub.md) - [**Entando Process Driven Applications Plugin**](../../tutorials/solution/pda-tutorial.md) - [**Entando Standard Banking Demo**](../../tutorials/solution/install-standard-demo.md) -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. +Each open source template was built with Entando and can be used as-is, reviewed as a reference, customized, or leveraged as a starting point for a similar application. -The following Solution Templates and other sets of components are available in the [public Entando Hub](https://entando.com/composable-platform/packaged-business-capabilities/) for installation in a user environment, where turnkey functionality can be customized and extended. +These Solution Templates, and other packaged business capabilities (PBCs), are available in the [Entando Marketplace Hub](https://entando.com/composable-platform/packaged-business-capabilities/). ## Entando Customer Portal -The [Entando Customer Portal](../../tutorials/solution/customer-portal.md) streamlines development of a customer-facing, self-service subscription management application. The Platform integrates Keycloak role based access control and Jira Service Management as a ticket tracking system. +The [Entando Customer Portal](../../tutorials/solution/customer-portal.md) is a customer-facing, self-service subscription management application. The Platform integrates Keycloak for role based access control and Jira Service Management as a ticket tracking system. ## Entando Hub -The [Entando Hub](../../tutorials/solution/entando-hub.md) empowers a team to share and collaborate on proprietary or Entando open source components. Capabilities, versions and metadata can be transparently analyzed, managed and published. +The [Entando Hub](../../tutorials/solution/entando-hub.md) empowers a team to share and collaborate on proprietary or Entando open source components. Capabilities, versions and metadata can be analyzed, managed and published. You can install a private catalog to share components within a team or the whole organization with user access controls. @@ -32,13 +32,13 @@ The [Entando Hub](../../tutorials/solution/entando-hub.md) empowers a team to sh ## Entando Process Driven Applications Plugin -The [Entando Process Driven Applications Plugin](../../tutorials/solution/pda-tutorial.md) provides a comprehensive and versatile automation scheme for Business Process Management. It comprises a custom UX layer, a Spring Boot Backend for Frontend microservice interface, and integration with the [Red Hat Process Automation Manager](https://www.redhat.com/en/technologies/jboss-middleware/process-automation-manager). +The [Entando Process Driven Applications Plugin](../../tutorials/solution/pda-tutorial.md) provides a comprehensive and versatile automation scheme for Business Process Management. It comprises a custom UX layer, a Spring Boot Backend for Frontend microservice interface, and integration with the [Red Hat Process Automation Manager](https://access.redhat.com/products/red-hat-process-automation-manager). ## Entando Standard Banking Demo -The [Entando Standard Banking Demo](../../tutorials/solution/install-standard-demo.md) showcases the benefits and possibilities of a composable application built from modular components. The example banking environment integrates a transaction table, sign up form, alert icon, and summary cards to demonstrate MFE communication and capabilities. Prominent features include Keycloak role based access control, coexistence of React and Angular MFEs, and pluggable Spring Boot microservices. +The [Entando Standard Banking Demo](../../tutorials/solution/install-standard-demo.md) showcases the possibilities and benefits of a composable application built from modular components. The example banking environment integrates a transaction table, sign up form, alert icon, and summary cards to demonstrate micro frontend (MFE) capabilities. Prominent features include Keycloak role based access control, coexistence of React and Angular MFEs, and pluggable Spring Boot microservices. diff --git a/vuepress/docs/next/tutorials/getting-started/azure-install.md b/vuepress/docs/next/tutorials/getting-started/azure-install.md index 22a5ca03cb..228faec784 100644 --- a/vuepress/docs/next/tutorials/getting-started/azure-install.md +++ b/vuepress/docs/next/tutorials/getting-started/azure-install.md @@ -140,7 +140,7 @@ kubectl get pods -n entando --watch http://YOUR-HOST-NAME/app-builder/ ``` -See the [Getting Started guide](../../docs/getting-started/README.md#login-to-entando) for helpful login instructions and next steps. +See the [Getting Started guide](../../docs/getting-started/README.md#log-in-to-entando) for helpful login instructions and next steps. ## Appendix A - Troubleshooting diff --git a/vuepress/docs/next/tutorials/getting-started/eks-install.md b/vuepress/docs/next/tutorials/getting-started/eks-install.md index 6658c4bf70..39fce2c281 100644 --- a/vuepress/docs/next/tutorials/getting-started/eks-install.md +++ b/vuepress/docs/next/tutorials/getting-started/eks-install.md @@ -214,7 +214,7 @@ Use `Ctrl+C` to exit the command. ``` http://YOUR-HOST-NAME/app-builder/ ``` -Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#login-to-entando) for helpful login instructions and next steps. +Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#log-in-to-entando) for helpful login instructions and next steps. ## Appendix A - Troubleshooting IAM and Roles diff --git a/vuepress/docs/next/tutorials/getting-started/gke-install.md b/vuepress/docs/next/tutorials/getting-started/gke-install.md index 735e3980f8..839a648061 100644 --- a/vuepress/docs/next/tutorials/getting-started/gke-install.md +++ b/vuepress/docs/next/tutorials/getting-started/gke-install.md @@ -132,7 +132,7 @@ kubectl get pods -n entando --watch http://YOUR-HOST-NAME/app-builder/ ``` -See the [Getting Started guide](../../docs/getting-started/README.md#login-to-entando) for helpful login instructions and next steps. +See the [Getting Started guide](../../docs/getting-started/README.md#log-in-to-entando) for helpful login instructions and next steps. ## Appendix: Configuring Clustered Storage diff --git a/vuepress/docs/next/tutorials/getting-started/openshift-install.md b/vuepress/docs/next/tutorials/getting-started/openshift-install.md index ba03e915bb..6e047c2a2e 100644 --- a/vuepress/docs/next/tutorials/getting-started/openshift-install.md +++ b/vuepress/docs/next/tutorials/getting-started/openshift-install.md @@ -84,7 +84,7 @@ http://YOUR-HOST-NAME/app-builder/ ``` ## Next Steps -Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#login-to-entando) for helpful login instructions and next steps. +Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#log-in-to-entando) for helpful login instructions and next steps. ## Appendix - Troubleshooting and Common Errors diff --git a/vuepress/docs/v7.3/docs/README.md b/vuepress/docs/v7.3/docs/README.md index a83146b3a4..1c48882861 100644 --- a/vuepress/docs/v7.3/docs/README.md +++ b/vuepress/docs/v7.3/docs/README.md @@ -4,16 +4,19 @@ sidebarDepth: 0 # Entando Platform -Entando is the leading open source **Application Composition Platform** for Kubernetes. It enables parallel teams to accelerate development and innovation of business capabilities on a modern, cloud-native, and Kubernetes-native stack. +Entando is an open-source application composition platform (ACP) that streamlines the development of composable applications for the web. By implementing a modular architecture, the Platform enables parallel teams to accelerate development and innovation on a modern, cloud-native, and Kubernetes-native stack. + +With Entando’s distributed working environment, you can build applications composed of modular reusable components and manage them all from one platform. The system includes development and runtime tools, a component catalog, and a component orchestrator to support all aspects of the development lifecycle. -It is a distributed and composable environment in which components can be built, scaled and iterated independently, helping teams build agile applications that can adapt to change. ![Entando Platform Development Process](./getting-started/img/concepts.png) -On the Entando Platform, development of an application is organized into four stages: Create, Curate, Compose, and Consume. In the simplest terms, you create functional building blocks, curate them in a catalog, compose the blocks into an application, which is then consumed by a user. The Enterprise Architect oversees the process, defining business domains and mapping the capabilities for the building blocks. +Development on Entando can be organized into four stages: Create, Curate, Compose, and Consume. In the simplest terms, you create functional building blocks or bundles, curate them in a catalog, compose them into an application, which is then consumed by a user. The Enterprise Architect oversees the process, defining business domains and mapping capabilities for the building blocks. -## Create Components -Building a composable application on Entando involves designing and creating each independent component or building block. Developers can use the [Entando Component Generator](./create/component-gen-overview.md) and [Blueprint](./create/blueprint-features.md) to automate the building and packaging of projects using any technology they choose. The modular architecture of apps built on Entando means new business capabilities can be easily integrated without reworking existing systems. + + +## Create +Building a composable application begins with self-contained bundles, created from scratch or using existing code. With the freedom to choose the technologies and frameworks that meet their needs, developers can use the [Entando Component Generator](./create/component-gen-overview.md) and [Blueprint](./create/blueprint-features.md) to speed up the process. The composable methods of Entando mean innovations can be easily integrated without reworking existing systems. | Documentation | Tutorials | | :------------ | :--------- | @@ -21,31 +24,29 @@ Building a composable application on Entando involves designing and creating eac | [Entando Blueprint Feature](./create/blueprint-features.md) | [Microservices](../tutorials/create/ms/generate-microservices-and-micro-frontends.md) | | [Component Generation Technologies](./create/component-gen-tech.md) | [Build and Publish Project Bundles](../tutorials/create/pb/publish-project-bundle.md) | -## Curate and Share Components -On the Entando Platform, Curate and Share means development teams can bundle and share components within a central catalog. Multiple teams can collaborate on a single component or packaged business capabilities (PBCs) and share them across organizations and applications. They can test and assess components for readiness, manage and publish versions, and share metadata for continuous upgrades. +## Curate +In this stage, curators discover and organize components to share across teams and projects. The components can be sourced internally or from the [Entando Marketplace](https://entando.com/composable-platform/packaged-business-capabilities/) which offers a selection of pre-built solutions. Curators assess, publish, and share component features and metadata in a private or public hub, ensuring that it is discoverable. Centralizing these functions also makes is easier to govern the consistency of the reusable bundles. | Documentation | Tutorials | | :------------ | :-------- | -| [Bundle and Component Descriptors](./curate/bundle-details.md) | [Install Bundles from a Private Image Registry](../tutorials/curate/bundle-private-images.md) | -| [Filtering Bundles](./curate/bundle-filters.md) | [Install Bundle Microservices from a Private Image Registry](../tutorials/curate/ms-private-images.md) | -| [Customize Bundle Info in App Builder](./curate/bundle-presentation-config.md) | | -| [Bundle Version and Updates FAQ](./curate/bundle-versions-faq.md) | | -| [Bundle Uninstall](./curate/uninstall-flow.md) | | +| [Bundle Details](./curate/bundle-details.md) | [Install Bundles from a Private Image Registry](../tutorials/curate/bundle-private-images.md) | +| [Bundle Component Descriptors](./curate/bundle-component-details.md) | [Install Bundle Microservices from a Private Image Registry](../tutorials/curate/ms-private-images.md) | +| [Enterprise Entando Hub](./curate/hub-details.md) | | + -## Compose an Application -The Compose stage is centered around the [Entando App Builder](./compose/app-builder.md), a low-code composition user interface where an application can be assembled using the prebuilt modular templates, widgets, PBCs and others. The [Entando Component Manager](./compose/ecm-overview.md) and [Local Hub](./compose/local-hub-overview.md) are integrated into the App Builder to manage your components, providing speed and flexibility. +## Compose +The Compose stage involves assembling the bundles, packaged business capabilities (PBCs), templates and other resources into an application. Centered around the visual interface, the [Entando App Builder](./compose/app-builder.md), the Platform provides tooling to define the structure, layouts, and interactions between micro frontends within an application. This unified environment, with direct access to the Entando catalogs, leads to the creation of a more cohesive and seamless user experience across a complex application. | Documentation | Tutorials | | :------------ | :-------- | -| [Welcome Wizard](./compose/welcome-wizard.md) | [Page Management](../tutorials/compose/page-management.md) | +| [App Builder Welcome Wizard](./compose/welcome-wizard.md) | [Create and Manage a Page](../tutorials/compose/page-management.md) | | [Local Hub](./compose/local-hub-overview.md) | [Widgets and Fragments](../tutorials/compose/widgets-fragments.md) | -| [Entando App Builder](./compose/app-builder.md) | [Content Creation](../tutorials/compose/content-tutorial.md) | -| [Entando Component Manager](./compose/ecm-overview.md) | [Content Templates](../tutorials/compose/content-templates-tutorial.md) | +| [Entando Component Manager](./compose/ecm-overview.md) | [Content Templates](../tutorials/compose/content-templates-tutorial.md) | | | [Digital Assets](../tutorials/compose/digital-assets-tutorial.md) | -## Consume Applications -In the development lifecycle of an application, Consume is the execution stage where users interact with the app. On Entando, the modular design of components and services means they can be scaled individually, or as a whole, according to those interactions. Likewise, content can be updated, engine rules adapted, and upgrades carried out seamlessly. As a result, the development cycle is a continuous process with minimal disruptions and faster time to market. +## Consume +In the lifecycle of an application, Consume is the execution stage where users interact with the application, using browsers, mobile devices, and conversational interfaces. On Entando, the modular design of components and services means they can be scaled independently, governed consistently, and new features integrated uniformly, as user's needs change. Likewise, content can be updated, interactions improved, and upgrades carried out in a continuous process, with minimal disruptions and faster time to market. | Documentation | Tutorials | | :------------ | :-------- | diff --git a/vuepress/docs/v7.3/docs/consume/identity-management.md b/vuepress/docs/v7.3/docs/consume/identity-management.md index 3417bad140..4018a0f50f 100644 --- a/vuepress/docs/v7.3/docs/consume/identity-management.md +++ b/vuepress/docs/v7.3/docs/consume/identity-management.md @@ -35,7 +35,7 @@ Keycloak authorizes microservices using clients and roles. Authorizations are st Below are the steps to grant a user one or more roles for a specific client. This controls permissions when configuring the microservice. Note, when a microservice is installed in Entando, a corresponding client (and set of roles) is created within its plugin definition. 1. [Log in to Keycloak](#logging-into-your-keycloak-instance) ->For non-external Keycloak instances, it is [the base URL of your running Entando application](../getting-started/README.md#configure-access-to-your-cluster) followed by `/auth/`, e.g. http://YOUR-HOST-NAME/auth. In a standard Entando installation, the base URL can be verified with `kubectl get ingress/default-sso-in-namespace-ingress`. +>For non-external Keycloak instances, it is the base URL of your running Entando application followed by `/auth/`, e.g. http://YOUR-HOST-NAME/auth. In a standard Entando installation, the base URL can be verified with `kubectl get ingress/default-sso-in-namespace-ingress`. 2. Select `Users` from the left menu 3. Use the search box to find the appropriate user, e.g. "admin" 4. Click on the user ID diff --git a/vuepress/docs/v7.3/docs/getting-started/README.md b/vuepress/docs/v7.3/docs/getting-started/README.md index c4cac4bf05..30ea590484 100644 --- a/vuepress/docs/v7.3/docs/getting-started/README.md +++ b/vuepress/docs/v7.3/docs/getting-started/README.md @@ -9,27 +9,27 @@ You can set up Entando in two simple steps or install it manually to meet your s * [Automatic Install](#automatic-install): The fastest way to locally install and start up Entando in Kubernetes. * [Manual Install](#manual-install): Useful if you want a shared cluster or a custom local instance. ->Installation on Mac M1/M2 systems: +>Installation on Apple Silicon processors: To install Entando on Mac systems running ARM64 architecture, see this alternate [Getting Started](../../tutorials/getting-started/arm-install.md) guide. ## Automatic Install Automatically install Entando via the Entando command-line interface (CLI) and prepare a local developer environment with default settings. -The following steps launch an Ubuntu VM via Multipass, install Kubernetes, then deploy Entando to it. +The following steps launch an Ubuntu VM via Multipass, install Kubernetes, and then deploy Entando to it. -1. Install [Multipass](https://multipass.run/#install) +1. Install [Multipass](https://multipass.run/#install). -2. Install Entando into Kubernetes on Ubuntu using the [Entando CLI](entando-cli.md) +2. Install Entando into Kubernetes on Ubuntu using the [Entando CLI](entando-cli.md): curl -sL "https://get.entando.org" | ENTANDO_RELEASE="{{ $site.themeConfig.entando.fixpack.v73 }}" bash -3. The progress of the install is displayed on the console. Installation can take up to 10 minutes, depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To understand what the CLI does, review the manual steps. +3. The progress of the install is displayed on the console. Installation can take up to 10 minutes, depending on how long the Docker images take to download. The sequence of steps performed by the CLI is identical to the manual steps below. To better understand what the CLI does, review the manual steps. 4. The URL to access the Entando App Builder will print to the console once the install completes. -5. Login with username:`admin` and password: `adminadmin`. Refer to [Login to Entando](#login-to-entando) for more information and next steps. +5. Log in with username:`admin` and password: `adminadmin`. Refer to [Log in to Entando](#log-in-to-entando) for more information and next steps. ## Manual Install -Manual installation allows you to configure a shared cluster or customize a local developer environment. The following learn-as-you-go approach provides a working knowledge of Kubernetes as you install Entando in a local environment. After downloading the necessary files, your instance of Kubernetes will be up and running in <60 seconds. +Manual installation allows you to configure a shared cluster or customize a local developer environment. The following learn-as-you-go approach provides additional context about the process in the highlighted text boxes. After downloading the necessary files, your instance of Kubernetes will be up and running in <60 seconds. This is a three stage process: @@ -43,20 +43,20 @@ Kubernetes is a container orchestrator designed to manage a server cluster. It r ### Install Kubernetes -#### Enable Hypervisor -::: tip Why a Hypervisor? -Hypervisors allow you to create and run VMs. Virtualization software that run on top of your operating system as "guests" are Type 2 hypervisors, e.g. VirtualBox or VMWare Workstation. Type 1 hypervisors run directly on your host machine. +#### 1. Enable a Hypervisor +::: tip Why a hypervisor? +Hypervisors allow you to create and run VMs. Virtualization software that runs on top of your operating system as a guest is a Type 2 hypervisor, like VirtualBox or VMWare Workstation. Type 1 hypervisors run directly on your host machine. ::: Install a Type 1 hypervisor for optimal performance. -**Mac:** Install `hyperkit` + - **Mac:** Install `hyperkit`: -``` bash -brew install hyperkit -``` + ``` bash + brew install hyperkit + ``` -**Windows:** [Install Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v?redirectedfrom=MSDN) + - **Windows:** [Install Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v?redirectedfrom=MSDN) --- @@ -74,32 +74,32 @@ Install a Type 2 hypervisor that runs on top of your operating system.
-#### Launch an Ubuntu VM +#### 2. Launch an Ubuntu VM ::: tip Why Multipass? Multipass is a cross-platform tool developed by the publishers of Ubuntu to create lightweight Ubuntu VMs in seconds. ::: -1. Install [Multipass](https://multipass.run/#install) + 1. Install [Multipass](https://multipass.run/#install) -2. Launch a VM + 2. Launch a VM: -``` bash -multipass launch --name quickstart --cpus 4 --mem 8G --disk 20G -``` + ``` bash + multipass launch --name quickstart --cpus 4 --mem 8G --disk 20G + ``` -3. Open a VM shell. (Note: on Windows, you may need to use `winpty multipass`) + 3. Open a VM shell (Note on Windows, you may need to use `winpty multipass`): -``` bash -multipass shell quickstart -``` + ``` bash + multipass shell quickstart + ``` ### Run Kubernetes ::: tip Why K3s? -K3s is a certified Kubernetes distribution designed for production workloads in resource-constrained environments. +K3s is a certified light-weight version of Kubernetes designed for production workloads in constrained environments. -It's packaged as a single <50MB binary that minimizes the dependencies and procedure required to install, run and auto-update a production Kubernetes cluster. +It's packaged as a single (<50MB) binary that minimizes dependencies and simplifies the procedures required to install, run, and update a production Kubernetes cluster. ::: 1. Install the version of `K3s` supported by Entando 7.3. Note that this may not be the latest version of Kubernetes. @@ -130,44 +130,43 @@ sudo kubectl get pods -A You now have a local instance of Kubernetes up and running. ::: -Now that Kubernetes is running, you can use kubectl to send commands directly to K3s from the host machine, rather than from within the VM. To set this up with the [ent CLI](entando-cli.md), run `ent attach-vm quickstart` and then use `ent kubectl` for any calls to K8s. Alternatively, see the K3s documentation to [access your cluster with kubectl](https://rancher.com/docs/k3s/latest/en/cluster-access/). +Now that Kubernetes is running, you can use kubectl to send commands directly to K3s from the host machine, rather than from within the VM. To set this up with the [ent CLI](entando-cli.md), run `ent attach-vm quickstart` and then use `ent kubectl` for any calls to Kubernetes. Alternatively, see the K3s documentation to [access your cluster with kubectl](https://rancher.com/docs/k3s/latest/en/cluster-access/). ### Prepare Kubernetes -To install Entando, we'll add `Custom Resources`, create a `Namespace` and configure external access to our cluster. - -#### Create a Namespace +To install Entando, add the `Custom Resources`, create a `Namespace`, and configure external access to your cluster. -::: tip What are Namespaces? -Kubernetes supports multiple virtual clusters backed by the same physical cluster. These virtual clusters are called [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). You can use namespaces to allocate resources and set CPU/memory limits for individual projects or teams. -::: +#### 1. Create a Namespace ``` bash sudo kubectl create namespace entando ``` +::: tip What are Namespaces? +Kubernetes supports multiple virtual clusters backed by the same physical cluster. These virtual clusters are called [namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). You can use namespaces to allocate resources and set CPU/memory limits for individual projects or teams. +::: -#### Add Custom Resources +#### 2. Add Custom Resources ::: tip Why Custom Resources? -Standard resources in Kubernetes include `Pods`, which are groups of one or more containers, `Services` to call or access Pods, and `Ingresses` to enable external access to Services. +Standard resources in Kubernetes include `Pods` (groups of one or more containers), `Services` to call or access Pods, and `Ingresses` to enable external access to Services. -[Custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) let you store and retrieve structured data. Combining a custom resource with a custom controller allows you to define a desired state to automate how your applications or services run in a Kubernetes cluster. +[Custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) let you store and retrieve structured data. Combining a custom resource with a custom controller allows you to define a desired state to automate how your applications and services run in a Kubernetes cluster. ::: Examples of custom resources in Entando are the [Entando App Engine](../../docs/getting-started/concepts-overview.md#entando-app-engine) and the [Entando Identity Management System](../../docs/getting-started/concepts-overview.md#entando-identity-management-system). -From your Ubuntu shell +From your Ubuntu shell: -1. Install the cluster-scoped custom resource definitions (CRDs) +1. Install the cluster-scoped custom resource definition (CRD): sudo kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v73 }}/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml -2. Install the namespace-scoped custom resources +2. Install the namespace-scoped custom resource: sudo kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v73 }}/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml -#### Configure Access to Your Cluster +#### 3. Configure Access to Your Cluster ::: tip What about Networking? Entando sets up [`Ingresses`](https://kubernetes.io/docs/concepts/services-networking/ingress/) in Kubernetes to expose HTTP routes from outside the cluster to services within the cluster. This is used to access Entando from a local browser. @@ -175,29 +174,32 @@ Entando sets up [`Ingresses`](https://kubernetes.io/docs/concepts/services-netwo If you run into network issues during startup, or if you are using Windows for your local development instance, you'll need to [troubleshoot your network](../reference/local-tips-and-tricks.md#network-issues). Indications of network issues can include Entando failing to completely start or a working Entando instance failing to restart later. ::: -To set up external access to your cluster, replace YOUR-HOST-NAME with the fully qualified domain of your Ubuntu VM. +To set up external access to your cluster, determine the fully qualified domain of your Ubuntu VM for the `ingressHostName` value in the EntandoApp CRD. -- On Windows with Hyper-V, YOUR-HOST-NAME is the name of your VM followed by `.mshome.net`, e.g. `quickstart.mshome.net`. +- On Windows with Hyper-V, `ingressHostName` is the name of your VM followed by `.mshome.net`, e.g. `quickstart.mshome.net`. -- On Mac, Linux, or Windows without Hyper-V, you'll use a host name based on your VM's IP address. You can determine the IP address from within the VM with this command: +- On Mac, Linux, or Windows without Hyper-V, `ingressHostName` is your VM name, plus you VM's IP address, plus "nip.io". You can determine the IP address from within the VM with this command: ``` bash hostname -I | awk '{print $1}' ``` -- Your IP-based YOUR-HOST-NAME should follow this pattern: `quickstart.YOUR-IP.nip.io`, e.g. `quickstart.192.168.64.33.nip.io`. The suffix `.nip.io` makes use of the free [nip.io](https://nip.io/) DNS service so that any requests to this host name will resolve to your VM. The prefix `quickstart` is arbitrary so you can choose your own. + E.g.: For VM named `quickstart`, IP=`192.168.64.33` + `ingressHostName` = `quickstart.192.168.64.33.nip.io` + +The suffix `.nip.io` makes use of the free [nip.io](https://nip.io/) DNS service so that any requests to this host name will resolve to your VM. `quickstart` is arbitrary so you can choose your own VM name. -Now that you've determined YOUR-HOST-NAME, use it to configure the Entando Application. +Now that you've determined `ingressHostName`, use it to configure the Entando Application. 1. Download the template `entando-app.yaml`. curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v73 }}/dist/ge-1-1-6/samples/entando-app.yaml" -2. Modify `entando-app.yaml` to set the `ingressHostName` to YOUR-HOST-NAME. Examples: -- `ingressHostName`: quickstart.mshome.net -- `ingressHostName`: quickstart.192.168.63.33.nip.io +2. Modify `entando-app.yaml` with the `ingressHostName` found in the previous step. Examples: +- Windows machine: `ingressHostName`: quickstart.mshome.net +- Mac or Linux: `ingressHostName`: quickstart.192.168.63.33.nip.io ::: tip Embedded Databases To speed up the _Getting Started_ environment, embedded databases are used by default. -See this [Tutorial on Default Databases](../../tutorials/devops/default-database.md) for information on how to change your database connection, or you can modify the `dbms` setting in the `entando-app.yaml`. +See the [Tutorial on Default Databases](../../tutorials/devops/default-database.md) for information on how to change your database connection, or modify the `dbms` setting in the `entando-app.yaml`. ::: ::: tip Entando Operator @@ -209,7 +211,7 @@ To customize the ingress path of a deployment, refer to the [Configure the Entan ::: ### Deploy Entando -Deploy Entando by applying `entando-app.yaml` to your namespace. +1. Deploy Entando by applying `entando-app.yaml` to your namespace. ```sh sudo kubectl apply -f entando-app.yaml -n entando @@ -217,7 +219,7 @@ sudo kubectl apply -f entando-app.yaml -n entando --- -Use the `get pods --watch` command to observe Entando starting up. +2. Use the `get pods --watch` command to observe Entando starting up. ```sh sudo kubectl get pods -n entando --watch @@ -225,16 +227,16 @@ sudo kubectl get pods -n entando --watch
What does a successful startup look like? -- The `entando-operator` and `entando-k8s-service` start when you apply the namespace resources above, so they should already be in the `Running` status by the time you reach this point -- When you apply the `entando-app.yaml`, the `quickstart-deployer` starts and kicks off a series of deployments, beginning with the Keycloak deployment via the `default-sso-in-namespace-deployer` +- The `entando-operator` and `entando-k8s-service` start when you apply the namespace resources above, so they should already be in `Running` status by the time you reach this point. +- When you apply the `entando-app.yaml`, the `quickstart-deployer` starts and kicks off a series of deployments, beginning with the Keycloak deployment via the `default-sso-in-namespace-deployer`. **Jobs / Deployments** -- Some Pods, like `quickstart-deployer`, run to completion and then shutdown; they should eventually show `READY`: `0/1` and `STATUS`: `Completed` +- Some Pods, like `quickstart-deployer`, run to completion and then shutdown; they should eventually show `READY`: `0/1` and `STATUS`: `Completed`. - Other deployments, like `quickstart-ab-deployment` or `quickstart-deployment`, should eventually show `READY`: `1/1` and `STATUS`: `Running` **Lifecycle Events** -- Each line represents an event: `Pending`, `ContainerCreating`, `Running` or `Completed` -- Restarts should ideally be `0`; otherwise, there may be a resource problem (slow network, not enough CPU or memory, etc.) with your cluster, and Kubernetes is trying to self-heal +- Each line represents an event: `Pending`, `ContainerCreating`, `Running` or `Completed`. +- Restarts should ideally be `0`; otherwise, there may be a resource problem (slow network, not enough CPU or memory, etc.) with your cluster, and Kubernetes is trying to self-heal. - This is a partial history for a typical install. ``` shell-session NAME READY STATUS RESTARTS AGE @@ -330,10 +332,10 @@ pn-3c07adf0-fac54a9f-entando-app-builder-menu-bff-deploymep6j87 1/1 Runnin --- -The URL of your running Entando instance is http://YOUR-HOST-NAME/app-builder/. +The URL of your running Entando instance is http://ingressHostName/app-builder/. -- Example URL +- Example URL: ``` bash quickstart.192.168.64.33.nip.io/app-builder/ @@ -341,9 +343,9 @@ quickstart.192.168.64.33.nip.io/app-builder/ --- -## Login to Entando +## Log in to Entando -Now that you've installed Entando, login to the Entando App Builder. +Now that you've installed Entando, log in to the Entando App Builder. ![entando-login.png](./img/entando-login.png) @@ -368,8 +370,8 @@ Check out these resources to continue your journey with Entando! * **Try a Tutorial:** Take advantage of the [Learning Paths](../../tutorials/), which organize a few of the most popular tutorials by user type. -* **Dig Deeper into Entando Concepts:** Review the [Docs](../) sections to more deeply understand the Entando building blocks. +* **Dig Deeper into Entando Concepts:** Review the [Docs](../) sections to get a better understanding of the Entando building blocks. -* **Learn about the Quickstart Environment:** See the [Quickstart Tips](../reference/local-tips-and-tricks.md) for more information on how to manage your Getting Started or quickstart environment. +* **Learn about the Quickstart Environment:** See the [Quickstart Tips](../reference/local-tips-and-tricks.md) for more information on how to manage and troublshoot your quickstart environment. --- diff --git a/vuepress/docs/v7.3/docs/getting-started/concepts-overview.md b/vuepress/docs/v7.3/docs/getting-started/concepts-overview.md index 9a7db53a94..8e2b3d99e4 100644 --- a/vuepress/docs/v7.3/docs/getting-started/concepts-overview.md +++ b/vuepress/docs/v7.3/docs/getting-started/concepts-overview.md @@ -1,89 +1,94 @@ # Entando Architecture Concepts -Entando is an application composition platform that simplifies and accelerates enterprise modernization across on-prem and cloud infrastructures. It offers native support for Javascript app development, a micro frontend and microservice architecture, scalable app deployment, and automated container orchestration via Kubernetes. +Entando is an application composition platform (ACP) that simplifies and accelerates enterprise modernization across on-prem and cloud infrastructures. It offers native support for Javascript app development, a micro frontend and microservice architecture, scalable deployments, and automated container orchestration via Kubernetes. -This document explores the architecture of the Entando Platform and some notable runtime characteristics. +This document explores the conceptual architecture of the Platform and its runtime characteristics. ![entando-architecture](./img/entando-architecture.png) -- [Key Entando Concepts](#key-entando-concepts) +- [Key Concepts](#key-concepts) - [Entando Cluster Elements](#entando-cluster-elements) - [Entando Ingresses](#entando-ingresses) -> Note: A portal, website, web app, or mobile app built with Entando is called an Entando Application. -An Entando Application is an assembly of out-of-the-box and/or custom-built components running on the -Entando Platform. Entando components can be widgets, micro frontends, microservices, page templates, WCMS content or WCMS content types. -## Key Entando Concepts +## Key Concepts + +### Entando Application +A portal, website, web app, or mobile app built with Entando is called an Entando Application. +An Entando Application is an assembly of out-of-the-box and/or custom-built components, called bundles, running on the +Platform. Applications also consist of page templates, WCMS content, content types, and other assets. + +### Entando Bundle +An Entando Bundle is a packaged set of components and resources created for the Platform. They are the building blocks of any application built on Entando, consisting of micro frontends, microservices, services and other resources. The Entando Component Manager identifies and installs the bundles to the Local Hub. + +See also: [Bundle Details](../curate/bundle-details.md) + ### Entando App Builder -The [Entando App Builder](../compose/app-builder.md) is the frontend of the Entando Platform with which an Entando Application is created and customized. It hosts the Entando WCMS and provides a feature-rich, low-code user interface to configure and interact with components, design and create pages, manage content, and build modular applications. +The [Entando App Builder](../compose/app-builder.md) is the application composer of the Platform. It hosts the WCMS and provides a feature-rich, low-code user interface to find and configure components, design and create pages, manage content, and build composable applications. See also: [Widget Tutorial](../../tutorials/compose/widgets-fragments.md) ### Entando App Engine -The Entando App Engine is the core runtime engine responsible for the primary out-of-the-box services required to develop Entando Applications. It exposes the backend APIs used to deliver the page and content management interface of an Entando Application, assembles and coordinates components within the Entando App Builder, and provides the data access layer to persist pages and application design. +The Entando App Engine is the core runtime engine responsible for the primary out-of-the-box services required to develop applications. It exposes the backend APIs used to deliver the page and content management interface of an Entando Application, assembles and coordinates components within the App Builder, and provides the data access layer to persist pages and application design. See also: [APIs tutorial](../consume/entando-apis.md) ### Entando Component Generator -The Entando Component Generator implements a [JHipster](https://www.jhipster.tech/) blueprint to quickly and efficiently generate the skeleton of an Entando project using automation and templating. The generator provides advanced data modeling capabilities, including object relational mapping, and the autogeneration of micro frontends and microservices. The [Entando Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) fast-tracks development by creating the folders, files and infrastructure required by a project. +The Entando Component Generator implements a [JHipster](https://www.jhipster.tech/) blueprint to quickly generate the skeleton of an Entando bundle with automation and templating. The Generator provides advanced data modeling capabilities, including object relational mapping and dynamic creation of micro frontends and microservices. -See also: [Component Generation Technologies](../create/component-gen-tech.md) +See also: [Generate Microservices & Micro Frontends](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) ### Entando Identity Management System -[Entando Identity Management System](../consume/identity-management.md) is Entando's [Keycloak](https://www.keycloak.org/)-based user management and authentication system. It applies Single Sign On capabilities across multiple domains to connect service providers with identity providers. +[Entando Identity Management System](../consume/identity-management.md) is the Platform's [Keycloak](https://www.keycloak.org/)-based user management and authentication system. It applies Single Sign On capabilities across multiple domains to connect service providers with identity providers. See also: [Entando Authentication](../../tutorials/create/mfe/authentication.md) ### Entando Local Hub -The [Entando Local Hub](../compose/local-hub-overview.md) is the component repository of an Entando App Builder. The Entando Bundles available to the Entando Application are represented and can be deployed, installed, updated or versioned using the App Builder UI. +The [Local Hub](../compose/local-hub-overview.md) is the component repository of the App Builder. Bundles--the basic building block for composing applications on Entando--are catalogued and organized here. The Local Hub also provides direct access to bundles in the Entando Marketplace and the Enterprise Hub, if one exists for the organization, and can be deployed and installed from here. ### Entando WCMS -The Entando Web Content Management System (WCMS) is a lightweight content and digital asset management system. It manages widgets, HTML fragments, and other content types used in an Entando Application. +The Entando Web Content Management System (WCMS) is a lightweight content and digital asset management system. It manages widgets, HTML fragments, and other content types for an Entando Application. See also: [Content Types](../../tutorials/compose/content-types-tutorial), [Content Templates](../../tutorials/compose/content-templates-tutorial) and [Digital Assets](../../tutorials/compose/digital-assets-tutorial.md) ## Entando Cluster Elements -The following is an overview of the elements comprising an Entando Cluster. +The following is an overview of the elements comprising an Entando cluster. ### Architecture - Members of the Cluster -Below is a diagram of an Entando Cluster and depicts how the various elements interact with one another. Entando deploys this infrastructure on Kubernetes using the Entando Operator and controllers. Each element is associated with a custom resource definition (CRD) file, if applicable. +This is a diagram of an Entando cluster, depicting how the various elements interact with one another. Entando deploys this infrastructure on Kubernetes using the Entando Operator and controllers. Each element is associated with a custom resource definition (CRD) where applicable. -![Entando Cluster Architecture Diagram](./img/entando-architecture-v1.5.svg) +![Entando Cluster Architecture Diagram](./img/entando-cluster-arch.png) #### EntandoApp -The EntandoApp is comprised of the Entando App Builder, the Entando App Engine and the Entando Component Manager. Keycloak-based authorization and authentication enable these to interact with each other and other cluster elements. +The EntandoApp is comprised of the App Builder, App Engine and Component Manager. Keycloak-based authorization and authentication enable these to interact with each other and other cluster elements. + + #### Entando Component Manager -The purpose of the [Entando Component Manager](../compose/ecm-overview.md) is to: +The purpose of the [Entando Component Manager](../compose/ecm-overview.md) (ECM) is to: - Provide the functionality to deploy and install micro frontends and widgets - Manage the connections between an application and the installed microservices -It integrates the Local Hub into the App Builder to list the Entando Bundles accessible from the EntandoApp, provisioning bundle management services such as install, uninstall, upgrade, downgrade and versioning. The Entando Kubernetes integration service communicates with the cluster to supply these bundle services and is the only service, other than the Entando Operator, that can interact with the cluster and custom resources. +The ECM integrates the Local Hub into the App Builder, listing the bundles accessible from the EntandoApp, and managing their install, uninstall, upgrade, downgrade and tracking processes. The Entando Kubernetes integration service communicates with the cluster to supply these bundle services and is the only service, other than the Entando Operator, that can interact with the cluster and custom resources. #### Entando Kubernetes Service -The Entando Kubernetes integration service (`entando-k8s-service`) is a function of the Entando Cluster infrastructure custom resource, providing an abstraction layer between Entando microservices and the APIs exposed by Kubernetes. It supplies access points to several custom resources defined by Entando, in particular Entando Applications, Entando Plugins, Entando Bundles and Entando links. +The Entando Kubernetes integration service (`entando-k8s-service`) is a function of the Entando cluster infrastructure custom resource, providing an abstraction layer between Entando microservices and the APIs exposed by Kubernetes. It supplies access points to several custom resources defined by Entando, in particular Entando Applications, plugins, bundles and links. The `entando-k8s-service` is used to: - Provide a list of the available Entando Bundles to the Entando Component Manager - Deploy a microservice, or expose an already available microservice, during the installation of a bundle - Create a link between an EntandoApp and an EntandoPlugin to expose microservice APIs to the EntandoApp and micro frontends -#### Entando Bundle -An Entando Bundle is a packaged set of components and resources created for the Entando Platform. The Entando Component Manager identifies the bundles and can install their components to extend the functionality of an Entando Application. - -See also: [Local Hub Overview](../compose/local-hub-overview.md) - #### Entando Plugin -An Entando Plugin is a microservice that exposes APIs reusable by one or more Entando Applications. Plugin services are commonly accessible from micro frontends and can be quickly generated with the [Entando Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md). A blueprint-generated project can be used as-is in an Entando environment and provides Keycloak integration, a set of default micro frontends, and microservices exposed by the bundle. +An Entando Plugin is a microservice that exposes APIs reusable by one or more Entando Applications. Plugin services are commonly accessible from micro frontends and can be quickly generated with the [Entando Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md). This blueprint-generated project is customizable and provides Keycloak integration, a set of default micro frontends, and microservices exposing APIs. #### Keycloak -Keycloak is responsible for authorization and authentication on Entando. All members of an Entando Cluster interact with Keycloak to verify user and service authorization. +Keycloak is responsible for authorization and authentication. All members of an Entando cluster interact with Keycloak to verify users and service authorizations. ## Entando Ingresses -An ingress is a Kubernetes resource that exposes HTTP and HTTPS paths from outside an Entando Cluster to services within it. Traffic routing is controlled by rules defined on the ingress resource. +An ingress is a Kubernetes resource that exposes HTTP and HTTPS paths from outside a cluster to services within it. Traffic routing is controlled by rules defined in the ingress resource. When deploying a cluster, ingresses are generated for the resources that must be exposed to external services. The Entando Operator and custom resource controllers create the ingresses and set the correct paths and certificates. Entando implements Keycloak and EntandoApp ingresses. #### Keycloak Ingress @@ -99,8 +104,8 @@ The EntandoApp ingress is also used to link a microservice with an EntandoApp wh The table below lists the default paths exposed for each ingress.
--++ @@ -142,5 +147,8 @@ A microservice under the same domain (ingress) as the EntandoApp is exposed usin Once the link between the EntandoApp and the microservice is created, the controller reads the link specification. It then automatically creates HTTP paths in the EntandoApp to expose the microservice in the same domain as the App Builder, App Engine and Component Manager. This allows micro frontend developers to reference the microservice using relative URLs. -See also: [Entando Deployment Structure](../reference/deployment-structure.md) and [Check Ingresses](../reference/check-ingress.md) +See also: +* [Entando Deployment Structure](../reference/deployment-structure.md) +* [Check Ingresses](../reference/check-ingress.md) +* [Entando Glossary](../reference/glossary.md) diff --git a/vuepress/docs/v7.3/docs/getting-started/ent-api.md b/vuepress/docs/v7.3/docs/getting-started/ent-api.md index d6334c5fcf..a4cffc09b5 100644 --- a/vuepress/docs/v7.3/docs/getting-started/ent-api.md +++ b/vuepress/docs/v7.3/docs/getting-started/ent-api.md @@ -5,11 +5,11 @@ sidebarDepth: 1 # API Management -An API claim informs the Entando Platform that a micro frontend (MFE) intends to use the API of a microservice (MS). This request can be sent within a single bundle or across bundles. The abstraction of an API claim eliminates the need to define and manage API endpoints, both in local development and within a running instance. +An API claim informs the Entando Platform that a micro frontend (MFE) intends to use the API of a microservice (MS), standardizing authentication across many services. This request can be sent within a single bundle or across bundles. The abstraction of an API claim eliminates the need to define and manage API endpoints, both in local development and within a running instance. ## Internal vs. External API Claim -An MFE can initiate both internal and external API claims. An internal claim specifies an MS API in the same bundle as the MFE, while an external claim specifies the MS API of another bundle in the same Kubernetes namespace. +An MFE can initiate both internal and external API claims. An internal claim connects an MS API in the same bundle as the MFE, while an external claim specifies the MS API of another bundle in the same Kubernetes namespace. The structure of internal and external API claims are as follows: @@ -33,7 +33,7 @@ The structure of internal and external API claims are as follows: ## API Claim Commands -Common operations associated with API claims are detailed below. To execute `ent bundle api` subcommands, the user must be connected to a running Entando instance (via `ent attach-*`) or the CLI will generate an authentication error. +Common operations associated with API claims are detailed below. To execute `ent bundle api` subcommands, the user must be connected to a running Entando instance (via [ent attach-vm](ent-profile.md)) or the CLI will generate an authentication error. | Command | Description | :- | :- @@ -61,12 +61,12 @@ Common operations associated with API claims are detailed below. To execute `ent ## Microservice URL Retrieval -To retrieve the URL of an MS declared through an API claim, add `systemParams.api[claimName].url` to the MFE JavaScript code so it can access that element of the config object. The `claimName` is chosen by the user when the API claim was defined. +To retrieve the URL of an MS declared through an API claim, add `systemParams.api[claimName].url` to the MFE JavaScript code so it can access that element of the config object. The `claimName` is chosen by the user when the API claim is defined. **Installed Bundles** -The configuration data of installed bundles are provided by the Entando instance. To render an MFE from an installed bundle, Entando injects a JSON object containing configuration details inside the "config" attribute of a custom HTML element, e.g. ``. +The configuration data of installed bundles are provided by the Entando instance. To render an MFE from an installed bundle, Entando injects a JSON object containing configuration details inside the `config` attribute of a custom HTML element, e.g. ``. **Local Bundles** diff --git a/vuepress/docs/v7.3/docs/getting-started/ent-bundle.md b/vuepress/docs/v7.3/docs/getting-started/ent-bundle.md index a962b031f2..a90710a19f 100644 --- a/vuepress/docs/v7.3/docs/getting-started/ent-bundle.md +++ b/vuepress/docs/v7.3/docs/getting-started/ent-bundle.md @@ -4,44 +4,45 @@ sidebarDepth: 2 # Bundle Management -The Entando Bundle CLI extends the functionality of **ent** through a dedicated bundle management system. The `ent bundle` command orchestrates the lifecycle of a project, packaging it into a convenient and recognizable docker-based bundle that can be inserted into any Entando Application. This composable approach takes advantage of a single project descriptor and repository, along with centralized [API management](ent-api.md) and [DB and Keycloak services](ent-svc.md). Common operations and the steps required to create an Entando Bundle are detailed below. +The Entando Bundle commands extend the functionality of **ent** through a dedicated bundle management system. The `ent bundle` set of subcommands orchestrate the lifecycle of a component, packing it into a convenient standardized docker-based bundle that can be used to build composable applications. This approach takes advantage of a single project descriptor, along with centralized [API management](ent-api.md) and [DB and Keycloak services](ent-svc.md). Common operations and the steps required to create an Entando Bundle are detailed below. -In addition, this document describes the series of `ent ecr` commands that manage bundle interactions with the [Entando Component Repository](../../docs/compose/local-hub-overview.md) (ECR). These are applicable to both docker-based bundles and their git-based predecessors (< Entando 7.1). Notable commands applicable to creating and deploying git-based bundles only are also discussed. +In addition, this document describes the series of `ent ecr` commands that manage bundle interactions with the [Entando Component Repository](../../docs/compose/local-hub-overview.md) (ECR). These are applicable to both docker-based bundles and their git-based predecessors (< Entando 7.1). Notable commands applicable to creating and deploying only git-based bundles are also discussed. ## Entando Bundle Development -The `ent bundle` CLI tool provides a streamlined process to govern the files, structure, and management of Entando bundles. The bundle development lifecycle consists of 6 stages, each corresponding to a subcommand: +The bundle development lifecycle consists of 6 stages, each corresponding to a subcommand of ent bundle: -- [Initialization](#initialization): `ent bundle init` initializes a new bundle project, either with the default files and folders or from an existing bundle in an Entando Hub. The bundle format relies on a single JSON descriptor as the project manifest. +- [Initialization](#initialization): `ent bundle init` launches a new bundle project, either with the default starter files and folders, or dynamically, from the catalog of an Entando Hub. The bundle format relies on a single JSON descriptor as the project manifest. -- [Build](#build): With the structure established, `ent bundle build` generates micro frontend (MFE) and microservice (MS) components. These are filtered by type and name and assigned version numbers. +- [Build](#build): With the structure established, `ent bundle build` generates micro frontend (MFE) and microservice (MS) components. These are filtered by type and name, and assigned version numbers. -- [Run](#run): `ent bundle run` and Keycloak integration enable components to be tested locally, external to an Entando cluster. +- [Run](#run): `ent bundle run` and Keycloak integration enable components to be tested locally, independent of an Entando cluster. -- [Package](#package): `ent bundle pack` generates the bundle artifacts, the bundle image and the microservice images. One image is created for each microservice while a single image is created for the bundle and micro frontends. +- [Package](#package): `ent bundle pack` generates the bundle artifacts and images for the bundle and each microservice. -- [Publish](#publish): `ent bundle publish` pushes the Docker images to a Docker repository, after which the bundle can be deployed and installed. +- [Publish](#publish): `ent bundle publish` pushes the images to a Docker repository, after which the bundle can be deployed and installed. -- [Deploy](#deploy): `ent bundle deploy` delivers a published bundle to the ECR of an Entando Application. The bundle custom resource is generated and tags are retrieved from Docker Hub. +- [Deploy](#deploy): `ent bundle deploy` delivers a published bundle to the ECR of the Entando Platform. The bundle custom resource is generated and tags are retrieved from Docker Hub. -- [Install](#install): `ent bundle install` applies the bundle to the Entando instance. It is then available in the App Builder for unlimited reuse within the application. +- [Install](#install): `ent bundle install` applies the bundle to the Entando instance. It is then available in the App Builder for unlimited reuse. -See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-simple-bundle.md) tutorial to see the full process. And for more information on Entando Bundle specifications, go to the [Bundle Details](../curate/bundle-details.md) page. +See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-simple-bundle.md) tutorial to follow the full process. And for more information on Entando Bundle specifications, go to the [Bundle Details](../curate/bundle-details.md) page. ## Docker-based Bundle Commands | Commands | Description | |:- |:- |`ent bundle build`| Build components (MFE, MS) with a selector | -|`ent bundle deploy`|Deploy a bundle to the Local Hub of an Entando Application +|`ent bundle convert --bundle-path [path1]` | Convert a git-based bundle to a Docker-based one | +|`ent bundle deploy`|Deploy a bundle to the Local Hub of an Entando Platform |`ent bundle generate-cr`| Generate the Entando Custom Resource for a bundle project | |`ent bundle help` | Display help for ent bundle | |`ent bundle info`| Show status information for the bundle project | |`ent bundle init`| Initialize the project folder structure and descriptor | -|`ent bundle install`| Install a bundle to the Local Hub of an Entando Application| +|`ent bundle install`| Install a bundle to the Local Hub of an Entando Platform| |`ent bundle list`| List the available bundle components | |`ent bundle mfe add` | Add a micro frontend | -| `ent bundle mfe rm` | Remove a micro frontend | +|`ent bundle mfe rm` | Remove a micro frontend | |`ent bundle ms add` | Add a microservice | |`ent bundle ms rm` | Remove a microservice | |`ent bundle run`| Run bundle components | @@ -54,25 +55,25 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si | Command | Description |:--|:-- |`ent bundle init [name]` | Initialize a new empty project with the default structure and files | -|`ent bundle init [name] --from-hub`| Initialize a bundle from the Entando Cloud Hub | +|`ent bundle init [name] --from-hub`| Initialize a bundle from the Entando Marketplace catalog | |`ent bundle init [name] --from-hub --hub-url=[url]` | Initialize a bundle from an enterprise Entando Hub | -|`ent bundle init [name] --from-hub --hub-url=[url] --hub-api-key=[]` | Initialize a bundle from a private Entando Hub with an API key| +|`ent bundle init [name] --from-hub --hub-url=[url] --hub-api-key=[]` | Initialize a bundle from a private enterprise Entando Hub with an API key| #### Init Command Details - Bundle names may only contain lowercase letters, numbers, periods(.) and dashes(-). They cannot start or end with periods or dashes. - `--from-hub`: This option leverages an existing bundle from an Entando Hub to jumpstart your project. The `ent bundle` tool will pull the package and rebuild the structure, which can then be customized locally. -- `--hub-url`: Use this option to specify a custom Entando Hub, else ent defaults to the Entando Cloud Hub +- `--hub-url`: Use this option to specify an enterprise Entando Hub, else ent defaults to the Entando Cloud Hub. -- `--hub-api-key`: This flag supplies the [Hub API key](../../tutorials/solution/entando-hub.md#create-a-private-catalog) to access a bundle from a private enterprise Entando Hub to copy it locally. +- `--hub-api-key`: This flag supplies the [Hub API key](../../tutorials/solution/entando-hub.md#create-a-private-catalog) to access a bundle from a private enterprise Hub. ### Micro Frontend and Microservice | Command| Descriptions |:--|:-- -|`ent bundle mfe add` --stack [stack-type] [name] | Add a React or Angular micro frontend | -|`ent bundle mfe add` --stack custom [name] | Add a custom stack micro frontend | +|`ent bundle mfe add --stack [stack-type] [name]` | Add a React or Angular micro frontend | +|`ent bundle mfe add --stack custom [name]` | Add a custom stack micro frontend | |`ent bundle ms add --stack [stack-type] [name]` | Add a Spring Boot or node microservice | -|`ent bundle ms add` --stack custom [name]` | Add a custom stack microservice | +|`ent bundle ms add --stack custom [name]` | Add a custom stack microservice | #### MFE and MS Command Details - `ent bundle mfe add --stack custom [name]` & `ent bundle ms add --stack custom [name]`: When a custom stack is used for any MFE or microservice, custom commands for the build, run, and pack functions are required under the Command spec in the bundle descriptor `entando.json`. In addition, a version number must be specified for each component. Because Entando can only parse information from a pom.xml or package.json, the custom commands are required to manage the bundle, and the version number is required to track Docker images. For an example, see the [Bundle Details](../curate/bundle-details.md#micro-frontends-sample-code) page. @@ -89,16 +90,16 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si #### Build Command Details - `ent bundle build`: - - The `build` command constructs the project files based on the `entando.json` descriptor. + - The `build` sub command constructs the project files based on the `entando.json` descriptor. - Component type and stack determines the build process, e.g. a React MFE executes an npm build. It can be customized in the command section of the `entando.json`. - All the components in the bundle are built in parallel. - A log file for each component is generated inside the .entando/logs directory of the project. - `--fail-fast`: - - Fail the command as soon as any subtask fails + - Fail the command as soon as any subtask fails. - `--max-parallel=`: - Maximum number of subtasks running simultaneously. The default value is 3. Setting `max-parallel=1` results in a sequential process. - `--stdout`: - - Print the subtask logs to the standard output (stdout) instead of individual log files. This is very useful in CI/CD pipelines. + - Print the subtask logs to the standard output (stdout) instead of individual log files. This is useful in CI/CD pipelines. ### Run | Command| Descriptions @@ -111,7 +112,7 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si #### Run Command Details - `ent bundle run`: - - The `run` command executes processes in accordance with the component type and stack, e.g `mvn spring-boot:run` for a Spring Boot microservice. It can be customized in the command section of the `entando.json`. + - The `run` subcommand executes processes in accordance with the component type and stack, e.g `mvn spring-boot:run` for a Spring Boot microservice. It can be customized in the command section of the `entando.json`. - All the components in the bundle run in parallel, with the logs printed to the standard output. - The `run` command can be used to run multiple microservices side by side without collision in local development, but in production, they must run on port 8081. @@ -128,13 +129,13 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si - `ent bundle pack`: - The artifacts generated for micro frontends and microservices are stored in their respective component folders. File format depends on component type, e.g. a React micro frontend may result in HTML, JavaScript and CSS files. - Once the artifacts are generated, a Docker image for each microservice is built using the Dockerfile located in the microservice's folder. If the Dockerfile is missing, the `pack` command exits with failure. - - The `pack` command executes either `mvn package` or `npm run build`, depending on the stack. These defaults can be overridden in the [custom command section](../curate/bundle-details.md#command-specification) of the bundle descriptor `entando.json`. + - The `pack` subcommand executes either `mvn package` or `npm run build`, depending on the stack. These defaults can be overridden in the [custom command section](../curate/bundle-details.md#command-specification) of the bundle descriptor `entando.json`. - `--fail-fast`: - Fail the command as soon as any subtask fails - `--max-parallel=`: - Maximum number of subtasks running simultaneously. The default value is 3. Setting `max-parallel=1` results in a sequential process. - `--stdout`: - - Print the subtask logs to the standard output (stdout) instead of individual log files. This is very useful in CI/CD pipelines. + - Print the subtask logs to the standard output (stdout) instead of individual log files. This is useful in CI/CD pipelines. - `--skip-docker-build`: - Allow the user to create a custom image build. The YAML descriptors and Dockerfile are created in the `.output` folder but no images are generated for the bundle and microservices. - `ent bundle images`: @@ -150,17 +151,17 @@ See the [Build and Publish a Simple Bundle](../../tutorials/create/pb/publish-si ### Deploy | Command| Description |:--|:-- -|`ent bundle deploy`| Deploy a bundle to the Local Hub of an Entando Application | +|`ent bundle deploy`| Deploy a bundle to the Local Hub of the Entando Platform | ### Install | Command| Description |:--|:-- -|`ent bundle install`| Install a bundle in the Local Hub of an Entando Application | +|`ent bundle install`| Install a bundle in the Local Hub of the Entando Platform | #### Install Command Details -* `ent bundle install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components +* `ent bundle install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, this flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components. -### Convert v1 to v5 +### Convert v1 to v5 Bundle | Command| Descriptions |:--|:-- @@ -196,14 +197,14 @@ The following commands are applicable to both docker-based and git-based bundles |`ent ecr uninstall`| Uninstall a bundle | #### ECR Command Details -* `ent ecr get-bundle-id`: The unique identifier assigned to each bundle provides a mechanism to customize parameters and add security controls for bundle-specific resources +* `ent ecr get-bundle-id`: The unique identifier assigned to each bundle provides a mechanism to customize parameters and add security controls for bundle-specific resources. -* `ent ecr get-plugin-code`: To retrieve the unique identifier for each microservice +* `ent ecr get-plugin-code`: Retrieve the unique identifier for each microservice. * Docker-based bundles: `ent ecr get-plugin-code YOUR-ORG/YOUR-PLUGIN-NAME --repo=docker://registry.hub.docker.com/YOUR-ORG/YOUR-BUNDLE` * Git-based bundles: `ent ecr get-plugin-code --auto --repo=[repository-url]` -* `ent ecr install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components +* `ent ecr install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components. ## Git-based Bundle Commands @@ -233,7 +234,7 @@ The following ent commands are used to manage git-based (< Entando 7.1) bundles. * `ent prj get-plugin-code`: Uniquely and safely identifies each bundle plugin and derived cloud-native resources -* `ent prj install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, the `--conflict-strategy` flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components +* `ent prj install --conflict-strategy=OVERRIDE`: If a bundle project has already been installed, this flag forces a `CREATE`, `SKIP` or `OVERRIDE` strategy for components * `ent bundler`: Provides an interactive mode to identify components to export. Point the bundler to existing environments to extract components and static assets into a custom bundle. This bundle can be used to migrate from one Entando environment to another (e.g. Dev to QA) or as a framework for building a new application. diff --git a/vuepress/docs/v7.3/docs/getting-started/ent-diag.md b/vuepress/docs/v7.3/docs/getting-started/ent-diag.md index a50c5839e2..42913cf639 100644 --- a/vuepress/docs/v7.3/docs/getting-started/ent-diag.md +++ b/vuepress/docs/v7.3/docs/getting-started/ent-diag.md @@ -4,24 +4,24 @@ sidebarDepth: 1 # Diagnostics and Troubleshooting -Diagnostic information is critical to analysis and troubleshooting, and the Entando CLI (ent) is a useful tool for debugging issues with an Entando instance. +Diagnostic information is critical for troubleshooting and analysis, and the Entando CLI (ent) provides several methods. | Command | Description -| :- | :- -| `ent app-info` | Display basic information about Kubernetes and Entando resources -| `ent bundle info` |Show status information for the bundle project| -| `ent --debug bundle "command"` |Enable debug mode| -| `ent diag` | Run diagnostics on the pods currently in an Entando namespace and prepare a diagnostic tar.gz -| `ent pod "command"` | Displays information related to a set of pods -| `ent pod grep --all "error\|fail"` | Locate error messages within EntandoApp pods +| :- | :---------------------------- | +|`ent app-info`| Display basic information about Kubernetes and Entando resources +|`ent bundle info`|Show status information for the bundle project| +|`ent --debug bundle "command"`|Enable debug mode| +|`ent diag`| Run diagnostics on the pods in the current Entando namespace and prepare a diagnostic tar.gz +|`ent pod "command"`| Display information related to a set of pods +|`ent pod grep --all "error\|fail"`| Locate error messages within EntandoApp pods ### Command Details -* `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command also generates diagnostics and returns log paths like the following: +* `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command generates this diagnostics data and returns log paths like the following: ``` > Collected diagdata available under "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000" for consultation > Collected diagdata available in archive "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000.tgz" ``` -* `ent pod "command"`: Analyzes pods in a cluster with commands like `describe`, `logs`, `shell`, `force-reload`, `port-forward`, and others. +* `ent pod "command"`: Administer pods in a cluster with subcommands like `describe`, `logs`, `shell`, `force-reload`, `port-forward`, and others. ### Log Files Log files for the `ent bundle build` and `pack` commands are generated for each component inside the .entando/logs directory. For single components and other processes, they are printed to the standard outputs. \ No newline at end of file diff --git a/vuepress/docs/v7.3/docs/getting-started/ent-profile.md b/vuepress/docs/v7.3/docs/getting-started/ent-profile.md index 71d6584f16..fbeb98c93b 100644 --- a/vuepress/docs/v7.3/docs/getting-started/ent-profile.md +++ b/vuepress/docs/v7.3/docs/getting-started/ent-profile.md @@ -3,17 +3,15 @@ sidebarDepth: 1 --- -# Profile and Configuration Management +# Profile Management -The [Entando CLI](entando-cli.md) can define a collection of configuration variables to fully describe an Entando instance. One or more profiles can be created to store configuration settings for a particular instance. A profile with this information is automatically generated for a quickstart application. +The [Entando CLI](entando-cli.md) manages one or more profile to store the configuration settings for a particular Entando instance. For a quickstart installation, a profile is automatically generated and can be edited for customization. A set of `ent profile` subcommands are available to manage the configurations and to switch between different Entando instances. -At minimum, a profile configuration must consist of the key-value pairs specifying the application name and namespace. To run the application, the Kubernetes connection must also be provided. Cloud Kubernetes tools typically create a Kube context, which can be linked to an Entando profile. +At a minimum, a profile must consist of the key-value pair specifying the application name and namespace. To run Entando, a Kubernetes context must be established and linked to an Entando profile. ## Profile Management -Common operations associated with profile management are detailed below. - -Note: The `ent profile` command is available to manage and switch between the configurations of different Entando instances. Refer to `ent profile first-use-readme` for additional information. +Refer to `ent profile first-use-readme` for additional information. | Command | Description | :- | :- @@ -31,17 +29,17 @@ Note: The `ent profile` command is available to manage and switch between the co **Command details:** -- `ent pro link`: Provides ent with instructions to connect to the Kubernetes containing the Entando Application. Alias of `ent attach-kubectx`. +- `ent pro link`: Provides ent with instructions to connect to the Kubernetes containing the EntandoApp. Alias of `ent attach-kubectx`. - `ent pro new`: Sets the minimal profile data and outputs next steps. - `ent pro use`: Initializes the global profile ent should use across shells. -- `source ent pro use`: Initializes the local profile ent should use within the current shell. Allows ent instances in different shells to simultaneously use different Kube contexts, kubeconfigs or custom commands. The quickstart script creates a profile named "qs--{vmname}" that is associated with the Entando Application it generates. +- `source ent pro use`: Initializes the local profile ent should use within the current shell. It allows ent instances in different shells to simultaneously use different Kube contexts, kubeconfigs or custom commands. The quickstart script creates a profile named "qs--{vmname}" that is associated with the EntandoApp. ## Configuration Management -The output of `ent config` is a key-value archive of configuration settings related to the current profile. The following commands and definitions are especially useful. +The output of `ent config` is a key-value archive of configurations defining the current profile. The following commands and definitions may be useful. ### Commands @@ -59,7 +57,7 @@ The output of `ent config` is a key-value archive of configuration settings rela | Key | Description |---|--- | ENTANDO_NAMESPACE | Stores the fallback namespace used by explicit or implicit runs of `ent kubectl` -| ENTANDO_APPNAME | Stores the Entando Application name related to the current profile +| ENTANDO_APPNAME | Stores the EntandoApp name related to the current profile | DESIGNATED_JAVA_HOME | Stores the path of the Java version used internally by ent diff --git a/vuepress/docs/v7.3/docs/getting-started/ent-svc.md b/vuepress/docs/v7.3/docs/getting-started/ent-svc.md index 2709e446db..ac51882e27 100644 --- a/vuepress/docs/v7.3/docs/getting-started/ent-svc.md +++ b/vuepress/docs/v7.3/docs/getting-started/ent-svc.md @@ -4,9 +4,9 @@ sidebarDepth: 1 # Auxiliary Services -Auxiliary services add capabilities to a local environment to accelerate application development. This is in contrast to developing on Kubernetes, where the equivalent services are either provisioned by the Entando Platform or are externally managed and pointed to by the application. +Auxiliary services add capabilities to a local environment for application development. This is in contrast to developing on Kubernetes, where the equivalent services are either provisioned by the Entando Platform or are externally managed and pointed to by the application. -To run auxiliary operations, a service must be enabled. When the Entando Bundle CLI enables a service, a default auxiliary configuration is generated and formatted as a Docker Compose YAML file in the bundle's 'svc' folder. Enabled services are listed under the 'svc' attribute in the bundle descriptor, `entando.json`. +To run auxiliary operations, a service must be enabled. When the Entando CLI enables a service for a bundle, a default auxiliary configuration is generated and formatted as a Docker Compose YAML file in the bundle's "svc" folder. Enabled services are listed under the `svc` attribute of the bundle descriptor `entando.json`. The following sections describe how Entando supports and implements auxiliary services. @@ -16,17 +16,17 @@ Three services are available out of the box: `mysql`, `postgresql` and `keycloak - `mysql` and `postgresql` obey the same naming convention - The username and password are derived from the bundle name, e.g. YOUR-BUNDLE has the username YOUR-BUNDLE-USER and the password YOUR-BUNDLE-PASSWORD - - A database is automatically created and given the bundle name, e.g. YOUR-BUNDLE + - A database is automatically created and given the name, e.g. YOUR-BUNDLE -- `keycloak` configures authentication for Entando - - The `keycloak` realm name is 'entando-dev' +- `keycloak` manages authentication for Entando + - The `keycloak` realm name is `entando-dev` - The console is accessible at *http://localhost:9080* with username: *admin*, password: *admin* - All roles and permissions are preset, based on the Keycloak realm-config file - - The `keycloak.yaml`, realm-config and user config files are located in the 'keycloak' folder inside 'svc' + - The `keycloak.yaml`, realm-config, and user config files are located in the "keycloak" folder inside "svc" ## Custom Services -A custom service can be added to a bundle's 'svc' folder as a Docker Compose YAML file. The file and service must have the same name, e.g. if the service filename is `mysql.yml`, then the service name must be `mysql`: +A custom service can be added to a bundle's "svc" folder as a Docker Compose YAML file. The file and service must have the same name, e.g. if the service filename is `mysql.yml`, then the service name must be `mysql`: ``` yaml version: '3.7' @@ -54,8 +54,8 @@ The subcommands of `ent bundle svc` are used to manage services. **Command details:** -- `svc logs`: The log of a running service will continue to update until exited via `Ctrl+C` +- `svc logs`: The log of a running service will continue to update until exited via `Ctrl+C`. -- `svc list`: Include the option `--available` to list all services located in the 'svc' bundle folder +- `svc list`: Include the option `--available` to list all services located in the "svc" bundle folder. - Auxiliary commands can operate on multiple services by listing each service name as an argument, e.g. `ent bundle svc start service_1 service_2`. The option `--all` applies the command to all enabled bundle services. \ No newline at end of file diff --git a/vuepress/docs/v7.3/docs/getting-started/entando-cli.md b/vuepress/docs/v7.3/docs/getting-started/entando-cli.md index e032ec799d..7bde158280 100644 --- a/vuepress/docs/v7.3/docs/getting-started/entando-cli.md +++ b/vuepress/docs/v7.3/docs/getting-started/entando-cli.md @@ -4,7 +4,7 @@ sidebarDepth: 1 # Entando CLI -The Entando Command Line Interface, **ent**, provides a set of commands that accelerate common tasks such as installing a new instance of Entando, building projects, creating and deploying bundles, and composing Entando Applications. This document covers the install, command list, and a few operations to start using the ent tool. +The Entando command line interface, **ent**, provides a set of commands that accelerate common tasks such as installing Entando, building projects, creating and deploying bundles, and composing Entando Applications. This document covers some basic commands to start using the ent tool. For specific topics, follow these links: 1. [Bundle Management](ent-bundle.md): `ent bundle` @@ -15,7 +15,7 @@ For specific topics, follow these links: ### Prerequisites -The basic requirements for the CLI vary with use case, as shown in the table below. +The requirements for ent functionality vary with each use case, shown in the table below. | Category | Prerequisite | :- | :- @@ -31,7 +31,7 @@ Install the current official release of the CLI: bash <(curl -L "https://get.entando.org/cli") --update --release="{{ $site.themeConfig.entando.fixpack.v73 }}" ->The automatic option in [Getting Started](../getting-started/) will install the CLI along with a quickstart Entando Application. +>The automatic option in [Getting Started](../getting-started/) will also install the CLI along with a quickstart Entando ACP. ## Command List Use `ent help` to review the list of available commands.\ @@ -39,8 +39,8 @@ Use `ent [command] --help` for command details. ``` > Available commands: - app-info => Displays information about an entando app - - bundle => Management of new generation entando bundles - - bundler => Export of resources from a running instance and generation old-generation bundle deployment CRs + - bundle => Management of entando bundles (v5 or higher) + - bundler => Export of resources from a running instance and older-generation bundle management - check-env => Checks the environment for required dependencies and settings - diag => Runs diagnostics and aggregates the related info in a .tgz file - ecr => Helper for managing the ECR @@ -50,7 +50,7 @@ Use `ent [command] --help` for command details. - kubectl => Helper for using kubectl in ent managed scenarios - pod => Displays information related to a set of pods - prj => Helper for managing the first generation of Entando bundle projects - - profile => Helps managing an EntandoApp + - profile => Helps manage the EntandoApp - quickstart => Helper for installing Entando instances locally - run-tests => Runs the internal tests @@ -77,16 +77,18 @@ TOPICS svc Manage auxiliary services COMMANDS - build Build bundle components - deploy Deploy a bundle to the Local Hub of an Entando Application + build Build the bundle components + deploy Generate the CR and deploy it to the currently attached EntandoApp generate-cr Generate the Entando Custom Resource (CR) for a bundle project - help Display help for ent bundle. + help Display help for ent bundle + images List the Docker images and their corresponding tags that are + included in the bundle info Show status information for the bundle project init Perform the scaffolding of a bundle project - install Install a bundle in the Local Hub of an Entando Application + install Install a bundle in the current directory to the currently attached EntandoApp list List the available components in the bundle pack Generate the bundle Docker images - publish Publish bundle Docker images + publish Publish the bundle Docker images run Run bundle components DEBUG MODE @@ -95,7 +97,7 @@ DEBUG MODE ``` ### Check the Environment -Verify dependencies required by your Entando installation: +Verify the dependencies required by your Entando installation: ``` bash ent check-env develop ``` @@ -107,16 +109,16 @@ To update ent to the latest version and check for dependencies: bash <(curl -L "https://get.entando.org/cli") --update ent check-env develop ``` ->Alternatively, to perform a clean install, delete the `~/.entando` directory via `rm -rf ~/.entando`. Then reinstall the CLI using the instructions above. This will also remove the private copies of JHipster, Entando Blueprint, etc. +>Alternatively, to perform a clean install, delete the `~/.entando` directory with the flags `rm -rf ~/.entando`. Then reinstall the CLI using the instructions above. This will also remove the private copies of JHipster, Entando Blueprint, etc. ### Enable Debug Mode -To utilize the debug mode for ent bundle commands: +To utilize the debug helper for ent bundle commands: ``` sh ent --debug bundle ``` ### Customize Quickstart -The `ent quickstart` command accepts parameters to customize your quickstart environment. These options allow you to modify specific properties of your VM, installation versions and databases. +The `ent quickstart` command accepts parameters to customize your quickstart environment. These options allow you to modify specific properties of the VM, installation versions, and databases. |Operation |Syntax|Description| |:--|:--|:--| diff --git a/vuepress/docs/v7.3/docs/getting-started/img/entando-architecture-v1.5.svg b/vuepress/docs/v7.3/docs/getting-started/img/entando-architecture-v1.5.svg deleted file mode 100644 index 0622d0bab7..0000000000 --- a/vuepress/docs/v7.3/docs/getting-started/img/entando-architecture-v1.5.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Entando Quickstart Architecture
Entando Quickstart Architecture
User Interface
User Interface
User/Identity Admin
User/Identity Admin
Entando Identity Management
Entando Identity Management
Content
Content
App Admin
App Admin
App Users
App Users
App Builder UI
App Builder UI
Content
Content
MFE
MFE
Paths
Paths
/abc-plugin-ingress-path
/abc-plugin-ingress-path
/app-builder
/app-builder
/auth
/auth
/entando-de-app
/entando-de-app
/digital-exchange
/digital-exchange
Kubernetes Containers
Kubernetes Containers
Plugin/Microservice Container(s)
Plugin/Microservice...
abc-plugin-server-deployment
abc-plugin-server-dep...
App Builder
App Builder
Component Manager
Component Manager
App Engine
App Engine
APIs
APIs
Core
Core
CMS
CMS


quickstart-cm-deployment
quickstart-cm-deploy...
quickstart-deployment
quickstart-deploym...
Operator
Operator
entando-operator
entando-opera...

default-sso-in-namespace-deployment

default-sso-in-namespace-dep...
Keycloak Server
Keycloak Server
entando-k8s--service
entando-k8s--ser...
Kubernetes Service
Kubernetes Service
Note: The Operator listens for events within the Kubernetes cluster and performs actions accordingly, e.g. creating Entando pods during initial install, setting up plugin ingress and pods upon bundle installation from ECR, etc.
Note: The Operator listens for events within the Kubern...

quickstart-ab-deployment

quickstart-ab-deployment
Custom App UI
Custom App UI

Text is not SVG - cannot display \ No newline at end of file diff --git a/vuepress/docs/v7.3/docs/getting-started/img/entando-architecture.png b/vuepress/docs/v7.3/docs/getting-started/img/entando-architecture.png index 8943dda7c2..549c9bd5ba 100644 Binary files a/vuepress/docs/v7.3/docs/getting-started/img/entando-architecture.png and b/vuepress/docs/v7.3/docs/getting-started/img/entando-architecture.png differ diff --git a/vuepress/docs/v7.3/docs/getting-started/img/entando-cluster-arch.png b/vuepress/docs/v7.3/docs/getting-started/img/entando-cluster-arch.png new file mode 100644 index 0000000000..13281c8956 Binary files /dev/null and b/vuepress/docs/v7.3/docs/getting-started/img/entando-cluster-arch.png differ diff --git a/vuepress/docs/v7.3/docs/getting-started/landing-page.md b/vuepress/docs/v7.3/docs/getting-started/landing-page.md index 44fab6baae..42c5a13749 100644 --- a/vuepress/docs/v7.3/docs/getting-started/landing-page.md +++ b/vuepress/docs/v7.3/docs/getting-started/landing-page.md @@ -4,26 +4,26 @@ sidebarDepth: 2 # Entando Solution Templates -The Entando Application Composition Platform offers several Solution Templates to demonstrate various business capabilities and integrations: +The Entando ACP offers several Solution Templates to demonstrate various business capabilities and integrations: - [**Entando Customer Portal**](../../tutorials/solution/customer-portal.md) - [**Entando Hub**](../../tutorials/solution/entando-hub.md) - [**Entando Process Driven Applications Plugin**](../../tutorials/solution/pda-tutorial.md) - [**Entando Standard Banking Demo**](../../tutorials/solution/install-standard-demo.md) -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. +Each open source template was built with Entando and can be used as-is, reviewed as a reference, customized, or leveraged as a starting point for a similar application. -The following Solution Templates and other sets of components are available in the [public Entando Hub](https://entando.com/composable-platform/packaged-business-capabilities/) for installation in a user environment, where turnkey functionality can be customized and extended. +These Solution Templates, and other packaged business capabilities (PBCs), are available in the [Entando Marketplace Hub](https://entando.com/composable-platform/packaged-business-capabilities/). ## Entando Customer Portal -The [Entando Customer Portal](../../tutorials/solution/customer-portal.md) streamlines development of a customer-facing, self-service subscription management application. The platform integrates Keycloak role based access control and Jira Service Management as a ticket tracking system. +The [Entando Customer Portal](../../tutorials/solution/customer-portal.md) is a customer-facing, self-service subscription management application. The Platform integrates Keycloak for role based access control and Jira Service Management as a ticket tracking system. ## Entando Hub -The [Entando Hub](../../tutorials/solution/entando-hub.md) empowers a team to share and collaborate on proprietary or Entando open source components. Capabilities, versions and metadata can be transparently analyzed, managed and published. +The [Entando Hub](../../tutorials/solution/entando-hub.md) empowers a team to share and collaborate on proprietary or Entando open source components. Capabilities, versions and metadata can be analyzed, managed and published. You can install a private catalog to share components within a team or the whole organization with user access controls. @@ -32,13 +32,13 @@ The [Entando Hub](../../tutorials/solution/entando-hub.md) empowers a team to sh ## Entando Process Driven Applications Plugin -The [Entando Process Driven Applications Plugin](../../tutorials/solution/pda-tutorial.md) provides a comprehensive and versatile automation scheme for Business Process Management. It comprises a custom UX layer, a Spring Boot Backend for Frontend microservice interface, and integration with the [Red Hat Process Automation Manager](https://www.redhat.com/en/technologies/jboss-middleware/process-automation-manager). +The [Entando Process Driven Applications Plugin](../../tutorials/solution/pda-tutorial.md) provides a comprehensive and versatile automation scheme for Business Process Management. It comprises a custom UX layer, a Spring Boot Backend for Frontend microservice interface, and integration with the [Red Hat Process Automation Manager](https://access.redhat.com/products/red-hat-process-automation-manager). ## Entando Standard Banking Demo -The [Entando Standard Banking Demo](../../tutorials/solution/install-standard-demo.md) showcases the benefits and possibilities of a composable application built from modular components. The example banking environment integrates a transaction table, sign up form, alert icon, and summary cards to demonstrate MFE communication and capabilities. Prominent features include Keycloak role based access control, coexistence of React and Angular MFEs, and pluggable Spring Boot microservices. +The [Entando Standard Banking Demo](../../tutorials/solution/install-standard-demo.md) showcases the possibilities and benefits of a composable application built from modular components. The example banking environment integrates a transaction table, sign up form, alert icon, and summary cards to demonstrate micro frontend (MFE) capabilities. Prominent features include Keycloak role based access control, coexistence of React and Angular MFEs, and pluggable Spring Boot microservices. diff --git a/vuepress/docs/v7.3/tutorials/getting-started/azure-install.md b/vuepress/docs/v7.3/tutorials/getting-started/azure-install.md index 22a5ca03cb..228faec784 100644 --- a/vuepress/docs/v7.3/tutorials/getting-started/azure-install.md +++ b/vuepress/docs/v7.3/tutorials/getting-started/azure-install.md @@ -140,7 +140,7 @@ kubectl get pods -n entando --watch http://YOUR-HOST-NAME/app-builder/ ``` -See the [Getting Started guide](../../docs/getting-started/README.md#login-to-entando) for helpful login instructions and next steps. +See the [Getting Started guide](../../docs/getting-started/README.md#log-in-to-entando) for helpful login instructions and next steps. ## Appendix A - Troubleshooting diff --git a/vuepress/docs/v7.3/tutorials/getting-started/eks-install.md b/vuepress/docs/v7.3/tutorials/getting-started/eks-install.md index 6658c4bf70..39fce2c281 100644 --- a/vuepress/docs/v7.3/tutorials/getting-started/eks-install.md +++ b/vuepress/docs/v7.3/tutorials/getting-started/eks-install.md @@ -214,7 +214,7 @@ Use `Ctrl+C` to exit the command. ``` http://YOUR-HOST-NAME/app-builder/ ``` -Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#login-to-entando) for helpful login instructions and next steps. +Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#log-in-to-entando) for helpful login instructions and next steps. ## Appendix A - Troubleshooting IAM and Roles diff --git a/vuepress/docs/v7.3/tutorials/getting-started/gke-install.md b/vuepress/docs/v7.3/tutorials/getting-started/gke-install.md index 735e3980f8..839a648061 100644 --- a/vuepress/docs/v7.3/tutorials/getting-started/gke-install.md +++ b/vuepress/docs/v7.3/tutorials/getting-started/gke-install.md @@ -132,7 +132,7 @@ kubectl get pods -n entando --watch http://YOUR-HOST-NAME/app-builder/ ``` -See the [Getting Started guide](../../docs/getting-started/README.md#login-to-entando) for helpful login instructions and next steps. +See the [Getting Started guide](../../docs/getting-started/README.md#log-in-to-entando) for helpful login instructions and next steps. ## Appendix: Configuring Clustered Storage diff --git a/vuepress/docs/v7.3/tutorials/getting-started/openshift-install.md b/vuepress/docs/v7.3/tutorials/getting-started/openshift-install.md index ba03e915bb..6e047c2a2e 100644 --- a/vuepress/docs/v7.3/tutorials/getting-started/openshift-install.md +++ b/vuepress/docs/v7.3/tutorials/getting-started/openshift-install.md @@ -84,7 +84,7 @@ http://YOUR-HOST-NAME/app-builder/ ``` ## Next Steps -Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#login-to-entando) for helpful login instructions and next steps. +Congratulations! To continue your journey with Entando, see the [Getting Started guide](../../docs/getting-started/#log-in-to-entando) for helpful login instructions and next steps. ## Appendix - Troubleshooting and Common Errors