/* Copyright 2017 The Kubernetes Authors All rights reserved. Licensed 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 kubernetes import ( "encoding/base64" "fmt" "os" "path" "path/filepath" "reflect" "regexp" "sort" "strconv" "strings" "github.com/compose-spec/compose-go/types" "github.com/fatih/structs" "github.com/kubernetes/kompose/pkg/kobject" "github.com/kubernetes/kompose/pkg/loader/compose" "github.com/kubernetes/kompose/pkg/transformer" deployapi "github.com/openshift/api/apps/v1" buildapi "github.com/openshift/api/build/v1" "github.com/pkg/errors" log "github.com/sirupsen/logrus" "github.com/spf13/cast" "golang.org/x/tools/godoc/util" appsv1 "k8s.io/api/apps/v1" api "k8s.io/api/core/v1" networkingv1 "k8s.io/api/networking/v1" "k8s.io/apimachinery/pkg/api/resource" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/util/intstr" ) // Kubernetes implements Transformer interface and represents Kubernetes transformer type Kubernetes struct { // the user provided options from the command line Opt kobject.ConvertOptions } // PVCRequestSize (Persistent Volume Claim) has default size const PVCRequestSize = "100Mi" // ValidVolumeSet has the different types of valid volumes var ValidVolumeSet = map[string]struct{}{"emptyDir": {}, "hostPath": {}, "configMap": {}, "persistentVolumeClaim": {}} const ( // DeploymentController is controller type for Deployment DeploymentController = "deployment" // DaemonSetController is controller type for DaemonSet DaemonSetController = "daemonset" // StatefulStateController is controller type for StatefulSet StatefulStateController = "statefulset" ) // CheckUnsupportedKey checks if given komposeObject contains // keys that are not supported by this transformer. // list of all unsupported keys are stored in unsupportedKey variable // returns list of TODO: .... func (k *Kubernetes) CheckUnsupportedKey(komposeObject *kobject.KomposeObject, unsupportedKey map[string]bool) []string { // collect all keys found in project var keysFound []string for _, serviceConfig := range komposeObject.ServiceConfigs { // this reflection is used in check for empty arrays val := reflect.ValueOf(serviceConfig) s := structs.New(serviceConfig) for _, f := range s.Fields() { // Check if given key is among unsupported keys, and skip it if we already saw this key if alreadySaw, ok := unsupportedKey[f.Name()]; ok && !alreadySaw { if f.IsExported() && !f.IsZero() { // IsZero returns false for empty array/slice ([]) // this check if field is Slice, and then it checks its size if field := val.FieldByName(f.Name()); field.Kind() == reflect.Slice { if field.Len() == 0 { // array is empty it doesn't matter if it is in unsupportedKey or not continue } } //get tag from kobject service configure tag := f.Tag(komposeObject.LoadedFrom) keysFound = append(keysFound, tag) unsupportedKey[f.Name()] = true } } } } return keysFound } // InitPodSpec creates the pod specification func (k *Kubernetes) InitPodSpec(name string, image string, pullSecret string) api.PodSpec { if image == "" { image = name } pod := api.PodSpec{ Containers: []api.Container{ { Name: name, Image: image, }, }, } if pullSecret != "" { pod.ImagePullSecrets = []api.LocalObjectReference{ { Name: pullSecret, }, } } return pod } // InitPodSpecWithConfigMap creates the pod specification func (k *Kubernetes) InitPodSpecWithConfigMap(name string, image string, service kobject.ServiceConfig) api.PodSpec { var volumeMounts []api.VolumeMount var volumes []api.Volume for _, value := range service.Configs { cmVolName := FormatFileName(value.Source) target := value.Target if target == "" { // short syntax, = / target = "/" + value.Source } subPath := filepath.Base(target) volSource := api.ConfigMapVolumeSource{} volSource.Name = cmVolName key, err := service.GetConfigMapKeyFromMeta(value.Source) if err != nil { log.Warnf("cannot parse config %s , %s", value.Source, err.Error()) // mostly it's external continue } volSource.Items = []api.KeyToPath{{ Key: key, Path: subPath, }} if value.Mode != nil { tmpMode := int32(*value.Mode) volSource.DefaultMode = &tmpMode } cmVol := api.Volume{ Name: cmVolName, VolumeSource: api.VolumeSource{ConfigMap: &volSource}, } volumeMounts = append(volumeMounts, api.VolumeMount{ Name: cmVolName, MountPath: target, SubPath: subPath, }) volumes = append(volumes, cmVol) } pod := api.PodSpec{ Containers: []api.Container{ { Name: name, Image: image, VolumeMounts: volumeMounts, }, }, Volumes: volumes, } if service.ImagePullSecret != "" { pod.ImagePullSecrets = []api.LocalObjectReference{ { Name: service.ImagePullSecret, }, } } return pod } // InitSvc initializes Kubernetes Service object // The created service name will = ServiceConfig.Name, but the selector may be not. // If this service is grouped, the selector may be another name = name func (k *Kubernetes) InitSvc(name string, service kobject.ServiceConfig) *api.Service { svc := &api.Service{ TypeMeta: metav1.TypeMeta{ Kind: "Service", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: service.Name, Labels: transformer.ConfigLabels(name), }, // The selector uses the service.Name, which must be consistent with workloads label Spec: api.ServiceSpec{ Selector: transformer.ConfigLabels(name), }, } return svc } // InitConfigMapForEnv initializes a ConfigMap object func (k *Kubernetes) InitConfigMapForEnv(name string, opt kobject.ConvertOptions, envFile string) *api.ConfigMap { envs, err := GetEnvsFromFile(envFile, opt) if err != nil { log.Fatalf("Unable to retrieve env file: %s", err) } // Remove root pathing // replace all other slashes / periods envName := FormatEnvName(envFile) // In order to differentiate files, we append to the name and remove '.env' if applicable from the file name configMap := &api.ConfigMap{ TypeMeta: metav1.TypeMeta{ Kind: "ConfigMap", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: envName, Labels: transformer.ConfigLabels(name + "-" + envName), }, Data: envs, } return configMap } // IntiConfigMapFromFileOrDir will create a configmap from dir or file // usage: // 1. volume func (k *Kubernetes) IntiConfigMapFromFileOrDir(name, cmName, filePath string, service kobject.ServiceConfig) (*api.ConfigMap, error) { configMap := &api.ConfigMap{ TypeMeta: metav1.TypeMeta{ Kind: "ConfigMap", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: cmName, Labels: transformer.ConfigLabels(name), }, } dataMap := make(map[string]string) fi, err := os.Stat(filePath) if err != nil { return nil, err } switch mode := fi.Mode(); { case mode.IsDir(): files, err := os.ReadDir(filePath) if err != nil { return nil, err } for _, file := range files { if !file.IsDir() { log.Debugf("Read file to ConfigMap: %s", file.Name()) data, err := GetContentFromFile(filePath + "/" + file.Name()) if err != nil { return nil, err } dataMap[file.Name()] = data } } initConfigMapData(configMap, dataMap) case mode.IsRegular(): // do file stuff configMap = k.InitConfigMapFromFile(name, service, filePath) configMap.Name = cmName configMap.Annotations = map[string]string{ "use-subpath": "true", } } return configMap, nil } // useSubPathMount check if a configmap should be mounted as subpath // in this situation, this configmap will only contains 1 key in data func useSubPathMount(cm *api.ConfigMap) bool { if cm.Annotations == nil { return false } if cm.Annotations["use-subpath"] != "true" { return false } return true } func initConfigMapData(configMap *api.ConfigMap, data map[string]string) { stringData := map[string]string{} binData := map[string][]byte{} for k, v := range data { isText := util.IsText([]byte(v)) if isText { stringData[k] = v } else { binData[k] = []byte(base64.StdEncoding.EncodeToString([]byte(v))) } } configMap.Data = stringData configMap.BinaryData = binData } // InitConfigMapFromFile initializes a ConfigMap object func (k *Kubernetes) InitConfigMapFromFile(name string, service kobject.ServiceConfig, fileName string) *api.ConfigMap { content, err := GetContentFromFile(fileName) if err != nil { log.Fatalf("Unable to retrieve file: %s", err) } configMapName := "" for key, tmpConfig := range service.ConfigsMetaData { if tmpConfig.File == fileName { configMapName = key } } configMap := &api.ConfigMap{ TypeMeta: metav1.TypeMeta{ Kind: "ConfigMap", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: FormatFileName(configMapName), Labels: transformer.ConfigLabels(name), }, } data := map[string]string{filepath.Base(fileName): content} initConfigMapData(configMap, data) return configMap } // InitD initializes Kubernetes Deployment object func (k *Kubernetes) InitD(name string, service kobject.ServiceConfig, replicas int) *appsv1.Deployment { var podSpec api.PodSpec if len(service.Configs) > 0 { podSpec = k.InitPodSpecWithConfigMap(name, service.Image, service) } else { podSpec = k.InitPodSpec(name, service.Image, service.ImagePullSecret) } rp := int32(replicas) dc := &appsv1.Deployment{ TypeMeta: metav1.TypeMeta{ Kind: "Deployment", APIVersion: "apps/v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Labels: transformer.ConfigAllLabels(name, &service), }, Spec: appsv1.DeploymentSpec{ Replicas: &rp, Selector: &metav1.LabelSelector{ MatchLabels: transformer.ConfigLabels(name), }, Template: api.PodTemplateSpec{ ObjectMeta: metav1.ObjectMeta{ //Labels: transformer.ConfigLabels(name), Annotations: transformer.ConfigAnnotations(service), }, Spec: podSpec, }, }, } dc.Spec.Template.Labels = transformer.ConfigLabels(name) update := service.GetKubernetesUpdateStrategy() if update != nil { dc.Spec.Strategy = appsv1.DeploymentStrategy{ Type: appsv1.RollingUpdateDeploymentStrategyType, RollingUpdate: update, } ms := "" if update.MaxSurge != nil { ms = update.MaxSurge.String() } mu := "" if update.MaxUnavailable != nil { mu = update.MaxUnavailable.String() } log.Debugf("Set deployment '%s' rolling update: MaxSurge: %s, MaxUnavailable: %s", name, ms, mu) } return dc } // InitDS initializes Kubernetes DaemonSet object func (k *Kubernetes) InitDS(name string, service kobject.ServiceConfig) *appsv1.DaemonSet { ds := &appsv1.DaemonSet{ TypeMeta: metav1.TypeMeta{ Kind: "DaemonSet", APIVersion: "apps/v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Labels: transformer.ConfigAllLabels(name, &service), }, Spec: appsv1.DaemonSetSpec{ Selector: &metav1.LabelSelector{ MatchLabels: transformer.ConfigLabels(name), }, Template: api.PodTemplateSpec{ Spec: k.InitPodSpec(name, service.Image, service.ImagePullSecret), }, }, } return ds } // InitSS method initialize a stateful set func (k *Kubernetes) InitSS(name string, service kobject.ServiceConfig, replicas int) *appsv1.StatefulSet { var podSpec api.PodSpec if len(service.Configs) > 0 { podSpec = k.InitPodSpecWithConfigMap(name, service.Image, service) } else { podSpec = k.InitPodSpec(name, service.Image, service.ImagePullSecret) } rp := int32(replicas) ds := &appsv1.StatefulSet{ TypeMeta: metav1.TypeMeta{ Kind: "StatefulSet", APIVersion: "apps/v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Labels: transformer.ConfigAllLabels(name, &service), }, Spec: appsv1.StatefulSetSpec{ Replicas: &rp, Template: api.PodTemplateSpec{ Spec: podSpec, }, Selector: &metav1.LabelSelector{ MatchLabels: transformer.ConfigLabels(name), }, ServiceName: service.Name, }, } return ds } func (k *Kubernetes) initIngress(name string, service kobject.ServiceConfig, port int32) *networkingv1.Ingress { hosts := regexp.MustCompile("[ ,]*,[ ,]*").Split(service.ExposeService, -1) ingress := &networkingv1.Ingress{ TypeMeta: metav1.TypeMeta{ Kind: "Ingress", APIVersion: "networking.k8s.io/v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Labels: transformer.ConfigLabels(name), Annotations: transformer.ConfigAnnotations(service), }, Spec: networkingv1.IngressSpec{ Rules: make([]networkingv1.IngressRule, len(hosts)), }, } tlsHosts := make([]string, len(hosts)) pathType := networkingv1.PathTypePrefix for i, host := range hosts { host, p := transformer.ParseIngressPath(host) if p == "" { p = "/" } ingress.Spec.Rules[i] = networkingv1.IngressRule{ IngressRuleValue: networkingv1.IngressRuleValue{ HTTP: &networkingv1.HTTPIngressRuleValue{ Paths: []networkingv1.HTTPIngressPath{ { Path: p, PathType: &pathType, Backend: networkingv1.IngressBackend{ Service: &networkingv1.IngressServiceBackend{ Name: name, Port: networkingv1.ServiceBackendPort{ Number: port, }, }, }, }, }, }, }, } if host != "true" { ingress.Spec.Rules[i].Host = host tlsHosts[i] = host } } if service.ExposeServiceTLS != "" { if service.ExposeServiceTLS != "true" { ingress.Spec.TLS = []networkingv1.IngressTLS{ { Hosts: tlsHosts, SecretName: service.ExposeServiceTLS, }, } } else { ingress.Spec.TLS = []networkingv1.IngressTLS{ { Hosts: tlsHosts, }, } } } if service.ExposeServiceIngressClassName != "" { ingress.Spec.IngressClassName = &service.ExposeServiceIngressClassName } return ingress } // CreateSecrets create secrets func (k *Kubernetes) CreateSecrets(komposeObject kobject.KomposeObject) ([]*api.Secret, error) { var objects []*api.Secret for name, config := range komposeObject.Secrets { if config.File != "" { dataString, err := GetContentFromFile(config.File) if err != nil { log.Fatal("unable to read secret from file: ", config.File) return nil, err } data := []byte(dataString) secret := &api.Secret{ TypeMeta: metav1.TypeMeta{ Kind: "Secret", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: FormatResourceName(name), Labels: transformer.ConfigLabels(name), }, Type: api.SecretTypeOpaque, Data: map[string][]byte{name: data}, } objects = append(objects, secret) } else { log.Warnf("External secrets %s is not currently supported - ignoring", name) } } return objects, nil } // CreatePVC initializes PersistentVolumeClaim func (k *Kubernetes) CreatePVC(name string, mode string, size string, selectorValue string, storageClassName string) (*api.PersistentVolumeClaim, error) { volSize, err := resource.ParseQuantity(size) if err != nil { return nil, errors.Wrap(err, "resource.ParseQuantity failed, Error parsing size") } pvc := &api.PersistentVolumeClaim{ TypeMeta: metav1.TypeMeta{ Kind: "PersistentVolumeClaim", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Labels: transformer.ConfigLabels(name), }, Spec: api.PersistentVolumeClaimSpec{ Resources: api.ResourceRequirements{ Requests: api.ResourceList{ api.ResourceStorage: volSize, }, }, }, } if len(selectorValue) > 0 { pvc.Spec.Selector = &metav1.LabelSelector{ MatchLabels: transformer.ConfigLabels(selectorValue), } } if mode == "ro" { pvc.Spec.AccessModes = []api.PersistentVolumeAccessMode{api.ReadOnlyMany} } else { pvc.Spec.AccessModes = []api.PersistentVolumeAccessMode{api.ReadWriteOnce} } if len(storageClassName) > 0 { pvc.Spec.StorageClassName = &storageClassName } return pvc, nil } // ConfigPorts configures the container ports. func ConfigPorts(service kobject.ServiceConfig) []api.ContainerPort { var ports []api.ContainerPort exist := map[string]bool{} for _, port := range service.Port { if exist[port.ID()] { continue } containerPort := api.ContainerPort{ ContainerPort: port.ContainerPort, HostIP: port.HostIP, } // If the default is already TCP, no need to include protocol. if protocol := api.Protocol(port.Protocol); protocol != api.ProtocolTCP { containerPort.Protocol = protocol } ports = append(ports, containerPort) exist[port.ID()] = true } return ports } // ConfigLBServicePorts method configure the ports of the k8s Load Balancer Service func (k *Kubernetes) ConfigLBServicePorts(service kobject.ServiceConfig) ([]api.ServicePort, []api.ServicePort) { var tcpPorts []api.ServicePort var udpPorts []api.ServicePort for _, port := range service.Port { if port.HostPort == 0 { port.HostPort = port.ContainerPort } var targetPort intstr.IntOrString targetPort.IntVal = port.ContainerPort targetPort.StrVal = strconv.Itoa(int(port.ContainerPort)) servicePort := api.ServicePort{ Name: strconv.Itoa(int(port.HostPort)), Port: port.HostPort, TargetPort: targetPort, } if protocol := api.Protocol(port.Protocol); protocol == api.ProtocolTCP { // If the default is already TCP, no need to include protocol. tcpPorts = append(tcpPorts, servicePort) } else { servicePort.Protocol = protocol udpPorts = append(udpPorts, servicePort) } } return tcpPorts, udpPorts } // ConfigServicePorts configure the container service ports. func (k *Kubernetes) ConfigServicePorts(service kobject.ServiceConfig) []api.ServicePort { servicePorts := []api.ServicePort{} seenPorts := make(map[int]struct{}, len(service.Port)) var servicePort api.ServicePort for _, port := range service.Port { if port.HostPort == 0 { port.HostPort = port.ContainerPort } var targetPort intstr.IntOrString targetPort.IntVal = port.ContainerPort targetPort.StrVal = strconv.Itoa(int(port.ContainerPort)) // decide the name based on whether we saw this port before name := strconv.Itoa(int(port.HostPort)) if _, ok := seenPorts[int(port.HostPort)]; ok { // https://github.com/kubernetes/kubernetes/issues/2995 if service.ServiceType == string(api.ServiceTypeLoadBalancer) { log.Fatalf("Service %s of type LoadBalancer cannot use TCP and UDP for the same port", name) } name = fmt.Sprintf("%s-%s", name, strings.ToLower(port.Protocol)) } servicePort = api.ServicePort{ Name: name, Port: port.HostPort, TargetPort: targetPort, } if service.ServiceType == string(api.ServiceTypeNodePort) && service.NodePortPort != 0 { servicePort.NodePort = service.NodePortPort } // If the default is already TCP, no need to include protocol. if protocol := api.Protocol(port.Protocol); protocol != api.ProtocolTCP { servicePort.Protocol = protocol } servicePorts = append(servicePorts, servicePort) seenPorts[int(port.HostPort)] = struct{}{} } return servicePorts } // ConfigCapabilities configure POSIX capabilities that can be added or removed to a container func ConfigCapabilities(service kobject.ServiceConfig) *api.Capabilities { capsAdd := []api.Capability{} capsDrop := []api.Capability{} for _, capAdd := range service.CapAdd { capsAdd = append(capsAdd, api.Capability(capAdd)) } for _, capDrop := range service.CapDrop { capsDrop = append(capsDrop, api.Capability(capDrop)) } return &api.Capabilities{ Add: capsAdd, Drop: capsDrop, } } // ConfigTmpfs configure the tmpfs. func (k *Kubernetes) ConfigTmpfs(name string, service kobject.ServiceConfig) ([]api.VolumeMount, []api.Volume) { //initializing volumemounts and volumes volumeMounts := []api.VolumeMount{} volumes := []api.Volume{} for index, volume := range service.TmpFs { //naming volumes if multiple tmpfs are provided volumeName := fmt.Sprintf("%s-tmpfs%d", name, index) volume = strings.Split(volume, ":")[0] // create a new volume mount object and append to list volMount := api.VolumeMount{ Name: volumeName, MountPath: volume, } volumeMounts = append(volumeMounts, volMount) //create tmpfs specific empty volumes volSource := k.ConfigEmptyVolumeSource("tmpfs") // create a new volume object using the volsource and add to list vol := api.Volume{ Name: volumeName, VolumeSource: *volSource, } volumes = append(volumes, vol) } return volumeMounts, volumes } // ConfigSecretVolumes config volumes from secret. // Link: https://docs.docker.com/compose/compose-file/#secrets // In kubernetes' Secret resource, it has a data structure like a map[string]bytes, every key will act like the file name // when mount to a container. This is the part that missing in compose. So we will create a single key secret from compose // config and the key's name will be the secret's name, it's value is the file content. // compose's secret can only be mounted at `/run/secrets`, so this will be hardcoded. func (k *Kubernetes) ConfigSecretVolumes(name string, service kobject.ServiceConfig) ([]api.VolumeMount, []api.Volume) { var volumeMounts []api.VolumeMount var volumes []api.Volume if len(service.Secrets) > 0 { for _, secretConfig := range service.Secrets { if secretConfig.UID != "" { log.Warnf("Ignore pid in secrets for service: %s", name) } if secretConfig.GID != "" { log.Warnf("Ignore gid in secrets for service: %s", name) } var secretItemPath, secretMountPath, secretSubPath string if k.Opt.SecretsAsFiles { secretItemPath, secretMountPath, secretSubPath = k.getSecretPaths(secretConfig) } else { secretItemPath, secretMountPath, secretSubPath = k.getSecretPathsLegacy(secretConfig) } volSource := api.VolumeSource{ Secret: &api.SecretVolumeSource{ SecretName: secretConfig.Source, Items: []api.KeyToPath{{ Key: secretConfig.Source, Path: secretItemPath, }}, }, } if secretConfig.Mode != nil { mode := cast.ToInt32(*secretConfig.Mode) volSource.Secret.DefaultMode = &mode } vol := api.Volume{ Name: secretConfig.Source, VolumeSource: volSource, } volumes = append(volumes, vol) volMount := api.VolumeMount{ Name: vol.Name, MountPath: secretMountPath, SubPath: secretSubPath, } volumeMounts = append(volumeMounts, volMount) } } return volumeMounts, volumes } func (k *Kubernetes) getSecretPaths(secretConfig types.ServiceSecretConfig) (secretItemPath, secretMountPath, secretSubPath string) { // Default secretConfig.Target to secretConfig.Source, just in case user was using short secret syntax or // otherwise did not define a specific target target := secretConfig.Target if target == "" { target = secretConfig.Source } // If target is an absolute path, set that as the MountPath if strings.HasPrefix(secretConfig.Target, "/") { secretMountPath = target } else { // If target is a relative path, prefix with "/run/secrets/" to replicate what docker-compose would do secretMountPath = "/run/secrets/" + target } // Set subPath to the target filename. this ensures that we end up with a file at our MountPath instead // of a directory with symlinks (see https://stackoverflow.com/a/68332231) splitPath := strings.Split(target, "/") secretFilename := splitPath[len(splitPath)-1] // `secretItemPath` and `secretSubPath` have to be the same as `secretFilename` to ensure we create a file with // that name at `secretMountPath`, instead of a directory containing a symlink to the actual file. secretItemPath = secretFilename secretSubPath = secretFilename return secretItemPath, secretMountPath, secretSubPath } func (k *Kubernetes) getSecretPathsLegacy(secretConfig types.ServiceSecretConfig) (secretItemPath, secretMountPath, secretSubPath string) { // The old way of setting secret paths. It resulted in files being placed in incorrect locations when compared to // docker-compose results, but some people might depend on this behavior so this is kept here for compatibility. // See https://github.com/kubernetes/kompose/issues/1280 for more details. var itemPath string // should be the filename var mountPath = "" // should be the directory // if is used the short-syntax if secretConfig.Target == "" { // the secret path (mountPath) should be inside the default directory /run/secrets mountPath = "/run/secrets/" + secretConfig.Source // the itemPath should be the source itself itemPath = secretConfig.Source } else { // if is the long-syntax, i should get the last part of path and consider it the filename pathSplitted := strings.Split(secretConfig.Target, "/") lastPart := pathSplitted[len(pathSplitted)-1] // if the filename (lastPart) and the target is the same if lastPart == secretConfig.Target { // the secret path should be the source (it need to be inside a directory and only the filename was given) mountPath = secretConfig.Source } else { // should then get the target without the filename (lastPart) mountPath = mountPath + strings.TrimSuffix(secretConfig.Target, "/"+lastPart) // menos ultima parte } // if the target isn't absolute path if !strings.HasPrefix(secretConfig.Target, "/") { // concat the default secret directory mountPath = "/run/secrets/" + mountPath } itemPath = lastPart } secretSubPath = "" // We didn't set a SubPath in legacy behavior return itemPath, mountPath, "" } // ConfigVolumes configure the container volumes. func (k *Kubernetes) ConfigVolumes(name string, service kobject.ServiceConfig) ([]api.VolumeMount, []api.Volume, []*api.PersistentVolumeClaim, []*api.ConfigMap, error) { volumeMounts := []api.VolumeMount{} volumes := []api.Volume{} var PVCs []*api.PersistentVolumeClaim var cms []*api.ConfigMap var volumeName string // Set a var based on if the user wants to use empty volumes // as opposed to persistent volumes and volume claims useEmptyVolumes := k.Opt.EmptyVols useHostPath := k.Opt.Volumes == "hostPath" useConfigMap := k.Opt.Volumes == "configMap" if k.Opt.Volumes == "emptyDir" { useEmptyVolumes = true } // Override volume type if specified in service labels. if vt, ok := service.Labels["kompose.volume.type"]; ok { if _, okk := ValidVolumeSet[vt]; !okk { return nil, nil, nil, nil, fmt.Errorf("invalid volume type %s specified in label 'kompose.volume.type' in service %s", vt, service.Name) } useEmptyVolumes = vt == "emptyDir" useHostPath = vt == "hostPath" useConfigMap = vt == "configMap" } // config volumes from secret if present secretsVolumeMounts, secretsVolumes := k.ConfigSecretVolumes(name, service) volumeMounts = append(volumeMounts, secretsVolumeMounts...) volumes = append(volumes, secretsVolumes...) var count int //iterating over array of `Vols` struct as it contains all necessary information about volumes for _, volume := range service.Volumes { // check if ro/rw mode is defined, default rw readonly := len(volume.Mode) > 0 && volume.Mode == "ro" if volume.VolumeName == "" { if useEmptyVolumes { volumeName = strings.Replace(volume.PVCName, "claim", "empty", 1) } else if useHostPath { volumeName = strings.Replace(volume.PVCName, "claim", "hostpath", 1) } else if useConfigMap { volumeName = strings.Replace(volume.PVCName, "claim", "cm", 1) } else { volumeName = volume.PVCName } // to support service group bases on volume, we need use the new group name to replace the origin service name // in volume name. For normal service, this should have no effect volumeName = strings.Replace(volumeName, service.Name, name, 1) count++ } else { volumeName = volume.VolumeName } volMount := api.VolumeMount{ Name: volumeName, ReadOnly: readonly, MountPath: volume.Container, } // Get a volume source based on the type of volume we are using // For PVC we will also create a PVC object and add to list var volsource *api.VolumeSource if useEmptyVolumes { volsource = k.ConfigEmptyVolumeSource("volume") } else if useHostPath { source, err := k.ConfigHostPathVolumeSource(volume.Host) if err != nil { return nil, nil, nil, nil, errors.Wrap(err, "k.ConfigHostPathVolumeSource failed") } volsource = source } else if useConfigMap { log.Debugf("Use configmap volume") cm, err := k.IntiConfigMapFromFileOrDir(name, volumeName, volume.Host, service) if err != nil { return nil, nil, nil, nil, err } cms = append(cms, cm) volsource = k.ConfigConfigMapVolumeSource(volumeName, volume.Container, cm) if useSubPathMount(cm) { volMount.SubPath = volsource.ConfigMap.Items[0].Path } } else { volsource = k.ConfigPVCVolumeSource(volumeName, readonly) if volume.VFrom == "" { var storageClassName string defaultSize := PVCRequestSize if k.Opt.PVCRequestSize != "" { defaultSize = k.Opt.PVCRequestSize } if len(volume.PVCSize) > 0 { defaultSize = volume.PVCSize } else { for key, value := range service.Labels { if key == "kompose.volume.size" { defaultSize = value } else if key == "kompose.volume.storage-class-name" { storageClassName = value } } } createdPVC, err := k.CreatePVC(volumeName, volume.Mode, defaultSize, volume.SelectorValue, storageClassName) if err != nil { return nil, nil, nil, nil, errors.Wrap(err, "k.CreatePVC failed") } PVCs = append(PVCs, createdPVC) } } volumeMounts = append(volumeMounts, volMount) // create a new volume object using the volsource and add to list vol := api.Volume{ Name: volumeName, VolumeSource: *volsource, } volumes = append(volumes, vol) if len(volume.Host) > 0 && (!useHostPath && !useConfigMap) { log.Warningf("Volume mount on the host %q isn't supported - ignoring path on the host", volume.Host) } } return volumeMounts, volumes, PVCs, cms, nil } // ConfigEmptyVolumeSource is helper function to create an EmptyDir api.VolumeSource // either for Tmpfs or for emptyvolumes func (k *Kubernetes) ConfigEmptyVolumeSource(key string) *api.VolumeSource { //if key is tmpfs if key == "tmpfs" { return &api.VolumeSource{ EmptyDir: &api.EmptyDirVolumeSource{Medium: api.StorageMediumMemory}, } } //if key is volume return &api.VolumeSource{ EmptyDir: &api.EmptyDirVolumeSource{}, } } // ConfigConfigMapVolumeSource config a configmap to use as volume source func (k *Kubernetes) ConfigConfigMapVolumeSource(cmName string, targetPath string, cm *api.ConfigMap) *api.VolumeSource { s := api.ConfigMapVolumeSource{} s.Name = cmName if useSubPathMount(cm) { var keys []string for k := range cm.Data { keys = append(keys, k) } for k := range cm.BinaryData { keys = append(keys, k) } key := keys[0] _, p := path.Split(targetPath) s.Items = []api.KeyToPath{ { Key: key, Path: p, }, } } return &api.VolumeSource{ ConfigMap: &s, } } // ConfigHostPathVolumeSource is a helper function to create a HostPath api.VolumeSource func (k *Kubernetes) ConfigHostPathVolumeSource(path string) (*api.VolumeSource, error) { dir, err := transformer.GetComposeFileDir(k.Opt.InputFiles) if err != nil { return nil, err } absPath := path if !filepath.IsAbs(path) { absPath = filepath.Join(dir, path) } return &api.VolumeSource{ HostPath: &api.HostPathVolumeSource{Path: absPath}, }, nil } // ConfigPVCVolumeSource is helper function to create an api.VolumeSource with a PVC func (k *Kubernetes) ConfigPVCVolumeSource(name string, readonly bool) *api.VolumeSource { return &api.VolumeSource{ PersistentVolumeClaim: &api.PersistentVolumeClaimVolumeSource{ ClaimName: name, ReadOnly: readonly, }, } } // ConfigEnvs configures the environment variables. func ConfigEnvs(service kobject.ServiceConfig, opt kobject.ConvertOptions) ([]api.EnvVar, error) { envs := transformer.EnvSort{} keysFromEnvFile := make(map[string]bool) // If there is an env_file, use ConfigMaps and ignore the environment variables // already specified if len(service.EnvFile) > 0 { // Load each env_file for _, file := range service.EnvFile { envName := FormatEnvName(file) // Load environment variables from file envLoad, err := GetEnvsFromFile(file, opt) if err != nil { return envs, errors.Wrap(err, "Unable to read env_file") } // Add configMapKeyRef to each environment variable for k := range envLoad { envs = append(envs, api.EnvVar{ Name: k, ValueFrom: &api.EnvVarSource{ ConfigMapKeyRef: &api.ConfigMapKeySelector{ LocalObjectReference: api.LocalObjectReference{ Name: envName, }, Key: k, }}, }) keysFromEnvFile[k] = true } } } // Load up the environment variables for _, v := range service.Environment { if !keysFromEnvFile[v.Name] { envs = append(envs, api.EnvVar{ Name: v.Name, Value: v.Value, }) } } // Stable sorts data while keeping the original order of equal elements // we need this because envs are not populated in any random order // this sorting ensures they are populated in a particular order sort.Stable(envs) return envs, nil } // ConfigAffinity configures the Affinity. func ConfigAffinity(service kobject.ServiceConfig) *api.Affinity { var affinity *api.Affinity // Config constraints // Convert constraints to requiredDuringSchedulingIgnoredDuringExecution positiveConstraints := configConstrains(service.Placement.PositiveConstraints, api.NodeSelectorOpIn) negativeConstraints := configConstrains(service.Placement.NegativeConstraints, api.NodeSelectorOpNotIn) if len(positiveConstraints) != 0 || len(negativeConstraints) != 0 { affinity = &api.Affinity{ NodeAffinity: &api.NodeAffinity{ RequiredDuringSchedulingIgnoredDuringExecution: &api.NodeSelector{ NodeSelectorTerms: []api.NodeSelectorTerm{ { MatchExpressions: append(positiveConstraints, negativeConstraints...), }, }, }, }, } } return affinity } // ConfigTopologySpreadConstraints configures the TopologySpreadConstraints. func ConfigTopologySpreadConstraints(service kobject.ServiceConfig) []api.TopologySpreadConstraint { preferencesLen := len(service.Placement.Preferences) constraints := make([]api.TopologySpreadConstraint, 0, preferencesLen) // Placement preferences are ignored for global services if service.DeployMode == "global" { log.Warnf("Ignore placement preferences for global service %s", service.Name) return constraints } for i, p := range service.Placement.Preferences { constraints = append(constraints, api.TopologySpreadConstraint{ // According to the order of preferences, the MaxSkew decreases in order // The minimum value is 1 MaxSkew: int32(preferencesLen - i), TopologyKey: p, WhenUnsatisfiable: api.ScheduleAnyway, LabelSelector: &metav1.LabelSelector{ MatchLabels: transformer.ConfigLabels(service.Name), }, }) } return constraints } func configConstrains(constrains map[string]string, operator api.NodeSelectorOperator) []api.NodeSelectorRequirement { constraintsLen := len(constrains) rs := make([]api.NodeSelectorRequirement, 0, constraintsLen) if constraintsLen == 0 { return rs } for k, v := range constrains { r := api.NodeSelectorRequirement{ Key: k, Operator: operator, Values: []string{v}, } rs = append(rs, r) } return rs } // CreateWorkloadAndConfigMapObjects generates a Kubernetes artifact for each input type service func (k *Kubernetes) CreateWorkloadAndConfigMapObjects(name string, service kobject.ServiceConfig, opt kobject.ConvertOptions) []runtime.Object { var objects []runtime.Object var replica int if opt.IsReplicaSetFlag || service.Replicas == 0 { replica = opt.Replicas } else { replica = service.Replicas } // Check to see if Docker Compose v3 Deploy.Mode has been set to "global" if service.DeployMode == "global" { //default use daemonset if opt.Controller == "" { opt.CreateD = false opt.CreateDS = true } else if opt.Controller != "daemonset" { log.Warnf("Global deploy mode service is best converted to daemonset, now it convert to %s", opt.Controller) } } //Resolve labels first if val, ok := service.Labels[compose.LabelControllerType]; ok { opt.CreateD = false opt.CreateDS = false opt.CreateRC = false if opt.Controller != "" { log.Warnf("Use label %s type %s for service %s, ignore %s flags", compose.LabelControllerType, val, name, opt.Controller) } opt.Controller = val } if len(service.Configs) > 0 { objects = k.createConfigMapFromComposeConfig(name, service, objects) } if opt.CreateD || opt.Controller == DeploymentController { objects = append(objects, k.InitD(name, service, replica)) } if opt.CreateDS || opt.Controller == DaemonSetController { objects = append(objects, k.InitDS(name, service)) } if opt.Controller == StatefulStateController { objects = append(objects, k.InitSS(name, service, replica)) } if len(service.EnvFile) > 0 { for _, envFile := range service.EnvFile { configMap := k.InitConfigMapForEnv(name, opt, envFile) objects = append(objects, configMap) } } return objects } func (k *Kubernetes) createConfigMapFromComposeConfig(name string, service kobject.ServiceConfig, objects []runtime.Object) []runtime.Object { for _, config := range service.Configs { currentConfigName := config.Source currentConfigObj := service.ConfigsMetaData[currentConfigName] if currentConfigObj.External.External { continue } currentFileName := currentConfigObj.File configMap := k.InitConfigMapFromFile(name, service, currentFileName) objects = append(objects, configMap) } return objects } // InitPod initializes Kubernetes Pod object func (k *Kubernetes) InitPod(name string, service kobject.ServiceConfig) *api.Pod { pod := api.Pod{ TypeMeta: metav1.TypeMeta{ Kind: "Pod", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Labels: transformer.ConfigLabels(name), Annotations: transformer.ConfigAnnotations(service), }, Spec: k.InitPodSpec(name, service.Image, service.ImagePullSecret), } return &pod } // CreateNetworkPolicy initializes Network policy func (k *Kubernetes) CreateNetworkPolicy(networkName string) (*networkingv1.NetworkPolicy, error) { str := "true" np := &networkingv1.NetworkPolicy{ TypeMeta: metav1.TypeMeta{ Kind: "NetworkPolicy", APIVersion: "networking.k8s.io/v1", }, ObjectMeta: metav1.ObjectMeta{ Name: networkName, //Labels: transformer.ConfigLabels(name)(name), }, Spec: networkingv1.NetworkPolicySpec{ PodSelector: metav1.LabelSelector{ MatchLabels: map[string]string{"io.kompose.network/" + networkName: str}, }, Ingress: []networkingv1.NetworkPolicyIngressRule{{ From: []networkingv1.NetworkPolicyPeer{{ PodSelector: &metav1.LabelSelector{ MatchLabels: map[string]string{"io.kompose.network/" + networkName: str}, }, }}, }}, }, } return np, nil } func buildServiceImage(opt kobject.ConvertOptions, service kobject.ServiceConfig, name string) error { // Must build the images before conversion (got to add service.Image in case 'image' key isn't provided // Check that --build is set to true // Check to see if there is an InputFile (required!) before we build the container // Check that there's actually a Build key // Lastly, we must have an Image name to continue if opt.Build == "local" && opt.InputFiles != nil && service.Build != "" { // If there's no "image" key, use the name of the container that's built if service.Image == "" { service.Image = name } if service.Image == "" { return fmt.Errorf("image key required within build parameters in order to build and push service '%s'", name) } log.Infof("Build key detected. Attempting to build image '%s'", service.Image) // Build the image! err := transformer.BuildDockerImage(service, name) if err != nil { return errors.Wrapf(err, "Unable to build Docker image for service %v", name) } // Push the built image to the repo! err = transformer.PushDockerImageWithOpt(service, name, opt) if err != nil { return errors.Wrapf(err, "Unable to push Docker image for service %v", name) } } return nil } func (k *Kubernetes) configKubeServiceAndIngressForService(service kobject.ServiceConfig, name string, objects *[]runtime.Object) { if k.PortsExist(service) { if service.ServiceType == "LoadBalancer" { svcs := k.CreateLBService(name, service) for _, svc := range svcs { *objects = append(*objects, svc) } if len(svcs) > 1 { log.Warningf("Create multiple service to avoid using mixed protocol in the same service when it's loadbalancer type") } } else { svc := k.CreateService(name, service) *objects = append(*objects, svc) if service.ExposeService != "" { *objects = append(*objects, k.initIngress(name, service, svc.Spec.Ports[0].Port)) } } } else { if service.ServiceType == "Headless" { svc := k.CreateHeadlessService(name, service) *objects = append(*objects, svc) } else { log.Warnf("Service %q won't be created because 'ports' is not specified", service.Name) } } } func (k *Kubernetes) configNetworkPolicyForService(service kobject.ServiceConfig, name string, objects *[]runtime.Object) error { if len(service.Network) > 0 { for _, net := range service.Network { log.Infof("Network %s is detected at Source, shall be converted to equivalent NetworkPolicy at Destination", net) np, err := k.CreateNetworkPolicy(net) if err != nil { return errors.Wrapf(err, "Unable to create Network Policy for network %v for service %v", net, name) } *objects = append(*objects, np) } } return nil } // Transform maps komposeObject to k8s objects // returns object that are already sorted in the way that Services are first func (k *Kubernetes) Transform(komposeObject kobject.KomposeObject, opt kobject.ConvertOptions) ([]runtime.Object, error) { // this will hold all the converted data var allobjects []runtime.Object if komposeObject.Secrets != nil { secrets, err := k.CreateSecrets(komposeObject) if err != nil { return nil, errors.Wrapf(err, "Unable to create Secret resource") } for _, item := range secrets { allobjects = append(allobjects, item) } } if opt.ServiceGroupMode != "" { log.Debugf("Service group mode is: %s", opt.ServiceGroupMode) komposeObjectToServiceConfigGroupMapping := KomposeObjectToServiceConfigGroupMapping(&komposeObject, opt) for name, group := range komposeObjectToServiceConfigGroupMapping { var objects []runtime.Object podSpec := PodSpec{} // if using volume group, the name here will be a volume config string. reset to the first service name if opt.ServiceGroupMode == "volume" { if opt.ServiceGroupName != "" { name = opt.ServiceGroupName } else { var names []string for _, svc := range group { names = append(names, svc.Name) } name = strings.Join(names, "-") } } // added a container // ports conflict check between services portsUses := map[string]bool{} for _, service := range group { // first do ports check ports := ConfigPorts(service) for _, port := range ports { key := string(port.ContainerPort) + string(port.Protocol) if portsUses[key] { return nil, fmt.Errorf("detect ports conflict when group services, service: %s, port: %d", service.Name, port.ContainerPort) } portsUses[key] = true } log.Infof("Group Service %s to [%s]", service.Name, name) service.WithKomposeAnnotation = opt.WithKomposeAnnotation podSpec.Append(AddContainer(service, opt)) if err := buildServiceImage(opt, service, service.Name); err != nil { return nil, err } // override.. objects = append(objects, k.CreateWorkloadAndConfigMapObjects(name, service, opt)...) k.configKubeServiceAndIngressForService(service, name, &objects) // Configure the container volumes. volumesMount, volumes, pvc, cms, err := k.ConfigVolumes(name, service) if err != nil { return nil, errors.Wrap(err, "k.ConfigVolumes failed") } // Configure Tmpfs if len(service.TmpFs) > 0 { TmpVolumesMount, TmpVolumes := k.ConfigTmpfs(name, service) volumes = append(volumes, TmpVolumes...) volumesMount = append(volumesMount, TmpVolumesMount...) } podSpec.Append( SetVolumeMounts(volumesMount), SetVolumes(volumes), ) // Looping on the slice pvc instead of `*objects = append(*objects, pvc...)` // because the type of objects and pvc is different, but when doing append // one element at a time it gets converted to runtime.Object for objects slice for _, p := range pvc { objects = append(objects, p) } for _, c := range cms { objects = append(objects, c) } podSpec.Append( SetPorts(service), ImagePullPolicy(name, service), RestartPolicy(name, service), SecurityContext(name, service), HostName(service), DomainName(service), ResourcesLimits(service), ResourcesRequests(service), TerminationGracePeriodSeconds(name, service), TopologySpreadConstraints(service), ) if serviceAccountName, ok := service.Labels[compose.LabelServiceAccountName]; ok { podSpec.Append(ServiceAccountName(serviceAccountName)) } err = k.UpdateKubernetesObjectsMultipleContainers(name, service, &objects, podSpec) if err != nil { return nil, errors.Wrap(err, "Error transforming Kubernetes objects") } if err = k.configNetworkPolicyForService(service, service.Name, &objects); err != nil { return nil, err } } allobjects = append(allobjects, objects...) } } sortedKeys := SortedKeys(komposeObject) for _, name := range sortedKeys { service := komposeObject.ServiceConfigs[name] // if service belongs to a group, we already processed it if service.InGroup { continue } var objects []runtime.Object service.WithKomposeAnnotation = opt.WithKomposeAnnotation if err := buildServiceImage(opt, service, name); err != nil { return nil, err } // Generate pod only and nothing more if (service.Restart == "no" || service.Restart == "on-failure") && !opt.IsPodController() { log.Infof("Create kubernetes pod instead of pod controller due to restart policy: %s", service.Restart) pod := k.InitPod(name, service) objects = append(objects, pod) } else { objects = k.CreateWorkloadAndConfigMapObjects(name, service, opt) } if opt.Controller == StatefulStateController { service.ServiceType = "Headless" } k.configKubeServiceAndIngressForService(service, name, &objects) err := k.UpdateKubernetesObjects(name, service, opt, &objects) if err != nil { return nil, errors.Wrap(err, "Error transforming Kubernetes objects") } if err := k.configNetworkPolicyForService(service, name, &objects); err != nil { return nil, err } allobjects = append(allobjects, objects...) } // sort all object so Services are first k.SortServicesFirst(&allobjects) k.RemoveDupObjects(&allobjects) // k.FixWorkloadVersion(&allobjects) return allobjects, nil } // UpdateController updates the given object with the given pod template update function and ObjectMeta update function func (k *Kubernetes) UpdateController(obj runtime.Object, updateTemplate func(*api.PodTemplateSpec) error, updateMeta func(meta *metav1.ObjectMeta)) (err error) { switch t := obj.(type) { case *appsv1.Deployment: err = updateTemplate(&t.Spec.Template) if err != nil { return errors.Wrap(err, "updateTemplate failed") } updateMeta(&t.ObjectMeta) case *appsv1.DaemonSet: err = updateTemplate(&t.Spec.Template) if err != nil { return errors.Wrap(err, "updateTemplate failed") } updateMeta(&t.ObjectMeta) case *appsv1.StatefulSet: err = updateTemplate(&t.Spec.Template) if err != nil { return errors.Wrap(err, "updateTemplate failed") } updateMeta(&t.ObjectMeta) case *deployapi.DeploymentConfig: err = updateTemplate(t.Spec.Template) if err != nil { return errors.Wrap(err, "updateTemplate failed") } updateMeta(&t.ObjectMeta) case *api.Pod: p := api.PodTemplateSpec{ ObjectMeta: t.ObjectMeta, Spec: t.Spec, } err = updateTemplate(&p) if err != nil { return errors.Wrap(err, "updateTemplate failed") } t.Spec = p.Spec t.ObjectMeta = p.ObjectMeta case *buildapi.BuildConfig: updateMeta(&t.ObjectMeta) } return nil }