Skip to content

Commit ba7dc94

Browse files
committed
Update docs on reserved template variables
We deprecated the ``python_version`` field of ``user_runtime`` a while ago, so remove that and instead document the contents of the ``python`` field. While we're at it, sync the ``mapped_identity`` documentation with the other top-level fields by removing the ``mapped_identity.`` prefix from its sub-fields.
1 parent 9bec581 commit ba7dc94

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

docs/endpoints/templates.rst

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -196,23 +196,39 @@ user or admin:
196196
user submitting tasks, such as their Python version. The following fields are
197197
available:
198198

199-
- ``globus_compute_sdk_version``: Version string of the Globus Compute SDK
200-
- ``globus_sdk_version``: Version string of the base Globus SDK dependency
201-
- ``python_version``: Complete Python version string from ``sys.version``,
202-
including implementation details
199+
- ``globus_compute_sdk_version``: Version string of the Globus Compute SDK (e.g., ``"3.14.0"``)
200+
201+
- ``globus_sdk_version``: Version string of the base Globus SDK dependency (e.g., ``"3.63.0"``)
202+
203+
- ``python``: Contains information about the Python runtime. The following fields are available:
204+
205+
- ``version``: Python version string (e.g., ``"3.13.7"``)
206+
- ``version_tuple``: Python version tuple as a list (e.g., ``[3, 13, 7]``)
207+
- ``version_info``: Python version info from ``list(sys.version_info)`` (e.g., ``[3, 13, 7, 'final', 0]``)
208+
- ``implementation``: Python implementation (e.g., ``"CPython"``)
209+
- ``compiler``: String identifying the compiler used for compiling Python (e.g., ``"Clang 14.0.6"``)
210+
211+
- ``platform``: Contains general platform information from the host. The following fields are available:
212+
213+
- ``architecture``: Host architecture tuple as a list (e.g., ``["64bit", "ELF"]``)
214+
- ``machine``: Host machine type (e.g., ``"x86_64"``)
215+
- ``node``: Host node name (e.g., ``"login03"``)
216+
- ``platform``: Host platform (e.g., ``"Linux-6.14.0-29-generic-x86_64-with-glibc2.39"``)
217+
- ``processor``: Host processor name (e.g., ``"x86_64"``)
218+
- ``release``: Host OS release (e.g., ``"6.16.5-2-generic"``)
203219

204220
- ``mapped_identity``: Contains information about the user's mapped identity.
205221
The following fields are available:
206222

207-
- ``mapped_identity.local.uname``: Local user's username
208-
- ``mapped_identity.local.uid``: Local user's ID
209-
- ``mapped_identity.local.gid``: Local user's primary group ID
210-
- ``mapped_identity.local.groups``: List of group IDs the local user is a
223+
- ``local.uname``: Local user's username
224+
- ``local.uid``: Local user's ID
225+
- ``local.gid``: Local user's primary group ID
226+
- ``local.groups``: List of group IDs the local user is a
211227
member of
212-
- ``mapped_identity.local.gecos``: Local user's GECOS field
213-
- ``mapped_identity.local.shell``: Local user's login shell
214-
- ``mapped_identity.local.dir``: Local user's home directory
215-
- ``mapped_identity.globus.id``: Matched Globus identity ID
228+
- ``local.gecos``: Local user's GECOS field
229+
- ``local.shell``: Local user's login shell
230+
- ``local.dir``: Local user's home directory
231+
- ``globus.id``: Matched Globus identity ID
216232

217233
.. code-block:: yaml+jinja
218234
:caption: Example usage of ``mapped_identity`` in a template

0 commit comments

Comments
 (0)