diff --git a/_topic_map.yml b/_topic_map.yml index 1637dcd47e06..b50379edaf3e 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -142,6 +142,8 @@ Topics: Distros: openshift-enterprise,openshift-origin - Name: Configuring your firewall File: configuring-firewall + - Name: Enable cluster-wide proxy + File: enable-cluster-wide-proxy # - Name: Configuring a custom certificate authority # File: configuring-custom-ca --- diff --git a/installing/install_config/enable-cluster-wide-proxy.adoc b/installing/install_config/enable-cluster-wide-proxy.adoc new file mode 100644 index 000000000000..f674cb5e6826 --- /dev/null +++ b/installing/install_config/enable-cluster-wide-proxy.adoc @@ -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: +spec: + trustedCA: + name: "" +status: +---- + +include::modules/installation-proxy-configure-object.adoc[leveloffset=+1] diff --git a/modules/installation-proxy-configure-object.adoc b/modules/installation-proxy-configure-object.adoc new file mode 100644 index 000000000000..c60135665023 --- /dev/null +++ b/modules/installation-proxy-configure-object.adoc @@ -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: +spec: + httpProxy: + httpsProxy: + noProxy: example.com + readinessEndpoints: + - http://www.google.com + - https://www.google.com + trustedCA: + name: user-ca-bundle +status: + httpProxy: + httpsProxy: + noProxy: + ----