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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
|
/*
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kControl
#include "mongo/db/mongod_options.h"
#include <boost/filesystem.hpp>
#include <iostream>
#include <string>
#include <vector>
#include "mongo/base/status.h"
#include "mongo/bson/json.h"
#include "mongo/bson/util/builder.h"
#include "mongo/config.h"
#include "mongo/db/db.h"
#include "mongo/db/global_settings.h"
#include "mongo/db/repl/repl_settings.h"
#include "mongo/db/server_options.h"
#include "mongo/db/server_options_server_helpers.h"
#include "mongo/util/log.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/net/ssl_options.h"
#include "mongo/util/options_parser/startup_options.h"
#include "mongo/util/stringutils.h"
#include "mongo/util/version.h"
namespace mongo {
using std::endl;
Status addMongodOptions(moe::OptionSection* options) {
moe::OptionSection general_options("General options");
Status ret = addGeneralServerOptions(&general_options);
if (!ret.isOK()) {
return ret;
}
#if defined(_WIN32)
moe::OptionSection windows_scm_options("Windows Service Control Manager options");
ret = addWindowsServerOptions(&windows_scm_options);
if (!ret.isOK()) {
return ret;
}
#endif
moe::OptionSection rs_options("Replica set options");
moe::OptionSection replication_options("Replication options");
moe::OptionSection sharding_options("Sharding options");
moe::OptionSection storage_options("Storage options");
// Authentication Options
// Way to enable or disable auth on command line and in Legacy config file
general_options.addOptionChaining("auth", "auth", moe::Switch, "run with security")
.setSources(moe::SourceAllLegacy)
.incompatibleWith("noauth");
// IP Whitelisting Options
general_options
.addOptionChaining("security.clusterIpSourceWhitelist",
"clusterIpSourceWhitelist",
moe::StringVector,
"Network CIDR specification of permitted origin for `__system` access.")
.composing();
// Way to enable or disable auth in JSON Config
general_options
.addOptionChaining(
"security.authorization",
"",
moe::String,
"How the database behaves with respect to authorization of clients. "
"Options are \"disabled\", which means that authorization checks are not "
"performed, and \"enabled\" which means that a client cannot perform actions it is "
"not authorized to do.")
.setSources(moe::SourceYAMLConfig)
.format("(:?disabled)|(:?enabled)", "(disabled/enabled)");
// setParameter parameters that we want as config file options
// TODO: Actually read these into our environment. Currently they have no effect
general_options.addOptionChaining("security.authSchemaVersion", "", moe::String, "TODO")
.setSources(moe::SourceYAMLConfig);
general_options.addOptionChaining("security.enableLocalhostAuthBypass", "", moe::String, "TODO")
.setSources(moe::SourceYAMLConfig);
// Diagnostic Options
general_options.addOptionChaining("profile", "profile", moe::Int, "0=off 1=slow, 2=all")
.setSources(moe::SourceAllLegacy);
general_options
.addOptionChaining("operationProfiling.mode", "", moe::String, "(off/slowOp/all)")
.setSources(moe::SourceYAMLConfig)
.format("(:?off)|(:?slowOp)|(:?all)", "(off/slowOp/all)");
general_options
.addOptionChaining(
"cpu", "cpu", moe::Switch, "periodically show cpu and iowait utilization")
.setSources(moe::SourceAllLegacy);
general_options
.addOptionChaining(
"sysinfo", "sysinfo", moe::Switch, "print some diagnostic system information")
.setSources(moe::SourceAllLegacy);
// Storage Options
storage_options.addOptionChaining(
"storage.engine",
"storageEngine",
moe::String,
"what storage engine to use - defaults to wiredTiger if no data files present");
#ifdef _WIN32
boost::filesystem::path currentPath = boost::filesystem::current_path();
std::string defaultPath = currentPath.root_name().string() + storageGlobalParams.kDefaultDbPath;
storage_options.addOptionChaining("storage.dbPath",
"dbpath",
moe::String,
std::string("directory for datafiles - defaults to ") +
storageGlobalParams.kDefaultDbPath + " which is " +
defaultPath + " based on the current working drive");
#else
storage_options.addOptionChaining("storage.dbPath",
"dbpath",
moe::String,
std::string("directory for datafiles - defaults to ") +
storageGlobalParams.kDefaultDbPath);
#endif
storage_options.addOptionChaining("storage.directoryPerDB",
"directoryperdb",
moe::Switch,
"each database will be stored in a separate directory");
storage_options
.addOptionChaining("storage.queryableBackupMode",
"queryableBackupMode",
moe::Switch,
"enable read-only mode - if true the server will not accept writes.")
.setSources(moe::SourceAll)
.hidden();
storage_options
.addOptionChaining("storage.groupCollections",
"groupCollections",
moe::Switch,
"group collections - if true the storage engine may group "
"collections within a database into a shared record store.")
.hidden();
// Only allow `noIndexBuildRetry` on standalones to quickly access data. Running with
// `noIndexBuildRetry` is risky in a live replica set. For example, trying to drop a
// collection that did not have its indexes rebuilt results in a crash.
general_options
.addOptionChaining("noIndexBuildRetry",
"noIndexBuildRetry",
moe::Switch,
"don't retry any index builds that were interrupted by shutdown")
.setSources(moe::SourceAllLegacy)
.incompatibleWith("replication.replSet")
.incompatibleWith("replication.replSetName");
general_options
.addOptionChaining("storage.indexBuildRetry",
"",
moe::Bool,
"don't retry any index builds that were interrupted by shutdown")
.setSources(moe::SourceYAMLConfig)
.incompatibleWith("replication.replSet")
.incompatibleWith("replication.replSetName");
storage_options
.addOptionChaining("noprealloc",
"noprealloc",
moe::Switch,
"disable data file preallocation - will often hurt performance")
.setSources(moe::SourceAllLegacy);
storage_options
.addOptionChaining("storage.syncPeriodSecs",
"syncdelay",
moe::Double,
"seconds between disk syncs (0=never, but not recommended)")
.setDefault(moe::Value(60.0));
// Upgrade and repair are disallowed in JSON configs since they trigger very heavyweight
// actions rather than specify configuration data
storage_options.addOptionChaining("upgrade", "upgrade", moe::Switch, "upgrade db if needed")
.setSources(moe::SourceAllLegacy);
storage_options.addOptionChaining("repair", "repair", moe::Switch, "run repair on all dbs")
.setSources(moe::SourceAllLegacy);
// Javascript Options
general_options
.addOptionChaining("noscripting", "noscripting", moe::Switch, "disable scripting engine")
.setSources(moe::SourceAllLegacy);
general_options
.addOptionChaining(
"security.javascriptEnabled", "", moe::Bool, "Enable javascript execution")
.setSources(moe::SourceYAMLConfig);
// Query Options
general_options
.addOptionChaining("notablescan", "notablescan", moe::Switch, "do not allow table scans")
.setSources(moe::SourceAllLegacy);
// Journaling Options
// Way to enable or disable journaling on command line and in Legacy config file
storage_options.addOptionChaining("journal", "journal", moe::Switch, "enable journaling")
.setSources(moe::SourceAllLegacy);
storage_options
.addOptionChaining("nojournal",
"nojournal",
moe::Switch,
"disable journaling (journaling is on by default for 64 bit)")
.setSources(moe::SourceAllLegacy);
storage_options.addOptionChaining("dur", "dur", moe::Switch, "enable journaling")
.hidden()
.setSources(moe::SourceAllLegacy);
storage_options.addOptionChaining("nodur", "nodur", moe::Switch, "disable journaling")
.hidden()
.setSources(moe::SourceAllLegacy);
// Way to enable or disable journaling in JSON Config
general_options.addOptionChaining("storage.journal.enabled", "", moe::Bool, "enable journaling")
.setSources(moe::SourceYAMLConfig);
#if defined(__linux__)
general_options.addOptionChaining(
"shutdown", "shutdown", moe::Switch, "kill a running server (for init scripts)");
#endif
// Replication Options
replication_options.addOptionChaining(
"replication.oplogSizeMB",
"oplogSize",
moe::Int,
"size to use (in MB) for replication op log. default is 5% of disk space "
"(i.e. large is good)");
rs_options
.addOptionChaining("replication.replSet",
"replSet",
moe::String,
"arg is <setname>[/<optionalseedhostlist>]")
.setSources(moe::SourceAllLegacy);
rs_options.addOptionChaining("replication.replSetName", "", moe::String, "arg is <setname>")
.setSources(moe::SourceYAMLConfig)
.format("[^/]+", "[replica set name with no \"/\"]");
rs_options
.addOptionChaining("replication.secondaryIndexPrefetch",
"replIndexPrefetch",
moe::String,
"specify index prefetching behavior (if secondary) [none|_id_only|all]")
.format("(:?none)|(:?_id_only)|(:?all)", "(none/_id_only/all)");
// `enableMajorityReadConcern` is enabled by default starting in 3.6.
rs_options
.addOptionChaining("replication.enableMajorityReadConcern",
"enableMajorityReadConcern",
moe::Bool,
"enables majority readConcern")
.setDefault(moe::Value(true))
.setImplicit(moe::Value(true));
replication_options.addOptionChaining(
"master", "master", moe::Switch, "Master/slave replication no longer supported");
replication_options.addOptionChaining(
"slave", "slave", moe::Switch, "Master/slave replication no longer supported");
// Sharding Options
sharding_options
.addOptionChaining("configsvr",
"configsvr",
moe::Switch,
"declare this is a config db of a cluster; default port 27019; "
"default dir /data/configdb")
.setSources(moe::SourceAllLegacy)
.incompatibleWith("shardsvr")
.incompatibleWith("nojournal");
sharding_options
.addOptionChaining("shardsvr",
"shardsvr",
moe::Switch,
"declare this is a shard db of a cluster; default port 27018")
.setSources(moe::SourceAllLegacy)
.incompatibleWith("configsvr");
sharding_options
.addOptionChaining(
"sharding.clusterRole",
"",
moe::String,
"Choose what role this mongod has in a sharded cluster. Possible values are:\n"
" \"configsvr\": Start this node as a config server. Starts on port 27019 by "
"default."
" \"shardsvr\": Start this node as a shard server. Starts on port 27018 by "
"default.")
.setSources(moe::SourceYAMLConfig)
.format("(:?configsvr)|(:?shardsvr)", "(configsvr/shardsvr)");
sharding_options
.addOptionChaining(
"sharding._overrideShardIdentity",
"",
moe::String,
"overrides the shardIdentity document settings stored in the local storage with "
"a MongoDB Extended JSON document in string format")
.setSources(moe::SourceYAMLConfig)
.incompatibleWith("configsvr")
.requires("storage.queryableBackupMode");
sharding_options
.addOptionChaining("noMoveParanoia",
"noMoveParanoia",
moe::Switch,
"turn off paranoid saving of data for the moveChunk command; default")
.hidden()
.setSources(moe::SourceAllLegacy)
.incompatibleWith("moveParanoia");
sharding_options
.addOptionChaining("moveParanoia",
"moveParanoia",
moe::Switch,
"turn on paranoid saving of data during the moveChunk command "
"(used for internal system diagnostics)")
.hidden()
.setSources(moe::SourceAllLegacy)
.incompatibleWith("noMoveParanoia");
sharding_options
.addOptionChaining("sharding.archiveMovedChunks",
"",
moe::Bool,
"config file option to turn on paranoid saving of data during the "
"moveChunk command (used for internal system diagnostics)")
.hidden()
.setSources(moe::SourceYAMLConfig);
options->addSection(general_options).transitional_ignore();
#if defined(_WIN32)
options->addSection(windows_scm_options).transitional_ignore();
#endif
options->addSection(replication_options).transitional_ignore();
options->addSection(rs_options).transitional_ignore();
options->addSection(sharding_options).transitional_ignore();
options->addSection(storage_options).transitional_ignore();
// The following are legacy options that are disallowed in the JSON config file
// This is a deprecated option that we are supporting for backwards compatibility
// The first value for this option can be either 'dbpath' or 'run'.
// If it is 'dbpath', mongod prints the dbpath and exits. Any extra values are ignored.
// If it is 'run', mongod runs normally. Providing extra values is an error.
options->addOptionChaining("command", "command", moe::StringVector, "command")
.hidden()
.positional(1, 3)
.setSources(moe::SourceAllLegacy);
options
->addOptionChaining("cacheSize", "cacheSize", moe::Long, "cache size (in MB) for rec store")
.hidden()
.setSources(moe::SourceAllLegacy);
// deprecated pairing command line options
options->addOptionChaining("pairwith", "pairwith", moe::Switch, "DEPRECATED")
.hidden()
.setSources(moe::SourceAllLegacy);
options->addOptionChaining("arbiter", "arbiter", moe::Switch, "DEPRECATED")
.hidden()
.setSources(moe::SourceAllLegacy);
options->addOptionChaining("opIdMem", "opIdMem", moe::Switch, "DEPRECATED")
.hidden()
.setSources(moe::SourceAllLegacy);
return Status::OK();
}
void printMongodHelp(const moe::OptionSection& options) {
std::cout << options.helpString() << std::endl;
};
namespace {
void sysRuntimeInfo() {
#if defined(_SC_PAGE_SIZE)
log() << " page size: " << (int)sysconf(_SC_PAGE_SIZE);
#endif
#if defined(_SC_PHYS_PAGES)
log() << " _SC_PHYS_PAGES: " << sysconf(_SC_PHYS_PAGES);
#endif
#if defined(_SC_AVPHYS_PAGES)
log() << " _SC_AVPHYS_PAGES: " << sysconf(_SC_AVPHYS_PAGES);
#endif
}
} // namespace
bool handlePreValidationMongodOptions(const moe::Environment& params,
const std::vector<std::string>& args) {
if (params.count("help") && params["help"].as<bool>() == true) {
printMongodHelp(moe::startupOptions);
return false;
}
if (params.count("version") && params["version"].as<bool>() == true) {
setPlainConsoleLogger();
auto&& vii = VersionInfoInterface::instance();
log() << mongodVersion(vii);
vii.logBuildInfo();
return false;
}
if (params.count("sysinfo") && params["sysinfo"].as<bool>() == true) {
setPlainConsoleLogger();
sysRuntimeInfo();
return false;
}
if (params.count("master") || params.count("slave")) {
severe() << "Master/slave replication is no longer supported";
return false;
}
return true;
}
Status validateMongodOptions(const moe::Environment& params) {
Status ret = validateServerOptions(params);
if (!ret.isOK()) {
return ret;
}
if ((params.count("nodur") || params.count("nojournal")) &&
(params.count("dur") || params.count("journal"))) {
return Status(ErrorCodes::BadValue,
"Can't specify both --journal and --nojournal options.");
}
#ifdef _WIN32
if (params.count("install") || params.count("reinstall")) {
if (params.count("storage.dbPath") &&
!boost::filesystem::path(params["storage.dbPath"].as<std::string>()).is_absolute()) {
return Status(ErrorCodes::BadValue,
"dbPath requires an absolute file path with Windows services");
}
}
#endif
if (params.count("storage.queryableBackupMode")) {
// Command line options that are disallowed when --queryableBackupMode is specified.
for (const auto& disallowedOption :
{"replication.replSet", "configsvr", "upgrade", "repair", "profile"}) {
if (params.count(disallowedOption)) {
return Status(ErrorCodes::BadValue,
str::stream() << "Cannot specify both queryable backup mode and "
<< disallowedOption);
}
}
bool isClusterRoleShard = params.count("shardsvr");
if (params.count("sharding.clusterRole")) {
auto clusterRole = params["sharding.clusterRole"].as<std::string>();
isClusterRoleShard = isClusterRoleShard || (clusterRole == "shardsvr");
}
if (isClusterRoleShard && !params.count("sharding._overrideShardIdentity")) {
return Status(
ErrorCodes::BadValue,
"shardsvr cluster role with queryableBackupMode requires _overrideShardIdentity");
}
}
return Status::OK();
}
Status canonicalizeMongodOptions(moe::Environment* params) {
Status ret = canonicalizeServerOptions(params);
if (!ret.isOK()) {
return ret;
}
// "storage.journal.enabled" comes from the config file, so override it if any of "journal",
// "nojournal", "dur", and "nodur" are set, since those come from the command line.
if (params->count("journal")) {
Status ret =
params->set("storage.journal.enabled", moe::Value((*params)["journal"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("journal");
if (!ret.isOK()) {
return ret;
}
}
if (params->count("nojournal")) {
Status ret =
params->set("storage.journal.enabled", moe::Value(!(*params)["nojournal"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("nojournal");
if (!ret.isOK()) {
return ret;
}
}
if (params->count("dur")) {
Status ret =
params->set("storage.journal.enabled", moe::Value((*params)["dur"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("dur");
if (!ret.isOK()) {
return ret;
}
}
if (params->count("nodur")) {
Status ret =
params->set("storage.journal.enabled", moe::Value(!(*params)["nodur"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("nodur");
if (!ret.isOK()) {
return ret;
}
}
// "security.authorization" comes from the config file, so override it if "auth" is
// set since those come from the command line.
if (params->count("auth")) {
Status ret =
params->set("security.authorization",
(*params)["auth"].as<bool>() ? moe::Value(std::string("enabled"))
: moe::Value(std::string("disabled")));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("auth");
if (!ret.isOK()) {
return ret;
}
}
// "sharding.archiveMovedChunks" comes from the config file, so override it if
// "noMoveParanoia" or "moveParanoia" are set since those come from the command line.
if (params->count("noMoveParanoia")) {
Status ret = params->set("sharding.archiveMovedChunks",
moe::Value(!(*params)["noMoveParanoia"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("noMoveParanoia");
if (!ret.isOK()) {
return ret;
}
}
if (params->count("moveParanoia")) {
Status ret = params->set("sharding.archiveMovedChunks",
moe::Value((*params)["moveParanoia"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("moveParanoia");
if (!ret.isOK()) {
return ret;
}
}
// "sharding.clusterRole" comes from the config file, so override it if "configsvr" or
// "shardsvr" are set since those come from the command line.
if (params->count("configsvr")) {
if ((*params)["configsvr"].as<bool>() == false) {
// Handle the case where "configsvr" comes from the legacy config file and is set to
// false. This option is not allowed in the YAML config.
return Status(ErrorCodes::BadValue,
"configsvr option cannot be set to false in config file");
}
Status ret = params->set("sharding.clusterRole", moe::Value(std::string("configsvr")));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("configsvr");
if (!ret.isOK()) {
return ret;
}
}
if (params->count("shardsvr")) {
if ((*params)["shardsvr"].as<bool>() == false) {
// Handle the case where "shardsvr" comes from the legacy config file and is set to
// false. This option is not allowed in the YAML config.
return Status(ErrorCodes::BadValue,
"shardsvr option cannot be set to false in config file");
}
Status ret = params->set("sharding.clusterRole", moe::Value(std::string("shardsvr")));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("shardsvr");
if (!ret.isOK()) {
return ret;
}
}
if (params->count("profile")) {
int profilingMode;
Status ret = params->get("profile", &profilingMode);
if (!ret.isOK()) {
return ret;
}
std::string profilingModeString;
if (profilingMode == 0) {
profilingModeString = "off";
} else if (profilingMode == 1) {
profilingModeString = "slowOp";
} else if (profilingMode == 2) {
profilingModeString = "all";
} else {
StringBuilder sb;
sb << "Bad value for profile: " << profilingMode
<< ". Supported modes are: (0=off|1=slowOp|2=all)";
return Status(ErrorCodes::BadValue, sb.str());
}
ret = params->set("operationProfiling.mode", moe::Value(profilingModeString));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("profile");
if (!ret.isOK()) {
return ret;
}
}
// "storage.indexBuildRetry" comes from the config file, so override it if
// "noIndexBuildRetry" is set since that comes from the command line.
if (params->count("noIndexBuildRetry")) {
Status ret = params->set("storage.indexBuildRetry",
moe::Value(!(*params)["noIndexBuildRetry"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("noIndexBuildRetry");
if (!ret.isOK()) {
return ret;
}
}
// Ensure that "replication.replSet" logically overrides "replication.replSetName". We
// can't canonicalize them as the same option, because they mean slightly different things.
// "replication.replSet" can include a seed list, while "replication.replSetName" just has
// the replica set name.
if (params->count("replication.replSet") && params->count("replication.replSetName")) {
ret = params->remove("replication.replSetName");
if (!ret.isOK()) {
return ret;
}
}
// "security.javascriptEnabled" comes from the config file, so override it if "noscripting"
// is set since that comes from the command line.
if (params->count("noscripting")) {
Status ret = params->set("security.javascriptEnabled",
moe::Value(!(*params)["noscripting"].as<bool>()));
if (!ret.isOK()) {
return ret;
}
ret = params->remove("noscripting");
if (!ret.isOK()) {
return ret;
}
}
return Status::OK();
}
Status storeMongodOptions(const moe::Environment& params) {
Status ret = storeServerOptions(params);
if (!ret.isOK()) {
return ret;
}
// TODO: Integrate these options with their setParameter counterparts
if (params.count("security.authSchemaVersion")) {
return Status(ErrorCodes::BadValue,
"security.authSchemaVersion is currently not supported in config files");
}
if (params.count("security.enableLocalhostAuthBypass")) {
return Status(ErrorCodes::BadValue,
"security.enableLocalhostAuthBypass is currently not supported in config "
"files");
}
if (params.count("storage.engine")) {
storageGlobalParams.engine = params["storage.engine"].as<std::string>();
storageGlobalParams.engineSetByUser = true;
}
if (params.count("storage.dbPath")) {
storageGlobalParams.dbpath = params["storage.dbPath"].as<std::string>();
if (params.count("processManagement.fork") && storageGlobalParams.dbpath[0] != '/') {
// we need to change dbpath if we fork since we change
// cwd to "/"
// fork only exists on *nix
// so '/' is safe
storageGlobalParams.dbpath = serverGlobalParams.cwd + "/" + storageGlobalParams.dbpath;
}
}
#ifdef _WIN32
if (storageGlobalParams.dbpath.size() > 1 &&
storageGlobalParams.dbpath[storageGlobalParams.dbpath.size() - 1] == '/') {
// size() check is for the unlikely possibility of --dbpath "/"
storageGlobalParams.dbpath =
storageGlobalParams.dbpath.erase(storageGlobalParams.dbpath.size() - 1);
}
#endif
if (params.count("operationProfiling.mode")) {
std::string profilingMode = params["operationProfiling.mode"].as<std::string>();
if (profilingMode == "off") {
serverGlobalParams.defaultProfile = 0;
} else if (profilingMode == "slowOp") {
serverGlobalParams.defaultProfile = 1;
} else if (profilingMode == "all") {
serverGlobalParams.defaultProfile = 2;
} else {
StringBuilder sb;
sb << "Bad value for operationProfiling.mode: " << profilingMode
<< ". Supported modes are: (off|slowOp|all)";
return Status(ErrorCodes::BadValue, sb.str());
}
}
if (params.count("storage.syncPeriodSecs")) {
storageGlobalParams.syncdelay = params["storage.syncPeriodSecs"].as<double>();
if (storageGlobalParams.syncdelay < 0 ||
storageGlobalParams.syncdelay > StorageGlobalParams::kMaxSyncdelaySecs) {
return Status(ErrorCodes::BadValue,
str::stream() << "syncdelay out of allowed range (0-"
<< StorageGlobalParams::kMaxSyncdelaySecs
<< "s)");
}
}
if (params.count("storage.directoryPerDB")) {
storageGlobalParams.directoryperdb = params["storage.directoryPerDB"].as<bool>();
}
if (params.count("storage.queryableBackupMode") &&
params["storage.queryableBackupMode"].as<bool>()) {
storageGlobalParams.readOnly = true;
storageGlobalParams.dur = false;
}
if (params.count("storage.groupCollections")) {
storageGlobalParams.groupCollections = params["storage.groupCollections"].as<bool>();
}
if (params.count("cpu")) {
serverGlobalParams.cpu = params["cpu"].as<bool>();
}
if (params.count("storage.journal.enabled")) {
storageGlobalParams.dur = params["storage.journal.enabled"].as<bool>();
}
if (params.count("storage.journal.commitIntervalMs")) {
// don't check if dur is false here as many will just use the default, and will default
// to off on win32. ie no point making life a little more complex by giving an error on
// a dev environment.
auto journalCommitIntervalMs = params["storage.journal.commitIntervalMs"].as<int>();
storageGlobalParams.journalCommitIntervalMs.store(journalCommitIntervalMs);
if (journalCommitIntervalMs < 1 ||
journalCommitIntervalMs > StorageGlobalParams::kMaxJournalCommitIntervalMs) {
return Status(ErrorCodes::BadValue,
str::stream() << "--journalCommitInterval out of allowed range (1-"
<< StorageGlobalParams::kMaxJournalCommitIntervalMs
<< "ms)");
}
}
if (params.count("security.javascriptEnabled")) {
mongodGlobalParams.scriptingEnabled = params["security.javascriptEnabled"].as<bool>();
}
if (params.count("security.clusterIpSourceWhitelist")) {
mongodGlobalParams.whitelistedClusterNetwork = std::vector<std::string>();
for (const std::string& whitelistEntry :
params["security.clusterIpSourceWhitelist"].as<std::vector<std::string>>()) {
std::vector<std::string> intermediates;
splitStringDelim(whitelistEntry, &intermediates, ',');
std::copy(intermediates.begin(),
intermediates.end(),
std::back_inserter(*mongodGlobalParams.whitelistedClusterNetwork));
}
}
if (params.count("repair") && params["repair"].as<bool>() == true) {
storageGlobalParams.upgrade = 1; // --repair implies --upgrade
storageGlobalParams.repair = 1;
}
if (params.count("upgrade") && params["upgrade"].as<bool>() == true) {
storageGlobalParams.upgrade = 1;
}
if (params.count("notablescan")) {
storageGlobalParams.noTableScan.store(params["notablescan"].as<bool>());
}
repl::ReplSettings replSettings;
if (params.count("replication.replSetName")) {
replSettings.setReplSetString(params["replication.replSetName"].as<std::string>().c_str());
}
if (params.count("replication.replSet")) {
/* seed list of hosts for the repl set */
replSettings.setReplSetString(params["replication.replSet"].as<std::string>().c_str());
}
if (params.count("replication.secondaryIndexPrefetch")) {
replSettings.setPrefetchIndexMode(
params["replication.secondaryIndexPrefetch"].as<std::string>());
}
if (params.count("replication.enableMajorityReadConcern")) {
serverGlobalParams.enableMajorityReadConcern =
params["replication.enableMajorityReadConcern"].as<bool>();
}
if (params.count("storage.indexBuildRetry")) {
serverGlobalParams.indexBuildRetry = params["storage.indexBuildRetry"].as<bool>();
}
if (params.count("replication.oplogSizeMB")) {
long long x = params["replication.oplogSizeMB"].as<int>();
if (x <= 0) {
return Status(ErrorCodes::BadValue,
str::stream() << "bad --oplogSize, arg must be greater than 0,"
"found: "
<< x);
}
// note a small size such as x==1 is ok for an arbiter.
if (x > 1000 && sizeof(void*) == 4) {
StringBuilder sb;
sb << "--oplogSize of " << x
<< "MB is too big for 32 bit version. Use 64 bit build instead.";
return Status(ErrorCodes::BadValue, sb.str());
}
replSettings.setOplogSizeBytes(x * 1024 * 1024);
invariant(replSettings.getOplogSizeBytes() > 0);
}
if (params.count("cacheSize")) {
long x = params["cacheSize"].as<long>();
if (x <= 0) {
return Status(ErrorCodes::BadValue, "bad --cacheSize arg");
}
return Status(ErrorCodes::BadValue, "--cacheSize option not currently supported");
}
if (!params.count("net.port")) {
if (params.count("sharding.clusterRole")) {
std::string clusterRole = params["sharding.clusterRole"].as<std::string>();
if (clusterRole == "configsvr") {
serverGlobalParams.port = ServerGlobalParams::ConfigServerPort;
} else if (clusterRole == "shardsvr") {
serverGlobalParams.port = ServerGlobalParams::ShardServerPort;
} else {
StringBuilder sb;
sb << "Bad value for sharding.clusterRole: " << clusterRole
<< ". Supported modes are: (configsvr|shardsvr)";
return Status(ErrorCodes::BadValue, sb.str());
}
}
} else {
if (serverGlobalParams.port < 0 || serverGlobalParams.port > 65535) {
return Status(ErrorCodes::BadValue, "bad --port number");
}
}
if (params.count("sharding.clusterRole")) {
auto clusterRoleParam = params["sharding.clusterRole"].as<std::string>();
if (clusterRoleParam == "configsvr") {
serverGlobalParams.clusterRole = ClusterRole::ConfigServer;
if (params.count("replication.enableMajorityReadConcern") &&
!params["replication.enableMajorityReadConcern"].as<bool>()) {
warning()
<< "Config servers require majority read concern, but it was explicitly "
"disabled. The override is being ignored and the process is continuing "
"with majority read concern enabled.";
}
serverGlobalParams.enableMajorityReadConcern = true;
// If we haven't explicitly specified a journal option, default journaling to true for
// the config server role
if (!params.count("storage.journal.enabled")) {
storageGlobalParams.dur = true;
}
if (!params.count("storage.dbPath")) {
storageGlobalParams.dbpath = storageGlobalParams.kDefaultConfigDbPath;
}
} else if (clusterRoleParam == "shardsvr") {
serverGlobalParams.clusterRole = ClusterRole::ShardServer;
}
}
if (params.count("sharding.archiveMovedChunks")) {
serverGlobalParams.moveParanoia = params["sharding.archiveMovedChunks"].as<bool>();
}
if (params.count("sharding._overrideShardIdentity")) {
auto docAsString = params["sharding._overrideShardIdentity"].as<std::string>();
try {
serverGlobalParams.overrideShardIdentity = fromjson(docAsString);
} catch (const DBException& exception) {
return exception.toStatus(
"Error encountered while parsing _overrideShardIdentity JSON document");
}
}
if (params.count("pairwith") || params.count("arbiter") || params.count("opIdMem")) {
return Status(ErrorCodes::BadValue,
"****\n"
"Replica Pairs have been deprecated. Invalid options: "
"--pairwith, --arbiter, and/or --opIdMem\n"
"<http://dochub.mongodb.org/core/replicapairs>\n"
"****");
}
#ifdef _WIN32
// If dbPath is a default value, prepend with drive name so log entries are explicit
// We must resolve the dbpath before it stored in repairPath in the default case.
if (storageGlobalParams.dbpath == storageGlobalParams.kDefaultDbPath ||
storageGlobalParams.dbpath == storageGlobalParams.kDefaultConfigDbPath) {
boost::filesystem::path currentPath = boost::filesystem::current_path();
storageGlobalParams.dbpath = currentPath.root_name().string() + storageGlobalParams.dbpath;
}
#endif
// Check if we are 32 bit and have not explicitly specified any journaling options
if (sizeof(void*) == 4 && !params.count("storage.journal.enabled")) {
// trying to make this stand out more like startup warnings
log() << endl;
warning() << "32-bit servers don't have journaling enabled by default. "
<< "Please use --journal if you want durability.";
log() << endl;
}
bool isClusterRoleShard = params.count("shardsvr");
bool isClusterRoleConfig = params.count("configsvr");
if (params.count("sharding.clusterRole")) {
auto clusterRole = params["sharding.clusterRole"].as<std::string>();
isClusterRoleShard = isClusterRoleShard || (clusterRole == "shardsvr");
isClusterRoleConfig = isClusterRoleConfig || (clusterRole == "configsvr");
}
if ((isClusterRoleShard || isClusterRoleConfig) && skipShardingConfigurationChecks) {
auto clusterRoleStr = isClusterRoleConfig ? "--configsvr" : "--shardsvr";
return Status(ErrorCodes::BadValue,
str::stream() << "Can not specify " << clusterRoleStr
<< " and set skipShardingConfigurationChecks=true");
}
setGlobalReplSettings(replSettings);
return Status::OK();
}
} // namespace mongo
|