Deployments

Caution: This is a deprecated version of the Deployment Manager API. Please use the latest API version instead.

A deployment is a collection of resources that are deployed and managed together, using a configuration file.

For a list of methods for this resource, see the end of this page.

Resource representations



{
  "id": unsigned long,
  "insertTime": string,
  "updateTime": string,
  "name": string,
  "description": string,
  "fingerprint": bytes,
  "manifest": string,
  "update": {
    "errors": [
      string
    ],
    "manifest": string
  },
  "target": {
    "config": string,
    "imports": [
      {
        "name": string,
        "content": string
      }
    ]
  },
  "state": string,
  "intent": string
}
Property name Value Description Notes
description string An optional user-provided description of the deployment.
fingerprint bytes Specifies a fingerprint for update() requests. A fingerprint is a randomly generated value that must be provided in update() requests to perform optimistic locking. This ensures optimistic concurrency so that only one update can be performed at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
id unsigned long [Output Only] Unique identifier for the resource; defined by the server.
insertTime string [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
intent string [Input Only] Specifies how Deployment Manager should apply this template. Possible options are PREVIEW, UPDATE, and CANCEL.

PREVIEW creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview updates to deployments or preview new deployments. You must provide a target.config with a configuration for this intent. After previewing a deployment, you can deploy your resources by making a request with the UPDATE intent or you can CANCEL the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

UPDATE performs an update to the underlying resources in a deployment. If you provide a populated target.config field with this request, Deployment Manager uses that configuration to perform an update. If you had previewed this update beforehand, and do not supply a target.config or provide an empty target.config, Deployment Manager uses the last previewed configuration.

CANCEL cancels an update that is in PREVIEW or UPDATE but does not undo any changes already made.
manifest string [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
name string Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
state string [Output Only] The current state of the deployment. This can be DEPLOYED, DEPLOYMENT_FAILED, PREVIEWING, UPDATING, and CANCELING.
target nested object [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
target.config string The configuration to use for this deployment.
target.imports[] list Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
target.imports[].content string The contents of the file.
target.imports[].name string The name of the file.
update nested object [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
update.errors[] list [Output Only] List of all errors encountered while trying to enact the update.
update.manifest string [Output Only] URL of the manifest representing the update configuration of this deployment.
updateTime string [Output Only] Timestamp when the deployment was updated, in RFC3339 text format .

Methods

delete
Deletes a deployment and all of the resources in the deployment.
get
Gets information about a specific deployment.
insert
Creates a deployment and all of the resources described by the deployment manifest.
list
Lists all deployments for a given project.
patch
Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
update
Updates a deployment and all of the resources described by the deployment manifest.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Deployment Manager Documentation