SupplyChain API

This topic gives you reference information about the SupplyChain resource for Tanzu Supply Chain.

Caution

Tanzu Supply Chain is currently in beta and is not intended for production use. It is intended only for evaluation purposes for the next generation Supply Chain. For the current Supply Chain solution, see the Supply Chain Choreographer documentation.

The supply chain defines the object kind of the Workload, the Components used, and their order.

Type and Object Metadata

apiVersion: supply-chain.apps.tanzu.vmware.com/v1alpha1
kind: SupplyChain

metadata.name

metadata.name is in the form:

<plural-name>.<group>-<Major>.<minor>.<patch>

  • plural-name must match the plural form of defines.kind, without the version. For example: kind: JavaServerAppV3 would have a plural-name of javaserverappv3s
  • group must match defines.group. See spec.defines.group later in the topic.
  • <Major>.<minor>.<patch> is the version definition.
metadata:
  name: hostedapps.widget.com-0.0.1

Spec

spec.config

The spec.stages structure introduces Components, where the aggregated config sections form the SupplyChain’s configuration and become the Workload spec.

This configuration can be altered by changing defaults, or overridden and hidden from the Workload.

spec.config.defaults

Change or add defaults for the config that is presented in the Workload’s spec.

spec.config.defaults is an array of path: and value: fields, where:

  • path is the path to the configuration value, formatted as either:
    • The full path to the field you want to set.
    • The path to any structure where all desired child fields must be set.
  • value: A string or structure value.

spec.config.overrides

Override the value of a config field, so that it no longer appears in the Workload spec.

spec.config.overrides is an array of path: and value: fields, where:

  • path is the path to the configuration value, formatted as either:

    • The full path to the field you wish to set.
    • The path to any structure where all desired child fields must be set.

  • value is the string or structure value.

Example

apiVersion: supply-chain.apps.tanzu.vmware.com/v1alpha1
kind: SupplyChain
spec:
  config:
    defaults:
      - path: spec.source
        value:
          branch: develop
          url: https://our.git.com/our-monorepo
    overrides:
      - path: spec.registry.repository
        value: "YOUR-REGISTRY-REPO"
      - path: spec.registry.server
        value: "YOUR-REGISTRY-SERVER"

spec.description

The spec.description field is visible to an app developer when they use the CLI to discover available Workload kinds:

tanzu workload kind list --wide

KIND                      VERSION     AGE   DESCRIPTION
serverappv2.example.com   v1alpha1    12m   Server application supply chain

Recommendation: embed complete documentation in the description.

The description field supports multi-line Plain text or Markdown.

spec.defines

The spec.defines object defines the Workload custom resource definition (CRD).

spec.defines.group

spec.defines.group (required) is used to fill in the group field in the [CustomResourceDefinitionSpec].

spec.defines.group is the classic domain-formatted group of any Kubernetes object. Use your organization’s top level domain, or a departmental domain.

spec.defines.kind

spec.defines.kind (required) is the name of the resource in CamelCase.

spec.defines.plural

spec.defines.plural (required) is typically the plural down-cased form of the kind. It must be all lowercase.

Recommendation: pluralize the name after the version, e.g: WebAppV1 becomes webappv1s

spec.defines.singular

spec.defines.singular is optional and defaults to the lowercase of kind, for example ServerAppv1 becomes serverappv1.

spec.defines.shortnames

spec.defines.shortnames is a list and defaults to empty. Use this to specify an array of aliases for your kind. These are great to simplify kubectl commands.

Example
kind: ServerAppV1
plural: serverappv1s
shortnames:
  - serverapp1
  - sa1

spec.defines.categories

spec.defines.categories is a list and defaults to empty. spec.defines.categories specify a collection term for a group of kinds, so that kubectl get <category> returns instances of all kinds in the category.

Example

Using kubectl get apps would include this kind in the listing

kind: ServerAppV1
plural: serverappv1s
categories:
  - apps

Complete Example

spec:
  defines: # Describes the workload
    kind: HostedApp
    pluralName: hostedapps
    group: example.com
    version: v1alpha1
    categories:
      - apps
    shortnames:
      - hosted1
      - ha1

spec.stages[]

spec.stages break the work to be done by this supply chain into a serial collection of “stages”, each with a component.

This is where you define the operations of this SupplyChain.

spec.stages[].name

Each stage has a name, which is shown to the user in the CLI and UI. name can only be composed of hyphens and lowercase alphanumeric characters.

spec.stages[].componentRef

Each stage also has a componentRef with a single field, name. componentRef.Name refers to the name of a Tanzu Supply Chain [Component] resource. Currently, [Component] must exist in the same namespace as the SupplyChain. The supply chain returns an error if a component expects an input that has not been output by a previous stage.

spec.stages[].securityContext

Each stage can specify a securityContext with a single field, runAs. When this is set to workload the stage is executed in the namespace of the Workload rather than the Supply Chain. For more information, see Security Model.

Example

apiVersion: supply-chain.apps.tanzu.vmware.com/v1alpha1
kind: SupplyChain
spec:
  stages:
    - name: fetch-source
      componentRef:
        name: source-git-provider-1.0.0
      securityContext:
        runAs: workload
    - name: build
      componentRef:
        name: golang-builder-1.0.0
    - name: commit
      componentRef:
        name: commit-writer-1.0.0

Status

status.conditions[]

Every status.conditions[] in Tanzu Supply Chain resources follows a strict set of conventions.

The top-level condition type is Ready because SupplyChain is a living resource.

The sub-types are:

RBACDefined

Reason Meaning
Ready The RoleBindings for the kind declared in spec.defines was created on the cluster.
AlreadyExists The RoleBinding record already exists.
Most common cause of this issue is another Supply Chain with the same spec.defines section.
UnknownError The RoleBinding record failed due to an exceptional error. Look at the reconciler logs and contact Tanzu Support.

APIsDefined

Reason Meaning
Ready The CRD for the kind declared in spec.defines was created on the cluster.
Conflict The CRD already exists and is managed by another SupplyChain.
Most common cause of this issue is another Supply Chain with the same spec.defines section.
Invalid The CRD is invalid
Most common cause of this is an illegal OpenAPIV3Schema in the [Component].
Unknown error The CRD could not be created due to an exceptional error. Look at the reconciler logs and contact Tanzu Support.

StageMapping

Reason Meaning
Ready The stages pass all the validation rules.
NoSuchComponent The referenced component cannot be found.
NoSuchInput The input to the stage is not emitted by any stage.
InputNotSatisfiedUntilLater The input to the stage is not emitted by a previous stage.
InputMismatch The input matches a previous output by name, however the type does not match.
OutputRedefined The output redefines an existing output. Shadowing of outputs is not supported.
check-circle-line exclamation-circle-line close-line
Scroll to top icon