Merge pull request #23 from bdpiparva/mandate-cluster-cacert

WIP: Different api authentication strategies for plugin

Author: varshavaradarajan

src/main/java/cd/go/contrib/elasticagent/KubernetesAgentInstances.java

@@ -34,6 +34,7 @@
 import static cd.go.contrib.elasticagent.KubernetesPlugin.LOG;
 import static cd.go.contrib.elasticagent.executors.GetProfileMetadataExecutor.SPECIFIED_USING_POD_CONFIGURATION;
 import static cd.go.contrib.elasticagent.utils.Util.getSimpleDateFormat;
+import static java.text.MessageFormat.format;
 
 public class KubernetesAgentInstances implements AgentInstances<KubernetesInstance> {
     private final ConcurrentHashMap<String, KubernetesInstance> instances = new ConcurrentHashMap<>();
@@ -58,14 +59,14 @@ public KubernetesAgentInstances(KubernetesClientFactory factory, KubernetesInsta
 
     @Override
     public KubernetesInstance create(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest) throws Exception {
-        final Integer maxAllowedContainers = settings.getMaximumPendingAgentsCount();
+        final Integer maxAllowedContainers = settings.getMaxPendingPods();
         synchronized (instances) {
             doWithLockOnSemaphore(new SetupSemaphore(maxAllowedContainers, instances, semaphore));
 
             if (semaphore.tryAcquire()) {
                 return createKubernetesInstance(request, settings, pluginRequest);
             } else {
-                LOG.warn(String.format("The number of pending kubernetes pods is currently at the maximum permissible limit (%d). Total kubernetes pods (%d). Not creating any more containers.", maxAllowedContainers, instances.size()));
+                LOG.warn(format("The number of pending kubernetes pods is currently at the maximum permissible limit ({0}). Total kubernetes pods ({1}). Not creating any more containers.", maxAllowedContainers, instances.size()));
                 return null;
             }
         }
@@ -77,14 +78,14 @@ private void doWithLockOnSemaphore(Runnable runnable) {
         }
     }
 
-    private KubernetesInstance createKubernetesInstance(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest) throws Exception {
+    private KubernetesInstance createKubernetesInstance(CreateAgentRequest request, PluginSettings settings, PluginRequest pluginRequest) {
         JobIdentifier jobIdentifier = request.jobIdentifier();
         if (isAgentCreatedForJob(jobIdentifier.getJobId())) {
-            LOG.warn("[Create Agent Request] Request for creating an agent for Job Identifier [" + jobIdentifier + "] has already been scheduled. Skipping current request.");
+            LOG.warn(format("[Create Agent Request] Request for creating an agent for Job Identifier [{0}] has already been scheduled. Skipping current request.", jobIdentifier));
             return null;
         }
 
-        KubernetesClient client = factory.kubernetes(settings);
+        KubernetesClient client = factory.client(settings);
         KubernetesInstance instance = kubernetesInstanceFactory.create(request, settings, client, pluginRequest, isUsingPodYaml(request));
         register(instance);
 
@@ -109,10 +110,10 @@ private boolean isUsingPodYaml(CreateAgentRequest request) {
     public void terminate(String agentId, PluginSettings settings) throws Exception {
         KubernetesInstance instance = instances.get(agentId);
         if (instance != null) {
-            KubernetesClient client = factory.kubernetes(settings);
+            KubernetesClient client = factory.client(settings);
             instance.terminate(client);
         } else {
-            LOG.warn("Requested to terminate an instance that does not exist " + agentId);
+            LOG.warn(format("Requested to terminate an instance that does not exist {0}.", agentId));
         }
         instances.remove(agentId);
     }
@@ -124,7 +125,7 @@ public void terminateUnregisteredInstances(PluginSettings settings, Agents agent
             return;
         }
 
-        LOG.warn("Terminating instances that did not register " + toTerminate.instances.keySet());
+        LOG.warn(format("Terminating instances that did not register {0}.", toTerminate.instances.keySet()));
         for (KubernetesInstance container : toTerminate.instances.values()) {
             terminate(container.name(), settings);
         }
@@ -147,9 +148,9 @@ public Agents instancesCreatedAfterTimeout(PluginSettings settings, Agents agent
     }
 
     @Override
-    public void refreshAll(PluginRequest pluginRequest) throws Exception {
-        LOG.debug("[Refresh Instances]. Syncing k8s elastic agent pod information");
-        KubernetesClient client = factory.kubernetes(pluginRequest.getPluginSettings());
+    public void refreshAll(PluginRequest pluginRequest) {
+        LOG.debug("[Refresh Instances]. Syncing k8s elastic agent pod information.");
+        KubernetesClient client = factory.client(pluginRequest.getPluginSettings());
         PodList list = client.pods().inNamespace(Constants.KUBERNETES_NAMESPACE).list();
 
         for (Pod pod : list.getItems()) {
@@ -174,7 +175,7 @@ private void register(KubernetesInstance instance) {
     private KubernetesAgentInstances unregisteredAfterTimeout(PluginSettings settings, Agents knownAgents) throws Exception {
         Period period = settings.getAutoRegisterPeriod();
         KubernetesAgentInstances unregisteredInstances = new KubernetesAgentInstances();
-        KubernetesClient client = factory.kubernetes(settings);
+        KubernetesClient client = factory.client(settings);
 
         for (String instanceName : instances.keySet()) {
             if (knownAgents.containsAgentWithId(instanceName)) {

src/main/java/cd/go/contrib/elasticagent/KubernetesClientFactory.java

@@ -16,11 +16,12 @@
 
 package cd.go.contrib.elasticagent;
 
-import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.ConfigBuilder;
 import io.fabric8.kubernetes.client.DefaultKubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClient;
-import org.apache.commons.lang3.StringUtils;
+
+import static cd.go.contrib.elasticagent.KubernetesPlugin.LOG;
+import static java.text.MessageFormat.format;
 
 public class KubernetesClientFactory {
     private static final KubernetesClientFactory KUBERNETES_CLIENT_FACTORY = new KubernetesClientFactory();
@@ -31,31 +32,26 @@ public static KubernetesClientFactory instance() {
         return KUBERNETES_CLIENT_FACTORY;
     }
 
-    private static KubernetesClient createClient(PluginSettings pluginSettings) throws Exception {
-        ConfigBuilder configBuilder = new ConfigBuilder().withMasterUrl(pluginSettings.getKubernetesClusterUrl());
-        if (StringUtils.isNotBlank(pluginSettings.getKubernetesClusterUsername())) {
-            configBuilder.withUsername(pluginSettings.getKubernetesClusterUsername());
-        }
-
-        if (StringUtils.isNotBlank(pluginSettings.getKubernetesClusterPassword())) {
-            configBuilder.withPassword(pluginSettings.getKubernetesClusterPassword());
-        }
-
-        if (StringUtils.isNotBlank(pluginSettings.getKubernetesClusterCACert())) {
-            configBuilder.withCaCertData(pluginSettings.getKubernetesClusterCACert());
-        }
-
-        Config build = configBuilder.build();
-        return new DefaultKubernetesClient(build);
-    }
-
-    public synchronized KubernetesClient kubernetes(PluginSettings pluginSettings) throws Exception {
+    public synchronized KubernetesClient client(PluginSettings pluginSettings) {
         if (pluginSettings.equals(this.pluginSettings) && this.client != null) {
+            LOG.debug("Using previously created client.");
             return this.client;
         }
 
+        LOG.debug(format("Creating a new client because {0}.", (client == null) ? "client is null" : "plugin setting is changed"));
         this.pluginSettings = pluginSettings;
-        this.client = createClient(pluginSettings);
+        this.client = createClientFor(pluginSettings);
+        LOG.debug("New client is created.");
         return this.client;
     }
+
+    private KubernetesClient createClientFor(PluginSettings pluginSettings) {
+        final ConfigBuilder configBuilder = new ConfigBuilder()
+                .withOauthToken(pluginSettings.getOauthToken())
+                .withMasterUrl(pluginSettings.getClusterUrl())
+                .withCaCertData(pluginSettings.getCaCertData());
+
+        return new DefaultKubernetesClient(configBuilder.build())
+                .inNamespace(pluginSettings.getNamespace());
+    }
 }

src/main/java/cd/go/contrib/elasticagent/KubernetesInstanceFactory.java

@@ -41,8 +41,8 @@
 import static cd.go.contrib.elasticagent.executors.GetProfileMetadataExecutor.PRIVILEGED;
 import static cd.go.contrib.elasticagent.utils.Util.GSON;
 import static cd.go.contrib.elasticagent.utils.Util.getSimpleDateFormat;
-import static java.lang.String.format;
 import static java.lang.String.valueOf;
+import static java.text.MessageFormat.format;
 import static org.apache.commons.lang3.StringUtils.isBlank;
 
 public class KubernetesInstanceFactory {
@@ -55,7 +55,7 @@ public KubernetesInstance create(CreateAgentRequest request, PluginSettings sett
     }
 
     private KubernetesInstance create(CreateAgentRequest request, PluginSettings settings, KubernetesClient client, PluginRequest pluginRequest) {
-        String containerName = format("%s-%s", KUBERNETES_POD_NAME_PREFIX, UUID.randomUUID().toString());
+        String containerName = format("{0}-{1}", KUBERNETES_POD_NAME_PREFIX, UUID.randomUUID().toString());
 
         Container container = new Container();
         container.setName(containerName);
@@ -101,13 +101,13 @@ private ResourceRequirements getPodResources(CreateAgentRequest request) {
         String maxMemory = request.properties().get("MaxMemory");
         if (StringUtils.isNotBlank(maxMemory)) {
             Size mem = Size.parse(maxMemory);
-            LOG.debug(format("[Create Agent] Setting memory resource limit on k8s pod:%s", new Quantity(valueOf(mem.toMegabytes()), "M")));
+            LOG.debug(format("[Create Agent] Setting memory resource limit on k8s pod: {0}.", new Quantity(valueOf(mem.toMegabytes()), "M")));
             limits.put("memory", new Quantity(valueOf(mem.toBytes())));
         }
 
         String maxCPU = request.properties().get("MaxCPU");
         if (StringUtils.isNotBlank(maxCPU)) {
-            LOG.debug(format("[Create Agent] Setting cpu resource limit on k8s pod:%s", new Quantity(maxCPU)));
+            LOG.debug(format("[Create Agent] Setting cpu resource limit on k8s pod: {0}.", new Quantity(maxCPU)));
             limits.put("cpu", new Quantity(maxCPU));
         }
 
@@ -130,7 +130,7 @@ private static void setAnnotations(Pod pod, CreateAgentRequest request) {
     }
 
     private KubernetesInstance createKubernetesPod(KubernetesClient client, Pod elasticAgentPod) {
-        LOG.info(format("[Create Agent] Creating K8s pod with spec:%s", elasticAgentPod.toString()));
+        LOG.info(format("[Create Agent] Creating K8s pod with spec: {0}.", elasticAgentPod.toString()));
         Pod pod = client.pods().inNamespace(KUBERNETES_NAMESPACE).create(elasticAgentPod);
         return fromKubernetesPod(pod);
     }

src/main/java/cd/go/contrib/elasticagent/KubernetesPlugin.java

@@ -35,7 +35,7 @@ public class KubernetesPlugin implements GoPlugin {
     public static final Logger LOG = Logger.getLoggerFor(KubernetesPlugin.class);
 
     private PluginRequest pluginRequest;
-    private AgentInstances agentInstances;
+    private AgentInstances<KubernetesInstance> agentInstances;
 
     @Override
     public void initializeGoApplicationAccessor(GoApplicationAccessor accessor) {

src/main/java/cd/go/contrib/elasticagent/PluginRequest.java

@@ -25,6 +25,7 @@
 
 import static cd.go.contrib.elasticagent.Constants.*;
 import static cd.go.contrib.elasticagent.KubernetesPlugin.LOG;
+import static java.text.MessageFormat.format;
 
 public class PluginRequest {
     private final GoApplicationAccessor accessor;
@@ -52,10 +53,11 @@ public PluginSettings getPluginSettings() throws ServerRequestFailedException {
             throw ServerRequestFailedException.getPluginSettings(response);
         }
 
-        final PluginSettings pluginSettings = PluginSettings.fromJSON(response.responseBody());
+        PluginSettings pluginSettings = PluginSettings.fromJSON(response.responseBody());
         if (pluginSettings == null) {
             throw new PluginSettingsNotConfiguredException();
         }
+
         return pluginSettings;
     }
 
@@ -71,7 +73,7 @@ public Agents listAgents() throws ServerRequestFailedException {
     }
 
     public void disableAgents(Collection<Agent> toBeDisabled) throws ServerRequestFailedException {
-        LOG.debug("[Server Ping] Disabling Agents:"+toBeDisabled.toString());
+        LOG.debug(format("[Server Ping] Disabling Agents: {0}", toBeDisabled.toString()));
         if (toBeDisabled.isEmpty()) {
             return;
         }
@@ -87,7 +89,7 @@ public void disableAgents(Collection<Agent> toBeDisabled) throws ServerRequestFa
     }
 
     public void deleteAgents(Collection<Agent> toBeDeleted) throws ServerRequestFailedException {
-        LOG.debug("[Server Ping] Deleting Agents:"+toBeDeleted.toString());
+        LOG.debug(format("[Server Ping] Deleting Agents: {0}", toBeDeleted.toString()));
         if (toBeDeleted.isEmpty()) {
             return;
         }