Skip to content

Commit

Permalink
Deprecation notices for GraphQL & Plugin Auth in 1.18 (#10371)
Browse files Browse the repository at this point in the history
Co-authored-by: Art <[email protected]>
  • Loading branch information
Rachael-Graham and artberger authored Nov 25, 2024
1 parent 483799e commit 2b20acf
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 11 deletions.
11 changes: 7 additions & 4 deletions .github/workflows/push-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ jobs:
copy-docs:
runs-on: ubuntu-latest
outputs:
minor: ${{ steps.version-variables.outputs.minor }}
steps:
- name: Get LTS branch version
id: lts-version
Expand Down Expand Up @@ -162,16 +164,17 @@ jobs:
slack-notification:
runs-on: ubuntu-latest
needs:
- copy-docs
if: ${{ always() }}
needs: copy-docs
steps:
- name: Notify on workflow success
if: |
needs.copy-docs.result == 'success'
env:
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
VERSION: ${{needs.copy-docs.outputs.minor}}
run: |
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>"
MESSAGE="✅ *Success:* Automated copy of reference docs for ${VERSION} was successful. <https://github.com/solo-io/docs/pulls|Review the PR>"
curl \
-d "text=$MESSAGE" \
Expand All @@ -185,7 +188,7 @@ jobs:
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
run: |
JOB_URL=https://github.com/solo-io/gloo/actions/runs/${GITHUB_RUN_ID}
MESSAGE="❌ *Failure:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} failed. <${JOB_URL}|Review the workflow failure>"
MESSAGE="❌ *Failure:* Automated copy of reference docs for ${VERSION} failed. <${JOB_URL}|Review the workflow failure>"
curl \
-d "text=$MESSAGE" \
Expand Down
11 changes: 11 additions & 0 deletions changelog/v1.18.0-rc3/docs-deprecation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
changelog:
- type: NON_USER_FACING
issueLink: https://github.com/solo-io/solo-projects/issues/7118
resolvesIssue: true
description: >-
Add deprecation notice for GraphQL in 1.18+.
- type: NON_USER_FACING
issueLink: https://github.com/solo-io/solo-projects/issues/6960
resolvesIssue: true
description: >-
Add deprecation notice for Plugin Auth in 1.18+.
3 changes: 2 additions & 1 deletion docs/content/guides/graphql/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ description: Enable GraphQL resolution.
Set up API gateway and GraphQL server functionality for your apps in the same process by using Gloo Gateway.

{{% notice warning %}}
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release.
{{% /notice %}}

{{% notice note %}}
This feature is available only in Gloo Gateway Enterprise.
{{% /notice %}}
Expand Down
6 changes: 5 additions & 1 deletion docs/content/guides/graphql/getting_started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ description: Get started with enabling GraphQL in Gloo Gateway and resolving Gra

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

{{% notice warning %}}
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release.
{{% /notice %}}

{{% notice note %}}
This feature is available only in Gloo Gateway Enterprise. Remote execution is supported only in versions 1.14.0 and later.
This feature is available only in Gloo Gateway Enterprise.
{{% /notice %}}

{{% children description="true" %}}
6 changes: 5 additions & 1 deletion docs/content/guides/graphql/getting_started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ description: Install GraphQL in Gloo Gateway and enable API spec discovery for u

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

{{% notice warning %}}
This feature is deprecated in Gloo Gateway 1.18 and will be removed in a future release.
{{% /notice %}}

{{% notice note %}}
This feature is available only in Gloo Gateway Enterprise. Remote execution is supported only in versions 1.14.0 and later.
This feature is available only in Gloo Gateway Enterprise.
{{% /notice %}}

## Step 1: Install GraphQL in Gloo Gateway
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ weight: 90
description: Extend Gloo Gateway's built-in auth server with custom Go plugins
---

{{% notice note %}}
This feature was introduced with **Gloo Gateway Enterprise**, release 0.18.11. If you are using an earlier version, this tutorial will not work.
{{% notice warning %}}
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.
{{% /notice %}}

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:
Expand Down
6 changes: 4 additions & 2 deletions docs/content/operations/upgrading/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,12 @@ The following lists consist of the changes that were initially introduced with t

* **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/" >}}).

<!--
**Deprecated features**:
N/A

* **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.
* **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.

<!--
**Removed features**:
N/A
-->
Expand Down

0 comments on commit 2b20acf

Please sign in to comment.