Versions Compared

Key

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

...

Lower clock speeds are supported but may result in reduced performance.

Network Switch Specifications

Minimum Capability: The network switch must support a minimum of 10 Gbps or 25 Gbps Ethernet (10/25GbE).

RAM Specifications

Minimum Requirement: 64 GB RAM.

Server Operating System Requirements for SNS Deployment

Operating System

Required OS:

...

Memory Requirements:

OS requirements:

...

Run the script as root, so you can sudo su to switch to root.

Code Block
datacore@demo00:~$ sudo su
root@demo00:/home/datacore#

You may or may not need to enter a password here to switch to root depending on the permissions provided earlier when installing the system.

Run the install-ssa script.

...

Ubuntu 22.04.

Partitioning Recommendation:

The operating system partitions and /var/lib should be mounted on a separate RAID-protected SSD set.

Purpose: To safeguard the operating system in the event of a single drive failure.

Network Configuration

IP Address: Ensure the server is assigned a static IP address for reliable communication and consistent networking.

Storage Drives

Drive Format:

Storage drives must remain unformatted.

Path Visibility:

Drives should appear as single paths in the system (e.g., /dev/sdc, /dev/sdd).

Known Issues

UI Notification for Free Ports on Network Switches

Issue:

If there are any unused ports on the network switches, the UI may display the following warning:
"Nics on <server> has issues!"

Impact: This is a false-positive alert and does not affect the functionality of the system.
Resolution: This issue is scheduled to be fixed in the next upcoming release.

Initial Server Access and Configuration

Logging into the Server

Ensure Server Readiness:

The server must be running Ubuntu 22.04 and should be powered on and accessible on the network.

Access via SSH:

Use SSH to log in to the server:

ssh <username>@<server_ip>

Switch to Root User:

After logging in, switch to the root user:

sudo su

Enter the password configured during the server installation when prompted.

Installing the SSA Debian Package

Installation Command

To install the SSA Debian package, execute the following command as the root user:

sudo su -c "bash <(wget -qO- https://apt.cloud.datacore.com/installssa/install-ssa.sh)"

...

root

  1. Installation is done via script. Please contact your Solutions Architect for the SNS installation.

    There are a few prechecks to accept.
    It adds the apt repository, then installs the latest periferyssa debian package as shown in the example below:

    Code Block
    We're running as root great
    The detected os version is Description: Ubuntu 22.04.3 LTS
    checking for updates in apt
    Adding the public key for the apt repository
    Warning: apt-key is deprecated. Manage keyring files in trusted.gpg.d instead (see apt-key(8)).
    OK
    Adding the perifery apt repository
    Repository: 'deb https://apt.cloud.datacore.com/dev jammy main'
    Description: Archive for codename: jammy components: main
    More info: https://apt.cloud.datacore.com/dev
    Adding repository.
    Adding deb entry to /etc/apt/sources.list.d/archive_uri-https_apt_cloud_datacore_com_dev-jammy.list
    Adding disabled deb-src entry to /etc/apt/sources.list.d/archive_uri-https_apt_cloud_datacore_com_dev-jammy.list
    Hit:1 http://us.archive.ubuntu.com/ubuntu jammy InRelease
    Hit:2 http://us.archive.ubuntu.com/ubuntu jammy-updates InRelease
    Get:3 https://apt.cloud.datacore.com/dev jammy InRelease [1,164 B]
    Hit:4 http://us.archive.ubuntu.com/ubuntu jammy-backports InRelease
    Hit:5 http://security.ubuntu.com/ubuntu jammy-security InRelease
    Get:6 https://apt.cloud.datacore.com/dev jammy/main amd64 Packages [1,204 B]
    Fetched 2,368 B in 1s (4,586 B/s)
    Reading package lists... Done
    W: https://apt.cloud.datacore.com/dev/dists/jammy/InRelease: Key is stored in legacy trusted.gpg keyring (/etc/apt/trusted.gpg), see the DEPRECATION section in apt-key(8) for details.
    W: https://apt.cloud.datacore.com/dev/dists/jammy/InRelease: Key is stored in legacy trusted.gpg keyring (/etc/apt/trusted.gpg), see the DEPRECATION section in apt-key(8) for details.
    The apt repository for the Swarm Software Appliance has now been installed\n added to this machine.
    The script will now install the application pending some environmental checks
    Do you want to proceed? (yes/no)
    
    
  2. Accepting those prechecks adds the Swarm deb repo.

  3. Type ‘yes’ , then hit enter. It proceeds to install the bootstrapper.

    Code Block
    Do you want to proceed? (yes/no) yes
    ok, attempting to install
    installing ssa bootstrapper
    Extracting templates from packages: 100%
    Scanning processes...
    Scanning processor microcode...
    Scanning linux images...
    
    Running kernel seems to be up-to-date.
    
    The processor microcode seems to be up-to-date.
    
    No services need to be restarted.
    
    No containers need to be restarted.
    
    No user sessions are running outdated binaries.
    
    No VM guests are running outdated hypervisor (qemu) binaries on this host.
    2024-03-19 16:49:39 - Installing pre-requisites
    Hit:1 https://apt.cloud.datacore.com/dev jammy InRelease
    Hit:2 http://us.archive.ubuntu.com/ubuntu jammy InRelease
    Hit:3 http://security.ubuntu.com/ubuntu jammy-security InRelease
    Hit:4 http://us.archive.ubuntu.com/ubuntu jammy-updates InRelease
    Hit:5 http://us.archive.ubuntu.com/ubuntu jammy-backports InRelease
    Reading package lists... Done
    W: https://apt.cloud.datacore.com/dev/dists/jammy/InRelease: Key is stored in legacy trusted.gpg keyring (/etc/apt/trusted.gpg), see the DEPRECATION section in apt-key(8) for details.
    Reading package lists... Done
    Building dependency tree... Done
    Reading state information... Done
    ca-certificates is already the newest version (20230311ubuntu0.22.04.1).
    ca-certificates set to manually installed.
    curl is already the newest version (7.81.0-1ubuntu1.15).
    curl set to manually installed.
    gnupg is already the newest version (2.2.27-3ubuntu2.1).
    gnupg set to manually installed.
    The following NEW packages will be installed:
      apt-transport-https
    0 upgraded, 1 newly installed, 0 to remove and 62 not upgraded.
    Need to get 1,510 B of archives.
    After this operation, 170 kB of additional disk space will be used.
    Get:1 http://us.archive.ubuntu.com/ubuntu jammy-updates/universe amd64 apt-transport-https all 2.4.11 [1,510 B]
    Fetched 1,510 B in 0s (8,571 B/s)
    Selecting previously unselected package apt-transport-https.
    (Reading database ... 174603 files and directories currently installed.)
    Preparing to unpack .../apt-transport-https_2.4.11_all.deb ...
    Unpacking apt-transport-https (2.4.11) ...
    Setting up apt-transport-https (2.4.11) ...
    Scanning processes...
    Scanning processor microcode...
    Scanning linux images...
    
    Running kernel seems to be up-to-date.
    
    The processor microcode seems to be up-to-date.
    
    No services need to be restarted.
    
    No containers need to be restarted.
    
    No user sessions are running outdated binaries.
    
    No VM guests are running outdated hypervisor (qemu) binaries on this host.
    Hit:1 https://apt.cloud.datacore.com/dev jammy InRelease
    Hit:2 http://us.archive.ubuntu.com/ubuntu jammy InRelease
    Get:3 https://deb.nodesource.com/node_18.x nodistro InRelease [12.1 kB]
    Hit:4 http://security.ubuntu.com/ubuntu jammy-security InRelease
    Hit:5 http://us.archive.ubuntu.com/ubuntu jammy-updates InRelease
    Hit:6 http://us.archive.ubuntu.com/ubuntu jammy-backports InRelease
    Get:7 https://deb.nodesource.com/node_18.x nodistro/main amd64 Packages [7,386 B]
    Fetched 19.5 kB in 0s (44.8 kB/s)
    Reading package lists... Done
    W: https://apt.cloud.datacore.com/dev/dists/jammy/InRelease: Key is stored in legacy trusted.gpg keyring (/etc/apt/trusted.gpg), see the DEPRECATION section in apt-key(8) for details.
    2024-03-19 16:49:44 - Repository configured successfully. To install Node.js, run: apt-get install nodejs -y
    Scanning processes...
    Scanning processor microcode...
    Scanning linux images...
    
    Running kernel seems to be up-to-date.
    
    The processor microcode seems to be up-to-date.
    
    No services need to be restarted.
    
    No containers need to be restarted.
    
    No user sessions are running outdated binaries.
    
    No VM guests are running outdated hypervisor (qemu) binaries on this host.
    Scanning processes...
    Scanning processor microcode...
    Scanning linux images...
    
    Running kernel seems to be up-to-date.
    
    The processor microcode seems to be up-to-date.
    
    No services need to be restarted.
    
    No containers need to be restarted.
    
    No user sessions are running outdated binaries.
    
    No VM guests are running outdated hypervisor (qemu) binaries on this host.
    npm notice
    npm notice New major version of npm available! 9.8.1 -> 10.5.0
    npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.5.0
    npm notice Run npm install -g npm@10.5.0 to update!
    npm notice

If the installer is at “Scanning linux images…” stage, press return and it should proceed further.

Once the bootstrapper is installed, it installs Nodejs, TypeScript, and some npm packages.

Code Block
Reading package lists... Done
W: https://apt.cloud.datacore.com/dev/dists/jammy/InRelease: Key is stored in legacy trusted.gpg keyring (/etc/apt/trusted.gpg), see the DEPRECATION section in apt-key(8) for details.
2024-03-20 15:26:43 - Repository configured successfully. To install Node.js, run: apt-get install nodejs -y
Reading package lists...
Building dependency tree...
Reading state information...
nodejs is already the newest version (18.18.2-1nodesource1).
The following packages were automatically installed and are no longer required:
  libavahi-client-dev libavahi-common-dev libavahi-compat-libdnssd-dev libavahi-compat-libdnssd1 libdbus-1-dev pkg-config wireguard wireguard-tools
Use 'sudo apt autoremove' to remove them.
0 upgraded, 0 newly installed, 0 to remove and 58 not upgraded.
Reading package lists...
Building dependency tree...
Reading state information...
node-typescript is already the newest version (4.5.4+ds1-1).
The following packages were automatically installed and are no longer required:
  libavahi-client-dev libavahi-common-dev libavahi-compat-libdnssd-dev libavahi-compat-libdnssd1 libdbus-1-dev pkg-config wireguard wireguard-tools
Use 'sudo apt autoremove' to remove them.
0 upgraded, 0 newly installed, 0 to remove and 59 not upgraded.
Scanning processes...
Scanning processor microcode...
Scanning linux images...

The processor microcode seems to be up-to-date.

No services need to be restarted.

No containers need to be restarted.

No user sessions are running outdated binaries.

No VM guests are running outdated hypervisor (qemu) binaries on this host.
The bootstrapper and api services have now been installed you can now go to http://<IP address>/ui to continue configuration

Once the installation is complete, it will display the URL to continue the configuration. Copy that URL and manually enter it in the browser for UI configuration. When the below pop-up prompts, you are ready to go to the UI to configure the system.

...

  1. and press enter to proceed with the installation of the bootstrapper and required packages. Once the installation is complete, a URL will be provided to access the UI. Following this, the support bundle packages will be updated, and firewall settings will be configured. Use the provided URL to access the UI.

    Code Block
    Automatic reboots after unattended upgrades have been disabled.
    The bootstrapper and api services have now been installed you can now go to http://<serverIP>:9010/ui to continue configuration

If the installer is at “Scanning linux images…” stage, press return and it should proceed further.

Access the provided URL from any browser, and it will prompt you with a "Create Cluster" button on the page. Click the "Create Cluster" button to proceed.

...

  • It will open the "Create New Cluster" page. Follow the steps below:

    1. Provide the desired cluster name.

    2. Upload the license using the "Choose File" link.

      • If no license is uploaded, the default 2TB license will be applied.

    3. Click on the "Advanced" dropdown link.

    4. Provide the Domain Name and Bucket Name for creation during cluster setup.

      • If Domain Name and Bucket Name are not provided, the default Domain Name “test“ and Bucket Name “default” will be used.

    5. After entering all details, click the "Next" button to proceed.

  • image-20250124-063105.pngImage Added

  • A confirmation page will open. Follow the steps below:

    1. Verify that the entered details are correct.

    2. If all values are correct, click "Confirm" to proceed further.

    3. If any modifications are needed, click "Back" to modify the values, then click "Next" and "Confirm" again to proceed.

...

Wait for a few minutes while the provided details are validated and the initial configuration is completed. Once all checks are done, you will see a pop-up message saying "New cluster is created successfully." Click "Done" to finish.

Need to add POP up image here

Once the "Calculating..." window opens, click on "Show Details." This will display the current phase of the cluster creation process.

image-20250124-064147.pngImage Added

image-20250124-064017.pngImage Added

Wait for a minimum of 10-15 minutes, depending on network speed. After that, the "Log in to Single Node Swarm" page will open. Provide the default username and password as "periferyadmin/password" and click on login. Note that there is an issue with the NICs, as mentioned above in the document.

image-20250124-065134.pngImage Added

After logging in, the "Update Password" page will open. Set the password as desired and click the "Update Password" button. Within a few seconds, the password will be updated, and a "Password Updated Successfully" message will briefly appear before disappearing. For the next login, use the updated password, as the initial default password will no longer work.

UPdate password page needs to be add.

You Will Be Redirected to the Dashboard Page, and Now Your Cluster is Up and Running: See the Below Section in UI Which Will Navigate You Through

  1. S3 Endpoint: In the "S3 Endpoint" section, view the S3 endpoint details.

  2. Advanced Section: Under the "Advanced" section, you will see the "Content Management" and "Storage Management" link boxes.

  3. Navigation: Clicking on these links will navigate you to the respective UIs in a new window.

  4. Storage Box: Under the "Storage" box, observe the utilized and free space bars.

Need to be updated UI screenshot here.

Hope you had enjoyed the Installation.