Search in sources :

Example 1 with ConfigMapVolume

use of org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume in project kubernetes-plugin by jenkinsci.

the class ConfigMapVolumeTest method testNullSubPathValue.

@Test
public void testNullSubPathValue() {
    ConfigMapVolume configMapVolume = new ConfigMapVolume("oneMountPath", "Myvolume", false);
    assertNull(configMapVolume.getSubPath());
}
Also used : ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) Test(org.junit.Test)

Example 2 with ConfigMapVolume

use of org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume in project kubernetes-plugin by jenkinsci.

the class ConfigMapVolumeTest method testValidSubPathValue.

@Test
public void testValidSubPathValue() {
    ConfigMapVolume configMapVolume = new ConfigMapVolume("oneMountPath", "Myvolume", false);
    configMapVolume.setSubPath("miSubpath");
    assertEquals(configMapVolume.getSubPath(), "miSubpath");
}
Also used : ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) Test(org.junit.Test)

Example 3 with ConfigMapVolume

use of org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume in project kubernetes-plugin by jenkinsci.

the class PodTemplateBuilder method build.

/**
 * Create a Pod object from a PodTemplate
 */
public Pod build() {
    // Build volumes and volume mounts.
    Map<String, Volume> volumes = new HashMap<>();
    Map<String, VolumeMount> volumeMounts = new HashMap<>();
    if (agent == null) {
        throw new IllegalStateException("No KubernetesSlave is set");
    }
    String podName = agent.getPodName();
    int i = 0;
    for (final PodVolume volume : template.getVolumes()) {
        final String volumeName = "volume-" + i;
        final String mountPath = normalizePath(volume.getMountPath());
        if (!volumeMounts.containsKey(mountPath)) {
            VolumeMountBuilder volumeMountBuilder = // 
            new VolumeMountBuilder().withMountPath(mountPath).withName(volumeName).withReadOnly(false);
            if (volume instanceof ConfigMapVolume) {
                final ConfigMapVolume configmapVolume = (ConfigMapVolume) volume;
                String subPath = configmapVolume.getSubPath();
                if (subPath != null) {
                    volumeMountBuilder = volumeMountBuilder.withSubPath(normalizePath(subPath));
                }
            }
            volumeMounts.put(mountPath, volumeMountBuilder.build());
            volumes.put(volumeName, volume.buildVolume(volumeName, podName));
            i++;
        }
    }
    volumes.put(WORKSPACE_VOLUME_NAME, template.getWorkspaceVolume().buildVolume(WORKSPACE_VOLUME_NAME, podName));
    Map<String, Container> containers = new HashMap<>();
    // containers from pod template
    for (ContainerTemplate containerTemplate : template.getContainers()) {
        containers.put(containerTemplate.getName(), createContainer(containerTemplate, template.getEnvVars(), volumeMounts.values()));
    }
    MetadataNested<PodBuilder> metadataBuilder = new PodBuilder().withNewMetadata();
    if (agent != null) {
        metadataBuilder.withName(agent.getPodName());
    }
    Map<String, String> labels = new HashMap<>();
    if (agent != null) {
        labels.putAll(agent.getKubernetesCloud().getPodLabelsMap());
    }
    labels.putAll(template.getLabelsMap());
    if (!labels.isEmpty()) {
        metadataBuilder.withLabels(labels);
    }
    Map<String, String> annotations = getAnnotationsMap(template.getAnnotations());
    if (!annotations.isEmpty()) {
        metadataBuilder.withAnnotations(annotations);
    }
    SpecNested<PodBuilder> builder = metadataBuilder.endMetadata().withNewSpec();
    if (template.getActiveDeadlineSeconds() > 0) {
        builder = builder.withActiveDeadlineSeconds(Long.valueOf(template.getActiveDeadlineSeconds()));
    }
    if (!volumes.isEmpty()) {
        builder.withVolumes(volumes.values().toArray(new Volume[volumes.size()]));
    }
    if (template.getServiceAccount() != null) {
        builder.withServiceAccountName(substituteEnv(template.getServiceAccount()));
    }
    if (template.getSchedulerName() != null) {
        builder.withSchedulerName(substituteEnv(template.getSchedulerName()));
    }
    List<LocalObjectReference> imagePullSecrets = template.getImagePullSecrets().stream().map((x) -> x.toLocalObjectReference()).collect(Collectors.toList());
    if (!imagePullSecrets.isEmpty()) {
        builder.withImagePullSecrets(imagePullSecrets);
    }
    Map<String, String> nodeSelector = getNodeSelectorMap(template.getNodeSelector());
    if (!nodeSelector.isEmpty()) {
        builder.withNodeSelector(nodeSelector);
    }
    if (template.getTerminationGracePeriodSeconds() != null) {
        builder.withTerminationGracePeriodSeconds(template.getTerminationGracePeriodSeconds());
    }
    builder.withContainers(containers.values().toArray(new Container[containers.size()]));
    Long runAsUser = template.getRunAsUserAsLong();
    Long runAsGroup = template.getRunAsGroupAsLong();
    String supplementalGroups = template.getSupplementalGroups();
    if (runAsUser != null || runAsGroup != null || supplementalGroups != null) {
        PodSpecFluent.SecurityContextNested<SpecNested<PodBuilder>> securityContext = builder.editOrNewSecurityContext();
        if (runAsUser != null) {
            securityContext.withRunAsUser(runAsUser);
        }
        if (runAsGroup != null) {
            securityContext.withRunAsGroup(runAsGroup);
        }
        if (supplementalGroups != null) {
            securityContext.withSupplementalGroups(parseSupplementalGroupList(supplementalGroups));
        }
        securityContext.endSecurityContext();
    }
    if (template.isHostNetworkSet()) {
        builder.withHostNetwork(template.isHostNetwork());
    }
    // merge with the yaml fragments
    Pod pod = combine(template.getYamlsPod(), builder.endSpec().build());
    // Apply defaults
    // default jnlp container
    Optional<Container> jnlpOpt = pod.getSpec().getContainers().stream().filter(c -> JNLP_NAME.equals(c.getName())).findFirst();
    Container jnlp = jnlpOpt.orElse(new ContainerBuilder().withName(JNLP_NAME).withVolumeMounts(volumeMounts.values().toArray(new VolumeMount[volumeMounts.values().size()])).build());
    if (!jnlpOpt.isPresent()) {
        pod.getSpec().getContainers().add(jnlp);
    }
    pod.getSpec().getContainers().stream().filter(c -> c.getWorkingDir() == null).forEach(c -> c.setWorkingDir(jnlp.getWorkingDir()));
    if (StringUtils.isBlank(jnlp.getImage())) {
        String jnlpImage = DEFAULT_JNLP_IMAGE;
        if (StringUtils.isNotEmpty(DEFAULT_JNLP_DOCKER_REGISTRY_PREFIX)) {
            jnlpImage = Util.ensureEndsWith(DEFAULT_JNLP_DOCKER_REGISTRY_PREFIX, "/") + jnlpImage;
        }
        jnlp.setImage(jnlpImage);
    }
    Map<String, EnvVar> envVars = new HashMap<>();
    envVars.putAll(jnlpEnvVars(jnlp.getWorkingDir()));
    envVars.putAll(defaultEnvVars(template.getEnvVars()));
    Optional.ofNullable(jnlp.getEnv()).ifPresent(jnlpEnv -> {
        jnlpEnv.forEach(var -> envVars.put(var.getName(), var));
    });
    jnlp.setEnv(new ArrayList<>(envVars.values()));
    if (jnlp.getResources() == null) {
        Map<String, Quantity> reqMap = new HashMap<>();
        Map<String, Quantity> limMap = new HashMap<>();
        reqMap.put("cpu", new Quantity(DEFAULT_JNLP_CONTAINER_CPU_REQUEST));
        reqMap.put("memory", new Quantity(DEFAULT_JNLP_CONTAINER_MEMORY_REQUEST));
        if (DEFAULT_JNLP_CONTAINER_CPU_LIMIT != null) {
            limMap.put("cpu", new Quantity(DEFAULT_JNLP_CONTAINER_CPU_LIMIT));
        }
        if (DEFAULT_JNLP_CONTAINER_MEMORY_LIMIT != null) {
            limMap.put("memory", new Quantity(DEFAULT_JNLP_CONTAINER_MEMORY_LIMIT));
        }
        ResourceRequirements reqs = new ResourceRequirementsBuilder().withRequests(reqMap).withLimits(limMap).build();
        jnlp.setResources(reqs);
    }
    if (cloud != null) {
        pod = PodDecorator.decorateAll(cloud, pod);
    }
    Pod finalPod = pod;
    LOGGER.finest(() -> "Pod built: " + Serialization.asYaml(finalPod));
    return pod;
}
Also used : Quantity(io.fabric8.kubernetes.api.model.Quantity) VolumeMount(io.fabric8.kubernetes.api.model.VolumeMount) JavaSpecificationVersion(io.jenkins.lib.versionnumber.JavaSpecificationVersion) StringUtils(org.apache.commons.lang.StringUtils) JNLP_NAME(org.csanchez.jenkins.plugins.kubernetes.KubernetesCloud.JNLP_NAME) PodTemplateStepExecution(org.csanchez.jenkins.plugins.kubernetes.pipeline.PodTemplateStepExecution) ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) SpecNested(io.fabric8.kubernetes.api.model.PodFluent.SpecNested) Matcher(java.util.regex.Matcher) TcpSlaveAgentListener(hudson.TcpSlaveAgentListener) ResourceRequirements(io.fabric8.kubernetes.api.model.ResourceRequirements) VolumeMountBuilder(io.fabric8.kubernetes.api.model.VolumeMountBuilder) PodBuilder(io.fabric8.kubernetes.api.model.PodBuilder) Map(java.util.Map) NonNull(edu.umd.cs.findbugs.annotations.NonNull) ContainerBuilder(io.fabric8.kubernetes.api.model.ContainerBuilder) PodTemplateUtils.isNullOrEmpty(org.csanchez.jenkins.plugins.kubernetes.PodTemplateUtils.isNullOrEmpty) Restricted(org.kohsuke.accmod.Restricted) Collection(java.util.Collection) Jenkins(jenkins.model.Jenkins) SlaveComputer(hudson.slaves.SlaveComputer) Logger(java.util.logging.Logger) Collectors(java.util.stream.Collectors) StandardCharsets(java.nio.charset.StandardCharsets) PodTemplateUtils.combine(org.csanchez.jenkins.plugins.kubernetes.PodTemplateUtils.combine) List(java.util.List) Optional(java.util.Optional) Pattern(java.util.regex.Pattern) ProbeBuilder(io.fabric8.kubernetes.api.model.ProbeBuilder) SuppressFBWarnings(edu.umd.cs.findbugs.annotations.SuppressFBWarnings) PodTemplateUtils.substituteEnv(org.csanchez.jenkins.plugins.kubernetes.PodTemplateUtils.substituteEnv) EnvVar(io.fabric8.kubernetes.api.model.EnvVar) Container(io.fabric8.kubernetes.api.model.Container) ResourceRequirementsBuilder(io.fabric8.kubernetes.api.model.ResourceRequirementsBuilder) HashMap(java.util.HashMap) LocalObjectReference(io.fabric8.kubernetes.api.model.LocalObjectReference) ArrayList(java.util.ArrayList) Level(java.util.logging.Level) Serialization(io.fabric8.kubernetes.client.utils.Serialization) PodSpecFluent(io.fabric8.kubernetes.api.model.PodSpecFluent) Volume(io.fabric8.kubernetes.api.model.Volume) Util(hudson.Util) Probe(io.fabric8.kubernetes.api.model.Probe) PodVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.PodVolume) ExecAction(io.fabric8.kubernetes.api.model.ExecAction) NoExternalUse(org.kohsuke.accmod.restrictions.NoExternalUse) Pod(io.fabric8.kubernetes.api.model.Pod) IOException(java.io.IOException) MetadataNested(io.fabric8.kubernetes.api.model.PodFluent.MetadataNested) TemplateEnvVar(org.csanchez.jenkins.plugins.kubernetes.model.TemplateEnvVar) ContainerPort(io.fabric8.kubernetes.api.model.ContainerPort) IOUtils(hudson.util.IOUtils) Paths(java.nio.file.Paths) PodDecorator(org.csanchez.jenkins.plugins.kubernetes.pod.decorator.PodDecorator) CheckForNull(edu.umd.cs.findbugs.annotations.CheckForNull) Collections(java.util.Collections) InputStream(java.io.InputStream) HashMap(java.util.HashMap) ResourceRequirementsBuilder(io.fabric8.kubernetes.api.model.ResourceRequirementsBuilder) SpecNested(io.fabric8.kubernetes.api.model.PodFluent.SpecNested) ResourceRequirements(io.fabric8.kubernetes.api.model.ResourceRequirements) Container(io.fabric8.kubernetes.api.model.Container) ContainerBuilder(io.fabric8.kubernetes.api.model.ContainerBuilder) EnvVar(io.fabric8.kubernetes.api.model.EnvVar) TemplateEnvVar(org.csanchez.jenkins.plugins.kubernetes.model.TemplateEnvVar) PodVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.PodVolume) ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) Pod(io.fabric8.kubernetes.api.model.Pod) PodBuilder(io.fabric8.kubernetes.api.model.PodBuilder) Quantity(io.fabric8.kubernetes.api.model.Quantity) VolumeMountBuilder(io.fabric8.kubernetes.api.model.VolumeMountBuilder) ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) Volume(io.fabric8.kubernetes.api.model.Volume) PodVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.PodVolume) PodSpecFluent(io.fabric8.kubernetes.api.model.PodSpecFluent) LocalObjectReference(io.fabric8.kubernetes.api.model.LocalObjectReference) VolumeMount(io.fabric8.kubernetes.api.model.VolumeMount)

Example 4 with ConfigMapVolume

use of org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume in project kubernetes-plugin by jenkinsci.

the class PodTemplateBuilderTest method yamlOverrideVolume.

@Test
public void yamlOverrideVolume() throws Exception {
    PodTemplate parent = new PodTemplate();
    parent.setYaml("apiVersion: v1\n" + "kind: Pod\n" + "metadata:\n" + "  labels:\n" + "    some-label: some-label-value\n" + "spec:\n" + "  containers:\n" + "  - name: jnlp\n" + "    volumeMounts:\n" + "    - name: host-volume\n" + "      mountPath: /etc/config\n" + "      subPath: mypath\n" + "  volumes:\n" + "  - name: host-volume\n" + "    hostPath:\n" + "      path: /host/data\n");
    PodTemplate child = new PodTemplate();
    child.setYaml("spec:\n" + "  volumes:\n" + "  - name: host-volume\n" + "    hostPath:\n" + "      path: /host/data2\n");
    child.setContainers(Collections.singletonList(new ContainerTemplate("jnlp", "image")));
    ConfigMapVolume cmVolume = new ConfigMapVolume("/etc/configmap", "my-configmap", false);
    cmVolume.setSubPath("subpath");
    child.setVolumes(Collections.singletonList(cmVolume));
    child.setInheritFrom("parent");
    child.setYamlMergeStrategy(merge());
    setupStubs();
    PodTemplate result = combine(parent, child);
    Pod pod = new PodTemplateBuilder(result, slave).build();
    // inherit from parent
    assertEquals("some-label-value", pod.getMetadata().getLabels().get("some-label"));
    Optional<Volume> maybeVolume = pod.getSpec().getVolumes().stream().filter(v -> "host-volume".equals(v.getName())).findFirst();
    assertTrue(maybeVolume.isPresent());
    // child value overrides parent value
    assertThat(maybeVolume.get().getHostPath().getPath(), equalTo("/host/data2"));
    assertThat(pod.getSpec().getContainers(), hasSize(1));
    Container container = pod.getSpec().getContainers().get(0);
    Optional<VolumeMount> maybeVolumeMount = container.getVolumeMounts().stream().filter(vm -> "host-volume".equals(vm.getName())).findFirst();
    assertTrue(maybeVolumeMount.isPresent());
    VolumeMount volumeMount = maybeVolumeMount.get();
    assertEquals("/etc/config", volumeMount.getMountPath());
    assertEquals("mypath", volumeMount.getSubPath());
    Optional<VolumeMount> maybeVolumeMountCm = container.getVolumeMounts().stream().filter(vm -> "/etc/configmap".equals(vm.getMountPath())).findFirst();
    assertTrue(maybeVolumeMountCm.isPresent());
    VolumeMount cmVolumeMount = maybeVolumeMountCm.get();
    assertEquals("subpath", cmVolumeMount.getSubPath());
}
Also used : Quantity(io.fabric8.kubernetes.api.model.Quantity) VolumeMount(io.fabric8.kubernetes.api.model.VolumeMount) PodSecurityContext(io.fabric8.kubernetes.api.model.PodSecurityContext) Arrays(java.util.Arrays) Issue(org.jvnet.hudson.test.Issue) ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) YamlMergeStrategy(org.csanchez.jenkins.plugins.kubernetes.pod.yaml.YamlMergeStrategy) KeyValueEnvVar(org.csanchez.jenkins.plugins.kubernetes.model.KeyValueEnvVar) FlagRule(org.jvnet.hudson.test.FlagRule) DynamicPVCWorkspaceVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.workspace.DynamicPVCWorkspaceVolume) ResourceRequirements(io.fabric8.kubernetes.api.model.ResourceRequirements) VolumeMountBuilder(io.fabric8.kubernetes.api.model.VolumeMountBuilder) Map(java.util.Map) Spy(org.mockito.Spy) JUnitParamsRunner(junitparams.JUnitParamsRunner) PodTemplateUtils(org.csanchez.jenkins.plugins.kubernetes.PodTemplateUtils) Jenkins(jenkins.model.Jenkins) WithoutJenkins(org.jvnet.hudson.test.WithoutJenkins) HostPathVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.HostPathVolume) Logger(java.util.logging.Logger) Collectors(java.util.stream.Collectors) List(java.util.List) PodTemplateBuilder(org.csanchez.jenkins.plugins.kubernetes.PodTemplateBuilder) Optional(java.util.Optional) EmptyDirVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.EmptyDirVolume) Parameters(junitparams.Parameters) EnvVar(io.fabric8.kubernetes.api.model.EnvVar) Container(io.fabric8.kubernetes.api.model.Container) Mock(org.mockito.Mock) RunWith(org.junit.runner.RunWith) Function(java.util.function.Function) ArrayList(java.util.ArrayList) Level(java.util.logging.Level) Merge(org.csanchez.jenkins.plugins.kubernetes.pod.yaml.Merge) LoggerRule(org.jvnet.hudson.test.LoggerRule) EmptyDirWorkspaceVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.workspace.EmptyDirWorkspaceVolume) MockitoJUnit(org.mockito.junit.MockitoJUnit) MatcherAssert.assertThat(org.hamcrest.MatcherAssert.assertThat) TestCaseName(junitparams.naming.TestCaseName) Before(org.junit.Before) Volume(io.fabric8.kubernetes.api.model.Volume) PodVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.PodVolume) Assert.assertNotNull(org.junit.Assert.assertNotNull) Matchers(org.hamcrest.Matchers) Assert.assertTrue(org.junit.Assert.assertTrue) IOUtils(org.apache.commons.compress.utils.IOUtils) Pod(io.fabric8.kubernetes.api.model.Pod) IOException(java.io.IOException) Test(org.junit.Test) Mockito(org.mockito.Mockito) TemplateEnvVar(org.csanchez.jenkins.plugins.kubernetes.model.TemplateEnvVar) Collectors.toList(java.util.stream.Collectors.toList) Assert.assertNull(org.junit.Assert.assertNull) Rule(org.junit.Rule) Matcher(org.hamcrest.Matcher) MockitoRule(org.mockito.junit.MockitoRule) JenkinsRule(org.jvnet.hudson.test.JenkinsRule) Collections(java.util.Collections) Assert.assertEquals(org.junit.Assert.assertEquals) ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) PodTemplateBuilder(org.csanchez.jenkins.plugins.kubernetes.PodTemplateBuilder) Container(io.fabric8.kubernetes.api.model.Container) Pod(io.fabric8.kubernetes.api.model.Pod) ConfigMapVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume) DynamicPVCWorkspaceVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.workspace.DynamicPVCWorkspaceVolume) HostPathVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.HostPathVolume) EmptyDirVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.EmptyDirVolume) EmptyDirWorkspaceVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.workspace.EmptyDirWorkspaceVolume) Volume(io.fabric8.kubernetes.api.model.Volume) PodVolume(org.csanchez.jenkins.plugins.kubernetes.volumes.PodVolume) VolumeMount(io.fabric8.kubernetes.api.model.VolumeMount) Test(org.junit.Test)

Aggregations

ConfigMapVolume (org.csanchez.jenkins.plugins.kubernetes.volumes.ConfigMapVolume)4 Container (io.fabric8.kubernetes.api.model.Container)2 EnvVar (io.fabric8.kubernetes.api.model.EnvVar)2 Pod (io.fabric8.kubernetes.api.model.Pod)2 Quantity (io.fabric8.kubernetes.api.model.Quantity)2 ResourceRequirements (io.fabric8.kubernetes.api.model.ResourceRequirements)2 Volume (io.fabric8.kubernetes.api.model.Volume)2 VolumeMount (io.fabric8.kubernetes.api.model.VolumeMount)2 VolumeMountBuilder (io.fabric8.kubernetes.api.model.VolumeMountBuilder)2 IOException (java.io.IOException)2 ArrayList (java.util.ArrayList)2 Collections (java.util.Collections)2 List (java.util.List)2 Map (java.util.Map)2 Optional (java.util.Optional)2 Level (java.util.logging.Level)2 Logger (java.util.logging.Logger)2 Collectors (java.util.stream.Collectors)2 Jenkins (jenkins.model.Jenkins)2 TemplateEnvVar (org.csanchez.jenkins.plugins.kubernetes.model.TemplateEnvVar)2