CFE-374: binding options #43576

Amrita42 · 2022-03-22T10:00:19Z

Applies only to 4.11
Jira
Preview
second preview
Two previews to indicate the two plaecholders.
Was CFE-10

@sherine-k please review @quarterpin ptal

netlify · 2022-03-22T10:02:21Z

✅ Deploy Preview for osdocs ready!

Name	Link
🔨 Latest commit	`a9854dd`
🔍 Latest deploy log	https://app.netlify.com/sites/osdocs/deploys/624ad48c2c1ce00008c588b1
😎 Deploy Preview	https://deploy-preview-43576--osdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

modules/nw-ingress-controller-configuration-parameters.adoc

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

Amrita42 · 2022-03-29T10:56:46Z

@sherine-k ptal

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

sherine-k · 2022-03-30T08:00:55Z

Great work @Amrita42 . this is looking quite good now

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

nalhadef

There are different presentations of IngressController (ingress controller, Ingress Controller) all over these files. If possible, be consistent.

nalhadef · 2022-04-07T11:33:19Z

modules/nw-ingress-controller-configuration-parameters.adoc

+----
+====

 For most platforms, the `endpointPublishingStrategy` value can be updated. On GCP, you can configure the following `endpointPublishingStrategy` fields:


Spell out first use of GCP.

nalhadef · 2022-04-07T11:47:15Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

- https://kubernetes.io/docs/concepts/services-networking/ingress-controllers 
+IngressController describes a managed ingress controller for the cluster. The controller can service OpenShift Route and Kubernetes Ingress resources.
+ When an IngressController is created, a new ingress controller deployment is created to allow external traffic to reach the services that expose Ingress or Route resources. Updating this resource may lead to disruption for public facing network connections as a new ingress controller revision may be rolled out.
+ https://kubernetes.io/docs/concepts/services-networking/ingress-controllers


In the preview, the line spacing is not happy.

It could use a bit of human text and maybe a lead-in (See XYZ for information about...) to give the link some context.

nalhadef · 2022-04-07T11:49:13Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

-   tls.crt: certificate file contents   tls.key: key file contents 
- If unset, a wildcard certificate is automatically generated and used. The certificate is valid for the ingress controller domain (and subdomains) and the generated certificate's CA will be automatically integrated with the cluster's trust store. 
- If a wildcard certificate is used and shared by multiple HTTP/2 enabled routes (which implies ALPN) then clients (i.e., notably browsers) are at liberty to reuse open connections. This means a client can reuse a connection to another route and that is likely to fail. This behaviour is generally known as connection coalescing. 
+| defaultCertificate is a reference to a secret containing the default certificate served by the ingress controller. When Routes don't specify their own certificate, defaultCertificate is used.


Should "ingress controller" have initial caps?

Both first letters should be capitalized as per the Glossary https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/term_glossary.adoc#ingress-controller. I had raised a PR to such effect #44002 (comment). Once I do a rebase on this PR , the changes should ideally reflect.

nalhadef · 2022-04-07T11:50:14Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

- If a wildcard certificate is used and shared by multiple HTTP/2 enabled routes (which implies ALPN) then clients (i.e., notably browsers) are at liberty to reuse open connections. This means a client can reuse a connection to another route and that is likely to fail. This behaviour is generally known as connection coalescing. 
+| defaultCertificate is a reference to a secret containing the default certificate served by the ingress controller. When Routes don't specify their own certificate, defaultCertificate is used.
+ The secret must contain the following keys and data:
+   tls.crt: certificate file contents   tls.key: key file contents


Make these two items a list.

nalhadef · 2022-04-07T11:51:05Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

+| defaultCertificate is a reference to a secret containing the default certificate served by the ingress controller. When Routes don't specify their own certificate, defaultCertificate is used.
+ The secret must contain the following keys and data:
+   tls.crt: certificate file contents   tls.key: key file contents
+ If unset, a wildcard certificate is automatically generated and used. The certificate is valid for the ingress controller domain (and subdomains) and the generated certificate's CA will be automatically integrated with the cluster's trust store.


Same question about "ingress controller."

nalhadef · 2022-04-07T17:16:06Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

+ Valid values are: * "Global": Specifying an internal load balancer with Global client access   allows clients from any region within the VPC to communicate with the load   balancer.
+     https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#global_access
+ * "Local": Specifying an internal load balancer with Local client access   means only clients within the same region (and VPC) as the GCP load balancer   can communicate with the load balancer. Note that this is the default behavior.


Use blank lines.

Should VPC be spelled out?

Tick the values, removing the quotation marks.

nalhadef · 2022-04-07T17:16:40Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

- PROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController.  Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs.  Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController.  See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol. 
- The following values are valid for this field: 
- * The empty string. * "TCP". * "PROXY". 
+| protocol specifies whether the IngressController expects incoming connections to use plain TCP or whether the IngressController expects PROXY protocol.


Tick "protocol."

IngressController

nalhadef · 2022-04-07T17:17:34Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

+ PROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController.  Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs.  Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController.  See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol.
+ The following values are valid for this field:
+ * The empty string. * "TCP". * "PROXY".


IngressController

Use blank lines

nalhadef · 2022-04-07T17:18:45Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

 | `ciphers`
 | `array (string)`
-| ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake.  Operators may remove entries their operands do not support.  For example, to use DES-CBC3-SHA  (yaml): 
+| ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake.  Operators may remove entries their operands do not support.  For example, to use DES-CBC3-SHA  (yaml):


Tick "ciphers"

Should "DES-CBC3-SHA" be ticked

nalhadef · 2022-04-07T17:19:33Z

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc

 | `string`
-| minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml): 
-   minTLSVersion: TLSv1.1 
+| minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml):


Tick "minTLSVersion"

Add comma after 1.2

bobfuru

I'm really confused. We don't normally hardcode any of our auto-generated API docs. Before I review the rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc file, I'd like @jboxman to weigh in on whether this PR should proceed in this way. Shouldn't the enhancement request be brought to the Engineering team?

modules/nw-ingress-controller-configuration-parameters.adoc

bobfuru · 2022-04-08T14:17:52Z

Adding the hold label.

These changes have to happen in the upstream Operator repo here:
https://github.com/openshift/api/blob/master/operator/v1/types_ingress.go. From there, our auto-gen process is for that code to get ingested and injected into an OpenAPI spec file where it can then be auto-imported for our docs (the process of this import is unclear to me but @jboxman understands more).

Amrita42 · 2022-04-11T11:57:13Z

@sherine-k @quarterpin based on the recent updates in CFE-10 . I have created a new PR that does not touch the rest_api file.

Amrita42 · 2022-04-11T11:57:59Z

Closing this PR

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 22, 2022

Amrita42 force-pushed the CFE-10 branch from 0a27b1d to 247ce05 Compare March 28, 2022 09:19

sherine-k reviewed Mar 28, 2022

View reviewed changes

Amrita42 force-pushed the CFE-10 branch from 247ce05 to d45df59 Compare March 29, 2022 10:46

Amrita42 changed the title ~~[WIP] CFE-10: binding options~~ CFE-10: binding options Mar 29, 2022

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 29, 2022

Amrita42 force-pushed the CFE-10 branch from d45df59 to b554841 Compare March 29, 2022 10:51

arjunrn reviewed Mar 29, 2022

View reviewed changes

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc Outdated Show resolved Hide resolved

sherine-k reviewed Mar 29, 2022

View reviewed changes

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc Outdated Show resolved Hide resolved

Amrita42 force-pushed the CFE-10 branch from b554841 to 96ed503 Compare March 29, 2022 16:21

Amrita42 changed the title ~~CFE-10: binding options~~ [WIP]:CFE-10: binding options Mar 31, 2022

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 31, 2022

alebedev87 reviewed Apr 1, 2022

View reviewed changes

rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc Outdated Show resolved Hide resolved

binding options

a9854dd

Amrita42 force-pushed the CFE-10 branch from 96ed503 to a9854dd Compare April 4, 2022 11:20

Amrita42 changed the title ~~[WIP]:CFE-10: binding options~~ CFE-10: binding options Apr 4, 2022

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 4, 2022

Amrita42 changed the title ~~CFE-10: binding options~~ CFE-374: binding options Apr 4, 2022

nalhadef reviewed Apr 7, 2022

View reviewed changes

bobfuru added the branch/enterprise-4.11 label Apr 7, 2022

bobfuru added this to the Future Release milestone Apr 7, 2022

bobfuru reviewed Apr 7, 2022

View reviewed changes

modules/nw-ingress-controller-configuration-parameters.adoc Show resolved Hide resolved

bobfuru added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 8, 2022

Amrita42 mentioned this pull request Apr 11, 2022

CFE-10/374: binding options #44435

Merged

Amrita42 closed this Apr 11, 2022

Amrita42 deleted the CFE-10 branch April 18, 2022 06:38

kalexand-rh modified the milestones: Future Release, OCP 4.11 GA Aug 9, 2022

kalexand-rh removed the branch/enterprise-4.11 label Aug 9, 2022

kalexand-rh removed this from the OCP 4.11 GA milestone Aug 9, 2022

CFE-374: binding options #43576

CFE-374: binding options #43576

Uh oh!

Conversation

Amrita42 commented Mar 22, 2022 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Mar 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for osdocs ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Amrita42 commented Mar 29, 2022

Uh oh!

Uh oh!

Uh oh!

sherine-k commented Mar 30, 2022

Uh oh!

Uh oh!

nalhadef left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bobfuru left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bobfuru commented Apr 8, 2022

Uh oh!

Amrita42 commented Apr 11, 2022 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Amrita42 commented Apr 11, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Amrita42 commented Mar 22, 2022 •

edited by openshift-ci bot

Loading

netlify bot commented Mar 22, 2022 •

edited

Loading

Amrita42 commented Apr 11, 2022 •

edited by openshift-ci bot

Loading