Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Update InitContainer properties to use correct naming #510

Closed
wants to merge 2 commits into from
Closed

Update InitContainer properties to use correct naming #510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
637d2f5
Rename key fields in the InitContainer
cppwfs Apr 9, 2025
0480732
Remove repettive code when deteriminng init container properties
cppwfs Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .../main/java/org/springframework/cloud/deployer/spi/kubernetes/DefaultContainerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,8 @@ public Container create(ContainerConfiguration containerConfiguration) {

ContainerBuilder container = new ContainerBuilder();
container.withName(containerConfiguration.getAppId()).withImage(image).withEnv(envVars).withEnvFrom(envFromSources)
.withArgs(appArgs).withVolumeMounts(deploymentPropertiesResolver.getVolumeMounts(deploymentProperties));
.withArgs(appArgs).withImagePullPolicy(deploymentPropertiesResolver.getImagePullPolicy(deploymentProperties))
.withVolumeMounts(deploymentPropertiesResolver.getVolumeMounts(deploymentProperties));

Set<Integer> ports = new HashSet<>();

Expand Down
37 changes: 26 additions & 11 deletions .../java/org/springframework/cloud/deployer/spi/kubernetes/DeploymentPropertiesResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,11 @@ Map<String, String> getNodeSelectors(Map<String, String> deploymentProperties) {
return nodeSelectors;
}

String getImagePullPolicy(Map<String, String> kubernetesDeployerProperties) {
ImagePullPolicy imagePullPolicy = deduceImagePullPolicy(kubernetesDeployerProperties);
return imagePullPolicy != null ? imagePullPolicy.name() : null;
}

String getImagePullSecret(Map<String, String> kubernetesDeployerProperties) {
String imagePullSecret = PropertyParserUtils.getDeploymentPropertyValue(kubernetesDeployerProperties,
this.propertyPrefix + ".imagePullSecret", "");
Expand Down Expand Up @@ -643,16 +648,16 @@ Collection<Container> getInitContainers(Map<String, String> kubernetesDeployerPr
}

private @Nullable Container initContainerFromProperties(Map<String, String> kubeProps, String propertyKey) {
String containerName = PropertyParserUtils.getDeploymentPropertyValue(kubeProps, propertyKey + ".containerName");
String imageName = PropertyParserUtils.getDeploymentPropertyValue(kubeProps, propertyKey + ".imageName");
if (StringUtils.hasText(containerName) && StringUtils.hasText(imageName)) {
String commandsStr = PropertyParserUtils.getDeploymentPropertyValue(kubeProps, propertyKey + ".commands");
List<String> commands = StringUtils.hasText(commandsStr) ? Arrays.asList(commandsStr.split(",")) : Collections.emptyList();
String envString = PropertyParserUtils.getDeploymentPropertyValue(kubeProps, propertyKey + ".environmentVariables");
String name = getFirstProperty(kubeProps, propertyKey, ".name", ".containerName");
String image = getFirstProperty(kubeProps, propertyKey, ".image", ".imageName");
if (StringUtils.hasText(name) && StringUtils.hasText(image)) {
String commandStr = getFirstProperty(kubeProps, propertyKey, ".command", ".commands");
List<String> commands = StringUtils.hasText(commandStr) ? Arrays.asList(commandStr.split(",")) : Collections.emptyList();
String envString = getFirstProperty(kubeProps, propertyKey, ".env", ".environmentVariables");
List<VolumeMount> vms = this.getInitContainerVolumeMounts(kubeProps, propertyKey);
return new ContainerBuilder()
.withName(containerName)
.withImage(imageName)
.withName(name)
.withImage(image)
.withCommand(commands)
.withEnv(toEnvironmentVariables((envString != null) ? envString.split(",") : new String[0]))
.addAllToVolumeMounts(vms)
Expand All @@ -661,11 +666,21 @@ Collection<Container> getInitContainers(Map<String, String> kubernetesDeployerPr
return null;
}

public static String getFirstProperty(Map<String, String> kubeProps, String baseKey, String... suffixes) {
for (String suffix : suffixes) {
String value = PropertyParserUtils.getDeploymentPropertyValue(kubeProps, baseKey + suffix);
if (StringUtils.hasText(value)) {
return value;
}
}
return null;
}

private Container containerFromProps(InitContainer initContainerProps) {
return new ContainerBuilder()
.withName(initContainerProps.getContainerName())
.withImage(initContainerProps.getImageName())
.withCommand(initContainerProps.getCommands())
.withName(initContainerProps.getName())
.withImage(initContainerProps.getImage())
.withCommand(initContainerProps.getCommand())
.withArgs(initContainerProps.getArgs())
.withEnv(toEnvironmentVariables(initContainerProps.getEnvironmentVariables()))
.addAllToVolumeMounts(Optional.ofNullable(initContainerProps.getVolumeMounts()).orElse(Collections.emptyList()))
Expand Down
82 changes: 57 additions & 25 deletions .../java/org/springframework/cloud/deployer/spi/kubernetes/KubernetesDeployerProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
import java.util.ArrayList;
import java.util.List;

import com.fasterxml.jackson.annotation.JsonAlias;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.fabric8.kubernetes.api.model.NodeAffinity;
import io.fabric8.kubernetes.api.model.PodAffinity;
import io.fabric8.kubernetes.api.model.PodAntiAffinity;
Expand Down Expand Up @@ -980,42 +982,72 @@ static class Container extends io.fabric8.kubernetes.api.model.Container {
}

public static class ContainerProperties {
private String imageName;

private String containerName;

private List<String> commands;
private List<String> args;
private List<VolumeMount> volumeMounts;
@JsonAlias("imageName")
@JsonProperty("image")
private String image;
@JsonAlias("containerName")
@JsonProperty("name")
private String name;
@JsonProperty("command")
@JsonAlias("commands")
private List<String> command;
private List<String> args;
private List<VolumeMount> volumeMounts;

/**
* Environment variables to set for any deployed init container.
*/
private String[] environmentVariables = new String[]{};

public String getImageName() {
return imageName;
}
public String getName() {
return name;
}

public void setImageName(String imageName) {
this.imageName = imageName;
}
public void setName(String name) {
this.name = name;
}
@Deprecated
public String getImageName() {
return getImage();
}
@Deprecated
public void setImageName(String image) {
setImage(image);
}
public String getImage() {
return image;
}

public String getContainerName() {
return containerName;
}
public void setImage(String image) {
this.image = image;
}

public void setContainerName(String containerName) {
this.containerName = containerName;
}
@Deprecated
public String getContainerName() {
return getName();
}

public List<String> getCommands() {
return commands;
}
@Deprecated
public void setContainerName(String containerName) {
setName(containerName);
}

public void setCommands(List<String> commands) {
this.commands = commands;
}
public List<String> getCommand() {
return command;
}

public void setCommand(List<String> command) {
this.command = command;
}
@Deprecated
public List<String> getCommands() {
return getCommand();
}

@Deprecated
public void setCommands(List<String> commands) {
setCommand(commands);
}

public List<String> getArgs() {
return args;
Expand Down
6 changes: 3 additions & 3 deletions ...org/springframework/cloud/deployer/spi/kubernetes/KubernetesAppDeployerIntegrationIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1327,9 +1327,9 @@ public void testCreateInitContainerWithEnvVariables() {
public void initContainerFromGlobalProps() {
// Set up a global initContainer (it should be chosen)
KubernetesDeployerProperties.InitContainer globalInitContainerProps = new KubernetesDeployerProperties.InitContainer();
globalInitContainerProps.setContainerName("test-global");
globalInitContainerProps.setImageName("busybox:latest");
globalInitContainerProps.setCommands(Arrays.asList("sh", "-c", "echo hello-global"));
globalInitContainerProps.setName("test-global");
globalInitContainerProps.setImage("busybox:latest");
globalInitContainerProps.setCommand(Arrays.asList("sh", "-c", "echo hello-global"));

KubernetesDeployerProperties kubernetesDeployerProperties = new KubernetesDeployerProperties();
kubernetesDeployerProperties.setInitContainer(globalInitContainerProps);
Expand Down
22 changes: 17 additions & 5 deletions ...st/java/org/springframework/cloud/deployer/spi/kubernetes/KubernetesAppDeployerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,15 +931,21 @@ public void testMultipleInitContainerProperties() {
props.put("spring.cloud.deployer.kubernetes.initContainers[1].imageName", "busybox:2");
props.put("spring.cloud.deployer.kubernetes.initContainers[1].containerName", "bb_s2");
props.put("spring.cloud.deployer.kubernetes.initContainers[1].commands", "sh,-c,script2.sh");
props.put("spring.cloud.deployer.kubernetes.initContainers[2]", "{ \"imageName\": \"busybox:3\", \"containerName\": \"bb_s3\", \"args\": [\"-c\", \"script3.sh\"], \"volumeMounts\": [{\"mountPath\": \"/data\", \"name\": \"s3vol\", \"readOnly\": true}] }");
props.put("spring.cloud.deployer.kubernetes.initContainers[1].environmentVariables", "foo=baz");

AppDefinition definition = new AppDefinition("app-test", null);
props.put("spring.cloud.deployer.kubernetes.initContainers[2]", "{ \"image\": \"busybox:3\", \"name\": \"bb_s3\", \"args\": [\"-c\", \"script3.sh\"], \"volumeMounts\": [{\"mountPath\": \"/data\", \"name\": \"s3vol\", \"readOnly\": true}] }");
props.put("spring.cloud.deployer.kubernetes.initContainers[3].image", "busybox:2");
props.put("spring.cloud.deployer.kubernetes.initContainers[3].name", "bb_s4");
props.put("spring.cloud.deployer.kubernetes.initContainers[3].command", "sh,-c,script4.sh");
props.put("spring.cloud.deployer.kubernetes.initContainers[3].env", "foo=bar");

AppDefinition definition = new AppDefinition("app-test", null);
AppDeploymentRequest appDeploymentRequest = new AppDeploymentRequest(definition, getResource(), props);

deployer = k8sAppDeployer(new KubernetesDeployerProperties());
PodSpec podSpec = deployer.createPodSpec(appDeploymentRequest);
assertThat(podSpec.getInitContainers()).isNotEmpty();
assertThat(podSpec.getInitContainers().size()).isEqualTo(3);
assertThat(podSpec.getInitContainers().size()).isEqualTo(4);
Container container0 = podSpec.getInitContainers().get(0);
assertThat(container0.getImage()).isEqualTo("busybox:1");
assertThat(container0.getName()).isEqualTo("bb_s1");
Expand All @@ -948,15 +954,21 @@ public void testMultipleInitContainerProperties() {
assertThat(container1.getImage()).isEqualTo("busybox:2");
assertThat(container1.getName()).isEqualTo("bb_s2");
assertThat(container1.getCommand()).containsExactly("sh", "-c", "script2.sh");
Container container2 = podSpec.getInitContainers().get(2);
assertThat(container1.getEnv()).isEqualTo(Collections.singletonList(new EnvVar("foo","baz", null)));
Container container2 = podSpec.getInitContainers().get(2);
assertThat(container2.getImage()).isEqualTo("busybox:3");
assertThat(container2.getName()).isEqualTo("bb_s3");
assertThat(container2.getArgs()).containsExactly("-c", "script3.sh");
assertThat(container2.getVolumeMounts()).isNotEmpty();
assertThat(container2.getVolumeMounts().get(0).getName()).isEqualTo("s3vol");
assertThat(container2.getVolumeMounts().get(0).getMountPath()).isEqualTo("/data");
assertThat(container2.getVolumeMounts().get(0).getReadOnly()).isTrue();
}
Container container3 = podSpec.getInitContainers().get(3);
assertThat(container3.getImage()).isEqualTo("busybox:2");
assertThat(container3.getName()).isEqualTo("bb_s4");
assertThat(container3.getCommand()).containsExactly("sh", "-c", "script4.sh");
assertThat(container3.getEnv()).isEqualTo(Collections.singletonList(new EnvVar("foo","bar", null)));
}

@Test
public void testNodeAffinityProperty() {
Expand Down