NE-2512: operator/ingress: Add configurationManagement option #2757
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| apiVersion: apiextensions.k8s.io/v1 # Hack because controller-gen complains if we don't have this | ||
| name: IngressController | ||
| crdName: ingresscontrollers.operator.openshift.io | ||
| featureGates: | ||
| - IngressControllerDynamicConfigurationManager | ||
| tests: | ||
| onCreate: | ||
| - name: Should be able to enable the Dynamic Configuration Manager | ||
| initial: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| tuningOptions: | ||
| configurationManagement: Dynamic | ||
| expected: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| tuningOptions: | ||
| configurationManagement: Dynamic | ||
| - name: Should be able to disable the Dynamic Configuration Manager | ||
| initial: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| tuningOptions: | ||
| configurationManagement: ForkAndReload | ||
| expected: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| tuningOptions: | ||
| configurationManagement: ForkAndReload | ||
| - name: Should not be able to specify a garbage value for DCM | ||
| initial: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| tuningOptions: | ||
| configurationManagement: garbage | ||
| expectedError: 'Unsupported value: "garbage": supported values: "Dynamic", "ForkAndReload"' | ||
| onUpdate: | ||
| - name: Should be able to enable DCM when currently no preference is specified | ||
| initial: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| updated: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| tuningOptions: | ||
| configurationManagement: Dynamic | ||
| expected: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| tuningOptions: | ||
| configurationManagement: Dynamic | ||
| - name: Should be able to turn DCM off when it is enabled | ||
| initial: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| tuningOptions: | ||
| configurationManagement: Dynamic | ||
| updated: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| expected: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| - name: Should be able to set no preference when DCM is enabled | ||
| initial: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| tuningOptions: | ||
| configurationManagement: Dynamic | ||
| updated: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| expected: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| - name: Should be able to set no preference when DCM is disabled | ||
| initial: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| tuningOptions: | ||
| configurationManagement: ForkAndReload | ||
| updated: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue | ||
| expected: | | ||
| apiVersion: operator.openshift.io/v1 | ||
| kind: IngressController | ||
| metadata: | ||
| name: default | ||
| namespace: openshift-ingress-operator | ||
| spec: | ||
| httpEmptyRequestsPolicy: Respond | ||
| idleConnectionTerminationPolicy: Immediate | ||
| closedClientConnectionPolicy: Continue |
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -2068,8 +2068,51 @@ type IngressControllerTuningOptions struct { | |||||||||
| // +kubebuilder:validation:Type:=string | ||||||||||
| // +optional | ||||||||||
| ReloadInterval metav1.Duration `json:"reloadInterval,omitempty"` | ||||||||||
|
|
||||||||||
| // configurationManagement specifies how OpenShift router should update | ||||||||||
| // the HAProxy configuration. The following values are valid for this | ||||||||||
| // field: | ||||||||||
| // | ||||||||||
| // * "ForkAndReload". | ||||||||||
| // * "Dynamic". | ||||||||||
| // | ||||||||||
| // Omitting this field means that the user has no opinion and the | ||||||||||
| // platform may choose a reasonable default. This default is subject to | ||||||||||
| // change over time. The current default is "ForkAndReload". | ||||||||||
| // | ||||||||||
| // "ForkAndReload" means that OpenShift router should rewrite the | ||||||||||
| // HAProxy configuration file and instruct HAProxy to fork and reload. | ||||||||||
| // This is OpenShift router's traditional approach. | ||||||||||
| // | ||||||||||
| // "Dynamic" means that OpenShift router may use HAProxy's control | ||||||||||
| // socket for some configuration updates and fall back to fork and | ||||||||||
| // reload for other configuration updates. This is a newer approach, | ||||||||||
| // which may be less mature than ForkAndReload. This setting can | ||||||||||
| // improve load-balancing fairness and metrics accuracy and reduce CPU | ||||||||||
| // and memory usage if HAProxy has frequent configuration updates for | ||||||||||
| // route and endpoints updates. | ||||||||||
| // | ||||||||||
| // Note: The "Dynamic" option is currently experimental and should not | ||||||||||
| // be enabled on production clusters. | ||||||||||
|
Comment on lines
+2095
to
+2096
Contributor
There was a problem hiding this comment. We don't really use the "experimental" key word. Tech Preview (or Dev Preview?) is more in line with what we usually call this.
Suggested change
Contributor
Author
There was a problem hiding this comment. If we used the "Tech Preview" wording now, what would we change it to when promoting the field to GA? The word "experimental" seems apt, and I figure we will remove the entire note when we make "Dynamic" the default setting. |
||||||||||
| // | ||||||||||
| // +openshift:enable:FeatureGate=IngressControllerDynamicConfigurationManager | ||||||||||
| // +optional | ||||||||||
| ConfigurationManagement IngressControllerConfigurationManagement `json:"configurationManagement,omitempty"` | ||||||||||
|
Contributor
There was a problem hiding this comment. Did you explore adding configuration management as a first-class ingress spec field instead of a field of tuning options? My reasoning: I would expect that we need to add further DCM configuration in the future, and this "tuning option" is the only one that isn't just number-based simple configuration.
Contributor
Author
There was a problem hiding this comment. I don't anticipate adding DCM-specific options. In fact, I have been very insistent that DCM should be an internal implementation detail with absolutely no customer-facing configuration. We are only adding the tuning option so that customers have an escape option if some critical issue is discovered after we enable it by default. That said, should the need to add DCM tuning options arise, we could change |
||||||||||
| } | ||||||||||
|
|
||||||||||
| // IngressControllerConfigurationManagement specifies whether always to use | ||||||||||
| // fork-and-reload to update the HAProxy configuration or whether to use | ||||||||||
| // HAProxy's control socket for some configuration updates. | ||||||||||
| // | ||||||||||
| // +enum | ||||||||||
| // +kubebuilder:validation:Enum=Dynamic;ForkAndReload | ||||||||||
| type IngressControllerConfigurationManagement string | ||||||||||
|
|
||||||||||
| const ( | ||||||||||
| IngressControllerConfigurationManagementDynamic IngressControllerConfigurationManagement = "Dynamic" | ||||||||||
| IngressControllerConfigurationManagementForkAndReload IngressControllerConfigurationManagement = "ForkAndReload" | ||||||||||
| ) | ||||||||||
|
|
||||||||||
| // HTTPEmptyRequestsPolicy indicates how HTTP connections for which no request | ||||||||||
| // is received should be handled. | ||||||||||
| // +kubebuilder:validation:Enum=Respond;Ignore | ||||||||||
|
|
||||||||||
Oops, something went wrong.
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.
nit:
ForkAndReloadassumes the user knows implementation details. How aboutLegacy, orReloadTriggered?Uh oh!
There was an error while loading. Please reload this page.
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.
Well, that's why it's under
TuningOptions. * grin *. There are two reasons why someone would setconfigurationManagement: ForkAndReload:configurationManagement: Dynamicbroke something, and so setting the other option (whatever it is called) is the best bet to unbreak things.Originally I had
dynamicConfigManager: Enabled | Disabled, and Joel suggestedconfigurationManagement: Dynamic | ForkAndReloadto make it more explicit. UsingconfigurationManagement: Dynamic | Legacyseems like a step backwards, andReloadTriggeredseems to me to be more opaque thanForkAndReload. Maybe @JoelSpeed could offer an outside perspective on whether "Legacy" or "ReloadTriggered" is clearer than "ForkAndReload".