Add Redstor plugin

.github/CODEOWNERS

@@ -18,6 +18,7 @@ plugins/MetOffice/*  @blackgrouse
 plugins/Phare/*  @vinbab
 plugins/Postcoder/*  @richbenwell
 plugins/RDAP/*  @richbenwell
+plugins/Redstor/  @TimWheeler-SQUP
 plugins/RSS/*  @clarkd
 plugins/Rootly/*  @noorulkhan-n
 plugins/SendGrid/*  @richbenwell

plugins/Redstor/v1/configValidation.json

@@ -0,0 +1,18 @@
+{
+    "steps": [
+        {
+            "displayName": "Authenticate",
+            "dataStream": { "name": "companyProfile" },
+            "required": true,
+            "error": "Could not authenticate with Redstor RedAPI. Check the Company ID, Client ID and Private Key.",
+            "success": "Connected to Redstor successfully."
+        },
+        {
+            "displayName": "Check customer access",
+            "dataStream": { "name": "companyCustomers" },
+            "required": false,
+            "error": "Authenticated, but could not list customer companies for this Partner account.",
+            "success": "Customer companies accessible."
+        }
+    ]
+}

plugins/Redstor/v1/correlationRules/relate-account-to-company.json

@@ -0,0 +1,20 @@
+{
+    "displayName": "Company has Account",
+    "source": {
+        "types": "Account"
+    },
+    "target": {
+        "types": "Company"
+    },
+    "conditions": [
+        {
+            "sourceProperty": "companyId",
+            "operator": "equals",
+            "targetProperty": "companyId"
+        }
+    ],
+    "labels": {
+        "forward": "belongs to",
+        "reverse": "has"
+    }
+}

plugins/Redstor/v1/correlationRules/relate-company-to-parent-company.json

@@ -0,0 +1,20 @@
+{
+    "displayName": "Company has customer Company",
+    "source": {
+        "types": "Company"
+    },
+    "target": {
+        "types": "Company"
+    },
+    "conditions": [
+        {
+            "sourceProperty": "parentCompanyId",
+            "operator": "equals",
+            "targetProperty": "companyId"
+        }
+    ],
+    "labels": {
+        "forward": "is a customer of",
+        "reverse": "has customer"
+    }
+}

plugins/Redstor/v1/custom_types.json

@@ -0,0 +1,37 @@
+[
+    {
+        "name": "Redstor Company",
+        "sourceType": "Company",
+        "icon": "building",
+        "singular": "Company",
+        "plural": "Companies"
+    },
+    {
+        "name": "Redstor Account",
+        "sourceType": "Account",
+        "icon": "cloud-arrow-up",
+        "singular": "Account",
+        "plural": "Accounts"
+    },
+    {
+        "name": "Redstor Product",
+        "sourceType": "Product",
+        "icon": "cube",
+        "singular": "Product",
+        "plural": "Products"
+    },
+    {
+        "name": "Redstor Service",
+        "sourceType": "Service",
+        "icon": "sitemap",
+        "singular": "Service",
+        "plural": "Services"
+    },
+    {
+        "name": "Redstor Edition",
+        "sourceType": "Edition",
+        "icon": "layer-group",
+        "singular": "Edition",
+        "plural": "Editions"
+    }
+]

plugins/Redstor/v1/dataStreams/accountBackupErrors.json

@@ -0,0 +1,38 @@
+{
+    "name": "accountBackupErrors",
+    "displayName": "Account Backup Errors",
+    "description": "Backup error and warning messages for an account",
+    "tags": ["Backup"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "config": {
+        "httpMethod": "get",
+        "endpointPath": "/backups/status/accounts/errors",
+        "getArgs": [{ "key": "accountId", "value": "{{object.rawId}}" }],
+        "paging": {
+            "mode": "token",
+            "pageSize": { "realm": "queryArg", "path": "maxResults", "value": "100" },
+            "in": { "realm": "payload", "path": "nextPageToken" },
+            "out": { "realm": "queryArg", "path": "pageToken" }
+        },
+        "pathToData": "results",
+        "errorHandling": { "type": "script", "script": "errorHandling/accountBackupErrors.js" }
+    },
+    "matches": { "sourceType": { "type": "oneOf", "values": ["Account"] } },
+    "metadata": [
+        { "name": "timestamp", "displayName": "Time", "shape": "date", "role": "timestamp" },
+        { "name": "message", "displayName": "Message", "shape": "string", "role": "label" },
+        { "name": "category", "displayName": "Category", "shape": "string" },
+        { "name": "type", "displayName": "Type", "shape": "string" },
+        { "name": "count", "displayName": "Count", "shape": "number" },
+        { "name": "extraInfo", "displayName": "Error Message", "shape": "string" },
+        { "name": "productId", "displayName": "Service ID", "shape": "number", "visible": false },
+        {
+            "name": "serviceName",
+            "displayName": "Service",
+            "sourceId": "productId",
+            "sourceType": "Service",
+            "objectPropertyPath": "name"
+        }
+    ],
+    "timeframes": false
+}

plugins/Redstor/v1/dataStreams/accountBackups.json

@@ -0,0 +1,37 @@
+{
+    "name": "accountBackups",
+    "displayName": "Account Backups",
+    "description": "Backup run history for an account, over Redstor's rolling seven day window",
+    "tags": ["Backup"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "config": {
+        "httpMethod": "get",
+        "endpointPath": "/backups/status/accounts",
+        "getArgs": [
+            { "key": "companyId", "value": "{{object.companyId}}" },
+            { "key": "accountId", "value": "{{object.rawId}}" }
+        ],
+        "paging": {
+            "mode": "token",
+            "pageSize": { "realm": "queryArg", "path": "maxResults", "value": "100" },
+            "in": { "realm": "payload", "path": "nextPageToken" },
+            "out": { "realm": "queryArg", "path": "pageToken" }
+        },
+        "postRequestScript": "accountBackups.js"
+    },
+    "matches": { "sourceType": { "type": "oneOf", "values": ["Account"] } },
+    "metadata": [
+        { "name": "timestamp", "displayName": "Time", "shape": "date", "role": "timestamp" },
+        {
+            "name": "overallStatus",
+            "displayName": "Status",
+            "computed": true,
+            "valueExpression": "{{ $['status'] === 1 ? 'success' : ($['status'] === 2 ? 'warning' : 'error') }}",
+            "shape": "state"
+        },
+        { "name": "status", "displayName": "Status Code", "shape": "number", "visible": false },
+        { "name": "message", "displayName": "Message", "shape": "string", "role": "label" },
+        { "name": "errorCount", "displayName": "Error Count", "shape": "number" }
+    ],
+    "timeframes": false
+}

plugins/Redstor/v1/dataStreams/accountRestoreErrors.json

@@ -0,0 +1,38 @@
+{
+    "name": "accountRestoreErrors",
+    "displayName": "Account Restore Errors",
+    "description": "Restore error and warning messages for an account",
+    "tags": ["Restore"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "config": {
+        "httpMethod": "get",
+        "endpointPath": "/restores/status/accounts/errors",
+        "getArgs": [{ "key": "accountId", "value": "{{object.rawId}}" }],
+        "paging": {
+            "mode": "token",
+            "pageSize": { "realm": "queryArg", "path": "maxResults", "value": "100" },
+            "in": { "realm": "payload", "path": "nextPageToken" },
+            "out": { "realm": "queryArg", "path": "pageToken" }
+        },
+        "pathToData": "results",
+        "errorHandling": { "type": "script", "script": "errorHandling/accountRestoreErrors.js" }
+    },
+    "matches": { "sourceType": { "type": "oneOf", "values": ["Account"] } },
+    "metadata": [
+        { "name": "timestamp", "displayName": "Time", "shape": "date", "role": "timestamp" },
+        { "name": "message", "displayName": "Message", "shape": "string", "role": "label" },
+        { "name": "category", "displayName": "Category", "shape": "string" },
+        { "name": "type", "displayName": "Type", "shape": "string" },
+        { "name": "count", "displayName": "Count", "shape": "number" },
+        { "name": "extraInfo", "displayName": "Error Message", "shape": "string" },
+        { "name": "productId", "displayName": "Service ID", "shape": "number", "visible": false },
+        {
+            "name": "serviceName",
+            "displayName": "Service",
+            "sourceId": "productId",
+            "sourceType": "Service",
+            "objectPropertyPath": "name"
+        }
+    ],
+    "timeframes": false
+}

plugins/Redstor/v1/dataStreams/accountRestores.json

@@ -0,0 +1,45 @@
+{
+    "name": "accountRestores",
+    "displayName": "Account Restores",
+    "description": "Current restore operation status for an account",
+    "tags": ["Restore"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "config": {
+        "httpMethod": "get",
+        "endpointPath": "/restores/status/accounts",
+        "getArgs": [
+            { "key": "companyId", "value": "{{object.companyId}}" },
+            { "key": "accountId", "value": "{{object.rawId}}" }
+        ],
+        "paging": {
+            "mode": "token",
+            "pageSize": { "realm": "queryArg", "path": "maxResults", "value": "100" },
+            "in": { "realm": "payload", "path": "nextPageToken" },
+            "out": { "realm": "queryArg", "path": "pageToken" }
+        },
+        "pathToData": "results"
+    },
+    "matches": { "sourceType": { "type": "oneOf", "values": ["Account"] } },
+    "metadata": [
+        { "name": "timestamp", "displayName": "Time", "shape": "date", "role": "timestamp" },
+        {
+            "name": "status",
+            "displayName": "Status",
+            "valueExpression": "{{ ({ 0: 'Failed', 1: 'Completed successfully', 2: 'Completed with warnings', 3: 'Completed with errors' })[$['status']] ?? $['status'] }}",
+            "shape": [
+                "state",
+                {
+                    "map": {
+                        "success": ["Completed successfully"],
+                        "warning": ["Completed with warnings"],
+                        "error": ["Completed with errors", "Failed"]
+                    }
+                }
+            ]
+        },
+        { "name": "accountName", "displayName": "Account", "shape": "string", "visible": false },
+        { "name": "accountId", "displayName": "Account ID", "shape": "guid", "visible": false },
+        { "name": "productId", "displayName": "Service ID", "shape": "number", "visible": false }
+    ],
+    "timeframes": false
+}

plugins/Redstor/v1/dataStreams/backupAccounts.json

@@ -0,0 +1,33 @@
+{
+    "name": "backupAccounts",
+    "displayName": "Company Accounts",
+    "description": "Backup accounts for a company (one row per account, and a single seat can hold more than one)",
+    "tags": ["Accounts"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "config": {
+        "httpMethod": "get",
+        "endpointPath": "/storage/accounts",
+        "getArgs": [{ "key": "companyId", "value": "{{object.rawId}}" }],
+        "paging": {
+            "mode": "token",
+            "pageSize": { "realm": "queryArg", "path": "maxResults", "value": "100" },
+            "in": { "realm": "payload", "path": "nextPageToken" },
+            "out": { "realm": "queryArg", "path": "pageToken" }
+        },
+        "postRequestScript": "backupAccounts.js"
+    },
+    "matches": { "sourceType": { "type": "oneOf", "values": ["Company"] } },
+    "metadata": [
+        { "name": "accountId", "displayName": "Account ID", "shape": "guid", "visible": false },
+        { "name": "accountName", "displayName": "Account Name", "shape": "string", "role": "label" },
+        { "name": "displayName", "displayName": "Display Name", "shape": "string" },
+        { "name": "serviceId", "displayName": "Service ID", "shape": "number", "visible": false },
+        { "name": "serviceName", "displayName": "Service", "shape": "string" },
+        { "name": "productId", "displayName": "Product ID", "shape": "number", "visible": false },
+        { "name": "productName", "displayName": "Product", "shape": "string" },
+        { "name": "storageRegion", "displayName": "Storage Region", "shape": "string" },
+        { "name": "createOn", "displayName": "Created On", "shape": "date" },
+        { "name": "companyId", "displayName": "Company ID", "shape": "guid", "visible": false }
+    ],
+    "timeframes": false
+}

plugins/Redstor/v1/dataStreams/companyBackupSummary.json

@@ -0,0 +1,37 @@
+{
+    "name": "companyBackupSummary",
+    "displayName": "Company Backup Summary",
+    "description": "Current backup operation status by product for a company",
+    "tags": ["Backup"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "config": {
+        "httpMethod": "get",
+        "endpointPath": "/backups/status",
+        "getArgs": [{ "key": "companyId", "value": "{{object.rawId}}" }],
+        "paging": {
+            "mode": "token",
+            "pageSize": { "realm": "queryArg", "path": "maxResults", "value": "100" },
+            "in": { "realm": "payload", "path": "nextPageToken" },
+            "out": { "realm": "queryArg", "path": "pageToken" }
+        },
+        "pathToData": "results"
+    },
+    "matches": { "sourceType": { "type": "oneOf", "values": ["Company"] } },
+    "metadata": [
+        { "name": "productName", "displayName": "Product", "shape": "string", "role": "label" },
+        { "name": "succeeded", "displayName": "Succeeded", "shape": "number" },
+        { "name": "completedWithWarnings", "displayName": "Completed with Warnings", "shape": "number" },
+        { "name": "completedWithErrors", "displayName": "Completed with Errors", "shape": "number" },
+        { "name": "failed", "displayName": "Failed", "shape": "number" },
+        { "name": "missed", "displayName": "Missed", "shape": "number" },
+        {
+            "name": "overallStatus",
+            "displayName": "Status",
+            "computed": true,
+            "valueExpression": "{{ $['failed'] > 0 ? 'error' : (($['completedWithErrors'] > 0 || $['missed'] > 0) ? 'warning' : 'success') }}",
+            "shape": "state"
+        },
+        { "name": "productId", "displayName": "Product ID", "shape": "number", "visible": false }
+    ],
+    "timeframes": false
+}

plugins/Redstor/v1/dataStreams/companyBackups.json

@@ -0,0 +1,35 @@
+{
+    "name": "companyBackups",
+    "displayName": "Company Backups",
+    "description": "Recent backup operation status history per account for a company",
+    "tags": ["Backup"],
+    "baseDataSourceName": "httpRequestScopedSingle",
+    "config": {
+        "httpMethod": "get",
+        "endpointPath": "/backups/status/accounts",
+        "getArgs": [{ "key": "companyId", "value": "{{object.rawId}}" }],
+        "paging": {
+            "mode": "token",
+            "pageSize": { "realm": "queryArg", "path": "maxResults", "value": "100" },
+            "in": { "realm": "payload", "path": "nextPageToken" },
+            "out": { "realm": "queryArg", "path": "pageToken" }
+        },
+        "postRequestScript": "companyBackups.js"
+    },
+    "matches": { "sourceType": { "type": "oneOf", "values": ["Company"] } },
+    "metadata": [
+        { "name": "accountName", "displayName": "Account", "shape": "string", "role": "label" },
+        { "name": "timestamp", "displayName": "Time", "shape": "date", "role": "timestamp" },
+        {
+            "name": "status",
+            "displayName": "Status Code",
+            "shape": "number",
+            "help": "0 = Failed, 1 = Completed successfully, 2 = Completed with warnings, 3 = Completed with errors"
+        },
+        { "name": "message", "displayName": "Message", "shape": "string" },
+        { "name": "errorCount", "displayName": "Error Count", "shape": "number" },
+        { "name": "productId", "displayName": "Product ID", "shape": "number", "visible": false },
+        { "name": "accountId", "displayName": "Account ID", "shape": "guid", "visible": false }
+    ],
+    "timeframes": false
+}