docs: add talos enterprise linux docs - #677
Conversation
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
| For example, to download a disk image with `curl`: | ||
|
|
||
| ```shell | ||
| curl -u "${EIF_USERNAME}:${EIF_TOKEN}" -fJLO \ |
There was a problem hiding this comment.
I would hold on this, there is a change incoming to change this flow a bit (how auth works).
There was a problem hiding this comment.
This is the only place the auth flow touches the page, and it's the same two variables in six examples. Rather than hold the whole section for it, let's pull the credential preamble into a snippet and reference it from each example, so when unified tokens land it's one file to change and every TEL page follows.
sterlingkoch
left a comment
sterlingkoch
left a comment
There was a problem hiding this comment.
Approving the structure. The versioned tel/v1.0 section is right and both pages read well, so this sets a good precedent for the six that follow. Line comments cover the details; three things at the PR level:
-
On the conflict, both files it touches resolve the same way and neither is a hand-merge. public/docs.json is generated, so rebase on main and re-run make docs.json rather than editing it. The Makefile conflicts because the version list was reordered to newest-first after you branched, so tel-v1.0.yaml just needs re-adding after omni.yaml in each of the four targets against the current ordering.
-
On the .mdx links: worth fixing carefully rather than quickly. The 308 you land on isn't a link-format quirk, it's a site-wide setting that turns every unresolvable URL into a redirect to the product landing page, filed as #723. When that gets turned off these will return honest 404s, so they need to be right.
Add Closes #650 and Closes #651 to the description so those don't stay open and unlinked after merge. -
Left a note on Andrey's comment about the auth flow. Short version is we should extract the credential lines into a snippet so this doesn't wait on the token rework.
There was a problem hiding this comment.
Pretty sure this file isn't supposed to be included.
|
|
||
| Enterprise Image Factory (`factory.siderolabs.com`) serves Talos Enterprise Linux boot assets along with the artifacts unique to it: per-schematic SBOMs, VEX data, and vulnerability scan reports. This page shows how to download each of them, through the web UI and programmatically. | ||
|
|
||
| For what these artifacts are and how Enterprise Image Factory differs from the public Image Factory, see <a href={`../../../talos/${version}/learn-more/enterprise-image-factory.mdx`}>Enterprise Image Factory</a> |
There was a problem hiding this comment.
I think we need to remove the .mdx extension on five of the links on this PR. I tried it with the .mdx and Mintlify did a 308 and redirected to the docs landing page. I'm assuming it was an accident and not some intentional thing that I don't understand.
| description: "How to download Talos Enterprise Linux boot assets, SBOMs, VEX data, and vulnerability scan reports from Enterprise Image Factory." | ||
| --- | ||
|
|
||
| import { version } from '/snippets/custom-variables.mdx'; |
|
|
||
| For more information, see also: | ||
|
|
||
| - <a href={`../../../talos/${version}/learn-more/enterprise-image-factory.mdx`}>Enterprise Image Factory</a>: To learn what these artifacts are and how the enterprise service differs from the public one |
|
|
||
| Grype matches every component listed in the SBOM against its vulnerability database and reports the CVEs it finds, with severity, fixed-in version, and match details. | ||
|
|
||
| Because the SBOM is generated per schematic, it describes your exact image — the Talos base plus every system extension in your configuration. This differs from the release SBOMs published on GitHub, which cover only the unmodified base OS. For base-OS SBOMs and reading SBOMs from a running node, see <a href={`../../../talos/${version}/advanced-guides/SBOM.mdx`}>SBOMs</a>. |
| For more information, see also: | ||
|
|
||
| - [Download images and artifacts from Enterprise Image Factory](./download-images-and-artifacts): How to retrieve the SBOM, VEX data, and scan reports used on this page | ||
| - <a href={`../../../talos/${version}/learn-more/enterprise-image-factory.mdx`}>Enterprise Image Factory</a>: What these artifacts are and how the enterprise service differs from the public one |
| For example, to download a disk image with `curl`: | ||
|
|
||
| ```shell | ||
| curl -u "${EIF_USERNAME}:${EIF_TOKEN}" -fJLO \ |
There was a problem hiding this comment.
This is the only place the auth flow touches the page, and it's the same two variables in six examples. Rather than hold the whole section for it, let's pull the credential preamble into a snippet and reference it from each example, so when unified tokens land it's one file to change and every TEL page follows.
4 participants
No description provided.