Storage options templates

To view the Storage Options (Templates), select Storage Options in the left pane.

The Storage Options (Templates) page is designed to manage and apply storage configurations to Kubernetes applications. It contains:

• Sample Templates: It contains two pre-defined storage configuration templates, which you can use as starting points for creating new storage templates.:
  • Volume replication (forced spread): Outlines a configuration set for a storage volume with specific attributes:
    • File System: The type of file system to be used with the storage volume, such as EXT4 or XFS, which dictates how data is stored, organized, and managed within the volume.
    • Provisioner: The specific storage driver responsible for dynamically provisioning storage resources in a Kubernetes environment. It determines how storage volumes are created and managed based on the requested storage class and attributes.
    • Replication Factor: The number of copies of the data that the storage system will maintain across different nodes or disks. It is a crucial parameter for ensuring data availability and resilience.
    • Volume Group: Indicates whether the volume is part of a collection of volumes managed together as a group. Volume groups can be beneficial for operations that need to be executed on multiple volumes simultaneously or for enforcing collective policies.
  • Volume replication (best-effort spread): Includes similar configurations but labeled differently, to show how the replication is spread across the cluster.
• Templates: Lists all the available storage templates that have been created. It aims to optimize performance and efficiency with centralized resource templates for Kubernetes applications.

Create a template

This topic explains how a PDS administrator can add a storage options template for users.

Prerequisites​

• PDS account Admin privileges

Procedure​

You can add a storage options template in one of the following ways:

• using a sample template
• copying an existing template
• adding your own template

Use a sample template​

To use a sample template:

1. In the Storage Options (Templates) page -> Sample Templates section, select a sample template you wish to add.
2. Click on the copy icon.
3. (Optional) In the Copy Template page -> Basic Information section, you can use the following pre-configured storage values or modify them to your needs:
   • Name: enter a unique template name.
   • File System Type: choose the XFS or Ext4 filesystem, based on the storage size required for your application.
   • Provisioner: choose one of the following Portworx provisioners:
     • Portworx in-tree: Allows PDS to create data volumes with an older, deprecated Portworx provisioner, which is built, linked, compiled, and shipped with the core Kubernetes binaries.
     • Portworx CSI: This default option allows PDS to create data volumes with a new Portworx provisioner based on Kubernetes Container Storage Interface (CSI), which is the latest storage standard. This enables you to perform all CSI-enabled operations. For more information, see Portworx with CSI and Portworx CSI driver.
     note

     Since CSI is the latest provisioner standard, Kubernetes encourages you to use CSI instead of the in-tree provisioner. Portworx CSI provisioner is used as a default provisioner for Prometheus volumes in new PDS installations.

     • Autodetect: Allows PDS to automatically assign the best Portworx provisioner (CSI or in-tree) possible. This automatic assignment by PDS depends on whether your target cluster supports CSI or not. You can modify the existing provisioner option in the Edit Storage Options Template.
   • Volume Replication Factor: From the dropdown list, select the number of nodes to replicate your data. If you select 1, then there is only one copy of a row in a cluster, and there is no way to recover the data if the node is compromised or goes down.
   • Enforce Volume Group Policy:: if you select this option, then PDS creates a volume group for your data service deployment. The volume group includes multiple physical volumes attached to the same disk adapter and other supporting hardware.
4. Review the Template Summary pane on the right side of the page, ensuring all details are correct.
5. Select the Add template button for the PDS platform to add and display the template in the Storage Options (Templates) page -> Templates section.

Copy and existing template

To add a storage options template by copying the configuration parameters of an existing template:

1. In the Templates section, find the template you want to copy, click on the vertical ellipsis button, and then select Copy from the options.
2. (Optional) In the Copy Template page -> Basic Information section, you can modify the pre-defined template name and the other selected storage configurations.
3. Review the Template Summary pane on the right side of the page, and select the Add Template button.

The copied storage options template appears in the Templates section.

Create your own template

To create a template by defining the storage configurations you want:

1. In the Storage Options (Templates) page, select the Create Template button.
2. In the Create Template page -> Basic Information section, enter the template name and select the other storage configurations available according to your needs.
3. Check the Template Summary on the right side of the page to ensure that all the information and configurations are correct, and then select the Add Template button to save the new template.

Add a template to a project

To add an existing storage options template to a project:

1. In the Templates section, select one or more template(s) you wish to add. To select all the available templates, select the checkbox beside the TITLE column label.
2. Select the Add to Project button.
3. In the Add to Project window -> Select Project dropdown, select a project to which you want to add the template.
4. Select Add to project.

Edit a template

This section explains how a PDS administrator can edit an existing resource settings template for users.

Prerequisites​

• PDS account Admin privileges
• An existing storage options template

Procedure

1. In the Templates section, find the template you want to edit, click on the vertical ellipsis menu icon, and select Edit from the options.
2. In the Edit Template page -> Basic Information section, modify the existing storage configurations.
3. In the Template Summary section, select the Update Template button.

Delete a template

This topic explains how a PDS administrator can delete an existing storage options template for users.

Prerequisites​

• PDS account Admin privileges
• An existing storage options template

Procedure​

1. In the Templates section, find the template you want to delete, click on the vertical ellipsis button, and then select Delete from the options.

2. In the Delete Storage Option Template window, select the Delete button.

   note

   You cannot bring back the deleted template in the PDS platform.