seanerstack 0.1.3__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.
Files changed (26) hide show
  1. seanerstack-0.1.3/LICENSE +202 -0
  2. seanerstack-0.1.3/PKG-INFO +224 -0
  3. seanerstack-0.1.3/README.md +212 -0
  4. seanerstack-0.1.3/data/share/seanerstack/config.toml +37 -0
  5. seanerstack-0.1.3/data/share/seanerstack/environments/demobus-dev/spack.yaml +10 -0
  6. seanerstack-0.1.3/data/share/seanerstack/environments/flux-core-dev/spack.yaml +10 -0
  7. seanerstack-0.1.3/data/share/seanerstack/environments/properdocs-dev/spack.yaml +10 -0
  8. seanerstack-0.1.3/data/share/seanerstack/spack-repo-index.yaml +4 -0
  9. seanerstack-0.1.3/data/share/seanerstack/spack_repo/seanerstack/packages/demobus/package.py +38 -0
  10. seanerstack-0.1.3/data/share/seanerstack/spack_repo/seanerstack/packages/properdocs/package.py +34 -0
  11. seanerstack-0.1.3/data/share/seanerstack/spack_repo/seanerstack/packages/seanergys_meta/package.py +13 -0
  12. seanerstack-0.1.3/data/share/seanerstack/spack_repo/seanerstack/repo.yaml +4 -0
  13. seanerstack-0.1.3/pyproject.toml +44 -0
  14. seanerstack-0.1.3/src/seanerstack/__init__.py +5 -0
  15. seanerstack-0.1.3/src/seanerstack/auth.py +143 -0
  16. seanerstack-0.1.3/src/seanerstack/bootstrap.py +161 -0
  17. seanerstack-0.1.3/src/seanerstack/buildcache.py +68 -0
  18. seanerstack-0.1.3/src/seanerstack/cli.py +397 -0
  19. seanerstack-0.1.3/src/seanerstack/config.py +93 -0
  20. seanerstack-0.1.3/src/seanerstack/docsgen.py +146 -0
  21. seanerstack-0.1.3/src/seanerstack/isolation.py +243 -0
  22. seanerstack-0.1.3/src/seanerstack/paths.py +52 -0
  23. seanerstack-0.1.3/src/seanerstack/recipe.py +108 -0
  24. seanerstack-0.1.3/src/seanerstack/secrets.py +60 -0
  25. seanerstack-0.1.3/src/seanerstack/sync.py +381 -0
  26. seanerstack-0.1.3/src/seanerstack/validate.py +202 -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,224 @@
1
+ Metadata-Version: 2.4
2
+ Name: seanerstack
3
+ Version: 0.1.3
4
+ Summary: Curated Spack recipes and environments for SEANERGYS, with synchronization, bootstrap, and validation tooling.
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Requires-Dist: packaging>=24
8
+ Requires-Dist: pyyaml>=6
9
+ Requires-Dist: keyloom>=0.1.0
10
+ Requires-Python: >=3.12
11
+ Description-Content-Type: text/markdown
12
+
13
+ # Seanerstack
14
+
15
+ Seanerstack combines two closely related roles for SEANERGYS:
16
+
17
+ - a curated collection of native Spack package recipes and Spack environments;
18
+ - a small command-line tool that synchronizes, bootstraps, validates, and locates that content.
19
+
20
+ Seanerstack does **not** define its own package, environment, compiler, or toolchain format. Spack remains the source of truth for all of those concepts.
21
+
22
+ ## Installation layout
23
+
24
+ The Python implementation is installed normally, while Spack-facing data is installed under the Python environment prefix:
25
+
26
+ ```text
27
+ <prefix>/
28
+ ├── bin/seanerstack
29
+ ├── lib/python.../site-packages/seanerstack/
30
+ └── share/seanerstack/
31
+ ├── spack-repo-index.yaml
32
+ ├── spack_repo/seanerstack/
33
+ │ ├── repo.yaml
34
+ │ └── packages/
35
+ └── environments/
36
+ ```
37
+
38
+ The paths can always be discovered at runtime:
39
+
40
+ ```console
41
+ seanerstack paths share
42
+ seanerstack paths repo
43
+ seanerstack paths env --package properdocs
44
+ ```
45
+
46
+ For example:
47
+
48
+ ```console
49
+ export SEANERSTACK_STATE_DIR=/path/to/seanerstack-state
50
+ seanerstack toolchain bootstrap gcc@15
51
+ eval "$(seanerstack activate)"
52
+ spack env activate "$(seanerstack paths env --package properdocs)"
53
+ ```
54
+
55
+ ## Development
56
+
57
+ ```console
58
+ uv sync --all-groups
59
+ uv run pytest
60
+ uv run seanerstack --help
61
+ ```
62
+
63
+ The unit tests are in `tests/unit`. The end-to-end tests in `tests/e2e` install
64
+ the wheel of the checkout into a fresh environment and run it against the
65
+ SEANERGYS GitLab, with credentials from a keyloom secrets file. They read the
66
+ demobus repository, and build a small package, push it to a test build cache,
67
+ and install it back from there. Each build-cache test pushes to its own
68
+ repository, `test-e2e-buildcache-<test>`, under the registry location given by
69
+ `SEANERSTACK_E2E_REGISTRY`, never to the project build cache. They need Git,
70
+ Spack, a C compiler, make, and a GitLab token that can read demobus and write to
71
+ that location; without a token they are skipped:
72
+
73
+ ```console
74
+ export SEANERSTACK_E2E_TOKEN=<GitLab personal access token>
75
+ export SEANERSTACK_E2E_SPACK=/path/to/spack/bin/spack
76
+ export SEANERSTACK_E2E_REGISTRY=oci://registry.seanergys.fz-juelich.de/<namespace>/<project>
77
+ tests/e2e/run.sh
78
+ ```
79
+
80
+ CI runs them in the `e2e` job with the job token.
81
+
82
+ Build or serve the documentation:
83
+
84
+ ```console
85
+ uv run --group docs properdocs build
86
+ uv run --group docs properdocs serve
87
+ ```
88
+
89
+ ## External resources and secrets
90
+
91
+ External services are named in `config.toml`. A resource may refer to a
92
+ credential set by name; the credential values themselves stay in a secrets file
93
+ encrypted with [keyloom](https://seanergys.github.io/keyloom).
94
+
95
+ ```toml
96
+ [resources.seanergys-gitlab]
97
+ kind = "git"
98
+ url = "https://gitlab.seanergys.fz-juelich.de/"
99
+ credentials = "seanergys-gitlab"
100
+
101
+ [resources.buildcache]
102
+ kind = "spack-buildcache"
103
+ url = "s3://seanerstack-buildcache"
104
+ endpoint_url = "https://objectstore.example.org"
105
+ credentials = "objectstore"
106
+ autopush = true
107
+ signed = false
108
+ ```
109
+
110
+ A private package recipe names the Git resource, not the credential:
111
+
112
+ ```python
113
+ class PrivatePackage(Package):
114
+ git = "https://gitlab.seanergys.fz-juelich.de/software/private-package.git"
115
+ seanerstack_resource = "seanergys-gitlab"
116
+ ```
117
+
118
+ Seanerstack sends the resource credentials to Git with the first request to a
119
+ URL under the resource, rather than only after the server asks for them, so an
120
+ invalid token fails even for a repository that anyone can read. They are passed
121
+ through Git's environment configuration, never on the command line. Older
122
+ versions of Git ignore that configuration, so Seanerstack refuses to run Git
123
+ with credentials unless it is version 2.31 or later.
124
+
125
+ A recipe that fetches releases as archives keeps `url` under the same resource.
126
+ Seanerstack sends the resource token as a `PRIVATE-TOKEN` header, only over HTTPS,
127
+ when downloading new releases to compute their `sha256`:
128
+
129
+ ```python
130
+ class PrivatePackage(Package):
131
+ url = "https://gitlab.seanergys.fz-juelich.de/software/private-package/-/archive/v1.0/private-package-v1.0.tar.gz"
132
+ git = "https://gitlab.seanergys.fz-juelich.de/software/private-package.git"
133
+ seanerstack_resource = "seanergys-gitlab"
134
+ ```
135
+
136
+ The corresponding secrets file can use a shared credential entry:
137
+
138
+ ```toml
139
+ [credentials.seanergys-gitlab]
140
+ username = "oauth2"
141
+ token = { __keyloom__ = "secret", value = "$KEYLOOM;..." }
142
+
143
+ [credentials.objectstore]
144
+ access_key_id = "..."
145
+ secret_access_key = { __keyloom__ = "secret", value = "$KEYLOOM;..." }
146
+
147
+ [credentials.seanergys-registry]
148
+ username = "oauth2"
149
+ token = { __keyloom__ = "secret", value = "$KEYLOOM;..." }
150
+ ```
151
+
152
+ Write each secret value as the placeholder `__keyloom__secret__` and run
153
+ `keyloom encrypt secrets.toml`, which prompts for the vault password and for
154
+ each value; see [Create a secrets file](docs/how-to/create-a-secrets-file.md).
155
+
156
+ Use it without putting either the vault password or service credential on the
157
+ command line:
158
+
159
+ ```console
160
+ seanerstack \
161
+ --secrets-file ./secrets.toml \
162
+ --secrets-password-file /run/secrets/vault-password \
163
+ package update private-package
164
+ ```
165
+
166
+ For interactive use, omit `--secrets-password-file`; Seanerstack prompts for the
167
+ vault password. CI may use `--secrets-password-stdin` instead.
168
+
169
+ Configure the Spack binary build caches from `config.toml` in the selected isolated state with:
170
+
171
+ ```console
172
+ seanerstack --state-dir /path/to/seanerstack-state buildcache configure
173
+ ```
174
+
175
+ A build cache with an `oci://` URL lives in a container registry and takes
176
+ `username` plus `password` or `token`; Spack cannot sign OCI caches, so such a
177
+ resource must set `signed = false`. A build cache with a `file://` URL is a
178
+ directory on a local or shared filesystem. It takes no credentials, because file
179
+ permissions control access to it, and it is unsigned unless the resource sets
180
+ `signed = true`. Any other URL is S3 and takes the access key pair. The project
181
+ cache, `seanerstack-buildcache`, is the seanerstack GitLab container registry.
182
+
183
+ Seanerstack stores only environment-variable references in Spack's mirror
184
+ configuration. It never writes S3 keys or registry tokens into Spack
185
+ configuration. The actual variables must be present in any later native
186
+ `spack` process that accesses a private cache; this is intentionally left as a
187
+ process/session concern rather than storing decrypted credentials on disk.
188
+
189
+ ## Isolated Spack session
190
+
191
+ Seanerstack keeps Spack configuration and mutable state inside one explicitly selected
192
+ state directory. It does not use `~/.spack`, `/etc/spack`, another Spack store, or
193
+ another Spack cache for Seanerstack-managed operations.
194
+
195
+ Activate a shell with:
196
+
197
+ ```console
198
+ $ eval "$(seanerstack --state-dir /path/to/seanerstack-state activate)"
199
+ $ spack find
200
+ $ spack install <spec>
201
+ ```
202
+
203
+ After activation, plain `spack` is the native Spack CLI executed with Seanerstack's
204
+ private configuration. The session sets `SEANERSTACK_STATE_DIR`, disables normal
205
+ local Spack configuration, redirects Spack user data, and places a transparent
206
+ launcher first on `PATH`. The private tree contains the install store, build
207
+ stages, source and miscellaneous caches, managed environments, and configuration.
208
+
209
+ If the private build cache needs credentials, activate with the existing secrets
210
+ options, for example:
211
+
212
+ ```console
213
+ $ eval "$(seanerstack --state-dir /path/to/seanerstack-state --secrets-file secrets.toml activate)"
214
+ ```
215
+
216
+ Leave the session with:
217
+
218
+ ```console
219
+ $ eval "$(seanerstack deactivate)"
220
+ ```
221
+
222
+ `toolchain bootstrap`, Spack-backed validation, and build-cache commands use the
223
+ same isolated state. Outside an activated shell, pass `--state-dir DIR` or set
224
+ `SEANERSTACK_STATE_DIR`. There is intentionally no public Spack `--scope` option.
@@ -0,0 +1,212 @@
1
+ # Seanerstack
2
+
3
+ Seanerstack combines two closely related roles for SEANERGYS:
4
+
5
+ - a curated collection of native Spack package recipes and Spack environments;
6
+ - a small command-line tool that synchronizes, bootstraps, validates, and locates that content.
7
+
8
+ Seanerstack does **not** define its own package, environment, compiler, or toolchain format. Spack remains the source of truth for all of those concepts.
9
+
10
+ ## Installation layout
11
+
12
+ The Python implementation is installed normally, while Spack-facing data is installed under the Python environment prefix:
13
+
14
+ ```text
15
+ <prefix>/
16
+ ├── bin/seanerstack
17
+ ├── lib/python.../site-packages/seanerstack/
18
+ └── share/seanerstack/
19
+ ├── spack-repo-index.yaml
20
+ ├── spack_repo/seanerstack/
21
+ │ ├── repo.yaml
22
+ │ └── packages/
23
+ └── environments/
24
+ ```
25
+
26
+ The paths can always be discovered at runtime:
27
+
28
+ ```console
29
+ seanerstack paths share
30
+ seanerstack paths repo
31
+ seanerstack paths env --package properdocs
32
+ ```
33
+
34
+ For example:
35
+
36
+ ```console
37
+ export SEANERSTACK_STATE_DIR=/path/to/seanerstack-state
38
+ seanerstack toolchain bootstrap gcc@15
39
+ eval "$(seanerstack activate)"
40
+ spack env activate "$(seanerstack paths env --package properdocs)"
41
+ ```
42
+
43
+ ## Development
44
+
45
+ ```console
46
+ uv sync --all-groups
47
+ uv run pytest
48
+ uv run seanerstack --help
49
+ ```
50
+
51
+ The unit tests are in `tests/unit`. The end-to-end tests in `tests/e2e` install
52
+ the wheel of the checkout into a fresh environment and run it against the
53
+ SEANERGYS GitLab, with credentials from a keyloom secrets file. They read the
54
+ demobus repository, and build a small package, push it to a test build cache,
55
+ and install it back from there. Each build-cache test pushes to its own
56
+ repository, `test-e2e-buildcache-<test>`, under the registry location given by
57
+ `SEANERSTACK_E2E_REGISTRY`, never to the project build cache. They need Git,
58
+ Spack, a C compiler, make, and a GitLab token that can read demobus and write to
59
+ that location; without a token they are skipped:
60
+
61
+ ```console
62
+ export SEANERSTACK_E2E_TOKEN=<GitLab personal access token>
63
+ export SEANERSTACK_E2E_SPACK=/path/to/spack/bin/spack
64
+ export SEANERSTACK_E2E_REGISTRY=oci://registry.seanergys.fz-juelich.de/<namespace>/<project>
65
+ tests/e2e/run.sh
66
+ ```
67
+
68
+ CI runs them in the `e2e` job with the job token.
69
+
70
+ Build or serve the documentation:
71
+
72
+ ```console
73
+ uv run --group docs properdocs build
74
+ uv run --group docs properdocs serve
75
+ ```
76
+
77
+ ## External resources and secrets
78
+
79
+ External services are named in `config.toml`. A resource may refer to a
80
+ credential set by name; the credential values themselves stay in a secrets file
81
+ encrypted with [keyloom](https://seanergys.github.io/keyloom).
82
+
83
+ ```toml
84
+ [resources.seanergys-gitlab]
85
+ kind = "git"
86
+ url = "https://gitlab.seanergys.fz-juelich.de/"
87
+ credentials = "seanergys-gitlab"
88
+
89
+ [resources.buildcache]
90
+ kind = "spack-buildcache"
91
+ url = "s3://seanerstack-buildcache"
92
+ endpoint_url = "https://objectstore.example.org"
93
+ credentials = "objectstore"
94
+ autopush = true
95
+ signed = false
96
+ ```
97
+
98
+ A private package recipe names the Git resource, not the credential:
99
+
100
+ ```python
101
+ class PrivatePackage(Package):
102
+ git = "https://gitlab.seanergys.fz-juelich.de/software/private-package.git"
103
+ seanerstack_resource = "seanergys-gitlab"
104
+ ```
105
+
106
+ Seanerstack sends the resource credentials to Git with the first request to a
107
+ URL under the resource, rather than only after the server asks for them, so an
108
+ invalid token fails even for a repository that anyone can read. They are passed
109
+ through Git's environment configuration, never on the command line. Older
110
+ versions of Git ignore that configuration, so Seanerstack refuses to run Git
111
+ with credentials unless it is version 2.31 or later.
112
+
113
+ A recipe that fetches releases as archives keeps `url` under the same resource.
114
+ Seanerstack sends the resource token as a `PRIVATE-TOKEN` header, only over HTTPS,
115
+ when downloading new releases to compute their `sha256`:
116
+
117
+ ```python
118
+ class PrivatePackage(Package):
119
+ url = "https://gitlab.seanergys.fz-juelich.de/software/private-package/-/archive/v1.0/private-package-v1.0.tar.gz"
120
+ git = "https://gitlab.seanergys.fz-juelich.de/software/private-package.git"
121
+ seanerstack_resource = "seanergys-gitlab"
122
+ ```
123
+
124
+ The corresponding secrets file can use a shared credential entry:
125
+
126
+ ```toml
127
+ [credentials.seanergys-gitlab]
128
+ username = "oauth2"
129
+ token = { __keyloom__ = "secret", value = "$KEYLOOM;..." }
130
+
131
+ [credentials.objectstore]
132
+ access_key_id = "..."
133
+ secret_access_key = { __keyloom__ = "secret", value = "$KEYLOOM;..." }
134
+
135
+ [credentials.seanergys-registry]
136
+ username = "oauth2"
137
+ token = { __keyloom__ = "secret", value = "$KEYLOOM;..." }
138
+ ```
139
+
140
+ Write each secret value as the placeholder `__keyloom__secret__` and run
141
+ `keyloom encrypt secrets.toml`, which prompts for the vault password and for
142
+ each value; see [Create a secrets file](docs/how-to/create-a-secrets-file.md).
143
+
144
+ Use it without putting either the vault password or service credential on the
145
+ command line:
146
+
147
+ ```console
148
+ seanerstack \
149
+ --secrets-file ./secrets.toml \
150
+ --secrets-password-file /run/secrets/vault-password \
151
+ package update private-package
152
+ ```
153
+
154
+ For interactive use, omit `--secrets-password-file`; Seanerstack prompts for the
155
+ vault password. CI may use `--secrets-password-stdin` instead.
156
+
157
+ Configure the Spack binary build caches from `config.toml` in the selected isolated state with:
158
+
159
+ ```console
160
+ seanerstack --state-dir /path/to/seanerstack-state buildcache configure
161
+ ```
162
+
163
+ A build cache with an `oci://` URL lives in a container registry and takes
164
+ `username` plus `password` or `token`; Spack cannot sign OCI caches, so such a
165
+ resource must set `signed = false`. A build cache with a `file://` URL is a
166
+ directory on a local or shared filesystem. It takes no credentials, because file
167
+ permissions control access to it, and it is unsigned unless the resource sets
168
+ `signed = true`. Any other URL is S3 and takes the access key pair. The project
169
+ cache, `seanerstack-buildcache`, is the seanerstack GitLab container registry.
170
+
171
+ Seanerstack stores only environment-variable references in Spack's mirror
172
+ configuration. It never writes S3 keys or registry tokens into Spack
173
+ configuration. The actual variables must be present in any later native
174
+ `spack` process that accesses a private cache; this is intentionally left as a
175
+ process/session concern rather than storing decrypted credentials on disk.
176
+
177
+ ## Isolated Spack session
178
+
179
+ Seanerstack keeps Spack configuration and mutable state inside one explicitly selected
180
+ state directory. It does not use `~/.spack`, `/etc/spack`, another Spack store, or
181
+ another Spack cache for Seanerstack-managed operations.
182
+
183
+ Activate a shell with:
184
+
185
+ ```console
186
+ $ eval "$(seanerstack --state-dir /path/to/seanerstack-state activate)"
187
+ $ spack find
188
+ $ spack install <spec>
189
+ ```
190
+
191
+ After activation, plain `spack` is the native Spack CLI executed with Seanerstack's
192
+ private configuration. The session sets `SEANERSTACK_STATE_DIR`, disables normal
193
+ local Spack configuration, redirects Spack user data, and places a transparent
194
+ launcher first on `PATH`. The private tree contains the install store, build
195
+ stages, source and miscellaneous caches, managed environments, and configuration.
196
+
197
+ If the private build cache needs credentials, activate with the existing secrets
198
+ options, for example:
199
+
200
+ ```console
201
+ $ eval "$(seanerstack --state-dir /path/to/seanerstack-state --secrets-file secrets.toml activate)"
202
+ ```
203
+
204
+ Leave the session with:
205
+
206
+ ```console
207
+ $ eval "$(seanerstack deactivate)"
208
+ ```
209
+
210
+ `toolchain bootstrap`, Spack-backed validation, and build-cache commands use the
211
+ same isolated state. Outside an activated shell, pass `--state-dir DIR` or set
212
+ `SEANERSTACK_STATE_DIR`. There is intentionally no public Spack `--scope` option.
@@ -0,0 +1,37 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ # External resources are named here. Recipes and build-cache configuration refer
3
+ # to the resource name; credential values live only in the keyloom-encrypted
4
+ # secrets file.
5
+
6
+ # Private SEANERGYS Git resource. A recipe names the resource, never the
7
+ # credential; the token itself lives in the secrets file under the credential name
8
+ # below. Seanerstack authenticates `git ls-remote` with it, and sends it as
9
+ # the PRIVATE-TOKEN header when downloading a release archive to checksum it.
10
+ [resources.seanergys-gitlab]
11
+ kind = "git"
12
+ url = "https://gitlab.seanergys.fz-juelich.de/"
13
+ credentials = "seanergys-gitlab"
14
+
15
+ # Project binary build cache in the seanerstack GitLab container registry. Spack
16
+ # cannot sign OCI build caches, so registry access control is the trust boundary.
17
+ [resources.seanerstack-buildcache]
18
+ kind = "spack-buildcache"
19
+ url = "oci://registry.seanergys.fz-juelich.de/software/seanerstack/buildcache"
20
+ credentials = "seanergys-registry"
21
+ signed = false
22
+
23
+ # Example S3-backed Spack binary build cache:
24
+ # [resources.jsc-buildcache]
25
+ # kind = "spack-buildcache"
26
+ # url = "s3://seanerstack-buildcache"
27
+ # endpoint_url = "https://objectstore.example.org"
28
+ # credentials = "jsc-objectstore"
29
+ # autopush = true
30
+ # signed = false
31
+
32
+ # Example build cache in a directory on a local or shared filesystem. It takes
33
+ # no credentials and is unsigned unless signed = true is set:
34
+ # [resources.local-buildcache]
35
+ # kind = "spack-buildcache"
36
+ # url = "file:///scratch/seanerstack/buildcache"
37
+ # autopush = true
@@ -0,0 +1,10 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ spack:
3
+ specs:
4
+ - demobus@main
5
+
6
+ # A source checkout is deliberately not committed here. After activating this
7
+ # environment, bind one with:
8
+ # spack develop --path /path/to/demobus demobus@main
9
+ concretizer:
10
+ unify: true