Split Kubernetes features from Kubernetes config. Fixes #355 (#356)

micronaut-projects · Jul 27, 2020 · 19a41a0 · 19a41a0
1 parent e1e1d92
commit 19a41a0
Show file tree

Hide file tree

Showing 4 changed files with 119 additions and 12 deletions.
diff --git a/starter-core/src/main/java/io/micronaut/starter/feature/Category.java b/starter-core/src/main/java/io/micronaut/starter/feature/Category.java
@@ -25,6 +25,7 @@ public class Category {
     public static final String API                  = "API";
     public static final String IOT                  = "Internet of Things";
     public static final String CACHE                = "Cache";
+    public static final String CLOUD                = "Cloud";
     public static final String RESILIENCE           = "Resilience";
     public static final String CONFIGURATION        = "Configuration";
     public static final String DATABASE             = "Database";

diff --git a/...r-core/src/main/java/io/micronaut/starter/feature/distributedconfig/KubernetesConfig.java b/...r-core/src/main/java/io/micronaut/starter/feature/distributedconfig/KubernetesConfig.java
@@ -0,0 +1,76 @@
+/*
+ * Copyright 2020 original authors
+ *
+ * Licensed 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.micronaut.starter.feature.distributedconfig;
+
+import javax.inject.Singleton;
+
+import io.micronaut.starter.application.ApplicationType;
+import io.micronaut.starter.application.generator.GeneratorContext;
+import io.micronaut.starter.feature.FeatureContext;
+import io.micronaut.starter.feature.k8s.Kubernetes;
+
+/**
+ * Adds support for Kubernetes config maps configuration.
+ *
+ * @author alvaro
+ * @since 2.0.0
+ */
+@Singleton
+public class KubernetesConfig implements DistributedConfigFeature {
+
+    private final Kubernetes kubernetes;
+
+    public KubernetesConfig(Kubernetes kubernetes) {
+        this.kubernetes = kubernetes;
+    }
+
+    @Override
+    public String getName() {
+        return "config-kubernetes";
+    }
+
+    @Override
+    public String getTitle() {
+        return "Kubernetes Distributed Configuration";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Adds support for Distributed Configuration with Kubernetes ConfigMap";
+    }
+
+    @Override
+    public void processSelectedFeatures(FeatureContext featureContext) {
+        if (!featureContext.isPresent(Kubernetes.class)) {
+            featureContext.addFeature(kubernetes);
+        }
+    }
+
+    @Override
+    public boolean supports(ApplicationType applicationType) {
+        return applicationType != ApplicationType.CLI && applicationType != ApplicationType.FUNCTION;
+    }
+
+    @Override
+    public void apply(GeneratorContext generatorContext) {
+        generatorContext.getBootstrapConfig().put("micronaut.config-client.enabled", true);
+    }
+
+    @Override
+    public String getMicronautDocumentation() {
+        return "https://micronaut-projects.github.io/micronaut-kubernetes/latest/guide/index.html";
+    }
+}
diff --git a/...feature/distributedconfig/Kubernetes.java → ...onaut/starter/feature/k8s/Kubernetes.java b/...feature/distributedconfig/Kubernetes.java → ...onaut/starter/feature/k8s/Kubernetes.java
@@ -13,45 +13,60 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micronaut.starter.feature.distributedconfig;
+package io.micronaut.starter.feature.k8s;
 
+import javax.inject.Singleton;
+
+import edu.umd.cs.findbugs.annotations.NonNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import io.micronaut.starter.application.ApplicationType;
 import io.micronaut.starter.application.generator.GeneratorContext;
+import io.micronaut.starter.feature.Category;
+import io.micronaut.starter.feature.Feature;
 import io.micronaut.starter.feature.FeatureContext;
 import io.micronaut.starter.feature.distributedconfig.template.k8sYaml;
 import io.micronaut.starter.feature.jib.Jib;
 import io.micronaut.starter.feature.other.Management;
 import io.micronaut.starter.template.RockerTemplate;
 
-import javax.inject.Singleton;
-
+/**
+ * Adds Kubernetes configuration to an application.
+ *
+ * @author graemerocher
+ * @since 2.0.1
+ */
 @Singleton
-public class Kubernetes implements DistributedConfigFeature {
+public class Kubernetes implements Feature {
 
     private final Jib jib;
     private final Management management;
 
-    public Kubernetes(Management management, Jib jib) {
-        this.management = management;
+    public Kubernetes(Jib jib, Management management) {
         this.jib = jib;
+        this.management = management;
     }
 
+    @NonNull
     @Override
     public String getName() {
-        return "config-kubernetes";
+        return "kubernetes";
     }
 
     @Override
     public String getTitle() {
-        return "Kubernetes Distributed Configuration";
+        return "Kubernetes Support";
     }
 
     @Override
     public String getDescription() {
-        return "Adds support for Distributed Configuration with Kubernetes ConfigMap";
+        return "Generates a k8s deployment descriptor for deployment to Kubernetes";
     }
 
     @Override
+    public String getCategory() {
+        return Category.CLOUD;
+    }
+
     public void processSelectedFeatures(FeatureContext featureContext) {
         if (!featureContext.isPresent(Management.class)) {
             featureContext.addFeature(management);
@@ -63,17 +78,23 @@ public void processSelectedFeatures(FeatureContext featureContext) {
 
     @Override
     public void apply(GeneratorContext generatorContext) {
-        generatorContext.getBootstrapConfig().put("micronaut.config-client.enabled", true);
         generatorContext.addTemplate("k8sYaml", new RockerTemplate("k8s.yml", k8sYaml.template(generatorContext.getProject())));
     }
 
     @Override
     public boolean supports(ApplicationType applicationType) {
-        return applicationType == ApplicationType.DEFAULT;
+        return applicationType == ApplicationType.DEFAULT || applicationType == ApplicationType.GRPC;
     }
 
+    @Nullable
     @Override
     public String getMicronautDocumentation() {
         return "https://micronaut-projects.github.io/micronaut-kubernetes/latest/guide/index.html";
     }
+
+    @Nullable
+    @Override
+    public String getThirdPartyDocumentation() {
+        return "https://kubernetes.io/docs/home/";
+    }
 }
diff --git a/...e/distributedconfig/KubernetesSpec.groovy → ...ributedconfig/KubernetesConfigSpec.groovy b/...e/distributedconfig/KubernetesSpec.groovy → ...ributedconfig/KubernetesConfigSpec.groovy
@@ -9,7 +9,7 @@ import io.micronaut.starter.fixture.CommandOutputFixture
 import io.micronaut.starter.options.Language
 import spock.lang.Unroll
 
-class KubernetesSpec extends BeanContextSpec  implements CommandOutputFixture {
+class KubernetesConfigSpec extends BeanContextSpec  implements CommandOutputFixture {
 
     void 'test readme.md with feature kubernetes contains links to micronaut docs'() {
         when:
@@ -63,4 +63,13 @@ class KubernetesSpec extends BeanContextSpec  implements CommandOutputFixture {
         commandContext.templates.get('k8sYaml')
     }
 
+
+    void 'test kubernetes no distributed config'() {
+        when:
+        GeneratorContext commandContext = buildGeneratorContext(['kubernetes'])
+
+        then:
+        commandContext.bootstrapConfig.get('micronaut.config-client.enabled'.toString()) == null
+        commandContext.templates.get('k8sYaml')
+    }
 }