🔧 Improve plugin configuration by being more consistent about plugin name vs plugin field (#1211)

Author: andersjohnsen

cmd/rig-ops/cmd/migrate/plugins.go

@@ -36,12 +36,12 @@ func (c *Cmd) getPlugins(ctx context.Context, migration *Migration) error {
 			for _, plugin := range resp.Msg.Plugins {
 				switch v := plugin.GetPlugin().(type) {
 				case *capabilities.GetPluginsResponse_Plugin_Builtin:
-					if v.Builtin.GetName() == p.Name {
-						plugins = append(plugins, p.Name)
+					if v.Builtin.GetName() == p.GetPlugin() {
+						plugins = append(plugins, p.GetPlugin())
 					}
 				case *capabilities.GetPluginsResponse_Plugin_ThirdParty:
-					if v.ThirdParty.Name == p.Name {
-						plugins = append(plugins, p.Name)
+					if v.ThirdParty.Name == p.GetPlugin() {
+						plugins = append(plugins, p.GetPlugin())
 					}
 				}
 			}

cmd/rig-ops/cmd/plugins/list.go

@@ -29,12 +29,12 @@ func (c *Cmd) listSteps(ctx context.Context, _ *cobra.Command, _ []string) error
 		}
 		for _, p := range s.Plugins {
 			plugin := pluginInfo{
-				Name: p.Name,
+				Name: p.GetPlugin(),
 			}
 			if showConfig {
 				plugin.Config = map[string]any{}
 				if err := yaml.Unmarshal([]byte(p.Config), &plugin.Config); err != nil {
-					return fmt.Errorf("plugin '%s' had malformed config: %q", p.Name, err)
+					return fmt.Errorf("plugin '%s' had malformed config: %q", p.GetPlugin(), err)
 				}
 			}
 			step.Plugins = append(step.Plugins, plugin)
@@ -112,7 +112,7 @@ func (c *Cmd) get(ctx context.Context, _ *cobra.Command, args []string) error {
 		for idx, s := range cfg.Pipeline.Steps {
 			var plugins []string
 			for _, p := range s.Plugins {
-				plugins = append(plugins, p.Name)
+				plugins = append(plugins, p.GetPlugin())
 			}
 			choices = append(choices, []string{strconv.Itoa(idx), strings.Join(plugins, ", ")})
 		}
@@ -141,7 +141,7 @@ func (c *Cmd) get(ctx context.Context, _ *cobra.Command, args []string) error {
 	}
 	for _, p := range s.Plugins {
 		plugin := pluginInfo{
-			Name: p.Name,
+			Name: p.GetPlugin(),
 		}
 		if err := yaml.Unmarshal([]byte(p.Config), &plugin.Config); err != nil {
 			return fmt.Errorf("plugin had malformed config: %q", err)

deploy/charts/rig-operator/values.yaml

@@ -27,8 +27,8 @@ config:
     steps:
       []
       # - plugins:
-      #   - name: rigdev.env_mapping
-      #   - name: rigdev.object_template
+      #   - plugin: rigdev.env_mapping
+      #   - plugin: rigdev.object_template
       #     config: |
       #       group: apps
       #       kind: Deployment
@@ -40,27 +40,27 @@ config:
       #               - name: {{ .capsule.metadata.name }}
       #                 image: alpine
       #                 command: ['sh', '-c', 'echo "Hello from {{ .capsule.metadata.name }}!"']
-      #   - name: rigdev.sidecar
+      #   - plugin: rigdev.sidecar
       #     config: |
       #       container:
       #         name: foobar
       #         image: alpine
       #         command: ['sh', '-c', 'sleep 1000']
-      #   - name: rigdev.init_container
+      #   - plugin: rigdev.init_container
       #     config: |
       #       container:
       #         name: startup
       #         image: alpine
       #         command: ['sh', '-c', 'echo "Startup!"']
-      #   - name: rigdev.annotations
+      #   - plugin: rigdev.annotations
       #     config: |
       #       group: apps
       #       kind: Deployment
       #       annotations:
       #         some-annotation: some-value
       #         templated-annotation: value-{{ .capsule.spec.image }}
       #         deleted-annotation: ""
-      #   - name: rigdev.datadog
+      #   - plugin: rigdev.datadog
       #     config: |
       #       libraryTag:
       #         java: latest

docs/docs/api/config/v1alpha1.md

@@ -649,7 +649,8 @@ _Appears in:_
 | Field | Description |
 | --- | --- |
 | `tag` _string_ | Optional tag which is readable by plugin when executed |
-| `name` _string_ | Name of the plugin to run. |
+| `name` _string_ | Name of the plugin to run. Deprecated, use Plugin. |
+| `plugin` _string_ | Name of the plugin to run. |
 | `config` _string_ | Config is a string defining the plugin-specific configuration of the plugin. |
 
 

docs/docs/operator-manual/cli.mdx

@@ -52,11 +52,11 @@ Available Commands:
 **check**
 ```
 % rig-ops plugins check
-Namespace                  Capsule    StepIndex  
-myproject                  mycapsule  0          
-myproject                  mycapsule2 0          
-myproject-staging          mycapsule  0      
-myproject-staging          mycapsule  1 
+Namespace                  Capsule    StepIndex
+myproject                  mycapsule  0
+myproject                  mycapsule2 0
+myproject-staging          mycapsule  0
+myproject-staging          mycapsule  1
 ```
 
 **dry-run**
@@ -73,28 +73,28 @@ plugins:
 - config:
     annotations:
       key: value
-  name: rigdev.annotations
+  plugin: rigdev.annotations
 ```
 
 **list**
 ```
-% rig-ops plugins list                                 
-Type     Name                                
-Builtin  rigdev.annotations                  
-Builtin  rigdev.cron_jobs                    
-Builtin  rigdev.datadog                      
-Builtin  rigdev.deployment                   
-Builtin  rigdev.env_mapping                  
-Builtin  rigdev.google_cloud_sql_auth_proxy  
-Builtin  rigdev.ingress_routes               
-Builtin  rigdev.init_container               
-Builtin  rigdev.object_create                
-Builtin  rigdev.object_template              
-Builtin  rigdev.placement                    
-Builtin  rigdev.service_account              
-Builtin  rigdev.service_monitor              
-Builtin  rigdev.sidecar                      
-Builtin  rigdev.vpa  
+% rig-ops plugins list
+Type     Name
+Builtin  rigdev.annotations
+Builtin  rigdev.cron_jobs
+Builtin  rigdev.datadog
+Builtin  rigdev.deployment
+Builtin  rigdev.env_mapping
+Builtin  rigdev.google_cloud_sql_auth_proxy
+Builtin  rigdev.ingress_routes
+Builtin  rigdev.init_container
+Builtin  rigdev.object_create
+Builtin  rigdev.object_template
+Builtin  rigdev.placement
+Builtin  rigdev.service_account
+Builtin  rigdev.service_monitor
+Builtin  rigdev.sidecar
+Builtin  rigdev.vpa
 ```
 
 ### Migrate

docs/docs/operator-manual/plugins/builtin/annotations.mdx

@@ -4,29 +4,34 @@ The annotations plugin can insert annotations and labels into a given object.
 If any of the given annotations or labels are already present in the object, they will be overwritten.
 
 The config can be templated with standard Go templating and has
+
 ```
 .capsule
 ```
+
 as its templating context.
 
 ## Example
+
 Config:
+
 ```yaml title="Helm values - Operator"
 config:
   pipeline:
     steps:
       - plugins:
-        - name: rigdev.annotations
-          config: |
-            annotations:
-              key1: value1
-            labels:
-              key2: value2
-            group: apps
-            kind: Deployment
+          - plugin: rigdev.annotations
+            config: |
+              annotations:
+                key1: value1
+              labels:
+                key2: value2
+              group: apps
+              kind: Deployment
 ```
 
 If the name of the capsule in the request context is `my-capsule` with corresponding `Deployment`
+
 ```
 apiVersion: apps/v1
 kind: Deployment
@@ -38,7 +43,9 @@ metadata:
     label: value
   ....
 ```
+
 The resulting config of the `Deployment` is
+
 ```
 apiVersion: apps/v1
 kind: Deployment
@@ -51,6 +58,7 @@ metadata:
     key2: value2
   ....
 ```
+
 ## Config
 
 

docs/docs/operator-manual/plugins/builtin/datadog.mdx

@@ -3,29 +3,34 @@
 The `rigdev.datadog` plugin adds Datadog specific tags to the Deployment and Pods of the capsule as requested [here](https://docs.datadoghq.com/tracing/trace_collection/library_injection_local/?tab=kubernetes). It can enable/disable the execution of the [Datadog Admission Controller](https://docs.datadoghq.com/containers/cluster_agent/admission_controller/?tab=operator) on the pods and sets the necessary library and unified service tags.
 
 The config can be templated with standard Go templating and has
+
 ```
 .capsule
 ```
+
 as its templating context.
 
 ## Example
+
 Config:
+
 ```yaml title="Helm values - Operator"
 config:
   pipeline:
     steps:
       - plugins:
-        - name: rigdev.datadog
-          config: |
-            libraryTag:
-              java: v1.31.0
-            unifiedServiceTags:
-              env: my-env
-              service: my-service
-              versin: my-version
+          - plugin: rigdev.datadog
+            config: |
+              libraryTag:
+                java: v1.31.0
+              unifiedServiceTags:
+                env: my-env
+                service: my-service
+                versin: my-version
 ```
 
 The resulting `Deployment` resource of the Capsule
+
 ```
 kind: Deployment
 metadata:
@@ -45,6 +50,7 @@ spec:
 				admission.datadoghq.com/java-lib.version: v1.31.0,
    ...
 ```
+
 ## Config
 
 

docs/docs/operator-manual/plugins/builtin/google_cloud_sql_auth_proxy.mdx

@@ -4,37 +4,43 @@ The `rigdev.google_cloud_sql_auth_proxy` plugins injects a Google Cloud SQL auth
 It will append a container named `google-cloud-sql-proxy` running the `gcr.io/cloud-sql-connectors/cloud-sql-proxy` image to your deployment and set its arguments, environment variables and config files according the the configuration of this plugin.
 
 The config can be templated with standard Go templating and has
+
 ```
 .capsule
 ```
+
 as its templating context.
 
 ## Example
+
 Config:
+
 ```yaml title="Helm value - Operator"
 config:
   pipeline:
     steps:
       - plugins:
-        - name: rigdev.google_cloud_sql_auth_proxy
-          config: |
-            tag: 2.9  
-            args
-              - arg1
-              - arg2
-            envFromSource:
-              - kind: ConfigMap
-                name: my-configmap
-            envVars:
-              name: MY_ENV_VAR
-              value: some-value
-            resources:
-              cpu: 0.1
-              memory: 128M
-            instanceConnectionNames:
-              - instance-name
+          - plugin: rigdev.google_cloud_sql_auth_proxy
+            config: |
+              tag: 2.9
+              args
+                - arg1
+                - arg2
+              envFromSource:
+                - kind: ConfigMap
+                  name: my-configmap
+              envVars:
+                name: MY_ENV_VAR
+                value: some-value
+              resources:
+                cpu: 0.1
+                memory: 128M
+              instanceConnectionNames:
+                - instance-name
 ```
+
 Resulting Deployment
+
 ```
 kind: Deployment
 spec:
@@ -57,6 +63,7 @@ spec:
         runAsNonRoot: true
       restartPolicy: Always
 ```
+
 ## Config
 
 

docs/docs/operator-manual/plugins/builtin/init_container.mdx

@@ -3,25 +3,31 @@
 The `rigdev.init_container` plugin adds an init container to the Capsule's deployment.
 
 The config can be templated with standard Go templating and has
+
 ```
 .capsule
 ```
+
 as its templating context.
 
 ## Example
+
 Config:
+
 ```yaml title="Helm values - Operator"
 config:
   pipeline:
     steps:
       - plugins:
-        - name: rigdev.init_container
-          config: |
-            container:
-              name: my-initcontainer
-              image: my-container-image:v1.1
+          - plugin: rigdev.init_container
+            config: |
+              container:
+                name: my-initcontainer
+                image: my-container-image:v1.1
 ```
+
 The resulting Deployment resource of the Capsule
+
 ```
 kind: Deployment
 ...
@@ -33,6 +39,7 @@ spec:
           image: my-container-image:v1.1
       ...
 ```
+
 ## Config