diff --git a/docs/explanation/extended-reservation.rst b/docs/explanation/extended-reservation.rst new file mode 100644 index 00000000..d4116ad0 --- /dev/null +++ b/docs/explanation/extended-reservation.rst @@ -0,0 +1,10 @@ +Extended Reservation +============ + +Normal users can reserve a machine with Testflinger for a maximum of 6 hours. +However, for certain use cases this is limiting. Testflinger has the ability +to allow authorised clients to request longer reservation times. See the Reserve +section of the :doc:`Test Phase <../reference/test-phases>` documentation for more +information on how to set reservation times. +Using this feature requires :doc:`authenticating <./authentication>` with +Testflinger server. diff --git a/docs/explanation/index.rst b/docs/explanation/index.rst index 9a1e2d57..54189392 100644 --- a/docs/explanation/index.rst +++ b/docs/explanation/index.rst @@ -10,4 +10,5 @@ This section covers conceptual questions about Testflinger. queues job-priority restricted-queues + extended-reservation authentication diff --git a/docs/reference/test-phases.rst b/docs/reference/test-phases.rst index 3ef962fe..07c8ac85 100644 --- a/docs/reference/test-phases.rst +++ b/docs/reference/test-phases.rst @@ -178,6 +178,7 @@ Variables in ``reserve_data``: * ``ssh_keys``: The list of public SSH keys to use for reserving the device. Each line includes an identity provider name and your username on the provider's system. Testflinger uses the ``ssh-import-id`` command to import public SSH keys from trusted, online identity. Supported identities are Launchpad (``lp``) and GitHub (``gh``). * ``timeout``: Reservation time in seconds. The default is one hour (3600), and you can request a reservation for up to 6 hours (21600). + Authenticated clients can request longer :doc:`reservation times <../explanation/extended-reservation>` with prior authorisation. If either ``reserve_command`` is missing from the agent configuration, or the the ``reserve_data`` section is missing from the job, this phase will be skipped.