Package google.cloud.gkehub.servicemesh.v1alpha

Index

• AnalysisMessage (message)
• AnalysisMessageBase (message)
• AnalysisMessageBase.Level (enum)
• AnalysisMessageBase.Type (message)
• Channel (enum)
• FeatureState (message)
• MembershipSpec (message)
• MembershipSpec.ConfigApi (enum)
• MembershipSpec.ControlPlaneManagement (enum)
• MembershipSpec.Management (enum)
• MembershipState (message)
• MembershipState.Condition (message)
• MembershipState.Condition.Code (enum)
• MembershipState.Condition.Severity (enum)
• MembershipState.ControlPlaneManagement (message)
• MembershipState.ControlPlaneManagement.Implementation (enum)
• MembershipState.DataPlaneManagement (message)
• MembershipState.LifecycleState (enum)
• StatusDetails (message)

AnalysisMessage

AnalysisMessage is a single message produced by an analyzer, and it used to communicate to the end user about the state of their Service Mesh configuration.

Fields
message_base	AnalysisMessageBase Details common to all types of Istio and ServiceMesh analysis messages.
description	string A human readable description of what the error means. It is suitable for non-internationalize display purposes.
resource_paths[]	string A list of strings specifying the resource identifiers that were the cause of message generation. A "path" here may be: * MEMBERSHIP_ID if the cause is a specific member cluster * MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME if the cause is a resource in a cluster
args	Struct A UI can combine these args with a template (based on message_base.type) to produce an internationalized message.

AnalysisMessageBase

AnalysisMessageBase describes some common information that is needed for all messages.

Fields
type	AnalysisMessageBase.Type Represents the specific type of a message.
level	AnalysisMessageBase.Level Represents how severe a message is.
documentation_url	string A url pointing to the Service Mesh or Istio documentation for this specific error type.

Level

The values here are chosen so that more severe messages get sorted higher, as well as leaving space in between to add more later See istio.analysis.v1alpha1.AnalysisMessageBase.Level

Enums
LEVEL_UNSPECIFIED	Illegal. Same istio.analysis.v1alpha1.AnalysisMessageBase.Level.UNKNOWN.
ERROR	ERROR represents a misconfiguration that must be fixed.
WARNING	WARNING represents a misconfiguration that should be fixed.
INFO	INFO represents an informational finding.

Type

A unique identifier for the type of message. Display_name is intended to be human-readable, code is intended to be machine readable. There should be a one-to-one mapping between display_name and code. (i.e. do not re-use display_names or codes between message types.) See istio.analysis.v1alpha1.AnalysisMessageBase.Type

Fields
display_name	string A human-readable name for the message type. e.g. "InternalError", "PodMissingProxy". This should be the same for all messages of the same type. (This corresponds to the name field in open-source Istio.)
code	string A 7 character code matching ^IST[0-9]{4}$ or ^ASM[0-9]{4}$, intended to uniquely identify the message type. (e.g. "IST0001" is mapped to the "InternalError" message type.)

Channel

Channel indicates which release channel a revision is subscribed to. Release channels are arranged in order of risk.

Enums
CHANNEL_UNSPECIFIED	Unspecified
RAPID	RAPID channel is offered on an early access basis for customers who want to test new releases.
REGULAR	REGULAR channel is intended for production users who want to take advantage of new features.
STABLE	STABLE channel includes versions that are known to be stable and reliable in production.

FeatureState

Service Mesh: State for the whole Hub, as analyzed by the Service Mesh Hub Controller.

Fields
analysis_messages[]	AnalysisMessage Output only. Results of running Service Mesh analyzers.

MembershipSpec

Service Mesh: Spec for a single Membership for the servicemesh feature

Fields
control_plane (deprecated)	MembershipSpec.ControlPlaneManagement This item is deprecated! Deprecated: use management instead Enables automatic control plane management.
default_channel (deprecated)	Channel This item is deprecated! Determines which release channel to use for default injection and service mesh APIs.
management	MembershipSpec.Management Optional. Enables automatic Service Mesh management.
config_api	MembershipSpec.ConfigApi Optional. Specifies the API that will be used for configuring the mesh workloads.

ConfigApi

Specifies the API that will be used for configuring the mesh workloads.

Enums
CONFIG_API_UNSPECIFIED	Unspecified
CONFIG_API_ISTIO	Use the Istio API for configuration.
CONFIG_API_GATEWAY	Use the K8s Gateway API for configuration.

ControlPlaneManagement

Whether to automatically manage Service Mesh control planes.

Enums
CONTROL_PLANE_MANAGEMENT_UNSPECIFIED	Unspecified
AUTOMATIC	Google should provision a control plane revision and make it available in the cluster. Google will enroll this revision in a release channel and keep it up to date. The control plane revision may be a managed service, or a managed install.
MANUAL	User will manually configure the control plane (e.g. via CLI, or via the ControlPlaneRevision KRM API)

Management

Whether to automatically manage Service Mesh.

Enums
MANAGEMENT_UNSPECIFIED	Unspecified
MANAGEMENT_AUTOMATIC	Google should manage my Service Mesh for the cluster.
MANAGEMENT_MANUAL	User will manually configure their service mesh components.

MembershipState

Service Mesh: State for a single Membership, as analyzed by the Service Mesh Hub Controller.

Fields
analysis_messages[]	AnalysisMessage Output only. Results of running Service Mesh analyzers.
control_plane_management	MembershipState.ControlPlaneManagement Output only. Status of control plane management
data_plane_management	MembershipState.DataPlaneManagement Output only. Status of data plane management.
config_api_version	string The API version (i.e. Istio CRD version) for configuring service mesh in this cluster. This version is influenced by the default_channel field.
conditions[]	MembershipState.Condition Output only. List of conditions reported for this membership.

Condition

Condition being reported.

Fields
code	MembershipState.Condition.Code Unique identifier of the condition which describes the condition recognizable to the user.
documentation_link	string Links contains actionable information.
details	string A short summary about the issue.
severity	MembershipState.Condition.Severity Severity level of the condition.

Code

Unique identifier of the condition which describes the condition recognizable to the user.

Enums
CODE_UNSPECIFIED	Default Unspecified code
MESH_IAM_PERMISSION_DENIED	Mesh IAM permission denied error code
MESH_IAM_CROSS_PROJECT_PERMISSION_DENIED	Permission denied error code for cross-project
CNI_CONFIG_UNSUPPORTED	CNI config unsupported error code
GKE_SANDBOX_UNSUPPORTED	GKE sandbox unsupported error code
NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED	Nodepool workload identity federation required error code
CNI_INSTALLATION_FAILED	CNI installation failed error code
CNI_POD_UNSCHEDULABLE	CNI pod unschedulable error code
CLUSTER_HAS_ZERO_NODES	Cluster has zero node code
UNSUPPORTED_MULTIPLE_CONTROL_PLANES	Multiple control planes unsupported error code
VPCSC_GA_SUPPORTED	VPC-SC GA is supported for this control plane.
DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT	User is using deprecated ControlPlaneManagement and they have not yet set Management.
DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT_SAFE	User is using deprecated ControlPlaneManagement and they have already set Management.
CONFIG_APPLY_INTERNAL_ERROR	Configuration (Istio/k8s resources) failed to apply due to internal error.
CONFIG_VALIDATION_ERROR	Configuration failed to be applied due to being invalid.
CONFIG_VALIDATION_WARNING	Encountered configuration(s) with possible unintended behavior or invalid configuration. These configs may not have been applied.
QUOTA_EXCEEDED_BACKEND_SERVICES	BackendService quota exceeded error code.
QUOTA_EXCEEDED_HEALTH_CHECKS	HealthCheck quota exceeded error code.
QUOTA_EXCEEDED_HTTP_ROUTES	HTTPRoute quota exceeded error code.
QUOTA_EXCEEDED_TCP_ROUTES	TCPRoute quota exceeded error code.
QUOTA_EXCEEDED_TLS_ROUTES	TLS routes quota exceeded error code.
QUOTA_EXCEEDED_TRAFFIC_POLICIES	TrafficPolicy quota exceeded error code.
QUOTA_EXCEEDED_ENDPOINT_POLICIES	EndpointPolicy quota exceeded error code.
QUOTA_EXCEEDED_GATEWAYS	Gateway quota exceeded error code.
QUOTA_EXCEEDED_MESHES	Mesh quota exceeded error code.
QUOTA_EXCEEDED_SERVER_TLS_POLICIES	ServerTLSPolicy quota exceeded error code.
QUOTA_EXCEEDED_CLIENT_TLS_POLICIES	ClientTLSPolicy quota exceeded error code.
QUOTA_EXCEEDED_SERVICE_LB_POLICIES	ServiceLBPolicy quota exceeded error code.
QUOTA_EXCEEDED_HTTP_FILTERS	HTTPFilter quota exceeded error code.
QUOTA_EXCEEDED_TCP_FILTERS	TCPFilter quota exceeded error code.
QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS	NetworkEndpointGroup quota exceeded error code.
MODERNIZATION_SCHEDULED	Modernization is scheduled for a cluster.
MODERNIZATION_IN_PROGRESS	Modernization is in progress for a cluster.
MODERNIZATION_COMPLETED	Modernization is completed for a cluster.
MODERNIZATION_ABORTED	Modernization is aborted for a cluster.

Severity

Severity level of the reported condition

Enums
SEVERITY_UNSPECIFIED	Unspecified severity
ERROR	Indicates an issue that prevents the mesh from operating correctly
WARNING	Indicates a setting is likely wrong, but the mesh is still able to operate
INFO	An informational message, not requiring any action

ControlPlaneManagement

Status of control plane management.

Fields
details[]	StatusDetails Explanation of state.
state	MembershipState.LifecycleState LifecycleState of control plane management.
implementation	MembershipState.ControlPlaneManagement.Implementation Output only. Implementation of managed control plane.

Implementation

Implementation of managed control plane.

Enums
IMPLEMENTATION_UNSPECIFIED	Unspecified
ISTIOD	A Google build of istiod is used for the managed control plane.
TRAFFIC_DIRECTOR	Traffic director is used for the managed control plane.
UPDATING	The control plane implementation is being updated.

DataPlaneManagement

Status of data plane management. Only reported per-member.

Fields
state	MembershipState.LifecycleState Lifecycle status of data plane management.
details[]	StatusDetails Explanation of the status.

LifecycleState

Lifecycle state of Service Mesh components.

Enums
LIFECYCLE_STATE_UNSPECIFIED	Unspecified
DISABLED	DISABLED means that the component is not enabled.
FAILED_PRECONDITION	FAILED_PRECONDITION means that provisioning cannot proceed because of some characteristic of the member cluster.
PROVISIONING	PROVISIONING means that provisioning is in progress.
ACTIVE	ACTIVE means that the component is ready for use.
STALLED	STALLED means that provisioning could not be done.
NEEDS_ATTENTION	NEEDS_ATTENTION means that the component is ready, but some user intervention is required. (For example that the user should migrate workloads to a new control plane revision.)
DEGRADED	DEGRADED means that the component is ready, but operating in a degraded state.

StatusDetails

Structured and human-readable details for a status.

Fields
code	string A machine-readable code that further describes a broad status.
details	string Human-readable explanation of code.