Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1804764

Summary:	[DOCS] Not clear when instance metadata endpoint (169.254.169.254) is added to status.noProxy
Product:	OpenShift Container Platform	Reporter:	Jonas Nordell <jnordell>
Component:	Documentation	Assignee:	Jason Boxman <jboxman>
Status:	CLOSED CURRENTRELEASE	QA Contact:	zhaozhanqi <zzhao>
Severity:	low	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	low
Version:	4.4	CC:	aos-bugs, jokerman, vigoyal
Target Milestone:	---
Target Release:	4.4.z
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-11-23 20:46:23 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Jonas Nordell 2020-02-19 15:15:01 UTC

Document URL: 

https://docs.openshift.com/container-platform/4.3/installing/installing_bare_metal/installing-bare-metal.html#installation-configure-proxy_installing-bare-metal

https://docs.openshift.com/container-platform/4.3/installing/installing_vsphere/installing-vsphere.html#installation-configure-proxy_installing-vsphere

Section Number and Name: 

Configure the cluster-wide proxy during installation, prerequisites

Describe the issue: 

In the prerequisites the docs state:

The Proxy object’s status.noProxy field is populated by default with the instance metadata endpoint (169.254.169.254) and with the values of the networking.machineCIDR, networking.clusterNetwork.cidr, and networking.serviceNetwork fields from your installation configuration.

This is not entirely true, because we only add that to noProxy if it's one of the following platforms: 

		case configv1.AWSPlatformType, configv1.GCPPlatformType, configv1.AzurePlatformType, configv1.OpenStackPlatformType:

As stated in:

https://github.com/openshift/cluster-network-operator/blob/master/pkg/util/proxyconfig/no_proxy.go#L67 

Suggestions for improvement: 

Documentation should clearly state when the instance metadata endpoint will automatically added to status.noProxy.  

Additional information:

Comment 6 Jason Boxman 2020-11-02 18:23:41 UTC

Hi Jonas,

Thanks for reporting this!

To clarify, on vSphere and bare metal, we do not currently populate `status.noProxy` with the instance metadata endpoint, and so the documentation should reflect only those platforms for which we do populate this field with that endpoint?

Thanks!

Comment 7 Jonas Nordell 2020-11-03 07:27:49 UTC

Yes,

Or maybe better, we only populate it if one of the following platforms are used

https://github.com/openshift/cluster-network-operator/blob/release-4.5/pkg/util/proxyconfig/no_proxy.go#L86-L88

if infra.Status.PlatformStatus != nil {
		switch infra.Status.PlatformStatus.Type {
		case configv1.AWSPlatformType, configv1.GCPPlatformType, configv1.AzurePlatformType, configv1.OpenStackPlatformType:
			set.Insert("169.254.169.254")
		}

Comment 8 Jason Boxman 2020-11-06 19:06:27 UTC

I've created the following PR to clarify this:

https://github.com/openshift/openshift-docs/pull/27154

What do you think?

Thanks!