Skip to content

Commit

Permalink
Remove experimental credshelper flags
Browse files Browse the repository at this point in the history 
Bug: b/370793522
Test: Tested locally with chromium build
Change-Id: I0121372300e2f1c3967faacd6de38d6ce6c0ac0b
GitOrigin-RevId: a77e2285eff262cf4128794f433d809cf6a0c47a
  • Loading branch information
@banikharbanda @copybara-github
banikharbanda authored and copybara-github committed Oct 2, 2024
1 parent 5132ea9 commit 4017a6c
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 44 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -420,8 +420,8 @@ If your RE Server uses RPC authentication then use one of the following flags:
* **credential_file** - The name of a file that contains service account
credentials to use when calling remote execution. Used only if
`-use_application_default_credentials` and `-use_gce_credentials` are false.
* **experimental_credentials_helper** - Path to the credentials helper binary. If given `execrel://`, looks for the `credshelper` binary in the same folder as bootstrap/reproxy
* **experimental_credentials_helper_args** - Arguments for the experimental credentials helper, separated by space
* **credentials_helper** - Path to the credentials helper binary. If given `execrel://`, looks for the `credshelper` binary in the same folder as bootstrap/reproxy
* **credentials_helper_args** - Arguments for the credentials helper, separated by space

The reproxy is typically started via the bootstrap, so it is recommended to
avoid configuring it through the command line flags. It's advised to use
Expand Down
62 changes: 24 additions & 38 deletions cmd/bootstrap/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,31 +58,29 @@ var (
)

var (
proxyLogDir []string
serverAddr = flag.String("server_address", "", "The server address in the format of host:port for network, or unix:///file for unix domain sockets.")
reProxy = flag.String("re_proxy", reproxyDefaultPath(), "Location of the reproxy binary")
waitSeconds = flag.Int("reproxy_wait_seconds", 20, "Number of seconds to wait for reproxy to start")
shutdown = flag.Bool("shutdown", false, "Whether to shut down the proxy and dump the stats.")
shutdownSeconds = flag.Int("shutdown_seconds", 60, "Number of seconds to wait for reproxy to shutdown")
logFormat = flag.String("log_format", "text", "Format of proxy log. Currently only text and reducedtext are supported.")
logPath = flag.String("log_path", "", "DEPRECATED. Use proxy_log_dir instead. If provided, the path to a log file of all executed records. The format is e.g. text://full/file/path.")
fastLogCollection = flag.Bool("fast_log_collection", false, "Enable optimized log aggregation pipeline. Does not work for multileg builds")
asyncReproxyShutdown = flag.Bool("async_reproxy_termination", false, "Allows reproxy to finish shutdown asyncronously. Only applicable with fast_log_collection=true")
metricsProject = flag.String("metrics_project", "", "If set, action and build metrics are exported to Cloud Monitoring in the specified GCP project")
outputDir = flag.String("output_dir", os.TempDir(), "The location to which stats should be written.")
useADC = flag.Bool(auth.UseAppDefaultCredsFlag, false, "Indicates whether to use application default credentials for authentication")
useGCE = flag.Bool(auth.UseGCECredsFlag, false, "Indicates whether to use GCE VM credentials for authentication")
useExternalToken = flag.Bool(auth.UseExternalTokenFlag, false, "Indicates whether to use an externally provided token for authentication")
serviceNoAuth = flag.Bool(auth.ServiceNoAuthFlag, false, "If true, do not authenticate with RBE.")
credFile = flag.String(auth.CredentialFileFlag, "", "The name of a file that contains service account credentials to use when calling remote execution. Used only if --use_application_default_credentials and --use_gce_credentials are false.")
remoteDisabled = flag.Bool("remote_disabled", false, "Whether to disable all remote operations and run all actions locally.")
cacheDir = flag.String("cache_dir", "", "Directory from which to load the cache files at startup and update at shutdown.")
metricsUploader = flag.String("metrics_uploader", defaultMetricsUploader(), "Path to the metrics uploader binary.")
logHTTPCalls = flag.Bool("log_http_calls", false, "Log all http requests made with the default http client.")
experimentalCredentialsHelper = flag.String(auth.CredshelperPathFlag, "", "Path to the credentials helper binary. If given execrel://, looks for the `credshelper` binary in the same folder as bootstrap")
experimentalCredentialsHelperArgs = flag.String(auth.CredshelperArgsFlag, "", "Arguments for the experimental credentials helper, separated by space.")
credentialsHelper = flag.String(credshelper.CredshelperPathFlag, "", "Path to the credentials helper binary. If given execrel://, looks for the `credshelper` binary in the same folder as bootstrap")
credentialsHelperArgs = flag.String(credshelper.CredshelperArgsFlag, "", "Arguments for the credentials helper, separated by space.")
proxyLogDir []string
serverAddr = flag.String("server_address", "", "The server address in the format of host:port for network, or unix:///file for unix domain sockets.")
reProxy = flag.String("re_proxy", reproxyDefaultPath(), "Location of the reproxy binary")
waitSeconds = flag.Int("reproxy_wait_seconds", 20, "Number of seconds to wait for reproxy to start")
shutdown = flag.Bool("shutdown", false, "Whether to shut down the proxy and dump the stats.")
shutdownSeconds = flag.Int("shutdown_seconds", 60, "Number of seconds to wait for reproxy to shutdown")
logFormat = flag.String("log_format", "text", "Format of proxy log. Currently only text and reducedtext are supported.")
logPath = flag.String("log_path", "", "DEPRECATED. Use proxy_log_dir instead. If provided, the path to a log file of all executed records. The format is e.g. text://full/file/path.")
fastLogCollection = flag.Bool("fast_log_collection", false, "Enable optimized log aggregation pipeline. Does not work for multileg builds")
asyncReproxyShutdown = flag.Bool("async_reproxy_termination", false, "Allows reproxy to finish shutdown asyncronously. Only applicable with fast_log_collection=true")
metricsProject = flag.String("metrics_project", "", "If set, action and build metrics are exported to Cloud Monitoring in the specified GCP project")
outputDir = flag.String("output_dir", os.TempDir(), "The location to which stats should be written.")
useADC = flag.Bool(auth.UseAppDefaultCredsFlag, false, "Indicates whether to use application default credentials for authentication")
useGCE = flag.Bool(auth.UseGCECredsFlag, false, "Indicates whether to use GCE VM credentials for authentication")
useExternalToken = flag.Bool(auth.UseExternalTokenFlag, false, "Indicates whether to use an externally provided token for authentication")
serviceNoAuth = flag.Bool(auth.ServiceNoAuthFlag, false, "If true, do not authenticate with RBE.")
credFile = flag.String(auth.CredentialFileFlag, "", "The name of a file that contains service account credentials to use when calling remote execution. Used only if --use_application_default_credentials and --use_gce_credentials are false.")
remoteDisabled = flag.Bool("remote_disabled", false, "Whether to disable all remote operations and run all actions locally.")
cacheDir = flag.String("cache_dir", "", "Directory from which to load the cache files at startup and update at shutdown.")
metricsUploader = flag.String("metrics_uploader", defaultMetricsUploader(), "Path to the metrics uploader binary.")
logHTTPCalls = flag.Bool("log_http_calls", false, "Log all http requests made with the default http client.")
credentialsHelper = flag.String(credshelper.CredshelperPathFlag, "", "Path to the credentials helper binary. If given execrel://, looks for the `credshelper` binary in the same folder as bootstrap")
credentialsHelperArgs = flag.String(credshelper.CredshelperArgsFlag, "", "Arguments for the credentials helper, separated by space.")
)

func main() {
Expand Down Expand Up @@ -136,14 +134,7 @@ func main() {
}

var ts *grpcOauth.TokenSource
credsArgs := []string{}
if !*remoteDisabled {
if *experimentalCredentialsHelper != "" && *credentialsHelper == "" {
*credentialsHelper = *experimentalCredentialsHelper
*credentialsHelperArgs = *experimentalCredentialsHelperArgs
credsArgs = append(credsArgs, fmt.Sprintf("--%v=%v", credshelper.CredshelperPathFlag, *credentialsHelper))
credsArgs = append(credsArgs, fmt.Sprintf("--%v=%v", credshelper.CredshelperArgsFlag, *credentialsHelperArgs))
}
if *credentialsHelper != "" {
c, err := credshelper.NewExternalCredentials(*credentialsHelper, strings.Fields(*credentialsHelperArgs))
if err != nil {
Expand Down Expand Up @@ -241,9 +232,8 @@ func main() {
}

currArgs := args[:]
if *experimentalCredentialsHelper != "" || *credentialsHelper != "" {
if *credentialsHelper != "" {
currArgs = append(currArgs, "--use_external_auth_token=true")
currArgs = append(currArgs, credsArgs...)
}
msg, exitCode := bootstrapReproxy(currArgs, bootstrapStart)
if exitCode == 0 {
Expand Down Expand Up @@ -343,10 +333,6 @@ func bootstrapReproxy(args []string, startTime time.Time) (string, int) {
}

func authMechanism() auth.Mechanism {
if *experimentalCredentialsHelper != "" {
fmt.Fprintf(os.Stderr, "--experimental_credentials_helper flags are deprecated, please use --credentials_helper flags")
os.Exit(auth.ExitCodeExternalTokenAuth)
}
m, err := auth.MechanismFromFlags()
if err != nil || m == auth.Unknown {
log.Errorf("Failed to determine auth mechanism: %v", err)
Expand Down
4 changes: 0 additions & 4 deletions internal/pkg/auth/auth.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,6 @@ func (m Mechanism) String() string {
}

const (
// CredshelperPathFlag is the path to the credentials helper binary.
CredshelperPathFlag = "experimental_credentials_helper"
// CredshelperArgsFlag is the flag used to pass in the arguments to the credentials helper binary.
CredshelperArgsFlag = "experimental_credentials_helper_args"
// UseAppDefaultCredsFlag is used to authenticate with application default credentials.
UseAppDefaultCredsFlag = "use_application_default_credentials"
// UseExternalTokenFlag indicates the user will authenticate with a provided token.
Expand Down

0 comments on commit 4017a6c

Please sign in to comment.