Bug 1860560 - [DOC] update doc related to creating mirror registry
Summary: [DOC] update doc related to creating mirror registry
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: 4.6.z
Assignee: Amrita
QA Contact: To Hung Sze
Latha S
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-07-25 04:45 UTC by To Hung Sze
Modified: 2021-11-09 05:49 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-11-09 05:49:54 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description To Hung Sze 2020-07-25 04:45:32 UTC
Document URL: 
This page has room for improvements:
https://docs.openshift.com/container-platform/4.2/installing/install_config/installing-restricted-networks-preparations.html


Describe the issue:

 
#1 The sample in "Adding the registry to your pull secret", step 4
Edit the new file and add a section that describes your registry to it:

<original>
{
  "auths": {
    "cloud.openshift.com": {
      "auth": "b3BlbnNo...",
      "email": "you"
    },
    "quay.io": {
      "auth": "b3BlbnNo...",
      "email": "you"
    },
    "registry.connect.redhat.com": {
      "auth": "NTE3Njg5Nj...",
      "email": "you"
    },
    "<mirror_registry>": {
      "auth": "<credentials>",
      "email": "you"
    },
    "registry.redhat.io": {
      "auth": "NTE3Njg5Nj...",
      "email": "you"
    }
  }
}
...

<suggestion>
{
  "auths": {
    "cloud.openshift.com": {
      "auth": "b3BlbnNo...",
      "email": "you"
    },
    "quay.io": {
      "auth": "b3BlbnNo...",
      "email": "you"
    },
    "registry.connect.redhat.com": {
      "auth": "NTE3Njg5Nj...",
      "email": "you"
    },
    "registry.example.com": {
      "auth": "BGVtbYk3ZHAtqXs=",
      "email": "you"
    },
    "registry.redhat.io": {
      "auth": "NTE3Njg5Nj...",
      "email": "you"
    }
  }
}



#2 In the sample in "Adding the registry to your pull secret" , step 3:

<original>
cat ./pull-secret.text | jq .  > <path>/<pull-secret-file>

<suggestion>
cat ./pull-secret.text | jq .  > <path>/<pull-secret-file-in-json>


Additional information: 
Big portion of this page was removed from 4.4 / 4.5 doc.
https://bugzilla.redhat.com/show_bug.cgi?id=1877966

Comment 1 To Hung Sze 2020-07-28 21:17:57 UTC
The above mentioned defect to restore missing part of the doc is 
https://bugzilla.redhat.com/show_bug.cgi?id=1861531

Comment 2 To Hung Sze 2021-06-11 22:10:52 UTC
Another defect in rollback: https://bugzilla.redhat.com/show_bug.cgi?id=1971087

Comment 3 Latha S 2021-10-06 08:25:05 UTC
@tsze - I understand this bug was raised in 4.2 version and I am not sure if this is still applicable for 4.6+ versions. Please confirm. 
If it is applicable for 4.6+ versions, then please provide specific details on what needs to be fixed. Thank you!

Comment 4 To Hung Sze 2021-10-06 12:58:16 UTC
Those examples mentioned in this bz (that need to be improved)are now listed in newer versions like
https://docs.openshift.com/container-platform/4.8/installing/installing-mirroring-installation-images.html

(they were not there when I wrote this bz).

Therefore, please improve those examples as described in all versions.

Thanks.


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