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 CNP Using GoRobin
  • 2.1. Supported Operating Systems
  • 2.2. Prerequisites
  • 2.3. Host Login JSON File
  • 2.4. Config JSON File
  • 2.5. Installing Robin CNP in an On-Premises Setup
  • 2.6. Installing Robin CNP in non-HA Mode
  • 2.7. Post Installation Steps
  • 2.8. Uninstalling Robin CNP
  • 2.9. VLAN-based installation
  • 2.10. Custom root CA certificate and key
  • 2.11. Best-Effort Quality of Service for isolated CPU setups
  • 2.12. Load Balancer Support via MetalLB
  • 2.13. High availability of Robin services
  • 2.14. Data Integrity
• 3. Setting Up Your Robin Cluster
  • 3.1. Robin license activation
  • 3.2. License management
  • 3.3. Resource pool assignment
  • 3.4. Role assignment
  • 3.5. IP-Pool addition
  • 3.6. File collection addition
  • 3.7. Enabling metrics
  • 3.8. Robin client
  • 3.9. Robin Auth Utility
  • 3.10. Kubernetes client
  • 3.11. Helm client
  • 3.12. 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. Tagging a node
  • 4.7. Disabling a node
  • 4.8. Remove a Worker or Master node
  • 4.9. Add or replace a Worker or Master Node
  • 4.10. Decommissioning a node
  • 4.11. Managing a cluster via the remote client
  • 4.12. 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. Managing Volume Snapshots
  • 5.13. Managing Volume Backups
  • 5.14. ReadWriteMany (RWX) Volumes
  • 5.15. Managing Application Ephemeral Volumes
  • 5.16. Auto Disk Rebalance
  • 5.17. Thin Provisioning
  • 5.18. Storage Metrics
  • 5.19. Handling Disruptions
  • 5.20. Hardware RAID Controllers
• 6. Managing Persistent Data Volumes
  • 6.1. Types of Persistent Data Volumes
  • 6.2. Considerations for Using Persistent Data Volumes
  • 6.3. Add a Persistent Data Volume
  • 6.4. List Persistent Data Volumes
  • 6.5. Resize a Persistent Data Volume
  • 6.6. Persistent Data Volume Share Options
  • 6.7. Share a Persistent Data Volume
  • 6.8. List Shared Persistent Data Volume Shares
  • 6.9. Unshare a Persistent Data Volume
  • 6.10. Change Ownership of a Shared Persistent Data Volume
  • 6.11. Delete a Persistent Data Volume
• 7. Managing Networking
  • 7.1. IP-Pool Management
  • 7.2. VLAN Support
  • 7.3. MACVLAN Support
  • 7.4. Managing PCI Resource Aliases
  • 7.5. Advanced Compute and Networking Support
  • 7.6. Network Policy Support
• 8. User Management
  • 8.1. Kubernetes user management
  • 8.2. Robin user management
  • 8.3. LDAP user authentication
  • 8.4. OpenShift user authentication
  • 8.5. User capabilities operations
  • 8.6. Object sharing operations
  • 8.7. User management operations
  • 8.8. LDAP management operations
• 9. Tenant Management
  • 9.1. Add a tenant
  • 9.2. Remove a tenant
  • 9.3. List tenants
  • 9.4. Rename a tenant
  • 9.5. Update tenant description
  • 9.6. Add resource pools to a tenant
  • 9.7. Remove resource pools from a tenant
  • 9.8. Add IP-Pools to a tenant
  • 9.9. Remove IP-Pools from a tenant
  • 9.10. Add Users to a Tenant
  • 9.11. Remove One or More Users from a Tenant
  • 9.12. Add user capabilities
  • 9.13. Update user capabilities
  • 9.14. Remove user capabilities
  • 9.15. Update tenant limits
  • 9.16. Update resource pool limits
• 10. Namespace Management
  • 10.1. Kubernetes Namespaces
  • 10.2. Robin Managed Namespaces
  • 10.3. Namespace Operations
• 11. Managing Stateful Applications
  • 11.1. Application life cycle management
  • 11.2. Robin Applications
  • 11.3. Limits on Non-bundle Applications for Tenants and Users
  • 11.4. Robin Application Bundles
  • 11.5. Helm Releases
  • 11.6. Robin FlexApp Applications
  • 11.7. Create an Application
  • 11.8. Register a Stateful Application
  • 11.9. Unregister a Stateful Application
  • 11.10. Delete an Application
  • 11.11. List all Applications
  • 11.12. Show information about a specific Application
  • 11.13. Stop a Robin Application
  • 11.14. Start a Robin Application
  • 11.15. Restart a Robin Application
  • 11.16. Application Sharing and the Reasignment of Application Ownership
  • 11.17. Scaling services for a Robin Application
  • 11.18. Scaling resources for a Robin Application
  • 11.19. Storage QoS for a Robin Application
  • 11.20. Upgrading a Robin Application
  • 11.21. Attach an External Storage Repo to an Application
  • 11.22. Detach an External Storage Repo from an Application
  • 11.23. Manage Application Snapshot Schedules
  • 11.24. Manage Application Backup Schedules
  • 11.25. Restore an Application from a Snapshot or Backup
  • 11.26. Configure Snapshot Space Limits for an Application
  • 11.27. Adding a volume for a service within an application
  • 11.28. Expanding a volume associated wih a service within an application
  • 11.29. Managing Application Vnodes
  • 11.30. High Availability of Applications
  • 11.31. Advanced Application Features
  • 11.32. Application Highlight: Virtual Machine Support
• 12. Managing Application Snapshots
  • 12.1. Create an Application Snapshot
  • 12.2. Configuring snapshot schedules and retention policies
  • 12.3. Delete an Application Snapshot
  • 12.4. Restore an Application Snapshot from a Backup
  • 12.5. List Application Snapshots
  • 12.6. Show Information About a Specific Snapshot
  • 12.7. Add labels to an Application Snapshot
  • 12.8. Remove labels from an Application Snapshot
• 13. Managing External Repositories
  • 13.1. Register a repo
  • 13.2. Unregister a repo
  • 13.3. List repos
  • 13.4. Get information about a specific repo
  • 13.5. List the contents of a repo (Browse Backup Catalog)
  • 13.6. Purge (delete) a backup from a repo
  • 13.7. Monitor the status of a repo
  • 13.8. Share a repo with tenants
  • 13.9. Stop sharing a repo with tenants
  • 13.10. Share a repo with users
  • 13.11. Stop sharing a repo with users
  • 13.12. List shares of a repo with tenants and users
• 14. Backup and Restore Applications
  • 14.1. Create an application backup
  • 14.2. Delete an application backup
  • 14.3. List application backups
  • 14.4. Get information about a specific application backup
  • 14.5. Configuring backup schedules and retention policies
  • 14.6. Monitor Status of an application backup
  • 14.7. Share an application backup with tenants
  • 14.8. Stop sharing an application backup with tenants
  • 14.9. Share an application backup with users
  • 14.10. Stop sharing an application backup with users
  • 14.11. List shares of an application backup with tenants and users
  • 14.12. Export an application backup
  • 14.13. Import an application backup
• 15. Alerts and Events
  • 15.1. Events
  • 15.2. Alerts
  • 15.3. Notification of events
• 16. Chargeback
  • 16.1. Points to be considered for the non-Robin Bundle apps
  • 16.2. Viewing and editing Chargeback pricing scheme
  • 16.3. Generating Chargeback report
  • 16.4. List all tracked resources
  • 16.5. Show information about a specific resource
• 17. Asynchronous Disaster Recovery
  • 17.1. Concepts
  • 17.2. Disaster Recovery process
  • 17.3. Managing Peer Clusters
  • 17.4. Managing Protection Groups
  • 17.5. Managing Replication Policies
  • 17.6. Asynchronous Disaster Recovery quickstart guide
• 18. High Availability
  • 18.1. High availability of the Kubernetes control plane
  • 18.2. High Availability of the Robin control plane
• 19. Integration with Kubernetes
  • 19.1. Topology and CPU Manager
  • 19.2. CNI plugins
• 20. Command Line Interface Cheatsheet
  • 20.1. Application Specific Commands
  • 20.2. Infrastructure Specific Commands
• 21. Troubleshooting Tools
  • 21.1. Listing all jobs
  • 21.2. Show information about a specific job
  • 21.3. Retrieving Job Logs
  • 21.4. Archiving Job Logs
  • 21.5. Purging Job logs
  • 21.6. Cleaning up stale Job logs
  • 21.7. Log Collection
  • 21.8. Cluster Auditing
  • 21.9. Sherlock
• 22. Managing Cluster Configuration
  • 22.1. View config attributes
  • 22.2. Update config attributes
  • 22.3. Table of Reference
• 23. Upgrade Robin CNP Platform
  • 23.1. Upgrade Using GoRobin Single command
• 24. Robin Performance Features
  • 24.1. Intel Cache Allocation Technology Support for vDU Pods
• 25. Release Notes
  • 25.1. Robin Cloud Native Platform v5.4.1