Index
AnalysisMessage
(message)AnalysisMessageBase
(message)AnalysisMessageBase.Level
(enum)AnalysisMessageBase.Type
(message)Channel
(enum)FeatureState
(message)MembershipSpec
(message)MembershipSpec.ControlPlaneManagement
(enum)MembershipSpec.Management
(enum)MembershipState
(message)MembershipState.ControlPlaneManagement
(message)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 |
Details common to all types of Istio and ServiceMesh analysis messages. |
description |
A human readable description of what the error means. It is suitable for non-internationalize display purposes. |
resource_paths[] |
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 |
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 |
Represents the specific type of a message. |
level |
Represents how severe a message is. |
documentation_url |
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 |
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 |
code |
A 7 character code matching |
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[] |
Output only. Results of running Service Mesh analyzers. |
MembershipSpec
Service Mesh: Spec for a single Membership for the servicemesh feature
Fields | |
---|---|
control_plane |
Deprecated: use |
default_channel |
Determines which release channel to use for default injection and service mesh APIs. |
management |
Enables automatic Service Mesh management. |
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[] |
Output only. Results of running Service Mesh analyzers. |
control_plane_management |
Output only. Status of control plane management |
data_plane_management |
Output only. Status of data plane management. |
config_api_version |
The API version (i.e. Istio CRD version) for configuring service mesh in this cluster. This version is influenced by the |
ControlPlaneManagement
Status of control plane management.
Fields | |
---|---|
details[] |
Explanation of state. |
state |
LifecycleState of control plane management. |
DataPlaneManagement
Status of data plane management. Only reported per-member.
Fields | |
---|---|
state |
Lifecycle status of data plane management. |
details[] |
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 |
A machine-readable code that further describes a broad status. |
details |
Human-readable explanation of code. |