EDG-MKGRIDMAP(8)

πŸ“¦ version 4.0.6, in epel 10, epel 9, fedora 43, fedora 44

πŸ’– EDG-MKGRIDMAP(8) β€” the grid-mapfile glow-up tool πŸ’–

okay bestie, gather round, because this is the manual page for edg-mkgridmap, and she is that girl. she builds your grid-mapfile. she's section 8 (system administration, iykyk). let's get into it 🫢


✨ NAME ✨

edg-mkgridmap β€” a tool to build the grid-mapfile. that's it, that's the whole job, and she does it flawlessly πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

edg-mkgridmap [--help] [--version]
              [--conf=config_file]
              [--output[=output_file]]
              [--quiet] [--verbose]
              [--safe] [--nosafe]
              [--cache] [--nocache]
              [--proxy] [--noproxy]
              [--usermode]

like, look at all those options. she's got range πŸ’…


🌸 DESCRIPTION 🌸

edg-mkgridmap is a tool to build the grid-mapfile from VO servers, taking into account both VO and local policies. no cap. VO policies AND local policies, she's holding both of those at once and she's not even sweating.


πŸŽ€ CONFIGURATION πŸŽ€

the edg-mkgridmap.conf file contains configuration information for edg-mkgridmap. it's literally where she keeps all her settings.

the syntax of the edg-mkgridmap.conf file is discussed seperately. bestie, go read edg-mkgridmap.conf(5) for the detailed reference information, I'm not gonna recite it all here.

the default location is /etc/edg-mkgridmap.conf.

the file essentially consists of a list of directives composed by a keyword and one or more arguments. optional arguments are put in square brackets, so [like this].

  • group URI [lcluser]
  • default_lcluser default_lcluser
  • auth URI
  • allowβŽͺdeny pattern_to_match
  • gmf_local grid-mapfile-local

those are the directives. five of them. memorise them or don't, I'm not your mum 🌈


πŸ’… OPTIONS πŸ’…

  • --help β€” prints a summary of the command line options and exits. she's giving you the rundown and then she's gone.
  • --version β€” prints the version of edg-mkgridmap and exits. yes she has a version, yes she's proud of it.
  • --conf=config_file β€” specifies the configuration file that is used by edg-mkgridmap. if you omit it, edg-mkgridmap checks /var/lib/edg-mkgridmap/etc/edg-mkgridmap.conf to see if a machine-specific configuration has been setup. and if such a file is not present, edg-mkgridmap uses the default configuration file /etc/edg-mkgridmap.conf. so it's like a lil hunt: machine-specific first, default second.
  • --output[=output_file] β€” specifies the output file. if omitted, stdout is used. if the optional argument output_file is omitted, the value of the environment variable GRIDMAP is used. and if GRIDMAP is not set, then the default value /etc/grid-security/grid-mapfile is used. three layers of fallback, she's thorough like that.
  • --quiet β€” turn off error messages. shhh. silence. iconic.
  • --verbose β€” print lots of useful informations. this one gets ignored if --quiet is specified, so don't try to have both, pick a lane bestie.
  • --safe, --nosafe β€” per group keep (--safe) or remove (--nosafe) the old grid-mapfile entries that are not found back, when at least one of the sources for that group directive had a problem. default is remove (--nosafe). so by default she's deleting stuff when a source acts up β€” know that before you run her 😭
  • --cache, --nocache β€” disable (--cache) or enable (--nocache) the grid-mapfile update when its contents remain unchanged. default is enable (--nocache). yes, the names are like that, I'm just reporting the facts.
  • --proxy, --noproxy β€” enable (--proxy) or disable (--noproxy) proxy support for HTTP/HTTPS and VOMS/VOMSS connections. default is disable (--noproxy). the proxy support must be configured through appropriate environmental variables. she's not doing it for you, she's just enabling the support, periodt.
  • --usermode β€” facilitate running the script as an ordinary user by having the relevant environment variables point to the user's X509 proxy instead of using the personal certificate and key. the user's proxy is taken from the X509_USER_PROXY environment variable, if defined, else from the default location /tmp/x509up_u$UID. so you too can run her, not just the root girlies 🫢

😭 ERRORS 😭

in case of one or more errors, edg-mkgridmap returns an exit code which is computed adding these possible values. yes, adding. the numbers stack up, so read them carefully.

  • 1 per group directive for which a server could not be contacted. so if three servers ghosted her, that's 3.
  • 16 β€” error reading the configuration file.
  • 32 β€” error writing the grid-mapfile.
  • 64 β€” error with a group directive.
  • 128 β€” error with an auth directive.

πŸ” DIAGNOSTICS πŸ”

the --verbose option produces some useful diagnostics. she's talkative and honestly? it's helpful.

any error message generated by edg-mkgridmap is logged to the syslogd. so if you're staring at your terminal like "where did the error go" β€” syslogd, bestie. check syslogd.


🌈 ENVIRONMENT 🌈

  • EDG_MKGRIDMAP_OPTIONS β€” used to specify command line options.
  • GRIDMAP β€” used to determine the location of the grid-mapfile. if not set, then the default value /etc/grid-security/grid-mapfile is used.
  • CERTDIR β€” used to determine the directory containing CA certificates. if not set, then the default value /etc/grid-security/certificates is used.
  • X509_USER_CERT β€” used to determine the location of the host certificate. if not set, then the default value /etc/grid-security/hostcert.pem is used.
  • X509_USER_KEY β€” used to determine the location of the host private key. if not set, then the default value /etc/grid-security/hostkey.pem is used.
  • X509_USER_PROXY β€” used to determine the location of the user's proxy when the --usermode option is given. if not set, the default value /tmp/x509up_u$UID is used.
  • http_proxy β€” used to determine the proxy for HTTP connections. the syntax is:
http_proxy="[http://]<host>:<port>"
  • https_proxy β€” used to determine the proxy for HTTPS connections. the syntax is:
https_proxy="[http://]<host>:<port>"

look at all those env vars. she reads the room. she reads the environment. πŸ’œ


⭐ EXAMPLES ⭐

edg-mkgridmap

writes the grid-mapfile to the standard output.

edg-mkgridmap --output=-

writes the grid-mapfile to the standard output.

edg-mkgridmap --output

writes the grid-mapfile to the default location of the grid-mapfile.

edg-mkgridmap --output=<output_file>

writes the grid-mapfile to <output_file>.

see how edg-mkgridmap and edg-mkgridmap --output=- do the same thing? yeah. she contains multitudes.


πŸ“ FILES πŸ“

  • /var/lib/edg-mkgridmap/etc/edg-mkgridmap.conf
  • /etc/edg-mkgridmap.conf
  • /usr/libexec/edg-mkgridmap/local-subject2user

🧚 SEE ALSO 🧚

edg-mkgridmap.conf(5) β€” go read her sister page, she's got the lore.


πŸ‘‘ AUTHORS πŸ‘‘

EU DataGrid Authorization Working Group, EGEE Middleware Security Group, Maarten Litmaath (CERN/WLCG). absolute legends, all of them, no notes πŸ’–


that's the whole page bestie!! go build that grid-mapfile, you're gonna eat πŸ’…βœ¨

and for the sign-off: this page is dated 2011-04-03, and it's the EDG-MKGRIDMAP(8) manual page, living in the section-8 house. she's been here since 2011 and she's still serving πŸ’œπŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from