diff --git a/.github/workflows/branch-e2e.yml b/.github/workflows/branch-e2e.yml index 858e1631bc..df5fbdd7a3 100644 --- a/.github/workflows/branch-e2e.yml +++ b/.github/workflows/branch-e2e.yml @@ -216,7 +216,7 @@ jobs: build-rpm: name: Build RPM packages - needs: [pr_metadata, version, build-binaries] + needs: [pr_metadata, version, build-binaries, build-vm-driver] if: needs.pr_metadata.outputs.run_integration == 'true' permissions: actions: read diff --git a/.github/workflows/build-rpm.yml b/.github/workflows/build-rpm.yml index 5050372df0..1f4db2494c 100644 --- a/.github/workflows/build-rpm.yml +++ b/.github/workflows/build-rpm.yml @@ -90,10 +90,16 @@ jobs: name: openshell-prover-${{ inputs.prover-target }} path: package-binaries/ + - name: Download VM driver artifact + uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 + with: + name: openshell-driver-vm-${{ inputs.gateway-target }} + path: package-binaries/ + - name: Configure package inputs run: | set -euo pipefail - chmod +x package-binaries/openshell{,-gateway,-prover} + chmod +x package-binaries/openshell{,-gateway,-prover,-driver-vm} ls -lah package-binaries - name: Mark workspace safe for git @@ -124,6 +130,19 @@ jobs: echo "=== Built RPMs ===" ls -lah artifacts/ + - name: Verify installed VM driver RPM + run: | + set -euo pipefail + vm_rpms=(artifacts/openshell-driver-vm-[0-9]*.rpm) + test "${#vm_rpms[@]}" -eq 1 + test -f "${vm_rpms[0]}" + rpm -qlp "${vm_rpms[0]}" | grep -Fx /usr/libexec/openshell/openshell-driver-vm + rpm -qpR "${vm_rpms[0]}" | grep -Fx 'e2fsprogs >= 1.43' + rpm -qpR "${vm_rpms[0]}" | grep -Fx "openshell-gateway = $(rpm -qp --qf '%{VERSION}-%{RELEASE}' "${vm_rpms[0]}")" + dnf install -y artifacts/openshell-[0-9]*.rpm artifacts/openshell-gateway-[0-9]*.rpm "${vm_rpms[0]}" + /usr/libexec/openshell/openshell-driver-vm --version + bash tasks/scripts/test-rpm-vm-install.sh + - name: Upload RPM artifacts uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7 with: diff --git a/.github/workflows/release-build.yml b/.github/workflows/release-build.yml index c85d29d2fc..1c940b05e2 100644 --- a/.github/workflows/release-build.yml +++ b/.github/workflows/release-build.yml @@ -217,7 +217,7 @@ jobs: build-rpm: name: Build RPM Packages - needs: [compute-versions, build-binaries] + needs: [compute-versions, build-binaries, build-vm-driver] uses: ./.github/workflows/rpm-package.yml with: checkout-ref: ${{ needs.compute-versions.outputs.source_sha }} diff --git a/.github/workflows/release-dev.yml b/.github/workflows/release-dev.yml index eae71894e5..9e7c32c803 100644 --- a/.github/workflows/release-dev.yml +++ b/.github/workflows/release-dev.yml @@ -248,7 +248,7 @@ jobs: build-rpm: name: Build RPM Packages - needs: [compute-versions, build-binaries] + needs: [compute-versions, build-binaries, build-vm-driver] uses: ./.github/workflows/rpm-package.yml with: checkout-ref: ${{ github.sha }} diff --git a/crates/openshell-driver-vm/README.md b/crates/openshell-driver-vm/README.md index a0371bacfb..49ea9294fd 100644 --- a/crates/openshell-driver-vm/README.md +++ b/crates/openshell-driver-vm/README.md @@ -327,7 +327,10 @@ auto-detection. Set `OPENSHELL_COMPUTE_DRIVER=vm` to force the VM driver. On RPM-family Linux x86_64 and aarch64 systems, `install.sh` installs the `openshell` and `openshell-gateway` RPM packages from the selected release tag. -The RPM gateway package is configured for the Podman driver. +Install the matching `openshell-driver-vm` RPM separately to use MicroVMs; it +places the driver under `/usr/libexec/openshell` and requires `e2fsprogs`. +The RPM gateway package remains configured for Podman until you select +`compute_driver = "vm"` in gateway TOML. On Apple Silicon macOS, `install.sh` stages the generated `openshell.rb` formula from the selected release in the `nvidia/openshell` Homebrew tap. diff --git a/deploy/rpm/CONFIGURATION.md b/deploy/rpm/CONFIGURATION.md index 79777fa561..7b5e07605c 100644 --- a/deploy/rpm/CONFIGURATION.md +++ b/deploy/rpm/CONFIGURATION.md @@ -32,6 +32,36 @@ interface. this, the gateway auto-detects in order: Kubernetes, Podman, Docker. Pinning prevents unexpected driver selection if Docker is also installed on the host. +### MicroVM driver + +On a Fedora or RHEL host with KVM, install the optional VM driver RPM: + +```shell +sudo dnf install openshell-driver-vm +``` + +The package installs `/usr/libexec/openshell/openshell-driver-vm`, which the +gateway searches without a `driver_dir` override. It requires the matching +`openshell-gateway` build and `e2fsprogs` 1.43 or newer. In your existing +`~/.config/openshell/gateway.toml`, change the gateway selector to: + +```toml +[openshell.gateway] +compute_driver = "vm" +``` + +Keep the other settings in that file. Check the selected VM host tools, then +restart the service: + +```shell +openshell-gateway config preflight --path ~/.config/openshell/gateway.toml +systemctl --user restart openshell-gateway +``` + +The RPM default remains Podman until you select `vm`. See the [VM driver +configuration](https://docs.nvidia.com/openshell/latest/how-it-works/gateways/configuration#microvm) +for VM-specific settings. + ### Customizing the configuration Edit `~/.config/openshell/gateway.toml` directly. The package-owned template at @@ -319,6 +349,7 @@ For air-gapped environments: | Purpose | Path | |---------|------| | Gateway binary | `/usr/bin/openshell-gateway` | +| Optional VM driver binary | `/usr/libexec/openshell/openshell-driver-vm` | | CLI binary | `/usr/bin/openshell` | | Systemd user unit | `/usr/lib/systemd/user/openshell-gateway.service` | | Default TOML config template (read-only) | `/usr/share/openshell-gateway/gateway.toml.default` | diff --git a/deploy/rpm/QUICKSTART.md b/deploy/rpm/QUICKSTART.md index fe0851ebcb..2f6ef236dc 100644 --- a/deploy/rpm/QUICKSTART.md +++ b/deploy/rpm/QUICKSTART.md @@ -157,7 +157,7 @@ openshell sandbox provider attach openai ## Next steps - See CONFIGURATION.md for TLS settings, environment variables, and - file locations. + file locations, including how to install and select the optional MicroVM driver. - See TROUBLESHOOTING.md for CLI compatibility notes, remote access, and common issues. - Run `man openshell` for the CLI reference. diff --git a/deploy/rpm/licenses/LICENSE-GPL-2.0-only b/deploy/rpm/licenses/LICENSE-GPL-2.0-only new file mode 100644 index 0000000000..10828e06ec --- /dev/null +++ b/deploy/rpm/licenses/LICENSE-GPL-2.0-only @@ -0,0 +1,341 @@ + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/deploy/rpm/licenses/LICENSE-LGPL-2.1-only b/deploy/rpm/licenses/LICENSE-LGPL-2.1-only new file mode 100644 index 0000000000..4362b49151 --- /dev/null +++ b/deploy/rpm/licenses/LICENSE-LGPL-2.1-only @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/docs/how-it-works/gateways/configuration.mdx b/docs/how-it-works/gateways/configuration.mdx index 3d5680301d..9dbbcae0a0 100644 --- a/docs/how-it-works/gateways/configuration.mdx +++ b/docs/how-it-works/gateways/configuration.mdx @@ -1561,7 +1561,15 @@ runtime-selected profile. Each sandbox runs inside its own libkrun microVM managed by the standalone `openshell-driver-vm` subprocess. Use this driver when you want stronger isolation than container namespaces alone. -The example uses explicit launch-signing paths. Point them at an existing signing bundle, or omit the `gateway_jwt` table to use local discovery. Listener and guest TLS certificates do not supply these signing credentials. +On Fedora or RHEL with KVM, install the optional RPM before selecting the driver. It places the binary where the gateway already searches and requires the matching gateway build and `e2fsprogs`: + +```shell +sudo dnf install openshell-driver-vm +``` + +In the RPM user service's existing `~/.config/openshell/gateway.toml`, change `compute_driver = "podman"` to `compute_driver = "vm"` and keep the other settings. No `driver_dir` override is needed. Run `openshell-gateway config preflight --path ~/.config/openshell/gateway.toml` before restarting the service. + +The following example shows a custom deployment with explicit paths, including launch-signing paths. Point them at an existing signing bundle, or omit the `gateway_jwt` table to use local discovery. Listener and guest TLS certificates do not supply these signing credentials. ```toml [openshell] @@ -1584,8 +1592,8 @@ gateway_id = "openshell" [openshell.drivers.vm] state_dir = "/var/lib/openshell/vm" -# Where the gateway looks for the openshell-driver-vm subprocess binary. -driver_dir = "/usr/local/libexec/openshell" +# Optional override; omit for the RPM's /usr/libexec/openshell path. +# driver_dir = "/usr/local/libexec/openshell" default_image = "nvcr.io/nvidia/base/ubuntu:24.04" # Optional override. When omitted, the gateway derives # https://host.openshell.internal: for the VM driver. @@ -1734,7 +1742,7 @@ systemctl --user restart openshell-gateway ### Check local VM host tools -For an explicitly selected local `vm` driver, preflight also checks a formatter (`mke2fs` or `mkfs.ext4`), `debugfs`, and `e2fsck`. Install e2fsprogs 1.43 or newer with your operating system's package manager. OpenShell does not install or manage these host dependencies. +For an explicitly selected local `vm` driver, preflight also checks a formatter (`mke2fs` or `mkfs.ext4`), `debugfs`, and `e2fsck`. The RPM driver package requires e2fsprogs 1.43 or newer. For other installs, install these host tools with your operating system's package manager. For example, on macOS: diff --git a/openshell.spec b/openshell.spec index 2af40c1734..fef3b9433e 100644 --- a/openshell.spec +++ b/openshell.spec @@ -19,8 +19,9 @@ Summary: Safe, sandboxed runtimes for autonomous AI agents # OpenShell's own code is Apache-2.0. The binaries statically link third-party # crates; this is the minimal SPDX expression covering every crate linked into -# openshell, openshell-gateway and openshell-prover (computed from `cargo tree` -# license metadata, treating "X OR MIT" as satisfied by MIT or Apache-2.0). +# openshell, openshell-gateway, openshell-driver-vm, and openshell-prover +# (computed from `cargo tree` license metadata, treating "X OR MIT" as +# satisfied by MIT or Apache-2.0). # The docs, man page sources, config templates and Python SDK sources carry # Apache-2.0 SPDX headers or fall under the repository LICENSE. The unit file is # generated from this spec. Re-check when Cargo.lock changes. @@ -65,6 +66,18 @@ lifecycle management. This package installs Podman-oriented defaults in gateway TOML while leaving compute driver selection to gateway auto-detection or explicit operator configuration. +# --- Optional VM compute driver sub-package --- +%package driver-vm +Summary: OpenShell MicroVM compute driver +# The embedded libkrunfw library and guest Linux kernel have separate licenses. +License: Apache-2.0 AND BSD-3-Clause AND CC0-1.0 AND CDLA-Permissive-2.0 AND GPL-2.0-only AND ISC AND LGPL-2.1-only AND MIT AND Unicode-3.0 AND Zlib +Requires: %{name}-gateway = %{version}-%{release} +Requires: e2fsprogs >= 1.43 + +%description driver-vm +Standalone MicroVM compute driver for the OpenShell gateway. Install this +package on a KVM host and select compute_driver = "vm" in gateway TOML. + # --- Standalone policy prover sub-package --- %package prover Summary: Standalone OpenShell policy boundary prover @@ -106,6 +119,7 @@ grep -q 'version = "%{openshell_cargo_version}"' Cargo.toml || (echo "ERROR: Car %build test -x "${OPENSHELL_PREBUILT_BINARIES_DIR}/openshell" test -x "${OPENSHELL_PREBUILT_BINARIES_DIR}/openshell-gateway" +test -x "${OPENSHELL_PREBUILT_BINARIES_DIR}/openshell-driver-vm" test -x "${OPENSHELL_PREBUILT_BINARIES_DIR}/openshell-prover" # Generate vendored crate manifest and license metadata. @@ -129,6 +143,9 @@ install -Dpm 0755 "${OPENSHELL_PREBUILT_BINARIES_DIR}/%{name}-prover" %{buildroo # --- Gateway binary --- install -Dpm 0755 "${OPENSHELL_PREBUILT_BINARIES_DIR}/%{name}-gateway" %{buildroot}%{_bindir}/%{name}-gateway +# --- VM compute driver --- +install -Dpm 0755 "${OPENSHELL_PREBUILT_BINARIES_DIR}/%{name}-driver-vm" %{buildroot}%{_libexecdir}/%{name}/%{name}-driver-vm + # --- Default gateway TOML config template --- # Shipped as a read-only reference in %{_datadir}. The systemd unit seeds a # user-level copy at ~/.config/openshell/gateway.toml on first start. @@ -244,6 +261,9 @@ touch %{buildroot}%{python3_sitelib}/%{name}-%{openshell_python_version}.dist-in # Smoke-test the gateway binary %{buildroot}%{_bindir}/%{name}-gateway --version +# Smoke-test the VM driver at the path the gateway searches by default. +%{buildroot}%{_libexecdir}/%{name}/%{name}-driver-vm --version + # Smoke-test the Python SDK version metadata via importlib.metadata. # We query the dist-info directly rather than importing the package because # the full import pulls in grpcio and other runtime deps not present in the @@ -314,6 +334,15 @@ grep -q 'gateway.toml.default.v1' %{buildroot}%{_userunitdir}/%{name}-gateway.se %{_datadir}/%{name}-gateway/gateway.toml.default.v1 %{_mandir}/man8/openshell-gateway.8* +%files driver-vm +%license LICENSE +%license LICENSE.dependencies +%license cargo-vendor.txt +%license deploy/rpm/licenses/LICENSE-GPL-2.0-only +%license deploy/rpm/licenses/LICENSE-LGPL-2.1-only +%dir %{_libexecdir}/%{name} +%{_libexecdir}/%{name}/%{name}-driver-vm + %files -n python3-%{name} %license LICENSE %{python3_sitelib}/%{name}/ diff --git a/skills/debug-openshell-cluster/SKILL.md b/skills/debug-openshell-cluster/SKILL.md index 9e56f7117c..3349499a5c 100644 --- a/skills/debug-openshell-cluster/SKILL.md +++ b/skills/debug-openshell-cluster/SKILL.md @@ -1485,7 +1485,7 @@ gateway chart. Use the VM driver logs and host diagnostics available in the user's environment. Verify: -- The VM driver process is running and reachable by the gateway. +- The VM driver process is running and reachable by the gateway. On RPM hosts, use `rpm -q openshell-driver-vm` and `rpm -ql openshell-driver-vm` to confirm that the matching package owns `/usr/libexec/openshell/openshell-driver-vm`. Preflight checks host tools but does not resolve or launch the driver binary. - The runtime rootfs exists and matches the expected architecture. - `mke2fs` or `mkfs.ext4`, `debugfs`, and `e2fsck` from e2fsprogs are installed. Run `openshell-gateway config preflight` with the intended local VM configuration, service account, and environment to check the selected paths and versions before startup. A remote endpoint reports that host checks were not performed. Explicit `sandbox_uid`/`sandbox_gid` does not remove this prerequisite. - A persisted overlay identity error is resolved from its owner marker, overlay diff --git a/tasks/scripts/rpm_vm_packaging_test.py b/tasks/scripts/rpm_vm_packaging_test.py new file mode 100644 index 0000000000..9c6a1aad4d --- /dev/null +++ b/tasks/scripts/rpm_vm_packaging_test.py @@ -0,0 +1,78 @@ +# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 + +"""Regression checks for the RPM VM driver packaging inputs.""" + +from pathlib import Path + +import pytest +import yaml + +ROOT = Path(__file__).resolve().parents[2] + + +@pytest.mark.parametrize( + "workflow_name", + ["branch-e2e.yml", "release-build.yml", "release-dev.yml"], +) +def test_rpm_waits_for_vm_driver_artifact(workflow_name: str) -> None: + workflow_path = ROOT / ".github" / "workflows" / workflow_name + workflow = yaml.load( + workflow_path.read_text(encoding="utf-8"), Loader=yaml.BaseLoader + ) + jobs = workflow["jobs"] + + assert "build-vm-driver" in jobs["build-rpm"]["needs"] + assert "build-binaries" in jobs["build-vm-driver"]["needs"] + + +def test_tmachine_rpm_stages_vm_driver_binary() -> None: + artifacts = (ROOT / "tests" / "tmachine" / "artifacts.nix").read_text( + encoding="utf-8" + ) + rpm_builder = artifacts.split('name = "build-artifacts-rpm";', 1)[1].split( + "\n };", 1 + )[0] + driver_path = "artifacts/binaries/${gnuToolchain.target}/openshell-driver-vm" + + assert f"{driver_path}; do" in rpm_builder + assert ( + f'--volume "$root/{driver_path}:/binaries/openshell-driver-vm:ro"' + in rpm_builder + ) + + +def test_vm_rpm_declares_bundled_native_runtime_licenses() -> None: + spec = (ROOT / "openshell.spec").read_text(encoding="utf-8") + vm_package = spec.split("%package driver-vm", 1)[1].split( + "%description driver-vm", 1 + )[0] + vm_files = spec.split("%files driver-vm", 1)[1].split("%files -n", 1)[0] + license_expression = next( + line.partition(":")[2] + for line in vm_package.splitlines() + if line.startswith("License:") + ) + + assert "GPL-2.0-only" in license_expression + assert "LGPL-2.1-only" in license_expression + for name, heading in ( + ("LICENSE-GPL-2.0-only", "GNU GENERAL PUBLIC LICENSE"), + ("LICENSE-LGPL-2.1-only", "GNU LESSER GENERAL PUBLIC LICENSE"), + ): + path = ROOT / "deploy" / "rpm" / "licenses" / name + assert heading in path.read_text(encoding="utf-8") + assert f"%license deploy/rpm/licenses/{name}" in vm_files + + +def test_rpm_workflow_starts_installed_vm_driver() -> None: + workflow_path = ROOT / ".github" / "workflows" / "build-rpm.yml" + workflow = yaml.load( + workflow_path.read_text(encoding="utf-8"), Loader=yaml.BaseLoader + ) + steps = workflow["jobs"]["build"]["steps"] + verify = next( + step for step in steps if step.get("name") == "Verify installed VM driver RPM" + ) + + assert "bash tasks/scripts/test-rpm-vm-install.sh" in verify["run"] diff --git a/tasks/scripts/test-rpm-vm-install.sh b/tasks/scripts/test-rpm-vm-install.sh new file mode 100755 index 0000000000..65ab39322e --- /dev/null +++ b/tasks/scripts/test-rpm-vm-install.sh @@ -0,0 +1,85 @@ +#!/usr/bin/env bash +# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 + +# Verify that the installed gateway starts the VM driver from its package path. +set -euo pipefail + +gateway_bin=${OPENSHELL_RPM_SMOKE_GATEWAY_BIN:-/usr/bin/openshell-gateway} +driver_bin=${OPENSHELL_RPM_SMOKE_DRIVER_BIN:-/usr/libexec/openshell/openshell-driver-vm} +test -x "$gateway_bin" +test -x "$driver_bin" + +smoke_dir=$(mktemp -d) +gateway_pid= +driver_pid= +cleanup() { + if [[ -n "$gateway_pid" ]]; then + kill "$gateway_pid" 2>/dev/null || true + wait "$gateway_pid" 2>/dev/null || true + fi + if [[ -n "$driver_pid" && -e "/proc/$driver_pid/exe" ]]; then + if [[ "$(readlink -f "/proc/$driver_pid/exe" 2>/dev/null || true)" == "$driver_bin" ]]; then + kill "$driver_pid" 2>/dev/null || true + fi + fi + rm -rf -- "$smoke_dir" +} +trap cleanup EXIT + +cat >"$smoke_dir/gateway.toml" <"$smoke_dir/gateway.log" 2>&1 & +gateway_pid=$! + +for _ in {1..50}; do + if ! kill -0 "$gateway_pid" 2>/dev/null; then + cat "$smoke_dir/gateway.log" >&2 + echo "gateway exited before starting the packaged VM driver" >&2 + exit 1 + fi + if [[ ! -r "/proc/$gateway_pid/task/$gateway_pid/children" ]]; then + sleep 0.2 + continue + fi + for child_pid in $(<"/proc/$gateway_pid/task/$gateway_pid/children"); do + if [[ "$(readlink -f "/proc/$child_pid/exe" 2>/dev/null || true)" == "$driver_bin" ]]; then + driver_pid=$child_pid + break + fi + done + if [[ -n "$driver_pid" ]]; then + sleep 0.5 + if kill -0 "$gateway_pid" 2>/dev/null && kill -0 "$driver_pid" 2>/dev/null; then + echo "gateway started $driver_bin" + exit 0 + fi + fi + sleep 0.2 +done + +cat "$smoke_dir/gateway.log" >&2 +echo "gateway did not start $driver_bin" >&2 +exit 1 diff --git a/tasks/test.toml b/tasks/test.toml index 6bafa95e9e..ce5754e010 100644 --- a/tasks/test.toml +++ b/tasks/test.toml @@ -71,7 +71,10 @@ hide = true ["test:packaging-assets"] description = "Run static packaging asset tests" -run = "tasks/scripts/test-packaging-assets.sh" +run = [ + "tasks/scripts/test-packaging-assets.sh", + "uv run --no-project --with pytest --with pytest-asyncio --with pyyaml pytest tasks/scripts/rpm_vm_packaging_test.py", +] run_windows = "echo Skipping test:packaging-assets: Linux service and RPM assets do not apply on Windows." hide = true diff --git a/tests/tmachine/artifacts.nix b/tests/tmachine/artifacts.nix index 4dc79b4a4e..9604022538 100644 --- a/tests/tmachine/artifacts.nix +++ b/tests/tmachine/artifacts.nix @@ -434,9 +434,10 @@ rec { ''; }; - # Build the CLI and gateway RPMs the way .github/workflows/build-rpm.yml does: + # Build RPMs the way .github/workflows/build-rpm.yml does: # `packit build locally` with openshell.spec in the same Fedora image, packaging - # the binaries staged by build-artifacts-binaries. The container runs on the + # binaries staged by build-artifacts-binaries and build-artifacts-vm-driver. + # The container runs on the # host's Linux architecture, so the RPMs match the tmachine guest. rpm = pkgs.writeShellApplication { name = "build-artifacts-rpm"; @@ -460,9 +461,10 @@ rec { for binary in \ artifacts/binaries/${muslToolchain.target}/openshell \ artifacts/binaries/${gnuToolchain.target}/openshell-gateway \ - artifacts/binaries/${muslToolchain.target}/openshell-prover; do + artifacts/binaries/${muslToolchain.target}/openshell-prover \ + artifacts/binaries/${gnuToolchain.target}/openshell-driver-vm; do if [[ ! -x "$binary" ]]; then - echo "missing $binary; run build-artifacts-binaries first" >&2 + echo "missing $binary; run build-artifacts-binaries and build-artifacts-vm-driver first" >&2 exit 1 fi done @@ -479,6 +481,7 @@ rec { --volume "$root/artifacts/binaries/${muslToolchain.target}/openshell:/binaries/openshell:ro" \ --volume "$root/artifacts/binaries/${gnuToolchain.target}/openshell-gateway:/binaries/openshell-gateway:ro" \ --volume "$root/artifacts/binaries/${muslToolchain.target}/openshell-prover:/binaries/openshell-prover:ro" \ + --volume "$root/artifacts/binaries/${gnuToolchain.target}/openshell-driver-vm:/binaries/openshell-driver-vm:ro" \ --volume "$output_dir:/out" \ --volume openshell-rpm-cargo:/root/.cargo/registry \ --volume openshell-rpm-dnf:/var/cache/libdnf5 \