Skip to content
This repository was archived by the owner on May 23, 2022. It is now read-only.

Commit 3a3fe2c

Browse files
committed
Merge branch 'master' into pr/SOFTWARE-5164.byelcmaps
2 parents d12cd7c + f4d7aa3 commit 3a3fe2c

File tree

102 files changed

+627
-4063
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+627
-4063
lines changed

docs/compute-element/covid-19.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To support COVID-19 work, the overall process includes the following:
2121
If neither solution is viable, or you'd like to discuss the options, please send email to
2222
<[email protected]> and we'll work with you to arrive at the best solution.
2323
- If you already provide resources through an OSG Hosted CE, skip to [this section](#requesting-covid-19-jobs).
24-
1. [Enable the OSG VO](../security/lcmaps-voms-authentication.md#configuring-the-lcmaps-voms-plugin) on your HTCondor-CE.
24+
1. [Enable the OSG VO](install-htcondor-ce.md#configuring-authentication) on your HTCondor-CE.
2525
1. Setup a job route specific to COVID-19 pilot jobs (documented below).
2626
The job route will allow you to prioritize these jobs using local policy in your site's cluster.
2727
1. (Optional) To attract more user jobs, install [CVMFS](../worker-node/install-cvmfs.md) and

docs/compute-element/htcondor-ce-overview.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ Before continuing with the overview, make sure that you are familiar with the fo
99
- An OSG site plan
1010
- What is a batch system and which one will you use ([HTCondor](http://htcondor.org/), PBS, LSF, SGE, or
1111
[SLURM](https://slurm.schedmd.com/))?
12-
- Security in the OSG via [GSI](https://gridcf.org/gct-docs/latest/gsic/index.html) (i.e.,
13-
[Certificate authorities](https://en.wikipedia.org/wiki/Certificate_authority), user and host
14-
[certificates](https://en.wikipedia.org/wiki/Public_key_certificate), proxies)
12+
- Security in the OSG via [host certificates](../security/host-certs/overview.md) to authenticate servers and
13+
[bearer tokens](../security/tokens/overview.md) to authenticate clients
1514
- Pilot jobs, frontends, and factories (i.e., [GlideinWMS](http://glideinwms.fnal.gov/doc.prd/index.html),
1615
AutoPyFactory)
1716

@@ -36,7 +35,7 @@ What is HTCondor-CE?
3635
--------------------
3736

3837
HTCondor-CE is a special configuration of the HTCondor software designed to be a job gateway solution for the OSG.
39-
It is configured to use the [JobRouter daemon](http://research.cs.wisc.edu/htcondor/manual/v8.6/5_4HTCondor_Job.html) to
38+
It is configured to use the [JobRouter daemon](https://htcondor.readthedocs.io/en/v9_0/grid-computing/job-router.html) to
4039
delegate jobs by transforming and submitting them to the site’s batch system.
4140

4241
Benefits of running the HTCondor-CE:
@@ -118,8 +117,8 @@ How the CE is Customized
118117
Aside from the [basic configuration](install-htcondor-ce.md#configuring-htcondor-ce) required in the CE
119118
installation, there are two main ways to customize your CE (if you decide any customization is required at all):
120119

121-
- **Deciding which VOs are allowed to run at your site:** The recommended method of authorizing VOs at your site is
122-
based on the [LCMAPS framework](../security/lcmaps-voms-authentication.md)
120+
- **Deciding which collaborations are allowed to run at your site:** collaborations will submit resource allocation
121+
requests to your CE using bearer tokens, and you can configure which collaboration's tokens you are willing to accept.
123122
- **How to filter and transform the grid jobs to be run on your batch system:** Filtering and transforming grid jobs
124123
(i.e., setting site-specific attributes or resource limits), requires configuration of your site’s job routes.
125124
For examples of common job routes, consult the [JobRouter recipes](job-router-recipes.md) page.
@@ -132,17 +131,14 @@ installation, there are two main ways to customize your CE (if you decide any cu
132131
How Security Works
133132
------------------
134133

135-
In the OSG, security depends on a PKI infrastructure involving Certificate Authorities (CAs) where CAs sign and issue
136-
certificates.
137-
When these clients and hosts wish to communicate with each other, the identities of each party is confirmed by
138-
cross-checking their certificates with the signing CA and establishing trust.
139-
140-
In its default configuration, HTCondor-CE uses GSI-based authentication and authorization to verify the certificate
141-
chain, which will work with [LCMAPS VOMS authentication](../security/lcmaps-voms-authentication.md).
142-
Additionally, it can be reconfigured to provide alternate authentication mechanisms such as Kerberos, SSL, shared
143-
secret, or even IP-based authentication.
144-
More information about authorization methods can be found
145-
[here](http://research.cs.wisc.edu/htcondor/manual/v8.6/3_8Security.html#SECTION00483000000000000000).
134+
In the OSG, communication is secured between various parties using a combination of PKI infrastructure involving
135+
Certificate Authorities (CAs) and bearer tokens.
136+
Services such as a Compute Entrypoint, present [host certificates](../security/host-certs/overview.md) to prove their
137+
identity to clients, much like your browser verifies websites that you may visit.
138+
139+
And to use these services, clients present [bearer tokens](../security/tokens/overview.md) declaring their association
140+
with a given collaboration and what permissions the collaboration has given the client.
141+
In turn, the service may be configured to authorize the client based on their collaboration.
146142

147143
Next steps
148144
----------

docs/compute-element/install-htcondor-ce.md

Lines changed: 26 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The [HTCondor-CE](http://htcondor-ce.org) software is a *job gateway* for an OSG
77
As such, the OSG will submit resource allocation requests (RARs) jobs to your HTCondor-CE and it will handle
88
authorization and delegation of RARs to your local batch system.
99
In OSG today, RARs are sent to CEs as *pilot jobs* from a factory, which in turn are able to accept and run end-user jobs.
10-
See the [upstream documentation](https://htcondor.github.io/htcondor-ce/architecture/) for a more detailed introduction.
10+
See the [upstream documentation](https://htcondor.com/htcondor-ce/architecture/) for a more detailed introduction.
1111

1212
Use this page to learn how to install, configure, run, test, and troubleshoot an OSG HTCondor-CE.
1313

@@ -17,18 +17,17 @@ Use this page to learn how to install, configure, run, test, and troubleshoot an
1717

1818
!!! note
1919
If you are installing an HTCondor-CE for use outside of the OSG, consult
20-
[the upstream documentation](https://htcondor.github.io/htcondor-ce/v5/installation/htcondor-ce/) instead.
20+
[the upstream documentation](https://htcondor.com/htcondor-ce/) instead.
2121

2222
Before Starting
2323
---------------
2424

2525
Before starting the installation process, consider the following points, consulting the upstream references as needed
26-
([HTCondor-CE 5](https://htcondor.github.io/htcondor-ce/v5/reference/),
27-
[HTCondor-CE 4](https://htcondor.github.io/htcondor-ce/v4/reference/)):
26+
([HTCondor-CE 5](https://htcondor.com/htcondor-ce/v5/reference/)):
2827

2928
- **User IDs:** If they do not exist already, the installation will create the Linux users `condor` (UID 4716) and
30-
`gratia` (UID 42401)
31-
You will also need to create Unix accounts for each VO that you wish to support.
29+
`gratia`
30+
You will also need to create Unix accounts for each collaboration that you wish to support.
3231
See details in the ['Configuring authentication' section below](#configuring-authentication).
3332
- **SSL certificate:** The HTCondor-CE service uses a host certificate at `/etc/grid-security/hostcert.pem` and an
3433
accompanying key at `/etc/grid-security/hostkey.pem`
@@ -37,38 +36,17 @@ Before starting the installation process, consider the following points, consult
3736
- **Access point/login node:** HTCondor-CE should be installed on a host that already has the ability to submit jobs
3837
into your local cluster
3938
- **File Systems**: Non-HTCondor batch systems require a
40-
[shared file system](https://htcondor.github.io/htcondor-ce/v5/configuration/local-batch-system/#sharing-the-spool-directory)
39+
[shared file system](https://htcondor.com/htcondor-ce/v5/configuration/local-batch-system/#sharing-the-spool-directory)
4140
between the HTCondor-CE host and the batch system worker nodes.
4241

4342
As with all OSG software installations, there are some one-time (per host) steps to prepare in advance:
4443

4544
- Ensure the host has [a supported operating system](../release/supported_platforms.md)
4645
- Install the appropriate [EPEL](../common/yum.md#install-the-epel-repositories) and
4746
[OSG](../common/yum.md#install-the-osg-repositories) Yum repositories for your operating system.
48-
See [the next section](#choosing-the-osg-yum-repository) for guidance on choosing which OSG Yum repository to install.
4947
- Obtain root access to the host
5048
- Install [CA certificates](../common/ca.md)
5149

52-
Choosing the OSG Yum Repository
53-
-------------------------------
54-
55-
!!! danger "Before considering OSG 3.6&hellip;"
56-
Due to potentially disruptive changes in protocols, contact your virtual organization(s) (VO) to verify that they
57-
support token-based authentication and/or HTTP-based data transfer before considering an upgrade to OSG 3.6.
58-
If your VO(s) don't support these new protocols or you don't know which protocols your VO(s) support,
59-
install or remain on the [OSG 3.5 release series](../release/notes.md).
60-
61-
The OSG distributes different versions of HTCondor-CE and HTCondor in separate [YUM repositories](../common/yum.md).
62-
Most notably, the repository that you choose will determine the types of credentials that your CE is able to accept.
63-
Use the following table to decide OSG YUM repository to install HTCondor-CE:
64-
65-
| **YUM Repository** | **Bearer Tokens** | **GSI and VOMS** |
66-
|-----------------------------------------------------------------|-------------------|------------------|
67-
| OSG 3.5 upcoming **(recommended)**: HTCondor-CE 5, HTCondor 9.0 | &#9989; | &#9989; |
68-
| OSG 3.5 release: HTCondor-CE 4, HTCondor 8.8 | | &#9989; |
69-
| OSG 3.6 release: HTCondor-CE 5, HTCondor 9.0 | &#9989; | |
70-
71-
7250
Installing HTCondor-CE
7351
----------------------
7452

@@ -115,15 +93,8 @@ To simplify installation, OSG provides convenience RPMs that install all require
11593

11694
1. Install the CE software where `<PACKAGE>` is the package you selected in the above step.:
11795

118-
- If you have decided to install from [3.5 upcoming](#choosing-the-osg-yum-repository), run the following command
119-
120-
:::console
121-
root@host # yum install --enablerepo=osg-upcoming <PACKAGE>
122-
123-
- Otherwise, run the following command:
124-
125-
:::console
126-
root@host # yum install <PACKAGE>
96+
:::console
97+
root@host # yum install <PACKAGE>
12798

12899

129100
Configuring HTCondor-CE
@@ -134,27 +105,15 @@ For more advanced configuration, see the section on [optional configurations](#o
134105

135106
### Configuring the local batch system ###
136107

137-
To configure HTCondor-CE to integrate with your local batch system, please refer to the upstream documentation based on
138-
your installed version of HTCondor-CE:
139-
140-
- [HTCondor-CE 5](https://htcondor.github.io/htcondor-ce/v5/configuration/local-batch-system/)
141-
- [HTCondor-CE 4](https://htcondor.github.io/htcondor-ce/v4/installation/htcondor-ce/#configuring-the-batch-system)
108+
To configure HTCondor-CE to integrate with your local batch system,
109+
please refer to the [upstream documentation](https://htcondor.com/htcondor-ce/v5/configuration/local-batch-system/).
142110

143111
### Configuring authentication ###
144112

145-
Depending on the OSG repository from which you have installed HTCondor-CE, you can allow pilot job submission to your CE
146-
based on X.509 proxies (i.e., GSI and VOMS), bearer tokens, or both.
147-
148-
#### GSI and VOMS (OSG 3.5 only) ####
149-
150-
To configure which VOs and users are authorized to submit pilot jobs to your HTCondor-CE, follow the instructions in
151-
[the LCMAPS VOMS plugin document](../security/lcmaps-voms-authentication.md#configuring-the-lcmaps-voms-plugin).
152-
153-
154-
#### Bearer Tokens (OSG 3.5 upcoming, OSG 3.6)####
155-
113+
HTCondor-CE clients will submit RARs accompanied by [bearer tokens](../security/tokens/overview.md) declaring their
114+
association with a given collaboration and what permissions the collaboration has given the client
156115
The `osg-scitokens-mapfile`, pulled in by the `osg-ce` package, provides default token to local user mappings.
157-
To add support for a particular VO:
116+
To accept RARs from a particular collaboration:
158117

159118
1. Create the Unix account(s) corresponding to the last field in the default mapfile:
160119
`/usr/share/condor-ce/mapfiles.d/osg-scitokens-mapfile.conf`.
@@ -171,7 +130,7 @@ To add support for a particular VO:
171130
SCITOKENS /^https\:\/\/scitokens\.org\/osg\-connect,/ osgpilot
172131

173132
For more details of the mapfile format, consult the "SciTokens" section of the
174-
[upstream documentation](https://htcondor.github.io/htcondor-ce/v5/configuration/authentication/#scitokens).
133+
[upstream documentation](https://htcondor.com/htcondor-ce/v5/configuration/authentication/#scitokens).
175134

176135

177136
### Automatic configuration
@@ -204,14 +163,10 @@ the different pieces of software required for an OSG HTCondor-CE:
204163

205164
In addition to the configurations above, you may need to further configure how pilot jobs are filtered and transformed
206165
before they are submitted to your local batch system or otherwise change the behavior of your CE.
207-
For detailed instructions, please refer to the upstream documentation based on your installed version of HTCondor-CE:
166+
For detailed instructions, please refer to the upstream documentation:
208167

209-
- HTCondor-CE 5
210-
- [Configuring the Job Router](https://htcondor.github.io/htcondor-ce/v5/configuration/job-router-overview/)
211-
- [Optional configuration](https://htcondor.github.io/htcondor-ce/v5/configuration/optional-configuration/)
212-
- HTCondor-CE 4
213-
- [Configuring the Job Router](https://htcondor.github.io/htcondor-ce/v4/batch-system-integration/)
214-
- [Optional configuration](https://htcondor.github.io/htcondor-ce/v4/installation/htcondor-ce/#optional-configuration)
168+
- [Configuring the Job Router](https://htcondor.com/htcondor-ce/v5/configuration/job-router-overview/)
169+
- [Optional configuration](https://htcondor.com/htcondor-ce/v5/configuration/optional-configuration/)
215170

216171
#### Accounting with multiple CEs or local user jobs
217172

@@ -220,61 +175,26 @@ For detailed instructions, please refer to the upstream documentation based on y
220175

221176
If your site has multiple CEs or you have non-grid users submitting to the same local batch system, the OSG accounting
222177
software needs to be configured so that it doesn't over report the number of jobs.
223-
224-
1. Determine which file you need to modify
225-
226-
- **For OSG 3.5 installations,** use the following table:
227-
228-
| If your batch system is… | Then edit the following file on each of your CE(s)… |
229-
|:-------------------------|:--------------------------------------------|
230-
| LSF | `/etc/gratia/pbs-lsf/ProbeConfig` |
231-
| PBS | `/etc/gratia/pbs-lsf/ProbeConfig` |
232-
| SGE | `/etc/gratia/sge/ProbeConfig` |
233-
| SLURM | `/etc/gratia/slurm/ProbeConfig` |
234-
235-
- **For OSG 3.6 installations,** you'll need to modify `/etc/gratia/htcondor-ce/ProbeConfig`
236-
237-
1. Edit the value of `SuppressNoDNRecords` on each of your CE's so that it reads:
178+
Modify the value of `SuppressNoDNRecords` in `/etc/gratia/htcondor-ce/ProbeConfig` on each of your CE's so that it
179+
reads:
238180

239181
:::file
240182
SuppressNoDNRecords="1"
241183

242184
Starting and Validating HTCondor-CE
243185
-----------------------------------
244186

245-
For information on how to start and validate the core HTCondor-CE services, please refer to the upstream documentation
246-
based on your installed version of HTCondor-CE:
247-
248-
- [HTCondor-CE 5](https://htcondor.github.io/htcondor-ce/v5/verification/)
249-
- [HTCondor-CE 4](https://htcondor.github.io/htcondor-ce/v4/verification/)
250-
251-
### Enabling OSG accounting (OSG 3.5 only)
252-
253-
In addition to the core HTCondor-CE services, an OSG 3.5 HTCondor-CE must also start and enable the accounting service,
254-
`gratia-probes-cron`:
255-
256-
```console
257-
root@host # systemctl start gratia-probes-cron
258-
root@host # systemctl enable gratia-probes-cron
259-
```
260-
261-
In OSG 3.6, OSG accounting is managed directly by HTCondor-CE
262-
(see the [update instructions](../release/updating-to-osg-36.md#gratia-probe) for more details).
187+
For information on how to start and validate the core HTCondor-CE services, please refer to the
188+
[upstream documentation](https://htcondor.com/htcondor-ce/v5/verification/)
263189

264190
Troubleshooting HTCondor-CE
265191
---------------------------
266192

267-
For information on how to troubleshoot your HTCondor-CE, please refer to the upstream documentation based on your
268-
installed version of HTCondor-CE:
269-
270-
- HTCondor-CE 5:
271-
- [Common issues](https://htcondor.github.io/htcondor-ce/v5/troubleshooting/common-issues/)
272-
- [Debugging tools](https://htcondor.github.io/htcondor-ce/v5/troubleshooting/debugging-tools/)
273-
- [Helpful logs](https://htcondor.github.io/htcondor-ce/v5/troubleshooting/logs/)
274-
- HTCondor-CE 4
275-
- [Common issues](https://htcondor.github.io/htcondor-ce/v4/troubleshooting/troubleshooting/#htcondor-ce-troubleshooting-items)
276-
- [Debugging tools](https://htcondor.github.io/htcondor-ce/v4/troubleshooting/troubleshooting/#htcondor-ce-troubleshooting-tools)
277-
- [Helpful logs](https://htcondor.github.io/htcondor-ce/v4/troubleshooting/troubleshooting/#htcondor-ce-troubleshooting-data)
193+
For information on how to troubleshoot your HTCondor-CE, please refer to the upstream documentation:
194+
195+
- [Common issues](https://htcondor.com/htcondor-ce/v5/troubleshooting/common-issues/)
196+
- [Debugging tools](https://htcondor.com/htcondor-ce/v5/troubleshooting/debugging-tools/)
197+
- [Helpful logs](https://htcondor.com/htcondor-ce/v5/troubleshooting/logs/)
278198

279199
Registering the CE
280200
------------------

0 commit comments

Comments
 (0)