# Quick installation guide

This is a quick installation guide. For a complete installation, refer to the following pages:

[bare-metal](https://docs.weka.io/4.0/install/bare-metal "mention")

[aws](https://docs.weka.io/4.0/install/aws "mention")

## Prerequisites

1. [OFED is installed](https://docs.weka.io/4.0/install/bare-metal/setting-up-the-hosts#mellanox-ofed-installation)
2. [NIC devices are configured properly](https://docs.weka.io/4.0/install/bare-metal/setting-up-the-hosts#configure-the-networking)
3. [NTP is set up](https://docs.weka.io/4.0/install/bare-metal/setting-up-the-hosts#configure-sync)

For a complete prerequisite list, refer to the [Prerequisites for Installation](https://docs.weka.io/4.0/install/prerequisites-for-installation-of-weka-dedicated-hosts) section. 

In the following examples, the deployment includes 8 identical servers (named `weka01` to `weka08`). 

This quick installation exemplifies two architecture types:

* **Multiple containers architecture:** an architecture with 8 servers. Each container is configured with only one process type: drive, compute, or frontend. See [Weka containers architecture overview](https://docs.weka.io/4.0/overview/weka-containers-architecture-overview).
* **Single container architecture:** an architecture with 8 identical servers. Each container is configured with the drive, compute, and frontend processes. 

In the following examples, we use Mellanox or Intel E810 NICs to simplify the installation commands. For example, only a single IP for data is required. No need to expose VFs, identification of the interface netmask, and default routing gateway. 

If the architecture is different, the installation commands are slightly different.

Once the WEKA system is installed, learn how to view, manage and operate it using either the GUI or the CLI, and perform the first IO to a WEKA filesystem.

The WEKA system supports a RESTful API for automating the interaction with the Weka system,  integrating it into your workflows, and monitoring systems.

## Quick installation for a multi-container backend architecture

It is assumed that the servers are ready for the WEKA software installation. In this example, there are 8 servers. Each server has over 20 cores, 6 NVME drives, and a single Mellanox NIC.

To run the commands on all containers in parallel, we use `pdsh` as an example only.

### Install the WEKA software

1. Install WEKA software on all servers:

```bash
pdsh -R ssh -w "weka0-[0-7]" "curl https://[GET.WEKA.IO-TOKEN]@get.weka.io/dist/v1/install/4.0.5.14/4.0.5.14 | sh

```

To get the download link with the token, see the [Obtain the Weka software installation package](https://docs.weka.io/4.0/install/bare-metal/obtaining-the-weka-install-file) topic.

### Remove the default container

1. Remove the single default container created on each server in the cluster:

```
pdsh -R ssh -w "weka0-[0-7]" 'weka local stop default && weka local rm -f default'

```

### Generate resource files

1. Get the resource generator to your local server:

```
wget 
https://raw.githubusercontent.com/weka/tools/master/install/resources_generator.py

```

2. Copy the resource generator from your local server to all servers in the cluster:

```
for i in {0..7}; do scp resources_generator.py weka0-$i:/tmp/resources_generator.py; done

```

3\. To enable execution, change the mode of the resource generator on all servers in the cluster:

```
pdsh -R ssh -w "weka0-[0-7]" 'chmod +x /tmp/resources_generator.py'

```

4\. Run resource generator on all servers in the cluster:

```
pdsh -R ssh -w "weka0-[0-7]" '/tmp/resources_generator.py  --path /tmp --net ens{5..7}'

```

The resource generator generates three resource files on each server in the `/tmp` directory: `drives0.json`, `compute0.json`, and `frontend0.json`.

For more details about the resource generator, see the [#3.-generate-the-resource-files](https://docs.weka.io/4.0/install/bare-metal/using-cli#3.-generate-the-resource-files "mention") procedure in the *WEKA cluster installation* topic.

### Configuration

#### Create the drive containers

1. Create the drive containers from the resource generator output file `drives0.json`. Run the following command on all servers in the cluster:

```
pdsh -R ssh -w "weka0-[0-7]" 'weka local setup container --resources-path /tmp/drives0.json'

```

#### Create a cluster

1. Connect to one of the servers, create the cluster, and set the cluster name.\
   Using bash, you can provide a compact list of containers cluster-name{n..m}. Otherwise, specify the complete list of all containers. For example: `weka cluster create weka0-0 weka0-1 weka0-2 weka0-3 weka0-7`.\
   It is assumed that the DNS is set up. Otherwise, specify the explicit IPs in the `weka cluster create` command.

```bash
ssh weka0-1
weka cluster create weka0-{0..7}
weka cluster update --cluster-name=WekaProd

```

#### Add a drive to the cluster

1. Add a drive to each server in the cluster. Run the following command from one of the servers:

```
for i in {0..7} ; do weka cluster drive add $i /dev/nvme0n1 /dev/nvme1n1 /dev/nvme2n1 /dev/nvme3n1 /dev/nvme4n1 /dev/nvme5n1 ; done

```

#### Create compute containers

1. Create the compute containers from the resource generator output file `compute0.json`. Run the following command on all servers in the cluster:

```
pdsh -R ssh -w "weka0-[0-7]" 'weka local setup container --resources-path /tmp/compute0.json --join-ips $(hostname -i)'

```

#### Name the cluster and enable event notifications to the cloud

1. Enable event notifications to the cloud for support purposes. From one of the servers, run the following command:

```
weka cluster update --cluster-name=WekaProd
weka cloud enable

```

#### Set the license

1. Obtain a classic or PAYG license from [get.weka.io](https://get.weka.io/).
2. Set the license. From one of the servers, run the following command:

```
weka cluster license set LICENSE_TEXT_OBTAINED_FROM_GET_WEKA_IO

```

#### Start the cluster IO service

1. Start the cluster IO service. From one of the servers, run the following command:

```
weka cluster start-io

```

#### Create frontend containers

1. Create the frontend containers from the resource generator output file `frontend0.json`. This step is required to mount from the server or set one of the additional protocols on the server, which requires a frontend process.\
   Run the following command on all servers in the cluster:

```
 pdsh -R ssh -w "weka0-[0-7]" 'weka local setup container --resources-path /tmp/frontend0.json --join-ips  $(hostname -i)'

```

### Post configuration

#### Check the cluster configuration

1. Check the resources per server (such as NICs and cores), drives, and configuration status:

```bash
do
    weka cluster container resources $i
done

weka cluster drive

weka status

```

Output example for a **multiple container** architecture:

```bash
WekaIO v4.0.5.14 (CLI build 4.0.5.14)

       cluster: WekaProd (00569cef-5679-4e1d-afe5-7e82748887de)
        status: OK (8 backends UP, 6 drives UP)
    protection: 6+2
     hot spare: 1 failure domains
 drive storage: 82.94 TiB total, 82.94 TiB unprovisioned
         cloud: connected
       license: Unlicensed

     io status: STARTED 7 seconds ago (96 io-nodes UP, 750 buckets UP)
    link layer: Ethernet
       clients: 0 connected
         reads: 0 B/s (0 IO/s)
        writes: 0 B/s (0 IO/s)
    operations: 0 ops/s
        alerts: 1 active alert, use `weka alerts` to list it

```

2\. Change the default admin password and ensure no other alerts exist.

## Quick installation for a single container architecture

It is assumed that the servers are ready for the Weka software installation. In the following example, there are 8 servers. Each server has over 20 cores, 6 NVME drives, and a single Mellanox NIC.

### Install the Weka software

1. Install Weka software on all containers:

```bash
pdsh -w weka0[1-8] "curl https://[GET.WEKA.IO-TOKEN]@get.weka.io/dist/v1/install/4.0.2/4.0.2 | sudo sh"
```

To get the download link with the token, see the [Obtain the Weka software installation package](https://docs.weka.io/4.0/install/bare-metal/obtaining-the-weka-install-file) topic.

### Configuration

1. Connect to one of the servers and run the commands below to:
   * Create the cluster and set the cluster name, stripe width, and protection scheme.\
     Using bash, you can provide a compact list of containers `cluster-name{n..m}`. Otherwise, specify the full list of all containers. For example: `weka cluster create weka01 weka02 weka03 weka04 weka05 weka06 weka07 weka08`.\
     It is assumed that the DNS is set up. Otherwise, specify the explicit IPs in the `weka cluster create` command.
   * Enable event notifications to the cloud for support purposes.

```bash
ssh weka01
weka cluster create weka0{1..8}
weka cluster update --cluster-name=WekaProd
weka cloud enable

```

Configure the network, drives, and CPUs per container:

2\. Configure the network NICs, drives, and cores per container. Replace network, drives, and cores \
    configuration with your actual data.

```bash
for i in {0..7}
do
    weka cluster container dedicate $i on
    
    # add network NICs to each container. For example, weka cluster container net add $i eth1
    weka cluster container net add $i NETDEV
    
    # add the nvme drives to each container 
    weka cluster drive add $i /dev/nvme0n1 /dev/nvme1n1 /dev/nvme2n1 /dev/nvme3n1 /dev/nvme4n1 /dev/nvme5n1
    
    # set the cores each container
    weka cluster container cores $i 19 --frontend-dedicated-cores 1 --drives-dedicated-cores 6
done

```

```bash
# show hosts info (net, cores, etc.)
for i in {0..7}
do
    weka cluster container resources $i
done

# show drives info
weka cluster drive

# show configuration status
weka status

```

### Post configuration

1. Check the resources per container (such as NICs and cores), drives, and configuration status:

```bash
for i in {0..7}
do
    weka cluster container resources $i
done

weka cluster drive

weka status

```

2\. If the configuration status is according to your needs, apply the configuration:

```bash
# initialize the containers
weka cluster container apply --all --force

```

3\. Verify that the `apply` operation is successful. Check the alerts and verify that the\
    `ResourcesNotAppliedalert` alert does not show.

```
weka alerts

```

4\. Obtain a classic or PAYG license from [get.weka.io](https://get.weka.io/) and set the license. 

```
weka cluster license set LICENSE_TEXT_OBTAINED_FROM_GET_WEKA_IO

```

5\. Start the cluster:

```bash
weka cluster start-io

```

6\. Check the cluster information and status:

```bash
weka status

```

Output example:

```bash
WekaIO v4.0.0 (CLI build 4.0.0)

       cluster: WekaProd (00569cef-5679-4e1d-afe5-7e82748887de)
        status: OK (8 backends UP, 48 drives UP)
    protection: 6+2
     hot spare: 1 failure domains
 drive storage: 82.94 TiB total, 82.94 TiB unprovisioned
         cloud: connected
       license: Unlicensed

     io status: STARTED 7 seconds ago (96 io-nodes UP, 750 buckets UP)
    link layer: Ethernet
       clients: 0 connected
         reads: 0 B/s (0 IO/s)
        writes: 0 B/s (0 IO/s)
    operations: 0 ops/s
        alerts: 1 active alert, use `weka alerts` to list it
```

7\. Change the default admin password and ensure no other alerts exist.

**Related topics**

[bare-metal](https://docs.weka.io/4.0/install/bare-metal "mention")

[manage-the-system-using-weka-cli](https://docs.weka.io/4.0/getting-started-with-weka/manage-the-system-using-weka-cli "mention")

[manage-the-system-using-weka-gui](https://docs.weka.io/4.0/getting-started-with-weka/manage-the-system-using-weka-gui "mention")

[performing-the-first-io](https://docs.weka.io/4.0/getting-started-with-weka/performing-the-first-io "mention")

[getting-started-with-weka-rest-api](https://docs.weka.io/4.0/getting-started-with-weka/getting-started-with-weka-rest-api "mention")


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.weka.io/4.0/getting-started-with-weka/quick-install-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.