Skip to content

Commit

Permalink
add doc for pulling docker images
Browse files Browse the repository at this point in the history
  • Loading branch information
LiliDeng committed Mar 4, 2025
1 parent 2d5d85f commit ffdabc5
Showing 3 changed files with 90 additions and 0 deletions.
50 changes: 50 additions & 0 deletions docs/docker_linux.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Pull LISA docker image on Linux
=====================

This guide will walk you through pulling the LISA Docker image on a Linux system.

Install docker on Linux
-----------------------

The first steps are to install Docker on your system.

On Ubuntu, you can install Docker with the following commands:

.. code:: bash
sudo apt update
sudo apt install docker.io -y
On Azure Linux, you can install Docker with the following commands:

.. code:: bash
sudo tdnf update
sudo tdnf install -y moby-engine moby-cli
Start Docker service
--------------------

After installing Docker, you can start the Docker service with the following command:

.. code:: bash
sudo systemctl start docker
List docker images
------------------

You can check the available tags for the LISA Docker image by listing the tags from the Microsoft Azure Registry.

.. code:: bash
curl -s https://mcr.microsoft.com/v2/lisa/runtime/tags/list
Launch LISA container
-----------------------

Use below command to launch the LISA container.

.. code:: bash
sudo docker run --rm -i mcr.microsoft.com/lisa/runtime:latest lisa -r ./examples/runbook/hello_world.yml
38 changes: 38 additions & 0 deletions docs/docker_windows.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Pull LISA docker image on Windows
=====================

This guide will walk you through pulling the LISA Docker image on a Windows system.

Install Docker Desktop on Windows
-----------------------

The first steps are to install Docker on your system.

You can download Docker Desktop from the `Docker website <https://www.docker.com/products/docker-desktop>`__.

Start Docker service
--------------------

After installing Docker, open the Docker Desktop application to start the Docker service. Or use the following command to launch and start the Docker service.

.. code:: powershell
Start-Process "C:\Program Files\Docker\Docker\Docker Desktop.exe"
List docker images
------------------

You can check the available tags for the LISA Docker image by listing the tags from the Microsoft Azure Registry.

.. code:: powershell
(Invoke-WebRequest -Uri "https://mcr.microsoft.com/v2/lisa/runtime/tags/list" -UseBasicParsing).Content
Launch LISA container
-----------------------

Use below command to launch the LISA container.

.. code:: powershell
docker run --rm -i mcr.microsoft.com/lisa/runtime:latest lisa -r ./examples/runbook/hello_world.yml
2 changes: 2 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -6,6 +6,8 @@ Currently we support installation on Linux & Windows.
.. toctree::
:maxdepth: 2

Use docker images on Linux. <docker_linux>
Use docker images on Windows. <docker_windows>
Installation on Linux <installation_linux>
Installation on Windows <installation_windows>
Updating LISA <update>

0 comments on commit ffdabc5

Please sign in to comment.