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.

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-694 update for Hub3.1 #717

Merged
merged 6 commits into from
May 4, 2023
Merged

ENDOC-694 update for Hub3.1 #717

merged 6 commits into from
May 4, 2023

Conversation

jyunmitch
Copy link
Collaborator

No description provided.

@jyunmitch jyunmitch requested review from nshaw and avdev4j April 18, 2023 13:35

## Using an Entando Enterprise Hub
### The Hub UI
The Entando enterprise Hub is equipped with a user interface from where users, entries, and catalogs are managed. Private and public catalogs can also be configured here.
Copy link
Contributor

Choose a reason for hiding this comment

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

from where -> where

![Hub UI](./hub-images/hub-ui.png)

### User Management
Only the Hub admin has the authorization to create and manage users.
Copy link
Contributor

Choose a reason for hiding this comment

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

the Hub admin -> a Hub admin (or a Hub administrator since it was spelled out above)


### Generate an API Key
Private catalogs have the option to utilize an API key instead of user ID specifications for access. The API key can be made mandatory for adding the catalog as a registry in the App Builder.
1. Make sure the user, including an admin, had been assigned to the organization with the private catalog.
Copy link
Contributor

Choose a reason for hiding this comment

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

-> API Keys are attached to a specific user account so first login as the user assigned to the organization with the private catalog.


### Concepts
### Add a Catalog as a Registry in your App Builder
Any enterprise Hub instance can be accessed from the Entando App Builder of another Entando Application. Configure the App Builder to access the desired catalog via the endpoint `BASEURL/entando-hub-api/appbuilder/api`, where the BASEURL is the address for the Entando Application.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this URL still correct? I don't have it running in my test instance currently but I think the path changed as a result of the v5 bundle so the bundleId is in the path.

Copy link
Contributor

@firegloves firegloves May 3, 2023

Choose a reason for hiding this comment

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

yes Nathan you are right, the new endpoint must respect the format BASEURL/entando-hub-application-152edaba/entando-hub-catalog-ms/appbuilder/api where BASEURL is the hostname of the Entando application. Probably I forgot to add it to the relevant ticket

3. Enter a name and the access URL for the catalog.
* Private Catalog
1. The access URL for a private catalog follows the pattern noted above, but with an added ID number from the catalog's HTTP address. Go to the published catalog page from the App Builder and find the address in the browser. The number after `/catalog/` is `YOUR-CATALOG-ID#`.
2. The URL to access the catalog is `BASEURL/entando-hub-api/appbuilder/api/?catalogId=YOUR-CATALOG-ID#`
Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like /entando-hub-api/ has to change to /entando-hub-application-152edaba/entando-hub-catalog-ms/
CC: @firegloves @jyunmitch

I wish we'd kept the ingress path in place so we could control the path in the entando.json but I think this is okay right now.

@jyunmitch jyunmitch merged commit f3910a7 into main May 4, 2023
@jyunmitch jyunmitch deleted the ENDOC-694 branch May 4, 2023 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants