[PROPOSAL] A Generic Protocol for Kubeflow Pipeline Template Registry

[hilcj]

Introduction

We are working on a generic protocol design of Kubeflow Pipeline Template Registry.

At high level, the protocol will define the generic APIs between KFP SDK client and a template registry server to

• upload and download template (as YAML file or ZIP), and
• organize templates as versioned objects.

Then, KFP SDK will implement a registry client class that can work with any registry server that implements the APIs defined in the generic protocol.

Feedbacks are welcomed :-)

Resource Hierarchy

The protocol will enable organizing templates as versioned objects in the registry, following the hierarchy of

• Host (http://my-registry.server/kubeflow-pipelines/public/)
  • Package (mnist-demo-workflow)
    • Version (sha256:e54fda…)
    • Tag (latest, v2)

Note

• Version name will use sha256 digest of the uploaded content.
• Tags are nicknames for versions, uniquely identifying a version under a package.
  • Tags are unique among versions - the same tag can only apply to a single version under a package.
  • Multiple tags can apply to the same version.
  • Tags are not fixed - an existing tag can be removed from the existing version, or be updated to point to another version.

API Design

Please visit Generic Protocol for
Kubeflow Pipelines Template Registry for the detailed design.

If you don't have permission to access the doc, please join https://groups.google.com/g/kubeflow-discuss for access.

[hilcj]

Thanks for all feedbacks! Closing this issue and review responses.