Skip to content

Reframe Kusto emulator docs around OCI (multi-client) - #2912

Open
Ben Faingold (MrStarktastic) wants to merge 1 commit into
MicrosoftDocs:mainfrom
MrStarktastic:user/benfaingold/kusto-emulator-oci-multi-client
Open

Reframe Kusto emulator docs around OCI (multi-client)#2912
Ben Faingold (MrStarktastic) wants to merge 1 commit into
MicrosoftDocs:mainfrom
MrStarktastic:user/benfaingold/kusto-emulator-oci-multi-client

Conversation

@MrStarktastic

Copy link
Copy Markdown

Summary

Reframe the Kusto emulator documentation around the OCI image format so it no longer implies a single-vendor (Docker) dependency. The published kustainer-linux image is a standard OCI image and already runs under any OCI-compatible engine (Docker, Podman, and others); these docs described it as a "Docker" image and required the Docker client specifically.

This is a minimal reframe with no command changes — the Docker walkthrough is intentionally kept as the concrete example.

Changes

kusto-emulator-overview.md

  • Architecture: "Linux Docker container image" → "Linux OCI container image", noting it runs on any OCI-compatible engine such as Docker or Podman.

kusto-emulator-install.md

  • Same OCI relabel in the intro.
  • Prerequisites: require "an OCI-compatible container engine, such as Docker or Podman" instead of the Docker client specifically.
  • Added a note that the docker-based steps work with Podman by swapping docker for podman.
  • Generalized the first-run "pulls the image" note from "Docker" to "the container engine".
  • Kept all docker run/docker ps/docker stop examples unchanged.

Context

Motivated by Docker Desktop licensing friction for customers running the emulator. The team's direction (per Vincent-Philippe Lauzon, ms.reviewer on these articles) is to standardize the docs on the OCI format and present a "multi-client" approach rather than switch to a specific alternative client.

Notes for doc writers

  • Scope is deliberately limited to the OCI/multi-client wording; the step-by-step install procedure is unchanged in this PR.
  • Podman-specific caveats (rootless port publishing, advisory -m under rootless cgroups v2) are intentionally left out to keep this change minimal; happy to add a short "Notes for Podman" section if you'd prefer.

The published kustainer-linux image is a standard OCI image, so it runs
under any OCI-compatible engine (Docker, Podman, and others). These docs
previously described it as a "Docker" image and required the Docker
client, implying a single-vendor dependency.
Minimal reframe (no command changes):
- Relabel "Linux Docker container image" as "Linux OCI container image"
and name Docker/Podman as example engines (overview + install).
- Prerequisites: require "an OCI-compatible container engine, such as
Docker or Podman" instead of the Docker client specifically.
- Add a note that the docker-based steps work with Podman by swapping
`docker` for `podman`; generalize the first-run pull note.
The Docker walkthrough is intentionally kept as the concrete example.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 8f2064c2-d734-4d90-afd5-fa1b1743ff2f
@prmerger-automator

Copy link
Copy Markdown
Contributor

Ben Faingold (@MrStarktastic) : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

@prmerger-automator

Copy link
Copy Markdown
Contributor

Ben Faingold (@MrStarktastic) : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit c9a340d:

✅ Validation status: passed

FileStatusPreview URLDetails
data-explorer/kusto-emulator-install.md✅Succeeded
data-explorer/kusto-emulator-overview.md✅Succeeded

For more details, please refer to the build report.

@v-regandowner

Copy link
Copy Markdown
Contributor

Sreedhar Pelluru (@spelluru)

Can you review the proposed changes?

IMPORTANT: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automatorprmerger-automatorBot added the aq-pr-triaged tracking label for the PR review team label Jul 13, 2026
@zivcaspi

Copy link
Copy Markdown
Contributor

#sign-off

@prmerger-automator

Copy link
Copy Markdown
Contributor

Invalid command: '#sign-off'. Only the assigned author of one or more file in this PR can sign off. Sreedhar Pelluru (@spelluru)

@v-dirichards

Copy link
Copy Markdown
Contributor

Hi Ziv Caspi (@zivcaspi) - Thanks for your review. In the public repo, pull requests should be signed off by the author, another member of the content team, or a PM.


Sreedhar Pelluru (@spelluru) Could you take a look? Thanks!

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@MrStarktastic

Copy link
Copy Markdown
Author

#sign-off

@prmerger-automator

Copy link
Copy Markdown
Contributor

Invalid command: '#sign-off'. Only the assigned author of one or more file in this PR can sign off. Sreedhar Pelluru (@spelluru)

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@MrStarktastic@v-regandowner@zivcaspi@v-dirichards@spelluru