mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-10 03:05:48 +00:00
Add v3 API token deprecation notice (#2250)
* Add v3 API token deprecation warning shared file / Add warning to applicable pages * Update Deprecation of v3 API tokens warning * Update shared-files/_v3-api-tokens-deprecation-warning.md Co-authored-by: Billy Tat <btat@suse.com> * Update src/theme/MDXComponents.js Co-authored-by: Billy Tat <btat@suse.com> * Fix/update typo in shared file name (v3APITokensDeprecationWarning) * Fix wording in Deprecation of v3 API tokens warning --------- Co-authored-by: Billy Tat <btat@suse.com>
This commit is contained in:
Lucas Saintarbor
co-authored by
Billy Tat
Billy Tat
parent
2f4b822cb3
commit
85a32cd276
@@ -6,6 +6,8 @@ title: Using API Tokens
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/api-tokens"/>
|
||||
</head>
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
Rancher v2.8.0 introduced the [Rancher Kubernetes API](./api-reference.mdx) which can be used to manage Rancher resources through `kubectl`. This page covers information on API tokens used with the [Rancher CLI](../reference-guides/cli-with-rancher/cli-with-rancher.md), [kubeconfig files](../how-to-guides/new-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md#about-the-kubeconfig-file), Terraform and the [v3 API browser](./v3-rancher-api-guide.md#enable-view-in-api).
|
||||
|
||||
By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. Tokens are not invalidated by changing a password.
|
||||
|
||||
@@ -6,6 +6,8 @@ title: Tokens
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/workflows/tokens"/>
|
||||
</head>
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
## Token Resource
|
||||
|
||||
Rancher has an imperative API resource `tokens.ext.cattle.io` that allows you to generate tokens for authenticating with Rancher.
|
||||
|
||||
@@ -6,6 +6,8 @@ title: API Keys
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/user-settings/api-keys"/>
|
||||
</head>
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
## API Keys and User Authentication
|
||||
|
||||
If you want to access your Rancher clusters, projects, or other objects using external applications, you can do so using the Rancher API. However, before your application can access the API, you must provide the app with a key used to authenticate with Rancher. You can obtain a key using the Rancher UI.
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
title: API 令牌
|
||||
---
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
默认情况下，某些集群级别的 API 令牌是使用无限期 TTL（`ttl=0`）生成的。换言之，除非你让令牌失效，否则 `ttl=0` 的 API 令牌永远不会过期。令牌不会因为更改密码而失效。
|
||||
|
||||
要停用 API 令牌，你可以删除令牌或停用用户账号。
|
||||
|
||||
+2
@@ -2,6 +2,8 @@
|
||||
title: API 密钥
|
||||
---
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
## API 密钥和用户身份验证
|
||||
|
||||
如果你想通过外部应用程序来访问 Rancher 集群、项目或其他对象，你可以使用 Rancher API。但是，在你的应用程序可以访问 API 之前，你必须为应用程序提供用于向 Rancher 进行身份验证的密钥。你可以通过 Rancher UI 获取密钥。
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
title: API 令牌
|
||||
---
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
默认情况下，某些集群级别的 API 令牌是使用无限期 TTL（`ttl=0`）生成的。换言之，除非你让令牌失效，否则 `ttl=0` 的 API 令牌永远不会过期。令牌不会因为更改密码而失效。
|
||||
|
||||
要停用 API 令牌，你可以删除令牌或停用用户账号。
|
||||
|
||||
+2
@@ -2,6 +2,8 @@
|
||||
title: API 密钥
|
||||
---
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
## API 密钥和用户身份验证
|
||||
|
||||
如果你想通过外部应用程序来访问 Rancher 集群、项目或其他对象，你可以使用 Rancher API。但是，在你的应用程序可以访问 API 之前，你必须为应用程序提供用于向 Rancher 进行身份验证的密钥。你可以通过 Rancher UI 获取密钥。
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
:::warning Deprecation of v3 API tokens
|
||||
Rancher v2.13 introduced a new token resource in the `ext.cattle.io` API group to serve as the public API for tokens, which was only accessible through `kubectl`.
|
||||
|
||||
Starting with Rancher v2.14.0:
|
||||
|
||||
- Legacy v3 API tokens (`tokens.management.cattle.io`) are being phased out and scheduled for removal in a future release. If you currently rely on legacy tokens for automation or API access, transition to the new `tokens.ext.cattle.io` tokens to ensure continued compatibility.
|
||||
- The Rancher dashboard provides basic support for `tokens.ext.cattle.io` (create, view or list, and delete).
|
||||
:::
|
||||
@@ -16,6 +16,7 @@ import ConfigureSLOOidc from '/shared-files/_configure-slo-oidc.md';
|
||||
import EOLRKE1Warning from '/shared-files/_eol-rke1-warning.md';
|
||||
import PermissionsWarning from '/shared-files/_permissions-warning.md';
|
||||
import SamlOpenLDAPGroupPermissions from '/shared-files/_saml-openldap-group-permissions.md';
|
||||
import v3APITokensDeprecationWarning from '/shared-files/_v3-api-tokens-deprecation-warning.md';
|
||||
import OIDCPKCESupport from '/shared-files/_oidc-pkce-support.md';
|
||||
|
||||
|
||||
@@ -39,5 +40,6 @@ export default {
|
||||
EOLRKE1Warning,
|
||||
PermissionsWarning,
|
||||
SamlOpenLDAPGroupPermissions,
|
||||
v3APITokensDeprecationWarning,
|
||||
OIDCPKCESupport,
|
||||
};
|
||||
|
||||
@@ -6,6 +6,8 @@ title: Using API Tokens
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/api-tokens"/>
|
||||
</head>
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
Rancher v2.8.0 introduced the [Rancher Kubernetes API](./api-reference.mdx) which can be used to manage Rancher resources through `kubectl`. This page covers information on API tokens used with the [Rancher CLI](../reference-guides/cli-with-rancher/cli-with-rancher.md), [kubeconfig files](../how-to-guides/new-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint.md#about-the-kubeconfig-file), Terraform and the [v3 API browser](./v3-rancher-api-guide.md#enable-view-in-api).
|
||||
|
||||
By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. Tokens are not invalidated by changing a password.
|
||||
|
||||
@@ -6,6 +6,8 @@ title: Tokens
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/api/workflows/tokens"/>
|
||||
</head>
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
## Token Resource
|
||||
|
||||
Rancher has an imperative API resource `tokens.ext.cattle.io` that allows you to generate tokens for authenticating with Rancher.
|
||||
|
||||
@@ -6,6 +6,8 @@ title: API Keys
|
||||
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/user-settings/api-keys"/>
|
||||
</head>
|
||||
|
||||
<v3APITokensDeprecationWarning />
|
||||
|
||||
## API Keys and User Authentication
|
||||
|
||||
If you want to access your Rancher clusters, projects, or other objects using external applications, you can do so using the Rancher API. However, before your application can access the API, you must provide the app with a key used to authenticate with Rancher. You can obtain a key using the Rancher UI.
|
||||
|
||||
Reference in New Issue
Block a user