Creating the S3 cluster

Limitations

After the S3 cluster deployment, you can change only the replication redundancy scheme. Changing the encoding redundancy scheme is disabled, because it may decrease cluster performance. Re-encoding demands a significant amount of cluster resources for a long period of time. If you still want to change the redundancy scheme, contact the technical support team.

Prerequisites

A clear understanding of the concept Storage policies.
The storage cluster has at least one disk with the Storage role.

To set up object storage services on cluster nodes

Admin panel

In the left menu, click Storage services > S3.
Select one or more nodes, and then click Create S3 cluster on the right pane. To create a highly available S3 cluster, select at least three nodes.

The nodes are displayed with small icons representing their roles within a cluster.
If the node network interfaces are not configured, click the cogwheel icon, select the networks as required, and then click Apply.
On the Volume parameters pane, select the desired tier, failure domain, and data redundancy mode. Click Proceed.
Specify the external (publicly resolvable) DNS name for the S3 endpoint that will be used by the end users to access the object storage. For example, s3.example.com. Click Proceed.

Configure your DNS server according to the example suggested in the admin panel.
From the drop-down list, select an S3 endpoint protocol: HTTP, HTTPS or both.

It is recommended to use only HTTPS for production deployments.
After selecting HTTPS
- Check Generate self-signed certificate to get a self-signed certificate for HTTPS evaluation purposes.
  S3 geo-replication requires a certificate from a trusted authority. It does not work with self-signed certificates.
  
  To access the data in the S3 cluster via a browser, add the self-signed certificate to browser’s exceptions.
- Acquire a key and a trusted wildcard SSL certificate for endpoint’s bottom-level domain. For example, the endpoint s3.storage.example.com would need a wildcard certificate for *.s3.storage.example.com with the subject alternative name s3.storage.example.com.
  
  If you acquired an SSL certificate from an intermediate certificate authority (CA), you should have an end-user certificate along with a CA bundle that contains the root and intermediate certificates. To be able to use these certificates, you need to merge them into a chain first. A certificate chain includes the end-user certificate, the certificates of intermediate CAs, and the certificate of a trusted root CA. In this case, an SSL certificate can only be trusted if every certificate in the chain is properly issued and valid.
  
  For example, if you have an end-user certificate, two intermediate CA certificates, and a root CA certificate, create a new certificate file and add all certificates to it in the following order:
```
# End-user certificate issued by the intermediate CA 1
-----BEGIN CERTIFICATE-----
MIICiDCCAg2gAwIBAgIQNfwmXNmET8k9Jj1X<...>
-----END CERTIFICATE-----
# Intermediate CA 1 certificate issued by the intermediate CA 2
-----BEGIN CERTIFICATE-----
MIIEIDCCAwigAwIBAgIQNE7VVyDV7exJ9ON9<...>
-----END CERTIFICATE-----
# Intermediate CA 2 certificate issued by the root CA
-----BEGIN CERTIFICATE-----
MIIC8jCCAdqgAwIBAgICZngwDQYJKoZIhvcN<...>
-----END CERTIFICATE-----
# Root CA certificate
-----BEGIN CERTIFICATE-----
MIIDODCCAiCgAwIBAgIGIAYFFnACMA0GCSqG<...>
-----END CERTIFICATE-----
```
  Upload the prepared certificate, and, depending on its type, do one of the following:
  - specify the passphrase (PKCS#12 files);
  - upload the SSL key.
Click Proceed.

You can change the protocol settings later. To do that, on the S3 > Nodes screen, click Protocol settings on the right pane.
If required, click Configure Notary and specify Notary DNS name and Notary user key.

You can also change the protocol settings later. To do that, on the S3 > Nodes screen, click Notary settings on the right pane.
Click Done to create the S3 cluster.

To check if the S3 cluster is successfully deployed and can be accessed by users, visit https://<S3_DNS_name> or http://<S3_DNS_name> in your browser. You should receive the following XML response:

<Error>
<Code>AccessDenied</Code>
<Message/>
</Error>

To start using the S3 storage, you will also need to create at least one S3 user.

Command-line interface

Use the following command:

vinfra service s3 cluster create [--tier {0,1,2,3}] [--failure-domain {0,1,2,3,4}]
                                 [--replicas <norm> | --encoding <M>+<N>]
                                 [--self-signed | --no-ssl | --cert-file <cert_file>]
                                 [--insecure] [--key-file <key_file>] [--password]
                                 --nodes <nodes> --s3gw-domain <domain>

--tier {0,1,2,3}

Storage tier (default: 0)

--failure-domain {0,1,2,3,4}

Storage failure domain (default: 0)

--replicas <norm>

Storage replication mapping in the format:

norm: the number of replicas to maintain (default: 1)

--encoding <M>+<N>

Storage erasure encoding mapping in the format:

M: the number of data blocks
N: the number of parity blocks

--self-signed

Generate a new self-signed certificate (default)

--no-ssl

Do not generate a self-signed certificate

--cert-file <cert_file>

Path to a file with the new certificate

--insecure

Allow insecure connections in addition to secure ones (only used with the --cert-file and --self-signed options)

--key-file <key_file>

Path to a file with the private key (only used with the --cert-file option)

--password

Read certificate password from stdin (only used with the --cert-file option)

--nodes <nodes>

A comma-separated list of node hostnames or IDs

--s3gw-domain <domain>

DNS name S3 endpoint

For example, to create the S3 cluster from nodes node001 and node002 with a self-signed certificate, run:

# vinfra service s3 cluster create --nodes node001,node002 --tier 0 --failure-domain 1 \
--encoding 1+2 --self-signed --s3gw-domain dns.example.com

This command also specifies the tier, failure domain, redundancy mode, and domain name.

You can view the S3 storage details in the vinfra service s3 show output:

# vinfra service s3 show
+----------------+--------------------------------------------+
| Field          | Value                                      |
+----------------+--------------------------------------------+
| failure_domain | 1                                          |
| id             | 0100000000000002                           |
| name           | cluster1                                   |
| nodes          | - id: ca334b1d-20a1-1241-96a5-eb9acadb8ecd |
|                | - id: ab36b523-91dc-e78d-53a7-88baed44541e |
| np             |                                            |
| nusers         | 0                                          |
| protocol       | scheme: https                              |
| redundancy     | m: 1                                       |
|                | n: 2                                       |
|                | type: raid6                                |
| s3gw_domain    | dns.example.com                            |
| tier           | 0                                          |
+----------------+--------------------------------------------+