Skip to content

Commit

Permalink
ENDOC-750-uninstall order of bundles
Browse files Browse the repository at this point in the history
  • Loading branch information
jyunmitch committed Oct 3, 2023
1 parent 2f81259 commit 424578c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
4 changes: 3 additions & 1 deletion vuepress/docs/next/docs/curate/uninstall-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ An application bundle that has been installed in the Entando App Builder can be
1. Log in to your App Builder instance and select `Hub` from the navigation on the left to enter your Local Hub.
2. Click the `Installed` button to open a pop-up window with the options to update or uninstall the bundle.
3. Click the `Uninstall` button.
4. An initial check is made to verify that components are not in use outside of the bundle. A pop-up window will list the components with external references that must be removed manually and then the uninstall process may be resumed.
4. An initial check is made to verify that components are not in use outside of the bundle. A pop-up window will list the components with external references that must be removed manually and then the uninstall process may be resumed^.
5. When the `Uninstall` is confirmed, the following removal process starts:
- Bundle resources are deleted from the Entando App Engine
- Components included in the bundle are removed from the Entando App Engine
- Plugins are unlinked
6. To remove the bundle from the Local Hub catalog, click the `Undeploy` button.

^ When unistalling a PBC or any component with **multiple bundles**, it is important to remove the bundles in the reverse order of installation because of dependencies.

## Troubleshooting
If an error occurs during the uninstall process, check out the [Troubleshooting guide](./troubleshooting-guide.md) or the [Entando Forum](https://forum.entando.com).

Expand Down
9 changes: 6 additions & 3 deletions vuepress/docs/next/tutorials/solution/entando-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ ent ecr deploy --repo=docker://registry.hub.docker.com/entando/entando-hub-conte
![install-bundles.png](./hub-images/install-bundles.png)

4. Click each bundle icon and `Install` the bundle, where order of installation is important. The `entando-hub-application-bundle` must be installed first because it provides the `entando-hub-content-bundle` with MFEs. It may take several minutes to download the Docker images for the microservices and install the related assets.
>For multi-bundle components or PBCs, you will need to follow the same order of installtion for upgrades. For uninstalling a bundle group, follow the reverse order of installation.
## Configuration
1. Set up permissions to configure the service for the Hub administrator:
Expand Down Expand Up @@ -101,9 +102,11 @@ Click the `Add +` button at the top of the Hub UI home page to create a new bund
![hub-add.png](./hub-images/hub-add.png)


1. Upload a file of the thumbnail for the bundle group.
2. Add one or more bundles for the entry using the `Add +` button next to the `Add Bundle URI` field.
3. Check `Display Contact Us button` and enter the URL under `Contact URL` to gather more information from the viewer/visitor and manage access to the entry. Typically, the contact URL points to a web form on the owner's web site with a request for access to the entry.
1. Upload a file for the thumbnail of the bundle group.
2. Fill in the documentation address, version and organization as needed.
3. Add one or more bundle URIs with the `Add +` button next to the field. For multi-bundle entries, it is recommended that the URIs be entered in the order they should be installed so they can be listed in that order in the Hub.
>Should a multi-bundle entry need to be uninstalled, bundles will need to be removed in the reverse order so the dependencies can be cleared without issue.
4. Check `Display Contact Us button` and enter the `Contact URL` to gather more information from the viewer/visitor and manage access to the entry. Typically, the contact URL points to a web form on the owner's web site with a request for access to the entry.

### Create a Private Catalog
A private catalog can be configured in the Hub UI when creating a new organization. There can be many organizations in a single Hub instance, but each organization is allowed one private catalog. Only the Hub admin can create an organization and provide a private catalog for it.
Expand Down

0 comments on commit 424578c

Please sign in to comment.