ncsa · navarroc · Feb 18, 2023 · Feb 15, 2023 · Feb 17, 2023 · Feb 17, 2023
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -42,7 +42,7 @@ jobs:
 
           # calculate the version and all tags
           if [ "$BRANCH" == "main" ]; then
-            VERSION="$(xpath -q -e 'project/version/text()' pom.xml)"
+            VERSION="$(cat pom.xml | grep "<version>.*</version>" | head -1 |awk -F'[><]' '{print $3}')"
             tags="latest"
             oldversion=""
             tmpversion="${VERSION}"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,14 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+## [4.6.0] - 2023-02-15
 
 ### Added
 - Add GitHub actions to build using maven and docker
+- Kubernetes executor to run jobs on kubernetes cluster [#9](https://github.com/ncsa/datawolf/issues/9)
+- Configuration option to allow administrators to configure datasets as public or private [#16](https://github.com/ncsa/datawolf/issues/16)
 
 ### Changed
-- Updated PostgreSQL jdbc driver to work with version 14
-  [WOLF-301](https://opensource.ncsa.illinois.edu/jira/browse/WOLF-301)
+- Updated PostgreSQL jdbc driver to work with version 14 [WOLF-301](https://opensource.ncsa.illinois.edu/jira/browse/WOLF-301)
 
 ## [4.5.0] - 2021-12-03
 

diff --git a/datawolf-core/pom.xml b/datawolf-core/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-core</artifactId>
 

diff --git a/datawolf-doc/doc/manual/index.html b/datawolf-doc/doc/manual/index.html
@@ -103,7 +103,12 @@
 
 #### HPC Executor
 
-The HPC Executor is a Remote Executor that uses SSH Channels to communicate with various queueing systems for submitting jobs to high performance computers (HPC) such as the [XSEDE](http://www.xsede.org) resources. The remote executor is similar to the command line executor except the execution line (executable, flags, inputs, etc) for the tool are appended to a script and submitted to a queueing system. When creating an HPC tool, an XML definition file with information about the HPC (e.g. location of submit, terminate, and status commands), a script to append the execution line to, and the regular expressions necessary for parsing job status messages, must be provided. The executor will use this information to communicate with the HPC to submit jobs, cancel jobs, get job status, etc. The queueing systems that have been tested with the HPCExecutor include Portable Batch System (PBS), IBM Loadleveler, and Sun Grid Engine (SGE), which was minimally tested. 
+The HPC Executor is a Remote Executor that uses SSH Channels to communicate with various queueing systems for submitting jobs to high performance computers (HPC) such as the [XSEDE](http://www.xsede.org) resources. The remote executor is similar to the command line executor except the execution line (executable, flags, inputs, etc) for the tool are appended to a script and submitted to a queueing system. When creating an HPC tool, an XML definition file with information about the HPC (e.g. location of submit, terminate, and status commands), a script to append the execution line to, and the regular expressions necessary for parsing job status messages, must be provided. The executor will use this information to communicate with the HPC to submit jobs, cancel jobs, get job status, etc. The queueing systems that have been tested with the HPCExecutor include Portable Batch System (PBS), IBM Loadleveler, and Sun Grid Engine (SGE), which was minimally tested.
+
+#### Kubernetes Executor
+The Kubernetes Executor is a Remote Executor that can run workflow tools using available Kubernetes cluster resources where DataWolf is running. The executor handles communicating with a Kubernetes cluster using the
+Kubernetes Java Client. Using the client API, DataWolf creates jobs on the cluster, sets up the job for execution, and runs the job. While the job is running the executor communicates with the cluster to check job
+status and fetches results from the job when it's finished.
 
 ### REST Interface
 Data Wolf provides a thin service layer that wraps around the Data Wolf Engine and exposes all primary functionality through a REST API that clients can program against. Below are all of Data Wolf's REST endpoints and a brief description about them. For a more information on how to use each endpoint, please see the javadoc associated with the service layer. If you are interested in an example that uses the the REST API, checkout the source code for the web editor. Instructions are included in the Source Code section.
@@ -242,18 +247,18 @@
 
 https://opensource.ncsa.illinois.edu/projects/artifacts.php?key=WOLF
 
-By default, the latest release is selected in the page (currently 4.5.0). To get early access to development releases, check the box **Show also prereleases.**
+By default, the latest release is selected in the page (currently 4.6.0). To get early access to development releases, check the box **Show also prereleases.**
 
 * Click on **Version** 
-    * Select **4.5.0**
-    * Under **Files** select **datawolf-webapp-all-4.5.0-bin.zip**
+    * Select **4.6.0**
+    * Under **Files** select **datawolf-webapp-all-4.6.0-bin.zip**
 * Click **I Accept** to accept the License.
 
 This will give you the latest stable build that includes both the Data Wolf Server and the Web Editor. You can also find links to the javacode there as well as the manual. The link to the source code can be found at the end of this document.
 
 ### Installation and Setup
 
-To install the files necessary for the Server and Editor, find where you downloaded Data Wolf and unzip it somewhere. This will create a folder called **datawolf-webapp-all-4.5.0**. In the next few sections, we'll discuss some of the important files that come with the installation you just unzipped so you can tailor your setup to meet your needs. If you wish to skip this, you can go directly to the section **Running Data Wolf Server and Editor**.
+To install the files necessary for the Server and Editor, find where you downloaded Data Wolf and unzip it somewhere. This will create a folder called **datawolf-webapp-all-4.6.0**. In the next few sections, we'll discuss some of the important files that come with the installation you just unzipped so you can tailor your setup to meet your needs. If you wish to skip this, you can go directly to the section **Running Data Wolf Server and Editor**.
 
 #### Data Wolf properties
 
@@ -293,6 +298,7 @@
 java.executor=edu.illinois.ncsa.datawolf.executor.java.JavaExecutor
 commandline.executor=edu.illinois.ncsa.datawolf.executor.commandline.CommandLineExecutor
 hpc.executor=edu.illinois.ncsa.datawolf.executor.hpc.HPCExecutor
+kubernetes.executor=edu.illinois.ncsa.datawolf.executor.kubernetes.KubernetesExecutor
 
 # Initial admins for the DataWolf server, this is a comma separated list of 
 # email addresses who will automatically get active accounts with admin access 
@@ -414,12 +420,30 @@
 ldap.trustAllCertificates=false
 ```
 
+To configure the kubernetes executor, you will need to provide some configuration values. These provide some default parameters for running jobs (e.g. 2 cpu, 4 gb memory, mount a data volume at /data, etc).
+Below is a snippet from the datawolf properties file with an example configuration:
+
+```
+kubernetes.namespace=some-namespace
+kubernetes.pvc=mypvc
+kubernetes.data=/data/
+kubernetes.cpu=2
+kubernetes.memory=4
+```
+
+By default, DataWolf datasets are only visible to the creator. For cases where you want to allow all authenticated user to see each other's data, you can set the permission to public. Below is the default. If you
+replace private with public all data will be visible to authenticated users (if USE_AUTH is on) or anyone if authentication is set to false.
+
+```
+dataset.permissions=private
+```
+
 In the same folder at **datawolf.properties** is a **custom.properties** file that can also be used to override parameters set in **datawolf.properties**. The
 next section will discuss the launch script for Data Wolf.
 
 #### Launch Scripts
 
-If you go back to the folder **Data Wolf-webapp-all-4.5.0** you will see a sub-folder called **bin**, open this. Inside you will find two scripts, **datawolf-service** and **datawolf-service.bat**. The latter is intended for running Data Wolf on a Windows machine and the former is for running on Mac & Linux. As with the previous section, knowledge of this file is not required unless you are interested in configuring the Data Wolf Server and Editor beyond the default settings. We will show snippets of the file **datawolf-service** and discuss what each section is configuring.
+If you go back to the folder **Data Wolf-webapp-all-4.6.0** you will see a sub-folder called **bin**, open this. Inside you will find two scripts, **datawolf-service** and **datawolf-service.bat**. The latter is intended for running Data Wolf on a Windows machine and the former is for running on Mac & Linux. As with the previous section, knowledge of this file is not required unless you are interested in configuring the Data Wolf Server and Editor beyond the default settings. We will show snippets of the file **datawolf-service** and discuss what each section is configuring.
 
 ```
 # port for the jetty server

diff --git a/datawolf-doc/pom.xml b/datawolf-doc/pom.xml
@@ -3,7 +3,7 @@
   <parent>
     <groupId>edu.illinois.ncsa</groupId>
     <artifactId>datawolf</artifactId>
-    <version>4.6.0-SNAPSHOT</version>
+    <version>4.6.0</version>
   </parent>
   <artifactId>datawolf-doc</artifactId>
 </project>
diff --git a/datawolf-domain/pom.xml b/datawolf-domain/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-domain</artifactId>
 

diff --git a/datawolf-editor/pom.xml b/datawolf-editor/pom.xml
@@ -4,7 +4,7 @@
     <parent>
                 <groupId>edu.illinois.ncsa</groupId>
                 <artifactId>datawolf</artifactId>
-                <version>4.6.0-SNAPSHOT</version>
+                <version>4.6.0</version>
         </parent>
 	<packaging>war</packaging>
 	<artifactId>datawolf-editor</artifactId>

diff --git a/datawolf-executor-commandline/pom.xml b/datawolf-executor-commandline/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<artifactId>datawolf</artifactId>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-executor-commandline</artifactId>
 

diff --git a/datawolf-executor-hpc/pom.xml b/datawolf-executor-hpc/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<artifactId>datawolf</artifactId>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-executor-hpc</artifactId>
 

diff --git a/datawolf-executor-java-tool/pom.xml b/datawolf-executor-java-tool/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<artifactId>datawolf</artifactId>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-executor-java-tool</artifactId>
 

diff --git a/datawolf-executor-java/pom.xml b/datawolf-executor-java/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<artifactId>datawolf</artifactId>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-executor-java</artifactId>
 

diff --git a/datawolf-executor-kubernetes/pom.xml b/datawolf-executor-kubernetes/pom.xml
@@ -3,7 +3,7 @@
   <parent>
     <groupId>edu.illinois.ncsa</groupId>
     <artifactId>datawolf</artifactId>
-    <version>4.6.0-SNAPSHOT</version>
+    <version>4.6.0</version>
   </parent>
   <artifactId>datawolf-executor-kubernetes</artifactId>
   <dependencies>

diff --git a/datawolf-jpa/pom.xml b/datawolf-jpa/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<artifactId>datawolf</artifactId>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-jpa</artifactId>
 	<packaging>jar</packaging>

diff --git a/datawolf-provenance/pom.xml b/datawolf-provenance/pom.xml
@@ -4,7 +4,7 @@
     <parent>
                 <groupId>edu.illinois.ncsa</groupId>
                 <artifactId>datawolf</artifactId>
-                <version>4.6.0-SNAPSHOT</version>
+                <version>4.6.0</version>
         </parent>
 	<packaging>war</packaging>
 	<artifactId>datawolf-provenance</artifactId>

diff --git a/datawolf-service-client/pom.xml b/datawolf-service-client/pom.xml
@@ -4,7 +4,7 @@
         <parent>
                 <groupId>edu.illinois.ncsa</groupId>
                 <artifactId>datawolf</artifactId>
-                <version>4.6.0-SNAPSHOT</version>
+                <version>4.6.0</version>
         </parent>
   <artifactId>datawolf-service-client</artifactId>
 

diff --git a/datawolf-service/pom.xml b/datawolf-service/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<artifactId>datawolf</artifactId>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>datawolf-service</artifactId>
 	<dependencies>

diff --git a/datawolf-tool-example/pom.xml b/datawolf-tool-example/pom.xml
@@ -5,7 +5,7 @@
         <parent>
 	    <artifactId>datawolf</artifactId>
             <groupId>edu.illinois.ncsa</groupId>
-            <version>4.6.0-SNAPSHOT</version>
+            <version>4.6.0</version>
         </parent>
 	<artifactId>datawolf-tool-example</artifactId>
 

diff --git a/datawolf-webapp-all/pom.xml b/datawolf-webapp-all/pom.xml
@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 		<groupId>edu.illinois.ncsa</groupId>
 	</parent>
 	<packaging>war</packaging>

diff --git a/datawolf-webapp/pom.xml b/datawolf-webapp/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<packaging>war</packaging>
 	<artifactId>datawolf-webapp</artifactId>

diff --git a/file-service-client/pom.xml b/file-service-client/pom.xml
@@ -4,7 +4,7 @@
         <parent>
                 <groupId>edu.illinois.ncsa</groupId>
                 <artifactId>datawolf</artifactId>
-                <version>4.6.0-SNAPSHOT</version>
+                <version>4.6.0</version>
         </parent>
   	<artifactId>file-service-client</artifactId>
 

diff --git a/file-service/pom.xml b/file-service/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<packaging>jar</packaging>
 	<artifactId>file-service</artifactId>

diff --git a/file-webapp/pom.xml b/file-webapp/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<packaging>war</packaging>
 	<artifactId>file-webapp</artifactId>

diff --git a/gondola/pom.xml b/gondola/pom.xml
@@ -5,7 +5,7 @@
         <parent>
                 <artifactId>datawolf</artifactId>
                 <groupId>edu.illinois.ncsa</groupId>
-                <version>4.6.0-SNAPSHOT</version>
+                <version>4.6.0</version>
         </parent>
 	<artifactId>gondola</artifactId>
 	<packaging>jar</packaging>

diff --git a/ncsa-common-clowder/pom.xml b/ncsa-common-clowder/pom.xml
@@ -4,7 +4,7 @@
 	<artifactId>ncsa-common-clowder</artifactId>
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 		<artifactId>datawolf</artifactId>
 	</parent>
 	<build>

diff --git a/ncsa-common-domain/pom.xml b/ncsa-common-domain/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<artifactId>ncsa-common-domain</artifactId>
 

diff --git a/ncsa-common-incore/pom.xml b/ncsa-common-incore/pom.xml
@@ -3,7 +3,7 @@
 	<artifactId>ncsa-common-incore</artifactId>
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 		<artifactId>datawolf</artifactId>
 	</parent>
 	<build>

diff --git a/ncsa-common-jpa/pom.xml b/ncsa-common-jpa/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>edu.illinois.ncsa</groupId>
 		<artifactId>datawolf</artifactId>
-		<version>4.6.0-SNAPSHOT</version>
+		<version>4.6.0</version>
 	</parent>
 	<build>
 		<resources>

diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 
 	<groupId>edu.illinois.ncsa</groupId>
-	<version>4.6.0-SNAPSHOT</version>
+	<version>4.6.0</version>
 	<artifactId>datawolf</artifactId>
 	<packaging>pom</packaging>