diff --git a/docs/kmeshctl/kmeshctl.md b/docs/kmeshctl/kmeshctl.md new file mode 100644 index 0000000..2a0c1ea --- /dev/null +++ b/docs/kmeshctl/kmeshctl.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_accesslog.md b/docs/kmeshctl/kmeshctl_accesslog.md new file mode 100644 index 0000000..85122d7 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_accesslog.md @@ -0,0 +1,27 @@ +## kmeshctl accesslog + +Enable or disable Kmesh's accesslog + +```bash +kmeshctl accesslog [flags] +``` + +### Examples + +```bash +# Enable Kmesh's accesslog: +kmeshctl accesslog enable + +# Disable Kmesh's accesslog: +kmeshctl accesslog disable +``` + +### Options + +```bash + -h, --help help for accesslog +``` + +### SEE ALSO + +* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh diff --git a/docs/kmeshctl/kmeshctl_authz.md b/docs/kmeshctl/kmeshctl_authz.md new file mode 100644 index 0000000..f4a1336 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_authz.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_authz_disable.md b/docs/kmeshctl/kmeshctl_authz_disable.md new file mode 100644 index 0000000..b9a4854 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_authz_disable.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_authz_enable.md b/docs/kmeshctl/kmeshctl_authz_enable.md new file mode 100644 index 0000000..79e95fa --- /dev/null +++ b/docs/kmeshctl/kmeshctl_authz_enable.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_authz_status.md b/docs/kmeshctl/kmeshctl_authz_status.md new file mode 100644 index 0000000..b4dbdbe --- /dev/null +++ b/docs/kmeshctl/kmeshctl_authz_status.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_dump.md b/docs/kmeshctl/kmeshctl_dump.md new file mode 100644 index 0000000..eed76b6 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_dump.md @@ -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 kernel-native + +# Dual Engine mode: +kmeshctl dump dual-engine +``` + +### Options + +```bash + -h, --help help for dump +``` + +### SEE ALSO + +* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh diff --git a/docs/kmeshctl/kmeshctl_log.md b/docs/kmeshctl/kmeshctl_log.md new file mode 100644 index 0000000..8ab262b --- /dev/null +++ b/docs/kmeshctl/kmeshctl_log.md @@ -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 --set default:debug + +# Get all loggers' name +kmeshctl log + +# Get default logger's level: +kmeshctl log 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 diff --git a/docs/kmeshctl/kmeshctl_monitoring.md b/docs/kmeshctl/kmeshctl_monitoring.md new file mode 100644 index 0000000..5cec0dc --- /dev/null +++ b/docs/kmeshctl/kmeshctl_monitoring.md @@ -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 --accesslog enable/disable + +# Enable/Disable services' metrics and accesslog generated from bpf: +kmeshctl monitoring --all enable/disable + +# Enable/Disable workload granularity metrics: +kmeshctl monitoring --workloadMetrics enable/disable + +# Enable/Disable connection granularity metrics: +kmeshctl monitoring --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 diff --git a/docs/kmeshctl/kmeshctl_secret.md b/docs/kmeshctl/kmeshctl_secret.md new file mode 100644 index 0000000..01cdbdc --- /dev/null +++ b/docs/kmeshctl/kmeshctl_secret.md @@ -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) +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 diff --git a/docs/kmeshctl/kmeshctl_secret_create.md b/docs/kmeshctl/kmeshctl_secret_create.md new file mode 100644 index 0000000..63d82d9 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_secret_create.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_secret_delete.md b/docs/kmeshctl/kmeshctl_secret_delete.md new file mode 100644 index 0000000..90790ed --- /dev/null +++ b/docs/kmeshctl/kmeshctl_secret_delete.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_secret_get.md b/docs/kmeshctl/kmeshctl_secret_get.md new file mode 100644 index 0000000..5c792c9 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_secret_get.md @@ -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 diff --git a/docs/kmeshctl/kmeshctl_version.md b/docs/kmeshctl/kmeshctl_version.md new file mode 100644 index 0000000..388a942 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_version.md @@ -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 +``` + +### Options + +```bash + -h, --help help for version +``` + +### SEE ALSO + +* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh diff --git a/docs/kmeshctl/kmeshctl_waypoint.md b/docs/kmeshctl/kmeshctl_waypoint.md new file mode 100644 index 0000000..6a7dc17 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_waypoint.md @@ -0,0 +1,42 @@ +## kmeshctl waypoint + +Manage waypoint configuration + +### Synopsis + +A group of commands used to manage waypoint configuration + +```bash +kmeshctl waypoint [flags] +``` + +### Examples + +```bash + # Apply a waypoint to the current namespace + kmeshctl waypoint apply + + # Generate a waypoint as yaml + kmeshctl waypoint generate --namespace default + + # List all waypoints in a specific namespace + kmeshctl waypoint list --namespace default +``` + +### Options + +```bash + -h, --help help for waypoint + --image string image of the waypoint + --name string name of the waypoint (default "waypoint") + -n, --namespace string Kubernetes namespace +``` + +### SEE ALSO + +* [kmeshctl](kmeshctl.md) - Kmesh command line tools to operate and debug Kmesh +* [kmeshctl waypoint apply](kmeshctl_waypoint_apply.md) - Apply a waypoint configuration +* [kmeshctl waypoint delete](kmeshctl_waypoint_delete.md) - Delete a waypoint configuration +* [kmeshctl waypoint generate](kmeshctl_waypoint_generate.md) - Generate a waypoint configuration +* [kmeshctl waypoint list](kmeshctl_waypoint_list.md) - List managed waypoint configurations +* [kmeshctl waypoint status](kmeshctl_waypoint_status.md) - Show the status of waypoints in a namespace diff --git a/docs/kmeshctl/kmeshctl_waypoint_apply.md b/docs/kmeshctl/kmeshctl_waypoint_apply.md new file mode 100644 index 0000000..4da9813 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_waypoint_apply.md @@ -0,0 +1,47 @@ +## kmeshctl waypoint apply + +Apply a waypoint configuration + +### Synopsis + +Apply a waypoint configuration to the cluster + +```bash +kmeshctl waypoint apply [flags] +``` + +### Examples + +```bash + # Apply a waypoint to the current namespace + kmeshctl waypoint apply + + # Apply a waypoint to a specific namespace and wait for it to be ready + kmeshctl waypoint apply --namespace default --wait + + # Apply a waypoint to a specific pod + kmesh waypoint apply -n default --name reviews-v2-pod-waypoint --for workload +``` + +### Options + +```bash + --enroll-namespace If set, the namespace will be labeled with the waypoint name + --for string Specify the traffic type [all none service workload] for the waypoint + -h, --help help for apply + --overwrite Overwrite the existing Waypoint used by the namespace + -r, --revision string The revision to label the waypoint with + -w, --wait Wait for the waypoint to be ready +``` + +### Options inherited from parent commands + +```bash + --image string image of the waypoint + --name string name of the waypoint (default "waypoint") + -n, --namespace string Kubernetes namespace +``` + +### SEE ALSO + +* [kmeshctl waypoint](kmeshctl_waypoint.md) - Manage waypoint configuration diff --git a/docs/kmeshctl/kmeshctl_waypoint_delete.md b/docs/kmeshctl/kmeshctl_waypoint_delete.md new file mode 100644 index 0000000..420ac3b --- /dev/null +++ b/docs/kmeshctl/kmeshctl_waypoint_delete.md @@ -0,0 +1,46 @@ +## kmeshctl waypoint delete + +Delete a waypoint configuration + +### Synopsis + +Delete a waypoint configuration from the cluster + +```bash +kmeshctl waypoint delete [flags] +``` + +### Examples + +```bash + # Delete a waypoint from the default namespace + kmeshctl waypoint delete + + # Delete a waypoint by name, which can obtain from kmeshctl waypoint list + kmeshctl waypoint delete waypoint-name --namespace default + + # Delete several waypoints by name + kmeshctl waypoint delete waypoint-name1 waypoint-name2 --namespace default + + # Delete all waypoints in a specific namespace + kmeshctl waypoint delete --all --namespace default +``` + +### Options + +```bash + --all Delete all waypoints in the namespace + -h, --help help for delete +``` + +### Options inherited from parent commands + +```bash + --image string image of the waypoint + --name string name of the waypoint (default "waypoint") + -n, --namespace string Kubernetes namespace +``` + +### SEE ALSO + +* [kmeshctl waypoint](kmeshctl_waypoint.md) - Manage waypoint configuration diff --git a/docs/kmeshctl/kmeshctl_waypoint_generate.md b/docs/kmeshctl/kmeshctl_waypoint_generate.md new file mode 100644 index 0000000..2029133 --- /dev/null +++ b/docs/kmeshctl/kmeshctl_waypoint_generate.md @@ -0,0 +1,41 @@ +## kmeshctl waypoint generate + +Generate a waypoint configuration + +### Synopsis + +Generate a waypoint configuration as YAML + +```bash +kmeshctl waypoint generate [flags] +``` + +### Examples + +```bash + # Generate a waypoint as yaml + kmeshctl waypoint generate --namespace default + + # Generate a waypoint that can process traffic for service in default namespace + kmeshctl waypoint generate --for service -n default +``` + +### Options + +```bash + --for string Specify the traffic type [all none service workload] for the waypoint + -h, --help help for generate + -r, --revision string The revision to label the waypoint with +``` + +### Options inherited from parent commands + +```bash + --image string image of the waypoint + --name string name of the waypoint (default "waypoint") + -n, --namespace string Kubernetes namespace +``` + +### SEE ALSO + +* [kmeshctl waypoint](kmeshctl_waypoint.md) - Manage waypoint configuration diff --git a/docs/kmeshctl/kmeshctl_waypoint_list.md b/docs/kmeshctl/kmeshctl_waypoint_list.md new file mode 100644 index 0000000..b96a82c --- /dev/null +++ b/docs/kmeshctl/kmeshctl_waypoint_list.md @@ -0,0 +1,40 @@ +## kmeshctl waypoint list + +List managed waypoint configurations + +### Synopsis + +List managed waypoint configurations in the cluster + +```bash +kmeshctl waypoint list [flags] +``` + +### Examples + +```bash + # List all waypoints in a specific namespace + kmeshctl waypoint list --namespace default + + # List all waypoints in the cluster + kmeshctl waypoint list -A +``` + +### Options + +```bash + -A, --all-namespaces List all waypoints in all namespaces + -h, --help help for list +``` + +### Options inherited from parent commands + +```bash + --image string image of the waypoint + --name string name of the waypoint (default "waypoint") + -n, --namespace string Kubernetes namespace +``` + +### SEE ALSO + +* [kmeshctl waypoint](kmeshctl_waypoint.md) - Manage waypoint configuration diff --git a/docs/kmeshctl/kmeshctl_waypoint_status.md b/docs/kmeshctl/kmeshctl_waypoint_status.md new file mode 100644 index 0000000..942423a --- /dev/null +++ b/docs/kmeshctl/kmeshctl_waypoint_status.md @@ -0,0 +1,39 @@ +## kmeshctl waypoint status + +Show the status of waypoints in a namespace + +### Synopsis + +Show the status of waypoints for the namespace provided or default namespace if none is provided + +```bash +kmeshctl waypoint status [flags] +``` + +### Examples + +```bash + # Show the status of the waypoint in the default namespace + kmeshctl waypoint status + + # Show the status of the waypoint in a specific namespace + kmeshctl waypoint status --namespace foo +``` + +### Options + +```bash + -h, --help help for status +``` + +### Options inherited from parent commands + +```bash + --image string image of the waypoint + --name string name of the waypoint (default "waypoint") + -n, --namespace string Kubernetes namespace +``` + +### SEE ALSO + +* [kmeshctl waypoint](kmeshctl_waypoint.md) - Manage waypoint configuration