Skip to content

Commit

Permalink
Merge pull request #8602 from romayalon/romy-remove-buf-size-configur…
Browse files Browse the repository at this point in the history 
…ation

Remove NSFS_BUF_SIZE from nsfs_config_schema
  • Loading branch information
@romayalon
romayalon authored Dec 17, 2024
2 parents 633d31c + 7cbef82 commit b6269d7
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 42 deletions.
59 changes: 22 additions & 37 deletions docs/NooBaaNonContainerized/ConfigFileCustomizations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,21 +137,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 9. Buffer size -
* <u>Key</u>: `NSFS_BUF_SIZE`
* <u>Type</u>: Number
* <u>Default</u>: 8MB = 8388608 bytes = 8 * 1024 * 1024
* <u>Description</u>: Set Buffer size in order to increase performance of small/large objects requests, service restart required.
* <u>Steps</u>:
```
1. Open /path/to/config_dir/config.json file.
2. Set the config key in bytes-
Example:
"NSFS_BUF_SIZE": 10485760
3. systemctl restart noobaa
```
### 10. Open read mode -
### 9. Open read mode -
* <u>Key</u>: `NSFS_OPEN_READ_MODE`
* <u>Type</u>: String
* <u>Default</u>: 'r'
Expand All @@ -164,7 +150,7 @@ The following list consists of supported optional developer customization -
"NSFS_OPEN_READ_MODE": "rd"
```
### 11. Trigger Check bucket boundaries -
### 10. Trigger Check bucket boundaries -
* <u>Key</u>: `NSFS_CHECK_BUCKET_BOUNDARIES`
* <u>Type</u>: Boolean
* <u>Default</u>: true
Expand All @@ -177,7 +163,7 @@ The following list consists of supported optional developer customization -
"NSFS_CHECK_BUCKET_BOUNDARIES": false
```
### 12. Trigger Fsync -
### 11. Trigger Fsync -
* <u>Key</u>: `NSFS_TRIGGER_FSYNC`
* <u>Type</u>: Boolean
* <u>Default</u>: true
Expand All @@ -190,7 +176,7 @@ The following list consists of supported optional developer customization -
"NSFS_TRIGGER_FSYNC": false
```
### 13. Whitelist IPs -
### 12. Whitelist IPs -
* <u>Key</u>: `S3_SERVER_IP_WHITELIST`
* <u>Type</u>:* Array
* <u>Default</u>: false
Expand All @@ -201,7 +187,7 @@ The following list consists of supported optional developer customization -
sudo noobaa-cli whitelist --ips '["127.0.0.1", "192.000.10.000", "3002:0bd6:0000:0000:0000:ee00:0033:000"]' 2>/dev/null
```
### 14. Config directory backend -
### 13. Config directory backend -
* <u>Key</u>: `NSFS_NC_CONFIG_DIR_BACKEND`
* <u>Type</u>: String
* <u>Default</u>: ''
Expand All @@ -214,7 +200,7 @@ The following list consists of supported optional developer customization -
"NSFS_NC_CONFIG_DIR_BACKEND": "GPFS"
```
### 15. Storage Backend -
### 14. Storage Backend -
* <u>Key</u>: `NSFS_NC_STORAGE_BACKEND`
* <u>Type</u>: String
* <u>Default</u>: ''
Expand All @@ -228,7 +214,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 16. Directories cache max directory size -
### 15. Directories cache max directory size -
* <u>Key</u>: `NSFS_DIR_CACHE_MAX_DIR_SIZE`
* <u>Type</u>: Number
* <u>Default</u>: 67108864 // 64MB = 64 * 1024 * 1024
Expand All @@ -242,7 +228,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 17. Directories cache max total usage size -
### 16. Directories cache max total usage size -
* <u>Key</u>: `NSFS_DIR_CACHE_MAX_TOTAL_SIZE`
* <u>Type</u>: Number
* <u>Default</u>: 268435456 // 256MB = 4 * config.NSFS_DIR_CACHE_MAX_DIR_SIZE = 4 * 1024 * 1024
Expand All @@ -257,7 +243,7 @@ The following list consists of supported optional developer customization -
```
### 18. Disable random seeding -
### 17. Disable random seeding -
* <u>Key</u>: `ENABLE_DEV_RANDOM_SEED`
* <u>Type</u>: Boolean
* <u>Default</u>: false
Expand All @@ -271,7 +257,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 19. Set Master Keys Store type-
### 18. Set Master Keys Store type-
* <u>Key</u>: `NC_MASTER_KEYS_STORE_TYPE`
* <u>Type</u>: String
* <u>Default</u>: 'file'
Expand All @@ -285,7 +271,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 20. Set Master Keys File Location -
### 19. Set Master Keys File Location -
* <u>Key</u>: `NC_MASTER_KEYS_FILE_LOCATION`
* <u>Type</u>: String
* <u>Default</u>: '/etc/noobaa.conf.d/master_keys.json'
Expand All @@ -299,7 +285,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 21. Set Master Keys GET executable script -
### 20. Set Master Keys GET executable script -
* <u>Key</u>: `NC_MASTER_KEYS_GET_EXECUTABLE`
* <u>Type</u>: String
* <u>Default</u>: undefined
Expand All @@ -313,7 +299,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 22. Set Master Keys PUT executable script -
### 21. Set Master Keys PUT executable script -
* <u>Key</u>: `NC_MASTER_KEYS_PUT_EXECUTABLE`
* <u>Type</u>: String
* <u>Default</u>: undefined
Expand All @@ -327,7 +313,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa
```
### 23. Set Virtual hosts -
### 22. Set Virtual hosts -
* <u>Key</u>: `VIRTUAL_HOSTS`
* <u>Type</u>: String
* <u>Default</u>: ''
Expand All @@ -341,7 +327,7 @@ The following list consists of supported optional developer customization -
3. systemctl restart noobaa_nsfs
```
### 24. Disable schema check -
### 23. Disable schema check -
* <u>Key</u>: `NC_DISABLE_SCHEMA_CHECK`
* <u>Type</u>: Boolean
* <u>Default</u>: false
Expand All @@ -356,7 +342,7 @@ Warning: After setting this configuration, NooBaa will skip schema validations a
```
### 25. Disable Read accessibility check -
### 24. Disable Read accessibility check -
* <u>Key</u>: `NC_DISABLE_ACCESS_CHECK`
* <u>Type</u>: Boolean
* <u>Default</u>: false
Expand All @@ -374,7 +360,7 @@ Warning: After setting this configuration, NooBaa will skip schema validations a
"NC_DISABLE_ACCESS_CHECK": true
```
### 26. Disable Read accessibility check on the Health CLI -
### 25. Disable Read accessibility check on the Health CLI -
* <u>Key</u>: `NC_DISABLE_HEALTH_ACCESS_CHECK`
* <u>Type</u>: Boolean
* <u>Default</u>: false
Expand All @@ -388,7 +374,7 @@ Warning: After setting this configuration, NooBaa will skip schema validations a
"NC_DISABLE_HEALTH_ACCESS_CHECK": true
```
### 27. Disable Read/Write POSIX mode bits check -
### 26. Disable Read/Write POSIX mode bits check -
* <u>Key</u>: `NC_DISABLE_POSIX_MODE_ACCESS_CHECK`
* <u>Type</u>: Boolean
* <u>Default</u>: true
Expand All @@ -407,7 +393,7 @@ Warning: After setting this configuration, NooBaa will skip schema validations a
```
### 26. Set Endpoint process title -
### 27. Set Endpoint process title -
* <u>Key</u>: `ENDPOINT_PROCESS_TITLE`
* <u>Type</u>: String
* <u>Default</u>: 'noobaa'
Expand All @@ -422,7 +408,7 @@ Warning: After setting this configuration, NooBaa will skip schema validations a
## Config.json example
```
### 27. GPFS down delay -
### 28. GPFS down delay -
* <u>Key</u>: `GPFS_DOWN_DELAY`
* <u>Type</u>: Number
* <u>Default</u>: 1000
Expand All @@ -436,7 +422,7 @@ Warning: After setting this configuration, NooBaa will skip schema validations a
3. systemctl restart noobaa
```
### 28. Syslog enable flag -
### 29. Syslog enable flag -
* <u>Key</u>: `LOG_TO_SYSLOG_ENABLED`
* <u>Type</u>: Boolean
* <u>Default</u>: true
Expand All @@ -450,7 +436,7 @@ Warning: After setting this configuration, NooBaa will skip schema validations a
3. systemctl restart noobaa
```
### 29. Stderr enable flag -
### 30. Stderr enable flag -
* <u>Key</u>: `LOG_TO_STDERR_ENABLED`
* <u>Type</u>: Boolean
* <u>Default</u>: false
Expand All @@ -476,7 +462,6 @@ The following is an example of a config.json file -
"UV_THREADPOOL_SIZE": 256,
"GPFS_DL_PATH": "/usr/lpp/mmfs/lib/libgpfs.so",
"NSFS_BUF_POOL_MEM_LIMIT": 4294967296,
"NSFS_BUF_SIZE": 16777216,
"NSFS_OPEN_READ_MODE": "rd",
"NSFS_CHECK_BUCKET_BOUNDARIES": false,
"ALLOW_HTTP": true,
Expand Down
4 changes: 0 additions & 4 deletions src/server/system_services/schemas/nsfs_config_schema.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,6 @@ const nsfs_node_config_schema = {
type: 'number',
doc: 'number of nsfs buffer pool memory limit, suggested values 1-4GB, service restart required'
},
NSFS_BUF_SIZE: {
type: 'number',
doc: 'number of nsfs buffer size, service restart required'
},
NSFS_OPEN_READ_MODE: {
type: 'string',
doc: `describes the mode of open for read, use 'rd' for direct-io reads, hot reload`
Expand Down
1 change: 0 additions & 1 deletion src/test/unit_tests/jest_tests/test_nc_nsfs_config_schema_validation.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ describe('schema validation NC NSFS config', () => {
NSFS_NC_STORAGE_BACKEND: 'GPFS',
NSFS_NC_CONFIG_DIR_BACKEND: 'GPFS',
NSFS_BUF_POOL_MEM_LIMIT: 4294967296,
NSFS_BUF_SIZE: 16777216,
NSFS_OPEN_READ_MODE: 'rd',
NSFS_CHECK_BUCKET_BOUNDARIES: false,
ALLOW_HTTP: true,
Expand Down

0 comments on commit b6269d7

Please sign in to comment.