From d4e6b3d8925e9f4f34ddc017a203cd1a73ff7463 Mon Sep 17 00:00:00 2001 From: Brian Lin Date: Tue, 4 Jun 2024 07:57:51 -0500 Subject: [PATCH 1/4] ClassAd transform syntax was introduced quite some time ago --- docs/v23/configuration/job-router-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/v23/configuration/job-router-overview.md b/docs/v23/configuration/job-router-overview.md index e8c0fa97..a87d77a5 100644 --- a/docs/v23/configuration/job-router-overview.md +++ b/docs/v23/configuration/job-router-overview.md @@ -19,7 +19,7 @@ overview of how to configure your HTCondor-CE Job Router Route Syntaxes -------------- -HTCondor-CE 5 introduces the ability to write job routes using [ClassAd transform syntax](#classad-transforms) in +HTCondor-CE 5 introduced the ability to write job routes using [ClassAd transform syntax](#classad-transforms) in addition to the [existing configuration syntax](#deprecated-syntax). The old route configuration syntax continues to be the default in HTCondor-CE 5 but there are benefits to transitioning to the new syntax as [outlined below](#choosing-a-syntax). From 148d26a47fb5df8d56735bc109a2b598b1ebf391 Mon Sep 17 00:00:00 2001 From: Brian Lin Date: Tue, 4 Jun 2024 08:01:46 -0500 Subject: [PATCH 2/4] We refer to them as ClassAd transform and deprecated syntaxes Also bonus change for text formatting to clarify how to set the deprecated config knob --- docs/v23/configuration/job-router-overview.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/v23/configuration/job-router-overview.md b/docs/v23/configuration/job-router-overview.md index a87d77a5..72e4f5c1 100644 --- a/docs/v23/configuration/job-router-overview.md +++ b/docs/v23/configuration/job-router-overview.md @@ -44,7 +44,7 @@ in the following order: - `JOB_ROUTER_DEFAULTS`, `JOB_ROUTER_ENTRIES`, `JOB_ROUTER_ENTRIES_CMD`, and `JOB_ROUTER_ENTRIES_FILE` are deprecated and will be removed for *V24* of the HTCondor Software Suite. New configuration syntax for the job router is defined using `JOB_ROUTER_ROUTE_NAMES` and `JOB_ROUTER_ROUTE_[name]`. - - For new syntax example vist: + - For a ClassAd transform syntax example vist: [HTCondor Documentation - Job Router](https://htcondor.readthedocs.io/en/lts/grid-computing/job-router.html#an-example-configuration) - **Note:** The removal will occur during the lifetime of the HTCondor *V23* feature series. @@ -89,22 +89,22 @@ Additionally, it is now easier to include job transformations that should be eva including transforms in the lists of `JOB_ROUTER_PRE_ROUTE_TRANSFORM_NAMES` and `JOB_ROUTER_PRE_ROUTE_TRANSFORM_NAMES`, respectively. -### Converting To New Syntax ### +### Converting to ClassAd transforms ### -For existing HTCondor-CE's utilizing the deprecated old job router syntax can do the following steps to convert -to using the new syntax: +For existing HTCondor-CE's utilizing the deprecated syntax can do the following steps to convert to using the ClassAd +transform syntax: 1. Output the current configuration by running `condor_ce_config_val -summary > summary-file` 2. Convert the stored configuration by running `condor_transform_ads -convert:file summary-file > converted-job-routes.conf` 3. Place the `converted-job-routes.conf` from the previous command into the HTCondor-CE's configuration. 4. Tweak new job routes as needed. For assistance please reach out to [htcondor-users@cs.wisc.edu](mailto:htcondor-users@cs.wisc.edu) -5. Set [JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES](https://htcondor.readthedocs.io/en/latest/admin-manual/configuration-macros.html#JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES)=False +5. Set `JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES = False` (see [this documentation](https://htcondor.readthedocs.io/en/latest/admin-manual/configuration-macros.html#JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES) in the HTCondor-CE's configuration. 6. Restart the HTCondor-CE !!! note "Not Using Custom Job Routes?" - Conversion of job router syntax from the deprecated old version to new only needs to occur - if custom job routes have been configured. + Conversion of job router syntax from the deprecated syntax to ClassAd transform syntax needs to occur if custom job + routes have been configured. How Jobs Match to Routes ------------------------ From ceb90f91c29751e7e09efd6435a3f70167dc6f16 Mon Sep 17 00:00:00 2001 From: Brian Lin Date: Tue, 4 Jun 2024 08:05:20 -0500 Subject: [PATCH 3/4] Move the commands to run on separate lines for readability --- docs/v23/configuration/job-router-overview.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/v23/configuration/job-router-overview.md b/docs/v23/configuration/job-router-overview.md index 72e4f5c1..584e55f4 100644 --- a/docs/v23/configuration/job-router-overview.md +++ b/docs/v23/configuration/job-router-overview.md @@ -94,8 +94,14 @@ respectively. For existing HTCondor-CE's utilizing the deprecated syntax can do the following steps to convert to using the ClassAd transform syntax: -1. Output the current configuration by running `condor_ce_config_val -summary > summary-file` -2. Convert the stored configuration by running `condor_transform_ads -convert:file summary-file > converted-job-routes.conf` +1. Output the current configuration by running the following: + + condor_ce_config_val -summary > summary-file + +2. Convert the stored configuration by running the following: + + condor_transform_ads -convert:file summary-file > converted-job-routes.conf + 3. Place the `converted-job-routes.conf` from the previous command into the HTCondor-CE's configuration. 4. Tweak new job routes as needed. For assistance please reach out to [htcondor-users@cs.wisc.edu](mailto:htcondor-users@cs.wisc.edu) 5. Set `JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES = False` (see [this documentation](https://htcondor.readthedocs.io/en/latest/admin-manual/configuration-macros.html#JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES) From cfbe62a3f56de30bb6e1a68d61508a2f6ee4ea0a Mon Sep 17 00:00:00 2001 From: Brian Lin Date: Tue, 4 Jun 2024 08:09:48 -0500 Subject: [PATCH 4/4] Prescribe generated job route config locations HTCondor-CE is very prescriptive, making it easier to document --- docs/v23/configuration/job-router-overview.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/v23/configuration/job-router-overview.md b/docs/v23/configuration/job-router-overview.md index 584e55f4..37d211e0 100644 --- a/docs/v23/configuration/job-router-overview.md +++ b/docs/v23/configuration/job-router-overview.md @@ -100,9 +100,15 @@ transform syntax: 2. Convert the stored configuration by running the following: - condor_transform_ads -convert:file summary-file > converted-job-routes.conf + condor_transform_ads -convert:file summary-file > 90-converted-job-routes.conf + +3. Place the `90-converted-job-routes.conf` from the previous command into the `/etc/condor-ce/config.d`. + + !!! note "Potential need to rename generated config" + The files in `/etc/condor-ce/config.d` are read in lexicographical order. + So if you define your current job router configuration in `/etc/condor-ce/config.d` in a file that is read + later, e.g. `95-local.conf`, you will need to rename your generated config file, e.g. `96-generated-job-routes.conf`. -3. Place the `converted-job-routes.conf` from the previous command into the HTCondor-CE's configuration. 4. Tweak new job routes as needed. For assistance please reach out to [htcondor-users@cs.wisc.edu](mailto:htcondor-users@cs.wisc.edu) 5. Set `JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES = False` (see [this documentation](https://htcondor.readthedocs.io/en/latest/admin-manual/configuration-macros.html#JOB_ROUTER_USE_DEPRECATED_ROUTER_ENTRIES) in the HTCondor-CE's configuration.