Skip to content

Commit d79c9a9

Browse files
committed
add doc for using docker images
1 parent 2d5d85f commit d79c9a9

File tree

3 files changed

+90
-0
lines changed

3 files changed

+90
-0
lines changed

docs/docker_linux.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Use LISA docker image on Linux
2+
=====================
3+
4+
This guide will walk you through using the LISA Docker image on a Linux system.
5+
6+
Install docker on Linux
7+
-----------------------
8+
9+
The first steps are to install Docker on your system.
10+
11+
On Ubuntu, you can install Docker with the following commands:
12+
13+
.. code:: bash
14+
15+
sudo apt update
16+
sudo apt install docker.io -y
17+
18+
On Azure Linux, you can install Docker with the following commands:
19+
20+
.. code:: bash
21+
22+
sudo tdnf update
23+
sudo tdnf install -y moby-engine moby-cli
24+
25+
Start Docker service
26+
--------------------
27+
28+
After installing Docker, you can start the Docker service with the following command:
29+
30+
.. code:: bash
31+
32+
sudo systemctl start docker
33+
34+
List docker images
35+
------------------
36+
37+
You can check the available tags for the LISA Docker image by listing the tags from the Microsoft Azure Registry.
38+
39+
.. code:: bash
40+
41+
curl -s https://mcr.microsoft.com/v2/lisa/runtime/tags/list
42+
43+
Launch LISA container
44+
-----------------------
45+
46+
Use below command to launch the LISA container.
47+
48+
.. code:: bash
49+
50+
sudo docker run --rm -i mcr.microsoft.com/lisa/runtime:latest lisa -r ./examples/runbook/hello_world.yml

docs/docker_windows.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Use LISA docker image on Windows
2+
=====================
3+
4+
This guide will walk you through using the LISA Docker image on a Windows system.
5+
6+
Install Docker Desktop on Windows
7+
-----------------------
8+
9+
The first steps are to install Docker on your system.
10+
11+
You can download Docker Desktop from the `Docker website <https://www.docker.com/products/docker-desktop>`__.
12+
13+
Start Docker service
14+
--------------------
15+
16+
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.
17+
18+
.. code:: powershell
19+
20+
Start-Process "C:\Program Files\Docker\Docker\Docker Desktop.exe"
21+
22+
List docker images
23+
------------------
24+
25+
You can check the available tags for the LISA Docker image by listing the tags from the Microsoft Azure Registry.
26+
27+
.. code:: powershell
28+
29+
(Invoke-WebRequest -Uri "https://mcr.microsoft.com/v2/lisa/runtime/tags/list" -UseBasicParsing).Content
30+
31+
Launch LISA container
32+
-----------------------
33+
34+
Use below command to launch the LISA container.
35+
36+
.. code:: powershell
37+
38+
docker run --rm -i mcr.microsoft.com/lisa/runtime:latest lisa -r ./examples/runbook/hello_world.yml

docs/install.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Currently we support installation on Linux & Windows.
66
.. toctree::
77
:maxdepth: 2
88

9+
Use docker images on Linux. <docker_linux>
10+
Use docker images on Windows. <docker_windows>
911
Installation on Linux <installation_linux>
1012
Installation on Windows <installation_windows>
1113
Updating LISA <update>

0 commit comments

Comments
 (0)