io.fabric8.maven.enricher.standard.DefaultControllerEnricher Maven / Gradle / Ivy
/*
* Copyright 2016 Red Hat, Inc.
*
* Red Hat 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 io.fabric8.maven.enricher.standard;
import io.fabric8.kubernetes.api.builder.TypedVisitor;
import io.fabric8.kubernetes.api.model.Container;
import io.fabric8.kubernetes.api.model.ContainerPort;
import io.fabric8.kubernetes.api.model.EnvVar;
import io.fabric8.kubernetes.api.model.KubernetesListBuilder;
import io.fabric8.kubernetes.api.model.PodSpec;
import io.fabric8.kubernetes.api.model.PodSpecBuilder;
import io.fabric8.kubernetes.api.model.PodTemplateSpec;
import io.fabric8.kubernetes.api.model.extensions.Deployment;
import io.fabric8.kubernetes.api.model.extensions.DeploymentBuilder;
import io.fabric8.kubernetes.api.model.extensions.DeploymentFluent;
import io.fabric8.kubernetes.api.model.extensions.DeploymentSpec;
import io.fabric8.maven.core.config.ResourceConfig;
import io.fabric8.maven.core.handler.DeploymentHandler;
import io.fabric8.maven.core.handler.HandlerHub;
import io.fabric8.maven.core.handler.ReplicaSetHandler;
import io.fabric8.maven.core.handler.ReplicationControllerHandler;
import io.fabric8.maven.core.util.Configs;
import io.fabric8.maven.core.util.KubernetesResourceUtil;
import io.fabric8.maven.core.util.MavenUtil;
import io.fabric8.maven.enricher.api.BaseEnricher;
import io.fabric8.maven.enricher.api.EnricherContext;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import static io.fabric8.utils.Strings.isNullOrBlank;
/**
* Enrich with controller if not already present.
*
* By default the following objects will be added
*
*
* - ReplicationController
* - ReplicaSet
* - Deployment (for Kubernetes)
* - DeploymentConfig (for OpenShift)
*
*
* TODO: There is a certain overlap with the ImageEnricher with adding default images etc.. This must be resolved.
*
* @author roland
* @since 25/05/16
*/
public class DefaultControllerEnricher extends BaseEnricher {
protected static final String[] POD_CONTROLLER_KINDS =
{ "ReplicationController", "ReplicaSet", "Deployment", "DeploymentConfig" };
private final DeploymentHandler deployHandler;
private final ReplicationControllerHandler rcHandler;
private final ReplicaSetHandler rsHandler;
// Available configuration keys
private enum Config implements Configs.Key {
name,
pullPolicy {{ d = "IfNotPresent"; }},
type {{ d = "deployment"; }};
public String def() { return d; } protected String d;
}
public DefaultControllerEnricher(EnricherContext buildContext) {
super(buildContext, "fmp-controller");
HandlerHub handlers = new HandlerHub(buildContext.getProject());
rcHandler = handlers.getReplicationControllerHandler();
rsHandler = handlers.getReplicaSetHandler();
deployHandler = handlers.getDeploymentHandler();
}
@Override
public void addMissingResources(KubernetesListBuilder builder) {
final String defaultName = getConfig(Config.name, MavenUtil.createDefaultResourceName(getProject()));
ResourceConfig config =
new ResourceConfig.Builder()
.replicaSetName(defaultName)
.imagePullPolicy(getConfig(Config.pullPolicy))
.build();
final Deployment defaultDeployment = deployHandler.getDeployment(config, getImages());
// Check if at least a replica set is added. If not add a default one
if (!KubernetesResourceUtil.checkForKind(builder, POD_CONTROLLER_KINDS)) {
String type = getConfig(Config.type);
if (type.equalsIgnoreCase("deployment")) {
log.info("Adding a default Deployment");
builder.addToDeploymentItems(defaultDeployment);
} else if (type.equalsIgnoreCase("replicaSet")) {
log.info("Adding a default ReplicaSet");
builder.addToReplicaSetItems(rsHandler.getReplicaSet(config, getImages()));
} else if (type.equalsIgnoreCase("replicationController")) {
log.info("Adding a default ReplicationController");
builder.addToReplicationControllerItems(rcHandler.getReplicationController(config, getImages()));
}
} else {
final DeploymentSpec spec = defaultDeployment.getSpec();
if (spec != null) {
PodTemplateSpec template = spec.getTemplate();
if (template != null) {
final PodSpec podSpec = template.getSpec();
if (podSpec != null) {
builder.accept(new TypedVisitor() {
@Override
public void visit(PodSpecBuilder builder) {
mergePodSpec(builder, podSpec, defaultName);
}
});
// handle Deployment YAML which may not have a DeploymentSpec, PodTemplateSpec or PodSpec
// or if it does lets enrich with the defaults
builder.accept(new TypedVisitor() {
@Override
public void visit(DeploymentBuilder builder) {
DeploymentSpec deploymentSpec = builder.getSpec();
if (deploymentSpec == null) {
builder.withNewSpec().endSpec();
deploymentSpec = builder.getSpec();
}
mergeDeploymentSpec(builder, spec);
PodTemplateSpec template = deploymentSpec.getTemplate();
DeploymentFluent.SpecNested specBuilder = builder.editSpec();
if (template == null) {
specBuilder.withNewTemplate().withNewSpecLike(podSpec).endSpec().endTemplate().endSpec();
} else {
PodSpec builderSpec = template.getSpec();
if (builderSpec == null) {
specBuilder.editTemplate().withNewSpecLike(podSpec).endSpec().endTemplate().endSpec();
} else {
PodSpecBuilder podSpecBuilder = new PodSpecBuilder(builderSpec);
mergePodSpec(podSpecBuilder, podSpec, defaultName);
}
}
}
});
}
}
}
}
}
private void mergeDeploymentSpec(DeploymentBuilder builder, DeploymentSpec spec) {
DeploymentFluent.SpecNested specBuilder = builder.editSpec();
mergeSimpleFields(specBuilder, spec);
specBuilder.endSpec();
}
/**
* Uses reflection to copy over default values from the defaultValues object to the targetValues
* object similar to the following:
*
*
\ * if( values.get${FIELD}() == null ) {
* values.(with|set){FIELD}(defaultValues.get${FIELD});
* }
*
*
* Only fields that which use primitives, boxed primitives, or String object are copied.
*
* @param targetValues
* @param defaultValues
*/
private static void mergeSimpleFields(Object targetValues, Object defaultValues) {
Class tc = targetValues.getClass();
Class sc = defaultValues.getClass();
for (Method targetGetMethod : tc.getMethods()) {
if( !targetGetMethod.getName().startsWith("get") )
continue;
Class fieldType = targetGetMethod.getReturnType();
if( !SIMPLE_FIELD_TYPES.contains(fieldType) )
continue;
String fieldName = targetGetMethod.getName().substring(3);
Method withMethod = null;
try {
withMethod = tc.getMethod("with" + fieldName, fieldType);
} catch (NoSuchMethodException e) {
try {
withMethod = tc.getMethod("set" + fieldName, fieldType);
} catch (NoSuchMethodException e2) {
continue;
}
}
Method sourceGetMethod = null;
try {
sourceGetMethod = sc.getMethod("get" + fieldName);
} catch (NoSuchMethodException e) {
continue;
}
try {
if( targetGetMethod.invoke(targetValues) == null ) {
withMethod.invoke(targetValues, sourceGetMethod.invoke(defaultValues));
}
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
} catch (InvocationTargetException e) {
throw new RuntimeException(e.getCause());
}
}
}
private static final HashSet> SIMPLE_FIELD_TYPES = new HashSet<>();
static {
SIMPLE_FIELD_TYPES.add(String.class);
SIMPLE_FIELD_TYPES.add(Double.class);
SIMPLE_FIELD_TYPES.add(Float.class);
SIMPLE_FIELD_TYPES.add(Long.class);
SIMPLE_FIELD_TYPES.add(Integer.class);
SIMPLE_FIELD_TYPES.add(Short.class);
SIMPLE_FIELD_TYPES.add(Character.class);
SIMPLE_FIELD_TYPES.add(Byte.class);
SIMPLE_FIELD_TYPES.add(double.class);
SIMPLE_FIELD_TYPES.add(float.class);
SIMPLE_FIELD_TYPES.add(long.class);
SIMPLE_FIELD_TYPES.add(int.class);
SIMPLE_FIELD_TYPES.add(short.class);
SIMPLE_FIELD_TYPES.add(char.class);
SIMPLE_FIELD_TYPES.add(byte.class);
}
private void mergePodSpec(PodSpecBuilder builder, PodSpec defaultPodSpec, String defaultName) {
List containers = builder.getContainers();
List defaultContainers = defaultPodSpec.getContainers();
int size = defaultContainers.size();
if (size > 0) {
if (containers == null || containers.isEmpty()) {
builder.addToContainers(defaultContainers.toArray(new Container[size]));
} else {
int idx = 0;
for (Container defaultContainer : defaultContainers) {
Container container;
if (idx < containers.size()) {
container = containers.get(idx);
} else {
container = new Container();
containers.add(container);
}
mergeSimpleFields(container, defaultContainer);
List defaultEnv = defaultContainer.getEnv();
if (defaultEnv != null) {
for (EnvVar envVar : defaultEnv) {
ensureHasEnv(container, envVar);
}
}
List defaultPorts = defaultContainer.getPorts();
if (defaultPorts != null) {
for (ContainerPort port : defaultPorts) {
ensureHasPort(container, port);
}
}
if (container.getReadinessProbe()==null) {
container.setReadinessProbe(defaultContainer.getReadinessProbe());
}
if (container.getLivenessProbe()==null) {
container.setLivenessProbe(defaultContainer.getLivenessProbe());
}
if (container.getSecurityContext()==null) {
container.setSecurityContext(defaultContainer.getSecurityContext());
}
idx++;
}
builder.withContainers(containers);
}
} else if (!containers.isEmpty()) {
// lets default the container name if there's none specified in the custom yaml file
Container container = containers.get(0);
if (isNullOrBlank(container.getName())) {
container.setName(defaultName);
}
builder.withContainers(containers);
}
}
private void ensureHasEnv(Container container, EnvVar envVar) {
List envVars = container.getEnv();
if (envVars == null) {
envVars = new ArrayList<>();
container.setEnv(envVars);
}
for (EnvVar var : envVars) {
if (Objects.equals(var.getName(), envVar.getName())) {
return;
}
}
envVars.add(envVar);
}
private void ensureHasPort(Container container, ContainerPort port) {
List ports = container.getPorts();
if (ports == null) {
ports = new ArrayList<>();
container.setPorts(ports);
}
for (ContainerPort cp : ports) {
String n1 = cp.getName();
String n2 = port.getName();
if (n1 != null && n2 != null && n1.equals(n2)) {
return;
}
Integer p1 = cp.getContainerPort();
Integer p2 = port.getContainerPort();
if (p1 != null && p2 != null && p1.intValue() == p2.intValue()) {
return;
}
}
ports.add(port);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy