OPCT-177: nit rename plugins image to reflect the real name (#66)

nit pre-release to prevent future confusion when reading the code on the reference of "tools" and "plugins" images. - Tools image is the base image used to ship shared tools/binaries used by the plugin's image - Plugins image contains the openshift-provider-cert plugin itself, it is based on the Tools image
redhat-openshift-ecosystem · May 18, 2023 · f3e765a · f3e765a
1 parent fcf0b4d
commit f3e765a
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 14 deletions.
diff --git a/manifests/openshift-artifacts-collector.yaml b/manifests/openshift-artifacts-collector.yaml
@@ -6,7 +6,7 @@ podSpec:
       emptyDir: {}
   containers:
     - name: report-progress
-      image: "{{ .ToolsImage }}"
+      image: "{{ .PluginsImage }}"
       imagePullPolicy: Always
       priorityClassName: system-node-critical
       command: ["./report-progress.sh"]
@@ -39,7 +39,7 @@ sonobuoy-config:
   skipCleanup: true
 spec:
   name: plugin
-  image: "{{ .ToolsImage }}"
+  image: "{{ .PluginsImage }}"
   imagePullPolicy: Always
   volumeMounts:
   - mountPath: /tmp/sonobuoy/results

diff --git a/manifests/openshift-cluster-upgrade.yaml b/manifests/openshift-cluster-upgrade.yaml
@@ -6,7 +6,7 @@ podSpec:
       emptyDir: {}
   containers:
     - name: report-progress
-      image: "{{ .ToolsImage }}"
+      image: "{{ .PluginsImage }}"
       imagePullPolicy: Always
       priorityClassName: system-node-critical
       command: ["./report-progress.sh"]
@@ -39,7 +39,7 @@ sonobuoy-config:
   skipCleanup: true
 spec:
   name: plugin
-  image: "{{ .ToolsImage }}"
+  image: "{{ .PluginsImage }}"
   imagePullPolicy: Always
   priorityClassName: system-node-critical
   volumeMounts:

diff --git a/manifests/openshift-conformance-validated.yaml b/manifests/openshift-conformance-validated.yaml
@@ -6,7 +6,7 @@ podSpec:
       emptyDir: {}
   containers:
     - name: report-progress
-      image: "{{ .ToolsImage }}"
+      image: "{{ .PluginsImage }}"
       imagePullPolicy: Always
       priorityClassName: system-node-critical
       command: ["./report-progress.sh"]
@@ -39,7 +39,7 @@ sonobuoy-config:
   skipCleanup: true
 spec:
   name: plugin
-  image: "{{ .ToolsImage }}"
+  image: "{{ .PluginsImage }}"
   imagePullPolicy: Always
   priorityClassName: system-node-critical
   volumeMounts:

diff --git a/manifests/openshift-kube-conformance.yaml b/manifests/openshift-kube-conformance.yaml
@@ -6,7 +6,7 @@ podSpec:
       emptyDir: {}
   containers:
     - name: report-progress
-      image: "{{ .ToolsImage }}"
+      image: "{{ .PluginsImage }}"
       imagePullPolicy: Always
       priorityClassName: system-node-critical
       command: ["./report-progress.sh"]
@@ -39,7 +39,7 @@ sonobuoy-config:
   skipCleanup: true
 spec:
   name: plugin
-  image: "{{ .ToolsImage }}"
+  image: "{{ .PluginsImage }}"
   imagePullPolicy: Always
   priorityClassName: system-node-critical
   volumeMounts:

diff --git a/pkg/run/run.go b/pkg/run/run.go
@@ -40,10 +40,10 @@ type RunOptions struct {
 	dedicated       bool
 	sonobuoyImage   string
 	imageRepository string
-	// ToolsImage
+	// PluginsImage
 	// defines the image containing plugins associated with the provider-certification-tool.
-	// this variable is referenced by plugin manifest templates to dynamically reference the tools image.
-	ToolsImage   string
+	// this variable is referenced by plugin manifest templates to dynamically reference the plugins image.
+	PluginsImage string
 	timeout      int
 	watch        bool
 	devCount     string
@@ -136,15 +136,15 @@ func NewCmdRun() *cobra.Command {
 	cmd.Flags().StringVar(&o.upgradeImage, "upgrade-to-image", defaultUpgradeImage, "Target OpenShift Release Image. Example: oc adm release info 4.11.18 -o jsonpath={.image}")
 	cmd.Flags().StringArrayVar(o.plugins, "plugin", nil, "Override default conformance plugins to use. Can be used multiple times. (default plugins can be reviewed with assets subcommand)")
 	cmd.Flags().StringVar(&o.sonobuoyImage, "sonobuoy-image", fmt.Sprintf("%s/sonobuoy:%s", pkg.DefaultToolsRepository, buildinfo.Version), "Image override for the Sonobuoy worker and aggregator")
-	cmd.Flags().StringVar(&o.ToolsImage, "tools-image", pkg.PluginsImage, "Image containing plugins to be executed.")
+	cmd.Flags().StringVar(&o.PluginsImage, "plugins-image", pkg.PluginsImage, "Image containing plugins to be executed.")
 	cmd.Flags().StringVar(&o.imageRepository, "image-repository", "", "Image repository containing required images test environment. Example: openshift-provider-cert-tool --mirror-repository mirror.repository.net/ocp-cert")
 	cmd.Flags().IntVar(&o.timeout, "timeout", defaultRunTimeoutSeconds, "Execution timeout in seconds")
 	cmd.Flags().BoolVarP(&o.watch, "watch", "w", defaultRunWatchFlag, "Keep watch status after running")
 
 	// Hide dedicated flag since this is for development only
 	cmd.Flags().MarkHidden("dedicated")
 	cmd.Flags().MarkHidden("dev-count")
-	cmd.Flags().MarkHidden("tools-image")
+	cmd.Flags().MarkHidden("plugins-image")
 
 	return cmd
 }
@@ -385,7 +385,7 @@ func (r *RunOptions) Run(kclient kubernetes.Interface, sclient sonobuoyclient.In
 		log.Infof("Mirror registry is configured %s ", r.imageRepository)
 	}
 	r.sonobuoyImage = fmt.Sprintf("%s/sonobuoy:%s", imageRepository, buildinfo.Version)
-	r.ToolsImage = fmt.Sprintf("%s/%s", imageRepository, r.ToolsImage)
+	r.PluginsImage = fmt.Sprintf("%s/%s", imageRepository, r.PluginsImage)
 
 	// Let Sonobuoy do some preflight checks before we run
 	errs := sclient.PreflightChecks(&sonobuoyclient.PreflightConfig{