Skip to content

Commit 993434d

Browse files
leogrpoiana
authored andcommitted
docs: regenerate
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
1 parent 4b77cc0 commit 993434d

File tree

5 files changed

+21
-8
lines changed

5 files changed

+21
-8
lines changed

cmd/bench.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ N.B.:
4949
5050
One commmon way to use this command is as following:
5151
52-
event-generator bench "ChangeThreadNamespace|ReadSensitiveFileUntrusted" --loop --sleep 10ms --pid $(pidof -s falco)
52+
event-generator bench "ChangeThreadNamespace|ReadSensitiveFileUntrusted" --all --loop --sleep 10ms --pid $(pidof -s falco)
5353
5454
5555
` + runWarningMessage

docs/event-generator_bench.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ N.B.:
2020

2121
One commmon way to use this command is as following:
2222

23-
event-generator bench "ChangeThreadNamespace|ReadSensitiveFileUntrusted" --loop --sleep 10ms --pid $(pidof -s falco)
23+
event-generator bench "ChangeThreadNamespace|ReadSensitiveFileUntrusted" --all --loop --sleep 10ms --pid $(pidof -s falco)
2424

2525

2626

@@ -38,14 +38,17 @@ event-generator bench [regexp] [flags]
3838

3939
```
4040
--all Run all actions, including those disabled by default
41-
--as string Username to impersonate for the operation
41+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
4242
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
43-
--cache-dir string Default HTTP cache directory (default "$HOME/.kube/http-cache")
43+
--as-uid string UID to impersonate for the operation.
44+
--cache-dir string Default cache directory (default "$HOME/.kube/http-cache")
4445
--certificate-authority string Path to a cert file for the certificate authority
4546
--client-certificate string Path to a client certificate file for TLS
4647
--client-key string Path to a client key file for TLS
4748
--cluster string The name of the kubeconfig cluster to use
4849
--context string The name of the kubeconfig context to use
50+
--disable-compression If true, opt-out of response compression for all requests to the server
51+
--dry-run Do not connect to Falco gRPC API
4952
--grpc-ca string CA root file path for connecting to a Falco gRPC server (default "/etc/falco/certs/ca.crt")
5053
--grpc-cert string Cert file path for connecting to a Falco gRPC server (default "/etc/falco/certs/client.crt")
5154
--grpc-hostname string Hostname for connecting to a Falco gRPC server (default "localhost")
@@ -65,6 +68,7 @@ event-generator bench [regexp] [flags]
6568
--round-duration duration Duration of a benchmark round (default 5s)
6669
-s, --server string The address and port of the Kubernetes API server
6770
--sleep duration The length of time to wait before running an action. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means no sleep. (default 100ms)
71+
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
6872
--token string Bearer token for authentication to the API server
6973
--user string The name of the kubeconfig user to use
7074
```
@@ -80,3 +84,4 @@ event-generator bench [regexp] [flags]
8084
### SEE ALSO
8185

8286
* [event-generator](event-generator.md) - A command line tool to perform a variety of suspect actions.
87+

docs/event-generator_list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ event-generator list [regexp] [flags]
1414
### Options
1515

1616
```
17+
--all List all actions, including those disabled by default
1718
-h, --help help for list
1819
```
1920

docs/event-generator_run.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,16 @@ event-generator run [regexp] [flags]
2323

2424
```
2525
--all Run all actions, including those disabled by default
26-
--as string Username to impersonate for the operation
26+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
2727
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
28-
--cache-dir string Default HTTP cache directory (default "$HOME/.kube/http-cache")
28+
--as-uid string UID to impersonate for the operation.
29+
--cache-dir string Default cache directory (default "$HOME/.kube/http-cache")
2930
--certificate-authority string Path to a cert file for the certificate authority
3031
--client-certificate string Path to a client certificate file for TLS
3132
--client-key string Path to a client key file for TLS
3233
--cluster string The name of the kubeconfig cluster to use
3334
--context string The name of the kubeconfig context to use
35+
--disable-compression If true, opt-out of response compression for all requests to the server
3436
-h, --help help for run
3537
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
3638
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
@@ -40,6 +42,7 @@ event-generator run [regexp] [flags]
4042
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
4143
-s, --server string The address and port of the Kubernetes API server
4244
--sleep duration The length of time to wait before running an action. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means no sleep. (default 100ms)
45+
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
4346
--token string Bearer token for authentication to the API server
4447
--user string The name of the kubeconfig user to use
4548
```

docs/event-generator_test.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@ event-generator test [regexp] [flags]
2424

2525
```
2626
--all Run all actions, including those disabled by default
27-
--as string Username to impersonate for the operation
27+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
2828
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
29-
--cache-dir string Default HTTP cache directory (default "$HOME/.kube/http-cache")
29+
--as-uid string UID to impersonate for the operation.
30+
--cache-dir string Default cache directory (default "$HOME/.kube/http-cache")
3031
--certificate-authority string Path to a cert file for the certificate authority
3132
--client-certificate string Path to a client certificate file for TLS
3233
--client-key string Path to a client key file for TLS
3334
--cluster string The name of the kubeconfig cluster to use
3435
--context string The name of the kubeconfig context to use
36+
--disable-compression If true, opt-out of response compression for all requests to the server
3537
--grpc-ca string CA root file path for connecting to a Falco gRPC server (default "/etc/falco/certs/ca.crt")
3638
--grpc-cert string Cert file path for connecting to a Falco gRPC server (default "/etc/falco/certs/client.crt")
3739
--grpc-hostname string Hostname for connecting to a Falco gRPC server (default "localhost")
@@ -48,6 +50,7 @@ event-generator test [regexp] [flags]
4850
-s, --server string The address and port of the Kubernetes API server
4951
--sleep duration The length of time to wait before running an action. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means no sleep. (default 100ms)
5052
--test-timeout duration Test duration timeout (default 1m0s)
53+
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
5154
--token string Bearer token for authentication to the API server
5255
--user string The name of the kubeconfig user to use
5356
```
@@ -63,3 +66,4 @@ event-generator test [regexp] [flags]
6366
### SEE ALSO
6467

6568
* [event-generator](event-generator.md) - A command line tool to perform a variety of suspect actions.
69+

0 commit comments

Comments
 (0)