Bug 2060512 - Update terminology for ISS
Summary: Update terminology for ISS
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Inter Satellite Sync
Version: 6.11.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: 6.11.0
Assignee: Partha Aji
QA Contact: Radek Mynar
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-03-03 16:37 UTC by Jonathon Turel
Modified: 2022-07-05 14:34 UTC (History)
6 users (show)

Fixed In Version: tfm-rubygem-katello-4.3.0.31-1
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2022-07-05 14:34:21 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 34734 0 Normal New Update terminology for ISS 2022-04-05 22:02:11 UTC
Red Hat Product Errata RHSA-2022:5498 0 None None None 2022-07-05 14:34:36 UTC

Description Jonathon Turel 2022-03-03 16:37:08 UTC
Description of problem:

The two avenues of ISS now have official names:

ISS - Network Sync: new functionality in 7.0 which enables content to be synced directly from one Satellite to another.

ISS - Export Sync: introduced in 6.10 to enable the export of content from one Satellite, and for that content to then be imported to an air-gapped Satellite.

The new UI under Content -> Subscriptions -> Manage Manifest should be updated to use these terms rather than 'Upstream Server' and 'Air-gapped'. Similarly, the supporting code (API, models) should be updated so that there isn't a discrepancy between the external and internal language used to talk about these two features.


Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Lena is already working on updating the documentation so working together closely here would be hugely beneficial:

https://github.com/theforeman/foreman-documentation/pull/1126/

https://github.com/theforeman/foreman-documentation/pull/1082

Comment 1 Partha Aji 2022-03-03 20:51:35 UTC
Needs more discussions with UX. 

The way I see it. 4 sync use cases

ISS Network Sync
1) Syncing from RH CDN  [RH Cdn]
2) Syncing from Local Cdn (either via file system or http server) [RH Cdn]
3) Syncing from another Satellite [Upstream Satellite]

ISS Export Sync
4) Importing from an export archive [Cdn, Upstream Satellite and  Airgapped]


we have 3 tabs in the UI for these scenarios -> Red Hat CDN, Upstream Satellite and AirGapped

Now I can see 
Air-Gapped renamed to Export Sync
But both Red Hat CDN, Upstream Satellite belong to the network sync category.

Might be better to just document them the way they are right now.

Comment 2 Zuzana Lena Ansorgova 2022-03-03 21:32:31 UTC
Regarding the "CDN Configuration" tab itself -- perhaps renaming it to something like "Inter-Server Synchronization" or "ISS Configuration" would be in order? Or perhaps not. Just a thought.

re. ISS Network Sync 2) -- doesn't Upstream Satellite and Export Sync replace this functionality?

Btw. I think that it's unlikely that someone would use Export Sync when they have a SatServer connected either to CDN or upstream Sat. Or am I missing something?

Comment 3 Zuzana Lena Ansorgova 2022-03-03 21:41:44 UTC
re. "CDN Configuration" tab -- perhaps "Content Sync Configuration" might be better than my previous ideas. I'm leaving it for your consideration.

Comment 4 Jeremy Lenz 2022-03-04 20:43:13 UTC
> both Red Hat CDN, Upstream Satellite belong to the network sync category

I disagree. If you're using Red Hat CDN, you're not using ISS.  The way I see it, you use _either_ Red Hat CDN _or_ one of the ISS options.

I think the UI that we landed on is great and doesn't need major redesigning.

Comment 5 Partha Aji 2022-03-07 14:50:17 UTC
> If you're using Red Hat CDN, you're not using ISS.  The way I see it, you use _either_ Red Hat CDN _or_ one of the ISS options.

So in other words have CDN/Network Sync/Export Sync . "Network Sync" sounds too generic for "Pull content from another Satellite over the network". I mean would you automatically connect "Network" to a "Satellite" ?

> I think the UI that we landed on is great and doesn't need major redesigning.
Agree.

Comment 6 Zuzana Lena Ansorgova 2022-03-16 15:26:30 UTC
FYI, Jonathan was discussing with me that there might be some minor tweaks in both the GUI and CLI.
In particular, he mentioned that there might be changes in the Hammer CLI command 'hammer organization configure-cdn --type=...'

- the type `upstream_server` might be renamed to `network_sync`
- the type `air-gapped` might be renamed to `export_sync`

I assume this should go together with renaming of the two tabs in the CDN configuration GUI if that would be the case.

Where do you stand on this?

Comment 8 Partha Aji 2022-04-05 22:02:09 UTC
Connecting redmine issue https://projects.theforeman.org/issues/34734 from this bug

Comment 9 Bryan Kearney 2022-04-06 00:05:01 UTC
Upstream bug assigned to paji

Comment 10 Bryan Kearney 2022-04-06 00:05:03 UTC
Upstream bug assigned to paji

Comment 11 Brad Buckingham 2022-04-26 15:53:41 UTC
The associated upstream PRs have been merged; therefore, moving to POST.

Comment 15 Radek Mynar 2022-06-13 15:07:37 UTC
CDN configuration items were renamed properly and behave correctly. Discrepancies are being/were solved in separate issues.

VERIFIED with Satellite 6.11 SNAP 24 @ RHEL8.5

Comment 18 errata-xmlrpc 2022-07-05 14:34:21 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: Satellite 6.11 Release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2022:5498


Note You need to log in before you can comment on or make changes to this bug.