Robin Platform Documentation

Contents:

• 1. Robin Platform Overview
  • 1.1. Summary of Robin Capabilities and Differentiation
  • 1.2. How to read this documentation?
• 2. Installing Robin Platform
  • 2.1. Minimum physical requirements
  • 2.2. General configuration requirements
  • 2.3. Installation files
  • 2.4. Installing Robin on-premises
  • 2.5. Uninstalling Robin on-premises
  • 2.6. Installing Robin on AWS EC2
  • 2.7. Uninstalling Robin on AWS
  • 2.8. Installing Robin on GCP
  • 2.9. Uninstalling Robin on GCP
  • 2.10. Load Balancer Support via MetalLB
  • 2.11. Robin Calico Typha Configuration
  • 2.12. High availability of Robin services
• 3. Setting Up Your Robin Cluster
  • 3.1. Robin license activation
  • 3.2. Resource pool assignment
  • 3.3. Role assignment
  • 3.4. IP-Pool addition
  • 3.5. File collection addition
  • 3.6. Enabling metrics
  • 3.7. Robin client
  • 3.8. Robin Auth Utility
  • 3.9. Kubernetes client
  • 3.10. Helm client
  • 3.11. Helm 2 client
• 4. Managing Nodes
  • 4.1. Resource Discovery
  • 4.2. Robin Node Roles
  • 4.3. Managing Resource Pools
  • 4.4. Managing File Collections
  • 4.5. Gathering information on nodes
  • 4.6. Updating node attributes
  • 4.7. Tagging a node
  • 4.8. Disabling a node
  • 4.9. Decommissioning a node
  • 4.10. Managing a cluster via the remote client
  • 4.11. Managing Unused Images
• 5. Managing Storage
  • 5.1. Attaching a disk
  • 5.2. Detaching a disk
  • 5.3. Provisioning a disk
  • 5.4. Listing all disks
  • 5.5. Show information about a specific disk
  • 5.6. Evacuating volumes from a disk
  • 5.7. Unregistering a disk
  • 5.8. Deleting a disk
  • 5.9. Updating disk properties
  • 5.10. Unfaulting a disk
  • 5.11. Managing Volumes
  • 5.12. Handling Disruptions
  • 5.13. Hardware RAID Controllers
• 6. Managing Networking
  • 6.1. IP-Pool Management
  • 6.2. VLAN Support
  • 6.3. Advanced Compute and Networking Support
• 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
• 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 resource pools to a tenant
  • 8.7. Remove resource pools from a tenant
  • 8.8. Add IP-Pools to a tenant
  • 8.9. Remove IP-Pools from a tenant
  • 8.10. Add Users to a Tenant
  • 8.11. Remove One or More Users from a Tenant
  • 8.12. Add user capabilities
  • 8.13. Update user capabilities
  • 8.14. Remove user capabilities
  • 8.15. Update tenant limits
  • 8.16. Update resource pool 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. Robin Application Bundles
  • 10.4. Helm Releases
  • 10.5. Robin FlexApp Applications
  • 10.6. Create an Application
  • 10.7. Register a Stateful Application
  • 10.8. Unregister a Stateful Application
  • 10.9. Delete an Application
  • 10.10. List all Applications
  • 10.11. Show information about a specific Application
  • 10.12. Stop a Robin Application
  • 10.13. Start a Robin Application
  • 10.14. Restart a Robin Application
  • 10.15. Application Sharing and the Reasignment of Application Ownership
  • 10.16. Scaling services for a Robin Application
  • 10.17. Scaling resources for a Robin Application
  • 10.18. Storage QoS for a Robin Application
  • 10.19. Upgrading a Robin Application
  • 10.20. Attach an External Storage Repo to an Application
  • 10.21. Detach an External Storage Repo from an Application
  • 10.22. Manage Application Snapshot Schedules
  • 10.23. Manage Application Backup Schedules
  • 10.24. Restore an Application from a Snapshot or Backup
  • 10.25. Configure Snapshot Space Limits for an Application
  • 10.26. Adding a volume for a service within an application
  • 10.27. Managing Application Vnodes
  • 10.28. High Availability of Applications
  • 10.29. Advanced Application Features
• 11. Managing Application Snapshots
  • 11.1. Create an Application Snapshot
  • 11.2. Configuring snapshot schedules and retention policies
  • 11.3. Delete an Application Snapshot
  • 11.4. Restore an Application Snapshot from a Backup
  • 11.5. List Application 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
  • 13.1. Create an application backup
  • 13.2. Delete an application backup
  • 13.3. List application backups
  • 13.4. Get information about a specific application backup
  • 13.5. Configuring backup schedules and retention policies
  • 13.6. Monitor Status of an application backup
  • 13.7. Share an application backup with tenants
  • 13.8. Stop sharing an application backup with tenants
  • 13.9. Share an application backup with users
  • 13.10. Stop sharing an application backup with users
  • 13.11. List shares of an application backup with tenants and users
  • 13.12. Export an application backup
  • 13.13. Import an application backup
• 14. Alerts and Events
  • 14.1. Events
  • 14.2. Alerts
  • 14.3. Notification of events
• 15. Chargeback
  • 15.1. Viewing and editing Chargeback pricing scheme
  • 15.2. Generating Chargeback report
  • 15.3. List all tracked resources
  • 15.4. Show information about a specific resource
• 16. High Availability
  • 16.1. High availability of the Kubernetes control plane
  • 16.2. High Availability of the Robin control plane
• 17. Integration with Kubernetes
  • 17.1. Topology and CPU Manager
  • 17.2. CNI plugins
• 18. Virtual Machines Support On Robin CNP
  • 18.1. Points to Consider for using KVM on Robin
  • 18.2. High-Level Steps to Create and Manage VMs
  • 18.3. Prerequisites
  • 18.4. Register a VM Image
  • 18.5. Create a KVM Robin Bundle
  • 18.6. Create a Virtual Machine
  • 18.7. Access a Virtual Machine
  • 18.8. Lifecycle Management of a Virtual Machine
• 19. Command Line Interface Cheatsheet
  • 19.1. Application Specific Commands
  • 19.2. Infrastructure Specific Commands
• 20. Troubleshooting
  • 20.1. Listing all jobs
  • 20.2. Show information about a specific job
  • 20.3. Archive Robin Job Logs
  • 20.4. Purge Robin Job logs
  • 20.5. Clean stale Robin job log directory
  • 20.6. Log Collection
  • 20.7. Retrieving Job Logs
  • 20.8. Cluster Auditing
• 21. Upgrading Robin Platform
  • 21.1. Robin Upgrade Path Matrix
  • 21.2. Pre Robin Upgrade Checklist
  • 21.3. Manual upgrade via the Robin installer
  • 21.4. Automated Upgrade via GoROBIN
  • 21.5. Post Upgrade Cluster Audit
  • 21.6. Upgraded Component Versions
• 22. Release Notes
  • 22.1. Robin CNP v5.3.5
  • 22.2. Robin CNP v5.3.5 HF1
  • 22.3. Robin CNP v5.3.5 HF2
  • 22.4. Robin CNP v5.3.5 HF3
  • 22.5. Robin CNP v5.3.5 HF4
  • 22.6. Robin CNP v5.3.5 HF5