Rakuten Cloud-Native Storage Documentation

Contents:

• 1. Rakuten Cloud-Native Storage Overview
  • 1.1. Compatibility
  • 1.2. How to read this documentation?
• 2. Installing Robin Cloud Native Storage (CNS)
  • 2.1. Prerequisites
  • 2.2. Install options
  • 2.3. Pre-install Checks
  • 2.4. Install on Google Anthos
  • 2.5. Install on Google GKE
  • 2.6. Install Robin CNS with Google KMS
  • 2.7. Install on an air-gapped Cluster
  • 2.8. Install with local PersistentVolume using Robin Installer
  • 2.9. Verify Installation
  • 2.10. ROBIN License Activation
  • 2.11. Data Integrity
  • 2.12. Uninstalling ROBIN
• 3. Setting Up Your Robin Cluster
  • 3.1. Robin client
  • 3.2. Robin license activation
  • 3.3. Robin Evaluation License for 90 days
  • 3.4. Disk Management
  • 3.5. User Management
  • 3.6. Importing Namespaces
  • 3.7. Disabling Telemetry
  • 3.8. Declarative way to Configure CNS Parameters
• 4. Using Robin CNS in Kubernetes
  • 4.1. Using Robin CNS Storage Class to Provision Storage
  • 4.2. Protecting PVCs using Robin’s Volume Replication
  • 4.3. Making Robin the default StorageClass
  • 4.4. ReadWriteMany (RWX) Volumes
  • 4.5. Robin StorageClass with GID and UID to Run Non-Root App Pods
  • 4.6. Snapshot Volumes
  • 4.7. Volume Clones
  • 4.8. Expand Volumes
  • 4.9. Backup and Import Volumes using Kubernetes specification
• 5. Managing Nodes
  • 5.1. Resource Discovery
  • 5.2. Robin Node Roles
  • 5.3. Gathering information on nodes
  • 5.4. Disabling a node
  • 5.5. Removing Nodes
  • 5.6. Monitor cluster health using RobinCluster CR
  • 5.7. Managing a cluster via the remote client
• 6. Managing Storage
  • 6.1. Provisioning a disk
  • 6.2. Attaching a disk
  • 6.3. Detaching a disk
  • 6.4. Listing all disks
  • 6.5. Show information about a specific disk
  • 6.6. Evacuating volumes from a disk
  • 6.7. Unregistering a disk
  • 6.8. Removing a disk
  • 6.9. Updating disk properties
  • 6.10. Unfaulting a disk
  • 6.11. Auto Disk Rebalance
  • 6.12. Managing Volumes
  • 6.13. Data Locality Tracking for Volumes
  • 6.14. Managing Volume Snapshots
  • 6.15. Managing Volume Backups
  • 6.16. Encrypted volume backup and recovery
  • 6.17. Auto Volume Cleanup
  • 6.18. Thin Provisioning
  • 6.19. Monitoring Robin via Prometheus
  • 6.20. Handling Disruptions
  • 6.21. Hardware RAID Controllers
• 7. User Management
  • 7.1. Kubernetes user management
  • 7.2. Robin user management
  • 7.3. LDAP user authentication
  • 7.4. OpenShift user authentication
  • 7.5. User capabilities operations
  • 7.6. Object sharing operations
  • 7.7. User management operations
  • 7.8. LDAP management operations
  • 7.9. Ephemeral users
• 8. Tenant Management
  • 8.1. Add a tenant
  • 8.2. Remove a tenant
  • 8.3. List tenants
  • 8.4. Rename a tenant
  • 8.5. Update tenant description
  • 8.6. Add Users to a Tenant
  • 8.7. Remove One or More Users from a Tenant
  • 8.8. Add user capabilities
  • 8.9. Update user capabilities
  • 8.10. Remove user capabilities
  • 8.11. Update tenant limits
• 9. Namespace Management
  • 9.1. Kubernetes Namespaces
  • 9.2. Robin Managed Namespaces
  • 9.3. Namespace Operations
• 10. Managing Stateful Applications
  • 10.1. Application life cycle management
  • 10.2. Robin Applications
  • 10.3. Helm Releases
  • 10.4. Robin FlexApp Applications
  • 10.5. Create an Application
  • 10.6. Register a Stateful Application
  • 10.7. Unregister a Stateful Application
  • 10.8. Delete an Application
  • 10.9. List all Applications
  • 10.10. Show information about a specific Application
  • 10.11. Application Sharing and the Reasignment of Application Ownership
  • 10.12. Attach an External Storage Repo to an Application
  • 10.13. Detach an External Storage Repo from an Application
  • 10.14. Manage Application Snapshot Schedules
  • 10.15. Manage Application Backup Schedules
  • 10.16. Restore an Application from a Snapshot or Backup
  • 10.17. Configure Snapshot Space Limits for an Application volume
  • 10.18. Register KubeVirt VMs as Applications and Manage
• 11. Managing Snapshots
  • 11.1. Create an Application Snapshot
  • 11.2. Configuring snapshot schedules and retention policies
  • 11.3. Delete a Snapshot
  • 11.4. Restore a Snapshot from a Backup
  • 11.5. List all Snapshots
  • 11.6. Show Information About a Specific Snapshot
• 12. Managing External Repositories
  • 12.1. Register a repo
  • 12.2. Unregister a repo
  • 12.3. List repos
  • 12.4. Get information about a specific repo
  • 12.5. List the contents of a repo (Browse Backup Catalog)
  • 12.6. Purge (delete) a backup from a repo
  • 12.7. Monitor the status of a repo
  • 12.8. Share a repo with tenants
  • 12.9. Stop sharing a repo with tenants
  • 12.10. Share a repo with users
  • 12.11. Stop sharing a repo with users
  • 12.12. List shares of a repo with tenants and users
• 13. Backup and Restore Applications and Volumes
  • 13.1. Create an application backup
  • 13.2. Delete a backup
  • 13.3. List backups
  • 13.4. Get information about a specific backup
  • 13.5. Configuring backup schedules and retention policies
  • 13.6. Monitor status of a backup
  • 13.7. Share a backup with tenants
  • 13.8. Stop sharing a backup with tenants
  • 13.9. Share a backup with users
  • 13.10. Stop sharing a backup with users
  • 13.11. List shares of backups with tenants and users
  • 13.12. Export a backup
  • 13.13. Import a backup
  • 13.14. View backup key from backup with encrypted volumes
  • 13.15. Export backup key from backup with encrypted volumes
  • 13.16. Import backup key from backup with encrypted volumes
  • 13.17. Configuring internal repo for Backup
• 14. Alerts and Events
  • 14.1. Events
  • 14.2. Alerts
  • 14.3. Notification of events
  • 14.4. Exposing alerts and events for external log monitoring tools
• 15. High Availability
  • 15.1. High Availability of the Robin control plane
  • 15.2. Robin Patroni Monitor
  • 15.3. Robin Manager
• 16. Command Line Interface Cheatsheet
  • 16.1. Application Specific Commands
  • 16.2. Infrastructure Specific Commands
• 17. Troubleshooting
  • 17.1. Listing all jobs
  • 17.2. Show information about a specific job
  • 17.3. Log Collection
  • 17.4. Retrieving Job Logs
  • 17.5. Tool for checking data integrity on PVCs
  • 17.6. Correcting the read-only database connection issue
• 18. Sherlock - Troubleshooting Tool
  • 18.1. Sherlock Use Cases
  • 18.2. Details you can View Using Sherlock
  • 18.3. Sherlock Report
  • 18.4. Access Sherlock
  • 18.5. View Health of All objects
  • 18.6. View Sherlock Command Options
  • 18.7. Access Sherlock On Web Server
  • 18.8. Check Application Health
  • 18.9. Check Node Health
  • 18.10. Check Pod Health
  • 18.11. Check Volume Health
  • 18.12. Check Devices Health
  • 18.13. Check Devices Nearing Maximum Capacity
  • 18.14. Find Devices With Rebalance Need
• 19. Upgrading Robin Cloud Native Storage
  • 19.1. Migration Webhook Deployment for API conversion
  • 19.2. Pre Robin Upgrade Checklist
  • 19.3. Upgrade using Robin installer
  • 19.4. Manual Upgrade Steps
• 20. Release Notes
  • 20.1. Robin Cloud Native Storage v6.1.1