From 59df296ae4a9e73b70f9b59ea9809f148459e5bd Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Wed, 24 Aug 2022 14:29:44 -0500 Subject: [PATCH 1/5] ENDOC-536 new bundle classification --- .../next/docs/curate/bundle-version-types.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 vuepress/docs/next/docs/curate/bundle-version-types.md diff --git a/vuepress/docs/next/docs/curate/bundle-version-types.md b/vuepress/docs/next/docs/curate/bundle-version-types.md new file mode 100644 index 0000000000..360d5980ff --- /dev/null +++ b/vuepress/docs/next/docs/curate/bundle-version-types.md @@ -0,0 +1,40 @@ +--- +sidebarDepth: 2 +--- + +# Entando Bundle Classification * + +Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based bundles, and this page clarifies the differences between the two, along with the improvements that were made in the new release. + +Some of the major improvements with the Docker-based bundles are: +* Simplified bundle directory structure +* Just one registry required with repositories created on the fly +* Optimized file storage and transfer using a layered file-system, beneficial for large projects +* Standardized bundle address format +* Easier to modify, compose, and troubleshoot with decoupled processes + +For specifications on Docker-based bundles, see the [Bundle Details](ecr-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)| +| :- | :-------------------- | :--------------------- | +|`descriptorVersion`| v1| v5 +| Bundle specifications |Define with descriptor files | Build 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 [entando.json](ecr-bundle-details.md). +|Plugin Ingress| Generated by Entando or set in the CRD | Generated by Entando or customize in the [bundle descriptor](ecr-bundle-details.md#entando-bundle-conventions), entando.json +|Identifiers| Designated Bundle ID and Plugin ID | Bundles, MFEs, & Plugins have unique global IDs| +|Initialize from Entando Hub|NA |[Direct initialization from Hub](../../tutorials/create/mfe/react.md)(switch to simple widget as available) with `ent init BUNDLE-NAME –from-hub`| +|Bundle Creation | `ent prj` commands| New modular `ent bundle` commands +|Deploy & Install| `ent ecr deploy` and `ent ecr install` | No change +|Export Bundle|`ent bundler`|`ent generate-cr` and export files +|JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| NA +|APIs| NA| [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace +||| MFEs support service discovery by using the property apiClaim +|Services |Utilizes Dockerfiles or CRDs to specify services. Keycloak is integrated with the ent CLI | 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 |NA| New ways to pass values or information to widgets, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-bundle-details.md). +|Bundle Thumbnail| Detailed inside the YAML bundle descriptor|Automatically setup with a jpg or png file named thumbnail in the bundle root folder. e.g. thumbnail.png + +* Alternate page titles +# Entando Bundle Version Comparison +# Entando Bundle Differentiation +(variations, Distinctions, Differences, differentiation, Variances, breakdown) \ No newline at end of file From 9d39e8541bf0910e77c06dd2a806d47fef7124d0 Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Thu, 25 Aug 2022 14:22:00 -0500 Subject: [PATCH 2/5] ENDOC-536-version --- .../next/docs/curate/bundle-comparison.md | 39 +++++++++++++++++++ .../next/docs/curate/bundle-version-types.md | 35 ++++++++--------- 2 files changed, 56 insertions(+), 18 deletions(-) create mode 100644 vuepress/docs/next/docs/curate/bundle-comparison.md diff --git a/vuepress/docs/next/docs/curate/bundle-comparison.md b/vuepress/docs/next/docs/curate/bundle-comparison.md new file mode 100644 index 0000000000..878d83fa15 --- /dev/null +++ b/vuepress/docs/next/docs/curate/bundle-comparison.md @@ -0,0 +1,39 @@ +--- +sidebarDepth: 2 +--- + +# Entando Bundle Transition to 7.1 + +Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release. + +Some of the major improvements with the docker-based bundles are: +* Simplified bundle directory structure +* Just one source git repository required with Docker image repositories created automatically as needed +* Optimized file storage and transfer using a layered file-system, beneficial for large projects +* 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. +### Bundle Comparison Table +|Attribute | [git-based bundles](../../../v7.0/docs/curate/ecr-bundle-details.md)| [docker-based bundles](ecr-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#entando-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| New modular `ent bundle` commands +|Deploy & Install| `ent ecr deploy` and `ent ecr install` | No change +|Export Bundle|`ent bundler`| Not Available +|JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| [Convert Blueprint project to v5 bundle](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) (TODO-change link to new tutorial) +|APIs| Not Available | [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace +||| 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, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-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 + +* Alternate page titles +# Entando Bundle Version Comparison +# Entando Bundle Differentiation diff --git a/vuepress/docs/next/docs/curate/bundle-version-types.md b/vuepress/docs/next/docs/curate/bundle-version-types.md index 360d5980ff..878d83fa15 100644 --- a/vuepress/docs/next/docs/curate/bundle-version-types.md +++ b/vuepress/docs/next/docs/curate/bundle-version-types.md @@ -2,39 +2,38 @@ sidebarDepth: 2 --- -# Entando Bundle Classification * +# Entando Bundle Transition to 7.1 -Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based bundles, and this page clarifies the differences between the two, along with the improvements that were made in the new release. +Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release. -Some of the major improvements with the Docker-based bundles are: +Some of the major improvements with the docker-based bundles are: * Simplified bundle directory structure -* Just one registry required with repositories created on the fly +* Just one source git repository required with Docker image repositories created automatically as needed * Optimized file storage and transfer using a layered file-system, beneficial for large projects * Standardized bundle address format -* Easier to modify, compose, and troubleshoot with decoupled processes +* 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](ecr-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/ecr-bundle-details.md)| [docker-based bundles](ecr-bundle-details.md)| | :- | :-------------------- | :--------------------- | |`descriptorVersion`| v1| v5 -| Bundle specifications |Define with descriptor files | Build 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 [entando.json](ecr-bundle-details.md). -|Plugin Ingress| Generated by Entando or set in the CRD | Generated by Entando or customize in the [bundle descriptor](ecr-bundle-details.md#entando-bundle-conventions), entando.json +| 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#entando-bundle-conventions), entando.json |Identifiers| Designated Bundle ID and Plugin ID | Bundles, MFEs, & Plugins have unique global IDs| -|Initialize from Entando Hub|NA |[Direct initialization from Hub](../../tutorials/create/mfe/react.md)(switch to simple widget as available) with `ent init BUNDLE-NAME –from-hub`| +|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| New modular `ent bundle` commands |Deploy & Install| `ent ecr deploy` and `ent ecr install` | No change -|Export Bundle|`ent bundler`|`ent generate-cr` and export files -|JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| NA -|APIs| NA| [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace +|Export Bundle|`ent bundler`| Not Available +|JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| [Convert Blueprint project to v5 bundle](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) (TODO-change link to new tutorial) +|APIs| Not Available | [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace ||| MFEs support service discovery by using the property apiClaim -|Services |Utilizes Dockerfiles or CRDs to specify services. Keycloak is integrated with the ent CLI | Default services now include PostgreSQL, MySQL, and Keycloak. Additional services can be added with the [`ent bundle svc` commands](../getting-started/ent-svc.md). +|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 |NA| New ways to pass values or information to widgets, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-bundle-details.md). -|Bundle Thumbnail| Detailed inside the YAML bundle descriptor|Automatically setup with a jpg or png file named thumbnail in the bundle root folder. e.g. thumbnail.png +|Data transfer | Manual | New ways to pass values or information to widgets, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-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 * Alternate page titles # Entando Bundle Version Comparison # Entando Bundle Differentiation -(variations, Distinctions, Differences, differentiation, Variances, breakdown) \ No newline at end of file From 8b6ca1b109909ff8ed9d1e2249974b189f67b599 Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Mon, 29 Aug 2022 10:52:36 -0500 Subject: [PATCH 3/5] ENDO-536 review updates & misc --- vuepress/docs/.vuepress/next.js | 10 ++++- .../next/docs/curate/bundle-comparison.md | 13 ++++--- .../next/docs/curate/bundle-version-types.md | 39 ------------------- 3 files changed, 16 insertions(+), 46 deletions(-) delete mode 100644 vuepress/docs/next/docs/curate/bundle-version-types.md diff --git a/vuepress/docs/.vuepress/next.js b/vuepress/docs/.vuepress/next.js index 88d2f6f545..c223efc089 100644 --- a/vuepress/docs/.vuepress/next.js +++ b/vuepress/docs/.vuepress/next.js @@ -78,7 +78,15 @@ module.exports = { title: 'Curate and Share Components', children: [ { - title: 'Bundle and Component Descriptors', + title: 'Bundle Descriptor Details', + path: path + 'curate/ecr-bundle-details.md' + }, + { + title: 'Bundle Transition Comparison', + path: path + 'curate/bundle-comparison.md' + }, + { + title: 'Component Descriptors', path: path + 'curate/ecr-bundle-details.md' }, { diff --git a/vuepress/docs/next/docs/curate/bundle-comparison.md b/vuepress/docs/next/docs/curate/bundle-comparison.md index 878d83fa15..b663dc7002 100644 --- a/vuepress/docs/next/docs/curate/bundle-comparison.md +++ b/vuepress/docs/next/docs/curate/bundle-comparison.md @@ -2,13 +2,13 @@ sidebarDepth: 2 --- -# Entando Bundle Transition to 7.1 +# Entando Bundle Transition to 7.1 Entando Bundle Evolution -Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release. +Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles. Though both systems are supported on Entando 7.1, this page clarifies the differences between the two, along with the improvements that were made with the new release. Some of the major improvements with the docker-based bundles are: * Simplified bundle directory structure -* Just one source git repository required with Docker image repositories created automatically as needed +* Single source git repository required with Docker image repositories created automatically as needed * Optimized file storage and transfer using a layered file-system, beneficial for large projects * Standardized bundle address format * A decoupled build and deployment process which is easier to understand, modify, and troubleshoot @@ -19,8 +19,8 @@ For specifications on docker-based bundles, see the [Bundle Details](ecr-bundle- | :- | :-------------------- | :--------------------- | |`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#entando-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](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#entando-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| New modular `ent bundle` commands @@ -32,8 +32,9 @@ For specifications on docker-based bundles, see the [Bundle Details](ecr-bundle- |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, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-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 +|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 * Alternate page titles # Entando Bundle Version Comparison # Entando Bundle Differentiation +# Feature Matrix for Bundle Transition \ No newline at end of file diff --git a/vuepress/docs/next/docs/curate/bundle-version-types.md b/vuepress/docs/next/docs/curate/bundle-version-types.md deleted file mode 100644 index 878d83fa15..0000000000 --- a/vuepress/docs/next/docs/curate/bundle-version-types.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -sidebarDepth: 2 ---- - -# Entando Bundle Transition to 7.1 - -Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release. - -Some of the major improvements with the docker-based bundles are: -* Simplified bundle directory structure -* Just one source git repository required with Docker image repositories created automatically as needed -* Optimized file storage and transfer using a layered file-system, beneficial for large projects -* 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. -### Bundle Comparison Table -|Attribute | [git-based bundles](../../../v7.0/docs/curate/ecr-bundle-details.md)| [docker-based bundles](ecr-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#entando-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| New modular `ent bundle` commands -|Deploy & Install| `ent ecr deploy` and `ent ecr install` | No change -|Export Bundle|`ent bundler`| Not Available -|JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| [Convert Blueprint project to v5 bundle](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) (TODO-change link to new tutorial) -|APIs| Not Available | [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace -||| 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, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-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 - -* Alternate page titles -# Entando Bundle Version Comparison -# Entando Bundle Differentiation From 3faee948822e80c036e8116764fe58059904a490 Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Mon, 29 Aug 2022 11:01:28 -0500 Subject: [PATCH 4/5] ENDOC-536 review edits and other updates --- vuepress/docs/.vuepress/next.js | 6 +++- .../next/docs/curate/bundle-comparison.md | 28 ++++++++++--------- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/vuepress/docs/.vuepress/next.js b/vuepress/docs/.vuepress/next.js index 88d2f6f545..5cc1edcb17 100644 --- a/vuepress/docs/.vuepress/next.js +++ b/vuepress/docs/.vuepress/next.js @@ -78,9 +78,13 @@ module.exports = { title: 'Curate and Share Components', children: [ { - title: 'Bundle and Component Descriptors', + title: 'Bundle Details', path: path + 'curate/ecr-bundle-details.md' }, + { + title: 'Entando Bundle Transition', + path: path + 'curate/bundle-comparison.md' + }, { title: 'Filtering Bundles', path: path + 'curate/ecr-bundle-filters.md' diff --git a/vuepress/docs/next/docs/curate/bundle-comparison.md b/vuepress/docs/next/docs/curate/bundle-comparison.md index 878d83fa15..d8cec8374b 100644 --- a/vuepress/docs/next/docs/curate/bundle-comparison.md +++ b/vuepress/docs/next/docs/curate/bundle-comparison.md @@ -2,14 +2,15 @@ sidebarDepth: 2 --- -# Entando Bundle Transition to 7.1 +# Bundle Evolution on Entando 7.1 -Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles, and this page clarifies the differences between the two, along with the improvements that were made with the new release. -Some of the major improvements with the docker-based bundles are: +Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando bundle was restructured, its processes decoupled by component type, and the publishing transport method was streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles. Both systems are supported on Entando 7.1, and this page clarifies the differences between the two, along with the improvements that were made with the new release. + +Some of the major improvements with docker-based bundles are: * Simplified bundle directory structure -* Just one source git repository required with Docker image repositories created automatically as needed -* Optimized file storage and transfer using a layered file-system, beneficial for large projects +* Single source git repository required with Docker image repositories created automatically as needed +* Optimized file storage and transfer using a layered file system, beneficial for large projects * Standardized bundle address format * A decoupled build and deployment process which is easier to understand, modify, and troubleshoot @@ -18,22 +19,23 @@ For specifications on docker-based bundles, see the [Bundle Details](ecr-bundle- |Attribute | [git-based bundles](../../../v7.0/docs/curate/ecr-bundle-details.md)| [docker-based bundles](ecr-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). +| 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#entando-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| New modular `ent bundle` commands +|Bundle Creation | [`ent prj` commands](../getting-started/ent-bundle.md#git-based-bundle-commands)| New modular [`ent bundle` commands](../getting-started/ent-bundle.md) |Deploy & Install| `ent ecr deploy` and `ent ecr install` | No change |Export Bundle|`ent bundler`| Not Available |JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| [Convert Blueprint project to v5 bundle](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md) (TODO-change link to new tutorial) |APIs| Not Available | [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace -||| MFEs support service discovery by using the property apiClaim +||| 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, bundles, or expose in the APIs by [utilizing context parameters, system parameters and the ext variable](ecr-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 +|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 APIs by [utilizing context parameters, system parameters and the ext variable](ecr-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 * Alternate page titles # Entando Bundle Version Comparison -# Entando Bundle Differentiation +# Feature Matrix for Bundle Transition +# Bundle Transition to Entando 7.1 \ No newline at end of file From 6a5981d4abba1671419e7c78c621eb7dbe96633b Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Tue, 30 Aug 2022 15:21:40 -0500 Subject: [PATCH 5/5] ENDOC-536 final edits --- vuepress/docs/.vuepress/next.js | 4 ---- vuepress/docs/next/docs/curate/bundle-comparison.md | 10 ++-------- 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/vuepress/docs/.vuepress/next.js b/vuepress/docs/.vuepress/next.js index 54d0804ad8..2809aa34e0 100644 --- a/vuepress/docs/.vuepress/next.js +++ b/vuepress/docs/.vuepress/next.js @@ -81,10 +81,6 @@ module.exports = { title: 'Bundle Details', path: path + 'curate/ecr-bundle-details.md' }, - { - title: 'Bundle Transition Comparison', - path: path + 'curate/bundle-comparison.md' - }, { title: 'Filtering Bundles', path: path + 'curate/ecr-bundle-filters.md' diff --git a/vuepress/docs/next/docs/curate/bundle-comparison.md b/vuepress/docs/next/docs/curate/bundle-comparison.md index 7e793ab11f..11fb957a35 100644 --- a/vuepress/docs/next/docs/curate/bundle-comparison.md +++ b/vuepress/docs/next/docs/curate/bundle-comparison.md @@ -4,7 +4,7 @@ sidebarDepth: 2 # Bundle Evolution on Entando 7.1 -Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando Bundle was restructured, its processes decoupled by component type, and the publishing transport method streamlined. With these changes, Entando Bundles went from git-based to Docker-based OCI bundles. Both systems are supported on Entando 7.1, and this page clarifies the differences between the two, along with the improvements in the new release. +Entando 7.1 implements a more modular approach to building apps with the **ent bundle** CLI orchestrating the management of project bundles. The Entando Bundle was restructured, its processes decoupled by component type, and the publishing transport method, streamlined. With these changes, Entando Bundles went from git-based to docker-based OCI bundles. Both methods are supported on Entando 7.1, and this page clarifies the differences between the two, along with the improvements in the new release. Some of the major improvements with docker-based bundles are: * Simplified bundle directory structure @@ -19,7 +19,7 @@ For specifications on docker-based bundles, see the [Bundle Details](ecr-bundle- | :- | :-------------------- | :--------------------- | |`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). +| 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 |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`| @@ -33,9 +33,3 @@ For specifications on docker-based bundles, see the [Bundle Details](ecr-bundle- |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). |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 - -* Alternate page titles -# Entando Bundle Version Comparison -# Entando Bundle Differentiation -# Bundle Transition on Entando 7.1 -# Feature Matrix for Bundle Transition