Skip to content

Commit b60523b

Browse files
committed
Made some minor documentational changes.
1 parent 6cb24d7 commit b60523b

File tree

1 file changed

+14
-15
lines changed
  • Management-Utilities/warm_performance_tier

1 file changed

+14
-15
lines changed

Management-Utilities/warm_performance_tier/README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,24 @@ assuming the tiering policy is not set to 'all' or 'snapshot', all the data shou
1111
in the performance tier until ONTAP tiers it back based on the volume's
1212
tiering policy.
1313

14-
Note that by default Data ONTAP will not store data in the performance
14+
Note that, by default, Data ONTAP will not store data in the performance
1515
tier from the capacity tier if it detects that the data is being read sequentially.
1616
This is to keep things like backups and virus scans from filling up the performance tier.
1717
You can, and should, override this behavior by setting
1818
the cloud-retrieval-policy to "on-read" for the volume. Examples on
1919
how to do that are shown below.
2020

21-
To further try and keep ONTAP from now keeping data in the performance tier
22-
after reading it in, this script will
23-
read files in "reverse" order. Meaning it will read the last block of
24-
the file first, then the second to last block, and so on.
21+
In an additional effort to try to get ONTAP to keep data in the performance tier
22+
after reading it in, this script will read files in "reverse" order. Meaning
23+
it will read the last block of the file first, then the second to last block, and so on.
2524

2625
To speed up the process, the script will spawn multiple threads to process
2726
the volume. It will spawn a separate thread for each directory
2827
in the volume, and then a separate thread for each file in that directory.
2928
The number of directory threads is controlled by the -t option. The number
3029
of reader threads is controlled by the -x option. Note that the script
31-
will spawn -x reader threads **per** directory thread. So for example, if you have 4
32-
directory threads and 10 reader threads, you could have up to 40 reader
30+
will spawn -x reader threads **per** directory thread. So, for example, if you have 2
31+
directory threads and 5 reader threads, you could have up to 10 reader
3332
threads running at one time.
3433

3534
Since the goal of this script is to force all the data that is currently
@@ -44,8 +43,8 @@ capacity tier after running this script. There can be several reasons
4443
for that. For example:
4544

4645
* Space is from snapshots that aren't part of the live volume anymore.
47-
* Space from blocks that are part of a object in the object store, but aren't
48-
part of the volume. This space will get consolidated eventaully.
46+
* Space from blocks that are part of an object in the object store, but aren't
47+
part of the volume. This space will get consolidated eventually.
4948
* Some is from metadata that is always kept in the capacity tier.
5049

5150
Even with the reasons mentioned above, we have found that running the
@@ -54,23 +53,23 @@ if you are trying to get as much data as possible into the performance tier,
5453
it is recommended to run the script twice.
5554

5655
## Set Up
57-
The first step is ensure the volume's tiering policy is set
56+
The first step is to ensure the volume's tiering policy is set
5857
to something other than "all" or "snapshot-only". You should also ensure
59-
that the cloud-retreival-policy to set to "on-read". You can make
58+
that the cloud-retrieval-policy is set to "on-read". You can make
6059
both of these changes with the following commands:
6160
```
6261
set advanced -c off
6362
volume modify -vserver <vserver> -volume <volume> -tiering-policy auto -cloud-retrieval-policy on-read
6463
```
6564
Where `<vserver>` is the name of the SVM and `<volume>` is the name of the volume.
6665

67-
The next perperational step is to copy the scrip to a Linux based host that is able to NFS
66+
The next step is to copy the script to a Linux based host that is able to NFS
6867
mount the volume to be warmed. If the volume is already mounted, then
6968
any user that has read access to all the files in the volume can run it.
7069
Otherwise, the script needs to be run as 'root' so it can mount the
7170
volume before reading the files.
7271

73-
If the 'root' user can't read the all files in the volume, then you should use 'root' user just
72+
If the 'root' user can't read the all files in the volume, then you should use the 'root' user just
7473
to mount the volume and then run the script from a user ID that can read the contents
7574
of all the files in the volume.
7675

@@ -114,8 +113,8 @@ Where:
114113
-v volume_name - Is the name of the volume.
115114
-n nfs_type - Is the NFS version to use. Default is nfs4.
116115
-d directory - Is the root directory to start the process from.
117-
-t max_directory_threads - Is the maximum number of threads to use to process directories. The default is 5
118-
-x max_read_threads - Is the maximum number of threads to use to read files. The default is 2.
116+
-t max_directory_threads - Is the maximum number of threads to use to process directories. The default is 2.
117+
-x max_read_threads - Is the maximum number of threads to use to read files. The default is 5.
119118
-V - Enable verbose output. Displays the thread ID, date (in epoch seconds), then the directory or file being processed.
120119
-h - Prints this help information.
121120

0 commit comments

Comments
 (0)