Rancher adopts the standard Docker Compose terminology for services and defines a basic service as one or more containers created from the same Docker image. Once a service (consumer) is linked to another service (producer) within the same stack, a DNS record mapped to each container instance is automatically created and discoverable by containers from the “consuming” service. Other benefits of creating a service under Rancher include”
Field | Type | Create | Update | Default | Notes |
---|---|---|---|---|---|
assignServiceIpAddress | boolean | Optional | - | - | |
description | string | Optional | Yes | - | |
environmentId | environment | Yes | - | - | |
externalId | string | Optional | - | - | |
launchConfig | launchConfig | Optional | - | - | |
metadata | map[json] | Optional | Yes | - | |
name | string | Yes | Yes | - | |
retainIp | boolean | Optional | Yes | - | |
scale | int | Optional | Yes | 1 | |
scalePolicy | scalePolicy | Optional | Yes | - | |
secondaryLaunchConfigs | array[secondaryLaunchConfig] | Optional | - | - | |
selectorContainer | string | Optional | Yes | - | |
selectorLink | string | Optional | Yes | - | |
startOnCreate | boolean | Optional | - | - | |
vip | string | Optional | - | - |
Field | Type | Notes |
---|---|---|
createIndex | int | |
currentScale | int | |
fqdn | string | |
healthState | string | |
id | int | The unique identifier for the service |
publicEndpoints | array[publicEndpoint] | |
upgrade | serviceUpgrade |
Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.
CreatePOST: /v1/projects/${PROJECT_ID}/services
DeleteDELETE: /v1/projects/${PROJECT_ID}/services/${ID}
UpdatePUT: /v1/projects/${PROJECT_ID}/services/${ID}
activate
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=activate
addservicelink
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=addservicelink
Input: AddRemoveServiceLinkInput
Field | Type | Required | Default | Notes |
---|---|---|---|---|
serviceLink | serviceLink | Yes |
Output: An updated copy of the service resource
cancelrollback
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=cancelrollback
cancelupgrade
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=cancelupgrade
deactivate
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=deactivate
finishupgrade
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=finishupgrade
removeservicelink
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=removeservicelink
Input: AddRemoveServiceLinkInput
Field | Type | Required | Default | Notes |
---|---|---|---|---|
serviceLink | serviceLink | Yes |
Output: An updated copy of the service resource
restart
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=restart
Input: ServiceRestart
Field | Type | Required | Default | Notes |
---|---|---|---|---|
rollingRestartStrategy | rollingRestartStrategy | Yes |
Output: An updated copy of the service resource
rollback
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=rollback
setservicelinks
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=setservicelinks
Input: SetServiceLinksInput
Field | Type | Required | Default | Notes |
---|---|---|---|---|
serviceLinks | array[serviceLink] | No |
Output: An updated copy of the service resource
upgrade
POST: /v1/projects/${PROJECT_ID}/services/${ID}?action=upgrade
Input: ServiceUpgrade
Field | Type | Required | Default | Notes |
---|---|---|---|---|
inServiceStrategy | inServiceUpgradeStrategy | No | ||
toServiceStrategy | toServiceUpgradeStrategy | No |
Output: An updated copy of the service resource