package api.v1.capsule
Get desktop application:
View/edit binary Protocol Buffers messages
service Service
service.proto:25The service to manage capsules.
rpc Create (, )
service.proto:27Create a new capsule.
message
service.proto:364Create capsule request.
string name = 1
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.
repeated initializers = 2
Deprecated field: The initial properties of the capsule.
string project_id = 3
The project to create the capsule in.
message
service.proto:376Create capsule response.
string capsule_id = 1
ID of the capsule. This is the same as the name.
rpc Get (, )
service.proto:29Get a capsule by id.
message
service.proto:382Request to get a capsule.
string capsule_id = 1
Capsule to get.
string project_id = 2
Project in which the capsule is.
message
service.proto:390Response to get a capsule.
optional capsule = 1
The capsule.
optional revision = 2
map<string, > environment_revisions = 3
rpc Delete (, )
service.proto:31Delete a capsule.
message
service.proto:398Request to delete a capsule.
string capsule_id = 1
The capsule to delete.
string project_id = 2
The project in which the capsule is to be deleted.
message
service.proto:406Empty delete response.
(message has no fields)
rpc Logs (, stream )
service.proto:33Logs returns (and streams) the log output of a capsule.
message
service.proto:409Request to get instance logs from a capsule.
string capsule_id = 1
The capsule to read logs from.
string instance_id = 2
The instance in the capsule to read logs from.
bool follow = 3
If true, the request will stay open and stream new log messages.
optional since = 4
If set, will not show logs older than since.
string project_id = 5
The project in which the capsule is.
string environment_id = 6
Environment to get logs from.
bool previous_containers = 7
If true, include logs from previously terminated containers
message
service.proto:427The response of a capsule.Logs RPC
optional log = 1
The actual logs
rpc Update (, )
service.proto:35Update a capsule.
message
service.proto:433Deprecated update - This is now a no-op
string capsule_id = 1
The capsule to update.
repeated updates = 2
The updates to apply to the capsule.
string project_id = 3
message
service.proto:442Deprecated: Empty update response.
(message has no fields)
rpc List (, )
service.proto:37Lists all capsules for current project.
message
service.proto:445List capsule request.
optional pagination = 2
Pagination options.
string project_id = 3
Project in which to list capsules.
message
service.proto:453List capsule response.
repeated capsules = 1
The capsules.
uint64 total = 2
Total number of capsules in the project.
rpc Deploy (, )
service.proto:42Deploy 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.
message
service.proto:462Deploy request. This will deploy a number of changes which results in a new rollout.
string capsule_id = 1
Capsule to deploy to.
repeated changes = 2
Changes to include in the new rollout.
bool force = 3
Force deploy, aborting an existing rollout if ongoing.
string project_id = 4
Project in which the capsule lives.
string environment_id = 5
Environment in which to deploy.
string message = 6
Deploy message.
bool dry_run = 7
if true, the deploy will not be executed, but the request will return the rollout config.
uint64 current_rollout_id = 8
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.
optional current_fingerprint = 10
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`
bool force_override = 9
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.
string operator_config = 11
Only allowed with dry_run = true. Will use this config for the operator instead of the config running in the cluster.
message
service.proto:504Deploy response.
uint64 rollout_id = 1
ID of the new rollout.
map<string, string> resource_yaml = 2
The YAML of the resources that will be deployed. Deprecated. Use `outcome` instead.
optional revision = 4
The rollout config. api.v1.capsule.RolloutConfig rollout_config = 3; The capsule revision created.
optional set_revision = 6
The capsule set revision created if it's the first time deploying to the environment.
optional outcome = 5
Breakdown of the changes that this deploy would make to the system. Only populated if dry-run is used.
rpc DeploySet (, )
service.proto:43message
service.proto:550string capsule_id = 1
Capsule to deploy to.
repeated changes = 2
Changes to include in the new rollout.
bool force = 3
Force deploy, aborting existing rollouts if ongoing.
string project_id = 4
Project in which the capsule lives.
string message = 6
Deploy message.
bool dry_run = 7
if true, the deploy will not be executed, but the request will return the rollout config.
map<string, uint64> current_rollout_ids = 8
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.
optional current_fingerprint = 9
If set, this will constrain the rollout only to be created if the current latest capsuleset fingerprint matches the given.
map<string, > current_environment_fingerprints = 10
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`
message
service.proto:587optional revision = 1
The capsule revision created.
optional outcome = 2
Breakdown of the changes that this deploy would make to the system. Only populated if dry-run is used.
repeated string ActiveEnvironments = 3
The environments which currently have rollouts. These will receive a rollout as result of the SetDeploy
rpc ProposeRollout (, )
service.proto:44message
service.proto:600Deploy request. This will deploy a number of changes which results in a new rollout.
string capsule_id = 1
Capsule to deploy to.
repeated changes = 2
Changes to include in the new rollout.
string project_id = 3
Project in which the capsule lives.
string environment_id = 4
Environment in which to deploy.
string message = 5
Deploy message.
bool force_override = 6
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.
string branch_name = 7
message
service.proto:624optional proposal = 1
optional outcome = 2
Breakdown of the changes that this deploy would make to the system.
rpc ProposeSetRollout (, )
service.proto:45message
service.proto:630string capsule_id = 1
Capsule to deploy to.
repeated changes = 2
Changes to include in the new rollout.
string project_id = 3
Project in which the capsule lives.
string message = 4
Deploy message.
bool force_override = 5
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.
string branch_name = 6
message
service.proto:652optional proposal = 1
optional outcome = 2
Breakdown of the changes that this deploy would make to the system.
rpc ListProposals (, )
service.proto:47message
service.proto:658string project_id = 1
string environment_id = 2
string capsule_id = 3
optional pagination = 4
message
service.proto:665repeated proposals = 1
uint64 total = 2
rpc ListSetProposals (, )
service.proto:48message
service.proto:670string project_id = 1
string capsule_id = 2
optional pagination = 3
message
service.proto:676repeated proposals = 1
uint64 total = 2
rpc GetProposalsEnabled (, )
service.proto:50message
service.proto:962string project_id = 1
string environment_id = 2
string capsule_id = 3
message
service.proto:968bool enabled = 1
rpc ListInstances (, )
service.proto:53Lists all instances for the capsule.
message
service.proto:682List instances request.
string capsule_id = 1
Capsule to list instances from.
optional pagination = 2
Pagination options.
string project_id = 3
Project in which the capsule lives.
string environment_id = 4
Environment to list instances from.
bool include_deleted = 5
if true, deleted instances will be included in the response.
bool exclude_existing = 6
if true, existing instances will be excluded from the response.
message
service.proto:698List instances response.
repeated instances = 1
The instances.
uint64 total = 2
Total number of instances in the capsule for the given environment.
rpc RestartInstance (, )
service.proto:55Restart a single capsule instance.
message
service.proto:748RestartInstanceRequest restarts a single instance.
string capsule_id = 1
The capsule to restart the instance in.
string instance_id = 2
The instance to restart.
string project_id = 3
The project in which the capsule lives.
string environment_id = 4
The environment to restart the instance in.
message
service.proto:760RestartInstanceResponse is an empty response.
(message has no fields)
rpc GetRollout (, )
service.proto:58Get a single rollout by ID.
message
service.proto:783GetRolloutRequest gets a single rollout.
string capsule_id = 1
The capsule to get the rollout from.
uint64 rollout_id = 2
The rollout to get.
string project_id = 3
The project in which the capsule lives.
message
service.proto:793GetRolloutResponse returns a single rollout for a capsule and an environment in a project.
optional rollout = 1
The rollout.
rpc ListRollouts (, )
service.proto:60Lists all rollouts for the capsule.
message
service.proto:763ListRolloutsRequest lists rollouts for a capsule.
string capsule_id = 1
The capsule to list rollouts for.
optional pagination = 2
Pagination options.
string project_id = 3
The project in which the capsule lives.
string environment_id = 4
The environment to list rollouts for.
message
service.proto:775ListRolloutsResponse lists rollouts for a capsule and an environment.
repeated rollouts = 1
The rollouts.
uint64 total = 2
Total number of rollouts in the capsule for the given environment.
rpc WatchRollouts (, stream )
service.proto:62Stream rollouts for a capsule.
message
service.proto:202string capsule_id = 1
The capsule to list rollouts for.
string project_id = 2
The project in which the capsule lives.
string environment_id = 3
The environment to list rollouts for.
uint64 rollout_id = 4
If given only the rollout with this ID will be watched.
optional pagination = 5
Pagination options.
message
service.proto:215optional updated = 1
rpc AbortRollout (, )
service.proto:65Abort the rollout.
message
service.proto:799AbortRolloutRequest aborts a rollout.
string capsule_id = 1
The capsule to abort the rollout in.
uint64 rollout_id = 2
The rollout to abort.
string project_id = 3
The project in which the capsule lives.
message
service.proto:809AbortRolloutResponse is an empty response.
(message has no fields)
rpc StopRollout (, )
service.proto:67Stop a Rollout, removing all resources associated with it.
message
service.proto:812StopRolloutRequest aborts a rollout.
string capsule_id = 1
The capsule of the aborting rollout.
uint64 rollout_id = 2
The rollout to stop.
string project_id = 3
The project in which the capsule lives.
message
service.proto:822StopRolloutResponse is an empty response.
(message has no fields)
rpc ListEvents (, )
service.proto:69List capsule events.
message
service.proto:826ListEvents request for listing rollout events for a given rollout in a capsule and environment.
string capsule_id = 1
The capsule to list events for.
uint64 rollout_id = 2
The rollout to list events for.
optional pagination = 3
Pagination options.
string project_id = 4
The project in which the capsule lives.
string environment_id = 5
The environment to list events for.
message
service.proto:840Response to List Events
repeated events = 1
The events for a rollout in a capsule and environment for a given project.
uint64 total = 2
Total number of events in the capsule for the given environment.
rpc CapsuleMetrics (, )
service.proto:71Get metrics for a capsule
message
service.proto:848Request for getting metrics for a capsule and optionally a single instance.
string capsule_id = 1
The capsule to get metrics for.
string instance_id = 2
If set, only returns metrics for the given instance_id.
string project_id = 4
The project in which the capsule lives.
string environment_id = 5
The environment to get metrics for.
optional since = 6
Return metrics generated after 'since'
message
service.proto:862Response to getting capsule metrics.
repeated instance_metrics = 1
Metrics
rpc GetInstanceStatus (, )
service.proto:73GetInstanceStatus returns the current status for the given instance.
message
service.proto:706Get status of an instance.
string capsule_id = 1
The capsule to get the instance status from.
string instance_id = 2
The instance to get.
string project_id = 3
The project in which the capsule lives.
string environment_id = 4
The environment to get the instance from.
message
service.proto:718Get instance status response.
optional status = 1
The instance status.
rpc ListInstanceStatuses (, )
service.proto:76ListInstanceStatuses lists the status of all instances.
message
service.proto:724List multiple instance statuses
string capsule_id = 1
The capsule to get the instance statuses from.
optional pagination = 2
Pagination options.
string project_id = 3
The project in which the capsule is.
string environment_id = 4
The environment to get the instance statuses from.
bool include_deleted = 5
if true, deleted instances will be included in the response.
bool exclude_existing = 6
if true, existing instances will be excluded from the response.
message
service.proto:740Response for listing multiple instance statuses
repeated instances = 1
The instance statuses.
uint64 total = 2
Total number of instances in the capsule for the given environment.
rpc WatchInstanceStatuses (, stream )
service.proto:80Stream Instance Statuses of a capsule.
message
service.proto:219string capsule_id = 1
The capsule to get the instance statuses from.
string project_id = 2
The project in which the capsule is.
string environment_id = 3
The environment to get the instance statuses from.
string instance_id = 4
If given, only the instance with this ID will be watched.
bool include_deleted = 5
if true, deleted instances will be included in the response.
bool exclude_existing = 6
if true, existing instances will be excluded from the response.
optional pagination = 7
Pagination options.
message
service.proto:236oneof response
updated = 1
string deleted = 2
rpc Execute (stream , stream )
service.proto:85Execute executes a command in a given in instance, and returns the output along with an exit code.
message
service.proto:282Execute request. This can either be a request to start a request, a terminal resize msg or a stream data msg.
oneof request
start = 1
Start request.
stdin = 2
Stream stdin request
resize = 3
Resize request
string project_id = 4
The project ID.
string environment_id = 5
The environment ID.
message
service.proto:323Execute response.
oneof response
stdout = 1
Stdout of the execute.
stderr = 2
Stderr in case of an error.
int32 exit_code = 3
Exit code of the execute.
rpc PortForward (stream , stream )
service.proto:88PortForward establishes a port-forwarding for the port to the given instance.
message
service.proto:334oneof request
start = 1
bytes data = 2
close = 3
message
service.proto:354oneof response
bytes data = 1
close = 2
message
service.proto:868Request for getting custom metrics for a capsule in an environment.
string capsule_id = 1
The capsule to get metrics for.
string project_id = 2
The project in which the capsule lives.
string environment_id = 3
The environment to get metrics for.
message
service.proto:878Response to getting custom metrics for a capsule in an environment.
repeated metrics = 1
Custom Metrics.
rpc GetJobExecutions (, )
service.proto:95Get list of job executions performed by the Capsule.
message
service.proto:884Request for getting job executions from cron jobs.
string capsule_id = 1
The capsule to get job executions for.
string job_name = 2
The name of the job to get executions for.
repeated JobState states = 4
Filtering executions by job state.
optional created_from = 5
Filtering executions created before this timestamp.
optional created_to = 6
Filtering executions created after this timestamp.
optional pagination = 7
Pagination options.
string project_id = 8
The project in which the capsule lives.
string environment_id = 9
The environment to get job executions for.
message
service.proto:904Response to getting job executions.
repeated job_executions = 1
Job executions.
uint64 total = 2
Total number of executions ignorring pagination.
rpc GetStatus (, )
service.proto:98message
service.proto:257GetStatusRequest is a request to start streaming the capsule status
string capsule_id = 1
The capsule to get the status from.
string project_id = 2
The project in which the capsule lives.
string environment_id = 3
The environment to get the status from.
message
service.proto:267GetCapsuleStatusResponse
optional status = 1
The capsule status
rpc GetRevision (, )
service.proto:99message
service.proto:911string project_id = 1
string environment_id = 2
string capsule_id = 3
optional fingerprint = 4
message
service.proto:918optional revision = 1
message
service.proto:922string project_id = 1
string environment_id = 2
string capsule_id = 3
optional fingerprints = 4
message
service.proto:929oneof kind
no_rollout = 1
rollout = 2
rpc WatchStatus (, stream )
service.proto:104Stream the status of a capsule.
message
service.proto:243string capsule_id = 1
The capsule to watch the status of.
string project_id = 2
The project in which the capsule lives.
string environment_id = 3
The environment to watch the status of.
message
service.proto:252optional status = 1
message
service.proto:951string project_id = 1
string environment_id = 2
string capsule_id = 3
message
service.proto:957optional git = 1
bool environment_enabled = 2
rpc StartPipeline (, )
service.proto:111Will initiate the pipeline, from the initial environment and it's current rollout.
message
service.proto:185string project_id = 1
string capsule_id = 2
string pipeline_name = 3
bool dry_run = 4
bool abort_current = 5
If true, and the pipeline is already running for the capsule and project, it will be aborted and a new one started.
message
service.proto:195optional status = 1
repeated dry_run_outcomes = 2
Breakdown of the changes that will be made to the environments throughout the pipeline. Only populated if dry-run is used.
rpc GetPipelineStatus (, )
service.proto:112message
service.proto:177uint64 execution_id = 1
message
service.proto:181optional status = 1
rpc PromotePipeline (, )
service.proto:115Progress the pipeline to the next environment.
message
service.proto:148uint64 execution_id = 1
bool dry_run = 2
If true, the progression will not be executed, but instead a breakdown of changes will be returned
repeated field_changes = 3
additional changes to include in the manual promotion
bool force = 4
If true, the pipeline will be force promoted to the next environment regardless of the state of the pipeline and the triggers.
message
service.proto:160optional status = 1
repeated dry_run_outcomes = 2
Breakdown of the changes that will be made to the environments throughout the pipeline. Only populated if dry-run is used.
optional revision = 3
The capsule revision created.
rpc AbortPipeline (, )
service.proto:119Abort the pipeline execution. This will stop the pipeline from any further promotions.
message
service.proto:140uint64 execution_id = 1
message
service.proto:144optional status = 1
message
service.proto:124optional pagination = 1
string project_filter = 2
Only include pipelines that are run in the given project.
string capsule_filter = 3
Only include pipelines that are run with the given capsule.
repeated pipeline.State states_filter = 4
Only include pipelines that are in one of the given states.
string name_filter = 5
Only include pipelines that have the given name.
message
service.proto:136repeated statuses = 1
message
event.proto:26An event that is associated with an abort.
Used in:
(message has no fields)
message
change.proto:301Autoscaling based on CPU target.
Used in:
uint32 average_utilization_percentage = 1
Average CPU utilization target.
message
capsule.proto:10Environment wide capsule abstraction.
Used in: ,
string capsule_id = 1
ID of the capsule.
optional updated_at = 6
Last time the capsule was updated.
optional updated_by = 7
Author of the last update.
optional git_store = 8
message
status.proto:23Used in:
repeated statuses = 1
message
change.proto:10Change to a capsule that ultimately results in a new rollout.
Used in: , , ,
oneof field
Different types of changes.
uint32 replicas = 1
Number of replicas changed.
string image_id = 2
New image change.
network = 3
Network interfaces change.
container_settings = 4
Container settings of the instances.
bool auto_add_rig_service_accounts = 5
Automatically add a rig-service account.
set_config_file = 6
Set a config file - either update or add.
set_config_file_ref = 25
Set a config file ref - either update or add.
string remove_config_file = 7
Path of a config file to remove.
horizontal_scale = 8
Horizontal scaling settings.
rollback = 9
Rollback to a previous rollout.
set_environment_variable = 11
Update or add an environment variable.
string remove_environment_variable = 12
Name of an environment variable to remove.
set_environment_source = 13
Set or update an environment source.
remove_environment_source = 14
Remove an environment source.
command_arguments = 15
Entrypoint for capsule instances.
add_cron_job = 16
Add a cron job.
remove_cron_job = 17
Remove a cron job.
set_interface = 18
Add or update a network interface.
string remove_interface = 19
Remove a network interface.
set_annotations = 20
Set capsule annotations.
set_annotation = 21
Update or add a single capsule annotation.
string remove_annotation = 22
Name of a single capsule annotation to remove.
add_image = 23
Image to deploy, adding it to images if not already present.
spec = 24
Complete capsule-spec to replace the current.
message
change.proto:71Used in:
string image = 1
message
change.proto:67Used in:
map<string, string> annotations = 1
message
change.proto:54Entrypoint for the capsule instances.
Used in:
string command = 2
Command to run.
repeated string args = 3
arguments to the command.
message
change.proto:12Config file change.
Used in:
string path = 1
Path of the file in the instance.
bytes content = 2
Content of the config file.
bool is_secret = 3
True if the content is secret.
message
change.proto:22Config file ref change.
Used in:
string path = 1
Path of the file in the instance.
string kind = 2
Kind of the object to inject as config file. Either ConfigMap or Secret.
string name = 3
Name of the object to inject as a config file.
string key = 4
Key of the data within the object contents.
message
change.proto:40Jobs change
repeated jobs = 1
The jobs.
message
change.proto:46Key-value change.
Used in:
string name = 1
Name of the property.
string value = 2
The value of the property.
message
change.proto:62Remove cron job change.
Used in:
string job_name = 1
Name of the job to remove
message
change.proto:34Rollback change.
Used in:
uint64 rollback_id = 1
Rollout to roll back to.
message
rollout.proto:56Used in:
repeated changes = 1
string message = 2
message
rollout.proto:57Used in:
string message = 1
message
rollout.proto:48Used in:
string path = 1
bytes content = 2
optional updated_by = 3
optional updated_at = 4
bool is_secret = 5
message
status.proto:61Used in:
string path = 1
bool isSecret = 2
repeated status = 3
Transition transition = 4
bytes content = 5
message
status.proto:38Used in:
string image = 1
string command = 2
repeated string args = 3
map<string, string> environment_variables = 4
optional scale = 5
optional resources = 6
message
change.proto:129Settings for the instance container
Used in: ,
map<string, string> environment_variables = 1
Environment variables.
string command = 2
Entrypoint for the container.
repeated string args = 3
Arguments to the container.
optional resources = 4
Resource requests and limits.
repeated environment_sources = 5
Environment sources.
message
instance.proto:173Used in:
int32 exit_code = 1
Exit status from the last termination of the container
int32 signal = 2
Signal from the last termination of the container +optional
string reason = 3
(brief) reason from the last termination of the container +optional
string message = 4
Message regarding the last termination of the container +optional
optional started_at = 5
Time at which previous execution of the container started +optional
optional finished_at = 6
Time at which the container last terminated +optional
string container_id = 7
Container's ID in the format 'type://container_id' +optional
message
instance.proto:137Used in:
string message = 1
optional timestamps = 2
optional data = 3
message
instance.proto:143Used in:
optional termination = 1
message
job.proto:47Specification for a cron job.
Used in: , ,
string job_name = 1
Name of the job.
string schedule = 2
Cron schedule.
int32 max_retries = 3
Maximum number of retries.
optional timeout = 4
Maximum duration of the job.
oneof job_type
The type of the job
url = 5
URL job.
command = 6
Command job.
message
status.proto:69Used in:
string job_name = 1
string schedule = 2
pipeline.ObjectState last_execution = 3
Transition transition = 4
message
instance.proto:61Used in:
string message = 1
optional timestamps = 2
message
change.proto:307Autoscaling based on custom metrics.
Used in:
oneof metric
The type of metric.
instance = 1
If scaling based on metrics across all intstances / pods.
object = 2
If scaling based on metrics for a specific kubernetes resource object.
message
service.proto:523Used in: , , ,
repeated field_changes = 1
The field-level changes that comes from applying this change.
repeated platform_objects = 2
The Platform-level objects that are generated by the Deploy.
repeated kubernetes_objects = 3
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.
string kubernetes_error = 4
In case generation of kubernetes files failed, this field will be populated with the error.
string cluster_name = 5
string kubernetes_namespace = 6
message
service.proto:529Used in:
string name = 1
string content_yaml = 2
message
service.proto:524Used in:
string name = 1
string content_yaml = 2
message
service.proto:581Used in: ,
repeated field_changes = 1
The field-level changes that comes from applying this change.
map<string, > environments = 2
message
instance.proto:66Used in:
string message = 1
optional timestamps = 2
message
change.proto:169Source of environment variables
Used in: ,
string name = 1
Name of the source
EnvironmentSource.Kind kind = 2
Type of the source
Used in:
KIND_UNSPECIFIED = 0
Unspecified.
KIND_CONFIG_MAP = 1
Environment variables from a config map.
KIND_SECRET = 2
Environment variables from a secret.
message
event.proto:29An event that is associated with an error.
Used in:
(message has no fields)
message
event.proto:9An event is a message from a rollout
Used in:
optional created_by = 1
Potential author associated with the event.
optional created_at = 2
When the event was created.
uint64 rollout_id = 3
The rollout that created the event.
string message = 4
A message associated with the event.
optional event_data = 5
The data associated with the event.
message
event.proto:32The data associated with an event.
Used in:
oneof kind
rollout = 1
If event is a rollout.
error = 2
if event is an error event.
abort = 3
If event is an abort event.
EVENT_TYPE_UNSPECIFIED = 0
EVENT_TYPE_ABORT = 1
message
service.proto:300Terminal resize request.
Used in: ,
uint32 height = 1
The new terminal height.
uint32 width = 2
The new terminal width.
message
service.proto:284Exec start request
Used in:
string capsule_id = 1
The capsule to execute in.
string instance_id = 2
The instance to execute in.
string command = 3
The command to execute.
repeated string arguments = 4
The arguments to the command.
optional tty = 5
The initial terminal size.
bool interactive = 6
If the command is interactive.
message
field.proto:12Used in: , ,
string field_id = 1
The Field-ID associated with this change. This is formated as a json-path string with '?' placeholders.
string field_path = 2
The unique Field-path identifying this change. This is formated as a json-path string.
string old_value_yaml = 3
YAML encoding of the old value (if any).
string new_value_yaml = 4
YAML encoding of the new value (if any).
FieldOperation operation = 5
Operation is how this field-change is applied against the source to get to the target spec.
string description = 6
Pretty-printed string description of the field change.
Used in:
FIELD_OPERATION_UNSPECIFIED = 0
FIELD_OPERATION_ADDED = 1
FIELD_OPERATION_REMOVED = 2
FIELD_OPERATION_MODIFIED = 3
message
service.proto:930Used in:
bool project = 1
Indicates no rollout with a project revision at least as new as the one given.
bool environment = 2
Indicates no rollout with an environment revision at least as new as the one given.
bool capsule_set = 3
Indicates no rollout with a capsule set revision at least as new as the one given.
bool capsule = 4
Indicates no rollout with a capsule revision at least as new as the one given.
message
image.proto:30GitReference is an origin of a image.
Used in:
string repository_url = 1
The url of the git repository
string commit_sha = 2
The commit sha of the git repository
string commit_url = 3
The commit url of the git repository
message
change.proto:161GPU resource limits
Used in:
string type = 1
gpu resource type - fx. nvidia.com/gpu
uint32 count = 2
number of gpus
message
change.proto:221Used in:
string path = 1
PathMatchType match = 2
message
change.proto:289Horizontal scaling settings.
Used in: , ,
uint32 max_replicas = 1
Maximum number of replicas.
uint32 min_replicas = 2
Minimum number of replicas.
optional cpu_target = 3
CPU target for autoscaling.
repeated custom_metrics = 4
If scaling based on custom metrics.
message
change.proto:207Used in: ,
string host = 1
optional options = 2
repeated paths = 3
string id = 4
message
image.proto:10Image is an cross-environment abstraction of an container image along with metadata for a capsule.
Used in: ,
string image_id = 2
unique identifier for the image
string digest = 7
digest of the image
string repository = 8
repository of the image
string tag = 9
tag of the image
optional created_by = 3
user who created the image
optional created_at = 4
time the image was created
optional origin = 5
origin of the image
map<string, string> labels = 6
labels of the image
message
instance.proto:85Used in:
string message = 1
optional timestamps = 2
optional stages = 3
message
instance.proto:108Used in:
string message = 1
optional timestamps = 2
message
instance.proto:113Used in:
string message = 1
optional timestamps = 2
message
instance.proto:103Used in:
string message = 1
optional timestamps = 2
message
instance.proto:98Used in:
string message = 1
optional timestamps = 2
message
instance.proto:91Used in:
optional pulling = 1
optional error = 2
optional back_off = 3
optional done = 4
message
instance.proto:17Used in:
string instance_id = 1
string image_id = 2
State state = 3
uint32 restart_count = 4
optional created_at = 5
optional started_at = 6
optional finished_at = 7
string message = 8
uint64 rollout_id = 9
message
change.proto:318Metric emitted by instances / pods.
Used in:
string metric_name = 1
Name of the metric
map<string, string> match_labels = 2
Labels of the instances to match.
string average_value = 3
Average value target.
message
instance.proto:168Used in:
string message = 1
optional timestamps = 2
message
instance.proto:29string message = 1
optional timestamps = 2
optional data = 3
optional stages = 4
message
instance.proto:36Used in:
string instance_id = 1
uint64 rollout_id = 2
string image_name = 3
string node = 4
message
instance.proto:74======================= PREPARING =====================
Used in:
string message = 1
optional timestamps = 2
optional stages = 3
message
instance.proto:81Used in:
optional pulling = 1
message
instance.proto:120======================== RUNNING ======================
Used in:
string message = 1
optional timestamps = 2
optional stages = 3
optional data = 4
message
instance.proto:127Used in:
uint32 restarts = 1
message
instance.proto:131Used in:
optional crash_loop_backoff = 1
optional ready = 2
optional running = 3
message
instance.proto:50====================== SCHEDULING ====================
Used in:
string message = 1
optional timestamps = 2
optional stages = 3
message
instance.proto:56Used in:
optional currently_unscheduleable = 1
optional done = 2
message
instance.proto:43Used in:
optional schedule = 1
optional preparing = 2
optional running = 3
message
status.proto:27Used in:
uint32 num_upgrading = 1
The number of updated instances.
uint32 num_ready = 2
The number of ready instances.
uint32 num_stuck = 3
The number of stuck instances.
uint32 num_wrong_version = 4
The number of instances with the wrong version.
message
change.proto:192A single network interface.
Used in: ,
uint32 port = 1
Port of the interface.
string name = 2
Name of the interface.
optional public = 4
If public interface is enabled. Contains ingress or load balancer settings.
optional liveness = 7
Liveness probe.
optional readiness = 8
Readiness probe.
repeated routes = 9
Routes for the network interface.
message
change.proto:231Probe for liveness or readiness.
Used in:
oneof kind
Type of the proble.
http = 1
tcp = 2
grpc = 3
message
change.proto:241GRPC service for the probe.
Used in:
string service = 1
message
change.proto:233HTTP path for the probe.
Used in:
string path = 1
message
change.proto:238IF TCP probe.
Used in:
(message has no fields)
message
status.proto:47Used in:
string name = 1
uint32 port = 2
repeated routes = 3
repeated status = 4
Transition transition = 5
message
status.proto:48Used in:
optional route = 1
repeated status = 2
Transition transition = 3
message
job.proto:76Run a job by running a command in an instance of a capsule
Used in:
string command = 1
Command to run.
repeated string args = 2
Arguments to pass to the command.
message
job.proto:9An execution of a cron job.
Used in:
string job_name = 1
Name of the job.
optional created_at = 2
When the job started running.
optional finished_at = 3
When the job finished.
JobState state = 4
The state of the job.
int32 retries = 5
Number of retries.
uint64 rollout_id = 6
ID of the rollout.
string capsule_id = 7
ID of the capsule.
string project_id = 8
ID of the project.
string execution_id = 9
ID of the execution.
string environment_id = 10
ID of the environment.
enum JobState
job.proto:33Different states a job execution can be in
Used in: ,
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.
message
job.proto:66Run a job by making a HTTP request to a URL.
Used in:
uint64 port = 1
Port to make the request to.
string path = 2
Path to make the request to.
map<string, string> query_parameters = 3
Query parameters to add to the request.
message
log.proto:8Log of an instance
Used in:
optional timestamp = 1
Timestamp of the log
optional message = 2
Message of the log
string instance_id = 3
Instance ID of the log
message
log.proto:18The actual log message
Used in:
oneof message
bytes stdout = 1
If the log is stdout
bytes stderr = 2
If the log is stderr
container_termination = 3
Represents a termination event
message
log.proto:19Used in:
(message has no fields)
message
change.proto:186A network configuration of network interfaces.
Used in: ,
repeated interfaces = 1
All the network interfaces.
message
instance.proto:163Used in:
string message = 1
optional timestamps = 2
message
change.proto:328Metric emitted by kubernetes object.
Used in:
string metric_name = 1
Name of the metric.
map<string, string> match_labels = 2
Labels of the object to match.
string average_value = 3
Average value target.
string value = 4
Value target.
optional object_reference = 5
Reference to the object.
message
image.proto:40Where the image came from
Used in: , ,
oneof kind
git_reference = 1
The image came from a git repository
Used in:
PATH_MATCH_TYPE_UNSPECIFIED = 0
PATH_MATCH_TYPE_PATH_PREFIX = 1
PATH_MATCH_TYPE_EXACT = 2
PATH_MATCH_TYPE_REGULAR_EXPRESSION = 3
message
service.proto:169Used in: ,
string environment_id = 1
Environment to promote to.
optional outcome = 2
Breakdown of the changes that this deploy would make to the system.
optional revision = 3
message
service.proto:345Used in:
(message has no fields)
message
service.proto:335Used in:
string project_id = 1
The project ID.
string environment_id = 2
The environment ID.
string capsule_id = 3
string instance_id = 4
uint32 port = 5
message
service.proto:355Used in:
(message has no fields)
message
revision.proto:19Used in: ,
optional spec = 1
optional metadata = 3
message
change.proto:254Public interface configuration.
Used in:
bool enabled = 1
True if the interface is public.
optional method = 2
Routing method - Ingress or Load Balancer.
message
instance.proto:152Used in:
string message = 1
optional timestamps = 2
optional stages = 3
message
instance.proto:158Used in:
optional not_ready = 1
optional ready = 2
message
change.proto:153CPU and Memory resource request or limits
Used in:
uint32 cpu_millis = 1
Unit: milli-CPUs
uint64 memory_bytes = 2
Unit: Bytes
message
change.proto:143Container resources requests and limits
Used in: ,
optional requests = 1
CPU and memory requests.
optional limits = 2
CPU and memory limits
optional gpu_limits = 3
GPU Limits
message
revision.proto:13Used in: , , , ,
optional spec = 1
optional metadata = 2
string message = 4
message
rollout.proto:14The rollout model.
Used in: , , ,
uint64 rollout_id = 1
Unique indentifier for the rollout.
optional config = 2
The rollout config.
optional status = 4
The rollout status.
optional spec = 5
optional revisions = 6
optional changelog = 7
message
rollout.proto:31Used in:
optional created_by = 1
The user who initiated the rollout.
optional created_at = 2
uint32 replicas = 4
string image_id = 5
optional network = 6
optional container_settings = 7
bool auto_add_rig_service_accounts = 8
repeated config_files = 9
optional horizontal_scale = 10
repeated cron_jobs = 11
string environment_id = 12
string message = 13
map<string, string> annotations = 14
message
event.proto:23An event that is associated with a rollout.
Used in:
(message has no fields)
message
change.proto:226Used in:
map<string, string> annotations = 1
message
change.proto:262The routing method for the public interface.
Used in:
oneof kind
Type of routing for the public interface.
load_balancer = 1
ingress = 2
message
change.proto:272Ingress routing.
Used in:
string host = 1
Hostname of the ingress.
bool tls = 2
True if TLS is enabled.
repeated string paths = 3
Paths of the ingress.
message
change.proto:264Loadbalancer routing.
Used in:
uint32 port = 1
public port.
uint32 node_port = 2
node port.
message
instance.proto:147Used in:
string message = 1
optional timestamps = 2
message
revision.proto:24Used in: ,
optional spec = 1
optional metadata = 3
message
revision.proto:8Used in: , ,
optional spec = 1
optional metadata = 2
message
sidecar.proto:6Deprecated: sidecar configuration
repeated interfaces = 1
message
sidecar.proto:11Deprecated: sidecar interface configuration
Used in:
uint32 port = 1
uint32 proxy_port = 2
Used in:
STATE_UNSPECIFIED = 0
STATE_PENDING = 1
STATE_RUNNING = 2
STATE_SUCCEEDED = 3
STATE_FAILED = 4
message
status.proto:9Used in: ,
string namespace = 1
optional capsule = 2
uint64 current_rollout_id = 3
optional container_config = 4
optional instances = 5
repeated interfaces = 6
repeated config_files = 7
repeated cron_jobs = 8
repeated issues = 9
List of all issues associated to the Capsule, include those of the current rollout. The list does not include instance-level issues.
message
instance.proto:197Used in: , , , , , , , , , , , , , , ,
optional entered = 1
optional updated = 2
optional exited = 3
message
service.proto:273StreamData for Execute RPC.
Used in: ,
bytes data = 1
Stream data.
bool closed = 2
If the stream is closed.
Used in: , , ,
TRANSITION_UNSPECIFIED = 0
TRANSITION_BEING_CREATED = 1
TRANSITION_UP_TO_DATE = 2
TRANSITION_BEING_DELETED = 3
message
capsule.proto:20Used in: ,
oneof field
set_git_store = 1
Set the git store.