Updated the directory structure, the licensing comments and added stu…

…bs for the remainng parts
glideinWMS · Dec 29, 2023 · 1ef02e3 · 1ef02e3
1 parent 29ca710
commit 1ef02e3
Show file tree

Hide file tree

Showing 20 changed files with 343 additions and 436 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ default_language_version:
   node: 17.9.0
 repos:
   - repo: "https://github.com/pre-commit/pre-commit-hooks"
-    rev: v4.1.0
+    rev: v4.4.0
     hooks:
       - id: check-ast
       - id: check-docstring-first
@@ -22,21 +22,21 @@ repos:
         args:
           - "--markdown-linebreak-ext=md"
   - repo: "https://github.com/pre-commit/pygrep-hooks"
-    rev: v1.9.0
+    rev: v1.10.0
     hooks:
       - id: python-check-blanket-noqa
       - id: python-check-blanket-type-ignore
       - id: python-use-type-annotations
   - repo: "https://github.com/pycqa/isort"
-    rev: 5.10.1
+    rev: 5.13.2
     hooks:
       - id: isort
   - repo: "https://github.com/psf/black"
-    rev: 22.3.0
+    rev: 23.12.0
     hooks:
       - id: black
   - repo: "https://github.com/pre-commit/mirrors-prettier"
-    rev: v2.6.2
+    rev: v3.1.0
     hooks:
       - id: prettier
         exclude_types:
@@ -51,7 +51,7 @@ repos:
         args:
           - "--py36-plus"
   - repo: "https://github.com/fsfe/reuse-tool"
-    rev: v0.14.0
+    rev: v2.1.0
     hooks:
       - id: reuse
         additional_dependencies:

diff --git a/.reuse/dep5 b/.reuse/dep5
@@ -10,13 +10,17 @@ Source: https://github.com/glideinwms/glideinbenchmark
 # License: ...
 
 Files: src/*.jsonnet src/*.libsonnet src/*/readme src/*.conf src/*.fixture src/*.csv src/*/test_filename_typo.jsonet src/*/log_sample.txt
-Copyright: 2022 Fermi Research Alliance, LLC
+Copyright: 2023 Fermi Research Alliance, LLC
 License: Apache-2.0
 
 Files: .codecov.yml .coveragerc .editorconfig .gitignore .lgtm.yaml .pep8speaks.yml .pre-commit-config.yaml .pylintrc pyproject.toml
-Copyright: 2022 Fermi Research Alliance, LLC
+Copyright: 2023 Fermi Research Alliance, LLC
 License: Apache-2.0
 
 Files: pkg/rpm/* pkg/systemd/*
-Copyright: 2022 Fermi Research Alliance, LLC
+Copyright: 2023 Fermi Research Alliance, LLC
+License: Apache-2.0
+
+Files: test/fixtures/*
+Copyright: 2023 Fermi Research Alliance, LLC
 License: Apache-2.0
diff --git a/.reuse/dep5bck b/.reuse/dep5bck
diff --git a/ACKNOWLEDGMENTS.md b/ACKNOWLEDGMENTS.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2022 Fermi Research Alliance, LLC
+SPDX-FileCopyrightText: 2023 Fermi Research Alliance, LLC
 SPDX-License-Identifier: Apache-2.0
 -->
 
@@ -9,6 +9,6 @@ The GlideinBenchmark development been sponsored
 by Fermi Research Alliance, LLC under Contract No. DE-AC02-07CH11359 with the
 U.S. Department of Energy, Office of Science, Office of High Energy Physics.
 
-GlideinBenchmark heavily relies on HTCondor:
-http://www.cs.wisc.edu/condor/.  
-The support of the Condor team is invaluable in the realization of GlideinBenchmark.
+GlideinBenchmark heavily relies on [GlideinWMS](https://glideinwms.fnal.gov/), which in turn relies on
+[HTCSS](https://htcondor.org/).
+The support of the GlideinWMS and HTCSS teams is invaluable in the realization of GlideinBenchmark.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2022 Fermi Research Alliance, LLC
+SPDX-FileCopyrightText: 2023 Fermi Research Alliance, LLC
 SPDX-License-Identifier: Apache-2.0
 -->
 

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2022 Fermi Research Alliance, LLC
+SPDX-FileCopyrightText: 2023 Fermi Research Alliance, LLC
 SPDX-License-Identifier: Apache-2.0
 -->
 
@@ -50,12 +50,12 @@ REUSE is installed as development dependency or you can install it manually
 - to check compliance you can use `reuse lint`. This is the command run also by the pre-commit and CI checks
 - you can add on top of new files [SPDX license notices](https://spdx.org/licenses/) like
   ```
-  # SPDX-FileCopyrightText: 2022 Fermi Research Alliance, LLC
+  # SPDX-FileCopyrightText: 2023 Fermi Research Alliance, LLC
   # SPDX-License-Identifier: Apache-2.0
   ```
 - or let REUSE do that for you (`FILEPATH` is your new file):
   ```
-  reuse addheader --year 2022 --copyright="Fermi Research Alliance, LLC" \
+  reuse addheader --year 2023 --copyright="Fermi Research Alliance, LLC" \
     --license="Apache-2.0" --template=compact FILEPATH
   ```
 - Files that are not supported and have no comments to add the SPDX notice

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: 2022 Fermi Research Alliance, LLC
+SPDX-FileCopyrightText: 2023 Fermi Research Alliance, LLC
 SPDX-License-Identifier: Apache-2.0
 -->
 
@@ -9,7 +9,15 @@ SPDX-License-Identifier: Apache-2.0
 
 # GlideinBenchmark
 
-Application to benchmark GlideinWMS provisioned resources
+Application to benchmark GlideinWMS provisioned resources.
+
+Runner_config allws to configure the GlideinWMS Factory to automatically run benchmarks on Glideins.
+
+Runner alloows to trigger a benchmark on a specific resource.
+
+Benchmarks are run using images defined in the [GlideinWMS containers repo](https://github.com/glideinWMS/containers/tree/main/worker/benchmark).
+
+Viewer provides access to the benchmarks' results.
 
 This code is distributed under the Apache 2.0 license, see the [LICENSE](LICENSE) file.