Make gateway and sensor controllers backward compatible with deprecat…

…ed specs (#633)
argoproj · May 1, 2020 · 5f2734b · 5f2734b
1 parent fb46335
commit 5f2734b
Show file tree

Hide file tree

Showing 15 changed files with 290 additions and 11 deletions.
diff --git a/api/event-source.html b/api/event-source.html
@@ -2649,5 +2649,5 @@ <h3 id="argoproj.io/v1alpha1.TLSConfig">TLSConfig
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>5172d79</code>.
+on git commit <code>fb46335</code>.
 </em></p>
diff --git a/api/event-source.md b/api/event-source.md
@@ -5236,6 +5236,6 @@ ClientKeyPath refers the file path that contains client key.
 <p>
 
 <em> Generated with <code>gen-crd-api-reference-docs</code> on git
-commit <code>5172d79</code>. </em>
+commit <code>fb46335</code>. </em>
 
 </p>
diff --git a/api/gateway.html b/api/gateway.html
@@ -630,6 +630,24 @@ <h3 id="argoproj.io/v1alpha1.Service">Service
 <p>The list of ports that are exposed by this service.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>spec</code></br>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#servicespec-v1-core">
+Kubernetes core/v1.ServiceSpec
+</a>
+</em>
+</td>
+<td>
+<p>Spec holds the gateway service spec.
+DEPRECATED: Use Ports to declare the ports to be exposed.</p>
+<br/>
+<br/>
+<table>
+</table>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="argoproj.io/v1alpha1.Subscribers">Subscribers
@@ -749,10 +767,28 @@ <h3 id="argoproj.io/v1alpha1.Template">Template
 Optional: Defaults to empty.  See type description for default values of each field.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>spec</code></br>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#podspec-v1-core">
+Kubernetes core/v1.PodSpec
+</a>
+</em>
+</td>
+<td>
+<p>Spec holds the gateway deployment spec.
+DEPRECATED: Use Container instead.</p>
+<br/>
+<br/>
+<table>
+</table>
+</td>
+</tr>
 </tbody>
 </table>
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>5172d79</code>.
+on git commit <code>fb46335</code>.
 </em></p>
diff --git a/api/gateway.md b/api/gateway.md
@@ -1250,6 +1250,35 @@ The list of ports that are exposed by this service.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>spec</code></br> <em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#servicespec-v1-core">
+Kubernetes core/v1.ServiceSpec </a> </em>
+
+</td>
+
+<td>
+
+<p>
+
+Spec holds the gateway service spec. DEPRECATED: Use Ports to declare
+the ports to be exposed.
+
+</p>
+
+<br/> <br/>
+
+<table>
+
+</table>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>
@@ -1491,6 +1520,35 @@ values of each field.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>spec</code></br> <em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#podspec-v1-core">
+Kubernetes core/v1.PodSpec </a> </em>
+
+</td>
+
+<td>
+
+<p>
+
+Spec holds the gateway deployment spec. DEPRECATED: Use Container
+instead.
+
+</p>
+
+<br/> <br/>
+
+<table>
+
+</table>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>
@@ -1500,6 +1558,6 @@ values of each field.
 <p>
 
 <em> Generated with <code>gen-crd-api-reference-docs</code> on git
-commit <code>5172d79</code>. </em>
+commit <code>fb46335</code>. </em>
 
 </p>
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -912,6 +912,10 @@
           "x-kubernetes-list-type": "map",
           "x-kubernetes-patch-merge-key": "port",
           "x-kubernetes-patch-strategy": "merge"
+        },
+        "spec": {
+          "description": "Spec holds the gateway service spec. DEPRECATED: Use Ports to declare the ports to be exposed.",
+          "$ref": "#/definitions/io.k8s.api.core.v1.ServiceSpec"
         }
       }
     },
@@ -952,6 +956,10 @@
           "description": "ServiceAccountName is the name of the ServiceAccount to use to run gateway pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
           "type": "string"
         },
+        "spec": {
+          "description": "Spec holds the gateway deployment spec. DEPRECATED: Use Container instead.",
+          "$ref": "#/definitions/io.k8s.api.core.v1.PodSpec"
+        },
         "volumes": {
           "description": "Volumes is a list of volumes that can be mounted by containers in a workflow.",
           "type": "array",
@@ -2090,6 +2098,10 @@
           "description": "ServiceAccountName is the name of the ServiceAccount to use to run gateway pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/",
           "type": "string"
         },
+        "spec": {
+          "description": "Spec holds the sensor deployment spec. DEPRECATED: Use Container instead.",
+          "$ref": "#/definitions/io.k8s.api.core.v1.PodSpec"
+        },
         "volumes": {
           "description": "Volumes is a list of volumes that can be mounted by containers in a workflow.",
           "type": "array",

diff --git a/api/sensor.html b/api/sensor.html
@@ -2855,6 +2855,24 @@ <h3 id="argoproj.io/v1alpha1.Template">Template
 Optional: Defaults to empty.  See type description for default values of each field.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>spec</code></br>
+<em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#podspec-v1-core">
+Kubernetes core/v1.PodSpec
+</a>
+</em>
+</td>
+<td>
+<p>Spec holds the sensor deployment spec.
+DEPRECATED: Use Container instead.</p>
+<br/>
+<br/>
+<table>
+</table>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="argoproj.io/v1alpha1.TimeFilter">TimeFilter
@@ -3450,5 +3468,5 @@ <h3 id="argoproj.io/v1alpha1.URLArtifact">URLArtifact
 <hr/>
 <p><em>
 Generated with <code>gen-crd-api-reference-docs</code>
-on git commit <code>5172d79</code>.
+on git commit <code>fb46335</code>.
 </em></p>
diff --git a/api/sensor.md b/api/sensor.md
@@ -5665,6 +5665,35 @@ values of each field.
 
 </tr>
 
+<tr>
+
+<td>
+
+<code>spec</code></br> <em>
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.13/#podspec-v1-core">
+Kubernetes core/v1.PodSpec </a> </em>
+
+</td>
+
+<td>
+
+<p>
+
+Spec holds the sensor deployment spec. DEPRECATED: Use Container
+instead.
+
+</p>
+
+<br/> <br/>
+
+<table>
+
+</table>
+
+</td>
+
+</tr>
+
 </tbody>
 
 </table>
@@ -6855,6 +6884,6 @@ VerifyCert decides whether the connection is secure or not
 <p>
 
 <em> Generated with <code>gen-crd-api-reference-docs</code> on git
-commit <code>5172d79</code>. </em>
+commit <code>fb46335</code>. </em>
 
 </p>
diff --git a/controllers/gateway/resource.go b/controllers/gateway/resource.go
@@ -34,7 +34,15 @@ import (
 
 // buildServiceResource builds a new service that exposes gateway.
 func (ctx *gatewayContext) buildServiceResource() (*corev1.Service, error) {
-	if ctx.gateway.Spec.Service == nil || len(ctx.gateway.Spec.Service.Ports) == 0 {
+	if ctx.gateway.Spec.Service == nil {
+		return nil, nil
+	}
+	if ctx.gateway.Spec.Service.Spec != nil {
+		// Deprecated spec, will be unsupported soon.
+		ctx.logger.WithField("name", ctx.gateway.Name).WithField("namespace", ctx.gateway.Namespace).Warn("spec.service.spec is DEPRECATED, it will be unsupported soon, please use spec.service.ports")
+		return ctx.buildLegacyServiceResource()
+	}
+	if len(ctx.gateway.Spec.Service.Ports) == 0 {
 		return nil, nil
 	}
 	labels := map[string]string{
@@ -57,7 +65,32 @@ func (ctx *gatewayContext) buildServiceResource() (*corev1.Service, error) {
 	return svc, nil
 }
 
+// buildLegacyServiceResource is deprecated, will be unsupported soon.
+func (ctx *gatewayContext) buildLegacyServiceResource() (*corev1.Service, error) {
+	labels := map[string]string{
+		common.LabelObjectName:  ctx.gateway.Name,
+		common.LabelGatewayName: ctx.gateway.Name,
+	}
+	svc := &corev1.Service{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: fmt.Sprintf("%s-gateway-svc", ctx.gateway.Name),
+		},
+		Spec: *ctx.gateway.Spec.Service.Spec,
+	}
+	svc.Spec.Selector = labels
+	if err := controllerscommon.SetObjectMeta(ctx.gateway, svc, v1alpha1.SchemaGroupVersionKind); err != nil {
+		return nil, err
+	}
+	return svc, nil
+}
+
 func (ctx *gatewayContext) makeDeploymentSpec() (*appv1.DeploymentSpec, error) {
+	// Deprecated spec, will be unsupported soon.
+	if ctx.gateway.Spec.Template.Spec != nil {
+		ctx.logger.WithField("name", ctx.gateway.Name).WithField("namespace", ctx.gateway.Namespace).Warn("spec.template.spec is DEPRECATED, it will be unsupported soon, please use spec.template.container")
+		return ctx.makeLegacyDeploymentSpec()
+	}
+
 	replicas := int32(ctx.gateway.Spec.Replica)
 	if replicas == 0 {
 		replicas = 1
@@ -100,7 +133,7 @@ func (ctx *gatewayContext) makeDeploymentSpec() (*appv1.DeploymentSpec, error) {
 						ImagePullPolicy: corev1.PullAlways,
 						Resources: corev1.ResourceRequirements{
 							Requests: corev1.ResourceList{
-								corev1.ResourceCPU:    apiresource.MustParse("50m"),
+								corev1.ResourceCPU:    apiresource.MustParse("10m"),
 								corev1.ResourceMemory: apiresource.MustParse("64Mi"),
 							},
 							Limits: corev1.ResourceList{
@@ -118,6 +151,31 @@ func (ctx *gatewayContext) makeDeploymentSpec() (*appv1.DeploymentSpec, error) {
 	}, nil
 }
 
+// makeLegacyDeploymentSpec is deprecated, will be unsupported soon.
+func (ctx *gatewayContext) makeLegacyDeploymentSpec() (*appv1.DeploymentSpec, error) {
+	replicas := int32(ctx.gateway.Spec.Replica)
+	if replicas == 0 {
+		replicas = 1
+	}
+	labels := map[string]string{
+		common.LabelGatewayName: ctx.gateway.Name,
+		common.LabelObjectName:  ctx.gateway.Name,
+	}
+
+	return &appv1.DeploymentSpec{
+		Selector: &metav1.LabelSelector{
+			MatchLabels: labels,
+		},
+		Replicas: &replicas,
+		Template: corev1.PodTemplateSpec{
+			ObjectMeta: metav1.ObjectMeta{
+				Labels: labels,
+			},
+			Spec: *ctx.gateway.Spec.Template.Spec,
+		},
+	}, nil
+}
+
 // buildDeploymentResource builds a deployment resource for the gateway
 func (ctx *gatewayContext) buildDeploymentResource() (*appv1.Deployment, error) {
 	deploymentSpec, err := ctx.makeDeploymentSpec()

diff --git a/controllers/sensor/resource.go b/controllers/sensor/resource.go
@@ -80,6 +80,12 @@ func (ctx *sensorContext) serviceBuilder() (*corev1.Service, error) {
 }
 
 func (ctx *sensorContext) makeDeploymentSpec() appv1.DeploymentSpec {
+	// Deprecated spec, will be unsupported soon.
+	if ctx.sensor.Spec.Template.Spec != nil {
+		ctx.logger.WithField("name", ctx.sensor.Name).WithField("namespace", ctx.sensor.Namespace).Warn("spec.template.spec is DEPRECATED, it will be unsupported soon, please use spec.template.container")
+		return ctx.makeLegacyDeploymentSpec()
+	}
+
 	replicas := int32(1)
 	labels := map[string]string{
 		common.LabelObjectName: ctx.sensor.Name,
@@ -113,6 +119,26 @@ func (ctx *sensorContext) makeDeploymentSpec() appv1.DeploymentSpec {
 	}
 }
 
+// makeLegacyDeploymentSpec is deprecated, will be unsupported soon.
+func (ctx *sensorContext) makeLegacyDeploymentSpec() appv1.DeploymentSpec {
+	replicas := int32(1)
+	labels := map[string]string{
+		common.LabelObjectName: ctx.sensor.Name,
+	}
+	return appv1.DeploymentSpec{
+		Selector: &metav1.LabelSelector{
+			MatchLabels: labels,
+		},
+		Replicas: &replicas,
+		Template: corev1.PodTemplateSpec{
+			ObjectMeta: metav1.ObjectMeta{
+				Labels: labels,
+			},
+			Spec: *ctx.sensor.Spec.Template.Spec,
+		},
+	}
+}
+
 // deploymentBuilder builds the deployment specification for the sensor
 func (ctx *sensorContext) deploymentBuilder() (*appv1.Deployment, error) {
 	deploymentSpec := ctx.makeDeploymentSpec()