These docs are for Rancher 1.6, if you are looking for Rancher 2.x docs, see
here.
launchConfig
Resource Fields
Writeable Fields
Field |
Type |
Create |
Update |
Default |
Notes |
blkioDeviceOptions |
map[blkioDeviceOption] |
Optional |
- |
- |
|
build |
dockerBuild |
Optional |
- |
- |
|
capAdd |
array[enum] |
Optional |
- |
- |
|
capDrop |
array[enum] |
Optional |
- |
- |
|
command |
array[string] |
Optional |
- |
- |
|
count |
int |
Optional |
- |
- |
|
cpuSet |
string |
Optional |
- |
- |
|
cpuShares |
int |
Optional |
- |
- |
|
dataVolumeMounts |
map[volume] |
Optional |
- |
- |
|
dataVolumes |
array[string] |
Optional |
- |
- |
|
dataVolumesFrom |
array[container] |
Optional |
- |
- |
|
dataVolumesFromLaunchConfigs |
array[string] |
Optional |
- |
- |
|
description |
string |
Optional |
Yes |
- |
|
devices |
array[string] |
Optional |
- |
- |
|
disks |
array[virtualMachineDisk] |
Optional |
- |
- |
|
dns |
array[string] |
Optional |
- |
- |
|
dnsSearch |
array[string] |
Optional |
- |
- |
|
domainName |
string |
Optional |
- |
- |
|
entryPoint |
array[string] |
Optional |
- |
- |
|
environment |
map[string] |
Optional |
- |
- |
|
expose |
array[string] |
Optional |
- |
- |
|
extraHosts |
array[string] |
Optional |
- |
- |
|
healthCheck |
instanceHealthCheck |
Optional |
- |
- |
|
hostname |
string |
Optional |
- |
- |
|
imageUuid |
string |
Optional |
- |
- |
|
instanceLinks |
map[instance] |
Optional |
- |
- |
|
kind |
enum |
Optional |
- |
container |
The options are container , virtualMachine . |
labels |
map[string] |
Optional |
- |
- |
A map of key value pairs to be used as labels for the launchConfig |
logConfig |
logConfig |
Optional |
- |
- |
|
lxcConf |
map[string] |
Optional |
- |
- |
|
memory |
int |
Optional |
- |
- |
|
memoryMb |
int |
Optional |
- |
- |
|
memorySwap |
int |
Optional |
- |
- |
|
networkContainerId |
container |
Optional |
- |
- |
|
networkIds |
array[network] |
Optional |
- |
- |
|
networkLaunchConfig |
string |
Optional |
- |
- |
|
networkMode |
enum |
Optional |
- |
managed |
The options are none , bridge , host , managed , container . |
pidMode |
enum |
Optional |
- |
- |
The options are host . |
ports |
array[string] |
Optional |
- |
- |
|
privileged |
boolean |
Optional |
- |
- |
|
publishAllPorts |
boolean |
Optional |
- |
- |
|
readOnly |
boolean |
Optional |
- |
- |
|
registryCredentialId |
registryCredential |
Optional |
- |
- |
|
requestedHostId |
host |
Optional |
- |
- |
|
requestedIpAddress |
string |
Optional |
- |
- |
|
securityOpt |
array[string] |
Optional |
- |
- |
|
startOnCreate |
boolean |
Optional |
- |
true |
|
stdinOpen |
boolean |
Optional |
- |
- |
|
tty |
boolean |
Optional |
- |
- |
|
user |
string |
Optional |
- |
- |
|
userdata |
string |
Optional |
- |
- |
|
vcpu |
int |
Optional |
- |
1 |
|
volumeDriver |
string |
Optional |
- |
- |
|
workingDir |
string |
Optional |
- |
- |
|
Read Only Fields
Field |
Type |
Notes |
accountId |
account |
The unique identifier for the associated account |
createIndex |
int |
|
created |
date |
The date of when the launchConfig was created. |
deploymentUnitUuid |
string |
|
externalId |
string |
|
firstRunning |
date |
|
healthState |
enum |
The options are healthy , unhealthy , updating-healthy , updating-unhealthy , initializing . |
hostId |
host |
The unique identifier for the associated host |
id |
int |
The unique identifier for the launchConfig |
nativeContainer |
boolean |
|
primaryIpAddress |
string |
|
removed |
date |
The date of when the launchConfig was removed |
startCount |
int |
|
state |
enum |
The current state of the launchConfig. The options are creating , error , erroring , migrating , purged , purging , removed , removing , requested , restarting , restoring , running , starting , stopped , stopping , updating-running , updating-stopped . |
systemContainer |
enum |
The options are NetworkAgent , LoadBalancerAgent . |
transitioning |
enum |
Whether or not the launchConfig is in a transitioning state |
transitioningMessage |
string |
The message to show while in a transitioning state |
transitioningProgress |
int |
The percentage remaining in the transitioning process of the launchConfig |
uuid |
string |
The universally unique identifier for the launchConfig. This will always be unique across Rancher installations. |
version |
string |
|