Skip to content

Commit e8504b2

Browse files
github-actions[bot]github-actions[bot]
committed
docs: sync kmeshctl docs from kmesh-net/kmesh
1 parent b307a77 commit e8504b2

20 files changed

+628
-0
lines changed

‎docs/kmeshctl/kmeshctl.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## kmeshctl
2+
3+
Kmesh command line tools to operate and debug Kmesh
4+
5+
### Options
6+
7+
```bash
8+
-h, --help help for kmeshctl
9+
```
10+
11+
### SEE ALSO
12+
13+
* [kmeshctl authz](kmeshctl_authz.md) - Manage xdp authz eBPF program for Kmesh's authz offloading
14+
* [kmeshctl dump](kmeshctl_dump.md) - Dump config of kernel-native or dual-engine mode
15+
* [kmeshctl log](kmeshctl_log.md) - Get or set kmesh-daemon's logger level
16+
* [kmeshctl monitoring](kmeshctl_monitoring.md) - Control Kmesh's monitoring to be turned on as needed
17+
* [kmeshctl secret](kmeshctl_secret.md) - Use secrets to manage secret configuration data for IPsec
18+
* [kmeshctl version](kmeshctl_version.md) - Prints out build version info
19+
* [kmeshctl waypoint](kmeshctl_waypoint.md) - Manage waypoint configuration

‎docs/kmeshctl/kmeshctl_accesslog.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## kmeshctl accesslog
2+
3+
Enable or disable Kmesh's accesslog
4+
5+
```bash
6+
kmeshctl accesslog [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
# Enable Kmesh's accesslog:
13+
kmeshctl accesslog <kmesh-daemon-pod> enable
14+
15+
# Disable Kmesh's accesslog:
16+
kmeshctl accesslog <kmesh-daemon-pod> disable
17+
```
18+
19+
### Options
20+
21+
```bash
22+
-h, --help help for accesslog
23+
```
24+
25+
### SEE ALSO
26+
27+
* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh

‎docs/kmeshctl/kmeshctl_authz.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## kmeshctl authz
2+
3+
Manage xdp authz eBPF program for Kmesh's authz offloading
4+
5+
### Options
6+
7+
```bash
8+
-h, --help help for authz
9+
```
10+
11+
### SEE ALSO
12+
13+
* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
14+
* [kmeshctl authz disable](kmeshctl_authz_disable.md) - Disable xdp authz eBPF program for Kmesh's authz offloading
15+
* [kmeshctl authz enable](kmeshctl_authz_enable.md) - Enable xdp authz eBPF program for Kmesh's authz offloading
16+
* [kmeshctl authz status](kmeshctl_authz_status.md) - Display the current authorization status

‎docs/kmeshctl/kmeshctl_authz_disable.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## kmeshctl authz disable
2+
3+
Disable xdp authz eBPF program for Kmesh's authz offloading
4+
5+
```bash
6+
kmeshctl authz disable [podNames...] [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
kmeshctl authz disable
13+
kmeshctl authz disable pod1 pod2
14+
```
15+
16+
### Options
17+
18+
```bash
19+
-h, --help help for disable
20+
```
21+
22+
### SEE ALSO
23+
24+
* [kmeshctl authz](kmeshctl_authz.md) - Manage xdp authz eBPF program for Kmesh's authz offloading

‎docs/kmeshctl/kmeshctl_authz_enable.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## kmeshctl authz enable
2+
3+
Enable xdp authz eBPF program for Kmesh's authz offloading
4+
5+
```bash
6+
kmeshctl authz enable [podNames...] [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
kmeshctl authz enable
13+
kmeshctl authz enable pod1 pod2
14+
```
15+
16+
### Options
17+
18+
```bash
19+
-h, --help help for enable
20+
```
21+
22+
### SEE ALSO
23+
24+
* [kmeshctl authz](kmeshctl_authz.md) - Manage xdp authz eBPF program for Kmesh's authz offloading

‎docs/kmeshctl/kmeshctl_authz_status.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## kmeshctl authz status
2+
3+
Display the current authorization status
4+
5+
```bash
6+
kmeshctl authz status [podNames...] [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
kmeshctl authz status
13+
kmeshctl authz status pod1 pod2
14+
```
15+
16+
### Options
17+
18+
```bash
19+
-h, --help help for status
20+
```
21+
22+
### SEE ALSO
23+
24+
* [kmeshctl authz](kmeshctl_authz.md) - Manage xdp authz eBPF program for Kmesh's authz offloading

‎docs/kmeshctl/kmeshctl_dump.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## kmeshctl dump
2+
3+
Dump config of kernel-native or dual-engine mode
4+
5+
```bash
6+
kmeshctl dump [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
# Kernel Native mode:
13+
kmeshctl dump <kmesh-daemon-pod> kernel-native
14+
15+
# Dual Engine mode:
16+
kmeshctl dump <kmesh-daemon-pod> dual-engine
17+
```
18+
19+
### Options
20+
21+
```bash
22+
-h, --help help for dump
23+
```
24+
25+
### SEE ALSO
26+
27+
* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh

‎docs/kmeshctl/kmeshctl_log.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## kmeshctl log
2+
3+
Get or set kmesh-daemon's logger level
4+
5+
```bash
6+
kmeshctl log [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
# Set default logger's level as "debug":
13+
kmeshctl log <kmesh-daemon-pod> --set default:debug
14+
15+
# Get all loggers' name
16+
kmeshctl log <kmesh-daemon-pod>
17+
18+
# Get default logger's level:
19+
kmeshctl log <kmesh-daemon-pod> default
20+
```
21+
22+
### Options
23+
24+
```bash
25+
-h, --help help for log
26+
--set string Set the logger level (e.g., default:debug)
27+
```
28+
29+
### SEE ALSO
30+
31+
* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh

‎docs/kmeshctl/kmeshctl_monitoring.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## kmeshctl monitoring
2+
3+
Control Kmesh's monitoring to be turned on as needed
4+
5+
```bash
6+
kmeshctl monitoring [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
# Enable/Disable Kmesh's accesslog:
13+
kmeshctl monitoring <kmesh-daemon-pod> --accesslog enable/disable
14+
15+
# Enable/Disable services' metrics and accesslog generated from bpf:
16+
kmeshctl monitoring <kmesh-daemon-pod> --all enable/disable
17+
18+
# Enable/Disable workload granularity metrics:
19+
kmeshctl monitoring <kmesh-daemon-pod> --workloadMetrics enable/disable
20+
21+
# Enable/Disable connection granularity metrics:
22+
kmeshctl monitoring <kmesh-daemon-pod> --connectionMetrics enable/disable
23+
24+
# If you want to change the monitoring functionality of all kmesh daemons in the cluster
25+
# Enable/Disable Kmesh's accesslog in each node:
26+
kmeshctl monitoring --accesslog enable/disable
27+
28+
# Enable/Disable workload granularity metrics in each node:
29+
kmeshctl monitoring --workloadMetrics enable/disable
30+
31+
# Enable/Disable connection granularity metrics in each node:
32+
kmeshctl monitoring --connectionMetrics enable/disable
33+
34+
#Enable/Disable services', workloads' and 'connections' metrics and accesslog generated from bpf in each node:
35+
kmeshctl monitoring --all enable/disable
36+
```
37+
38+
### Options
39+
40+
```bash
41+
--accesslog string Control accesslog enable or disable
42+
--all string Control accesslog and services' and workloads' metrics enable or disable together
43+
--connectionMetrics string Control connection granularity metrics enable or disable
44+
-h, --help help for monitoring
45+
--workloadMetrics string Control workload granularity metrics enable or disable
46+
```
47+
48+
### SEE ALSO
49+
50+
* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh

‎docs/kmeshctl/kmeshctl_secret.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## kmeshctl secret
2+
3+
Use secrets to manage secret configuration data for IPsec
4+
5+
```bash
6+
kmeshctl secret [flags]
7+
```
8+
9+
### Examples
10+
11+
```bash
12+
# Use kmeshctl secret to manage secret configuration data for IPsec:
13+
kmeshctl secret create or kmeshctl secret create --key=$(echo -n "{36-character user-defined key here}" | xxd -p -c 64)
14+
kmeshctl secret get
15+
kmeshctl secret delete
16+
17+
```
18+
19+
### Options
20+
21+
```bash
22+
-h, --help help for secret
23+
```
24+
25+
### SEE ALSO
26+
27+
* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
28+
* [kmeshctl secret create](kmeshctl_secret_create.md) - Generate IPsec key and configuration by kmeshctl
29+
* [kmeshctl secret delete](kmeshctl_secret_delete.md) - Delete IPsec key and configuration by kmeshctl
30+
* [kmeshctl secret get](kmeshctl_secret_get.md) - Get IPsec key and configuration by kmeshctl

0 commit comments

Comments
 (0)