diff --git a/data/deprecations/16-7-remove-jwks-endpoint.yml b/data/deprecations/16-7-remove-jwks-endpoint.yml new file mode 100644 index 0000000000000000000000000000000000000000..6d59f4ff3be617a8f55d2875c7f479bf08fd41b2 --- /dev/null +++ b/data/deprecations/16-7-remove-jwks-endpoint.yml @@ -0,0 +1,26 @@ +# +# REQUIRED FIELDS +# +- title: "JWT `/-/jwks` instance endpoint is deprecated" + removal_milestone: "17.0" # (required) The milestone when this feature is planned to be removed + announcement_milestone: "16.7" # (required) The milestone when this feature was first announced as deprecated. + breaking_change: true # (required) Change to false if this is not a breaking change. + reporter: jocelynjane # (required) GitLab username of the person reporting the change + stage: verify # (required) String value of the stage that the feature was created in. e.g., Growth + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/221031 # (required) Link to the deprecation issue in GitLab + body: | # (required) Do not modify this line, instead modify the lines below. + With the [deprecation of old JSON web token versions](https://docs.gitlab.com/ee/update/deprecations.html?removal_milestone=17.0#old-versions-of-json-web-tokens-are-deprecated) in GitLab 17.0, the associated `/-/jwks` endpoint which is an alias for `/oauth/discovery/keys` is no longer necessary and will be removed. Please replace any uses of `/-/jwks` with `/oauth/discovery/keys`, for example change `https://gitlab.example.com/-/jwks` to `https://gitlab.example.com/oauth/discovery/keys`. +# +# OPTIONAL END OF SUPPORT FIELDS +# +# If an End of Support period applies, the announcement should be shared with GitLab Support +# in the `#spt_managers` channel in Slack, and mention `@gitlab-com/support` in this MR. +# + end_of_support_milestone: # (optional) Use "XX.YY" format. The milestone when support for this feature will end. + # + # OTHER OPTIONAL FIELDS + # + tiers: # (optional - may be required in the future) An array of tiers that the feature is available in currently. e.g., [Free, Silver, Gold, Core, Premium, Ultimate] + documentation_url: # (optional) This is a link to the current documentation page + image_url: # (optional) This is a link to a thumbnail image depicting the feature + video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index bcbad162bc578858fca6f066b2679ace8dba61f3..225d3484db9bed8e50ec05d59589ee81ce14f0f8 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -725,6 +725,20 @@ If you do access the internal container registry API and use the original tag de <div class="deprecation breaking-change" data-milestone="17.0"> +### JWT `/-/jwks` instance endpoint is deprecated + +<div class="deprecation-notes"> +- Announced in GitLab <span class="milestone">16.7</span> +- Removal in GitLab <span class="milestone">17.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) +- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/221031). +</div> + +With the [deprecation of old JSON web token versions](https://docs.gitlab.com/ee/update/deprecations.html?removal_milestone=17.0#old-versions-of-json-web-tokens-are-deprecated) in GitLab 17.0, the associated `/-/jwks` endpoint which is an alias for `/oauth/discovery/keys` is no longer necessary and will be removed. Please replace any uses of `/-/jwks` with `/oauth/discovery/keys`, for example change `https://gitlab.example.com/-/jwks` to `https://gitlab.example.com/oauth/discovery/keys`. + +</div> + +<div class="deprecation breaking-change" data-milestone="17.0"> + ### Legacy Geo Prometheus metrics <div class="deprecation-notes">