Merge pull request #1241 from LiZhenCheng9527/make-gen

Modify the kmeshctl documentation according to make gen
kmesh-net · Feb 17, 2025 · 724789d · 724789d
2 parents 28bd8ad + 74e3655
commit 724789d
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 16 deletions.
diff --git a/docs/ctl/kmeshctl.md b/docs/ctl/kmeshctl.md
@@ -10,7 +10,7 @@ Kmesh command line tools to operate and debug Kmesh
 
 ### SEE ALSO
 
-* [kmeshctl authz](kmeshctl_authz.md)	 - Enable or disable xdp authz eBPF Prog for Kmesh's authz offloading
+* [kmeshctl authz](kmeshctl_authz.md)	 - Manage xdp authz eBPF program for Kmesh's authz offloading
 * [kmeshctl dump](kmeshctl_dump.md)	 - Dump config of kernel-native or dual-engine mode
 * [kmeshctl log](kmeshctl_log.md)	 - Get or set kmesh-daemon's logger level
 * [kmeshctl monitoring](kmeshctl_monitoring.md)	 - Control Kmesh's monitoring to be turned on as needed

diff --git a/docs/ctl/kmeshctl_authz.md b/docs/ctl/kmeshctl_authz.md
@@ -1,20 +1,6 @@
 ## kmeshctl authz
 
-Enable or disable xdp authz eBPF Prog for Kmesh's authz offloading
-
-```
-kmeshctl authz [flags]
-```
-
-### Examples
-
-```
-# Enable/Disable Kmesh's authz offloading in the specified kmesh daemon:
- kmeshctl authz <kmesh-daemon-pod> enable/disable
- 
- # If you want to enable or disable authz offloading of all Kmeshs in the cluster
- kmeshctl authz enable/disable
-```
+Manage xdp authz eBPF program for Kmesh's authz offloading
 
 ### Options
 
@@ -25,4 +11,7 @@ kmeshctl authz [flags]
 ### SEE ALSO
 
 * [kmeshctl](kmeshctl.md)	 - Kmesh command line tools to operate and debug Kmesh
+* [kmeshctl authz disable](kmeshctl_authz_disable.md)	 - Disable xdp authz eBPF program for Kmesh's authz offloading
+* [kmeshctl authz enable](kmeshctl_authz_enable.md)	 - Enable xdp authz eBPF program for Kmesh's authz offloading
+* [kmeshctl authz status](kmeshctl_authz_status.md)	 - Display the current authorization status
 
diff --git a/docs/ctl/kmeshctl_authz_disable.md b/docs/ctl/kmeshctl_authz_disable.md
@@ -0,0 +1,25 @@
+## kmeshctl authz disable
+
+Disable xdp authz eBPF program for Kmesh's authz offloading
+
+```
+kmeshctl authz disable [podNames...] [flags]
+```
+
+### Examples
+
+```
+kmeshctl authz disable
+kmeshctl authz disable pod1 pod2
+```
+
+### Options
+
+```
+  -h, --help   help for disable
+```
+
+### SEE ALSO
+
+* [kmeshctl authz](kmeshctl_authz.md)	 - Manage xdp authz eBPF program for Kmesh's authz offloading
+
diff --git a/docs/ctl/kmeshctl_authz_enable.md b/docs/ctl/kmeshctl_authz_enable.md
@@ -0,0 +1,25 @@
+## kmeshctl authz enable
+
+Enable xdp authz eBPF program for Kmesh's authz offloading
+
+```
+kmeshctl authz enable [podNames...] [flags]
+```
+
+### Examples
+
+```
+kmeshctl authz enable
+kmeshctl authz enable pod1 pod2
+```
+
+### Options
+
+```
+  -h, --help   help for enable
+```
+
+### SEE ALSO
+
+* [kmeshctl authz](kmeshctl_authz.md)	 - Manage xdp authz eBPF program for Kmesh's authz offloading
+
diff --git a/docs/ctl/kmeshctl_authz_status.md b/docs/ctl/kmeshctl_authz_status.md
@@ -0,0 +1,25 @@
+## kmeshctl authz status
+
+Display the current authorization status
+
+```
+kmeshctl authz status [podNames...] [flags]
+```
+
+### Examples
+
+```
+kmeshctl authz status
+kmeshctl authz status pod1 pod2
+```
+
+### Options
+
+```
+  -h, --help   help for status
+```
+
+### SEE ALSO
+
+* [kmeshctl authz](kmeshctl_authz.md)	 - Manage xdp authz eBPF program for Kmesh's authz offloading
+