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 <tsp@apache.org>
(cherry picked from commit 74643c9561b1ea564f180c3780ef762e97e7c10b)
This commit is contained in:
Thomas O'Dowd 2013-08-06 14:53:47 +09:00 committed by Prasanna Santhanam
parent 8d0f08a4b8
commit a764cb91b3
2 changed files with 50 additions and 4 deletions

View File

@ -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',

View File

@ -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
}