Documenting Hub online synchronization #3921
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0rnela
changed the title
keichwa
approved these changes
Apr 28, 2025
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
…sync.adoc Co-authored-by: Karl Eichwalder <ke@suse.de>
…sync.adoc Co-authored-by: Karl Eichwalder <ke@suse.de>
0rnela
commented
Apr 29, 2025
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
mackdk
reviewed
Apr 30, 2025
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
…sync.adoc Co-authored-by: Thomas Florio <mackdk@users.noreply.github.com>
…sync.adoc Co-authored-by: Thomas Florio <mackdk@users.noreply.github.com>
mcalmer
reviewed
May 5, 2025
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
modules/specialized-guides/pages/large-deployments/hub-online-sync.adoc
Outdated
Show resolved
Hide resolved
| When the peripheral server is configured to communicate with the hub, the public GPG key will then automatically be transferred to it. | ||
|
|
||
| Once the GPG key is created on the hub, field [literal]``GPG Public Key`` will be set to show that this serevr is using the GPG key. | ||
| For more information about setting up own GPG key, see xref:administration:repo-metadata.adoc[]. |
There was a problem hiding this comment.
I think you need to update the peripheral registration when you create the GPG key after you registered the peripheral.
I need to check how this can be done. Or Thomas knows it
There was a problem hiding this comment.
I don't think there is currently a way to do it through the UI. I think we have only any API call to update the GPG key.
…sync.adoc Co-authored-by: Michael Calmer <mc@suse.de>
keichwa
requested changes
May 5, 2025
|
|
||
| == Introduction | ||
|
|
||
| Hub online synchronization reuses the existing repository syncing mechanism and synchronizes channels in the peripheral servers from the repositories on the hub server. |
There was a problem hiding this comment.
Suggested change
| Hub online synchronization reuses the existing repository syncing mechanism and synchronizes channels in the peripheral servers from the repositories on the hub server. | |
| Hub online synchronization reuses the existing repository synchronization and synchronizes channels in the peripheral servers from the repositories on the hub server. |
|
|
||
| Hub online synchronization reuses the existing repository syncing mechanism and synchronizes channels in the peripheral servers from the repositories on the hub server. | ||
|
|
||
| Once the connection between hub and peripheral server is established, the hub server becomes the main source of data for the peripheral server. |
There was a problem hiding this comment.
Suggested change
| Once the connection between hub and peripheral server is established, the hub server becomes the main source of data for the peripheral server. | |
| When the connection between hub and peripheral server is established, the hub server becomes the main source of data for the peripheral server. |
|
|
||
| Once the connection between hub and peripheral server is established, the hub server becomes the main source of data for the peripheral server. | ||
| In case of vendor channels, hub server is effectively replacing {scclongform}. | ||
| In case of custom channels, once they are synced, the peripheral server will fetch the packages from the hub and not from the original location of the custom channel defined on the hub. |
There was a problem hiding this comment.
Suggested change
| In case of custom channels, once they are synced, the peripheral server will fetch the packages from the hub and not from the original location of the custom channel defined on the hub. | |
| In case of custom channels, when they are synchronized, the peripheral server will fetch the packages from the hub and not from the original location of the custom channel defined on the hub. |
| . by using a combination of token creation on the peripheral, and subsequent registration on the hub server. | ||
| This method uses <<peripheral-token-generation>> and <<token-transfer>>. | ||
| . by direct registration from the hub, without any user interactions with the peripheral server. | ||
| The steps for this method are described in <<direct-registration>>. |
There was a problem hiding this comment.
Suggested change
| The steps for this method are described in <<direct-registration>>. | |
| This method is described in <<direct-registration>>. |
|
|
||
| === Registration from peripheral server by token generation | ||
|
|
||
| Before being registered to the hub server, a token needs to be generated on the peripheral server and passed it to the administrator of the hub server. |
There was a problem hiding this comment.
Not sure, but maybe:
Suggested change
| Before being registered to the hub server, a token needs to be generated on the peripheral server and passed it to the administrator of the hub server. | |
| Before being registered to the hub server, a token needs to be generated on the peripheral server and passed to the administrator of the hub server. |
Judging from the following menu description, you just seem to "copy" the token.
| * Use option [literal]``Upload a file`` if the servers have different certificate authorities to upload a certificate file. | ||
| * Use option [literal]``Paste a PEM certificate`` to paste a certificate. | ||
| . Click button btn:[Register]. | ||
| A newly registered peripheral serevr will appear on screen [literal]``Peripherals Configuration``. |
There was a problem hiding this comment.
Suggested change
| A newly registered peripheral serevr will appear on screen [literal]``Peripherals Configuration``. | |
| A newly registered peripheral server will appear on screen [literal]``Peripherals Configuration``. |
|
|
||
| When the metadata on the hub server are signed with a GPG key, the public key is automatically transmitted from hub to peripheral server. | ||
|
|
||
| By default, {productname} is not signing meta data. |
There was a problem hiding this comment.
Suggested change
| By default, {productname} is not signing meta data. | |
| By default, {productname} is not signing metadata. |
| By default, {productname} is not signing meta data. | ||
| Therefore, when the peripheral server is downloading data from the hub server there is no way of checking if the downloaded metadata have a valid signature, unless the customer has created their own GPG key. | ||
|
|
||
| To enable checking of the data integrity, the GPG key needs to be created on the hub side. |
There was a problem hiding this comment.
Suggested change
| To enable checking of the data integrity, the GPG key needs to be created on the hub side. | |
| To enable checking of the data integrity, the GPG key needs to be created on the hub. |
| To enable checking of the data integrity, the GPG key needs to be created on the hub side. | ||
| When the peripheral server is configured to communicate with the hub, the public GPG key will then automatically be transferred to it. | ||
|
|
||
| Once the GPG key is created on the hub, field [literal]``GPG Public Key`` will be set to show that this serevr is using the GPG key. |
There was a problem hiding this comment.
Suggested change
| Once the GPG key is created on the hub, field [literal]``GPG Public Key`` will be set to show that this serevr is using the GPG key. | |
| When the GPG key is created on the hub, field [literal]``GPG Public Key`` will be set to show that this server is using the GPG key. |
There was a problem hiding this comment.
It is also worth checking the titles about capitalization again.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR supersedes #3895.
Description
Hub online synchronization (a.k.a. ISS v3) feature had been added to the product.
This PR creates corresponding documentation for the feature.
Target branches
Backport targets (edit as needed):
Links