astefanutti commented on a change in pull request #2771: URL: https://github.com/apache/camel-k/pull/2771#discussion_r777994177
########## File path: pkg/util/kubernetes/factory.go ########## @@ -32,6 +33,12 @@ var ( validResourceRequirementsRegexp = regexp.MustCompile(`^(requests|limits)\.(memory|cpu)=([\w\.]+)$`) ) +// ConfigMapAutogenLabel -- +const ConfigMapAutogenLabel = "camel.apache.org/autogenerated" Review comment: May I suggest `camel.apache.org/generated` instead? ########## File path: pkg/trait/mount.go ########## @@ -0,0 +1,193 @@ +/* +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package trait + +import ( + "fmt" + "strings" + + appsv1 "k8s.io/api/apps/v1" + "k8s.io/api/batch/v1beta1" + corev1 "k8s.io/api/core/v1" + + serving "knative.dev/serving/pkg/apis/serving/v1" + + v1 "github.com/apache/camel-k/pkg/apis/camel/v1" + "github.com/apache/camel-k/pkg/util/kubernetes" + utilResource "github.com/apache/camel-k/pkg/util/resource" +) + +// The Mount trait can be used to configure volumes mounted on the Integration Pods. +// +// +camel-k:trait=mount +// nolint: tagliatelle +type mountTrait struct { + BaseTrait `property:",squash"` + // A list of configuration (only text content) pointing to configmap/secret. Syntax: [configmap|secret]:name[key], where name represents the resource name and key optionally represents the resource key to be filtered + Configs []string `property:"configs" json:"configs,omitempty"` + // A list of resources (text or binary content) pointing to configmap/secret. Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path + Resources []string `property:"resources" json:"resources,omitempty"` + // A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path] + Volumes []string `property:"volumes" json:"volumes,omitempty"` +} + +func newMountTrait() Trait { + return &mountTrait{ + // Must follow immediately the container trait + BaseTrait: NewBaseTrait("mount", 1610), + } +} + +func (t *mountTrait) Configure(e *Environment) (bool, error) { + if IsFalse(t.Enabled) { + return false, nil + } + + if e.IntegrationInPhase(v1.IntegrationPhaseInitialization) { + return false, nil + } + + // Validate resources and pvcs + for _, c := range t.Configs { + if !strings.HasPrefix(c, "configmap:") && !strings.HasPrefix(c, "secret:") { + return false, fmt.Errorf("unsupported config %s, must be a configmap or secret resource", c) + } + } + for _, r := range t.Resources { + if !strings.HasPrefix(r, "configmap:") && !strings.HasPrefix(r, "secret:") { + return false, fmt.Errorf("unsupported resource %s, must be a configmap or secret resource", r) + } + } + + return true, nil +} + +func (t *mountTrait) Apply(e *Environment) error { + if e.IntegrationInPhase(v1.IntegrationPhaseInitialization) { + return nil + } + + container := e.GetIntegrationContainer() + if container == nil { + return fmt.Errorf("unable to find integration container: %s", e.Integration.Name) + } + + var volumes *[]corev1.Volume + visited := false + + // Deployment + if err := e.Resources.VisitDeploymentE(func(deployment *appsv1.Deployment) error { + volumes = &deployment.Spec.Template.Spec.Volumes + visited = true + return nil + }); err != nil { + return err + } + + // Knative Service + if err := e.Resources.VisitKnativeServiceE(func(service *serving.Service) error { + volumes = &service.Spec.ConfigurationSpec.Template.Spec.Volumes + visited = true + return nil + }); err != nil { + return err + } + + // CronJob + if err := e.Resources.VisitCronJobE(func(cron *v1beta1.CronJob) error { + volumes = &cron.Spec.JobTemplate.Spec.Template.Spec.Volumes + visited = true + return nil + }); err != nil { + return err + } + + if visited { + // Volumes declared in the Integration resources + e.configureVolumesAndMounts(volumes, &container.VolumeMounts) + // Volumes declared in the trait config/resource options + err := t.configureVolumesAndMounts(e, volumes, &container.VolumeMounts) + if err != nil { + return err + } + } + + return nil +} + +func (t *mountTrait) configureVolumesAndMounts(e *Environment, vols *[]corev1.Volume, mnts *[]corev1.VolumeMount) error { + for _, c := range t.Configs { + if conf, parseErr := utilResource.ParseConfig(c); parseErr == nil { + t.attachResource(e, conf) + t.mountResource(vols, mnts, conf) + } else { + return parseErr + } + } + for _, r := range t.Resources { + if res, parseErr := utilResource.ParseResource(r); parseErr == nil { + t.attachResource(e, res) + t.mountResource(vols, mnts, res) + } else { + return parseErr + } + } + for _, v := range t.Volumes { + if vol, parseErr := utilResource.ParseVolume(v); parseErr == nil { + t.mountResource(vols, mnts, vol) + } else { + return parseErr + } + } + + return nil +} + +// attachResource is in charge to filter the autogenerated configmap and attach to the Integration resources. +// The owner trait will be in charge to bind it accordingly. +func (t *mountTrait) attachResource(e *Environment, conf *utilResource.Config) { + if conf.StorageType() == utilResource.StorageTypeConfigmap { + // verify if it was autogenerated + cm := kubernetes.LookupConfigmap(e.Ctx, e.Client, e.Integration.Namespace, conf.Name()) + if cm != nil && cm.ObjectMeta.Labels[kubernetes.ConfigMapAutogenLabel] == "true" { + // we must remove the managed fields as owner trait later will complain otherwise + cm.ManagedFields = nil Review comment: I'd suggest to try adding an empty ConfigMap object with the same namespace and name instead. That way we make sure the original ConfigMap is left untouched, the other traits like the _owner_ one, add their bits, then the _deployer_ trait relies on server-side apply to merge everything. It should avoid that `cm.ManagedFields = nil`. ########## File path: pkg/trait/mount.go ########## @@ -0,0 +1,177 @@ +/* +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package trait + +import ( + "fmt" + "strings" + + appsv1 "k8s.io/api/apps/v1" + "k8s.io/api/batch/v1beta1" + corev1 "k8s.io/api/core/v1" + + serving "knative.dev/serving/pkg/apis/serving/v1" + + v1 "github.com/apache/camel-k/pkg/apis/camel/v1" + "github.com/apache/camel-k/pkg/util/kubernetes" + utilResource "github.com/apache/camel-k/pkg/util/resource" +) + +// The Mount trait can be used to configure volumes mounted on the Integration Pod. +// +// +camel-k:trait=mount +// nolint: tagliatelle +type mountTrait struct { + BaseTrait `property:",squash"` + // A list of configuration pointing to configmap/secret. Syntax: [configmap|secret]:name[key], where name represents the resource name and key optionally represents the resource key to be filtered + Configs []string `property:"configs" json:"configs,omitempty"` Review comment: The comment now documents what kind of content can be provided. I could still imagine an external user asking what's the difference between configs and resources functionally. May I suggest to add that configs are added to the classpath, and that they are typically used to configuration Camel. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@camel.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org