doc: fs.inotify hint for karmada deploy (#659)

* doc: fs.inotify hint for karmada deploy Signed-off-by: Tom <[email protected]> * doc: typo fix Signed-off-by: Tom <[email protected]> * Apply suggestions from code review Co-authored-by: lizhencheng <[email protected]> Signed-off-by: Tom <[email protected]> --------- Signed-off-by: Tom <[email protected]> Co-authored-by: lizhencheng <[email protected]>
kurator-dev · Aug 1, 2024 · 1b03ae6 · 1b03ae6
1 parent e5c325d
commit 1b03ae6
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/content/en/docs/Integrations/karmada.md b/docs/content/en/docs/Integrations/karmada.md
@@ -18,6 +18,8 @@ cd kurator
 hack/local-dev-setup.sh
 ```
 
+> `fs.inotify.max_user_watches` and `fs.inotify.max_user_instances` may need to be adjusted as described [here](https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files)
+
 ### Deploy Karmada
 
 Compile `kurator` from source
@@ -39,7 +41,7 @@ kurator install karmada --kubeconfig=/root/.kube/config
 karmada installation parameters can be set with `--set`, e.g.
 
 ```bash
-kurator install karmada --set karmada-data=/etc/Karmada-test --set port=32222 --kubeconfig .kube/config
+kurator install karmada --set karmada-data=/etc/Karmada-test --set port=32222 --kubeconfig ~/.kube/config
 ```
 
 ### Add kubernetes cluster to karmada control plane
@@ -56,7 +58,7 @@ kurator join karmada member2 \
     --cluster-context=kurator-member2
 ```
 
-Show members of karmada 
+Show members of karmada
 
 ```bash
 kubectl --kubeconfig /etc/karmada/karmada-apiserver.config get clusters

diff --git a/docs/content/en/docs/fleet-manager/manage-attachedcluster.md b/docs/content/en/docs/fleet-manager/manage-attachedcluster.md
@@ -30,7 +30,7 @@ kubectl create secret generic kurator-member1 --from-file=kurator-member1.config
 kubectl create secret generic kurator-member2 --from-file=kurator-member2.config=/root/.kube/kurator-member2.config
 ```
 
-Please note, here we have named the secrets as `kurator-member1` and `kurator-member2` respectively, and set the key to save the kubeconfig in the secret as `kurator-member1.config` and `kurator-member1.config` respectively.
+Please note, here we have named the secrets as `kurator-member1` and `kurator-member2` respectively, and set the key to save the kubeconfig in the secret as `kurator-member1.config` and `kurator-member2.config` respectively.
 You can modify these two elements according to your needs.
 
 ## Create attachedCluster resources