Skip to content

Commit 9ed3d68

Browse files
authored
Merge pull request #172 from jumpstarter-dev/glossary
Update glossary with definition for in-tree/out-of-tree standard/cust…
2 parents 2f50f69 + 5fdb004 commit 9ed3d68

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/source/glossary.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,14 @@ This project is still evolving, so these docs may be incomplete or out-of-date.
3434
* `Lease`: a time limited reservation of a exporter, a lease is created by a client
3535
and allows the client to use the exporter resources for a limited time.
3636

37-
* `DriverClass`: is the name of the driver class that is used to interact with
37+
* `driver class`: is the name of the driver class that is used to interact with
3838
the exporter resources.
39+
40+
* `driver client class`: is the name of the driver client class that is used directly
41+
by end users, it interacts with `DriverClass` remotely via remote procedure call to
42+
invoke `DriverClass` provided methods, which in turn interacts with the exporter resources.
43+
44+
* `driver`: is the name for `driver class` and the corresponding `driver client class`, not to
45+
be confused with `Driver`, the base class of all `driver class`. Drivers in the main `jumpstarter`
46+
repo are called `in-tree drivers`, otherwise called `out-of-tree drivers`. Drivers implementing
47+
predefined interfaces are called `standard drivers`, otherwise called `custom drivers`.

0 commit comments

Comments
 (0)