-
Notifications
You must be signed in to change notification settings - Fork 105
/
stores.rs
995 lines (906 loc) · 35.7 KB
/
stores.rs
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
// Copyright 2024 The NativeLink Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use serde::{Deserialize, Serialize};
use crate::serde_utils::{
convert_data_size_with_shellexpand, convert_duration_with_shellexpand,
convert_numeric_with_shellexpand, convert_optional_string_with_shellexpand,
convert_string_with_shellexpand, convert_vec_string_with_shellexpand,
};
/// Name of the store. This type will be used when referencing a store
/// in the `CasConfig::stores`'s map key.
pub type StoreRefName = String;
#[allow(non_camel_case_types)]
#[derive(Serialize, Deserialize, Debug, Clone, Copy)]
pub enum ConfigDigestHashFunction {
/// Use the sha256 hash function.
/// <https://en.wikipedia.org/wiki/SHA-2>
sha256,
/// Use the blake3 hash function.
/// <https://en.wikipedia.org/wiki/BLAKE_(hash_function)>
blake3,
}
#[allow(non_camel_case_types)]
#[derive(Serialize, Deserialize, Debug, Clone)]
pub enum StoreConfig {
/// Memory store will store all data in a hashmap in memory.
///
/// **Example JSON Config:**
/// ```json
/// "memory": {
/// "eviction_policy": {
/// // 10mb.
/// "max_bytes": 10000000,
/// }
/// }
/// }
/// ```
///
memory(MemoryStore),
/// S3 store will use Amazon's S3 service as a backend to store
/// the files. This configuration can be used to share files
/// across multiple instances.
///
/// This configuration will never delete files, so you are
/// responsible for purging old files in other ways.
///
/// **Example JSON Config:**
/// ```json
/// "experimental_s3_store": {
/// "region": "eu-north-1",
/// "bucket": "crossplane-bucket-af79aeca9",
/// "key_prefix": "test-prefix-index/",
/// "retry": {
/// "max_retries": 6,
/// "delay": 0.3,
/// "jitter": 0.5
/// },
/// "multipart_max_concurrent_uploads": 10
/// }
/// ```
///
experimental_s3_store(S3Store),
/// Verify store is used to apply verifications to an underlying
/// store implementation. It is strongly encouraged to validate
/// as much data as you can before accepting data from a client,
/// failing to do so may cause the data in the store to be
/// populated with invalid data causing all kinds of problems.
///
/// The suggested configuration is to have the CAS validate the
/// hash and size and the AC validate nothing.
///
/// **Example JSON Config:**
/// ```json
/// "verify": {
/// "memory": {
/// "eviction_policy": {
/// "max_bytes": 500000000 // 500mb.
/// }
/// },
/// "verify_size": true,
/// "hash_verification_function": "sha256"
/// }
/// ```
///
verify(Box<VerifyStore>),
/// Completeness checking store verifies if the
/// output files & folders exist in the CAS before forwarding
/// the request to the underlying store.
/// Note: This store should only be used on AC stores.
///
/// **Example JSON Config:**
/// ```json
/// "completeness_checking": {
/// "backend": {
/// "filesystem": {
/// "content_path": "~/.cache/nativelink/content_path-ac",
/// "temp_path": "~/.cache/nativelink/tmp_path-ac",
/// "eviction_policy": {
/// // 500mb.
/// "max_bytes": 500000000,
/// }
/// }
/// },
/// "cas_store": {
/// "ref_store": {
/// "name": "CAS_MAIN_STORE"
/// }
/// }
/// }
/// ```
///
completeness_checking(Box<CompletenessCheckingStore>),
/// A compression store that will compress the data inbound and
/// outbound. There will be a non-trivial cost to compress and
/// decompress the data, but in many cases if the final store is
/// a store that requires network transport and/or storage space
/// is a concern it is often faster and more efficient to use this
/// store before those stores.
///
/// **Example JSON Config:**
/// ```json
/// "compression": {
/// "compression_algorithm": {
/// "lz4": {}
/// },
/// "backend": {
/// "filesystem": {
/// "content_path": "/tmp/nativelink/data/content_path-cas",
/// "temp_path": "/tmp/nativelink/data/tmp_path-cas",
/// "eviction_policy": {
/// // 2gb.
/// "max_bytes": 2000000000,
/// }
/// }
/// }
/// }
/// ```
///
compression(Box<CompressionStore>),
/// A dedup store will take the inputs and run a rolling hash
/// algorithm on them to slice the input into smaller parts then
/// run a sha256 algorithm on the slice and if the object doesn't
/// already exist, upload the slice to the `content_store` using
/// a new digest of just the slice. Once all parts exist, an
/// Action-Cache-like digest will be built and uploaded to the
/// `index_store` which will contain a reference to each
/// chunk/digest of the uploaded file. Downloading a request will
/// first grab the index from the `index_store`, and forward the
/// download content of each chunk as if it were one file.
///
/// This store is exceptionally good when the following conditions
/// are met:
/// * Content is mostly the same (inserts, updates, deletes are ok)
/// * Content is not compressed or encrypted
/// * Uploading or downloading from `content_store` is the bottleneck.
///
/// Note: This store pairs well when used with CompressionStore as
/// the `content_store`, but never put DedupStore as the backend of
/// CompressionStore as it will negate all the gains.
///
/// Note: When running `.has()` on this store, it will only check
/// to see if the entry exists in the `index_store` and not check
/// if the individual chunks exist in the `content_store`.
///
/// **Example JSON Config:**
/// ```json
/// "dedup": {
/// "index_store": {
/// "memory_store": {
/// "max_size": 1000000000, // 1GB
/// "eviction_policy": "LeastRecentlyUsed"
/// }
/// },
/// "content_store": {
/// "compression": {
/// "compression_algorithm": {
/// "lz4": {}
/// },
/// "backend": {
/// "fast_slow": {
/// "fast": {
/// "memory_store": {
/// "max_size": 500000000, // 500MB
/// "eviction_policy": "LeastRecentlyUsed"
/// }
/// },
/// "slow": {
/// "filesystem": {
/// "content_path": "/tmp/nativelink/data/content_path-content",
/// "temp_path": "/tmp/nativelink/data/tmp_path-content",
/// "eviction_policy": {
/// "max_bytes": 2000000000 // 2gb.
/// }
/// }
/// }
/// }
/// }
/// }
/// }
/// }
/// ```
///
dedup(Box<DedupStore>),
/// Existence store will wrap around another store and cache calls
/// to has so that subsequent has_with_results calls will be
/// faster. This is useful for cases when you have a store that
/// is slow to respond to has calls.
/// Note: This store should only be used on CAS stores.
///
/// **Example JSON Config:**
/// ```json
/// "existence_cache": {
/// "backend": {
/// "memory": {
/// "eviction_policy": {
/// // 500mb.
/// "max_bytes": 500000000,
/// }
/// }
/// },
/// "cas_store": {
/// "ref_store": {
/// "name": "CAS_MAIN_STORE"
/// }
/// }
/// }
/// ```
///
existence_cache(Box<ExistenceCacheStore>),
/// FastSlow store will first try to fetch the data from the `fast`
/// store and then if it does not exist try the `slow` store.
/// When the object does exist in the `slow` store, it will copy
/// the data to the `fast` store while returning the data.
/// This store should be thought of as a store that "buffers"
/// the data to the `fast` store.
/// On uploads it will mirror data to both `fast` and `slow` stores.
///
/// WARNING: If you need data to always exist in the `slow` store
/// for something like remote execution, be careful because this
/// store will never check to see if the objects exist in the
/// `slow` store if it exists in the `fast` store (ie: it assumes
/// that if an object exists `fast` store it will exist in `slow`
/// store).
///
/// ***Example JSON Config:***
/// ```json
/// "fast_slow": {
/// "fast": {
/// "filesystem": {
/// "content_path": "/tmp/nativelink/data/content_path-index",
/// "temp_path": "/tmp/nativelink/data/tmp_path-index",
/// "eviction_policy": {
/// // 500mb.
/// "max_bytes": 500000000,
/// }
/// }
/// },
/// "slow": {
/// "filesystem": {
/// "content_path": "/tmp/nativelink/data/content_path-index",
/// "temp_path": "/tmp/nativelink/data/tmp_path-index",
/// "eviction_policy": {
/// // 500mb.
/// "max_bytes": 500000000,
/// }
/// }
/// }
/// }
/// ```
///
fast_slow(Box<FastSlowStore>),
/// Shards the data to multiple stores. This is useful for cases
/// when you want to distribute the load across multiple stores.
/// The digest hash is used to determine which store to send the
/// data to.
///
/// **Example JSON Config:**
/// ```json
/// "shard": {
/// "stores": [
/// "memory": {
/// "eviction_policy": {
/// // 10mb.
/// "max_bytes": 10000000
/// },
/// "weight": 1
/// }
/// ]
/// }
/// ```
///
shard(ShardStore),
/// Stores the data on the filesystem. This store is designed for
/// local persistent storage. Restarts of this program should restore
/// the previous state, meaning anything uploaded will be persistent
/// as long as the filesystem integrity holds. This store uses the
/// filesystem's `atime` (access time) to hold the last touched time
/// of the file(s).
///
/// **Example JSON Config:**
/// ```json
/// "filesystem": {
/// "content_path": "/tmp/nativelink/data-worker-test/content_path-cas",
/// "temp_path": "/tmp/nativelink/data-worker-test/tmp_path-cas",
/// "eviction_policy": {
/// // 10gb.
/// "max_bytes": 10000000000,
/// }
/// }
/// ```
///
filesystem(FilesystemStore),
/// Store used to reference a store in the root store manager.
/// This is useful for cases when you want to share a store in different
/// nested stores. Example, you may want to share the same memory store
/// used for the action cache, but use a FastSlowStore and have the fast
/// store also share the memory store for efficiency.
///
/// **Example JSON Config:**
/// ```json
/// "ref_store": {
/// "name": "FS_CONTENT_STORE"
/// }
/// ```
///
ref_store(RefStore),
/// Uses the size field of the digest to separate which store to send the
/// data. This is useful for cases when you'd like to put small objects
/// in one store and large objects in another store. This should only be
/// used if the size field is the real size of the content, in other
/// words, don't use on AC (Action Cache) stores. Any store where you can
/// safely use VerifyStore.verify_size = true, this store should be safe
/// to use (ie: CAS stores).
///
/// **Example JSON Config:**
/// ```json
/// "size_partitioning": {
/// "size": 134217728, // 128mib.
/// "lower_store": {
/// "memory": {
/// "eviction_policy": {
/// "max_bytes": "${NATIVELINK_CAS_MEMORY_CONTENT_LIMIT:-100000000}"
/// }
/// }
/// },
/// "upper_store": {
/// /// This store discards data larger than 128mib.
/// "noop": {}
/// }
/// }
/// ```
///
size_partitioning(Box<SizePartitioningStore>),
/// This store will pass-through calls to another GRPC store. This store
/// is not designed to be used as a sub-store of another store, but it
/// does satisfy the interface and will likely work.
///
/// One major GOTCHA is that some stores use a special function on this
/// store to get the size of the underlying object, which is only reliable
/// when this store is serving the a CAS store, not an AC store. If using
/// this store directly without being a child of any store there are no
/// side effects and is the most efficient way to use it.
///
/// **Example JSON Config:**
/// ```json
/// "grpc": {
/// "instance_name": "main",
/// "endpoints": [
/// {"address": "grpc://${CAS_ENDPOINT:-127.0.0.1}:50051"}
/// ],
/// "store_type": "ac"
/// }
/// ```
///
grpc(GrpcStore),
/// Stores data in any stores compatible with Redis APIs.
///
/// Pairs well with SizePartitioning and/or FastSlow stores.
/// Ideal for accepting small object sizes as most redis store
/// services have a max file upload of between 256Mb-512Mb.
///
/// **Example JSON Config:**
/// ```json
/// "redis_store": {
/// "addresses": [
/// "redis://127.0.0.1:6379/",
/// ]
/// }
/// ```
///
redis_store(RedisStore),
/// Noop store is a store that sends streams into the void and all data
/// retrieval will return 404 (NotFound). This can be useful for cases
/// where you may need to partition your data and part of your data needs
/// to be discarded.
///
/// **Example JSON Config:**
/// ```json
/// "noop": {}
/// ```
///
noop,
}
/// Configuration for an individual shard of the store.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct ShardConfig {
/// Store to shard the data to.
pub store: StoreConfig,
/// The weight of the store. This is used to determine how much data
/// should be sent to the store. The actual percentage is the sum of
/// all the store's weights divided by the individual store's weight.
///
/// Default: 1
pub weight: Option<u32>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct ShardStore {
/// Stores to shard the data to.
pub stores: Vec<ShardConfig>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct SizePartitioningStore {
/// Size to partition the data on.
#[serde(deserialize_with = "convert_data_size_with_shellexpand")]
pub size: u64,
/// Store to send data when object is < (less than) size.
pub lower_store: StoreConfig,
/// Store to send data when object is >= (less than eq) size.
pub upper_store: StoreConfig,
}
#[derive(Serialize, Deserialize, Debug, Default, Clone)]
#[serde(deny_unknown_fields)]
pub struct RefStore {
/// Name of the store under the root "stores" config object.
#[serde(deserialize_with = "convert_string_with_shellexpand")]
pub name: String,
}
#[derive(Serialize, Deserialize, Debug, Default, Clone)]
#[serde(deny_unknown_fields)]
pub struct FilesystemStore {
/// Path on the system where to store the actual content. This is where
/// the bulk of the data will be placed.
/// On service bootup this folder will be scanned and all files will be
/// added to the cache. In the event one of the files doesn't match the
/// criteria, the file will be deleted.
#[serde(deserialize_with = "convert_string_with_shellexpand")]
pub content_path: String,
/// A temporary location of where files that are being uploaded or
/// deleted will be placed while the content cannot be guaranteed to be
/// accurate. This location must be on the same block device as
/// `content_path` so atomic moves can happen (ie: move without copy).
/// All files in this folder will be deleted on every startup.
#[serde(deserialize_with = "convert_string_with_shellexpand")]
pub temp_path: String,
/// Buffer size to use when reading files. Generally this should be left
/// to the default value except for testing.
/// Default: 32k.
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub read_buffer_size: u32,
/// Policy used to evict items out of the store. Failure to set this
/// value will cause items to never be removed from the store causing
/// infinite memory usage.
pub eviction_policy: Option<EvictionPolicy>,
/// The block size of the filesystem for the running machine
/// value is used to determine an entry's actual size on disk consumed
/// For a 4KB block size filesystem, a 1B file actually consumes 4KB
/// Default: 4096
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub block_size: u64,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct FastSlowStore {
/// Fast store that will be attempted to be contacted before reaching
/// out to the `slow` store.
pub fast: StoreConfig,
/// If the object does not exist in the `fast` store it will try to
/// get it from this store.
pub slow: StoreConfig,
}
#[derive(Serialize, Deserialize, Debug, Default, Clone)]
#[serde(deny_unknown_fields)]
pub struct MemoryStore {
/// Policy used to evict items out of the store. Failure to set this
/// value will cause items to never be removed from the store causing
/// infinite memory usage.
pub eviction_policy: Option<EvictionPolicy>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct DedupStore {
/// Store used to store the index of each dedup slice. This store
/// should generally be fast and small.
pub index_store: StoreConfig,
/// The store where the individual chunks will be uploaded. This
/// store should generally be the slower & larger store.
pub content_store: StoreConfig,
/// Minimum size that a chunk will be when slicing up the content.
/// Note: This setting can be increased to improve performance
/// because it will actually not check this number of bytes when
/// deciding where to partition the data.
///
/// Default: 65536 (64k)
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub min_size: u32,
/// A best-effort attempt will be made to keep the average size
/// of the chunks to this number. It is not a guarantee, but a
/// slight attempt will be made.
///
/// This value will also be about the threshold used to determine
/// if we should even attempt to dedup the entry or just forward
/// it directly to the content_store without an index. The actual
/// value will be about `normal_size * 1.3` due to implementation
/// details.
///
/// Default: 262144 (256k)
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub normal_size: u32,
/// Maximum size a chunk is allowed to be.
///
/// Default: 524288 (512k)
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub max_size: u32,
/// Due to implementation detail, we want to prefer to download
/// the first chunks of the file so we can stream the content
/// out and free up some of our buffers. This configuration
/// will be used to to restrict the number of concurrent chunk
/// downloads at a time per `get()` request.
///
/// This setting will also affect how much memory might be used
/// per `get()` request. Estimated worst case memory per `get()`
/// request is: `max_concurrent_fetch_per_get * max_size`.
///
/// Default: 10
#[serde(default, deserialize_with = "convert_numeric_with_shellexpand")]
pub max_concurrent_fetch_per_get: u32,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct ExistenceCacheStore {
/// The underlying store wrap around. All content will first flow
/// through self before forwarding to backend. In the event there
/// is an error detected in self, the connection to the backend
/// will be terminated, and early termination should always cause
/// updates to fail on the backend.
pub backend: StoreConfig,
/// Policy used to evict items out of the store. Failure to set this
/// value will cause items to never be removed from the store causing
/// infinite memory usage.
pub eviction_policy: Option<EvictionPolicy>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct VerifyStore {
/// The underlying store wrap around. All content will first flow
/// through self before forwarding to backend. In the event there
/// is an error detected in self, the connection to the backend
/// will be terminated, and early termination should always cause
/// updates to fail on the backend.
pub backend: StoreConfig,
/// If set the store will verify the size of the data before accepting
/// an upload of data.
///
/// This should be set to false for AC, but true for CAS stores.
#[serde(default)]
pub verify_size: bool,
/// If the data should be hashed and verify that the key matches the
/// computed hash. The hash function is automatically determined based
/// request and if not set will use the global default.
///
/// This should be set to None for AC, but hashing function like `sha256` for CAS stores.
#[serde(default)]
pub verify_hash: bool,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct CompletenessCheckingStore {
/// The underlying store that will have it's results validated before sending to client.
pub backend: StoreConfig,
/// When a request is made, the results are decoded and all output digests/files are verified
/// to exist in this CAS store before returning success.
pub cas_store: StoreConfig,
}
#[derive(Serialize, Deserialize, Debug, Default, PartialEq, Clone, Copy)]
#[serde(deny_unknown_fields)]
pub struct Lz4Config {
/// Size of the blocks to compress.
/// Higher values require more ram, but might yield slightly better
/// compression ratios.
///
/// Default: 65536 (64k).
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub block_size: u32,
/// Maximum size allowed to attempt to deserialize data into.
/// This is needed because the block_size is embedded into the data
/// so if there was a bad actor, they could upload an extremely large
/// block_size'ed entry and we'd allocate a large amount of memory
/// when retrieving the data. To prevent this from happening, we
/// allow you to specify the maximum that we'll attempt deserialize.
///
/// Default: value in `block_size`.
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub max_decode_block_size: u32,
}
#[allow(non_camel_case_types)]
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
pub enum CompressionAlgorithm {
/// LZ4 compression algorithm is extremely fast for compression and
/// decompression, however does not perform very well in compression
/// ratio. In most cases build artifacts are highly compressible, however
/// lz4 is quite good at aborting early if the data is not deemed very
/// compressible.
///
/// see: <https://lz4.github.io/lz4/>
lz4(Lz4Config),
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct CompressionStore {
/// The underlying store wrap around. All content will first flow
/// through self before forwarding to backend. In the event there
/// is an error detected in self, the connection to the backend
/// will be terminated, and early termination should always cause
/// updates to fail on the backend.
pub backend: StoreConfig,
/// The compression algorithm to use.
pub compression_algorithm: CompressionAlgorithm,
}
/// Eviction policy always works on LRU (Least Recently Used). Any time an entry
/// is touched it updates the timestamp. Inserts and updates will execute the
/// eviction policy removing any expired entries and/or the oldest entries
/// until the store size becomes smaller than max_bytes.
#[derive(Serialize, Deserialize, Debug, Default, Clone)]
#[serde(deny_unknown_fields)]
pub struct EvictionPolicy {
/// Maximum number of bytes before eviction takes place.
/// Default: 0. Zero means never evict based on size.
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub max_bytes: usize,
/// When eviction starts based on hitting max_bytes, continue until
/// max_bytes - evict_bytes is met to create a low watermark. This stops
/// operations from thrashing when the store is close to the limit.
/// Default: 0
#[serde(default, deserialize_with = "convert_data_size_with_shellexpand")]
pub evict_bytes: usize,
/// Maximum number of seconds for an entry to live since it was last
/// accessed before it is evicted.
/// Default: 0. Zero means never evict based on time.
#[serde(default, deserialize_with = "convert_duration_with_shellexpand")]
pub max_seconds: u32,
/// Maximum size of the store before an eviction takes place.
/// Default: 0. Zero means never evict based on count.
#[serde(default, deserialize_with = "convert_numeric_with_shellexpand")]
pub max_count: u64,
}
#[derive(Serialize, Deserialize, Debug, Default, Clone)]
#[serde(deny_unknown_fields)]
pub struct S3Store {
/// S3 region. Usually us-east-1, us-west-2, af-south-1, exc...
#[serde(default, deserialize_with = "convert_string_with_shellexpand")]
pub region: String,
/// Bucket name to use as the backend.
#[serde(default, deserialize_with = "convert_string_with_shellexpand")]
pub bucket: String,
/// If you wish to prefix the location on s3. If None, no prefix will be used.
#[serde(default)]
pub key_prefix: Option<String>,
/// Retry configuration to use when a network request fails.
#[serde(default)]
pub retry: Retry,
/// If the number of seconds since the `last_modified` time of the object
/// is greater than this value, the object will not be considered
/// "existing". This allows for external tools to delete objects that
/// have not been uploaded in a long time. If a client receives a NotFound
/// the client should re-upload the object.
///
/// There should be sufficient buffer time between how long the expiration
/// configuration of the external tool is and this value. Keeping items
/// around for a few days is generally a good idea.
///
/// Default: 0. Zero means never consider an object expired.
#[serde(default, deserialize_with = "convert_duration_with_shellexpand")]
pub consider_expired_after_s: u32,
/// The maximum buffer size to retain in case of a retryable error
/// during upload. Setting this to zero will disable upload buffering;
/// this means that in the event of a failure during upload, the entire
/// upload will be aborted and the client will likely receive an error.
///
/// Default: 5MB.
pub max_retry_buffer_per_request: Option<usize>,
/// Maximum number of concurrent UploadPart requests per MultipartUpload.
///
/// Default: 10.
pub multipart_max_concurrent_uploads: Option<usize>,
/// Allow unencrypted HTTP connections. Only use this for local testing.
///
/// Default: false
#[serde(default)]
pub insecure_allow_http: bool,
/// Disable http/2 connections and only use http/1.1. Default client
/// configuration will have http/1.1 and http/2 enabled for connection
/// schemes. Http/2 should be disabled if environments have poor support
/// or performance related to http/2. Safe to keep default unless
/// underlying network environment or S3 API servers specify otherwise.
///
/// Default: false
#[serde(default)]
pub disable_http2: bool,
}
#[allow(non_camel_case_types)]
#[derive(Serialize, Deserialize, Debug, Clone, Copy)]
pub enum StoreType {
/// The store is content addressable storage.
cas,
/// The store is an action cache.
ac,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct ClientTlsConfig {
/// Path to the certificate authority to use to validate the remote.
#[serde(deserialize_with = "convert_string_with_shellexpand")]
pub ca_file: String,
/// Path to the certificate file for client authentication.
#[serde(deserialize_with = "convert_optional_string_with_shellexpand")]
pub cert_file: Option<String>,
/// Path to the private key file for client authentication.
#[serde(deserialize_with = "convert_optional_string_with_shellexpand")]
pub key_file: Option<String>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct GrpcEndpoint {
/// The endpoint address (i.e. grpc(s)://example.com:443).
#[serde(deserialize_with = "convert_string_with_shellexpand")]
pub address: String,
/// The TLS configuration to use to connect to the endpoint (if grpcs).
pub tls_config: Option<ClientTlsConfig>,
/// The maximum concurrency to allow on this endpoint.
pub concurrency_limit: Option<usize>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(deny_unknown_fields)]
pub struct GrpcStore {
/// Instance name for GRPC calls. Proxy calls will have the instance_name changed to this.
#[serde(default, deserialize_with = "convert_string_with_shellexpand")]
pub instance_name: String,
/// The endpoint of the grpc connection.
pub endpoints: Vec<GrpcEndpoint>,
/// The type of the upstream store, this ensures that the correct server calls are made.
pub store_type: StoreType,
/// Retry configuration to use when a network request fails.
#[serde(default)]
pub retry: Retry,
/// Limit the number of simultaneous upstream requests to this many. A
/// value of zero is treated as unlimited. If the limit is reached the
/// request is queued.
#[serde(default)]
pub max_concurrent_requests: usize,
/// The number of connections to make to each specified endpoint to balance
/// the load over multiple TCP connections. Default 1.
#[serde(default)]
pub connections_per_endpoint: usize,
}
/// The possible error codes that might occur on an upstream request.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub enum ErrorCode {
Cancelled = 1,
Unknown = 2,
InvalidArgument = 3,
DeadlineExceeded = 4,
NotFound = 5,
AlreadyExists = 6,
PermissionDenied = 7,
ResourceExhausted = 8,
FailedPrecondition = 9,
Aborted = 10,
OutOfRange = 11,
Unimplemented = 12,
Internal = 13,
Unavailable = 14,
DataLoss = 15,
Unauthenticated = 16,
// Note: This list is duplicated from nativelink-error/lib.rs.
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct RedisStore {
/// The hostname or IP address of the Redis server.
/// Ex: ["redis://username:password@redis-server-url:6380/99"]
/// 99 Represents database ID, 6380 represents the port.
#[serde(deserialize_with = "convert_vec_string_with_shellexpand")]
pub addresses: Vec<String>,
/// The response timeout for the Redis connection in seconds.
///
/// Default: 10
#[serde(default)]
pub response_timeout_s: u64,
/// The connection timeout for the Redis connection in seconds.
///
/// Default: 10
#[serde(default)]
pub connection_timeout_s: u64,
/// An optional and experimental Redis channel to publish write events to.
///
/// If set, every time a write operation is made to a Redis node
/// then an event will be published to a Redis channel with the given name.
/// If unset, the writes will still be made,
/// but the write events will not be published.
///
/// Default: (Empty String / No Channel)
#[serde(default)]
pub experimental_pub_sub_channel: Option<String>,
/// An optional prefix to prepend to all keys in this store.
///
/// Setting this value can make it convenient to query or
/// organize your data according to the shared prefix.
///
/// Default: (Empty String / No Prefix)
#[serde(default)]
pub key_prefix: String,
/// Set the mode Redis is operating in.
///
/// Available options are "cluster" for
/// [cluster mode](https://redis.io/docs/latest/operate/oss_and_stack/reference/cluster-spec/),
/// "sentinel" for [sentinel mode](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/),
/// or "standard" if Redis is operating in neither cluster nor sentinel mode.
///
/// Default: standard,
#[serde(default)]
pub mode: RedisMode,
}
#[derive(Debug, Default, Deserialize, Serialize, Clone, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum RedisMode {
Cluster,
Sentinel,
#[default]
Standard,
}
/// Retry configuration. This configuration is exponential and each iteration
/// a jitter as a percentage is applied of the calculated delay. For example:
/// ```haskell
/// Retry{
/// max_retries: 7,
/// delay: 0.1,
/// jitter: 0.5,
/// }
/// ```
/// will result in:
/// Attempt - Delay
/// 1 0ms
/// 2 75ms - 125ms
/// 3 150ms - 250ms
/// 4 300ms - 500ms
/// 5 600ms - 1s
/// 6 1.2s - 2s
/// 7 2.4s - 4s
/// 8 4.8s - 8s
/// Remember that to get total results is additive, meaning the above results
/// would mean a single request would have a total delay of 9.525s - 15.875s.
#[derive(Serialize, Deserialize, Clone, Debug, Default)]
#[serde(deny_unknown_fields)]
pub struct Retry {
/// Maximum number of retries until retrying stops.
/// Setting this to zero will always attempt 1 time, but not retry.
#[serde(default, deserialize_with = "convert_numeric_with_shellexpand")]
pub max_retries: usize,
/// Delay in seconds for exponential back off.
#[serde(default)]
pub delay: f32,
/// Amount of jitter to add as a percentage in decimal form. This will
/// change the formula like:
/// ```haskell
/// random(
/// (2 ^ {attempt_number}) * {delay} * (1 - (jitter / 2)),
/// (2 ^ {attempt_number}) * {delay} * (1 + (jitter / 2)),
/// )
/// ```
#[serde(default)]
pub jitter: f32,
/// A list of error codes to retry on, if this is not set then the default
/// error codes to retry on are used. These default codes are the most
/// likely to be non-permanent.
/// - Unknown
/// - Cancelled
/// - DeadlineExceeded
/// - ResourceExhausted
/// - Aborted
/// - Internal
/// - Unavailable
/// - DataLoss
#[serde(default)]
pub retry_on_errors: Option<Vec<ErrorCode>>,
}