Skip to content

instructions.md

Latest commit

 

History

History
84 lines (60 loc) · 6.65 KB

instructions.md

File metadata and controls

84 lines (60 loc) · 6.65 KB
Raw

How to submit conformance results

The self assessment

The set of conformance requirements for each Kubernetes version are defined in the AiConformance-x.yy.yaml in the docs folder.

Submitting the self assessment

Prepare a PR to https://github.com/cncf/k8s-ai-conformance. Here are directions to prepare a pull request from a fork. In the descriptions below, X.Y refers to the kubernetes major and minor version, and $dir is a short subdirectory name to hold the results for your product. Examples would be gke or openshift.

Contents of the PR

You must submit the completed self assesment manifest file for the relevant major/minor version of Kubernetes.

vX.Y/$dir/PRODUCT.yaml: See below.

PRODUCT.yaml

This file describes your product. It is YAML formatted with the following root-level fields. Please fill in as appropriate.

Field Description
vendorName Name of the legal entity that is certifying. This entity must have a signed participation form on file with the CNCF. This must be an exact match to the organization's name as listed under CNCF Members in the CNCF Landscape.
kubernetesVersion Kubernetes Version to verify
platformName Name of the product being certified.
platformVersion The version of the product being certified (not the version of Kubernetes it runs).
websiteUrl URL to the product information website
repoUrl If your product is open source, this field is necessary to point to the primary GitHub repo containing the source. It's OK if this is a mirror. OPTIONAL
documentationUrl URL to the product documentation
productLogoUrl URL to the product's logo, (must be in SVG, AI or EPS format -- not a PNG -- and include the product name). OPTIONAL. If not supplied, we'll use your company logo. Please see logo guidelines
description One sentence description of your offering
contactEmailAddress An email address which can be used to contact maintainers regarding the product submitted and updates to the submission process
k8sConformanceUrl URL to your product's Kubernetes Conformance submission in cncf/k8s-conformance. Format: https://github.com/cncf/k8s-conformance/tree/master/vX.Y/product-name

Examples below are for a fictional Kubernetes implementation called Turbo Encabulator produced by a company named Yoyodyne.

metadata:
  kubernetesVersion: v1.34
  platformName: Turbo Encabulator
  platformVersion: v1.7.4
  vendorName: Yoyodyne
  website_url: https://yoyo.dyne/turbo-encabulator
  repo_url: https://github.com/yoyo.dyne/turbo-encabulator
  documentation_url: https://yoyo.dyne/turbo-encabulator/docs
  product_logo_url: https://yoyo.dyne/assets/turbo-encabulator.svg
  description: "The Yoyodyne Turbo Encabulator is a superb Kubernetes distribution for all of your Encabulating needs."
  contact_email_address: yoyodyne@turbo-encabulator.org
  k8s_conformance_url: https://github.com/cncf/k8s-conformance/tree/master/v1.34/turbo-encabulator

Requirements

The self conformance file must be submitted without adjustments or changes in spec to the fields id, description, level. The fields status, evidence, and notes need to be filled if the level is MUST.

To reach conformance all MUST spec fields need to be addressed and the evidence needs to be publicly reachable.

Amendment for Private Review

If you require a private review for an unreleased product, please email a .zip file containing what you would otherwise submit as a pull request to conformance@cncf.io and the documentation for the evidence. We'll review and confirm that you are ready to be Certified AI Kubernetes Platform as soon as you open the pull request. We can then often arrange to accept your pull request soon after you make it, at which point you become Certified Kubernetes.

Review

A reviewer will comment on and/or accept your pull request, typically within 10 business days. If you don't see a response, please contact conformance@cncf.io.

Issues

If you encounter issues with the conformance program itself during certification (rather than problems with your own implementation), you can file an issue in the repository.

Questions and comments can also be sent to the AI Conformance working group, which is the change controller of the conformance definition. You can also reach the community on Slack.