Contents Menu Expand Light mode Dark mode Auto light/dark mode
Documentation Portal
  • 4.13 (current)
  • 4.0
  • 2.9
  • 3.0 (EOL)
  • 2.8 (EOL)
Logo
Mirantis Secure Registry
  • Product Overview
  • Reference Architecture
    • Introduction to MSR
    • Components
    • System requirements
      • System requirements on Kubernetes
      • System requirements on Swarm
    • Volumes
    • Storage
    • MSR web UI
      • Rule engine
  • Installation Guide
    • System requirements
      • System requirements on Kubernetes
      • System requirements on Swarm
    • Prepare MKE for MSR Install
    • Install on Kubernetes
      • Install using the MSR Operator
        • Install online using the MSR Operator
          • Prepare your environment
          • Prerequisites
          • Install MSR
          • Check the Pods
          • Add load balancer (AWS)
        • Install offline using the MSR Operator
          • Prepare your environment
          • Set up a Docker registry
          • Prerequisites
          • Install MSR
          • Check the Pods
      • Install MSR using a Helm chart
        • Install MSR online using a Helm chart
          • Prerequisites
          • Run install command
          • Check the Pods
          • Add load balancer (AWS)
        • Install MSR offline using a Helm chart
          • Prepare your environment
          • Set up a Docker registry
          • Prerequisites
          • Run install command
          • Check the Pods
    • Install on Swarm
      • Install MSR online
      • Install MSR offline
    • Obtain the MSR license
    • Uninstall MSR
  • Operations Guide
    • Access MSR
      • Configure your Mirantis Container Runtime
      • Configure your Notary client
      • Use a cache
    • Manage access tokens
    • Configure MSR
      • Add a custom TLS certificate
      • Disable persistent cookies
      • Disable MSR telemetry
      • Configure external storage
        • Configure MSR image storage
        • Deploy MSR on NFS
        • Configure MSR for a cloud storage provider (S3)
        • Switch storage backends
      • Set up high availability
        • Install an HA MSR deployment
        • Modify replica counts on an existing installation
        • Modify replica counts for RethinkDB resources
      • Set up security scanning
        • Enable MSR security scanning
        • Set repository scanning mode
        • Update the CVE scanning database
      • Caches
        • MSR cache prerequisites
        • MSR cache deployment scenario
        • Deploy an MSR cache with Kubernetes
          • Prepare the cache deployment
          • Create Kubernetes resources
          • Expose the MSR Cache
        • Deploy an MSR cache with Swarm
          • Prepare the cache deployment
          • Deploy the cache
        • Configure caches for high availability
        • MSR cache configuration
      • Garbage collection
        • Schedule garbage collection
        • How garbage collection works
      • Create a new repository when pushing an image
      • Use a web proxy
      • Use Ingress to expose MSR service to the Internet on AWS
    • Manage applications
    • Manage images
      • Create a repository
      • Review repository information
      • Pull and push images
      • Delete images
      • Scan images for vulnerabilities
        • Security scan process
        • Scan images
        • Review security scan results
        • Override a vulnerability
        • Scanner reporting
      • Prevent tags from being overwritten
      • Sign images with Docker Content Trust
        • Configure image signing
        • Sign an image
        • Add an additional signer
        • Delete trust data
        • Delete signed images
        • Using Docker Content Trust with a Remote MKE Cluster
    • Manage jobs
    • Manage users
      • Authentication and authorization
        • Enable LDAP and sync teams and users
        • Configure SAML integration on MSR
        • SCIM integration
      • Create and manage teams
      • Create and manage organizations
      • Permission levels
    • Manage webhooks
      • Webhook types
      • Manage repository webhooks using web UI
      • Manage repository webhooks using API
        • API curl requests
        • Manage content structure using API
        • View and manage subscriptions
    • Manage repository events
      • Audit repository events
      • Enable Auto-Deletion of Repository Events
    • Promotion policies and monitoring
      • Promotion policies overview
      • Promote an image using policies
      • Mirror images to another registry
      • Mirror images from another registry
      • Template reference
    • Use Helm charts
      • Add a Helm chart repository
      • Pull charts and their provenance files
      • Push charts and their provenance files
      • View charts in a Helm repository
      • Delete charts from a Helm repository
      • Helm chart linting
        • Implement Helm linting
        • Helm chart linting rules
      • Helm limitations
    • Tag pruning
    • Image enforcement policies and monitoring
    • Upgrade MSR
      • Semantic versioning
      • Upgrade on Kubernetes
        • Upgrade on Kubernetes using the MSR Operator
        • Upgrade on Kubernetes using a Helm chart
      • Upgrade on Swarm
    • Monitor MSR
      • Collect MSR metrics with Prometheus
        • Configure Prometheus to scrape MSR metrics
        • MSR metrics exposed for Prometheus
      • Health check endpoints
      • Cluster status
      • Review the Notary audit logs
      • MSR repository size utility
    • Troubleshoot MSR
      • Troubleshoot your MSR Kubernetes deployment
      • Troubleshoot your MSR Swarm deployment
      • Access RethinkDB
      • Troubleshoot scanning or CVE updates failure
      • Vulnerability scan warnings
      • Certificate issues when pushing and pulling images
      • Configure AWS_CA_BUNDLE environment variable
      • MSR on Swarm one node to multi node scaling failure
    • Disaster recovery
      • Disaster recovery overview
      • Repair a single replica
      • Repair a cluster
      • Create an MSR backup
      • Restore from an MSR backup
    • Customer feedback
  • Migration Guide
    • MMT architecture
    • Migration prerequisites
    • Select the storage mode
    • Simplified migration
      • Swarm migration
      • Kubernetes migration
    • Multi-step migration
      • Verify the source system configuration
      • Estimate the migration
      • Extract the data
      • Transform the data extract
      • Restore the data extract
      • Kubernetes migrations
    • Settings not migrated
    • Telemetry
    • Troubleshoot migration
      • Restore MSR reusing an extract copy
      • Filesystem storage backends
      • Too many open files
      • Failure to load data error message
      • No space left on device
      • Failed to estimate migration error message
      • rethinkdb row cannot be restored
      • Admin password on MSR 3.0.x target no longer works
      • Blob image copy considerations
      • Total blob size: 0
      • Additional parameters
      • Additional volume mappings for containers
      • Failed to query for metadata size
      • flag provided but not defined: -append
      • Storage configuration is out of sync with metadata
      • The estimate command returns an image data value of 0
      • Unable to get FileInfo: /blobs
      • failed to run container: mmt-dtr-rethinkdb-backup
    • MMT release notes
      • 2.0.3
      • 2.0.2
      • 2.0.1
      • 2.0.0
      • 1.0.2
      • 1.0.1
  • Get Support
    • Mirantis Support Console
    • MSR support bundles on MKE

Reference documentation

  • API Reference
  • CLI Reference
    • mirantis/msr auth register
    • mirantis/msr auth status
    • mirantis/msr backup
    • mirantis/msr db migrate
    • mirantis/msr db scale
    • mirantis/msr db wait
    • mirantis/msr db emergency-repair
    • mirantis/msr init
    • mirantis/msr restore
    • mirantis/msr rethinkdb count
    • mirantis/msr rethinkdb list
    • mirantis/msr rethinkdb decommission

Release notes

  • Release Notes
    • 3.1.14
      • Addressed issues
      • Known issues
      • Major component versions
    • 3.1.13
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
    • 3.1.12
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
    • 3.1.11
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.10
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.9
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.8
      • Enhancements
      • Known issues
      • Major component versions
      • Security information
    • 3.1.7
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.6
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.5
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.4
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
    • 3.1.3
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.2
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.1
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.1.0
      • New features
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • Deprecation notes
  • Release Compatibility Matrix
    • MSR 3.1 Compatibility Matrix
    • MKE and MSR Browser compatibility
    • MKE, MSR, and MCR Maintenance Lifecycle
  • Release Cadence and Support Lifecycle
  • Open Source Components and Licenses
With the upcoming end-of-life (EOL) of MSR 3.1.x, Mirantis encourages you to upgrade to the latest supported version to ensure continued support and security updates.

Configure MSR¶

  • Add a custom TLS certificate
  • Disable persistent cookies
  • Disable MSR telemetry
  • Configure external storage
  • Set up high availability
  • Set up security scanning
  • Caches
  • Garbage collection
  • Create a new repository when pushing an image
  • Use a web proxy
  • Use Ingress to expose MSR service to the Internet on AWS
Next
Add a custom TLS certificate
Previous
Manage access tokens
  • Multi-page view
  • Single-page view

Mirantis Inc. 900 E Hamilton Avenue, Suite 650, Campbell, CA 95008 +1-650-963-9828

© 2005 - 2025 Mirantis, Inc. All rights reserved. "Mirantis" and "FUEL" are registered trademarks of Mirantis, Inc. All other trademarks are the property of their respective owners.