Storage-as-a-Service Integration Guide

ManualsBrandsAcronis ManualsApplicationsStorage 2.2

Table Of Contents

Acronis Storage 2.2

Storage-as-a-Service Integration

Guide

August 11, 2017

Summary of content (76 pages)

PAGE 1
Acronis Storage 2.
PAGE 2
Copyright Statement Acronis International GmbH, 2002-2016. All rights reserved. ”Acronis” and ”Acronis Secure Zone” are registered trademarks of Acronis International GmbH. ”Acronis Compute with Conﬁdence”, ”Acronis Startup Recovery Manager”, ”Acronis Active Restore”, ”Acronis Instant Restore” and the Acronis logo are trademarks of Acronis International GmbH. Linux is a registered trademark of Linus Torvalds. VMware and VMware Ready are trademarks and/or registered trademarks of VMware, Inc.
PAGE 3
Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.1 About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 About WHMCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 About S3 Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.
PAGE 4
3.1 Requirements for Integration via REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3.1.1 Conﬁguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.1.2 Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.2 Managing S3 Users via REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.2.1 Creating S3 Users . . . . . . . . . . . . .
PAGE 5
4.2.4 Disabling S3 Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 4.2.5 Enabling S3 Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 4.2.6 Deleting S3 Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 4.2.7 Generating S3 Access Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 4.2.8 Revoking S3 Access Keys . . . . . . . . . . . . . .
PAGE 6
CHAPTER 1 Introduction Acronis Storage is a software-deﬁned storage optimized for storing large amounts of data. It provides data redundancy (replication and erasure coding), high availability, self-healing, and storage sharing. 1.1 About This Guide This document will help you integrate Amazon S3 compatible services into your WHMCS provisioning and billing system.
PAGE 7
Chapter 1. Introduction 1.3 About S3 Clusters Acronis Storage allows you to export cluster disk space to customers in the form of an S3-like object-based storage. Acronis Storage is implemented as an Amazon S3-like API, which is one of the most common object storage APIs. End users can work with Acronis Storage as they work with Amazon S3. You can use the usual applications for S3 and continue working with it after the data migration from Amazon S3 to Acronis Storage.
PAGE 8
1.3.
PAGE 9
Chapter 1. Introduction 1.4 Integration Methods Acronis Storage provides an orchestration representational state transfer (REST) API as well as an Amazon S3 compatible REST API. With the orchestration API, you can manage users and buckets, conﬁgure user and bucket limits, and collect usage statistics. You can use the orchestration API by means of a single CLI tool shipped with Acronis Storage.
PAGE 10
CHAPTER 2 Integration via Command-Line Interface (CLI) This chapter explains ways to use the command-line interface to provision, enable, disable, and terminate S3 users as well as set user and bucket limits for billing purposes. 2.1 Managing S3 Users The concept of S3 user is one of the base concepts of object storage along with those of object and bucket (container for storing objects).
PAGE 11
Chapter 2. Integration via Command-Line Interface (CLI) 2.1.1 Creating S3 Users You can generate a unique random S3 user ID and an access key pair (S3 Access Key ID, S3 Secret Access Key) using the ostor-s3-admin create-user command. You need to specify a user email. For example: # ostor-s3-admin create-user -e user@email.com UserEmail:user@email.
PAGE 12
2.1. Managing S3 Users 3SecretAccessKey>JL7gt1OH873zR0Fzv8Oh9ZuA6JtCVnkgV7lET6ET 2.1.3 Querying S3 User Information To display information about the speciﬁed user, use the ostor-s3-admin query-user-info command. You need to specify either the user email (-e) or S3 ID (-i). For example: # ostor-s3-admin query-user-info -e user@email.com Query user: user id=d866d9d114cc3d20, user email=user@email.
PAGE 13
Chapter 2. Integration via Command-Line Interface (CLI) need to specify either the user email (-e) or S3 ID (-i). For example: # ostor-s3-admin gen-access-key -e user@email.com Generate access key: user id=d866d9d114cc3d20, access key id=d866d9d114cc3d20D8EW, secret access key=83tTsNAuuRyoBBqhxMFqHAC60dhKHtTCCkQe54zu Note: It is recommended to periodically revoke old and generate new access key pairs. 2.1.
PAGE 14
2.2. Managing S3 User and Bucket Limits via CLI ops:put=0.00ops/s ops:list=0.00ops/s ops:delete=0.00ops/s bandwidth:out=0kbs/s 2.2.2 Setting Bandwidth per Second for Users You can limit outgoing bandwidth of a response with the set-limits command and the following parameters: specifying the email address, -t bandwidth specifying the limit type, and -L out= -e specifying the limit key: # ostor-s3-admin set-limits -e client@example.com -t bandwidth -L out=100 ops:default=0.00ops/s ops:get=3600.
PAGE 15
Chapter 2. Integration via Command-Line Interface (CLI) # ostor-s3-admin rm-limits -e client@example.com ops:default=0.00ops/s ops:get=0.00ops/s ops:put=0.00ops/s ops:list=0.00ops/s ops:delete=0.00ops/s bandwidth:out=0kbs/s 2.2.
PAGE 16
2.2. Managing S3 User and Bucket Limits via CLI 2.2.7 Querying Bucket Limits You can display the current limits with the query-limits command and parameter -b specifying the bucket name: # ostor-s3-admin query-limits -b example ops:default=0.00ops/s ops:get=3600.00ops/s ops:put=0.00ops/s ops:list=0.00ops/s ops:delete=0.00ops/s bandwidth:out=100kbs/s 2.2.
PAGE 17
CHAPTER 3 Integration via REST API This chapter explains ways to provision, enable, disable, and terminate S3 users as well as set user and bucket limits for billing purposes. The provided examples are Bash commands with which you can send requests to S3 cluster’s REST API via cURL and OpenSSL. Responses are in JSON format and can be processed further with tools like json_pp or json_reformat. Note: Replace http://s3.example.com in examples with your actual S3 gateway URL. 3.
PAGE 18
3.1. Requirements for Integration via REST API 3.1.1 Conﬁguration The examples will use cURL for authentication as well as GET, PUT, POST, and DELETE operations run in Bash. You can simplify signature creation if you create a sane environment ﬁrst. Create a ﬁle s3_key ~/.s3_environment replacing with your S3AcessKeyId and s3_secret with your S3SecretAccessKey and the following content: # s3 login variables.
PAGE 19
Chapter 3. Integration via REST API } You need to load the ﬁle into your default environment to make the s3_curl function available. Once the ﬁle is loaded, you can use it for all further S3 requests. Load the ﬁle with the following command: # source ~/.s3_environment 3.1.2 Statistics You need to have statistics collection enabled on your S3 gateway. The S3 gateway will save the statistics as regular storage objects. On each S3 storage node, create a ﬁle /var/lib/ostor/local/gw.
PAGE 20
3.2. Managing S3 Users via REST API ”AWSAccessKeyId”: ”ca55631f9f3d59dcDF4M”, ”AWSSecretAccessKey”: ”QCbj17BzeepyvUAdJeFNFYW9fCzbq0uFal6e5pGm” } ] } 3.2.2 Listing S3 Users You can list information about all users with the ostor-users service. Additional rows may list S3 access key pairs associated with the user. For example: # s3_curl GET ”http://s3.example.com/?ostor-users” [ { ”UserEmail”: ”user@example.
PAGE 21
Chapter 3. Integration via REST API ”UserId”: ”ca55631f9f3d59dc”, ”State”: ”enabled”, ”OwnerId”: ”0000000000000000”, ”Flags”: [ ], ”AWSAccessKeys”: [ { ”AWSAccessKeyId”: ”ca55631f9f3d59dcDF4M”, ”AWSSecretAccessKey”: ”QCbj17BzeepyvUAdJeFNFYW9fCzbq0uFal6e5pGm” }, { ”AWSAccessKeyId”: ”ca55631f9f3d59dcZMDX”, ”AWSSecretAccessKey”: ”ffWvnOcNiH0jkQod4huv51BMYBuSWs4zRLFVwd4d” } ] } 3.2.
PAGE 22
3.2. Managing S3 Users via REST API # s3_curl DELETE ”http://s3.example.com/?ostor-users&emailAddress=client@example.com” Users who own buckets cannot be removed until their buckets are deleted. You can get a list of user’s buckets by means of S3AccessKeyId and S3SecretAccessKey from user account: # export s3_key=”b81d6c5f895a8c86DYL6” # export s3_secret=”FwWe34pjLPhtGsqHxNwvnE6ECea6TfyH3pyfFZ3G” # s3_curl GET http://s3.example.com/
PAGE 23
Chapter 3. Integration via REST API ”AWSAccessKeyId”: ”ca55631f9f3d59dcZMDX”, ”AWSSecretAccessKey”: ”ffWvnOcNiH0jkQod4huv51BMYBuSWs4zRLFVwd4d” } ] } 3.2.8 Revoking S3 Access Keys You can revoke the speciﬁed access key pair of the speciﬁed user with the ostor-users service and the following parameters: emailAddress specifying the user email address, revokeKey specifying the access key in the key pair: # s3_curl POST ”http://s3.example.com/?ostor-users&emailAddress=client@example.com\ &revokeKey=ca55631f9
PAGE 24
3.3. Managing S3 User and Bucket Limits via REST API # s3_curl PUT ”http://s3.example.com/?ostor-limits&emailAddress=client@example.com\ &limit-type=bandwidth&limit-resource=out&limit-value=100” 3.3.3 Querying User Limits You can display the current limits with the ostor-limits service and parameter emailAddress specifying the email address: # s3_curl GET ”http://s3.example.com/?ostor-limits&emailAddress=client@example.com” { ”ops:default”: ”0.00”, ”ops:get”: ”3600.00”, ”ops:put”: ”0.
PAGE 25
Chapter 3. Integration via REST API 3.3.6 Setting Bandwidth per Second for Buckets You can limit outgoing bandwidth of a response with the bucket ostor-limits service and the following parameters: specifying the bucket name, bandwidth specifying the limit type, and out= specifying the limit value: # s3_curl PUT ”http://s3.example.com/?ostor-limits&bucket=client&limit-type=bandwidth\ &limit-resource=out&limit-value=100” 3.3.
PAGE 26
3.4. Obtaining Usage Statistics via REST API 3.4.1 Listing Statistics Objects You can list all available statistics objects with the ostor-usage service and no parameters. The output only contains objects that have not been deleted. For example: # s3_curl GET ”http://s3.example.com/?ostor-usage” { ”nr_items”: 7, ”truncated”: false, ”items”: [ ”s3-usage-8000000000000065-2017-02-01T16:31:54.000Z-1800”, ”s3-usage-8000000000000067-2017-02-01T16:30:51.000Z-1800”, ”s3-usage-8000000000000068-2017-02-01T16:27:25.
PAGE 27
Chapter 3. Integration via REST API ”key”: { ”bucket”: ”client”, ”epoch”: 98309, ”user_id”: ”b81d6c5f895a8c86”, ”tag”: ”” }, ”counters”: { ”ops”: { ”put”: 1, ”get”: 3, ”list”: 0, ”other”: 0 }, ”net_io”: { ”uploaded”: 41258, ”downloaded”: 45511311 } } } ] } 3.4.3 Deleting Statistics Objects You can delete existing statistics objects with the ostor-usage service and parameter obj specifying the statistics object: # s3_curl DELETE ”http://s3.example.com/?ostor-usage\ &obj=s3-usage-8000000000000065-2017-02-01T
PAGE 28
CHAPTER 4 Integration with WHMCS This chapter explains ways to provision, enable, disable, and terminate S3 users as well as set user and bucket limits for billing purposes. The provided examples are PHP scripts with which you can send requests to S3 cluster’s REST API via cURL and OpenSSL. Note: Replace http://s3.example.com in examples with your actual S3 gateway URL and http://whmcs.example.com with you actual WHMCS portal URL.
PAGE 29
Chapter 4. Integration with WHMCS 4.1 Requirements Any operation or management request must be authenticated with a signed request via Signature Version 2 or 4 of the Amazon S3 protocol of the corresponding S3 system user. You can create system users on any storage node in the cluster with the ostor-s3-admin create-user -S command and parameter -e specifying the user email address: # ostor-s3-admin create-user -S -e user@example.com UserEmail:user@example.
PAGE 30
4.1. Requirements // s3 login. $vars[’s3_key’] = ”939e2ac6916b57082P9O”; $vars[’s3_secret’] = ”tVYF3kZD9zcTtl6q6QDTHaZKM2nuq4xVcl8ikJpd”; // s3 gateway. $vars[’s3_gateway’] = ”http://s3.example.com”; // whmcs login. $vars[’whmcs_username’] = ”admin”; // Return config array. return $vars; } } ?> 4.1.2 Includes Shared functions required by API operations are provided in a number of standalone PHP include ﬁles. The ﬁrst ﬁle returns the client information (e.g.
PAGE 31
Chapter 4. Integration with WHMCS $results = localAPI($command, $data, $whmcs_username); // Return client information. return $results; } } ?> The next ﬁle adds notes to the client in WHMCS with the S3 access key pairs whenever a new user or access key pair is created. Create a ﬁle S3_addClientNote.php with the following contentss:
PAGE 32
4.1. Requirements localAPI($command, $data, $whmcs_username); } } } ?> The next ﬁle removes notes from the client in WHMCS with the S3 access key pairs whenever a user or access key pair is removed. Create a ﬁle S3_delClientNote.php with the following contents:
PAGE 33
Chapter 4. Integration with WHMCS } } ?> The last ﬁle is the cURL library for sending GET, PUT, POST, and DELETE requests. Create a ﬁle S3_requestCurl.php with the following contents:
PAGE 34
4.1. Requirements break; } curl_setopt($s3_curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($s3_curl, CURLOPT_URL, $s3_gateway . $s3_query); curl_setopt($s3_curl, CURLOPT_HTTPHEADER, array( ’Host: ’ . $s3_host, ’Date: ’ . $s3_date, ’Authorization: AWS ’ . $s3_key . ’:’ . $s3_signature, ’Content-Type:’, ’Expect:’, )); // Call. $response = curl_exec($s3_curl); $response = json_decode($response, true); // Curl deinit. curl_close($s3_curl); // Return response. return $response; } } ?> 4.1.
PAGE 35
Chapter 4. Integration with WHMCS // Modify other actions admin page. function S3_adminAreaClientSummaryActionLinks($vars) { // Create additional links. $result[] = ’S3 - User Management’; $result[] = ’ Create User’; $result[] = ’
PAGE 36
4.1. Requirements ops/s
bandwidth/s
PAGE 37
Chapter 4. Integration with WHMCS bandwidth/s
bucket name
PAGE 38
4.1. Requirements // Return links. return $result; } // Modify admin area. add_hook(’AdminAreaClientSummaryActionLinks’, 1, ”S3_adminAreaClientSummaryActionLinks”); ?> The last ﬁle extends the admin summary page and displays S3 user information as well as user and bucket limits if the corresponding links are clicked. Create a ﬁle S3_adminAreaClientSummaryPage.php with the following contents:
PAGE 39
Chapter 4. Integration with WHMCS UserEmail ’; // One row per access key pair. foreach ($_SESSION[’s3_list’] as $s3_row) { $result = $result . ’ ’ . $s3_row[’UserId’] . ’ ’ . $s3_row[’UserEmail’] . ’ ’; } // Table footer. $result = $result . ’

’; } // Show user. if ($_SESSION[’s3_query_user’] == 1) { // Table header. $result = $result .

PAGE 40

4.1. Requirements AWSSecretAccessKey ’; // One row per access key pair. foreach ($_SESSION[’s3_aws_access_keys’] as $s3_row) { $result = $result . ’ ’ . $s3_row[’AWSAccessKeyId’] . ’ ’ . $s3_row[’AWSSecretAccessKey’] . ’ ’; } // Table footer. $result = $result . ’ ’; } // Table footer and next header. $result = $result . ’

’; // Show statistics list.

PAGE 41

Chapter 4. Integration with WHMCS

S3 Statistics List

’; // One row per access key pair. foreach ($_SESSION[’s3_stat’][’items’] as $s3_object) { $result = $result . ’ ’; } // Table footer. $result = $result . ’

Object Name
’ . $s3_object . ’

Object Name

’ . $s3_object . ’

’; } // Show limits for user.

PAGE 42

4.1. Requirements

’; // One row per access key pair. foreach ($_SESSION[’s3_limits_user’] as $s3_limits => $s3_value) { list($s3_type, $s3_limit) = explode(”:”, $s3_limits); $result = $result . ’ ’; } // Table footer. $result = $result .

PAGE 43

Chapter 4. Integration with WHMCS

S3 Limits for Bucket: ’ . $_SESSION[’s3_bucket’] . ’

Type	Name	Value
’ . $s3_type . ’	’ . $s3_limit . ’	’ . $s3_value . ’

’; // One row per access key pair. foreach ($_SESSION[’s3_limits_bucket’] as $s3_limits => $s3_value) { list($s3_type, $s3_limit) = explode(”:”, $s3_limits); $result = $result . ’

Type	Name	Value
’ . $s3_type . PAGE 44 4.1. Requirements ’; // Show statistics for object. if (!empty($_SESSION[’s3_object_statistic’])) { // Table header. $result = $result . ’ S3 Statistics for Object: ’ . $_SESSION[’s3_object’] . PAGE 45 Chapter 4. Integration with WHMCS
’ . $_SESSION[’s3_object_statistic’][’fmt_version’]. ’	’ . $_SESSION[’s3_object_statistic’][’service_id’]. ’	’ . $_SESSION[’s3_object_statistic’][’start_ts’]. ’	’ . $_SESSION[’s3_object_statistic’][’period’]. ’	’ . $s3_object[’key’][’bucket’] . ’	’ . $s3_object[’key’][’epoch’] . ’	’ . $s3_object[’key’][’user’] . ’	’ . $s3_object[’key’][’tag’] . ’	’ . PAGE 46 4.1. Requirements // Modify admin area. add_hook(’AdminAreaClientSummaryPage’, 1, ”S3_adminAreaClientSummaryPage”); ?> 4.1.4 Statistics You need to have statistics collection enabled on your S3 gateway. The S3 gateway will save the statistics as regular storage objects. On each S3 storage node, create a ﬁle /var/lib/ostor/local/gw.conf with the following contents: # Enable usage statistics collection. S3_GW_COLLECT_STAT=1 Restart the S3 storage service to apply the conﬁguration changes. PAGE 47 Chapter 4. Integration with WHMCS 4.2 Managing S3 Users in WHMCS This section describes how to manage users in WHMCS in a service provider scenario. New customers will sign up for the service during purchase in your online store and you will need to create users for them in the S3 cluster. Create all ﬁles mentioned further in the directory whmcs/admin/AcronisStorage. 4.2.1 Creating S3 Users You can create a user with the ostor-users service and parameter emailAddress specifying the user email address. PAGE 48 4.2. Managing S3 Users in WHMCS $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-users&emailAddress=” . $s3_whmcs[’email’], ”PUT” ); // Add note with the s3 access key and s3 secret. S3_addClientNote( $s3_whmcs[’userid’], $s3_config[’whmcs_username’], $s3_client[’UserId’], $s3_client[’AWSAccessKeys’][’0’][’AWSAccessKeyId’], $s3_client[’AWSAccessKeys’][’0’][’AWSSecretAccessKey’] ); // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. PAGE 49 Chapter 4. Integration with WHMCS 4.2.2 Listing S3 Users You can list information about all users with the ostor-users service. Additional rows may list S3 access key pairs associated with the user. WHMCS lists the users information fetched from S3 cluster when you click List Users (on/oﬀ). Create a ﬁle S3_listUsers.php with the following contents: PAGE 50 4.2. Managing S3 Users in WHMCS // Hide. $_SESSION[’s3_list_users’] = 0; // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); // Return immediately. return; } // Load configuration. $s3_config = s3_getConfig(); // Get s3 users. $s3_client = S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-users”, ”GET” ); // Store s3 result. $_SESSION[’s3_list_users’] = 1; $_SESSION[’s3_list’] = $s3_client; // Redirect back. header(’Location: ’ . PAGE 51 Chapter 4. Integration with WHMCS 4.2.3 Querying S3 Users You can display information and status of a user with the ostor-users service and parameter emailAddress specifying the user email address. WHMCS displays the user information fetched from S3 cluster when you click Query User (on/oﬀ). Create a ﬁle S3_queryUser.php with the following contents: PAGE 52 4.2. Managing S3 Users in WHMCS if ($_SESSION[’s3_query_user’] == 1) { // Hide. $_SESSION[’s3_query_user’] = 0; // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); // Return immediately. return; } // Load configuration. $s3_config = s3_getConfig(); // Get whmcs user email. $s3_whmcs = S3_getClient($userid, $s3_config[’whmcs_username’]); // Get s3 user id. $s3_client = S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-users&emailAddress=” . PAGE 53 Chapter 4. Integration with WHMCS // Call function. S3_queryUser($_GET[’userid’]); ?> 4.2.4 Disabling S3 Users You can disable users with the ostor-users service and parameter emailAddress specifying the user email address. WHMCS disables read and write access to S3 cluster when you click Disable User. Create a ﬁle S3_disableUser.php with the following contents: PAGE 54 4.2. Managing S3 Users in WHMCS // Disable user. function S3_disableUser($userid) { // Load configuration. $s3_config = s3_getConfig(); // Get whmcs user email. $s3_whmcs = S3_getClient($userid, $s3_config[’whmcs_username’]); // Disable user. $s3_client = S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-users&emailAddress=” . $s3_whmcs[’email’] . ”&disable”, ”POST” ); // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. PAGE 55 Chapter 4. Integration with WHMCS PAGE 56 4.2. Managing S3 Users in WHMCS 4.2.6 Deleting S3 Users You can delete users with the ostor-users service and parameter emailAddress specifying the user email address. WHMCS removes the user from S3 cluster when you click Delete User. Create a ﬁle S3_deleteUser.php with the following contents: PAGE 57 Chapter 4. Integration with WHMCS $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-users&emailAddress=” . $s3_whmcs[’email’], ”DELETE” ); // Delete note with the s3 access key and s3 secret. S3_delClientNote( $s3_whmcs[’userid’], $s3_config[’whmcs_username’], $s3_client[’UserId’], ”” ); // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. S3_deleteUser($_GET[’userid’]); ?> 4.2. PAGE 58 4.2. Managing S3 Users in WHMCS require(’../../includes/AcronisStorage/S3_getConfig.php’); require(’../../includes/AcronisStorage/S3_requestCurl.php’); require(’../../init.php’); // Generate s3 access key pair. function S3_generateAccessKey($userid) { // Load configuration. $s3_config = s3_getConfig(); // Get whmcs user email. $s3_whmcs = S3_getClient($userid, $s3_config[’whmcs_username’]); // Generate s3 key pair. PAGE 59 Chapter 4. Integration with WHMCS // Call function. S3_generateAccessKey($_GET[’userid’]); ?> 4.2.8 Revoking S3 Access Keys You can revoke the speciﬁed access key pair of the speciﬁed user with the ostor-users service and the following parameters: emailAddress specifying the user email address, revokeKey specifying the access key in the key pair. WHMCS removes the key pair when you click Revoke Access Key. Create a ﬁle following contents: PAGE 60 4.2. Managing S3 Users in WHMCS require(’../../init.php’); // Revoke s3 access key pair. function S3_revokeAccessKey($userid) { // Load configuration. $s3_config = s3_getConfig(); // Get whmcs user email. $s3_whmcs = S3_getClient($userid, $s3_config[’whmcs_username’]); // Get first s3 access key. $s3_client = S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-users&emailAddress=” . $s3_whmcs[’email’], ”GET” ); // Revoke s3 access key. PAGE 61 Chapter 4. Integration with WHMCS $s3_client[’AWSAccessKeys’][’0’][’AWSAccessKeyId’] ); // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. S3_revokeAccessKey($_GET[’userid’]); ?> 4.3 Managing S3 User and Bucket Limits in WHMCS This section describes limits you can deﬁne for users and buckets in WHMCS. You can apply the limits according to speciﬁc options that can be a part of your service plan. 4.3. PAGE 62 4.3. Managing S3 User and Bucket Limits in WHMCS // Set s3 user limits. function S3_setLimitsForUser($vars) { // Load configuration. $s3_config = s3_getConfig(); // Get whmcs user email. $s3_whmcs = S3_getClient($vars[’userid’], $s3_config[’whmcs_username’]); // Set only if value specified. if (!empty($vars[’ops-value’])) { // Set s3 bucket limits (ops). S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-limits&emailAddress=” . $s3_whmcs[’email’] . PAGE 63 Chapter 4. Integration with WHMCS ’&limit-value=’ . $vars[’bandwidth-value’], ”PUT” ); } // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. S3_setLimitsForUser($_GET); ?> 4.3.2 Querying User Limits You can display the current limits with the ostor-limits service and parameter emailAddress specifying the email address. WHMCS displays the user limits in S3 cluster when you click the Get button. Create a ﬁle S3_getLimitsForUser. PAGE 64 4.3. Managing S3 User and Bucket Limits in WHMCS PAGE 65 Chapter 4. Integration with WHMCS ?> 4.3.3 Deleting User Limits You can delete the current limits with the ostor-limits service and parameter emailAddress specifying the email address. WHMCS removes the user limits from S3 cluster when you click the Delete button. Create a ﬁle S3_deleteLimitsForUser.php with the following contents: PAGE 66 4.3. Managing S3 User and Bucket Limits in WHMCS // Clear array. $_SESSION[’s3_limits_user’] = null; // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. S3_getLimitsForUser($_GET[’userid’]); ?> 4.3.4 Setting Buckets Limits You can limit operations rate with the ostor-limits service and the following parameters: bucket specifying the bucket name, default=, get=, put=, list=, delete= specifying the limit value. PAGE 67 Chapter 4. Integration with WHMCS if (!empty($vars[’ops-value’])) { // Set s3 bucket limits (ops). S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-limits&bucket=” . $vars[’bucket’] . ”&limit-type=ops&limit-resource=” . $vars[’ops-name’] . ’&limit-value=’ . $vars[’ops-value’], ”PUT” ); } // Set only if value specified. if (!empty($vars[’bandwidth-value’])) { // Set s3 bucket limits (bandwidth). PAGE 68 4.3. Managing S3 User and Bucket Limits in WHMCS ?> 4.3.5 Querying Bucket Limits You can display the current limits with the name. ostor-limits service and parameter bucket specifying the bucket WHMCS displays the bucket limits in S3 cluster when you click the Get button. S3_getLimitsForBucket.php Create a ﬁle with the following contents: PAGE 69 Chapter 4. Integration with WHMCS // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. S3_getLimitsForBucket($_GET[’bucket’]); ?> 4.3.6 Deleting Bucket Limits You can delete the current limits with the ostor-limits service and parameter bucket specifying the bucket name. WHMCS removes the bucket limits from S3 cluster when you click the Delete button. Create a ﬁle S3_deleteLimitsForBucket.php with the following contents: PAGE 70 4.4. Obtaining Usage Statistics in WHMCS require(’../../includes/AcronisStorage/S3_requestCurl.php’); require(’../../init.php’); // Delete s3 bucket limits. function S3_deleteLimitsForBucket($bucket) { // Load configuration. $s3_config = s3_getConfig(); // Delete s3 bucket limits. S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-limits&bucket=” . $bucket, ”DELETE” ); // Clear array. $_SESSION[’s3_limits_bucket’] = null; // Redirect back. PAGE 71 Chapter 4. Integration with WHMCS Note: Delete statistics objects after collecting the required data. 4.4.1 Listing Statistics Objects You can list all available statistics objects with the ostor-usage service and no parameters. IThe output only contains objects that have not been deleted. WHMCS lists the available statistics objects from S3 cluster when you click List statistics objects (on/oﬀ). Create a ﬁle S3_listStatsObjects. PAGE 72 4.4. Obtaining Usage Statistics in WHMCS // Get s3 statistics objects. $s3_client = S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-usage”, ”GET” ); // Store s3 result. $_SESSION[’s3_stat_objects’] = 1; $_SESSION[’s3_stat’] = $s3_client; // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. PAGE 73 Chapter 4. Integration with WHMCS 4.4.2 Querying Statistics Objects You can display usage statistics with the ostor-usage service and parameter obj specifying the statistics object. WHMCS displays the accessed buckets, user ID, and counters when you click the Get button. Create a ﬁle S3_getStatsForObject.php with the following contents: PAGE 74 4.4. Obtaining Usage Statistics in WHMCS // Get s3 statistics object. $s3_client = S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-usage&obj=” . $object, ”GET” ); // Store s3 result. $_SESSION[’s3_object_statistic’] = $s3_client; $_SESSION[’s3_object’] = $object; // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. PAGE 75 Chapter 4. Integration with WHMCS 4.4.3 Deleting Statistics Objects You can delete existing statistics objects with the ostor-usage service and parameter obj specifying the statistics object. WHMCS removes the statistics object from S3 cluster when you click the Delete button. Create a ﬁle S3_deleteStatsForObject.php with the following contents: PAGE 76 4.4. Obtaining Usage Statistics in WHMCS // Delete s3 statistics object. S3_requestCurl( $s3_config[’s3_key’], $s3_config[’s3_secret’], $s3_config[’s3_gateway’], ”/?ostor-usage&obj=” . $object, ”DELETE” ); // Clear array. $_SESSION[’s3_limits_bucket’] = null; // Redirect back. header(’Location: ’ . $_SERVER[’HTTP_REFERER’]); } // Call function. Who We Are About Us Company Careers Terms & Privacy Resources List of Manufacturers Support For the Press Media assets FAQ Get in touch Blog Email DMCA ManualShelf © 2013-2025