Page Comparison

Some Swarm configuration settings are site-specific and related to: 

• DNS settings - There are queried for proper DHCP configuration 

• Administrative username and password - Once the administrator username and password are set, the platform server will not accept any unauthenticated commands. 

• Disk encryption settings - These settings are related to “Encryption at REST” and should be ideally skipped unless specified by DataCore Support. 

To specify these values, run scsctl diagnostics config scan_missing command.

Finalize Configuration Settings

Run scsctl diagnostic config scan_missing.

...

Some Swarm configuration settings are site-specific and related to: 

• DNS settings - There are queried for proper DHCP configuration 

• Administrative username and password - Once the administrator username and password are set, the platform server will not accept any unauthenticated commands. 

• Disk encryption settings - These settings are related to “Encryption at REST” and should be ideally skipped unless specified by DataCore Support. 

To specify their values, run scsctl diagnostics config scan_missing command.

Finalize Configuration Settings

1. Run scsctl diagnostic config scan_missing.

   Code Block

   ======================================================================================================  Component: network_boot  ----------------------------------------------  Name: network.dnsServers  Type: array[str]  Description: Required. DNS servers to be used.  ----------------------------------------------  Component Group: network_boot/192.168.9.0x24.network_boot.scs-hklab1.datacore.internal [DEFAULT GROUP]  Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance!  If any new instances are added, please define these settings, or define them at the group level to apply to all instances. Best practice is to define them at the group level if possible.

2. Hit ‘Enter’ to apply settings as a default at the group level.

   Code Block

   ----------------------------------------------  Name: network.dnsServers  Type: array[str]  Description: Required. DNS servers to be used.  ----------------------------------------------  ComponentMissing Groupsetting: network_boot/192.168.9.0x24.network_boot.scs-hklab1.datacore.internal [DEFAULT GROUP]  Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance!  If any new instances are added, please define these settings, or define them at the group level to apply to all instances.  Best practice is to define them at the group level if possible.

   Hit ‘Enter’ to apply settings as a default at the group level.

   Code Block
   .dnsServers  Where would you like to update this setting? > As a default at group level    For each instance in the group    Skip this setting for now

3. Enter DNS servers.

   Code Block

   -------------------------------------------------  Name: network.dnsServers  Type: array[str]  Description: Required. DNS servers to be used.  ----------------------------------------------  Missing setting: network_boot/network.dnsServers  network.dnsServers dnsServers Where would you like[type: array[str]] (Required. DNS servers to update this setting? > As a default at group level    For each instance in the group    Skip this setting for now

   Enter DNS Servers.

   Code Block

   be used.): 172.16.33.4,172.16.33.5 ======================================================================================================  Component: platform  -------------------------------------------------  Name: network.dnsServers -----------------------------------------------------  Name: admin.password  Type: array[str] str  Description: Required.Administrative DNSuser servers to be used.  password  --------------------------------------------------  Missing setting: network_boot/network.dnsServers  network.dnsServers [type: array[str]] (Required. DNS servers to be used.): 172.16.33.4,172.16.33.5 ======================================================================================================  Component: platform  ----------------------------------------------------  Name: admin.userName  Type: str  Description: Administrative user name  ----------------------------------------------------------------------------------------------------------------------------------------------------  Name: adminlogging.password syslogHost  Type: str  Description: Administrative user password  If defined, then the host that component instances should use for syslog logging.  ------------------------------------------------------------------------------------------------------  Name: adminnetwork.userName dnsDomain  Type: str  Description: AdministrativeRequired. user name The DNS domain name that will be used.  ------------------------------------------------------------------------------------------------------  Name: loggingnetwork.syslogHost ntpServers  Type: str array[str]  Description: Required. The IP address(es) of one or more NTP servers. If defined the nodes cannot access public NTP servers, thenthey thewill hosttime thatout componentwaiting instancesfor shoulda useconnection forand syslogautomatically loggingrestart.  - Only use trusted NTP servers, whether they are dedicated hardware solutions in your internal network or external, public servers that the nodes can access over the network. ------------------------------------------------------------------------------------------------------  Component NameGroup: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used.  ---------------------platform/global.platform.scs-hklab1.datacore.internal [DEFAULT GROUP]  Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance! If any new instances are added, please define these settings, or define them at the group level to apply to all instances.  Best practice is to define them at the group level if possible. -------------------------------------------------------------  Name: admin.password  Type: str  Description: Administrative user password  ------------------------  Name: network.ntpServers -------------------------------------  Name: admin.userName  Type: array[str] str  Description: Required.Administrative Theuser IP address(es) of one or more NTP servers. If the nodes cannot access public NTP servers, they will time out waiting for a connection and automatically restart. Only use trusted NTP servers, whether they are dedicated hardware solutions in your internal network or external, public servers that the nodes can access over the network. name  -------------------------------------------------------------  Name: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used.  ----------------------------------------------------------------------------------------------------------  Component Group

4. Hit ‘Enter’ to apply the password at the group level.

   Code Block

   Missing setting: platform/global.platform.scs-hklab1.datacore.internal [DEFAULT GROUP]  Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance! If any new instances are added, please define these settings, or define them at the group level to apply to all instances.  Best practice is to define them at the group level if possible. -------------------------------------------------------------  Name: admin.password  Type: str  Description: Administrative user password  -------------------------------------------------------------  Name: admin.userName  Type: str  Description: Administrative user name  -------------------------------------------------------------  Name: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used.  -------------------------------------------------------------

5. Hit ‘Enter’ to apply the password at the group level.

   Code Block
   Missing setting: platform/admin.password Where would you like to update this setting?  > As a default at group level    For each instance in the group    Skip this setting for now

6. Enter the administrator password e.g., datacore, where the input characters are hidden.

   Code Block
   Missing setting: platform/admin.password admin.password [type: str ***SECURE***] (Administrative user password):  datacore  Please re-enter to confirm:  datacore

7. Hit ‘Enter” to apply the user name at the group level.

   Code Block
   Missing setting: platform/admin.userName Where would you like to update this setting?  > As a default at group level    For each instance in the group    Skip this setting for now

8. Enter the administrator user name e.g., dcadmin, where input characters are hidden.

   Code Block
   Missing setting: platform/admin.userName  admin.userName [type: str ***SECURE***] (Administrative user name):  dcadmin  Please re-enter to confirm:  dcadmin  Authentication state may have changed in the API!  Please log in, then re-run this command to resume:    > scsctl auth login --user "{administrative user name}"    > scsctl diagnostics config scan_missing

9. Login to Platform Server CLI via scsctl auth login --user datacore. It is important that input characters are hidden.

   Code Block
   [root@zorc Platform]# scsctl auth login --user datacore  Enter password for user "dcadmin":  datacore Logged in

10. Continue finalizing after logged in using scsctl diagnostics config scan_missing.

    Code Block
    ======================================================================================================  Component: network_boot  admin.password Where would you like to update this setting?  > As a default at group level    For each instance in the group    Skip this setting for now

11. Enter the administrator password e.g., datacore, where the input characters are hidden.

    Code Block
    Missing setting: platform/admin.password admin.password [type: str ***SECURE***] (Administrative user password):  datacore  Please re-enter to confirm:  datacore

12. Hit ‘Enter” to apply the user name at the group level.

    Code Block
    Missing setting: platform/admin.userName Where would you like to update this setting?  > As a default at group level    For each instance in the group    Skip this setting for now

13. Enter the administrator user name e.g., dcadmin, where input characters are hidden.

    Code Block
    Missing setting: platform/admin.userName  admin.userName [type: str ***SECURE***] (Administrative user name):  dcadmin  Please re-enter to confirm:  dcadmin  Authentication state may have changed in the API!  Please log in, then re-run this command to resume:    > scsctl auth login --user "{administrative user name}"    > scsctl diagnostics config scan_missing

14. Login to Platform Server CLI via scsctl auth login --user datacore.

    Code Block
    [root@zorc Platform]# scsctl auth login --user datacore  Enter password for user "dcadmin":  datacore Logged in

15. Once you are logged in, continue finalizing configuration settings via scsctl diagnostics config scan_missing command.

    Code Block

    ======================================================================================================  Component: network_boot  ----------------------------------------------  Name: network.dnsServers  Type: array[str]  Description: Required. DNS servers to be used.  ----------------------------------------------  Component Group: network_boot/192.168.9.0x24.network_boot.scs-hklab1.datacore.internal [DEFAULT GROUP]  all settings defined for group ====================================================================================================== Component: platform  ------------------------------------------------------------------------------------------------------  Name: admin.password  Type: str Description: Administrative user password  ------------------------------------------------------------------------------------------------------  Name: networkadmin.dnsServers userName  Type: array[str] str  Description: Required.Administrative DNSuser servers to be used.  name  ---------------------------------------------------  Component Group: network_boot/192.168.9.0x24.network_boot.scs-hklab1.datacore.internal [DEFAULT GROUP]  all settings defined for group ====================================================================================================== Component: platform  ---------------------------------------------------  Name: logging.syslogHost  Type: str  Description: If defined, then the host that component instances should use for syslog logging.  ------------------------------------------------------------------------------------------------------------------------------------  Name: admin.password  Type: str Description: Administrative user password   Name: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used. ------------------------------------------------------------------------------------------------------  Name: adminnetwork.userName ntpServers  Type: str array[str]  Description: Administrative user name  ---------------------------------------------------- Required. The IP address(es) of one or more NTP servers. If the nodes cannot access public NTP servers, they will time out waiting for a connection and automatically restart. Only use trusted NTP servers, whether they are dedicated hardware solutions in your internal network or external, public servers that the nodes can access over the network. ------------------------------------------------------------  Name: logging.syslogHost  Type: str  Description: If defined, then the host that component instances should use for syslog logging.  ----------------------------------------------------------------------------------------------------------  Name: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used. -----------------------------------------------  Component Group: platform/global.platform.scs-hklab1.datacore.internal [DEFAULT GROUP]  Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance! If any new instances are added, please define these settings, or define them at the group level to apply to all instances.  Best practice is to define them at the group level if possible.

16. Configure DNS domain and apply it at the group level.

    Code Block

    -------------------------------------------------------------  Name: network.ntpServers dnsDomain  Type: array[str] str  Description: Required. The IP address(es) of one or more NTP servers. If the nodes cannot access public NTP servers, they will time out waiting for a connection and automatically restart. Only use trusted NTP servers, whether they are dedicated hardware solutions in your internal network or external, public servers that the nodes can access over the network. DNS domain name that will be used.  -------------------------------------------------------------  Missing setting: platform/network.dnsDomain Where would you like to update this setting?  > As a default at group level    For each instance in the group    Skip this setting for now

17. Set the DNS domain.

    Code Block

    -----------------------------------------------------------------  Name: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used.  -------------------------------------------------------------  Missing Component Groupsetting: platform/global.platform.scs-hklab1.datacore.internal [DEFAULT GROUP]  Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance! If any new instances are added, please define these settings, or define them at the group level to apply to all instances.  Best practice is to define them at the group level if possible.

18. Configure DNS domain and apply it at the group level.

    Code Block

    -------------------------------------------------------------  Name: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used.  -------------------------------------------------------------  Missing setting: platform/network.dnsDomain Where would you like to update this setting?  > As a default at group level    For each instance in the group    Skip this setting for now

19. Set the DNS domain.

    Code Block

    -------------------------------------------------------------  Name: network.dnsDomain  Type: str  Description: Required. The DNS domain name that will be used.  -------------------------------------------------------------  Missing setting: platform/network.dnsDomain   network.dnsDomain [type: str] (Required. The DNS domain name that will be used.):   datacore.internal ====================================================================================================== Component: storage ------------------------------------------------------------------------------------------------------ Name: disk.encryptionKeyPrimary Type: str Description: The mnemonic name of the encryption key to use for encrypting new Swarm volumes. Do not use quotes. For this key to be used, disk.encryptNewVolumes must be set to True. ------------------------------------------------------------------------------------------------------ Name: disk.encryptionKeys Type: dict[str,str] Description: A comma-separated list of mnemonic name and encryption key pairs, used for accessing encrypted Swarm volumes. ------------------------------------------------------------------------------------------------------ Name: support.proxyPassword Type: str Description: Proxy authentication password ------------------------------------------------------------------------------------------------------ Component Group: storage/objstor.scs-hklab1.datacore.internal [DEFAULT GROUP] Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance! If any new instances are added, please define these settings, or define them at the group level to apply to all instances. Best practice is to define them at the group level if possible. ------------------------------------------------------------------------------------------------------ Name: disk.encryptionKeyPrimary Type: str Description: The mnemonic name of the encryption key to use for encrypting new Swarm volumes. Do not use quotes. For this key to be used, disk.encryptNewVolumes must be set to True. ------------------------------------------------------------------------------------------------------ Name: disk.encryptionKeys Type: dict[str,str] Description: A comma-separated list of mnemonic name and encryption key pairs, used for accessing encrypted Swarm volumes. ------------------------------------------------------------------------------------------------------ Name: support.proxyPassword Type: str Description: Proxy authentication password ------------------------------------------------------------------------------------------------------

20. Apply encryption primary at the group level.

    Code Block
    Missing setting: storage/disk.encryptionKeyPrimary  Where would you like to update this setting?  > As a default at group level    For each instance in the group    Skip this setting for now

21. Enter encryption primary key e.g., primarykey.

    Code Block
    Missing setting: storage/disk.encryptionKeyPrimary disk.encryptionKeyPrimary [type: str ***SECURE***] (The mnemonic name of the encryption key to use for encrypting new Swarm volumes. Do not use quotes. For this key to be used, disk.encryptNewVolumes must be set to True.):  primarykey  Please re-enter to confirm: primarykey

22. Apply encryption Keys at the group level.

    Code Block
    Missing setting: storage/disk.encryptionKeys Where would you like to update this setting? > As a default at group level   For each instance in the group   Skip this setting for now

23. Enter encryption keys in JSON format e.g., {'primarykey':'a24f8ec391ab3341'}.

    Code Block
    Missing setting: storage/disk.encryptionKeys disk.encryptionKeys [type: dict[str,str] ***SECURE***] (A comma-separated list of mnemonic name and encryption key pairs, used for accessing encrypted Swarm volumes.): {'primarykey':'a24f8ec391ab3341'} Please re-enter to confirm: {'primarykey':'a24f8ec391ab3341'}

24. Apply proxy password at the group level.

    Code Block
    Missing setting: storage/support.proxyPassword Where would you like to update this setting? > As a default at group level   For each instance in the group   Skip this setting for now

25. Enter proxy password e.g., datacore.

    Code Block
    Missing setting: storage/support.proxyPassword  datacore  support.proxyPassword [type: str ***SECURE***] (Proxy authentication password):  datacore  Please re-enter to confirm:

26. Run diagnostics again via scsctl diagnostics config scan_missing to make sure all the configurations are set.

    Code Block

    ======================================================================================================  Component: network_boot  ----------------------------------------------  Name: network.dnsServers  Type: array[str]  Description: Required. DNS servers to be used. ----------------------------------------------  Component Group: network_boot/192.168.9.0x24.network_boot.scs-hklab1.datacore.internal [DEFAULT GROUP]  all settings defined for group  ======================================================================================================  Component: platform ------------------------------------------------------------------------------------------------------  Name: admin.password  Type: str  Description: Administrative user password  ------------------------------------------------------------------------------------------------------  Name: admin.userName  Type: str  Description: Administrative user name  network.dnsDomain   network.dnsDomain [type: str] (Required. The DNS domain name that will be used.):   datacore.internal ====================================================================================================== Component: storage ------------------------------------------------------------------------------------------------------  Name: logging.syslogHost  Type: str  Description: If defined, then the host that component instances should use for syslog logging.  Name: disk.encryptionKeyPrimary Type: str Description: The mnemonic name of the encryption key to use for encrypting new Swarm volumes. Do not use quotes. For this key to be used, disk.encryptNewVolumes must be set to True. ------------------------------------------------------------------------------------------------------  Name: networkdisk.dnsDomain encryptionKeys Type: dict[str,str] str  Description: Required. The DNS domain name that will be used.  A comma-separated list of mnemonic name and encryption key pairs, used for accessing encrypted Swarm volumes. ------------------------------------------------------------------------------------------------------  Name: network.ntpServers  Type: array[str]  Description: Required. The IP address(es) of one or more NTP servers. If the nodes cannot access public NTP servers, they will time out waiting for a connection and automatically restart. Only use trusted NTP servers, whether they are dedicated hardware solutions in your internal network or external, public servers that the nodes can access over the network. ------------ Name: support.proxyPassword Type: str Description: Proxy authentication password ------------------------------------------------------------------------------------------------------  Component Group: platformstorage/global.platformobjstor.scs-hklab1.datacore.internal [DEFAULT GROUP] all settings defined for group  ======================================================================================================  Component: storage.datacore.internal [DEFAULT GROUP] Instances cannot currently inherit these from the group (since they have not been defined at the group level), so these settings must instead be defined for each instance! If any new instances are added, please define these settings, or define them at the group level to apply to all instances. Best practice is to define them at the group level if possible. ------------------------------------------------------------------------------------------------------  Name: disk.encryptionKeyPrimary encryptionKeyPrimary Type: str str Description: The mnemonic name of the encryption key to use for encrypting new Swarm volumes. Do not use quotes. For this key to be used, disk.encryptNewVolumes must be set to True. ------------------------------------------------------------------------------------------------------  Name: disk.encryptionKeys encryptionKeys Type: dict[str,str]  Description: A comma-separated list of mnemonic name and encryption key pairs, used for accessing encrypted Swarm volumes.  ------------------------------------------------------------------------------------------------------  Name: support.proxyPassword proxyPassword Type: str str  Description: Proxy authentication password password ------------------------------------------------------------------------------------------------------  Component Group: storage/objstor.scs-hklab1.datacore.internal [DEFAULT GROUP] all settings defined for group -------

27. Apply proxy password at the group level.

    Code Block
    Missing setting: storage/support.proxyPassword Where would you like to update this setting? > As a default at group level   For each instance in the group   Skip this setting for now

28. Enter proxy password e.g., datacore.

    Code Block
    Missing setting: storage/support.proxyPassword  datacore  support.proxyPassword [type: str ***SECURE***] (Proxy authentication password):  datacore  Please re-enter to confirm: