From 5d9cf8ec3448e23aeaa35af81d8673b104a57785 Mon Sep 17 00:00:00 2001 From: Derek Nola Date: Wed, 19 Jul 2023 14:58:34 -0700 Subject: [PATCH] Globally import tabs (#156) Signed-off-by: Derek Nola --- docs/advanced/advanced.md | 3 --- docs/architecture/architecture.md | 3 --- docs/cli/etcd-snapshot.md | 2 -- docs/cli/secrets-encrypt.md | 2 -- docs/datastore/datastore.md | 2 -- docs/installation/airgap.md | 2 -- docs/installation/kube-dashboard.md | 3 --- docs/installation/network-options.md | 3 --- docs/installation/private-registry.md | 2 -- docs/security/hardening-guide.md | 3 --- .../current/advanced/advanced.md | 2 -- .../current/cli/etcd-snapshot.md | 2 -- .../current/cli/secrets-encrypt.md | 2 -- .../current/datastore/datastore.md | 2 -- .../current/installation/airgap.md | 2 -- .../current/installation/kube-dashboard.md | 2 -- .../current/installation/network-options.md | 2 -- .../current/installation/private-registry.md | 2 -- .../current/security/hardening-guide.md | 2 -- .../current/advanced/advanced.md | 2 -- .../current/architecture/architecture.md | 2 -- .../current/cli/etcd-snapshot.md | 2 -- .../current/cli/secrets-encrypt.md | 2 -- .../current/datastore/datastore.md | 2 -- .../current/installation/airgap.md | 2 -- .../current/installation/kube-dashboard.md | 2 -- .../current/installation/network-options.md | 2 -- .../current/installation/private-registry.md | 2 -- .../current/security/hardening-guide.md | 2 -- src/theme/MDXComponents.js | 13 +++++++++++++ 30 files changed, 13 insertions(+), 63 deletions(-) create mode 100644 src/theme/MDXComponents.js diff --git a/docs/advanced/advanced.md b/docs/advanced/advanced.md index 88d05db1e..58ee69d9f 100644 --- a/docs/advanced/advanced.md +++ b/docs/advanced/advanced.md @@ -6,9 +6,6 @@ aliases: - /k3s/latest/en/configuration/ --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - This section contains advanced information describing the different ways you can run and manage K3s, as well as steps necessary to prepare the host OS for K3s use. ## Certificate Management diff --git a/docs/architecture/architecture.md b/docs/architecture/architecture.md index a812aa05d..0bf6080bd 100644 --- a/docs/architecture/architecture.md +++ b/docs/architecture/architecture.md @@ -5,9 +5,6 @@ weight: 1 import ThemedImage from '@theme/ThemedImage'; import useBaseUrl from '@docusaurus/useBaseUrl'; -import TabItem from '@theme/TabItem'; -import Tabs from '@theme/Tabs'; - This page describes the architecture of a high-availability K3s server cluster and how it differs from a single-node server cluster. diff --git a/docs/cli/etcd-snapshot.md b/docs/cli/etcd-snapshot.md index 0191f1682..6c9d2babe 100644 --- a/docs/cli/etcd-snapshot.md +++ b/docs/cli/etcd-snapshot.md @@ -1,8 +1,6 @@ --- title: etcd-snapshot --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; # k3s etcd-snapshot diff --git a/docs/cli/secrets-encrypt.md b/docs/cli/secrets-encrypt.md index 6c3b1165d..56a74dcad 100644 --- a/docs/cli/secrets-encrypt.md +++ b/docs/cli/secrets-encrypt.md @@ -1,8 +1,6 @@ --- title: secrets-encrypt --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; # k3s secrets-encrypt diff --git a/docs/datastore/datastore.md b/docs/datastore/datastore.md index 840c2cd77..ba413d15b 100644 --- a/docs/datastore/datastore.md +++ b/docs/datastore/datastore.md @@ -3,8 +3,6 @@ title: "Cluster Datastore" weight: 50 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; The ability to run Kubernetes using a datastore other than etcd sets K3s apart from other Kubernetes distributions. This feature provides flexibility to Kubernetes operators. The available datastore options allow you to select a datastore that best fits your use case. For example: diff --git a/docs/installation/airgap.md b/docs/installation/airgap.md index 027b11cbc..3a247dc0a 100644 --- a/docs/installation/airgap.md +++ b/docs/installation/airgap.md @@ -2,8 +2,6 @@ title: "Air-Gap Install" weight: 60 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; You can install K3s in an air-gapped environment using two different methods. An air-gapped environment is any environment that is not directly connected to the Internet. You can either deploy a private registry and mirror docker.io, or you can manually deploy images such as for small clusters. diff --git a/docs/installation/kube-dashboard.md b/docs/installation/kube-dashboard.md index 858b1ad28..47135dcd3 100644 --- a/docs/installation/kube-dashboard.md +++ b/docs/installation/kube-dashboard.md @@ -3,9 +3,6 @@ title: "Kubernetes Dashboard" weight: 60 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - This installation guide will help you to deploy and configure the [Kubernetes Dashboard](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/) on K3s. ### Deploying the Kubernetes Dashboard diff --git a/docs/installation/network-options.md b/docs/installation/network-options.md index 1fd31665b..ef018fb76 100644 --- a/docs/installation/network-options.md +++ b/docs/installation/network-options.md @@ -3,9 +3,6 @@ title: "Network Options" weight: 25 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - This page describes K3s network configuration options, including configuration or replacement of Flannel, and configuring IPv6. > **Note:** Please reference the [Networking](../networking/networking.md) page for information about CoreDNS, Traefik, and the Service LB. diff --git a/docs/installation/private-registry.md b/docs/installation/private-registry.md index 8afe162fe..19d9f921e 100644 --- a/docs/installation/private-registry.md +++ b/docs/installation/private-registry.md @@ -2,8 +2,6 @@ title: "Private Registry Configuration" weight: 55 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; Containerd can be configured to connect to private registries and use them to pull private images on the node. diff --git a/docs/security/hardening-guide.md b/docs/security/hardening-guide.md index 8ab4e0f36..17b84b744 100644 --- a/docs/security/hardening-guide.md +++ b/docs/security/hardening-guide.md @@ -3,9 +3,6 @@ title: "CIS Hardening Guide" weight: 80 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - This document provides prescriptive guidance for hardening a production installation of K3s. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Internet Security (CIS). K3s has a number of security mitigations applied and turned on by default and will pass a number of the Kubernetes CIS controls without modification. There are some notable exceptions to this that require manual intervention to fully comply with the CIS Benchmark: diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/advanced/advanced.md b/i18n/kr/docusaurus-plugin-content-docs/current/advanced/advanced.md index 954390ded..bc91cdd85 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/advanced/advanced.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/advanced/advanced.md @@ -6,8 +6,6 @@ aliases: - /k3s/latest/kr/configuration/ --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; 이 섹션에는 K3s를 실행하고 관리할 수 있는 다양한 방법과 K3s 사용을 위해 호스트 OS를 준비하는 데 필요한 단계를 설명하는 고급 정보가 포함되어 있습니다. diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md b/i18n/kr/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md index 0191f1682..6c9d2babe 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md @@ -1,8 +1,6 @@ --- title: etcd-snapshot --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; # k3s etcd-snapshot diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md b/i18n/kr/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md index 6c3b1165d..56a74dcad 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md @@ -1,8 +1,6 @@ --- title: secrets-encrypt --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; # k3s secrets-encrypt diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/datastore/datastore.md b/i18n/kr/docusaurus-plugin-content-docs/current/datastore/datastore.md index bc858eca6..5a971e75a 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/datastore/datastore.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/datastore/datastore.md @@ -3,8 +3,6 @@ title: "클러스터 데이터 저장소" weight: 50 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; etcd가 아닌 다른 데이터스토어를 사용하여 쿠버네티스를 실행할 수 있는 기능은 K3s를 다른 쿠버네티스 배포판과 차별화합니다. 이 기능은 쿠버네티스 운영자에게 유연성을 제공합니다. 사용 가능한 데이터스토어 옵션을 통해 사용 사례에 가장 적합한 데이터스토어를 선택할 수 있습니다. 예를 들어: diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/installation/airgap.md b/i18n/kr/docusaurus-plugin-content-docs/current/installation/airgap.md index 9c2c8c45d..40a240dd3 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/installation/airgap.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/installation/airgap.md @@ -2,8 +2,6 @@ title: "Air-Gap Install" weight: 60 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; You can install K3s in an air-gapped environment using two different methods. An air-gapped environment is any environment that is not directly connected to the Internet. You can either deploy a private registry and mirror docker.io, or you can manually deploy images such as for small clusters. diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md b/i18n/kr/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md index 858b1ad28..da427361b 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md @@ -3,8 +3,6 @@ title: "Kubernetes Dashboard" weight: 60 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; This installation guide will help you to deploy and configure the [Kubernetes Dashboard](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/) on K3s. diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/installation/network-options.md b/i18n/kr/docusaurus-plugin-content-docs/current/installation/network-options.md index a535f8875..5a9279e97 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/installation/network-options.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/installation/network-options.md @@ -3,8 +3,6 @@ title: "Network Options" weight: 25 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; This page describes K3s network configuration options, including configuration or replacement of Flannel, and configuring IPv6. diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/installation/private-registry.md b/i18n/kr/docusaurus-plugin-content-docs/current/installation/private-registry.md index 53d06f8d6..7c06ff96f 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/installation/private-registry.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/installation/private-registry.md @@ -2,8 +2,6 @@ title: "Private Registry Configuration" weight: 55 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; Containerd can be configured to connect to private registries and use them to pull private images on the node. diff --git a/i18n/kr/docusaurus-plugin-content-docs/current/security/hardening-guide.md b/i18n/kr/docusaurus-plugin-content-docs/current/security/hardening-guide.md index 8ab4e0f36..a57fbd5dd 100644 --- a/i18n/kr/docusaurus-plugin-content-docs/current/security/hardening-guide.md +++ b/i18n/kr/docusaurus-plugin-content-docs/current/security/hardening-guide.md @@ -3,8 +3,6 @@ title: "CIS Hardening Guide" weight: 80 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; This document provides prescriptive guidance for hardening a production installation of K3s. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Internet Security (CIS). diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/advanced/advanced.md b/i18n/zh/docusaurus-plugin-content-docs/current/advanced/advanced.md index 02a6e92d3..1c540a49f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/advanced/advanced.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/advanced/advanced.md @@ -6,8 +6,6 @@ aliases: - /k3s/latest/en/configuration/ --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; 本文描述了用于运行和管理 K3s 的高级设置，以及为 K3s 准备主机操作系统所需的步骤。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/architecture/architecture.md b/i18n/zh/docusaurus-plugin-content-docs/current/architecture/architecture.md index 1c808d837..e399dd529 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/architecture/architecture.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/architecture/architecture.md @@ -5,8 +5,6 @@ weight: 1 import ThemedImage from '@theme/ThemedImage'; import useBaseUrl from '@docusaurus/useBaseUrl'; -import TabItem from '@theme/TabItem'; -import Tabs from '@theme/Tabs'; 本文介绍了高可用（HA）K3s 服务器集群的架构，以及 K3s 与单节点服务器集群的区别。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md b/i18n/zh/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md index 95119276a..b0981a998 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/cli/etcd-snapshot.md @@ -1,8 +1,6 @@ --- title: etcd-snapshot --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; # k3s etcd-snapshot diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md b/i18n/zh/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md index dcb7fd1cd..8adc4dc38 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/cli/secrets-encrypt.md @@ -1,8 +1,6 @@ --- title: secrets-encrypt --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; # k3s secrets-encrypt diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/datastore/datastore.md b/i18n/zh/docusaurus-plugin-content-docs/current/datastore/datastore.md index f46307eed..8cff1ddef 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/datastore/datastore.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/datastore/datastore.md @@ -3,8 +3,6 @@ title: "集群数据存储" weight: 50 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; K3s 与其他 Kubernetes 发行版的不同之处，在于 K3s 支持使用 etcd 以外的数据库来运行 Kubernetes。该功能让 Kubernetes 运维更加灵活。你可以根据实际情况选择合适的数据存储选项。例如： diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/installation/airgap.md b/i18n/zh/docusaurus-plugin-content-docs/current/installation/airgap.md index 0b8f9be51..efa3bec2e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/installation/airgap.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/installation/airgap.md @@ -2,8 +2,6 @@ title: "离线安装" weight: 60 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; 你可以使用两种不同的方法在离线环境中安装 K3s。离线环境指的是不直接连接到 Internet 的环境。你可以部署私有镜像仓库和 mirror docker.io，也可以手动部署镜像，例如用于小型集群。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md b/i18n/zh/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md index e0d3a8527..501164f6b 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/installation/kube-dashboard.md @@ -3,8 +3,6 @@ title: "Kubernetes 仪表板" weight: 60 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; 本安装指南将帮助你在 K3s 上部署和配置 [Kubernetes 仪表板](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/)。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/installation/network-options.md b/i18n/zh/docusaurus-plugin-content-docs/current/installation/network-options.md index e32bb6b34..b98ed1971 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/installation/network-options.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/installation/network-options.md @@ -3,8 +3,6 @@ title: "网络选项" weight: 25 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; 本文介绍了 K3s 网络配置选项，包括配置或替换 Flannel，以及配置 IPv6。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/installation/private-registry.md b/i18n/zh/docusaurus-plugin-content-docs/current/installation/private-registry.md index fc3e670a0..d248e93a0 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/installation/private-registry.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/installation/private-registry.md @@ -2,8 +2,6 @@ title: "私有镜像仓库配置" weight: 55 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; 你可以将 Containerd 配置为连接到私有镜像仓库，并在节点上使用私有镜像仓库拉取私有镜像。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/security/hardening-guide.md b/i18n/zh/docusaurus-plugin-content-docs/current/security/hardening-guide.md index ee8a4eb41..0a29cfddd 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/security/hardening-guide.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/security/hardening-guide.md @@ -3,8 +3,6 @@ title: "CIS Hardening Guide" weight: 80 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; :::info 请知悉，本文仅提供英文版。 diff --git a/src/theme/MDXComponents.js b/src/theme/MDXComponents.js new file mode 100644 index 000000000..8c9abd4ed --- /dev/null +++ b/src/theme/MDXComponents.js @@ -0,0 +1,13 @@ +import React from 'react'; +// Import the original mapper +import MDXComponents from '@theme-original/MDXComponents'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +export default { + // Re-use the default mapping + ...MDXComponents, + // Global import the and components + Tabs, + TabItem +}; \ No newline at end of file