Bug 1814932 - [DOCS] Mismatch of the names in step and explanation when creating mirror registry
Summary: [DOCS] Mismatch of the names in step and explanation when creating mirror reg...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.3.z
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: 4.3.z
Assignee: Kathryn Alexander
QA Contact: Liang Xia
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-03-19 04:12 UTC by Liang Xia
Modified: 2020-03-24 15:19 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-03-24 15:19:47 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Liang Xia 2020-03-19 04:12:01 UTC
Document URL: 
https://docs.openshift.com/container-platform/4.3/installing/install_config/installing-restricted-networks-preparations.html#installation-adding-registry-pull-secret_installing-restricted-networks-preparations

Section Number and Name: 
Step 4 in Procedure


Describe the issue: 
In the step, we have '<local_registry_host_name>', '<local_registry_host_port>' and '<credentials>' act as place holders.
But in the explanation after the step, 'bastion_host_name' is used, where it should be 'local_registry_host_name'


Suggestions for improvement: 
Replace 'bastion_host_name' with 'local_registry_host_name'



Additional information: 
--------------------------------------------------------
Edit the new file and add a section that describes your registry to it:

  "auths": {
...
    "<local_registry_host_name>:<local_registry_host_port>": { 
      "auth": "<credentials>", 
      "email": "you"
  },
...

	For bastion_host_name, specify the registry domain name that you specified in your certificate, and for <local_registry_host_port>, specify the port that your mirror registry uses to serve content.
	For <credentials>, specify the base64-encoded user name and password for the mirror registry that you generated.

The file resembles the following example:

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

Comment 1 Liang Xia 2020-03-19 04:13:19 UTC
This should apply to enterprise-4.2/4.3/4.4

Comment 2 Liang Xia 2020-03-19 04:18:20 UTC
Propose PR, https://github.com/openshift/openshift-docs/pull/20580

Comment 3 Kathryn Alexander 2020-03-19 16:28:43 UTC
Thanks! I've merged the change and am waiting for it to go live.


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