-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
gkehub_v1.projects.locations.features.html
3810 lines (3751 loc) 路 445 KB
/
gkehub_v1.projects.locations.features.html
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
<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_v1.html">GKE Hub API</a> . <a href="gkehub_v1.projects.html">projects</a> . <a href="gkehub_v1.projects.locations.html">locations</a> . <a href="gkehub_v1.projects.locations.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="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</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()</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>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</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, Required. The parent (project and location) where the Feature will be created. Specified in the format `projects/*/locations/*`. (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.
"fleetDefaultMemberConfig": { # CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet # Optional. Feature configuration applicable to all memberships of the fleet.
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"cluster": "A String", # The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.
"enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The Google Cloud 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. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.
"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.
},
"metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.
"oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncRepo": "A String", # The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"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.
},
"management": "A String", # Enables automatic Feature management.
"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.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"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.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Version of ACM installed.
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Enables automatic Service Mesh management.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # 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.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller installed.
},
},
"labels": { # 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. NOTE: Please use snake case in your feature name.
"configmanagement": { # **Anthos Config Management**: Configuration for a single cluster. Intended to parallel the ConfigManagement CR. # Config Management-specific spec.
"cluster": "A String", # The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.
"enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The Google Cloud 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. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.
"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.
},
"metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.
"oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncRepo": "A String", # The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"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.
},
"management": "A String", # Enables automatic Feature management.
"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.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"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.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"version": "A String", # Version of ACM installed.
},
"fleetobservability": { # **FleetObservability**: The membership-specific input for FleetObservability feature. # Fleet observability membership spec
},
"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec.
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
},
"mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec
"controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management.
"management": "A String", # Enables automatic Service Mesh management.
},
"origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly.
"type": "A String", # Type specifies which type of origin is set.
},
"policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec.
"policyControllerHubConfig": { # 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.
"constraintViolationLimit": "A String", # The maximum number of audit violations to be stored in a constraint. If not set, the internal default (currently 20) will be used.
"deploymentConfigs": { # Map of deployment configs to deployments ("admission", "audit", "mutation').
"a_key": { # Deployment-specific configuration.
"containerResources": { # ResourceRequirements describes the compute resource requirements. # Container resource requirements.
"limits": { # ResourceList contains container resource requirements. # Limits describes the maximum amount of compute resources allowed for use by the running container.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
"requests": { # ResourceList contains container resource requirements. # Requests describes the amount of compute resources reserved for the container by the kube-scheduler.
"cpu": "A String", # CPU requirement expressed in Kubernetes resource units.
"memory": "A String", # Memory requirement expressed in Kubernetes resource units.
},
},
"podAffinity": "A String", # Pod affinity configuration.
"podAntiAffinity": True or False, # Pod anti-affinity enablement. Deprecated: use `pod_affinity` instead.
"podTolerations": [ # Pod tolerations of node taints.
{ # Toleration of a node taint.
"effect": "A String", # Matches a taint effect.
"key": "A String", # Matches a taint key (not necessarily unique).
"operator": "A String", # Matches a taint operator.
"value": "A String", # Matches a taint value.
},
],
"replicaCount": "A String", # Pod replica count.
},
},
"exemptableNamespaces": [ # The set of namespaces that are excluded from Policy Controller checks. Namespaces do not need to currently exist on the cluster.
"A String",
],
"installSpec": "A String", # The install_spec represents the intended state specified by the latest request that mutated install_spec in the feature spec, not the lifecycle state of the feature observed by the Hub feature controller that is reported in the feature state.
"logDeniesEnabled": True or False, # Logs all denies and dry run failures.
"monitoring": { # MonitoringConfig specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller.
"policyContent": { # PolicyContentSpec defines the user's desired content configuration on the cluster. # Specifies the desired policy content on the cluster
"bundles": { # map of bundle name to BundleInstallSpec. The bundle name maps to the `bundleName` key in the `policycontroller.gke.io/constraintData` annotation on a constraint.
"a_key": { # BundleInstallSpec is the specification configuration for a single managed bundle.
"exemptedNamespaces": [ # The set of namespaces to be exempted from the bundle.
"A String",
],
},
},
"templateLibrary": { # The config specifying which default library templates to install. # Configures the installation of the Template Library.
"installation": "A String", # Configures the manner in which the template library is installed on the cluster.
},
},
"referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.
},
"version": "A String", # Version of Policy Controller 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.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # Per-membership state for this feature. # ClusterUpgrade state.
"ignored": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default. # Whether this membership is ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
"upgrades": [ # Actual upgrade state against desired.
{ # ScopeGKEUpgradeState is a GKEUpgrade and its state per-membership.
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"configmanagement": { # **Anthos Config Management**: State for a single cluster. # Config Management-specific state.
"clusterName": "A String", # This field is set to the `cluster_name` field of the Membership Spec if it is not empty. Otherwise, it is set to the cluster's fleet membership name.
"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
"admissionWebhook": "A String", # Deployment state of admission-webhook
"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
},
"errors": [ # Errors pertaining to the installation of Config Sync.
{ # Errors pertaining to the installation of Config Sync
"errorMessage": "A String", # A string representing the user facing error message
},
],
"reposyncCrd": "A String", # The state of the Reposync CRD
"rootsyncCrd": "A String", # The state of the RootSync CRD
"state": "A String", # The state of CS This field summarizes the other fields in this message.
"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", # Deprecated: use last_sync_time instead. Timestamp of when ACM last successfully synced the repo The time format is specified in https://golang.org/pkg/time/#Time.String
"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
"admissionWebhook": "A String", # Version of the deployed admission_webhook pod
"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": { # **Anthos Config Management**: 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
"cluster": "A String", # The user-specified cluster name used by Config Sync cluster-name-selector annotation or ClusterSelector, for applying configs to only a subset of clusters. Omit this field if the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector. Set this field if a name different from the cluster's fleet membership name is used by Config Sync cluster-name-selector annotation or ClusterSelector.
"configSync": { # Configuration for Config Sync # Config Sync configuration for the cluster.
"allowVerticalScale": True or False, # Set to true to allow the vertical scaling. Defaults to false which disallows vertical scaling. This field is deprecated.
"enabled": True or False, # Enables the installation of ConfigSync. If set to true, ConfigSync resources will be created and the other ConfigSync fields will be applied if exist. If set to false, all other ConfigSync fields will be ignored, ConfigSync resources will be deleted. If omitted, ConfigSync resources will be managed depends on the presence of the git or oci field.
"git": { # Git repo configuration for a single cluster. # Git repo configuration for the cluster.
"gcpServiceAccountEmail": "A String", # The Google Cloud 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. Must be one of ssh, cookiefile, gcenode, token, gcpserviceaccount or none. The validation of this is case-sensitive. Required.
"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.
},
"metricsGcpServiceAccountEmail": "A String", # The Email of the Google Cloud Service Account (GSA) used for exporting Config Sync metrics to Cloud Monitoring and Cloud Monarch when Workload Identity is enabled. The GSA should have the Monitoring Metric Writer (roles/monitoring.metricWriter) IAM role. The Kubernetes ServiceAccount `default` in the namespace `config-management-monitoring` should be bound to the GSA.
"oci": { # OCI repo configuration for a single cluster # OCI repo configuration for the cluster
"gcpServiceAccountEmail": "A String", # The Google Cloud Service Account Email used for auth when secret_type is gcpServiceAccount.
"policyDir": "A String", # The absolute path of the directory that contains the local resources. Default: the root directory of the image.
"secretType": "A String", # Type of secret configured for access to the Git repo.
"syncRepo": "A String", # The OCI image repository URL for the package to sync from. e.g. `LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME`.
"syncWaitSecs": "A String", # Period in seconds between consecutive syncs. Default: 15.
},
"preventDrift": True or False, # Set to true to enable the Config Sync admission webhook to prevent drifts. If set to `false`, disables the Config Sync admission webhook and does not prevent drifts.
"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.
},
"management": "A String", # Enables automatic Feature management.
"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.
"monitoring": { # PolicyControllerMonitoring specifies the backends Policy Controller should export metrics to. For example, to specify metrics should be exported to Cloud Monitoring and Prometheus, specify backends: ["cloudmonitoring", "prometheus"] # Monitoring specifies the configuration of monitoring.
"backends": [ # Specifies the list of backends Policy Controller will export to. An empty list would effectively disable metrics export.
"A String",
],
},
"mutationEnabled": True or False, # Enable or disable mutation in policy controller. If true, mutation CRDs, webhook and controller deployment will be deployed to the cluster.
"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.
"updateTime": "A String", # Output only. Last time this membership spec was updated.
},
"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.
"gatekeeperMutation": "A String", # Status of the pod serving the mutation webhook.
},
"migration": { # State for the migration of PolicyController from ACM -> PoCo Hub. # Record state of ACM -> PoCo Hub migration for this feature.
"copyTime": "A String", # Last time this membership spec was copied to PoCo feature.
"stage": "A String", # Stage of the migration.
},
"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.
},
},
},
"fleetobservability": { # **FleetObservability**: Membership-specific Feature state for fleetobservability. # Fleet observability membership state.
},
"identityservice": { # **Anthos Identity Service**: State for a single Membership. # Identity Service-specific state.
"failureReason": "A String", # The reason of the failure.
"installedVersion": "A String", # Installed AIS version. This is the AIS version installed on this member. The values makes sense iff state is OK.
"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration
"authMethods": [ # A member may support multiple auth methods.
{ # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.
"azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration.
"clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider.
"clientSecret": "A String", # Input only. Unencrypted AzureAD client secret will be passed to the GKE Hub CLH.
"encryptedClientSecret": "A String", # Output only. Encrypted AzureAD client secret.
"groupFormat": "A String", # Optional. Format of the AzureAD groups that the client wants for auth.
"kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization.
"tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.
"userClaim": "A String", # Optional. Claim in the AzureAD ID Token that holds the user details.
},
"googleConfig": { # Configuration for the Google Plugin Auth flow. # GoogleConfig specific configuration.
"disable": True or False, # Disable automatic configuration of Google Plugin on supported platforms.
},
"ldapConfig": { # Configuration for the LDAP Auth flow. # LDAP specific configuration.
"group": { # Contains the properties for locating and authenticating groups in the directory. # Optional. Contains the properties for locating and authenticating groups in the directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for group entries.
"filter": "A String", # Optional. Optional filter to be used when searching for groups a user belongs to. This can be used to explicitly match only certain groups in order to reduce the amount of groups returned for each user. This defaults to "(objectClass=Group)".
"idAttribute": "A String", # Optional. The identifying name of each group a user belongs to. For example, if this is set to "distinguishedName" then RBACs and other group expectations should be written as full DNs. This defaults to "distinguishedName".
},
"server": { # Server settings for the external LDAP server. # Required. Server settings for the external LDAP server.
"certificateAuthorityData": "A String", # Optional. Contains a Base64 encoded, PEM formatted certificate authority certificate for the LDAP server. This must be provided for the "ldaps" and "startTLS" connections.
"connectionType": "A String", # Optional. Defines the connection type to communicate with the LDAP server. If `starttls` or `ldaps` is specified, the certificate_authority_data should not be empty.
"host": "A String", # Required. Defines the hostname or IP of the LDAP server. Port is optional and will default to 389, if unspecified. For example, "ldap.server.example" or "10.10.10.10:389".
},
"serviceAccount": { # Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate. # Required. Contains the credentials of the service account which is authorized to perform the LDAP search in the directory. The credentials can be supplied by the combination of the DN and password or the client certificate.
"simpleBindCredentials": { # The structure holds the LDAP simple binding credential. # Credentials for basic auth.
"dn": "A String", # Required. The distinguished name(DN) of the service account object/user.
"encryptedPassword": "A String", # Output only. The encrypted password of the service account object/user.
"password": "A String", # Required. Input only. The password of the service account object/user.
},
},
"user": { # Defines where users exist in the LDAP directory. # Required. Defines where users exist in the LDAP directory.
"baseDn": "A String", # Required. The location of the subtree in the LDAP directory to search for user entries.
"filter": "A String", # Optional. Filter to apply when searching for the user. This can be used to further restrict the user accounts which are allowed to login. This defaults to "(objectClass=User)".
"idAttribute": "A String", # Optional. Determines which attribute to use as the user's identity after they are authenticated. This is distinct from the loginAttribute field to allow users to login with a username, but then have their actual identifier be an email address or full Distinguished Name (DN). For example, setting loginAttribute to "sAMAccountName" and identifierAttribute to "userPrincipalName" would allow a user to login as "bsmith", but actual RBAC policies for the user would be written as "bsmith@example.com". Using "userPrincipalName" is recommended since this will be unique for each user. This defaults to "userPrincipalName".
"loginAttribute": "A String", # Optional. The name of the attribute which matches against the input username. This is used to find the user in the LDAP database e.g. "(=)" and is combined with the optional filter field. This defaults to "userPrincipalName".
},
},
"name": "A String", # Identifier for auth config.
"oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration.
"certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider.
"clientId": "A String", # ID for OIDC client application.
"clientSecret": "A String", # Input only. Unencrypted OIDC client secret will be passed to the GKE Hub CLH.
"deployCloudConsoleProxy": True or False, # Flag to denote if reverse proxy is used to connect to auth provider. This flag should be set to true when provider is not reachable by Google Cloud Console.
"enableAccessToken": True or False, # Enable access token.
"encryptedClientSecret": "A String", # Output only. Encrypted OIDC Client secret
"extraParams": "A String", # Comma-separated list of key-value pairs.
"groupPrefix": "A String", # Prefix to prepend to group name.
"groupsClaim": "A String", # Claim in OIDC ID token that holds group information.
"issuerUri": "A String", # URI for the OIDC provider. This should point to the level below .well-known/openid-configuration.
"kubectlRedirectUri": "A String", # Registered redirect uri to redirect users going through OAuth flow using kubectl plugin.
"scopes": "A String", # Comma-separated list of identifiers.
"userClaim": "A String", # Claim in OIDC ID token that holds username.
"userPrefix": "A String", # Prefix to prepend to user name.
},
"proxy": "A String", # Proxy server address to use for auth method.
"samlConfig": { # Configuration for the SAML Auth flow. # SAML specific configuration.
"attributeMapping": { # Optional. The mapping of additional user attributes like nickname, birthday and address etc.. `key` is the name of this additional attribute. `value` is a string presenting as CEL(common expression language, go/cel) used for getting the value from the resources. Take nickname as an example, in this case, `key` is "attribute.nickname" and `value` is "assertion.nickname".
"a_key": "A String",
},
"groupPrefix": "A String", # Optional. Prefix to prepend to group name.
"groupsAttribute": "A String", # Optional. The SAML attribute to read groups from. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `group_prefix`).
"identityProviderCertificates": [ # Required. The list of IdP certificates to validate the SAML response against.
"A String",
],
"identityProviderId": "A String", # Required. The entity ID of the SAML IdP.
"identityProviderSsoUri": "A String", # Required. The URI where the SAML IdP exposes the SSO service.
"userAttribute": "A String", # Optional. The SAML attribute to read username from. If unspecified, the username will be read from the NameID element of the assertion in SAML response. This value is expected to be a string and will be passed along as-is (with the option of being prefixed by the `user_prefix`).
"userPrefix": "A String", # Optional. Prefix to prepend to user name.
},
},
],
},
"state": "A String", # Deployment state on this member
},
"policycontroller": { # **Policy Controller**: State for a single cluster. # Policycontroller-specific state.
"componentStates": { # Currently these include (also serving as map keys): 1. "admission" 2. "audit" 3. "mutation"
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"policyContentState": { # The state of the policy controller policy content # The overall content state observed by the Hub Feature controller.
"bundleStates": { # The state of the any bundles included in the chosen version of the manifest
"a_key": { # OnClusterState represents the state of a sub-component of Policy Controller.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"referentialSyncConfigState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the referential data sync configuration. This could represent the state of either the syncSet object(s) or the config object, depending on the version of PoCo configured by the user.
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
"templateLibraryState": { # OnClusterState represents the state of a sub-component of Policy Controller. # The state of the template library
"details": "A String", # Surface potential errors or information logs.
"state": "A String", # The lifecycle state of this component.
},
},
"state": "A String", # The overall Policy Controller lifecycle state observed by the Hub Feature controller.
},
"servicemesh": { # **Service Mesh**: State for a single Membership, as analyzed by the Service Mesh Hub Controller. # Service Mesh-specific state.
"conditions": [ # Output only. List of condition reporting membership statues
{ # Condition being reported.
"code": "A String", # Unique identifier of the condition which describes the condition recognizable to the user.
"details": "A String", # A short summary about the issue.
"documentationLink": "A String", # Links contains actionable information.
"severity": "A String", # Severity level of the condition.
},
],
"controlPlaneManagement": { # Status of control plane management. # Output only. Status of control plane management
"details": [ # Explanation of state.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"state": "A String", # LifecycleState of control plane management.
},
"dataPlaneManagement": { # Status of data plane management. Only reported per-member. # Output only. Status of data plane management.
"details": [ # Explanation of the status.
{ # Structured and human-readable details for a status.
"code": "A String", # A machine-readable code that further describes a broad status.
"details": "A String", # Human-readable explanation of code.
},
],
"state": "A String", # Lifecycle status of data plane management.
},
},
"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/*/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.
},
"scopeSpecs": { # Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {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 Scope 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": { # ScopeFeatureSpec contains feature specs for a fleet scope.
},
},
"scopeStates": { # Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project.
"a_key": { # ScopeFeatureState contains Scope-wide Feature status information.
"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 Scope.
"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.
},
},
},
"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.
"appdevexperience": { # Spec for App Dev Experience Feature. # Appdevexperience specific spec.
},
"clusterupgrade": { # **ClusterUpgrade**: The configuration for the fleet-level ClusterUpgrade feature. # ClusterUpgrade (fleet-based) feature spec.
"gkeUpgradeOverrides": [ # Allow users to override some properties of each GKE upgrade.
{ # Properties of a GKE upgrade that can be overridden by the user. For example, a user can skip soaking by overriding the soaking to 0.
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to override for the specified upgrade (name + version). Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Required. Which upgrade to override. Required.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
"postConditions": { # Post conditional checks after an upgrade has been applied on all eligible clusters. # Required. Post conditions to evaluate to mark an upgrade COMPLETE. Required.
"soaking": "A String", # Required. Amount of time to "soak" after a rollout has been finished before marking it COMPLETE. Cannot exceed 30 days. Required.
},
"upstreamFleets": [ # This fleet consumes upgrades that have COMPLETE status code in the upstream fleets. See UpgradeStatus.Code for code definitions. The fleet name should be either fleet project number or id. This is defined as repeated for future proof reasons. Initial implementation will enforce at most one upstream fleet.
"A String",
],
},
"dataplanev2": { # **Dataplane V2**: Spec # DataplaneV2 feature spec.
"enableEncryption": True or False, # Enable dataplane-v2 based encryption for multiple clusters.
},
"fleetobservability": { # **Fleet Observability**: The Hub-wide input for the FleetObservability feature. # FleetObservability feature spec.
"loggingConfig": { # LoggingConfig defines the configuration for different types of logs. # Specified if fleet logging feature is enabled for the entire fleet. If UNSPECIFIED, fleet logging feature is disabled for the entire fleet.
"defaultConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the default routing config to logs not specified in other configs.
"mode": "A String", # mode configures the logs routing mode.
},
"fleetScopeLogsConfig": { # RoutingConfig configures the behaviour of fleet logging feature. # Specified if applying the routing config to all logs for all fleet scopes.
"mode": "A String", # mode configures the logs routing mode.
},
},
},
"multiclusteringress": { # **Multi-cluster Ingress**: The configuration 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.
"appdevexperience": { # State for App Dev Exp Feature. # Appdevexperience specific state.
"networkingInstallSucceeded": { # Status specifies state for the subcomponent. # Status of subcomponent that detects configured Service Mesh resources.
"code": "A String", # Code specifies AppDevExperienceFeature's subcomponent ready state.
"description": "A String", # Description is populated if Code is Failed, explaining why it has failed.
},
},
"clusterupgrade": { # **ClusterUpgrade**: The state for the fleet-level ClusterUpgrade feature. # ClusterUpgrade fleet-level state.
"downstreamFleets": [ # This fleets whose upstream_fleets contain the current fleet. The fleet name should be either fleet project number or id.
"A String",
],
"gkeState": { # GKEUpgradeFeatureState contains feature states for GKE clusters in the scope. # Feature state for GKE clusters.
"conditions": [ # Current conditions of the feature.
{ # GKEUpgradeFeatureCondition describes the condition of the feature for GKE clusters at a certain point of time.
"reason": "A String", # Reason why the feature is in this status.
"status": "A String", # Status of the condition, one of True, False, Unknown.
"type": "A String", # Type of the condition, for example, "ready".
"updateTime": "A String", # Last timestamp the condition was updated.
},
],
"upgradeState": [ # Upgrade state. It will eventually replace `state`.
{ # GKEUpgradeState is a GKEUpgrade and its state at the scope and fleet level.
"stats": { # Number of GKE clusters in each status code.
"a_key": "A String",
},
"status": { # UpgradeStatus provides status information for each upgrade. # Status of the upgrade.
"code": "A String", # Status code of the upgrade.
"reason": "A String", # Reason for this status.
"updateTime": "A String", # Last timestamp the status was updated.
},
"upgrade": { # GKEUpgrade represents a GKE provided upgrade, e.g., control plane upgrade. # Which upgrade to track the state.
"name": "A String", # Name of the upgrade, e.g., "k8s_control_plane". It should be a valid upgrade name. It must not exceet 99 characters.
"version": "A String", # Version of the upgrade, e.g., "1.22.1-gke.100". It should be a valid version. It must not exceet 99 characters.
},
},
],
},
"ignored": { # A list of memberships ignored by the feature. For example, manually upgraded clusters can be ignored if they are newer than the default versions of its release channel. The membership resource is in the format: `projects/{p}/locations/{l}/membership/{m}`.
"a_key": { # IgnoredMembership represents a membership ignored by the feature. A membership can be ignored because it was manually upgraded to a newer version than RC default.
"ignoredTime": "A String", # Time when the membership was first set to ignored.
"reason": "A String", # Reason why the membership is ignored.
},
},
},
"fleetobservability": { # **FleetObservability**: Hub-wide Feature for FleetObservability feature. state. # FleetObservability feature state.
"logging": { # Feature state for logging feature. # The feature state of default logging.
"defaultLog": { # Base state for fleet observability feature. # The base feature state of fleet default log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
"scopeLog": { # Base state for fleet observability feature. # The base feature state of fleet scope log.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
"monitoring": { # Feature state for monitoring feature. # The feature state of fleet monitoring.
"state": { # Base state for fleet observability feature. # The base feature state of fleet monitoring feature.
"code": "A String", # The high-level, machine-readable status of this Feature.
"errors": [ # Errors after reconciling the monitoring and logging feature if the code is not OK.
{ # All error details of the fleet observability feature.
"code": "A String", # The code of the error.
"description": "A String", # A human-readable description of the current status.
},
],
},
},
},
"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, 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, successful response of the operation. 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, Required. The Feature resource name in the format `projects/*/locations/*/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.