Skip to content
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

Doc fixes #10672

Merged
merged 3 commits into from
Feb 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions changelog/v1.19.0-beta13/docs-fixes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
changelog:
- type: NON_USER_FACING
resolvesIssue: true
description: >-
Weekly doc fixes.
2 changes: 0 additions & 2 deletions docs/content/guides/observability/ui/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,3 @@ You can install the Gloo UI with a separate Helm chart to get an at-a-glance vie
To learn more, see the following guides:

{{< children descriptions="true" >}}

![Gloo UI dashboard]({{< versioned_link_path fromRoot="/img/ui-dashboard.png" >}})
10 changes: 5 additions & 5 deletions docs/content/reference/values.txt
Original file line number Diff line number Diff line change
Expand Up @@ -610,12 +610,12 @@
|discovery.serviceAccount.kubeResourceOverride.NAME|interface||override fields in the generated resource by specifying the yaml structure to override under the top-level key.|
|discovery.logLevel|string||Level at which the pod should log. Options include "info", "debug", "warn", "error", "panic" and "fatal". Default level is info.|
|gateway.enabled|bool|true|enable Gloo Edge API Gateway features|
|gateway.validation.enabled|bool|true|enable Gloo Edge API Gateway validation hook (default true)|
|gateway.validation.alwaysAcceptResources|bool|true|unless this is set this to false in order to ensure validation webhook rejects invalid resources. by default, validation webhook will only log and report metrics for invalid resource admission without rejecting them outright.|
|gateway.validation.allowWarnings|bool|true|set this to false in order to ensure validation webhook rejects resources that would have warning status or rejected status, rather than just rejected.|
|gateway.validation.warnMissingTlsSecret|bool|true|set this to false in order to treat missing tls secret references as errors, causing validation to fail.|
|gateway.validation.enabled|bool|true|Enable the Gateway validation webhook for Gloo Edge API resources (default true).|
|gateway.validation.alwaysAcceptResources|bool|true|By default, the validation webhook admits, logs, and reports metrics for invalid resources instead of rejecting them. To reject the invalid resources, set this value to false.|
|gateway.validation.allowWarnings|bool|true|By default, the validation webhook rejects resources with a rejected status. To reject resources with either a warning status or rejected status, set this value to false.|
|gateway.validation.warnMissingTlsSecret|bool|true|By default, missing TLS secret references are treated as warnings, not errors. To treat them as errors that cause validation to fail, set this value to false.|
|gateway.validation.serverEnabled|bool|true|By providing the validation field (parent of this object) the user is implicitly opting into validation. This field allows the user to opt out of the validation server, while still configuring pre-existing fields such as warn_route_short_circuiting and disable_transformation_validation.|
|gateway.validation.disableTransformationValidation|bool|false|set this to true to disable transformation validation. This may bring significant performance benefits if using many transformations, at the cost of possibly incorrect transformations being sent to Envoy. When using this value make sure to pre-validate transformations.|
|gateway.validation.disableTransformationValidation|bool|false|Set this value to true to disable transformation validation. Because this process takes time when you have many resources to translate, disabling transformation validation can bring significant performance benefits. However, you increase the risk of incorrect transformations being configured in Envoy. Therefore, make sure to pre-validate transformation when setting this value.|
|gateway.validation.warnRouteShortCircuiting|bool|false|Write a warning to route resources if validation produced a route ordering warning (defaults to false). By setting to true, this means that Gloo Edge will start assigning warnings to resources that would result in route short-circuiting within a virtual host.|
|gateway.validation.secretName|string|gateway-validation-certs|Name of the Kubernetes Secret containing TLS certificates used by the validation webhook server. This secret will be created by the certGen Job if the certGen Job is enabled.|
|gateway.validation.failurePolicy|string|Ignore|Specify how to handle unrecognized errors for Gloo resources that are returned from the Gateway validation endpoint. Supported values are 'Ignore' or 'Fail'|
Expand Down
2 changes: 1 addition & 1 deletion docs/content/static/content/version-platform.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.7.0-rc2
2.7.0
2 changes: 1 addition & 1 deletion docs/content/static/content/version_gee_latest.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.18.2
1.18.6
2 changes: 1 addition & 1 deletion docs/content/static/content/version_gee_n+1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.18.2
1.19.0-beta3
2 changes: 1 addition & 1 deletion docs/content/static/content/version_gee_n-1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.17.5
1.18.6
2 changes: 1 addition & 1 deletion docs/content/static/content/version_gee_n-1_oldpatch.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.17.4
1.18.5
2 changes: 1 addition & 1 deletion docs/content/static/content/version_geoss_latest.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.19.0-beta2
1.19.0-beta3
2 changes: 1 addition & 1 deletion docs/content/static/content/version_geoss_n+1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.19.0-beta2
1.19.0-beta3
2 changes: 1 addition & 1 deletion docs/content/static/content/version_geoss_n-1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.18.3
1.18.10
11 changes: 5 additions & 6 deletions install/helm/gloo/generate/values.go
Original file line number Diff line number Diff line change
Expand Up @@ -480,14 +480,13 @@ type ServiceAccount struct {
DisableAutomount *bool `json:"disableAutomount,omitempty" desc:"disable automounting the service account to the gateway proxy. not mounting the token hardens the proxy container, but may interfere with service mesh integrations"`
*KubeResourceOverride
}

type GatewayValidation struct {
Enabled *bool `json:"enabled,omitempty" desc:"enable Gloo Edge API Gateway validation hook (default true)"`
AlwaysAcceptResources *bool `json:"alwaysAcceptResources,omitempty" desc:"unless this is set this to false in order to ensure validation webhook rejects invalid resources. by default, validation webhook will only log and report metrics for invalid resource admission without rejecting them outright."`
AllowWarnings *bool `json:"allowWarnings,omitempty" desc:"set this to false in order to ensure validation webhook rejects resources that would have warning status or rejected status, rather than just rejected."`
WarnMissingTlsSecret *bool `json:"warnMissingTlsSecret,omitempty" desc:"set this to false in order to treat missing tls secret references as errors, causing validation to fail."`
Enabled *bool `json:"enabled,omitempty" desc:"Enable the Gateway validation webhook for Gloo Edge API resources (default true)."`
AlwaysAcceptResources *bool `json:"alwaysAcceptResources,omitempty" desc:"By default, the validation webhook admits, logs, and reports metrics for invalid resources instead of rejecting them. To reject the invalid resources, set this value to false."`
AllowWarnings *bool `json:"allowWarnings,omitempty" desc:"By default, the validation webhook rejects resources with a rejected status. To reject resources with either a warning status or rejected status, set this value to false."`
WarnMissingTlsSecret *bool `json:"warnMissingTlsSecret,omitempty" desc:"By default, missing TLS secret references are treated as warnings, not errors. To treat them as errors that cause validation to fail, set this value to false."`
ServerEnabled *bool `json:"serverEnabled,omitempty" desc:"By providing the validation field (parent of this object) the user is implicitly opting into validation. This field allows the user to opt out of the validation server, while still configuring pre-existing fields such as warn_route_short_circuiting and disable_transformation_validation."`
DisableTransformationValidation *bool `json:"disableTransformationValidation,omitempty" desc:"set this to true to disable transformation validation. This may bring significant performance benefits if using many transformations, at the cost of possibly incorrect transformations being sent to Envoy. When using this value make sure to pre-validate transformations."`
DisableTransformationValidation *bool `json:"disableTransformationValidation,omitempty" desc:"Set this value to true to disable transformation validation. Because this process takes time when you have many resources to translate, disabling transformation validation can bring significant performance benefits. However, you increase the risk of incorrect transformations being configured in Envoy. Therefore, make sure to pre-validate transformation when setting this value."`
WarnRouteShortCircuiting *bool `json:"warnRouteShortCircuiting,omitempty" desc:"Write a warning to route resources if validation produced a route ordering warning (defaults to false). By setting to true, this means that Gloo Edge will start assigning warnings to resources that would result in route short-circuiting within a virtual host."`
SecretName *string `json:"secretName,omitempty" desc:"Name of the Kubernetes Secret containing TLS certificates used by the validation webhook server. This secret will be created by the certGen Job if the certGen Job is enabled."`
FailurePolicy *string `json:"failurePolicy,omitempty" desc:"Specify how to handle unrecognized errors for Gloo resources that are returned from the Gateway validation endpoint. Supported values are 'Ignore' or 'Fail'"`
Expand Down