Skip to content

Commit 2b20acf

Browse files
Deprecation notices for GraphQL & Plugin Auth in 1.18 (#10371)
Co-authored-by: Art <[email protected]>
1 parent 483799e commit 2b20acf

File tree

7 files changed

+36
-11
lines changed

7 files changed

+36
-11
lines changed

.github/workflows/push-docs.yaml

+7-4
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ jobs:
2525
2626
copy-docs:
2727
runs-on: ubuntu-latest
28+
outputs:
29+
minor: ${{ steps.version-variables.outputs.minor }}
2830
steps:
2931
- name: Get LTS branch version
3032
id: lts-version
@@ -162,16 +164,17 @@ jobs:
162164
163165
slack-notification:
164166
runs-on: ubuntu-latest
165-
needs:
166-
- copy-docs
167+
if: ${{ always() }}
168+
needs: copy-docs
167169
steps:
168170
- name: Notify on workflow success
169171
if: |
170172
needs.copy-docs.result == 'success'
171173
env:
172174
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
175+
VERSION: ${{needs.copy-docs.outputs.minor}}
173176
run: |
174-
MESSAGE="✅ *Success:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} was successful. <https://github.com/solo-io/docs/pulls|Review the PR>"
177+
MESSAGE="✅ *Success:* Automated copy of reference docs for ${VERSION} was successful. <https://github.com/solo-io/docs/pulls|Review the PR>"
175178
176179
curl \
177180
-d "text=$MESSAGE" \
@@ -185,7 +188,7 @@ jobs:
185188
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
186189
run: |
187190
JOB_URL=https://github.com/solo-io/gloo/actions/runs/${GITHUB_RUN_ID}
188-
MESSAGE="❌ *Failure:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} failed. <${JOB_URL}|Review the workflow failure>"
191+
MESSAGE="❌ *Failure:* Automated copy of reference docs for ${VERSION} failed. <${JOB_URL}|Review the workflow failure>"
189192
190193
curl \
191194
-d "text=$MESSAGE" \
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
changelog:
2+
- type: NON_USER_FACING
3+
issueLink: https://github.com/solo-io/solo-projects/issues/7118
4+
resolvesIssue: true
5+
description: >-
6+
Add deprecation notice for GraphQL in 1.18+.
7+
- type: NON_USER_FACING
8+
issueLink: https://github.com/solo-io/solo-projects/issues/6960
9+
resolvesIssue: true
10+
description: >-
11+
Add deprecation notice for Plugin Auth in 1.18+.

docs/content/guides/graphql/_index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ description: Enable GraphQL resolution.
77
Set up API gateway and GraphQL server functionality for your apps in the same process by using Gloo Gateway.
88

99
{{% notice warning %}}
10-
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release
10+
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release.
1111
{{% /notice %}}
12+
1213
{{% notice note %}}
1314
This feature is available only in Gloo Gateway Enterprise.
1415
{{% /notice %}}

docs/content/guides/graphql/getting_started/_index.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ description: Get started with enabling GraphQL in Gloo Gateway and resolving Gra
66

77
Set up API gateway and GraphQL server functionality for your apps in the same process by using Gloo Gateway.
88

9+
{{% notice warning %}}
10+
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release.
11+
{{% /notice %}}
12+
913
{{% notice note %}}
10-
This feature is available only in Gloo Gateway Enterprise. Remote execution is supported only in versions 1.14.0 and later.
14+
This feature is available only in Gloo Gateway Enterprise.
1115
{{% /notice %}}
1216

1317
{{% children description="true" %}}

docs/content/guides/graphql/getting_started/setup.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ description: Install GraphQL in Gloo Gateway and enable API spec discovery for u
66

77
Set up API gateway and GraphQL server functionality for your apps in the same process by using Gloo Gateway.
88

9+
{{% notice warning %}}
10+
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release.
11+
{{% /notice %}}
12+
913
{{% notice note %}}
10-
This feature is available only in Gloo Gateway Enterprise. Remote execution is supported only in versions 1.14.0 and later.
14+
This feature is available only in Gloo Gateway Enterprise.
1115
{{% /notice %}}
1216

1317
## Step 1: Install GraphQL in Gloo Gateway

docs/content/guides/security/auth/extauth/plugin_auth/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ weight: 90
44
description: Extend Gloo Gateway's built-in auth server with custom Go plugins
55
---
66

7-
{{% notice note %}}
8-
This feature was introduced with **Gloo Gateway Enterprise**, release 0.18.11. If you are using an earlier version, this tutorial will not work.
7+
{{% notice warning %}}
8+
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release. Consider using the [Passthrough Auth]({{< versioned_link_path fromRoot="/guides/security/auth/extauth/passthrough_auth/" >}}) feature instead.
99
{{% /notice %}}
1010

1111
We have seen that one way of implementing custom authentication logic is by [providing your own auth server]({{< versioned_link_path fromRoot="/guides/security/auth/custom_auth" >}}). While this approach gives you great freedom, it also comes at a cost:

docs/content/operations/upgrading/faq.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,12 @@ The following lists consist of the changes that were initially introduced with t
9999

100100
* **Apply JWT policy at the route-level**: Now, you can apply JWT policies to specific routes by configuring the `jwtProvidersStaged` settings in the route option. Previously, JWT policies applied at the gateway level and were configured in only the VirtualHost option. With this new feature, you can apply JWT policies at both the route and gateway level. For more information and example steps, see [Route-level JWT policy]({{< versioned_link_path fromRoot="/security/auth/jwt/route-jwt-policy/" >}}).
101101

102-
<!--
103102
**Deprecated features**:
104-
N/A
105103

104+
* **GraphQL integration**: The [GraphQL integration]({{< versioned_link_path fromRoot="/guides/graphql/" >}}) is deprecated in Gloo Gateway 1.18 and will be removed in a future release.
105+
* **Plugin Auth**: The [Plugin Auth]({{< versioned_link_path fromRoot="/guides/security/auth/extauth/plugin_auth/" >}}) feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release. Consider using the [Passthrough Auth]({{< versioned_link_path fromRoot="/guides/security/auth/extauth/passthrough_auth/" >}}) feature instead.
106+
107+
<!--
106108
**Removed features**:
107109
N/A
108110
-->

0 commit comments

Comments
 (0)