TSB Component Status

This guide helps you understand and troubleshoot the Tetrate Service Bridge (TSB) Management Plane and Control Plane installation status using the Install API Custom Resource (CR) status field.

Alpha Feature

The TSB Component Status feature is currently in alpha and may change in future releases. Please provide feedback to help us improve the feature.

Component Status

The TSB Management Plane and Control Plane has multiple components managed by the TSB Operator. It is hard to track individual component status during installation or upgrade. The Install API CR status field provides the status of the TSB components to help you understand the installation and upgrade status. Status field also provides version information for each component.

To get TSB Management Plane component status, use the following command:

kubectl get managementplane managementplane -n tsb -o yaml

Following is an example of the Install CR status field:

status:
  components:
    apiServer:
      status: INSTALLED
      version: v1.12.0
    collector:
      status: INSTALLED
      version: 0.117.0
    eck:
      status: INSTALLED
      version: 2.11.1-tetrate-v4
    frontEnvoy:
      status: INSTALLED
      version: 1.22.6-479cdabae5-distroless
    iamServer:
      status: INSTALLED
      version: v1.12.0
    kubegres:
      status: INSTALLED
      version: v1.16.0-tetrate-v14
    mpc:
      status: INSTALLED
      version: v1.12.0
    n2ac:
      status: INSTALLED
      version: v1.12.0
    oap:
      status: INSTALLED
      version: v1.12.0
    webUi:
      status: INSTALLED
      version: v1.12.0
    xcp:
      central:
        status: INSTALLED
        version: v1.12.0
      operator:
        status: INSTALLED
        version: v1.12.0
  lastUpdated: "2025-02-03T01:28:48.424871780Z"
  observedGeneration: "10"
  phase: INSTALLED
  tsbVersion: v1.12.0

Similarly, to get TSB Control Plane component status, use the following command:

kubectl get controlplane controlplane -n istio-system -o yaml

Following is an example of the Control Plane Install CR status field:

status:
  components:
    collector:
      status: INSTALLED
      version: 0.117.0
    istio:
      istiod:
      - isolationBoundary: global
        revision: default
        status: INSTALLED
        version: 1.22.6-479cdabae5-distroless
    oap:
      status: INSTALLED
      version: 48e43604d4f1eb6b9ab1995fa02b61b4e9d977e6
    onboarding:
      operator:
        status: INSTALLED
        version: 6ff0e1ed01caf2b9b05d35fda033f6ed748745a0
    wasmFetcher:
      status: INSTALLED
      version: 6ff0e1ed01caf2b9b05d35fda033f6ed748745a0
    xcp:
      edge:
        status: INSTALLED
        version: bd61915abcda407fc978a99572fc045105766164
      operator:
        status: INSTALLED
        version: bd61915abcda407fc978a99572fc045105766164
  lastUpdated: "2025-02-05T08:01:56.391326611Z"
  observedGeneration: "6"
  phase: INSTALLED
  tsbVersion: v1.12.0-internal-rc4-master (6ff0e1ed0, +7)

Phase and Status Field

The status field follows Kubernetes conventions with these key sections:

status:
  components:                   # List of components managed by TSB MP or CP
    apiServer:                  # Component name
      status: INSTALLED         # Component status
      version: <version>        # Component version
  lastUpdated: <timestamp>
  observedGeneration: <number>
  phase: INSTALLED              # Overall deployment phase
  tsbVersion: <version-info>    # TSB version

Individual component status has the following values:

• UNKNOWN: The status of the component is unknown.
• INSTALLED: The component is installed as expected.
• FAILED: The component installed failed and not operational.
• IN_PROGRESS: The component is in the process of reconciling.

Installation Progress Deadline

A component is marked as failed only if the installation is not successful within the configured progressDeadlineSeconds interval. By default, this value is set to 600 seconds (10 minutes) in Kubernetes. During this period, the component remains in the IN_PROGRESS/INSTALLING state while waiting for the installation to stabilize.

The progressDeadlineSeconds value for components can be customized using overlays, allowing you to adjust the timeout based on your deployment needs.

Overall phase has the following values:

• UNKNOWN: The phase of the TSB installation is unknown.
• INSTALLED: The TSB installation is available and operational.
• FAILED: The TSB installation failed and is not operational.
• INSTALLING: TSB is in the process of being installed.
• UPGRADING: TSB is in the process of being upgraded.

Error Message

TSB operators will reconcile the components to the desired state. If the component status is not as expected, you can see the error message in the component status field. The error message will help you understand the issue and take corrective action.

status:
  components:
    apiServer:
      status: FAILED
      version: v1.12.0
      errorMessage: <Error message details> 
    ...
  lastUpdated: "2025-02-03T01:28:48.424871780Z"
  observedGeneration: "10"
  phase: FAILED
  tsbVersion: v1.12.0

Troubleshooting Tips

1. If a component shows FAILED status:

   • Check the component's pods in the respective namespace
   • Review the pod logs
   • Check the errorMessage field for specific failure details

2. During UPGRADING phase:

   • Monitor component versions to ensure they're updating as expected
   • Check the lastUpdated timestamp for progress
   • Verify the observedGeneration matches the current configuration

3. For UNKNOWN status:

   • Verify the TSB operator is running
   • Check operator logs for reconciliation issues
   • Ensure all prerequisites are met

4. When stuck in INSTALLING:

   • Check resource constraints
   • Verify network connectivity
   • Review operator logs for blocking conditions