Skip to content

Commit

Permalink
Document DemultiplexingBlobAccess more extensively
Browse files Browse the repository at this point in the history
Instead of refering users to the scheduler demultiplexing, just document
it in a similar way. That way it's harder to overlook.
  • Loading branch information
EdSchouten committed Sep 14, 2023
1 parent c04246b commit 3e2cfd8
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
6 changes: 3 additions & 3 deletions pkg/proto/configuration/bb_storage/bb_storage.proto
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ message ApplicationConfiguration {
repeated buildbarn.configuration.grpc.ServerConfiguration grpc_servers = 4;

// Map of schedulers available capable of running build actions, where
// the key corresponds to the instance name prefix. In case of
// multiple matches, the scheduler with the longest matching prefix is
// used. The matching prefix is removed from the resulting instance
// the key corresponds to the instance name prefix to match. In case
// of multiple matches, the scheduler with the longest matching prefix
// is used. The matching prefix is removed from the resulting instance
// name.
//
// For example, if schedulers for instance name prefixes "acmecorp"
Expand Down
17 changes: 14 additions & 3 deletions pkg/proto/configuration/blobstore/blobstore.proto
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,7 @@ message BlobAccessConfiguration {
//
// The logic for matching incoming requests and mutating the
// instance name in outgoing requests is identical to bb_storage's
// 'schedulers' configuration option. Please refer to that
// configuration option for more details.
// 'schedulers' configuration option.
DemultiplexingBlobAccessConfiguration demultiplexing = 20;

// Read objects using instance names in a hierarchical fashion. This
Expand Down Expand Up @@ -897,7 +896,19 @@ message ConcurrencyLimitingBlobReplicatorConfiguration {
}

message DemultiplexingBlobAccessConfiguration {
// The instance name prefixes for which requests are forwarded.
// Map of storage backends, where the key corresponds to the instance
// name prefix to match. In case of multiple matches, the storage
// backend with the longest matching prefix is used. The matching
// prefix is removed from the resulting instance name.
//
// For example, if storage backends for instance name prefixes
// "acmecorp" and "acmecorp/rockets" are declared, requests for
// instance name "acmecorp/rockets/mars" will be forwarded to the
// latter. This storage backend will receive requests with instance
// name "mars".
//
// The empty string can be used to match all instance names, thereby
// causing all requests to be forwarded to a single storage backend.
map<string, DemultiplexedBlobAccessConfiguration> instance_name_prefixes = 1;
}

Expand Down

0 comments on commit 3e2cfd8

Please sign in to comment.