-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
workstations.proto
1398 lines (1190 loc) · 56.3 KB
/
workstations.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 2023 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.workstations.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/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option go_package = "cloud.google.com/go/workstations/apiv1/workstationspb;workstationspb";
option java_multiple_files = true;
option java_outer_classname = "WorkstationsProto";
option java_package = "com.google.cloud.workstations.v1";
// Service for interacting with Cloud Workstations.
service Workstations {
option (google.api.default_host) = "workstations.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Returns the requested workstation cluster.
rpc GetWorkstationCluster(GetWorkstationClusterRequest)
returns (WorkstationCluster) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/workstationClusters/*}"
};
option (google.api.method_signature) = "name";
}
// Returns all workstation clusters in the specified location.
rpc ListWorkstationClusters(ListWorkstationClustersRequest)
returns (ListWorkstationClustersResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/workstationClusters"
};
option (google.api.method_signature) = "parent";
}
// Creates a new workstation cluster.
rpc CreateWorkstationCluster(CreateWorkstationClusterRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/workstationClusters"
body: "workstation_cluster"
};
option (google.api.method_signature) =
"parent,workstation_cluster,workstation_cluster_id";
option (google.longrunning.operation_info) = {
response_type: "WorkstationCluster"
metadata_type: "OperationMetadata"
};
}
// Updates an existing workstation cluster.
rpc UpdateWorkstationCluster(UpdateWorkstationClusterRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{workstation_cluster.name=projects/*/locations/*/workstationClusters/*}"
body: "workstation_cluster"
};
option (google.api.method_signature) = "workstation_cluster,update_mask";
option (google.longrunning.operation_info) = {
response_type: "WorkstationCluster"
metadata_type: "OperationMetadata"
};
}
// Deletes the specified workstation cluster.
rpc DeleteWorkstationCluster(DeleteWorkstationClusterRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/workstationClusters/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "WorkstationCluster"
metadata_type: "OperationMetadata"
};
}
// Returns the requested workstation configuration.
rpc GetWorkstationConfig(GetWorkstationConfigRequest)
returns (WorkstationConfig) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}"
};
option (google.api.method_signature) = "name";
}
// Returns all workstation configurations in the specified cluster.
rpc ListWorkstationConfigs(ListWorkstationConfigsRequest)
returns (ListWorkstationConfigsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/workstationClusters/*}/workstationConfigs"
};
option (google.api.method_signature) = "parent";
}
// Returns all workstation configurations in the specified cluster on which
// the caller has the "workstations.workstation.create" permission.
rpc ListUsableWorkstationConfigs(ListUsableWorkstationConfigsRequest)
returns (ListUsableWorkstationConfigsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/workstationClusters/*}/workstationConfigs:listUsable"
};
option (google.api.method_signature) = "parent";
}
// Creates a new workstation configuration.
rpc CreateWorkstationConfig(CreateWorkstationConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/workstationClusters/*}/workstationConfigs"
body: "workstation_config"
};
option (google.api.method_signature) =
"parent,workstation_config,workstation_config_id";
option (google.longrunning.operation_info) = {
response_type: "WorkstationConfig"
metadata_type: "OperationMetadata"
};
}
// Updates an existing workstation configuration.
rpc UpdateWorkstationConfig(UpdateWorkstationConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{workstation_config.name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}"
body: "workstation_config"
};
option (google.api.method_signature) = "workstation_config,update_mask";
option (google.longrunning.operation_info) = {
response_type: "WorkstationConfig"
metadata_type: "OperationMetadata"
};
}
// Deletes the specified workstation configuration.
rpc DeleteWorkstationConfig(DeleteWorkstationConfigRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "WorkstationConfig"
metadata_type: "OperationMetadata"
};
}
// Returns the requested workstation.
rpc GetWorkstation(GetWorkstationRequest) returns (Workstation) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}"
};
option (google.api.method_signature) = "name";
}
// Returns all Workstations using the specified workstation configuration.
rpc ListWorkstations(ListWorkstationsRequest)
returns (ListWorkstationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}/workstations"
};
option (google.api.method_signature) = "parent";
}
// Returns all workstations using the specified workstation configuration
// on which the caller has the "workstations.workstations.use" permission.
rpc ListUsableWorkstations(ListUsableWorkstationsRequest)
returns (ListUsableWorkstationsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}/workstations:listUsable"
};
option (google.api.method_signature) = "parent";
}
// Creates a new workstation.
rpc CreateWorkstation(CreateWorkstationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}/workstations"
body: "workstation"
};
option (google.api.method_signature) = "parent,workstation,workstation_id";
option (google.longrunning.operation_info) = {
response_type: "Workstation"
metadata_type: "OperationMetadata"
};
}
// Updates an existing workstation.
rpc UpdateWorkstation(UpdateWorkstationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{workstation.name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}"
body: "workstation"
};
option (google.api.method_signature) = "workstation,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Workstation"
metadata_type: "OperationMetadata"
};
}
// Deletes the specified workstation.
rpc DeleteWorkstation(DeleteWorkstationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "Workstation"
metadata_type: "OperationMetadata"
};
}
// Starts running a workstation so that users can connect to it.
rpc StartWorkstation(StartWorkstationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}:start"
body: "*"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "Workstation"
metadata_type: "OperationMetadata"
};
}
// Stops running a workstation, reducing costs.
rpc StopWorkstation(StopWorkstationRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}:stop"
body: "*"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "Workstation"
metadata_type: "OperationMetadata"
};
}
// Returns a short-lived credential that can be used to send authenticated and
// authorized traffic to a workstation.
rpc GenerateAccessToken(GenerateAccessTokenRequest)
returns (GenerateAccessTokenResponse) {
option (google.api.http) = {
post: "/v1/{workstation=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}:generateAccessToken"
body: "*"
};
option (google.api.method_signature) = "workstation";
}
}
// A workstation cluster resource in the Cloud Workstations API.
//
// Defines a group of workstations in a particular region and the
// VPC network they're attached to.
message WorkstationCluster {
option (google.api.resource) = {
type: "workstations.googleapis.com/WorkstationCluster"
pattern: "projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}"
plural: "workstationClusters"
singular: "workstationCluster"
style: DECLARATIVE_FRIENDLY
};
// Configuration options for private workstation clusters.
message PrivateClusterConfig {
// Immutable. Whether Workstations endpoint is private.
bool enable_private_endpoint = 1 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Hostname for the workstation cluster. This field will be
// populated only when private endpoint is enabled. To access workstations
// in the workstation cluster, create a new DNS zone mapping this domain
// name to an internal IP address and a forwarding rule mapping that address
// to the service attachment.
string cluster_hostname = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Service attachment URI for the workstation cluster. The
// service attachemnt is created when private endpoint is enabled. To access
// workstations in the workstation cluster, configure access to the managed
// service using [Private Service
// Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
string service_attachment_uri = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Additional projects that are allowed to attach to the
// workstation cluster's service attachment. By default, the workstation
// cluster's project and the VPC host project (if different) are allowed.
repeated string allowed_projects = 4
[(google.api.field_behavior) = OPTIONAL];
}
// Full name of this workstation cluster.
string name = 1;
// Optional. Human-readable name for this workstation cluster.
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
// Output only. A system-assigned unique identifier for this workstation
// cluster.
string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Indicates whether this workstation cluster is currently being
// updated to match its intended state.
bool reconciling = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Client-specified annotations.
map<string, string> annotations = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional.
// [Labels](https://cloud.google.com/workstations/docs/label-resources) that
// are applied to the workstation cluster and that are also propagated to the
// underlying Compute Engine resources.
map<string, string> labels = 15 [(google.api.field_behavior) = OPTIONAL];
// Output only. Time when this workstation cluster was created.
google.protobuf.Timestamp create_time = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this workstation cluster was most recently updated.
google.protobuf.Timestamp update_time = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this workstation cluster was soft-deleted.
google.protobuf.Timestamp delete_time = 8
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Checksum computed by the server. May be sent on update and delete
// requests to make sure that the client has an up-to-date value before
// proceeding.
string etag = 9 [(google.api.field_behavior) = OPTIONAL];
// Immutable. Name of the Compute Engine network in which instances associated
// with this workstation cluster will be created.
string network = 10 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Name of the Compute Engine subnetwork in which instances
// associated with this workstation cluster will be created. Must be part of
// the subnetwork specified for this workstation cluster.
string subnetwork = 11 [(google.api.field_behavior) = IMMUTABLE];
// Output only. The private IP address of the control plane for this
// workstation cluster. Workstation VMs need access to this IP address to work
// with the service, so make sure that your firewall rules allow egress from
// the workstation VMs to this address.
string control_plane_ip = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Configuration for private workstation cluster.
PrivateClusterConfig private_cluster_config = 12
[(google.api.field_behavior) = OPTIONAL];
// Output only. Whether this workstation cluster is in degraded mode, in which
// case it may require user action to restore full functionality. Details can
// be found in
// [conditions][google.cloud.workstations.v1.WorkstationCluster.conditions].
bool degraded = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Status conditions describing the workstation cluster's current
// state.
repeated google.rpc.Status conditions = 14
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// A workstation configuration resource in the Cloud Workstations API.
//
// Workstation configurations act as templates for workstations. The workstation
// configuration defines details such as the workstation virtual machine (VM)
// instance type, persistent storage, container image defining environment,
// which IDE or Code Editor to use, and more. Administrators and platform teams
// can also use [Identity and Access Management
// (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to
// teams or to individual developers.
message WorkstationConfig {
option (google.api.resource) = {
type: "workstations.googleapis.com/WorkstationConfig"
pattern: "projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}"
plural: "workstationConfigs"
singular: "workstationConfig"
style: DECLARATIVE_FRIENDLY
};
// Runtime host for a workstation.
message Host {
// A runtime using a Compute Engine instance.
message GceInstance {
// A set of Compute Engine Shielded instance options.
message GceShieldedInstanceConfig {
// Optional. Whether the instance has Secure Boot enabled.
bool enable_secure_boot = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. Whether the instance has the vTPM enabled.
bool enable_vtpm = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Whether the instance has integrity monitoring enabled.
bool enable_integrity_monitoring = 3
[(google.api.field_behavior) = OPTIONAL];
}
// A set of Compute Engine Confidential VM instance options.
message GceConfidentialInstanceConfig {
// Optional. Whether the instance has confidential compute enabled.
bool enable_confidential_compute = 1
[(google.api.field_behavior) = OPTIONAL];
}
// Optional. The type of machine to use for VM instances—for example,
// `"e2-standard-4"`. For more information about machine types that
// Cloud Workstations supports, see the list of
// [available machine
// types](https://cloud.google.com/workstations/docs/available-machine-types).
string machine_type = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. The email address of the service account for Cloud
// Workstations VMs created with this configuration. When specified, be
// sure that the service account has `logginglogEntries.create` permission
// on the project so it can write logs out to Cloud Logging. If using a
// custom container image, the service account must have permissions to
// pull the specified image.
//
// If you as the administrator want to be able to `ssh` into the
// underlying VM, you need to set this value to a service account
// for which you have the `iam.serviceAccounts.actAs` permission.
// Conversely, if you don't want anyone to be able to `ssh` into the
// underlying VM, use a service account where no one has that
// permission.
//
// If not set, VMs run with a service account provided by the
// Cloud Workstations service, and the image must be publicly
// accessible.
string service_account = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Scopes to grant to the
// [service_account][google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.service_account].
// Various scopes are automatically added based on feature usage. When
// specified, users of workstations under this configuration must have
// `iam.serviceAccounts.actAs` on the service account.
repeated string service_account_scopes = 3
[(google.api.field_behavior) = OPTIONAL];
// Optional. Network tags to add to the Compute Engine VMs backing the
// workstations. This option applies
// [network
// tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs
// created with this configuration. These network tags enable the creation
// of [firewall
// rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).
repeated string tags = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. The number of VMs that the system should keep idle so that
// new workstations can be started quickly for new users. Defaults to `0`
// in the API.
int32 pool_size = 5 [(google.api.field_behavior) = OPTIONAL];
// Output only. Number of instances currently available in the pool for
// faster workstation startup.
int32 pooled_instances = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. When set to true, disables public IP addresses for VMs. If
// you disable public IP addresses, you must set up Private Google Access
// or Cloud NAT on your network. If you use Private Google Access and you
// use `private.googleapis.com` or `restricted.googleapis.com` for
// Container Registry and Artifact Registry, make sure that you set
// up DNS records for domains `*.gcr.io` and `*.pkg.dev`.
// Defaults to false (VMs have public IP addresses).
bool disable_public_ip_addresses = 6
[(google.api.field_behavior) = OPTIONAL];
// Optional. Whether to enable nested virtualization on Cloud Workstations
// VMs created under this workstation configuration.
//
// Nested virtualization lets you run virtual machine (VM) instances
// inside your workstation. Before enabling nested virtualization,
// consider the following important considerations. Cloud Workstations
// instances are subject to the [same restrictions as Compute Engine
// instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions):
//
// * **Organization policy**: projects, folders, or
// organizations may be restricted from creating nested VMs if the
// **Disable VM nested virtualization** constraint is enforced in
// the organization policy. For more information, see the
// Compute Engine section,
// [Checking whether nested virtualization is
// allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed).
// * **Performance**: nested VMs might experience a 10% or greater
// decrease in performance for workloads that are CPU-bound and
// possibly greater than a 10% decrease for workloads that are
// input/output bound.
// * **Machine Type**: nested virtualization can only be enabled on
// workstation configurations that specify a
// [machine_type][google.cloud.workstations.v1.WorkstationConfig.Host.GceInstance.machine_type]
// in the N1 or N2 machine series.
// * **GPUs**: nested virtualization may not be enabled on workstation
// configurations with accelerators.
// * **Operating System**: Because
// [Container-Optimized
// OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos)
// does not support nested virtualization, when nested virtualization is
// enabled, the underlying Compute Engine VM instances boot from an
// [Ubuntu
// LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts)
// image.
bool enable_nested_virtualization = 7
[(google.api.field_behavior) = OPTIONAL];
// Optional. A set of Compute Engine Shielded instance options.
GceShieldedInstanceConfig shielded_instance_config = 8
[(google.api.field_behavior) = OPTIONAL];
// Optional. A set of Compute Engine Confidential VM instance options.
GceConfidentialInstanceConfig confidential_instance_config = 10
[(google.api.field_behavior) = OPTIONAL];
// Optional. The size of the boot disk for the VM in gigabytes (GB).
// The minimum boot disk size is `30` GB. Defaults to `50` GB.
int32 boot_disk_size_gb = 9 [(google.api.field_behavior) = OPTIONAL];
}
// Type of host that will be used for the workstation's runtime.
oneof config {
// Specifies a Compute Engine instance as the host.
GceInstance gce_instance = 1;
}
}
// A directory to persist across workstation sessions.
message PersistentDirectory {
// A PersistentDirectory backed by a Compute Engine regional persistent
// disk. The
// [persistent_directories][google.cloud.workstations.v1.WorkstationConfig.persistent_directories]
// field is repeated, but it may contain only one entry. It creates a
// [persistent
// disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that
// mounts to the workstation VM at `/home` when the session starts and
// detaches when the session ends. If this field is empty, workstations
// created with this configuration do not have a persistent home
// directory.
message GceRegionalPersistentDisk {
// Value representing what should happen to the disk after the workstation
// is deleted.
enum ReclaimPolicy {
// Do not use.
RECLAIM_POLICY_UNSPECIFIED = 0;
// Delete the persistent disk when deleting the workstation.
DELETE = 1;
// Keep the persistent disk when deleting the workstation.
// An administrator must manually delete the disk.
RETAIN = 2;
}
// Optional. The GB capacity of a persistent home directory for each
// workstation created with this configuration. Must be empty if
// [source_snapshot][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.source_snapshot]
// is set.
//
// Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`.
// Defaults to `200`. If less than `200` GB, the
// [disk_type][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.disk_type]
// must be
// `"pd-balanced"` or `"pd-ssd"`.
int32 size_gb = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. Type of file system that the disk should be formatted with.
// The workstation image must support this file system type. Must be empty
// if
// [source_snapshot][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.source_snapshot]
// is set. Defaults to `"ext4"`.
string fs_type = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. The [type of the persistent
// disk](https://cloud.google.com/compute/docs/disks#disk-types) for the
// home directory. Defaults to `"pd-standard"`.
string disk_type = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Name of the snapshot to use as the source for the disk. If
// set,
// [size_gb][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.size_gb]
// and
// [fs_type][google.cloud.workstations.v1.WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.fs_type]
// must be empty.
string source_snapshot = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. Whether the persistent disk should be deleted when the
// workstation is deleted. Valid values are `DELETE` and `RETAIN`.
// Defaults to `DELETE`.
ReclaimPolicy reclaim_policy = 4 [(google.api.field_behavior) = OPTIONAL];
}
// How a persistent directory should be implemented.
oneof directory_type {
// A PersistentDirectory backed by a Compute Engine persistent disk.
GceRegionalPersistentDisk gce_pd = 2;
}
// Optional. Location of this directory in the running workstation.
string mount_path = 1 [(google.api.field_behavior) = OPTIONAL];
}
// A Docker container.
message Container {
// Optional. A Docker container image that defines a custom environment.
//
// Cloud Workstations provides a number of
// [preconfigured
// images](https://cloud.google.com/workstations/docs/preconfigured-base-images),
// but you can create your own
// [custom container
// images](https://cloud.google.com/workstations/docs/custom-container-images).
// If using a private image, the `host.gceInstance.serviceAccount` field
// must be specified in the workstation configuration and must have
// permission to pull the specified image. Otherwise, the image must be
// publicly accessible.
string image = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, overrides the default ENTRYPOINT specified by the
// image.
repeated string command = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. Arguments passed to the entrypoint.
repeated string args = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Environment variables passed to the container's entrypoint.
map<string, string> env = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, overrides the default DIR specified by the image.
string working_dir = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, overrides the USER specified in the image with the
// given uid.
int32 run_as_user = 6 [(google.api.field_behavior) = OPTIONAL];
}
// A customer-managed encryption key (CMEK) for the Compute Engine
// resources of the associated workstation configuration. Specify the name of
// your Cloud KMS encryption key and the default service account.
// We recommend that you use a separate service account and follow
// [Cloud KMS best
// practices](https://cloud.google.com/kms/docs/separation-of-duties).
message CustomerEncryptionKey {
// Immutable. The name of the Google Cloud KMS encryption key. For example,
// `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`.
// The key must be in the same region as the workstation configuration.
string kms_key = 1 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. The service account to use with the specified
// KMS key. We recommend that you use a separate service account
// and follow KMS best practices. For more information, see
// [Separation of
// duties](https://cloud.google.com/kms/docs/separation-of-duties) and
// `gcloud kms keys add-iam-policy-binding`
// [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
string kms_key_service_account = 2
[(google.api.field_behavior) = IMMUTABLE];
}
// A readiness check to be performed on a workstation.
message ReadinessCheck {
// Optional. Path to which the request should be sent.
string path = 1 [(google.api.field_behavior) = OPTIONAL];
// Optional. Port to which the request should be sent.
int32 port = 2 [(google.api.field_behavior) = OPTIONAL];
}
// Full name of this workstation configuration.
string name = 1;
// Optional. Human-readable name for this workstation configuration.
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
// Output only. A system-assigned unique identifier for this workstation
// configuration.
string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Indicates whether this workstation configuration is currently
// being updated to match its intended state.
bool reconciling = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Client-specified annotations.
map<string, string> annotations = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional.
// [Labels](https://cloud.google.com/workstations/docs/label-resources) that
// are applied to the workstation configuration and that are also propagated
// to the underlying Compute Engine resources.
map<string, string> labels = 18 [(google.api.field_behavior) = OPTIONAL];
// Output only. Time when this workstation configuration was created.
google.protobuf.Timestamp create_time = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this workstation configuration was most recently
// updated.
google.protobuf.Timestamp update_time = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this workstation configuration was soft-deleted.
google.protobuf.Timestamp delete_time = 8
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Checksum computed by the server. May be sent on update and delete
// requests to make sure that the client has an up-to-date value before
// proceeding.
string etag = 9 [(google.api.field_behavior) = OPTIONAL];
// Optional. Number of seconds to wait before automatically stopping a
// workstation after it last received user traffic.
//
// A value of `"0s"` indicates that Cloud Workstations VMs created with this
// configuration should never time out due to idleness.
// Provide
// [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration)
// terminated by `s` for seconds—for example, `"7200s"` (2 hours).
// The default is `"1200s"` (20 minutes).
google.protobuf.Duration idle_timeout = 10
[(google.api.field_behavior) = OPTIONAL];
// Optional. Number of seconds that a workstation can run until it is
// automatically shut down. We recommend that workstations be shut down daily
// to reduce costs and so that security updates can be applied upon restart.
// The
// [idle_timeout][google.cloud.workstations.v1.WorkstationConfig.idle_timeout]
// and
// [running_timeout][google.cloud.workstations.v1.WorkstationConfig.running_timeout]
// fields are independent of each other. Note that the
// [running_timeout][google.cloud.workstations.v1.WorkstationConfig.running_timeout]
// field shuts down VMs after the specified time, regardless of whether or not
// the VMs are idle.
//
// Provide duration terminated by `s` for seconds—for example, `"54000s"`
// (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates
// that workstations using this configuration should never time out. If
// [encryption_key][google.cloud.workstations.v1.WorkstationConfig.encryption_key]
// is set, it must be greater than `"0s"` and less than
// `"86400s"` (24 hours).
//
// Warning: A value of `"0s"` indicates that Cloud Workstations VMs created
// with this configuration have no maximum running time. This is strongly
// discouraged because you incur costs and will not pick up security updates.
google.protobuf.Duration running_timeout = 11
[(google.api.field_behavior) = OPTIONAL];
// Optional. Runtime host for the workstation.
Host host = 12 [(google.api.field_behavior) = OPTIONAL];
// Optional. Directories to persist across workstation sessions.
repeated PersistentDirectory persistent_directories = 13
[(google.api.field_behavior) = OPTIONAL];
// Optional. Container that runs upon startup for each workstation using this
// workstation configuration.
Container container = 14 [(google.api.field_behavior) = OPTIONAL];
// Immutable. Encrypts resources of this workstation configuration using a
// customer-managed encryption key (CMEK).
//
// If specified, the boot disk of the Compute Engine instance and the
// persistent disk are encrypted using this encryption key. If
// this field is not set, the disks are encrypted using a generated
// key. Customer-managed encryption keys do not protect disk metadata.
//
// If the customer-managed encryption key is rotated, when the workstation
// instance is stopped, the system attempts to recreate the
// persistent disk with the new version of the key. Be sure to keep
// older versions of the key until the persistent disk is recreated.
// Otherwise, data on the persistent disk might be lost.
//
// If the encryption key is revoked, the workstation session automatically
// stops within 7 hours.
//
// Immutable after the workstation configuration is created.
CustomerEncryptionKey encryption_key = 17
[(google.api.field_behavior) = IMMUTABLE];
// Optional. Readiness checks to perform when starting a workstation using
// this workstation configuration. Mark a workstation as running only after
// all specified readiness checks return 200 status codes.
repeated ReadinessCheck readiness_checks = 19
[(google.api.field_behavior) = OPTIONAL];
// Optional. Immutable. Specifies the zones used to replicate the VM and disk
// resources within the region. If set, exactly two zones within the
// workstation cluster's region must be specified—for example,
// `['us-central1-a', 'us-central1-f']`. If this field is empty, two default
// zones within the region are used.
//
// Immutable after the workstation configuration is created.
repeated string replica_zones = 23 [
(google.api.field_behavior) = OPTIONAL,
(google.api.field_behavior) = IMMUTABLE
];
// Output only. Whether this resource is degraded, in which case it may
// require user action to restore full functionality. See also the
// [conditions][google.cloud.workstations.v1.WorkstationConfig.conditions]
// field.
bool degraded = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Status conditions describing the current resource state.
repeated google.rpc.Status conditions = 16
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// A single instance of a developer workstation with its own persistent storage.
message Workstation {
option (google.api.resource) = {
type: "workstations.googleapis.com/Workstation"
pattern: "projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation}"
plural: "workstations"
singular: "workstation"
style: DECLARATIVE_FRIENDLY
};
// Whether a workstation is running and ready to receive user requests.
enum State {
// Do not use.
STATE_UNSPECIFIED = 0;
// The workstation is not yet ready to accept requests from users but will
// be soon.
STATE_STARTING = 1;
// The workstation is ready to accept requests from users.
STATE_RUNNING = 2;
// The workstation is being stopped.
STATE_STOPPING = 3;
// The workstation is stopped and will not be able to receive requests until
// it is started.
STATE_STOPPED = 4;
}
// Full name of this workstation.
string name = 1;
// Optional. Human-readable name for this workstation.
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
// Output only. A system-assigned unique identifier for this workstation.
string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Indicates whether this workstation is currently being updated
// to match its intended state.
bool reconciling = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Client-specified annotations.
map<string, string> annotations = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional.
// [Labels](https://cloud.google.com/workstations/docs/label-resources) that
// are applied to the workstation and that are also propagated to the
// underlying Compute Engine resources.
map<string, string> labels = 13 [(google.api.field_behavior) = OPTIONAL];
// Output only. Time when this workstation was created.
google.protobuf.Timestamp create_time = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this workstation was most recently updated.
google.protobuf.Timestamp update_time = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this workstation was most recently successfully
// started, regardless of the workstation's initial state.
google.protobuf.Timestamp start_time = 14
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time when this workstation was soft-deleted.
google.protobuf.Timestamp delete_time = 8
[(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Checksum computed by the server. May be sent on update and delete
// requests to make sure that the client has an up-to-date value before
// proceeding.
string etag = 9 [(google.api.field_behavior) = OPTIONAL];
// Output only. Current state of the workstation.
State state = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Host to which clients can send HTTPS traffic that will be
// received by the workstation. Authorized traffic will be received to the
// workstation as HTTP on port 80. To send traffic to a different port,
// clients may prefix the host with the destination port in the format
// `{port}-{host}`.
string host = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Request message for GetWorkstationCluster.
message GetWorkstationClusterRequest {
// Required. Name of the requested resource.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "workstations.googleapis.com/WorkstationCluster"
}
];
}
// Request message for ListWorkstationClusters.
message ListWorkstationClustersRequest {
// Required. Parent resource name.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "workstations.googleapis.com/WorkstationCluster"
}
];
// Optional. Maximum number of items to return.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. next_page_token value returned from a previous List request, if
// any.
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Response message for ListWorkstationClusters.
message ListWorkstationClustersResponse {
// The requested workstation clusters.
repeated WorkstationCluster workstation_clusters = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
// Unreachable resources.
repeated string unreachable = 3;
}
// Message for creating a CreateWorkstationCluster.
message CreateWorkstationClusterRequest {
// Required. Parent resource name.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "workstations.googleapis.com/WorkstationCluster"
}
];
// Required. ID to use for the workstation cluster.
string workstation_cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Workstation cluster to create.
WorkstationCluster workstation_cluster = 3
[(google.api.field_behavior) = REQUIRED];
// Optional. If set, validate the request and preview the review, but do not
// actually apply it.
bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Request message for UpdateWorkstationCluster.
message UpdateWorkstationClusterRequest {
// Required. Workstation cluster to update.
WorkstationCluster workstation_cluster = 1
[(google.api.field_behavior) = REQUIRED];
// Required. Mask that specifies which fields in the workstation cluster
// should be updated.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
// Optional. If set, validate the request and preview the review, but do not
// actually apply it.
bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. If set, and the workstation cluster is not found, a new
// workstation cluster will be created. In this situation, update_mask is
// ignored.
bool allow_missing = 4 [(google.api.field_behavior) = OPTIONAL];
}
// Message for deleting a workstation cluster.