Update CRD name to NginxProxy

Author: sjberman

docs/proposals/gateway-settings.md

@@ -5,26 +5,26 @@
 
 ## Summary
 
-This Enhancement Proposal introduces the `GatewaySettings` API, which allows Cluster Operators to define configuration at the GatewayClass level for all Gateways under that Class. This configuration is attached via the GatewayClass `parametersRef` field.
+This Enhancement Proposal introduces the `NginxProxy` API, which allows Cluster Operators to define configuration at the GatewayClass level for all Gateways (proxies) under that Class. This configuration is attached via the GatewayClass `parametersRef` field.
 
 ## Goals
 
 - Define the Gateway settings.
-- Define an API for the Gateway settings.
+- Define an API for the NginxProxy CRD.
 
 ## Non-Goals
 
-- Provide implementation details for implementing the Gateway settings.
+- Provide implementation details for implementing the NginxProxy configuration.
 
 ## Introduction
 
 ### Gateway Settings
 
-Gateway Settings are NGINX directives or configuration attached at the GatewayClass level that should be solely controlled by the Cluster Operator and should not be changed by the Application Developers. All Gateways attached to this GatewayClass will inherit these settings.
+Gateway settings are NGINX directives or configuration attached at the GatewayClass level that should be solely controlled by the Cluster Operator and should not be changed by the Application Developers. All Gateways attached to this GatewayClass will inherit these settings.
 
-These settings apply to the `main`, `http`, and/or `stream` contexts of the NGINX config.
+These settings apply to the `main`, `http`, and/or `stream` contexts of the NGINX config. The `NginxProxy` CRD will contain these settings.
 
-To begin, the Gateway Settings config will include the following NGINX directives (focusing on OpenTelemetry tracing):
+To begin, the `NginxProxy` CRD will include the following NGINX directives (focusing on OpenTelemetry tracing):
 
 - [`otel_exporter`](https://nginx.org/en/docs/ngx_otel_module.html#otel_exporter)
 - [`otel_service_name`](https://nginx.org/en/docs/ngx_otel_module.html#otel_service_name)
@@ -34,11 +34,11 @@ In the future, this config will be extended to support other directives, such as
 
 ## API, Customer Driven Interfaces, and User Experience
 
-The `GatewaySettings` API is a CRD that is a part of the `gateway.nginx.org` Group. It will be referenced in the `parametersRef` field of a GatewayClass. It will live at the cluster scope.
+The `NginxProxy` API is a CRD that is a part of the `gateway.nginx.org` Group. It will be referenced in the `parametersRef` field of a GatewayClass. It will live at the cluster scope.
 
 This is a dynamic configuration that can be changed by a user at any time, and NGF will propagate those changes to NGINX. This is something we need to clearly document in our public documentation about this feature, so that users know that all Gateways under the Class can be updated by these settings.
 
-For example, a `GatewaySettings` named `gw-settings` would be referenced as follows:
+For example, an `NginxProxy` named `proxy-settings` would be referenced as follows:
 
 ```yaml
 kind: GatewayClass
@@ -48,11 +48,11 @@ spec:
     controllerName: gateway.nginx.org/nginx-gateway-controller
     parametersRef:
         group: gateway.nginx.org/v1alpha1
-        kind: GatewaySettings
-        name: gw-settings
+        kind: NginxProxy
+        name: proxy-settings
 ```
 
-Below is the Golang API for the `GatewaySettings` API:
+Below is the Golang API for the `NginxProxy` API:
 
 ### Go
 
@@ -61,15 +61,15 @@ package v1alpha1
 
 import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
-type GatewaySettings struct {
+type NginxProxy struct {
     metav1.TypeMeta   `json:",inline"`
     metav1.ObjectMeta `json:"metadata,omitempty"`
 
-    // Spec defines the desired state of the GatewaySettings.
-    Spec GatewaySettingsSpec `json:"spec"`
+    // Spec defines the desired state of the NginxProxy.
+    Spec NginxProxySpec `json:"spec"`
 }
 
-type GatewaySettingsSpec struct {
+type NginxProxySpec struct {
     // Telemetry specifies the OpenTelemetry configuration.
     //
     // +optional
@@ -128,9 +128,9 @@ type Duration string
 
 #### GatewayClass
 
-There are two Conditions on the GatewayClass status to consider when using the `parametersRef`. The first is a `ResolvedRefs` Condition. If the `GatewaySettings` reference cannot be found, then this Condition is set to `False`.
+There are two Conditions on the GatewayClass status to consider when using the `parametersRef`. The first is a `ResolvedRefs` Condition. If the `NginxProxy` reference cannot be found, then this Condition is set to `False`.
 
-NGINX Gateway Fabric must set this Condition on the GatewayClass affected by a `GatewaySettings`.
+NGINX Gateway Fabric must set this Condition on the GatewayClass affected by an `NginxProxy`.
 Below is an example of what this Condition may look like:
 
 ```yaml
@@ -144,13 +144,13 @@ Conditions:
 
 Some additional rules:
 
-- This Condition should be added when the affected object starts being affected by a `GatewaySettings`.
-- When the `GatewaySettings` affecting that object is removed, the Condition should be removed.
-- The Observed Generation is the generation of the GatewayClass, not the generation of the `GatewaySettings`.
+- This Condition should be added when the affected object starts being affected by an `NginxProxy`.
+- When the `NginxProxy` affecting that object is removed, the Condition should be removed.
+- The Observed Generation is the generation of the GatewayClass, not the generation of the `NginxProxy`.
 
-The other condition is the existing `Accepted` condition on the GatewayClass. There is an existing reason for this Condition, `InvalidParameters`, that sets `Accepted` to `False` when the `parametersRef` fields are invalid. However, this could lead to downstream problems. For example, if a GatewayClass is `Accepted`, and then `GatewaySettings` are updated to something invalid, then marking the GatewayClass as `not Accepted` would result in the entire downstream configuration tree being nullified. This is a large disruption.
+The other condition is the existing `Accepted` condition on the GatewayClass. There is an existing reason for this Condition, `InvalidParameters`, that sets `Accepted` to `False` when the `parametersRef` fields are invalid. However, this could lead to downstream problems. For example, if a GatewayClass is `Accepted`, and then `NginxProxy` are updated to something invalid, then marking the GatewayClass as `not Accepted` would result in the entire downstream configuration tree being nullified. This is a large disruption.
 
-The proposition is to instead keep the GatewayClass as `Accepted` even if the `GatewaySettings` are invalid, but still set the reason to `InvalidParameters` and include a detailed message about the issue. In this case, default values will be reverted to for the settings, and downstream configuration will remain intact. There may be impact by reverting to defaults, but this impact is likely less than the impact of completely nullifying all Gateways/Routes/etc. that live under the GatewayClass if we instead marked it as `not Accepted`
+The proposition is to instead keep the GatewayClass as `Accepted` even if the `NginxProxy` are invalid, but still set the reason to `InvalidParameters` and include a detailed message about the issue. In this case, default values will be reverted to for the settings, and downstream configuration will remain intact. There may be impact by reverting to defaults, but this impact is likely less than the impact of completely nullifying all Gateways/Routes/etc. that live under the GatewayClass if we instead marked it as `not Accepted`.
 
 If this scenario occurs, we must be clear about what happened. Log an error, an event, and write the status. We should also set the generation to the last known good state of the resource.
 
@@ -165,16 +165,16 @@ If this scenario occurs, we must be clear about what happened. Log an error, an
 
 ## Security Considerations
 
-Validating all fields in the `GatewaySettings` is critical to ensuring that the NGINX config generated by NGINX Gateway Fabric is correct and secure.
+Validating all fields in the `NginxProxy` is critical to ensuring that the NGINX config generated by NGINX Gateway Fabric is correct and secure.
 
-All fields in the `GatewaySettings` will be validated with Open API Schema. If the Open API Schema validation rules are not sufficient, we will use [CEL](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation-rules).
+All fields in the `NginxProxy` will be validated with Open API Schema. If the Open API Schema validation rules are not sufficient, we will use [CEL](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#validation-rules).
 
-RBAC via the Kubernetes API server will ensure that only authorized users can update the CRD containing Gateway Settings.
+RBAC via the Kubernetes API server will ensure that only authorized users can update the CRD.
 
 ## Alternatives
 
 - ParametersRef with ConfigMap: A ConfigMap is another resource type where a user can provide configuration options. However, unlike CRDs, ConfigMaps do not have built-in schema validation, versioning, or conversion webhooks.
-- Direct Policy: A Direct Policy may also work for Gateway Settings. It can be attached to a Gateway and scoped to Cluster Operators through RBAC. It would allow Cluster Operators to apply settings for specific Gateways, instead of all Gateways.
+- Direct Policy: A Direct Policy may also work for Gateway settings. It can be attached to a Gateway and scoped to Cluster Operators through RBAC. It would allow Cluster Operators to apply settings for specific Gateways, instead of all Gateways.
 
 ## References