Merge pull request #25 from intel/tmp23.2

release 23.2

Author: xwu2intel

CMakeLists.txt

@@ -1,3 +1,8 @@
+#
+# Apache v2 license
+# Copyright (C) 2023 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+#
 
 cmake_minimum_required (VERSION 2.8...3.24)
 
@@ -34,8 +39,8 @@ else()
 endif()
 
 include(registry OPTIONAL)
-execute_process(COMMAND bash -c "GIT_SSH_COMMAND='ssh -o BatchMode=yes' GIT_ASKPASS=echo git fetch --tags > /dev/null && GIT_ASKPASS=echo git tag" TIMEOUT 5 OUTPUT_VARIABLE tmp RESULT_VARIABLE status OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
-if (RELEASE MATCHES "^:?v?[0-9]+[.][0-9]+$")
+execute_process(COMMAND bash -c "GIT_SSH_COMMAND='ssh -o BatchMode=yes' GIT_ASKPASS=echo git fetch --tags > /dev/null;GIT_ASKPASS=echo git tag | sort -V" TIMEOUT 5 OUTPUT_VARIABLE tmp RESULT_VARIABLE status OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET)
+if (RELEASE MATCHES "^:?v?[0-9]+[.][0-9]+[.]*[0-9]*$")
     string(REPLACE ":" "" release1 "${RELEASE}")
     if ((status EQUAL 0) AND (tmp MATCHES "${release1}"))
         if((NOT DEFINED REGISTRY) OR (NOT REGISTRY))
@@ -45,16 +50,22 @@ if (RELEASE MATCHES "^:?v?[0-9]+[.][0-9]+$")
         endif()
     endif()
 else ()
-    string(REGEX REPLACE ".*\nv?" "" tmp "${tmp}")
+    string(REGEX REPLACE ".*\n" "" tmp "${tmp}")
+    string(REGEX REPLACE "(v?[0-9]*[.][0-9]*)[.].*" "\\1" mtmp "${tmp}")
     if (tmp AND (status EQUAL 0))
         message("")
         message("*************************************************************")
         message("")
-        message("${green}INFO:${reset} Detected release ${tmp}.")
-        message("  Switch to release ${tmp} as follows:")
+        if (tmp STREQUAL mtmp)
+            message("${green}INFO:${reset} Detected major release ${mtmp}.")
+        else()
+            message("${green}INFO:${reset} Detected major release ${mtmp} and minor releases up to ${tmp}.")
+            message("${green}INFO:${reset} Minor releases do not cover all workloads. See workload README.")
+        endif()
         message("")
-        message("git checkout ${tmp}")
-        message("cmake -DRELEASE=v${tmp} ..")
+        message("${green}INFO:${reset} Switch to a major/minor release as follows:")
+        message("${green}INFO:${reset} git checkout tags/${mtmp}")
+        message("${green}INFO:${reset} cmake -DRELEASE=${mtmp} ..")
         message("")
         message("*************************************************************")
         message("")

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ### Evaluate Workloads
 
-Follow the [README](README.md#prerequisite) instructions to setup [local](doc/setup-docker.md), [remote](doc/setup-cumulus.md), or [Cloud](doc/setup-cumulus.md) systems to evaluate any [supported workloads](worklod/README.md#list-of-workloads). 
+Follow the [README](README.md#prerequisite) instructions to setup [local](doc/user-guide/preparing-infrastructure/setup-docker.md), [remote](doc/user-guide/preparing-infrastructure/setup-cumulus.md), or [Cloud](doc/user-guide/preparing-infrastructure/setup-cumulus.md) systems to evaluate any [supported workloads](worklod/README.md#list-of-workloads).
 
 You can choose to build the workloads and evaluate the workload execution with `ctest`, which manage the workload test cases. You can run any subset of the test cases or all of them. 
 
@@ -13,14 +13,14 @@ If you spot a problem with the repository, submit an issue at the **github issue
 ### Contribute to Workload Development
 
 Here is a list of references you can follow for workload development:
-- A workload consists of a few critical pieces of scripts or manifests, documented in [Workload Elements](doc/workload.md):
-  - [`CMakeLists.txt`](doc/cmakelists.txt.md)  
-  - [`build.sh`](doc/build.md)  
-  - [`Dockerfiles`](doc/dockerfile.md)  
-  - [`cluster-config.yaml.m4`](doc/cluster-config.md)  
-  - [`kubernetes-config.yaml.m4`](doc/kuernetes-config.md)  
-  - [`validate.sh`](doc/validate.md)  
-  - [`kpi.sh`](doc/kpi.md)  
+- A workload consists of a few critical pieces of scripts or manifests, documented in [Workload Elements](doc/developer-guide/component-design/workload.md):
+  - [`CMakeLists.txt`](doc/developer-guide/component-design/cmakelists.md)
+  - [`build.sh`](doc/developer-guide/component-design/build.md)
+  - [`Dockerfiles`](doc/developer-guide/component-design/dockerfile.md)
+  - [`cluster-config.yaml.m4`](doc/developer-guide/component-design/cluster-config.md)
+  - [`kubernetes-config.yaml.m4`](doc/developer-guide/component-design/kubernetes-config.md)
+  - [`validate.sh`](doc/developer-guide/component-design/validate.md)
+  - [`kpi.sh`](doc/developer-guide/component-design/kpi.md)
 - The best way to start a new workload development is by copying the [dummy](workload/dummy) workload and then modifying it to your needs. 
 
 ### Submit Contributions

README.md

@@ -1,3 +1,6 @@
+>
+> **Note: The Workload Services Framework is a benchmarking framework and is not intended to be used for the deployment of workloads in production environments. It is recommended that users consider any adjustments which may be necessary for the deployment of these workloads in a production environment including those necessary for implementing software best practices for workload scalability and security.**
+>
 
 ### Introduction
 
@@ -7,7 +10,7 @@ This is the **Workload Services Framework** repository. The repository contains
 
 - Sync your system date/time. This is required by any credential authorization.  
 - If you are behind a corporate firewall, please setup `http_proxy`, `https_proxy` and `no_proxy` in `/etc/environment`.
-- Run the [`setup-dev.sh`](doc/setup-wsf.md#setup-devsh) script to setup the development host for Cloud and On-Premises workload development and evaluation. See [Cloud and On-Premises Setup](doc/setup-wsf.md) for more details on the setup.     
+- Run the [`setup-dev.sh`](doc/user-guide/preparing-infrastructure/setup-wsf.md#setup-devsh) script to setup the development host for Cloud and On-Premises workload development and evaluation. See [Cloud and On-Premises Setup](doc/user-guide/preparing-infrastructure/setup-wsf.md) for more details on the setup.
 
 ### Evaluate Workload
 
@@ -25,7 +28,7 @@ cd workload/OpenSSL-RSAMB              # Go to any workload folder
 
 ---
 
-- The WSF supports multiple validation backends. By default, the [`docker`](doc/setup-docker.md) backend, or the [`Kubernetes`](doc/setup-kubernetes.md) backend if available, is used to evaluate any workload locally. To evaluate workloads on Cloud or in an on-premises cluster, please use the [terraform](doc/setup-terraform.md) backend. Additional setup required such as configuring Cloud account credentials.   
+- The WSF supports multiple validation backends. By default, the [`docker`](doc/user-guide/preparing-infrastructure/setup-docker.md) backend, or the [`Kubernetes`](doc/user-guide/preparing-infrastructure/setup-kubernetes.md) backend if available, is used to evaluate any workload locally. To evaluate workloads on Cloud or in an on-premises cluster, please use the [terraform](doc/user-guide/preparing-infrastructure/setup-terraform.md) backend. Additional setup required such as configuring Cloud account credentials.
 
 ---
 
@@ -40,7 +43,7 @@ make
 ./ctest.sh -N
 ```
 
-> TIP: You can specify `BENCHMARK` to limit the repository scope to the specified workload. The build and test operations on all other workloads are disabled. See [Build Options](doc/cmake.md) for details.  
+> TIP: You can specify `BENCHMARK` to limit the repository scope to the specified workload. The build and test operations on all other workloads are disabled. See [Build Options](doc/user-guide/executing-workload/cmake.md) for details.
 
 ```
 cd build
@@ -51,7 +54,7 @@ make
 
 ### See Also
 
-- [Build Options](doc/cmake.md)   
-- [Test Options](doc/ctest.md)   
-- [Setup Terraform](doc/setup-terraform.md)  
+- [Build Options](doc/user-guide/executing-workload/cmake.md)
+- [Test Options](doc/user-guide/executing-workload/ctest.md)
+- [Setup Terraform](doc/user-guide/preparing-infrastructure/setup-terraform.md)
 

Security.md

@@ -0,0 +1,6 @@
+# Security Policy
+Intel is committed to rapidly addressing security vulnerabilities affecting our customers and providing clear guidance on the solution, impact, severity and mitigation. 
+
+## Reporting a Vulnerability
+Please report any security vulnerabilities in this project [utilizing the guidelines here](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html).
+