-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
cloud_deploy.proto
4160 lines (3449 loc) · 160 KB
/
cloud_deploy.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.deploy.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/type/date.proto";
option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "CloudDeployProto";
option java_package = "com.google.cloud.deploy.v1";
option (google.api.resource_definition) = {
type: "cloudbuild.googleapis.com/Build"
pattern: "projects/{project}/locations/{location}/builds/{build}"
};
option (google.api.resource_definition) = {
type: "cloudbuild.googleapis.com/Repository"
pattern: "projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}"
};
option (google.api.resource_definition) = {
type: "container.googleapis.com/Cluster"
pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
};
option (google.api.resource_definition) = {
type: "clouddeploy.googleapis.com/Operation"
pattern: "projects/{project}/locations/{location}/operations/{operation}"
};
option (google.api.resource_definition) = {
type: "cloudbuild.googleapis.com/WorkerPool"
pattern: "projects/{project}/locations/{location}/workerPools/{worker_pool}"
};
option (google.api.resource_definition) = {
type: "gkehub.googleapis.com/Membership"
pattern: "projects/{project}/locations/{location}/memberships/{membership}"
};
option (google.api.resource_definition) = {
type: "run.googleapis.com/Service"
pattern: "projects/{project}/locations/{location}/services/{service}"
};
option (google.api.resource_definition) = {
type: "run.googleapis.com/Job"
pattern: "projects/{project}/locations/{location}/jobs/{job}"
};
// CloudDeploy service creates and manages Continuous Delivery operations
// on Google Cloud Platform via Skaffold (https://skaffold.dev).
service CloudDeploy {
option (google.api.default_host) = "clouddeploy.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Lists DeliveryPipelines in a given project and location.
rpc ListDeliveryPipelines(ListDeliveryPipelinesRequest)
returns (ListDeliveryPipelinesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/deliveryPipelines"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single DeliveryPipeline.
rpc GetDeliveryPipeline(GetDeliveryPipelineRequest)
returns (DeliveryPipeline) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/deliveryPipelines/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new DeliveryPipeline in a given project and location.
rpc CreateDeliveryPipeline(CreateDeliveryPipelineRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/deliveryPipelines"
body: "delivery_pipeline"
};
option (google.api.method_signature) =
"parent,delivery_pipeline,delivery_pipeline_id";
option (google.longrunning.operation_info) = {
response_type: "DeliveryPipeline"
metadata_type: "OperationMetadata"
};
}
// Updates the parameters of a single DeliveryPipeline.
rpc UpdateDeliveryPipeline(UpdateDeliveryPipelineRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{delivery_pipeline.name=projects/*/locations/*/deliveryPipelines/*}"
body: "delivery_pipeline"
};
option (google.api.method_signature) = "delivery_pipeline,update_mask";
option (google.longrunning.operation_info) = {
response_type: "DeliveryPipeline"
metadata_type: "OperationMetadata"
};
}
// Deletes a single DeliveryPipeline.
rpc DeleteDeliveryPipeline(DeleteDeliveryPipelineRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/deliveryPipelines/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists Targets in a given project and location.
rpc ListTargets(ListTargetsRequest) returns (ListTargetsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/targets"
};
option (google.api.method_signature) = "parent";
}
// Creates a `Rollout` to roll back the specified target.
rpc RollbackTarget(RollbackTargetRequest) returns (RollbackTargetResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/deliveryPipelines/*}:rollbackTarget"
body: "*"
};
option (google.api.method_signature) = "name,target_id,rollout_id";
}
// Gets details of a single Target.
rpc GetTarget(GetTargetRequest) returns (Target) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/targets/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new Target in a given project and location.
rpc CreateTarget(CreateTargetRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/targets"
body: "target"
};
option (google.api.method_signature) = "parent,target,target_id";
option (google.longrunning.operation_info) = {
response_type: "Target"
metadata_type: "OperationMetadata"
};
}
// Updates the parameters of a single Target.
rpc UpdateTarget(UpdateTargetRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{target.name=projects/*/locations/*/targets/*}"
body: "target"
};
option (google.api.method_signature) = "target,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Target"
metadata_type: "OperationMetadata"
};
}
// Deletes a single Target.
rpc DeleteTarget(DeleteTargetRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/targets/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists CustomTargetTypes in a given project and location.
rpc ListCustomTargetTypes(ListCustomTargetTypesRequest)
returns (ListCustomTargetTypesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/customTargetTypes"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single CustomTargetType.
rpc GetCustomTargetType(GetCustomTargetTypeRequest)
returns (CustomTargetType) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/customTargetTypes/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new CustomTargetType in a given project and location.
rpc CreateCustomTargetType(CreateCustomTargetTypeRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/customTargetTypes"
body: "custom_target_type"
};
option (google.api.method_signature) =
"parent,custom_target_type,custom_target_type_id";
option (google.longrunning.operation_info) = {
response_type: "CustomTargetType"
metadata_type: "OperationMetadata"
};
}
// Updates a single CustomTargetType.
rpc UpdateCustomTargetType(UpdateCustomTargetTypeRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{custom_target_type.name=projects/*/locations/*/customTargetTypes/*}"
body: "custom_target_type"
};
option (google.api.method_signature) = "custom_target_type,update_mask";
option (google.longrunning.operation_info) = {
response_type: "CustomTargetType"
metadata_type: "OperationMetadata"
};
}
// Deletes a single CustomTargetType.
rpc DeleteCustomTargetType(DeleteCustomTargetTypeRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/customTargetTypes/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Lists Releases in a given project and location.
rpc ListReleases(ListReleasesRequest) returns (ListReleasesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*}/releases"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single Release.
rpc GetRelease(GetReleaseRequest) returns (Release) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new Release in a given project and location.
rpc CreateRelease(CreateReleaseRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*}/releases"
body: "release"
};
option (google.api.method_signature) = "parent,release,release_id";
option (google.longrunning.operation_info) = {
response_type: "Release"
metadata_type: "OperationMetadata"
};
}
// Abandons a Release in the Delivery Pipeline.
rpc AbandonRelease(AbandonReleaseRequest) returns (AbandonReleaseResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*}:abandon"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Approves a Rollout.
rpc ApproveRollout(ApproveRolloutRequest) returns (ApproveRolloutResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}:approve"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Advances a Rollout in a given project and location.
rpc AdvanceRollout(AdvanceRolloutRequest) returns (AdvanceRolloutResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}:advance"
body: "*"
};
option (google.api.method_signature) = "name,phase_id";
}
// Cancels a Rollout in a given project and location.
rpc CancelRollout(CancelRolloutRequest) returns (CancelRolloutResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}:cancel"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Lists Rollouts in a given project and location.
rpc ListRollouts(ListRolloutsRequest) returns (ListRolloutsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*/releases/*}/rollouts"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single Rollout.
rpc GetRollout(GetRolloutRequest) returns (Rollout) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a new Rollout in a given project and location.
rpc CreateRollout(CreateRolloutRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*/releases/*}/rollouts"
body: "rollout"
};
option (google.api.method_signature) = "parent,rollout,rollout_id";
option (google.longrunning.operation_info) = {
response_type: "Rollout"
metadata_type: "OperationMetadata"
};
}
// Ignores the specified Job in a Rollout.
rpc IgnoreJob(IgnoreJobRequest) returns (IgnoreJobResponse) {
option (google.api.http) = {
post: "/v1/{rollout=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}:ignoreJob"
body: "*"
};
option (google.api.method_signature) = "rollout,phase_id,job_id";
}
// Retries the specified Job in a Rollout.
rpc RetryJob(RetryJobRequest) returns (RetryJobResponse) {
option (google.api.http) = {
post: "/v1/{rollout=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}:retryJob"
body: "*"
};
option (google.api.method_signature) = "rollout,phase_id,job_id";
}
// Lists JobRuns in a given project and location.
rpc ListJobRuns(ListJobRunsRequest) returns (ListJobRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}/jobRuns"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single JobRun.
rpc GetJobRun(GetJobRunRequest) returns (JobRun) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*/jobRuns/*}"
};
option (google.api.method_signature) = "name";
}
// Terminates a Job Run in a given project and location.
rpc TerminateJobRun(TerminateJobRunRequest)
returns (TerminateJobRunResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*/jobRuns/*}:terminate"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Gets the configuration for a location.
rpc GetConfig(GetConfigRequest) returns (Config) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/config}"
};
option (google.api.method_signature) = "name";
}
// Creates a new Automation in a given project and location.
rpc CreateAutomation(CreateAutomationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*}/automations"
body: "automation"
};
option (google.api.method_signature) = "parent,automation,automation_id";
option (google.longrunning.operation_info) = {
response_type: "Automation"
metadata_type: "OperationMetadata"
};
}
// Updates the parameters of a single Automation resource.
rpc UpdateAutomation(UpdateAutomationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{automation.name=projects/*/locations/*/deliveryPipelines/*/automations/*}"
body: "automation"
};
option (google.api.method_signature) = "automation,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Automation"
metadata_type: "OperationMetadata"
};
}
// Deletes a single Automation resource.
rpc DeleteAutomation(DeleteAutomationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/automations/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Gets details of a single Automation.
rpc GetAutomation(GetAutomationRequest) returns (Automation) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/automations/*}"
};
option (google.api.method_signature) = "name";
}
// Lists Automations in a given project and location.
rpc ListAutomations(ListAutomationsRequest)
returns (ListAutomationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*}/automations"
};
option (google.api.method_signature) = "parent";
}
// Gets details of a single AutomationRun.
rpc GetAutomationRun(GetAutomationRunRequest) returns (AutomationRun) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/automationRuns/*}"
};
option (google.api.method_signature) = "name";
}
// Lists AutomationRuns in a given project and location.
rpc ListAutomationRuns(ListAutomationRunsRequest)
returns (ListAutomationRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/deliveryPipelines/*}/automationRuns"
};
option (google.api.method_signature) = "parent";
}
// Cancels an AutomationRun. The `state` of the `AutomationRun` after
// cancelling is `CANCELLED`. `CancelAutomationRun` can be called on
// AutomationRun in the state `IN_PROGRESS` and `PENDING`; AutomationRun
// in a different state returns an `FAILED_PRECONDITION` error.
rpc CancelAutomationRun(CancelAutomationRunRequest)
returns (CancelAutomationRunResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/deliveryPipelines/*/automationRuns/*}:cancel"
body: "*"
};
option (google.api.method_signature) = "name";
}
}
// A `DeliveryPipeline` resource in the Cloud Deploy API.
//
// A `DeliveryPipeline` defines a pipeline through which a Skaffold
// configuration can progress.
message DeliveryPipeline {
option (google.api.resource) = {
type: "clouddeploy.googleapis.com/DeliveryPipeline"
pattern: "projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}"
};
// Optional. Name of the `DeliveryPipeline`. Format is
// `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`.
// The `deliveryPipeline` component must match
// `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
string name = 1 [(google.api.field_behavior) = OPTIONAL];
// Output only. Unique identifier of the `DeliveryPipeline`.
string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Description of the `DeliveryPipeline`. Max length is 255 characters.
string description = 3;
// User annotations. These attributes can only be set and used by the
// user, and not by Cloud Deploy.
map<string, string> annotations = 4;
// Labels are attributes that can be set and used by both the
// user and by Cloud Deploy. Labels must meet the following constraints:
//
// * Keys and values can contain only lowercase letters, numeric characters,
// underscores, and dashes.
// * All characters must use UTF-8 encoding, and international characters are
// allowed.
// * Keys must start with a lowercase letter or international character.
// * Each resource is limited to a maximum of 64 labels.
//
// Both keys and values are additionally constrained to be <= 128 bytes.
map<string, string> labels = 5;
// Output only. Time at which the pipeline was created.
google.protobuf.Timestamp create_time = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Most recent time at which the pipeline was updated.
google.protobuf.Timestamp update_time = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
// The ordering configuration of the `DeliveryPipeline`.
oneof pipeline {
// SerialPipeline defines a sequential set of stages for a
// `DeliveryPipeline`.
SerialPipeline serial_pipeline = 8;
}
// Output only. Information around the state of the Delivery Pipeline.
PipelineCondition condition = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
// This checksum is computed by the server based on the value of other
// fields, and may be sent on update and delete requests to ensure the
// client has an up-to-date value before proceeding.
string etag = 10;
// When suspended, no new releases or rollouts can be created,
// but in-progress ones will complete.
bool suspended = 12;
}
// SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`.
message SerialPipeline {
// Each stage specifies configuration for a `Target`. The ordering
// of this list defines the promotion flow.
repeated Stage stages = 1;
}
// Stage specifies a location to which to deploy.
message Stage {
// The target_id to which this stage points. This field refers exclusively to
// the last segment of a target name. For example, this field would just be
// `my-target` (rather than
// `projects/project/locations/location/targets/my-target`). The location of
// the `Target` is inferred to be the same as the location of the
// `DeliveryPipeline` that contains this `Stage`.
string target_id = 1;
// Skaffold profiles to use when rendering the manifest for this stage's
// `Target`.
repeated string profiles = 2;
// Optional. The strategy to use for a `Rollout` to this stage.
Strategy strategy = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. The deploy parameters to use for the target in this stage.
repeated DeployParameters deploy_parameters = 6
[(google.api.field_behavior) = OPTIONAL];
}
// DeployParameters contains deploy parameters information.
message DeployParameters {
// Required. Values are deploy parameters in key-value pairs.
map<string, string> values = 1 [(google.api.field_behavior) = REQUIRED];
// Optional. Deploy parameters are applied to targets with match labels.
// If unspecified, deploy parameters are applied to all targets (including
// child targets of a multi-target).
map<string, string> match_target_labels = 2
[(google.api.field_behavior) = OPTIONAL];
}
// Strategy contains deployment strategy information.
message Strategy {
// Deployment strategy details.
oneof deployment_strategy {
// Standard deployment strategy executes a single deploy and allows
// verifying the deployment.
Standard standard = 1;
// Canary deployment strategy provides progressive percentage based
// deployments to a Target.
Canary canary = 2;
}
}
// Predeploy contains the predeploy job configuration information.
message Predeploy {
// Optional. A sequence of Skaffold custom actions to invoke during execution
// of the predeploy job.
repeated string actions = 1 [(google.api.field_behavior) = OPTIONAL];
}
// Postdeploy contains the postdeploy job configuration information.
message Postdeploy {
// Optional. A sequence of Skaffold custom actions to invoke during execution
// of the postdeploy job.
repeated string actions = 1 [(google.api.field_behavior) = OPTIONAL];
}
// Standard represents the standard deployment strategy.
message Standard {
// Whether to verify a deployment.
bool verify = 1;
// Optional. Configuration for the predeploy job. If this is not configured,
// predeploy job will not be present.
Predeploy predeploy = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Configuration for the postdeploy job. If this is not configured,
// postdeploy job will not be present.
Postdeploy postdeploy = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Canary represents the canary deployment strategy.
message Canary {
// Optional. Runtime specific configurations for the deployment strategy. The
// runtime configuration is used to determine how Cloud Deploy will split
// traffic to enable a progressive deployment.
RuntimeConfig runtime_config = 1 [(google.api.field_behavior) = OPTIONAL];
// The mode to use for the canary deployment strategy.
oneof mode {
// Configures the progressive based deployment for a Target.
CanaryDeployment canary_deployment = 2;
// Configures the progressive based deployment for a Target, but allows
// customizing at the phase level where a phase represents each of the
// percentage deployments.
CustomCanaryDeployment custom_canary_deployment = 3;
}
}
// CanaryDeployment represents the canary deployment configuration
message CanaryDeployment {
// Required. The percentage based deployments that will occur as a part of a
// `Rollout`. List is expected in ascending order and each integer n is
// 0 <= n < 100.
repeated int32 percentages = 1 [(google.api.field_behavior) = REQUIRED];
// Whether to run verify tests after each percentage deployment.
bool verify = 2;
// Optional. Configuration for the predeploy job of the first phase. If this
// is not configured, there will be no predeploy job for this phase.
Predeploy predeploy = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Configuration for the postdeploy job of the last phase. If this
// is not configured, there will be no postdeploy job for this phase.
Postdeploy postdeploy = 4 [(google.api.field_behavior) = OPTIONAL];
}
// CustomCanaryDeployment represents the custom canary deployment
// configuration.
message CustomCanaryDeployment {
// PhaseConfig represents the configuration for a phase in the custom
// canary deployment.
message PhaseConfig {
// Required. The ID to assign to the `Rollout` phase.
// This value must consist of lower-case letters, numbers, and hyphens,
// start with a letter and end with a letter or a number, and have a max
// length of 63 characters. In other words, it must match the following
// regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
string phase_id = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Percentage deployment for the phase.
int32 percentage = 2 [(google.api.field_behavior) = REQUIRED];
// Skaffold profiles to use when rendering the manifest for this phase.
// These are in addition to the profiles list specified in the
// `DeliveryPipeline` stage.
repeated string profiles = 3;
// Whether to run verify tests after the deployment.
bool verify = 4;
// Optional. Configuration for the predeploy job of this phase. If this is
// not configured, there will be no predeploy job for this phase.
Predeploy predeploy = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. Configuration for the postdeploy job of this phase. If this is
// not configured, there will be no postdeploy job for this phase.
Postdeploy postdeploy = 6 [(google.api.field_behavior) = OPTIONAL];
}
// Required. Configuration for each phase in the canary deployment in the
// order executed.
repeated PhaseConfig phase_configs = 1
[(google.api.field_behavior) = REQUIRED];
}
// KubernetesConfig contains the Kubernetes runtime configuration.
message KubernetesConfig {
// Information about the Kubernetes Gateway API service mesh configuration.
message GatewayServiceMesh {
// Required. Name of the Gateway API HTTPRoute.
string http_route = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Name of the Kubernetes Service.
string service = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Name of the Kubernetes Deployment whose traffic is managed by
// the specified HTTPRoute and Service.
string deployment = 3 [(google.api.field_behavior) = REQUIRED];
// Optional. The time to wait for route updates to propagate. The maximum
// configurable time is 3 hours, in seconds format. If unspecified, there is
// no wait time.
google.protobuf.Duration route_update_wait_time = 4
[(google.api.field_behavior) = OPTIONAL];
// Optional. The amount of time to migrate traffic back from the canary
// Service to the original Service during the stable phase deployment. If
// specified, must be between 15s and 3600s. If unspecified, there is no
// cutback time.
google.protobuf.Duration stable_cutback_duration = 5
[(google.api.field_behavior) = OPTIONAL];
}
// Information about the Kubernetes Service networking configuration.
message ServiceNetworking {
// Required. Name of the Kubernetes Service.
string service = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Name of the Kubernetes Deployment whose traffic is managed by
// the specified Service.
string deployment = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. Whether to disable Pod overprovisioning. If Pod
// overprovisioning is disabled then Cloud Deploy will limit the number of
// total Pods used for the deployment strategy to the number of Pods the
// Deployment has on the cluster.
bool disable_pod_overprovisioning = 3
[(google.api.field_behavior) = OPTIONAL];
}
// The service definition configuration.
oneof service_definition {
// Kubernetes Gateway API service mesh configuration.
GatewayServiceMesh gateway_service_mesh = 1;
// Kubernetes Service networking configuration.
ServiceNetworking service_networking = 2;
}
}
// CloudRunConfig contains the Cloud Run runtime configuration.
message CloudRunConfig {
// Whether Cloud Deploy should update the traffic stanza in a Cloud Run
// Service on the user's behalf to facilitate traffic splitting. This is
// required to be true for CanaryDeployments, but optional for
// CustomCanaryDeployments.
bool automatic_traffic_control = 1;
// Optional. A list of tags that are added to the canary revision while the
// canary phase is in progress.
repeated string canary_revision_tags = 2
[(google.api.field_behavior) = OPTIONAL];
// Optional. A list of tags that are added to the prior revision while the
// canary phase is in progress.
repeated string prior_revision_tags = 3
[(google.api.field_behavior) = OPTIONAL];
// Optional. A list of tags that are added to the final stable revision when
// the stable phase is applied.
repeated string stable_revision_tags = 4
[(google.api.field_behavior) = OPTIONAL];
}
// RuntimeConfig contains the runtime specific configurations for a deployment
// strategy.
message RuntimeConfig {
// The runtime configuration details.
oneof runtime_config {
// Kubernetes runtime configuration.
KubernetesConfig kubernetes = 1;
// Cloud Run runtime configuration.
CloudRunConfig cloud_run = 2;
}
}
// PipelineReadyCondition contains information around the status of the
// Pipeline.
message PipelineReadyCondition {
// True if the Pipeline is in a valid state. Otherwise at least one condition
// in `PipelineCondition` is in an invalid state. Iterate over those
// conditions and see which condition(s) has status = false to find out what
// is wrong with the Pipeline.
bool status = 3;
// Last time the condition was updated.
google.protobuf.Timestamp update_time = 4;
}
// `TargetsPresentCondition` contains information on any Targets referenced in
// the Delivery Pipeline that do not actually exist.
message TargetsPresentCondition {
// True if there aren't any missing Targets.
bool status = 1;
// The list of Target names that do not exist. For example,
// `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
repeated string missing_targets = 2 [(google.api.resource_reference) = {
type: "clouddeploy.googleapis.com/Target"
}];
// Last time the condition was updated.
google.protobuf.Timestamp update_time = 4;
}
// TargetsTypeCondition contains information on whether the Targets defined in
// the Delivery Pipeline are of the same type.
message TargetsTypeCondition {
// True if the targets are all a comparable type. For example this is true if
// all targets are GKE clusters. This is false if some targets are Cloud Run
// targets and others are GKE clusters.
bool status = 1;
// Human readable error message.
string error_details = 2;
}
// PipelineCondition contains all conditions relevant to a Delivery Pipeline.
message PipelineCondition {
// Details around the Pipeline's overall status.
PipelineReadyCondition pipeline_ready_condition = 1;
// Details around targets enumerated in the pipeline.
TargetsPresentCondition targets_present_condition = 3;
// Details on the whether the targets enumerated in the pipeline are of the
// same type.
TargetsTypeCondition targets_type_condition = 4;
}
// The request object for `ListDeliveryPipelines`.
message ListDeliveryPipelinesRequest {
// Required. The parent, which owns this collection of pipelines. Format must
// be `projects/{project_id}/locations/{location_name}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "clouddeploy.googleapis.com/DeliveryPipeline"
}
];
// The maximum number of pipelines to return. The service may return
// fewer than this value. If unspecified, at most 50 pipelines will
// be returned. The maximum value is 1000; values above 1000 will be set
// to 1000.
int32 page_size = 2;
// A page token, received from a previous `ListDeliveryPipelines` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other provided parameters match
// the call that provided the page token.
string page_token = 3;
// Filter pipelines to be returned. See https://google.aip.dev/160 for more
// details.
string filter = 4;
// Field to sort by. See https://google.aip.dev/132#ordering for more details.
string order_by = 5;
}
// The response object from `ListDeliveryPipelines`.
message ListDeliveryPipelinesResponse {
// The `DeliveryPipeline` objects.
repeated DeliveryPipeline delivery_pipelines = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
// Locations that could not be reached.
repeated string unreachable = 3;
}
// The request object for `GetDeliveryPipeline`
message GetDeliveryPipelineRequest {
// Required. Name of the `DeliveryPipeline`. Format must be
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "clouddeploy.googleapis.com/DeliveryPipeline"
}
];
}
// The request object for `CreateDeliveryPipeline`.
message CreateDeliveryPipelineRequest {
// Required. The parent collection in which the `DeliveryPipeline` should be
// created. Format should be
// `projects/{project_id}/locations/{location_name}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "clouddeploy.googleapis.com/DeliveryPipeline"
}
];
// Required. ID of the `DeliveryPipeline`.
string delivery_pipeline_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The `DeliveryPipeline` to create.
DeliveryPipeline delivery_pipeline = 3
[(google.api.field_behavior) = REQUIRED];
// Optional. A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server knows to ignore the
// request if it has already been completed. The server guarantees that for
// at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
string request_id = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set to true, the request is validated and the user is provided
// with an expected result, but no actual change is made.
bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
}
// The request object for `UpdateDeliveryPipeline`.
message UpdateDeliveryPipelineRequest {
// Required. Field mask is used to specify the fields to be overwritten in the
// `DeliveryPipeline` resource by the update.
// The fields specified in the update_mask are relative to the resource, not
// the full request. A field will be overwritten if it's in the mask. If the
// user doesn't provide a mask then all fields are overwritten.
google.protobuf.FieldMask update_mask = 1
[(google.api.field_behavior) = REQUIRED];
// Required. The `DeliveryPipeline` to update.
DeliveryPipeline delivery_pipeline = 2
[(google.api.field_behavior) = REQUIRED];
// Optional. A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server knows to ignore the
// request if it has already been completed. The server guarantees that for
// at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
string request_id = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set to true, updating a `DeliveryPipeline` that does not exist
// will result in the creation of a new `DeliveryPipeline`.
bool allow_missing = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set to true, the request is validated and the user is provided
// with an expected result, but no actual change is made.
bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL];
}