Child pages
  • Installing the CSN

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Noprint


The CSN distribution is available as a collection of RPM packages that are installed with a shell script. The packages and their dependencies must be installed as a user with root privileges from an attached monitor and keyboard with at least one NIC connected to the external network.

Section
Column
width40%
Panel

On this page:

Table of Contents
maxLevel3

Column
width60%

 

Note

Note: You must log in to the CSN machine to install the software. You cannot install it using ssh.

1. As a user with root privileges, copy caringo-csn-version-brand.zip to your Cluster Services Node and unzip it into an empty directory of your choice. This directory is referred to as csn-extract-dir.

For example, if csn-extract-dir is /tmp/csninstall:

cd /tmp/csninstall
unzip caringo-csn-version-brand.zip

2. Install the CSN by running the self-extracting script from the directory location where the shell script was unzipped. You must run the following command as a user with root privileges:

cd caringo-csn-version
./caringo-csn-bundle-install.sh

This command initiates installation of the CSN and its dependent packages. When the installation is complete, the following prompt displays:

Would you like to proceed with CSN network configuration? (yes/no):

3. Enter yes to proceed with configuring the CSN and continue to Dual-network Primary Configuration if you are installing the CSN in a dual-network configuration or Single-Network Primary CSN Configuration if you are installing the CSN in a single-network configuration within a larger network.

4. If you answer no, you can set up the network at a later time by running the command: /opt/caringo/csn/bin/firstcsnboot.

Note

Note:

  • firstcsnboot should be used only to configure the network for the first time. If you are re-installing because of a failed installation, or need to correct mistakes made during a previous installation, run csn-reset first as discussed in “CSN-Reset”.
  • firstcsnboot must be run from the local terminal console and cannot be run over an ssh connection.

CSN Configuration

After running the CSN installation script and answering yes to the question about CSN network configuration, you must enter some minimal configuration data to configure the server on the overall network. Network settings are central to all CSN services and should be planned with care in advance by an administrator knowledgeable about the environment. The initial configuration process is required only once after the initial installation. Any necessary subsequent updates to the initial configuration parameters can be made from the CSN Console.

Several prompts will suggest a default value in brackets that can be accepted by simply pressing Enter.

Anchor
dual_network_primary_config
dual_network_primary_config
Dual-network Primary Configuration

The following prompts will display if you are configuring the Primary CSN on a dual-network:

1. Is this the Primary CSN (yes/no)? [yes]:

This prompt enables you to specify whether or not the CSN is a primary or secondary CSN. For a review of primary and secondary CSN, see  Primary vs. Secondary.

Make sure that only one primary CSN is configured on the internal network to prevent IP address conflicts as well as conflicts with both DHCP and Netmail Store netboot configuration. The primary server must be configured prior to configuration of a secondary. DHCP is not started on the secondary CSN.

2. Is this a single or dual network CSN (single/dual)? [dual]

Enter whether the CSN should be configured in a 'single' configuration with both the CSN and the storage nodes directly addressable on a single network or in a 'dual' configuration with the  storage nodes isolated on an internal network. For a review of dual and single-network configurations, see Networking (in CSN Requirements and Recommendations).

3. The following message then displays if you are setting up a Primary CSN:

Half of the NIC ports on this system will be bonded and assigned to the external network. The following questions configure the external network: Enter the CSN IP address []. Enter an available IP address on the public network. This is the address you use to access the CSN console and that external clients use to access resources on the internal network (such as Content Router services and the Netmail Store cluster through the SCSP Proxy).

4. Enter the cluster IP address. This IP address will remain with the Primary CSN in the event of a CSN failover []:

Enter another publicly accessible CSN IP address. (The term cluster here refers to a cluster of CSNs; that is, one primary CSN and one secondary CSN.)

This well-known address remains with the primary CSN in the event of a failover, meaning the cluster can always be reached at this address. The entered address must be in IPv4 format and must not already be in use by another host on the network.

5. Enter the subnet mask [255.255.255.0]:

Enter the subnet mask for the preceding IP addresses. The default is 255.255.255.0.

6. Enter the gateway IP address []:

Enter the IP address of the default gateway for the preceding IP addresses.

7. Half of the NIC ports on this system will be bonded and assigned to the internal network. The following questions configure the internal network:
    Enter the network address, e.g. 192.168.100.0 (small network), 192.168.0.0, 172.20.0.0 (large network) []:

Enter an IP address in your internal network to create an address space for Netmail Store nodes, third-party servers like DHCP, and other services. Enter the IP address in one of the following formats, depending on your needs:

    • Large network (Class B - more than 128 nodes): Format like 192.168.0.0, 10.10.0.0, or 172.20.0.0
    • Small network (Class C - 128 or fewer nodes): Format like 192.160.100.0, 10.10.100.0, or 172.20.100.0, where the 100 in the third octet limits the number of available IP Addresses in the specified range.

The interface is divided between the CSN(s), privileged applications on the internal network and the Netmail Store nodes. The initial configuration process automatically creates multiple alias IP addresses on the internal network for use by various system services and reserves similar IP Addresses for a Secondary CSN.

Prompts similar to the following display:

Configuring external/internal ports. This may take some time.
Checking ... eth0 ...eth1 ...eth2 ...eth3 ...
Eth Device | MAC | Public? | Bond
eth0 | 00:0c:29:e2:e6:65 | Y | bond1
eth1 | 00:0c:29:e2:e6:6f | Y | bond1
eth2 | 00:0c:29:e2:e6:79 | N | bond0
eth3 | 00:0c:29:e2:e6:83 | N | bond0
=============================================
Disconnected NICs =
Recommended ethernet device assignment

Internal NICs = eth2 eth3
External NICs = eth0 eth1
Input the list of External NICs.

The preceding shows how CSN suggests you allocate the available NICs by assigning them to internal and external CSN interfaces. The recommendation is based on how the NICs are currently cabled. All NICs that are currently connected to the network display.

Any NICs that are not connected to the network display as Disconnected NICs. After you connect them to the network (or if you later need to change NIC assignments), you can assign them to internal or external CSN interfaces as discussed in Modifying CSN Network Configuration.

Note

Note: If you answer no to the last configuration prompt asking if the entered values are correct, the interface table displayed on subsequent runs through the configuration prompts will show the values you previously selected for external and internal NICs NOT newly detected values based on any cabling changes.

8. external nics [space-separated-list]:

Displays the list of NICs the CSN has determined are for its external interface based upon responses from the external gateway. You can optionally change the list if you want to override the CSN's detection. If the NIC distribution is not as expected and you need to recable the NICs, best practice is to abort the initial configuration script, correct the cabling and then rerun initial configuration using /opt/caringo/csn/bin/firstcsnboot.

Note

Note: If the configured external gateway has ICMP turned off so that it does not respond to ping requests, the CSN will not be able to automatically detect how the NICs are cabled. You will need to manually assign the NICs to either the external or internal interface using the blank prompts.

9. internal nics [space-separated-list]:

Displays the list of NICs that CSN has determined are for its internal interface based on lack of response from the external gateway. You can optionally change the list if you want to override the CSN's detection. If the NIC distribution is not as expected and you need to recable the NICs, best practice is to abort the initial configuration script, correct the cabling and then rerun initial configuration using /opt/caringo/csn/bin/firstcsnboot.

10. Enter a list of IP addresses (separated by spaces) for external name servers [8.8.8.8 8.8.4.4]:

Enter a space-separated list of DNS server IP addresses for the external interface. The default values specify public DNS servers.

11. Enter a list of IP addresses or server names (separated by a space) for external time servers [0.pool.ntp.org 1.pool.ntp.org 2.pool.ntp.org]:

Enter a space-separated list of Network Time Protocol (NTP) server IP addresses or fully qualified host names for the external interface. The default values specify public DNS names from the NTP pool project.

12. Enter a unique storage cluster name. This name cannot be changed once assigned. A fully qualified domain name is recommended []:

Enter a unique name to identify the Netmail Store cluster. This value must be unique among all clusters you manage; otherwise, disaster recovery will be problematic. (If the contents of more than one cluster with the same name are written to a single disaster recovery cluster, it will be very difficult to recover the contents later.) Netmail strongly recommends you use a fully qualified IANA domain name (for example, csn.example.com).

The name you enter displays as the name of the storage cluster on the CSN Console as well as in metadata for all objects written to the local cluster. The CSN also uses this name to detect all the nodes participating in the cluster.

13. Enter the multicast group that should be used to uniquely identify the storage cluster on the network. Different storage clusters on the same network must have unique multicast addresses or the nodes will merge into a single cluster (225.0.10.100):

Enter a multicast group address for the storage cluster. Each cluster on the same network must have a unique multicast group address. It must be a Class D IP address in the range 224.2.0.0 - 239.255.255.255.

14. Are these values correct (yes/no)?

This last step allows you to review the values entered for all prompts before submitting them. Entering yes enables the initial configuration process to proceed with network and service configuration, resulting in a fully functional CSN. Entering no to the final initial configuration prompt restarts the initial configuration script at the first prompt, with the previously entered values populated. Values other than yes or no (case sensitive) are not supported.

Note

Note: After you complete the installation, but before CSN reboots, Fail messages might display. These messages are harmless and can be ignored.

At the completion of a successful initial configuration, the CSN immediately reboots the server to initialize all services. When the node comes back up, all network services are configured and available including SNMP, syslog, DHCP, DNS, NTP, and firewall. Additionally, the CSN Console is available, the SCSP Proxy will be configured and started and the Content Router Publisher will be configured and started.

Note

Note: The CSN configuration of network services in a dual-network configuration assumes full system control; manual editing of system configuration files may have unexpected results and is therefore not supported.

Dual-network Secondary CSN Configuration

After you configure a dual-network Primary CSN, you can optionally configure a Secondary CSN. The Secondary requires only the entry of a single unique external IP address and identification of the internal interface that is already defined on the Primary. The Secondary will then pull much of its network configuration data from the Primary. To facilitate this, a one-time use of the Primary's root password is required as follows (blank passwords are not supported):

Additional information about the network will be obtained from the primary CSN

Please enter the primary csn root password []:

Please re-enter the primary csn root password []:

Taken from the confirmation at the end of the initial configuration script, the Secondary configuration parameters are simply:

Primary: no
CSN Type: dual
External CSN IP address: 192.168.66.11
Internal network address: 172.20.20.0
external nics [defaults from system scan]:
internal nics [defaults from system scan]:
Are these values correct (yes/no)?

Note

Note: If a server on the Secondary's public network has an address that conflicts with the private internal address (.3) of the Primary CSN, then discovery of the Primary will fail and the Secondary CSN will not be able to boot. Administrators should take care to ensure IP address spaces do not overlap.

Once configured, a secondary CSN will register with the primary CSN on the internal network using a privileged SSH channel setup during configuration. This allows the primary to periodically sync needed information to the secondary, specifically the Primary's Backup Manifest UUID.

Anchor
single_network_primary_csn_config
single_network_primary_csn_config
Single-Network Primary CSN Configuration

The primary CSN in a single-network configuration should already have its network interfaces and IP address configured prior to installation, so the configuration prompts do not include those settings in single-network. During the configuration process, the CSN will read the subnet that was statically pre-configured in the CSN's network services files and use it to define the ranges that will be used for DHCP and netboot. The ranges will be printed during the configuration process to verify they are as intended. Administrators only need to define that the configuration should be for a primary CSN on a single network and then provide name server IP Addresses(es), NTP server(s), and a unique name and multicast group to identify the Netmail Store cluster as described in the dual-network configuration above.

Taken from the confirmation at the end of the initial configuration script, the single-network primary csn configuration parameters are simply:

DHCP Range:    172.20.20.33 - 172.20.20.83
Netboot Range: 172.20.20.84 - 172.20.20.254
Primary: yes
CSN Type: single
Name Servers: 8.8.8.8 8.8.4.4
Time Servers: 0.pool.ntp.org 1.pool.ntp.org 2.pool.ntp.org
Storage cluster name: cluster.example.com
Multicast Group: 225.0.10.100
Are these values correct (yes/no)?

Note the DHCP and Netboot Ranges are not entered during configuration but derived from the configured subnet.

Single-Network Secondary CSN Configuration

The secondary CSN in a single-network configuration should also already have its network interfaces and IP address configured prior to installation. Similar to a secondary CSN in a dual-network configuration, the secondary in a single-network configuration gets most of the rest of its configuration information from the primary CSN. You will need to enter the primary's IP address and root password to allow the primary's configuration settings to be shared.

Taken from the confirmation at the end of the initial configuration script, the single-network secondary csn configuration parameters are simply:

Primary CSN IP Address: 192.168.1.14
Primary: no
CSN Type: single
Are these values correct (yes/no)?

Configuring Object Storage Cluster Licensing

Subsequent to rebooting after configuration and prior to booting any storage cluster nodes, the Netmail Store license file you received with your purchased capacity must be published via the administrative CSN Console. The console allows web-based configuration of all CSN services after the initial network configuration.

To access the console initially for license publication, enter the following address: http://<CSNExternalIP>:8090. You will be required to authenticate prior to being granted access. The username for the console is 'admin' and the default password is 'caringo'. Once authenticated, click on the Licensing link under the Content Storage tab to access the licensing interface.

To correctly publish a license the following high-level steps are required:

1. Browse to the location of the license file you received with your published capacity using the Upload New License File field in the licensing user interface.

2. Upload the license. After the file has been updated, the licensing interface will show the company information populated in the license file as well as a last modified date for the license file.

Note

Note: The following characters are accepted: letters, numbers, and characters available by pressing Shift on the number keys (@, @, #, and so on).

Note

Note: Netmail Store scans for license updates every 15 minutes so it may be up to that long before a newly published license is registered in a running storage cluster.