Index
GkeHub
(interface)CommonFeatureSpec
(message)CommonFeatureState
(message)CommonFleetDefaultMemberConfigSpec
(message)CreateFeatureRequest
(message)CreateFleetRequest
(message)CreateMembershipBindingRequest
(message)CreateMembershipRBACRoleBindingRequest
(message)CreateNamespaceRequest
(message)CreateRBACRoleBindingRequest
(message)CreateScopeNamespaceRequest
(message)CreateScopeRBACRoleBindingRequest
(message)CreateScopeRequest
(message)DeleteFeatureRequest
(message)DeleteFleetRequest
(message)DeleteMembershipBindingRequest
(message)DeleteMembershipRBACRoleBindingRequest
(message)DeleteNamespaceRequest
(message)DeleteRBACRoleBindingRequest
(message)DeleteScopeNamespaceRequest
(message)DeleteScopeRBACRoleBindingRequest
(message)DeleteScopeRequest
(message)Feature
(message)FeatureResourceState
(message)FeatureResourceState.State
(enum)FeatureState
(message)FeatureState.Code
(enum)Fleet
(message)FleetLifecycleState
(message)FleetLifecycleState.Code
(enum)GenerateMembershipRBACRoleBindingYAMLRequest
(message)GenerateMembershipRBACRoleBindingYAMLResponse
(message)GetFeatureRequest
(message)GetFleetRequest
(message)GetMembershipBindingRequest
(message)GetMembershipRBACRoleBindingRequest
(message)GetNamespaceRequest
(message)GetRBACRoleBindingRequest
(message)GetScopeNamespaceRequest
(message)GetScopeRBACRoleBindingRequest
(message)GetScopeRequest
(message)ListFeaturesRequest
(message)ListFeaturesResponse
(message)ListFleetsRequest
(message)ListFleetsResponse
(message)ListMembershipBindingsRequest
(message)ListMembershipBindingsResponse
(message)ListMembershipRBACRoleBindingsRequest
(message)ListMembershipRBACRoleBindingsResponse
(message)ListNamespacesRequest
(message)ListNamespacesResponse
(message)ListRBACRoleBindingsRequest
(message)ListRBACRoleBindingsResponse
(message)ListScopeNamespacesRequest
(message)ListScopeNamespacesResponse
(message)ListScopeRBACRoleBindingsRequest
(message)ListScopeRBACRoleBindingsResponse
(message)ListScopesRequest
(message)ListScopesResponse
(message)MembershipBinding
(message)MembershipBindingLifecycleState
(message)MembershipBindingLifecycleState.Code
(enum)MembershipFeatureSpec
(message)MembershipFeatureSpec.Origin
(message)MembershipFeatureSpec.Origin.Type
(enum)MembershipFeatureState
(message)Namespace
(message)NamespaceLifecycleState
(message)NamespaceLifecycleState.Code
(enum)OperationMetadata
(message)RBACRoleBinding
(message)RBACRoleBinding.Role
(message)RBACRoleBinding.Role.PredefinedRoles
(enum)RBACRoleBindingLifecycleState
(message)RBACRoleBindingLifecycleState.Code
(enum)Scope
(message)ScopeFeatureSpec
(message)ScopeFeatureState
(message)ScopeLifecycleState
(message)ScopeLifecycleState.Code
(enum)UpdateFeatureRequest
(message)UpdateFleetRequest
(message)UpdateMembershipBindingRequest
(message)UpdateMembershipRBACRoleBindingRequest
(message)UpdateNamespaceRequest
(message)UpdateRBACRoleBindingRequest
(message)UpdateScopeNamespaceRequest
(message)UpdateScopeRBACRoleBindingRequest
(message)UpdateScopeRequest
(message)
GkeHub
The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.
The GKE Hub service operates on the following resources:
Membership
Feature
GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions.
Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.
CreateFeature |
---|
Adds a new Feature.
|
CreateFleet |
---|
Creates a fleet.
|
CreateMembershipBinding |
---|
Creates a MembershipBinding.
|
CreateMembershipRBACRoleBinding |
---|
Creates a Membership RBACRoleBinding.
|
CreateNamespace |
---|
Creates a fleet namespace.
|
CreateRBACRoleBinding |
---|
Creates a RBACRoleBinding.
|
CreateScope |
---|
Creates a Scope.
|
CreateScopeNamespace |
---|
Creates a fleet namespace.
|
CreateScopeRBACRoleBinding |
---|
Creates a Scope RBACRoleBinding.
|
DeleteFeature |
---|
Removes a Feature.
|
DeleteFleet |
---|
Removes a Fleet. There must be no memberships remaining in the Fleet.
|
DeleteMembershipBinding |
---|
Deletes a MembershipBinding.
|
DeleteMembershipRBACRoleBinding |
---|
Deletes a Membership RBACRoleBinding.
|
DeleteNamespace |
---|
Deletes a fleet namespace.
|
DeleteRBACRoleBinding |
---|
Deletes a RBACRoleBinding.
|
DeleteScope |
---|
Deletes a Scope.
|
DeleteScopeNamespace |
---|
Deletes a fleet namespace.
|
DeleteScopeRBACRoleBinding |
---|
Deletes a Scope RBACRoleBinding.
|
GenerateMembershipRBACRoleBindingYAML |
---|
Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.
|
GetFeature |
---|
Gets details of a single Feature.
|
GetFleet |
---|
Returns the details of a fleet.
|
GetMembershipBinding |
---|
Returns the details of a MembershipBinding.
|
GetMembershipRBACRoleBinding |
---|
Returns the details of a Membership RBACRoleBinding.
|
GetNamespace |
---|
Returns the details of a fleet namespace.
|
GetRBACRoleBinding |
---|
Returns the details of a RBACRoleBinding.
|
GetScope |
---|
Returns the details of a Scope.
|
GetScopeNamespace |
---|
Returns the details of a fleet namespace.
|
GetScopeRBACRoleBinding |
---|
Returns the details of a Scope RBACRoleBinding.
|
ListFeatures |
---|
Lists Features in a given project and location.
|
ListFleets |
---|
Returns all fleets within an organization or a project that the caller has access to.
|
ListMembershipBindings |
---|
Lists MembershipBindings.
|
ListMembershipRBACRoleBindings |
---|
Lists all Membership RBACRoleBindings.
|
ListNamespaces |
---|
Lists fleet namespaces.
|
ListRBACRoleBindings |
---|
Lists RBACRoleBinding.
|
ListScopeNamespaces |
---|
Lists fleet namespaces.
|
ListScopeRBACRoleBindings |
---|
Lists all Scope RBACRoleBindings.
|
ListScopes |
---|
Lists Scopes.
|
UpdateFeature |
---|
Updates an existing Feature.
|
UpdateFleet |
---|
Updates a fleet.
|
UpdateMembershipBinding |
---|
Updates a MembershipBinding.
|
UpdateMembershipRBACRoleBinding |
---|
Updates a Membership RBACRoleBinding.
|
UpdateNamespace |
---|
Updates a fleet namespace.
|
UpdateRBACRoleBinding |
---|
Updates a RBACRoleBinding.
|
UpdateScope |
---|
Updates a scopes.
|
UpdateScopeNamespace |
---|
Updates a fleet namespace.
|
UpdateScopeRBACRoleBinding |
---|
Updates a Scope RBACRoleBinding.
|
CommonFeatureSpec
CommonFeatureSpec contains Hub-wide configuration information
Fields | |
---|---|
Union field
|
|
multiclusteringress |
Multicluster Ingress-specific spec. |
appdevexperience |
Appdevexperience specific spec. |
anthosobservability |
Anthos Observability spec |
fleetobservability |
FleetObservability feature spec. |
CommonFeatureState
CommonFeatureState contains Hub-wide Feature status information.
Fields | |
---|---|
state |
Output only. The "running state" of the Feature in this Hub. |
Union field
|
|
appdevexperience |
Appdevexperience specific state. |
fleetobservability |
FleetObservability feature state. |
CommonFleetDefaultMemberConfigSpec
CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet
Fields | |
---|---|
Union field
|
|
identityservice |
Identity Service-specific spec. |
CreateFeatureRequest
Request message for the GkeHub.CreateFeature
method.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Feature will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
feature_id |
The ID of the feature to create. |
resource |
The Feature resource to create. |
request_id |
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). |
CreateFleetRequest
Request message for the GkeHub.CreateFleet
method.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Fleet will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
fleet |
Required. The fleet to create. |
CreateMembershipBindingRequest
Request to create a MembershipBinding.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the MembershipBinding will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
membership_binding |
Required. The MembershipBinding to create. |
membership_binding_id |
Required. The ID to use for the MembershipBinding. |
CreateMembershipRBACRoleBindingRequest
Request to create a rbacrolebindings.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
rbacrolebinding_id |
Required. Client chosen ID for the RBACRoleBinding.
Which can be expressed as the regex: |
rbacrolebinding |
Required. The rbacrolebindings to create. |
CreateNamespaceRequest
Request to create a fleet namespace.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Namespace will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
namespace_id |
Required. Client chosen ID for the Namespace.
Which can be expressed as the regex: |
namespace |
Required. The fleet namespace to create. |
CreateRBACRoleBindingRequest
Request to create a rbacrolebindings.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
rbacrolebinding_id |
Required. Client chosen ID for the RBACRoleBinding.
Which can be expressed as the regex: |
rbacrolebinding |
Required. The rbacrolebindings to create. |
CreateScopeNamespaceRequest
Request to create a fleet namespace.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Namespace will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
scope_namespace_id |
Required. Client chosen ID for the Namespace.
Which can be expressed as the regex: |
scope_namespace |
Required. The fleet namespace to create. |
CreateScopeRBACRoleBindingRequest
Request to create a rbacrolebindings.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
rbacrolebinding_id |
Required. Client chosen ID for the RBACRoleBinding.
Which can be expressed as the regex: |
rbacrolebinding |
Required. The rbacrolebindings to create. |
CreateScopeRequest
Request to create a Scope.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Scope will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
scope_id |
Required. Client chosen ID for the Scope. |
scope |
Required. The Scope to create. |
DeleteFeatureRequest
Request message for GkeHub.DeleteFeature
method.
Fields | |
---|---|
name |
Required. The Feature resource name in the format Authorization requires the following IAM permission on the specified resource
|
force |
If set to true, the delete will ignore any outstanding resources for this Feature (that is, |
request_id |
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). |
DeleteFleetRequest
Request message for GkeHub.DeleteFleet
method.
Fields | |
---|---|
name |
Required. The Fleet resource name in the format Authorization requires the following IAM permission on the specified resource
|
DeleteMembershipBindingRequest
Request to delete a Binding.
Fields | |
---|---|
name |
Required. The MembershipBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
DeleteMembershipRBACRoleBindingRequest
Request to delete a Membership RBACRoleBinding.
Fields | |
---|---|
name |
Required. The RBACRoleBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
DeleteNamespaceRequest
Request to delete a fleet namespace.
Fields | |
---|---|
name |
Required. The Namespace resource name in the format Authorization requires the following IAM permission on the specified resource
|
DeleteRBACRoleBindingRequest
Request to delete a RBACRoleBinding.
Fields | |
---|---|
name |
Required. The RBACRoleBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
DeleteScopeNamespaceRequest
Request to delete a fleet namespace.
Fields | |
---|---|
name |
Required. The Namespace resource name in the format Authorization requires the following IAM permission on the specified resource
|
DeleteScopeRBACRoleBindingRequest
Request to delete a Scope RBACRoleBinding.
Fields | |
---|---|
name |
Required. The RBACRoleBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
DeleteScopeRequest
Request to delete a Scope.
Fields | |
---|---|
name |
Required. The Scope resource name in the format Authorization requires the following IAM permission on the specified resource
|
Feature
Feature represents the settings and status of any Hub Feature.
Fields | |
---|---|
name |
Output only. The full, unique name of this Feature resource in the format |
labels |
Labels for this Feature. |
resource_state |
Output only. State of the Feature resource itself. |
spec |
Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused. |
membership_specs |
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:
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. |
state |
Output only. The Hub-wide Feature state. |
membership_states |
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:
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. |
create_time |
Output only. When the Feature resource was created. |
update_time |
Output only. When the Feature resource was last updated. |
delete_time |
Output only. When the Feature resource was deleted. |
fleet_default_member_config |
Optional. Feature configuration applicable to all memberships of the fleet. |
scope_specs |
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:
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. |
scope_states |
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:
Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. |
FeatureResourceState
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.
Fields | |
---|---|
state |
The current state of the Feature resource in the Hub API. |
State
State describes the lifecycle status of a Feature.
Enums | |
---|---|
STATE_UNSPECIFIED |
State is unknown or not set. |
ENABLING |
The Feature is being enabled, and the Feature resource is being created. Once complete, the corresponding Feature will be enabled in this Hub. |
ACTIVE |
The Feature is enabled in this Hub, and the Feature resource is fully available. |
DISABLING |
The Feature is being disabled in this Hub, and the Feature resource is being deleted. |
UPDATING |
The Feature resource is being updated. |
SERVICE_UPDATING |
The Feature resource is being updated by the Hub Service. |
FeatureState
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.
Fields | |
---|---|
code |
The high-level, machine-readable status of this Feature. |
description |
A human-readable description of the current status. |
update_time |
The time this status and any related Feature-specific details were updated. |
Code
Code represents a machine-readable, high-level status of the Feature.
Enums | |
---|---|
CODE_UNSPECIFIED |
Unknown or not set. |
OK |
The Feature is operating normally. |
WARNING |
The Feature has encountered an issue, and is operating in a degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information. |
ERROR |
The Feature is not operating or is in a severely degraded state. The Feature may need intervention to return to normal operation. See the description and any associated Feature-specific details for more information. |
Fleet
Fleet contains the Fleet-wide metadata and configuration.
Fields | |
---|---|
name |
Output only. The full, unique resource name of this fleet in the format of Each Google Cloud project can have at most one fleet resource, named "default". |
display_name |
Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: |
create_time |
Output only. When the Fleet was created. |
update_time |
Output only. When the Fleet was last updated. |
delete_time |
Output only. When the Fleet was deleted. |
uid |
Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet resource is deleted and another resource with the same name is created, it gets a different uid. |
state |
Output only. State of the namespace resource. |
labels |
Optional. Labels for this Fleet. |
FleetLifecycleState
FleetLifecycleState describes the state of a Fleet resource.
Fields | |
---|---|
code |
Output only. The current state of the Fleet resource. |
Code
Code describes the state of a Fleet resource.
Enums | |
---|---|
CODE_UNSPECIFIED |
The code is not set. |
CREATING |
The fleet is being created. |
READY |
The fleet active. |
DELETING |
The fleet is being deleted. |
UPDATING |
The fleet is being updated. |
GenerateMembershipRBACRoleBindingYAMLRequest
Request to generate a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format Authorization requires the following IAM permission on the specified resource
|
rbacrolebinding_id |
Required. Client chosen ID for the RBACRoleBinding.
Which can be expressed as the regex: |
rbacrolebinding |
Required. The rbacrolebindings to generate the YAML for. |
GenerateMembershipRBACRoleBindingYAMLResponse
Response for GenerateRBACRoleBindingYAML.
Fields | |
---|---|
role_bindings_yaml |
a yaml text blob including the RBAC policies. |
GetFeatureRequest
Request message for GkeHub.GetFeature
method.
Fields | |
---|---|
name |
Required. The Feature resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetFleetRequest
Request message for the GkeHub.GetFleet
method.
Fields | |
---|---|
name |
Required. The Fleet resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetMembershipBindingRequest
Request message for the GkeHub.GetMembershipBinding
method.
Fields | |
---|---|
name |
Required. The MembershipBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetMembershipRBACRoleBindingRequest
Request message for the GkeHub.GetMembershipRBACRoleBinding
method.
Fields | |
---|---|
name |
Required. The RBACRoleBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetNamespaceRequest
Request message for the GkeHub.GetNamespace
method.
Fields | |
---|---|
name |
Required. The Namespace resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetRBACRoleBindingRequest
Request message for the GkeHub.GetRBACRoleBinding
method.
Fields | |
---|---|
name |
Required. The RBACRoleBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetScopeNamespaceRequest
Request message for the GkeHub.GetNamespace
method.
Fields | |
---|---|
name |
Required. The Namespace resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetScopeRBACRoleBindingRequest
Request message for the GkeHub.GetScopeRBACRoleBinding
method.
Fields | |
---|---|
name |
Required. The RBACRoleBinding resource name in the format Authorization requires the following IAM permission on the specified resource
|
GetScopeRequest
Request message for the GkeHub.GetScope
method.
Fields | |
---|---|
name |
Required. The Scope resource name in the format Authorization requires the following IAM permission on the specified resource
|
ListFeaturesRequest
Request message for GkeHub.ListFeatures
method.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
When requesting a 'page' of resources, |
page_token |
Token returned by previous call to |
filter |
Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples:
|
order_by |
One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. |
ListFeaturesResponse
Response message for the GkeHub.ListFeatures
method.
Fields | |
---|---|
resources[] |
The list of matching Features |
next_page_token |
A token to request the next page of resources from the |
ListFleetsRequest
Request message for the GkeHub.ListFleets
method.
Fields | |
---|---|
parent |
Required. The organization or project to list for Fleets under, in the format |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
page_size |
Optional. The maximum number of fleets to return. The service may return fewer than this value. If unspecified, at most 200 fleets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
ListFleetsResponse
Response message for the GkeHub.ListFleetsResponse
method.
Fields | |
---|---|
fleets[] |
The list of matching fleets. |
next_page_token |
A token, which can be sent as |
ListMembershipBindingsRequest
Request to list MembershipBinding.
Fields | |
---|---|
parent |
Required. The parent Membership for which the MembershipBindings will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. When requesting a 'page' of resources, |
page_token |
Optional. Token returned by previous call to |
filter |
Optional. Lists MembershipBindings that match the filter expression, following the syntax outlined in https://google.aip.dev/160. |
ListMembershipBindingsResponse
List of MembershipBindings.
Fields | |
---|---|
membership_bindings[] |
The list of membership_bindings |
next_page_token |
A token to request the next page of resources from the |
ListMembershipRBACRoleBindingsRequest
Request to list Membership RBACRoleBindings.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. When requesting a 'page' of resources, |
page_token |
Optional. Token returned by previous call to |
ListMembershipRBACRoleBindingsResponse
List of Membership RBACRoleBindings.
Fields | |
---|---|
rbacrolebindings[] |
The list of Membership RBACRoleBindings. |
next_page_token |
A token to request the next page of resources from the |
ListNamespacesRequest
Request to list fleet namespaces.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. When requesting a 'page' of resources, |
page_token |
Optional. Token returned by previous call to |
ListNamespacesResponse
List of fleet namespaces.
Fields | |
---|---|
namespaces[] |
The list of fleet namespaces |
next_page_token |
A token to request the next page of resources from the |
ListRBACRoleBindingsRequest
Request to list RBACRoleBindings.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. When requesting a 'page' of resources, |
page_token |
Optional. Token returned by previous call to |
ListRBACRoleBindingsResponse
List of RBACRoleBindings.
Fields | |
---|---|
rbacrolebindings[] |
The list of RBACRoleBindings |
next_page_token |
A token to request the next page of resources from the |
ListScopeNamespacesRequest
Request to list fleet namespaces.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. When requesting a 'page' of resources, |
page_token |
Optional. Token returned by previous call to |
ListScopeNamespacesResponse
List of fleet namespaces.
Fields | |
---|---|
scope_namespaces[] |
The list of fleet namespaces |
next_page_token |
A token to request the next page of resources from the |
ListScopeRBACRoleBindingsRequest
Request to list Scope RBACRoleBindings.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Features will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. When requesting a 'page' of resources, |
page_token |
Optional. Token returned by previous call to |
ListScopeRBACRoleBindingsResponse
List of Scope RBACRoleBindings.
Fields | |
---|---|
rbacrolebindings[] |
The list of Scope RBACRoleBindings. |
next_page_token |
A token to request the next page of resources from the |
ListScopesRequest
Request to list Scopes.
Fields | |
---|---|
parent |
Required. The parent (project and location) where the Scope will be listed. Specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. When requesting a 'page' of resources, |
page_token |
Optional. Token returned by previous call to |
ListScopesResponse
List of Scopes.
Fields | |
---|---|
scopes[] |
The list of Scopes |
next_page_token |
A token to request the next page of resources from the |
MembershipBinding
MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to.
Fields | |
---|---|
name |
The resource name for the membershipbinding itself |
uid |
Output only. Google-generated UUID for this resource. This is unique across all membershipbinding resources. If a membershipbinding resource is deleted and another resource with the same name is created, it gets a different uid. |
create_time |
Output only. When the membership binding was created. |
update_time |
Output only. When the membership binding was last updated. |
delete_time |
Output only. When the membership binding was deleted. |
state |
Output only. State of the membership binding resource. |
labels |
Optional. Labels for this MembershipBinding. |
Union field target . What type of membershipbinding this is. target can be only one of the following: |
|
scope |
A Scope resource name in the format |
fleet |
Whether the membershipbinding is Fleet-wide; true means that this Membership should be bound to all Namespaces in this entire Fleet. |
MembershipBindingLifecycleState
MembershipBindingLifecycleState describes the state of a Binding resource.
Fields | |
---|---|
code |
Output only. The current state of the MembershipBinding resource. |
Code
Code describes the state of a MembershipBinding resource.
Enums | |
---|---|
CODE_UNSPECIFIED |
The code is not set. |
CREATING |
The membershipbinding is being created. |
READY |
The membershipbinding active. |
DELETING |
The membershipbinding is being deleted. |
UPDATING |
The membershipbinding is being updated. |
MembershipFeatureSpec
MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name.
Fields | |
---|---|
origin |
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. |
Union field
|
|
configmanagement |
Config Management-specific spec. |
cloudbuild |
Cloud Build-specific spec |
identityservice |
Identity Service-specific spec. |
mesh |
Anthos Service Mesh-specific spec |
anthosobservability |
Anthos Observability-specific spec |
policycontroller |
Policy Controller spec. |
fleetobservability |
Fleet observability membership spec |
Origin
Origin defines where this MembershipFeatureSpec originated from.
Fields | |
---|---|
type |
Type specifies which type of origin is set. |
Type
Type specifies the persona that persisted the config.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Type is unknown or not set. |
FLEET |
Per-Membership spec was inherited from the fleet-level default. |
USER |
Per-Membership spec was inherited from a user specification. |
MembershipFeatureState
MembershipFeatureState contains Feature status information for a single Membership.
Fields | |
---|---|
state |
The high-level state of this Feature for a single membership. |
Union field
|
|
servicemesh |
Service Mesh-specific state. |
metering |
Metering-specific state. |
configmanagement |
Config Management-specific state. |
identityservice |
Identity Service-specific state. |
appdevexperience |
Appdevexperience specific state. |
policycontroller |
Policycontroller-specific state. |
fleetobservability |
Fleet observability membership state. |
Namespace
Namespace represents a namespace across the Fleet
Fields | |
---|---|
name |
The resource name for the namespace |
uid |
Output only. Google-generated UUID for this resource. This is unique across all namespace resources. If a namespace resource is deleted and another resource with the same name is created, it gets a different uid. |
create_time |
Output only. When the namespace was created. |
update_time |
Output only. When the namespace was last updated. |
delete_time |
Output only. When the namespace was deleted. |
state |
Output only. State of the namespace resource. |
scope |
Required. Scope associated with the namespace |
namespace_labels |
Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels ( |
labels |
Optional. Labels for this Namespace. |
NamespaceLifecycleState
NamespaceLifecycleState describes the state of a Namespace resource.
Fields | |
---|---|
code |
Output only. The current state of the Namespace resource. |
Code
Code describes the state of a Namespace resource.
Enums | |
---|---|
CODE_UNSPECIFIED |
The code is not set. |
CREATING |
The namespace is being created. |
READY |
The namespace active. |
DELETING |
The namespace is being deleted. |
UPDATING |
The namespace is being updated. |
OperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_detail |
Output only. Human-readable status of the operation, if any. |
cancel_requested |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a |
api_version |
Output only. API version used to start the operation. |
RBACRoleBinding
RBACRoleBinding represents a rbacrolebinding across the Fleet
Fields | |
---|---|
name |
The resource name for the rbacrolebinding |
uid |
Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid. |
create_time |
Output only. When the rbacrolebinding was created. |
update_time |
Output only. When the rbacrolebinding was last updated. |
delete_time |
Output only. When the rbacrolebinding was deleted. |
state |
Output only. State of the rbacrolebinding resource. |
role |
Required. Role to bind to the principal |
labels |
Optional. Labels for this RBACRolebinding. |
Union field principal . Principal that is be authorized in the cluster (at least of one the oneof is required). Updating one will unset the other automatically. principal can be only one of the following: |
|
user |
user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld" |
group |
group is the group, as seen by the kubernetes cluster. |
Role
Role is the type for Kubernetes roles
Fields | |
---|---|
predefined_role |
predefined_role is the Kubernetes default role to use |
PredefinedRoles
PredefinedRoles is an ENUM representation of the default Kubernetes Roles
Enums | |
---|---|
UNKNOWN |
UNKNOWN |
ADMIN |
ADMIN has EDIT and RBAC permissions |
EDIT |
EDIT can edit all resources except RBAC |
VIEW |
VIEW can only read resources |
ANTHOS_SUPPORT |
ANTHOS_SUPPORT gives Google Support read-only access to a number of cluster resources. |
RBACRoleBindingLifecycleState
RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource.
Fields | |
---|---|
code |
Output only. The current state of the rbacrolebinding resource. |
Code
Code describes the state of a rbacrolebinding resource.
Enums | |
---|---|
CODE_UNSPECIFIED |
The code is not set. |
CREATING |
The rbacrolebinding is being created. |
READY |
The rbacrolebinding active. |
DELETING |
The rbacrolebinding is being deleted. |
UPDATING |
The rbacrolebinding is being updated. |
Scope
Scope represents a Scope in a Fleet.
Fields | |
---|---|
name |
The resource name for the scope |
all_memberships |
If true, all Memberships in the Fleet bind to this Scope. |
|