From e1fd6bb2e5f0441ea846487b16d8a904896282d0 Mon Sep 17 00:00:00 2001 From: Jason Hall Date: Mon, 22 Mar 2021 09:52:19 -0400 Subject: [PATCH] Update generated CRDs --- deploy/crds/shipwright.io_buildruns.yaml | 69 ++++++++++++------------ deploy/crds/shipwright.io_builds.yaml | 50 +++++++++-------- 2 files changed, 59 insertions(+), 60 deletions(-) diff --git a/deploy/crds/shipwright.io_buildruns.yaml b/deploy/crds/shipwright.io_buildruns.yaml index 0e3cb6f029..ce28a49e27 100644 --- a/deploy/crds/shipwright.io_buildruns.yaml +++ b/deploy/crds/shipwright.io_buildruns.yaml @@ -74,8 +74,8 @@ spec: spec properties: credentials: - description: SecretRef is a reference to the Secret containing - the credentials to push the image to the registry + description: Credentials references a Secret that contains credentials + to access the image registry. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -83,8 +83,7 @@ spec: type: string type: object image: - description: ImageURL is the URL where the image will be pushed - to. + description: Image is the reference of the image. type: string required: - image @@ -115,12 +114,12 @@ spec: description: BuildSpec is the Build Spec of this BuildRun. properties: builder: - description: BuilderImage refers to the image containing the build + description: Builder refers to the image containing the build tools inside which the source code would be built. properties: credentials: - description: SecretRef is a reference to the Secret containing - the credentials to push the image to the registry + description: Credentials references a Secret that contains + credentials to access the image registry. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -128,8 +127,7 @@ spec: type: string type: object image: - description: ImageURL is the URL where the image will be pushed - to. + description: Image is the reference of the image. type: string required: - image @@ -140,12 +138,12 @@ spec: an image. type: string output: - description: Output refers to the location where the generated - image would be pushed to. + description: Output refers to the location where the built image + would be pushed. properties: credentials: - description: SecretRef is a reference to the Secret containing - the credentials to push the image to the registry + description: Credentials references a Secret that contains + credentials to access the image registry. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -153,8 +151,7 @@ spec: type: string type: object image: - description: ImageURL is the URL where the image will be pushed - to. + description: Image is the reference of the image. type: string required: - image @@ -177,14 +174,14 @@ spec: type: object type: array runtime: - description: Runtime represents the runtime-image + description: Runtime represents the runtime-image. properties: base: description: Base runtime base image. properties: credentials: - description: SecretRef is a reference to the Secret containing - the credentials to push the image to the registry + description: Credentials references a Secret that contains + credentials to access the image registry. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -193,8 +190,7 @@ spec: type: string type: object image: - description: ImageURL is the URL where the image will - be pushed to. + description: Image is the reference of the image. type: string required: - image @@ -253,8 +249,8 @@ spec: Optional. type: string credentials: - description: SecretRef refers to the secret that contains - credentials to access the git repo. Optional. + description: Credentials references a Secret that contains + credentials to access the repository. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -276,19 +272,19 @@ spec: no proxying should be performed. Optional. type: string revision: - description: Ref is a git reference. Optional. If not defined, - it will fallback to the git repository default branch. + description: "Revision describes the Git revision (e.g., branch, + tag, commit SHA, etc.) to fetch. \n If not defined, it will + fallback to the repository's default branch." type: string url: - description: URL of the git repo + description: URL describes the URL of the Git repository. type: string required: - url type: object strategy: - description: StrategyRef refers to the BuildStrategy to be used - to build the container image. There are namespaced scope and - cluster scope BuildStrategy + description: Strategy references the BuildStrategy to use to build + the container image. properties: apiVersion: description: API version of the referent @@ -304,7 +300,8 @@ spec: - name type: object timeout: - description: Timeout defines the maximum run time of a build run. + description: Timeout defines the maximum amount of time the Build + should take to execute. format: duration type: string required: @@ -317,7 +314,8 @@ spec: format: date-time type: string conditions: - description: Conditions + description: Conditions holds the latest available observations of + a resource's current state. items: description: Condition defines the required fields for populating Build controllers Conditions @@ -354,18 +352,21 @@ spec: type: string type: object latestTaskRunRef: - description: PodName is the name of the pod responsible for executing - this task's steps. + description: "LatestTaskRunRef is the name of the TaskRun responsible + for executing this BuildRun. \n TODO: This should be called something + like \"TaskRunName\"" type: string reason: - description: The Succeeded reason of the TaskRun + description: "The Succeeded reason of the TaskRun \n Deprecated: Use + Conditions instead. This will be removed in a future release." type: string startTime: description: StartTime is the time the build is actually started. format: date-time type: string succeeded: - description: The Succeeded status of the TaskRun + description: "The Succeeded status of the TaskRun \n Deprecated: Use + Conditions instead. This will be removed in a future release." type: string type: object type: object diff --git a/deploy/crds/shipwright.io_builds.yaml b/deploy/crds/shipwright.io_builds.yaml index 5df9053003..9bb4eb9e5d 100644 --- a/deploy/crds/shipwright.io_builds.yaml +++ b/deploy/crds/shipwright.io_builds.yaml @@ -59,12 +59,12 @@ spec: description: BuildSpec defines the desired state of Build properties: builder: - description: BuilderImage refers to the image containing the build - tools inside which the source code would be built. + description: Builder refers to the image containing the build tools + inside which the source code would be built. properties: credentials: - description: SecretRef is a reference to the Secret containing - the credentials to push the image to the registry + description: Credentials references a Secret that contains credentials + to access the image registry. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -72,8 +72,7 @@ spec: type: string type: object image: - description: ImageURL is the URL where the image will be pushed - to. + description: Image is the reference of the image. type: string required: - image @@ -83,12 +82,12 @@ spec: build strategies which bank on the Dockerfile for building an image. type: string output: - description: Output refers to the location where the generated image - would be pushed to. + description: Output refers to the location where the built image would + be pushed. properties: credentials: - description: SecretRef is a reference to the Secret containing - the credentials to push the image to the registry + description: Credentials references a Secret that contains credentials + to access the image registry. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -96,8 +95,7 @@ spec: type: string type: object image: - description: ImageURL is the URL where the image will be pushed - to. + description: Image is the reference of the image. type: string required: - image @@ -120,14 +118,14 @@ spec: type: object type: array runtime: - description: Runtime represents the runtime-image + description: Runtime represents the runtime-image. properties: base: description: Base runtime base image. properties: credentials: - description: SecretRef is a reference to the Secret containing - the credentials to push the image to the registry + description: Credentials references a Secret that contains + credentials to access the image registry. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -135,8 +133,7 @@ spec: type: string type: object image: - description: ImageURL is the URL where the image will be pushed - to. + description: Image is the reference of the image. type: string required: - image @@ -194,8 +191,8 @@ spec: description: ContextDir is a path to subfolder in the repo. Optional. type: string credentials: - description: SecretRef refers to the secret that contains credentials - to access the git repo. Optional. + description: Credentials references a Secret that contains credentials + to access the repository. properties: name: description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names @@ -217,19 +214,19 @@ spec: no proxying should be performed. Optional. type: string revision: - description: Ref is a git reference. Optional. If not defined, - it will fallback to the git repository default branch. + description: "Revision describes the Git revision (e.g., branch, + tag, commit SHA, etc.) to fetch. \n If not defined, it will + fallback to the repository's default branch." type: string url: - description: URL of the git repo + description: URL describes the URL of the Git repository. type: string required: - url type: object strategy: - description: StrategyRef refers to the BuildStrategy to be used to - build the container image. There are namespaced scope and cluster - scope BuildStrategy + description: Strategy references the BuildStrategy to use to build + the container image. properties: apiVersion: description: API version of the referent @@ -245,7 +242,8 @@ spec: - name type: object timeout: - description: Timeout defines the maximum run time of a build run. + description: Timeout defines the maximum amount of time the Build + should take to execute. format: duration type: string required: