From aaad618e204365e72b0aa1a45234059653707a48 Mon Sep 17 00:00:00 2001 From: stefanprodan Date: Mon, 20 Jul 2020 15:02:53 +0300 Subject: [PATCH] Rename kustomization arg from validate to validation Fix `tk create kustomization` command args inconsistency with the Kustomize API --- .github/workflows/e2e.yaml | 2 +- cmd/tk/create_kustomization.go | 12 ++++++------ cmd/tk/main.go | 2 +- docs/cmd/tk.md | 2 +- docs/cmd/tk_create_kustomization.md | 8 ++++---- docs/get-started/index.md | 12 ++++++------ 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml index 9002c0ff..524c5693 100644 --- a/.github/workflows/e2e.yaml +++ b/.github/workflows/e2e.yaml @@ -65,7 +65,7 @@ jobs: --path="./deploy/overlays/dev" \ --prune=true \ --interval=5m \ - --validate=client \ + --validation=client \ --health-check="Deployment/frontend.dev" \ --health-check="Deployment/backend.dev" \ --health-check-timeout=3m diff --git a/cmd/tk/create_kustomization.go b/cmd/tk/create_kustomization.go index 512dc14c..13ce334e 100644 --- a/cmd/tk/create_kustomization.go +++ b/cmd/tk/create_kustomization.go @@ -45,7 +45,7 @@ var createKsCmd = &cobra.Command{ --path="./examples/contour/" \ --prune=true \ --interval=10m \ - --validate=client \ + --validation=client \ --health-check="Deployment/contour.projectcontour" \ --health-check="DaemonSet/envoy.projectcontour" \ --health-check-timeout=3m @@ -57,7 +57,7 @@ var createKsCmd = &cobra.Command{ --path="./deploy/overlays/dev" \ --prune=true \ --interval=5m \ - --validate=client + --validation=client # Create a Kustomization resource that runs under a service account create kustomization webapp \ @@ -65,7 +65,7 @@ var createKsCmd = &cobra.Command{ --path="./deploy/overlays/staging" \ --prune=true \ --interval=5m \ - --validate=client \ + --validation=client \ --sa-name=reconclier \ --sa-namespace=staging `, @@ -77,7 +77,7 @@ var ( ksPath string ksPrune bool ksDependsOn []string - ksValidate string + ksValidation string ksHealthCheck []string ksHealthTimeout time.Duration ksSAName string @@ -90,7 +90,7 @@ func init() { createKsCmd.Flags().BoolVar(&ksPrune, "prune", false, "enable garbage collection") createKsCmd.Flags().StringArrayVar(&ksHealthCheck, "health-check", nil, "workload to be included in the health assessment, in the format '/.'") createKsCmd.Flags().DurationVar(&ksHealthTimeout, "health-check-timeout", 2*time.Minute, "timeout of health checking operations") - createKsCmd.Flags().StringVar(&ksValidate, "validate", "", "validate the manifests before applying them on the cluster, can be 'client' or 'server'") + createKsCmd.Flags().StringVar(&ksValidation, "validation", "", "validate the manifests before applying them on the cluster, can be 'client' or 'server'") createKsCmd.Flags().StringArrayVar(&ksDependsOn, "depends-on", nil, "Kustomization that must be ready before this Kustomization can be applied") createKsCmd.Flags().StringVar(&ksSAName, "sa-name", "", "service account name") createKsCmd.Flags().StringVar(&ksSANamespace, "sa-namespace", "", "service account namespace") @@ -142,7 +142,7 @@ func createKsCmdRun(cmd *cobra.Command, args []string) error { Name: ksSource, }, Suspend: false, - Validation: ksValidate, + Validation: ksValidation, }, } diff --git a/cmd/tk/main.go b/cmd/tk/main.go index 4b01667f..aaaa64a0 100644 --- a/cmd/tk/main.go +++ b/cmd/tk/main.go @@ -65,7 +65,7 @@ var rootCmd = &cobra.Command{ --path="./deploy/webapp/" \ --prune=true \ --interval=5m \ - --validate=client \ + --validation=client \ --health-check="Deployment/backend.webapp" \ --health-check="Deployment/frontend.webapp" \ --health-check-timeout=2m diff --git a/docs/cmd/tk.md b/docs/cmd/tk.md index 447d55af..b4dee787 100644 --- a/docs/cmd/tk.md +++ b/docs/cmd/tk.md @@ -36,7 +36,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way. --path="./deploy/webapp/" \ --prune=true \ --interval=5m \ - --validate=client \ + --validation=client \ --health-check="Deployment/backend.webapp" \ --health-check="Deployment/frontend.webapp" \ --health-check-timeout=2m diff --git a/docs/cmd/tk_create_kustomization.md b/docs/cmd/tk_create_kustomization.md index bdb32f95..18464d46 100644 --- a/docs/cmd/tk_create_kustomization.md +++ b/docs/cmd/tk_create_kustomization.md @@ -19,7 +19,7 @@ tk create kustomization [name] [flags] --path="./examples/contour/" \ --prune=true \ --interval=10m \ - --validate=client \ + --validation=client \ --health-check="Deployment/contour.projectcontour" \ --health-check="DaemonSet/envoy.projectcontour" \ --health-check-timeout=3m @@ -31,7 +31,7 @@ tk create kustomization [name] [flags] --path="./deploy/overlays/dev" \ --prune=true \ --interval=5m \ - --validate=client + --validation=client # Create a Kustomization resource that runs under a service account create kustomization webapp \ @@ -39,7 +39,7 @@ tk create kustomization [name] [flags] --path="./deploy/overlays/staging" \ --prune=true \ --interval=5m \ - --validate=client \ + --validation=client \ --sa-name=reconclier \ --sa-namespace=staging @@ -57,7 +57,7 @@ tk create kustomization [name] [flags] --sa-name string service account name --sa-namespace string service account namespace --source string GitRepository name - --validate string validate the manifests before applying them on the cluster, can be 'client' or 'server' + --validation string validate the manifests before applying them on the cluster, can be 'client' or 'server' ``` ### Options inherited from parent commands diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 81560580..06a7edea 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -2,7 +2,7 @@ ## Prerequisites -You will need two Kubernetes clusters version 1.14 or newer and kubectl version 1.18. +You will need two Kubernetes clusters version 1.16 or newer and kubectl version 1.18. For a quick local test, you can use [Kubernetes kind](https://kind.sigs.k8s.io/docs/user/quick-start/). Any other Kubernetes setup will work as well though. @@ -63,7 +63,7 @@ $ tk check --pre ► checking prerequisites ✔ kubectl 1.18.3 >=1.18.0 -✔ kubernetes 1.18.2 >=1.14.0 +✔ kubernetes 1.18.2 >=1.16.0 ✔ prerequisites checks passed ``` @@ -152,7 +152,7 @@ tk create kustomization webapp-common \ --source=webapp \ --path="./deploy/webapp/common" \ --prune=true \ - --validate=client \ + --validation=client \ --interval=1h \ --export > ./staging-cluster/webapp-common.yaml ``` @@ -165,7 +165,7 @@ tk create kustomization webapp-backend \ --source=webapp \ --path="./deploy/webapp/backend" \ --prune=true \ - --validate=client \ + --validation=client \ --interval=10m \ --health-check="Deployment/backend.webapp" \ --health-check-timeout=2m \ @@ -180,7 +180,7 @@ tk create kustomization webapp-frontend \ --source=webapp \ --path="./deploy/webapp/frontend" \ --prune=true \ - --validate=client \ + --validation=client \ --interval=10m \ --health-check="Deployment/frontend.webapp" \ --health-check-timeout=2m \ @@ -278,7 +278,7 @@ tk create kustomization webapp \ --source=webapp \ --path="./deploy/overlays/production" \ --prune=true \ - --validate=client \ + --validation=client \ --interval=10m \ --health-check="Deployment/frontend.production" \ --health-check="Deployment/backend.production" \