mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-26 13:08:11 +00:00
deploy: 4efd181f29
This commit is contained in:
File diff suppressed because one or more lines are too long
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
@@ -324,8 +324,8 @@ const metadata = {
|
|||||||
"editUrl": "https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.8/reference-guides/about-the-api/api-tokens.md",
|
"editUrl": "https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.8/reference-guides/about-the-api/api-tokens.md",
|
||||||
"tags": [],
|
"tags": [],
|
||||||
"version": "2.8",
|
"version": "2.8",
|
||||||
"lastUpdatedAt": 1696627994,
|
"lastUpdatedAt": 1699039237,
|
||||||
"formattedLastUpdatedAt": "Oct 6, 2023",
|
"formattedLastUpdatedAt": "Nov 3, 2023",
|
||||||
"frontMatter": {
|
"frontMatter": {
|
||||||
"title": "API Tokens"
|
"title": "API Tokens"
|
||||||
},
|
},
|
||||||
@@ -376,11 +376,6 @@ const toc = [
|
|||||||
id: 'kubeconfig-default-token-ttl-minutes',
|
id: 'kubeconfig-default-token-ttl-minutes',
|
||||||
level: 4
|
level: 4
|
||||||
},
|
},
|
||||||
{
|
|
||||||
value: 'kubeconfig-token-ttl-minutes',
|
|
||||||
id: 'kubeconfig-token-ttl-minutes',
|
|
||||||
level: 4
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
value: 'auth-token-max-ttl-minutes',
|
value: 'auth-token-max-ttl-minutes',
|
||||||
id: 'auth-token-max-ttl-minutes',
|
id: 'auth-token-max-ttl-minutes',
|
||||||
@@ -451,16 +446,6 @@ function MDXContent(_param) {
|
|||||||
"align": null
|
"align": null
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
||||||
parentName: "td"
|
parentName: "td"
|
||||||
}, `kubeconfig-*`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
|
||||||
parentName: "tr",
|
|
||||||
"align": null
|
|
||||||
}, `Kubeconfig token`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("tr", {
|
|
||||||
parentName: "tbody"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
|
||||||
parentName: "tr",
|
|
||||||
"align": null
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "td"
|
|
||||||
}, `kubectl-shell-*`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
}, `kubectl-shell-*`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
||||||
parentName: "tr",
|
parentName: "tr",
|
||||||
"align": null
|
"align": null
|
||||||
@@ -530,7 +515,7 @@ function MDXContent(_param) {
|
|||||||
"href": "#kubeconfig-default-token-ttl-minutes"
|
"href": "#kubeconfig-default-token-ttl-minutes"
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
||||||
parentName: "a"
|
parentName: "a"
|
||||||
}, `kubeconfig-default-token-ttl-minutes`)), ` is 0, which means tokens never expire.`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("admonition", {
|
}, `kubeconfig-default-token-ttl-minutes`)), ` is 43200, which is 30 days.`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("admonition", {
|
||||||
"type": "note"
|
"type": "note"
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", {
|
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", {
|
||||||
parentName: "admonition"
|
parentName: "admonition"
|
||||||
@@ -539,11 +524,7 @@ function MDXContent(_param) {
|
|||||||
"href": "#disable-tokens-in-generated-kubeconfigs"
|
"href": "#disable-tokens-in-generated-kubeconfigs"
|
||||||
}, `generate kubeconfig tokens`), `.`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("h3", {
|
}, `generate kubeconfig tokens`), `.`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("h3", {
|
||||||
"id": "disable-tokens-in-generated-kubeconfigs"
|
"id": "disable-tokens-in-generated-kubeconfigs"
|
||||||
}, `Disable Tokens in Generated Kubeconfigs`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("ol", null, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("li", {
|
}, `Disable Tokens in Generated Kubeconfigs`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `Set the `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
||||||
parentName: "ol"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", {
|
|
||||||
parentName: "li"
|
|
||||||
}, `Set the `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "p"
|
parentName: "p"
|
||||||
}, `kubeconfig-generate-token`), ` setting to `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
}, `kubeconfig-generate-token`), ` setting to `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
||||||
parentName: "p"
|
parentName: "p"
|
||||||
@@ -552,15 +533,7 @@ function MDXContent(_param) {
|
|||||||
"href": "/v2.8/reference-guides/cli-with-rancher/kubectl-utility#authentication-with-kubectl-and-kubeconfig-tokens-with-ttl"
|
"href": "/v2.8/reference-guides/cli-with-rancher/kubectl-utility#authentication-with-kubectl-and-kubeconfig-tokens-with-ttl"
|
||||||
}, `Rancher CLI`), ` to retrieve a short-lived token for the cluster. When this kubeconfig is used in a client, such as `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
}, `Rancher CLI`), ` to retrieve a short-lived token for the cluster. When this kubeconfig is used in a client, such as `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
||||||
parentName: "p"
|
parentName: "p"
|
||||||
}, `kubectl`), `, the Rancher CLI needs to be installed to complete the log in request.`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("li", {
|
}, `kubectl`), `, the Rancher CLI needs to be installed to complete the log in request.`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("h3", {
|
||||||
parentName: "ol"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", {
|
|
||||||
parentName: "li"
|
|
||||||
}, `Set the `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "p"
|
|
||||||
}, `kubeconfig-token-ttl-minutes`), ` setting to the desired duration in minutes. By default, `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "p"
|
|
||||||
}, `kubeconfig-token-ttl-minutes`), ` is 960 (16 hours).`))), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("h3", {
|
|
||||||
"id": "token-hashing"
|
"id": "token-hashing"
|
||||||
}, `Token Hashing`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `Users can enable token hashing, where tokens will undergo a one-way hash using the SHA256 algorithm. This is a non-reversible process, once enabled, this feature cannot be disabled. It is advisable to take backups prior to enabling and/or evaluating in a test environment first.`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `To enable token hashing, refer to `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
}, `Token Hashing`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `Users can enable token hashing, where tokens will undergo a one-way hash using the SHA256 algorithm. This is a non-reversible process, once enabled, this feature cannot be disabled. It is advisable to take backups prior to enabling and/or evaluating in a test environment first.`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `To enable token hashing, refer to `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
||||||
parentName: "p",
|
parentName: "p",
|
||||||
@@ -621,23 +594,6 @@ function MDXContent(_param) {
|
|||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
||||||
parentName: "tr",
|
parentName: "tr",
|
||||||
"align": null
|
"align": null
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
|
||||||
parentName: "td",
|
|
||||||
"href": "#kubeconfig-token-ttl-minutes"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "a"
|
|
||||||
}, `kubeconfig-token-ttl-minutes`))), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
|
||||||
parentName: "tr",
|
|
||||||
"align": null
|
|
||||||
}, `TTL used for tokens generated via the CLI. `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("strong", {
|
|
||||||
parentName: "td"
|
|
||||||
}, `Deprecated since version 2.6.6, and will be removed in 2.8.0.`), ` This setting will be removed, and `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "td"
|
|
||||||
}, `kubeconfig-default-token-TTL-minutes`), ` will be used for all kubeconfig tokens.`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("tr", {
|
|
||||||
parentName: "tbody"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("td", {
|
|
||||||
parentName: "tr",
|
|
||||||
"align": null
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
||||||
parentName: "td",
|
parentName: "td",
|
||||||
"href": "#auth-token-max-ttl-minutes"
|
"href": "#auth-token-max-ttl-minutes"
|
||||||
@@ -685,26 +641,6 @@ function MDXContent(_param) {
|
|||||||
`, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("strong", {
|
`, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("strong", {
|
||||||
parentName: "p"
|
parentName: "p"
|
||||||
}, `Introduced in version 2.6.6`), `.`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("h4", {
|
}, `Introduced in version 2.6.6`), `.`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("h4", {
|
||||||
"id": "kubeconfig-token-ttl-minutes"
|
|
||||||
}, `kubeconfig-token-ttl-minutes`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `Time to live (TTL) duration in minutes used to determine when a kubeconfig token that was generated by the CLI expires. Tokens are generated by the CLI when `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
|
||||||
parentName: "p",
|
|
||||||
"href": "#kubeconfig-generate-token"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "a"
|
|
||||||
}, `kubeconfig-generate-token`)), ` is false. When the token is expired, the API will reject the token. This setting can not be larger than `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
|
||||||
parentName: "p",
|
|
||||||
"href": "#auth-token-max-ttl-minutes"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "a"
|
|
||||||
}, `auth-token-max-ttl-minutes`)), `.
|
|
||||||
`, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("strong", {
|
|
||||||
parentName: "p"
|
|
||||||
}, `Deprecated since version 2.6.6, and will be removed in 2.8.0: This setting will be replaced with the value of `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("a", {
|
|
||||||
parentName: "strong",
|
|
||||||
"href": "#kubeconfig-default-token-ttl-minutes"
|
|
||||||
}, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
|
||||||
parentName: "a"
|
|
||||||
}, `kubeconfig-default-token-TTL-minutes`)), `.`)), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("h4", {
|
|
||||||
"id": "auth-token-max-ttl-minutes"
|
"id": "auth-token-max-ttl-minutes"
|
||||||
}, `auth-token-max-ttl-minutes`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `Maximum Time to Live (TTL) in minutes allowed for auth tokens. If a user attempts to create a token with a TTL greater than `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
}, `auth-token-max-ttl-minutes`), /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("p", null, `Maximum Time to Live (TTL) in minutes allowed for auth tokens. If a user attempts to create a token with a TTL greater than `, /*#__PURE__*/ (0,_mdx_js_react__WEBPACK_IMPORTED_MODULE_1__/* .mdx */ .kt)("inlineCode", {
|
||||||
parentName: "p"
|
parentName: "p"
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
+6
-6
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user