SMI Conformance Checklist

With the increasing adoption of Service Mesh Interface by what is a vibrant and diverse community of both service mesh providers and ecosystem integrators, the need for verification and validation of SMI implementations is clear. We’re still counting, however, as of this writing SMI has been adopted by more than 10 of the available service meshes and ecosystem tools. As you can see on the service mesh landscape, the last few significant, new service mesh project / product announcements have proclaimed SMI compatibility from the start. Validating consistency of these implementations is key to upholding the value of SMI itself.

From my time spent creating the v1.0 versions of other specifications like Redfish, Docker Benchmark, CloudEvents, and others, I can tell you that the promise of consistency lies at the heart of any specification. SMI’s specifications and their implementations are no different in this regard. Consistency enables portability and choice. Consistency enables great user experiences. Service Mesh Interface specifications present a consistent set of abstractions to describe functional service mesh configuration in a common way. SMI makes integrations with participating service meshes portable. In order to better serve these goals, the SMI community and Layer5 have developed an SMI Conformance initiative.

Conforming to SMI

SMI Conformance Program Overview

The scope of the SMI Conformance initiative includes all service mesh projects participating in the Service Mesh Interface specification. The goal of this initiative is to provide open tooling for validation of SMI specifications, instilling user confidence in the SMI implementation of their chosen service mesh. This validation initiative is not a full-blown certification program, yet, but has all of the makings to become one:

  • Versioned suite of conformance tests.
  • Self-reporting with guaranteed provenance and integrity of conformance test results.
  • Continually published conformance results.
  • Support for all service meshes that implement SMI.

Delivering on these requirements required a tool specifically suited to SMI.

Meshery

SMI Conformance Tool: Meshery

Meshery, the service mesh management plane, is service mesh agnostic, which is an important characteristic as a compliance tool. No better tool for the job exists (in fact, no other tool is capable of the job) than Meshery, which has been a partner of SMI since its inception.

SMI Conformance Tool

Meshery is ideal tooling in that it provides lifecycle management of a large number of service meshes and sample applications which need to be provisioned, tested, and deprovisioned in the process of validating conformance. And Meshery is capable of generating load and verifying test assertions. Meshery will be extended to validate any service mesh that claims to implement and conform SMI specifications. And, more broadly, Meshery will leverage the same tooling to validate service mesh standards at-large, including SMI and Service Mesh Performance (SMP).

Defining Conformance

Conformance of SMI specifications is defined as a series of test assertions. A test assertion is a condition that must be positively verified in order for an implementation to be considered conformant. A test assertion may involve any number of conditions. Sets of test assertions are categorized by SMI specification. Collectively, these test sets comprise the complete suite of SMI conformance tests. Just like SMI itself, the suite of SMI Conformance tests is versioned, and with each new version of SMI, as interfaces are added and specifications changed, the Conformance requirements will change as appropriate. The SMI community is the change controller and oversees what it means to conform to SMI. Work on the mechanics of the conformance tests occurs in the CNCF Service Mesh WG, which develops the process and policy around the conformance program.

Validating Conformance

Conformance validation is performed through automated provisioning of individual service meshes, deployment of a common workload, and generation of service request load as necessary. To facilitate a common set of tests, a simple, instrumented, sample application has been developed for purposes of providing a consistent workload to apply SMI specs against. Deployment of the sample application has been fitted to each service mesh.

Conformance Test Execution Flow

The following list highlights the sequence of steps taken to perform conformance testing of one type of service mesh.

  • Preconditions
    • A given service mesh’s ability to adhere to the SMI specification is validated by running a workload on top of the service mesh.
    • Workload deployments are configured specific to the onboarding requirements of the given service mesh.
    • Tests are defined to validate conformance for each type of SMI specification (e.g. metrics, access, traffic… ).
  • Invocation
    • Test assertions are defined in a workload-specific way and deployed with the workloads being tested (test assertions are packaged).
    • A test result is collected with the evaluation of each assertion. Future: Test results will be individually streamed to Meshery after each assertion is evaluated.
    • Once all assertions are evaluated, test results are returned for visual presentation in Meshery.
    • Tests that are run by the service mesh project team are identified by a pre-approved service account and are publicly published the SMI Conformance dashboard.
Results Mockup

Validate Your Service Mesh’s Conformance

All SMI implementers are invited to submit conformance testing results for review and publication by the SMI project. Use Meshery’s diagnostic tool to verify that your service mesh’s behavior in an accessible and non-destructive manner.

See current conformance test results and the full list of conformance tests.

The SMI Conformance program gives end users the confidence that when they use a validated SMI project or product that they can rely on common functionality and high level behavior. The program gives Independent Software Vendors (ISVs) confidence that if their customer is using a service mesh with validated SMI implementation that their software will behave as expected.

Learn more about SMI Conformance. Join the #smi channel in the CNCF Slack.