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 |
- |
- |
|
| blkioWeight |
int |
Optional |
- |
- |
|
| build |
dockerBuild |
Optional |
- |
- |
|
| capAdd |
array[enum] |
Optional |
- |
- |
|
| capDrop |
array[enum] |
Optional |
- |
- |
|
| cgroupParent |
string |
Optional |
- |
- |
|
| command |
array[string] |
Optional |
- |
- |
|
| count |
int |
Optional |
- |
- |
|
| cpuCount |
int |
Optional |
- |
- |
|
| cpuPercent |
int |
Optional |
- |
- |
|
| cpuPeriod |
int |
Optional |
- |
- |
|
| cpuQuota |
int |
Optional |
- |
- |
|
| cpuSet |
string |
Optional |
- |
- |
|
| cpuSetMems |
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 |
- |
- |
|
| diskQuota |
int |
Optional |
- |
- |
|
| disks |
array[virtualMachineDisk] |
Optional |
- |
- |
|
| dns |
array[string] |
Optional |
- |
- |
|
| dnsOpt |
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 |
- |
- |
|
| groupAdd |
array[string] |
Optional |
- |
- |
|
| healthCheck |
instanceHealthCheck |
Optional |
- |
- |
|
| healthCmd |
array[string] |
Optional |
- |
- |
|
| healthInterval |
int |
Optional |
- |
- |
|
| healthRetries |
int |
Optional |
- |
- |
|
| healthTimeout |
int |
Optional |
- |
- |
|
| hostname |
string |
Optional |
- |
- |
|
| imageUuid |
string |
Optional |
- |
- |
|
| instanceLinks |
map[instance] |
Optional |
- |
- |
|
| instanceTriggeredStop |
enum |
Optional |
- |
stop |
The options are stop, remove. |
| ioMaximumBandwidth |
int |
Optional |
- |
- |
|
| ioMaximumIOps |
int |
Optional |
- |
- |
|
| ip |
string |
Optional |
- |
- |
|
| ip6 |
string |
Optional |
- |
- |
|
| ipcMode |
string |
Optional |
- |
- |
|
| isolation |
string |
Optional |
- |
- |
|
| kernelMemory |
int |
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 |
- |
- |
|
| memoryReservation |
int |
Optional |
- |
- |
|
| memorySwap |
int |
Optional |
- |
- |
|
| memorySwappiness |
int |
Optional |
- |
- |
|
| milliCpuReservation |
int |
Optional |
- |
- |
|
| netAlias |
array[string] |
Optional |
- |
- |
|
| networkContainerId |
container |
Optional |
- |
- |
|
| networkIds |
array[network] |
Optional |
- |
- |
|
| networkLaunchConfig |
string |
Optional |
- |
- |
|
| networkMode |
string |
Optional |
- |
managed |
|
| oomKillDisable |
boolean |
Optional |
- |
- |
|
| oomScoreAdj |
int |
Optional |
- |
- |
|
| pidMode |
enum |
Optional |
- |
- |
The options are host. |
| pidsLimit |
int |
Optional |
- |
- |
|
| ports |
array[string] |
Optional |
Yes |
- |
|
| privileged |
boolean |
Optional |
- |
- |
|
| publishAllPorts |
boolean |
Optional |
- |
- |
|
| readOnly |
boolean |
Optional |
- |
- |
|
| registryCredentialId |
registryCredential |
Optional |
- |
- |
|
| requestedHostId |
host |
Optional |
- |
- |
|
| requestedIpAddress |
string |
Optional |
- |
- |
|
| securityOpt |
array[string] |
Optional |
- |
- |
|
| shmSize |
int |
Optional |
- |
- |
|
| startOnCreate |
boolean |
Optional |
- |
true |
|
| stdinOpen |
boolean |
Optional |
- |
- |
|
| stopSignal |
string |
Optional |
- |
- |
|
| storageOpt |
map[string] |
Optional |
- |
- |
|
| sysctls |
map[string] |
Optional |
- |
- |
|
| tmpfs |
map[string] |
Optional |
- |
- |
|
| tty |
boolean |
Optional |
- |
- |
|
| ulimits |
array[ulimit] |
Optional |
- |
- |
|
| user |
string |
Optional |
- |
- |
|
| userdata |
string |
Optional |
- |
- |
|
| usernsMode |
string |
Optional |
- |
- |
|
| uts |
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 |
| mounts |
array[mountEntry] |
|
| nativeContainer |
boolean |
|
| primaryIpAddress |
string |
|
| primaryNetworkId |
network |
|
| removed |
date |
The date of when the launchConfig was removed |
| serviceIds |
array[service] |
|
| 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. |
| system |
boolean |
|
| 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 |
|