Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse

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

  • DNS settings Settings - These are required for proper DHCP configuration.Administrative user name and password - Once these are set, no commands will be accepted by the Platform server without proper authentication.

  • Disk encryption settings Encryption Settings - These relate settings are related to Encryption “Encryption at RestRest” and should be skipped unless otherwise specified by DataCore Support.

To specify these values, run the following command:

zorctl diagnostics config scan_missing

Info

Once the administrative user name and password have been set, this process will be interrupted to allow zorctl to be configured with the administrative user name and password for future interaction with the Platform server. To perform this configuration, run:

zorctl auth login --user {administrative user name}

This command will securely prompt for the administrative password and authenticate with the Platform Server. Once the CLI is logged in, re-run the configuration scan command to resume.

Below is an example of the start of the scanning process:

...

  •  

Finalize Configuration Settings

Note

Input characters such as encryptionKeys are hidden when configuring Swarm settings. The best practice is to copy and paste inputs from a raw text editor to prevent any transcription or transposition errors. 

  1. Run

    Code Block
    scsctl diagnostics config scan_missing

    Code Block
    languagebash
    ======================================================================================================

...

  1.  
    Component: network_

...

  1. boot 
    ---------------------------------------------- 
    Name: network.

...

  1. dnsServers 
    Type: array[str] 
    Description: Required. DNS servers to be used. 
    ---------------------------------------------- 
    

...

  1. Component Group: network_boot/

...

  1. 192.168.9.0x24.network_boot.scs-lab1.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 

...

  1. apply to all instances.

...

  1.  Best practice is to define them at the group level if possible.

...

  1.  

  2. Click ‘Enter‘ to apply the settings when prompted for the DNS servers.

    Code Block
    languagebash
    ---------------------------------------------- 
    Name: network.

...

  1. dnsServers 
    Type: array[str] 
    Description: Required. DNS servers to be used. 
    ---------------------------------------------- 
    Missing setting: network_boot/network.

...

  1. 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 
  2. Provide the DNS servers.

    Code Block
    languagebash
    ---------------------------------------------- 
    Name: network.dnsServers 
    Type: array[str] 
    Description: Required. DNS servers to be used. 
    ---------------------------------------------- 
    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.password 
    Type: str 
    Description: Administrative user password 
    ------------------------------------------------------------------------------------------------------ 
    Name: admin.userName 
    Type: str 
    Description: Administrative user name 
    ------------------------------------------------------------------------------------------------------ 
    Name: logging.syslogHost 
    Type: str 
    Description: If 

...

  1. defined, 

...

  1. then 

...

  1. the 

...

  1. host 

...

  1. that 

...

  1. component 

...

  1. instances should use for syslog logging. 
    ------------------------------------------------------------------------------------------------------ 
    Name: network.dnsDomain 
    Type: str 
    Description: Required. The DNS domain name that will be used. 
    ------------------------------------------------------------------------------------------------------ 
    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.
    ------------------------------------------------------------------------------------------------------ 
    Component Group: platform/global.platform.scs-lab1.datacore.internal [DEFAULT GROUP] 
    Instances cannot currently 

...

  1. inherit 

...

  1. these 

...

  1. from 

...

  1. 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: network.dnsDomain 
    Type: str 
    Description: Required. The DNS domain name that will be used. 
    ------------------------------------------------------------- 
  2. Click ‘Enter‘ to apply at the group level when prompted for the DNS domain.

    Code Block
    languagebash
    ------------------------------------------------------------- 
    Name: network.dnsDomain 
    Type: str 
    Description: Required. The DNS domain name that will be 

...

  1. used. 
    ------------------------------------------------------------- 
    Missing setting: platform/

...

  1. network.

...

  1. dnsDomain
    
    Where would you like to update this setting?

...

  1.  
    > As a default at group 

...

  1. level 
      For each instance in the 

...

  1. group 
      Skip this setting for now
  2. Set the DNS domain.

    Code Block
    languagebash
    ------------------------------------------------------------- 
    Name: network.dnsDomain 
    Type: str 
    Description: Required. The DNS domain name that will be used. 
    

...

  1. ------------------------------------------------------------- 
    Missing setting: platform/

...

  1. network.

...

  1. dnsDomain 
    
    

...

  1.  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-lab1.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 
    ------------------------------------------------------------------------------------------------------ 

Notes on Administrative User Name

If SCS is being installed with an existing Swarm storage cluster, then care must be taken to ensure that the SCS administrative user name matches the administrative user name within the storage cluster. This must occur before booting any nodes with SCS. To update the administrative user name at this point:

Code Block
languagebash
scsctl platform config set -d "admin.userName={existing cluster administrative user name}" --allow-notification-failures
Info

Info

Any time the administrative credentials are updated, you will need to run the following to re-authenticate scsctl with the API server.

scsctl auth login --user [administrative user name]

This command securely prompts the administrative password and authenticates to SCS.

Tip

Next, Configure DHCP.