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
1 change: 1 addition & 0 deletions docs/docs/dev/generated/cmd/kuma-dp/kuma-dp_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ kuma-dp run [flags]
--dns-prometheus-port uint32 A port for exposing Prometheus stats (default 19153)
--dns-server-config-dir string Directory in which DNS Server config will be generated
--drain-time duration drain time for Envoy connections on Kuma DP shutdown (default 30s)
--envoy-log-level string Envoy log level. Available values are: [trace][debug][info][warning|warn][error][critical][off]. By default it inherits Kuma DP logging level.
-h, --help help for run
--mesh string Mesh that Dataplane belongs to
--name string Name of the Dataplane
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ kumactl inspect dataplane NAME [flags]
### Options

```
--config-dump if set then the command returns envoy config dump for provided dataplane
-h, --help help for dataplane
-m, --mesh string mesh to use (default "default")
--type string inspection type: one of policies|config-dump|stats|clusters (default "policies")
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ kumactl inspect zoneegress NAME [flags]
### Options

```
--config-dump if set then the command returns envoy config dump for provided dataplane
-h, --help help for zoneegress
--type string inspection type: one of config-dump|stats|clusters (default "config-dump")
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ kumactl inspect zoneingress NAME [flags]
### Options

```
--config-dump if set then the command returns envoy config dump for provided dataplane
-h, --help help for zoneingress
--type string inspection type: one of config-dump|stats|clusters (default "config-dump")
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,21 @@ kumactl install control-plane [flags]
--cni-chained enable chained CNI installation
--cni-conf-name string set the CNI configuration name (default "kuma-cni.conf")
--cni-enabled install Kuma with CNI instead of proxy init container
--cni-experimental install Kuma with new version of the CNI (experimental)
--cni-net-dir string set the CNI install directory (default "/etc/cni/multus/net.d")
--cni-node-selector stringToString node selector for CNI deployment (default [])
--cni-registry string registry for the image of the Kuma CNI component (default "docker.io/kumahq")
--cni-registry string registry for the image of the Kuma CNI component
--cni-repository string repository for the image of the Kuma CNI component (default "install-cni")
--cni-version string version of the image of the Kuma CNI component (default "0.0.10")
--control-plane-node-selector stringToString node selector for Kuma Control Plane (default [])
--control-plane-registry string registry for the image of the Kuma Control Plane component (default "docker.io/kumahq")
--control-plane-registry string registry for the image of the Kuma Control Plane component
--control-plane-repository string repository for the image of the Kuma Control Plane component (default "kuma-cp")
--control-plane-service-name string Service name of the Kuma Control Plane (default "kuma-control-plane")
--control-plane-version string version of the image of the Kuma Control Plane component (default "unknown")
--dataplane-init-registry string registry for the init image of the Kuma DataPlane component (default "docker.io/kumahq")
--dataplane-init-registry string registry for the init image of the Kuma DataPlane component
--dataplane-init-repository string repository for the init image of the Kuma DataPlane component (default "kuma-init")
--dataplane-init-version string version of the init image of the Kuma DataPlane component (default "unknown")
--dataplane-registry string registry for the image of the Kuma DataPlane component (default "docker.io/kumahq")
--dataplane-registry string registry for the image of the Kuma DataPlane component
--dataplane-repository string repository for the image of the Kuma DataPlane component (default "kuma-dp")
--dataplane-version string version of the image of the Kuma DataPlane component (default "unknown")
--dump-values output all possible values for the configuration. This is similar to `helm show values <chart>
Expand All @@ -52,6 +53,7 @@ kumactl install control-plane [flags]
--kds-global-address string URL of Global Kuma CP (example: grpcs://192.168.0.1:5685)
--mode string kuma cp modes: one of standalone|zone|global (default "standalone")
--namespace string namespace to install Kuma Control Plane to (default "kuma-system")
--registry string registry for all images (default "docker.io/kumahq")
--set helm template <chart> --set ... set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2), This is similar to helm template <chart> --set ... to use set-file or set-string just use helm instead
--tls-api-server-client-certs-secret string Secret that contains list of .pem certificates that can access admin endpoints of Kuma API on HTTPS
--tls-api-server-secret string Secret that contains tls.crt, tls.key for protecting Kuma API on HTTPS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ kumactl install demo [flags]
```
-h, --help help for demo
--namespace string Namespace to install demo to (default "kuma-demo")
--without-gateway Skip MeshGateway resources
--zone string Zone in which to install demo (default "local")
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ kumactl install transparent-proxy [flags]

```
--dry-run dry run
--ebpf-bpffs-path string the path of the BPF filesystem (default "/run/kuma/bpf")
--ebpf-enabled use ebpf instead of iptables to install transparent proxy
--ebpf-instance-ip string IP address of the instance (pod/vm) where transparent proxy will be installed
--ebpf-programs-source-path string path where compiled ebpf programs and other necessary for ebpf mode files can be found (default "/kuma/ebpf")
--exclude-inbound-ports string a comma separated list of inbound ports to exclude from redirect to Envoy
--exclude-outbound-ports string a comma separated list of outbound ports to exclude from redirect to Envoy
--experimental-transparent-proxy-engine use experimental transparent proxy engine
Expand Down
27 changes: 27 additions & 0 deletions docs/docs/dev/generated/kuma-cp.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,12 @@ xdsServer:
dataplaneStatusFlushInterval: 10s # ENV: KUMA_XDS_SERVER_DATAPLANE_STATUS_FLUSH_INTERVAL
# Backoff that is executed when Control Plane is sending the response that was previously rejected by Dataplane
nackBackoff: 5s # ENV: KUMA_XDS_SERVER_NACK_BACKOFF
# A delay between proxy terminating a connection and the CP trying to deregister the proxy.
# It is used only in universal mode when you use direct lifecycle.
# Setting this setting to 0s disables the delay.
# Disabling this may cause race conditions that one instance of CP removes proxy object
# while proxy is connected to another instance of the CP.
dataplaneDeregistrationDelay: 10s # ENV: KUMA_XDS_DATAPLANE_DEREGISTRATION_DELAY

# API Server configuration
apiServer:
Expand Down Expand Up @@ -266,6 +272,17 @@ runtime:
enabled: true # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_BUILTIN_DNS_ENABLED
# Redirect port for DNS
port: 15053 # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_BUILTIN_DNS_PORT
# EBPF defines configuration for the ebpf, when transparent proxy is marked to be
# installed using ebpf instead of iptables
ebpf:
# Install transparent proxy using ebpf
enabled: false # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_ENABLED
# Name of the environmental variable which will include IP address of the pod
instanceIPEnvVarName: INSTANCE_IP # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_INSTANCE_IP_ENV_VAR_NAME
# Path where BPF file system will be mounted for pinning ebpf programs and maps
bpffsPath: /run/kuma/bpf # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_BPFFS_PATH
# Path where compiled eBPF programs are placed
programsSourcePath: /kuma/ebpf # ENV: KUMA_RUNTIME_KUBERNETES_INJECTOR_EBPF_PROGRAMS_SOURCE_PATH
marshalingCacheExpirationTime: 5m # ENV: KUMA_RUNTIME_KUBERNETES_MARSHALING_CACHE_EXPIRATION_TIME
# Universal-specific configuration
universal:
Expand Down Expand Up @@ -437,6 +454,16 @@ access:
users: [ ] # ENV: KUMA_ACCESS_STATIC_GET_CONFIG_DUMP_USERS
# List of groups that are allowed to get envoy config dump
groups: ["mesh-system:unauthenticated","mesh-system:authenticated"] # ENV: KUMA_ACCESS_STATIC_GET_CONFIG_DUMP_GROUPS
viewStats:
# List of users that are allowed to get envoy stats
users: [ ] # ENV: KUMA_ACCESS_STATIC_VIEW_STATS_USERS
# List of groups that are allowed to get envoy stats
groups: ["mesh-system:unauthenticated","mesh-system:authenticated"] # ENV: KUMA_ACCESS_STATIC_VIEW_STATS_GROUPS
viewClusters:
# List of users that are allowed to get envoy clusters
users: [ ] # ENV: KUMA_ACCESS_STATIC_VIEW_CLUSTERS_USERS
# List of groups that are allowed to get envoy clusters
groups: ["mesh-system:unauthenticated","mesh-system:authenticated"] # ENV: KUMA_ACCESS_STATIC_VIEW_CLUSTERS_GROUPS

# Configuration of experimental features of Kuma
experimental:
Expand Down
Loading