Backstage
Docs
Github
Preparing search index...
@backstage/plugin-scaffolder-backend-module-cookiecutter
ContainerRunner
Interface ContainerRunner
Handles the running of containers.
interface
ContainerRunner
{
runContainer
(
opts
:
{
args
:
string
[]
;
command
?:
string
|
string
[]
;
defaultUser
?:
boolean
;
envVars
?:
Record
<
string
,
string
>
;
imageName
:
string
;
logStream
?:
Writable
;
mountDirs
?:
Record
<
string
,
string
>
;
pullImage
?:
boolean
;
pullOptions
?:
{
authconfig
?:
{
auth
?:
string
;
email
?:
string
;
password
?:
string
;
serveraddress
?:
string
;
username
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
workingDir
?:
string
;
}
,
)
:
Promise
<
void
>
;
}
Index
Methods
run
Container
Methods
run
Container
runContainer
(
opts
:
{
args
:
string
[]
;
command
?:
string
|
string
[]
;
defaultUser
?:
boolean
;
envVars
?:
Record
<
string
,
string
>
;
imageName
:
string
;
logStream
?:
Writable
;
mountDirs
?:
Record
<
string
,
string
>
;
pullImage
?:
boolean
;
pullOptions
?:
{
authconfig
?:
{
auth
?:
string
;
email
?:
string
;
password
?:
string
;
serveraddress
?:
string
;
username
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
workingDir
?:
string
;
}
,
)
:
Promise
<
void
>
Runs a container image to completion.
Parameters
opts
:
{
args
:
string
[]
;
command
?:
string
|
string
[]
;
defaultUser
?:
boolean
;
envVars
?:
Record
<
string
,
string
>
;
imageName
:
string
;
logStream
?:
Writable
;
mountDirs
?:
Record
<
string
,
string
>
;
pullImage
?:
boolean
;
pullOptions
?:
{
authconfig
?:
{
auth
?:
string
;
email
?:
string
;
password
?:
string
;
serveraddress
?:
string
;
username
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
workingDir
?:
string
;
}
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
run
Container
Docs
Github
Backstage
Loading...
Handles the running of containers.