Skip to content

Commit e4d644f

Browse files
Abstracts out common steps in installation guide (#3445)
# Description A lot of content is shared between different installation guides. This MR moves them to a common "include" so that it is easier for us to maintain and modify these changes. ## Type of change - Documentation update ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Co-authored-by: Kelly Guo <[email protected]>
1 parent 0d1725e commit e4d644f

17 files changed

+918
-1498
lines changed

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,13 @@ Table of Contents
7474
=================
7575

7676
.. toctree::
77-
:maxdepth: 2
77+
:maxdepth: 1
7878
:caption: Isaac Lab
7979

8080
source/setup/ecosystem
8181
source/setup/installation/index
8282
source/deployment/index
83+
source/setup/installation/cloud_installation
8384
source/refs/reference_architecture/index
8485

8586

docs/source/deployment/index.rst

Lines changed: 61 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _container-deployment:
2+
13
Container Deployment
24
====================
35

@@ -11,13 +13,65 @@ The Dockerfile is based on the Isaac Sim image provided by NVIDIA, which include
1113
application launcher and the Isaac Sim application. The Dockerfile installs Isaac Lab and its dependencies
1214
on top of this image.
1315

14-
The following guides provide instructions for building the Docker image and running Isaac Lab in a
15-
container.
16+
Cloning the Repository
17+
----------------------
18+
19+
Before building the container, clone the Isaac Lab repository (if not already done):
20+
21+
.. tab-set::
22+
23+
.. tab-item:: SSH
24+
25+
.. code:: bash
26+
27+
git clone [email protected]:isaac-sim/IsaacLab.git
28+
29+
.. tab-item:: HTTPS
30+
31+
.. code:: bash
32+
33+
git clone https://github.com/isaac-sim/IsaacLab.git
34+
35+
Next Steps
36+
----------
37+
38+
After cloning, you can choose the deployment workflow that fits your needs:
39+
40+
- :doc:`docker`
41+
42+
- Learn how to build, configure, and run Isaac Lab in Docker containers.
43+
- Explains the repository's ``docker/`` setup, the ``container.py`` helper script, mounted volumes,
44+
image extensions (like ROS 2), and optional CloudXR streaming support.
45+
- Covers running pre-built Isaac Lab containers from NVIDIA NGC for headless training.
46+
47+
- :doc:`run_docker_example`
48+
49+
- Learn how to run a development workflow inside the Isaac Lab Docker container.
50+
- Demonstrates building the container, entering it, executing a sample Python script (`log_time.py`),
51+
and retrieving logs using mounted volumes.
52+
- Highlights bind-mounted directories for live code editing and explains how to stop or remove the container
53+
while keeping the image and artifacts.
54+
55+
- :doc:`cluster`
56+
57+
- Learn how to run Isaac Lab on high-performance computing (HPC) clusters.
58+
- Explains how to export the Docker image to a Singularity (Apptainer) image, configure cluster-specific parameters,
59+
and submit jobs using common workload managers (SLURM or PBS).
60+
- Includes tested workflows for ETH Zurich's Euler cluster and IIT Genoa's Franklin cluster,
61+
with notes on adapting to other environments.
62+
63+
- :doc:`cloudxr_teleoperation_cluster`
64+
65+
- Deploy CloudXR Teleoperation for Isaac Lab on a Kubernetes cluster.
66+
- Covers system requirements, software dependencies, and preparation steps including RBAC permissions.
67+
- Demonstrates how to install and verify the Helm chart, run the pod, and uninstall it.
68+
1669

1770
.. toctree::
18-
:maxdepth: 1
71+
:maxdepth: 1
72+
:hidden:
1973

20-
docker
21-
cluster
22-
cloudxr_teleoperation_cluster
23-
run_docker_example
74+
docker
75+
run_docker_example
76+
cluster
77+
cloudxr_teleoperation_cluster

docs/source/setup/installation/asset_caching.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Click the message to enable `Hub <https://docs.omniverse.nvidia.com/utilities/la
3434
Hub automatically manages local caching for Isaac Lab assets, so subsequent runs will use cached files instead of
3535
downloading from AWS each time.
3636

37-
.. figure:: ../../_static/setup/asset_caching.jpg
37+
.. figure:: /source/_static/setup/asset_caching.jpg
3838
:align: center
3939
:figwidth: 100%
4040
:alt: Simulator with cache messaging.

0 commit comments

Comments
 (0)