Skip to content

Commit 4f1c889

Browse files
committed
Fix deployment links
1 parent 6e588d5 commit 4f1c889

File tree

13 files changed

+24
-17
lines changed

13 files changed

+24
-17
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you are interested in contributing to OSMO, your contributions will fall into
2727

2828
- **[Git LFS](https://git-lfs.com/)** - Source control for large files (>=3.7.1)
2929
- **[Bazel](https://bazel.build/install/bazelisk)** - Build tool (>=8.1.1)
30-
- **[Docker](https://docs.docker.com/get-docker/)** - Container runtime (>=28.3.2)
30+
- **[Docker](https://docs.docker.com/get-started/get-docker/)** - Container runtime (>=28.3.2)
3131
- **[Helm](https://helm.sh/docs/intro/install/)** - Package manager for Kubernetes (>=3.17.1)
3232
- **[KIND](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)** - Kubernetes in Docker
3333
(>=0.29.0)

docs/conf.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,18 @@
7171

7272
# Linkcheck ignore
7373
linkcheck_ignore = [
74-
'https://github.com/settings/tokens/new',
7574
'https://osmo-example-url.com*',
76-
'https://github.com/NVIDIA/Isaac-GR00T*',
75+
'http://osmo.example.com*',
76+
'https://osmo.example.com*',
77+
'http://localhost:*',
78+
# Requires authentication so we can't check it
79+
'https://github.com/settings/tokens/new',
80+
'https://console.volcengine.com*',
81+
'https://us-east-1.console.aws.amazon.com*'
7782
]
7883

84+
linkcheck_anchors = False
85+
7986
# Copybutton
8087
copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
8188
copybutton_prompt_is_regexp = True

docs/deployment_guide/appendix/deploy_local.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Prerequisites
5656

5757
Install the following tools on your workstation:
5858

59-
* `Docker <https://docs.docker.com/get-docker/>`_ - Container runtime (>=28.3.2)
59+
* `Docker <https://docs.docker.com/get-started/get-docker/>`_ - Container runtime (>=28.3.2)
6060
* `KIND <https://kind.sigs.k8s.io/docs/user/quick-start/#installation>`_ - Kubernetes in Docker (>=0.29.0)
6161
* `kubectl <https://kubernetes.io/docs/tasks/tools/>`_ - Kubernetes command-line tool (>=1.32.2)
6262
* `helm <https://helm.sh/docs/intro/install/>`_ - Helm package manager (>=3.16.2)

docs/deployment_guide/appendix/deploy_minimal.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -610,11 +610,11 @@ With Ingress
610610
611611
1. **Access OSMO Service API**:
612612
613-
Visit https://<your-domain>/api/docs in your web browser to access the OSMO API.
613+
Visit ``https://<your-domain>/api/docs`` in your web browser to access the OSMO API.
614614
615615
2. **Access OSMO UI**:
616616
617-
Visit https://<your-domain> in your web browser to access the OSMO UI.
617+
Visit ``https://<your-domain>`` in your web browser to access the OSMO UI.
618618
619619
.. note::
620620
1. Replace ``<your-domain>`` with your domain name or use the alternative approach below

docs/deployment_guide/getting_started/create_storage/s3/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To handle who can access Datasets, the necessary AWS resources/policies must be
3131
Setting up the bucket
3232
=====================
3333

34-
First, navigate to the `AWS S3 console <https://s3.console.aws.amazon.com/s3/home?region=us-west-2>`_
34+
First, navigate to the `AWS S3 console <https://console.aws.amazon.com:443/s3/home?region=us-west-2>`_
3535

3636
Click on the ``Create Bucket`` button.
3737

docs/deployment_guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Integrate with your existing storage infrastructure:
6767

6868
.. seealso::
6969

70-
Learn more about OSMO in the `What is OSMO? <https://nvidia.github.io/OSMO/user_guide/main/index.html#what-is-osmo>`_ section of the User Guide.
70+
Learn more about OSMO in the `Welcome to OSMO <https://nvidia.github.io/OSMO/user_guide/main/index.html>`_ section of the User Guide.
7171

7272
What You'll Deploy
7373
==================

docs/deployment_guide/install_backend/create_backend/cloud_setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Setup Guide
6363
* `Node pools <https://cloud.google.com/kubernetes-engine/docs/concepts/node-pools>`__
6464
- * **Backend-Operator**: n1-standard-4 (4 vCPUs, 8 GB RAM, auto-scaling: 1-3 nodes)
6565
* **Compute (CPU)**: n1-standard-8
66-
* **Compute (GPU)**: n1-standard-4 with T4/A100, a2-highgpu-1g (A100), a3-highgpu-8g (H100) - `GPUs on Compute Engine <https://cloud.google.com/compute/docs/gpus>`__
66+
* **Compute (GPU)**: n1-standard-4 with T4/A100, a2-highgpu-1g (A100), a3-highgpu-8g (H100) - `GPUs on Compute Engine <https://docs.cloud.google.com/compute/docs/gpus>`__
6767

6868
.. note::
6969

docs/deployment_guide/install_backend/create_backend/onprem_setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Kubeadm is the official tool for bootstrapping Kubernetes clusters and provides
9797
1. Install containerd 1.7.27+ as the container runtime
9898
2. Configure control plane and worker nodes per specifications above
9999
3. Apply appropriate node labels (``node-type=operator``, ``node-type=compute``, ``node-type=gpu``, ``node-type=jetson``)
100-
4. For GPU nodes (x86_64): Install `NVIDIA drivers <https://docs.nvidia.com/datacenter/tesla/tesla-installation-notes/index.html>`__ (535.216.03+), `CUDA <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html>`__ (12.6+), and `NVIDIA Container Toolkit <https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html>`__
100+
4. For GPU nodes (x86_64): Install `NVIDIA drivers <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/>`__ (535.216.03+), `CUDA <https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html>`__ (12.6+), and `NVIDIA Container Toolkit <https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html>`__
101101
5. For GPU nodes (Jetson): Install `JetPack 6.2+ <https://developer.nvidia.com/embedded/jetpack>`__ (includes CUDA and container runtime)
102102
6. Configure CNI plugin and verify CoreDNS is operational
103103
7. Configure firewall rules per `Kubernetes Ports and Protocols <https://kubernetes.io/docs/reference/networking/ports-and-protocols/>`__

docs/deployment_guide/install_backend/dependencies/dependencies.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Install Dependencies
3434
Install KAI Scheduler
3535
======================
3636

37-
OSMO uses `KAI scheduler <https://github.com/NVIDIA/kai-scheduler>`_ to run AI workflows at very large scale with `Workflow Groups <http://nvidia.github.io/OSMO/user_guide/main/tutorials/parallel_workflows/index.html#groups>`_.
37+
OSMO uses `KAI scheduler <https://github.com/NVIDIA/kai-scheduler>`_ to run AI workflows at very large scale with `Workflow Groups <https://nvidia.github.io/OSMO/user_guide/main/tutorials/parallel_workflows/index.html#groups>`_.
3838

3939
For more information on the scheduler, see :ref:`scheduler`.
4040

docs/deployment_guide/install_backend/observability.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Download the following dashboard JSON files:
5050
Import to Grafana
5151
-------------------
5252

53-
Import the dashboards using `Grafana's Import Dashboard <https://grafana.com/docs/grafana/latest/dashboards/export-import/#import-a-dashboard>`__ documentation.
53+
Import the dashboards using `Grafana's Import Dashboard <https://grafana.com/docs/grafana/latest/visualizations/dashboards/build-dashboards/import-dashboards/>`__ documentation.
5454

5555
Configure Alerts
5656
-----------------
@@ -61,7 +61,7 @@ Set up alerts using Grafana's `alert configuration <https://grafana.com/docs/gra
6161
Install Storage Metrics
6262
====================================
6363

64-
To enable usage metrics for ephemeral storage in Grafana, install the `k8s-ephemeral-storage-metrics <https://github.com/jmcgrath207/k8s-ephemeral-storage-metrics#installation>`__ plugin in your compute cluster.
64+
To enable usage metrics for ephemeral storage in Grafana, install the `k8s-ephemeral-storage-metrics <https://github.com/jmcgrath207/k8s-ephemeral-storage-metrics>`__ plugin in your compute cluster.
6565

6666
Update Backend Configs
6767
=============================

0 commit comments

Comments
 (0)