From 323a233bf7197eec638497eb1a3818b767f88931 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Mon, 16 Dec 2024 08:52:59 +0100 Subject: [PATCH 1/4] check-before-deployment: add selinux See also: - https://docs.pingcap.com/tidb/stable/deploy-a-dm-cluster-using-tiup - https://docs.pingcap.com/tidb/stable/tiup-component-cluster-check#selinux --- check-before-deployment.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/check-before-deployment.md b/check-before-deployment.md index 7a6ea543de6dc..92fa9e4f025ee 100644 --- a/check-before-deployment.md +++ b/check-before-deployment.md @@ -781,3 +781,8 @@ sudo yum -y install numactl ``` To get help information of the `tiup cluster exec` command, run the `tiup cluster exec --help` command. + +## Disable SELinux + +Check with the [`getenforce(8)`](https://linux.die.net/man/8/getenforce) utility to see if SELinux is disabled or set to permissive. When SELinux is in Enforcing mode it can cause deployment failures. Refer to the documentation of your Operating System to see how to disable SELinux. + From fd00e8fc158333630903b139fa1297059e8fa492 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Mon, 16 Dec 2024 08:55:35 +0100 Subject: [PATCH 2/4] quick-start-with-dm: add selinux note --- dm/quick-start-with-dm.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index 3386f01ffa96f..e23923edb5143 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -8,6 +8,10 @@ aliases: ['/docs/tidb-data-migration/dev/get-started/'] This document describes how to migrate data from MySQL to TiDB using [TiDB Data Migration (DM)](/dm/dm-overview.md). This guide is a quick demo of DM features and is not recommended for any production environment. +> **Note:** +> +> If your target machine's operating system supports SELinux, make sure that SELinux is **disabled**. + ## Step 1: Deploy a DM cluster 1. Install TiUP, and install [`dmctl`](/dm/dmctl-introduction.md) using TiUP: From 08eb0ffccd4412bd259d03b69e31da7cc00b95f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Mon, 16 Dec 2024 15:40:26 +0100 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: xixirangrang --- check-before-deployment.md | 3 +-- dm/quick-start-with-dm.md | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/check-before-deployment.md b/check-before-deployment.md index 92fa9e4f025ee..c8aab211cdd37 100644 --- a/check-before-deployment.md +++ b/check-before-deployment.md @@ -784,5 +784,4 @@ sudo yum -y install numactl ## Disable SELinux -Check with the [`getenforce(8)`](https://linux.die.net/man/8/getenforce) utility to see if SELinux is disabled or set to permissive. When SELinux is in Enforcing mode it can cause deployment failures. Refer to the documentation of your Operating System to see how to disable SELinux. - +Use the [getenforce(8)](https://linux.die.net/man/8/getenforce) utility to check if SELinux is disabled or set to permissive. SELinux in Enforcing mode can cause deployment failures. Consult your operating system's documentation for instructions on disabling SELinux. diff --git a/dm/quick-start-with-dm.md b/dm/quick-start-with-dm.md index e23923edb5143..b9df1b32dd750 100644 --- a/dm/quick-start-with-dm.md +++ b/dm/quick-start-with-dm.md @@ -10,7 +10,7 @@ This document describes how to migrate data from MySQL to TiDB using [TiDB Data > **Note:** > -> If your target machine's operating system supports SELinux, make sure that SELinux is **disabled**. +> If your target machine's operating system supports SELinux, ensure that SELinux is **disabled**. ## Step 1: Deploy a DM cluster From 5915cf32bc2c844ce88255943622d99a89e37026 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Wed, 18 Dec 2024 05:53:08 +0100 Subject: [PATCH 4/4] Update check-before-deployment.md Co-authored-by: Grace Cai --- check-before-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/check-before-deployment.md b/check-before-deployment.md index c8aab211cdd37..11528df1d455d 100644 --- a/check-before-deployment.md +++ b/check-before-deployment.md @@ -784,4 +784,4 @@ sudo yum -y install numactl ## Disable SELinux -Use the [getenforce(8)](https://linux.die.net/man/8/getenforce) utility to check if SELinux is disabled or set to permissive. SELinux in Enforcing mode can cause deployment failures. Consult your operating system's documentation for instructions on disabling SELinux. +Use the [getenforce(8)](https://linux.die.net/man/8/getenforce) utility to check if SELinux is disabled or set to permissive. SELinux in enforcing mode can cause deployment failures. For instructions on disabling SELinux, refer to your operating system's documentation.