Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MrStarktastic wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −6
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions data-explorer/kusto-emulator-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can install the Azure Data Explorer Kusto emulator in the following ways:
- **On your own device**: Consider using this option if you need to provision a local development environment
- **On a CI/CD agent virtual machine (VM)**: Use this option if you require a CI/CD pipeline for running automated tests

The emulator is available as a *Linux* Docker container image.
The emulator is available as a *Linux* [OCI](https://opencontainers.org/) container image. It runs on any OCI-compatible container engine, such as Docker or Podman.

In this article, you learn how to:

Expand All @@ -24,18 +24,18 @@ In this article, you learn how to:
- [Ingest data](#ingest-data)
- [Query data](#query-data)

This article focuses on how to install the Linux Docker container on a Windows client.
This article focuses on how to install the Linux container on a Windows client using Docker.

## Prerequisites

- The host operating system must be one of:
- Windows Server 2022
- Windows Server 2019 Version 10.0.17763.2928 or newer
- Windows 11
- Any Linux distribution that supports Docker Client for Linux
- Any Linux distribution that supports an OCI container engine
- A processor that supports SSE4.2/AVX2 instruction sets
- At least 2 GB of RAM (4 GB or more recommended)
- [Docker Client for Linux](https://docs.docker.com/desktop/install/linux-install/) or [Docker Client for Windows](https://docs.docker.com/desktop/windows/install/)
- An OCI-compatible container engine, such as [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation)

> [!IMPORTANT]
> Linux distros only support Linux container images.
Expand All @@ -45,14 +45,17 @@ This article focuses on how to install the Linux Docker container on a Windows c

The following steps are for using a shell to start the emulator using the [Kusto emulator container image](https://aka.ms/adx.emulator.image). For other options, see [Run emulator options](#run-emulator-options).

> [!NOTE]
> These steps use the `docker` command. The emulator is a standard OCI image, so you can run the same commands with another OCI engine such as Podman by replacing `docker` with `podman` (for example, `podman run` or `podman ps`).

1. Run the following command to start the emulator.

> [!IMPORTANT]
> The Kusto emulator container image is a free offering under the [Microsoft Software License Terms](https://aka.ms/adx.emulator.license). Since the emulator runs in a container, you must accept the license terms by passing the `ACCEPT_EULA` environment variable to the container with its value set to `Y`.

> [!NOTE]
>
> - The first time this command is run, Docker pulls the container image which is several GBs in size and might take several minutes to download. Once downloaded, the image is cached and available for subsequent runs without having to download it again.
> - The first time this command is run, the container engine pulls the container image which is several GBs in size and might take several minutes to download. Once downloaded, the image is cached and available for subsequent runs without having to download it again.

1. To start the Linux container, make sure you use the `latest` or `stable` tag:

Expand Down
2 changes: 1 addition & 1 deletion data-explorer/kusto-emulator-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Kusto emulator is a local environment that encapsulates the query engine. Yo

## Architecture

The emulator is available as a *Linux* Docker container image. It exposes a query endpoint over HTTP that can be used with any client including [Kusto.Explorer](/kusto/tools/kusto-explorer-using?view=azure-data-explorer&preserve-view=true), [Kusto.CLI](/kusto/tools/kusto-cli?view=azure-data-explorer&preserve-view=true), or [Kusto.Data SDKs](/kusto/api/netfx/about-kusto-data?view=azure-data-explorer&preserve-view=true).
The emulator is available as a *Linux* [OCI](https://opencontainers.org/) container image. It runs on any OCI-compatible container engine, such as Docker or Podman. It exposes a query endpoint over HTTP that can be used with any client including [Kusto.Explorer](/kusto/tools/kusto-explorer-using?view=azure-data-explorer&preserve-view=true), [Kusto.CLI](/kusto/tools/kusto-cli?view=azure-data-explorer&preserve-view=true), or [Kusto.Data SDKs](/kusto/api/netfx/about-kusto-data?view=azure-data-explorer&preserve-view=true).

![Schematic representation of Kusto emulator architecture.](media/kusto-emulator/kusto-emulator-architecture.png)

Expand Down