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.

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

adding cli usage for aws efs #9184

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

advaitpatel
Copy link

Issue #, if available:
none

Description of changes:
Added cli examples for EFS

  • to enable lifecycle management
  • to modify the throughput mode
  • to list all access points
  • to enable automatic backups

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Added cli examples
- to enable lifecycle management
- to modify the throughput mode
- to list all access points
- to enable automatic backups
@advaitpatel
Copy link
Author

How can I request reviewers to review this PR? @kdaily @ashovlin @aemous @hssyoo

@advaitpatel
Copy link
Author

Hello @kdaily @ashovlin @aemous @hssyoo can I please get a review on this? TIA

@ashovlin ashovlin added the documentation This is a problem with documentation. label Jan 17, 2025
@elysahall elysahall self-assigned this Jan 22, 2025
@elysahall elysahall added the pr:work-in-progress This PR is a draft and needs further work. label Jan 22, 2025
Copy link
Collaborator

@elysahall elysahall left a comment

Choose a reason for hiding this comment

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

Hi @advaitpatel,

Thank you for your example submission. There are a few formatting issues that need to be addressed. After you commit these fixes, your PR should be good for maintainer review.

Thanks!

@@ -0,0 +1,20 @@
**To enable automatic backups for a file system**

The following ``put-backup-policy`` example shows how to enable automatic backups for an existing Amazon EFS file system by creating a backup policy.::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``put-backup-policy`` example shows how to enable automatic backups for an existing Amazon EFS file system by creating a backup policy.::
The following ``put-backup-policy`` example shows how to enable automatic backups for an existing Amazon EFS file system by creating a backup policy.
This command sets the backup policy for the file system with the ID ``fs-4gd2a78et`` to enable automatic backups. ::

@@ -0,0 +1,33 @@
**To list all access points for a file system**

The following ``describe-access-points`` example lists all access points for a specified file system.::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``describe-access-points`` example lists all access points for a specified file system.::
The following ``describe-access-points`` example lists all access points for a specified file system.
This command lists all access points associated with the file system ``fs-4gd2a78et``. ::

Output::

{
"AccessPoints": [
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
"AccessPoints": [
"AccessPoints": [

Copy link
Collaborator

Choose a reason for hiding this comment

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

All your output indenting from this line and below needs to be an additional 4 spaces.

}
}

This command sets the backup policy for the file system with the ID fs-4gd2a78et to enable automatic backups.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command sets the backup policy for the file system with the ID fs-4gd2a78et to enable automatic backups.

}


This command lists all access points associated with the file system fs-4gd2a78et.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command lists all access points associated with the file system fs-4gd2a78et.

@@ -0,0 +1,23 @@
**To enable lifecycle management for a file system**

The following ``put-lifecycle-configuration`` example enables lifecycle management on an existing file system to transition files to the Infrequent Access (IA) storage class after 30 days of non-access.::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``put-lifecycle-configuration`` example enables lifecycle management on an existing file system to transition files to the Infrequent Access (IA) storage class after 30 days of non-access.::
The following ``put-lifecycle-configuration`` example enables lifecycle management on an existing file system to transition files to the Infrequent Access (IA) storage class after 30 days of non-access.
This command sets a lifecycle policy for the file system with the ID ``fs-4gd2a78et``, transitioning files to IA storage after 30 days of inactivity. ::

}


This command sets a lifecycle policy for the file system with the ID fs-4gd2a78et, transitioning files to IA storage after 30 days of inactivity.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command sets a lifecycle policy for the file system with the ID fs-4gd2a78et, transitioning files to IA storage after 30 days of inactivity.

}


This command updates the throughput mode of the file system with the ID fs-c7a0456e to provisioned mode with 50 MiB/s of throughput.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command updates the throughput mode of the file system with the ID fs-c7a0456e to provisioned mode with 50 MiB/s of throughput.

@@ -0,0 +1,23 @@
**To modify the throughput mode of a file system**

The following ``update-file-system`` example changes the throughput mode of an existing file system to provisioned and sets the provisioned throughput to 50 MiB/s.::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following ``update-file-system`` example changes the throughput mode of an existing file system to provisioned and sets the provisioned throughput to 50 MiB/s.::
The following ``update-file-system`` example changes the throughput mode of an existing file system to provisioned and sets the provisioned throughput to 50 MiB/s.
This command updates the throughput mode of the file system with the ID fs-c7a0456e to provisioned mode with 50 MiB/s of throughput. ::

@elysahall elysahall assigned advaitpatel and unassigned elysahall Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. pr:work-in-progress This PR is a draft and needs further work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants