generated from kyma-project/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add NFS feature description #918
Open
mmitoraj
wants to merge
8
commits into
kyma-project:main
Choose a base branch
from
mmitoraj:features-descr
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c976af5
Add NFS feature description
mmitoraj 323d882
Add Redis feature description
mmitoraj f625f40
Apply review suggestions
mmitoraj 95ebfe5
Apply Dusan's suggestions
mmitoraj 08694c2
Fix
mmitoraj ad3eaf5
Change order
mmitoraj b8da0e4
Add input for the VPC peering feature
mmitoraj 5e74609
Unify the section titles across the topics
mmitoraj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,61 @@ | ||
| # NFS | ||
|
|
||
| ## Overview | ||
|
|
||
| The Cloud Manager module provides a Network File System (NFS) feature which allows you to create ReadWriteMany (RWX) volumes. RWX volumes can be used by multiple workloads. | ||
|
|
||
| When you create an NFS instance in Kyma, you depend on the cloud provider of your Kyma cluster. The cloud provider in use determines the exact implementation. | ||
|
|
||
| Cloud Manager module supports the NFS feature of two cloud providers: | ||
|
|
||
| * Google Cloud's [Filestore](https://cloud.google.com/filestore?hl=en) | ||
| * Amazon Web Services [Amazon Elastic File System](https://aws.amazon.com/efs/) | ||
|
|
||
| You can configure Cloud Manager's NFS instances using the NFS custom resource corresponding with the cloud provider for your Kyma cluster, namely GcpNfsVolume CR or AwsNfsVolume CR. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To instantiate NFS, an IpRange CR must exist in the Kyma cluster. IpRange defines network address space reserved for your cloud provider's NFS resources. If you don't create the IpRange CR manually, Cloud Manager creates a default IpRange CR with the default address space and Classless Inter-Domain Routing (CIDR) selected. For more information, see [IpRange Custom Resoucre](./resources/04-10-iprange.md). | ||
|
|
||
| ## Lifecycle | ||
|
|
||
| GcpNfsVolume and AwsNfsVolume are namespace-level CRs. Once you create a GcpNfsVolume or AwsNfsVolume resource, the following are also created automatically: | ||
|
|
||
| * IpRange CR | ||
| * IpRange is a cluster-level CR. | ||
| * Only one IpRange CR can exist per cluster. | ||
| * If you don't want the default IpRange to be used, create one manually. | ||
| * Persistent Volume (PV) | ||
| * PV is a cluster-level piece of storage. | ||
| * The PV uses a unique name based on the NFS instance status ID. | ||
| * The PV references the instantiated NFS in the respective cloud provider. | ||
| * Persistent Volume Claim (PVC) | ||
| * PVC is a namespace-level resource created in the same namespace as the IpRange CR. | ||
| * By default, the PVC's name is the same as the name of your NFS instance unless you specify a different name. | ||
| * The PVC references the automatically created PV. | ||
|
|
||
| ## Cloud Providers' Specifics | ||
|
|
||
| ### Google Cloud Kyma Clusters | ||
|
|
||
| Kyma clusters provisioned on Google Cloud use Filestore as the underlying NFS. See the following list of all CRs available in the Cloud Manager module dedicated to Google Cloud Filestore: | ||
|
|
||
| * GcpNfsVolume CR | ||
| * GcpNfsVolumeBackup | ||
| * GcpNfsBackupSchedule | ||
| * GcpNfsVolumeRestore | ||
|
|
||
| ### Amazon Web Services Kyma Cluster | ||
|
|
||
| Kyma clusters provisioned on Amazon Web Services use Amazon Elastic File System. See the following list of CRs available in the Cloud Manager module dedicated to Amazon Elastic File System: | ||
|
|
||
| * AwsNfsVolume CR | ||
| * AwsNfsVolumeBackup | ||
| * AwsNfsBackupSchedule | ||
| * AwsNfsVolumeRestore | ||
|
|
||
| ## Related information | ||
|
|
||
| * [Cloud Manager Resources: NFS](./resources/README.md#nfs). | ||
| * [Tutorials](./tutorials/README.md). | ||
| * Pricing (link TBD) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ngrkajac please provide the sentence about the standard setup and the benefit of the NFS feature over the standard approach
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will wait for Nikola's comment here as the product owner. But what you mentioned above is clear and on the point. NFS is not the feature here, it is just the protocol. ReadWriteMany is the feature, and as you mentioned RWX volumes can be used by multiple workloads. While regular persistent disk volumes can't be shared and can be used by only a single workload.