Trident

Storage Orchestrator for Containers

Introduction

• What is Trident?

Kubernetes

• Trident for Kubernetes
  • Upgrading Trident
    • Initiate the upgrade
      • Upgrading Trident on Kubernetes 1.13
      • Upgrading Trident on Kubernetes 1.14 and above
    • What happens when you upgrade
    • Next steps
    • Upgrading legacy volumes to CSI volumes
      • Things to consider when upgrading volumes
      • Example volume upgrade
  • Deploying
    • Before you begin
    • 1: Qualify your Kubernetes cluster
    • 2: Download & extract the installer
    • 3: Install Trident
      • Installing Trident on Kubernetes 1.13
      • Installing Trident on Kubernetes 1.14 and above
      • Customized Installation
    • 4: Create and Verify your first backend
    • 5: Add your first storage class
    • 6: Provision your first volume
    • 7: Mount the volume in a pod
  • Common tasks
    • Managing Trident
      • Installing Trident
      • Upgrading Trident
      • Uninstalling Trident
      • Downgrading Trident
    • Worker preparation
      • NFS
      • iSCSI
    • Backend configuration
      • Azure NetApp Files
        • Preparation
        • Backend configuration options
        • Example configurations
      • Cloud Volumes Service for AWS
        • Preparation
        • Backend configuration options
        • Example configurations
      • Cloud Volumes Service for GCP
        • Preparation
        • Backend configuration options
        • Example configurations
      • Element (HCI/SolidFire)
        • Preparation
        • Backend configuration options
        • Example configuration
        • Using access groups
      • ONTAP (AFF/FAS/Select/Cloud)
        • Choosing a driver
        • Preparation
          • ontap-nas, ontap-nas-economy, ontap-nas-flexgroups
          • ontap-san, ontap-san-economy
        • Backend configuration options
        • Example configuration
        • User permissions
      • SANtricity (E-Series)
        • Preparation
        • Backend configuration options
        • Example configuration
    • Managing backends
      • Creating a backend configuration
      • Creating a backend
      • Deleting a backend
      • Viewing the existing backends
      • Identifying the storage classes that will use a backend
      • Updating a backend
    • Managing storage classes
      • Designing a storage class
      • Creating a storage class
      • Deleting a storage class
      • Viewing the existing storage classes
      • Setting a default storage class
      • Identifying the Trident backends that a storage class will use
    • Managing volumes
      • On-Demand Volume Snapshots
      • Expanding an iSCSI volume
      • Expanding an NFS volume
      • Importing a volume
        • Behavior of Drivers for Volume Import
  • Concepts
    • Kubernetes and Trident objects
      • Object overview
      • Kubernetes PersistentVolumeClaim objects
      • Kubernetes PersistentVolume objects
      • Kubernetes StorageClass objects
      • Kubernetes CustomResourceDefinition objects
      • Trident StorageClass objects
      • Trident Backend objects
      • Trident StoragePool objects
      • Trident Volume objects
    • How does provisioning work?
    • Virtual Storage Pools
  • Known issues
  • Troubleshooting
• Design and Architecture Guide
  • 1. Introduction
    • 1.1. Target Audience
  • 2. Concepts and Definitions
    • 2.1. Kubernetes storage concepts
      • 2.1.1. Persistent Volume Claim
      • 2.1.2. Persistent Volume
      • 2.1.3. Storage Class
    • 2.2. Kubernetes compute concepts
      • 2.2.1. Pods
      • 2.2.2. Services
      • 2.2.3. Deployments
      • 2.2.4. StatefulSets
    • 2.3. Connecting containers to storage
    • 2.4. Destroying and creating pods
    • 2.5. Container Storage Interface
  • 3. NetApp Products and Integrations with Kubernetes
    • 3.1. Trident
    • 3.2. ONTAP
      • 3.2.1. Cloud Volumes ONTAP
    • 3.3. Element OS
      • 3.3.1. NetApp HCI
    • 3.4. SANtricity
    • 3.5. Azure NetApp Files
    • 3.6. Cloud Volumes Service for AWS
    • 3.7. Cloud Volumes Service for GCP
  • 4. Kubernetes Cluster Architecture and Considerations
    • 4.1. Cluster concepts and components
    • 4.2. Cluster architectures
      • 4.2.1. Single master, compute
      • 4.2.2. Multiple master, compute
      • 4.2.3. Master, etcd, compute
      • 4.2.4. Red Hat OpenShift infrastructure architecture
    • 4.3. Choosing an architecture
  • 5. Storage for Kubernetes Infrastructure Services
    • 5.1. Persistent storage for cluster services
      • 5.1.1. etcd considerations
      • 5.1.2. logging considerations
      • 5.1.3. metrics considerations
      • 5.1.4. registry considerations
    • 5.2. Design choices and guidelines when using ONTAP
      • 5.2.1. Storage Virtual Machines
      • 5.2.2. Kubernetes cluster services
  • 6. Storage Configuration for Trident
    • 6.1. Best practices for configuring ONTAP and Cloud Volumes ONTAP
      • 6.1.1. Use SVM(s) which are dedicated to Trident
      • 6.1.2. Limit the maximum volume count
      • 6.1.3. Limit the maximum size of volumes created by Trident
      • 6.1.4. Create and use an SVM QoS policy
      • 6.1.5. Limit storage resource access to Kubernetes cluster members
      • 6.1.6. Create an export policy
      • 6.1.7. Disable showmount for the application SVM
    • 6.2. Best practices for configuring SolidFire
    • 6.3. Best practices for configuring E-Series
    • 6.4. Best practices for configuring Cloud Volumes Service on AWS
  • 7. Deploying Trident
    • 7.1. Supported Kubernetes cluster architectures
    • 7.2. Trident installation modes
    • 7.3. Trident Installation on Docker UCP 3.1
    • 7.4. Using Trident with the NetApp Kubernetes Service
    • 7.5. Deploying Trident as an enhanced CSI Provisioner
    • 7.6. CRDs for maintaining Trident’s state
      • 7.6.1. Things to keep in mind about Trident’s CRDs
    • 7.7. Trident Upgrade/Downgrade Process
      • 7.7.1. Upgrading Trident
      • 7.7.2. Downgrading Trident
    • 7.8. Recommendations for all deployments
      • 7.8.1. Deploy Trident to a dedicated namespace
      • 7.8.2. Use quotas and range limits to control storage consumption
    • 7.9. Deploying Trident to OpenShift
      • 7.9.1. Deploy Trident to infrastructure nodes
  • 8. Integrating Trident
    • 8.1. Trident backend design
      • 8.1.1. ONTAP
      • 8.1.2. Element (HCI/SolidFire)
      • 8.1.3. SANtricity (E-Series)
      • 8.1.4. Azure NetApp Files Backend Driver
      • 8.1.5. Cloud Volumes Service with AWS Backend Driver
      • 8.1.6. Cloud Volumes Service with GCP Backend Driver
    • 8.2. Storage Class design
      • 8.2.1. Storage Class design for specific backend utilization
      • 8.2.2. Storage Class design to emulate QoS policies
      • 8.2.3. Storage Class Design To utilize backend based on specific features
      • 8.2.4. Storage Class Design for Virtual Storage Pools
    • 8.3. Virtual Storage Pool Design
      • 8.3.1. Design Virtual Storage Pools for emulating different Service Levels/QoS
      • 8.3.2. Design Virtual Pools for Assigning Specifc Set of Aspects
    • 8.4. PVC characteristics which affect storage provisioning
      • 8.4.1. Access mode
    • 8.5. Volume Operations
      • 8.5.1. Modifying persistent volumes
      • 8.5.2. Volume Move Operations
      • 8.5.3. Expanding volumes
      • 8.5.4. Import an existing volume into Kubernetes
    • 8.6. Deploying OpenShift services using Trident
      • 8.6.1. Registry service
      • 8.6.2. Logging service
      • 8.6.3. Metrics service
  • 9. Backup and Disaster Recovery
    • 9.1. Backing Up Kubernetes and Trident’s state
      • 9.1.1. etcdctl snapshot backup
      • 9.1.2. etcdctl snapshot restore
    • 9.2. ONTAP Snapshots
      • 9.2.1. Using ONTAP snapshots with containers
      • 9.2.2. Accessing the snapshot directory
      • 9.2.3. Restoring the snapshots
    • 9.3. Data replication using ONTAP
      • 9.3.1. ONTAP SnapMirror SVM Replication
        • 9.3.1.1. ONTAP SnapMirror SVM Replication Setup
        • 9.3.1.2. SnapMirror SVM Disaster Recovery Workflow for Trident
      • 9.3.2. ONTAP SnapMirror Volume Replication
        • 9.3.2.1. ONTAP SnapMirror Volume Replication Setup
        • 9.3.2.2. SnapMirror Volume Disaster Recovery Workflow for Trident
    • 9.4. ElementOS snapshots
  • 10. Security Recommendations
    • 10.1. Run Trident in its own namespace
    • 10.2. CHAP authentication
  • 11. Frequently Asked Questions
    • 11.1. Trident for Kubernetes Installation
      • 11.1.1. What are the supported versions of etcd?
      • 11.1.2. Does Trident support an offline install from a private registry?
      • 11.1.3. Can Trident be installed remotely?
      • 11.1.4. Can we configure High Availability with Trident?
      • 11.1.5. Does Trident need access to kube-system namespace?
      • 11.1.6. What are the roles and privileges used by Trident?
      • 11.1.7. Can we locally generate the exact manifest files Trident uses to install?
      • 11.1.8. Can we share the same ONTAP backend SVM for two separate Trident instances for two separate Kubernetes clusters?
      • 11.1.9. Is it possible to install Trident under ContainerLinux (formerly CoreOS)?
      • 11.1.10. Can we use Trident with NetApp Cloud Volumes ONTAP?
      • 11.1.11. Does Trident work with Cloud Volumes Services?
      • 11.1.12. What versions of Kubernetes support Trident as an enhanced CSI Provisioner?
      • 11.1.13. Why should I install Trident to work as a CSI Provisioner?
      • 11.1.14. How do I install Trident to work as a CSI Provisioner?
      • 11.1.15. How does Trident maintain state if it doesn’t use etcd?
      • 11.1.16. How do I uninstall Trident?
    • 11.2. Trident Backend Configuration and Use
      • 11.2.1. Do we need to define both Management and Data LIFs in an ONTAP backend definition file?
      • 11.2.2. Can we specify a port in the DataLIF?
      • 11.2.3. Is it possible to update the Management LIF on the backend ?
      • 11.2.4. Is it possible to update the Data LIF on the backend ?
      • 11.2.5. Can we create multiple backends in Trident for Kubernetes?
      • 11.2.6. How does Trident store backend credentials?
      • 11.2.7. How does Trident select a specific backend?
      • 11.2.8. Can we make sure Trident will not provision from a specific backend?
      • 11.2.9. If there are multiple backends of the same kind, how does Trident select which backend to use?
      • 11.2.10. Does Trident support bi-directional CHAP with Element/SolidFire?
      • 11.2.11. How does Trident deploy Qtrees on an ONTAP volume? How many Qtrees can be deployed on a single volume through Trident?
      • 11.2.12. How can we set Unix permissions for volumes provisioned on ONTAP NAS?
      • 11.2.13. How can we configure an explicit set of ONTAP NFS mount options while provisioning a volume?
      • 11.2.14. How do I set the provisioned volumes to a specific export policy?
      • 11.2.15. How do I set volume encryption through Trident with ONTAP?
      • 11.2.16. What is the best way to implement QoS for ONTAP through Trident?
      • 11.2.17. How do we specify thin or thick provisioning through Trident?
      • 11.2.18. How do I make sure that the volumes being used are not deleted even if I accidentally delete the PVC?
      • 11.2.19. Can we use PVC resize functionality with NFS, Trident, and ONTAP?
      • 11.2.20. If I have a volume that was created outside Trident can I import it into Trident?
      • 11.2.21. Can I import a volume while it is in Snapmirror Data Protection (DP) or offline mode?
      • 11.2.22. Can we use PVC resize functionality with iSCSI, Trident, and ONTAP?
      • 11.2.23. How is resource quota translated to a NetApp cluster?
      • 11.2.24. Can you create Volume Snapshots using Trident?
      • 11.2.25. How do we take a snapshot backup of a volume provisioned by Trident with ONTAP?
      • 11.2.26. Can we set a snapshot reserve percentage for a volume provisioned through Trident?
      • 11.2.27. Can we directly access the volume snapshot directory and copy files?
      • 11.2.28. Can we set up SnapMirror for Trident volumes through Trident?
      • 11.2.29. How do I restore Persistent Volumes to a specific ONTAP snapshot?
      • 11.2.30. How can I obtain complete Trident configuration details?
      • 11.2.31. How can we separate out storage class usage for each customer/tenant?
      • 11.2.32. Does Trident provide insight into the capacity of the storage?
      • 11.2.33. Does the user experience change when using Trident as a CSI Provisioner?
      • 11.2.34. How do I design a Disaster Workflow for Trident v19.10?
    • 11.3. Trident Upgrade, Support, Licensing, and Troubleshooting
      • 11.3.1. How frequently is Trident released?
      • 11.3.2. Does NetApp support Trident?
      • 11.3.3. How do I raise a support case for Trident?
      • 11.3.4. How do I generate a support log bundle using Trident?
      • 11.3.5. Does Trident support all the features that are released in a particular version of Kubernetes?
      • 11.3.6. What do I do if I need to raise a request for a new feature on Trident?
      • 11.3.7. Where do I raise a defect for Trident?
      • 11.3.8. What happens if I have quick question on Trident that I need clarification on? Is there a community or a forum for Trident?
      • 11.3.9. Does Trident have any dependencies on other NetApp products for its functioning?
      • 11.3.10. Can I upgrade from a older version of Trident directly to a newer version (skipping a few versions)?
      • 11.3.11. How can I upgrade to the most recent version of Trident?
      • 11.3.12. Is it possible to downgrade Trident to a previous release?
      • 11.3.13. If the Trident pod is destroyed, will we lose the data?
      • 11.3.14. My storage system’s password has changed and Trident no longer works, how do I recover?

Docker

• Trident for Docker
  • Deploying
  • Host and storage configuration
    • Host Configuration
      • NFS
      • iSCSI
      • Traditional Install Method (Docker <= 1.12)
        • Starting Trident at System Startup
      • Docker Managed Plugin Method (Docker >= 1.13 / 17.03)
    • Global Configuration
    • ONTAP Configuration
      • User Permissions
      • Configuration File Options
      • Scaling Options
      • Example ONTAP Config Files
    • Element OS/SolidFire Configuration
      • Example Solidfire Config File
    • E-Series Configuration
      • Example E-Series Config File
      • E-Series Array Setup Notes
    • Cloud Volumes Service (CVS) on AWS Configuration
      • Example CVS on AWS Config File
    • Cloud Volumes Service (CVS) on GCP Configuration
      • Example CVS on GCP Config File
    • Azure NetApp Files Configuration
      • Preparation
      • Backend configuration options
      • Example Configurations
    • Multiple Instances of Trident
  • Common tasks
    • Managing Trident
      • Installing Trident
      • Updating Trident
      • Uninstalling Trident
    • Managing volumes
      • Create a Volume
      • Volume Driver CLI Options
        • ONTAP Volume Options
        • Element OS/SolidFire Volume Options
          • Other SolidFire Create Options
        • E-Series Volume Options
          • Media Type
          • File System Type
        • Cloud Volumes Service (CVS) on AWS Volume Options
        • Cloud Volumes Service (CVS) on GCP Volume Options
      • Destroy a Volume
      • Volume Cloning
      • Access Externally Created Volumes
  • Known issues
  • Troubleshooting
    • Managed plugin method
    • Binary method

Support

• Requirements
  • Supported frontends (orchestrators)
  • Supported backends (storage)
  • Feature Gates
  • Supported host operating systems
  • Host configuration
  • Storage system configuration
• Getting help

Reference

• trident
  • Logging
  • Kubernetes
  • Docker
  • REST
• tridentctl
  • create
  • delete
  • get
  • import volume
  • install
  • logs
  • uninstall
  • update
  • upgrade
  • version
• REST API
• Simple Kubernetes install