docs: update config types doc (#1348)

Signed-off-by: hejianpeng <[email protected]>
envoyproxy · Apr 25, 2023 · edb56fe · edb56fe
1 parent a05c1af
commit edb56fe
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/docs/latest/api/config_types.md b/docs/latest/api/config_types.md
@@ -28,7 +28,10 @@ EnvoyGateway is the schema for the envoygateways API.
 | --- | --- |
 | `apiVersion` _string_ | `config.gateway.envoyproxy.io/v1alpha1`
 | `kind` _string_ | `EnvoyGateway`
-| `EnvoyGatewaySpec` _[EnvoyGatewaySpec](#envoygatewayspec)_ | EnvoyGatewaySpec defines the desired state of EnvoyGateway. |
+| `gateway` _[Gateway](#gateway)_ | Gateway defines desired Gateway API specific configuration. If unset, default configuration parameters will apply. |
+| `provider` _[EnvoyGatewayProvider](#envoygatewayprovider)_ | Provider defines the desired provider and provider-specific configuration. If unspecified, the Kubernetes provider is used with default configuration parameters. |
+| `rateLimit` _[RateLimit](#ratelimit)_ | RateLimit defines the configuration associated with the Rate Limit service deployed by Envoy Gateway required to implement the Global Rate limiting functionality. The specific rate limit service used here is the reference implementation in Envoy. For more details visit https://github.com/envoyproxy/ratelimit. This configuration is unneeded for "Local" rate limiting. |
+| `extension` _[Extension](#extension)_ | Extension defines an extension to register for the Envoy Gateway Control Plane. |
 
 
 ## EnvoyGatewayFileProvider
@@ -63,6 +66,7 @@ _Appears in:_
 EnvoyGatewayProvider defines the desired configuration of a provider.
 
 _Appears in:_
+- [EnvoyGateway](#envoygateway)
 - [EnvoyGatewaySpec](#envoygatewayspec)
 
 | Field | Description |
@@ -160,6 +164,7 @@ _Appears in:_
 Extension defines the configuration for registering an extension to the Envoy Gateway control plane.
 
 _Appears in:_
+- [EnvoyGateway](#envoygateway)
 - [EnvoyGatewaySpec](#envoygatewayspec)
 
 | Field | Description |
@@ -210,7 +215,7 @@ _Appears in:_
 
 | Field | Description |
 | --- | --- |
-| `certificateRef` _[SecretObjectReference](#secretobjectreference)_ | CertificateRef contains a references to objects (Kubernetes objects or otherwise) that contains a TLS certificate and private keys. These certificates are used to establish a TLS handshake to the extension server. 
+| `certificateRef` _[SecretObjectReference](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.SecretObjectReference)_ | CertificateRef contains a references to objects (Kubernetes objects or otherwise) that contains a TLS certificate and private keys. These certificates are used to establish a TLS handshake to the extension server. 
  CertificateRef can only reference a Kubernetes Secret at this time. |
 
 
@@ -221,6 +226,7 @@ _Appears in:_
 Gateway defines the desired Gateway API configuration of Envoy Gateway.
 
 _Appears in:_
+- [EnvoyGateway](#envoygateway)
 - [EnvoyGatewaySpec](#envoygatewayspec)
 
 | Field | Description |
@@ -362,6 +368,7 @@ _Appears in:_
 RateLimit defines the configuration associated with the Rate Limit Service used for Global Rate Limiting.
 
 _Appears in:_
+- [EnvoyGateway](#envoygateway)
 - [EnvoyGatewaySpec](#envoygatewayspec)
 
 | Field | Description |

diff --git a/tools/crd-ref-docs/config.yaml b/tools/crd-ref-docs/config.yaml
@@ -10,3 +10,7 @@ processor:
 render:
   # Version of Kubernetes to use when generating links to Kubernetes API documentation.
   kubernetesVersion: 1.26
+  knownTypes:
+    - name: SecretObjectReference
+      package: sigs.k8s.io/gateway-api/apis/v1beta1
+      link: https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io/v1beta1.SecretObjectReference
diff --git a/tools/src/crd-ref-docs/go.mod b/tools/src/crd-ref-docs/go.mod
@@ -2,7 +2,7 @@ module local
 
 go 1.20
 
-require github.com/elastic/crd-ref-docs v0.0.8
+require github.com/elastic/crd-ref-docs v0.0.9-0.20230424093950-7444d6aeffc4
 
 require (
 	github.com/BurntSushi/toml v1.2.1 // indirect

diff --git a/tools/src/crd-ref-docs/go.sum b/tools/src/crd-ref-docs/go.sum
@@ -10,6 +10,8 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/elastic/crd-ref-docs v0.0.8 h1:Sy0A24E+L5aCj/8BGTgxkumCSNeckg4650d96o7QHiU=
 github.com/elastic/crd-ref-docs v0.0.8/go.mod h1:Jd1XDGgrvHzd/+qCf4SwBnOnLl4RaFRjind0ORnHovo=
+github.com/elastic/crd-ref-docs v0.0.9-0.20230424093950-7444d6aeffc4 h1:ckr39uH7B7nECmKS9zu+3js/dYeR84vyUgwAEaRU6k8=
+github.com/elastic/crd-ref-docs v0.0.9-0.20230424093950-7444d6aeffc4/go.mod h1:xIVa/Q7mJK/M2KUGFPDJEVmF0AhdvOJEz62c1zj5VYc=
 github.com/fatih/color v1.10.0/go.mod h1:ELkj/draVOlAH/xkhN6mQ50Qd0MPOk5AAr3maGEBuJM=
 github.com/fatih/color v1.14.1 h1:qfhVLaG5s+nCROl1zJsZRxFeYrHLqWroPOQ8BWiNb4w=
 github.com/fatih/color v1.14.1/go.mod h1:2oHN61fhTpgcxD3TSWCgKDiH1+x4OiDVVGH8WlgGZGg=