Skip to content

MSR Documentation

Tutorials

Initializing search

MSR Documentation Contents

Product Overview
MSR 4 Key Changes
MSR 4 Key Changes
Architecture
Architecture
- Reference Architecture
  Reference Architecture
- Deployment
  Deployment
  - Deployment Options
    
    Deployment Options
    
    All-in-one Deployment
    
    High Availability Deployment
  - Components Deployment
    
    Components Deployment
    
    Web Portal
    
    Proxy (API Routing)
    
    Core
    
    Job Service
    
    Registry
    
    Tivy
    
    K-V storage
    
    SQL Database
  - Deployment Resources
    
    Deployment Resources
    
    Harbor Helm Chart
    
    Valkey Helm Chart
    
    PostgreSQL Helm Chart
  - Interact with MSR
- System Requirements
- Storage
- Networking
- Security
  Security
Installation Guide
Installation Guide
- Prepare MKE for MSR Installation
- Prerequisites
- Install MSR with High Availability
  Install MSR with High Availability
  - Prerequisites
  - Install Helm
  - Create PVC across Kubernetes workers
  - Install Highly Available PostgreSQL
  - Install Highly Available Cache
    
    Install Highly Available Cache
    
    Install Highly Available Valkey (preferred)
    
    Install Highly Available Valkey (preferred)
    
    Install highly available Valkey with replication (preferred)
    
    Install Highly Available Redis
    
    Install Highly Available Redis
    
    Install highly available Redis with replication
    
    Install highly available Redis with Sentinel
    
    Migrate from Redis to Valkey
    
    Migrate from Redis to Valkey
    
    Upgrade MSR to use Valkey
    
    Remove Redis
  - Install Highly Available MSR
- Install MSR single host using Docker Compose
  Install MSR single host using Docker Compose
- Install MSR single host using Helm
  Install MSR single host using Helm
- Install MSR using Envoy Gateway
  Install MSR using Envoy Gateway
  - Install MSR on MKE 4k
  - Install MSR on MKE 3
Operations Guide
Operations Guide
- Authentication Configuration
  Authentication Configuration
- Configuring Replication
- Configuring Webhooks
- Log Rotation and Forwarding
- Managing Garbage Collection
- Managing Project Permissions
- Managing Tag Retention Rules
- Metrics Collection and Visualization
- Mirror Images
- Proxy Caches
  Proxy Caches
- Signing Artifacts with Cosign
- Troubleshoot MSR
  Troubleshoot MSR
- Upgrade Guide
  Upgrade Guide
  - Semantic versioning
  - Upgrade using Helm
    
    Upgrade using Helm
    
    Minor and major upgrade procedure
    
    Patch upgrade procedure
    
    Troubleshooting
  - Upgrade using Docker Compose
    
    Upgrade using Docker Compose
    
    Minor and major upgrade procedure
    
    Patch upgrade procedure
  - Upgrade Harbor to MSR
- Vulnerability Scanning
- SBOM Management
  SBOM Management
  - Managing SBOMs
  - Retrieving SBOMs for MSR Images
Tutorials
Tutorials
- Setup for MSR with Entra ID OIDC authentication
  Setup for MSR with Entra ID OIDC authentication
Backup Guide
Backup Guide
- Velero Installation
- HA Backup
  HA Backup
- Single Instance Backup
- Disaster Recovery
  Disaster Recovery
  - NFS Metadata Restore
    
    NFS Metadata Restore
    
    Install MinIO and Velero
    
    Backup and Restore
  - NFS Full Restore
    
    NFS Full Restore
    
    Install MinIO and Velero
    
    Backup and Restore
  - MinIO Bucket Replication
    
    MinIO Bucket Replication
    
    Configure bucket replication with Web UI
    
    Configure bucket replication with CLI
    
    Troubleshoot bucket replication
Migration Guide
Migration Guide
- Manual Migration
  Manual Migration
- Tool Migration
  Tool Migration
  - What to Expect During the Migration
  - Migration Prerequisites
  - Install Migration Tool
  - Database Access Configuration
  - Configure Migration Settings
  - Perform Migration
    
    Perform Migration
    
    Migrate Projects
    
    Migrate Permissions
    
    Migrate Push and Poll Mirroring Policies
  - Validate Migration Data
  - Post-Migration Configuration
  - Post-Migration Cleanup
  - Migration Tool Reference
    
    Migration Tool Reference
    
    Command Reference
    
    Configuration Reference
  - Migration Tool Release Notes
    
    Migration Tool Release Notes
    
    Migration Tool 1.5.0
    
    Migration Tool 1.4.1
    
    Migration Tool 1.4.0
    
    Migration Tool 1.3.0
    
    Migration Tool 1.2.0
    
    Migration Tool 1.1.0
    
    Migration Tool 1.0.1
    
    Migration Tool 1.0.0
Support, Services, Contact
Support, Services, Contact
Releases and Lifecycle
Release Notes
Release Notes
- 4.13.8
  4.13.8
- 4.13.7
  4.13.7
- 4.13.6
  4.13.6
- 4.13.5
  4.13.5
- 4.13.4
  4.13.4
- 4.13.3
  4.13.3
- 4.13.2
  4.13.2
- 4.13.1
  4.13.1
- 4.13.0
  4.13.0
Release Compatibility Matrix
MKE, MSR, and MCR Maintenance Lifecycle
Release Cadence and Support Lifecycle
Previous Versions
MSR 4.0 (EOL)
MSR 3.1 (EOL)
MSR 3.0 (EOL)
MSR 2.8 (EOL)

Home
Tutorials

Tutorials#

Scenario 1: Setup for MSR with Entra ID OIDC authentication

Previous Retrieving SBOMs for MSR Images Next Setup for MSR with Entra ID OIDC authentication

Copyright © 2026 Mirantis Inc. - All rights reserved

Made with Material for MkDocs