feat(repo): add root capabilities and reorganize README (#17)

WilliamBerryiii · web-flow · commit 4aede6fb33fe · 2026-01-30T17:08:18.000-08:00
- add SECURITY.md with Microsoft standard vulnerability reporting
- add SUPPORT.md with community support documentation
- add dependabot.yml for pip, terraform, and github-actions
- reorganize README with frontmatter, trademark, and responsible AI

📚 - Generated by Copilot
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,84 @@
+version: 2
+updates:
+  # Python dependencies
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 10
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"
+    labels:
+      - "dependencies"
+      - "python"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  # Python dependencies for training
+  - package-ecosystem: "pip"
+    directory: "/src/training"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    groups:
+      training-dependencies:
+        patterns:
+          - "*"
+    labels:
+      - "dependencies"
+      - "python"
+      - "training"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  # Terraform modules
+  - package-ecosystem: "terraform"
+    directory: "/deploy/001-iac"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    labels:
+      - "dependencies"
+      - "terraform"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  # Terraform DNS module
+  - package-ecosystem: "terraform"
+    directory: "/deploy/001-iac/dns"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    labels:
+      - "dependencies"
+      - "terraform"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  # GitHub Actions (when workflows are added)
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+    labels:
+      - "dependencies"
+      - "github-actions"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
diff --git a/README.md b/README.md
@@ -1,8 +1,26 @@
-# 🤖 Azure NVIDIA Robotics Reference Architecture
+---
+title: Azure Robotics Reference Architecture with NVIDIA OSMO
+description: Production-ready framework for orchestrating robotics and AI workloads on Microsoft Azure using NVIDIA Isaac Lab, Isaac Sim, and OSMO
+author: Microsoft
+ms.date: 2025-12-03
+ms.topic: overview
+keywords:
+  - azure
+  - nvidia
+  - osmo
+  - isaac lab
+  - isaac sim
+  - robotics
+  - reinforcement learning
+  - mlflow
+estimated_reading_time: 5
+---
+
+# Azure NVIDIA Robotics Reference Architecture
 
 Production-ready framework for orchestrating robotics and AI workloads on [Azure](https://azure.microsoft.com/) using [NVIDIA Isaac Lab](https://developer.nvidia.com/isaac/lab), [Isaac Sim](https://developer.nvidia.com/isaac/sim), and [OSMO](https://developer.nvidia.com/osmo).
 
-## 🚀 Features
+## Features
 
 | Capability | Description |
 |------------|-------------|
@@ -14,7 +32,7 @@ Production-ready framework for orchestrating robotics and AI workloads on [Azure
 | GPU Scheduling | [KAI Scheduler](deploy/002-setup/values/kai-scheduler.yaml) for efficient utilization |
 | Auto-scaling | Pay-per-use GPU compute on AKS Spot nodes |
 
-## 🏗️ Architecture
+## Architecture
 
 The infrastructure deploys an AKS cluster with GPU node pools running the NVIDIA GPU Operator and KAI Scheduler. Training workloads can be submitted via OSMO workflows (control plane and backend operator) and AzureML jobs (ML extension). Both platforms share common infrastructure: Azure Storage for checkpoints and data, Key Vault for secrets, and Azure Container Registry for container images. OSMO additionally uses PostgreSQL for workflow state and Redis for caching.
 
@@ -46,12 +64,10 @@ The infrastructure deploys an AKS cluster with GPU node pools running the NVIDIA
 | OSMO Control Plane | Workflow API, router, and web interface |
 | OSMO Backend Operator | Workflow execution on cluster |
 
-⚙️ = Optional component
-
 > [!NOTE]
 > Running both AzureML and OSMO on the same cluster? Create **separate GPU node pools** for each platform. AzureML uses [Volcano](https://volcano.sh/) while OSMO uses [KAI Scheduler](https://github.com/NVIDIA/KAI-Scheduler)—these schedulers don't share resource visibility. Without dedicated pools, jobs from one platform may fail when the other is using GPU resources. Configure node selectors and taints to isolate workloads.
 
-## 🌍 Real World Examples
+## Real World Examples
 
 OSMO orchestration on Azure enables production-scale robotics training across industries:
 
@@ -62,7 +78,7 @@ OSMO orchestration on Azure enables production-scale robotics training across in
 | Legged Robots | Locomotion optimization with MLflow tracking for sim-to-real transfer |
 | Collaborative Robots | Safe interaction policies with Azure Monitor logging for compliance |
 
-## 📋 Prerequisites
+## Prerequisites
 
 ### Required Tools
 
@@ -83,7 +99,7 @@ OSMO orchestration on Azure enables production-scale robotics training across in
   - Alternative: **Owner** (grants more permissions than required)
 - GPU VM quota for your target region (e.g., `Standard_NV36ads_A10_v5`)
 
-## 🏃 Quick Start
+## Quick Start
 
 ### 1. Deploy Infrastructure
 
@@ -184,7 +200,7 @@ See [Accessing OSMO](deploy/002-setup/README.md#-accessing-osmo) for port-forwar
 
 > **Tip**: Run any script with `--help` for all available options.
 
-## 🔐 Deployment Scenarios
+## Deployment Scenarios
 
 | Scenario | Storage Auth | Registry | Use Case |
 |----------|--------------|----------|----------|
@@ -194,7 +210,7 @@ See [Accessing OSMO](deploy/002-setup/README.md#-accessing-osmo) for port-forwar
 
 See [002-setup/README.md](deploy/002-setup/README.md) for detailed instructions.
 
-## 📁 Repository Structure
+## Repository Structure
 
 ```text
 .
@@ -212,7 +228,7 @@ See [002-setup/README.md](deploy/002-setup/README.md) for detailed instructions.
 └── docs/                               # Additional documentation
 ```
 
-## 📖 Documentation
+## Documentation
 
 | Guide | Description |
 |-------|-------------|
@@ -223,7 +239,7 @@ See [002-setup/README.md](deploy/002-setup/README.md) for detailed instructions.
 | [Workflows](workflows/README.md) | Job and workflow templates |
 | [MLflow Integration](docs/mlflow-integration.md) | Experiment tracking setup |
 
-## 💰 Cost Estimation
+## Cost Estimation
 
 Use the [Azure Pricing Calculator](https://azure.microsoft.com/pricing/calculator/) to estimate costs. Add these services based on the architecture:
 
@@ -242,12 +258,36 @@ Use the [Azure Pricing Calculator](https://azure.microsoft.com/pricing/calculato
 
 GPU Spot VMs provide significant savings (60-90%) compared to on-demand pricing. Actual costs depend on training frequency, job duration, and data volumes.
 
-## 🪪 License
+## Contributing
 
-MIT License. See [LICENSE.md](LICENSE.md).
+We appreciate contributions! Check out [open issues](https://github.com/Azure-Samples/azure-nvidia-robotics-reference-architecture/issues) to get started.
 
-## 🙏 Acknowledgments
+## Acknowledgments
 
 - [microsoft/edge-ai](https://github.com/microsoft/edge-ai) – Infrastructure components
 - [NVIDIA Isaac Lab](https://github.com/isaac-sim/IsaacLab) – RL framework
 - [NVIDIA OSMO](https://github.com/NVIDIA/OSMO) – Workflow orchestration
+
+## Responsible AI
+
+Microsoft encourages customers to review its Responsible AI Standard when developing AI-enabled systems to ensure ethical, safe, and inclusive AI practices. Learn more at [Microsoft's Responsible AI](https://www.microsoft.com/ai/responsible-ai).
+
+## Legal
+
+This project is licensed under the [MIT License](./LICENSE.md).
+
+**Security:** See [SECURITY.md](./SECURITY.md) for security policy and reporting vulnerabilities.
+
+## Trademark Notice
+
+> This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
+> trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in
+> modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or
+> logos are subject to those third-party's policies.
+
+---
+
+<!-- markdownlint-disable MD036 -->
+*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,
+then carefully refined by our team of discerning human reviewers.*
+<!-- markdownlint-enable MD036 -->
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.9 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet) and [Xamarin](https://github.com/xamarin).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/security.md/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/security.md/msrc/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/security.md/msrc/pgp).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/security.md/msrc/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/security.md/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,62 @@
+# Support
+
+Thank you for using the Azure NVIDIA Robotics Reference Architecture! This document explains how to get help with issues, questions, and contributions.
+
+## How to Get Support
+
+### Community Support
+
+This is an open-source reference architecture maintained by Microsoft and community contributors. We provide community support through GitHub issue tracking with the following response commitments:
+
+| Priority Level | Description | Response Time Target |
+|----------------|-------------|----------------------|
+| Security Vulnerability | Security issues (see [SECURITY.md](SECURITY.md)) | 24 hours (via MSRC) |
+| Critical | Blocking issues preventing deployment | 1-2 business days |
+| Major | Significant issues affecting functionality | 3-5 business days |
+| General Issues & Questions | Bug reports, feature requests, questions | Best effort |
+
+**Note**: Response times indicate initial acknowledgment. Resolution time varies based on issue complexity and community availability.
+
+## Filing Issues
+
+### General Issues, Bugs, and Feature Requests
+
+1. **Search existing issues** in our [GitHub Issues](https://github.com/Azure-Samples/azure-nvidia-robotics-reference-architecture/issues)
+2. **Create a new issue** if yours isn't already tracked: [New Issue](https://github.com/Azure-Samples/azure-nvidia-robotics-reference-architecture/issues/new/choose)
+3. **Provide details**:
+   - Clear description of the problem or request
+   - Steps to reproduce (for bugs)
+   - Expected vs. actual behavior
+   - Environment details (OS, Azure region, component versions)
+
+### Security Vulnerabilities
+
+**Do not file security issues in GitHub.**
+
+If you believe you've found a security vulnerability:
+
+1. Report to the [Microsoft Security Response Center (MSRC)](https://msrc.microsoft.com/create-report)
+2. Or email: [secure@microsoft.com](mailto:secure@microsoft.com)
+3. See our [SECURITY.md](SECURITY.md) for complete reporting instructions
+
+We respond to security reports within **24 hours** and follow coordinated disclosure practices.
+
+## Contributing
+
+Before contributing code, please:
+
+1. Check for existing issues or create a new one
+2. Follow the coding conventions in this repository
+3. Test your changes with the provided training scripts
+
+## Microsoft Support Policy
+
+Support for this project is limited to the community support described above. This is an open-source reference architecture and does not include enterprise-level SLA commitments.
+
+For enterprise support related to Azure services, please contact [Azure Support](https://azure.microsoft.com/support/options/).
+
+## Code of Conduct
+
+This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+For questions, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com).
