Build application templates for your organization

Contributors netapp-tonacki Download PDF of this page

Select one or more of the NetApp-provided "actions" and quickly build an application template that your organization can use to start optimizing the creation of resources.

Quick start

Get started quickly by following these steps, or scroll down to the remaining sections for full details.

Number 1 Verify required prerequisites

  • Before users can create a volume for a Cloud Volumes ONTAP, on-premises ONTAP, or Azure NetApp Files system using a template, make sure they have access to an appropriate working environment where the volume will be deployed.

  • If you plan to add a Cloud service "action" to your template, such as Cloud Backup or Cloud Data Sense, ensure that the service is active and licensed in your environment.

Number 2 Launch the Application Templates service

Select the AppTemplate service, click the Editor tab, and select the template.

Number 3 Build the template by selecting "actions" and defining parameters

Follow the creation steps and define the actions that will be performed by the template.

Requirements

Read the following requirements to make sure that you have a supported configuration.

  • If you don’t already have a Connector, see how to create Connectors for AWS, Azure, and GCP.

  • When creating a Cloud Volumes ONTAP volume template, make sure you have a Cloud Volumes ONTAP working environment available for your users. See how to launch a Cloud Volumes ONTAP system in AWS, Azure, or in GCP.

  • When creating an on-premises ONTAP volume template, make sure you have an on-premises ONTAP working environment available for your users. See how to discover an on-premises ONTAP system in Cloud Manager.

  • When creating an Azure NetApp Files volume template, make sure you have an Azure NetApp Files working environment available for your users. See how to create an Azure NetApp Files working environment in Cloud Manager.

  • If you plan to enable Cloud Backup in the template, ensure that your environment has an active and licensed Cloud Backup service.

  • If you plan to enable Cloud Data Sense in the template, ensure that your environment has an active and licensed Cloud Data Sense service.

  • If you plan to enable Replication in the template, and the template is for an on-premises ONTAP volume, the ONTAP cluster must have an active SnapMirror license.

Examples of creating resources using templates

Resource templates enable you to create new volumes or a new Cloud Volumes ONTAP working environment.

Create a template for a Cloud Volumes ONTAP volume

See how to provision Cloud Volumes ONTAP volumes for details about all the parameters you need to complete in the Cloud Volumes ONTAP volume template.

For this example we’ll create a template named "CVO volume for databases" and include the following 2 actions:

  • Create Cloud Volumes ONTAP Volume

    Make the volume for the AWS environment, configure it with 100 GB of storage, set the Snapshot Policy to "default", and enable Storage Efficiency.

  • Enable Cloud Backup

    Create daily backups with a retention value of 30 copies.

Steps
  1. Select the AppTemplate service, click the Templates tab, and click Add New Template.

    The Select_a Template page is displayed.

    A screenshot showing how to select the primary action that will be performed using this template.

  2. Select Volume for Cloud Volumes ONTAP + Backup as the type of resource you want to create, and click Get Started.

    The Create Volume in Cloud Volumes ONTAP Action Definition page is displayed.

    A screenshot showing a blank CVO template that you need to fill in.

  3. Action Name: Optionally, enter a customized action name instead of the default value.

  4. Details: Enter the volume name and size.

    Field Description

    Volume Name

    Click in the field and select one of the 5 options. You can let the admin enter any name by selecting Free Text, or you can specify that the volume name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    For example, you could specify that "db" be a required prefix, suffix, or contains; requiring the user to add volume names like "db_vol1", "vol1_db", or "vol_db_1".

    Volume Size

    You can specify a range of allowable values, or you can specify a fixed size. This value is in GB. For our example we can add a fixed value 100.

    Tags

    Enter a name and value pair for a tag that you want to associate with this volume. For example, you could add "Cost Center" as the tag name and the cost center code "6655829" as the value. You can associate more than one tag with a volume by adding more tag name and value pairs.

  5. Protection: Choose whether this volume will have Snapshot copies created by selecting "Default" or some other policy, or choose "None" if you do not want to create Snapshot copies.

  6. Usage Profile: Choose whether or not NetApp storage efficiency features are applied to the volume. This includes Thin Provisioning, Deduplication, and Compression. For our example, keep storage efficiency enabled.

  7. Disk Type: Choose the cloud storage provider and the type of disk. For some disk selections you can also select a minimum and maximum IOPS or Throughput (MB/s) value; basically defining a certain Quality of Service (QoS).

  8. Protocol Options: Select NFS or SMB to set the protocol of the volume. And then the provide the protocol details.

    NFS Fields Description

    Access Control

    Choose whether access controls are needed to access the volume.

    Export Policy

    Create an export policy to define the clients in the subnet that can access the volume.

    NFS Version

    Select the NFS version for the volume: either NFSv3 or NFSv4, or you can select both.

    SMB Fields Description

    Share Name

    Click in the field and select one of the 5 options. You can let the admin enter any name (Free Text) or you can specify that the share name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    Permissions

    Select the level of access to a share for users and groups (also called access control lists, or ACLs).

    Users / Groups

    Specify local or domain Windows users or groups, or UNIX users or groups. If you specify a domain Windows user name, you must include the user’s domain using the format domain\username.

  9. Tiering: Choose the tiering policy that you would like applied to the volume, or set this to "None" if you do not want to tier cold data from this volume to object storage.

    See volume tiering policies for an overview, and see Tiering inactive data to object storage to make sure your environment is set up for tiering.

  10. Context: Enter the Cloud Volumes ONTAP working environment context; if required.

    When users launch the template from an existing working environment, this information gets filled in automatically.

    When users launch the template from the Templates Dashboard (not in a working environment context), then they need to select the working environment and the SVM where the volume will be created. That’s why these fields are marked as "Editable".

  11. Click Apply after you have defined the parameters needed for this action.

    If the template values are correctly completed, a green checkmark is added to the "Create Volume in Cloud Volumes ONTAP" box.

  12. Click the Enable Cloud Backup box and the Enable Cloud Backup Action Definition dialog is displayed so you can fill in the Cloud Backup details.

    A screenshot showing additional actions that you can add to the created volume.

  13. Define the backup policy to create daily backups with a 30-day retention value.

  14. Below the Volume Name field there are three fields you use to indicate which volume will have backup enabled. See how to complete these fields.

  15. Click Apply and the Cloud Backup dialog is saved.

  16. Enter the template name CVO volume for databases (for this example) in the top left.

  17. Click Settings & Drift to provide a more detailed description so that this template can be distinguished from other similar templates, and so you can enable Drift for the overall template, and then click Apply.

    Drift allows Cloud Manager to monitor the hard-coded values you entered for parameters when creating this template.

  18. Click Save Template.

Result

The template is created and you are returned to the Templates Dashboard where your new template appears.

Create a template for an Azure NetApp Files volume

Creating a template for an Azure NetApp Files volume is done in the same manner as creating a template for a Cloud Volumes ONTAP volume.

See how to provision Azure NetApp Files volumes for details about all the parameters you need to complete in the ANF volume template.

Steps
  1. Select the AppTemplate service, click the Templates tab, and click Add New Template.

    The Select_a Template page is displayed.

    A screenshot showing how to select the primary action that will be performed using this template.

  2. Select Volume for Azure NetApp Files as the type of resource you want to create, and click Get Started.

    The Create Volume in Azure NetApp Files Action Definition page is displayed.

    A screenshot showing a blank ANF template that you need to fill in.

  3. Action Name: Optionally, enter a customized action name instead of the default value.

  4. Volume Details: Enter a volume name and size, and optionally specify tags for the volume.

    Field Description

    Volume Name

    Click in the field and select one of the 5 options. You can let the admin enter any name by selecting Free Text, or you can specify that the volume name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    For example, you could specify that "db" be a required prefix, suffix, or contains; requiring the user to add volume names like "db_vol1", "vol1_db", or "vol_db_1".

    Volume Size

    You can specify a range of allowable values, or you can specify a fixed size. This value is in GB.

    Tags

    Enter a name and value pair for a tag that you want to associate with this volume. For example, you could add "Cost Center" as the tag name and the cost center code "6655829" as the value. You can associate more than one tag with a volume by adding more tag name and value pairs.

  5. Protocol: Select NFSv3, NFSv4.1, or SMB to set the protocol of the volume. And then the provide the protocol details.

    NFS Fields Description

    Volume Path

    Select one of the 5 options. You can let the admin enter any path by selecting Free Text, or you can specify that the path name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    Export Policy Rules

    Create an export policy to define the clients in the subnet that can access the volume.

    SMB Fields Description

    Volume Path

    Select one of the 5 options. You can let the admin enter any path by selecting Free Text, or you can specify that the path name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

  6. Context: Enter the Azure NetApp Files working environment, details for a new or an existing Azure NetApp Files account, and other details.

    Field Description

    Working Environment

    When storage admin users launch the template from an existing working environment, this information gets filled in automatically.

    When users launch the template from the Templates Dashboard (not in a working environment context), then they need to select the working environment where the volume will be created.

    NetApp Account Name

    Enter the name you want to use for the account.

    Azure Subscription ID

    Enter the Azure Subscription ID. This is the full ID in a format similar to "2b04f26-7de6-42eb-9234-e2903d7s327".

    Region

    Enter the region using the internal region name.

    Resource Group Name

    Enter the name of the Resource Group you want to use.

    Capacity Pool Name

    Enter the name of an existing capacity pool.

    Subnet

    Enter the VNet and subnet. This value includes the full path, in a format similar to "/subscriptions/<subscription_id>/resourceGroups/<resource_group>/ providers/Microsoft.Network/virtualNetworks/<vpc_name>/subnets/<subhet_name>".

  7. Snapshot Copy: Enter the Snapshot ID for an existing volume Snapshot if you want this new volume to be created using characteristics from an existing volume.

  8. Click Apply after you have defined the parameters needed for this action.

  9. Enter the name you want to use for the template in the top left.

  10. Click Settings & Drift to provide a more detailed description so that this template can be distinguished from other similar templates, and so you can enable Drift for the overall template, and then click Apply.

    Drift allows Cloud Manager to monitor the hard-coded values you entered for parameters when creating this template.

  11. Click Save Template.

Result

The template is created and you are returned to the Templates Dashboard where your new template appears.

Create a template for an on-premises ONTAP volume

See how to provision on-premises ONTAP volumes for details about all the parameters you need to complete in the on-premises ONTAP volume template.

Steps
  1. Select the AppTemplate service, click the Templates tab, and click Add New Template.

    The Select_a Template page is displayed.

    A screenshot showing how to select the primary action that will be performed using this template.

  2. Select Blank template and click Get Started.

    The Add New Action page is displayed.

    A screenshot showing how to select the primary action from the Add New Action page.

  3. Select Create Volume in On-Premises ONTAP as the type of resource you want to create, and click Apply.

    The Create Volume in On-Premises ONTAP Action Definition page is displayed.

    A screenshot showing a blank onprem ONTAP template that you need to fill in.

  4. Action Name: Optionally, enter a customized action name instead of the default value.

  5. Details: Enter the volume name and size.

    Field Description

    Volume Name

    Click in the field and select one of the 5 options. You can let the admin enter any name by selecting Free Text, or you can specify that the volume name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    For example, you could specify that "db" be a required prefix, suffix, or contains; requiring the user to add volume names like "db_vol1", "vol1_db", or "vol_db_1".

    Volume Size

    You can specify a range of allowable values, or you can specify a fixed size. This value is in GB. For our example we can add a fixed value 100.

    Tags

    Enter a name and value pair for a tag that you want to associate with this volume. For example, you could add "Cost Center" as the tag name and the cost center code "6655829" as the value. You can associate more than one tag with a volume by adding more tag name and value pairs.

  6. Protection: Choose whether this volume will have Snapshot copies created by selecting "Default" or some other policy, or choose "None" if you do not want to create Snapshot copies.

  7. Usage Profile: Choose whether or not NetApp storage efficiency features are applied to the volume. This includes Thin Provisioning, Deduplication, and Compression.

  8. Protocol Options: Select NFS or SMB to set the protocol of the volume. And then the provide the protocol details.

    NFS Fields Description

    Access Control

    Choose whether access controls are needed to access the volume.

    Export Policy

    Create an export policy to define the clients in the subnet that can access the volume.

    NFS Version

    Select the NFS version for the volume: either NFSv3 or NFSv4, or you can select both.

    SMB Fields Description

    Share Name

    Click in the field and select one of the 5 options. You can let the admin enter any name (Free Text) or you can specify that the share name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    Permissions

    Select the level of access to a share for users and groups (also called access control lists, or ACLs).

    Users / Groups

    Specify local or domain Windows users or groups, or UNIX users or groups. If you specify a domain Windows user name, you must include the user’s domain using the format domain\username.

  9. Context: Enter the on-premises ONTAP working environment context; if required.

    When users launch the template from an existing working environment, this information gets filled in automatically.

    When users launch the template from the Templates Dashboard (not in a working environment context), then they need to select the working environment, the SVM, and the aggregate where the volume will be created.

  10. Click Apply after you have defined the parameters needed for this action.

    If the template values are correctly completed, a green checkmark is added to the "Create Volume in On-Premises ONTAP" box.

  11. Enter the template name in the top left.

  12. Click Settings & Drift to provide a more detailed description so that this template can be distinguished from other similar templates, and so you can enable Drift for the overall template, and then click Apply.

    Drift allows Cloud Manager to monitor the hard-coded values you entered for parameters when creating this template.

  13. Click Save Template.

Result

The template is created and you are returned to the Template Dashboard where your new template appears.

Create a template for a Cloud Volumes ONTAP working environment

You can create a Cloud Volumes ONTAP working environment using templates.

Note
  • This support is provided only for AWS environments at this time, and only for single-node clusters.

  • This template doesn’t create the first volume in the working environment. You must add a "Create Volume in Cloud Volumes ONTAP" action in the template to create the volume.

See how to launch a single-node Cloud Volumes ONTAP system in AWS for the prerequisites that must be in place, and for details about all the parameters you need to complete in this template.

Steps
  1. Select the AppTemplate service, click the Templates tab, and click Add New Template.

    The Select_a Template page is displayed.

    A screenshot showing how to select the primary action that will be performed using this template.

  2. Select Blank template and click Get Started.

    The Add New Action page is displayed.

    A screenshot showing how to select the primary action from the Add New Action page.

  3. Select Create Working Environment in AWS (single node) as the type of resource you want to create, and click Apply.

    The Create Working Environment in AWS (single node) page is displayed.

    A screenshot showing a blank Cloud Volumes ONTAP working environment template that you need to fill in.

  4. Action Name: Optionally, enter a customized action name instead of the default value.

  5. Details and Credentials: Select the AWS credentials to use, enter a working environment name, and add tags, if needed.

    Some of the fields in this page are self-explanatory. The following table describes fields for which you might need guidance:

    Field Description

    Credentials

    These are the credentials for the Cloud Volumes ONTAP cluster admin account. You can use these credentials to connect to Cloud Volumes ONTAP through ONTAP System Manager or its CLI.

    Working Environment Name

    Cloud Manager uses the working environment name to name both the Cloud Volumes ONTAP system and the Amazon EC2 instance. It also uses the name as the prefix for the predefined security group, if you select that option.

    Click in the field and select one of the 5 options. You can let the admin enter any name by selecting Free Text, or you can specify that the working environment name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    Tags

    AWS tags are metadata for your AWS resources. Cloud Manager adds the tags to the Cloud Volumes ONTAP instance and each AWS resource associated with the instance.

    For information about tags, refer to AWS Documentation: Tagging your Amazon EC2 Resources.

  6. Location & Connectivity: Enter the network information that you recorded in the AWS worksheet. This includes the AWS Region, VPC, Subnet, and Security Group.

    If you have an AWS Outpost, you can deploy a single node Cloud Volumes ONTAP system in that Outpost by selecting the Outpost VPC. The experience is the same as any other VPC that resides in AWS.

  7. Authentication Method: Select the SSH authentication method you want to use; either a password or a key pair.

  8. Data Encryption: Choose no data encryption or AWS-managed encryption.

    For AWS-managed encryption, you can choose a different Customer Master Key (CMK) from your account or another AWS account.

  9. Charging Method: Specify which charging option would you like to use with this system.

  10. NSS Account: Select a NetApp Support Site account.

  11. Preconfigured Packages: Select one of the four preconfigured packages that will determine several factors for volumes created in the working environment.

  12. SMB Configuration: If you plan to deploy volumes using SMB on this working environment, you can set up a CIFS server and related configuration elements.

  13. Click Apply after you have defined the parameters needed for this action.

    If the template values are correctly completed, a green checkmark is added to the "Create Working Environment in AWS (single node)" box.

  14. You may want to add another action in this template to create a volume for this working environment. If so, click button plus sign round and add that action. See how to Create a template for a Cloud Volumes ONTAP volume for details.

  15. Enter the template name in the top left.

  16. Click Settings & Drift to provide a more detailed description so that this template can be distinguished from other similar templates, and so you can enable Drift for the overall template, and then click Apply.

    Drift allows Cloud Manager to monitor the hard-coded values you entered for parameters when creating this template.

  17. Click Save Template.

Result

The template is created and you are returned to the Template Dashboard where your new template appears.

Examples of enabling services using templates

Service templates enable you to activate Cloud Backup, Cloud Data Sense, or Replication (SnapMirror) services on a newly created volume.

Add Backup functionality to a volume

When creating a volume template, you can add in the template that you want to create backups of the volume periodically using the Cloud Backup service.

Tip This action is not applicable for Azure NetApp Files volumes.

A screenshot of the page to enable backup functionality for your volumes.

  1. Policy: Define the backup policy to create daily, weekly, or monthly backups, and specify the number of backup copies to retain.

  2. Context: By default, the variables are filled out for the working environment, storage VM, and volume to indicate that you will be creating backups for the volume created previously in this same template. So if that’s what you want to do, you’re all set.

    If you want to create backups for a different volume, you can enter those details manually. See how to complete the Context fields to indicate a different volume.

  3. Click Apply to save your changes.

Add Data Sense functionality to a volume

When creating a volume template, you can add in the template that you want to scan the volume for compliance and classification using the Cloud Data Sense service.

A screenshot of the page to enable scanning functionality for your volumes.

  1. Context: By default, the variables are filled out for the working environment, volume name, volume UUID, volume path, and protocol to indicate that you will be scanning data for the volume created previously in this same template. So if that’s what you want to do, you’re all set.

    If you want to scan data for a different volume, you can enter those details manually. See how to complete the Context fields to indicate a different volume.

  2. Click Apply to save your changes.

Add Replication functionality to a volume

When creating a volume template, you can add in the template that you want to replicate the data in the volume to another volume using the Replication service. You can replicate data to a Cloud Volumes ONTAP cluster or to an on-prem ONTAP cluster.

Tip This action is not applicable for Azure NetApp Files volumes.

Replication functionality consists of three parts: selecting the source volume, selecting the destination volume, and defining the replication settings. Each section is described below.

  1. Source Details: Enter the details about the source volume you want to replicate:

    A screenshot of the page to define the replication source volume location.

    1. By default, the first three variables are filled out for the working environment, storage VM, and volume to indicate that you will be replicating the volume created previously in this same template. So if that’s what you want to do, you’re all set.

      If you want to replicate a different volume, you can enter those details manually. See how to complete the Context fields to indicate a different volume.

    2. Replication requires that the source and destination working environments are connected through their intercluster LIFs. Enter the intercluster LIF IP address for the source working environment.

      To get this information: double-click the working environment, click the menu icon, and click Information.

  2. Destination Details: Enter the details about the destination volume that will be created by the replication operation:

    A screenshot of the page to define the replication destination volume location.

    1. Select the working environment where the volume will be created.

    2. Select the storage VM on which the volume will reside.

    3. When replicating a volume to a Cloud Volumes ONTAP cluster (not to an on-prem ONTAP cluster), you need to specify the Destination Provider (AWS, Azure, or GCP).

    4. When replicating a volume to a Cloud Volumes ONTAP cluster, you can specify whether volume tiering is enabled on the destination volume.

    5. For the destination volume name, click in the field and select one of the 5 options. You can let the admin enter any name by selecting Free Text, or you can specify that the volume name must have a certain prefix or suffix, that it contains certain characters, or that it follows rules from a regular expression (regex) you enter.

    6. Replication requires that the source and destination working environments are connected through their intercluster LIFs. Enter the intercluster LIF IP address for the destination working environment.

    7. Select the aggregate on which the volume will reside.

    8. When replicating a volume to a Cloud Volumes ONTAP cluster (not to an on-prem ONTAP cluster), you need to specify the type of disk that will be used for the new volume.

  3. Replication Details: Enter the details about the type and frequency of the replication operation:

    A screenshot of the page to define the replication settings for the relationship.

    1. Select the replication policy that you want to use.

    2. Choose a one-time copy or a recurring replication schedule.

    3. Enable replication health status monitoring if you want the drift report to include the replication health of the SnapMirror relationship along with the lag time, status, and last transfer time. See what this looks like in the drift report.

    4. Select whether you want to set a transfer rate limit, and then enter the maximum rate (in kilobytes per second) at which data can be transferred. You can enter a fixed value, or you can provide a minimum and maximum and let the storage admin select a value in that range.

  4. Click Apply to save your changes.

What to do after you have created the template

After you have created a template, you should inform your storage administrators to use the template when creating new working environments and volumes.

You can point them to Creating resources using templates for details.

Edit or delete a template

You can modify a template if you need to change any of the parameters. After you save your changes, all future resources created from the template will use the new parameter values.

You can also delete a template if you no longer need it. Deleting a template does not affect any of the resources that were created with the template. However, no Drift compliance checking can be done after the template is deleted.

A screenshot showing how to modify a template or delete a template.

Make a copy of a template

You can create a copy of an existing template. This can save a lot of time in case you want to create a new template that is very similar to an existing template. Just make the duplicate with a new name, and then you can edit the template to change the couple items that make the template unique.

A screenshot showing how to duplicate a template.