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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="gkehub_v1alpha.html">GKE Hub</a> . <a href="gkehub_v1alpha.projects.html">projects</a> . <a href="gkehub_v1alpha.projects.locations.html">locations</a> . <a href="gkehub_v1alpha.projects.locations.global_.html">global_</a> . <a href="gkehub_v1alpha.projects.locations.global_.features.html">features</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a new Feature.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a Feature.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Feature.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Features in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing Feature.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, featureId=None, requestId=None, x__xgafv=None)</code>
<pre>Adds a new Feature.
Args:
parent: string, The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/global`. (required)
body: object, The request body.
The object takes the form of:
{ # Feature represents the settings and status of any Hub Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"labels": { # GCP labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"configmanagement": { # State for Anthos Config Management # Config Management-specific state.
"binauthzState": { # State for Binauthz # Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.
"configSyncState": { # State information for ConfigSync # Current sync status
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616)
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"metering": { # Metering per-Membership Feature State. # Metering-specific spec.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"servicemesh": { # MembershipState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for single Membership. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
"cloudauditlogging": { # Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.
"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)
"A String",
],
},
"multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
},
"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
"servicemesh": { # FeatureState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for the whole Hub. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"updateTime": "A String", # Output only. When the Feature resource was last updated.
}
featureId: string, The ID of the feature to create.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
<pre>Removes a Feature.
Args:
name: string, The Feature resource name in the format `projects/*/locations/global/features/*`. (required)
force: boolean, If set to true, the delete will ignore any outstanding resources for this Feature (that is, `FeatureState.has_resources` is set to true). These resources will NOT be cleaned up or modified in any way.
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Feature.
Args:
name: string, The Feature resource name in the format `projects/*/locations/global/features/*` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Feature represents the settings and status of any Hub Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"labels": { # GCP labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"configmanagement": { # State for Anthos Config Management # Config Management-specific state.
"binauthzState": { # State for Binauthz # Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.
"configSyncState": { # State information for ConfigSync # Current sync status
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616)
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"metering": { # Metering per-Membership Feature State. # Metering-specific spec.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"servicemesh": { # MembershipState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for single Membership. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
"cloudauditlogging": { # Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.
"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)
"A String",
],
},
"multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
},
"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
"servicemesh": { # FeatureState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for the whole Hub. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"updateTime": "A String", # Output only. When the Feature resource was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Features in a given project and location.
Args:
parent: string, The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/global`. (required)
filter: string, Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called `foo`: labels.foo:* - Features that have a label called `foo` whose value is `bar`: labels.foo = bar
orderBy: string, One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
pageSize: integer, When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
pageToken: string, Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the `GkeHub.ListFeatures` method.
"nextPageToken": "A String", # A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return.
"resources": [ # The list of matching Features
{ # Feature represents the settings and status of any Hub Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"labels": { # GCP labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"configmanagement": { # State for Anthos Config Management # Config Management-specific state.
"binauthzState": { # State for Binauthz # Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.
"configSyncState": { # State information for ConfigSync # Current sync status
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616)
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"metering": { # Metering per-Membership Feature State. # Metering-specific spec.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"servicemesh": { # MembershipState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for single Membership. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
"cloudauditlogging": { # Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.
"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)
"A String",
],
},
"multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
},
"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
"servicemesh": { # FeatureState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for the whole Hub. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"updateTime": "A String", # Output only. When the Feature resource was last updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing Feature.
Args:
name: string, The Feature resource name in the format `projects/*/locations/global/features/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Feature represents the settings and status of any Hub Feature.
"createTime": "A String", # Output only. When the Feature resource was created.
"deleteTime": "A String", # Output only. When the Feature resource was deleted.
"labels": { # GCP labels for this Feature.
"a_key": "A String",
},
"membershipSpecs": { # Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature.
"a_key": { # MembershipFeatureSpec contains configuration information for a single Membership.
"configmanagement": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
},
},
"membershipStates": { # Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: projects/{p}/locations/{l}/memberships/{m} Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number.
"a_key": { # MembershipFeatureState contains Feature status information for a single Membership.
"configmanagement": { # State for Anthos Config Management # Config Management-specific state.
"binauthzState": { # State for Binauthz # Binauthz status
"version": { # The version of binauthz. # The version of binauthz that is installed.
"webhookVersion": "A String", # The version of the binauthz webhook.
},
"webhook": "A String", # The state of the binauthz webhook.
},
"clusterName": "A String", # The user-defined name for the cluster used by ClusterSelectors to group clusters together. This should match Membership's membership_name, unless the user installed ACM on the cluster manually prior to enabling the ACM hub feature. Unique within a Anthos Config Management installation.
"configSyncState": { # State information for ConfigSync # Current sync status
"deploymentState": { # The state of ConfigSync's deployment on a cluster # Information about the deployment of ConfigSync, including the version of the various Pods deployed
"gitSync": "A String", # Deployment state of the git-sync pod
"importer": "A String", # Deployment state of the importer pod
"monitor": "A String", # Deployment state of the monitor pod
"reconcilerManager": "A String", # Deployment state of reconciler-manager pod
"rootReconciler": "A String", # Deployment state of root-reconciler
"syncer": "A String", # Deployment state of the syncer pod
},
"syncState": { # State indicating an ACM's progress syncing configurations to a cluster # The state of ConfigSync's process to sync configs to a cluster
"code": "A String", # Sync status code
"errors": [ # A list of errors resulting from problematic configs. This list will be truncated after 100 errors, although it is unlikely for that many errors to simultaneously exist.
{ # An ACM created error representing a problem syncing configurations
"code": "A String", # An ACM defined error code
"errorMessage": "A String", # A description of the error
"errorResources": [ # A list of config(s) associated with the error, if any
{ # Model for a config file in the git repo with an associated Sync error
"resourceGvk": { # A Kubernetes object's GVK # Group/version/kind of the resource that is causing an error
"group": "A String", # Kubernetes Group
"kind": "A String", # Kubernetes Kind
"version": "A String", # Kubernetes Version
},
"resourceName": "A String", # Metadata name of the resource that is causing an error
"resourceNamespace": "A String", # Namespace of the resource that is causing an error
"sourcePath": "A String", # Path in the git repo of the erroneous config
},
],
},
],
"importToken": "A String", # Token indicating the state of the importer.
"lastSync": "A String", # Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String This field is being deprecated. Use last_sync_time instead. (b/154053616)
"lastSyncTime": "A String", # Timestamp type of when ACM last successfully synced the repo
"sourceToken": "A String", # Token indicating the state of the repo.
"syncToken": "A String", # Token indicating the state of the syncer.
},
"version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed
"gitSync": "A String", # Version of the deployed git-sync pod
"importer": "A String", # Version of the deployed importer pod
"monitor": "A String", # Version of the deployed monitor pod
"reconcilerManager": "A String", # Version of the deployed reconciler-manager pod
"rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod
"syncer": "A String", # Version of the deployed syncer pod
},
},
"hierarchyControllerState": { # State for Hierarchy Controller # Hierarchy Controller status
"state": { # Deployment state for Hierarchy Controller # The deployment state for Hierarchy Controller
"extension": "A String", # The deployment state for Hierarchy Controller extension (e.g. v0.7.0-hc.1)
"hnc": "A String", # The deployment state for open source HNC (e.g. v0.7.0-hc.0)
},
"version": { # Version for Hierarchy Controller # The version for Hierarchy Controller
"extension": "A String", # Version for Hierarchy Controller extension
"hnc": "A String", # Version for open source HNC
},
},
"membershipSpec": { # Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Membership configuration in the cluster. This represents the actual state in the cluster, while the MembershipSpec in the FeatureSpec represents the intended state
"binauthz": { # Configuration for Binauthz # Binauthz conifguration for the cluster.
"enabled": True or False, # Whether binauthz is enabled in this cluster.
},
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The GCP Service Account Email used for auth when secret_type is gcpServiceAccount.
"httpsProxy": "A String", # URL for the HTTPS proxy to be used when communicating with the Git repo.
"policyDir": "A String", # The path within the Git repository that represents the top level of the repo to sync. Default: the root directory of the repository.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncBranch": "A String", # The branch of the repository to sync from. Default: master.
"syncRepo": "A String", # The URL of the Git repository to use as the source of truth.
"syncRev": "A String", # Git revision (tag or hash) to check out. Default HEAD.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"sourceFormat": "A String", # Specifies whether the Config Sync Repo is in “hierarchical” or “unstructured” mode.
},
"hierarchyController": { # Configuration for Hierarchy Controller # Hierarchy Controller configuration for the cluster.
"enableHierarchicalResourceQuota": True or False, # Whether hierarchical resource quota is enabled in this cluster.
"enablePodTreeLabels": True or False, # Whether pod tree labels are enabled in this cluster.
"enabled": True or False, # Whether Hierarchy Controller is enabled in this cluster.
},
"policyController": { # Configuration for Policy Controller # Policy Controller configuration for the cluster.
"auditIntervalSeconds": "A String", # Sets the interval for Policy Controller Audit Scans (in seconds). When set to 0, this disables audit functionality altogether.
"enabled": True or False, # Enables the installation of Policy Controller. If false, the rest of PolicyController fields take no effect.
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
"templateLibraryInstalled": True or False, # Installs the default template library along with Policy Controller.
},
"version": "A String", # Version of ACM installed.
},
"operatorState": { # State information for an ACM's Operator # Current install status of ACM's Operator
"deploymentState": "A String", # The state of the Operator's deployment
"errors": [ # Install errors.
{ # Errors pertaining to the installation of ACM
"errorMessage": "A String", # A string representing the user facing error message
},
],
"version": "A String", # The semenatic version number of the operator
},
"policyControllerState": { # State for PolicyControllerState. # PolicyController status
"deploymentState": { # State of Policy Controller installation. # The state about the policy controller installation.
"gatekeeperAudit": "A String", # Status of gatekeeper-audit deployment.
"gatekeeperControllerManagerState": "A String", # Status of gatekeeper-controller-manager pod.
},
"version": { # The build version of Gatekeeper Policy Controller is using. # The version of Gatekeeper Policy Controller deployed.
"version": "A String", # The gatekeeper image tag that is composed of ACM version, git tag, build number.
},
},
},
"metering": { # Metering per-Membership Feature State. # Metering-specific spec.
"lastMeasurementTime": "A String", # The time stamp of the most recent measurement of the number of vCPUs in the cluster.
"preciseLastMeasuredClusterVcpuCapacity": 3.14, # The vCPUs capacity in the cluster according to the most recent measurement (1/1000 precision).
},
"servicemesh": { # MembershipState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for single Membership. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # The high-level state of this Feature for a single membership.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
},
"name": "A String", # Output only. The full, unique name of this Feature resource in the format `projects/*/locations/global/features/*`.
"resourceState": { # FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. # Output only. State of the Feature resource itself.
"state": "A String", # The current state of the Feature resource in the Hub API.
},
"spec": { # CommonFeatureSpec contains Hub-wide configuration information # Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
"cloudauditlogging": { # Spec for Audit Logging Allowlisting. # Cloud Audit Logging-specific spec.
"allowlistedServiceAccounts": [ # Service account that should be allowlisted to send the audit logs; eg cloudauditlogging@gcp-project.iam.gserviceaccount.com. These accounts must already exist, but do not need to have any permissions granted to them. The customer's entitlements will be checked prior to allowlisting (i.e. the customer must be an Anthos customer.)
"A String",
],
},
"multiclusteringress": { # FeatureSpec contains the input for the MultiClusterIngress feature. # Multicluster Ingress-specific spec.
"configMembership": "A String", # Fully-qualified Membership name which hosts the MultiClusterIngress CRD. Example: `projects/foo-proj/locations/global/memberships/bar`
},
},
"state": { # CommonFeatureState contains Hub-wide Feature status information. # Output only. The Hub-wide Feature state.
"servicemesh": { # FeatureState describes the state of the Service Mesh Hub Feature as analyzed by the Service Mesh Hub Controller, for the whole Hub. # Service Mesh-specific state.
"analysisMessages": [ # Output only. Results of running Service Mesh analyzers.
{ # AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.
"args": { # A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.
"a_key": "", # Properties of the object.
},
"description": "A String", # A human readable description of what the error means. It is suitable for non-internationalize display purposes.
"messageBase": { # AnalysisMessageBase describes some common information that is needed for all messages. # Details common to all types of Istio and ServiceMesh analysis messages.
"documentationUrl": "A String", # A url pointing to the Service Mesh or Istio documentation for this specific error type.
"level": "A String", # Represents how severe a message is.
"type": { # A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type # Represents the specific type of a message.
"code": "A String", # A 7 character code matching `^IST[0-9]{4}$` or `^ASM[0-9]{4}$`, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)
"displayName": "A String", # A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the `name` field in open-source Istio.)
},
},
"resourcePaths": [ # A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
"A String",
],
},
],
},
"state": { # FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context. # Output only. The "running state" of the Feature in this Hub.
"code": "A String", # The high-level, machine-readable status of this Feature.
"description": "A String", # A human-readable description of the current status.
"updateTime": "A String", # The time this status and any related Feature-specific details were updated.
},
},
"updateTime": "A String", # Output only. When the Feature resource was last updated.
}
requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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).
updateMask: string, Mask of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
