From bdca6fe9462cee395b6d14278574a7ce7e0f5a19 Mon Sep 17 00:00:00 2001 From: Christopher May Date: Tue, 1 Jun 2021 14:43:01 -0400 Subject: [PATCH] Fixed several typos / grammar issues found while copying values over for the GitLab Runner POC --- .../Pipeline_ploigos-workflow-everything.yml | 50 +++++++++---------- .../everything-tekton-pipeline/values.yaml | 18 +++---- .../Pipeline_ploigos-workflow-minimal.yml | 35 +++++++------ .../minimal-tekton-pipeline/values.yaml | 10 ++-- ...ask_ploigos-setup-workflow-step-runner.yml | 4 +- .../templates/TriggerTemplate.yml | 6 +-- .../tekton-shared-resources/values.yaml | 14 +++--- .../typical-tekton-pipeline/values.yaml | 4 +- 8 files changed, 70 insertions(+), 71 deletions(-) diff --git a/charts/ploigos-workflow/everything-tekton-pipeline/templates/Pipeline_ploigos-workflow-everything.yml b/charts/ploigos-workflow/everything-tekton-pipeline/templates/Pipeline_ploigos-workflow-everything.yml index 638bd8d..44c1b37 100644 --- a/charts/ploigos-workflow/everything-tekton-pipeline/templates/Pipeline_ploigos-workflow-everything.yml +++ b/charts/ploigos-workflow/everything-tekton-pipeline/templates/Pipeline_ploigos-workflow-everything.yml @@ -18,14 +18,14 @@ spec: {{- if $.Values.global.separatePlatformConfig }} - name: ploigos-platform-config description: | - Workspace containing platform-level config + Workspace containing platform-level config. - name: ploigos-platform-config-secrets description: | - Workspace containing platform-level secrets + Workspace containing platform-level secrets. {{- end }} params: - name: verbose - description: log any *sh commands used during execution + description: Log any *sh commands used during execution. type: string default: "false" - name: appRepoUrl @@ -39,7 +39,7 @@ spec: - name: appCloneSSLVerify description: | Passed to git-clone ClusterTask. - Defines if http.sslVerify should be set to true or false in the global git config + Defines if http.sslVerify should be set to true or false in the global git config. type: string default: "true" - name: stepRunnerConfigDir @@ -78,20 +78,20 @@ spec: type: string description: | Regex pattern for git references that should only go through the - Continues Integration (CI) workflow. + Continuous Integration (CI) workflow. default: "^$" - name: devGitRefPatterns type: string description: | Regex pattern for git references that should go through the - Continues Integration (CI) workflow and then the deployment to + Continuous Integration (CI) workflow and then the deployment to "Development" environment(s) (IE: "DEV" environment) workflow. default: "^feature/.+$|^PR-.+$" - name: releaseGitRefPatterns type: string description: | Regex pattern for git references that should go through the - Continues Integration (CI) workflow and then the deployment to + Continuous Integration (CI) workflow and then the deployment to "Release" environment(s) (IE: "TEST" and then "PROD" environments) workflow. default: "^main$" - name: stepRunnerPackageName @@ -122,7 +122,7 @@ spec: NOTE ---- PIP is indeterminate whether it will pull packages from '--index-url' or - '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' if trying to pull a specific version from a specific index. SEE @@ -139,7 +139,7 @@ spec: NOTE ---- PIP is indeterminate whether it will pull packages from '--index-url' or - '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' if trying to pull a specific version from a specific index. SEE @@ -161,7 +161,7 @@ spec: type: string description: | If none empty value given and 'stepRunnerUpdateLibrary' is true this will be used as the source - location to install the Workflow Step Runner library from rather then from a PEP 503 compliant + location to install the Workflow Step Runner library from rather than from a PEP 503 compliant repository. If given then the following parameters are ignored: @@ -241,7 +241,7 @@ spec: Container image to use when creating a workflow worker to run pipeline steps when performing deploy step(s). default: ploigos/ploigos-tool-argocd:latest - - name: workflowWorkerImageValidateEnvironmentConfiguraiton + - name: workflowWorkerImageValidateEnvironmentConfiguration type: string description: | Container image to use when creating a workflow worker @@ -311,9 +311,9 @@ spec: runAfter: - setup-stage-gate # NOTE: - # this dependency is only here because of read/write once constraints of most PV/PVCs - # if happening to be using storage that supports ReadWriteMany then the following steps - # can run in parallel + # This dependency is only here because of read/write once constraints of most PV/PVCs. + # If happening to be using storage that supports ReadWriteMany then the following steps + # can run in parallel. # * setup-app-clone # * setup-workflow-step-runner # * setup-pgp-keys @@ -355,9 +355,9 @@ spec: runAfter: - setup-stage-gate # NOTE: - # this dependency is only here because of read/write once constraints of most PV/PVCs - # if happening to be using storage that supports ReadWriteMany then the following steps - # can run in parallel + # This dependency is only here because of read/write once constraints of most PV/PVCs. + # If happening to be using storage that supports ReadWriteMany then the following steps + # can run in parallel. # * setup-app-clone # * setup-workflow-step-runner # * setup-pgp-keys @@ -382,9 +382,9 @@ spec: - name: pgpKeysSecretName value: $(params.pgpKeysSecretName) - ######################### - # Continues Integration # - ######################### + ########################## + # Continuous Integration # + ########################## - name: ci-stage-gate runAfter: - setup-app-clone @@ -728,7 +728,7 @@ spec: runAfter: - ci-create-container-image # NOTE: - # since we need to share the $HOME dir between tasks and Kube and Tekton don't like + # Since we need to share the $HOME dir between tasks, and Kube and Tekton don't like # two pods mounting the same PV as ready write, we can't run the vulnerability and compliance # tasks in parallel. # @@ -973,7 +973,7 @@ spec: - name: verbose value: $(params.verbose) - name: image - value: $(params.workflowWorkerImageValidateEnvironmentConfiguraiton) + value: $(params.workflowWorkerImageValidateEnvironmentConfiguration) - name: imagePullPolicy value: $(params.workflowWorkersImagePullPolicy) - name: stepRunnerPackageName @@ -1078,7 +1078,7 @@ spec: runAfter: # NOTE: # We would prefer to say this runs after the DEV stage finishes.... - # but....https://github.com/tektoncd/pipeline/issues/2127. Which means + # but....https://github.com/tektoncd/pipeline/issues/2127. Which means: # If the DEV stage is skipped then this stage will be skipped too because the # dev-generate-evidence task was skipped so the runAfter makes it so this step # would never run. @@ -1165,7 +1165,7 @@ spec: - name: verbose value: $(params.verbose) - name: image - value: $(params.workflowWorkerImageValidateEnvironmentConfiguraiton) + value: $(params.workflowWorkerImageValidateEnvironmentConfiguration) - name: imagePullPolicy value: $(params.workflowWorkersImagePullPolicy) - name: stepRunnerPackageName @@ -1350,7 +1350,7 @@ spec: - name: verbose value: $(params.verbose) - name: image - value: $(params.workflowWorkerImageValidateEnvironmentConfiguraiton) + value: $(params.workflowWorkerImageValidateEnvironmentConfiguration) - name: imagePullPolicy value: $(params.workflowWorkersImagePullPolicy) - name: stepRunnerPackageName diff --git a/charts/ploigos-workflow/everything-tekton-pipeline/values.yaml b/charts/ploigos-workflow/everything-tekton-pipeline/values.yaml index 40dd34e..6d0bc2a 100644 --- a/charts/ploigos-workflow/everything-tekton-pipeline/values.yaml +++ b/charts/ploigos-workflow/everything-tekton-pipeline/values.yaml @@ -28,7 +28,7 @@ global: # eventListenerCreateRoute is boolean whether to create a Route to the EventListener. # Routes are specific to OpenShift but are convenient in that they can auto-generate # a host name for the Route. - # If true then eventListenerRouteHostOverride maybe specified. + # If true then eventListenerRouteHostOverride may be specified. # If false then eventListenerRouteHostOverride is ignored. eventListenerCreateRoute: true @@ -75,7 +75,7 @@ global: # that deletes old PipelineRuns. # This is important if your Kubernetes Cluster isn't always on because the CronJob will # think it failed to run while the Kubernetes Cluster was off and then stop attempting to run - # all together. Therefor this number should be long enough to cover any planned outage periods. + # all together. Therefore this number should be long enough to cover any planned outage periods. # See https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#cron-job-limitations # Required. cleanupPipelineStartingDeadlineSeconds: 600 @@ -130,7 +130,7 @@ global: # NOTE # ---- # PIP is indeterminate whether it will pull packages from '--index-url' or - # '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + # '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' # if trying to pull a specific version from a specific index. # # SEE @@ -147,7 +147,7 @@ global: # NOTE # ---- # PIP is indeterminate whether it will pull packages from '--index-url' or - # '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + # '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' # if trying to pull a specific version from a specific index. # # SEE @@ -183,16 +183,16 @@ global: envNameProd: PROD # ciOnlyGitRefPatterns is the regex pattern for git references that should only go through the - # Continues Integration (CI) workflow. + # Continuous Integration (CI) workflow. # Required. ciOnlyGitRefPatterns: "^$" # devGitRefPatterns is the Regex pattern for git references that should go through the - # Continues Integration (CI) workflow and then the deployment to + # Continuous Integration (CI) workflow and then the deployment to # "Development" environment(s) (IE: "DEV" environment) workflow. # Required. devGitRefPatterns: "^feature/.+$|^PR-.+$" # releaseGitRefPatterns is the Regex pattern for git references that should go through the - # Continues Integration (CI) workflow and then the deployment to + # Continuous Integration (CI) workflow and then the deployment to # "Release" environment(s) (IE: "TEST" and then "PROD" environments) workflow. # Required. releaseGitRefPatterns: "^main$" @@ -283,10 +283,10 @@ global: # workflowWorkerImageDeploy is the container image to use when creating a workflow worker # to run pipeline steps when performing deploy step(s). workflowWorkerImageDeploy: ploigos/ploigos-tool-argocd:latest - # workflowWorkerImageValidateEnvironmentConfiguraiton is the + # workflowWorkerImageValidateEnvironmentConfiguration is the # container image to use when creating a workflow worker # to run pipeline steps when performing validate environment configuration step(s). - workflowWorkerImageValidateEnvironmentConfiguraiton: ploigos/ploigos-tool-config-lint:latest + workflowWorkerImageValidateEnvironmentConfiguration: ploigos/ploigos-tool-config-lint:latest # workflowWorkerImageUAT is the container image to use when creating a workflow worker # to run pipeline steps when performing user acceptance tests (UAT) step(s). workflowWorkerImageUAT: diff --git a/charts/ploigos-workflow/minimal-tekton-pipeline/templates/Pipeline_ploigos-workflow-minimal.yml b/charts/ploigos-workflow/minimal-tekton-pipeline/templates/Pipeline_ploigos-workflow-minimal.yml index b02bf1d..0850dff 100644 --- a/charts/ploigos-workflow/minimal-tekton-pipeline/templates/Pipeline_ploigos-workflow-minimal.yml +++ b/charts/ploigos-workflow/minimal-tekton-pipeline/templates/Pipeline_ploigos-workflow-minimal.yml @@ -25,7 +25,7 @@ spec: {{- end }} params: - name: verbose - description: log any *sh commands used during execution + description: Log any *sh commands used during execution. type: string default: "false" - name: appRepoUrl @@ -39,7 +39,7 @@ spec: - name: appCloneSSLVerify description: | Passed to git-clone ClusterTask. - Defines if http.sslVerify should be set to true or false in the global git config + Defines if http.sslVerify should be set to true or false in the global git config. type: string default: "true" - name: stepRunnerConfigDir @@ -74,25 +74,24 @@ spec: files and to pass to the Workflow Step Runner when running a step targeted to the "Production" environment. default: PROD - - name: ciOnlyGitRefPatterns type: string description: | Regex pattern for git references that should only go through the - Continues Integration (CI) workflow. + Continuous Integration (CI) workflow. default: "^$" - name: devGitRefPatterns type: string description: | Regex pattern for git references that should go through the - Continues Integration (CI) workflow and then the deployment to + Continuous Integration (CI) workflow and then the deployment to "Development" environment(s) (IE: "DEV" environment) workflow. default: "^feature/.+$|^PR-.+$" - name: releaseGitRefPatterns type: string description: | Regex pattern for git references that should go through the - Continues Integration (CI) workflow and then the deployment to + Continuous Integration (CI) workflow and then the deployment to "Release" environment(s) (IE: "TEST" and then "PROD" environments) workflow. default: "^main$" - name: stepRunnerPackageName @@ -123,7 +122,7 @@ spec: NOTE ---- PIP is indeterminate whether it will pull packages from '--index-url' or - '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' if trying to pull a specific version from a specific index. SEE @@ -140,7 +139,7 @@ spec: NOTE ---- PIP is indeterminate whether it will pull packages from '--index-url' or - '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' if trying to pull a specific version from a specific index. SEE @@ -278,9 +277,9 @@ spec: runAfter: - setup-stage-gate # NOTE: - # this dependency is only here because of read/write once constraints of most PV/PVCs - # if happening to be using storage that supports ReadWriteMany then the following steps - # can run in parallel + # This dependency is only here because of read/write once constraints of most PV/PVCs. + # If happening to be using storage that supports ReadWriteMany then the following steps + # can run in parallel. # * setup-app-clone # * setup-workflow-step-runner # * setup-pgp-keys @@ -322,9 +321,9 @@ spec: runAfter: - setup-stage-gate # NOTE: - # this dependency is only here because of read/write once constraints of most PV/PVCs - # if happening to be using storage that supports ReadWriteMany then the following steps - # can run in parallel + # This dependency is only here because of read/write once constraints of most PV/PVCs. + # If happening to be using storage that supports ReadWriteMany then the following steps + # can run in parallel. # * setup-app-clone # * setup-workflow-step-runner # * setup-pgp-keys @@ -349,9 +348,9 @@ spec: - name: pgpKeysSecretName value: $(params.pgpKeysSecretName) - ######################### - # Continues Integration # - ######################### + ########################## + # Continuous Integration # + ########################## - name: ci-stage-gate runAfter: - setup-app-clone @@ -595,7 +594,7 @@ spec: # NOTE: # We would prefer to say this runs after the DEV stage finishes.... # but....https://github.com/tektoncd/pipeline/issues/2127. Which means - # If the DEV stage is skipped then this stage will be skipped too because the + # if the DEV stage is skipped then this stage will be skipped too because the # dev-deploy-or-update-environment task was skipped so the runAfter makes it so this step # would never run. - ci-push-container-image-to-repository diff --git a/charts/ploigos-workflow/minimal-tekton-pipeline/values.yaml b/charts/ploigos-workflow/minimal-tekton-pipeline/values.yaml index 87e535a..d9ea5c8 100644 --- a/charts/ploigos-workflow/minimal-tekton-pipeline/values.yaml +++ b/charts/ploigos-workflow/minimal-tekton-pipeline/values.yaml @@ -130,7 +130,7 @@ global: # NOTE # ---- # PIP is indeterminate whether it will pull packages from '--index-url' or - # '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + # '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' # if trying to pull a specific version from a specific index. # # SEE @@ -147,7 +147,7 @@ global: # NOTE # ---- # PIP is indeterminate whether it will pull packages from '--index-url' or - # '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + # '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' # if trying to pull a specific version from a specific index. # # SEE @@ -183,16 +183,16 @@ global: envNameProd: PROD # ciOnlyGitRefPatterns is the regex pattern for git references that should only go through the - # Continues Integration (CI) workflow. + # Continuous Integration (CI) workflow. # Required. ciOnlyGitRefPatterns: "^$" # devGitRefPatterns is the Regex pattern for git references that should go through the - # Continues Integration (CI) workflow and then the deployment to + # Continuous Integration (CI) workflow and then the deployment to # "Development" environment(s) (IE: "DEV" environment) workflow. # Required. devGitRefPatterns: "^feature/.+$|^PR-.+$" # releaseGitRefPatterns is the Regex pattern for git references that should go through the - # Continues Integration (CI) workflow and then the deployment to + # Continuous Integration (CI) workflow and then the deployment to # "Release" environment(s) (IE: "TEST" and then "PROD" environments) workflow. # Required. releaseGitRefPatterns: "^main$" diff --git a/charts/ploigos-workflow/tekton-cluster-resources/templates/ClusterTask_ploigos-setup-workflow-step-runner.yml b/charts/ploigos-workflow/tekton-cluster-resources/templates/ClusterTask_ploigos-setup-workflow-step-runner.yml index d9f8c1c..ae372d9 100644 --- a/charts/ploigos-workflow/tekton-cluster-resources/templates/ClusterTask_ploigos-setup-workflow-step-runner.yml +++ b/charts/ploigos-workflow/tekton-cluster-resources/templates/ClusterTask_ploigos-setup-workflow-step-runner.yml @@ -64,7 +64,7 @@ spec: NOTE ---- PIP is indeterminate whether it will pull packages from '--index-url' or - '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' if trying to pull a specific version from a specific index. SEE @@ -81,7 +81,7 @@ spec: NOTE ---- PIP is indeterminate whether it will pull packages from '--index-url' or - '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' if trying to pull a specific version from a specific index. SEE diff --git a/charts/ploigos-workflow/tekton-shared-resources/templates/TriggerTemplate.yml b/charts/ploigos-workflow/tekton-shared-resources/templates/TriggerTemplate.yml index c75fac3..652aa1f 100644 --- a/charts/ploigos-workflow/tekton-shared-resources/templates/TriggerTemplate.yml +++ b/charts/ploigos-workflow/tekton-shared-resources/templates/TriggerTemplate.yml @@ -145,9 +145,9 @@ spec: {{- end }} - name: workflowWorkerImageDeploy value: {{ (required "Global Value is required: workflowWorkerImageDeploy" $.Values.global.workflowWorkerImageDeploy) | quote }} - {{- if $.Values.global.workflowWorkerImageValidateEnvironmentConfiguraiton }} - - name: workflowWorkerImageValidateEnvironmentConfiguraiton - value: {{ $.Values.global.workflowWorkerImageValidateEnvironmentConfiguraiton | quote }} + {{- if $.Values.global.workflowWorkerImageValidateEnvironmentConfiguration }} + - name: workflowWorkerImageValidateEnvironmentConfiguration + value: {{ $.Values.global.workflowWorkerImageValidateEnvironmentConfiguration | quote }} {{- end }} {{- if $.Values.global.workflowWorkerImageUAT }} - name: workflowWorkerImageUAT diff --git a/charts/ploigos-workflow/tekton-shared-resources/values.yaml b/charts/ploigos-workflow/tekton-shared-resources/values.yaml index f32245a..28d848e 100644 --- a/charts/ploigos-workflow/tekton-shared-resources/values.yaml +++ b/charts/ploigos-workflow/tekton-shared-resources/values.yaml @@ -130,7 +130,7 @@ global: # NOTE # ---- # PIP is indeterminate whether it will pull packages from '--index-url' or - # '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + # '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' # if trying to pull a specific version from a specific index. # # SEE @@ -147,7 +147,7 @@ global: # NOTE # ---- # PIP is indeterminate whether it will pull packages from '--index-url' or - # '--extra-index-url', therefor be sure to specify 'stepRunnerLibVersion' + # '--extra-index-url', therefore be sure to specify 'stepRunnerLibVersion' # if trying to pull a specific version from a specific index. # # SEE @@ -183,16 +183,16 @@ global: envNameProd: PROD # ciOnlyGitRefPatterns is the regex pattern for git references that should only go through the - # Continues Integration (CI) workflow. + # Continuous Integration (CI) workflow. # Required. ciOnlyGitRefPatterns: "^$" # devGitRefPatterns is the Regex pattern for git references that should go through the - # Continues Integration (CI) workflow and then the deployment to + # Continuous Integration (CI) workflow and then the deployment to # "Development" environment(s) (IE: "DEV" environment) workflow. # Required. devGitRefPatterns: "^feature/.+$|^PR-.+$" # releaseGitRefPatterns is the Regex pattern for git references that should go through the - # Continues Integration (CI) workflow and then the deployment to + # Continuous Integration (CI) workflow and then the deployment to # "Release" environment(s) (IE: "TEST" and then "PROD" environments) workflow. # Required. releaseGitRefPatterns: "^main$" @@ -283,10 +283,10 @@ global: # workflowWorkerImageDeploy is the container image to use when creating a workflow worker # to run pipeline steps when performing deploy step(s). workflowWorkerImageDeploy: ploigos/ploigos-tool-argocd:latest - # workflowWorkerImageValidateEnvironmentConfiguraiton is the + # workflowWorkerImageValidateEnvironmentConfiguration is the # container image to use when creating a workflow worker # to run pipeline steps when performing validate environment configuration step(s). - workflowWorkerImageValidateEnvironmentConfiguraiton: ploigos/ploigos-tool-config-lint:latest + workflowWorkerImageValidateEnvironmentConfiguration: ploigos/ploigos-tool-config-lint:latest # workflowWorkerImageUAT is the container image to use when creating a workflow worker # to run pipeline steps when performing user acceptance tests (UAT) step(s). workflowWorkerImageUAT: diff --git a/charts/ploigos-workflow/typical-tekton-pipeline/values.yaml b/charts/ploigos-workflow/typical-tekton-pipeline/values.yaml index 40dd34e..4b27116 100644 --- a/charts/ploigos-workflow/typical-tekton-pipeline/values.yaml +++ b/charts/ploigos-workflow/typical-tekton-pipeline/values.yaml @@ -283,10 +283,10 @@ global: # workflowWorkerImageDeploy is the container image to use when creating a workflow worker # to run pipeline steps when performing deploy step(s). workflowWorkerImageDeploy: ploigos/ploigos-tool-argocd:latest - # workflowWorkerImageValidateEnvironmentConfiguraiton is the + # workflowWorkerImageValidateEnvironmentConfiguration is the # container image to use when creating a workflow worker # to run pipeline steps when performing validate environment configuration step(s). - workflowWorkerImageValidateEnvironmentConfiguraiton: ploigos/ploigos-tool-config-lint:latest + workflowWorkerImageValidateEnvironmentConfiguration: ploigos/ploigos-tool-config-lint:latest # workflowWorkerImageUAT is the container image to use when creating a workflow worker # to run pipeline steps when performing user acceptance tests (UAT) step(s). workflowWorkerImageUAT: