Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENDOC-536 new bundle classification #555

Merged
merged 6 commits into from
Aug 31, 2022
+36 −1
Merged

ENDOC-536 new bundle classification #555

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
59df296
ENDOC-536 new bundle classification
jyunmitch Aug 24, 2022
9d39e85
ENDOC-536-version
jyunmitch Aug 25, 2022
8b6ca1b
ENDO-536 review updates & misc
jyunmitch Aug 29, 2022
3faee94
ENDOC-536 review edits and other updates
jyunmitch Aug 29, 2022
39e127f
ENDOC-536 Review edits & more
jyunmitch Aug 29, 2022
6a5981d
ENDOC-536 final edits
jyunmitch Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions vuepress/docs/next/docs/curate/bundle-version-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved

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
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
* 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
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved

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)|
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
| :- | :-------------------- | :--------------------- |
|`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
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
|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`|
Copy link
Contributor

Choose a reason for hiding this comment

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

NA -> "as git clone"
What is "switch to simple widget?" Should that be marked as a TODO so we don't lose it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, it's a TODO. Will add note as such

|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
Copy link
Contributor

Choose a reason for hiding this comment

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

For v5, there's no change. ent generate-cr does not export a bundle.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

?? thought we couldn't do ent bundler on 7.1 v5 so how is that no change. Thought that generating the CR and manually copying over the files was a method of exporting.

Should I put Not Applicable?

|JHipster Integrated Blueprint Project| `ent jhipster blueprint` creates [MFE & MS template project](../../tutorials/create/ms/generate-microservices-and-micro-frontends.md)| NA
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
|APIs| NA| [Manage APIs with `ent bundle` commands](../getting-started/ent-api.md). MFEs can make API claims to MSs within the namespace
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
||| 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).
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
|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).
jyunmitch marked this conversation as resolved.
Show resolved Hide resolved
|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
Copy link
Contributor

Choose a reason for hiding this comment

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

I prefer this one of the 3. I don't love Version in the title for some reason (since bundles themselves have versions when published) but I don't have a better idea. In some ways this is a Feature Matrix like you get when you do insurance shopping. Entando Bundle Feature Matrix?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How about Entando Bundle Transition to 7.1?
Entando Bundle Transition from 7.0 to 7.1
How Entando Bundles changed from 7.0 to 7.1

Copy link
Contributor

Choose a reason for hiding this comment

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

Feature Matrix for Bundle Transition?

# Entando Bundle Differentiation
(variations, Distinctions, Differences, differentiation, Variances, breakdown)