Protocol Documentation

Table of Contents

• deployment.proto
  • ApprovalRead
  • ApprovalsRead
  • ApproveStep
  • CreateDeployment
  • DeploymentCreated
  • DeploymentDestroyed
  • DeploymentRead
  • DeploymentReadSummary
  • DeploymentTemplated
  • DeploymentTokenRead
  • DeploymentUpdated
  • DeploymentsRead
  • DestroyDeployment
  • LinkRead
  • ReadApprovals
  • ReadDeployment
  • ReadDeploymentToken
  • ReadDeployments
  • ReadRun
  • ReadRuns
  • RunRead
  • RunReadSummary
  • RunsRead
  • StepApproved
  • StepLog
  • StepRead
  • TemplateDeployment

  • UpdateDeployment

  • LogLevel

  • Status

  • Deployment
• Scalar Value Types

Top

deployment.proto

Deployment is the service for creation and management of application installs/upgrades.

ApprovalRead

Field	Type	Label	Description
uuid	string
name	string
run_uuid	string
run_name	string
run_version	string
step_name	string

ApprovalsRead

Field	Type	Label	Description
approvals	ApprovalRead	repeated

ApproveStep

Field	Type	Label	Description
run_uuid	string
approve	bool
override	bool

CreateDeployment

Field	Type	Label	Description
name	string		the name of this deployment
repo_id	string		the unique id of the repo to get the deployment yaml from
branch	string		the branch from the repo to get the file from
file_path	string		the path to the deployment file

DeploymentCreated

DeploymentDestroyed

DeploymentRead

Field	Type	Label	Description
uuid	string		unique id of the deployment
name	string		the name of this deployment
repo_id	string		the unique id of the repo to get the deployment yaml from
repo_name	string		the name of the repo
branch	string		the branch from the repo to get the file from
file_path	string		the path to the deployment file

DeploymentReadSummary

Field	Type	Label	Description
uuid	string		unique id of the deployment
name	string		the name of this deployment

DeploymentTemplated

Field	Type	Label	Description
uuid	string		unique id of the deployment
yaml	string		the templated yaml for this deployment

DeploymentTokenRead

Field	Type	Label	Description
token	string		deployment token for web calls

DeploymentUpdated

DeploymentsRead

Field	Type	Label	Description
deployments	DeploymentReadSummary	repeated	the list of deployments

DestroyDeployment

Field	Type	Label	Description
uuid	string		unique id of the deployment

LinkRead

Field	Type	Label	Description
name	string
url	string

ReadApprovals

ReadDeployment

Field	Type	Label	Description
uuid	string		unique id of the deployment

ReadDeploymentToken

Field	Type	Label	Description
uuid	string		unique id of the deployment

ReadDeployments

ReadRun

Field	Type	Label	Description
deployment_uuid	string		unique id of the run

ReadRuns

Field	Type	Label	Description
deployment_uuid	string		unique id of the deployment to get runs for

RunRead

Field	Type	Label	Description
uuid	string
name	string
version	string
status	Status
start_time	int64
stop_time	int64
links	LinkRead	repeated
steps	StepRead	repeated

RunReadSummary

Field	Type	Label	Description
uuid	string
name	string
version	string
status	Status
start_time	int64
stop_time	int64

RunsRead

Field	Type	Label	Description
runs	RunReadSummary	repeated	the runs

StepApproved

StepLog

Field	Type	Label	Description
timestamp	int64
level	LogLevel
message	string

StepRead

Field	Type	Label	Description
name	string
status	Status
start_time	int64
stop_time	int64
logs	StepLog	repeated

TemplateDeployment

Field	Type	Label	Description
uuid	string		unique id of the deployment

UpdateDeployment

Field	Type	Label	Description
uuid	string		unique id of the deployment
name	string		the name of this deployment
repo_id	string		the unique id of the repo to get the deployment yaml from
branch	string		the branch from the repo to get the file from
file_path	string		the path to the deployment file

LogLevel

Name	Number	Description
DEBUG	0
INFO	1
WARN	2
ERROR	3

Status

Name	Number	Description
NOT_STARTED	0
IN_PROGRESS	1
AWAITING_APPROVAL	2
FAILED	3
SUCCEEDED	4
SKIPPED	5

Deployment

Method Name	Request Type	Response Type	Description
Create	CreateDeployment	DeploymentCreated	creates a new deployment
Update	UpdateDeployment	DeploymentUpdated	edits an already existing deployment
Destroy	DestroyDeployment	DeploymentDestroyed	removes a deployment from the list of configurations
Read	ReadDeployment	DeploymentRead	reads out a deployment
All	ReadDeployments	DeploymentsRead	gets all deployments currently configured and their status
Template	TemplateDeployment	DeploymentTemplated	get the templated version of this deployment
Token	ReadDeploymentToken	DeploymentTokenRead	gets the token for this deployment, for use with web calls
Run	ReadRun	RunRead	read all the information about a particular run
Runs	ReadRuns	RunsRead	read summaries of all runs for a particular deployment
Approve	ApproveStep	StepApproved	approve a step for a run
Approvals	ReadApprovals	ApprovalsRead	gets all approvals for the user

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)