Skip to content

Commit

Permalink
Create routes in openshift with the same pattern than the urls provid…
Browse files Browse the repository at this point in the history 
…ed by naming strategy (eclipse-che#5879)

* Create routes in openshift with the same pattern than the urls provided by the naming strategy.
Also it will be able to handle service name described through labels on Docker image.

It means that for one image 8080 port can be tomcat, but for another image it can be named "vertx" or default value if not specified

Change-Id: Ie8e0a09d0be8f6d042f542a76c146e2bbe266fc7
Signed-off-by: Florent BENOIT <fbenoit@redhat.com>
  • Loading branch information
@benoitf
benoitf authored Aug 3, 2017
1 parent 5f52277 commit 5bbbf9c
Show file tree
Hide file tree
Showing 6 changed files with 133 additions and 68 deletions.
37 changes: 0 additions & 37 deletions ...enshift-client/src/main/java/org/eclipse/che/plugin/openshift/client/CheServicePorts.java
View file

This file was deleted.

120 changes: 101 additions & 19 deletions ...hift-client/src/main/java/org/eclipse/che/plugin/openshift/client/OpenShiftConnector.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@
import io.fabric8.openshift.client.OpenShiftClient;
import io.fabric8.openshift.client.dsl.DeployableScalableResource;

import com.google.common.collect.ImmutableSet;

import org.eclipse.che.api.core.notification.EventService;
import org.eclipse.che.api.core.notification.EventSubscriber;
import org.eclipse.che.api.workspace.server.event.ServerIdleEvent;
Expand All @@ -77,6 +79,7 @@
import org.eclipse.che.plugin.docker.client.json.Event;
import org.eclipse.che.plugin.docker.client.json.Filters;
import org.eclipse.che.plugin.docker.client.json.HostConfig;
import org.eclipse.che.plugin.docker.client.json.ImageConfig;
import org.eclipse.che.plugin.docker.client.json.ImageInfo;
import org.eclipse.che.plugin.docker.client.json.NetworkCreated;
import org.eclipse.che.plugin.docker.client.json.NetworkSettings;
Expand Down Expand Up @@ -134,7 +137,6 @@
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
Expand All @@ -143,6 +145,8 @@
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;

Expand Down Expand Up @@ -188,6 +192,12 @@ public class OpenShiftConnector extends DockerConnector {
private static final String IDLING_ALPHA_OPENSHIFT_IO_UNIDLE_TARGETS = "idling.alpha.openshift.io/unidle-targets";
private static final String ISO_8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ssX";

/**
* Regexp to extract port (under the form 22/tcp or 4401/tcp, etc.) from label references
*/
public static final String LABEL_CHE_SERVER_REF_KEY = "^che:server:(.*):ref$";


private Map<String, KubernetesExecHolder> execMap = new HashMap<>();

private final String openShiftCheProjectName;
Expand Down Expand Up @@ -301,6 +311,83 @@ private void idleCheServer(ServerIdleEvent event) {
}
}

/**
* Gets exposed ports for both container and image.
*
* @param containerConfig
* the configuration of the container
* @param imageConfig
* the configuration of the image
* @return all exposed ports
*/
protected Set<String> getExposedPorts(ContainerConfig containerConfig, ImageConfig imageConfig) {

Set<String> containerExposedPorts = containerConfig.getExposedPorts().keySet();
Set<String> imageExposedPorts = imageConfig.getExposedPorts().keySet();
return ImmutableSet.<String>builder().addAll(containerExposedPorts)
.addAll(imageExposedPorts)
.build();

}

/**
* Gets labels for both container and image.
*
* @param containerConfig
* the configuration of the container
* @param imageConfig
* the configuration of the image
* @return all labels found
*/
protected Map<String, String> getLabels(ContainerConfig containerConfig, ImageConfig imageConfig) {

// first, get labels defined in the container configuration
Map<String, String> containerLabels = containerConfig.getLabels();

// Also, get labels from the image itself
Map<String, String> imageLabels = imageConfig.getLabels();

// Now merge all labels
final Map<String, String> allLabels = new HashMap<>(containerLabels);
allLabels.putAll(imageLabels);
return allLabels;
}

/**
* Gets the mapping between the port (with format 8080/tcp) and the associated label (if found)
*
* @param labels
* the mapping for known port labels
* @param exposedPorts
* the ports that are exposed
* @return a map that allow to get the service name for a given exposed port
*/
protected Map<String, String> getPortsToRefName(Map<String, String> labels, Set<String> exposedPorts) {

// Ports to known/unknown ref is map like : 8080/tcp <--> myCustomLabel
Pattern pattern = Pattern.compile(LABEL_CHE_SERVER_REF_KEY);
Map<String, String> portsToKnownRefName = labels.entrySet().stream()
.filter(map -> pattern.matcher(map.getKey()).matches())
.collect(Collectors.toMap(p -> {
Matcher matcher = pattern.matcher(p.getKey());
matcher.matches();
String val = matcher.group(1);
return val.contains("/") ? val : val.concat("/tcp");
}, p -> p.getValue()));

// add to this map only port without a known ref name
Map<String, String> portsToUnkownRefName =
exposedPorts.stream().filter((port) -> !portsToKnownRefName.containsKey(port))
.collect(Collectors.toMap(p -> p, p -> "server-" + p.replace('/', '-')));

// list of all ports with refName (known/unknown)
Map<String, String> portsToRefName = new HashMap(portsToKnownRefName);
portsToRefName.putAll(portsToUnkownRefName);

return portsToRefName;

}

/**
* @param createContainerParams
* @return
Expand Down Expand Up @@ -346,10 +433,12 @@ public ContainerCreated createContainer(CreateContainerParams createContainerPar
openShiftCheProjectName,
imageStreamTagPullSpec);

Set<String> containerExposedPorts = createContainerParams.getContainerConfig().getExposedPorts().keySet();
Set<String> imageExposedPorts = inspectImage(InspectImageParams.create(imageForDocker))
.getConfig().getExposedPorts().keySet();
Set<String> exposedPorts = getExposedPorts(containerExposedPorts, imageExposedPorts);
ContainerConfig containerConfig = createContainerParams.getContainerConfig();
ImageConfig imageConfig = inspectImage(InspectImageParams.create(imageForDocker)).getConfig();

final Set<String> exposedPorts = getExposedPorts(containerConfig, imageConfig);
final Map<String, String> labels = getLabels(containerConfig, imageConfig);
Map<String, String> portsToRefName = getPortsToRefName(labels, exposedPorts);

String[] envVariables = createContainerParams.getContainerConfig().getEnv();
String[] volumes = createContainerParams.getContainerConfig().getHostConfig().getBinds();
Expand Down Expand Up @@ -393,11 +482,12 @@ public ContainerCreated createContainer(CreateContainerParams createContainerPar
String containerID;
OpenShiftClient openShiftClient = new DefaultOpenShiftClient();
try {
createOpenShiftService(deploymentName, serviceName, exposedPorts, additionalLabels, endpointAliases);
createOpenShiftService(deploymentName, serviceName, exposedPorts, portsToRefName, additionalLabels, endpointAliases);
createOpenShiftDeployment(deploymentName,
dockerPullSpec,
containerName,
exposedPorts,
portsToRefName,
envVariables,
volumes,
resourceLimits,
Expand Down Expand Up @@ -1082,10 +1172,11 @@ private boolean isDevMachine(CreateContainerParams createContainerParams) {
private void createOpenShiftService(String deploymentName,
String serviceName,
Set<String> exposedPorts,
Map<String, String> portsToRefName,
Map<String, String> additionalLabels,
String[] endpointAliases) {
Map<String, String> selector = Collections.singletonMap(OPENSHIFT_DEPLOYMENT_LABEL, deploymentName);
List<ServicePort> ports = KubernetesService.getServicePortsFrom(exposedPorts);
List<ServicePort> ports = KubernetesService.getServicePortsFrom(exposedPorts, portsToRefName);

try (OpenShiftClient openShiftClient = new DefaultOpenShiftClient()) {
Service service = openShiftClient
Expand Down Expand Up @@ -1127,6 +1218,7 @@ private void createOpenShiftDeployment(String deploymentName,
String imageName,
String sanitizedContainerName,
Set<String> exposedPorts,
Map<String, String> portsToRefName,
String[] envVariables,
String[] volumes,
Map<String, Quantity> resourceLimits,
Expand All @@ -1146,7 +1238,7 @@ private void createOpenShiftDeployment(String deploymentName,
.withName(sanitizedContainerName)
.withImage(imageName)
.withEnv(KubernetesEnvVar.getEnvFrom(envVariables))
.withPorts(KubernetesContainer.getContainerPortsFrom(exposedPorts))
.withPorts(KubernetesContainer.getContainerPortsFrom(exposedPorts, portsToRefName))
.withImagePullPolicy(OPENSHIFT_IMAGE_PULL_POLICY_IFNOTPRESENT)
.withNewSecurityContext()
.withPrivileged(false)
Expand Down Expand Up @@ -1562,17 +1654,7 @@ private Map<String, List<PortBinding>> getCheServicePorts(Service service) {
return networkSettingsPorts;
}

/**
* @param containerExposedPorts
* @param imageExposedPorts
* @return ports exposed by both image and container
*/
private Set<String> getExposedPorts(Set<String> containerExposedPorts, Set<String> imageExposedPorts) {
Set<String> exposedPorts = new HashSet<>();
exposedPorts.addAll(containerExposedPorts);
exposedPorts.addAll(imageExposedPorts);
return exposedPorts;
}


/**
* @param exposedPorts
Expand Down
6 changes: 3 additions & 3 deletions ...src/main/java/org/eclipse/che/plugin/openshift/client/kubernetes/KubernetesContainer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@

import org.eclipse.che.plugin.docker.client.json.ContainerConfig;
import org.eclipse.che.plugin.docker.client.json.ImageConfig;
import org.eclipse.che.plugin.openshift.client.CheServicePorts;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static com.google.common.base.Strings.isNullOrEmpty;
Expand All @@ -38,15 +38,15 @@ private KubernetesContainer() {
* @param exposedPorts
* @return list of {@link ContainerPort}
*/
public static List<ContainerPort> getContainerPortsFrom(Set<String> exposedPorts) {
public static List<ContainerPort> getContainerPortsFrom(Set<String> exposedPorts, Map<String, String> portsToRefName) {
List<ContainerPort> containerPorts = new ArrayList<>(exposedPorts.size());
for (String exposedPort : exposedPorts) {
String[] portAndProtocol = exposedPort.split("/", 2);
String port = portAndProtocol[0];
String protocol = portAndProtocol[1].toUpperCase();

int portNumber = Integer.parseInt(port);
String portName = CheServicePorts.get().get(portNumber);
String portName = portsToRefName.get(exposedPort);
portName = isNullOrEmpty(portName) ? "server-" + exposedPort.replace("/", "-") : portName;

ContainerPort containerPort = new ContainerPortBuilder().withName(portName).withProtocol(protocol)
Expand Down
6 changes: 3 additions & 3 deletions ...t/src/main/java/org/eclipse/che/plugin/openshift/client/kubernetes/KubernetesService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@

import org.eclipse.che.plugin.docker.client.json.ContainerConfig;
import org.eclipse.che.plugin.docker.client.json.ImageConfig;
import org.eclipse.che.plugin.openshift.client.CheServicePorts;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static com.google.common.base.Strings.isNullOrEmpty;
Expand All @@ -38,15 +38,15 @@ private KubernetesService() {
* @param exposedPorts
* @return list of {@link ServicePort}
*/
public static List<ServicePort> getServicePortsFrom(Set<String> exposedPorts) {
public static List<ServicePort> getServicePortsFrom(Set<String> exposedPorts, Map<String, String> portsToRefName) {
List<ServicePort> servicePorts = new ArrayList<>(exposedPorts.size());
for (String exposedPort : exposedPorts) {
String[] portAndProtocol = exposedPort.split("/", 2);
String port = portAndProtocol[0];
String protocol = portAndProtocol[1];

int portNumber = Integer.parseInt(port);
String portName = CheServicePorts.get().get(portNumber);
String portName = portsToRefName.get(exposedPort);
portName = isNullOrEmpty(portName) ? "server-" + exposedPort.replace("/", "-") : portName;

int targetPortNumber = portNumber;
Expand Down
9 changes: 7 additions & 2 deletions ...test/java/org/eclipse/che/plugin/openshift/client/kubernetes/KubernetesContainerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,12 @@ public void shouldReturnContainerPortFromExposedPortList() {
exposedPorts.add("22/tcp");
exposedPorts.add("4401/tcp");
exposedPorts.add("4403/tcp");
Map<String, String> portsToRefName = new HashMap<>();
portsToRefName.put("8080/tcp", "tomcat");


// When
List<ContainerPort> containerPorts = KubernetesContainer.getContainerPortsFrom(exposedPorts);
List<ContainerPort> containerPorts = KubernetesContainer.getContainerPortsFrom(exposedPorts, portsToRefName);

// Then
List<String> portsAndProtocols = containerPorts.stream().
Expand All @@ -51,9 +54,11 @@ public void shouldReturnContainerPortListFromImageExposedPortList() {
// Given
Map<String, ExposedPort> imageExposedPorts = new HashMap<>();
imageExposedPorts.put("8080/tcp",new ExposedPort());
Map<String, String> portsToRefName = new HashMap<>();
portsToRefName.put("8080/tcp", "tomcat");

// When
List<ContainerPort> containerPorts = KubernetesContainer.getContainerPortsFrom(imageExposedPorts.keySet());
List<ContainerPort> containerPorts = KubernetesContainer.getContainerPortsFrom(imageExposedPorts.keySet(), portsToRefName);

// Then
List<String> portsAndProtocols = containerPorts.stream().
Expand Down
Loading

0 comments on commit 5bbbf9c

Please sign in to comment.