getting started with cloud volumes service · note: netapp data brokers make use of the cloud sync...

Getting Started with Cloud VolumesService

October 2019 | SL10473 Version 1.1.5

Getting Started with Cloud Volumes Service2 © 2019 NetApp, Inc. All rights reserved. NetApp Proprietary

TABLE OF CONTENTS

1 Introduction...................................................................................................................................... 4

1.1 Lab Use Case.............................................................................................................................4

1.2 Prerequisites.............................................................................................................................. 4

2 Lab Environment............................................................................................................................. 5

3 Lab Activities................................................................................................................................... 6

3.1 Review the Cloud Volumes Service Web Interface................................................................ 6

3.1.1 Tour the Web Interface.........................................................................................................................................6

3.1.2 Adjusting Allocated Capacity on an Existing Cloud Volume.............................................................................. 11

3.2 Create and Delete a Cloud Volume....................................................................................... 13

3.2.1 Create a new Cloud Volume using NFS............................................................................................................ 13

3.2.2 Create a new Cloud Volume using SMB........................................................................................................... 15

3.2.3 Create a new dual protocol Cloud Volume........................................................................................................ 19

3.2.4 Delete a Cloud Volume...................................................................................................................................... 23

3.3 Working with Sync Relationships..........................................................................................24

3.3.1 Manage existing sync relationships for an AWS Data Broker............................................................................24

3.3.2 Sync Data to or from a Cloud Volume using Cloud Sync..................................................................................26

3.4 Working with Cloud Volumes.................................................................................................28

3.4.1 Mount an NFS Cloud Volume to a Compute resource...................................................................................... 28

3.4.2 Access an SMB Cloud Volume share from a client........................................................................................... 31

3.4.3 Explore Cloud Volume Options.......................................................................................................................... 37

4 Advanced Lab Activities - API Exploration................................................................................ 43

4.1 API Introduction.......................................................................................................................43

4.2 How to access and interact through the API....................................................................... 43

4.3 Build API calls......................................................................................................................... 51

4.4 Show how API calls can be utilized...................................................................................... 62

5 Lab Limitations.............................................................................................................................. 72


6 References......................................................................................................................................73

7 Version History.............................................................................................................................. 74


1 IntroductionCloud Volumes Service:NetApp Cloud Volumes Service is a fully managed cloud connected flash service,delivering extreme performance service levels to your cloud workloads. NFS and SMB protocols are offered, withActive Directory integration and always-on encryption at rest. A simple UI and API are available to provision CloudVolumes, each up to 100 TB, in just a few seconds.

Cloud Sync Service: Data migration with integrated NetApp Cloud Sync efficiently moves your data from anyvendor’s existing NFS, SMB, or AWS S3 to Cloud Volumes and other NetApp Cloud-enabled endpoints. TheCloud Sync Service can also be directly accessed from https://cloud.netapp.com/. It can be used to sync datafrom many types of sources to many types of targets.

This lab is similar to a user logging into Cloud Volumes Service from NetApp Cloud Central to configure aCloud Volume for AWS. The Cloud Volumes Service for Azure is delivered by Microsoft as a native first-partyNetwork File System (NFS) service known as Azure NetApp Files. The service can be accessed directly fromthe Azure portal once you purchase it. (For more information visit: https://cloud.netapp.com/azure-netapp-files).Similarly, NetApp Cloud Volumes for Google Cloud Platform is integrated with the Google Cloud. It can be usedto create Cloud Volumes for both NFS and SMB access in Google Cloud. (For more information visit: https://cloud.netapp.com/cloud-volumes-service).

In order to use Cloud Volumes Service, the customer first subscribes to the service from the hyperscaler’smarketplace using their cloud account. This will start to onboard the customer’s public cloud networking to thecloud-connected flash storage. Following the boarding process, the customer will get a login to use in the CloudVolumes Service portal from NetApp Cloud Central (https://cloud.netapp.com/).

This lab assumes that the above steps have been completed, and begins the demonstration by using a simulatorfor the Cloud Volumes Service and all other resources.

1.1 Lab Use CaseThis lab illustrates the following use case:

Problem: A customer has a cloud application running in AWS. The application requires a level of performancefrom storage (latency and IOPS) that is not available or cost effective from AWS's standard integrated storageofferings, even in the higher tiers like EFS. Additionally, while running their workload on some other vendor's NAScloud solution, or AWS S3, the lack of data management features combined with lack of performance leads tohigher costs making them ineffective.

Solution: As a result, in order to guarantee high performance they turn to NetApp's cloud-connected flash.Running Cloud Volumes Service provides the storage efficiencies and data fabric endpoint benefits of NetAppwith a metered billing experience. After establishing a Cloud Volume for AWS from the Cloud Volumes ServiceUI, the customer creates and uses a Data Broker from this UI to establish a Sync relationship to get their data intotheir new cloud-connected flash volume.

So whether their original workload started on-premises, or in Cloud Volumes ONTAP (or some other storageoffering), they can use the API integration in Cloud Volumes Service to communicate with Cloud Sync Serviceto migrate their data to the cloud volume to gain higher performance levels and advanced data managementcapabilities.

1.2 PrerequisitesWe recommend that you have the following knowledge before taking this lab:

• A basic understanding of NFS and SMB network attached storage protocols.• A basic understanding of the hybrid cloud replication operations.• A general familiarity with NetApp storage concepts and systems.

https://cloud.netapp.com/

https://cloud.netapp.com/azure-netapp-files

https://cloud.netapp.com/cloud-volumes-service

https://cloud.netapp.com/cloud-volumes-service



2 Lab EnvironmentThis lab simulates functions commonly performed from Cloud Volumes Service for AWS.

Figure 2-1: Lab Diagram

Table 1: Table of Systems

Hostname Operating System Role/Function IP address

JUMPHOST Windows 2016 Jumphost to access 192.168.0.5

DC1 Windows 2012 Domain Controller 192.168.0.253

CENTOS1 CentOS Linux compute resource to testmount of NFS share from CloudVolumes

192.168.0.65

Table 2: User IDs and Passwords

Hostname User ID Password

Jumphost DEMO\administrator Netapp1!

CENTOS1 user or root Netapp1!

Cloud Volumes Auth0 demo account [email protected] Netapp1!

Cloud Volumes local demo dev acct [email protected]!

Cloud Volumes local api admin acct [email protected]!


3 Lab ActivitiesThe following lab activities demonstrate the functionality of Cloud Volumes:

• Review the Cloud Volumes Service Web Interface on page 6

• Tour the Web Interface on page 6• Adjusting Allocated Capacity on an Existing Cloud Volume on page 11

• Create and Delete a Cloud Volume on page 13

• Create a new Cloud Volume using NFS on page 13• Create a new Cloud Volume using SMB on page 15• Create a new dual protocol Cloud Volume on page 19• Delete a Cloud Volume on page 23

• Working with Sync Relationships on page 24

• Manage existing sync relationships for an AWS Data Broker on page 24• Sync Data to or from a Cloud Volume using Cloud Sync on page 26

• Working with Cloud Volumes on page 28

• Mount an NFS Cloud Volume to a Compute resource on page 28• Access an SMB Cloud Volume share from a client on page 31• Create and Delete a Cloud Volume on page 13

• Advanced Lab Activities - API Exploration on page 43

• API Introduction on page 43• How to access and interact through the API on page 43• Build API calls on page 51• Show how API calls can be utilized on page 62

3.1 Review the Cloud Volumes Service Web Interface

3.1.1 Tour the Web Interface

This lab activity walks through the web interfaces used by Cloud Volume Services customers.

1. Open a browser by double-clicking on the shortcut labeled Cloud Volumes Service Simulator to startthe Cloud Volumes Service simulator.

Figure 3-1:

2. Click Log in with Auth0.

Note: This demonstration uses an Auth0 account for login. Auth0 is a hosted authentication andauthorization service. NetApp Cloud Orchestrator is the NetApp Service Delivery Engine thatpowers the Cloud Volumes Service.


2

Figure 3-2:

3. Log in with email [email protected], and a password of Netapp1!, then click LOGIN. This is anaccount ID associated with the customer account tied to the subscription. In this lab, a staging “Auth0”account has been created in a staging site for Cloud Central.


3

Figure 3-3:

Note: A generous timeout value exists for inactivity. If you are logged out, you will be able to logback in and return to your previous option.

4. After you log in, the main screen presents the existing volumes configured for this account that areaccessible to this user.

4

Figure 3-4:

5. Click on the circle with the number in the top right corner of the web user interface to see notifications.This menu option displays the last operations performed.


5

Figure 3-5:

6. On the left menu, click Snapshots.7. This view allows you to create a new snapshot, or delete an existing snapshot on a volume.

6

Figure 3-6:

8. On the left menu, click Active Directory.9. From here you will be able to view any Active Directory Domains, either Windows or AWS AD, that were

created as part of the onboard process.

8 9

Figure 3-7:

10. On the left menu, click Sync.11. You will explore additional lab activities later in this lab guide, however, from here you can discover the

data brokers assigned to this account.

Note: NetApp Data Brokers make use of the Cloud Sync API sync relationship managementfrom Cloud Volumes.


1011

Figure 3-8:

12. Click on the username, and select User profile.

12

Figure 3-9:

13. This view allows for basic profile management.

13

Figure 3-10:

14. Click Notifications.15. This view allows you to view the full list of notifications as an activity event log for this account.16. Click the NetApp Logo to return to the main page.


14

15

16

Figure 3-11:

3.1.2 Adjusting Allocated Capacity on an Existing Cloud Volume

Customer's business needs may change because the size of their data can grow or shrink. You can create andprovision a volume that anticipates growth, but if the growth is never realized, right-sizing for a capacity-basedservice offering may be beneficial because costs are incurred when allocated. Cloud Volumes Service deploysvolumes that allow data to be written up to 100TB in size, but setting Allocated Capacity and the Service Leveladjusts the monthly usage billing. This lab activity shows how simple it is to adjust the allocated capacity in CVSwhen demand has increased.

1. From the view displaying all the Cloud Volumes, click on the name of the volume demoVolume.

1

Figure 3-12:

2. From this view you can edit the Name, change the Service Level, or adjust the Allocated Capacity. Clickon Edit next to Allocated Capacity.


2

Figure 3-13:

3. Change the allocated capacity size from 50GB to 100GB.4. Click the blue checkmark icon.

3 4

Figure 3-14:

5. The allocated capacity changes, and the new value is displayed.

Note: Allocated Capacity and even Service Levels can be changed non-disruptively at any time.

5

Figure 3-15:


6. Click on Volumes to return to the main page.

6

Figure 3-16:

For more information on how allocated capacity and service levels impact pricing visit: https://cloud.netapp.com/pricing.

3.2 Create and Delete a Cloud Volume

3.2.1 Create a new Cloud Volume using NFS

Creating a new Cloud Volume is a simple process to start. Only four entries are required to quickly create anddeploy a 1TB volume on NetApp cloud connected flash storage so that you can immediately use the volume witha Cloud Compute resource. However, you can adjust other options during the Cloud Volume creation. This labactivity demonstrates how easy it is to create a Cloud Volume accessible by an NFS client.

1. Click on green button labeled Create new volume.

1

Figure 3-17:

2. Cloud Volume creation is done from one simple display after you input all the necessary parameters.Begin by clicking on the option for NFS.

3. Enter the “Name”: newNFSvol4app.4. Select the “Region”: LOD Demo.5. “Volume Path” options are pre-populated. You can refresh or overwrite them to something more specific.6. The interface allows you to create a new volume from scratch, or from a snapshot of an existing volume.

In this case, leave this value blank to create a new volume with no data.7. Performance is defined by a Service Level. Select the “Service Level”: Standard, Premium, or Extreme.8. Enter the "Allocated Capacity".

Note: These service levels identify predefined quality of service level objectives that areconfigured for initial 1TB Maximum Throughput, and 16MB/s, 64, 128 for Standard, Premium, andExtreme respectively. Service Level combined with Quota are what determines billing amounts.

9. Click on Export policy to open. NFS clients require configuration of Export Policies. A specific IPaddress, address range or any value can be configured. In this demonstration we will give everyoneRead Only access and Read and Write access to those on a specific 172 subnet.

https://cloud.netapp.com/pricing

https://cloud.netapp.com/pricing


a. Define the first rule by entering 0.0.0.0/0 in Allowed Clients (everyone) and select "ReadOnly" under Access.

b. Click + Add export policy rule and enter 172.0.0.0/8 in Allowed Clients (172 subnet) andselect "Read and Write" under Access.

Note: A single policy can have multiple rules that can be created for different accesslevels.

10. Scroll down.

2 3

4

56

78

9 10

Figure 3-18:

11. Click on Snapshot Policy.12. Review the options to define a Snapshot Policy:

a. Determine the frequency: Hourly, Daily, Weekly, Monthly or not at all. Select Hourly.b. Select the retention for the number of “Snapshots to keep” at 2.c. Set the “Minute” of when on the hour to take the snapshot to 15.d. The Explanation explains how the Snapshot policy is configured in simple terms.

13. Click Create Volume.


1112

13Figure 3-19:

14. The UI returns you to the main page, and the status updates.

14

Figure 3-20:

15. Once complete, the volume is now listed.

15

Figure 3-21:

3.2.2 Create a new Cloud Volume using SMB

Choosing Server Message Block (SMB) instead of NFS as a protocol for the Cloud Volume is just as easy. Thisactivity demonstrates the simplicity to setting up a Cloud Volume for access by an SMB client and how to join it toa Active Directory domain.

1. Click on green button labeled Create new volume.


1

Figure 3-22:

2. Cloud Volume creation is done from one simple display after you input all the parameters needed. Beginby clicking on the option for SMB.

3. Enter the “Name”: newSMBvol4app.4. Select the “Region”: LOD Demo.5. “Volume Path” options are pre-populated. You can refresh or overwrite them to something more specific.6. The interface allows you to create a new volume from scratch, or from a snapshot of an existing volume.

In this case, leave this value blank to create a new volume with no data.7. Performance is defined by a Service Level. Select the “Service Level”: Standard, Premium, or Extreme.8. Enter the “Allocated Capacity".

Note: These service levels identify predefined quality of service level objectives that areconfigured for initial 1TB Maximum Throughput, and 16MB/s, 64, 128 for Standard, Premium, andExtreme respectively. Service Level combined with Quota are what determines billing amounts.

9. Scroll down to view the Active Directory settings. Under Available Settings select "\\loddemo.demo.netapp.com\...".

Note: The Active Directory option will be used to join the SVM to an AD domain. The AD domainis created as part of the onboarding.


2

3

4

56

78

9

Figure 3-23:

10. Scroll down and click on Snapshot Policy.11. Review the options to define a Snapshot Policy:

a. Determine the frequency: Hourly, Daily, Weekly, Monthly, or not at all. Select Hourly.b. Set the “Number of snapshots to keep” at 4.c. Set the “Minute” of when on the hour to take the snapshot to 15.d. The Explanation describes how the Snapshot policy is configured in simple terms.

12. Click Create volume.


10

11

12

Figure 3-24:


13

Figure 3-25:



14

Figure 3-26:

3.2.3 Create a new dual protocol Cloud Volume

Cloud Volumes Service allows you three NAS protocol options. You can choose either SMB, NFS or both. Bothallows an SMB protocol client to access the same volume and data made available to an NFS protocol client. Thislab activity demonstrates how easy it is to create a Cloud Volume accessible by both protocols.

1. Click on green button labeled Create New Volume.

1

Figure 3-27:

2. Cloud Volume creation is done from one simple display after you input all the necessary parameters.Begin by clicking on the option for Dual-protocol.

3. Enter the “Name”: newDUALvol4app.4. Select the “Region”: LOD Demo.5. “Volume Path” options are pre-populated. You can refresh or overwrite them to something more specific.6. The interface allows you to create a new volume from scratch, or from a snapshot of an existing volume.

In this case, leave this value blank to create a new volume with no data.7. Performance is defined by a Service Level. In the “Service Level” drop down menu select either

“Standard”, “Premium”, or “Extreme”.8. Enter the “Allocated Capacity".

Note: These service levels identify predefined quality of service level objectives that areconfigured for initial 1TB Maximum Throughput, and 16MB/s, 64, 128 for Standard, Premium, andExtreme respectively. Service Level combined with Quota determines billing amounts.

9. Under Security Style choose the setting UNIX.10. Click on Export policy to open. NFS clients require configuration of Export Policies. A specific IP

address, address range or any value can be configured. In this demonstration we will give everyoneRead Only access and Read and Write access to those on a specific 172 subnet.

a. Define the first rule by entering 0.0.0.0/0 in Allowed Clients (everyone) and select "ReadOnly" under Access.


b. Click + Add export policy rule and enter 172.0.0.0/8 in Allowed Clients (172 subnet) andselect "Read and Write" under Access.

Note: A single policy can have multiple rules that can be created for different accesslevels.

11. Scroll down.

2

3

4

5

6

7 89

11

10

Figure 3-28:

12. Open the Active Directory settings and select "\\loddemo.demo.netapp.com\<..>" in the AvailableSettings dropdown..

Note: The Active Directory option will be used to join the SVM to an AD domain. The ADdomain is created as part of the onboarding.


12

Figure 3-29:

13. Click on Snapshot Policy.14. Review the options to define a Snapshot Policy:

a. Determine the frequency: Hourly, Daily, Weekly, Monthly or not at all. Select Hourly.b. Set the number of “Snapshots to keep” at 4.c. Set the “Minute” of when on the hour to take the snapshot to 30.d. The “Explanation” describes how the Snapshot policy is configured in simple terms.

15. Click Create Volume.


13

14

15

Figure 3-30:


16

Figure 3-31:



17

Figure 3-32:

3.2.4 Delete a Cloud Volume

Deleting a Cloud Volume is simple from the Web Interface.

1. From the main screen select the "demoVolume" volume.2. Click on the Actions menu to select Delete volume/s.

1

2

Figure 3-33:

3. Enter the word delete.4. Click Delete.


34

Figure 3-34:

5. Once the volume is deleted it is removed from the main page.6. Click on the notifications bubble icon to see the event log.

6

Figure 3-35:

3.3 Working with Sync Relationships

3.3.1 Manage existing sync relationships for an AWS Data Broker

Now that there is an empty Cloud Volume, a customer may have data that they want to bring into that volume.Cloud Volumes Service utilizes another NetApp service called Cloud Sync for this purpose. By using Cloud SyncAPIs, Cloud Volumes Service can offer the Cloud Sync features from its own user interface. This lab activityexplores the NetApp Data Broker from the Cloud Volumes Service UI.

1. Click Sync.


1

Figure 3-36:

2. Click on the AWSDataBroker dropdown menu.3. Examine the details.

Note: Since this is a Data Broker in AWS, the Region, VPC, Availability Zone, and subnetinformation is displayed.

2

3

Figure 3-37:

4. Select the sync relationship by selecting the checkbox next to it.5. Click Actions, and select Delete relationship(s).

45

Figure 3-38:

6. Enter the text delete.7. Click on Delete.


6

7

Figure 3-39:

8. The sync relationship is now gone, but the Data Broker is now ready for a new sync relationship.

8

Figure 3-40:

3.3.2 Sync Data to or from a Cloud Volume using Cloud Sync

Now that the customer has an empty volume, their data needs to be synced to it from a source that allows themto start using the data. This lab activity shows how the Cloud Volumes Service integrates with the Cloud Sync APIto use a NetApp Data Broker to move data. The NetApp Data Broker defines a source with a target to establish async relationship. In this activity you will use a Cloud Volume created earlier as a target.

This lab uses a simulator that responds to the Cloud Sync APIs, and does not perform any data movement. Thisis simply a demonstration of how to set it up.

1. Click on Sync.2. Note that the “AWSDataBroker” is green, and available.3. Click on Create new relationship.


12

3Figure 3-41:

4. Select the volume newDUALvol4app, for example.5. Alternatively select Use volume as target, and Use volume as source to see that the information

below is filled in for you. Leave Use volume as source selected to simulate archiving data from the"newDUALvol4app" Cloud Volume.

6. Under “Target”, note that the Protocol is selected for you. Enter the host information success.com tosimulate a container accessible to the NetApp Data Broker. This could be an S3 bucket, but in this caseyou use an NFS share as the target.

7. Select any Export directory, or simply select "/".8. Click Create relationship.

4

5

67

8

Figure 3-42:

9. The Sync changes to “Running”, and the simulated data movement is copying to the Cloud Volumetarget.


9

Figure 3-43:

10. Once the intial copy is done, you can adjust the relationship by toggling on or off “Auto sync”.11. You can set a schedule.12. If you move your mouse over the File progress option you can see what changed since the last sync.

Note: To simulate other types of File progress options being displayed instead of“success.com”, try entering any IP address in source and target, or failsync.com, orfail.com. Each will result in a different simulated outcome.

10

1112 13

Figure 3-44:

13. Additionally, if you move the mouse under the “Action” menu the "Sync Now" option becomes available.

13

Figure 3-45:

3.4 Working with Cloud Volumes

3.4.1 Mount an NFS Cloud Volume to a Compute resource

Once a Cloud Volume is created using NFS it is immediately ready and available for use by a Cloud Computeresource. This activity illustrates how to use the simple NFS mounting instructions feature.

1. Find the volume you wish to mount in the main screen.


2. Click on the (?) icon next to the volume for the mount instructions.

2Figure 3-46:

3. With the mount instructions open, launch PuTTy to connect to a compute resource.

Remember: The PuTTy icon is on the desktop.

Note: This lab already includes a compute resource with an NFS client installed. Therefore youwill move right to “Mounting your file system”.

3

Figure 3-47:

4. Double-click on NFS Client, or highlight and click Open to connect.


4

Figure 3-48:

5. Login as: user.6. Enter password: Netapp1!.7. Enter the following text: sudo su.8. Enter password: Netapp1!.9. Click on the copy icon next to the Step 1 to create a new directory.10. Return to the PuTTy session, and right-click to paste, and click Enter.11. Click on the copy icon next to the Step 2 to mount the NFS share, and click Enter.12. Return to the PuTTy session, and right-click to paste, and click Enter.13. Enter the following text: df -k to view the Filesystem mounts.


57

9

6

8 10

11

12

13

Figure 3-49:

3.4.2 Access an SMB Cloud Volume share from a client

Once a Cloud Volume is created using SMB it is immediately ready and available for access by an SMB client.This activity illustrates how to use the simple SMB mounting instructions feature to map a network drive.

1. Find the newDUALvol4app volume you will mount.2. Click on the (?) icon next to the volume for the mount instructions.


12

Figure 3-50:

3. With the mount instructions open, launch Windows Explorer to map the network drive by clicking onFolder icon.


3

Figure 3-51:

4. With This PC highlighted, click on Computer.5. Click on Map network drive.


45

Figure 3-52:

6. Select a Drive letter.7. Copy/Paste or enter the path from Step 4 of the “Mount” instructions.8. Check Reconnect at logon.9. Click Finish.

6 7

89

Figure 3-53:

10. Browse the mapped network drive from the Windows Explorer window.


11. Notice that the “~snapshot” directory is available. You may wish to create some new files and take asnapshot. Using the ~snapshot directory, you can easily browse the backups to restore deleted files.

10

11

Figure 3-54:

12. Now examine how to access the Previous Versions tab in Windows. Right-click on the SMB share andgo to Properties.


12

Figure 3-55:

13. Go to the Previous Versions tab. There may or may not be copies listed depending on the length oftime since the volume was created.

14. Click Cancel.


13

14Figure 3-56:

Leave Windows Explorer open or minimize it. You will return to it in a later lab.

3.4.3 Explore Cloud Volume Options

Once a Cloud Volume is created, the web interface allows for direct management of options tied to the volume tomanage data.

1. Click on the volume newDUALvol4appto view the options.

1

Figure 3-57:

2. Click on Snapshots.


2

Figure 3-58:

3. Click Create new snapshot (or click on Snapshots in the left menu).

Figure 3-59:

4. You can change the snapshot name to a custom name, or keep the pre-completed name.5. Additionally, you can change the volume selection from this menu, or keep the one selected.6. Click Create snapshot.

5

6

7

Figure 3-60:

7. Once the snapshot completes it is displayed in the “Volume details” view.8. Click Export policy.


8

9

Figure 3-61:

9. The existing Export Policy is listed. Here you can add a new rule, or modify an existing rule and save it.10. Click Snapshot policy.

10

11

Figure 3-62:

11. The Snapshot policy can be disabled or enabled, and the schedule and retention value can bemodified.


12

Figure 3-63:

12. Click on Sync.13. The Sync relationship is displayed (if one exists for the Cloud Volume), and can be managed from this

more focused view rather than the larger view with all the volumes.

14

Figure 3-64:

14. Open or return to the Windows Explorer window started earlier in the lab.15. Select the mapped network drive from the Windows Explorer window.16. Right-click on the SMB share and select Properties.


16

17

Figure 3-65:

17. Go to the Previous Versions tab. You can now see the Snapshot copy you created in a previous step.18. Click Cancel.


18

19

Figure 3-66:


4 Advanced Lab Activities - API ExplorationThe following section is optional, and can be performed independent of the previous sections. We provide it inorder to demonstrate some advanced concepts and use of the this product or service.

The activities in this section explore how to connect and view the RESTful APIs available in CVS. They alsoillustrate how to build an HTTP request, and how to apply these features in a real world scenario.

4.1 API IntroductionA RESTful (REpresentational State Transfer) API (application program interface) is a communication method forapplications that uses HTTP requests to GET, PUT, POST and DELETE data. For each request the resultingoutput is characterized by the type of request, for example a GET request is a description of something, a PUTrequest is an update of something, a POST request is a creation of something, and a DELETE request is adeletion of something. This architectural method of communicating with an application is widely used with cloudapplications because it requires low bandwidth and is compatible in nearly all browsers.

The HTTP request is assembled in a modular fashion in order to execute a transaction. This enables the codeto be very flexible for many applications. API interactions between the client and server are independent of eachother, or stateless. In other words, the server does not rely on a previous interaction in order to complete theHTTP request. Since each HTTP request includes all the information to interact and complete the action, thosemodular requests can be assembled individually but then brought together in a script or web page to interact witha user for input in a very efficient manner.

The following list offers just a few of the variety of ways you can use Rest APIs:

• Integrate storage monitoring and reporting into one management interface.• View inventory objects, configuration, and events collectively.• Pull essential operational and performance metrics to take action.• Provision storage based on performance and service level requirements.

The following table lists the tasks you will perform in the REST API activities section:

Tasks

Demonstrate how to get access credentials.

Demonstrate how to see all the calls and functions that are available.

Use an API building tool to assemble a call that performs a function.

Confirm the API operations worked.

Learn how this could be applied to a real world scenario.

Demonstrate a mock API integration.

4.2 How to access and interact through the APICloud Volumes Service offers a RESTful API that allows programmatic access to its features, and simplifiesprovisioning, automation and scalability. This lab activity shows how easy it is to interact with a Cloud VolumesService through the RESTful API.

1. Double-click on the Cloud Volumes Service Simulator Session 2 shortcut on the desktop of theJumphost.

Note: This shortcut opens the browser in private or incognito mode since in this exercise you aregoing to log in with different personas and want to avoid caching the credentials.


Figure 4-1:

2. Use a local login with credentials username apiExplorer and password Netapp1!.

2

Figure 4-2:

3. From the main screen click on API access.4. Click Show keys and credentials.


3

4

Figure 4-3:

5. Enter the password: Netapp1!.6. Click Show.

5

6

Figure 4-4:

7. A client and server share knowledge of two secret tokens in order to authenicate and allow forcommunication. The API key and Secret key are listed for this user in order to access the REST APIfunctionality.


7

Figure 4-5:

8. After obtaining the necessary programmatic access credentials to authenticate, the next step is todetermine which functions can be performed. Open an additional tab on your browser and navigate tohttps://services.cloud.netapp.com/developer-hub to explore the API Documentation.

9. To the right of Cloud Volumes Service for AWS click on View API Documentation.

9

Figure 4-6:

10. SwaggerHub is a collaborative web application that allows users to view and use API definitions.Review the repository for “Cloud Volumes as a Service API” by changing from the Design View to thePreview Docs view to learn the supported operations, schema, and how to use the API.

Note: Each action is grouped by an Endpoint. For example using “GET /v1/Pools Describesall pools,” the Action is “Describes all pools”, the Endpoint is “pools”, and the HTTP Header is“GET.”


10

Figure 4-7:

11. Scroll down the site to see how programmers can use the API calls that are available.

11

Figure 4-8:


12. Scroll to the “Filesystems” section and locate the “GET” call for “/v1/FileSystems/{fileSystemId}” whichis the API call to describe a file system.

13. Click on Describe a file system to see the details.

12

13

Figure 4-9:

14. From the “Parameters” section you can see what a properly assembled call requires, which in this GETrequest is only one string, the fileSystemID.

14

Figure 4-10:

15. Below the parameters, scroll down to explore the available HTTP Response codes and descriptionsyou would expect to see. Under code “200” you can see all of the details of the CVS volume that isincluded in a successful GET response..


15

Figure 4-11:

16. Scroll down to see the other types of responses.

16

Figure 4-12:

17. Scroll to the “PUT” call for “/v1/FileSystems/{fileSystemId}” and click on Update a file system toexpand.

18. This PUT call requires a body parameter that looks very similar to the output of the GET request shownabove. A single PUT call can be used to modify each of the data in its body parameter.


18

17

Figure 4-13:

19. Scroll down to see HTTP Response code 200, that illustrates an example of the ouptut when the filesystem is updated.

19

Figure 4-14:

20. Just like the GET request, the PUT shows other possible outcomes.


20

Figure 4-15:

This activity demonstrates how API calls can be used to assemble two modular requests into a usefulaction. Following the GET request first to obtain all the details of a CVS volume, the output is then used tomodify the desired parameters of a PUT request to update the volume. For more information visit https://services.cloud.netapp.com/developer-hub.

4.3 Build API callsNow that you know how to authenticate with access credentials, and you know where to find the APIs that areavailable, the next step is to assemble the calls into a useable request. In order to build HTTP requests, API callsand parameters are assembled into a useable format to run them. This activity uses an API explorer web-basedtool (similar to Postman, a popular API development tool) that easily assembles the credentials, API call andparameters to give the full cURL or PowerShell command to test with.

Note: cURL is a command-line tool used commonly used by developers to send common internetprotocols within scripts. PowerShell is a common Microsoft scripting language.

In this activity you will perform four simple operations before you test:

• Section 1 - Validate API Credentials.• Section 2 - Choose an API Function.• Section 3 - Set Parameters for that specific Function.• Section 4 - Create an API call.

https://services.cloud.netapp.com/developer-hub

https://services.cloud.netapp.com/developer-hub


Figure 4-16: API Explorer 4 Sections

Once the API call is assembled, you can choose how to interact with the API based on your desired programminglanguage. This example uses two methods: (1) curl, on Linux OS and (2) PowerShell on Microsoft Windows.Copy the full command to the clipboard, then paste it into a command line to execute the call.

This activity illustrates how many of the common UI functions can be scripted using API calls, and delivered in aprogramming languange used by command line Linux or Microsoft Windows. In a similar modular fashion thesesame API calls can be assembled and used in a web application to perform the same HTTP requests.

1. Double-click on the API Explorer shortcut on the desktop of the Jumphost. This will open a browsersession in Incognito mode.


Note: Incognito mode will allow you to login as a different local user in a later part of this lab.

Figure 4-17:

2. Under Section 1, notice that your programmatic access credentials (API key, Secret Key and the BaseURL) are all preloaded, click Validate Credentials.

2Figure 4-18:

3. Under Section 2, choose a function. Start by creating a new CVS volume. Under “Filesystems”, click[POST} for /v1/FileSystems.

3

Figure 4-19:

4. Scroll down to Section 3, and view the Parameters. Some have been hard-coded in this UI to ensure thecall will work. You will explore the benefits of this in the next activity.


Note: “Creation Token” is the parameter used for a unique export/mount name (NFS) and/orshare name (SMB).

5. Under Section 4, you can see the assembled API call in cURL (can be run from Linux), or PowerShell(can be run from the Jumphost Windows powershell UI).

4

5

Figure 4-20:

6. Before you execute the command, double-click on the Cloud Volumes Service Simulator Session 2shortcut on the desktop of the Jumphost.

7. Use a local login with credentials username apiExplorer and password Netapp1!.


7

Figure 4-21:

8. Note that only one volume is present.

8

Figure 4-22:

9. Return to the API explorer window, highlight the entire command in the PowerShell box, right-click thetext and select copy to copy the API call for Powershell.

Note: Optionally you may choose to run the curl commands in Linux which will be demonstratedin the next part of this activity.

10. Open PowerShell.


9

10

Figure 4-23:

11. Paste the command in the PowerShell window.

11

Figure 4-24:

12. After pressing Enter, observe the output generates a status code of “202” and description of“Accepted”.


12

Figure 4-25:

13. Return to the Cloud Volumes Service UI and refresh the browser to see the new volume.

13

Figure 4-26:

14. Now perform the same steps to create a volume from a snapshot. Return to the “API Explorer” tab, andsince the credentials are still being stored, scroll down to Section 2 under the “Snapshots” section, andclick on [POST] /v1/FileSystems.


14

Figure 4-27:

15. Scroll to Section 3 to see the parameters. Change the “Volume Name” to demo volume fromsnapshot.

16. Change the “Creation Token” to something unique, api-demo-volume-from-ss.17. Under “SnapshotId”, select the API-explorer-snapshots 5f0d....


15 16

17

Figure 4-28:

18. Go to the CVS UI and click Volumes.19. There are only two volumes.

18

19

Figure 4-29:

20. Return to Section 4 of the API Explorer, , highlight the entire command in the curl box, right-click thetext and select copy to copy the API call for curl.

Note: If you wish to continue using PowerShell, perform the same steps using the PowerShellcode.

21. Click the PuTTy icon either on the taskbar, or the shortcut on the desktop.


20

21

Figure 4-30:

22. Launch an SSH session to the NFS Client to execute the curl API call.

22

Figure 4-31:

23. Log in as root and password Netapp1!.24. Right-click to paste the curl call into the SSH session.


2324

Figure 4-32:

25. Press Enter and the output displays.

Figure 4-33:

26. Return to the CVS UI. Click Volumes, and refresh the browser to see that the new volume created froma snapshot using the API call from curl is now listed.


26

Figure 4-34:

In this activity you used the API interface to create two volumes, one that was from an existing snapshot.

4.4 Show how API calls can be utilizedThere are many reasons to consider API functionality to enhance service delivery of cloud-connected flashstorage. This lab activity explores an example customer use case.

DevOps with CVS Scenario: A software company utilizes cloud compute for their software development.They recently moved all of their storage to Cloud Volumes Service to take advantage of the high performantstorage at a reduced cost. Cloud Administrators have become very comfortable using the Cloud Volumes ServiceUI to provision data and code sets in seconds, and even make use of the snapshots or clones for even moretime-saving storage features. But developer requests in the ticketing system for storage related operations aregrowing. The Cloud Administrators find themselves repeatedly performing the same functions for developers.Developers want a self-service way to manage their development testing to speed up their time-to-market.

Requirement: Use the company's homegrown service catalog web portal to deliver a simplified self-provisioninginterface for developers to perform their job duties, while obscuring the parameters that the Cloud Administratorsdo not want changed.

The developer workflow needs to be able to:

• Get snapshots named in a specific format for testing from a prestaged CVS, initially built by the CloudAdministrator with a base dataset.

• Create base snapshot versions of the original datastore.• Clone from snapshots of datasets.• View mounting instructions to connect cloud compute.• Revert volume to a snapshot to reset to a point in time.• List CVS volumes to see what testing is going on.• Take a snapshot of the volume and name it something unique.• Destroy a CVS snapshot.

Not required by the developer workflow:

• Allocated capacity can be fixed because the relative size of the dataset remains the same.• The developer does not need to worry about service levels for integration, or regression testing.• The developer works from one region, and only wants their dataset in the region for their compute.

Solution: The Cloud Administrator develops API calls to be integrated into the service catalog web portal to offeran integrated and simplified programmatic way for the developer to get what they need without actually using theCVS UI. This allows the developer to provision cloud connected flash to meet their needs from a web application,


while at the same time giving control to the Cloud Administrator to determine what parameters the developer canchange. This also allows for a completely custom experience changing buttons and terminology to meet the usecase that works for the user.

1. Double-click on the Service Catalog shortcut on the desktop of the Jumphost. This will open a browsersession in Incognito mode.

Figure 4-35:

2. You will notice that this UI looks completely different from the CVS UI. This is an example of a customapplication, in this case a web portal for self-service, that the Cloud Administrator has specifically builtfor the developers. This allows developers to self-provision and manage storage for their needs in astandard and consistent way. Examine what is happening behind the custom portal with the API calls.

2

Figure 4-36:

3. If you are still logged into the CVS UI, logout as the apiExplorer user if the session has not timed out.


3

Figure 4-37:

4. Double-click on the Cloud Volumes Service Simulator Session 2 shortcut on the desktop of theJumphost, and log into the CVS UI using the local login of username: cloudadmin, and passwordNetapp1! to see what is happening with each API call.


4

Figure 4-38:

5. After logging in you will see that the Cloud Administrator has set up two application repositories asstarting points for the developers that will be using the custom portal.

5

Figure 4-39:

6. Click Snapshots and notice that there are two staged Snapshots ready for use by the new portal.


6

Figure 4-40:

7. Return to the Service Catalog portal browser tab.8. In the "Applications" section, click on the Repository drop-down and select one of the two existing

repository volumes.

Note: This dropdown is populated by the execution of a GET /v1/FileSystems API call.9. Also in the "Applications" section, click on the Available Versions drop-down and select the specific

version of the repository. In this lab activity there is only one version.

Note: This dropdown is populated by the execution of a GET /v1/FileSystems/{fileSystemId}/Snapshots API call.

10. Click the Create dev copy button to create a development copy of the selected repository and version.

Note: This action will take the results of the previous action and perform a POST /v1/FileSystems/{fileSystemId}/Snapshot API call.


8

910

Figure 4-41:

11. Moving to the "Development" section of the demonstration custom portal, developers can now makeuse of what they pulled from the source repositories (volumes) and available versions (snapshots)that the Cloud Administrator maintains and presents to them. Having clicked “Create dev copy” in theprevious step made the cloud volume available in “My development copies” drop-down.

12. Under “My development copies” the developer can view a drop-down list of copies they have created.Click the drop-down to select the entry, though at this point there will be only one choice.

Note: This dropdown is populated by the execution of a GET /v1/FileSystems/{fileSystemId}API call.


11

12

Figure 4-42:

13. The developer might need to know how mount and access this volume from their server. Click theShow mount instructions button to provide detailed steps. Click Close.

Note: This action takes the snapshot ID from the dropdown above to perform a GET /v1/FileSystems/{fileSystemId}/MountTargets.


13

Figure 4-43:

14. The “Commit” button gives the developer the ability to take their own snapshot during development.

Note: this action performs a POST /v1/FileSystems/{fileSystemId}/Snapshot APIcall.

The Cloud Administrator provides a standard naming structure with each API request that helpspopulate the drop-down for the next step in the workflow.

15. Once the developer is ready to test, they have the ability to manage the lifecycle of those test copies.Click Create a test copy to simulate.


14

15

Figure 4-44:

16. Run through as a developer performing some commits, create, and delete test copies. Then return tothe Cloud Volumes Service UI and use the local login as the Cloud Administrator who is managing theCVS UI, to see what is happening when the actions are performed. Take note of the standard formatof naming, and how the parameters of service level, volume size, and in some cases, custom naminghave been standardized by the Cloud Administrator to ensure uniformity for each developer.

16

Figure 4-45:

Now consider the flexiblity that NetApp Data Fabric brings. During the software development process, the latesttest results need to be archived and be accessible to other software developers. The Cloud Administrator and thedeveloper use Cloud Sync to put a copy in an S3 bucket accessible by those who reference the test results toimprove their software delivery and time-to-market. For more information visit: https://cloud.netapp.com/devops.

https://cloud.netapp.com/devops


This lab activity is a simple demonstration of how APIs can be used not only to automate from scripting (aslearned in the previous exercises), but how API calls can be leveraged in third-party applications. This allows onlythe necessary parameters to be exposed to and completed by the user, which can help control costs. This type ofintegration, along with scripting, allows for more widespread use of CVS for other users beyond just the suppliedUI from NetApp.


5 Lab LimitationsThis lab uses a non-production version of the NetApp Service Delivery Engine (SDE), along with an simulator forcloud connected flash. Compute resources from a hyperscaler are mimicked with an in-lab Linux system.


6 ReferencesThe following resources provide additional information that relate to this lab:

• NetApp Cloud Central• What are Cloud Volumes?• NetApp Cloud Volumes Service for AWS documentation


https://www.netapp.com/us/products/cloud-storage/cloud-volumes/index.aspx

https://docs.netapp.com/us-en/cloud_volumes/aws/index.html


7 Version History

Version Date Document Version History

Version 1.1.0 August 2018 Version with Cloud Volumes 1.0.65 and Cloud Sync

Version 1.1.1 August 2018 Minor clarificiation edits

Version 1.1.2 October 2018 Updated some text added API demo section

Version 1.1.3 October 2018 Update Cloud Volumes and Cloud Sync

Version 1.1.4 November 2018 Minor corrections

Version 1.1.5 December 2018 Minor clarification to Sync Data activity

Refer to the Interoperability Matrix Tool (IMT) on the NetApp Support site to validate that the exactproduct and feature versions described in this document are supported for your specific environment.The NetApp IMT defines the product components and versions that can be used to constructconfigurations that are supported by NetApp. Specific results depend on each customer's installation inaccordance with published specifications.

NetApp provides no representations or warranties regarding the accuracy, reliability, or serviceability of anyinformation or recommendations provided in this publication, or with respect to any results that may be obtainedby the use of the information or observance of any recommendations provided herein. The information in thisdocument is distributed AS IS, and the use of this information or the implementation of any recommendations ortechniques herein is a customer’s responsibility and depends on the customer’s ability to evaluate and integratethem into the customer’s operational environment. This document and the information contained herein may beused solely in connection with the NetApp products discussed in this document.

Go further, faster®

© 2019NetApp, Inc. All rights reserved. No portions of this document may be reproduced without prior written consentof NetApp, Inc. Specifications are subject to change without notice. NetApp, the NetApp logo, Data ONTAP®,ONTAP®, OnCommand®, SANtricity®, FlexPod®, SnapCenter®, and SolidFire® are trademarks or registeredtrademarks of NetApp, Inc. in the United States and/or other countries. All other brands or products are trademarks orregistered trademarks of their respective holders and should be treated as such.

http://support.netapp.com/matrix/mtx/login.do

getting started with cloud volumes service · note: netapp data brokers make use of the cloud sync...

Documents