egrit-preflight 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- egrit_preflight-0.1.0/LICENSE +202 -0
- egrit_preflight-0.1.0/NOTICE +8 -0
- egrit_preflight-0.1.0/PKG-INFO +173 -0
- egrit_preflight-0.1.0/README.md +150 -0
- egrit_preflight-0.1.0/pyproject.toml +37 -0
- egrit_preflight-0.1.0/setup.cfg +4 -0
- egrit_preflight-0.1.0/src/egrit_preflight/__init__.py +3 -0
- egrit_preflight-0.1.0/src/egrit_preflight/__main__.py +12 -0
- egrit_preflight-0.1.0/src/egrit_preflight/cli.py +183 -0
- egrit_preflight-0.1.0/src/egrit_preflight/contract.py +257 -0
- egrit_preflight-0.1.0/src/egrit_preflight/doctor.py +106 -0
- egrit_preflight-0.1.0/src/egrit_preflight/host.py +67 -0
- egrit_preflight-0.1.0/src/egrit_preflight/image.py +520 -0
- egrit_preflight-0.1.0/src/egrit_preflight/outcomes.py +35 -0
- egrit_preflight-0.1.0/src/egrit_preflight/report.py +88 -0
- egrit_preflight-0.1.0/src/egrit_preflight/runner.py +96 -0
- egrit_preflight-0.1.0/src/egrit_preflight/safe.py +70 -0
- egrit_preflight-0.1.0/src/egrit_preflight/smoke.py +216 -0
- egrit_preflight-0.1.0/src/egrit_preflight.egg-info/PKG-INFO +173 -0
- egrit_preflight-0.1.0/src/egrit_preflight.egg-info/SOURCES.txt +32 -0
- egrit_preflight-0.1.0/src/egrit_preflight.egg-info/dependency_links.txt +1 -0
- egrit_preflight-0.1.0/src/egrit_preflight.egg-info/entry_points.txt +2 -0
- egrit_preflight-0.1.0/src/egrit_preflight.egg-info/top_level.txt +1 -0
- egrit_preflight-0.1.0/tests/test_cli_report.py +188 -0
- egrit_preflight-0.1.0/tests/test_contract.py +315 -0
- egrit_preflight-0.1.0/tests/test_docs_commands.py +84 -0
- egrit_preflight-0.1.0/tests/test_doctor.py +96 -0
- egrit_preflight-0.1.0/tests/test_examples.py +71 -0
- egrit_preflight-0.1.0/tests/test_hardening.py +255 -0
- egrit_preflight-0.1.0/tests/test_image.py +538 -0
- egrit_preflight-0.1.0/tests/test_isolation.py +204 -0
- egrit_preflight-0.1.0/tests/test_report_text.py +18 -0
- egrit_preflight-0.1.0/tests/test_smoke.py +159 -0
- egrit_preflight-0.1.0/tests/test_target_neutral_design.py +199 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
Egrit-Preflight
|
|
2
|
+
Copyright 2026 Neul Space Ltd
|
|
3
|
+
|
|
4
|
+
This product is licensed under the Apache License, Version 2.0. See the LICENSE file.
|
|
5
|
+
|
|
6
|
+
NVIDIA, Jetson, JetPack, CUDA and TensorRT are trademarks or registered trademarks of NVIDIA Corporation. Docker is a
|
|
7
|
+
trademark of Docker, Inc. Egrit-Preflight is an independent project. It is not affiliated with, endorsed by or
|
|
8
|
+
sponsored by NVIDIA or Docker.
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: egrit-preflight
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Free, open-source ARM64 container preflight checks for NVIDIA Jetson and edge AI development.
|
|
5
|
+
Author: Neul Space Ltd
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Source, https://github.com/Egrit-AI/egrit-preflight
|
|
8
|
+
Project-URL: Issues, https://github.com/Egrit-AI/egrit-preflight/issues
|
|
9
|
+
Keywords: arm64,jetson,docker,buildx,qemu,edge-ai,preflight
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
14
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
15
|
+
Classifier: Operating System :: MacOS
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Topic :: Software Development :: Testing
|
|
18
|
+
Requires-Python: >=3.9
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
License-File: NOTICE
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# Egrit-Preflight
|
|
25
|
+
|
|
26
|
+
Free, open-source ARM64 container preflight checks for NVIDIA Jetson and edge AI development.
|
|
27
|
+
|
|
28
|
+
**Status: version 0.1.0.** The CLI works and is tested, including real linux/arm64 container runs in CI. It has never
|
|
29
|
+
run on a Jetson and cannot verify one: see [what it cannot verify](docs/limitations.md) and
|
|
30
|
+
[what has been verified](docs/verification.md). Its security review was done by an AI reviewer, not a person; a human
|
|
31
|
+
review is welcome.
|
|
32
|
+
|
|
33
|
+
Egrit-Preflight tells you, on an ordinary Linux or macOS computer, whether you can run `linux/arm64` containers,
|
|
34
|
+
what an image declares about its architecture and Jetson dependencies, and whether a small CPU-only ARM64 smoke
|
|
35
|
+
test runs. It orchestrates Docker, Buildx and QEMU that you already have. It is not an emulator and it does not
|
|
36
|
+
install anything.
|
|
37
|
+
|
|
38
|
+
## What it cannot verify
|
|
39
|
+
|
|
40
|
+
A pass here is **not** a Jetson pass. ARM64 user-space emulation (or a native ARM64 run) does not provide the Jetson GPU,
|
|
41
|
+
the NVIDIA driver, the device nodes or the host-provided CUDA/TensorRT libraries. Those checks always come out as
|
|
42
|
+
`REQUIRES_HARDWARE` and need a physical Jetson. See [docs/limitations.md](docs/limitations.md).
|
|
43
|
+
|
|
44
|
+
## Install
|
|
45
|
+
|
|
46
|
+
Needs Python 3.9 or later and no other Python packages. From PyPI (from v0.1.0 on):
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
pipx install egrit-preflight # or: pip install egrit-preflight
|
|
50
|
+
egrit-preflight --version
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Or from a checkout of this repository:
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
git clone <this repository>
|
|
57
|
+
cd egrit-preflight
|
|
58
|
+
python3 -m venv .venv && . .venv/bin/activate
|
|
59
|
+
pip install .
|
|
60
|
+
egrit-preflight --version
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
You also need Docker (Docker Engine on Linux, Docker Desktop on macOS). Setup: [Linux](docs/linux.md),
|
|
64
|
+
[macOS](docs/macos.md), [troubleshooting](docs/troubleshooting.md).
|
|
65
|
+
|
|
66
|
+
## Quickstart
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
egrit-preflight doctor # can this machine run linux/arm64 containers?
|
|
70
|
+
egrit-preflight image --image IMAGE_REF # inspect an image; nothing is pulled or run
|
|
71
|
+
egrit-preflight smoke --image IMAGE_REF --pull --yes # run one CPU-only ARM64 test (explicit consent)
|
|
72
|
+
egrit-preflight report --image IMAGE_REF --smoke --pull --yes -o report.json
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Use an immutable reference, and keep the tag beside the digest (`name:tag@sha256:<digest>`): the digest fixes the
|
|
76
|
+
content, and an L4T release stated in the tag can then still be compared with a target record. To find the digest
|
|
77
|
+
of a tag:
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
docker buildx imagetools inspect ubuntu:24.04 # the top-level "Digest:" line
|
|
81
|
+
egrit-preflight smoke --image ubuntu@sha256:<digest> --pull --yes
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Expected: `[PASS] smoke.arch: linux/arm64 container ran the 'arch' test (prints 'aarch64').`, then
|
|
85
|
+
`[REQUIRES_HARDWARE] jetson.gpu` with the reminder that this is not GPU compatibility.
|
|
86
|
+
|
|
87
|
+
Where this fits in a build-to-device process, what to do with each outcome, and how to use it in CI:
|
|
88
|
+
[docs/where-it-fits.md](docs/where-it-fits.md).
|
|
89
|
+
The report's fields and the guarantees a program reading it can rely on: [docs/report-contract.md](docs/report-contract.md).
|
|
90
|
+
What `image` establishes about an NVIDIA L4T image from its registry, and what it does not, with a real run:
|
|
91
|
+
[docs/l4t-example.md](docs/l4t-example.md).
|
|
92
|
+
The same kind of run with `--target` set, showing what a target record adds: [docs/target-example.md](docs/target-example.md).
|
|
93
|
+
Optional and separate, not publicly released yet: Egrit's developer client, which can help an AI assistant choose one
|
|
94
|
+
of this repository's target records and keep your reports with a local plan; nothing here needs it. See
|
|
95
|
+
[docs/where-it-fits.md](docs/where-it-fits.md#optional-egrit-alongside-preflight).
|
|
96
|
+
|
|
97
|
+
## Outcomes and exit codes
|
|
98
|
+
|
|
99
|
+
| Outcome | Meaning |
|
|
100
|
+
|---|---|
|
|
101
|
+
| `PASS` | Checked and met. The `evidence` field says `observed` (this tool saw it) or `declared` (somebody said so). |
|
|
102
|
+
| `FAIL` | Checked and not met, or a refusal such as an unpinned tag. |
|
|
103
|
+
| `UNKNOWN` | Could not be established. Never treated as a pass. |
|
|
104
|
+
| `REQUIRES_HARDWARE` | Cannot be decided without a physical Jetson. |
|
|
105
|
+
|
|
106
|
+
Exit codes: `0` no FAIL, `1` at least one FAIL, `2` usage error or consent not given, `3` with `--strict`, no FAIL but
|
|
107
|
+
some UNKNOWN, `4` internal error (the tool itself failed: there is no result, and it is not a failed check), `130`
|
|
108
|
+
interrupted.
|
|
109
|
+
|
|
110
|
+
## Commands
|
|
111
|
+
|
|
112
|
+
- `doctor`: host OS/architecture, Docker CLI, daemon, Buildx and the ARM64 route: Linux x86_64 with QEMU, native Linux
|
|
113
|
+
ARM64, Intel Mac with Docker Desktop emulation, Apple Silicon (ARM64 containers in Docker's VM). Read-only. If QEMU
|
|
114
|
+
is missing it prints the manual recipe and runs nothing.
|
|
115
|
+
- `image --image REF [--target FILE] [--require-digest]`: reads a local image, or the registry manifest and its image config, without
|
|
116
|
+
pulling or running it. Reports digest, architecture and the CUDA/TensorRT/L4T versions the image declares, and
|
|
117
|
+
compares them with an optional target record. It also lists the SBOM and build-provenance attestations the registry
|
|
118
|
+
publishes for the `linux/arm64` image (`image.sbom`, `image.provenance`, and `image.provenance` in the report). Missing
|
|
119
|
+
data is `UNKNOWN`. A listed attestation is the publisher's declaration: its contents and any signature are **not**
|
|
120
|
+
verified. Registry lookups read manifests only, never layers.
|
|
121
|
+
- `smoke --image REF --yes [--test arch|os-release|python-import] [--module NAME] [--pull] [--timeout S]`: one
|
|
122
|
+
allowlisted command in a locked-down container ([security](docs/security.md)). `python-import --module numpy` checks
|
|
123
|
+
that the image's `python3` imports a module on ARM64 CPU (no network, no GPU). Refuses an unpinned tag unless
|
|
124
|
+
`--allow-mutable`.
|
|
125
|
+
- `report [--image REF] [--smoke --yes] [--pull] [--json] [-o FILE]`: the above as one JSON document
|
|
126
|
+
([schema](schema/report.schema.json), [example](docs/example-report.json)). Set `SOURCE_DATE_EPOCH` for byte-identical
|
|
127
|
+
output. The report is always JSON. With `-o FILE` it goes to the file and the terminal gets a short summary; add
|
|
128
|
+
`--json` to print the whole report to standard output as well.
|
|
129
|
+
|
|
130
|
+
### Target record
|
|
131
|
+
|
|
132
|
+
`--target` reads a small JSON file. The fields used are `architecture`, `software.jetpack`, `software.jetson_linux`,
|
|
133
|
+
`runtimes.cuda`, `runtimes.tensorrt` and `status` (`declared` until read from a device). A version that is absent or
|
|
134
|
+
`"not established"` gives `UNKNOWN`. An `architecture` other than `aarch64` or `arm64` gives `target.architecture`
|
|
135
|
+
`FAIL`, because the report is about linux/arm64 only; an absent one adds no check. Versions you copy from NVIDIA release notes are declarations; the tool does not
|
|
136
|
+
embed a JetPack compatibility table, because one it cannot keep verified would be worse than none.
|
|
137
|
+
|
|
138
|
+
An optional `module_id` names the Jetson module the record is for, such as `jetson-orin-nano-8gb-devkit`: lowercase
|
|
139
|
+
letters and digits joined by hyphens, at most 64 characters. It adds no check. The report carries it in
|
|
140
|
+
`target.record.module_id` so that a program comparing a later device result with this report can tell one module from
|
|
141
|
+
another; a missing or malformed value is `null`, never read from the record's `name`.
|
|
142
|
+
|
|
143
|
+
[examples/targets/](examples/targets/README.md) holds a declared record for each recent JetPack release (6.2.1, 6.2,
|
|
144
|
+
6.1 and 5.1.8), each citing NVIDIA's release page and the date it was read. Pass the one your device runs, for example
|
|
145
|
+
`--target examples/targets/jetpack-6.2.json`, and check it against what the device reports.
|
|
146
|
+
|
|
147
|
+
## Free and open source
|
|
148
|
+
|
|
149
|
+
Egrit-Preflight is Apache-2.0 and copyright 2026 Neul Space Ltd (see [NOTICE](NOTICE)). The local CLI needs no account, no login, no subscription and no usage credits, and it
|
|
150
|
+
sends no telemetry: it makes no network connections of its own (Docker may, when you ask it to pull or inspect a
|
|
151
|
+
registry). Functionality released in the free edition will not be withdrawn to create paid tiers.
|
|
152
|
+
|
|
153
|
+
Egrit may in future offer separate, optional services such as hardware-backed verification, managed testing, evidence
|
|
154
|
+
retention and deployment automation. None is part of this tool, and nothing here depends on them.
|
|
155
|
+
|
|
156
|
+
## Trademarks
|
|
157
|
+
|
|
158
|
+
NVIDIA, Jetson, JetPack, CUDA and TensorRT are trademarks or registered trademarks of NVIDIA Corporation. Docker is a
|
|
159
|
+
trademark of Docker, Inc. Egrit-Preflight is an independent project. It is not affiliated with, endorsed by or
|
|
160
|
+
sponsored by NVIDIA or Docker, and nothing it reports is an NVIDIA certification or a statement by NVIDIA. The names are
|
|
161
|
+
used only to say which software and hardware a check is about.
|
|
162
|
+
|
|
163
|
+
## What has been verified
|
|
164
|
+
|
|
165
|
+
See [docs/verification.md](docs/verification.md) for exactly what has run, where, and what has not.
|
|
166
|
+
|
|
167
|
+
## Development
|
|
168
|
+
|
|
169
|
+
```sh
|
|
170
|
+
PYTHONPATH=src python3 -m unittest discover -s tests -t . -v
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
Contributing: [CONTRIBUTING.md](CONTRIBUTING.md). Security: [SECURITY.md](SECURITY.md).
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# Egrit-Preflight
|
|
2
|
+
|
|
3
|
+
Free, open-source ARM64 container preflight checks for NVIDIA Jetson and edge AI development.
|
|
4
|
+
|
|
5
|
+
**Status: version 0.1.0.** The CLI works and is tested, including real linux/arm64 container runs in CI. It has never
|
|
6
|
+
run on a Jetson and cannot verify one: see [what it cannot verify](docs/limitations.md) and
|
|
7
|
+
[what has been verified](docs/verification.md). Its security review was done by an AI reviewer, not a person; a human
|
|
8
|
+
review is welcome.
|
|
9
|
+
|
|
10
|
+
Egrit-Preflight tells you, on an ordinary Linux or macOS computer, whether you can run `linux/arm64` containers,
|
|
11
|
+
what an image declares about its architecture and Jetson dependencies, and whether a small CPU-only ARM64 smoke
|
|
12
|
+
test runs. It orchestrates Docker, Buildx and QEMU that you already have. It is not an emulator and it does not
|
|
13
|
+
install anything.
|
|
14
|
+
|
|
15
|
+
## What it cannot verify
|
|
16
|
+
|
|
17
|
+
A pass here is **not** a Jetson pass. ARM64 user-space emulation (or a native ARM64 run) does not provide the Jetson GPU,
|
|
18
|
+
the NVIDIA driver, the device nodes or the host-provided CUDA/TensorRT libraries. Those checks always come out as
|
|
19
|
+
`REQUIRES_HARDWARE` and need a physical Jetson. See [docs/limitations.md](docs/limitations.md).
|
|
20
|
+
|
|
21
|
+
## Install
|
|
22
|
+
|
|
23
|
+
Needs Python 3.9 or later and no other Python packages. From PyPI (from v0.1.0 on):
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
pipx install egrit-preflight # or: pip install egrit-preflight
|
|
27
|
+
egrit-preflight --version
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Or from a checkout of this repository:
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
git clone <this repository>
|
|
34
|
+
cd egrit-preflight
|
|
35
|
+
python3 -m venv .venv && . .venv/bin/activate
|
|
36
|
+
pip install .
|
|
37
|
+
egrit-preflight --version
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
You also need Docker (Docker Engine on Linux, Docker Desktop on macOS). Setup: [Linux](docs/linux.md),
|
|
41
|
+
[macOS](docs/macos.md), [troubleshooting](docs/troubleshooting.md).
|
|
42
|
+
|
|
43
|
+
## Quickstart
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
egrit-preflight doctor # can this machine run linux/arm64 containers?
|
|
47
|
+
egrit-preflight image --image IMAGE_REF # inspect an image; nothing is pulled or run
|
|
48
|
+
egrit-preflight smoke --image IMAGE_REF --pull --yes # run one CPU-only ARM64 test (explicit consent)
|
|
49
|
+
egrit-preflight report --image IMAGE_REF --smoke --pull --yes -o report.json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Use an immutable reference, and keep the tag beside the digest (`name:tag@sha256:<digest>`): the digest fixes the
|
|
53
|
+
content, and an L4T release stated in the tag can then still be compared with a target record. To find the digest
|
|
54
|
+
of a tag:
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
docker buildx imagetools inspect ubuntu:24.04 # the top-level "Digest:" line
|
|
58
|
+
egrit-preflight smoke --image ubuntu@sha256:<digest> --pull --yes
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Expected: `[PASS] smoke.arch: linux/arm64 container ran the 'arch' test (prints 'aarch64').`, then
|
|
62
|
+
`[REQUIRES_HARDWARE] jetson.gpu` with the reminder that this is not GPU compatibility.
|
|
63
|
+
|
|
64
|
+
Where this fits in a build-to-device process, what to do with each outcome, and how to use it in CI:
|
|
65
|
+
[docs/where-it-fits.md](docs/where-it-fits.md).
|
|
66
|
+
The report's fields and the guarantees a program reading it can rely on: [docs/report-contract.md](docs/report-contract.md).
|
|
67
|
+
What `image` establishes about an NVIDIA L4T image from its registry, and what it does not, with a real run:
|
|
68
|
+
[docs/l4t-example.md](docs/l4t-example.md).
|
|
69
|
+
The same kind of run with `--target` set, showing what a target record adds: [docs/target-example.md](docs/target-example.md).
|
|
70
|
+
Optional and separate, not publicly released yet: Egrit's developer client, which can help an AI assistant choose one
|
|
71
|
+
of this repository's target records and keep your reports with a local plan; nothing here needs it. See
|
|
72
|
+
[docs/where-it-fits.md](docs/where-it-fits.md#optional-egrit-alongside-preflight).
|
|
73
|
+
|
|
74
|
+
## Outcomes and exit codes
|
|
75
|
+
|
|
76
|
+
| Outcome | Meaning |
|
|
77
|
+
|---|---|
|
|
78
|
+
| `PASS` | Checked and met. The `evidence` field says `observed` (this tool saw it) or `declared` (somebody said so). |
|
|
79
|
+
| `FAIL` | Checked and not met, or a refusal such as an unpinned tag. |
|
|
80
|
+
| `UNKNOWN` | Could not be established. Never treated as a pass. |
|
|
81
|
+
| `REQUIRES_HARDWARE` | Cannot be decided without a physical Jetson. |
|
|
82
|
+
|
|
83
|
+
Exit codes: `0` no FAIL, `1` at least one FAIL, `2` usage error or consent not given, `3` with `--strict`, no FAIL but
|
|
84
|
+
some UNKNOWN, `4` internal error (the tool itself failed: there is no result, and it is not a failed check), `130`
|
|
85
|
+
interrupted.
|
|
86
|
+
|
|
87
|
+
## Commands
|
|
88
|
+
|
|
89
|
+
- `doctor`: host OS/architecture, Docker CLI, daemon, Buildx and the ARM64 route: Linux x86_64 with QEMU, native Linux
|
|
90
|
+
ARM64, Intel Mac with Docker Desktop emulation, Apple Silicon (ARM64 containers in Docker's VM). Read-only. If QEMU
|
|
91
|
+
is missing it prints the manual recipe and runs nothing.
|
|
92
|
+
- `image --image REF [--target FILE] [--require-digest]`: reads a local image, or the registry manifest and its image config, without
|
|
93
|
+
pulling or running it. Reports digest, architecture and the CUDA/TensorRT/L4T versions the image declares, and
|
|
94
|
+
compares them with an optional target record. It also lists the SBOM and build-provenance attestations the registry
|
|
95
|
+
publishes for the `linux/arm64` image (`image.sbom`, `image.provenance`, and `image.provenance` in the report). Missing
|
|
96
|
+
data is `UNKNOWN`. A listed attestation is the publisher's declaration: its contents and any signature are **not**
|
|
97
|
+
verified. Registry lookups read manifests only, never layers.
|
|
98
|
+
- `smoke --image REF --yes [--test arch|os-release|python-import] [--module NAME] [--pull] [--timeout S]`: one
|
|
99
|
+
allowlisted command in a locked-down container ([security](docs/security.md)). `python-import --module numpy` checks
|
|
100
|
+
that the image's `python3` imports a module on ARM64 CPU (no network, no GPU). Refuses an unpinned tag unless
|
|
101
|
+
`--allow-mutable`.
|
|
102
|
+
- `report [--image REF] [--smoke --yes] [--pull] [--json] [-o FILE]`: the above as one JSON document
|
|
103
|
+
([schema](schema/report.schema.json), [example](docs/example-report.json)). Set `SOURCE_DATE_EPOCH` for byte-identical
|
|
104
|
+
output. The report is always JSON. With `-o FILE` it goes to the file and the terminal gets a short summary; add
|
|
105
|
+
`--json` to print the whole report to standard output as well.
|
|
106
|
+
|
|
107
|
+
### Target record
|
|
108
|
+
|
|
109
|
+
`--target` reads a small JSON file. The fields used are `architecture`, `software.jetpack`, `software.jetson_linux`,
|
|
110
|
+
`runtimes.cuda`, `runtimes.tensorrt` and `status` (`declared` until read from a device). A version that is absent or
|
|
111
|
+
`"not established"` gives `UNKNOWN`. An `architecture` other than `aarch64` or `arm64` gives `target.architecture`
|
|
112
|
+
`FAIL`, because the report is about linux/arm64 only; an absent one adds no check. Versions you copy from NVIDIA release notes are declarations; the tool does not
|
|
113
|
+
embed a JetPack compatibility table, because one it cannot keep verified would be worse than none.
|
|
114
|
+
|
|
115
|
+
An optional `module_id` names the Jetson module the record is for, such as `jetson-orin-nano-8gb-devkit`: lowercase
|
|
116
|
+
letters and digits joined by hyphens, at most 64 characters. It adds no check. The report carries it in
|
|
117
|
+
`target.record.module_id` so that a program comparing a later device result with this report can tell one module from
|
|
118
|
+
another; a missing or malformed value is `null`, never read from the record's `name`.
|
|
119
|
+
|
|
120
|
+
[examples/targets/](examples/targets/README.md) holds a declared record for each recent JetPack release (6.2.1, 6.2,
|
|
121
|
+
6.1 and 5.1.8), each citing NVIDIA's release page and the date it was read. Pass the one your device runs, for example
|
|
122
|
+
`--target examples/targets/jetpack-6.2.json`, and check it against what the device reports.
|
|
123
|
+
|
|
124
|
+
## Free and open source
|
|
125
|
+
|
|
126
|
+
Egrit-Preflight is Apache-2.0 and copyright 2026 Neul Space Ltd (see [NOTICE](NOTICE)). The local CLI needs no account, no login, no subscription and no usage credits, and it
|
|
127
|
+
sends no telemetry: it makes no network connections of its own (Docker may, when you ask it to pull or inspect a
|
|
128
|
+
registry). Functionality released in the free edition will not be withdrawn to create paid tiers.
|
|
129
|
+
|
|
130
|
+
Egrit may in future offer separate, optional services such as hardware-backed verification, managed testing, evidence
|
|
131
|
+
retention and deployment automation. None is part of this tool, and nothing here depends on them.
|
|
132
|
+
|
|
133
|
+
## Trademarks
|
|
134
|
+
|
|
135
|
+
NVIDIA, Jetson, JetPack, CUDA and TensorRT are trademarks or registered trademarks of NVIDIA Corporation. Docker is a
|
|
136
|
+
trademark of Docker, Inc. Egrit-Preflight is an independent project. It is not affiliated with, endorsed by or
|
|
137
|
+
sponsored by NVIDIA or Docker, and nothing it reports is an NVIDIA certification or a statement by NVIDIA. The names are
|
|
138
|
+
used only to say which software and hardware a check is about.
|
|
139
|
+
|
|
140
|
+
## What has been verified
|
|
141
|
+
|
|
142
|
+
See [docs/verification.md](docs/verification.md) for exactly what has run, where, and what has not.
|
|
143
|
+
|
|
144
|
+
## Development
|
|
145
|
+
|
|
146
|
+
```sh
|
|
147
|
+
PYTHONPATH=src python3 -m unittest discover -s tests -t . -v
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
Contributing: [CONTRIBUTING.md](CONTRIBUTING.md). Security: [SECURITY.md](SECURITY.md).
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=61"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "egrit-preflight"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "Free, open-source ARM64 container preflight checks for NVIDIA Jetson and edge AI development."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.9"
|
|
11
|
+
license = {text = "Apache-2.0"}
|
|
12
|
+
authors = [{name = "Neul Space Ltd"}]
|
|
13
|
+
keywords = ["arm64", "jetson", "docker", "buildx", "qemu", "edge-ai", "preflight"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Development Status :: 3 - Alpha",
|
|
16
|
+
"Environment :: Console",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"License :: OSI Approved :: Apache Software License",
|
|
19
|
+
"Operating System :: POSIX :: Linux",
|
|
20
|
+
"Operating System :: MacOS",
|
|
21
|
+
"Programming Language :: Python :: 3",
|
|
22
|
+
"Topic :: Software Development :: Testing",
|
|
23
|
+
]
|
|
24
|
+
dependencies = []
|
|
25
|
+
|
|
26
|
+
[project.scripts]
|
|
27
|
+
egrit-preflight = "egrit_preflight.__main__:run"
|
|
28
|
+
|
|
29
|
+
[tool.setuptools.dynamic]
|
|
30
|
+
version = {attr = "egrit_preflight.__version__"}
|
|
31
|
+
|
|
32
|
+
[tool.setuptools.packages.find]
|
|
33
|
+
where = ["src"]
|
|
34
|
+
|
|
35
|
+
[project.urls]
|
|
36
|
+
Source = "https://github.com/Egrit-AI/egrit-preflight"
|
|
37
|
+
Issues = "https://github.com/Egrit-AI/egrit-preflight/issues"
|