-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
PropertyKey.java
executable file
·6944 lines (6811 loc) · 363 KB
/
PropertyKey.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
* (the "License"). You may not use this work except in compliance with the License, which is
* available at www.apache.org/licenses/LICENSE-2.0
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied, as more fully set forth in the License.
*
* See the NOTICE file distributed with this work for information regarding copyright ownership.
*/
package alluxio.conf;
import alluxio.Constants;
import alluxio.DefaultSupplier;
import alluxio.ProjectConstants;
import alluxio.RuntimeConstants;
import alluxio.annotation.PublicApi;
import alluxio.exception.ExceptionMessage;
import alluxio.grpc.Scope;
import alluxio.grpc.WritePType;
import alluxio.util.OSUtils;
import alluxio.util.io.PathUtils;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.collect.Sets;
import com.sun.management.OperatingSystemMXBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.management.ManagementFactory;
import java.util.Arrays;
import java.util.Collection;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.BiFunction;
import java.util.function.Supplier;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;
/**
* Configuration property keys. This class provides a set of pre-defined property keys.
*/
@ThreadSafe
@PublicApi
public final class PropertyKey implements Comparable<PropertyKey> {
private static final Logger LOG = LoggerFactory.getLogger(PropertyKey.class);
// The following two maps must be the first to initialize within this file.
/** A map from default property key's string name to the key. */
private static final Map<String, PropertyKey> DEFAULT_KEYS_MAP = new ConcurrentHashMap<>();
/** A map from default property key's alias to the key. */
private static final Map<String, PropertyKey> DEFAULT_ALIAS_MAP = new ConcurrentHashMap<>();
/** A cache storing result for template regexp matching results. */
private static final Cache<String, Boolean> REGEXP_CACHE = CacheBuilder.newBuilder()
.maximumSize(1024)
.build();
/**
* The consistency check level to apply to a certain property key.
* User can run "alluxio validateEnv all cluster.conf.consistent" to validate the consistency of
* configuration properties within the cluster. The command reads all Alluxio properties on
* each node of the cluster and shows error or warning for properties that have inconsistent
* values among the nodes. For example, it would show error if the Alluxio property for aws secret
* access key has some value on a master node and a different value on one of the worker nodes.
*/
public enum ConsistencyCheckLevel {
/**
* Do not check consistency of property value.
* This should be set if the property is not required to have same value among the nodes
* (e.g. worker hostname).
*/
IGNORE,
/**
* Check consistency of property value, show warning of inconsistent values.
* This should be set if the property is recommended to have same value among the nodes,
* although having different values does not cause immediate issues(e.g. alluxio home folder
* location, timeout value for connecting to a worker).
*/
WARN,
/**
* Check consistency of property value, show error of inconsistent values.
* This should be set if the property is required to have same value among the nodes
* (e.g. AWS credentials, journal location).
*/
ENFORCE,
}
/**
* Indicates how the property value should be displayed.
*/
public enum DisplayType {
/**
* The property value should be displayed normally.
*/
DEFAULT,
/**
* The property value contains credentials and should not be displayed directly.
*/
CREDENTIALS,
}
/**
* Builder to create {@link PropertyKey} instances. Note that, <code>Builder.build()</code> will
* throw exception if there is an existing property built with the same name.
*/
public static final class Builder {
private String[] mAlias;
private DefaultSupplier mDefaultSupplier;
private Object mDefaultValue;
private String mDescription;
private String mName;
private boolean mIgnoredSiteProperty;
private boolean mIsBuiltIn = true;
private boolean mIsHidden;
private ConsistencyCheckLevel mConsistencyCheckLevel = ConsistencyCheckLevel.IGNORE;
private Scope mScope = Scope.ALL;
private DisplayType mDisplayType = DisplayType.DEFAULT;
private boolean mIsDynamic = true;
/**
* @param name name of the property
*/
public Builder(String name) {
mName = name;
}
/**
* @param template template for the property name
* @param params parameters of the template
*/
public Builder(PropertyKey.Template template, Object... params) {
mName = String.format(template.mFormat, params);
}
/**
* @param aliases aliases for the property
* @return the updated builder instance
*/
public Builder setAlias(String... aliases) {
mAlias = Arrays.copyOf(aliases, aliases.length);
return this;
}
/**
* @param name name for the property
* @return the updated builder instance
*/
public Builder setName(String name) {
mName = name;
return this;
}
/**
* @param defaultSupplier supplier for the property's default value
* @return the updated builder instance
*/
public Builder setDefaultSupplier(DefaultSupplier defaultSupplier) {
mDefaultSupplier = defaultSupplier;
return this;
}
/**
* @param supplier supplier for the property's default value
* @param description description of the default value
* @return the updated builder instance
*/
public Builder setDefaultSupplier(Supplier<Object> supplier, String description) {
mDefaultSupplier = new DefaultSupplier(supplier, description);
return this;
}
/**
* @param defaultValue the property's default value
* @return the updated builder instance
*/
public Builder setDefaultValue(Object defaultValue) {
mDefaultValue = defaultValue;
return this;
}
/**
* @param description of the property
* @return the updated builder instance
*/
public Builder setDescription(String description) {
mDescription = description;
return this;
}
/**
* @param isBuiltIn whether to the property is a built-in Alluxio property
* @return the updated builder instance
*/
public Builder setIsBuiltIn(boolean isBuiltIn) {
mIsBuiltIn = isBuiltIn;
return this;
}
/**
* @param isHidden whether to hide the property when generating property documentation
* @return the updated builder instance
*/
public Builder setIsHidden(boolean isHidden) {
mIsHidden = isHidden;
return this;
}
/**
* @param ignoredSiteProperty whether the property should be ignored in alluxio-site.properties
* @return the updated builder instance
*/
public Builder setIgnoredSiteProperty(boolean ignoredSiteProperty) {
mIgnoredSiteProperty = ignoredSiteProperty;
return this;
}
/**
* @param consistencyCheckLevel the consistency level that applies to this property
* @return the updated builder instance
*/
public Builder setConsistencyCheckLevel(ConsistencyCheckLevel consistencyCheckLevel) {
mConsistencyCheckLevel = consistencyCheckLevel;
return this;
}
/**
* @param scope which components this property applies to
* @return the updated builder instance
*/
public Builder setScope(Scope scope) {
mScope = scope;
return this;
}
/**
* @param displayType the displayType that indicates how the property value should be displayed
* @return the updated builder instance
*/
public Builder setDisplayType(DisplayType displayType) {
mDisplayType = displayType;
return this;
}
/**
* @param dynamic whether the property could be updated dynamically
* @return the updated builder instance
*/
public Builder setIsDynamic(boolean dynamic) {
mIsDynamic = dynamic;
return this;
}
/**
* Creates and registers the property key.
*
* @return the created property key instance
*/
public PropertyKey build() {
PropertyKey key = buildUnregistered();
Preconditions.checkState(PropertyKey.register(key), "Cannot register existing key \"%s\"",
mName);
return key;
}
/**
* Creates the property key without registering it with default property list.
*
* @return the created property key instance
*/
public PropertyKey buildUnregistered() {
DefaultSupplier defaultSupplier = mDefaultSupplier;
if (defaultSupplier == null) {
String defaultString = String.valueOf(mDefaultValue);
defaultSupplier = (mDefaultValue == null)
? new DefaultSupplier(() -> null, "null")
: new DefaultSupplier(() -> defaultString, defaultString);
}
PropertyKey key = new PropertyKey(mName, mDescription, defaultSupplier, mAlias,
mIgnoredSiteProperty, mIsHidden, mConsistencyCheckLevel, mScope, mDisplayType,
mIsBuiltIn, mIsDynamic);
return key;
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("alias", mAlias)
.add("defaultValue", mDefaultValue)
.add("description", mDescription)
.add("name", mName).toString();
}
}
public static final PropertyKey CONF_DIR =
new Builder(Name.CONF_DIR)
.setDefaultValue(String.format("${%s}/conf", Name.HOME))
.setDescription("The directory containing files used to configure Alluxio.")
.setIgnoredSiteProperty(true)
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey CONF_DYNAMIC_UPDATE_ENABLED =
new Builder(Name.CONF_DYNAMIC_UPDATE_ENABLED)
.setDefaultValue(false)
.setDescription("Whether to support dynamic update property.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey CONF_VALIDATION_ENABLED =
new Builder(Name.CONF_VALIDATION_ENABLED)
.setDefaultValue(true)
.setDescription("Whether to validate the configuration properties when initializing "
+ "Alluxio clients or server process.")
.setIsHidden(true)
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey DEBUG =
new Builder(Name.DEBUG)
.setDefaultValue(false)
.setDescription("Set to true to enable debug mode which has additional logging and "
+ "info in the Web UI.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey EXTENSIONS_DIR =
new Builder(Name.EXTENSIONS_DIR)
.setDefaultValue(String.format("${%s}/extensions", Name.HOME))
.setDescription("The directory containing Alluxio extensions.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey HOME =
new Builder(Name.HOME)
.setDefaultValue("/opt/alluxio")
.setDescription("Alluxio installation directory.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey LOGGER_TYPE =
new Builder(Name.LOGGER_TYPE)
.setDefaultValue("Console")
.setDescription("This controls which logger the process uses. "
+ "This is only set by test code.")
.setIsHidden(true)
.setConsistencyCheckLevel(ConsistencyCheckLevel.IGNORE)
.setScope(Scope.ALL)
.build();
public static final PropertyKey LOGS_DIR =
new Builder(Name.LOGS_DIR)
.setDefaultValue(String.format("${%s}/logs", Name.WORK_DIR))
.setDescription("The path under Alluxio home directory to store log files. It has a "
+ "corresponding environment variable $ALLUXIO_LOGS_DIR.")
.setIgnoredSiteProperty(true)
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
// Used in alluxio-config.sh and conf/log4j.properties
public static final PropertyKey USER_LOGS_DIR =
new Builder(Name.USER_LOGS_DIR)
.setDefaultValue(String.format("${%s}/user", Name.LOGS_DIR))
.setDescription("The path to store logs of Alluxio shell. To change its value, one can "
+ " set environment variable $ALLUXIO_USER_LOGS_DIR.")
.setIgnoredSiteProperty(true)
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.build();
public static final PropertyKey METRICS_CONF_FILE =
new Builder(Name.METRICS_CONF_FILE)
.setDefaultValue(String.format("${%s}/metrics.properties", Name.CONF_DIR))
.setDescription("The file path of the metrics system configuration file. By default "
+ "it is `metrics.properties` in the `conf` directory.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey METRICS_CONTEXT_SHUTDOWN_TIMEOUT =
new Builder(Name.METRICS_CONTEXT_SHUTDOWN_TIMEOUT)
.setDefaultValue("1sec")
.setDescription("Time to wait for the metrics context to shut down. The main purpose for "
+ "this property is to allow tests to shut down faster.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.IGNORE)
.setIsHidden(true)
.setScope(Scope.ALL)
.build();
public static final PropertyKey NETWORK_CONNECTION_AUTH_TIMEOUT =
new Builder(Name.NETWORK_CONNECTION_AUTH_TIMEOUT)
.setDefaultValue("30sec")
.setDescription("Maximum time to wait for a connection (gRPC channel) to attempt to "
+ "receive an authentication response.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey NETWORK_CONNECTION_HEALTH_CHECK_TIMEOUT =
new Builder(Name.NETWORK_CONNECTION_HEALTH_CHECK_TIMEOUT)
.setAlias("alluxio.network.connection.health.check.timeout.ms")
.setDefaultValue("5sec")
.setDescription("Allowed duration for checking health of client connections (gRPC "
+ "channels) before being assigned to a client. If a connection does not become "
+ "active within configured time, it will be shut down and a new connection will be "
+ "created for the client")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey NETWORK_CONNECTION_SERVER_SHUTDOWN_TIMEOUT =
new Builder(Name.NETWORK_CONNECTION_SERVER_SHUTDOWN_TIMEOUT)
.setDefaultValue("60sec")
.setDescription("Maximum time to wait for gRPC server to stop on shutdown")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey NETWORK_CONNECTION_SHUTDOWN_GRACEFUL_TIMEOUT =
new Builder(Name.NETWORK_CONNECTION_SHUTDOWN_GRACEFUL_TIMEOUT)
.setDefaultValue("45sec")
.setDescription("Maximum time to wait for connections (gRPC channels) to stop on "
+ "shutdown")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey NETWORK_CONNECTION_SHUTDOWN_TIMEOUT =
new Builder(Name.NETWORK_CONNECTION_SHUTDOWN_TIMEOUT)
.setDefaultValue("15sec")
.setDescription("Maximum time to wait for connections (gRPC channels) to stop after "
+ "graceful shutdown attempt.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey NETWORK_HOST_RESOLUTION_TIMEOUT_MS =
new Builder(Name.NETWORK_HOST_RESOLUTION_TIMEOUT_MS)
.setAlias("alluxio.network.host.resolution.timeout.ms")
.setDefaultValue("5sec")
.setDescription("During startup of the Master and Worker processes Alluxio needs to "
+ "ensure that they are listening on externally resolvable and reachable host "
+ "names. To do this, Alluxio will automatically attempt to select an "
+ "appropriate host name if one was not explicitly specified. This represents "
+ "the maximum amount of time spent waiting to determine if a candidate host "
+ "name is resolvable over the network.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey SITE_CONF_DIR =
new Builder(Name.SITE_CONF_DIR)
.setDefaultSupplier(
() -> String.format("${%s}/,%s/.alluxio/,/etc/alluxio/",
Name.CONF_DIR, System.getProperty("user.home")),
String.format("${%s}/,${user.home}/.alluxio/,/etc/alluxio/", Name.CONF_DIR))
.setDescription(
String.format("Comma-separated search path for %s.", Constants.SITE_PROPERTIES))
.setIgnoredSiteProperty(true)
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey NETWORK_IP_ADDRESS_USED =
new Builder(Name.NETWORK_IP_ADDRESS_USED)
.setDefaultValue("false")
.setDescription("If true, when alluxio.<service_name>.hostname and "
+ "alluxio.<service_name>.bind.host of a service not specified, "
+ "use IP as the connect host of the service.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey TEST_MODE =
new Builder(Name.TEST_MODE)
.setDefaultValue(false)
.setDescription("Flag used only during tests to allow special behavior.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setIsHidden(true)
.setScope(Scope.ALL)
.build();
public static final PropertyKey TMP_DIRS =
new Builder(Name.TMP_DIRS)
.setDefaultValue("/tmp")
.setDescription("The path(s) to store Alluxio temporary files, use commas as delimiters. "
+ "If multiple paths are specified, one will be selected at random per temporary "
+ "file. Currently, only files to be uploaded to object stores are stored in these "
+ "paths.")
.setScope(Scope.SERVER)
.build();
public static final PropertyKey VERSION =
new Builder(Name.VERSION)
.setConsistencyCheckLevel(ConsistencyCheckLevel.IGNORE)
.setDefaultValue(ProjectConstants.VERSION)
.setDescription("Version of Alluxio. User should never modify this property.")
.setIgnoredSiteProperty(true)
.setIsHidden(true)
.setScope(Scope.ALL)
.build();
public static final PropertyKey WEB_FILE_INFO_ENABLED =
new Builder(Name.WEB_FILE_INFO_ENABLED)
.setDefaultValue(true)
.setDescription("Whether detailed file information are enabled for the web UI.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey WEB_RESOURCES =
new Builder(Name.WEB_RESOURCES)
.setDefaultValue(String.format("${%s}/webui/", Name.HOME))
.setDescription("Path to the web UI resources. User should never modify this property.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.setIsHidden(true)
.build();
public static final PropertyKey WEB_THREADS =
new Builder(Name.WEB_THREADS)
.setDefaultValue(1)
.setDescription("How many threads to serve Alluxio web UI.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey WEB_CORS_ENABLED =
new Builder(Name.WEB_CORS_ENABLED)
.setDefaultValue(false)
.setDescription("Set to true to enable Cross-Origin Resource Sharing for RESTful API"
+ "endpoints.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey WEB_REFRESH_INTERVAL =
new Builder(Name.WEB_REFRESH_INTERVAL)
.setDefaultValue("15s")
.setDescription("The amount of time to await before refreshing the Web UI if it is set "
+ "to auto refresh.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey WEB_UI_ENABLED =
new Builder(Name.WEB_UI_ENABLED)
.setDefaultValue(true)
.setDescription("Whether the master/worker will have Web UI enabled. "
+ "If set to false, the master/worker will not have Web UI page, but the RESTful "
+ "endpoints and metrics will still be available.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey WORK_DIR =
new Builder(Name.WORK_DIR)
.setDefaultValue(String.format("${%s}", Name.HOME))
.setDescription("The directory to use for Alluxio's working directory. By default, "
+ "the journal, logs, and under file storage data (if using local filesystem) "
+ "are written here.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey ZOOKEEPER_ADDRESS =
new Builder(Name.ZOOKEEPER_ADDRESS)
.setDescription("Address of ZooKeeper.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.ALL)
.build();
public static final PropertyKey ZOOKEEPER_CONNECTION_TIMEOUT =
new Builder(Name.ZOOKEEPER_CONNECTION_TIMEOUT)
.setDefaultValue("15s") // matches Zookeeper's default
.setDescription("Connection timeout for Alluxio (job) masters to select "
+ "the leading (job) master when connecting to Zookeeper")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.MASTER)
.build();
public static final PropertyKey ZOOKEEPER_ELECTION_PATH =
new Builder(Name.ZOOKEEPER_ELECTION_PATH)
.setDefaultValue("/alluxio/election")
.setDescription("Election directory in ZooKeeper.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.ALL)
.build();
public static final PropertyKey ZOOKEEPER_ENABLED =
new Builder(Name.ZOOKEEPER_ENABLED)
.setDefaultValue(false)
.setDescription("If true, setup master fault tolerant mode using ZooKeeper.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.ALL)
.build();
public static final PropertyKey ZOOKEEPER_LEADER_INQUIRY_RETRY_COUNT =
new Builder(Name.ZOOKEEPER_LEADER_INQUIRY_RETRY_COUNT)
.setDefaultValue(10)
.setDescription("The number of retries to inquire leader from ZooKeeper.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey ZOOKEEPER_LEADER_PATH =
new Builder(Name.ZOOKEEPER_LEADER_PATH)
.setDefaultValue("/alluxio/leader")
.setDescription("Leader directory in ZooKeeper.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.ALL)
.build();
public static final PropertyKey ZOOKEEPER_SESSION_TIMEOUT =
new Builder(Name.ZOOKEEPER_SESSION_TIMEOUT)
.setDefaultValue("60s") // matches Zookeeper's default
.setDescription("Session timeout to use when connecting to Zookeeper")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.MASTER)
.build();
public static final PropertyKey ZOOKEEPER_AUTH_ENABLED =
new Builder(Name.ZOOKEEPER_AUTH_ENABLED)
.setDefaultValue(true)
.setDescription("If true, enable client-side Zookeeper authentication.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.ALL)
.build();
public static final PropertyKey ZOOKEEPER_LEADER_CONNECTION_ERROR_POLICY =
new Builder(Name.ZOOKEEPER_LEADER_CONNECTION_ERROR_POLICY)
.setDefaultValue("SESSION")
.setDescription("Connection error policy defines how errors on zookeeper connections "
+ "to be treated in leader election. "
+ "STANDARD policy treats every connection event as failure."
+ "SESSION policy relies on zookeeper sessions for judging failures, "
+ "helping leader to retain its status, as long as its session is protected.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.MASTER)
.build();
/**
* UFS related properties.
*/
public static final PropertyKey UNDERFS_ALLOW_SET_OWNER_FAILURE =
new Builder(Name.UNDERFS_ALLOW_SET_OWNER_FAILURE)
.setDefaultValue(false)
.setDescription("Whether to allow setting owner in UFS to fail. When set to true, "
+ "it is possible file or directory owners diverge between Alluxio and UFS.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.MASTER)
.build();
public static final PropertyKey UNDERFS_CLEANUP_ENABLED =
new Builder(Name.UNDERFS_CLEANUP_ENABLED)
.setDefaultValue(false)
.setDescription("Whether or not to clean up under file storage periodically."
+ "Some ufs operations may not be completed and cleaned up successfully "
+ "in normal ways and leave some intermediate data that needs periodical cleanup."
+ "If enabled, all the mount points will be cleaned up when a leader master starts "
+ "or cleanup interval is reached. This should be used sparingly.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.MASTER)
.build();
public static final PropertyKey UNDERFS_CLEANUP_INTERVAL =
new Builder(Name.UNDERFS_CLEANUP_INTERVAL)
.setDefaultValue("1day")
.setDescription("The interval for periodically cleaning all the "
+ " mounted under file storages.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.MASTER)
.build();
public static final PropertyKey UNDERFS_LISTING_LENGTH =
new Builder(Name.UNDERFS_LISTING_LENGTH)
.setDefaultValue(1000)
.setDescription("The maximum number of directory entries to list in a single query "
+ "to under file system. If the total number of entries is greater than the "
+ "specified length, multiple queries will be issued.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.MASTER)
.build();
public static final PropertyKey UNDERFS_LOGGING_THRESHOLD =
new Builder(Name.UNDERFS_LOGGING_THRESHOLD)
.setDefaultValue("10s")
.setDescription("Logging a UFS API call when it takes more time than the threshold.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.IGNORE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_DEFAULT_MODE =
new Builder(Name.UNDERFS_GCS_DEFAULT_MODE)
.setDefaultValue("0700")
.setDescription("Mode (in octal notation) for GCS objects if mode cannot be discovered.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_DIRECTORY_SUFFIX =
new Builder(Name.UNDERFS_GCS_DIRECTORY_SUFFIX)
.setDefaultValue("/")
.setDescription("Directories are represented in GCS as zero-byte objects named with "
+ "the specified suffix.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_OWNER_ID_TO_USERNAME_MAPPING =
new Builder(Name.UNDERFS_GCS_OWNER_ID_TO_USERNAME_MAPPING)
.setDescription(String.format("Optionally, specify a preset gcs owner id "
+ "to Alluxio username static mapping in the format \"id1=user1;id2=user2\". "
+ "The Google Cloud Storage IDs can be found at the console address "
+ "https://console.cloud.google.com/storage/settings . Please use the "
+ "\"Owners\" one. This property key is only valid when %s=1",
Name.UNDERFS_GCS_VERSION))
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_RETRY_INITIAL_DELAY_MS =
new Builder(Name.UNDERFS_GCS_RETRY_INITIAL_DELAY_MS)
.setDefaultValue(1000)
.setDescription("Initial delay before attempting the retry on the ufs")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_RETRY_MAX_DELAY_MS =
new Builder(Name.UNDERFS_GCS_RETRY_MAX_DELAY_MS)
.setDefaultValue(1000 * 60) // 1 min
.setDescription("Maximum delay before attempting the retry on the ufs")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_RETRY_DELAY_MULTIPLIER =
new Builder(Name.UNDERFS_GCS_RETRY_DELAY_MULTIPLIER)
.setDefaultValue(2)
.setDescription("Delay multiplier while retrying requests on the ufs")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_RETRY_JITTER =
new Builder(Name.UNDERFS_GCS_RETRY_JITTER)
.setDefaultValue(true)
.setDescription("Enable delay jitter while retrying requests on the ufs")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_RETRY_TOTAL_DURATION_MS =
new Builder(Name.UNDERFS_GCS_RETRY_TOTAL_DURATION_MS)
.setDefaultValue(5 * 1000 * 60) // 5 mins
.setDescription("Maximum retry duration on the ufs")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_RETRY_MAX =
new Builder(Name.UNDERFS_GCS_RETRY_MAX)
.setDefaultValue(60)
.setDescription("Maximum Number of retries on the ufs")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_GCS_VERSION =
new Builder(Name.UNDERFS_GCS_VERSION)
.setDefaultValue(2)
.setDescription(String.format("Specify the version of GCS module to use. "
+ "GCS version \"1\" builds on top of jets3t package "
+ "which requires %s and %s. GCS version \"2\" build on top "
+ "of Google cloud API which requires %s", Name.GCS_ACCESS_KEY, Name.GCS_SECRET_KEY,
Name.GCS_CREDENTIAL_PATH))
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_HDFS_CONFIGURATION =
new Builder(Name.UNDERFS_HDFS_CONFIGURATION)
.setDefaultValue(String.format(
"${%s}/core-site.xml:${%s}/hdfs-site.xml", Name.CONF_DIR, Name.CONF_DIR))
.setDescription("Location of the HDFS configuration file to overwrite "
+ "the default HDFS client configuration. Note that, these files must be available"
+ "on every node.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_HDFS_IMPL =
new Builder(Name.UNDERFS_HDFS_IMPL)
.setDefaultValue("org.apache.hadoop.hdfs.DistributedFileSystem")
.setDescription("The implementation class of the HDFS as the under storage system.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_HDFS_PREFIXES =
new Builder(Name.UNDERFS_HDFS_PREFIXES)
.setDefaultValue("hdfs://,glusterfs:///")
.setDescription("Optionally, specify which prefixes should run through the HDFS "
+ "implementation of UnderFileSystem. The delimiter is any whitespace "
+ "and/or ','.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_HDFS_REMOTE =
new Builder(Name.UNDERFS_HDFS_REMOTE)
.setDefaultValue(true)
.setDescription("Boolean indicating whether or not the under storage worker nodes "
+ "are remote with respect to Alluxio worker nodes. If set to true, Alluxio "
+ "will not attempt to discover locality information from the under storage "
+ "because locality is impossible. This will improve performance. The default "
+ "value is true.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_WEB_HEADER_LAST_MODIFIED =
new Builder(Name.UNDERFS_WEB_HEADER_LAST_MODIFIED)
.setDefaultValue("EEE, dd MMM yyyy HH:mm:ss zzz")
.setDescription("Date format of last modified for a http response header.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_WEB_CONNECTION_TIMEOUT =
new Builder(Name.UNDERFS_WEB_CONNECTION_TIMEOUT)
.setDefaultValue("60s")
.setDescription("Default timeout for a http connection.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_WEB_PARENT_NAMES =
new Builder(Name.UNDERFS_WEB_PARENT_NAMES)
.setDefaultValue("Parent Directory,..,../")
.setDescription("The text of the http link for the parent directory.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_WEB_TITLES =
new Builder(Name.UNDERFS_WEB_TITLES)
.setDefaultValue("Index of,Directory listing for")
.setDescription("The title of the content for a http url.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OBJECT_STORE_BREADCRUMBS_ENABLED =
new Builder(Name.UNDERFS_OBJECT_STORE_BREADCRUMBS_ENABLED)
.setDefaultValue(true)
.setDescription("Set this to false to prevent Alluxio from creating zero byte objects "
+ "during read or list operations on object store UFS. Leaving this on enables more"
+ " efficient listing of prefixes.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OBJECT_STORE_MULTI_RANGE_CHUNK_SIZE =
new Builder(Name.UNDERFS_OBJECT_STORE_MULTI_RANGE_CHUNK_SIZE)
.setDefaultValue(String.format("${%s}", Name.USER_BLOCK_SIZE_BYTES_DEFAULT))
.setDescription("Default chunk size for ranged reads from multi-range object input "
+ "streams.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OBJECT_STORE_SERVICE_THREADS =
new Builder(Name.UNDERFS_OBJECT_STORE_SERVICE_THREADS)
.setDefaultValue(20)
.setDescription("The number of threads in executor pool for parallel object store "
+ "UFS operations, such as directory renames and deletes.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OBJECT_STORE_SKIP_PARENT_DIRECTORY_CREATION =
new Builder(Name.UNDERFS_OBJECT_STORE_SKIP_PARENT_DIRECTORY_CREATION)
.setDefaultValue(true)
.setDescription("Do not create parent directory for new files. Object stores generally "
+ "uses prefix which is not required for creating new files. Skipping parent "
+ "directory is recommended for better performance. Set this to false if the "
+ "object store requires prefix creation for new files.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OBJECT_STORE_MOUNT_SHARED_PUBLICLY =
new Builder(Name.UNDERFS_OBJECT_STORE_MOUNT_SHARED_PUBLICLY)
.setDefaultValue(false)
.setDescription("Whether or not to share object storage under storage system "
+ "mounted point with all Alluxio users. Note that this configuration has no "
+ "effect on HDFS nor local UFS.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_EVENTUAL_CONSISTENCY_RETRY_BASE_SLEEP_MS =
new Builder(Name.UNDERFS_EVENTUAL_CONSISTENCY_RETRY_BASE_SLEEP_MS)
.setDefaultValue("50ms")
.setDescription("To handle eventually consistent storage semantics "
+ "for certain under storages, Alluxio will perform retries "
+ "when under storage metadata doesn't match Alluxio's expectations. "
+ "These retries use exponential backoff. "
+ "This property determines the base time for the exponential backoff.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_EVENTUAL_CONSISTENCY_RETRY_MAX_NUM =
new Builder(Name.UNDERFS_EVENTUAL_CONSISTENCY_RETRY_MAX_NUM)
.setDefaultValue(20)
.setDescription("To handle eventually consistent storage semantics "
+ "for certain under storages, Alluxio will perform retries "
+ "when under storage metadata doesn't match Alluxio's expectations. "
+ "These retries use exponential backoff. "
+ "This property determines the maximum number of retries.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_EVENTUAL_CONSISTENCY_RETRY_MAX_SLEEP_MS =
new Builder(Name.UNDERFS_EVENTUAL_CONSISTENCY_RETRY_MAX_SLEEP_MS)
.setDefaultValue("30sec")
.setDescription("To handle eventually consistent storage semantics "
+ "for certain under storages, Alluxio will perform retries "
+ "when under storage metadata doesn't match Alluxio's expectations. "
+ "These retries use exponential backoff. "
+ "This property determines the maximum wait time in the backoff.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OSS_CONNECT_MAX =
new Builder(Name.UNDERFS_OSS_CONNECT_MAX)
.setDefaultValue(1024)
.setDescription("The maximum number of OSS connections.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OSS_CONNECT_TIMEOUT =
new Builder(Name.UNDERFS_OSS_CONNECT_TIMEOUT)
.setAlias("alluxio.underfs.oss.connection.timeout.ms")
.setDefaultValue("50sec")
.setDescription("The timeout when connecting to OSS.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OSS_CONNECT_TTL =
new Builder(Name.UNDERFS_OSS_CONNECT_TTL)
.setDefaultValue(-1)
.setDescription("The TTL of OSS connections in ms.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_OSS_SOCKET_TIMEOUT =
new Builder(Name.UNDERFS_OSS_SOCKET_TIMEOUT)
.setAlias("alluxio.underfs.oss.socket.timeout.ms")
.setDefaultValue("50sec")
.setDescription("The timeout of OSS socket.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_ADMIN_THREADS_MAX =
new Builder(Name.UNDERFS_S3_ADMIN_THREADS_MAX)
.setDefaultValue(20)
.setDescription("The maximum number of threads to use for metadata operations when "
+ "communicating with S3. These operations may be fairly concurrent and "
+ "frequent but should not take much time to process.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_DISABLE_DNS_BUCKETS =
new Builder(Name.UNDERFS_S3_DISABLE_DNS_BUCKETS)
.setDefaultValue(false)
.setDescription("Optionally, specify to make all S3 requests path style.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_ENDPOINT =
new Builder(Name.UNDERFS_S3_ENDPOINT)
.setDescription("Optionally, to reduce data latency or visit resources which are "
+ "separated in different AWS regions, specify a regional endpoint to make aws "
+ "requests. An endpoint is a URL that is the entry point for a web service. "
+ "For example, s3.cn-north-1.amazonaws.com.cn is an entry point for the Amazon "
+ "S3 service in beijing region.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_OWNER_ID_TO_USERNAME_MAPPING =
new Builder(Name.UNDERFS_S3_OWNER_ID_TO_USERNAME_MAPPING)
.setDescription("Optionally, specify a preset s3 canonical id to Alluxio username "
+ "static mapping, in the format \"id1=user1;id2=user2\". The AWS S3 canonical "
+ "ID can be found at the console address "
+ "https://console.aws.amazon.com/iam/home?#security_credential . Please expand "
+ "the \"Account Identifiers\" tab and refer to \"Canonical User ID\". "
+ "Unspecified owner id will map to a default empty username")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_PROXY_HOST =
new Builder(Name.UNDERFS_S3_PROXY_HOST)
.setDescription("Optionally, specify a proxy host for communicating with S3.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_PROXY_PORT =
new Builder(Name.UNDERFS_S3_PROXY_PORT)
.setDescription("Optionally, specify a proxy port for communicating with S3.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.ENFORCE)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_THREADS_MAX =
new Builder(Name.UNDERFS_S3_THREADS_MAX)
.setDefaultValue(40)
.setDescription("The maximum number of threads to use for communicating with S3 and "
+ "the maximum number of concurrent connections to S3. Includes both threads "
+ "for data upload and metadata operations. This number should be at least as "
+ "large as the max admin threads plus max upload threads.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_UPLOAD_THREADS_MAX =
new Builder(Name.UNDERFS_S3_UPLOAD_THREADS_MAX)
.setDefaultValue(20)
.setDescription("For an Alluxio worker, this is the maximum number of threads to use "
+ "for uploading data to S3 for multipart uploads. These operations can be fairly "
+ "expensive, so multiple threads are encouraged. However, this also splits the "
+ "bandwidth between threads, meaning the overall latency for completing an upload "
+ "will be higher for more threads. For the Alluxio master, this is the maximum "
+ "number of threads used for the rename (copy) operation. It is recommended that "
+ "value should be greater than or equal to "
+ Name.UNDERFS_OBJECT_STORE_SERVICE_THREADS)
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_DEFAULT_MODE =
new Builder(Name.UNDERFS_S3_DEFAULT_MODE)
.setAlias("alluxio.underfs.s3a.default.mode")
.setDefaultValue("0700")
.setDescription("Mode (in octal notation) for S3 objects if mode cannot be discovered.")
.setConsistencyCheckLevel(ConsistencyCheckLevel.WARN)
.setScope(Scope.SERVER)
.build();
public static final PropertyKey UNDERFS_S3_DIRECTORY_SUFFIX =
new Builder(Name.UNDERFS_S3_DIRECTORY_SUFFIX)
.setAlias("alluxio.underfs.s3a.directory.suffix")