Skip to content

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

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.

Sign up for GitHub

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

Merged
guydc merged 3 commits into from
Jul 12, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96d17b4
update v1.1.0-rc.1 release notes
guydc Jul 11, 2024
05ca8a8
Merge branch 'main' into doc-v1.1-rc.1-update
guydc Jul 11, 2024
a74c121
Merge branch 'main' into doc-v1.1-rc.1-update
guydc Jul 11, 2024
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
10 changes: 10 additions & 0 deletions release-notes/v1.1.0-rc.1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions site/content/en/latest/tasks/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions site/content/en/news/releases/notes/v1.1.0-rc.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions tools/src/release-notes-docs/yml2md.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__":
Expand Down