Skip to content

Commit

Permalink
roachtest: document StartServiceForVirtualClusterE
Browse files Browse the repository at this point in the history
Epic: None
Release Note: None
  • Loading branch information
herkolategan authored and DarrylWong committed Jan 16, 2024
1 parent 33e7dad commit e0c80e3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions pkg/cmd/roachtest/cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -1971,6 +1971,17 @@ func (c *clusterImpl) StartE(
return nil
}

// StartServiceForVirtualClusterE can start either external or shared process
// virtual clusters. This can be specified in startOpts.RoachprodOpts. Set the
// `Target` to the required virtual cluster type. Refer to the virtual cluster
// section in the struct for more information on what fields are available for
// virtual clusters.
//
// With external process virtual clusters an external process will be started on
// each node specified in the externalNodes parameter.
//
// With shared process virtual clusters the required queries will be run on a
// storage node of the cluster specified in the opts parameter.
func (c *clusterImpl) StartServiceForVirtualClusterE(
ctx context.Context,
l *logger.Logger,
Expand Down

0 comments on commit e0c80e3

Please sign in to comment.