Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: Add NFS feature description #918

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

docs: Add NFS feature description #918

wants to merge 8 commits into from

Conversation

mmitoraj
Copy link
Contributor

Description

Changes proposed in this pull request:

  • Added the NFS feature description based on the input from Nikola

Related issue(s)

@mmitoraj mmitoraj added documentation Improvements or additions to documentation area/documentation Issues or PRs related to documentation labels Dec 20, 2024
@mmitoraj mmitoraj requested a review from a team as a code owner December 20, 2024 14:34
@kyma-bot kyma-bot added cla: yes Indicates the PR's author has signed the CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 20, 2024
mmitoraj
mmitoraj commented Dec 20, 2024
View reviewed changes
docs/user/00-20-nfs.md Outdated
@@ -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.
Copy link
Contributor Author

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

Copy link
Contributor

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.

dushanpantic
dushanpantic reviewed Dec 26, 2024
View reviewed changes
docs/user/00-40-redis.md Outdated

## Related Information

* [Cloud Manager Resources: NFS](./resources/README.md#redis).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [Cloud Manager Resources: NFS](./resources/README.md#redis).
* [Cloud Manager Resources: Redis](./resources/README.md#redis).

abalaie
abalaie reviewed Jan 6, 2025
View reviewed changes
docs/user/00-20-nfs.md

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these are CRs. Do we need to mention CR here? If we do, why not mention it in the rest of the list.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will use "CR" across the whole list. Thanks!

docs/user/00-20-nfs.md Outdated
@@ -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.
Copy link
Contributor

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.

mmitoraj
mmitoraj commented Jan 10, 2025
View reviewed changes
docs/user/00-40-redis.md Outdated

## Overview

The Cloud Manager module provides managed Redis which allows you to use caching functionality directly from your cloud provider.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Cloud Manager module provides managed Redis which allows you to use caching functionality directly from your cloud provider.
The Cloud Manager module allows you to provision a cloud provider-managed Redis instance within your cluster network.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you provision a Redis instance, you can choose between the Standard and Premium Tier.

  • Standard - offers one instance
  • Premium - offers high availability with automatic failover by provisioning an additional read replica of your instance

@kyma-bot kyma-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abalaie abalaie abalaie left review comments

@dushanpantic dushanpantic dushanpantic left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
area/documentation Issues or PRs related to documentation cla: yes Indicates the PR's author has signed the CLA. documentation Improvements or additions to documentation size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mmitoraj @dushanpantic @abalaie @kyma-bot