Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/kmeshctl/kmeshctl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## kmeshctl

Kmesh command line tools to operate and debug Kmesh

### Options

```bash
-h, --help help for kmeshctl
```

### SEE ALSO

* [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
* [kmeshctl secret](kmeshctl_secret.md) - Use secrets to manage secret configuration data for IPsec
* [kmeshctl version](kmeshctl_version.md) - Prints out build version info
* [kmeshctl waypoint](kmeshctl_waypoint.md) - Manage waypoint configuration
27 changes: 27 additions & 0 deletions docs/kmeshctl/kmeshctl_accesslog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## kmeshctl accesslog

Enable or disable Kmesh's accesslog

```bash
kmeshctl accesslog [flags]
```

### Examples

```bash
# Enable Kmesh's accesslog:
kmeshctl accesslog <kmesh-daemon-pod> enable

# Disable Kmesh's accesslog:
kmeshctl accesslog <kmesh-daemon-pod> disable
```

### Options

```bash
-h, --help help for accesslog
```

### SEE ALSO

* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
16 changes: 16 additions & 0 deletions docs/kmeshctl/kmeshctl_authz.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## kmeshctl authz

Manage xdp authz eBPF program for Kmesh's authz offloading

### Options

```bash
-h, --help help for authz
```

### 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
24 changes: 24 additions & 0 deletions docs/kmeshctl/kmeshctl_authz_disable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## kmeshctl authz disable

Disable xdp authz eBPF program for Kmesh's authz offloading

```bash
kmeshctl authz disable [podNames...] [flags]
```

### Examples

```bash
kmeshctl authz disable
kmeshctl authz disable pod1 pod2
```

### Options

```bash
-h, --help help for disable
```

### SEE ALSO

* [kmeshctl authz](kmeshctl_authz.md) - Manage xdp authz eBPF program for Kmesh's authz offloading
24 changes: 24 additions & 0 deletions docs/kmeshctl/kmeshctl_authz_enable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## kmeshctl authz enable

Enable xdp authz eBPF program for Kmesh's authz offloading

```bash
kmeshctl authz enable [podNames...] [flags]
```

### Examples

```bash
kmeshctl authz enable
kmeshctl authz enable pod1 pod2
```

### Options

```bash
-h, --help help for enable
```

### SEE ALSO

* [kmeshctl authz](kmeshctl_authz.md) - Manage xdp authz eBPF program for Kmesh's authz offloading
24 changes: 24 additions & 0 deletions docs/kmeshctl/kmeshctl_authz_status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## kmeshctl authz status

Display the current authorization status

```bash
kmeshctl authz status [podNames...] [flags]
```

### Examples

```bash
kmeshctl authz status
kmeshctl authz status pod1 pod2
```

### Options

```bash
-h, --help help for status
```

### SEE ALSO

* [kmeshctl authz](kmeshctl_authz.md) - Manage xdp authz eBPF program for Kmesh's authz offloading
27 changes: 27 additions & 0 deletions docs/kmeshctl/kmeshctl_dump.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## kmeshctl dump

Dump config of kernel-native or dual-engine mode

```bash
kmeshctl dump [flags]
```

### Examples

```bash
# Kernel Native mode:
kmeshctl dump <kmesh-daemon-pod> kernel-native

# Dual Engine mode:
kmeshctl dump <kmesh-daemon-pod> dual-engine
```

### Options

```bash
-h, --help help for dump
```

### SEE ALSO

* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
31 changes: 31 additions & 0 deletions docs/kmeshctl/kmeshctl_log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## kmeshctl log

Get or set kmesh-daemon's logger level

```bash
kmeshctl log [flags]
```

### Examples

```bash
# Set default logger's level as "debug":
kmeshctl log <kmesh-daemon-pod> --set default:debug

# Get all loggers' name
kmeshctl log <kmesh-daemon-pod>

# Get default logger's level:
kmeshctl log <kmesh-daemon-pod> default
```

### Options

```bash
-h, --help help for log
--set string Set the logger level (e.g., default:debug)
```

### SEE ALSO

* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
50 changes: 50 additions & 0 deletions docs/kmeshctl/kmeshctl_monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## kmeshctl monitoring

Control Kmesh's monitoring to be turned on as needed

```bash
kmeshctl monitoring [flags]
```

### Examples

```bash
# Enable/Disable Kmesh's accesslog:
kmeshctl monitoring <kmesh-daemon-pod> --accesslog enable/disable

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The use of enable/disable in the example is ambiguous. It's better to provide separate, concrete examples for both enable and disable actions. This will make the documentation clearer for users. Please consider splitting this into two examples, one for enable and one for disable.

This comment applies to all similar examples in this file (lines 16, 19, 22, 26, 29, 32, 35).

Suggested change
kmeshctl monitoring <kmesh-daemon-pod> --accesslog enable/disable
kmeshctl monitoring <kmesh-daemon-pod> --accesslog enable


# Enable/Disable services' metrics and accesslog generated from bpf:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a grammatical error here. The apostrophe in services' is incorrect for a plural noun. It should be service metrics or metrics for services.

This issue is also present on lines 34 and 42.

Suggested change
# Enable/Disable services' metrics and accesslog generated from bpf:
# Enable/Disable service metrics and accesslog generated from bpf:

kmeshctl monitoring <kmesh-daemon-pod> --all enable/disable

# Enable/Disable workload granularity metrics:
kmeshctl monitoring <kmesh-daemon-pod> --workloadMetrics enable/disable

# Enable/Disable connection granularity metrics:
kmeshctl monitoring <kmesh-daemon-pod> --connectionMetrics enable/disable

# If you want to change the monitoring functionality of all kmesh daemons in the cluster
# Enable/Disable Kmesh's accesslog in each node:
kmeshctl monitoring --accesslog enable/disable

# Enable/Disable workload granularity metrics in each node:
kmeshctl monitoring --workloadMetrics enable/disable

# Enable/Disable connection granularity metrics in each node:
kmeshctl monitoring --connectionMetrics enable/disable

#Enable/Disable services', workloads' and 'connections' metrics and accesslog generated from bpf in each node:
kmeshctl monitoring --all enable/disable
```

### Options

```bash
--accesslog string Control accesslog enable or disable
--all string Control accesslog and services' and workloads' metrics enable or disable together
--connectionMetrics string Control connection granularity metrics enable or disable
-h, --help help for monitoring
--workloadMetrics string Control workload granularity metrics enable or disable
```

### SEE ALSO

* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
30 changes: 30 additions & 0 deletions docs/kmeshctl/kmeshctl_secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## kmeshctl secret

Use secrets to manage secret configuration data for IPsec

```bash
kmeshctl secret [flags]
```

### Examples

```bash
# Use kmeshctl secret to manage secret configuration data for IPsec:
kmeshctl secret create or kmeshctl secret create --key=$(echo -n "{36-character user-defined key here}" | xxd -p -c 64)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The use of or in the example command is confusing and makes the command invalid. To show alternative commands, please place them on separate lines. For example:

kmeshctl secret create
kmeshctl secret create --key=$(echo -n "{36-character user-defined key here}" | xxd -p -c 64)
Suggested change
kmeshctl secret create or kmeshctl secret create --key=$(echo -n "{36-character user-defined key here}" | xxd -p -c 64)
kmeshctl secret create

kmeshctl secret get
kmeshctl secret delete

```

### Options

```bash
-h, --help help for secret
```

### SEE ALSO

* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
* [kmeshctl secret create](kmeshctl_secret_create.md) - Generate IPsec key and configuration by kmeshctl
* [kmeshctl secret delete](kmeshctl_secret_delete.md) - Delete IPsec key and configuration by kmeshctl
* [kmeshctl secret get](kmeshctl_secret_get.md) - Get IPsec key and configuration by kmeshctl
27 changes: 27 additions & 0 deletions docs/kmeshctl/kmeshctl_secret_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## kmeshctl secret create

Generate IPsec key and configuration by kmeshctl

```bash
kmeshctl secret create [flags]
```

### Examples

```bash
# Generate IPsec configuration with random IPsec key:
kmeshctl secret create
# Generate IPsec configuration with user-defined key:
kmeshctl secret create --key=$(echo -n "{36-character user-defined key here}" | xxd -p -c 64)
```

### Options

```bash
-h, --help help for create
-k, --key string key of the encryption
```

### SEE ALSO

* [kmeshctl secret](kmeshctl_secret.md) - Use secrets to manage secret configuration data for IPsec
23 changes: 23 additions & 0 deletions docs/kmeshctl/kmeshctl_secret_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## kmeshctl secret delete

Delete IPsec key and configuration by kmeshctl

```bash
kmeshctl secret delete [flags]
```

### Examples

```bash
kmeshctl secret delete
```

### Options

```bash
-h, --help help for delete
```

### SEE ALSO

* [kmeshctl secret](kmeshctl_secret.md) - Use secrets to manage secret configuration data for IPsec
24 changes: 24 additions & 0 deletions docs/kmeshctl/kmeshctl_secret_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## kmeshctl secret get

Get IPsec key and configuration by kmeshctl

```bash
kmeshctl secret get [flags]
```

### Examples

```bash
# Get IPsec key and configuration by kmeshctl. The results will be displayed in JSON format.
kmeshctl secret get
```

### Options

```bash
-h, --help help for get
```

### SEE ALSO

* [kmeshctl secret](kmeshctl_secret.md) - Use secrets to manage secret configuration data for IPsec
27 changes: 27 additions & 0 deletions docs/kmeshctl/kmeshctl_version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## kmeshctl version

Prints out build version info

```bash
kmeshctl version [flags]
```

### Examples

```bash
# Show version of all kmesh components
kmeshctl version

# Show version info of a specific kmesh daemon
kmeshctl version <kmesh-daemon-pod>
```

### Options

```bash
-h, --help help for version
```

### SEE ALSO

* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh
Loading