| name | data type | description |
|---|---|---|
| service | ApiServiceRef | (Possibly remote) HDFS service where the replication snapshots will be rotated. |
| snapshotPrefix | string | HDFS replication snapshot prefix.
Rotating the snapshots means deleting the "old" snapshot (i.e. #snapshotPrefix#-old) if
it exists and renaming the "new" snapshot to "old".
|
| path | string | HDFS path for the replication. The snapshots to be rotated are expected to be in the snapshottable ancestor of this path (including itself). |
| additionalConfigs | map of string | A map of additional configuration options for the HDFS file system.
These will override the values gathered automatically by getting the
client configuration of the HDFS service.
null values are not allowed; use unsetConfigs
to remove configuration properties.
|
| unsetConfigs | array of string | A set of configuration properties to be unset for HDFS. The properties listed here will be removed from the file system configuration. |
| additionalEnvironmentVariables | map of string | A map of additional environment variables to be used in the one-off process
This is the place to add environment variables related to e.g. JVM options.
null values are not allowed; this interface must be changed should that be necessary.
|
| delegationTokens | string | Base64-encoded serialized Hadoop Credentials (delegation tokens) to use for authenticating
against the HDFS service.
When present, the delegation tokens are loaded into the process's UserGroupInformation
before accessing the file system, enabling operation against a Kerberized cluster without
requiring a Kerberos ticket on the execution host. Impersonation, if required, must be encoded
in the delegation tokens themselves (obtained via the obtainDelegationTokens endpoint).
When null, the tool runs without pre-obtained tokens. For non-secured (non-kerberized)
services either null or an empty Credentials object is acceptable.
One can obtain delegation tokens via native hadoop service APIs, hadoop cli
(e.g. hadoop dtutil get) or the /obtainDelegationTokens CM API endpoint.
|
Example
{
"service" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"snapshotPrefix" : "...",
"path" : "...",
"additionalConfigs" : {
"property1" : "...",
"property2" : "..."
},
"unsetConfigs" : [ "...", "..." ],
"additionalEnvironmentVariables" : {
"property1" : "...",
"property2" : "..."
},
"delegationTokens" : "..."
}