From b532e0f6f3319a238d3beec7596d56a3829954ec Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Mon, 29 Aug 2022 18:24:41 -0700 Subject: [PATCH 01/10] ENDOC-515 Replace ECR with Local Hub --- vuepress/docs/.vuepress/next.js | 22 +++++++++--------- vuepress/docs/next/docs/README.md | 14 +++++------ .../docs/next/docs/community/contributing.md | 2 +- .../docs/next/docs/compose/app-builder.md | 4 ++-- .../docs/next/docs/compose/ecm-overview.md | 10 ++++---- .../{ecr-architecture.png => local-hub.png} | Bin ...{ecr-overview.md => local-hub-overview.md} | 18 +++++++------- .../docs/next/docs/consume/entandoapp-cr.md | 2 +- .../docs/create/component-gen-overview.md | 8 +++---- .../next/docs/create/component-gen-tech.md | 2 +- .../img/{ecr-page.png => local-hub-page.png} | Bin ...details.md => local-hub-bundle-details.md} | 2 +- ...filters.md => local-hub-bundle-filters.md} | 14 +++++------ ...> local-hub-bundle-presentation-config.md} | 4 ++-- ...aq.md => local-hub-bundle-versions-faq.md} | 18 +++++++------- ...-hub-how-microservices-connect-to-apps.md} | 2 +- ....md => local-hub-troubleshooting-guide.md} | 0 ...ll-flow.md => local-hub-uninstall-flow.md} | 8 +++---- .../docs/getting-started/concepts-overview.md | 16 ++++++------- .../next/docs/getting-started/ent-bundle.md | 6 ++--- .../next/docs/getting-started/entando-cli.md | 2 +- .../docs/reference/deployment-structure.md | 4 ++-- vuepress/docs/next/tutorials/README.md | 2 +- .../docs/next/tutorials/create/mfe/angular.md | 2 +- .../create/ms/add-access-controls.md | 2 +- ...erate-microservices-and-micro-frontends.md | 2 +- .../create/pb/publish-project-bundle.md | 4 ++-- ...-repo.md => local-hub-private-git-repo.md} | 4 ++-- ...-images.md => local-hub-private-images.md} | 4 ++-- ...cking-up-and-restoring-your-environment.md | 2 +- .../next/tutorials/devops/build-core-image.md | 4 ++-- .../docs/next/tutorials/devops/external-db.md | 2 +- .../getting-started/kubernetes-install.md | 2 +- .../tutorials/solution/customer-portal.md | 4 ++-- .../next/tutorials/solution/entando-hub.md | 10 ++++---- .../solution/install-standard-demo.md | 6 ++--- .../next/tutorials/solution/pda-tutorial.md | 6 ++--- 37 files changed, 107 insertions(+), 107 deletions(-) rename vuepress/docs/next/docs/compose/img/{ecr-architecture.png => local-hub.png} (100%) rename vuepress/docs/next/docs/compose/{ecr-overview.md => local-hub-overview.md} (80%) rename vuepress/docs/next/docs/curate/img/{ecr-page.png => local-hub-page.png} (100%) rename vuepress/docs/next/docs/curate/{ecr-bundle-details.md => local-hub-bundle-details.md} (99%) rename vuepress/docs/next/docs/curate/{ecr-bundle-filters.md => local-hub-bundle-filters.md} (82%) rename vuepress/docs/next/docs/curate/{ecr-bundle-presentation-config.md => local-hub-bundle-presentation-config.md} (91%) rename vuepress/docs/next/docs/curate/{ecr-bundle-versions-faq.md => local-hub-bundle-versions-faq.md} (71%) rename vuepress/docs/next/docs/curate/{ecr-how-microservices-connect-to-apps.md => local-hub-how-microservices-connect-to-apps.md} (97%) rename vuepress/docs/next/docs/curate/{ecr-troubleshooting-guide.md => local-hub-troubleshooting-guide.md} (100%) rename vuepress/docs/next/docs/curate/{ecr-uninstall-flow.md => local-hub-uninstall-flow.md} (77%) rename vuepress/docs/next/tutorials/curate/{ecr-private-git-repo.md => local-hub-private-git-repo.md} (90%) rename vuepress/docs/next/tutorials/curate/{ecr-private-images.md => local-hub-private-images.md} (85%) diff --git a/vuepress/docs/.vuepress/next.js b/vuepress/docs/.vuepress/next.js index 0323661184..78c4f7a4a5 100644 --- a/vuepress/docs/.vuepress/next.js +++ b/vuepress/docs/.vuepress/next.js @@ -79,31 +79,31 @@ module.exports = { children: [ { title: 'Bundle and Component Descriptors', - path: path + 'curate/ecr-bundle-details.md' + path: path + 'curate/local-hub-bundle-details.md' }, { title: 'Filtering Bundles', - path: path + 'curate/ecr-bundle-filters.md' + path: path + 'curate/local-hub-bundle-filters.md' }, { title: 'Customize Bundle Info in App Builder', - path: path + 'curate/ecr-bundle-presentation-config.md' + path: path + 'curate/local-hub-bundle-presentation-config.md' }, { title: 'Bundle Version and Updates - FAQ', - path: path + 'curate/ecr-bundle-versions-faq.md' + path: path + 'curate/local-hub-bundle-versions-faq.md' }, { title: 'How Microservices connect to Entando Apps', - path: path + 'curate/ecr-how-microservices-connect-to-apps.md' + path: path + 'curate/local-hub-how-microservices-connect-to-apps.md' }, { title: 'Bundle Upgrade, Downgrade, Uninstall', - path: path + 'curate/ecr-uninstall-flow.md' + path: path + 'curate/local-hub-uninstall-flow.md' }, { title: 'Troubleshooting ECR', - path: path + 'curate/ecr-troubleshooting-guide.md' + path: path + 'curate/local-hub-troubleshooting-guide.md' } ] }, @@ -119,8 +119,8 @@ module.exports = { path: path + 'compose/app-builder.md' }, { - title: 'Entando Component Repository', - path: path + 'compose/ecr-overview.md' + title: 'Local Hub', + path: path + 'compose/local-hub-overview.md' }, { title: 'Entando Component Manager', @@ -358,8 +358,8 @@ module.exports = { { title: 'Curate and Share Applications', children: [ - path + 'curate/ecr-private-git-repo.md', - path + 'curate/ecr-private-images.md', + path + 'curate/local-hub-private-git-repo.md', + path + 'curate/local-hub-private-images.md', ] }, { diff --git a/vuepress/docs/next/docs/README.md b/vuepress/docs/next/docs/README.md index 445dd7020d..589def1db9 100644 --- a/vuepress/docs/next/docs/README.md +++ b/vuepress/docs/next/docs/README.md @@ -32,20 +32,20 @@ On the Entando Platform, Curate and Share means development teams can bundle and | Documentation | Tutorials | | :------------ | :-------- | -| [Bundle and Component Descriptors](./curate/ecr-bundle-details.md) | [Install Bundles from a Private Git Repository](../tutorials/curate/ecr-private-git-repo.md) | -| [Filtering Bundles](./curate/ecr-bundle-filters.md) | [Install Bundle Plugins from a Private Image Repo](../tutorials/curate/ecr-private-images.md) | -| [Customize Bundle Info in App Builder](./curate/ecr-bundle-presentation-config.md) | | -| [Bundle Version and Updates FAQ](./curate/ecr-bundle-versions-faq.md) | | -| [Bundle Uninstall](./curate/ecr-uninstall-flow.md) | | +| [Bundle and Component Descriptors](./curate/local-hub-bundle-details.md) | [Install Bundles from a Private Git Repository](../tutorials/curate/local-hub-private-git-repo.md) | +| [Filtering Bundles](./curate/local-hub-bundle-filters.md) | [Install Bundle Plugins from a Private Image Repo](../tutorials/curate/local-hub-private-images.md) | +| [Customize Bundle Info in App Builder](./curate/local-hub-bundle-presentation-config.md) | | +| [Bundle Version and Updates FAQ](./curate/local-hub-bundle-versions-faq.md) | | +| [Bundle Uninstall](./curate/local-hub-uninstall-flow.md) | | ## Compose an Application -The Compose stage is centered around the [Entando App Builder](./compose/app-builder.md), a low-code composition user interface. In the App Builder, application owners can assemble new components or upgrade existing ones with templates, widgets and PBCs. The [Entando Component Manager](./compose/ecm-overview.md) and [Entando Component Repository](./compose/ecr-overview.md) are integrated into the App Builder to manage your components, making the process flexible and agile. +The Compose stage is centered around the [Entando App Builder](./compose/app-builder.md), a low-code composition user interface. In the App Builder, application owners can assemble new components or upgrade existing ones with templates, widgets and PBCs. 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, making the process flexible and agile. | Documentation | Tutorials | | :------------ | :-------- | | [Welcome Wizard](./compose/welcome-wizard.md) | [Page Management](../tutorials/compose/page-management.md) | -| [Entando Component Repository](./compose/ecr-overview.md) | [Widgets and Fragments](../tutorials/compose/widgets-fragments.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) | | | [Digital Assets](../tutorials/compose/digital-assets-tutorial.md) | diff --git a/vuepress/docs/next/docs/community/contributing.md b/vuepress/docs/next/docs/community/contributing.md index 8cbef1045c..386d86e4d0 100644 --- a/vuepress/docs/next/docs/community/contributing.md +++ b/vuepress/docs/next/docs/community/contributing.md @@ -1,7 +1,7 @@ # Contributing to Entando -There are many ways to contribute to Entando including participating in the [Entando Forum](https://forum.entando.org), opening issues on GitHub, [updating documentation](https://github.com/entando/entando-docs/tree/master/vuepress), building bundles using the [Entando Component Repository](../compose/ecr-overview.md), and contributing directly to the source. +There are many ways to contribute to Entando including participating in the [Entando Forum](https://forum.entando.org), opening issues on GitHub, [updating documentation](https://github.com/entando/entando-docs/tree/master/vuepress), building bundles using the [Local Hub](../compose/local-hub-overview.md), and contributing directly to the source. ## Contributing to the Source diff --git a/vuepress/docs/next/docs/compose/app-builder.md b/vuepress/docs/next/docs/compose/app-builder.md index 455862cd2d..6d6448e625 100644 --- a/vuepress/docs/next/docs/compose/app-builder.md +++ b/vuepress/docs/next/docs/compose/app-builder.md @@ -8,7 +8,7 @@ The Entando App Builder plays a key role in the composition of Entando Applicati ![app-builder](./img/app-builder.png) -The App Builder allows you to create pages and content, configure widgets and plugins, and interact with the [Entando Component Repository](ecr-overview.md) (ECR). It also interfaces with the [Entando Hub](https://hub.entando.com), where you can share components and collaborate. +The App Builder allows you to create pages and content, configure widgets and plugins, and interact with the [Local Hub](local-hub-overview.md). It also interfaces with the [Entando Hub](https://hub.entando.com), where you can share components and collaborate. Pages are designed and embedded with functionality via drag-and-drop: @@ -19,7 +19,7 @@ In the default deployment, the App Builder is a React JS application served by N ### Key Features: -* Install component bundles from the Entando Component Repository +* Install component bundles from the Local Hub * Deploy standalone packaged business capabilities diff --git a/vuepress/docs/next/docs/compose/ecm-overview.md b/vuepress/docs/next/docs/compose/ecm-overview.md index 3b6dcfe584..3386ed31fe 100644 --- a/vuepress/docs/next/docs/compose/ecm-overview.md +++ b/vuepress/docs/next/docs/compose/ecm-overview.md @@ -6,17 +6,17 @@ sidebarDepth: 2 ​​An Entando Application is composed of the [Entando App Builder](app-builder.md), [Entando App Engine](../getting-started/concepts-overview.md#entando-app-engine), and Entando Component Manager. The Entando Component Manager (ECM) provides functionality to build and organize micro frontends and widgets from within the App Builder. It also manages the connections between an application and the installed plugins. -The Component Manager is a service that links the [Entando Component Repository](ecr-overview.md) (ECR) of the App Builder to the core application instance. It appears as `quickstart-cm-deployment` in the Kubernetes pod list: +The Component Manager is a service that links the [Local Hub](local-hub-overview.md) of the App Builder to the core application instance. It appears as `quickstart-cm-deployment` in the Kubernetes pod list: ![pods.png](./img/pods.png) -The ECM communicates with the Kubernetes service to populate the ECR with the bundles available as [Custom Resources](../consume/custom-resources.md) in the Entando namespace. These bundles can be installed in the application and managed from within the ECR. +The ECM communicates with the Kubernetes service to populate the Local Hub with the bundles available as [Custom Resources](../consume/custom-resources.md) in the Entando namespace. These bundles can be installed in the application and managed from within the Local Hub. ![ecm-flow.png](./img/ecm-flow.png) In the flow pictured above: -1. A user visits the ECR page in the App Builder -2. The ECR makes a REST call to the `digital-exchange` endpoint +1. A user visits the Local Hub page in the App Builder +2. The Local Hub makes a REST call to the `digital-exchange` endpoint 3. The Component Manager receives the `digital-exchange` request 4. The Component Manager calls the `k8s-service` to return the list of available `EntandoDeBundles` in the namespace @@ -26,6 +26,6 @@ A similar process occurs when bundles are installed or uninstalled. The [Entando * Manages the installation and removal of project bundles -* Makes components available in the App Builder through the Component Repository +* Makes components available in the App Builder through the Local Hub * Handles versioning of component bundles for sharing and collaborating diff --git a/vuepress/docs/next/docs/compose/img/ecr-architecture.png b/vuepress/docs/next/docs/compose/img/local-hub.png similarity index 100% rename from vuepress/docs/next/docs/compose/img/ecr-architecture.png rename to vuepress/docs/next/docs/compose/img/local-hub.png diff --git a/vuepress/docs/next/docs/compose/ecr-overview.md b/vuepress/docs/next/docs/compose/local-hub-overview.md similarity index 80% rename from vuepress/docs/next/docs/compose/ecr-overview.md rename to vuepress/docs/next/docs/compose/local-hub-overview.md index e4ee3c27f3..8f9efd3ace 100644 --- a/vuepress/docs/next/docs/compose/ecr-overview.md +++ b/vuepress/docs/next/docs/compose/local-hub-overview.md @@ -1,14 +1,14 @@ --- sidebarDepth: 2 --- -# Entando Component Repository +# Local Hub ## Introduction -The Entando Component Repository (ECR) is a repository where +The Local Hub is a repository where reusable components can be shared across applications and enterprises. -The following examines some of the nuts and bolts of the ECR. +The following examines some of the nuts and bolts of the Local Hub. ### Component @@ -17,9 +17,9 @@ code that can be used in an Entando widget, page or application. Examples of components are widgets, micro frontends, content types, labels, plugins, and static resources. -### ECR Bundle +### Local Hub Bundle -An ECR bundle is a package containing one or more components and a +A Local Hub bundle is a package containing one or more components and a descriptor.yaml file providing information about the bundle. The bundle is published in a Git registry and shared with an Entando Application using the EntandoDeBundle custom resource. @@ -28,7 +28,7 @@ Application using the EntandoDeBundle custom resource. The EntandoDeBundle custom resource is a Kubernetes resource readable by the Entando Operator. It provides information -about an ECR bundle and makes the bundle available in Kubernetes for the +about a Local Hub bundle and makes the bundle available in Kubernetes for the Entando Component Manager. ### Entando Component Manager (ECM) @@ -44,9 +44,9 @@ responsible for the low-level communication with the K8s cluster API. ## Architecture -![ECR Architecture](./img/ecr-architecture.png) +![Local Hub Architecture](./img/local-hub-architecture.png) -From an architectural point of view, the ECR is composed of: +From an architectural point of view, the Local Hub is composed of: 1. The `EntandoDeBundles` which contain the metadata associated with a bundle 2. The `entando-k8s-service` which reads the bundles from the cluster/namspace(s) and serves them via a consumable API @@ -55,7 +55,7 @@ and the K8s service. ### Example Flow -1. From the Repository page in the App Builder, the user finds the +1. From the Local Hub page in the App Builder, the user finds the list of bundles shared in that EntandoApp 2. App Builder requests a list of available bundles from the ECM diff --git a/vuepress/docs/next/docs/consume/entandoapp-cr.md b/vuepress/docs/next/docs/consume/entandoapp-cr.md index 674bb66ccb..c41109efbb 100644 --- a/vuepress/docs/next/docs/consume/entandoapp-cr.md +++ b/vuepress/docs/next/docs/consume/entandoapp-cr.md @@ -27,7 +27,7 @@ spec: | :- | :- | | `spec.customServerImage`| Used to deploy the Docker image containing your custom Entando App. Follow these instructions on how to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| |`spec.dbms` | Allowed values are: MySQL, PostgreSQL (default), Oracle, or embedded. Oracle is only supported as an external database.| -|`spec.ecrGitSshSecretName`| The configuration used by the Entando Component Repository to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| +|`spec.ecrGitSshSecretName`| The configuration used by the Local Hub to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| |`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. This can be used to provide connection details of custom datasources or message queues as discussed in the [custom datasources tutorial](../../tutorials/devops/change-default-datasource.md). These variables can sometimes be used as a mechanism to override any of the default environment variables that need customization.| |`spec.ingressPath`| Specifies the web context of the EntandoApp to be deployed. | |`spec.ingressHostName`| The hostname of the Kubernetes ingress to be created for the EntandoApp. EntandoPlugins linked to this app will also be made available on the host.| diff --git a/vuepress/docs/next/docs/create/component-gen-overview.md b/vuepress/docs/next/docs/create/component-gen-overview.md index f1bc999f63..dc36ab499c 100644 --- a/vuepress/docs/next/docs/create/component-gen-overview.md +++ b/vuepress/docs/next/docs/create/component-gen-overview.md @@ -34,11 +34,11 @@ This section provides an overview of the component generation process. If you wa 2. Define bundle and deploy assets - The Entando blueprint includes scripts and tools to automatically generate a bundle ready for deployment to the ECR. The bundle will include your microservice, generated microfrontends, and any microfrontends that you have created manually under the `ui` folder - The generated Spring Boot microservice can be built and deployed to a Docker registry using the provided maven Jib plugin - - Generated bundles can be pushed to a git repository of the users choice + - Generated bundles can be pushed to a Git repository of the users choice -3. Deploy bundles to [Entando Component Repository (ECR)](../compose/ecr-overview.md) +3. Deploy bundles to the [Local Hub](../compose/local-hub-overview.md) - Once your Docker images are pushed to your registry and your bundle is available in Git you can generate an Entando bundle descriptor and push the bundles to the ECR - - The bundles can be versioned and updated using tags in the git repository + - The bundles can be versioned and updated using tags in the Git repository 4. Install in Entando Apps - - Once the bundles are in the ECR they are available for deployment in any Entando application that has access to the ECR in the cluster + - Once the bundles are in the Local Hub they are available for deployment in any Entando application that has access to the Local Hub in the cluster diff --git a/vuepress/docs/next/docs/create/component-gen-tech.md b/vuepress/docs/next/docs/create/component-gen-tech.md index c134e9120d..4c78929b94 100644 --- a/vuepress/docs/next/docs/create/component-gen-tech.md +++ b/vuepress/docs/next/docs/create/component-gen-tech.md @@ -5,7 +5,7 @@ When generating a microservice using the Entando Component Generator there are a * Microservice code * The Component Generator currently only supports the generation of Spring Boot microservices but will support the generation of Quarkus based services soon. * If you're interested in using Quarkus in your Entando app, contact us on the [Forum](https://forum.entando.org/) or [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw) and we'll help you get started. - * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/ecr-bundle-details.md#plugin), including information on the runtime contract required to use them. + * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/local-hub-bundle-details.md#plugin), including information on the runtime contract required to use them. * Database type * Entando recommends standardizing your choice of database to simplify operational maintenance but you do have the ability to use different databases for different microservices if you choose. * Supported choices are none, MySQL, and Postgres. Enterprise customers can choose Oracle but should contact Entando Support for details. diff --git a/vuepress/docs/next/docs/curate/img/ecr-page.png b/vuepress/docs/next/docs/curate/img/local-hub-page.png similarity index 100% rename from vuepress/docs/next/docs/curate/img/ecr-page.png rename to vuepress/docs/next/docs/curate/img/local-hub-page.png diff --git a/vuepress/docs/next/docs/curate/ecr-bundle-details.md b/vuepress/docs/next/docs/curate/local-hub-bundle-details.md similarity index 99% rename from vuepress/docs/next/docs/curate/ecr-bundle-details.md rename to vuepress/docs/next/docs/curate/local-hub-bundle-details.md index 306f80680a..00a3e948e4 100644 --- a/vuepress/docs/next/docs/curate/ecr-bundle-details.md +++ b/vuepress/docs/next/docs/curate/local-hub-bundle-details.md @@ -278,7 +278,7 @@ Groups in a page descriptor are configured by `ownerGroup` and `joinGroups`. The seo: false charset: utf-8 - # ECR will publish the page according to this property + # Local Hub will publish the page according to this property status: published|draft # Page Configuration diff --git a/vuepress/docs/next/docs/curate/ecr-bundle-filters.md b/vuepress/docs/next/docs/curate/local-hub-bundle-filters.md similarity index 82% rename from vuepress/docs/next/docs/curate/ecr-bundle-filters.md rename to vuepress/docs/next/docs/curate/local-hub-bundle-filters.md index 996bcccddc..a4b3bf196b 100644 --- a/vuepress/docs/next/docs/curate/ecr-bundle-filters.md +++ b/vuepress/docs/next/docs/curate/local-hub-bundle-filters.md @@ -1,12 +1,12 @@ # Filtering bundles -ECR bundles are filterable by component, by status or by textual research. +Local Hub bundles are filterable by component, by status or by textual research. ## Filtering bundles by component -ECR bundles are filterable by component from App Builder user interface. +Local Hub bundles are filterable by component from App Builder user interface. -![App Builder bundle filtering](./img/app-builder-ecr-bundle-component-filters.png) +![App Builder bundle filtering](./img/app-builder-local-hub-bundle-component-filters.png) Behind the scenes, filtering is done using the label-based filtering provided out of the box from Kubernetes. @@ -54,7 +54,7 @@ To enable filtering of a bundle, the custom-resource representing the bundle on ### Example -Here is an example of the metadata for a ecr bundle containg micro-frontends, some microservices and page templates +Here is an example of the metadata for a Local Hub bundle containg micro frontends, some microservices and page templates ``` apiVersion: entando.org/v1 @@ -72,9 +72,9 @@ spec: ## Filtering bundles by status -ECR bundles are filterable by status from App Builder user interface. +Local Hub bundles are filterable by status from App Builder user interface. -![App Builder bundle filtering](./img/app-builder-ecr-bundle-status-filters.png) +![App Builder bundle filtering](./img/app-builder-local-hub-bundle-status-filters.png) You can choose to see the full list of the bundles available in Kubernetes cluster by selecting the `Explore` tab, or the list of the currently installed bundles by clicking on the `Installed` tab. @@ -83,7 +83,7 @@ You can choose to see the full list of the bundles available in Kubernetes clust You can search for bundles containing some keywords by executing a textual search. -![App Builder bundle filtering](./img/app-builder-ecr-bundle-textual-search.png) +![App Builder bundle filtering](./img/app-builder-local-hub-bundle-textual-search.png) You can open the menu on the left to select which field to target. diff --git a/vuepress/docs/next/docs/curate/ecr-bundle-presentation-config.md b/vuepress/docs/next/docs/curate/local-hub-bundle-presentation-config.md similarity index 91% rename from vuepress/docs/next/docs/curate/ecr-bundle-presentation-config.md rename to vuepress/docs/next/docs/curate/local-hub-bundle-presentation-config.md index 8558fbf213..3b60d0eab6 100644 --- a/vuepress/docs/next/docs/curate/ecr-bundle-presentation-config.md +++ b/vuepress/docs/next/docs/curate/local-hub-bundle-presentation-config.md @@ -1,8 +1,8 @@ # How to customize bundle info shown in Entando App Builder -![ECR User interface in Entando App Builder](./img/ecr-page.png) +![Local Hub user interface in Entando App Builder](./img/local-hub-page.png) -In the image above you can see an example of a bundle as is displayed in the ECR user interface inside the Entando App Builder. +In the image above you can see an example of a bundle as is displayed in the Local Hub user interface inside the Entando App Builder. The corresponding custom-resource file on Kubernetes is similar to this: diff --git a/vuepress/docs/next/docs/curate/ecr-bundle-versions-faq.md b/vuepress/docs/next/docs/curate/local-hub-bundle-versions-faq.md similarity index 71% rename from vuepress/docs/next/docs/curate/ecr-bundle-versions-faq.md rename to vuepress/docs/next/docs/curate/local-hub-bundle-versions-faq.md index 1853c789fe..e1ac92149e 100644 --- a/vuepress/docs/next/docs/curate/ecr-bundle-versions-faq.md +++ b/vuepress/docs/next/docs/curate/local-hub-bundle-versions-faq.md @@ -1,8 +1,8 @@ # Bundle versions and updates - FAQ -## Does the ECR support versioning? -A bundle, as discussed in the [overview](../compose/ecr-overview.md), is a package containing one or more components. -As in many other packaging systems, the ECR supports bundle versioning, allowing developers to create and release improvements of their package over time. +## Does the Local Hub support versioning? +A bundle, as discussed in the [overview](../compose/local-hub-overview.md), is a package containing one or more components. +As in many other packaging systems, the Local Hub supports bundle versioning, allowing developers to create and release improvements of their package over time. ## How is a bundle version defined? @@ -29,11 +29,11 @@ spec: ``` As you can see from the code above, the bundle `cms-quickstart-bundle` has 2 versions available. -Each version in the `tags` object must correspond a tag in the git repository provided in the `tarball` field. +Each version in the `tags` object must correspond a tag in the Git repository provided in the `tarball` field. ## What format should I use to version my bundle? -The ECR requires versions to follow the [semantic versioning 2.0.0](https://semver.org/#semantic-versioning-200), with the possibility to prepend a `v` to the version itself. Some valid bundle versions are: +The Local Hub requires versions to follow the [semantic versioning 2.0.0](https://semver.org/#semantic-versioning-200), with the possibility to prepend a `v` to the version itself. Some valid bundle versions are: - 1.0 - v0.1.0-alpha @@ -42,8 +42,8 @@ The ECR requires versions to follow the [semantic versioning 2.0.0](https://semv ## As a bundle developer, how should I create a new version of a bundle? -If you're a bundle developer and you want to release a new version of your bundle, you can simply update the content of your bundle and commit the changes to the bundle git repository. -Once all the required changes are committed, you can create a new tag in the git repository using the `git tag` command and publish it to the remote repository using the `git push --tags` command +If you're a bundle developer and you want to release a new version of your bundle, you can simply update the content of your bundle and commit the changes to the bundle Git repository. +Once all the required changes are committed, you can create a new tag in the Git repository using the `git tag` command and publish it to the remote repository using the `git push --tags` command For example, let's assume my bundle already has a version `1.0.0` and I want to publish the version `2.0.0` of my bundle, here the commands I need to use to create and publish the new tag: @@ -72,6 +72,6 @@ This gives the bundle developer complete control over the bundle release process ## How bundle versions are installed from the ECR -When the user decides to install a version of the bundle, the ECR checks the provided tag in the git repository and clones locally just the content of the repository for that tag. +When the user decides to install a version of the bundle, the Local Hub checks the provided tag in the Git repository and clones locally just the content of the repository for that tag. -For this reason it's important that for each provided tag in the custom-resource a corresponding tag is available in the git repository, otherwise the ECR will not be able to donwload the bundle and will throw an error. Note that the ECR can only see published tags, so make sure that all the time you create a new tag in your git repository you publish it to the remote repository too. \ No newline at end of file +For this reason it's important that for each provided tag in the custom-resource a corresponding tag is available in the Git repository, otherwise the Local Hub will not be able to donwload the bundle and will throw an error. Note that the Local Hub can only see published tags, so make sure that all the time you create a new tag in your Git repository you publish it to the remote repository too. \ No newline at end of file diff --git a/vuepress/docs/next/docs/curate/ecr-how-microservices-connect-to-apps.md b/vuepress/docs/next/docs/curate/local-hub-how-microservices-connect-to-apps.md similarity index 97% rename from vuepress/docs/next/docs/curate/ecr-how-microservices-connect-to-apps.md rename to vuepress/docs/next/docs/curate/local-hub-how-microservices-connect-to-apps.md index 4a6699988d..ad5f89de55 100644 --- a/vuepress/docs/next/docs/curate/ecr-how-microservices-connect-to-apps.md +++ b/vuepress/docs/next/docs/curate/local-hub-how-microservices-connect-to-apps.md @@ -24,7 +24,7 @@ When a bundle containing a microservice is installed using the ECR, behind the s This is the standard flow when no other micorservice with a given name is already available in the EntandoApp namespace. -If there is an existing microservice with the same name as the one generated from the PluginDescriptor, the ECR will connect the EntandoApp to +If there is an existing microservice with the same name as the one generated from the PluginDescriptor, the Local Hub will connect the EntandoApp to the existing microservice by generating and deploying the required EntandoAppPluginLink per step 3 above. This way, plugins can be reused by many applications at the same time. diff --git a/vuepress/docs/next/docs/curate/ecr-troubleshooting-guide.md b/vuepress/docs/next/docs/curate/local-hub-troubleshooting-guide.md similarity index 100% rename from vuepress/docs/next/docs/curate/ecr-troubleshooting-guide.md rename to vuepress/docs/next/docs/curate/local-hub-troubleshooting-guide.md diff --git a/vuepress/docs/next/docs/curate/ecr-uninstall-flow.md b/vuepress/docs/next/docs/curate/local-hub-uninstall-flow.md similarity index 77% rename from vuepress/docs/next/docs/curate/ecr-uninstall-flow.md rename to vuepress/docs/next/docs/curate/local-hub-uninstall-flow.md index cff8cbbae1..ef40a6af31 100644 --- a/vuepress/docs/next/docs/curate/ecr-uninstall-flow.md +++ b/vuepress/docs/next/docs/curate/local-hub-uninstall-flow.md @@ -2,7 +2,7 @@ An application bundle that is installed in the Entando App Builder, or from the Entando Hub, can be upgraded, downgraded or uninstalled at any time. You can upgrade the bundle or just a component within that bundle, all within the App Builder. ## Upgrade or Downgrade Bundle Version -From Entando App Builder's **Component Repository**, you can upgrade or downgrade the version of a bundle. +From Entando App Builder's **Local Hub**, you can upgrade or downgrade the version of a bundle. ![Uninstall flow](./img/uninstall-bundle.png) @@ -12,7 +12,7 @@ From Entando App Builder's **Component Repository**, you can upgrade or downgrad 4. Click `Ok` to finish. ## Uninstall a Bundle -1. From Entando App Builder Repository, click on the `Installed` button next to the bundle you want to uninstall. A pop-up window will open with the option to `Uninstall`. +1. From Entando App Builder's **Local Hub**, click on the `Installed` button next to the bundle you want to uninstall. A pop-up window will open with the option to `Uninstall`. 2. An initial check is made to verify that none of the bundle components are in use. If they are in use, a pop-up shows a warning and you must unpublish the content and remove the components. You can't force the removal of a bundle if any component is in use or linked. Each component needs to be uninstalled, and references to it removed, in order for the bundle uninstall to complete. @@ -22,12 +22,12 @@ If they are in use, a pop-up shows a warning and you must unpublish the content - Bundle resources are deleted from the Entando App Engine - Components included in the bundle are removed from the Entando App Engine - Plugins are unlinked -4. To remove the bundle from the Repository catalog, click the `Undeploy` button. +4. To remove the bundle from the Local Hub catalog, click the `Undeploy` button. ## Troubleshooting If an error occurs during the uninstall process, -check out the [Troubleshooting guide](./ecr-troubleshooting-guide.md) or the [Entando Forum](https://forum.entando.org). +check out the [Troubleshooting guide](./local-hub-troubleshooting-guide.md) or the [Entando Forum](https://forum.entando.org). diff --git a/vuepress/docs/next/docs/getting-started/concepts-overview.md b/vuepress/docs/next/docs/getting-started/concepts-overview.md index abd51bab74..5ee776494c 100644 --- a/vuepress/docs/next/docs/getting-started/concepts-overview.md +++ b/vuepress/docs/next/docs/getting-started/concepts-overview.md @@ -9,7 +9,7 @@ This document explores the architecture of the platform and some notable runtime - [Entando App Engine](#entando-app-engine) - [Entando App Builder](#entando-app-builder) - [Entando Component Generator](#entando-component-generator) -- [Entando Component Repository (ECR)](#entando-component-repository) +- [Local Hub](#local-hub) - [Entando Identity Management](#entando-identity-management) - [Entando WCMS](#entando-wcms) - [Entando Cluster Citizens](#entando-cluster-citizens) @@ -43,8 +43,8 @@ The generated skeleton serves as a starting point to help a development team swi See also: [Entando JHipster Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) -## Entando Component Repository -The [Entando Component Repository](../compose/ecr-overview.md) is used to store and retrieve shareable components so they can be used in multiple +## Local Hub +The [Local Hub](../compose/local-hub-overview.md) is used to store and retrieve shareable components so they can be used in multiple Entando applications across an enterprise. ## Entando Identity Management @@ -82,7 +82,7 @@ The EntandoApp is composed of three parts: 2. **Entando App Engine**: the backend APIs providing access to services. -3. **Entando Component Manager (ECM)**: the service integrating the ECR into the App Builder providing bundle management for deploying and versioning components. +3. **Entando Component Manager (ECM)**: the service integrating the Local Hub into the App Builder providing bundle management for deploying and versioning components. The interaction between these three components, and the rest of the cluster, use the authorization/authentication features provided by Keycloak. @@ -99,7 +99,7 @@ the custom resources defined by Entando, in particular: - Entando Applications - Entando plugins - Entando links -- Entando Component Repository bundles +- Local Hub bundles Some of the main services provided by the Entando Kubernetes service are: @@ -112,12 +112,12 @@ are: #### EntandoDeBundle -An EntandoDeBundle - or Component Repository bundle - is a package with +An EntandoDeBundle - or Local Hub bundle - is a package with a set of Entando components and resources. The ECM can identify the packages and install the components to extend the functionality of an EntandoApp. For more details on the -EntandoDeBundle and the Entando Component Repository, check the -[Component Repository Overview](../compose/ecr-overview.md). +EntandoDeBundle and the Local Hub, check the +[Local Hub Overview](../compose/local-hub-overview.md). #### Entando Plugin diff --git a/vuepress/docs/next/docs/getting-started/ent-bundle.md b/vuepress/docs/next/docs/getting-started/ent-bundle.md index 03de1c5ef1..295eaec2f6 100644 --- a/vuepress/docs/next/docs/getting-started/ent-bundle.md +++ b/vuepress/docs/next/docs/getting-started/ent-bundle.md @@ -12,7 +12,7 @@ This document covers `ent bundle` operations and the steps required to create an 3. [Run](#run) 4. [Package](#package) 5. [Publish](#publish) -6. [ECR Deploy](#ecr-commands) +6. [Deploy](#local-hub-commands) ### Bundle Development Overview A single JSON descriptor file works as the manifest for an Entando project to be converted into a reusable bundle. The process starts with the initialization step which @@ -98,8 +98,8 @@ See [Build and Publish a Project Bundle](../../tutorials/create/pb/publish-proje |`ent bundle publish --org [organization]`|Publish Docker images to the Docker registry, with a specified organization | |`ent bundle publish --registry [registry]`| Publish the Docker images to your Docker registry| -## ECR Commands -Entando provides a series of `ent ecr` commands for managing bundle interactions with [the Entando Component Repository](../../docs/compose/ecr-overview.md) (ECR). +## Local Hub Commands +Entando provides a series of `ent ecr` commands for managing bundle interactions with the [Local Hub](../../docs/compose/local-hub-overview.md). | Command| Descriptions |:--|:-- diff --git a/vuepress/docs/next/docs/getting-started/entando-cli.md b/vuepress/docs/next/docs/getting-started/entando-cli.md index 73a927f303..2dec5fbdd0 100644 --- a/vuepress/docs/next/docs/getting-started/entando-cli.md +++ b/vuepress/docs/next/docs/getting-started/entando-cli.md @@ -53,7 +53,7 @@ Use `ent [command] --help` to see the details for each command. - check-env => Checks the environment for required dependencies and settings - diag => Runs diagnostics and aggregates the related info in a .tgz file - ent => Helper for managing the local ent installations - - ecr => Helper for managing the ECR + - ecr => Helper for managing the Local Hub - help => Help information - jhipster => wrapper for the ent installation of JHipster - kubectl => Helper for using kubectl in ent managed scenarios diff --git a/vuepress/docs/next/docs/reference/deployment-structure.md b/vuepress/docs/next/docs/reference/deployment-structure.md index cf039913a7..55273c3000 100644 --- a/vuepress/docs/next/docs/reference/deployment-structure.md +++ b/vuepress/docs/next/docs/reference/deployment-structure.md @@ -23,7 +23,7 @@ During installation, an Entando Application needs to create and initialize sever * GitHub: * DockerHub: -The screenshot below highlights the init containers for the Entando Application schema creation, DB initialization, and component repository database. +The screenshot below highlights the init containers for the Entando Application schema creation, DB initialization, and Local Hub database. ![Init Containers Screenshot](./img/init-containers-screenshot.png) @@ -59,7 +59,7 @@ integrations, extensions to the CMS, and migrations from earlier Entando version ## App Builder The App Builder is the user-friendly frontend UI for the **entando-de-app**. A ReactJS application, it is served via node in the default deployment. In a quickstart deployment, the App Builder container is deployed in the **entando-app** multi-container pod. It communicates with the **entando-de-app** and the Entando Component Manager (ECM) via [REST -APIs](../consume/entando-apis.md). The ECM provides information about bundles deployed to the Entando Component Repository (ECR). +APIs](../consume/entando-apis.md). The ECM provides information about bundles deployed to the Local Hub. * GitHub: * DockerHub: diff --git a/vuepress/docs/next/tutorials/README.md b/vuepress/docs/next/tutorials/README.md index 4627625c5b..e0ccb0a486 100644 --- a/vuepress/docs/next/tutorials/README.md +++ b/vuepress/docs/next/tutorials/README.md @@ -47,7 +47,7 @@ table th:nth-of-type(3) { | Basic | Intermediate | Advanced | :-: | :-: | :-: -| [Set Up Entando on a Local Kubernetes Cluster](../docs/getting-started/) | [Backing Up and Restoring Your Entando Environment](./devops/backing-up-and-restoring-your-environment.md) | [Install Bundle Microservices from a Private Registry](./curate/ecr-private-images.md) | +| [Set Up Entando on a Local Kubernetes Cluster](../docs/getting-started/) | [Backing Up and Restoring Your Entando Environment](./devops/backing-up-and-restoring-your-environment.md) | [Install Bundle Microservices from a Private Registry](./curate/local-hub-private-images.md) | | [Set Up Entando on Amazon Elastic Kubernetes Service (EKS)](./getting-started/eks-install.md) | [Customize the base Entando Application via a Docker Image](./devops/build-core-image.md) |[Add a GitHub Actions CI Workflow](./create/pb/github-actions-workflow.md)| | [Set Up Entando on Azure Kubernetes Service (AKS)](./getting-started/azure-install.md) |[Connect Your Entando Application to an External Database](./devops/external-db.md) | [Manage NGINX](./devops/manage-nginx.md) | [Set Up Entando on Google Kubernetes Engine (GKE)](./getting-started/gke-install.md) | [Install the Standard Demo Application](./solution/install-standard-demo.md)| [Setup Plugin Profiles](./devops/plugin-configuration.md) diff --git a/vuepress/docs/next/tutorials/create/mfe/angular.md b/vuepress/docs/next/tutorials/create/mfe/angular.md index ba3eeea127..116dcc34ca 100644 --- a/vuepress/docs/next/tutorials/create/mfe/angular.md +++ b/vuepress/docs/next/tutorials/create/mfe/angular.md @@ -243,7 +243,7 @@ Now we're ready to host our micro frontend in Entando. - `runtime-es2015.js` ::: warning Additional Deployment Options -1. Install the micro frontend from a bundle in the `Entando Component Repository`. +1. Install the micro frontend from a bundle in the `Local Hub`. 2. Add the micro frontend to `Entando App Builder`. 3. Load the micro frontend from an API. ::: diff --git a/vuepress/docs/next/tutorials/create/ms/add-access-controls.md b/vuepress/docs/next/tutorials/create/ms/add-access-controls.md index 6154474a88..cae067358a 100644 --- a/vuepress/docs/next/tutorials/create/ms/add-access-controls.md +++ b/vuepress/docs/next/tutorials/create/ms/add-access-controls.md @@ -177,7 +177,7 @@ See the [Spring Security page](https://www.baeldung.com/spring-security-check-us ### Local vs. Kubernetes Testing This tutorial leverages the `internal` client, which is configured in the microservice via the `application.yml`. Client roles are manually created and assigned in Keycloak. -In Kubernetes, Entando will automatically create client roles per the bundle plugin definition (see the [plugin definition](../../../docs/curate/ecr-bundle-details.md) for more information). These roles are created for the client specific to the microservice, e.g. `-conference-server`. The client name is injected as an environment variable into the plugin container, so the annotations noted above will work in both local and Kubernetes environments. +In Kubernetes, Entando will automatically create client roles per the bundle plugin definition (see the [plugin definition](../../../docs/curate/local-hub-bundle-details.md) for more information). These roles are created for the client specific to the microservice, e.g. `-conference-server`. The client name is injected as an environment variable into the plugin container, so the annotations noted above will work in both local and Kubernetes environments. #### Modify Security Checks for Kubernetes diff --git a/vuepress/docs/next/tutorials/create/ms/generate-microservices-and-micro-frontends.md b/vuepress/docs/next/tutorials/create/ms/generate-microservices-and-micro-frontends.md index 532ade2005..b1a73b29d9 100644 --- a/vuepress/docs/next/tutorials/create/ms/generate-microservices-and-micro-frontends.md +++ b/vuepress/docs/next/tutorials/create/ms/generate-microservices-and-micro-frontends.md @@ -6,7 +6,7 @@ sidebarDepth: 2 ## Overview -This tutorial describes how to use the Entando Component Generator (ECG) to create microservices and micro frontends for deployment to the [Entando Component Repository](../../../docs/compose/ecr-overview.md) and Entando Applications. The ECG is powered by [JHipster](https://www.jhipster.tech/) and leverages the Entando Blueprint. +This tutorial describes how to use the Entando Component Generator (ECG) to create microservices and micro frontends for deployment to the [Entando Component Repository](../../../docs/compose/local-hub-overview.md) and Entando Applications. The ECG is powered by [JHipster](https://www.jhipster.tech/) and leverages the Entando Blueprint. ![Entando Component Generator](./img/component-gen-flow.png) diff --git a/vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md b/vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md index a6fc4c9d91..f51ddf7761 100644 --- a/vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md +++ b/vuepress/docs/next/tutorials/create/pb/publish-project-bundle.md @@ -3,7 +3,7 @@ sidebarDepth: 2 --- # Build and Publish a Project Bundle ## Overview -This tutorial demonstrates how to deploy an existing Entando project directory into the [Entando Component Repository](../../../docs/getting-started/concepts-overview.md#entando-component-repository) (ECR). This involves building a Docker image from your microservice, creating an Entando Bundle, checking your Bundle artifacts into Git, and deploying the Bundle into Kubernetes. +This tutorial demonstrates how to deploy an existing Entando project directory into the [Local Hub](../../../docs/getting-started/concepts-overview.md#local-hub). This involves building a Docker image from your microservice, creating an Entando Bundle, checking your Bundle artifacts into Git, and deploying the Bundle into Kubernetes. The Entando CLI (ent) automates many of the tasks involved in deploying an Entando Bundle, but you can also choose to perform these tasks manually. @@ -157,7 +157,7 @@ ent prj install --conflict-strategy=OVERRIDE > In the event of a timeout or pod failure, refer to the errors captured by the quickstart-cm-deployment and plugin deployer logs. ## Use the App Builder -1. Log into your App Builder and select `Repository` in the lower left +1. Log into your App Builder and select `Hub` 2. Find your bundle and select `Install` diff --git a/vuepress/docs/next/tutorials/curate/ecr-private-git-repo.md b/vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md similarity index 90% rename from vuepress/docs/next/tutorials/curate/ecr-private-git-repo.md rename to vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md index 2a2255ba18..935c03d4b0 100644 --- a/vuepress/docs/next/tutorials/curate/ecr-private-git-repo.md +++ b/vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md @@ -2,11 +2,11 @@ # Install Bundles from a Private Git Repository ## Overview -The standard deployment of the Entando Component Repository (ECR) assumes that bundles are checked out from public Git repositories. Public repositories do not require user authentication, but if a customer chooses to limit repository access to specific Git accounts, a private key is required. This document details how to allow the ECR to access a private Git repository. +The standard deployment of the Local Hub assumes that bundles are checked out from public Git repositories. Public repositories do not require user authentication, but if a customer chooses to limit repository access to specific Git accounts, a private key is required. This document details how to allow the Local Hub to access a private Git repository. For more background information please consult 1. [Entando custom resource reference](../../docs/consume/custom-resources.md) -2. [Entando Component Repository overview](../../docs/compose/ecr-overview.md) +2. [Local Hub overview](../../docs/compose/local-hub-overview.md) ## Using SSH keys with Git Entando supports connecting to Git repositories with SSH keys. While SSH Git URLs are accepted, HTTPS git URLs are not. For the private key to work correctly, the SSH syntax of `git@github.com:THE-REPO-OWNER-NAME/THE-REPO-NAME.git` must be used (the HTTPS syntax of `https://github.com/THE-REPO-OWNER-NAME/THE-REPO-NAME.git` is not permitted). diff --git a/vuepress/docs/next/tutorials/curate/ecr-private-images.md b/vuepress/docs/next/tutorials/curate/local-hub-private-images.md similarity index 85% rename from vuepress/docs/next/tutorials/curate/ecr-private-images.md rename to vuepress/docs/next/tutorials/curate/local-hub-private-images.md index 91d5b9c554..1ce41bc529 100644 --- a/vuepress/docs/next/tutorials/curate/ecr-private-images.md +++ b/vuepress/docs/next/tutorials/curate/local-hub-private-images.md @@ -5,7 +5,7 @@ sidebarDepth: 2 # Install Bundle Plugins from a Private Image Repository ## Overview -The standard deployment of the Entando Component Repository assumes that plugin images are pulled from public repositories. Public repositores do not require user authentication in order to pull an image. The following tutorial will show you how to add secrets to your Kubernetes environment so you can successfully pull images from private repositories. +The standard deployment of the Local Hub assumes that plugin images are pulled from public repositories. Public repositores do not require user authentication in order to pull an image. The following tutorial will show you how to add secrets to your Kubernetes environment so you can successfully pull images from private repositories. ## Prerequisites * A running Entando application @@ -67,7 +67,7 @@ If `(not found)` is listed next to the Secret name, then you may have added the **3. Install the Entando Bundle** - You can now install Entando Bundles from the `Entando App Builder` → `Entando Component Repository`. The microservice plugin should now be able to successfully pull the image. + You can now install Entando Bundles from the `Entando App Builder` → `Hub`. The microservice plugin should now be able to successfully pull the image. ## Troubleshooting You may see an `ErrImagePull` status in `kubectl get pods` if a plugin is based on an image from a private repository and if there are any issues with the image URL or credentials, including a missing or incorrect Secret. \ No newline at end of file diff --git a/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md b/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md index 189451bbf4..830bb8975a 100644 --- a/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md +++ b/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md @@ -38,7 +38,7 @@ Restoring a backup requires creating and then deploying a custom image of an Ent backup files included. ### Build the Custom Image -1. Clone the Entando Application repository +1. Clone the Entando Application Local Hub ```sh git clone https://github.com/entando/entando-de-app ``` diff --git a/vuepress/docs/next/tutorials/devops/build-core-image.md b/vuepress/docs/next/tutorials/devops/build-core-image.md index fb39b34039..5706ed7e66 100644 --- a/vuepress/docs/next/tutorials/devops/build-core-image.md +++ b/vuepress/docs/next/tutorials/devops/build-core-image.md @@ -10,7 +10,7 @@ - maven -- Access to a docker repository (docker.io or other) +- Access to a Docker repository (docker.io or other) ## Introduction @@ -37,7 +37,7 @@ additional commands and configuration can be found here: docker build . -f Dockerfile.wildfly -t /: -4. Create a repository on your docker repository to house your new +4. Create a repository on your Docker repository to store your new application 5. Push the Image to your Repository diff --git a/vuepress/docs/next/tutorials/devops/external-db.md b/vuepress/docs/next/tutorials/devops/external-db.md index 430126b4f5..a10060a2f3 100644 --- a/vuepress/docs/next/tutorials/devops/external-db.md +++ b/vuepress/docs/next/tutorials/devops/external-db.md @@ -23,7 +23,7 @@ backup workflow to scale with your application. 1. Create and install a secret or secrets for your database credentials 2. Edit the EntandoApp and EntandoKeycloakServer custom resources. 3. Set the value for `dbms` to `none` in both resources. -4. Under `environmentVariables`, you will need to provide database connection information for two Entando server databases and one connection for the Entando Component Repository. Example connection information for each of those databases is provided below: +4. Under `environmentVariables`, you will need to provide database connection information for two Entando server databases and one connection for the Local Hub. Example connection information for each of those databases is provided below: #### ECR ``` diff --git a/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md b/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md index 1f878554ec..6db43f66df 100644 --- a/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md +++ b/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md @@ -8,7 +8,7 @@ Below are the minimum infrastructure requirements to install Entando directly on - A default [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/) is needed for the Entando Operator to create the correct persistent volume claims (PVCs) for each pod. - NGINX [ingress controller](https://kubernetes.github.io/ingress-nginx/deploy/) is needed to expose the Entando Application. - To install bundles, the cluster containing the Entando Application must have access to the bundle repository (either public or private, often on GitHub) as well as the Docker image repository (e.g. DockerHub) for any microservices. -- Kubernetes Secrets are required to [install bundles from a private image repository](../curate/ecr-private-images.md), such as DockerHub. +- Kubernetes Secrets are required to [install bundles from a private image repository](../curate/local-hub-private-images.md), such as DockerHub. ## Minimum Hardware Requirements diff --git a/vuepress/docs/next/tutorials/solution/customer-portal.md b/vuepress/docs/next/tutorials/solution/customer-portal.md index 51ab0ee2a1..e40fb96324 100644 --- a/vuepress/docs/next/tutorials/solution/customer-portal.md +++ b/vuepress/docs/next/tutorials/solution/customer-portal.md @@ -27,7 +27,7 @@ This tutorial covers: ### Automatic Install via the Entando Hub Install the Customer Portal in two steps by integrating the Entando Hub into your App Builder. -1. Log into your `App Builder` → `Repository` → `Select Registry` → choose `Entando Hub` if it has been configured. +1. Log into your `App Builder` → `Hub` → `Select Registry` → choose `Entando Hub` if it has been configured. 1. If not, choose `New Registry` 2. In the pop-up window, enter `Entando Hub` and `https://entando.com/entando-hub-api/appbuilder/api` for the URL, then `Save` 3. Click on the Hub in the Registry @@ -61,7 +61,7 @@ ent ecr deploy --repo="https://github.com/entando-samples/customerportal-content ``` 2. Log into the App Builder. -3. Go to the `Repository` from the left sidebar. Two Customer Portal bundles will be visible there. `Install` the `customerportal-application-bundle` first, then the `customerportal-content-bundle`. +3. Go to the `Hub` from the left sidebar. Two Customer Portal bundles will be visible there. `Install` the `customerportal-application-bundle` first, then the `customerportal-content-bundle`. 4. To navigate to your CP: * From the sidebar → `Page` → `Management` diff --git a/vuepress/docs/next/tutorials/solution/entando-hub.md b/vuepress/docs/next/tutorials/solution/entando-hub.md index c267110977..30d22e03ae 100644 --- a/vuepress/docs/next/tutorials/solution/entando-hub.md +++ b/vuepress/docs/next/tutorials/solution/entando-hub.md @@ -22,7 +22,7 @@ This tutorial covers: 5. [Resources](#resources) ## Installation -The Hub is installed using the Entando Component Repository (ECR) and two Entando Bundles. The first bundle contains the Hub micro frontends and microservices, and the second sets up the initial content and pages for the Hub user experience. +The Hub is installed using the Local Hub and two Entando Bundles. The first bundle contains the Hub micro frontends and microservices, and the second sets up the initial content and pages for the Hub user experience. ### Prerequisites @@ -31,7 +31,7 @@ The Hub is installed using the Entando Component Repository (ECR) and two Entand ### Automatically Access the Hub from the App Builder 1. Login to your App Builder -2. Go to `Repository` → `Select Registry` +2. Go to `Hub` → `Select Registry` 3. Choose `New Registry` 4. In the pop-up window, enter `Entando Hub` and `https://entando.com/entando-hub-api/appbuilder/api` for the URL, then `Save` 5. Click on the Hub in the Registry and continue with the tutorial at Step 4 below @@ -49,7 +49,7 @@ ent ecr deploy --repo="https://github.com/entando-samples/entando-hub-content-bu 2. Log into your App Builder instance. -3. Select `Repository` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below. +3. Select `Hub` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below. ![install-bundles.png](./hub-images/install-bundles.png) @@ -79,13 +79,13 @@ The key entities in the Entando Hub are: - `Bundle Group`: A Bundle Group is a group of one or more Entando Bundles. - `Bundle Group Version`: A Bundle Group can have one or more versions, each with a particular status. -- `Bundle`: A Bundle is the deployment unit within an Entando Application. A Bundle can contain one or multiple components such as micro frontends, microservices, or any of the [component types](../../docs/curate/ecr-bundle-details.md) available in Entando. +- `Bundle`: A Bundle is the deployment unit within an Entando Application. A Bundle can contain one or multiple components such as micro frontends, microservices, or any of the [component types](../../docs/curate/local-hub-bundle-details.md) available in Entando. - `Category`: Each Bundle Group belongs to a specific category. The initial possible categories are Solution Template, Packaged Business Capability (PBC), or Component Collection. An admin of an Entando Hub can refine the available categories as desired. - `Organization`: Bundle Groups belong to a single organization. Authors and managers can only update Bundle Groups for their own organization. - `User`: User identity is managed within Keycloak, where users are granted roles within the Hub. Users must be assigned to a specific organization. Notes: -- A private repository can be used for a Bundle, but this requires [an additional Kubernetes secret](../curate/ecr-private-git-repo.md#overview) before deployment via the App Builder. +- A private repository can be used for a Bundle, but this requires [an additional Kubernetes secret](../curate/local-hub-private-git-repo.md#overview) before deployment via the App Builder. ### Roles diff --git a/vuepress/docs/next/tutorials/solution/install-standard-demo.md b/vuepress/docs/next/tutorials/solution/install-standard-demo.md index 5b25ef1726..49bdda5370 100644 --- a/vuepress/docs/next/tutorials/solution/install-standard-demo.md +++ b/vuepress/docs/next/tutorials/solution/install-standard-demo.md @@ -4,7 +4,7 @@ sidebarDepth: 2 # Entando Standard Banking Demo -This tutorial will guide you through installing a demo application using the Entando Component Repository (ECR) and a set of Entando +This tutorial will guide you through installing a demo application using the Local Hub and a set of Entando bundles. This solution template includes: - microservices @@ -31,7 +31,7 @@ There are numerous assets installed as part of the Standard Banking Demo. Entand ### Automatic Install via the Entando Hub Install the Standard Banking Demo by integrating the Entando Hub into your App Builder. -1. Log into your `App Builder` → `Repository` → `Select Registry` → choose `Entando Hub` if it has been configured. +1. Log into your `App Builder` → `Hub` → `Select Registry` → choose `Entando Hub` if it has been configured. 1. If not, choose `New Registry` 2. In the pop-up window, enter `Entando Hub` and https://entando.com/entando-hub-api/appbuilder/api for the URL, then `Save` 3. Click on the Hub in the Registry @@ -64,7 +64,7 @@ ent ecr deploy --repo="https://github.com/entando-samples/standard-demo-content- 2. Log into your App Builder instance. -3. Select `Repository` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below. +3. Select `Hub` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below. ![Repository.png](./images/Repository.png) 4. Select `Install` for each bundle, where order of installation is important. The `standard-demo-content-bundle` will need to be installed last, as it relies on MFEs from the other bundles to set up each of the pages. diff --git a/vuepress/docs/next/tutorials/solution/pda-tutorial.md b/vuepress/docs/next/tutorials/solution/pda-tutorial.md index bdf55042fd..3e26fa2ea8 100644 --- a/vuepress/docs/next/tutorials/solution/pda-tutorial.md +++ b/vuepress/docs/next/tutorials/solution/pda-tutorial.md @@ -11,7 +11,7 @@ The Entando Process Driven Applications (PDA) plugin is engineered to provide a - A general purpose UX layer created from micro frontends that can be implemented for any business process or task engine. The UX layer can serve data via the included Entando integration adapter or by implementing a set of interfaces on the server side. - A Spring Boot microservice backend providing a pluggable interface for the injection of underlying processes or automation toolkits. The interfaces and steps for creating a new PDA backend implementation are described in further detail [here](./pda-technical-guide.md). -The following tutorial installs the PDA plugin via the Entando Component Repository (ECR) and an Entando Bundle. It demonstrates the scope of process automation enabled by integrating: +The following tutorial installs the PDA plugin via the Local Hub and an Entando Bundle. It demonstrates the scope of process automation enabled by integrating: - Custom Micro Frontends (MFEs) - Backend for Frontend (BFF) microservice @@ -31,7 +31,7 @@ There are numerous assets installed as part of the Entando PDA plugin. Entando B ### Automatic Install via the Entando Hub -1. Log into your `App Builder` → `Repository` → `Select Registry` → choose `Entando Hub` if it has been configured. +1. Log into your `App Builder` → `Hub` → `Select Registry` → choose `Entando Hub` if it has been configured. 1. If not, choose `New Registry` 2. In the pop-up window, enter `Entando Hub` and https://entando.com/entando-hub-api/appbuilder/api for the URL, then `Save` 3. Click on the Hub in the Registry @@ -48,7 +48,7 @@ ent ecr deploy --repo="https://github.com/entando-samples/entando-process-driven 2. Log into your App Builder instance. -3. Select `Repository` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below. +3. Select `Hub` from the menu on the left. Your bundles will be visible in the repository as shown in the screenshot below. ![pda-install.png](./pda-images/pda-install.png) From a50a07bb1744d7edf10f7a4bd65d0ff5e500956a Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Mon, 29 Aug 2022 18:31:28 -0700 Subject: [PATCH 02/10] ENDOC-515 Fix images --- .../{local-hub.png => local-hub-architecture.png} | Bin ...-builder-local-hub-bundle-component-filters.png} | Bin ...app-builder-local-hub-bundle-status-filters.png} | Bin ...app-builder-local-hub-bundle-textual-search.png} | Bin 4 files changed, 0 insertions(+), 0 deletions(-) rename vuepress/docs/next/docs/compose/img/{local-hub.png => local-hub-architecture.png} (100%) rename vuepress/docs/next/docs/curate/img/{app-builder-ecr-bundle-component-filters.png => app-builder-local-hub-bundle-component-filters.png} (100%) rename vuepress/docs/next/docs/curate/img/{app-builder-ecr-bundle-status-filters.png => app-builder-local-hub-bundle-status-filters.png} (100%) rename vuepress/docs/next/docs/curate/img/{app-builder-ecr-bundle-textual-search.png => app-builder-local-hub-bundle-textual-search.png} (100%) diff --git a/vuepress/docs/next/docs/compose/img/local-hub.png b/vuepress/docs/next/docs/compose/img/local-hub-architecture.png similarity index 100% rename from vuepress/docs/next/docs/compose/img/local-hub.png rename to vuepress/docs/next/docs/compose/img/local-hub-architecture.png diff --git a/vuepress/docs/next/docs/curate/img/app-builder-ecr-bundle-component-filters.png b/vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-component-filters.png similarity index 100% rename from vuepress/docs/next/docs/curate/img/app-builder-ecr-bundle-component-filters.png rename to vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-component-filters.png diff --git a/vuepress/docs/next/docs/curate/img/app-builder-ecr-bundle-status-filters.png b/vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-status-filters.png similarity index 100% rename from vuepress/docs/next/docs/curate/img/app-builder-ecr-bundle-status-filters.png rename to vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-status-filters.png diff --git a/vuepress/docs/next/docs/curate/img/app-builder-ecr-bundle-textual-search.png b/vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-textual-search.png similarity index 100% rename from vuepress/docs/next/docs/curate/img/app-builder-ecr-bundle-textual-search.png rename to vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-textual-search.png From 8c37b0d722d901a0dfa3091cc54ea5f5cbd2f997 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Tue, 30 Aug 2022 18:06:12 -0700 Subject: [PATCH 03/10] ENDOC-515 Apply first round of PR feedback --- vuepress/docs/.vuepress/next.js | 18 ++++++------- .../docs/next/docs/compose/app-builder.md | 2 +- .../docs/next/docs/compose/ecm-overview.md | 4 +-- .../next/docs/compose/local-hub-overview.md | 12 +++------ .../docs/next/docs/consume/entandoapp-cr.md | 2 +- .../docs/create/component-gen-overview.md | 2 +- ...ub-bundle-details.md => bundle-details.md} | 0 ...ub-bundle-filters.md => bundle-filters.md} | 16 ++++++------ ...onfig.md => bundle-presentation-config.md} | 6 ++--- ...versions-faq.md => bundle-versions-faq.md} | 24 +++++++++--------- ...d => how-microservices-connect-to-apps.md} | 0 ... app-builder-bundle-component-filters.png} | Bin ... => app-builder-bundle-status-filters.png} | Bin ... => app-builder-bundle-textual-search.png} | Bin ...ting-guide.md => troubleshooting-guide.md} | 0 ...ub-uninstall-flow.md => uninstall-flow.md} | 0 .../docs/getting-started/concepts-overview.md | 8 +++--- .../next/docs/getting-started/ent-bundle.md | 6 ++--- .../next/docs/getting-started/entando-cli.md | 2 +- .../docs/reference/deployment-structure.md | 2 +- .../curate/local-hub-private-git-repo.md | 2 +- .../curate/local-hub-private-images.md | 22 ++++++++-------- ...cking-up-and-restoring-your-environment.md | 2 +- .../docs/next/tutorials/devops/external-db.md | 2 +- 24 files changed, 64 insertions(+), 68 deletions(-) rename vuepress/docs/next/docs/curate/{local-hub-bundle-details.md => bundle-details.md} (100%) rename vuepress/docs/next/docs/curate/{local-hub-bundle-filters.md => bundle-filters.md} (78%) rename vuepress/docs/next/docs/curate/{local-hub-bundle-presentation-config.md => bundle-presentation-config.md} (88%) rename vuepress/docs/next/docs/curate/{local-hub-bundle-versions-faq.md => bundle-versions-faq.md} (72%) rename vuepress/docs/next/docs/curate/{local-hub-how-microservices-connect-to-apps.md => how-microservices-connect-to-apps.md} (100%) rename vuepress/docs/next/docs/curate/img/{app-builder-local-hub-bundle-component-filters.png => app-builder-bundle-component-filters.png} (100%) rename vuepress/docs/next/docs/curate/img/{app-builder-local-hub-bundle-status-filters.png => app-builder-bundle-status-filters.png} (100%) rename vuepress/docs/next/docs/curate/img/{app-builder-local-hub-bundle-textual-search.png => app-builder-bundle-textual-search.png} (100%) rename vuepress/docs/next/docs/curate/{local-hub-troubleshooting-guide.md => troubleshooting-guide.md} (100%) rename vuepress/docs/next/docs/curate/{local-hub-uninstall-flow.md => uninstall-flow.md} (100%) diff --git a/vuepress/docs/.vuepress/next.js b/vuepress/docs/.vuepress/next.js index 78c4f7a4a5..fb7956ff22 100644 --- a/vuepress/docs/.vuepress/next.js +++ b/vuepress/docs/.vuepress/next.js @@ -79,31 +79,31 @@ module.exports = { children: [ { title: 'Bundle and Component Descriptors', - path: path + 'curate/local-hub-bundle-details.md' + path: path + 'curate/bundle-details.md' }, { title: 'Filtering Bundles', - path: path + 'curate/local-hub-bundle-filters.md' + path: path + 'curate/bundle-filters.md' }, { title: 'Customize Bundle Info in App Builder', - path: path + 'curate/local-hub-bundle-presentation-config.md' + path: path + 'curate/bundle-presentation-config.md' }, { title: 'Bundle Version and Updates - FAQ', - path: path + 'curate/local-hub-bundle-versions-faq.md' + path: path + 'curate/bundle-versions-faq.md' }, { title: 'How Microservices connect to Entando Apps', - path: path + 'curate/local-hub-how-microservices-connect-to-apps.md' + path: path + 'curate/how-microservices-connect-to-apps.md' }, { title: 'Bundle Upgrade, Downgrade, Uninstall', - path: path + 'curate/local-hub-uninstall-flow.md' + path: path + 'curate/uninstall-flow.md' }, { title: 'Troubleshooting ECR', - path: path + 'curate/local-hub-troubleshooting-guide.md' + path: path + 'curate/troubleshooting-guide.md' } ] }, @@ -358,8 +358,8 @@ module.exports = { { title: 'Curate and Share Applications', children: [ - path + 'curate/local-hub-private-git-repo.md', - path + 'curate/local-hub-private-images.md', + path + 'curate/private-git-repo.md', + path + 'curate/private-images.md', ] }, { diff --git a/vuepress/docs/next/docs/compose/app-builder.md b/vuepress/docs/next/docs/compose/app-builder.md index 6d6448e625..15d90b81ff 100644 --- a/vuepress/docs/next/docs/compose/app-builder.md +++ b/vuepress/docs/next/docs/compose/app-builder.md @@ -8,7 +8,7 @@ The Entando App Builder plays a key role in the composition of Entando Applicati ![app-builder](./img/app-builder.png) -The App Builder allows you to create pages and content, configure widgets and plugins, and interact with the [Local Hub](local-hub-overview.md). It also interfaces with the [Entando Hub](https://hub.entando.com), where you can share components and collaborate. +The App Builder allows you to create pages and content, configure widgets and plugins, and interact with the [Local Hub](local-hub-overview.md). It also interfaces with the [Entando Cloud Hub](https://hub.entando.com), where you can share components and collaborate. Pages are designed and embedded with functionality via drag-and-drop: diff --git a/vuepress/docs/next/docs/compose/ecm-overview.md b/vuepress/docs/next/docs/compose/ecm-overview.md index 3386ed31fe..a69a039823 100644 --- a/vuepress/docs/next/docs/compose/ecm-overview.md +++ b/vuepress/docs/next/docs/compose/ecm-overview.md @@ -15,8 +15,8 @@ The ECM communicates with the Kubernetes service to populate the Local Hub with ![ecm-flow.png](./img/ecm-flow.png) In the flow pictured above: -1. A user visits the Local Hub page in the App Builder -2. The Local Hub makes a REST call to the `digital-exchange` endpoint +1. A user visits the Hub page in the App Builder +2. The Hub makes a REST call to the `digital-exchange` endpoint 3. The Component Manager receives the `digital-exchange` request 4. The Component Manager calls the `k8s-service` to return the list of available `EntandoDeBundles` in the namespace diff --git a/vuepress/docs/next/docs/compose/local-hub-overview.md b/vuepress/docs/next/docs/compose/local-hub-overview.md index 8f9efd3ace..e57a4386bb 100644 --- a/vuepress/docs/next/docs/compose/local-hub-overview.md +++ b/vuepress/docs/next/docs/compose/local-hub-overview.md @@ -5,8 +5,7 @@ sidebarDepth: 2 ## Introduction -The Local Hub is a repository where -reusable components can be shared across applications and enterprises. +The Local Hub is a repository of modular components that can be reused within an Entando Application. The following examines some of the nuts and bolts of the Local Hub. @@ -17,12 +16,9 @@ code that can be used in an Entando widget, page or application. Examples of components are widgets, micro frontends, content types, labels, plugins, and static resources. -### Local Hub Bundle +### Entando Bundle -A Local Hub bundle is a package containing one or more components and a -descriptor.yaml file providing information about the bundle. The -bundle is published in a Git registry and shared with an Entando -Application using the EntandoDeBundle custom resource. +An Entanto Bundle is a package containing one or more components and descriptor files that provide information about the bundle. A git-based bundle requires a `descriptor.yaml` and is published in a Git registry. A docker-based bundle requires an `entando.json` and is published to Docker. Both git-based and docker-based bundles are shared with an Entando Application using the EntandoDeBundle custom resource. ### EntandoDeBundle Custom Resource @@ -55,7 +51,7 @@ and the K8s service. ### Example Flow -1. From the Local Hub page in the App Builder, the user finds the +1. From the Hub page in the App Builder, the user finds the list of bundles shared in that EntandoApp 2. App Builder requests a list of available bundles from the ECM diff --git a/vuepress/docs/next/docs/consume/entandoapp-cr.md b/vuepress/docs/next/docs/consume/entandoapp-cr.md index c41109efbb..2c67c04761 100644 --- a/vuepress/docs/next/docs/consume/entandoapp-cr.md +++ b/vuepress/docs/next/docs/consume/entandoapp-cr.md @@ -27,7 +27,7 @@ spec: | :- | :- | | `spec.customServerImage`| Used to deploy the Docker image containing your custom Entando App. Follow these instructions on how to [build your own image](../../tutorials/devops/build-core-image.md). This property and the `spec.standardServerImage` are mutually exclusive.| |`spec.dbms` | Allowed values are: MySQL, PostgreSQL (default), Oracle, or embedded. Oracle is only supported as an external database.| -|`spec.ecrGitSshSecretName`| The configuration used by the Local Hub to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| +|`spec.ecrGitSshSecretName`| The configuration used by the Entando Component Manager to download bundles from authenticated Git repositories. It's a Secret containing a private key file named `rsa_id` that matches a public key configured in the authenticated Git repository.| |`spec.environmentVariables`| A map of environment variables to pass to the EntandoApp Docker image. This can be used to provide connection details of custom datasources or message queues as discussed in the [custom datasources tutorial](../../tutorials/devops/change-default-datasource.md). These variables can sometimes be used as a mechanism to override any of the default environment variables that need customization.| |`spec.ingressPath`| Specifies the web context of the EntandoApp to be deployed. | |`spec.ingressHostName`| The hostname of the Kubernetes ingress to be created for the EntandoApp. EntandoPlugins linked to this app will also be made available on the host.| diff --git a/vuepress/docs/next/docs/create/component-gen-overview.md b/vuepress/docs/next/docs/create/component-gen-overview.md index dc36ab499c..d9af051769 100644 --- a/vuepress/docs/next/docs/create/component-gen-overview.md +++ b/vuepress/docs/next/docs/create/component-gen-overview.md @@ -41,4 +41,4 @@ This section provides an overview of the component generation process. If you wa - The bundles can be versioned and updated using tags in the Git repository 4. Install in Entando Apps - - Once the bundles are in the Local Hub they are available for deployment in any Entando application that has access to the Local Hub in the cluster + - Once the bundles are in the Local Hub they are available for deployment within the Entando Application diff --git a/vuepress/docs/next/docs/curate/local-hub-bundle-details.md b/vuepress/docs/next/docs/curate/bundle-details.md similarity index 100% rename from vuepress/docs/next/docs/curate/local-hub-bundle-details.md rename to vuepress/docs/next/docs/curate/bundle-details.md diff --git a/vuepress/docs/next/docs/curate/local-hub-bundle-filters.md b/vuepress/docs/next/docs/curate/bundle-filters.md similarity index 78% rename from vuepress/docs/next/docs/curate/local-hub-bundle-filters.md rename to vuepress/docs/next/docs/curate/bundle-filters.md index a4b3bf196b..0957a632c7 100644 --- a/vuepress/docs/next/docs/curate/local-hub-bundle-filters.md +++ b/vuepress/docs/next/docs/curate/bundle-filters.md @@ -1,12 +1,12 @@ # Filtering bundles -Local Hub bundles are filterable by component, by status or by textual research. +Entando Bundles are filterable by component, by status or by textual research. ## Filtering bundles by component -Local Hub bundles are filterable by component from App Builder user interface. +Entando Bundles are filterable by component from App Builder user interface. -![App Builder bundle filtering](./img/app-builder-local-hub-bundle-component-filters.png) +![App Builder bundle filtering](./img/app-builder-bundle-component-filters.png) Behind the scenes, filtering is done using the label-based filtering provided out of the box from Kubernetes. @@ -54,7 +54,7 @@ To enable filtering of a bundle, the custom-resource representing the bundle on ### Example -Here is an example of the metadata for a Local Hub bundle containg micro frontends, some microservices and page templates +Here is an example of the metadata for an Entando Bundle containg micro frontends, some microservices and page templates ``` apiVersion: entando.org/v1 @@ -72,18 +72,18 @@ spec: ## Filtering bundles by status -Local Hub bundles are filterable by status from App Builder user interface. +Entando Bundles are filterable by status from App Builder user interface. -![App Builder bundle filtering](./img/app-builder-local-hub-bundle-status-filters.png) +![App Builder bundle filtering](./img/app-builder-bundle-status-filters.png) -You can choose to see the full list of the bundles available in Kubernetes cluster by selecting the `Explore` tab, or the list of the currently installed bundles by clicking on the `Installed` tab. +You can choose to see the full list of the bundles available in the Kubernetes cluster by selecting the `Explore` tab, or the list of the currently installed bundles by clicking on the `Installed` tab. ## Filtering bundles by textual search You can search for bundles containing some keywords by executing a textual search. -![App Builder bundle filtering](./img/app-builder-local-hub-bundle-textual-search.png) +![App Builder bundle filtering](./img/app-builder-bundle-textual-search.png) You can open the menu on the left to select which field to target. diff --git a/vuepress/docs/next/docs/curate/local-hub-bundle-presentation-config.md b/vuepress/docs/next/docs/curate/bundle-presentation-config.md similarity index 88% rename from vuepress/docs/next/docs/curate/local-hub-bundle-presentation-config.md rename to vuepress/docs/next/docs/curate/bundle-presentation-config.md index 3b60d0eab6..c3e8afe1e0 100644 --- a/vuepress/docs/next/docs/curate/local-hub-bundle-presentation-config.md +++ b/vuepress/docs/next/docs/curate/bundle-presentation-config.md @@ -1,8 +1,8 @@ # How to customize bundle info shown in Entando App Builder -![Local Hub user interface in Entando App Builder](./img/local-hub-page.png) +![Hub user interface in Entando App Builder](./img/local-hub-page.png) -In the image above you can see an example of a bundle as is displayed in the Local Hub user interface inside the Entando App Builder. +In the image above you can see an example of a bundle as is displayed in the Hub user interface inside the Entando App Builder. The corresponding custom-resource file on Kubernetes is similar to this: @@ -32,7 +32,7 @@ spec: # .... ``` -In order to change the UI elements, you need to update the custom-resource in accordance with this table +In order to change the UI elements, you need to update the custom-resource in accordance with this table: | Field | UI Element | |---------------------------------|---------------------------------------------------------------------------| diff --git a/vuepress/docs/next/docs/curate/local-hub-bundle-versions-faq.md b/vuepress/docs/next/docs/curate/bundle-versions-faq.md similarity index 72% rename from vuepress/docs/next/docs/curate/local-hub-bundle-versions-faq.md rename to vuepress/docs/next/docs/curate/bundle-versions-faq.md index e1ac92149e..5f169c1c0d 100644 --- a/vuepress/docs/next/docs/curate/local-hub-bundle-versions-faq.md +++ b/vuepress/docs/next/docs/curate/bundle-versions-faq.md @@ -1,12 +1,12 @@ # Bundle versions and updates - FAQ -## Does the Local Hub support versioning? +## Does an Entando Bundle support versioning? A bundle, as discussed in the [overview](../compose/local-hub-overview.md), is a package containing one or more components. -As in many other packaging systems, the Local Hub supports bundle versioning, allowing developers to create and release improvements of their package over time. +As in many other packaging systems, an Entando Bundle supports versioning, allowing developers to create and release improvements of their package over time. ## How is a bundle version defined? -In the ECR, the bundle custom resource comes with a set of `tags`, each one representing a version of the bundle. +In the repository, the bundle custom resource comes with a set of `tags`, each one representing a version of the bundle. Here an example for a CMS quickstart bundle ``` apiVersion: entando.org/v1 @@ -33,7 +33,7 @@ Each version in the `tags` object must correspond a tag in the Git repository pr ## What format should I use to version my bundle? -The Local Hub requires versions to follow the [semantic versioning 2.0.0](https://semver.org/#semantic-versioning-200), with the possibility to prepend a `v` to the version itself. Some valid bundle versions are: +Entando requires versions to follow the [semantic versioning 2.0.0](https://semver.org/#semantic-versioning-200), with the possibility to prepend a `v` to the version itself. Some valid bundle versions are: - 1.0 - v0.1.0-alpha @@ -45,14 +45,14 @@ The Local Hub requires versions to follow the [semantic versioning 2.0.0](https: If you're a bundle developer and you want to release a new version of your bundle, you can simply update the content of your bundle and commit the changes to the bundle Git repository. Once all the required changes are committed, you can create a new tag in the Git repository using the `git tag` command and publish it to the remote repository using the `git push --tags` command -For example, let's assume my bundle already has a version `1.0.0` and I want to publish the version `2.0.0` of my bundle, here the commands I need to use to create and publish the new tag: +For example, let's assume my bundle already has a version `1.0.0` and I want to publish version `2.0.0` of my bundle; here the commands I need to use to create and publish the new tag: ``` git tag -a "2.0.0" -m "My new version" git push --tags ``` -## How to prevent a particular bundle version from being visible in the ECR? +## How to prevent a particular bundle version from being visible in the Local Hub? If, for some reason, you don't want a particular version to be available for the installation, you can proceed as follows: @@ -60,18 +60,18 @@ If, for some reason, you don't want a particular version to be available for the or if you still have the original file you can also: -1. remove the undesired version from the tag list in your bundle Kubernetes file (`integrity`, `shasum`, `tarball` and `version`) -2. delete your bundle from your cluster using a command like this `kubectl delete -f your-bundle-file.yml [-n your-cluster-namespace]` -3. upload your bundle again to Kubernetes using a command like this `kubectl create -f your-bundle-file.yml [-n your-cluster-namespace]` +1. Remove the undesired version from the tag list in your bundle Kubernetes file (`integrity`, `shasum`, `tarball` and `version`) +2. Delete your bundle from your cluster using a command like this `kubectl delete -f your-bundle-file.yml [-n your-cluster-namespace]` +3. Upload your bundle again to Kubernetes using a command like this `kubectl create -f your-bundle-file.yml [-n your-cluster-namespace]` ## My bundle contains a microservice generated with the Entando Component Generator, does the version of the microservice have to be the same as the bundle version? -The version of the microservice - or to be more precise the docker image associated with the microservice - isn't bound to the version of the bundle containing the microservice itself. +The version of the microservice - or to be more precise the Docker image associated with the microservice - isn't bound to the version of the bundle containing the microservice itself. This gives the bundle developer complete control over the bundle release process, especially in those situations where the bundle contains more components and even more microservices. -## How bundle versions are installed from the ECR +## How bundle versions are installed from the Local Hub -When the user decides to install a version of the bundle, the Local Hub checks the provided tag in the Git repository and clones locally just the content of the repository for that tag. +When the user decides to install a version of the bundle, the repository checks the provided tag in the Git repository and clones locally just the content of the repository for that tag. For this reason it's important that for each provided tag in the custom-resource a corresponding tag is available in the Git repository, otherwise the Local Hub will not be able to donwload the bundle and will throw an error. Note that the Local Hub can only see published tags, so make sure that all the time you create a new tag in your Git repository you publish it to the remote repository too. \ No newline at end of file diff --git a/vuepress/docs/next/docs/curate/local-hub-how-microservices-connect-to-apps.md b/vuepress/docs/next/docs/curate/how-microservices-connect-to-apps.md similarity index 100% rename from vuepress/docs/next/docs/curate/local-hub-how-microservices-connect-to-apps.md rename to vuepress/docs/next/docs/curate/how-microservices-connect-to-apps.md diff --git a/vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-component-filters.png b/vuepress/docs/next/docs/curate/img/app-builder-bundle-component-filters.png similarity index 100% rename from vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-component-filters.png rename to vuepress/docs/next/docs/curate/img/app-builder-bundle-component-filters.png diff --git a/vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-status-filters.png b/vuepress/docs/next/docs/curate/img/app-builder-bundle-status-filters.png similarity index 100% rename from vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-status-filters.png rename to vuepress/docs/next/docs/curate/img/app-builder-bundle-status-filters.png diff --git a/vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-textual-search.png b/vuepress/docs/next/docs/curate/img/app-builder-bundle-textual-search.png similarity index 100% rename from vuepress/docs/next/docs/curate/img/app-builder-local-hub-bundle-textual-search.png rename to vuepress/docs/next/docs/curate/img/app-builder-bundle-textual-search.png diff --git a/vuepress/docs/next/docs/curate/local-hub-troubleshooting-guide.md b/vuepress/docs/next/docs/curate/troubleshooting-guide.md similarity index 100% rename from vuepress/docs/next/docs/curate/local-hub-troubleshooting-guide.md rename to vuepress/docs/next/docs/curate/troubleshooting-guide.md diff --git a/vuepress/docs/next/docs/curate/local-hub-uninstall-flow.md b/vuepress/docs/next/docs/curate/uninstall-flow.md similarity index 100% rename from vuepress/docs/next/docs/curate/local-hub-uninstall-flow.md rename to vuepress/docs/next/docs/curate/uninstall-flow.md diff --git a/vuepress/docs/next/docs/getting-started/concepts-overview.md b/vuepress/docs/next/docs/getting-started/concepts-overview.md index 5ee776494c..1d43631f87 100644 --- a/vuepress/docs/next/docs/getting-started/concepts-overview.md +++ b/vuepress/docs/next/docs/getting-started/concepts-overview.md @@ -44,8 +44,8 @@ The generated skeleton serves as a starting point to help a development team swi See also: [Entando JHipster Blueprint](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) ## Local Hub -The [Local Hub](../compose/local-hub-overview.md) is used to store and retrieve shareable components so they can be used in multiple -Entando applications across an enterprise. +The [Local Hub](../compose/local-hub-overview.md) is used to store and retrieve shareable components so they can be reused within an +Entando Application. ## Entando Identity Management [Entando Identity Management](../consume/identity-management.md) is the [Keycloak-](https://www.keycloak.org/) and token-based authentication mechanism used by the @@ -112,11 +112,11 @@ are: #### EntandoDeBundle -An EntandoDeBundle - or Local Hub bundle - is a package with +An EntandoDeBundle - or Entando Bundle - is a package with a set of Entando components and resources. The ECM can identify the packages and install the components to extend the functionality of an EntandoApp. For more details on the -EntandoDeBundle and the Local Hub, check the +EntandoDeBundle and the Local Hub, check out the [Local Hub Overview](../compose/local-hub-overview.md). #### Entando Plugin diff --git a/vuepress/docs/next/docs/getting-started/ent-bundle.md b/vuepress/docs/next/docs/getting-started/ent-bundle.md index 295eaec2f6..94d33b6f68 100644 --- a/vuepress/docs/next/docs/getting-started/ent-bundle.md +++ b/vuepress/docs/next/docs/getting-started/ent-bundle.md @@ -12,7 +12,7 @@ This document covers `ent bundle` operations and the steps required to create an 3. [Run](#run) 4. [Package](#package) 5. [Publish](#publish) -6. [Deploy](#local-hub-commands) +6. [Deploy](#ecr-commands) ### Bundle Development Overview A single JSON descriptor file works as the manifest for an Entando project to be converted into a reusable bundle. The process starts with the initialization step which @@ -98,8 +98,8 @@ See [Build and Publish a Project Bundle](../../tutorials/create/pb/publish-proje |`ent bundle publish --org [organization]`|Publish Docker images to the Docker registry, with a specified organization | |`ent bundle publish --registry [registry]`| Publish the Docker images to your Docker registry| -## Local Hub Commands -Entando provides a series of `ent ecr` commands for managing bundle interactions with the [Local Hub](../../docs/compose/local-hub-overview.md). +## ECR Commands +Entando provides a series of `ent ecr` commands for managing bundle interactions with the [Local Hub](../../docs/compose/local-hub-overview.md). | Command| Descriptions |:--|:-- diff --git a/vuepress/docs/next/docs/getting-started/entando-cli.md b/vuepress/docs/next/docs/getting-started/entando-cli.md index 2dec5fbdd0..73a927f303 100644 --- a/vuepress/docs/next/docs/getting-started/entando-cli.md +++ b/vuepress/docs/next/docs/getting-started/entando-cli.md @@ -53,7 +53,7 @@ Use `ent [command] --help` to see the details for each command. - check-env => Checks the environment for required dependencies and settings - diag => Runs diagnostics and aggregates the related info in a .tgz file - ent => Helper for managing the local ent installations - - ecr => Helper for managing the Local Hub + - ecr => Helper for managing the ECR - help => Help information - jhipster => wrapper for the ent installation of JHipster - kubectl => Helper for using kubectl in ent managed scenarios diff --git a/vuepress/docs/next/docs/reference/deployment-structure.md b/vuepress/docs/next/docs/reference/deployment-structure.md index 55273c3000..aa4e07e57e 100644 --- a/vuepress/docs/next/docs/reference/deployment-structure.md +++ b/vuepress/docs/next/docs/reference/deployment-structure.md @@ -23,7 +23,7 @@ During installation, an Entando Application needs to create and initialize sever * GitHub: * DockerHub: -The screenshot below highlights the init containers for the Entando Application schema creation, DB initialization, and Local Hub database. +The screenshot below highlights the init containers for the Entando Application schema creation, DB initialization, and component repository database. ![Init Containers Screenshot](./img/init-containers-screenshot.png) diff --git a/vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md b/vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md index 935c03d4b0..6d5b2e0f39 100644 --- a/vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md +++ b/vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md @@ -2,7 +2,7 @@ # Install Bundles from a Private Git Repository ## Overview -The standard deployment of the Local Hub assumes that bundles are checked out from public Git repositories. Public repositories do not require user authentication, but if a customer chooses to limit repository access to specific Git accounts, a private key is required. This document details how to allow the Local Hub to access a private Git repository. +The standard deployment of Entando assumes that bundles are checked out from public Git repositories. Public repositories do not require user authentication, but a private key is required if a customer chooses to limit repository access to specific Git accounts. This document details how to allow Entando to access a private Git repository. For more background information please consult 1. [Entando custom resource reference](../../docs/consume/custom-resources.md) diff --git a/vuepress/docs/next/tutorials/curate/local-hub-private-images.md b/vuepress/docs/next/tutorials/curate/local-hub-private-images.md index 1ce41bc529..88174df914 100644 --- a/vuepress/docs/next/tutorials/curate/local-hub-private-images.md +++ b/vuepress/docs/next/tutorials/curate/local-hub-private-images.md @@ -5,21 +5,21 @@ sidebarDepth: 2 # Install Bundle Plugins from a Private Image Repository ## Overview -The standard deployment of the Local Hub assumes that plugin images are pulled from public repositories. Public repositores do not require user authentication in order to pull an image. The following tutorial will show you how to add secrets to your Kubernetes environment so you can successfully pull images from private repositories. +The standard deployment of Entando assumes that plugin images are pulled from public repositories. Public repositores do not require user authentication in order to pull an image. The following tutorial will show you how to add Secrets to your Kubernetes environment so you can successfully pull images from private repositories. ## Prerequisites -* A running Entando application +* A running Entando Application * A bundle containing a microservice plugin based on an image from a private repository. You can set this up by [creating a microservice bundle](../create/ms/generate-microservices-and-micro-frontends.md) and making the corresponding Docker Hub repository private. ## Tutorial -The first step demonstrates how to create a Secret for Docker Hub but please see the [corresponding Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry) for other options. +The first step demonstrates how to create a Secret for Docker Hub. See the [corresponding Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry) for other options. **1. Create the secret** Supply the following parameters: -* the name of the new Secret, e.g. `my-docker-secret`. -* the URL to your registry server. For Docker Hub this is currently -* your Docker Hub username, password, and email. -* the Entando namespace, e.g. `entando` for a quickstart environment. +* The name of the new Secret, e.g. `my-docker-secret` +* The URL to your registry server. For Docker Hub, this is currently +* Your Docker Hub username, password, and email. +* The Entando namespace, e.g. `entando` for a quickstart environment ``` sh kubectl create secret docker-registry YOUR-SECRET-NAME --docker-server=YOUR-REGISTRY-SERVER --docker-username=YOUR-USERNAME --docker-password=YOUR-PASSWORD --docker-email=YOUR-EMAIL -n entando @@ -27,7 +27,7 @@ kubectl create secret docker-registry YOUR-SECRET-NAME --docker-server=YOUR-REGI **2b. Deploy a new Entando Application** -If you're setting up a new Entando Application, you can [add the secret to the Entando Operator ConfigMap](../devops/entando-operator.md) under the property `entando.k8s.operator.image.pull.secrets`. This is just a list containing the names of Docker Secrets in the operator's namespace. +If you're setting up a new Entando Application, you can [add the Secret to the Entando Operator ConfigMap](../devops/entando-operator.md) under the property `entando.k8s.operator.image.pull.secrets`. This is just a list containing the names of Docker Secrets in the operator's namespace. ``` yaml data: @@ -42,7 +42,7 @@ If you're updating an existing Entando Application, you can add the new Secret t kubectl edit serviceaccount entando-plugin -n entando ``` -Add the secret to the serviceaccount. You can either add a new section if it's the first Secret or add another Secret to the list. +Add the Secret to the serviceaccount. You can either add a new section if it's the first Secret or add another Secret to the list. ``` yaml apiVersion: v1 imagePullSecrets: @@ -67,7 +67,7 @@ If `(not found)` is listed next to the Secret name, then you may have added the **3. Install the Entando Bundle** - You can now install Entando Bundles from the `Entando App Builder` → `Hub`. The microservice plugin should now be able to successfully pull the image. + You can now install Entando Bundles from the `Entando App Builder` → `Hub`. The microservice plugin should be able to successfully pull the image. ## Troubleshooting -You may see an `ErrImagePull` status in `kubectl get pods` if a plugin is based on an image from a private repository and if there are any issues with the image URL or credentials, including a missing or incorrect Secret. \ No newline at end of file +You may see an `ErrImagePull` status in `kubectl get pods` if a plugin is based on an image from a private repository and there are issues with the image URL or credentials, including a missing or incorrect Secret. \ No newline at end of file diff --git a/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md b/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md index 830bb8975a..189451bbf4 100644 --- a/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md +++ b/vuepress/docs/next/tutorials/devops/backing-up-and-restoring-your-environment.md @@ -38,7 +38,7 @@ Restoring a backup requires creating and then deploying a custom image of an Ent backup files included. ### Build the Custom Image -1. Clone the Entando Application Local Hub +1. Clone the Entando Application repository ```sh git clone https://github.com/entando/entando-de-app ``` diff --git a/vuepress/docs/next/tutorials/devops/external-db.md b/vuepress/docs/next/tutorials/devops/external-db.md index a10060a2f3..430126b4f5 100644 --- a/vuepress/docs/next/tutorials/devops/external-db.md +++ b/vuepress/docs/next/tutorials/devops/external-db.md @@ -23,7 +23,7 @@ backup workflow to scale with your application. 1. Create and install a secret or secrets for your database credentials 2. Edit the EntandoApp and EntandoKeycloakServer custom resources. 3. Set the value for `dbms` to `none` in both resources. -4. Under `environmentVariables`, you will need to provide database connection information for two Entando server databases and one connection for the Local Hub. Example connection information for each of those databases is provided below: +4. Under `environmentVariables`, you will need to provide database connection information for two Entando server databases and one connection for the Entando Component Repository. Example connection information for each of those databases is provided below: #### ECR ``` From ec270779a8c4dc3f1ea2610e5bc78a3c993c06e2 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Tue, 30 Aug 2022 18:16:52 -0700 Subject: [PATCH 04/10] ENDOC-515 Fix links --- vuepress/docs/next/docs/README.md | 10 +++++----- vuepress/docs/next/docs/create/component-gen-tech.md | 2 +- vuepress/docs/next/docs/curate/uninstall-flow.md | 2 +- .../next/tutorials/create/ms/add-access-controls.md | 2 +- vuepress/docs/next/tutorials/solution/entando-hub.md | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/vuepress/docs/next/docs/README.md b/vuepress/docs/next/docs/README.md index 589def1db9..062dcfe248 100644 --- a/vuepress/docs/next/docs/README.md +++ b/vuepress/docs/next/docs/README.md @@ -32,11 +32,11 @@ On the Entando Platform, Curate and Share means development teams can bundle and | Documentation | Tutorials | | :------------ | :-------- | -| [Bundle and Component Descriptors](./curate/local-hub-bundle-details.md) | [Install Bundles from a Private Git Repository](../tutorials/curate/local-hub-private-git-repo.md) | -| [Filtering Bundles](./curate/local-hub-bundle-filters.md) | [Install Bundle Plugins from a Private Image Repo](../tutorials/curate/local-hub-private-images.md) | -| [Customize Bundle Info in App Builder](./curate/local-hub-bundle-presentation-config.md) | | -| [Bundle Version and Updates FAQ](./curate/local-hub-bundle-versions-faq.md) | | -| [Bundle Uninstall](./curate/local-hub-uninstall-flow.md) | | +| [Bundle and Component Descriptors](./curate/bundle-details.md) | [Install Bundles from a Private Git Repository](../tutorials/curate/private-git-repo.md) | +| [Filtering Bundles](./curate/bundle-filters.md) | [Install Bundle Plugins from a Private Image Repo](../tutorials/curate/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) | | ## Compose an Application diff --git a/vuepress/docs/next/docs/create/component-gen-tech.md b/vuepress/docs/next/docs/create/component-gen-tech.md index 4c78929b94..7954eee900 100644 --- a/vuepress/docs/next/docs/create/component-gen-tech.md +++ b/vuepress/docs/next/docs/create/component-gen-tech.md @@ -5,7 +5,7 @@ When generating a microservice using the Entando Component Generator there are a * Microservice code * The Component Generator currently only supports the generation of Spring Boot microservices but will support the generation of Quarkus based services soon. * If you're interested in using Quarkus in your Entando app, contact us on the [Forum](https://forum.entando.org/) or [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw) and we'll help you get started. - * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/local-hub-bundle-details.md#plugin), including information on the runtime contract required to use them. + * If you're considering non-Java based microservices, [here is a definition of an Entando plugin](../curate/bundle-details.md#plugin), including information on the runtime contract required to use them. * Database type * Entando recommends standardizing your choice of database to simplify operational maintenance but you do have the ability to use different databases for different microservices if you choose. * Supported choices are none, MySQL, and Postgres. Enterprise customers can choose Oracle but should contact Entando Support for details. diff --git a/vuepress/docs/next/docs/curate/uninstall-flow.md b/vuepress/docs/next/docs/curate/uninstall-flow.md index ef40a6af31..f7b3c51f59 100644 --- a/vuepress/docs/next/docs/curate/uninstall-flow.md +++ b/vuepress/docs/next/docs/curate/uninstall-flow.md @@ -27,7 +27,7 @@ If they are in use, a pop-up shows a warning and you must unpublish the content ## Troubleshooting If an error occurs during the uninstall process, -check out the [Troubleshooting guide](./local-hub-troubleshooting-guide.md) or the [Entando Forum](https://forum.entando.org). +check out the [Troubleshooting guide](./troubleshooting-guide.md) or the [Entando Forum](https://forum.entando.org). diff --git a/vuepress/docs/next/tutorials/create/ms/add-access-controls.md b/vuepress/docs/next/tutorials/create/ms/add-access-controls.md index cae067358a..e7a234adf9 100644 --- a/vuepress/docs/next/tutorials/create/ms/add-access-controls.md +++ b/vuepress/docs/next/tutorials/create/ms/add-access-controls.md @@ -177,7 +177,7 @@ See the [Spring Security page](https://www.baeldung.com/spring-security-check-us ### Local vs. Kubernetes Testing This tutorial leverages the `internal` client, which is configured in the microservice via the `application.yml`. Client roles are manually created and assigned in Keycloak. -In Kubernetes, Entando will automatically create client roles per the bundle plugin definition (see the [plugin definition](../../../docs/curate/local-hub-bundle-details.md) for more information). These roles are created for the client specific to the microservice, e.g. `-conference-server`. The client name is injected as an environment variable into the plugin container, so the annotations noted above will work in both local and Kubernetes environments. +In Kubernetes, Entando will automatically create client roles per the bundle plugin definition (see the [plugin definition](../../../docs/curate/bundle-details.md) for more information). These roles are created for the client specific to the microservice, e.g. `-conference-server`. The client name is injected as an environment variable into the plugin container, so the annotations noted above will work in both local and Kubernetes environments. #### Modify Security Checks for Kubernetes diff --git a/vuepress/docs/next/tutorials/solution/entando-hub.md b/vuepress/docs/next/tutorials/solution/entando-hub.md index 30d22e03ae..c8267771cd 100644 --- a/vuepress/docs/next/tutorials/solution/entando-hub.md +++ b/vuepress/docs/next/tutorials/solution/entando-hub.md @@ -79,13 +79,13 @@ The key entities in the Entando Hub are: - `Bundle Group`: A Bundle Group is a group of one or more Entando Bundles. - `Bundle Group Version`: A Bundle Group can have one or more versions, each with a particular status. -- `Bundle`: A Bundle is the deployment unit within an Entando Application. A Bundle can contain one or multiple components such as micro frontends, microservices, or any of the [component types](../../docs/curate/local-hub-bundle-details.md) available in Entando. +- `Bundle`: A Bundle is the deployment unit within an Entando Application. A Bundle can contain one or multiple components such as micro frontends, microservices, or any of the [component types](../../docs/curate/bundle-details.md) available in Entando. - `Category`: Each Bundle Group belongs to a specific category. The initial possible categories are Solution Template, Packaged Business Capability (PBC), or Component Collection. An admin of an Entando Hub can refine the available categories as desired. - `Organization`: Bundle Groups belong to a single organization. Authors and managers can only update Bundle Groups for their own organization. - `User`: User identity is managed within Keycloak, where users are granted roles within the Hub. Users must be assigned to a specific organization. Notes: -- A private repository can be used for a Bundle, but this requires [an additional Kubernetes secret](../curate/local-hub-private-git-repo.md#overview) before deployment via the App Builder. +- A private repository can be used for a Bundle, but this requires [an additional Kubernetes secret](../curate/private-git-repo.md#overview) before deployment via the App Builder. ### Roles From b9ece250343f3568784d10629f574d33ba60d4bf Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Tue, 30 Aug 2022 18:24:25 -0700 Subject: [PATCH 05/10] ENDOC-515 Next round of links --- vuepress/docs/next/tutorials/README.md | 2 +- .../{local-hub-private-git-repo.md => private-git-repo.md} | 0 .../curate/{local-hub-private-images.md => private-images.md} | 0 3 files changed, 1 insertion(+), 1 deletion(-) rename vuepress/docs/next/tutorials/curate/{local-hub-private-git-repo.md => private-git-repo.md} (100%) rename vuepress/docs/next/tutorials/curate/{local-hub-private-images.md => private-images.md} (100%) diff --git a/vuepress/docs/next/tutorials/README.md b/vuepress/docs/next/tutorials/README.md index e0ccb0a486..0d184ee204 100644 --- a/vuepress/docs/next/tutorials/README.md +++ b/vuepress/docs/next/tutorials/README.md @@ -47,7 +47,7 @@ table th:nth-of-type(3) { | Basic | Intermediate | Advanced | :-: | :-: | :-: -| [Set Up Entando on a Local Kubernetes Cluster](../docs/getting-started/) | [Backing Up and Restoring Your Entando Environment](./devops/backing-up-and-restoring-your-environment.md) | [Install Bundle Microservices from a Private Registry](./curate/local-hub-private-images.md) | +| [Set Up Entando on a Local Kubernetes Cluster](../docs/getting-started/) | [Backing Up and Restoring Your Entando Environment](./devops/backing-up-and-restoring-your-environment.md) | [Install Bundle Microservices from a Private Registry](./curate/private-images.md) | | [Set Up Entando on Amazon Elastic Kubernetes Service (EKS)](./getting-started/eks-install.md) | [Customize the base Entando Application via a Docker Image](./devops/build-core-image.md) |[Add a GitHub Actions CI Workflow](./create/pb/github-actions-workflow.md)| | [Set Up Entando on Azure Kubernetes Service (AKS)](./getting-started/azure-install.md) |[Connect Your Entando Application to an External Database](./devops/external-db.md) | [Manage NGINX](./devops/manage-nginx.md) | [Set Up Entando on Google Kubernetes Engine (GKE)](./getting-started/gke-install.md) | [Install the Standard Demo Application](./solution/install-standard-demo.md)| [Setup Plugin Profiles](./devops/plugin-configuration.md) diff --git a/vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md b/vuepress/docs/next/tutorials/curate/private-git-repo.md similarity index 100% rename from vuepress/docs/next/tutorials/curate/local-hub-private-git-repo.md rename to vuepress/docs/next/tutorials/curate/private-git-repo.md diff --git a/vuepress/docs/next/tutorials/curate/local-hub-private-images.md b/vuepress/docs/next/tutorials/curate/private-images.md similarity index 100% rename from vuepress/docs/next/tutorials/curate/local-hub-private-images.md rename to vuepress/docs/next/tutorials/curate/private-images.md From c530fbc8318282bb1f0e22e50da44a1fc5a17bef Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Tue, 30 Aug 2022 18:26:32 -0700 Subject: [PATCH 06/10] ENDOC-515 Fingers crossed --- .../docs/next/tutorials/getting-started/kubernetes-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md b/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md index 6db43f66df..45e8358bef 100644 --- a/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md +++ b/vuepress/docs/next/tutorials/getting-started/kubernetes-install.md @@ -8,7 +8,7 @@ Below are the minimum infrastructure requirements to install Entando directly on - A default [storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/) is needed for the Entando Operator to create the correct persistent volume claims (PVCs) for each pod. - NGINX [ingress controller](https://kubernetes.github.io/ingress-nginx/deploy/) is needed to expose the Entando Application. - To install bundles, the cluster containing the Entando Application must have access to the bundle repository (either public or private, often on GitHub) as well as the Docker image repository (e.g. DockerHub) for any microservices. -- Kubernetes Secrets are required to [install bundles from a private image repository](../curate/local-hub-private-images.md), such as DockerHub. +- Kubernetes Secrets are required to [install bundles from a private image repository](../curate/private-images.md), such as DockerHub. ## Minimum Hardware Requirements From a3bc6e239ec91dc1a42a787b037509d1db4d5a21 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Wed, 31 Aug 2022 10:51:37 -0700 Subject: [PATCH 07/10] ENDOC-515 Fixes, fixes, fixes... --- ...al-hub-architecture.png => ecr-architecture.png} | Bin .../docs/next/docs/compose/local-hub-overview.md | 12 ++++++------ .../docs/next/docs/create/component-gen-overview.md | 4 ++-- vuepress/docs/next/docs/curate/bundle-filters.md | 8 ++++---- .../docs/next/docs/curate/bundle-versions-faq.md | 4 ++-- .../next/docs/getting-started/concepts-overview.md | 2 +- .../docs/next/docs/getting-started/ent-bundle.md | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) rename vuepress/docs/next/docs/compose/img/{local-hub-architecture.png => ecr-architecture.png} (100%) diff --git a/vuepress/docs/next/docs/compose/img/local-hub-architecture.png b/vuepress/docs/next/docs/compose/img/ecr-architecture.png similarity index 100% rename from vuepress/docs/next/docs/compose/img/local-hub-architecture.png rename to vuepress/docs/next/docs/compose/img/ecr-architecture.png diff --git a/vuepress/docs/next/docs/compose/local-hub-overview.md b/vuepress/docs/next/docs/compose/local-hub-overview.md index e57a4386bb..60f6a65fda 100644 --- a/vuepress/docs/next/docs/compose/local-hub-overview.md +++ b/vuepress/docs/next/docs/compose/local-hub-overview.md @@ -24,7 +24,7 @@ An Entanto Bundle is a package containing one or more components and descriptor The EntandoDeBundle custom resource is a Kubernetes resource readable by the Entando Operator. It provides information -about a Local Hub bundle and makes the bundle available in Kubernetes for the +about an Entando Bundle and makes the bundle available in Kubernetes for the Entando Component Manager. ### Entando Component Manager (ECM) @@ -40,13 +40,13 @@ responsible for the low-level communication with the K8s cluster API. ## Architecture -![Local Hub Architecture](./img/local-hub-architecture.png) +![ECR Architecture](./img/ecr-architecture.png) -From an architectural point of view, the Local Hub is composed of: -1. The `EntandoDeBundles` which contain the metadata associated with a bundle -2. The `entando-k8s-service` which reads the bundles from the +From an architectural point of view, the Entando Component Repository (ECR) is composed of: +1. The `EntandoDeBundles`, which contain the metadata associated with a bundle. The list of EntandoDeBundles (or Entando Bundles) is displayed as the "Local Hub" in the App Builder. +2. The `entando-k8s-service`, which reads the bundles from the cluster/namspace(s) and serves them via a consumable API -3. The ECM which creates the connection between the EntandoApp +3. The ECM, which creates the connection between the EntandoApp and the K8s service. ### Example Flow diff --git a/vuepress/docs/next/docs/create/component-gen-overview.md b/vuepress/docs/next/docs/create/component-gen-overview.md index d9af051769..40de43c291 100644 --- a/vuepress/docs/next/docs/create/component-gen-overview.md +++ b/vuepress/docs/next/docs/create/component-gen-overview.md @@ -34,11 +34,11 @@ This section provides an overview of the component generation process. If you wa 2. Define bundle and deploy assets - The Entando blueprint includes scripts and tools to automatically generate a bundle ready for deployment to the ECR. The bundle will include your microservice, generated microfrontends, and any microfrontends that you have created manually under the `ui` folder - The generated Spring Boot microservice can be built and deployed to a Docker registry using the provided maven Jib plugin - - Generated bundles can be pushed to a Git repository of the users choice + - Generated bundles can be pushed to a Git repository of the user's choice 3. Deploy bundles to the [Local Hub](../compose/local-hub-overview.md) - Once your Docker images are pushed to your registry and your bundle is available in Git you can generate an Entando bundle descriptor and push the bundles to the ECR - The bundles can be versioned and updated using tags in the Git repository 4. Install in Entando Apps - - Once the bundles are in the Local Hub they are available for deployment within the Entando Application + - Once the bundles are in the Local Hub, they are available for deployment within the Entando Application diff --git a/vuepress/docs/next/docs/curate/bundle-filters.md b/vuepress/docs/next/docs/curate/bundle-filters.md index 0957a632c7..ef238175ea 100644 --- a/vuepress/docs/next/docs/curate/bundle-filters.md +++ b/vuepress/docs/next/docs/curate/bundle-filters.md @@ -1,10 +1,10 @@ # Filtering bundles -Entando Bundles are filterable by component, by status or by textual research. +Entando Bundles are filterable by component, status or textual search. ## Filtering bundles by component -Entando Bundles are filterable by component from App Builder user interface. +Entando Bundles are filterable by component from the App Builder user interface. ![App Builder bundle filtering](./img/app-builder-bundle-component-filters.png) @@ -72,11 +72,11 @@ spec: ## Filtering bundles by status -Entando Bundles are filterable by status from App Builder user interface. +Entando Bundles are filterable by status from the App Builder user interface. ![App Builder bundle filtering](./img/app-builder-bundle-status-filters.png) -You can choose to see the full list of the bundles available in the Kubernetes cluster by selecting the `Explore` tab, or the list of the currently installed bundles by clicking on the `Installed` tab. +You can choose to see the full list of bundles available in the Kubernetes cluster by selecting the `Explore` tab, or the list of the currently installed bundles by clicking on the `Installed` tab. ## Filtering bundles by textual search diff --git a/vuepress/docs/next/docs/curate/bundle-versions-faq.md b/vuepress/docs/next/docs/curate/bundle-versions-faq.md index 5f169c1c0d..ab62e8ec00 100644 --- a/vuepress/docs/next/docs/curate/bundle-versions-faq.md +++ b/vuepress/docs/next/docs/curate/bundle-versions-faq.md @@ -45,7 +45,7 @@ Entando requires versions to follow the [semantic versioning 2.0.0](https://semv If you're a bundle developer and you want to release a new version of your bundle, you can simply update the content of your bundle and commit the changes to the bundle Git repository. Once all the required changes are committed, you can create a new tag in the Git repository using the `git tag` command and publish it to the remote repository using the `git push --tags` command -For example, let's assume my bundle already has a version `1.0.0` and I want to publish version `2.0.0` of my bundle; here the commands I need to use to create and publish the new tag: +For example, let's assume my bundle already has a version `1.0.0` and I want to publish version `2.0.0` of my bundle; here are the commands I need to use to create and publish the new tag: ``` git tag -a "2.0.0" -m "My new version" @@ -66,7 +66,7 @@ or if you still have the original file you can also: ## My bundle contains a microservice generated with the Entando Component Generator, does the version of the microservice have to be the same as the bundle version? -The version of the microservice - or to be more precise the Docker image associated with the microservice - isn't bound to the version of the bundle containing the microservice itself. +The version of the Docker image associated with the microservice isn't bound to the version of the bundle containing the microservice itself. This gives the bundle developer complete control over the bundle release process, especially in those situations where the bundle contains more components and even more microservices. diff --git a/vuepress/docs/next/docs/getting-started/concepts-overview.md b/vuepress/docs/next/docs/getting-started/concepts-overview.md index 1d43631f87..ded075c8df 100644 --- a/vuepress/docs/next/docs/getting-started/concepts-overview.md +++ b/vuepress/docs/next/docs/getting-started/concepts-overview.md @@ -99,7 +99,7 @@ the custom resources defined by Entando, in particular: - Entando Applications - Entando plugins - Entando links -- Local Hub bundles +- Entando Bundles Some of the main services provided by the Entando Kubernetes service are: diff --git a/vuepress/docs/next/docs/getting-started/ent-bundle.md b/vuepress/docs/next/docs/getting-started/ent-bundle.md index 94d33b6f68..20e7031c62 100644 --- a/vuepress/docs/next/docs/getting-started/ent-bundle.md +++ b/vuepress/docs/next/docs/getting-started/ent-bundle.md @@ -99,7 +99,7 @@ See [Build and Publish a Project Bundle](../../tutorials/create/pb/publish-proje |`ent bundle publish --registry [registry]`| Publish the Docker images to your Docker registry| ## ECR Commands -Entando provides a series of `ent ecr` commands for managing bundle interactions with the [Local Hub](../../docs/compose/local-hub-overview.md). +Entando provides a series of `ent ecr` commands for managing bundle interactions with the [Entando Component Repository](../../docs/compose/local-hub-overview.md) (ECR). | Command| Descriptions |:--|:-- From ab34f10557f4e69f9793ace15e3c5255ed6c8962 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Wed, 31 Aug 2022 11:08:32 -0700 Subject: [PATCH 08/10] ENDOC-515 Private Git repo language --- vuepress/docs/next/tutorials/curate/private-git-repo.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vuepress/docs/next/tutorials/curate/private-git-repo.md b/vuepress/docs/next/tutorials/curate/private-git-repo.md index 6d5b2e0f39..34d094cc9d 100644 --- a/vuepress/docs/next/tutorials/curate/private-git-repo.md +++ b/vuepress/docs/next/tutorials/curate/private-git-repo.md @@ -2,7 +2,7 @@ # Install Bundles from a Private Git Repository ## Overview -The standard deployment of Entando assumes that bundles are checked out from public Git repositories. Public repositories do not require user authentication, but a private key is required if a customer chooses to limit repository access to specific Git accounts. This document details how to allow Entando to access a private Git repository. +The standard deployment of Entando assumes that bundles are checked out from public Git or Docker repositories. Public repositories do not require user authentication, but a private key is required if a customer chooses to limit repository access to specific Git or Docker accounts. This tutorial describes how to allow Entando to access a private Git repository. For more background information please consult 1. [Entando custom resource reference](../../docs/consume/custom-resources.md) From 656deb2a055d9904b251b4899f266ca00be4b2f4 Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Thu, 1 Sep 2022 10:20:39 -0700 Subject: [PATCH 09/10] ENDOC-515 Fix links on newly merged page --- vuepress/docs/next/docs/curate/bundle-comparison.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/vuepress/docs/next/docs/curate/bundle-comparison.md b/vuepress/docs/next/docs/curate/bundle-comparison.md index 11fb957a35..b2e8a4d909 100644 --- a/vuepress/docs/next/docs/curate/bundle-comparison.md +++ b/vuepress/docs/next/docs/curate/bundle-comparison.md @@ -13,14 +13,14 @@ Some of the major improvements with docker-based bundles are: * Standardized bundle address format * A decoupled build and deployment process which is easier to understand, modify, and troubleshoot -For specifications on docker-based bundles, see the [Bundle Details](ecr-bundle-details.md) page. +For specifications on docker-based bundles, see the [Bundle Details](bundle-details.md) page. ### Bundle Comparison Table -|Attribute | [git-based bundles](../../../v7.0/docs/curate/ecr-bundle-details.md)| [docker-based bundles](ecr-bundle-details.md)| +|Attribute | [git-based bundles](../../../v7.0/docs/curate/bundle-details.md)| [docker-based bundles](bundle-details.md)| | :- | :-------------------- | :--------------------- | |`descriptorVersion`| v1| v5 | Bundle Specifications |Defined with descriptor files | Built with [ent bundle CLI](../getting-started/ent-bundle.md) tool -| Versioning |Bundle version set by Git tags |Bundle version set by Docker tags. For MFEs, the version defaults to 1.0.0 unless set in the [entando.json](ecr-bundle-details.md). -|Plugin Ingress| Generated by Entando or set in the plugin descriptor.yaml | Generated by Entando or customized in the [bundle descriptor](ecr-bundle-details.md#bundle-conventions), entando.json +| Versioning |Bundle version set by Git tags |Bundle version set by Docker tags. For MFEs, the version defaults to 1.0.0 unless set in the [entando.json](bundle-details.md). +|Plugin Ingress| Generated by Entando or set in the plugin descriptor.yaml | Generated by Entando or customized in the [bundle descriptor](bundle-details.md#bundle-conventions), entando.json |Identifiers| Designated Bundle ID and Plugin ID | Bundles, MFEs, & Plugins have unique global IDs| |Initialize from Entando Hub| As git clone |[Direct initialization from Hub](../../tutorials/create/mfe/react.md)(TODO-switch to appropriate tutorial) with `ent init BUNDLE-NAME –from-hub`| |Bundle Creation | [`ent prj` commands](../getting-started/ent-bundle.md#git-based-bundle-commands)| New modular [`ent bundle` commands](../getting-started/ent-bundle.md) @@ -31,5 +31,5 @@ For specifications on docker-based bundles, see the [Bundle Details](ecr-bundle- ||| MFEs support service discovery by using the property `apiClaim` |Local Services |Not Available | Default services now include PostgreSQL, MySQL, and Keycloak. Additional services can be added with the [`ent bundle svc` commands](../getting-started/ent-svc.md). |MFE Custom UI| Add with manual scripts| Custom UI is auto-generated in FTL format -|Data Transfer | Manual | New ways to pass values or information to widgets and bundles, or expose them in the APIs, by [utilizing context parameters, system parameters and the ext variable](ecr-bundle-details.md). +|Data Transfer | Manual | New ways to pass values or information to widgets and bundles, or expose them in the APIs, by [utilizing context parameters, system parameters and the ext variable](bundle-details.md). |Bundle Thumbnail| Detailed inside the YAML bundle descriptor|Automatically set with a JPG or PNG file named `thumbnail` in the bundle root folder. e.g. thumbnail.png From f87802ece9f75b9afcb601313dffb66d67c8098a Mon Sep 17 00:00:00 2001 From: Lydia Pedersen Date: Thu, 1 Sep 2022 10:24:28 -0700 Subject: [PATCH 10/10] ENDOC-515 Revert to old filename in 7.0 link --- vuepress/docs/next/docs/curate/bundle-comparison.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vuepress/docs/next/docs/curate/bundle-comparison.md b/vuepress/docs/next/docs/curate/bundle-comparison.md index b2e8a4d909..6b6977a8e5 100644 --- a/vuepress/docs/next/docs/curate/bundle-comparison.md +++ b/vuepress/docs/next/docs/curate/bundle-comparison.md @@ -15,7 +15,7 @@ Some of the major improvements with docker-based bundles are: For specifications on docker-based bundles, see the [Bundle Details](bundle-details.md) page. ### Bundle Comparison Table -|Attribute | [git-based bundles](../../../v7.0/docs/curate/bundle-details.md)| [docker-based bundles](bundle-details.md)| +|Attribute | [git-based bundles](../../../v7.0/docs/curate/ecr-bundle-details.md)| [docker-based bundles](bundle-details.md)| | :- | :-------------------- | :--------------------- | |`descriptorVersion`| v1| v5 | Bundle Specifications |Defined with descriptor files | Built with [ent bundle CLI](../getting-started/ent-bundle.md) tool