Nexus Public Preview System Settings

Jump to Section

Notes:

  • Config TAGNames are case sensitive 

  • Also, see sample Nexfs cloud and object configurations

  • Nexfscli for Configuration Management is recommended

Service Managment

Config TagName

Live Update

or Restart

Allowed

Values

Description

NEXFSPAUSED

Live

Default: 0

Valid values: 0 (no) or 1 (yes)

If set to 1 nexfs will stop accepting file opens/creates/reads and writes, does not affect the job scheduler or bg migrations

BGMIGRATIONSPAUSED

Live

Default: 0

Valid values: 0 (no) or 1 (yes)

If set to 1 background nexfs data migrations between storage tiers will be paused

DELETEPAUSED

Live

Default: 0

Valid values: 0 (no) or 1 (yes)

If background deletions can run or should be paused

See “File Deletion Management” for information on actions taken when a file is deleted.

SMARTPROTECTENABLED

Live

Default: 1

Valid values: 0 (no) or 1 (yes)

Set to 1 to enabled Smart Protect. Affects SMARTPROTECT and SMARTPROTECTOPENFILECYCLE

See SmartProtectAndTier for details of Nexfs Smart Protection

SMARTTIERENABLED

Live

Default: 0

Valid values: 0 (no) or 1 (yes)

Set to 1 to enabled Smart Tiering. Affects SMARTTIER and SMARTTIEROPENFILECYCLE

See SmartProtectAndTier for details of Nexfs Smart Tiering

JOBSCHEDULARPAUSED

Live

Default: 0

Valid values: 0 (no) or 1 (yes)

If set to 1 the internal nexfs job scheduler will be paused

Tier 3 Cloud and Object Storage Connection Settings

Config TagName

Live Update

or Restart

Allowed

Values

Description

T3S3URL

Live

Default: amazonaws.com

A valid URL to be used to connect to the object or cloud storage

URL for accessing T3 S3 compatible storage

For AWS this does not include the region.

T3S3REGION

Live

Default: us-west-1

Valid Values: Any valid region.

Note this setting is not validated

The AWS S3 Region to connect to, or equivalent S3 compatible storage region.

T3S3ENABLEREGION

Live

Default:1

Valid Values: 0 (no) or (1) Yes

If to include the region configured by T3S3REGION in the final URL used to connect to the object or cloud storage

T3S3BUCKET

Live

Default: nexfs

Valid values: Any existing Cloud or object storage bucket

The S3 or compatible storage bucket to use.

Note: The bucket configured here must already exist before it can be used by Nexfs. Nexus will NOT create the bucket if it does not exist.

T3S3PORT

Live

Default: 9000

Valid values: a TCP port between 0 and 16384

The TCP port us when connecting to the cloud or object storage.

Port 9000 is the default port used by minio.

T3USEHTTPS

Live

Default: 1

Valid Values: 0 (no) or 1 (yes)

If set to 1 then nexfs connects to the S3 storage system over encrypted HTTPS

If set to 0 then nexus connect using basic HTTP

T3DDIRENABLED

Restart

Default: 0

Valid values: 0 (no) or 1 (yes)

If to enabled T3 Storage

Currently, Nexfs supports Amazon AWS S3 and S3 API compatible Object and Cloud Storage.

Nexus releases are tested against AWS S3 cloud storage and Minio Object storage

T3AWSSecretAccessKey

Live

Default: minioadmin


Valid value: the correct Secret Key to use to connect to the configured bucket

The Secret key that has been configured against the cloud or object storage system.

T3AWSAccessKeyId

Live

Default: minioadmin


Valid value: the correct Access Key to use to connect to the configured bucket

The Access key which has been configured against the cloud or object storage system.

T3S3USEVIRTUALHOST

Live

Default: 1

Valid values:
0 (no) or 1 (yes)

If set to 1 then AWS Virtual Host style URLs are used to connect to the storage system.

If set to 0 then the older AWS Path Host style is used.

T3S3COMPATIBLE

(Read description before changing, it likely this should still be set to 0 when connecting to s3 compatible storage systems)

Live

Default: 0

Valid value: 0 or 1

This setting should be set to 0 when connecting to most s3 compatible storage systems.

When set to 0 the word “s3” is included in the final URL used to connect t the cloud or object storage, for example when set to 0 the URL format will be:

https://bucketname.s3.Region.amazonaws.com

When set to one it will be

https://bucketname.Region.amazonaws.com

This setting may need to be set to 1 when connecting to some S3 compatible storage systems.

T3S3RETRIES

Live

Default: 3

Valid values: 0 to 12

How many times to retry a request that fails to the S3 cloud or object storage.

T3S3RETRYSLEEP

Live

Default: 1

Valid values: 0 to 360

The number of seconds to wait for retiring a failed request to S3 cloud or object storage.

T3S3RETRY404

Live

Default: 0

Valid values: 0 (no) or 1 (yes)

If to retry an S3 request when nexus received an http 404 from the storage system.

An http 404 means that the storage system is stating the requested object or cloud file does not exist. Some storage systems may return a 404 if an object is created soon after it has been created, or if that storage system is too busy to serve the request. If this happens nexfs could believe that the object does not exist and create an empty one instead of returning the expected data. This behaviour does not happen with AWS S3, but can occur with Swarm object storage, you should check with your storage object or cloud storage vendor whether this should setting should be enabled or not.

T3S3RETRY404SLEEP

Live

Default: 1 (ms)

Valid values: 0 to 999999

The number of milliseconds to wait between retiring a request which previously received a 404 from the S3 cloud or object storage system.

Tier 1 and Tier 2 Storage Configuration

Config TagName

Live Update

or Restart

Allowed

Values

Description

T1SDIR

Restart

Default: /nexfs/s1

A existing path up to a max 2048 characters

The path to the mountpoint/folder that nexus will use to storage tier-1 file structure information, must be a full path starting with /, the path can contain a max of 2048 characters.

T1DDIR

Restart

Default: /nexfs/t1

A path up to a max 2048 characters

The path to the mountpoint/folder that nexus will use to storage tier-1 data, must be a full path starting with /, the path can contain a max of 2048 characters.

T1DDIRENABLED

Restart

Default: 1

Valid values: 0 (no) or 1 (yes)

If to enabled T1 Storage

Nexfs requires at least either T1 or T2 data storage to be enabled.

T2DDIR

Restart

Default: /nexfs/t2

A path up to a max 2048 characters

The path to the mountpoint/folder that nexus will use to storage tier-2 data, must be a full path starting with /, the path can contain a max of 2048 characters.

While available in public preview releases, Enabling T2 storage otherwise requires a Nexfs enterprise license, subscription or a non expired time-limited trial license to be enabled in general releases.

T2DDIRENABLED

Restart

Default: 0

Valid values: 0 (no) or 1 (yes)

If to enabled T2 Storage

Nexfs requires at least either T1 or T2 data storage to be enabled.

While available in public preview releases, Enabling T2 storage otherwise requires a Nexfs enterprise license, subscription or a non expired time-limited trial license to be enabled in general releases.

Tier Capacity Management

Config TagName

Live Update

or Restart

Allowed

Values

Description

General Configuration

Config TagName

Live Update

or Restart

Allowed

Values

Description

Background Migration Settings

Config TagName

Live Update

or Restart

Allowed

Values

Description

Deletion and Storage Cleanup Settings

Config TagName

Live Update

or Restart

Allowed

Values

Description

Smart Protect and Tier

Config TagName

Live Update

or Restart

Allowed

Values

Description

Job Management

Config TagName

Live Update

or Restart

Allowed

Values

Description

JOBSCHEDULARPAUSED

Live

Default: 0

Valid values: 0 (no) or 1 (yes)

If set to 1 the internal nexfs job scheduler will be paused

JSMAXTHREADS

Restart

Default: 4

Valid values: 1 to 16

The maximum number of Job Scheduler Threads that can run concurrently

JOBSCHEDULARSLEEP

Live

Default 60

Valid values: 0 to 3600

Seconds the internal jobs and bg migration schedulers will sleep between determining if any jobs should be started

JOBSCHEDULARSALLOWMANUALWHENPAUSED

Live

Default: 0

Valid values: 0 or 1

If set to 1 then manual “admin” jobs can still be run when the job scheduler is paused

Security

Config TagName

Live Update

or Restart

Allowed

Values

Description

DEFAULTPERMISSIONS

Restart

Default: 1

Valid values: 0 (no) or 1 (yes)

Enable file permission checking, restricting access based on a files access mode.

(Requires nexfs to be started using nexfscli)"

ROOTONLYACCESS

Restart

Default: 0

Valid values: 0 (no) or 1 (yes)

If enabled only the root user can access the nexfs filesystem, or if access is allowed for all users
(Requires nexfs to be started using nexfscli)"

SECURITYCMDGROUP

Live

Default: 0 (root)

Valid values: 0 to 65536

User Group whose members can run nexfs admin commands

SECURITYCMDGROUPACCESS

Live

Default: 2

Valid values: 0=no access, 1 read-only, 2 read/write

The access level nexfs cmd group members have for running admin commands

SECURITYCONFGROUP

Live

Default: 0 (root)

Valid values: 0 to 65536

User Group whose members can view and make nexfs configuration changes

SECURITYCONFGROUPACCESS

Live

Default: 2

Valid values: 0=no access, 1 read-only, 2 read/write

The access level nexfs configuration group members have for viewing and making configuration changes

Advanced Settings

Config TagName

Live Update

or Restart

Allowed

Values

Description

PARTSIZE

Live

Default: 1024000

Valid values:
Min: 4096
Max: 8192000

Size of nexfs file dataparts in bytes.

WRITEBUFSIZE

Live

Default: 4096000

Valid values:
Min: 4096
Max: 4096000

Write buffer size in bytes. The size of incoming write buffers (for receiving data from the kernel)

MAXFILENAMELENGTH

Restart

Defaut: 2048

Valid values:
Min: 1024
Max: 2048

The maximum lenght in characters of a file name including its full path that nexfs can process.

The upper limit will soon be increased to 65536

MAXHANDLEPAGES

Restart

Defaut: 4

Valid values:
Min: 1
Max: 128

The maximum number of in memory dataparts that nexfs can have open for each open file handle.

More handles allows more concurrent client requests to be serviced for each open filehandle, and allows more dataparts to be cached in memory. To many parts can lower IO as nexfs needs to scan each cached datapart for a match for every read/wrtie request.

CACHELOCKWAIT

Live

Defaut: 4000

Valid values:
Min: 5
Max: 99999999

The number of nano seconds to wait between attempts to take a buffer lock.

Having this set to large will reduce performance with nexfs is sleeping, having it to low will increase CPU usage as nexfs attempts to take unavailable buffer locks more often.

Log Management 

Config TagName

Live Update

or Restart

Allowed

Values

Description