docs: update v1.1.0-rc.1 release notes (envoyproxy#3821)

update v1.1.0-rc.1 release notes Signed-off-by: Guy Daich <[email protected]>
Xunzhuo · Jul 12, 2024 · c9d3e45 · c9d3e45
1 parent 5ca2c0e
commit c9d3e45
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/release-notes/v1.1.0-rc.1.yaml b/release-notes/v1.1.0-rc.1.yaml
@@ -130,6 +130,16 @@ changes:
 
     breaking-change: |
       Gateway-API BackendTLSPolicy v1alpha3 is incompatible with previous versions of the CRD
+      xPolicy targetRefs can no longer specify a namespace, since Gateway-API v1.1.0 uses LocalPolicyTargetReferenceWithSectionName in Policy resources
+
+
+    deprecation: |
+      xPolicy targetRef is deprecated, use targetRefs instead
+      SecurityPolicy ExtAuth BackendRef is deprecated, use BackendRefs instead
+      OpenTelemetry Proxy Access Log Host and Port are deprecated, use backendRefs instead
+      OpenTelemetry Proxy Metrics Sink Host and Port are deprecated, use backendRefs instead
+      Proxy Tracing Provider Host and Port are deprecated, use backendRefs instead
+      Envoy Gateway Extension Server Host and Port are deprecated, use BackendEndpoint instead
 
 
   - area: conformance

diff --git a/site/content/en/latest/tasks/quickstart.md b/site/content/en/latest/tasks/quickstart.md
@@ -110,6 +110,8 @@ kubectl apply -f ./gateway-helm/crds/generated
 
 Update your `BackendTLSPolicy` and `GRPCRoute` resources according to Gateway-API [v1.1 Upgrade Notes](https://gateway-api.sigs.k8s.io/guides/#v11-upgrade-notes)
 
+Update your Envoy Gateway xPolicy resources: remove the namespace section from targetRef. 
+
 Install Envoy Gateway v1.1.0:
 
 ```shell

diff --git a/site/content/en/news/releases/notes/v1.1.0-rc.1.md b/site/content/en/news/releases/notes/v1.1.0-rc.1.md
@@ -128,6 +128,15 @@ Date: July 8, 2024
 
 ### Breaking Changes
 - Gateway-API BackendTLSPolicy v1alpha3 is incompatible with previous versions of the CRD
+- xPolicy targetRefs can no longer specify a namespace, since Gateway-API v1.1.0 uses LocalPolicyTargetReferenceWithSectionName in Policy resources
+
+### Deprecations
+- xPolicy targetRef is deprecated, use targetRefs instead
+- SecurityPolicy ExtAuth BackendRef is deprecated, use BackendRefs instead
+- OpenTelemetry Proxy Access Log Host and Port are deprecated, use backendRefs instead
+- OpenTelemetry Proxy Metrics Sink Host and Port are deprecated, use backendRefs instead
+- Proxy Tracing Provider Host and Port are deprecated, use backendRefs instead
+- Envoy Gateway Extension Server Host and Port are deprecated, use BackendEndpoint instead
 
 ## Conformance
 - Added Supported Features to Gateway Class

diff --git a/tools/src/release-notes-docs/yml2md.py b/tools/src/release-notes-docs/yml2md.py
@@ -55,6 +55,10 @@ def convert_yaml_to_markdown(input_yaml_file, output_markdown_path):
                 file.write("### Breaking Changes\n")
                 file.write(change_to_markdown(area['breaking-change']) + '\n\n')
 
+            if 'deprecation' in area:
+                file.write("### Deprecations\n")
+                file.write(change_to_markdown(area['deprecation']) + '\n\n')
+
     print("Markdown file '{}' has been generated.".format(output_markdown_file))
 
 if __name__ == "__main__":