Skip to content

Commit

Permalink
Merge pull request #594 from htcondor/docs-HTCONDOR-2169-test-token-docs
Browse files Browse the repository at this point in the history
HTCONDOR-2169 test token docs
  • Loading branch information
timtheisen committed Jan 23, 2024
2 parents c749e8d + ab1ccc0 commit 9b8cab6
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 25 deletions.
4 changes: 2 additions & 2 deletions docs/v23/configuration/job-router-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ in the following order:
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:
[HTCondor Documentation - Job Router](https://htcondor.readthedocs.io/en/latest/grid-computing/job-router.html#an-example-configuration)
[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.

Since the inception of HTCondor-CE, job routes have been written as a
[list of ClassAds](https://htcondor.readthedocs.io/en/lts/grid-computing/job-router.html#deprecated-router-configuration).
Each job route’s [ClassAd](http://research.cs.wisc.edu/htcondor/manual/v8.6/4_1HTCondor_s_ClassAd.html) is constructed
Each job route’s [ClassAd](https://htcondor.readthedocs.io/en/lts/classads/classad-mechanism.html) is constructed
by combining each entry from the `JOB_ROUTER_ENTRIES` with the `JOB_ROUTER_DEFAULTS`:

- `JOB_ROUTER_ENTRIES` is a configuration variable whose default is set in `/etc/condor-ce/config.d/02-ce-*.conf` but
Expand Down
2 changes: 1 addition & 1 deletion docs/v23/configuration/optional-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Inserting IDTOKENs into the routed job's sandbox
If you want to insert IDTOKENS into the routed job's sandbox you can use the `SendIDTokens` route command, or
the `JOB_ROUTER_SEND_ROUTE_IDTOKENS` global configuration variable. Tokens
sent using this mechanism must be named and declared using the `JOB_ROUTER_CREATE_IDTOKEN_NAMES`
and [`JOB_ROUTER_CREATE_IDTOKEN_<name>`](https://htcondor.readthedocs.io/en/latest/admin-manual/configuration-macros.html#JOB_ROUTER_CREATE_IDTOKEN_%3CNAME%3E) configuration variables. Tokens whose names are declared in
and [`JOB_ROUTER_CREATE_IDTOKEN_<name>`](https://htcondor.readthedocs.io/en/lts/admin-manual/configuration-macros.html#JOB_ROUTER_CREATE_IDTOKEN_%3CNAME%3E) configuration variables. Tokens whose names are declared in
the `JOB_ROUTER_SEND_ROUTE_IDTOKENS` configuration variable are sent by default for each route that does
not have a `SendIDTokens` command.

Expand Down
8 changes: 4 additions & 4 deletions docs/v23/configuration/writing-job-routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Syntax Differences
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:
[HTCondor Documentation - Job Router](https://htcondor.readthedocs.io/en/latest/grid-computing/job-router.html#an-example-configuration)
[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.


Expand Down Expand Up @@ -836,12 +836,12 @@ This section outlines how to limit the number of total or idle jobs in a specifi
!!! note
If you are using an HTCondor batch system, limiting the number of jobs is not the preferred solution:
HTCondor manages fair share on its own via
[user priorities and group accounting](http://research.cs.wisc.edu/htcondor/manual/v8.6/3_6User_Priorities.html).
[user priorities and group accounting](https://htcondor.readthedocs.io/en/lts/admin-manual/user-priorities-negotiation.html).

### Total jobs

To set a limit on the number of jobs for a specific route,
set the [MaxJobs](http://research.cs.wisc.edu/htcondor/manual/v8.6/5_4HTCondor_Job.html#57134) attribute:
set the [MaxJobs](https://htcondor.readthedocs.io/en/lts/grid-computing/job-router.html#index-6) attribute:

=== "ClassAd Transform"

Expand Down Expand Up @@ -871,7 +871,7 @@ set the [MaxJobs](http://research.cs.wisc.edu/htcondor/manual/v8.6/5_4HTCondor_J
### Idle jobs

To set a limit on the number of idle jobs for a specific route,
set the [MaxIdleJobs](http://research.cs.wisc.edu/htcondor/manual/v8.6/5_4HTCondor_Job.html#57135) attribute:
set the [MaxIdleJobs](https://htcondor.readthedocs.io/en/lts/grid-computing/job-router.html#index-7) attribute:

=== "ClassAd Transform"

Expand Down
2 changes: 1 addition & 1 deletion docs/v23/installation/central-collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ There are some one-time (per host) steps to prepare in advance:

- Ensure the host has a supported operating system (Red Hat Enterprise Linux variant 7)
- Obtain root access to the host
- Prepare the [EPEL](https://fedoraproject.org/wiki/EPEL) and [HTCondor](https://research.cs.wisc.edu/htcondor/yum/) Yum
- Prepare the [EPEL](https://fedoraproject.org/wiki/EPEL) and [HTCondor](https://htcondor.readthedocs.io/en/lts/getting-htcondor/from-our-repositories.html) Yum
repositories
- Install CA certificates and VO data into `/etc/grid-security/certificates` and `/etc/grid-security/vomsdir`,
respectively
Expand Down
2 changes: 1 addition & 1 deletion docs/v23/installation/htcondor-ce.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are some one-time (per host) steps to prepare in advance:

- Ensure the host has a supported operating system (Red Hat Enterprise Linux variant 7)
- Obtain root access to the host
- Prepare the [EPEL](https://fedoraproject.org/wiki/EPEL) and [HTCondor Development](https://research.cs.wisc.edu/htcondor/yum/) Yum
- Prepare the [EPEL](https://fedoraproject.org/wiki/EPEL) and [HTCondor Development](https://htcondor.readthedocs.io/en/lts/getting-htcondor/from-our-repositories.html) Yum
repositories
- Install CA certificates and VO data into `/etc/grid-security/certificates` and `/etc/grid-security/vomsdir`,
respectively
Expand Down
6 changes: 3 additions & 3 deletions docs/v23/troubleshooting/common-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ The most common cases for this behavior are as follows:
- **The route(s) that the job matches to are full:**
See [limiting the number of jobs](../configuration/writing-job-routes.md#limiting-the-number-of-jobs).
- **The job router is throttling submission to your batch system due to submission failures:**
See the HTCondor manual for [FailureRateThreshold](http://research.cs.wisc.edu/htcondor/manual/v8.6/5_4HTCondor_Job.html#55958).
See the HTCondor manual for [FailureRateThreshold](https://htcondor.readthedocs.io/en/lts/grid-computing/job-router.html#index-8).
Check for errors in the [JobRouterLog](logs.md#jobrouterlog) or [GridmanagerLog](logs.md#gridmanagerlog) for HTCondor
and non-HTCondor batch systems, respectively.

Expand All @@ -465,10 +465,10 @@ Ensure that the owner of the job generates their proxy with `voms-proxy-init`.

#### Held jobs: Invalid job universe

The HTCondor-CE only accepts jobs that have `universe` in their submit files set to `vanilla`, `standard`, `local`, or
The HTCondor-CE only accepts jobs that have `universe` in their submit files set to `vanilla`, `local`, or
`scheduler`.
These universes also have corresponding integer values that can be found in the
[HTCondor manual](http://research.cs.wisc.edu/htcondor/manual/v8.6/12_Appendix_A.html#104736).
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/codes-other-values/job-universe-numbers.html).

**Next actions**

Expand Down
56 changes: 44 additions & 12 deletions docs/v23/troubleshooting/debugging-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,9 @@ Authorized: TRUE

!!! note
If you run the `condor_ce_ping` command on the CE that you are testing, omit the `-name` and `-pool`
options. `condor_ce_ping` takes the same arguments as `condor_ping` and is documented in the
[HTCondor manual](http://research.cs.wisc.edu/htcondor/manual/v8.6/condor_ping.html).
options. `condor_ce_ping` takes the same arguments as
`condor_ping`, which is documented in the
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/man-pages/condor_ping.html).

### Troubleshooting ###

Expand Down Expand Up @@ -182,8 +183,8 @@ user@host $ condor_ce_q -name condorce.example.com -pool condorce.example.com:96

!!! note
If you run the `condor_ce_q` command on the CE that you are testing, omit the `-name` and `-pool` options.
`condor_ce_q` takes the same arguments as `condor_q` and is documented in the
[HTCondor manual](http://research.cs.wisc.edu/htcondor/manual/v8.6/condor_q.html).
`condor_ce_q` takes the same arguments as `condor_q`, which is documented in the
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/man-pages/condor_q.html).

### Troubleshooting ###

Expand Down Expand Up @@ -248,8 +249,8 @@ user@host $ condor_ce_history -name condorce.example.com -pool condorce.example.

!!! note
If you run the `condor_ce_history` command on the CE that you are testing, omit the `-name` and `-pool` options.
`condor_ce_history` takes the same arguments as `condor_history` and is documented in the
[HTCondor manual](http://research.cs.wisc.edu/htcondor/manual/v8.6/condor_history.html).
`condor_ce_history` takes the same arguments as `condor_history`, which is documented in the
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/man-pages/condor_history.html).


condor_ce_job_router_info
Expand Down Expand Up @@ -343,8 +344,38 @@ and their statuses:
user@host $ condor_ce_router_q
```

`condor_ce_router_q` takes the same options as `condor_router_q` and `condor_q` and is documented in the
[HTCondor manual](http://research.cs.wisc.edu/htcondor/manual/v8.6/condor_router_q.html)
`condor_ce_router_q` takes the same options as `condor_router_q`,
which is documented in the
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/man-pages/condor_router_q.html)


condor_ce_test_token
--------------------

## Usage ###

Use the `condor_ce_test_token` command to test SciTokens
authentication in the CE.
It will create a token with an issuer and subject that you specify and
configure the CE daemons to accept that token as if it had been
generated by the given issuer (for one hour).
The token is printed to stdout; use it with `condor_ce_submit` to test
that SciTokens authentication and user mapping operate correctly.

To create a temporary SciToken that appears to be issued by the
SciTokens demo issuer:

``` console
root@host # condor_ce_token_test --issuer https://demo.scitokens.org
--audience ANY --scope condor:/WRITE --subject [email protected]
```

!!! note
You must run `condor_ce_test_token` on the CE that you are testing
as the root user.
`condor_ce_test_token` takes the same arguments as
`condor_test_token`, which is documented in the
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/man-pages/condor_test_token.html).


condor_ce_status
Expand All @@ -358,8 +389,8 @@ To see the daemons running on a CE, run the following command:
user@host $ condor_ce_status -any
```

`condor_ce_status` takes the same arguments as `condor_status`, which are documented in the
[HTCondor manual](http://research.cs.wisc.edu/htcondor/manual/v8.6/condor_status.html).
`condor_ce_status` takes the same arguments as `condor_status`, which is documented in the
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/man-pages/condor_status.html).

!!! note ""Missing" Worker Nodes"
An HTCondor-CE will not show any worker nodes (e.g. `Machine` entries in the `condor_ce_status -any` output) if
Expand Down Expand Up @@ -404,8 +435,9 @@ following command:
user@host $ condor_ce_config_val -config
```

`condor_ce_config_val` takes the same arguments as `condor_config_val` and is documented in the
[HTCondor manual](http://research.cs.wisc.edu/htcondor/manual/v8.6/condor_config_val.html).
`condor_ce_config_val` takes the same arguments as
`condor_config_val`, which is documented in the
[HTCondor manual](https://htcondor.readthedocs.io/en/lts/man-pages/condor_config_val.html).


condor_ce_reconfig
Expand Down
2 changes: 1 addition & 1 deletion docs/v23/troubleshooting/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ SharedPortLog
The HTCondor-CE shared port log keeps track of all connections to all of the HTCondor-CE daemons other than the
collector.
This log is a good place to check if experiencing connectivity issues with HTCondor-CE. More information can be found
[here](http://research.cs.wisc.edu/htcondor/manual/v8.6/3_9Networking_includes.html#SECTION00492000000000000000).
[here](https://htcondor.readthedocs.io/en/lts/admin-manual/networking.html#reducing-port-usage-with-the-condor-shared-port-daemon).

- Location: `/var/log/condor-ce/SharedPortLog`
- Key contents: Every attempt to connect to HTCondor-CE (except collector queries)
Expand Down

0 comments on commit 9b8cab6

Please sign in to comment.