Skip to content

Commit

Permalink
docs: regenerate
Browse files Browse the repository at this point in the history 
Signed-off-by: Leonardo Grasso <[email protected]>
  • Loading branch information
@leogr @poiana
leogr authored and poiana committed Jan 29, 2024
1 parent 4b77cc0 commit 993434d
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 8 deletions.
2 changes: 1 addition & 1 deletion cmd/bench.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ N.B.:
One commmon way to use this command is as following:
event-generator bench "ChangeThreadNamespace|ReadSensitiveFileUntrusted" --loop --sleep 10ms --pid $(pidof -s falco)
event-generator bench "ChangeThreadNamespace|ReadSensitiveFileUntrusted" --all --loop --sleep 10ms --pid $(pidof -s falco)
` + runWarningMessage
Expand Down
11 changes: 8 additions & 3 deletions docs/event-generator_bench.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ N.B.:

One commmon way to use this command is as following:

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



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

```
--all Run all actions, including those disabled by default
--as string Username to impersonate for the operation
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--cache-dir string Default HTTP cache directory (default "$HOME/.kube/http-cache")
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "$HOME/.kube/http-cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--disable-compression If true, opt-out of response compression for all requests to the server
--dry-run Do not connect to Falco gRPC API
--grpc-ca string CA root file path for connecting to a Falco gRPC server (default "/etc/falco/certs/ca.crt")
--grpc-cert string Cert file path for connecting to a Falco gRPC server (default "/etc/falco/certs/client.crt")
--grpc-hostname string Hostname for connecting to a Falco gRPC server (default "localhost")
Expand All @@ -65,6 +68,7 @@ event-generator bench [regexp] [flags]
--round-duration duration Duration of a benchmark round (default 5s)
-s, --server string The address and port of the Kubernetes API server
--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)
--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
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
```
Expand All @@ -80,3 +84,4 @@ event-generator bench [regexp] [flags]
### SEE ALSO

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

1 change: 1 addition & 0 deletions docs/event-generator_list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ event-generator list [regexp] [flags]
### Options

```
--all List all actions, including those disabled by default
-h, --help help for list
```

Expand Down
7 changes: 5 additions & 2 deletions docs/event-generator_run.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,16 @@ event-generator run [regexp] [flags]

```
--all Run all actions, including those disabled by default
--as string Username to impersonate for the operation
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--cache-dir string Default HTTP cache directory (default "$HOME/.kube/http-cache")
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "$HOME/.kube/http-cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--disable-compression If true, opt-out of response compression for all requests to the server
-h, --help help for run
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
Expand All @@ -40,6 +42,7 @@ event-generator run [regexp] [flags]
--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")
-s, --server string The address and port of the Kubernetes API server
--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)
--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
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
```
Expand Down
8 changes: 6 additions & 2 deletions docs/event-generator_test.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@ event-generator test [regexp] [flags]

```
--all Run all actions, including those disabled by default
--as string Username to impersonate for the operation
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--cache-dir string Default HTTP cache directory (default "$HOME/.kube/http-cache")
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "$HOME/.kube/http-cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--disable-compression If true, opt-out of response compression for all requests to the server
--grpc-ca string CA root file path for connecting to a Falco gRPC server (default "/etc/falco/certs/ca.crt")
--grpc-cert string Cert file path for connecting to a Falco gRPC server (default "/etc/falco/certs/client.crt")
--grpc-hostname string Hostname for connecting to a Falco gRPC server (default "localhost")
Expand All @@ -48,6 +50,7 @@ event-generator test [regexp] [flags]
-s, --server string The address and port of the Kubernetes API server
--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)
--test-timeout duration Test duration timeout (default 1m0s)
--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
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
```
Expand All @@ -63,3 +66,4 @@ event-generator test [regexp] [flags]
### SEE ALSO

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

0 comments on commit 993434d

Please sign in to comment.