Skip to content

Commit 765bdbf

Browse files
committed
adds example blueprint documentation and doc updates
1 parent fa14c59 commit 765bdbf

File tree

3 files changed

+66
-8
lines changed

3 files changed

+66
-8
lines changed

examples/README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ md_toc github examples/README.md | sed -e "s/\s-\s/ * /"
6161
* [gke-tpu-v6](#gke-tpu-v6--) ![community-badge] ![experimental-badge]
6262
* [xpk-n2-filestore](#xpk-n2-filestore--) ![community-badge] ![experimental-badge]
6363
* [gke-h4d](#gke-h4d-) ![core-badge]
64+
* [netapp-volumes.yaml](#netapp-volumesyaml--) ![community-badge]
6465
* [Blueprint Schema](#blueprint-schema)
6566
* [Writing an HPC Blueprint](#writing-an-hpc-blueprint)
6667
* [Blueprint Boilerplate](#blueprint-boilerplate)
@@ -1489,6 +1490,61 @@ This blueprint uses GKE to provision a Kubernetes cluster and a H4D node pool, a
14891490

14901491
[gke-h4d]: ../examples/gke-h4d
14911492

1493+
### [netapp-volumes.yaml] ![core-badge]
1494+
1495+
This blueprint demonstrates how to provision NFS volumes as shares filesystems for compute VMs, using Google Cloud NetApp Volumes. It can be used as an alternative to FileStore in blueprints.
1496+
1497+
NetApp Volumes is a first-party Google service that provides NFS and/or SMB shared file-systems to VMs. It offers advanced data management capabilities and highly scalable capacity and performance.
1498+
1499+
NetApp Volume provides:
1500+
1501+
* robust support for NFSv3, NFSv4.x and SMB 2.1 and 3.x
1502+
* a [rich feature set][service-levels]
1503+
* scalable [performance](https://cloud.google.com/netapp/volumes/docs/performance/performance-benchmarks)
1504+
* FlexCache: Caching of ONTAP-based volumes to provide high-throughput and low latency read access to compute clusters of on-premises data
1505+
* [Auto-tiering](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/manage-auto-tiering) of unused data to optimse cost
1506+
1507+
Support for NetApp Volumes is split into two modules.
1508+
1509+
* **netapp-storage-pool** provisions a [storage pool](https://cloud.google.com/netapp/volumes/docs/configure-and-use/storage-pools/overview). Storage pools are pre-provisioned storage capacity containers which host volumes. A pool also defines fundamental properties of all the volumes within, like the region, the attached network, the [service level][service-levels], CMEK encryption, Active Directory and LDAP settings.
1510+
* **netapp-volume** provisions a [volume](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/overview) inside an existing storage pool. A volume file-system container which is shared using NFS or SMB. It provides advanced data management capabilities.
1511+
1512+
You can provision multiple volumes in a pool. For service levels Standard, Premium and Extreme the throughput capability depends on volume size and service level. Every GiB of provisioned volume space adds 16/64/128 KiBps of throughput capability.
1513+
1514+
#### Steps to deploy the blueprint
1515+
1516+
To provision the bluebrint, please run:
1517+
1518+
```shell
1519+
./gcluster create examples/netapp-volumes.yaml --vars "project_id=${GOOGLE_CLOUD_PROJECT}"
1520+
./gcluster deploy netapp-volumes
1521+
```
1522+
1523+
After the blueprint deployed, you can login the to VM created:
1524+
1525+
```shell
1526+
gcloud compute ssh --zone "us-central1-a" "netapp-volumes-0" --project ${GOOGLE_CLOUD_PROJECT} --tunnel-through-iap
1527+
```
1528+
1529+
A NetApp Volumes volume was provisioned and mounted to /home in all the provisioned VMs. A home directory for your user is created automatically:
1530+
1531+
```shell
1532+
pwd
1533+
df -h -t nfs
1534+
```
1535+
1536+
#### Clean Up
1537+
To destroy all resources associated with creating the GKE cluster, from Cloud Shell run the following command:
1538+
1539+
```sh
1540+
./gcluster destroy netapp-volumes
1541+
```
1542+
1543+
[netapp-storage-pool]: ../netapp-storage-pool/README.md
1544+
[service-levels]: https://cloud.google.com/netapp/volumes/docs/discover/service-levels
1545+
[auto-tiering]: https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/manage-auto-tiering
1546+
[netapp-volumes.yaml]: ../examples/netapp-volumes.yaml
1547+
14921548
## Blueprint Schema
14931549

14941550
Similar documentation can be found on

modules/file-system/netapp-storage-pool/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
## Description
22

33
This module creates a [Google Cloud NetApp Volumes](https://cloud.google.com/netapp/volumes/docs/discover/overview)
4-
storage pool. NetApp Volumes is a fully managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance. It provides filesystems shared through the NFSv3, NFSv4.x and the SMB protocols.
4+
storage pool.
55

6+
NetApp Volumes is a first-party Google service that provides NFS and/or SMB shared file-systems to VMs. It offers advanced data management capabilities and highly scalable capacity and performance.
67
NetApp Volume provides:
78

89
- robust support for NFSv3, NFSv4.x and SMB 2.1 and 3.x
910
- a [rich feature set][service-levels]
1011
- scalable [performance](https://cloud.google.com/netapp/volumes/docs/performance/performance-benchmarks)
11-
- Caching of ONTAP-based volumes to provide high-throughput and low latency read access to compute clusters of on-premises data
12+
- FlexCache: Caching of ONTAP-based volumes to provide high-throughput and low latency read access to compute clusters of on-premises data
1213
- [Auto-tiering](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/manage-auto-tiering) of unused data to optimse cost
1314

1415
Support for NetApp Volumes is split into two modules.
1516

16-
- **netapp-storage-pool** provisions a [storage pool](https://cloud.google.com/netapp/volumes/docs/configure-and-use/storage-pools/overview). Storage pools are pre-provisioned storage capacity containers which host filesystems called volumes. Volumes are provisioned using the [netapp-volume module](../netapp-volume/README.md). A pool also defined fundamental properties of all the volumes within, like the region, the attached network, the [service level][service-levels], CMEK encryption, Active Directory and LDAP settings.
17-
- **netapp-volume** provisions a [volume](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/overview) inside an existing storage pool. A volume is a shared file-system. It can be shared using NFS and SMB protocols and provides scalabale performance.
17+
- **netapp-storage-pool** provisions a [storage pool](https://cloud.google.com/netapp/volumes/docs/configure-and-use/storage-pools/overview). Storage pools are pre-provisioned storage capacity containers which host volumes. A pool also defines fundamental properties of all the volumes within, like the region, the attached network, the [service level][service-levels], CMEK encryption, Active Directory and LDAP settings.
18+
- **netapp-volume** provisions a [volume](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/overview) inside an existing storage pool. A volume file-system container which is shared using NFS or SMB. It provides advanced data management capabilities.
1819

1920
For more information on this and other network storage options in the Cluster
2021
Toolkit, see the extended [Network Storage documentation](../../../docs/network_storage.md).

modules/file-system/netapp-volume/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
## Description
22

33
This module creates a [Google Cloud NetApp Volumes](https://cloud.google.com/netapp/volumes/docs/discover/overview)
4-
volume. NetApp Volumes is a fully managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance. It provides filesystems shared through the NFSv3, NFSv4.x and the SMB protocols.
4+
volume.
55

6+
NetApp Volumes is a first-party Google service that provides NFS and/or SMB shared file-systems to VMs. It offers advanced data management capabilities and highly scalable capacity and performance.
67
NetApp Volume provides:
78

89
- robust support for NFSv3, NFSv4.x and SMB 2.1 and 3.x
910
- a [rich feature set][service-levels]
1011
- scalable [performance](https://cloud.google.com/netapp/volumes/docs/performance/performance-benchmarks)
11-
- Caching of ONTAP-based volumes to provide high-throughput and low latency read access to compute clusters of on-premises data
12+
- FlexCache: Caching of ONTAP-based volumes to provide high-throughput and low latency read access to compute clusters of on-premises data
1213
- [Auto-tiering](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/manage-auto-tiering) of unused data to optimse cost
1314

1415
Support for NetApp Volumes is split into two modules.
1516

16-
- **netapp-storage-pool** provisions a [storage pool](https://cloud.google.com/netapp/volumes/docs/configure-and-use/storage-pools/overview). Storage pools are pre-provisioned storage capacity containers which host filesystems called volumes. Volumes are provisioned using the [netapp-volume module](../netapp-volume/README.md). A pool also defined fundamental properties of all the volumes within, like the region, the attached network, the [service level][service-levels], CMEK encryption, Active Directory and LDAP settings.
17-
- **netapp-volume** provisions a [volume](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/overview) inside an existing storage pool. A volume is a shared file-system. It can be shared using NFS and SMB protocols and provides scalabale performance.
17+
- **netapp-storage-pool** provisions a [storage pool](https://cloud.google.com/netapp/volumes/docs/configure-and-use/storage-pools/overview). Storage pools are pre-provisioned storage capacity containers which host volumes. A pool also defines fundamental properties of all the volumes within, like the region, the attached network, the [service level][service-levels], CMEK encryption, Active Directory and LDAP settings.
18+
- **netapp-volume** provisions a [volume](https://cloud.google.com/netapp/volumes/docs/configure-and-use/volumes/overview) inside an existing storage pool. A volume file-system container which is shared using NFS or SMB. It provides advanced data management capabilities.
1819

1920
For more information on this and other network storage options in the Cluster
2021
Toolkit, see the extended [Network Storage documentation](../../../docs/network_storage.md).

0 commit comments

Comments
 (0)