diff --git a/docs/pipeline-api.md b/docs/pipeline-api.md index 923318413a2..793f0653751 100644 --- a/docs/pipeline-api.md +++ b/docs/pipeline-api.md @@ -5958,9 +5958,9 @@ RunStatus
VerificationPolicy defines the Tekton resources and corresponding authorities to verify. -The VerificationPolicy is used in trusted resources to store the public keys to verify -Tekton resources.
+VerificationPolicy defines the rules to verify Tekton resources. +VerificationPolicy can config the mapping from resources to a list of public +keys, so when verifying the resources we can use the corresponding public keys.
- Resources defines the patterns of Resources names that should be subject to this policy. -For example, we may want to apply this Policy only from a certain github repo. -Then the ResourcesPattern should include the path. If using gitresolver, and we want to config keys from a certain git repo. + Resources defines the patterns of resources sources that should be subject to this policy.
+For example, we may want to apply this Policy from a certain GitHub repo.
+Then the ResourcesPattern should be valid regex. E.g. If using gitresolver, and we want to config keys from a certain git repo.
|
@@ -6186,7 +6186,7 @@ the controller, but was unused as there is no controller for PipelineResource.
(Appears on:VerificationPolicySpec)
- Key defines the type of key to validate the resource. +Key contains the public key to validate the resource. |
@@ -6293,6 +6293,14 @@ structs.
string
alias)+(Appears on:KeyRef) +
+HashAlgorithm defines the hash algorithm used for the public key
+@@ -6339,7 +6347,9 @@ string
hashAlgorithm
Pattern defines a resource pattern. Regex is created to filter resources based on Pattern
-Examples patterns:
-Github resource: https://github.com/tektoncd/catalog.git, https://github.com/tektoncd/*
+Example patterns:
+GitHub resource: https://github.com/tektoncd/catalog.git, https://github.com/tektoncd/*
Bundle resource: gcr.io/tekton-releases/catalog/upstream/git-clone, gcr.io/tekton-releases/catalog/upstream/*
Hub resource: https://artifacthub.io/*,
string
alias)
TaskRunConditionType is an enum used to store TaskRun custom conditions +
TaskRunConditionType is an enum used to store TaskRun custom conditions such as one used in spire results verification