Skip to content

Rename variable ScannerGRPCEndpoint to ScannerSlimGRPCEndpoint #3657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SimonBaeumer merged 2 commits into from
Nov 14, 2022
Merged

Rename variable ScannerGRPCEndpoint to ScannerSlimGRPCEndpoint #3657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
577d14a
X-Smart-Branch-Parent: master
SimonBaeumer Nov 14, 2022
812d359
Rename Scanner Slim gRPC endpoint
SimonBaeumer Nov 2, 2022
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
4 changes: 2 additions & 2 deletions pkg/env/sensor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ var (
// SensorEndpoint is used to communicate the sensor endpoint to other services in the same cluster.
SensorEndpoint = RegisterSetting("ROX_SENSOR_ENDPOINT", WithDefault("sensor.stackrox.svc:443"))

// ScannerGRPCEndpoint is used to communicate the scanner endpoint to other services in the same cluster.
// ScannerSlimGRPCEndpoint is used to communicate the scanner endpoint to other services in the same cluster.
// This is typically used for Sensor to communicate with a local Scanner-slim's gRPC server.
ScannerGRPCEndpoint = RegisterSetting("ROX_SCANNER_GRPC_ENDPOINT", WithDefault("scanner.stackrox.svc:8443"))
ScannerSlimGRPCEndpoint = RegisterSetting("ROX_SCANNER_GRPC_ENDPOINT", WithDefault("scanner.stackrox.svc:8443"))
Copy link
Copy Markdown
Contributor

@RTann RTann Nov 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typically used for this, but it's possible Sensor communicates with a full-Scanner (when this is the Central cluster). I'll check the other PR because I'm curious where the confusion came from

Copy link
Copy Markdown
Contributor Author

@SimonBaeumer SimonBaeumer Nov 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The confusion was there because I search for scanner endpoints and found this env variable. Without looking at the concrete package path you can't see whether the variable belongs to sensor or central.

Renaming the variable to slim helps distinguishing when the env var is read. I do agree that it is not 100% technically correct in that case.


// LocalImageScanningEnabled is used to specify if Sensor should attempt to scan images via a local Scanner.
LocalImageScanningEnabled = RegisterBooleanSetting("ROX_LOCAL_IMAGE_SCANNING_ENABLED", false)
Expand Down
2 changes: 1 addition & 1 deletion sensor/common/scannerclient/singleton.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ func GRPCClientSingleton() *Client {
}

var err error
scannerClient, err = dial(env.ScannerGRPCEndpoint.Setting())
scannerClient, err = dial(env.ScannerSlimGRPCEndpoint.Setting())
// If err is not nil, then there was a configuration error.
_ = utils.Should(err)
})
Expand Down