platform-api

api.v1.activity.Service

Method Name	Request Type	Response Type	Description
/api.v1.activity.Service/GetActivities	GetActivitiesRequest	GetActivitiesResponse	Get Activities

api.v1.authentication.Service

Method Name	Request Type	Response Type	Description
/api.v1.authentication.Service/Login	LoginRequest	LoginResponse	Login authenticats a user and returns a access/refresh token
/api.v1.authentication.Service/Logout	LogoutRequest	LogoutResponse	Logout validates the access token and blocks it afterwards
/api.v1.authentication.Service/Get	GetRequest	GetResponse	Get the logged in user
/api.v1.authentication.Service/Register	RegisterRequest	RegisterResponse	Register creates a new user
/api.v1.authentication.Service/SendPasswordReset	SendPasswordResetRequest	SendPasswordResetResponse	Send reset password email to the user
/api.v1.authentication.Service/ResetPassword	ResetPasswordRequest	ResetPasswordResponse	Reset password of the user
/api.v1.authentication.Service/Delete	DeleteRequest	DeleteResponse	Delete logged in user
/api.v1.authentication.Service/RefreshToken	RefreshTokenRequest	RefreshTokenResponse	Refresh logged in token pair
/api.v1.authentication.Service/GetAuthConfig	GetAuthConfigRequest	GetAuthConfigResponse	Get auth config for how available login methods
/api.v1.authentication.Service/VerifyEmail	VerifyEmailRequest	VerifyEmailResponse	Verify email
/api.v1.authentication.Service/VerifyPhoneNumber	VerifyPhoneNumberRequest	VerifyPhoneNumberResponse	Verify phone number
/api.v1.authentication.Service/SendVerificationEmail	SendVerificationEmailRequest	SendVerificationEmailResponse

api.v1.capsule.Service

Method Name	Request Type	Response Type	Description
/api.v1.capsule.Service/Create	CreateRequest	CreateResponse	Create a new capsule.
/api.v1.capsule.Service/Get	GetRequest	GetResponse	Get a capsule by id.
/api.v1.capsule.Service/Delete	DeleteRequest	DeleteResponse	Delete a capsule.
/api.v1.capsule.Service/Logs	LogsRequest	LogsResponse stream	Logs returns (and streams) the log output of a capsule.
/api.v1.capsule.Service/Update	UpdateRequest	UpdateResponse	Update a capsule.
/api.v1.capsule.Service/List	ListRequest	ListResponse	Lists all capsules for current project.
/api.v1.capsule.Service/Deploy	DeployRequest	DeployResponse	Deploy changes to a capsule. When deploying, a new rollout will be initiated. Only one rollout can be running at a single point in time. Use Abort to abort an already running rollout.
/api.v1.capsule.Service/DeploySet	DeploySetRequest	DeploySetResponse
/api.v1.capsule.Service/ProposeRollout	ProposeRolloutRequest	ProposeRolloutResponse
/api.v1.capsule.Service/ProposeSetRollout	ProposeSetRolloutRequest	ProposeSetRolloutResponse
/api.v1.capsule.Service/ListProposals	ListProposalsRequest	ListProposalsResponse
/api.v1.capsule.Service/ListSetProposals	ListSetProposalsRequest	ListSetProposalsResponse
/api.v1.capsule.Service/GetProposalsEnabled	GetProposalsEnabledRequest	GetProposalsEnabledResponse
/api.v1.capsule.Service/ListInstances	ListInstancesRequest	ListInstancesResponse	Lists all instances for the capsule.
/api.v1.capsule.Service/RestartInstance	RestartInstanceRequest	RestartInstanceResponse	Restart a single capsule instance.
/api.v1.capsule.Service/GetRollout	GetRolloutRequest	GetRolloutResponse	Get a single rollout by ID.
/api.v1.capsule.Service/ListRollouts	ListRolloutsRequest	ListRolloutsResponse	Lists all rollouts for the capsule.
/api.v1.capsule.Service/WatchRollouts	WatchRolloutsRequest	WatchRolloutsResponse stream	Stream rollouts for a capsule.
/api.v1.capsule.Service/AbortRollout	AbortRolloutRequest	AbortRolloutResponse	Abort the rollout.
/api.v1.capsule.Service/StopRollout	StopRolloutRequest	StopRolloutResponse	Stop a Rollout, removing all resources associated with it.
/api.v1.capsule.Service/ListEvents	ListEventsRequest	ListEventsResponse	List capsule events.
/api.v1.capsule.Service/CapsuleMetrics	CapsuleMetricsRequest	CapsuleMetricsResponse	Get metrics for a capsule
/api.v1.capsule.Service/GetInstanceStatus	GetInstanceStatusRequest	GetInstanceStatusResponse	GetInstanceStatus returns the current status for the given instance.
/api.v1.capsule.Service/ListInstanceStatuses	ListInstanceStatusesRequest	ListInstanceStatusesResponse	ListInstanceStatuses lists the status of all instances.
/api.v1.capsule.Service/WatchInstanceStatuses	WatchInstanceStatusesRequest	WatchInstanceStatusesResponse stream	Stream Instance Statuses of a capsule.
/api.v1.capsule.Service/Execute	ExecuteRequest stream	ExecuteResponse stream	Execute executes a command in a given in instance, and returns the output along with an exit code.
/api.v1.capsule.Service/PortForward	PortForwardRequest stream	PortForwardResponse stream	PortForward establishes a port-forwarding for the port to the given instance.
/api.v1.capsule.Service/GetCustomInstanceMetrics	GetCustomInstanceMetricsRequest	GetCustomInstanceMetricsResponse
/api.v1.capsule.Service/GetJobExecutions	GetJobExecutionsRequest	GetJobExecutionsResponse	Get list of job executions performed by the Capsule.
/api.v1.capsule.Service/GetStatus	GetStatusRequest	GetStatusResponse
/api.v1.capsule.Service/GetRevision	GetRevisionRequest	GetRevisionResponse
/api.v1.capsule.Service/GetRolloutOfRevisions	GetRolloutOfRevisionsRequest	GetRolloutOfRevisionsResponse
/api.v1.capsule.Service/WatchStatus	WatchStatusRequest	WatchStatusResponse stream	Stream the status of a capsule.
/api.v1.capsule.Service/GetEffectiveGitSettings	GetEffectiveGitSettingsRequest	GetEffectiveGitSettingsResponse
/api.v1.capsule.Service/StartPipeline	StartPipelineRequest	StartPipelineResponse	Will initiate the pipeline, from the initial environment and it's current rollout.
/api.v1.capsule.Service/GetPipelineStatus	GetPipelineStatusRequest	GetPipelineStatusResponse
/api.v1.capsule.Service/PromotePipeline	PromotePipelineRequest	PromotePipelineResponse	Progress the pipeline to the next environment.
/api.v1.capsule.Service/AbortPipeline	AbortPipelineRequest	AbortPipelineResponse	Abort the pipeline execution. This will stop the pipeline from any further promotions.
/api.v1.capsule.Service/ListPipelineStatuses	ListPipelineStatusesRequest	ListPipelineStatusesResponse

api.v1.cluster.Service

Method Name	Request Type	Response Type	Description
/api.v1.cluster.Service/List	ListRequest	ListResponse
/api.v1.cluster.Service/GetConfig	GetConfigRequest	GetConfigResponse	GetConfig returns the config for the cluster.
/api.v1.cluster.Service/GetConfigs	GetConfigsRequest	GetConfigsResponse	GetConfigs returns the configs for all clusters.
/api.v1.cluster.Service/ListNodes	ListNodesRequest	ListNodesResponse
/api.v1.cluster.Service/ListNodePods	ListNodePodsRequest	ListNodePodsResponse

api.v1.environment.Service

Method Name	Request Type	Response Type	Description
/api.v1.environment.Service/Create	CreateRequest	CreateResponse
/api.v1.environment.Service/Update	UpdateRequest	UpdateResponse
/api.v1.environment.Service/Delete	DeleteRequest	DeleteResponse
/api.v1.environment.Service/List	ListRequest	ListResponse	List available environments.
/api.v1.environment.Service/GetNamespaces	GetNamespacesRequest	GetNamespacesResponse
/api.v1.environment.Service/Get	GetRequest	GetResponse

api.v1.group.Service

Method Name	Request Type	Response Type	Description
/api.v1.group.Service/Create	CreateRequest	CreateResponse	Create a new group.
/api.v1.group.Service/Delete	DeleteRequest	DeleteResponse	Delete a group.
/api.v1.group.Service/List	ListRequest	ListResponse	List groups.
/api.v1.group.Service/Update	UpdateRequest	UpdateResponse	Update group.
/api.v1.group.Service/Get	GetRequest	GetResponse	Get group.
/api.v1.group.Service/AddMember	AddMemberRequest	AddMemberResponse	Add a member to a group.
/api.v1.group.Service/RemoveMember	RemoveMemberRequest	RemoveMemberResponse	Remove member from group.
/api.v1.group.Service/ListMembers	ListMembersRequest	ListMembersResponse	Get Group Members.
/api.v1.group.Service/ListGroupsForMember	ListGroupsForMemberRequest	ListGroupsForMemberResponse	Get Groups.

api.v1.image.Service

Method Name	Request Type	Response Type	Description
/api.v1.image.Service/GetImageInfo	GetImageInfoRequest	GetImageInfoResponse	Get Information about an image in a image.
/api.v1.image.Service/GetRepositoryInfo	GetRepositoryInfoRequest	GetRepositoryInfoResponse	Get Information about a docker registry repository.
/api.v1.image.Service/Get	GetRequest	GetResponse	Get a image.
/api.v1.image.Service/Add	AddRequest	AddResponse	Add a new image. Images are immutable and cannot change. Add a new image to make changes from an existing one.
/api.v1.image.Service/List	ListRequest	ListResponse	List images for a capsule.
/api.v1.image.Service/Delete	DeleteRequest	DeleteResponse	Delete a image.

api.v1.issue.Service

Method Name	Request Type	Response Type	Description
/api.v1.issue.Service/GetIssues	GetIssuesRequest	GetIssuesResponse	Get issues

api.v1.metrics.Service

Method Name	Request Type	Response Type	Description
/api.v1.metrics.Service/GetMetrics	GetMetricsRequest	GetMetricsResponse	Retrieve metrics. metric_type is mandatory, while the rest of the fields in the tags are optional. If project, env or capsule is not specified, they will be treated as wildcards.
/api.v1.metrics.Service/GetMetricsMany	GetMetricsManyRequest	GetMetricsManyResponse	Retrive metrics for multiple sets of tags at a time. Metrics within the same set of tags will be in ascending order of timestamp.
/api.v1.metrics.Service/GetMetricsExpression	GetMetricsExpressionRequest	GetMetricsExpressionResponse

api.v1.project.Service

Method Name	Request Type	Response Type	Description
/api.v1.project.Service/Create	CreateRequest	CreateResponse	Create project.
/api.v1.project.Service/Delete	DeleteRequest	DeleteResponse	Delete project.
/api.v1.project.Service/Get	GetRequest	GetResponse	Get project.
/api.v1.project.Service/List	ListRequest	ListResponse	Get project list.
/api.v1.project.Service/Update	UpdateRequest	UpdateResponse	Update updates the profile of the project.
/api.v1.project.Service/PublicKey	PublicKeyRequest	PublicKeyResponse	Get public key.
/api.v1.project.Service/GetObjectsByKind	GetObjectsByKindRequest	GetObjectsByKindResponse	Returns all objects of a given kind.
/api.v1.project.Service/GetCustomObjectMetrics	GetCustomObjectMetricsRequest	GetCustomObjectMetricsResponse	Returns all metrics of a given custom object.
/api.v1.project.Service/GetEffectiveGitSettings	GetEffectiveGitSettingsRequest	GetEffectiveGitSettingsResponse
/api.v1.project.Service/GetEffectivePipelineSettings	GetEffectivePipelineSettingsRequest	GetEffectivePipelineSettingsResponse
/api.v1.project.Service/GetEffectiveNotificationSettings	GetEffectiveNotificationSettingsRequest	GetEffectiveNotificationSettingsResponse

api.v1.project.settings.Service

Method Name	Request Type	Response Type	Description
/api.v1.project.settings.Service/GetSettings	GetSettingsRequest	GetSettingsResponse	Gets the users settings for the current project.
/api.v1.project.settings.Service/UpdateSettings	UpdateSettingsRequest	UpdateSettingsResponse	Sets the users settings for the current project.
/api.v1.project.settings.Service/GetLicenseInfo	GetLicenseInfoRequest	GetLicenseInfoResponse	Get License Information.

api.v1.role.Service

Method Name	Request Type	Response Type	Description
/api.v1.role.Service/Create	CreateRequest	CreateResponse	Create a new role.
/api.v1.role.Service/Delete	DeleteRequest	DeleteResponse	Delete role.
/api.v1.role.Service/List	ListRequest	ListResponse	List roles.
/api.v1.role.Service/Update	UpdateRequest	UpdateResponse	Update role
/api.v1.role.Service/Get	GetRequest	GetResponse	Get role.
/api.v1.role.Service/Assign	AssignRequest	AssignResponse	Assign a role.
/api.v1.role.Service/Revoke	RevokeRequest	RevokeResponse	Revoke a role.
/api.v1.role.Service/ListForEntity	ListForEntityRequest	ListForEntityResponse	List roles for an entity.
/api.v1.role.Service/ListAssignees	ListAssigneesRequest	ListAssigneesResponse	List Assignees.

api.v1.service_account.Service

Method Name	Request Type	Response Type	Description
/api.v1.service_account.Service/Create	CreateRequest	CreateResponse	Create a new Service Account. The returned client_id and client_secret can be used as login credentials. Note that the client_secret can only be read out once, at creation.
/api.v1.service_account.Service/List	ListRequest	ListResponse	List all service accounts.
/api.v1.service_account.Service/Delete	DeleteRequest	DeleteResponse	Delete a service account. It can take up to the TTL of access tokens for existing sessions using this service_account, to expire.

api.v1.settings.Service

Method Name	Request Type	Response Type	Description
/api.v1.settings.Service/GetConfiguration	GetConfigurationRequest	GetConfigurationResponse
/api.v1.settings.Service/GetSettings	GetSettingsRequest	GetSettingsResponse
/api.v1.settings.Service/UpdateSettings	UpdateSettingsRequest	UpdateSettingsResponse
/api.v1.settings.Service/GetLicenseInfo	GetLicenseInfoRequest	GetLicenseInfoResponse
/api.v1.settings.Service/GetGitStoreStatus	GetGitStoreStatusRequest	GetGitStoreStatusResponse

api.v1.tunnel.Service

Method Name	Request Type	Response Type	Description
/api.v1.tunnel.Service/Tunnel	TunnelRequest stream	TunnelResponse stream

api.v1.user.Service

Method Name	Request Type	Response Type	Description
/api.v1.user.Service/Create	CreateRequest	CreateResponse	Create a new user.
/api.v1.user.Service/Update	UpdateRequest	UpdateResponse	Update a users profile and info.
/api.v1.user.Service/ListSessions	ListSessionsRequest	ListSessionsResponse	Get the list of active sessions for the given user.
/api.v1.user.Service/Get	GetRequest	GetResponse	Get a user by user-id.
/api.v1.user.Service/GetByIdentifier	GetByIdentifierRequest	GetByIdentifierResponse	Lookup a user by a unique identifier - email, username, phone number etc.
/api.v1.user.Service/List	ListRequest	ListResponse	List users.
/api.v1.user.Service/Delete	DeleteRequest	DeleteResponse	Delete a specific user.

api.v1.user.settings.Service

Method Name	Request Type	Response Type	Description
/api.v1.user.settings.Service/GetSettings	GetSettingsRequest	GetSettingsResponse	Gets the users settings for the current project.
/api.v1.user.settings.Service/UpdateSettings	UpdateSettingsRequest	UpdateSettingsResponse	Sets the users settings for the current project.

api/v1/capsule/rollout/status.proto

ConfigureCapsuleStep

A step configuring a capsule.

Field	Type	Label	Description
info	StepInfo		Step information.
state	ConfigureResult		The state of the step.

ConfigureCommitStep

A step committing the changes to git

Field	Type	Label	Description
info	StepInfo		Step information
commit_hash	string		The hash of the commit containing the changes
commit_url	string		The url to the commit (if known. May be empty)

ConfigureEnvStep

A step configuring an environment.

Field	Type	Label	Description
info	StepInfo		Step information.
state	ConfigureResult		The result of the environment configuration.
is_secret	bool		Whether the environment is a secret.

ConfigureFileStep

A step configuring a file.

Field	Type	Label	Description
info	StepInfo		Step information.
state	ConfigureResult		The result of the file configuration.
path	string		The path of the file.
is_secret	bool		Whether the file is a secret.

ConfigureStage

The configure stage.

Field	Type	Label	Description
info	StageInfo		Stage information.
steps	ConfigureStep	repeated	The steps of the stage.

ConfigureStep

A step of the configure stage.

Field	Type	Label	Description
generic	GenericStep		A generic step.
configure_capsule	ConfigureCapsuleStep		A step configuring a capsule.
configure_file	ConfigureFileStep		A step configuring a file.
configure_env	ConfigureEnvStep		A step configuring an environment.
commit	ConfigureCommitStep		A step for commiting the changes to git.

CreateResourceStep

A step creating a resource.

Field	Type	Label	Description
info	StepInfo		Step information.
kind	string		The kind of the resource.
name	string		The name of the resource.

GenericStep

A generic step of a stage.

Field	Type	Label	Description
info	StepInfo		Step information.

InstancesStep

Information on the instances of the rollout.

Field	Type	Label	Description
info	StepInfo		Step information.
num_updated	uint32		The number of updated instances.
num_ready	uint32		The number of ready instances.
num_stuck	uint32		The number of stuck instances.
num_wrong_version	uint32		The number of instances with the wrong version.

ResourceCreationStage

The resource creation stage.

Field	Type	Label	Description
info	StageInfo		Stage information.
steps	ResourceCreationStep	repeated	The steps of the stage.

ResourceCreationStep

A step of the resource creation stage.

Field	Type	Label	Description
generic	GenericStep		A generic step.
create_resource	CreateResourceStep		A step creating a resource.

RunningStage

The running stage.

Field	Type	Label	Description
info	StageInfo		Stage information.
steps	RunningStep	repeated	The steps of the stage.

RunningStep

A step of the running stage.

Field	Type	Label	Description
generic	GenericStep		A generic step.
instances	InstancesStep		A step containing information on the instances of the rollout.

StageInfo

Information about a stage of a rollout.

Field	Type	Label	Description
name	string		Name of the stage.
updated_at	google.protobuf.Timestamp		The last time the stage was updated.
state	StageState		The current state of the stage.
started_at	google.protobuf.Timestamp		The time the stage started.

Stages

The three stages of a rollout

Field	Type	Label	Description
configure	ConfigureStage		The configure stage.
resource_creation	ResourceCreationStage		The resource creation stage.
running	RunningStage		The running stage.

Status

Status is a representation of the current state of a rollout.

Field	Type	Label	Description
rollout_id	uint64		The ID of the rollout.
state	State		The current state of the rollout.
stages	Stages		The stages of the rollout.
updated_at	google.protobuf.Timestamp		The last time the rollout was updated.
result	Result		The result of the rollout.

StepInfo

Information about a step of a stage.

Field	Type	Label	Description
name	string		Name of the step.
message	string		Messages in the step.
updated_at	google.protobuf.Timestamp		The last time the step was updated.
state	StepState		The current state of the step.
started_at	google.protobuf.Timestamp		The time the step started.

ConfigureResult

The result of a configuration step.

Name	Number	Description
CONFIGURE_RESULT_UNSPECIFIED	0	The result is unspecified.
CONFIGURE_RESULT_CREATED	1	The resource is to be created.
CONFIGURE_RESULT_UPDATED	2	The resource is to be updated.
CONFIGURE_RESULT_NO_CHANGE	3	The resource has no change.
CONFIGURE_RESULT_DELETED	4	The resource is to be deleted.

Result

Different result of a rollout.

Name	Number	Description
RESULT_UNSPECIFIED	0	The result is unspecified.
RESULT_REPLACED	1	The rollout has been replaced.
RESULT_FAILED	2	The rollout has failed.
RESULT_ABORTED	3	The rollout has been aborted.
RESULT_ROLLBACK	4	The rollout has been rolled back.

StageState

Different states a stage can be in.

Name	Number	Description
STAGE_STATE_UNSPECIFIED	0	The state is unspecified.
STAGE_STATE_DEPLOYING	1	The stage is deploying.
STAGE_STATE_RUNNING	2	The stage is running.
STAGE_STATE_STOPPED	3	The stage is stopped.

State

Different states a rollout can be in.

Name	Number	Description
STATE_UNSPECIFIED	0	The state is unspecified.
STATE_PREPARING	1	The rollout is preparing.
STATE_CONFIGURE	2	The rollout is configuring.
STATE_RESOURCE_CREATION	3	The rollout is creating resources.
STATE_RUNNING	4	The rollout is running.
STATE_STOPPED	5	The rollout is stopped.

StepState

Different states a step can be in.

Name	Number	Description
STEP_STATE_UNSPECIFIED	0	The state is unspecified.
STEP_STATE_ONGOING	1	The step is ongoing.
STEP_STATE_FAILED	2	The step failed.
STEP_STATE_DONE	3	The step is done.

api/v1/activity/activity.proto

Activity

Field	Type	Label	Description
timestamp	google.protobuf.Timestamp
scope	Scope
message	Message

Message

Field	Type	Label	Description
rollout	Message.Rollout
project	Message.Project
environment	Message.Environment
capsule	Message.Capsule
user	Message.User

Message.Capsule

Field	Type	Label	Description
capsule_id	string
deleted	bool

Message.Environment

Field	Type	Label	Description
environment_id	string
deleted	bool

Message.Project

Field	Type	Label	Description
project_id	string
deleted	bool

Message.Rollout

Field	Type	Label	Description
rollout_id	uint64
state	api.v1.capsule.rollout.StepState

Message.User

Field	Type	Label	Description
printable_name	string
deleted	bool

Scope

Field	Type	Label	Description
project	string
environment	string
capsule	string
user	string

model/common.proto

BcryptHashingConfig

Bcrypt hashing configuration.

Field	Type	Label	Description
cost	int32		The cost of the hashing algorithm.

BcryptHashingInstance

Bcrypt hashing instance.

HashingConfig

Hashing configuration.

Field	Type	Label	Description
bcrypt	BcryptHashingConfig		if bcrypt is set, use bcrypt.
scrypt	ScryptHashingConfig		if scrypt is set, use scrypt.

HashingInstance

Hashing instance.

Field	Type	Label	Description
config	HashingConfig		The hashing configuration.
hash	bytes		A hash
bcrypt	BcryptHashingInstance		if bcrypt is set, this bcrypt instance was used.
scrypt	ScryptHashingInstance		if scrypt is set, this scrypt instance was used.

Pagination

Pagination option.

Field	Type	Label	Description
offset	uint32		Where to start the pagination.
limit	uint32		How many items to return.
descending	bool		Whether to sort in descending order.

ScryptHashingConfig

Scrypt hashing configuration.

Field	Type	Label	Description
signer_key	string		The key used to sign the salt.
salt_separator	string		The salt separator.
rounds	int32		The number of rounds in the algorithm.
mem_cost	int32		The memory cost of the algorithm.
p	int32		The parallelization factor of the algorithm.
key_len	int32		The length of the key.

ScryptHashingInstance

Scrypt hashing instance.

Field	Type	Label	Description
salt	bytes		The salt used to hash the password.

api/v1/activity/service.proto

ActivityFilter

Field	Type	Label	Description
project_filter	string
environment_filter	string
capsule_filter	string
user_identifier_filter	string

GetActivitiesRequest

Field	Type	Label	Description
from	google.protobuf.Timestamp
to	google.protobuf.Timestamp
pagination	model.Pagination
filter	ActivityFilter

GetActivitiesResponse

Field	Type	Label	Description
activities	Activity	repeated
total	uint64

model/auth.proto

AuthMethod

Message that tells how the user was authenticated.

Field	Type	Label	Description
login_type	LoginType

LoginType

The LoginType enum defines the type of login.

Name	Number	Description
LOGIN_TYPE_UNSPECIFIED	0	Default value.
LOGIN_TYPE_EMAIL_PASSWORD	1	Email and password login.
LOGIN_TYPE_PHONE_PASSWORD	2	deprecated: text is not supported - Phone number and password login.
LOGIN_TYPE_USERNAME_PASSWORD	3	Username and password login.
LOGIN_TYPE_SSO	4	SSO Login

model/author.proto

Author

Author of a change.

Field	Type	Label	Description
identifier	string		Cached identifier of the author, e.g. email or username at the time of change.
printable_name	string		Cached pretty-printed name of the author at the time of change.
user_id	string		if a user did the change
service_account_id	string		if a service account did the change

model/user.proto

MemberEntry

Entry model of a group member - placed in models to prevent cyclic imports.

Field	Type	Label	Description
user	UserEntry		if the member is a user.
service_account	ServiceAccountEntry		if the member is a service account.
joined_at	google.protobuf.Timestamp		when the member joined the group.

RegisterInfo

Registering information of a user.

Field	Type	Label	Description
creater_id	string		Who created the user.
method	RegisterMethod		How the user was registered.

RegisterMethod

Method used to register a user.

Field	Type	Label	Description
system	RegisterMethod.System		system created the user.
signup	RegisterMethod.Signup		user signed up.

RegisterMethod.Signup

if the user was created by signing up.

Field	Type	Label	Description
login_type	LoginType		The login type used to sign up.

RegisterMethod.System

if the user was created by the system.

ServiceAccountEntry

Entry model of a service account - placed in models to prevent cyclic imports.

Field	Type	Label	Description
service_account_id	string		unique id of the service account.
name	string		name of the service account.
client_id	string		client id of the service account.
group_ids	string	repeated	groups the service account belongs to.
created_at	google.protobuf.Timestamp		when the service account was created.
created_by	Author		who created the service account.

UserEntry

Entry model of a user - placed in models to prevent cyclic imports.

Field	Type	Label	Description
user_id	string		unique id of the user.
printable_name	string		pretty printable name of a user.
register_info	RegisterInfo		how the user was registered.
verified	bool		whether the user is verified.
group_ids	string	repeated	groups the user belongs to.
created_at	google.protobuf.Timestamp		when the user was created.

UserIdentifier

different fields that can identify a user.

Field	Type	Label	Description
username	string		username is unique.
email	string		email is unique.
phone_number	string		Deprecated: text is not supported - phone number is unique.

UserInfo

Userinfo - placed in models to prevent cyclic imports.

Field	Type	Label	Description
email	string		email of the user.
username	string		username of the user.
phone_number	string		Deprecated: text is not supported - phone number of the user.
created_at	google.protobuf.Timestamp		when the user was created.
group_ids	string	repeated	groups the user belongs to.

api/v1/authentication/user.proto

ClientCredentials

Field	Type	Label	Description
client_id	string		ID of the service account
client_secret	string		secret of the service account

Token

Field	Type	Label	Description
access_token	string		Access token
refresh_token	string		Refresh token

UserPassword

Field	Type	Label	Description
identifier	model.UserIdentifier		Identifier of user. This can be username, email etc.
password	string		Password of the user

api/v1/authentication/service.proto

DeleteRequest

Request to delete the logged in user. The user ID etc. is taken from the token.

DeleteResponse

Empty response to the delete request.

GetAuthConfigRequest

Empty Request to get the auth config containing the available login mechanisms and if self-registering is enabled.

GetAuthConfigResponse

Response with the auth config containing the available login mechanisms and if self-registering is enabled.

Field	Type	Label	Description
name	string		The name of the project
logo_url	string		The logo of the project
validate_password	bool		If to validate password
login_types	model.LoginType	repeated	Array of supported login methods.
allows_register	bool		True if new users can sign up.
sso_options	SSOOption	repeated	SSO login options

GetRequest

Get request to get the logged in user. The user ID etc. is taken from the token.

GetResponse

Response with user information to the get request.

Field	Type	Label	Description
user_info	model.UserInfo		Information about the user.
user_id	string		ID of the user

LoginRequest

Login request with either user identifier & email or client credentials.

Field	Type	Label	Description
user_password	UserPassword		User identifier & password.
client_credentials	ClientCredentials		Client credentials from service account.

LoginResponse

Login response with tokens and user information.

Field	Type	Label	Description
token	Token		The access token and refresh token.
user_id	string		ID of the user.
user_info	model.UserInfo		User information.

LogoutRequest

Empty logout request. The user ID etc. is taken from the token.

LogoutResponse

Empty response to the logout request.

RefreshTokenRequest

Request to refresh the access and refresh token of the logged in user.

Field	Type	Label	Description
refresh_token	string		The access token of the user Refresh token matching the access token.

RefreshTokenResponse

Response with new access and refresh token.

Field	Type	Label	Description
token	Token		New refresh and access tokens

RegisterRequest

Register request for users to self-register. This is only possible with the register bool set in users settings.

Field	Type	Label	Description
user_password	UserPassword		User identifier & password for the new user.

RegisterResponse

Register response with tokens and user information.

Field	Type	Label	Description
token	Token		Access and refresh token for the new logged in user.
user_id	string		User ID of the new user.
user_info	model.UserInfo		Information about the new user.

ResetPasswordRequest

Request to reset the password of a user with a verification code sent to the email.

Field	Type	Label	Description
code	string		The 6 digit verification code
new_password	string		The new password
identifier	model.UserIdentifier		Identifier of the user
token	string		JWT token to reset the password.

ResetPasswordResponse

Empty response to the reset password request

SSOID

Represents an SSO provided ID of a user

Field	Type	Label	Description
type	SSOType		What type of SSO this ID is from
provider_id	string		The ID of the SSO provider
sso_id	string		The ID provided by SSO
user_id	string		The internal user ID

SSOOption

A login option for using SSO. This might be merged into GetAuthConfigResponse.login_types, but is introduced as a separate field, to maintain backwards compatibility.

Field	Type	Label	Description
type	SSOType		Type of SSO. Currently only OIDC is supported.
provider_id	string		ID of the SSO provider as given in the platform configuration.
name	string		Name of SSO provider. This is an optional human readable version of the provider ID.
icon	string		URL of the underlying issuer. This can be used in the frontend for showing specific items for certain known issuers.

SendPasswordResetRequest

Request to send a reset password email to the user. This is only possible if an email provider is configured, and the user has an email.

Field	Type	Label	Description
identifier	model.UserIdentifier		User identifier of the user.

SendPasswordResetResponse

Empty response to the send password reset request

Field	Type	Label	Description
token	string		JWT token to reset the password.

SendVerificationEmailRequest

Request to send an email containing the code for the email verification flow. This is an upsert, and will invalidate the current verification-code if it exists. Only possible if an email-provider is configured, and the user has en email.

Field	Type	Label	Description
identifier	model.UserIdentifier		User identifier of the user.

SendVerificationEmailResponse

Empty response for sending a verification email

Field	Type	Label	Description
token	string		JWT token to verify the email.

VerifyEmailRequest

Request to verify the email of a user with a verification code sent to the email.

Field	Type	Label	Description
code	string		The verification code.
email	string		The email of the user.
token	string		JWT token to verify the email.

VerifyEmailResponse

Empty response to the Verify Email Request.

VerifyPhoneNumberRequest

Request to verify the phone number of a user with a verification code sent to the phone number.

Field	Type	Label	Description
code	string
phone_number	string

VerifyPhoneNumberResponse

Empty response to the Verify Phone Number Request.

SSOType

The type of SSO. Currently only OIDC is supported.

Name	Number	Description
SSO_TYPE_UNSPECIFIED	0
SSO_TYPE_OIDC	1

model/environment.proto

EnvironmentFilter

Field	Type	Label	Description
all	EnvironmentFilter.All
selected	EnvironmentFilter.Selected

EnvironmentFilter.All

Field	Type	Label	Description
include_ephemeral	bool

EnvironmentFilter.Selected

Field	Type	Label	Description
environment_ids	string	repeated

model/git.proto

BitBucketInfo

Field	Type	Label	Description
team	string
project	string
repository	string

Commit

Field	Type	Label	Description
provider	GitProvider
github	GitHubInfo
gitlab	GitLabInfo
bitbucket	BitBucketInfo
commit_id	string
commit_url	string
repository_url	string

GitChange

Field	Type	Label	Description
commit	Commit
paths	string	repeated

GitHubInfo

Field	Type	Label	Description
owner	string
repository	string

GitLabInfo

Field	Type	Label	Description
groups	string	repeated
project	string

GitStatus

Field	Type	Label	Description
last_processed_commit_id	string
last_processed_commit_time	google.protobuf.Timestamp
last_successful_commit_id	string
last_successful_commit_time	google.protobuf.Timestamp
error	string

GitStore

Field	Type	Label	Description
disabled	bool
repository	string
branch	string
capsule_path	string
capsule_set_path	string
commit_template	string
environments	EnvironmentFilter
pr_title_template	string
pr_body_template	string
require_pull_request	bool

RepoBranch

Field	Type	Label	Description
repository	string
branch	string

GitProvider

Name	Number	Description
GIT_PROVIDER_UNSPECIFIED	0
GIT_PROVIDER_GITHUB	1
GIT_PROVIDER_GITLAB	2
GIT_PROVIDER_BITBUCKET	3

api/v1/capsule/capsule.proto

Capsule

Environment wide capsule abstraction.

Field	Type	Label	Description
capsule_id	string		ID of the capsule.
updated_at	google.protobuf.Timestamp		Last time the capsule was updated.
updated_by	model.Author		Author of the last update.
git_store	model.GitStore

Update

Field	Type	Label	Description
set_git_store	model.GitStore		Set the git store.

api/v1/capsule/job.proto

CronJob

Specification for a cron job.

Field	Type	Label	Description
job_name	string		Name of the job.
schedule	string		Cron schedule.
max_retries	int32		Maximum number of retries.
timeout	google.protobuf.Duration		Maximum duration of the job.
url	JobURL		URL job.
command	JobCommand		Command job.

JobCommand

Run a job by running a command in an instance of a capsule

Field	Type	Label	Description
command	string		Command to run.
args	string	repeated	Arguments to pass to the command.

JobExecution

An execution of a cron job.

Field	Type	Label	Description
job_name	string		Name of the job.
created_at	google.protobuf.Timestamp		When the job started running.
finished_at	google.protobuf.Timestamp		When the job finished.
state	JobState		The state of the job.
retries	int32		Number of retries.
rollout_id	uint64		ID of the rollout.
capsule_id	string		ID of the capsule.
project_id	string		ID of the project.
execution_id	string		ID of the execution.
environment_id	string		ID of the environment.

JobURL

Run a job by making a HTTP request to a URL.

Field	Type	Label	Description
port	uint64		Port to make the request to.
path	string		Path to make the request to.
query_parameters	JobURL.QueryParametersEntry	repeated	Query parameters to add to the request.

JobURL.QueryParametersEntry

Field	Type	Label	Description
key	string
value	string

JobState

Different states a job execution can be in

Name	Number	Description
JOB_STATE_UNSPECIFIED	0	Default value.
JOB_STATE_ONGOING	1	The job is running.
JOB_STATE_COMPLETED	2	The job completed successfully.
JOB_STATE_FAILED	3	The job failed.
JOB_STATE_TERMINATED	4	The job was terminated.

model/metrics.proto

ContainerMetrics

Metrics for a container.

Field	Type	Label	Description
timestamp	google.protobuf.Timestamp		Timestamp of the metrics.
memory_bytes	uint64		Memory usage in bytes.
cpu_ms	uint64		CPU usage in milliseconds.
storage_bytes	uint64		Storage usage in bytes.

InstanceMetrics

Metrics for an instance

Field	Type	Label	Description
capsule_id	string		Capsule of the instance.
instance_id	string		Instance ID.
main_container	ContainerMetrics		Main container metrics.
proxy_container	ContainerMetrics		Proxy container metrics.

Metric

Custom metrics

Field	Type	Label	Description
name	string		Name of the metric.
latest_value	double		Latest value of the metric.
latest_timestamp	google.protobuf.Timestamp		Timestamp of the latest value.

ObjectReference

A reference to a kubernetes object.

Field	Type	Label	Description
kind	string		Type of object.
name	string		Name of the object.
api_version	string		Api version of the object.

Resources

Field	Type	Label	Description
cpu_millis	uint64
memory_bytes	uint64
pods	uint64

k8s.io/api/autoscaling/v2/generated.proto

CrossVersionObjectReference

Field	Type	Label	Description
kind	string
name	string
apiVersion	string

platform/v1/generated.proto

CPUTarget

Field	Type	Label	Description
utilization	uint32

Capsule

Field	Type	Label	Description
kind	string
apiVersion	string
name	string
project	string
environment	string
spec	CapsuleSpec

CapsuleInterface

Field	Type	Label	Description
name	string
port	int32
liveness	InterfaceLivenessProbe
readiness	InterfaceReadinessProbe
routes	HostRoute	repeated

CapsuleSet

Field	Type	Label	Description
kind	string
apiVersion	string
name	string
project	string
spec	CapsuleSpec
environments	CapsuleSet.EnvironmentsEntry	repeated
environmentRefs	string	repeated

CapsuleSet.EnvironmentsEntry

Field	Type	Label	Description
key	string
value	CapsuleSpec

CapsuleSpec

Field	Type	Label	Description
annotations	CapsuleSpec.AnnotationsEntry	repeated
image	string
command	string
args	string	repeated
interfaces	CapsuleInterface	repeated
files	File	repeated
env	EnvironmentVariables
scale	Scale
cronJobs	CronJob	repeated
autoAddRigServiceAccounts	bool
extensions	CapsuleSpec.ExtensionsEntry	repeated

CapsuleSpec.AnnotationsEntry

Field	Type	Label	Description
key	string
value	string

CapsuleSpec.ExtensionsEntry

Field	Type	Label	Description
key	string
value	google.protobuf.Struct

CronJob

Field	Type	Label	Description
name	string
schedule	string
url	URL
command	JobCommand
maxRetries	uint64
timeoutSeconds	uint64

CustomMetric

Field	Type	Label	Description
instanceMetric	InstanceMetric
objectMetric	ObjectMetric

Environment

Field	Type	Label	Description
kind	string
apiVersion	string
name	string
namespaceTemplate	string
operatorVersion	string
cluster	string
spec	ProjEnvCapsuleBase
ephemeral	bool
activeProjects	string	repeated
global	bool

EnvironmentSource

Field	Type	Label	Description
name	string
kind	string

EnvironmentVariables

Field	Type	Label	Description
raw	EnvironmentVariables.RawEntry	repeated
sources	EnvironmentSource	repeated

EnvironmentVariables.RawEntry

Field	Type	Label	Description
key	string
value	string

File

Field	Type	Label	Description
path	string
asSecret	bool
bytes	bytes
string	string
ref	FileReference

FileReference

Field	Type	Label	Description
kind	string
name	string
key	string

HTTPPathRoute

Field	Type	Label	Description
path	string
match	string

HorizontalScale

Field	Type	Label	Description
min	uint32
max	uint32
instances	Instances
cpuTarget	CPUTarget
customMetrics	CustomMetric	repeated

HostCapsule

Field	Type	Label	Description
kind	string
apiVersion	string
name	string
project	string
environment	string
network	HostNetwork

HostNetwork

Field	Type	Label	Description
hostInterfaces	ProxyInterface	repeated
capsuleInterfaces	ProxyInterface	repeated
tunnelPort	uint32

HostRoute

Field	Type	Label	Description
id	string
host	string
paths	HTTPPathRoute	repeated
annotations	HostRoute.AnnotationsEntry	repeated

HostRoute.AnnotationsEntry

Field	Type	Label	Description
key	string
value	string

InstanceMetric

Field	Type	Label	Description
metricName	string
matchLabels	InstanceMetric.MatchLabelsEntry	repeated
averageValue	string

InstanceMetric.MatchLabelsEntry

Field	Type	Label	Description
key	string
value	string

Instances

Field	Type	Label	Description
min	uint32
max	uint32

InterfaceGRPCProbe

Field	Type	Label	Description
service	string
enabled	bool

InterfaceLivenessProbe

Field	Type	Label	Description
path	string
tcp	bool
grpc	InterfaceGRPCProbe
startupDelay	uint32

InterfaceOptions

Field	Type	Label	Description
tcp	bool
allowOrigin	string
changeOrigin	bool
headers	InterfaceOptions.HeadersEntry	repeated

InterfaceOptions.HeadersEntry

Field	Type	Label	Description
key	string
value	string

InterfaceReadinessProbe

Field	Type	Label	Description
path	string
tcp	bool
grpc	InterfaceGRPCProbe

JobCommand

Field	Type	Label	Description
command	string
args	string	repeated

ObjectMetric

Field	Type	Label	Description
metricName	string
matchLabels	ObjectMetric.MatchLabelsEntry	repeated
averageValue	string
value	string
objectReference	k8s.io.api.autoscaling.v2.CrossVersionObjectReference

ObjectMetric.MatchLabelsEntry

Field	Type	Label	Description
key	string
value	string

ProjEnvCapsuleBase

Field	Type	Label	Description
files	File	repeated
env	EnvironmentVariables

Project

Field	Type	Label	Description
kind	string
apiVersion	string
name	string
spec	ProjEnvCapsuleBase

ProxyInterface

Field	Type	Label	Description
port	uint32
target	string
options	InterfaceOptions

ResourceLimits

Field	Type	Label	Description
request	string
limit	string

ResourceRequest

Field	Type	Label	Description
request	string

Scale

Field	Type	Label	Description
horizontal	HorizontalScale
vertical	VerticalScale

URL

Field	Type	Label	Description
port	uint32
path	string
queryParameters	URL.QueryParametersEntry	repeated

URL.QueryParametersEntry

Field	Type	Label	Description
key	string
value	string

VerticalScale

Field	Type	Label	Description
cpu	ResourceLimits
memory	ResourceLimits
gpu	ResourceRequest

api/v1/capsule/change.proto

CPUTarget

Autoscaling based on CPU target.

Field	Type	Label	Description
average_utilization_percentage	uint32		Average CPU utilization target.

Change

Change to a capsule that ultimately results in a new rollout.

Field	Type	Label	Description
replicas	uint32		Number of replicas changed.
image_id	string		New image change.
network	Network		Network interfaces change.
container_settings	ContainerSettings		Container settings of the instances.
auto_add_rig_service_accounts	bool		Automatically add a rig-service account.
set_config_file	Change.ConfigFile		Set a config file - either update or add.
set_config_file_ref	Change.ConfigFileRef		Set a config file ref - either update or add.
remove_config_file	string		Path of a config file to remove.
horizontal_scale	HorizontalScale		Horizontal scaling settings.
rollback	Change.Rollback		Rollback to a previous rollout.
set_environment_variable	Change.KeyValue		Update or add an environment variable.
remove_environment_variable	string		Name of an environment variable to remove.
set_environment_source	EnvironmentSource		Set or update an environment source.
remove_environment_source	EnvironmentSource		Remove an environment source.
command_arguments	Change.CommandArguments		Entrypoint for capsule instances.
add_cron_job	CronJob		Add a cron job.
remove_cron_job	Change.RemoveCronJob		Remove a cron job.
set_interface	Interface		Add or update a network interface.
remove_interface	string		Remove a network interface.
set_annotations	Change.Annotations		Set capsule annotations.
set_annotation	Change.KeyValue		Update or add a single capsule annotation.
remove_annotation	string		Name of a single capsule annotation to remove.
add_image	Change.AddImage		Image to deploy, adding it to images if not already present.
spec	platform.v1.CapsuleSpec		Complete capsule-spec to replace the current.

Change.AddImage

Field	Type	Label	Description
image	string

Change.Annotations

Field	Type	Label	Description
annotations	Change.Annotations.AnnotationsEntry	repeated

Change.Annotations.AnnotationsEntry

Field	Type	Label	Description
key	string
value	string

Change.CommandArguments

Entrypoint for the capsule instances.

Field	Type	Label	Description
command	string		Command to run.
args	string	repeated	arguments to the command.

Change.ConfigFile

Config file change.

Field	Type	Label	Description
path	string		Path of the file in the instance.
content	bytes		Content of the config file.
is_secret	bool		True if the content is secret.

Change.ConfigFileRef

Config file ref change.

Field	Type	Label	Description
path	string		Path of the file in the instance.
kind	string		Kind of the object to inject as config file. Either ConfigMap or Secret.
name	string		Name of the object to inject as a config file.
key	string		Key of the data within the object contents.

Change.CronJobs

Jobs change

Field	Type	Label	Description
jobs	CronJob	repeated	The jobs.

Change.KeyValue

Key-value change.

Field	Type	Label	Description
name	string		Name of the property.
value	string		The value of the property.

Change.RemoveCronJob

Remove cron job change.

Field	Type	Label	Description
job_name	string		Name of the job to remove

Change.Rollback

Rollback change.

Field	Type	Label	Description
rollback_id	uint64		Rollout to roll back to.

ContainerSettings

Settings for the instance container

Field	Type	Label	Description
environment_variables	ContainerSettings.EnvironmentVariablesEntry	repeated	Environment variables.
command	string		Entrypoint for the container.
args	string	repeated	Arguments to the container.
resources	Resources		Resource requests and limits.
environment_sources	EnvironmentSource	repeated	Environment sources.

ContainerSettings.EnvironmentVariablesEntry

Field	Type	Label	Description
key	string
value	string

CustomMetric

Autoscaling based on custom metrics.

Field	Type	Label	Description
instance	InstanceMetric		If scaling based on metrics across all intstances / pods.
object	ObjectMetric		If scaling based on metrics for a specific kubernetes resource object.

EnvironmentSource

Source of environment variables

Field	Type	Label	Description
name	string		Name of the source
kind	EnvironmentSource.Kind		Type of the source

GpuLimits

GPU resource limits

Field	Type	Label	Description
type	string		gpu resource type - fx. nvidia.com/gpu
count	uint32		number of gpus

HTTPPathRoute

Field	Type	Label	Description
path	string
match	PathMatchType

HorizontalScale

Horizontal scaling settings.

Field	Type	Label	Description
max_replicas	uint32		Maximum number of replicas.
min_replicas	uint32		Minimum number of replicas.
cpu_target	CPUTarget		CPU target for autoscaling.
custom_metrics	CustomMetric	repeated	If scaling based on custom metrics.

HostRoute

Field	Type	Label	Description
host	string
options	RouteOptions
paths	HTTPPathRoute	repeated
id	string

InstanceMetric

Metric emitted by instances / pods.

Field	Type	Label	Description
metric_name	string		Name of the metric
match_labels	InstanceMetric.MatchLabelsEntry	repeated	Labels of the instances to match.
average_value	string		Average value target.

InstanceMetric.MatchLabelsEntry

Field	Type	Label	Description
key	string
value	string

Interface

A single network interface.

Field	Type	Label	Description
port	uint32		Port of the interface.
name	string		Name of the interface.
public	PublicInterface		If public interface is enabled. Contains ingress or load balancer settings.
liveness	InterfaceProbe		Liveness probe.
readiness	InterfaceProbe		Readiness probe.
routes	HostRoute	repeated	Routes for the network interface.

InterfaceProbe

Probe for liveness or readiness.

Field	Type	Label	Description
http	InterfaceProbe.HTTP
tcp	InterfaceProbe.TCP
grpc	InterfaceProbe.GRPC

InterfaceProbe.GRPC

GRPC service for the probe.

Field	Type	Label	Description
service	string

InterfaceProbe.HTTP

HTTP path for the probe.

Field	Type	Label	Description
path	string

InterfaceProbe.TCP

IF TCP probe.

Network

A network configuration of network interfaces.

Field	Type	Label	Description
interfaces	Interface	repeated	All the network interfaces.

ObjectMetric

Metric emitted by kubernetes object.

Field	Type	Label	Description
metric_name	string		Name of the metric.
match_labels	ObjectMetric.MatchLabelsEntry	repeated	Labels of the object to match.
average_value	string		Average value target.
value	string		Value target.
object_reference	model.ObjectReference		Reference to the object.

ObjectMetric.MatchLabelsEntry

Field	Type	Label	Description
key	string
value	string

PublicInterface

Public interface configuration.

Field	Type	Label	Description
enabled	bool		True if the interface is public.
method	RoutingMethod		Routing method - Ingress or Load Balancer.

ResourceList

CPU and Memory resource request or limits

Field	Type	Label	Description
cpu_millis	uint32		Unit: milli-CPUs
memory_bytes	uint64		Unit: Bytes

Resources

Container resources requests and limits

Field	Type	Label	Description
requests	ResourceList		CPU and memory requests.
limits	ResourceList		CPU and memory limits
gpu_limits	GpuLimits		GPU Limits

RouteOptions

Field	Type	Label	Description
annotations	RouteOptions.AnnotationsEntry	repeated

RouteOptions.AnnotationsEntry

Field	Type	Label	Description
key	string
value	string

RoutingMethod

The routing method for the public interface.

Field	Type	Label	Description
load_balancer	RoutingMethod.LoadBalancer
ingress	RoutingMethod.Ingress

RoutingMethod.Ingress

Ingress routing.

Field	Type	Label	Description
host	string		Hostname of the ingress.
tls	bool		True if TLS is enabled.
paths	string	repeated	Paths of the ingress.

RoutingMethod.LoadBalancer

Loadbalancer routing.

Field	Type	Label	Description
port	uint32		public port.
node_port	uint32		node port.

EnvironmentSource.Kind

Name	Number	Description
KIND_UNSPECIFIED	0	Unspecified.
KIND_CONFIG_MAP	1	Environment variables from a config map.
KIND_SECRET	2	Environment variables from a secret.

PathMatchType

Name	Number	Description
PATH_MATCH_TYPE_UNSPECIFIED	0
PATH_MATCH_TYPE_PATH_PREFIX	1
PATH_MATCH_TYPE_EXACT	2
PATH_MATCH_TYPE_REGULAR_EXPRESSION	3

api/v1/capsule/event.proto

AbortEvent

An event that is associated with an abort.

ErrorEvent

An event that is associated with an error.

Event

An event is a message from a rollout

Field	Type	Label	Description
created_by	model.Author		Potential author associated with the event.
created_at	google.protobuf.Timestamp		When the event was created.
rollout_id	uint64		The rollout that created the event.
message	string		A message associated with the event.
event_data	EventData		The data associated with the event.

EventData

The data associated with an event.

Field	Type	Label	Description
rollout	RolloutEvent		If event is a rollout.
error	ErrorEvent		if event is an error event.
abort	AbortEvent		If event is an abort event.

RolloutEvent

An event that is associated with a rollout.

api/v1/capsule/field.proto

FieldChange

Field	Type	Label	Description
field_id	string		The Field-ID associated with this change. This is formated as a json-path string with '?' placeholders.
field_path	string		The unique Field-path identifying this change. This is formated as a json-path string.
old_value_yaml	string		YAML encoding of the old value (if any).
new_value_yaml	string		YAML encoding of the new value (if any).
operation	FieldOperation		Operation is how this field-change is applied against the source to get to the target spec.
description	string		Pretty-printed string description of the field change.

FieldOperation

Name	Number	Description
FIELD_OPERATION_UNSPECIFIED	0
FIELD_OPERATION_ADDED	1
FIELD_OPERATION_REMOVED	2
FIELD_OPERATION_MODIFIED	3

api/v1/capsule/image.proto

GitReference

GitReference is an origin of a image.

Field	Type	Label	Description
repository_url	string		The url of the git repository
commit_sha	string		The commit sha of the git repository
commit_url	string		The commit url of the git repository

Image

Image is an cross-environment abstraction of an container image along with metadata for a capsule.

Field	Type	Label	Description
image_id	string		unique identifier for the image
digest	string		digest of the image
repository	string		repository of the image
tag	string		tag of the image
created_by	model.Author		user who created the image
created_at	google.protobuf.Timestamp		time the image was created
origin	Origin		origin of the image
labels	Image.LabelsEntry	repeated	labels of the image

Image.LabelsEntry

Field	Type	Label	Description
key	string
value	string

Origin

Where the image came from

Field	Type	Label	Description
git_reference	GitReference		The image came from a git repository

api/v1/capsule/instance.proto

ContainerStateTerminated

Field	Type	Label	Description
exit_code	int32		Exit status from the last termination of the container
signal	int32		Signal from the last termination of the container +optional
reason	string		(brief) reason from the last termination of the container +optional
message	string		Message regarding the last termination of the container +optional
started_at	google.protobuf.Timestamp		Time at which previous execution of the container started +optional
finished_at	google.protobuf.Timestamp		Time at which the container last terminated +optional
container_id	string		Container's ID in the format 'type://container_id' +optional

CrashLoopBackoff

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps
data	CrashLoopBackoffData

CrashLoopBackoffData

Field	Type	Label	Description
termination	ContainerStateTerminated

CurrentlyUnscheduleable

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

DoneScheduling

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

ImagePulling

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps
stages	ImagePullingStages

ImagePullingBackOff

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

ImagePullingDone

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

ImagePullingError

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

ImagePullingPulling

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

ImagePullingStages

Field	Type	Label	Description
pulling	ImagePullingPulling
error	ImagePullingError
back_off	ImagePullingBackOff
done	ImagePullingDone

Instance

Field	Type	Label	Description
instance_id	string
image_id	string
state	State
restart_count	uint32
created_at	google.protobuf.Timestamp
started_at	google.protobuf.Timestamp
finished_at	google.protobuf.Timestamp
message	string
rollout_id	uint64

InstanceReady

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

InstanceStatus

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps
data	InstanceStatusData
stages	InstanceStatusStages

InstanceStatusData

Field	Type	Label	Description
instance_id	string
rollout_id	uint64
image_name	string
node	string

InstanceStatusPreparing

======================= PREPARING =====================

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps
stages	InstanceStatusPreparingStages

InstanceStatusPreparingStages

Field	Type	Label	Description
pulling	ImagePulling

InstanceStatusRunning

======================== RUNNING ======================

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps
stages	InstanceStatusRunningStages
data	InstanceStatusRunningData

InstanceStatusRunningData

Field	Type	Label	Description
restarts	uint32

InstanceStatusRunningStages

Field	Type	Label	Description
crash_loop_backoff	CrashLoopBackoff
ready	Ready
running	Running

InstanceStatusScheduling

====================== SCHEDULING ====================

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps
stages	InstanceStatusSchedulingStages

InstanceStatusSchedulingStages

Field	Type	Label	Description
currently_unscheduleable	CurrentlyUnscheduleable
done	DoneScheduling

InstanceStatusStages

Field	Type	Label	Description
schedule	InstanceStatusScheduling
preparing	InstanceStatusPreparing
running	InstanceStatusRunning

NotReady

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

Ready

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps
stages	ReadyStages

ReadyStages

Field	Type	Label	Description
not_ready	NotReady
ready	InstanceReady

Running

Field	Type	Label	Description
message	string
timestamps	StatusTimestamps

StatusTimestamps

Field	Type	Label	Description
entered	google.protobuf.Timestamp
updated	google.protobuf.Timestamp
exited	google.protobuf.Timestamp

State

Name	Number	Description
STATE_UNSPECIFIED	0
STATE_PENDING	1
STATE_RUNNING	2
STATE_SUCCEEDED	3
STATE_FAILED	4

api/v1/capsule/instance/status.proto

ContainerInfo

Field	Type	Label	Description
name	string
type	api.v1.pipeline.ContainerType

ContainerTermination

Information about the last container termination.

Field	Type	Label	Description
exit_code	int32		Exit status from the last termination of the container
signal	int32		Signal from the last termination of the container +optional
reason	string		(brief) reason from the last termination of the container +optional
message	string		Message regarding the last termination of the container +optional
started_at	google.protobuf.Timestamp		Time at which previous execution of the container started +optional
finished_at	google.protobuf.Timestamp		Time at which the container last terminated +optional
container_id	string		Container's ID in the format 'type://container_id' +optional

DeletedStage

Field	Type	Label	Description
info	StageInfo
steps	DeletedStep	repeated

DeletedStep

Field	Type	Label	Description
generic	GenericStep

ExecutingStep

An executing step of the running stage.

Field	Type	Label	Description
info	StepInfo		Meta information about the step.
started_at	google.protobuf.Timestamp		Time at which the step started.
finished_at	google.protobuf.Timestamp		Time at which the step finished.
restarts	uint32		Number of restarts of the container
last_container_termination	ContainerTermination		Information about the last container termination.

GenericStep

A generic step.

Field	Type	Label	Description
info	StepInfo

ImagePullingStep

An image pulling step of the preparing stage.

Field	Type	Label	Description
info	StepInfo		Meta information about the step.
state	ImagePullingState		State of the step.
image	string		Image that is being pulled.

PlacementStep

Placement step.

Field	Type	Label	Description
info	StepInfo		Meta information about the step.
node	string		Node on which the instance should run.

PreparingStage

The preparing stage

Field	Type	Label	Description
info	StageInfo		Meta information about the stage.
steps	PreparingStep	repeated	Steps of the stage.

PreparingStep

A step of the preparing stage.

Field	Type	Label	Description
generic	GenericStep		Generic step.
image_pulling	ImagePullingStep		Image pulling step.
init_executing	ExecutingStep		Executing step for init containers

ReadyStep

A ready step of the running stage.

Field	Type	Label	Description
info	StepInfo		Meta information about the step.
state	ReadyState		State of the step.
failed_at	google.protobuf.Timestamp		Time at which the step failed.
fail_count	uint32		Number of times the step has failed.

RunningStage

The running stage of the instance

Field	Type	Label	Description
info	StageInfo		Meta information about the stage.
steps	RunningStep	repeated	Steps of the stage.
restarts	uint32		Number of restarts of the instance.
last_container_termination	ContainerTermination		Information about the last container termination.

RunningStep

A step of the running stage.

Field	Type	Label	Description
generic	GenericStep		Generic step.
ready	ReadyStep		Ready step.
executing	ExecutingStep		Executing step.

SchedulingStage

The scheduling stage.

Field	Type	Label	Description
info	StageInfo		Meta information about the stage.
steps	SchedulingStep	repeated	Steps of the stage.

SchedulingStep

A step of the scheduling stage.

Field	Type	Label	Description
generic	GenericStep		Generic step.
placement	PlacementStep		Placement step - On what node should the instance run.

StageInfo

Meta information about a stage.

Field	Type	Label	Description
name	string		Name of the stage.
updated_at	google.protobuf.Timestamp		Last update time of the stage.
state	StageState		State of the stage.

Stages

The different stages of the instance.

Field	Type	Label	Description
schedule	SchedulingStage		Scheduling stage.
preparing	PreparingStage		Preparing stage.
running	RunningStage		Running stage.
deleted	DeletedStage		Deleted stage.

Status

Status is a representation of the current state of an instance.

Field	Type	Label	Description
instance_id	string		Instance ID.
stages	Stages		Stages of the instance.
rollout_id	uint64		Rollout ID.
image	string		Image of the instance.
created_at	google.protobuf.Timestamp		Creation time of the instance.

StepInfo

Meta data about a step.

Field	Type	Label	Description
name	string		Name of the step.
message	string		Message of the step.
updated_at	google.protobuf.Timestamp		Last update time of the step.
state	StepState		State of the step.
container	ContainerInfo		Information about the container associated with the step.

ImagePullingState

Different states of an image pulling step.

Name	Number	Description
IMAGE_PULLING_STATE_UNSPECIFIED	0	Unspecified state.
IMAGE_PULLING_STATE_PULLING	1	Image is being pulled.
IMAGE_PULLING_STATE_ERROR	2	Image pulling has failed.
IMAGE_PULLING_STATE_BACK_OFF	3	Image pulling is in back off.
IMAGE_PULLING_STATE_DONE	4	Image pulling is done.

PlacementState

Different states of a placement step

Name	Number	Description
SCHEDULING_STATE_UNSPECIFIED	0	Unspecified state.
SCHEDULING_STATE_UNSCHEDULEABLE	1	If the instance is unschedulable.
SCHEDULING_STATE_DONE	2	If the instance is scheduled.

ReadyState

Different states of a ready step.

Name	Number	Description
READY_STATE_UNSPECIFIED	0	Unspecified state.
READY_STATE_CRASH_LOOP_BACKOFF	1	If the instance is in crash loop backoff.
READY_STATE_NOT_READY	2	If the instance is not ready.
READY_STATE_READY	3	If the instance is ready.

StageState

Different states a stage can be in.

Name	Number	Description
STAGE_STATE_UNSPECIFIED	0	Unspecified state.
STAGE_STATE_ONGOING	1	Stage is ongoing.
STAGE_STATE_FAILED	2	Stage has failed.
STAGE_STATE_DONE	3	Stage is done.
STAGE_STATE_RUNNING	4	Stage is running.

StepState

Different states a step can be in.

Name	Number	Description
STEP_STATE_UNSPECIFIED	0	Unspecified state.
STEP_STATE_ONGOING	1	Step is ongoing.
STEP_STATE_FAILED	2	Step has failed.
STEP_STATE_DONE	3	Step is done.
STEP_STATE_RUNNING	4	Step is running.

api/v1/capsule/log.proto

Log

Log of an instance

Field	Type	Label	Description
timestamp	google.protobuf.Timestamp		Timestamp of the log
message	LogMessage		Message of the log
instance_id	string		Instance ID of the log

LogMessage

The actual log message

Field	Type	Label	Description
stdout	bytes		If the log is stdout
stderr	bytes		If the log is stderr
container_termination	LogMessage.ContainerTermination		Represents a termination event

LogMessage.ContainerTermination

model/pipeline.proto

FieldPrefixes

Field	Type	Label	Description
inclusion	bool		If true, only fields with the specified prefixes will be promoted If false, only fields without the specified prefixes will be promoted
prefixes	string	repeated

Phase

Field	Type	Label	Description
environment_id	string		Environment to promote to. The project must be active in this environment.
field_prefixes	FieldPrefixes		Fields prefixes to either promote or not.
triggers	Triggers		Promotion triggers.

Pipeline

Field	Type	Label	Description
name	string		Custom name for the pipeline.
initial_environment	string		The environment to base the pipeline on.
phases	Phase	repeated	The subsequent phases of the pipeline to promote to.
created_at	google.protobuf.Timestamp		The time the pipeline was created.
updated_at	google.protobuf.Timestamp		The time the pipeline was updated.
description	string		User specified description of the pipeline.

Trigger

Field	Type	Label	Description
conditions	Trigger.Condition	repeated	The conditions that must be met for the trigger to fire.
require_all	bool		If true, all conditions must be met for the trigger to fire. Otherwise only a single condition must be met.
enabled	bool		If true, the trigger is enabled. Otherwise it is disabled.

Trigger.Condition

Condition that must be met for the trigger to fire.

Field	Type	Label	Description
time_alive	google.protobuf.Duration

Triggers

Field	Type	Label	Description
automatic	Trigger		The automatic trigger
manual	Trigger		The manual trigger

api/v1/capsule/pipeline/status.proto

PhaseMessage

Field	Type	Label	Description
message	string
timestamp	google.protobuf.Timestamp

PhaseStatus

Field	Type	Label	Description
environment_id	string
state	PhaseState
rollout_id	uint64
messages	PhaseMessage	repeated
started_at	google.protobuf.Timestamp

Status

Field	Type	Label	Description
pipeline_name	string		The name of the pipeline.
capsule_id	string		The capsule that is executing the pipeline.
execution_id	uint64		The ID of the pipeline execution
state	State		The overall state of the pipeline execution.
phase_statuses	PhaseStatus	repeated	The statuses of the phases in the pipeline.
started_at	google.protobuf.Timestamp		When the pipeline was started.
updated_at	google.protobuf.Timestamp		When the pipeline was last updated.
current_phase	uint32		current phase
config	model.Pipeline		the configured pipeline

PhaseState

Name	Number	Description
PHASE_STATE_UNSPECIFIED	0	The state is unspecified.
PHASE_STATE_NOT_READY	1	The phase is not ready for promotion
PHASE_STATE_READY	2	The phase is ready for promotion
PHASE_STATE_PROMOTED	3	The phase is promoted

State

Name	Number	Description
STATE_UNSPECIFIED	0	The state is unspecified.
STATE_RUNNING	1	The pipeline has started.
STATE_ABORTED	2	The pipeline is aborted.
STATE_COMPLETED	3	The pipeline is completed.

model/revision.proto

BookmarkingConfiguration

Field	Type	Label	Description
dont_bookmark	bool

Fingerprint

Field	Type	Label	Description
data	string

Fingerprints

Field	Type	Label	Description
project	Fingerprint
environment	Fingerprint
capsule_set	Fingerprint
capsule	Fingerprint

GitLabProposal

Field	Type	Label	Description
pr_id	int64

GithubProposal

Field	Type	Label	Description
pr_id	int64

ProposalMetadata

Field	Type	Label	Description
created_at	google.protobuf.Timestamp
created_by	Author
fingerprint	Fingerprint
spawn_point	RepoBranch
branch	string
review_url	string
github	GithubProposal
gitlab	GitLabProposal

RevisionMetadata

Field	Type	Label	Description
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp
updated_by	Author
fingerprint	Fingerprint
git_change	GitChange
bookmarking	BookmarkingConfiguration

Revisions

Field	Type	Label	Description
projects	RevisionMetadata	repeated
environments	RevisionMetadata	repeated
capsule_sets	RevisionMetadata	repeated
capsules	RevisionMetadata	repeated

api/v1/capsule/revision.proto

Proposal

Field	Type	Label	Description
spec	platform.v1.Capsule
metadata	model.ProposalMetadata

Revision

Field	Type	Label	Description
spec	platform.v1.Capsule
metadata	model.RevisionMetadata
message	string

SetProposal

Field	Type	Label	Description
spec	platform.v1.CapsuleSet
metadata	model.ProposalMetadata

SetRevision

Field	Type	Label	Description
spec	platform.v1.CapsuleSet
metadata	model.RevisionMetadata

api/v1/capsule/rollout.proto

Changelog

Field	Type	Label	Description
changes	Changelog.Change	repeated
message	string

Changelog.Change

Field	Type	Label	Description
message	string

ConfigFile

Field	Type	Label	Description
path	string
content	bytes
updated_by	model.Author
updated_at	google.protobuf.Timestamp
is_secret	bool

Rollout

The rollout model.

Field	Type	Label	Description
rollout_id	uint64		Unique indentifier for the rollout.
config	RolloutConfig		The rollout config.
status	rollout.Status		The rollout status.
spec	platform.v1.CapsuleSpec
revisions	model.Revisions
changelog	Changelog

RolloutConfig

Field	Type	Label	Description
created_by	model.Author		The user who initiated the rollout.
created_at	google.protobuf.Timestamp
replicas	uint32
image_id	string
network	Network
container_settings	ContainerSettings
auto_add_rig_service_accounts	bool
config_files	ConfigFile	repeated
horizontal_scale	HorizontalScale
cron_jobs	CronJob	repeated
environment_id	string
message	string
annotations	RolloutConfig.AnnotationsEntry	repeated

RolloutConfig.AnnotationsEntry

Field	Type	Label	Description
key	string
value	string

EventType

Name	Number	Description
EVENT_TYPE_UNSPECIFIED	0
EVENT_TYPE_ABORT	1

api/v1/issue/issue.proto

Issue

Field	Type	Label	Description
issue_id	string
type	string
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp
stale_at	google.protobuf.Timestamp
closed_at	google.protobuf.Timestamp
reference	Reference
message	string
level	Level
count	uint32

Reference

Field	Type	Label	Description
project_id	string
capsule_id	string
environment_id	string
rollout_id	uint64
instance_id	string

Level

Name	Number	Description
LEVEL_UNSPECIFIED	0
LEVEL_INFORMATIVE	1
LEVEL_MINOR	2
LEVEL_MAJOR	3
LEVEL_CRITICAL	4

api/v1/capsule/status.proto

CapsuleStatus

Field	Type	Label	Description
statuses	api.v1.pipeline.ObjectStatus	repeated

ConfigFileStatus

Field	Type	Label	Description
path	string
isSecret	bool
status	api.v1.pipeline.ObjectStatus	repeated
transition	Transition
content	bytes

ContainerConfig

Field	Type	Label	Description
image	string
command	string
args	string	repeated
environment_variables	ContainerConfig.EnvironmentVariablesEntry	repeated
scale	HorizontalScale
resources	Resources

ContainerConfig.EnvironmentVariablesEntry

Field	Type	Label	Description
key	string
value	string

CronJobStatus

Field	Type	Label	Description
job_name	string
schedule	string
last_execution	api.v1.pipeline.ObjectState
transition	Transition

InstancesStatus

Field	Type	Label	Description
num_upgrading	uint32		The number of updated instances.
num_ready	uint32		The number of ready instances.
num_stuck	uint32		The number of stuck instances.
num_wrong_version	uint32		The number of instances with the wrong version.

InterfaceStatus

Field	Type	Label	Description
name	string
port	uint32
routes	InterfaceStatus.Route	repeated
status	api.v1.pipeline.ObjectStatus	repeated
transition	Transition

InterfaceStatus.Route

Field	Type	Label	Description
route	HostRoute
status	api.v1.pipeline.ObjectStatus	repeated
transition	Transition

Status

Field	Type	Label	Description
namespace	string
capsule	CapsuleStatus
current_rollout_id	uint64
container_config	ContainerConfig
instances	InstancesStatus
interfaces	InterfaceStatus	repeated
config_files	ConfigFileStatus	repeated
cron_jobs	CronJobStatus	repeated
issues	api.v1.issue.Issue	repeated	List of all issues associated to the Capsule, include those of the current rollout. The list does not include instance-level issues.

Transition

Name	Number	Description
TRANSITION_UNSPECIFIED	0
TRANSITION_BEING_CREATED	1
TRANSITION_UP_TO_DATE	2
TRANSITION_BEING_DELETED	3

api/v1/capsule/service.proto

AbortPipelineRequest

Field	Type	Label	Description
execution_id	uint64

AbortPipelineResponse

Field	Type	Label	Description
status	pipeline.Status

AbortRolloutRequest

AbortRolloutRequest aborts a rollout.

Field	Type	Label	Description
capsule_id	string		The capsule to abort the rollout in.
rollout_id	uint64		The rollout to abort.
project_id	string		The project in which the capsule lives.

AbortRolloutResponse

AbortRolloutResponse is an empty response.

CapsuleMetricsRequest

Request for getting metrics for a capsule and optionally a single instance.

Field	Type	Label	Description
capsule_id	string		The capsule to get metrics for.
instance_id	string		If set, only returns metrics for the given instance_id.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to get metrics for.
since	google.protobuf.Timestamp		Return metrics generated after 'since'

CapsuleMetricsResponse

Response to getting capsule metrics.

Field	Type	Label	Description
instance_metrics	model.InstanceMetrics	repeated	Metrics

CreateRequest

Create capsule request.

Field	Type	Label	Description
name	string		The name of the capsule. This property must be unique for a project and cannot be changed after creation. Resources created in associating with the capsule will use this name.
initializers	Update	repeated	Deprecated field: The initial properties of the capsule.
project_id	string		The project to create the capsule in.

CreateResponse

Create capsule response.

Field	Type	Label	Description
capsule_id	string		ID of the capsule. This is the same as the name.

DeleteRequest

Request to delete a capsule.

Field	Type	Label	Description
capsule_id	string		The capsule to delete.
project_id	string		The project in which the capsule is to be deleted.

DeleteResponse

Empty delete response.

DeployOutcome

Field	Type	Label	Description
field_changes	FieldChange	repeated	The field-level changes that comes from applying this change.
platform_objects	DeployOutcome.PlatformObject	repeated	The Platform-level objects that are generated by the Deploy.
kubernetes_objects	DeployOutcome.KubernetesObject	repeated	The Kubernetes-level objects that are generated by the Deploy. The objects are both the outcome of what the platform generated for the Kubernetes cluster directly and what plugins are further adding.
kubernetes_error	string		In case generation of kubernetes files failed, this field will be populated with the error.
cluster_name	string
kubernetes_namespace	string

DeployOutcome.KubernetesObject

Field	Type	Label	Description
name	string
content_yaml	string

DeployOutcome.PlatformObject

Field	Type	Label	Description
name	string
content_yaml	string

DeployRequest

Deploy request. This will deploy a number of changes which results in a new rollout.

Field	Type	Label	Description
capsule_id	string		Capsule to deploy to.
changes	Change	repeated	Changes to include in the new rollout.
force	bool		Force deploy, aborting an existing rollout if ongoing.
project_id	string		Project in which the capsule lives.
environment_id	string		Environment in which to deploy.
message	string		Deploy message.
dry_run	bool		if true, the deploy will not be executed, but the request will return the rollout config.
current_rollout_id	uint64		If not zero, this will constrain the rollout only to be created if the currently running rollout matches this identifier. If this check fails, the request will return an Aborted error.
current_fingerprint	model.Fingerprint		If set, this will constrain the rollout only to be created if the current latest capsule fingerprint matches the given. Cannot be used together with current_rollout_id
force_override	bool		By default, existing objects will be kept in favor of overriding them. To force the override of resources, set this flag to true. An example of this use-case is a migration step, where resource created by a previous toolchain e.g. based on Helm charts, are to be replaced and instead be created by the Rig operator. While the override is irreversible, this flag is not "sticky" and must be set by each deploy that should use this behavior.
operator_config	string		Only allowed with dry_run = true. Will use this config for the operator instead of the config running in the cluster.

DeployResponse

Deploy response.

Field	Type	Label	Description
rollout_id	uint64		ID of the new rollout.
resource_yaml	DeployResponse.ResourceYamlEntry	repeated	The YAML of the resources that will be deployed. Deprecated. Use outcome instead.
revision	Revision		The rollout config. api.v1.capsule.RolloutConfig rollout_config = 3; The capsule revision created.
set_revision	SetRevision		The capsule set revision created if it's the first time deploying to the environment.
outcome	DeployOutcome		Breakdown of the changes that this deploy would make to the system. Only populated if dry-run is used.

DeployResponse.ResourceYamlEntry

Field	Type	Label	Description
key	string
value	string

DeploySetOutcome

Field	Type	Label	Description
field_changes	FieldChange	repeated	The field-level changes that comes from applying this change.
environments	DeploySetOutcome.EnvironmentsEntry	repeated

DeploySetOutcome.EnvironmentsEntry

Field	Type	Label	Description
key	string
value	DeployOutcome

DeploySetRequest

Field	Type	Label	Description
capsule_id	string		Capsule to deploy to.
changes	Change	repeated	Changes to include in the new rollout.
force	bool		Force deploy, aborting existing rollouts if ongoing.
project_id	string		Project in which the capsule lives.
message	string		Deploy message.
dry_run	bool		if true, the deploy will not be executed, but the request will return the rollout config.
current_rollout_ids	DeploySetRequest.CurrentRolloutIdsEntry	repeated	If present, maps from environment to expected current rollout within that environment. This will constrain the rollout only to be created if the currently running rollout matches this identifier. If this check fails, the request will return an Aborted error.
current_fingerprint	model.Fingerprint		If set, this will constrain the rollout only to be created if the current latest capsuleset fingerprint matches the given.
current_environment_fingerprints	DeploySetRequest.CurrentEnvironmentFingerprintsEntry	repeated	If set, this will constrain the rollout only to be created if the current latest capsule fingerprint for each environment in the map matches the ones in the map. Cannot be used together with current_rollout_ids

DeploySetRequest.CurrentEnvironmentFingerprintsEntry

Field	Type	Label	Description
key	string
value	model.Fingerprint

DeploySetRequest.CurrentRolloutIdsEntry

Field	Type	Label	Description
key	string
value	uint64

DeploySetResponse

Field	Type	Label	Description
revision	SetRevision		The capsule revision created.
outcome	DeploySetOutcome		Breakdown of the changes that this deploy would make to the system. Only populated if dry-run is used.
ActiveEnvironments	string	repeated	The environments which currently have rollouts. These will receive a rollout as result of the SetDeploy

ExecuteRequest

Execute request. This can either be a request to start a request, a terminal resize msg or a stream data msg.

Field	Type	Label	Description
start	ExecuteRequest.Start		Start request.
stdin	StreamData		Stream stdin request
resize	ExecuteRequest.Resize		Resize request
project_id	string		The project ID.
environment_id	string		The environment ID.

ExecuteRequest.Resize

Terminal resize request.

Field	Type	Label	Description
height	uint32		The new terminal height.
width	uint32		The new terminal width.

ExecuteRequest.Start

Exec start request

Field	Type	Label	Description
capsule_id	string		The capsule to execute in.
instance_id	string		The instance to execute in.
command	string		The command to execute.
arguments	string	repeated	The arguments to the command.
tty	ExecuteRequest.Resize		The initial terminal size.
interactive	bool		If the command is interactive.

ExecuteResponse

Execute response.

Field	Type	Label	Description
stdout	StreamData		Stdout of the execute.
stderr	StreamData		Stderr in case of an error.
exit_code	int32		Exit code of the execute.

GetCustomInstanceMetricsRequest

Request for getting custom metrics for a capsule in an environment.

Field	Type	Label	Description
capsule_id	string		The capsule to get metrics for.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to get metrics for.

GetCustomInstanceMetricsResponse

Response to getting custom metrics for a capsule in an environment.

Field	Type	Label	Description
metrics	model.Metric	repeated	Custom Metrics.

GetEffectiveGitSettingsRequest

Field	Type	Label	Description
project_id	string
environment_id	string
capsule_id	string

GetEffectiveGitSettingsResponse

Field	Type	Label	Description
git	model.GitStore
environment_enabled	bool

GetInstanceStatusRequest

Get status of an instance.

Field	Type	Label	Description
capsule_id	string		The capsule to get the instance status from.
instance_id	string		The instance to get.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to get the instance from.

GetInstanceStatusResponse

Get instance status response.

Field	Type	Label	Description
status	instance.Status		The instance status.

GetJobExecutionsRequest

Request for getting job executions from cron jobs.

Field	Type	Label	Description
capsule_id	string		The capsule to get job executions for.
job_name	string		The name of the job to get executions for.
states	JobState	repeated	Filtering executions by job state.
created_from	google.protobuf.Timestamp		Filtering executions created before this timestamp.
created_to	google.protobuf.Timestamp		Filtering executions created after this timestamp.
pagination	model.Pagination		Pagination options.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to get job executions for.

GetJobExecutionsResponse

Response to getting job executions.

Field	Type	Label	Description
job_executions	JobExecution	repeated	Job executions.
total	uint64		Total number of executions ignorring pagination.

GetPipelineStatusRequest

Field	Type	Label	Description
execution_id	uint64

GetPipelineStatusResponse

Field	Type	Label	Description
status	pipeline.Status

GetProposalsEnabledRequest

Field	Type	Label	Description
project_id	string
environment_id	string
capsule_id	string

GetProposalsEnabledResponse

Field	Type	Label	Description
enabled	bool

GetRequest

Request to get a capsule.

Field	Type	Label	Description
capsule_id	string		Capsule to get.
project_id	string		Project in which the capsule is.

GetResponse

Response to get a capsule.

Field	Type	Label	Description
capsule	Capsule		The capsule.
revision	SetRevision
environment_revisions	GetResponse.EnvironmentRevisionsEntry	repeated

GetResponse.EnvironmentRevisionsEntry

Field	Type	Label	Description
key	string
value	Revision

GetRevisionRequest

Field	Type	Label	Description
project_id	string
environment_id	string
capsule_id	string
fingerprint	model.Fingerprint

GetRevisionResponse

Field	Type	Label	Description
revision	Revision

GetRolloutOfRevisionsRequest

Field	Type	Label	Description
project_id	string
environment_id	string
capsule_id	string
fingerprints	model.Fingerprints

GetRolloutOfRevisionsResponse

Field	Type	Label	Description
no_rollout	GetRolloutOfRevisionsResponse.NoRollout
rollout	Rollout

GetRolloutOfRevisionsResponse.NoRollout

Field	Type	Label	Description
project	bool		Indicates no rollout with a project revision at least as new as the one given.
environment	bool		Indicates no rollout with an environment revision at least as new as the one given.
capsule_set	bool		Indicates no rollout with a capsule set revision at least as new as the one given.
capsule	bool		Indicates no rollout with a capsule revision at least as new as the one given.

GetRolloutRequest

GetRolloutRequest gets a single rollout.

Field	Type	Label	Description
capsule_id	string		The capsule to get the rollout from.
rollout_id	uint64		The rollout to get.
project_id	string		The project in which the capsule lives.

GetRolloutResponse

GetRolloutResponse returns a single rollout for a capsule and an environment in a project.

Field	Type	Label	Description
rollout	Rollout		The rollout.

GetStatusRequest

GetStatusRequest is a request to start streaming the capsule status

Field	Type	Label	Description
capsule_id	string		The capsule to get the status from.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to get the status from.

GetStatusResponse

GetCapsuleStatusResponse

Field	Type	Label	Description
status	Status		The capsule status

ListEventsRequest

ListEvents request for listing rollout events for a given rollout in a capsule and environment.

Field	Type	Label	Description
capsule_id	string		The capsule to list events for.
rollout_id	uint64		The rollout to list events for.
pagination	model.Pagination		Pagination options.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to list events for.

ListEventsResponse

Response to List Events

Field	Type	Label	Description
events	Event	repeated	The events for a rollout in a capsule and environment for a given project.
total	uint64		Total number of events in the capsule for the given environment.

ListInstanceStatusesRequest

List multiple instance statuses

Field	Type	Label	Description
capsule_id	string		The capsule to get the instance statuses from.
pagination	model.Pagination		Pagination options.
project_id	string		The project in which the capsule is.
environment_id	string		The environment to get the instance statuses from.
include_deleted	bool		if true, deleted instances will be included in the response.
exclude_existing	bool		if true, existing instances will be excluded from the response.

ListInstanceStatusesResponse

Response for listing multiple instance statuses

Field	Type	Label	Description
instances	instance.Status	repeated	The instance statuses.
total	uint64		Total number of instances in the capsule for the given environment.

ListInstancesRequest

List instances request.

Field	Type	Label	Description
capsule_id	string		Capsule to list instances from.
pagination	model.Pagination		Pagination options.
project_id	string		Project in which the capsule lives.
environment_id	string		Environment to list instances from.
include_deleted	bool		if true, deleted instances will be included in the response.
exclude_existing	bool		if true, existing instances will be excluded from the response.

ListInstancesResponse

List instances response.

Field	Type	Label	Description
instances	Instance	repeated	The instances.
total	uint64		Total number of instances in the capsule for the given environment.

ListPipelineStatusesRequest

Field	Type	Label	Description
pagination	model.Pagination
project_filter	string		Only include pipelines that are run in the given project.
capsule_filter	string		Only include pipelines that are run with the given capsule.
states_filter	pipeline.State	repeated	Only include pipelines that are in one of the given states.
name_filter	string		Only include pipelines that have the given name.

ListPipelineStatusesResponse

Field	Type	Label	Description
statuses	pipeline.Status	repeated

ListProposalsRequest

Field	Type	Label	Description
project_id	string
environment_id	string
capsule_id	string
pagination	model.Pagination

ListProposalsResponse

Field	Type	Label	Description
proposals	Proposal	repeated
total	uint64

ListRequest

List capsule request.

Field	Type	Label	Description
pagination	model.Pagination		Pagination options.
project_id	string		Project in which to list capsules.

ListResponse

List capsule response.

Field	Type	Label	Description
capsules	Capsule	repeated	The capsules.
total	uint64		Total number of capsules in the project.

ListRolloutsRequest

ListRolloutsRequest lists rollouts for a capsule.

Field	Type	Label	Description
capsule_id	string		The capsule to list rollouts for.
pagination	model.Pagination		Pagination options.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to list rollouts for.

ListRolloutsResponse

ListRolloutsResponse lists rollouts for a capsule and an environment.

Field	Type	Label	Description
rollouts	Rollout	repeated	The rollouts.
total	uint64		Total number of rollouts in the capsule for the given environment.

ListSetProposalsRequest

Field	Type	Label	Description
project_id	string
capsule_id	string
pagination	model.Pagination

ListSetProposalsResponse

Field	Type	Label	Description
proposals	SetProposal	repeated
total	uint64

LogsRequest

Request to get instance logs from a capsule.

Field	Type	Label	Description
capsule_id	string		The capsule to read logs from.
instance_id	string		The instance in the capsule to read logs from.
follow	bool		If true, the request will stay open and stream new log messages.
since	google.protobuf.Duration		If set, will not show logs older than since.
project_id	string		The project in which the capsule is.
environment_id	string		Environment to get logs from.
previous_containers	bool		If true, include logs from previously terminated containers

LogsResponse

The response of a capsule.Logs RPC

Field	Type	Label	Description
log	Log		The actual logs

PipelineDryRunOutput

Field	Type	Label	Description
environment_id	string		Environment to promote to.
outcome	DeployOutcome		Breakdown of the changes that this deploy would make to the system.
revision	Revision

PortForwardRequest

Field	Type	Label	Description
start	PortForwardRequest.Start
data	bytes
close	PortForwardRequest.Close

PortForwardRequest.Close

PortForwardRequest.Start

Field	Type	Label	Description
project_id	string		The project ID.
environment_id	string		The environment ID.
capsule_id	string
instance_id	string
port	uint32

PortForwardResponse

Field	Type	Label	Description
data	bytes
close	PortForwardResponse.Close

PortForwardResponse.Close

PromotePipelineRequest

Field	Type	Label	Description
execution_id	uint64
dry_run	bool		If true, the progression will not be executed, but instead a breakdown of changes will be returned
field_changes	FieldChange	repeated	additional changes to include in the manual promotion
force	bool		If true, the pipeline will be force promoted to the next environment regardless of the state of the pipeline and the triggers.

PromotePipelineResponse

Field	Type	Label	Description
status	pipeline.Status
dry_run_outcomes	PipelineDryRunOutput	repeated	Breakdown of the changes that will be made to the environments throughout the pipeline. Only populated if dry-run is used.
revision	Revision		The capsule revision created.

ProposeRolloutRequest

Deploy request. This will deploy a number of changes which results in a new rollout.

Field	Type	Label	Description
capsule_id	string		Capsule to deploy to.
changes	Change	repeated	Changes to include in the new rollout.
project_id	string		Project in which the capsule lives.
environment_id	string		Environment in which to deploy.
message	string		Deploy message.
force_override	bool		By default, existing objects will be kept in favor of overriding them. To force the override of resources, set this flag to true. An example of this use-case is a migration step, where resource created by a previous toolchain e.g. based on Helm charts, are to be replaced and instead be created by the Rig operator. While the override is irreversible, this flag is not "sticky" and must be set by each deploy that should use this behavior.
branch_name	string

ProposeRolloutResponse

Field	Type	Label	Description
proposal	Proposal
outcome	DeployOutcome		Breakdown of the changes that this deploy would make to the system.

ProposeSetRolloutRequest

Field	Type	Label	Description
capsule_id	string		Capsule to deploy to.
changes	Change	repeated	Changes to include in the new rollout.
project_id	string		Project in which the capsule lives.
message	string		Deploy message.
force_override	bool		By default, existing objects will be kept in favor of overriding them. To force the override of resources, set this flag to true. An example of this use-case is a migration step, where resource created by a previous toolchain e.g. based on Helm charts, are to be replaced and instead be created by the Rig operator. While the override is irreversible, this flag is not "sticky" and must be set by each deploy that should use this behavior.
branch_name	string

ProposeSetRolloutResponse

Field	Type	Label	Description
proposal	SetProposal
outcome	DeploySetOutcome		Breakdown of the changes that this deploy would make to the system.

RestartInstanceRequest

RestartInstanceRequest restarts a single instance.

Field	Type	Label	Description
capsule_id	string		The capsule to restart the instance in.
instance_id	string		The instance to restart.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to restart the instance in.

RestartInstanceResponse

RestartInstanceResponse is an empty response.

StartPipelineRequest

Field	Type	Label	Description
project_id	string
capsule_id	string
pipeline_name	string
dry_run	bool
abort_current	bool		If true, and the pipeline is already running for the capsule and project, it will be aborted and a new one started.

StartPipelineResponse

Field	Type	Label	Description
status	pipeline.Status
dry_run_outcomes	PipelineDryRunOutput	repeated	Breakdown of the changes that will be made to the environments throughout the pipeline. Only populated if dry-run is used.

StopRolloutRequest

StopRolloutRequest aborts a rollout.

Field	Type	Label	Description
capsule_id	string		The capsule of the aborting rollout.
rollout_id	uint64		The rollout to stop.
project_id	string		The project in which the capsule lives.

StopRolloutResponse

StopRolloutResponse is an empty response.

StreamData

StreamData for Execute RPC.

Field	Type	Label	Description
data	bytes		Stream data.
closed	bool		If the stream is closed.

UpdateRequest

Deprecated update - This is now a no-op

Field	Type	Label	Description
capsule_id	string		The capsule to update.
updates	Update	repeated	The updates to apply to the capsule.
project_id	string

UpdateResponse

Deprecated: Empty update response.

WatchInstanceStatusesRequest

Field	Type	Label	Description
capsule_id	string		The capsule to get the instance statuses from.
project_id	string		The project in which the capsule is.
environment_id	string		The environment to get the instance statuses from.
instance_id	string		If given, only the instance with this ID will be watched.
include_deleted	bool		if true, deleted instances will be included in the response.
exclude_existing	bool		if true, existing instances will be excluded from the response.
pagination	model.Pagination		Pagination options.

WatchInstanceStatusesResponse

Field	Type	Label	Description
updated	instance.Status
deleted	string

WatchRolloutsRequest

Field	Type	Label	Description
capsule_id	string		The capsule to list rollouts for.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to list rollouts for.
rollout_id	uint64		If given only the rollout with this ID will be watched.
pagination	model.Pagination		Pagination options.

WatchRolloutsResponse

Field	Type	Label	Description
updated	Rollout

WatchStatusRequest

Field	Type	Label	Description
capsule_id	string		The capsule to watch the status of.
project_id	string		The project in which the capsule lives.
environment_id	string		The environment to watch the status of.

WatchStatusResponse

Field	Type	Label	Description
status	Status

api/v1/capsule/sidecar.proto

Sidecar

Deprecated: sidecar configuration

Field	Type	Label	Description
interfaces	SidecarInterface	repeated

SidecarInterface

Deprecated: sidecar interface configuration

Field	Type	Label	Description
port	uint32
proxy_port	uint32

config/v1alpha1/generated.proto

CapsuleMatch

Field	Type	Label	Description
namespaces	string	repeated
names	string	repeated
annotations	CapsuleMatch.AnnotationsEntry	repeated
enableForPlatform	bool

CapsuleMatch.AnnotationsEntry

Field	Type	Label	Description
key	string
value	string

CapsuleStep

Field	Type	Label	Description
plugin	string
config	string

CustomPlugin

Field	Type	Label	Description
image	string

OperatorConfig

Field	Type	Label	Description
kind	string
apiVersion	string
webhooksEnabled	bool
devModeEnabled	bool
leaderElectionEnabled	bool
pipeline	Pipeline

Pipeline

Field	Type	Label	Description
serviceAccountStep	CapsuleStep
deploymentStep	CapsuleStep
routesStep	CapsuleStep
cronJobsStep	CapsuleStep
vpaStep	CapsuleStep
serviceMonitorStep	CapsuleStep
steps	Step	repeated
customPlugins	CustomPlugin	repeated
capsuleExtensions	Pipeline.CapsuleExtensionsEntry	repeated

Pipeline.CapsuleExtensionsEntry

Field	Type	Label	Description
key	string
value	CapsuleStep

Plugin

Field	Type	Label	Description
tag	string
name	string
plugin	string
config	string

Step

Field	Type	Label	Description
tag	string
match	CapsuleMatch
plugins	Plugin	repeated
namespaces	string	repeated
capsules	string	repeated
enableForPlatform	bool

api/v1/cluster/cluster.proto

Cluster

Cluster model.

Field	Type	Label	Description
cluster_id	string		ID of the cluster.
operator_config	config.v1alpha1.OperatorConfig
operator_version	string
k8s_version	string
allocateable	model.Resources
usage	model.Resources
utilization	model.Resources

api/v1/cluster/service.proto

DockerDaemon

Docker daemon dev registry

GetConfigRequest

request for getting cluster config for an environment.

Field	Type	Label	Description
environment_id	string		The environment to get cluster config for.

GetConfigResponse

response for getting cluster config for an environment.

Field	Type	Label	Description
cluster_type	ClusterType		Type of the cluster.
docker	DockerDaemon		Docker.
registry	Registry		Registry.
ingress	bool		if true, the cluster has an ingress controller.

GetConfigsRequest

Empty Request for getting the configs of all clusters.

GetConfigsResponse

Empty Response for getting the configs of all clusters.

Field	Type	Label	Description
clusters	GetConfigResponse	repeated

ListNodePodsRequest

Field	Type	Label	Description
cluster_name	string
node_name	string

ListNodePodsResponse

Field	Type	Label	Description
pods	Pod	repeated

ListNodesRequest

Field	Type	Label	Description
cluster_id	string

ListNodesResponse

Field	Type	Label	Description
nodes	api.v1.operator.cluster.Node	repeated

ListRequest

Request for listing available clusters.

Field	Type	Label	Description
pagination	model.Pagination		Pagination options.

ListResponse

Response for listing available clusters.

Field	Type	Label	Description
clusters	Cluster	repeated	List of clusters.

Pod

Field	Type	Label	Description
pod_name	string
namespace	string
project_name	string
environment_name	string
capsule_name	string

Registry

Registry dev registry

Field	Type	Label	Description
host	string

ClusterType

Cluster type - Docker or kubernetes.

Name	Number	Description
CLUSTER_TYPE_UNSPECIFIED	0
CLUSTER_TYPE_DOCKER	1
CLUSTER_TYPE_KUBERNETES	2

api/v1/environment/environment.proto

Environment

Environment model.

Field	Type	Label	Description
environment_id	string		ID of the environment.
operator_version	string		The version of the Rig-operator CRD for this environment.
cluster_id	string		ID of the backing cluster.
namespace_template	string		Namespace template is used to generate the namespace name when configuring resources. Default is to set the namespace equal to the project name.
ephemeral	bool		If true, the environment is deletable by developer users, and can be deleted with capsules running.
active_projects	string	repeated	Active Projects. These projects can deploy capsules to this environment. This is overridden by a true the global flag.
global	bool		If true, the environment is available to all projects.

Update

Field	Type	Label	Description
add_project	string
remove_project	string
set_global	bool

api/v1/environment/revision.proto

Revision

Field	Type	Label	Description
spec	platform.v1.Environment
metadata	model.RevisionMetadata

api/v1/environment/service.proto

CreateRequest

Field	Type	Label	Description
environment_id	string
initializers	Update	repeated
cluster_id	string
namespace_template	string		Namespace template is used to generate the namespace name when configuring resources. Default is to set the namespace equal to the project name. Default value is: {{ .Project.Name }} Valid template properties are: .Project.Name - name of the project .Environment.Name - name of the environment.
ephemeral	bool		If true, the environment will be marked as ephemeral. It is possible for developers to create ephemeral environments.

CreateResponse

DeleteRequest

Field	Type	Label	Description
environment_id	string
force	bool		Force delete all running capsules in the enviornment. If false, the request will be aborted if any capsules is running in the environment.

DeleteResponse

GetNamespacesRequest

Field	Type	Label	Description
project_envs	ProjectEnvironment	repeated

GetNamespacesResponse

Field	Type	Label	Description
namespaces	ProjectEnvironmentNamespace	repeated

GetRequest

Field	Type	Label	Description
environment_id	string

GetResponse

Field	Type	Label	Description
environment	Environment

ListRequest

Request for listing available environments.

Field	Type	Label	Description
pagination	model.Pagination		Pagination options.
exclude_ephemeral	bool		Exclude ephemeral environments in the list.
project_filter	string		Get environments for a specific project.

ListResponse

Response for listing available environments.

Field	Type	Label	Description
environments	Environment	repeated	List of environments.
platform_version	string		The version of the Rig-platform.

ProjectEnvironment

Field	Type	Label	Description
project_id	string
environment_id	string

ProjectEnvironmentNamespace

Field	Type	Label	Description
project_id	string
environment_id	string
namespace	string

UpdateRequest

Field	Type	Label	Description
environment_id	string
updates	Update	repeated

UpdateResponse

model/metadata.proto

Metadata

Generic metadata model.

Field	Type	Label	Description
key	string		Key of the metadata.
value	bytes		Value of the metadata.

api/v1/group/group.proto

Group

Group is a named collection of users and service accounts with optional metadata.

Field	Type	Label	Description
group_id	string		Unique name of the group.
num_members	uint64		Number of members.
metadata	Group.MetadataEntry	repeated	Metadata of the group.
created_at	google.protobuf.Timestamp		Creation time of the group.
updated_at	google.protobuf.Timestamp		Last update time of the group.

Group.MetadataEntry

Field	Type	Label	Description
key	string
value	bytes

MemberID

MemberID is a union of service account id and user id.

Field	Type	Label	Description
service_account_id	string		ID of a service account.
user_id	string		ID of a user.

Update

An update msg for a group.

Field	Type	Label	Description
group_id	string		Update the unique group name.
set_metadata	model.Metadata		Update or create a metadata entry.
delete_metadata_key	string		Delete a metadata entry.

api/v1/group/service.proto

AddMemberRequest

Request for adding one or more members to a group.

Field	Type	Label	Description
group_id	string		The group to add members to.
member_ids	MemberID	repeated	The members to add.

AddMemberResponse

Empty response for adding one or more members to a group.

CreateRequest

The request of a Groups.Create RPC.

Field	Type	Label	Description
initializers	Update	repeated	The group to create.

CreateResponse

The response of a Groups.Create RPC.

Field	Type	Label	Description
group	Group		The created group.

DeleteRequest

The request of a Group.Delete RPC.

Field	Type	Label	Description
group_id	string		The group to delete.

DeleteResponse

The response of a Group.Delete RPC.

GetRequest

The request of a Groups.Get RPC.

Field	Type	Label	Description
group_id	string		The group id.

GetResponse

The response of a Groups.Get RPC

Field	Type	Label	Description
group	Group		The group.

ListGroupsForMemberRequest

Request for listing the groups a member is in.

Field	Type	Label	Description
member_id	MemberID		The member to list groups for.
pagination	model.Pagination		Pagination options.

ListGroupsForMemberResponse

Response for listing the groups a member is in.

Field	Type	Label	Description
groups	Group	repeated	The groups the member is in.
total	uint64		The total amount of groups the member is in.

ListMembersRequest

Reqyest for listing members of a group.

Field	Type	Label	Description
group_id	string		The group to list members of.
pagination	model.Pagination		Pagination options.

ListMembersResponse

Response for listing members of a group.

Field	Type	Label	Description
members	model.MemberEntry	repeated	The members in the group.
total	uint64		The total amount of members in the group.

ListRequest

The request of a Groups.List RPC.

Field	Type	Label	Description
pagination	model.Pagination		Pagination options.
search	string		Search string.

ListResponse

The response of a Groups.List RPC.

Field	Type	Label	Description
groups	Group	repeated	list of groups.
total	uint64		total amount of groups.

RemoveMemberRequest

Request for removing a member from a group.

Field	Type	Label	Description
group_id	string		The group to remove the member from.
member_id	MemberID		The member to remove.

RemoveMemberResponse

Empty response for removing a member from a group.

UpdateRequest

The request of a Groups.Update RPC.

Field	Type	Label	Description
updates	Update	repeated	The updates to apply.
group_id	string		The group id.

UpdateResponse

The response of a Groups.Update RPC.

api/v1/image/service.proto

AddRequest

Request to add a new image in a capsule.

Field	Type	Label	Description
capsule_id	string		Capsule to add the image in.
image	string		Container image to add the image from.
digest	string		Digest of the image.
origin	api.v1.capsule.Origin		Origin of the image
labels	AddRequest.LabelsEntry	repeated	Meta data to attach to the image.
skip_image_check	bool		if true skip check if image exists.
project_id	string		Project ID.

AddRequest.LabelsEntry

Field	Type	Label	Description
key	string
value	string

AddResponse

Response to add a new image in a capsule.

Field	Type	Label	Description
image_id	string		ID of the image.
added_new_image	bool		True if a new image was added, false if the image already existed.

DeleteRequest

Request to delete a image.

Field	Type	Label	Description
capsule_id	string		Capsule to delete the image from.
image_id	string		Image to delete.
project_id	string		Project ID.

DeleteResponse

Empty response to delete a image.

GetImageInfoRequest

Request to get information about an image.

Field	Type	Label	Description
image	string		The image to get information about.

GetImageInfoResponse

Reponse to GetImageInfo request, containing information about an image.

Field	Type	Label	Description
image_id	ImageId		Image ID.
image_string	string		Image from the request.
created_at	google.protobuf.Timestamp		When the image was created.
origin	api.v1.capsule.Origin		Origin of the image.

GetRepositoryInfoRequest

Get repository information request.

Field	Type	Label	Description
registry	string		Docker Registry
repository	string		Docker Repository

GetRepositoryInfoResponse

Get repository information response.

Field	Type	Label	Description
tags	Tag	repeated	Image Tags in the repository.

GetRequest

Request to get a image.

Field	Type	Label	Description
capsule_id	string		Capsule to get the image from.
image_id	string		Image to get.
project_id	string		Project ID.

GetResponse

Response to get a image.

Field	Type	Label	Description
image	api.v1.capsule.Image		The image to retrieve

ImageId

A collection of image properties that uniquely identifies an image.

Field	Type	Label	Description
registry	string		Docker Registry.
repository	string		Docker Repository.
tag	string		Tag of the image.
digest	string		Digest of the image.

ListRequest

Request to list images.

Field	Type	Label	Description
capsule_id	string		Capsule to list images in.
pagination	model.Pagination		Pagination options.
project_id	string		Project ID.

ListResponse

Reponse to list images.

Field	Type	Label	Description
images	api.v1.capsule.Image	repeated	Images in the capsule.
total	uint64		Total number of images in the capsule.

Tag

A docker image tag.

Field	Type	Label	Description
tag	string		Tag of the image.
image_created_at	google.protobuf.Timestamp		When the image was created.

api/v1/issue/service.proto

Filter

Field	Type	Label	Description
project	string
environment	string
capsule	string
level	Level
include_closed	bool
include_stale	bool

GetIssuesRequest

Field	Type	Label	Description
pagination	model.Pagination
filter	Filter

GetIssuesResponse

Field	Type	Label	Description
issues	Issue	repeated
total	uint64

api/v1/metrics/metrics.proto

Keys

Field	Type	Label	Description
project	bool
environment	bool
capsule	bool
metric_name	bool
cluster	string
all	bool

Metric

Field	Type	Label	Description
timestamp	google.protobuf.Timestamp
value	double

MetricFull

Field	Type	Label	Description
metric	Metric
tags	Tags

Tags

Field	Type	Label	Description
project	string
environment	string
capsule	string
metric_name	string
cluster	string

api/v1/metrics/service.proto

Aggregation

Field	Type	Label	Description
aggregator	Aggregator
bucket_size	google.protobuf.Duration

Expression

Field	Type	Label	Description
leaf	Expression.Leaf
operation	Expression.Operation
constant	Expression.Constant
with_default	Expression.WithDefault
sum	Expression.Sum

Expression.Constant

Field	Type	Label	Description
constant	double

Expression.Leaf

Field	Type	Label	Description
tags	Tags
aggregator	Aggregator

Expression.Operation

Field	Type	Label	Description
left	Expression
right	Expression
operation	BinOp
on	Keys
ignore	Keys

Expression.Sum

Field	Type	Label	Description
on	Keys
ignore	Keys
expression	Expression

Expression.WithDefault

Field	Type	Label	Description
expression	Expression
default	double

GetMetricsExpressionRequest

Field	Type	Label	Description
expression	Expression
from	google.protobuf.Timestamp
to	google.protobuf.Timestamp
bucket_size	google.protobuf.Duration

GetMetricsExpressionResponse

Field	Type	Label	Description
metrics	Metric	repeated

GetMetricsManyRequest

Field	Type	Label	Description
tags	Tags	repeated
from	google.protobuf.Timestamp
to	google.protobuf.Timestamp
aggregation	Aggregation

GetMetricsManyResponse

Field	Type	Label	Description
metrics	MetricFull	repeated

GetMetricsRequest

Field	Type	Label	Description
tags	Tags
from	google.protobuf.Timestamp
to	google.protobuf.Timestamp
aggregation	Aggregation

GetMetricsResponse

Field	Type	Label	Description
metrics	Metric	repeated

Aggregator

Name	Number	Description
AGGREGATOR_UNSPECIFIED	0
AGGREGATOR_AVG	1
AGGREGATOR_MIN	2
AGGREGATOR_MAX	3
AGGREGATOR_SUM	4

BinOp

Name	Number	Description
BINOP_UNSPECIFIED	0
BINOP_ADD	1
BINOP_SUB	2
BINOP_MULT	3
BINOP_DIV	4

model/notification.proto

NotificationNotifier

Field	Type	Label	Description
target	NotificationTarget
topics	NotificationTopic	repeated
environments	EnvironmentFilter

NotificationTarget

Field	Type	Label	Description
slack	NotificationTarget.SlackTarget
email	NotificationTarget.EmailTarget

NotificationTarget.EmailTarget

Field	Type	Label	Description
id	string
from_email	string
to_emails	string	repeated

NotificationTarget.SlackTarget

Field	Type	Label	Description
workspace	string
channel_id	string

NotificationTopic

Name	Number	Description
NOTIFICATION_TOPIC_UNSPECIFIED	0
NOTIFICATION_TOPIC_ROLLOUT	1
NOTIFICATION_TOPIC_ISSUE	2
NOTIFICATION_TOPIC_PROJECT	3
NOTIFICATION_TOPIC_ENVIRONMENT	4
NOTIFICATION_TOPIC_CAPSULE	5
NOTIFICATION_TOPIC_USER	6

api/v1/project/project.proto

NotificationNotifiers

Field	Type	Label	Description
disabled	bool		If the notifiers are disabled, notifiers from parent are not inherited even if these notifiers at this level are empty.
notifiers	model.NotificationNotifier	repeated

Project

The top most model that capsules etc belong to.

Field	Type	Label	Description
project_id	string		The unique id of the project.
created_at	google.protobuf.Timestamp		When the project was created.
updated_at	google.protobuf.Timestamp		When the project was last updated.
installation_id	string		The installation id of the project.
git_store	model.GitStore
notifiers	NotificationNotifiers		The notifiers for the project.
pipelines	model.Pipeline	repeated	Environment pipelines for the project

Update

Update msg for a project.

Field	Type	Label	Description
set_git_store	model.GitStore		Set the git store.
notifiers	NotificationNotifiers		Set the notifiers.
pipelines	Update.Pipelines		Set the pipelines

Update.Pipelines

Field	Type	Label	Description
pipelines	model.Pipeline	repeated	The pipelines to update.

api/v1/project/revision.proto

Revision

Field	Type	Label	Description
spec	platform.v1.Project
metadata	model.RevisionMetadata

api/v1/project/service.proto

CreateRequest

The request to create a project.

Field	Type	Label	Description
initializers	Update	repeated	The initializers of the project.
project_id	string		ID of the project to create.

CreateResponse

The response to Create a project.

Field	Type	Label	Description
project	Project		The created project.

DeleteRequest

Request to delete a project.

Field	Type	Label	Description
project_id	string		Id of the project to delete

DeleteResponse

Empty response for deleting a project.

GetCustomObjectMetricsRequest

Request to get custom metrics for a project and environment.

Field	Type	Label	Description
object_reference	model.ObjectReference		The object to get metrics for.
project_id	string		The project to get metrics for.
environment_id	string		The environment to get metrics for.

GetCustomObjectMetricsResponse

Response for getting custom metrics for a project and environment.

Field	Type	Label	Description
metrics	model.Metric	repeated	The metrics for the given object.
project_id	string		The project the metrics are for.
environment_id	string		The environment the metrics are for.

GetEffectiveGitSettingsRequest

Field	Type	Label	Description
project_id	string

GetEffectiveGitSettingsResponse

Field	Type	Label	Description
git	model.GitStore

GetEffectiveNotificationSettingsRequest

Field	Type	Label	Description
project_id	string

GetEffectiveNotificationSettingsResponse

Field	Type	Label	Description
notifiers	model.NotificationNotifier	repeated

GetEffectivePipelineSettingsRequest

Field	Type	Label	Description
project_id	string
capsule_id	string		If set, the response will contain information as to whether the pipeline is already running for that capsule.

GetEffectivePipelineSettingsResponse

Field	Type	Label	Description
pipelines	GetEffectivePipelineSettingsResponse.Pipeline	repeated

GetEffectivePipelineSettingsResponse.Pipeline

Field	Type	Label	Description
pipeline	model.Pipeline
already_running	bool

GetObjectsByKindRequest

Request to get all objects of a given kind in a project and environment.

Field	Type	Label	Description
kind	string		The kind of the objects to get.
api_version	string		The api version of the objects to get.
project_id	string		The project to get the objects for.
environment_id	string		The environment to get the objects for.

GetObjectsByKindResponse

Response for getting all objects of a given kind in a project and environment.

Field	Type	Label	Description
objects	KubernetesObject	repeated	The objects of the given kind.

GetRequest

Request for getting a project.

Field	Type	Label	Description
project_id	string		The project to get.

GetResponse

Response for getting a project.

Field	Type	Label	Description
project	Project		The retrieved project.

KubernetesObject

Model of a kubernetes object.

Field	Type	Label	Description
kind	string		Type / kind of the object.
name	string		Name of the object.

ListRequest

Request for listing projects.

Field	Type	Label	Description
pagination	model.Pagination		Pagination options.

ListResponse

Response for listing projects.

Field	Type	Label	Description
projects	Project	repeated	The retrieved projects.
total	int64		Total number of projects.

PublicKeyRequest

Request to get the public key of a project.

Field	Type	Label	Description
project_id	string		The project to get the key from.

PublicKeyResponse

Response for getting a projects public key.

Field	Type	Label	Description
public_key	string		the retrieved public key.

UpdateRequest

Update the name field of a project.

Field	Type	Label	Description
updates	Update	repeated	the updates to apply.
project_id	string		The project to update.

UpdateResponse

Empty response for updating a project.

api/v1/project/settings/settings.proto

AddDockerRegistry

Message for adding a docker registry

Field	Type	Label	Description
host	string		The host of the docker registry.
auth	string		authentication string to the docker registry.
credentials	DockerRegistryCredentials		Credentials for the docker registry.

DockerRegistry

Docker registry.

Field	Type	Label	Description
secret_id	string		The secret id of the docker registry.
host	string		Host of the docker registry/

DockerRegistryCredentials

Credentials for a docker registry.

Field	Type	Label	Description
username	string		Username for the docker registry.
password	string		Password for the docker registry.
email	string		Email for the docker registry.

Settings

Project wide settings.

Field	Type	Label	Description
docker_registries	DockerRegistry	repeated	Docker registries for images.

Update

Update message for project settings.

Field	Type	Label	Description
add_docker_registry	AddDockerRegistry		Add a docker registry.
delete_docker_registry	string		Delete a docker registry.

api/v1/project/settings/service.proto

GetLicenseInfoRequest

Request to get the license information of the Rig installation.

GetLicenseInfoResponse

Response for getting the license information of the Rig installation.

// The plan of the rig installation. api.v1.project.Plan plan = 1; // The expiration date of the license. google.protobuf.Timestamp expires_at = 2;

GetSettingsRequest

Empty get settings request

GetSettingsResponse

Response for getting settings for the project.

Field	Type	Label	Description
settings	Settings		The settings.

UpdateSettingsRequest

Request for updating settings for a project.

Field	Type	Label	Description
updates	Update	repeated	The updates to apply.

UpdateSettingsResponse

Empty response for updating a project's settings.

api/v1/role/role.proto

EntityID

EntityID is a oneof type that can be used to represent a user, service account or group.

Field	Type	Label	Description
user_id	string		User entity.
service_account_id	string		Service account entity.
group_id	string		Group entity.

Permission

A permission that is granted to a role.

Field	Type	Label	Description
action	string		The action that is action permission to perform.
scope	Scope		The scope in which the action can be performed.

Role

Role model for Role based access control.

Field	Type	Label	Description
role_id	string		Unique ID of the role.
permissions	Permission	repeated	The permissions granted to the role.
metadata	Role.MetadataEntry	repeated	Metadata associated with the role.
created_at	google.protobuf.Timestamp		Timestamp when the role was created.
updated_at	google.protobuf.Timestamp		Timestamp when the role was last updated.

Role.MetadataEntry

Field	Type	Label	Description
key	string
value	bytes

Scope

Scope for permissions.

Field	Type	Label	Description
resource	string		The resource on which the action can be performed. This consists of a type, and an optional ID. fx. "user/*", "group/admin"
environment	string		The environment in which the action can be performed. This can be a wildcard.
project	string		The project in which the action can be performed. This can be a wildcard.

Update

Update message to update a field of a role.

Field	Type	Label	Description
add_permission	Permission		Adding a permission to the role.
remove_permission	Permission		Removing a permission from the role.
set_metadata	model.Metadata		Update or create a metadata field on the role.
delete_metadata_key	string		Delete a metadata field on the role.

api/v1/role/service.proto

AssignRequest

Assign a role to an entity.

Field	Type	Label	Description
role_id	string		The role to assign.
entity_id	EntityID		The entity to assign the role to.

AssignResponse

Empty response of assigning a role to an entity.

CreateRequest

Request to create a role.

Field	Type	Label	Description
role_id	string		The id / name of the role to create.
permissions	Permission	repeated	The permissions to assign to the role.

CreateResponse

Response to create a role.

Field	Type	Label	Description
role	Role		The created role.

DeleteRequest

Request to delete a role.

Field	Type	Label	Description
role_id	string		The id / name of the role to delete.

DeleteResponse

Empty Response to delete a role.

GetRequest

Request to retrieve a role.

Field	Type	Label	Description
role_id	string		The role to retrieve.

GetResponse

Response to getting a role.

Field	Type	Label	Description
role	Role		The retrieved role.

ListAssigneesRequest

Field	Type	Label	Description
role_id	string		The role to list assignees for.
pagination	model.Pagination		Pagination options.

ListAssigneesResponse

Field	Type	Label	Description
entity_ids	string	repeated	The assignees of the role.

ListForEntityRequest

Field	Type	Label	Description
entity_id	EntityID		The entity to list roles for.
pagination	model.Pagination		Pagination options.

ListForEntityResponse

Field	Type	Label	Description
role_ids	string	repeated	The roles assigned to the entity.

ListRequest

Request to list roles.

Field	Type	Label	Description
pagination	model.Pagination		Pagination options.

ListResponse

Response to list roles.

Field	Type	Label	Description
roles	Role	repeated	The retrieved roles.

RevokeRequest

Revoke a role from an entity.

Field	Type	Label	Description
role_id	string		The role to revoke.
entity_id	EntityID		The entity to revoke the role from.

RevokeResponse

Empty response for revoking a role.

UpdateRequest

Request to update a role.

Field	Type	Label	Description
role_id	string		the role to update.
updates	Update	repeated	The updates to apply to the role.

UpdateResponse

Empty update response.

api/v1/service_account/service_account.proto

ServiceAccount

Service account model.

Field	Type	Label	Description
name	string		Unique name of the service account.
created_at	google.protobuf.Timestamp		Creation date.
created_by	model.Author		Author of the service account.
managed	bool		Whether the service account is managed by the system.
group_ids	string	repeated	List of group IDs the service account belongs to.

api/v1/service_account/service.proto

CreateRequest

Request o create a service account.

Field	Type	Label	Description
name	string		Name of the service account to create.
initial_group_id	string		If set, the service-account will be added to this group upon creation.

CreateResponse

Response of creating a service account.

Field	Type	Label	Description
service_account	ServiceAccount		The created service account.
client_id	string		The client id of the service account.
client_secret	string		The client secret of the service account.

DeleteRequest

Request to delete a service account.

Field	Type	Label	Description
service_account_id	string		The id of the service account to delete.

DeleteResponse

Empty response for deleting a service account.

ListRequest

Request to list service accounts.

ListResponse

Response for listing service accounts.

Field	Type	Label	Description
service_accounts	model.ServiceAccountEntry	repeated	the retrieved service accounts.

api/v1/settings/configuration.proto

Client

Field	Type	Label	Description
slack	Slack
email	EmailClient	repeated
git	Git	repeated

Configuration

Platform wide static configuration.

Field	Type	Label	Description
client	Client
docker_registries	string	repeated
default_email	EmailClient
capsule_extensions	Configuration.CapsuleExtensionsEntry	repeated

Configuration.CapsuleExtensionsEntry

Field	Type	Label	Description
key	string
value	Extension

EmailClient

Field	Type	Label	Description
id	string
type	EmailType

Extension

Field	Type	Label	Description
json_schema	string		The schema of the extension, expressed as a json-schema (https://json-schema.org/).

Git

Field	Type	Label	Description
url	string		URL is a exact match for the repo-url this auth can be used for.
url_prefix	string		URLPrefix is a prefix-match for the repo urls this auth can be used for.

Slack

Field	Type	Label	Description
workspace	Slack.Workspace	repeated

Slack.Workspace

Field	Type	Label	Description
name	string

EmailType

Name	Number	Description
EMAIL_TYPE_UNSPECIFIED	0
EMAIL_TYPE_MAILJET	1
EMAIL_TYPE_SMTP	2

api/v1/settings/settings.proto

Settings

Platform wide settings.

Field	Type	Label	Description
notification_notifiers	model.NotificationNotifier	repeated
git_store	model.GitStore
pipelines	model.Pipeline	repeated

Update

Update message for platform settings.

Field	Type	Label	Description
set_notification_notifiers	Update.SetNotificationNotifiers		Set the notification notifiers.
set_git_store	model.GitStore		Set the git store.
set_pipelines	Update.SetPipelines		Set the pipelines.

Update.SetNotificationNotifiers

Field	Type	Label	Description
notifiers	model.NotificationNotifier	repeated

Update.SetPipelines

Field	Type	Label	Description
pipelines	model.Pipeline	repeated

Plan

The plan for a rig installation

Name	Number	Description
PLAN_UNSPECIFIED	0	Unspecified / unactivated plan.
PLAN_FREE	1	Free tier.
PLAN_TEAM	2	Team / Pro tier.
PLAN_ENTERPRISE	3	Enterprise tier.

model/id.proto

CapsuleID

Field	Type	Label	Description
project	string
environment	string
capsule	string

CapsuleSetID

Field	Type	Label	Description
project	string
capsule	string

api/v1/settings/service.proto

GetConfigurationRequest

GetConfigurationResponse

Field	Type	Label	Description
configuration	Configuration

GetGitStoreStatusRequest

GetGitStoreStatusResponse

Field	Type	Label	Description
repositories	GetGitStoreStatusResponse.RepoGitStatus	repeated
capsules	GetGitStoreStatusResponse.CapsuleStatus	repeated
capsule_sets	GetGitStoreStatusResponse.CapsuleSetStatus	repeated
errors	GetGitStoreStatusResponse.CallbackErr	repeated

GetGitStoreStatusResponse.CallbackErr

Field	Type	Label	Description
err	string
timestamp	google.protobuf.Timestamp

GetGitStoreStatusResponse.CapsuleSetStatus

Field	Type	Label	Description
capsule	model.CapsuleSetID
status	model.GitStatus

GetGitStoreStatusResponse.CapsuleStatus

Field	Type	Label	Description
capsule	model.CapsuleID
status	model.GitStatus

GetGitStoreStatusResponse.RepoGitStatus

Field	Type	Label	Description
repo	model.RepoBranch
status	model.GitStatus

GetLicenseInfoRequest

Request to get the license information of the Rig installation.

GetLicenseInfoResponse

Response for getting the license information of the Rig installation.

Field	Type	Label	Description
expires_at	google.protobuf.Timestamp		The expiration date of the license.
user_limit	int32		The number of users allowed in the installation.

GetSettingsRequest

GetSettingsResponse

Field	Type	Label	Description
settings	Settings

UpdateSettingsRequest

Field	Type	Label	Description
updates	Update	repeated

UpdateSettingsResponse

api/v1/tunnel/service.proto

TunnelClose

Field	Type	Label	Description
tunnel_id	uint64
code	uint32
message	string

TunnelData

Field	Type	Label	Description
tunnel_id	uint64
data	bytes

TunnelInfo

Field	Type	Label	Description
tunnel_id	uint64
port	uint32

TunnelMessage

Field	Type	Label	Description
new_tunnel	TunnelInfo
data	TunnelData
close	TunnelClose

TunnelRequest

Field	Type	Label	Description
message	TunnelMessage

TunnelResponse

Field	Type	Label	Description
message	TunnelMessage

api/v1/user/user.proto

AuthMethod

how a user is authenticated.

Field	Type	Label	Description
login_type	model.LoginType		Login type of the user.

Profile

User profile

Field	Type	Label	Description
first_name	string		First name of the user.
last_name	string		Last name of the user.

Session

A user's sessions.

Field	Type	Label	Description
auth_method	AuthMethod		how the user is authenticated.
is_invalidated	bool		if the session is invalidated
created_at	google.protobuf.Timestamp		Timestamp when the session was created.
invalidated_at	google.protobuf.Timestamp		Timestamp when the session was invalidated.
expires_at	google.protobuf.Timestamp		Timestamp when the session expires.
renewed_at	google.protobuf.Timestamp		Timestamp when the session was renewed.
country	string		Country of the session.
postal_code	int32		Postal code of the session.

SessionEntry

Session entry

Field	Type	Label	Description
session_id	string		Session ID of the session.
session	Session		Session of the session.

Update

Update message to update a user.

Field	Type	Label	Description
email	string		Email of the user.
username	string		Username of the user.
phone_number	string		Deprecated: text is not supported - Phone number of the user.
password	string		Password of the user.
profile	Profile		Profile of the user.
is_email_verified	bool		Whether the user's email is verified.
is_phone_verified	bool		Deprecated: text is not supported - Whether the user's phone number is verified.
reset_sessions	Update.ResetSessions		Reset sessions of the user.
set_metadata	model.Metadata		Set metadata of the user.
delete_metadata_key	string		Delete metadata of the user.
hashed_password	model.HashingInstance		Hashed password of the user.

Update.ResetSessions

if sessions are reset, all sessions will be invalidated and a new session will be created.

User

The user model.

Field	Type	Label	Description
user_id	string		User ID of the user.
user_info	model.UserInfo		User info of the user.
profile	Profile		Profile of the user.
updated_at	google.protobuf.Timestamp		Timestamp when the user was last updated.
register_info	model.RegisterInfo		Register info of the user.
is_phone_verified	bool		Deprecated: text is not supported - Whether the user's phone number is verified.
is_email_verified	bool		Whether the user's email is verified.
new_sessions_since	google.protobuf.Timestamp		Timestamp when the user last created a new session.
metadata	User.MetadataEntry	repeated	Metadata of the user.

User.MetadataEntry

Field	Type	Label	Description
key	string
value	bytes

VerificationCode

short-lived verification code.

Field	Type	Label	Description
code	model.HashingInstance		Hashed verification code.
sent_at	google.protobuf.Timestamp		Timestamp when the verification code was sent.
expires_at	google.protobuf.Timestamp		Timestamp when the verification code expires.
attempts	int32		Number of attempts to verify the code.
last_attempt	google.protobuf.Timestamp		Timestamp of the last attempt to verify the code.
type	VerificationType		Type of verification code.
user_id	string		User ID of the user who the code was sent to.

VerificationType

Type of verification code

Name	Number	Description
VERIFICATION_TYPE_UNSPECIFIED	0	Default value
VERIFICATION_TYPE_EMAIL	1	Email verification code.
VERIFICATION_TYPE_TEXT	2	Deprecated: text is not supported - text verification code.
VERIFICATION_TYPE_RESET_PASSWORD	3	reset password verification code.

api/v1/user/service.proto

CreateRequest

The request to create a user.

Field	Type	Label	Description
initializers	Update	repeated	Initial fields to set.
initial_group_id	string		If set, the user will be added to this group upon creation.

CreateResponse

The response of creating a user.

Field	Type	Label	Description
user	User		The created user.

DeleteRequest

Request for deleting a user.

Field	Type	Label	Description
user_id	string		The user identifier to fetch the user.

DeleteResponse

Empty response for deleting a user.

GetByIdentifierRequest

Request to get a user by an identifier.

Field	Type	Label	Description
identifier	model.UserIdentifier		The identifier to lookup.

GetByIdentifierResponse

Response to get a user by an identifier.

Field	Type	Label	Description
user	User		The user.

GetRequest

Get request for retrieving a user.

Field	Type	Label	Description
user_id	string		The user identifier to fetch the user.

GetResponse

The response of getting a user.

Field	Type	Label	Description
user	User		The retrieved user.

ListRequest

Request for listing users.

Field	Type	Label	Description
pagination	model.Pagination		Pagination options.
search	string		Search string.

ListResponse

Response for listing users.

Field	Type	Label	Description
users	model.UserEntry	repeated	The users returned.
total	uint64		total number of users.

ListSessionsRequest

Request to list a users login sessions.

Field	Type	Label	Description
user_id	string		The user to retrieve sessions for.
pagination	model.Pagination		Pagination options.

ListSessionsResponse

The response of listing a users login sessions.

Field	Type	Label	Description
sessions	SessionEntry	repeated	The retrieved sessions.
total	uint64		The total number of sessions.

UpdateRequest

The request of updating a user.

Field	Type	Label	Description
user_id	string		The user identifier of the user to update.
updates	Update	repeated	The updates to apply to the user.

UpdateResponse

Empty update response.

model/credentials.proto

ProviderCredentials

Generic credentials model.

Field	Type	Label	Description
public_key	string		Public key.
private_key	string		Private key.

api/v1/user/settings/settings.proto

AuthMethod

Message that tells how the user was authenticated.

Field	Type	Label	Description
login_type	model.LoginType

DefaultInstance

Default email provider instance.

EmailInstance

Type of email instance in a provider.

Field	Type	Label	Description
default	DefaultInstance		default from platform config.
mailjet	MailjetInstance		Mailjet instance.
smtp	SmtpInstance		SMTP instance.

EmailProvider

The email provider.

Field	Type	Label	Description
from	string		The email-address that the provider sends emails from.
credentials	model.ProviderCredentials		The credentials for the provider.
instance	EmailInstance		The instance of the provider.

EmailProviderEntry

an entry model for the email provider.

Field	Type	Label	Description
from	string		The email-address that the provider sends emails from.
client_id	string		The client id for the provider.
secret_id	string		The secret id for the provider.
instance	EmailInstance		The instance of the provider.

MailjetInstance

Mailjet email rpvoider instance.

RegisterMethod

Message that tells how the user was registered / created.

Field	Type	Label	Description
system	RegisterMethod.System		The user was created by the system.
signup	RegisterMethod.Signup		The user was self-registered with a login-type.

RegisterMethod.Signup

The user was self-registered with a login-type.

Field	Type	Label	Description
login_type	model.LoginType		The login type used to register.

RegisterMethod.System

The user was created by the system.

Settings

The users settings configuration. Settings of everything that has to do with users.

Field	Type	Label	Description
allow_register	bool		If true, users can self register.
is_verified_email_required	bool		If true, users must be verified via email to login.
is_verified_phone_required	bool		Deprecated: Text is not supported - If true, users must be verified via phone to login.
access_token_ttl	google.protobuf.Duration		Access token Time to Live.
refresh_token_ttl	google.protobuf.Duration		Refresh token Time to Live.
verification_code_ttl	google.protobuf.Duration		Verification code Time to Live.
password_hashing	model.HashingConfig		The hashing config used to hash passwords.
login_mechanisms	model.LoginType	repeated	The allowed login mechanisms.
send_welcome_mail	bool		If true, send a welcome email to new users.
email_provider	EmailProviderEntry		The email provider.
text_provider	TextProviderEntry		Deprecated: Text is not supported - The text provider.
templates	Templates		The templates used for sending emails and texts.

SmtpInstance

SMTP email provider instance.

Field	Type	Label	Description
host	string		Host of the smtp server.
port	int64		Port of the smtp server.

Template

A generic template model for sending emails and texts.

Field	Type	Label	Description
body	string		The body of the template.
subject	string		The subject of the template.
type	TemplateType		The type of the template.
format	string	repeated	The format of the template.

Templates

Field	Type	Label	Description
welcome_email	Template		The welcome email template.
welcome_text	Template		Deprecated: Text is not supported - The welcome text template.
reset_password_email	Template		The reset password email template.
reset_password_text	Template		Deprecated: Text is not supported - The reset password text template.
verify_email	Template		The email verification template.
verify_phone_number	Template		Deprecated: Text is not supported - The text verification template.

TextInstance

Deprecated: Text is not supported - Type of text instance in a provider.

Field	Type	Label	Description
default	DefaultInstance		default from platform config.
twilio	TwilioInstance		Twilio instance.

TextProvider

Deprecated: Text is not supported - The text provider.

Field	Type	Label	Description
from	string		The phone number that the provider sends texts from.
credentials	model.ProviderCredentials		The credentials for the provider.
instance	TextInstance		The instance of the provider.

TextProviderEntry

Deprecated: Text is not supported - An entry model for the text provider.

Field	Type	Label	Description
from	string		The phone number that the provider sends texts from.
client_id	string		The client id for the provider.
secret_id	string		The secret id for the provider.
instance	TextInstance		The instance of the provider.

TwilioInstance

Deprecated: Text is not supported - Default text provider instance.

Update

Update message for updating users settings.

Field	Type	Label	Description
allow_register	bool		If true, users can self register.
is_verified_email_required	bool		If true, users must be verified via email to login.
is_verified_phone_required	bool		If true, users must be verified via phone to login.
access_token_ttl	google.protobuf.Duration		Access token Time to Live.
refresh_token_ttl	google.protobuf.Duration		Refresh token Time to Live.
verification_code_ttl	google.protobuf.Duration		Verification code Time to Live.
password_hashing	model.HashingConfig		The hashing config used to hash passwords.
login_mechanisms	Update.LoginMechanisms		The allowed login mechanisms.
email_provider	EmailProvider		The email provider.
text_provider	TextProvider		The text provider.
template	Template		The templates used for sending emails and texts.

Update.LoginMechanisms

The allowed login mechanisms

Field	Type	Label	Description
login_mechanisms	model.LoginType	repeated

TemplateType

The different template types.

Name	Number	Description
TEMPLATE_TYPE_UNSPECIFIED	0	Unspecified template type.
TEMPLATE_TYPE_WELCOME_EMAIL	1	The welcome email template.
TEMPLATE_TYPE_EMAIL_VERIFICATION	2	The email verification template.
TEMPLATE_TYPE_EMAIL_RESET_PASSWORD	3	The reset password email template.
TEMPLATE_TYPE_WELCOME_TEXT	4	Deprecated: Text is not supported - The welcome text template.
TEMPLATE_TYPE_TEXT_VERIFICATION	5	Deprecated: Text is not supported - The text verification template.
TEMPLATE_TYPE_TEXT_RESET_PASSWORD	6	Deprecated: Text is not supported - The reset password text template.

api/v1/user/settings/service.proto

GetSettingsRequest

Request for getting users settings for the Rig project.

GetSettingsResponse

Response for getting users settings for the Rig project.

Field	Type	Label	Description
settings	Settings		The users settings.

UpdateSettingsRequest

Request for updating users settings for the Rig project.

Field	Type	Label	Description
settings	Update	repeated	The updates to apply to the users settings.

UpdateSettingsResponse

Empty response for updating users settings for the Rig project.

k8s.io/apimachinery/pkg/api/resource/generated.proto

Quantity

Field	Type	Label	Description
string	string

k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto

TypeMeta

Field	Type	Label	Description
kind	string
aPIVersion	string