-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[WIP] PROD-615-proxy-enablement #16392
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| [id="enable-cluster-wide-proxy"] | ||
| = Enable cluster-wide proxy | ||
| include::modules/common-attributes.adoc[] | ||
| :context: enable-cluster-wide-proxy | ||
|
|
||
| toc::[] | ||
|
|
||
| The `Proxy` object is used to manage cluster-wide egress proxy. When a cluster is | ||
| installed or upgraded without proxy configured, a proxy object is still | ||
| generated but it will have a nil spec/status. For example: | ||
|
|
||
| ---- | ||
| $ oc get proxy/cluster -o yaml | ||
| apiVersion: config.openshift.io/v1 | ||
| kind: Proxy | ||
| metadata: | ||
| creationTimestamp: "2019-08-21T22:36:49Z" | ||
| generation: 2 | ||
| name: cluster | ||
| resourceVersion: "24913" | ||
| selfLink: /apis/config.openshift.io/v1/proxies/cluster | ||
| uid: <user ID string> | ||
| spec: | ||
| trustedCA: | ||
| name: "" | ||
| status: | ||
| ---- | ||
|
|
||
| include::modules/installation-proxy-configure-object.adoc[leveloffset=+1] | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * installing/insall_config/enable-cluster-wide-proxy.adoc | ||
|
|
||
| [id="installation-proxy-configure-object_{context}"] | ||
| = Configure the Proxy object | ||
|
|
||
| A cluster administrator can interact with the `Proxy` object using | ||
| {product-title} `oc` commands. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * Cluster administrator permissions | ||
| * {product-title} `oc` commands installed | ||
|
|
||
| .Procedure | ||
|
|
||
| . Use the `oc edit` command to modify the `Proxy` object: | ||
|
|
||
| ---- | ||
| $ oc edit proxy/cluster -o yaml | ||
| ---- | ||
|
|
||
| . Use the `oc get` command to view the modified file: | ||
|
|
||
| ---- | ||
| $ oc get proxy/cluster -o yaml | ||
| apiVersion: config.openshift.io/v1 | ||
| kind: Proxy | ||
| metadata: | ||
| creationTimestamp: "2019-08-21T22:36:49Z" | ||
| generation: 2 | ||
| name: cluster | ||
| resourceVersion: "24913" | ||
| selfLink: /apis/config.openshift.io/v1/proxies/cluster | ||
| uid: <user ID string> | ||
| spec: | ||
| httpProxy: <http://proxy> | ||
| httpsProxy: <https://proxy> | ||
| noProxy: example.com | ||
| readinessEndpoints: | ||
| - http://www.google.com | ||
| - https://www.google.com | ||
| trustedCA: | ||
| name: user-ca-bundle | ||
| status: | ||
| httpProxy: <http://proxy> | ||
| httpsProxy: <https://proxy> | ||
| noProxy: <IPs and URLs> | ||
| ---- |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bmcelvee currently
enable-cluster-wide-proxy.adocprovides guidance on how to modify a cluster to enable proxy, but not how to create a cluster with proxy enabled. Do you mind using some of the references I provided here to expandenable-cluster-wide-proxy.adocor create a new doc that provides the steps for creating a new cluster with proxy enabled?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we'll need a separate assembly to cover the installation with proxy piece. @bmcelvee, I might have time to make that next week.