From 30ea87f39f742e440f137c276c89905c614dc243 Mon Sep 17 00:00:00 2001 From: Amir Balaie Date: Tue, 9 Jul 2024 17:18:10 -0700 Subject: [PATCH 1/5] docs: user tutorial for GCP NFS --- docs/user/05-glossary.md | 33 +-- .../user/resources/04-30-10-gcp-nfs-volume.md | 32 +-- docs/user/tutorials/01-20-gcp-nfs-volume.md | 190 ++++++++++++++++++ docs/user/tutorials/README.md | 1 + 4 files changed, 225 insertions(+), 31 deletions(-) create mode 100644 docs/user/tutorials/01-20-gcp-nfs-volume.md diff --git a/docs/user/05-glossary.md b/docs/user/05-glossary.md index dd69807ae..87ff5ea55 100644 --- a/docs/user/05-glossary.md +++ b/docs/user/05-glossary.md @@ -3,19 +3,20 @@ > [!TIP] > The terms in the list are ordered alphabetically. -| Term | Description | Useful links | -|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| -| AWS | Amazon Web Services is a subsidiary of Amazon that provides on-demand cloud computing platforms and APIs. | [Amazon Web Services, Inc.](https://aws.amazon.com/) | -| AWS EFS | Amazon Elastic File System is a cloud storage service provided by Amazon Web Services designed to provide scalable, elastic, concurrent with some restrictions, and encrypted file storage that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [Amazon Elastic File System](https://aws.amazon.com/efs/) | -| Azure | Microsoft Azure, or just Azure, is the cloud computing platform developed by Microsoft. It offers management, access and development of applications and services to individuals, companies, and governments through its global infrastructure. | [Microsoft Azure](https://azure.microsoft.com/) | -| CIDR | Classless Inter-Domain Routing is a bitwise, prefix-based standard for the representation of IP address ranges. It facilitates routing by allowing blocks of addresses to be grouped into single entry. | [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) | -| Cloud | Cloud computing is the on-demand availability of computer system resources, especially data storage and computing power, without direct active management by the user. Large clouds often have functions distributed over multiple locations, each of which is a data center. | | -| Cloud provider | An IT company that provides on-demand, scalable computing resources like computing power, data storage, or applications over the internet. | | -| Cloud resources | A virtualized environment or IT service provided by the Cloud provider, like compute, data storage, analytics... | | -| GCP | Google Cloud Platform, offered by Google, is a suite of cloud computing services that provides a series of modular cloud services including computing, data storage, data analytics, and machine learning, alongside a set of management tools. | [Google Cloud Platform](https://cloud.google.com/) | -| GCP Filestore | A managed GCP file storage service for cloud applications that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [GCP file storage service](https://cloud.google.com/filestore?hl=en) | -| IP Address | Internet Protocol address is a unique address that identifies a device on the internet or a local network. | | -| IP Address range | A set of consecutive IP addresses, usually a network routing target expressed in the CIDR notation. | | -| Network routing | The process of selecting a path from source to destination node across one or more networks. | | -| RWX | Persistent Volume ReadWriteMany access mode. | [Kubernetes Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#introduction) | -| VPC Network | Virtual Private Cloud network is a virtual version of a physical network that is implemented inside the cloud provider production network by using special netowrk virtualization software. | | +| Term | Description | Useful links | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| AWS | Amazon Web Services is a subsidiary of Amazon that provides on-demand cloud computing platforms and APIs. | [Amazon Web Services, Inc.](https://aws.amazon.com/) | +| AWS EFS | Amazon Elastic File System is a cloud storage service provided by Amazon Web Services designed to provide scalable, elastic, concurrent with some restrictions, and encrypted file storage that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [Amazon Elastic File System](https://aws.amazon.com/efs/) | +| Azure | Microsoft Azure, or just Azure, is the cloud computing platform developed by Microsoft. It offers management, access and development of applications and services to individuals, companies, and governments through its global infrastructure. | [Microsoft Azure](https://azure.microsoft.com/) | +| CIDR | Classless Inter-Domain Routing is a bitwise, prefix-based standard for the representation of IP address ranges. It facilitates routing by allowing blocks of addresses to be grouped into single entry. | [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) | +| Cloud | Cloud computing is the on-demand availability of computer system resources, especially data storage and computing power, without direct active management by the user. Large clouds often have functions distributed over multiple locations, each of which is a data center. | | +| Cloud provider | An IT company that provides on-demand, scalable computing resources like computing power, data storage, or applications over the internet. | | +| Cloud resources | A virtualized environment or IT service provided by the Cloud provider, like compute, data storage, analytics... | | +| GCP | Google Cloud Platform, offered by Google, is a suite of cloud computing services that provides a series of modular cloud services including computing, data storage, data analytics, and machine learning, alongside a set of management tools. | [Google Cloud Platform](https://cloud.google.com/) | +| GCP Filestore | A managed GCP file storage service for cloud applications that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [GCP file storage service](https://cloud.google.com/filestore?hl=en) | +| IP Address | Internet Protocol address is a unique address that identifies a device on the internet or a local network. | | +| IP Address range | A set of consecutive IP addresses, usually a network routing target expressed in the CIDR notation. | | +| Network routing | The process of selecting a path from source to destination node across one or more networks. | | +| NFS | Network File System is a network file sharing protocol that defines the way files are stored and retrieved from storage devices across networks. | | +| RWX | Persistent Volume ReadWriteMany access mode. | [Kubernetes Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#introduction) | +| VPC Network | Virtual Private Cloud network is a virtual version of a physical network that is implemented inside the cloud provider production network by using special netowrk virtualization software. | | diff --git a/docs/user/resources/04-30-10-gcp-nfs-volume.md b/docs/user/resources/04-30-10-gcp-nfs-volume.md index 18758df1d..7e900a92c 100644 --- a/docs/user/resources/04-30-10-gcp-nfs-volume.md +++ b/docs/user/resources/04-30-10-gcp-nfs-volume.md @@ -31,20 +31,22 @@ This table lists the parameters of the given resource together with their descri **Spec:** -| Parameter | Type | Description | -|-----------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **ipRange** | object | Optional IpRange reference. If omitted, default IpRange will be used, if default IpRange does not exist, it will be created | -| **ipRange.name** | string | Name of the existing IpRange to use. | -| **capacityGb** | int | Capacity of the provisioned volume. | -| **tier** | string | The GCP Filestore tier configuration option. One of `generalPurpose`, `maxIO`. Defaults to `generalPurpose`. | -| **volume** | object | The PersistentVolume options. Optional. | -| **volume.name** | string | The PersistentVolume name. Optional. Defaults to the name of the AwsNfsVolume resource. | -| **volume.labels** | map\[string\]string | The PersistentVolume labels. Optional. Defaults to nil. | -| **volume.annotations** | map\[string\]string | The PersistentVolume annotations. Optional. Defaults to nil. | -| **volumeClaim** | object | The PersistentVolumeClaim options. Optional. | -| **volumeClaim.name** | string | The PersistentVolumeClaim name. Optional. Defaults to the name of the AwsNfsVolume resource. | -| **volumeClaim.labels** | map\[string\]string | The PersistentVolumeClaim labels. Optional. Defaults to nil. | -| **volumeClaim.annotations** | map\[string\]string | The PersistentVolumeClaim annotations. Optional. Defaults to nil. | +| Parameter | Type | Description | +|-----------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| **ipRange** | object | Optional IpRange reference. If omitted, default IpRange will be used, if default IpRange does not exist, it will be created. | +| **ipRange.name** | string | Name of the existing IpRange to use. | +| **capacityGb** | int | Capacity of the provisioned volume in GiB. | +| **location** | string | The zone (for zonal tiers) or the region (for regional tiers) where GCP Filestore will reside. | +| **tier** | string | The GCP Filestore tier configuration option. Defaults to `BASIC_HDD`. | +| **fileShareName** | string | The name of the file share option. Defaults to `vol1`. A file share is the directory on a Filestore instance where all shared files are stored. | +| **volume** | object | The PersistentVolume options. Optional. | +| **volume.name** | string | The PersistentVolume name. Optional. Defaults to the name of the AwsNfsVolume resource. | +| **volume.labels** | map\[string\]string | The PersistentVolume labels. Optional. Defaults to nil. | +| **volume.annotations** | map\[string\]string | The PersistentVolume annotations. Optional. Defaults to nil. | +| **volumeClaim** | object | The PersistentVolumeClaim options. Optional. | +| **volumeClaim.name** | string | The PersistentVolumeClaim name. Optional. Defaults to the name of the AwsNfsVolume resource. | +| **volumeClaim.labels** | map\[string\]string | The PersistentVolumeClaim labels. Optional. Defaults to nil. | +| **volumeClaim.annotations** | map\[string\]string | The PersistentVolumeClaim annotations. Optional. Defaults to nil. | **Status:** @@ -70,7 +72,7 @@ metadata: name: my-vol spec: capacityGb: 1024 - tier: ENTERPRISE + location: us-west1 --- apiVersion: v1 kind: Pod diff --git a/docs/user/tutorials/01-20-gcp-nfs-volume.md b/docs/user/tutorials/01-20-gcp-nfs-volume.md new file mode 100644 index 000000000..382d97c93 --- /dev/null +++ b/docs/user/tutorials/01-20-gcp-nfs-volume.md @@ -0,0 +1,190 @@ +# Use RWX Volumes in GCP + +This tutorial explains how to create ReadWriteMany (RWX) volumes in Google Cloud Platform (GCP). You can use the created RWX volume from multiple workloads. + +## Steps + +1. Create a namespace and export its value as an environment variable. Run: + + ```shell + export NAMESPACE={NAMESPACE_NAME} + kubectl create ns $NAMESPACE + ``` + +2. Create an GcpNfsVolume resource. + + ```shell + cat < [!NOTE] + > If you have other cloud resources using the default IpRange, + > skip this step, and do not delete the default IpRange. + + ```shell + kubectl delete iprange default + ``` + + * Remove the created namespace: + ```shell + kubectl delete namespace $NAMESPACE + ``` diff --git a/docs/user/tutorials/README.md b/docs/user/tutorials/README.md index da23a7149..04a11c3f2 100644 --- a/docs/user/tutorials/README.md +++ b/docs/user/tutorials/README.md @@ -3,3 +3,4 @@ Browse the Cloud Manager tutorials to learn how to create and use cloud resources. * [Use RWX Volumes in AWS](./01-10-aws-nfs-volume.md) +* [Use RWX Volumes in GCP](./01-20-gcp-nfs-volume.md) From 6293376e391f7e16c9e4ae33dbbaf0f07f039e96 Mon Sep 17 00:00:00 2001 From: Milos Tomic <59831542+tmilos77@users.noreply.github.com> Date: Mon, 15 Jul 2024 14:30:20 +0200 Subject: [PATCH 2/5] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Małgorzata Świeca --- docs/user/tutorials/01-20-gcp-nfs-volume.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/user/tutorials/01-20-gcp-nfs-volume.md b/docs/user/tutorials/01-20-gcp-nfs-volume.md index 382d97c93..779e94fd4 100644 --- a/docs/user/tutorials/01-20-gcp-nfs-volume.md +++ b/docs/user/tutorials/01-20-gcp-nfs-volume.md @@ -69,7 +69,7 @@ This tutorial explains how to create ReadWriteMany (RWX) volumes in Google Cloud Similarly to PV, note the `RWX` access mode and `Bound` status. -6. Create two workloads that both write to the volume +6. Create two workloads that both write to the volume. Run: ```shell cat <[!NOTE] The `File content:` contains prints from both workloads. This demonstrates the ReadWriteMany capability of the volume. -8. Clean up +8. Clean up: * Remove the created workloads: ```shell From 10f4e6f05ded13d000dbcece7c214617f033d8ee Mon Sep 17 00:00:00 2001 From: Amir Balaie Date: Tue, 9 Jul 2024 17:18:10 -0700 Subject: [PATCH 3/5] docs: user tutorial for GCP NFS --- docs/user/00-10-glossary.md | 33 +-- .../user/resources/04-30-10-gcp-nfs-volume.md | 32 +-- docs/user/tutorials/01-20-gcp-nfs-volume.md | 190 ++++++++++++++++++ docs/user/tutorials/README.md | 1 + 4 files changed, 225 insertions(+), 31 deletions(-) create mode 100644 docs/user/tutorials/01-20-gcp-nfs-volume.md diff --git a/docs/user/00-10-glossary.md b/docs/user/00-10-glossary.md index dd69807ae..87ff5ea55 100644 --- a/docs/user/00-10-glossary.md +++ b/docs/user/00-10-glossary.md @@ -3,19 +3,20 @@ > [!TIP] > The terms in the list are ordered alphabetically. -| Term | Description | Useful links | -|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| -| AWS | Amazon Web Services is a subsidiary of Amazon that provides on-demand cloud computing platforms and APIs. | [Amazon Web Services, Inc.](https://aws.amazon.com/) | -| AWS EFS | Amazon Elastic File System is a cloud storage service provided by Amazon Web Services designed to provide scalable, elastic, concurrent with some restrictions, and encrypted file storage that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [Amazon Elastic File System](https://aws.amazon.com/efs/) | -| Azure | Microsoft Azure, or just Azure, is the cloud computing platform developed by Microsoft. It offers management, access and development of applications and services to individuals, companies, and governments through its global infrastructure. | [Microsoft Azure](https://azure.microsoft.com/) | -| CIDR | Classless Inter-Domain Routing is a bitwise, prefix-based standard for the representation of IP address ranges. It facilitates routing by allowing blocks of addresses to be grouped into single entry. | [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) | -| Cloud | Cloud computing is the on-demand availability of computer system resources, especially data storage and computing power, without direct active management by the user. Large clouds often have functions distributed over multiple locations, each of which is a data center. | | -| Cloud provider | An IT company that provides on-demand, scalable computing resources like computing power, data storage, or applications over the internet. | | -| Cloud resources | A virtualized environment or IT service provided by the Cloud provider, like compute, data storage, analytics... | | -| GCP | Google Cloud Platform, offered by Google, is a suite of cloud computing services that provides a series of modular cloud services including computing, data storage, data analytics, and machine learning, alongside a set of management tools. | [Google Cloud Platform](https://cloud.google.com/) | -| GCP Filestore | A managed GCP file storage service for cloud applications that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [GCP file storage service](https://cloud.google.com/filestore?hl=en) | -| IP Address | Internet Protocol address is a unique address that identifies a device on the internet or a local network. | | -| IP Address range | A set of consecutive IP addresses, usually a network routing target expressed in the CIDR notation. | | -| Network routing | The process of selecting a path from source to destination node across one or more networks. | | -| RWX | Persistent Volume ReadWriteMany access mode. | [Kubernetes Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#introduction) | -| VPC Network | Virtual Private Cloud network is a virtual version of a physical network that is implemented inside the cloud provider production network by using special netowrk virtualization software. | | +| Term | Description | Useful links | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| AWS | Amazon Web Services is a subsidiary of Amazon that provides on-demand cloud computing platforms and APIs. | [Amazon Web Services, Inc.](https://aws.amazon.com/) | +| AWS EFS | Amazon Elastic File System is a cloud storage service provided by Amazon Web Services designed to provide scalable, elastic, concurrent with some restrictions, and encrypted file storage that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [Amazon Elastic File System](https://aws.amazon.com/efs/) | +| Azure | Microsoft Azure, or just Azure, is the cloud computing platform developed by Microsoft. It offers management, access and development of applications and services to individuals, companies, and governments through its global infrastructure. | [Microsoft Azure](https://azure.microsoft.com/) | +| CIDR | Classless Inter-Domain Routing is a bitwise, prefix-based standard for the representation of IP address ranges. It facilitates routing by allowing blocks of addresses to be grouped into single entry. | [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) | +| Cloud | Cloud computing is the on-demand availability of computer system resources, especially data storage and computing power, without direct active management by the user. Large clouds often have functions distributed over multiple locations, each of which is a data center. | | +| Cloud provider | An IT company that provides on-demand, scalable computing resources like computing power, data storage, or applications over the internet. | | +| Cloud resources | A virtualized environment or IT service provided by the Cloud provider, like compute, data storage, analytics... | | +| GCP | Google Cloud Platform, offered by Google, is a suite of cloud computing services that provides a series of modular cloud services including computing, data storage, data analytics, and machine learning, alongside a set of management tools. | [Google Cloud Platform](https://cloud.google.com/) | +| GCP Filestore | A managed GCP file storage service for cloud applications that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [GCP file storage service](https://cloud.google.com/filestore?hl=en) | +| IP Address | Internet Protocol address is a unique address that identifies a device on the internet or a local network. | | +| IP Address range | A set of consecutive IP addresses, usually a network routing target expressed in the CIDR notation. | | +| Network routing | The process of selecting a path from source to destination node across one or more networks. | | +| NFS | Network File System is a network file sharing protocol that defines the way files are stored and retrieved from storage devices across networks. | | +| RWX | Persistent Volume ReadWriteMany access mode. | [Kubernetes Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#introduction) | +| VPC Network | Virtual Private Cloud network is a virtual version of a physical network that is implemented inside the cloud provider production network by using special netowrk virtualization software. | | diff --git a/docs/user/resources/04-30-10-gcp-nfs-volume.md b/docs/user/resources/04-30-10-gcp-nfs-volume.md index 18758df1d..7e900a92c 100644 --- a/docs/user/resources/04-30-10-gcp-nfs-volume.md +++ b/docs/user/resources/04-30-10-gcp-nfs-volume.md @@ -31,20 +31,22 @@ This table lists the parameters of the given resource together with their descri **Spec:** -| Parameter | Type | Description | -|-----------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **ipRange** | object | Optional IpRange reference. If omitted, default IpRange will be used, if default IpRange does not exist, it will be created | -| **ipRange.name** | string | Name of the existing IpRange to use. | -| **capacityGb** | int | Capacity of the provisioned volume. | -| **tier** | string | The GCP Filestore tier configuration option. One of `generalPurpose`, `maxIO`. Defaults to `generalPurpose`. | -| **volume** | object | The PersistentVolume options. Optional. | -| **volume.name** | string | The PersistentVolume name. Optional. Defaults to the name of the AwsNfsVolume resource. | -| **volume.labels** | map\[string\]string | The PersistentVolume labels. Optional. Defaults to nil. | -| **volume.annotations** | map\[string\]string | The PersistentVolume annotations. Optional. Defaults to nil. | -| **volumeClaim** | object | The PersistentVolumeClaim options. Optional. | -| **volumeClaim.name** | string | The PersistentVolumeClaim name. Optional. Defaults to the name of the AwsNfsVolume resource. | -| **volumeClaim.labels** | map\[string\]string | The PersistentVolumeClaim labels. Optional. Defaults to nil. | -| **volumeClaim.annotations** | map\[string\]string | The PersistentVolumeClaim annotations. Optional. Defaults to nil. | +| Parameter | Type | Description | +|-----------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| **ipRange** | object | Optional IpRange reference. If omitted, default IpRange will be used, if default IpRange does not exist, it will be created. | +| **ipRange.name** | string | Name of the existing IpRange to use. | +| **capacityGb** | int | Capacity of the provisioned volume in GiB. | +| **location** | string | The zone (for zonal tiers) or the region (for regional tiers) where GCP Filestore will reside. | +| **tier** | string | The GCP Filestore tier configuration option. Defaults to `BASIC_HDD`. | +| **fileShareName** | string | The name of the file share option. Defaults to `vol1`. A file share is the directory on a Filestore instance where all shared files are stored. | +| **volume** | object | The PersistentVolume options. Optional. | +| **volume.name** | string | The PersistentVolume name. Optional. Defaults to the name of the AwsNfsVolume resource. | +| **volume.labels** | map\[string\]string | The PersistentVolume labels. Optional. Defaults to nil. | +| **volume.annotations** | map\[string\]string | The PersistentVolume annotations. Optional. Defaults to nil. | +| **volumeClaim** | object | The PersistentVolumeClaim options. Optional. | +| **volumeClaim.name** | string | The PersistentVolumeClaim name. Optional. Defaults to the name of the AwsNfsVolume resource. | +| **volumeClaim.labels** | map\[string\]string | The PersistentVolumeClaim labels. Optional. Defaults to nil. | +| **volumeClaim.annotations** | map\[string\]string | The PersistentVolumeClaim annotations. Optional. Defaults to nil. | **Status:** @@ -70,7 +72,7 @@ metadata: name: my-vol spec: capacityGb: 1024 - tier: ENTERPRISE + location: us-west1 --- apiVersion: v1 kind: Pod diff --git a/docs/user/tutorials/01-20-gcp-nfs-volume.md b/docs/user/tutorials/01-20-gcp-nfs-volume.md new file mode 100644 index 000000000..382d97c93 --- /dev/null +++ b/docs/user/tutorials/01-20-gcp-nfs-volume.md @@ -0,0 +1,190 @@ +# Use RWX Volumes in GCP + +This tutorial explains how to create ReadWriteMany (RWX) volumes in Google Cloud Platform (GCP). You can use the created RWX volume from multiple workloads. + +## Steps + +1. Create a namespace and export its value as an environment variable. Run: + + ```shell + export NAMESPACE={NAMESPACE_NAME} + kubectl create ns $NAMESPACE + ``` + +2. Create an GcpNfsVolume resource. + + ```shell + cat < [!NOTE] + > If you have other cloud resources using the default IpRange, + > skip this step, and do not delete the default IpRange. + + ```shell + kubectl delete iprange default + ``` + + * Remove the created namespace: + ```shell + kubectl delete namespace $NAMESPACE + ``` diff --git a/docs/user/tutorials/README.md b/docs/user/tutorials/README.md index da23a7149..04a11c3f2 100644 --- a/docs/user/tutorials/README.md +++ b/docs/user/tutorials/README.md @@ -3,3 +3,4 @@ Browse the Cloud Manager tutorials to learn how to create and use cloud resources. * [Use RWX Volumes in AWS](./01-10-aws-nfs-volume.md) +* [Use RWX Volumes in GCP](./01-20-gcp-nfs-volume.md) From c180c9f17f510871f2f411bc20ef1de33a2f918c Mon Sep 17 00:00:00 2001 From: Milos Tomic <59831542+tmilos77@users.noreply.github.com> Date: Mon, 15 Jul 2024 14:30:20 +0200 Subject: [PATCH 4/5] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Małgorzata Świeca --- docs/user/tutorials/01-20-gcp-nfs-volume.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/user/tutorials/01-20-gcp-nfs-volume.md b/docs/user/tutorials/01-20-gcp-nfs-volume.md index 382d97c93..779e94fd4 100644 --- a/docs/user/tutorials/01-20-gcp-nfs-volume.md +++ b/docs/user/tutorials/01-20-gcp-nfs-volume.md @@ -69,7 +69,7 @@ This tutorial explains how to create ReadWriteMany (RWX) volumes in Google Cloud Similarly to PV, note the `RWX` access mode and `Bound` status. -6. Create two workloads that both write to the volume +6. Create two workloads that both write to the volume. Run: ```shell cat <[!NOTE] The `File content:` contains prints from both workloads. This demonstrates the ReadWriteMany capability of the volume. -8. Clean up +8. Clean up: * Remove the created workloads: ```shell From 5a61b029f2e7b9131b2223a5fce192d058a173ac Mon Sep 17 00:00:00 2001 From: Amir Balaie Date: Mon, 15 Jul 2024 15:35:28 -0700 Subject: [PATCH 5/5] Rebase and add GCP NFS tutorial link to sidebar --- docs/user/00-10-glossary.md | 34 +++++++++++++++++----------------- docs/user/_sidebar.md | 1 + 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/user/00-10-glossary.md b/docs/user/00-10-glossary.md index 87ff5ea55..239dd1893 100644 --- a/docs/user/00-10-glossary.md +++ b/docs/user/00-10-glossary.md @@ -3,20 +3,20 @@ > [!TIP] > The terms in the list are ordered alphabetically. -| Term | Description | Useful links | -|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| -| AWS | Amazon Web Services is a subsidiary of Amazon that provides on-demand cloud computing platforms and APIs. | [Amazon Web Services, Inc.](https://aws.amazon.com/) | -| AWS EFS | Amazon Elastic File System is a cloud storage service provided by Amazon Web Services designed to provide scalable, elastic, concurrent with some restrictions, and encrypted file storage that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [Amazon Elastic File System](https://aws.amazon.com/efs/) | -| Azure | Microsoft Azure, or just Azure, is the cloud computing platform developed by Microsoft. It offers management, access and development of applications and services to individuals, companies, and governments through its global infrastructure. | [Microsoft Azure](https://azure.microsoft.com/) | -| CIDR | Classless Inter-Domain Routing is a bitwise, prefix-based standard for the representation of IP address ranges. It facilitates routing by allowing blocks of addresses to be grouped into single entry. | [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) | -| Cloud | Cloud computing is the on-demand availability of computer system resources, especially data storage and computing power, without direct active management by the user. Large clouds often have functions distributed over multiple locations, each of which is a data center. | | -| Cloud provider | An IT company that provides on-demand, scalable computing resources like computing power, data storage, or applications over the internet. | | -| Cloud resources | A virtualized environment or IT service provided by the Cloud provider, like compute, data storage, analytics... | | -| GCP | Google Cloud Platform, offered by Google, is a suite of cloud computing services that provides a series of modular cloud services including computing, data storage, data analytics, and machine learning, alongside a set of management tools. | [Google Cloud Platform](https://cloud.google.com/) | -| GCP Filestore | A managed GCP file storage service for cloud applications that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [GCP file storage service](https://cloud.google.com/filestore?hl=en) | -| IP Address | Internet Protocol address is a unique address that identifies a device on the internet or a local network. | | -| IP Address range | A set of consecutive IP addresses, usually a network routing target expressed in the CIDR notation. | | -| Network routing | The process of selecting a path from source to destination node across one or more networks. | | -| NFS | Network File System is a network file sharing protocol that defines the way files are stored and retrieved from storage devices across networks. | | -| RWX | Persistent Volume ReadWriteMany access mode. | [Kubernetes Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#introduction) | -| VPC Network | Virtual Private Cloud network is a virtual version of a physical network that is implemented inside the cloud provider production network by using special netowrk virtualization software. | | +| Term | Description | Useful links | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| AWS | Amazon Web Services is a subsidiary of Amazon that provides on-demand cloud computing platforms and APIs. | [Amazon Web Services, Inc.](https://aws.amazon.com/) | +| AWS EFS | Amazon Elastic File System is a cloud storage service provided by Amazon Web Services designed to provide scalable, elastic, concurrent with some restrictions, and encrypted file storage that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [Amazon Elastic File System](https://aws.amazon.com/efs/) | +| Azure | Microsoft Azure, or just Azure, is the cloud computing platform developed by Microsoft. It offers management, access and development of applications and services to individuals, companies, and governments through its global infrastructure. | [Microsoft Azure](https://azure.microsoft.com/) | +| CIDR | Classless Inter-Domain Routing is a bitwise, prefix-based standard for the representation of IP address ranges. It facilitates routing by allowing blocks of addresses to be grouped into single entry. | [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) | +| Cloud | Cloud computing is the on-demand availability of computer system resources, especially data storage and computing power, without direct active management by the user. Large clouds often have functions distributed over multiple locations, each of which is a data center. | | +| Cloud provider | An IT company that provides on-demand, scalable computing resources like computing power, data storage, or applications over the internet. | | +| Cloud resources | A virtualized environment or IT service provided by the Cloud provider, like compute, data storage, analytics... | | +| GCP | Google Cloud Platform, offered by Google, is a suite of cloud computing services that provides a series of modular cloud services including computing, data storage, data analytics, and machine learning, alongside a set of management tools. | [Google Cloud Platform](https://cloud.google.com/) | +| GCP Filestore | A managed GCP file storage service for cloud applications that can be mounted by NFS protocol to the Kyma cluster workloads and used in RWX access mode. | [GCP file storage service](https://cloud.google.com/filestore?hl=en) | +| IP Address | Internet Protocol address is a unique address that identifies a device on the internet or a local network. | | +| IP Address range | A set of consecutive IP addresses, usually a network routing target expressed in the CIDR notation. | | +| Network routing | The process of selecting a path from source to destination node across one or more networks. | | +| NFS | Network File System is a network file sharing protocol that defines the way files are stored and retrieved from storage devices across networks. | | +| RWX | Persistent Volume ReadWriteMany access mode. | [Kubernetes Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#introduction) | +| VPC Network | Virtual Private Cloud network is a virtual version of a physical network that is implemented inside the cloud provider production network by using special netowrk virtualization software. | | diff --git a/docs/user/_sidebar.md b/docs/user/_sidebar.md index 4996b28c5..af687c6aa 100644 --- a/docs/user/_sidebar.md +++ b/docs/user/_sidebar.md @@ -7,5 +7,6 @@ * [GcpNfsVolume](/cloud-manager/user/resources/04-30-10-gcp-nfs-volume.md) * [Tutorials](/cloud-manager/user/tutorials/README.md) * [Use RWX Volumes in AWS](/cloud-manager/user/tutorials/01-10-aws-nfs-volume.md) + * [Use RWX Volumes in GCP](/cloud-manager/user/tutorials/01-20-gcp-nfs-volume.md) * [Glossary](/cloud-manager/user/00-10-glossary.md)