Skip to content

docs: add the On Premises token actor profile - #934

Open
Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:eif-on-premises-token-actor
Open

Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:eif-on-premises-token-actor

Conversation

@Iheanacho-ai

Copy link
Copy Markdown
Member

What

Adds the On Premises token actor profile to the Enterprise Image Factory API Tokens page.

Why

Image Factory v1.7.1 added a fifth token actor, On Premises, to the Create Token form on Enterprise Image Factory. The API Tokens page still listed four profiles, so readers had no way to tell what the new option grants or when to use it.

Change

  • Changed "four fixed actor profiles" to "five".
  • Added an On Premises entry after Talos, matching the order in the UI. It covers:
    • the source:pull scope, its purpose (mirroring source images into an on-premises installation), and the images it can pull under /v2/siderolabs/
    • what it doesn't grant: generated images, schematics, the security report endpoints, or token management

Testing

  • Ran: Checked the profile against the Image Factory source (v1.8.0):
    • internal/apitoken/scope.go: the onprem profile carries only source:pull, which allows read-only requests under /v2/siderolabs/. image:read excludes those paths.
    • cmd/image-factory/cmd/options.go (ImageMap): the proxied images are installer-base, installer, imager, extensions, overlays, talosctl-all, image-factory, and talos-vex-data. internal/registry/service.go (Proxy) rejects anything else.
    • pkg/client/client.go and frontend/src/locales/en.json: the purpose, the "On Premises" label, and the help text.
    • Added in commit c35986a, first released in v1.7.1.
  • Ran: Compared against the Create Token form on factory.siderolabs.com. The label, help text, and order match.
  • Ran: make style-check-changed-local (0 errors, 0 warnings) and make check-frontmatter-changed.
  • Where: Source review, the live Enterprise Image Factory UI, and local checks. No On Premises token was created or used to pull images.
  • By: An agent (Claude Code) for the source review and checks, and me for the UI comparison.
  • Filled from outside the page: Nothing.

Enterprise Image Factory offers an On Premises actor profile, added in
Image Factory v1.7.1, that carries only the source:pull scope for
mirroring source images into an on-premises installation. Document it
and update the profile count to five.

Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
@mintlify

mintlify Bot commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit 180652c.

Approve preview

@github-actions

Copy link
Copy Markdown

📋 Automated documentation review

An automated pass runs on documentation changes in every PR. The items below are suggestions to consider — advisory, not a merge gate.

Reviewed commit 180652c · 🔴 0 critical · 🟡 0 warning(s) · ⚪ 1 notice(s)

Nothing flagged at critical or warning level — see any notices inline.

Notices, and the reviewer's full report, are in the run's doc-accuracy-report artifact.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants