diff --git a/docs/setup/install-with-keadm.md b/docs/setup/install-with-keadm.md index d8de750a5e..b4ee26e60a 100644 --- a/docs/setup/install-with-keadm.md +++ b/docs/setup/install-with-keadm.md @@ -3,7 +3,11 @@ title: Installing KubeEdge with Keadm sidebar_position: 3 --- -Keadm is used to install the cloud and edge components of KubeEdge. It does not handle the installation of Kubernetes and its [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime). +Keadm is used to install the cloud and edge components of KubeEdge. It does not install Kubernetes or the [runtime environment](https://kubeedge.io/docs/setup/prerequisites/runtime). Before using `keadm`, make sure your Kubernetes cluster and runtime environment are already prepared. + +## Important note + +Installing KubeEdge with `keadm` does not install Kubernetes or the container runtime. `keadm` only installs KubeEdge components. Before running `keadm init` or `keadm join`, make sure Kubernetes and the runtime environment are already installed and working properly. Please refer to [Kubernetes compatibility](https://github.com/kubeedge/kubeedge#kubernetes-compatibility) documentation to check **Kubernetes compatibility** and ascertain the Kubernetes version to be installed. diff --git a/docs/welcome/getting-started.md b/docs/welcome/getting-started.md index cccb1b152b..69a1c62669 100644 --- a/docs/welcome/getting-started.md +++ b/docs/welcome/getting-started.md @@ -10,6 +10,10 @@ In this quick-start guide, we will explain: - A few common ways of deploying KubeEdge. - Links for further reading. +## Before you begin + +KubeEdge is installed on top of an existing Kubernetes environment. Installing KubeEdge does not automatically provision Kubernetes or the container runtime, so make sure they are prepared before installation. + ## Dependencies For cloud side, we need: