From a764cb91b30cb998aa391a1dc897cbafec26f34a Mon Sep 17 00:00:00 2001 From: Thomas O'Dowd Date: Tue, 6 Aug 2013 14:53:47 +0900 Subject: [PATCH] CLOUDSTACK-3211: Add help docs to S3 secondary storage configuration. When adding an S3 secondary storage, the administrator will now be shown help for each input field making it friendlier to use. Signed-off-by: Prasanna Santhanam (cherry picked from commit 74643c9561b1ea564f180c3780ef762e97e7c10b) --- ui/scripts/docs.js | 37 +++++++++++++++++++++++++++++++++++++ ui/scripts/system.js | 17 +++++++++++++---- 2 files changed, 50 insertions(+), 4 deletions(-) diff --git a/ui/scripts/docs.js b/ui/scripts/docs.js index 03318b87f34..bb3c4d2f06a 100755 --- a/ui/scripts/docs.js +++ b/ui/scripts/docs.js @@ -660,6 +660,43 @@ cloudStack.docs = { desc: 'The exported path from the server', externalLink: '' }, + // S3 + helpS3AccessKey: { + desc: 'This identifies the S3 user account', + externalLink: '' + }, + helpS3SecretKey: { + desc: 'The password matching the S3 Access Key', + externalLink: '' + }, + helpS3Bucket: { + desc: 'The S3 bucket to store CloudStack data in. The bucket must be created and owned by the same user identified by the S3 Access Key', + externalLink: '' + }, + helpS3Endpoint: { + desc: 'The S3 server to use. Non-standard ports can be appended to the hostname as per s3.amazonaws.com:8080', + externalLink: '' + }, + helpS3ConnectionTimeout: { + desc: 'The number of milliseconds to wait when establishing an S3 connection. This is optional', + externalLink: '' + }, + helpS3MaxErrorRetry: { + desc: 'The number of times to retry S3 requests before failing. This is optional', + externalLink: '' + }, + helpS3SocketTimeout: { + desc: 'The number of milliseconds to wait while reading an S3 response. This is optional', + externalLink: '' + }, + helpNFSStagingServer: { + desc: 'The name or IP address of the NFS secondary staging server', + externalLink: '' + }, + helpNFSStagingPath: { + desc: 'The exported path to use on the NFS staging server', + externalLink: '' + }, // Add SRX helpSRXIPAddress: { desc: 'The IP address of the device', diff --git a/ui/scripts/system.js b/ui/scripts/system.js index 92fa8674942..e9ba4c65bfa 100644 --- a/ui/scripts/system.js +++ b/ui/scripts/system.js @@ -14525,24 +14525,28 @@ //S3 (begin) accesskey: { label: 'label.s3.access_key', + docID: 'helpS3AccessKey', validation: { required: true } }, secretkey: { label: 'label.s3.secret_key', + docID: 'helpS3SecretKey', validation: { required: true } }, bucket: { label: 'label.s3.bucket', + docID: 'helpS3Bucket', validation: { required: true } }, endpoint: { - label: 'label.s3.endpoint' + label: 'label.s3.endpoint', + docID: 'helpS3Endpoint' }, usehttps: { label: 'label.s3.use_https', @@ -14552,13 +14556,16 @@ converter: cloudStack.converters.toBooleanText }, connectiontimeout: { - label: 'label.s3.connection_timeout' + label: 'label.s3.connection_timeout', + docID: 'helpS3ConnectionTimeout' }, maxerrorretry: { - label: 'label.s3.max_error_retry' + label: 'label.s3.max_error_retry', + docID: 'helpS3MaxErrorRetry' }, sockettimeout: { - label: 'label.s3.socket_timeout' + label: 'label.s3.socket_timeout', + docID: 'helpS3SocketTimeout' }, createNfsCache: { @@ -14602,6 +14609,7 @@ nfsCacheNfsServer: { dependsOn: 'createNfsCache', label: 'label.nfs.server', + docID: 'helpNFSStagingServer', validation: { required: true } @@ -14609,6 +14617,7 @@ nfsCachePath: { dependsOn: 'createNfsCache', label: 'label.path', + docID: 'helpNFSStagingPath', validation: { required: true }