PAYARA-2297 Support Kubernetes Secret Volumes as Config Source

.gitignore

@@ -12,3 +12,4 @@ target/
 gfbuild.log
 /nucleus/payara-modules/requesttracing-core/nbproject/
 nb-configuration.xml
+/nucleus/payara-modules/nucleus-microprofile/config-service/nbproject/

appserver/extras/payara-micro/payara-micro-boot/src/main/resources/MICRO-INF/domain/domain.xml

@@ -196,6 +196,7 @@ Portions Copyright [2016-2017] [Payara Foundation and/or its affiliates]
                 <thread-pool name="http-thread-pool" min-thread-pool-size="10" max-thread-pool-size="200" max-queue-size="4096"></thread-pool>
                 <thread-pool name="thread-pool-1" min-thread-pool-size="2" max-thread-pool-size="200"/>
             </thread-pools>
+            <microprofile-config/>
         </config> 
     </configs>
     <property name="administrative.domain.name" value="domain1"/>

appserver/extras/payara-micro/payara-micro-core/src/main/java/fish/payara/micro/cmd/options/RUNTIME_OPTION.java

@@ -62,6 +62,7 @@ public enum RUNTIME_OPTION {
     addjars(true, new SeparatedFilesValidator(true, true, false, true, true)),
     rootdir(true, new DirectoryValidator(true, true, true)),
     deploymentdir(true, new DirectoryValidator(true, true, false)),
+    secretsdir(true,new DirectoryValidator(true, true, false)),
     domainconfig(true, new FileValidator(true, true, true)),
     minhttpthreads(true, new IntegerValidator(1, Integer.MAX_VALUE)),
     maxhttpthreads(true, new IntegerValidator(2, Integer.MAX_VALUE)),

appserver/extras/payara-micro/payara-micro-core/src/main/java/fish/payara/micro/impl/PayaraMicroImpl.java

@@ -168,6 +168,7 @@ public class PayaraMicroImpl implements PayaraMicroBoot {
     private String postBootFileName;
     private String postDeployFileName;
     private RuntimeDirectory runtimeDir = null;
+    private String secretsDir;
 
     /**
      * Runs a Payara Micro server used via java -jar payara-micro.jar
@@ -984,6 +985,7 @@ public PayaraMicroRuntime bootStrap() throws BootstrapException {
             configurePhoneHome();
             configureNotificationService();
             configureHealthCheck();
+            configureSecrets();
 
             // Add additional libraries
             addLibraries();
@@ -1300,6 +1302,9 @@ else if (requestTracing[0].matches("\\D+")) {
                     case postdeploycommandfile:
                         postDeployFileName = value;
                         break;
+                    case secretsdir:
+                        secretsDir = value;
+                        break;
                     default:
                         break;
                 }
@@ -1979,6 +1984,7 @@ private void setArgumentsFromSystemProperties() {
         enableRequestTracing = getBooleanProperty("payaramicro.enableRequestTracing");
         requestTracingThresholdUnit = getProperty("payaramicro.requestTracingThresholdUnit", "SECONDS");
         requestTracingThresholdValue = getLongProperty("payaramicro.requestTracingThresholdValue", 30L);
+        secretsDir = getProperty("payaramicro.secretsDir");
 
         // Set the rootDir file
         String rootDirFileStr = getProperty("payaramicro.rootDir");
@@ -2102,6 +2108,10 @@ private void packageUberJar() {
         if (hzClusterPassword != null) {
             props.setProperty("payaramicro.clusterPassword", hzClusterPassword);
         }
+
+        if (secretsDir != null) {
+            props.setProperty("payaramicro.secretsDir", secretsDir);
+        }
 
         props.setProperty("payaramicro.autoBindHttp", Boolean.toString(autoBindHttp));
         props.setProperty("payaramicro.autoBindSsl", Boolean.toString(autoBindSsl));
@@ -2405,4 +2415,10 @@ public void addLibrary(File lib) {
         }
     }
 
+    private void configureSecrets() {
+        if (secretsDir != null) {
+            preBootCommands.add(new BootCommand("set", "configs.config.server-config.microprofile-config.secret-dir=" + secretsDir));            
+        }
+    }
+
 }

appserver/extras/payara-micro/payara-micro-core/src/main/resources/commandoptions.properties

@@ -85,3 +85,4 @@ instancegroup=Sets the instance group
 group=Sets the instance group
 nested=Do not unpack the Nested Jars when booting the server. This is generally slower than unpacking the runtime.
 unpackdir=Unpack the Nested Jar runtime jars to the specified directory. Default behaviour is to unpack to java.io.tmpdir
+secretsdir=Directory to read secrets files using the Microprofile config api.

nucleus/payara-modules/nucleus-microprofile/config-service/pom.xml

@@ -50,6 +50,15 @@ holder.
     <name>Microprofile Config Service</name>
     <description>Implementation of Microprofile Configuration Service</description>
     <packaging>glassfish-jar</packaging>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.15</version>
+            </plugin>
+        </plugins>
+    </build>
     <dependencies>
         <dependency>
             <groupId>org.glassfish.hk2</groupId>

nucleus/payara-modules/nucleus-microprofile/config-service/src/main/java/fish/payara/nucleus/microprofile/config/admin/GetConfigOrdinal.java

@@ -57,6 +57,7 @@
 
 /**
  * asAdmin command to the get the ordinal for one of the built in Config Sources
+ *
  * @since 4.1.2.173
  * @author Steve Millidge (Payara Foundation)
  */
@@ -65,15 +66,15 @@
 @ExecuteOn(RuntimeType.DAS)
 @TargetType()
 @RestEndpoints({ // creates a REST endpoint needed for integration with the admin interface
-    
+
     @RestEndpoint(configBean = MicroprofileConfigConfiguration.class,
             opType = RestEndpoint.OpType.POST, // must be POST as it is doing an update
             path = "get-config-ordinal",
             description = "Gets the Ordinal of a builtin Config Source")
 })
 public class GetConfigOrdinal implements AdminCommand {
 
-    @Param(optional = true, acceptableValues = "domain,config,server,application,module,cluster,jndi", defaultValue = "domain")
+    @Param(optional = true, acceptableValues = "domain,config,server,application,module,cluster,jndi,secrets", defaultValue = "domain")
     String source;
 
     @Param(optional = true, defaultValue = "server") // if no target is specified it will be the DAS
@@ -112,10 +113,16 @@ public void execute(AdminCommandContext context) {
                 case "cluster": {
                     result = serviceConfig.getClusterOrdinality();
                     break;
-                }case "jndi": {
+                }
+                case "jndi": {
                     result = serviceConfig.getJNDIOrdinality();
                     break;
                 }
+                case "secrets": {
+                    result = serviceConfig.getSecretDirOrdinality();
+                    break;
+                }
+
             }
             context.getActionReport().setMessage(result.toString());
         } else {

nucleus/payara-modules/nucleus-microprofile/config-service/src/main/java/fish/payara/nucleus/microprofile/config/admin/GetConfigSecretsDirectory.java

@@ -0,0 +1,57 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package fish.payara.nucleus.microprofile.config.admin;
+
+import com.sun.enterprise.config.serverbeans.Config;
+import fish.payara.nucleus.microprofile.config.spi.MicroprofileConfigConfiguration;
+import javax.inject.Inject;
+import org.glassfish.api.Param;
+import org.glassfish.api.admin.AdminCommand;
+import org.glassfish.api.admin.AdminCommandContext;
+import org.glassfish.api.admin.ExecuteOn;
+import org.glassfish.api.admin.RestEndpoint;
+import org.glassfish.api.admin.RestEndpoints;
+import org.glassfish.config.support.TargetType;
+import org.glassfish.hk2.api.PerLookup;
+import org.glassfish.internal.api.Target;
+import org.jvnet.hk2.annotations.Service;
+
+/**
+ * asAdmin command to the set the directory for the Secrets Dir Config Source
+ *
+ * @since 4.1.2.181
+ * @author Steve Millidge (Payara Foundation)
+ */
+@Service(name = "get-config-secrets-dir") // the name of the service is the asadmin command name
+@PerLookup // this means one instance is created every time the command is run
+@ExecuteOn()
+@TargetType()
+@RestEndpoints({ // creates a REST endpoint needed for integration with the admin interface
+
+    @RestEndpoint(configBean = MicroprofileConfigConfiguration.class,
+            opType = RestEndpoint.OpType.POST, // must be POST as it is doing an update
+            path = "get-config-secrets-dir",
+            description = "Gets the Secrets Directory for the Secrets Config Source")
+})
+public class GetConfigSecretsDirectory implements AdminCommand {
+
+    @Param(optional = true, defaultValue = "server") // if no target is specified it will be the DAS
+    String target;
+
+    @Inject
+    Target targetUtil;    
+
+    @Override
+    public void execute(AdminCommandContext context) {
+        String result = "Not Found";
+        Config configVal = targetUtil.getConfig(target);
+        MicroprofileConfigConfiguration serviceConfig = configVal.getExtensionByType(MicroprofileConfigConfiguration.class);
+        if (serviceConfig != null) {
+            result = serviceConfig.getSecretDir();
+        }
+        context.getActionReport().setMessage(result);
+    }
+}

nucleus/payara-modules/nucleus-microprofile/config-service/src/main/java/fish/payara/nucleus/microprofile/config/admin/SetConfigOrdinal.java

@@ -59,33 +59,34 @@
 
 /**
  * asAdmin command to the set the ordinal for one of the built in Config Sources
+ *
  * @since 4.1.2.173
  * @author Steve Millidge (Payara Foundation)
  */
 @Service(name = "set-config-ordinal") // the name of the service is the asadmin command name
 @PerLookup // this means one instance is created every time the command is run
-@ExecuteOn() 
+@ExecuteOn()
 @TargetType()
-@RestEndpoints({  // creates a REST endpoint needed for integration with the admin interface
+@RestEndpoints({ // creates a REST endpoint needed for integration with the admin interface
+
     @RestEndpoint(configBean = MicroprofileConfigConfiguration.class,
             opType = RestEndpoint.OpType.POST, // must be POST as it is doing an update
             path = "set-config-ordinal",
             description = "Sets the Ordinal of a builtin Config Source")
 })
 public class SetConfigOrdinal implements AdminCommand {
-    
+
     @Param()
     int ordinal;
-    
-    @Param(optional = true, acceptableValues = "domain,config,server,application,module,cluster,jndi", defaultValue = "domain")
+
+    @Param(optional = true, acceptableValues = "domain,config,server,application,module,cluster,jndi,secrets", defaultValue = "domain")
     String source;
-    
-    @Param (optional = true, defaultValue = "server") // if no target is specified it will be the DAS
+
+    @Param(optional = true, defaultValue = "server") // if no target is specified it will be the DAS
     String target;
-    
+
     @Inject
     Target targetUtil;
-
 
     @Override
     public void execute(AdminCommandContext context) {
@@ -95,11 +96,11 @@ public void execute(AdminCommandContext context) {
             try {
                 // to perform a transaction on the domain.xml you need to use this construct
                 // see https://github.com/hk2-project/hk2/blob/master/hk2-configuration/persistence/hk2-xml-dom/hk2-config/src/main/java/org/jvnet/hk2/config/ConfigSupport.java
-                ConfigSupport.apply(new SingleConfigCode<MicroprofileConfigConfiguration>(){
+                ConfigSupport.apply(new SingleConfigCode<MicroprofileConfigConfiguration>() {
                     @Override
                     public Object run(MicroprofileConfigConfiguration config) {
-                        
-                        switch(source) {
+
+                        switch (source) {
                             case "domain": {
                                 config.setDomainOrdinality(ordinal);
                                 break;
@@ -111,23 +112,27 @@ public Object run(MicroprofileConfigConfiguration config) {
                             case "server": {
                                 config.setServerOrdinality(ordinal);
                                 break;
-                            }                            
+                            }
                             case "application": {
                                 config.setApplicationOrdinality(ordinal);
                                 break;
                             }
                             case "module": {
                                 config.setModuleOrdinality(ordinal);
                                 break;
-                            } 
+                            }
                             case "cluster": {
                                 config.setClusterOrdinality(ordinal);
                                 break;
-                            } 
+                            }
                             case "jndi": {
                                 config.setJNDIOrdinality(ordinal);
                                 break;
-                            } 
+                            }
+                            case "secrets": {
+                                config.setSecretDirOrdinality(ordinal);
+                                break;
+                            }
                         }
                         return null;
                     }
@@ -139,7 +144,7 @@ public Object run(MicroprofileConfigConfiguration config) {
         } else {
             context.getActionReport().failure(Logger.getLogger(SetConfigOrdinal.class.getName()), "No configuration with name " + target);
         }
-        
+
     }
-    
+
 }