Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

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

  • DNS settings - These are required for DHCP configuration.

  • Administrative username and password - Once the administrator username and password are set, SCS 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. 

Info

Once the administrative username and password are set, this process will be interrupted to allow scsctl to be configured with the administrative username and password for the future interaction with SCS. To perform this configuration, run: 

scsctl auth login --user [administrative user name] 

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

scsctl diagnostics config scan_missing

Finalize configuration settings

Note

When configuring Swarm settings, input characters are hidden such as ‘admin.userName’, ‘admin.password’, ‘encryptionKeys’, etc. It is advised to use inputs on a raw text editor and do copy & paste to prevent any typo mistakes. 

  1. Run scsctl diagnostic config scan_missing.

    ====================================================================================================== 
    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-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. 
  2. When prompted for the DNS servers, hit ‘Enter’ to apply settings as a default at the group level.

    ---------------------------------------------- 
    Name: network.dnsServers 
    Type: array[str] 
    Description: Required. DNS servers to be used. 
    ---------------------------------------------- 
    Missing setting: network_boot/network.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.

    ---------------------------------------------- 
    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 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. 
    ------------------------------------------------------------------------------------------------------ 
    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 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. 
    ------------------------------------------------------------- 
  4. When prompted for the administrative password, hit ‘Enter’ to apply the password at the group level.

    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 
  5. Enter the administrator password (e.g., datacore). The input characters are hidden for the password.

    Missing setting: platform/admin.password
    
    admin.password [type: str ***SECURE***] (Administrative user password): 
     
    Please re-enter to confirm: 
    
  6. When prompted for the administrative user name, hit ‘Enter‘ to apply the user name at the group level.

    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 
  7. Enter the administrator username (e.g., dcadmin). The input characters are hidden for the administrator username.

    Missing setting: platform/admin.userName 
    
    admin.userName [type: str ***SECURE***] (Administrative user name): 
    
    Please re-enter to confirm: 
     
    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 
  8. At this point, the SCS API is locked, and all requests must be authenticated. Login to SCS CLI via scsctl auth login --user [administrative user name]. The below example uses the sample administrative user name from above. The input characters are hidden.

    [root@zorc Platform]# scsctl auth login --user dcadmin 
    Enter password for user "dcadmin": 
    
    Logged in 
  9. Once you are logged in, continue finalizing configuration settings via scsctl diagnostics config scan_missing command.

    ====================================================================================================== 
    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-lab1.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 
    ------------------------------------------------------------------------------------------------------ 
    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.
    ------------------------------------------------------------------------------------------------------ 
    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 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.
  10. When prompted for the DNS domain, hit ‘Enter‘ to apply it at the group level.

    ------------------------------------------------------------- 
    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
  11. Set the DNS domain.

    ------------------------------------------------------------- 
    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-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 
    ------------------------------------------------------------------------------------------------------ 
  12. Select Skip this setting for now and hit Enter.

    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
  13. The support proxy password applies if an HTTP proxy is needed for automatic health report submission. Select As a default at group level now and hit Enter.

    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
  14. Enter Proxy Password (e.g., datacore). The input characters are hidden for the password.

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