Skip to content

Commit

Permalink
Added info to references.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JoukoVirtanen committed Oct 8, 2024
1 parent c3e1306 commit fb994de
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/references.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ internal state of Collector. Refer to the
[troubleshooting](troubleshooting.md#introspection-endpoints) section for more details.
The default is false.

* `ROX_ENABLE_EXTERNAL_IPS`: Enables or disables the external IPs feature.

NOTE: Using environment variables is a preferred way of configuring Collector,
so if you're adding a new configuration knob, keep this in mind.

Expand All @@ -104,6 +106,35 @@ seconds. The default value is 30 seconds.

* `logLevel`: Sets logging level. The default is INFO.

### File mount or ConfigMap

The external IPs feature can be enabled or disabled using a file or ConfigMap. This is an optional
method and does not have to be used. This file overwites the ENABLE_EXTERNAL_IPS feature flag.
When using collector by itself a file can be mounted to it at /etc/stackrox/runtime_config.yaml. The
following is an example of the contents

```
networkConnectionConfig:
enableExternalIps: true
```

Alternatively, if collector is used as a part of Stackrox, the configuration can be set
using a ConfigMap. The following is an example of such a ConfigMap.

```
apiVersion: v1
kind: ConfigMap
metadata:
name: collector-config
namespace: stackrox
data:
runtime_config.yaml: |
networkConnectionConfig:
enableExternalIps: true
```

The file path can be set using the `ROX_COLLECTOR_CONFIG_PATH` environment variable.

### Other arguments

* `--collection-method`: Which technology to use for data gathering. Either
Expand Down

0 comments on commit fb994de

Please sign in to comment.