restore-workspace¶
- subtitle
Restore a Cloudera Machine Learning workspace.
- version
0.9.121
Description¶
Create a new workspace based on an existing workspace backup snapshot.
Synopsis¶
restore-workspace
[--new-workspace-parameters <value>]
[--backup-crn <value>]
[--use-static-subdomain | --no-use-static-subdomain]
[--restore-job-timeout-minutes <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--new-workspace-parameters
(object)
Request object for the CreateWorkspace method.
environmentName -> (string)
The environment for the workspace to create.
workspaceName -> (string)
The name of the workspace to create.
provisionK8sRequest -> (object)
Request object for workspace provision. Required in public cloud.
instanceGroups -> (array)
The instance groups.
item -> (object)
Contains the necessary info for an instance group.
instanceType -> (string)
The cloud provider instance type for the node instance.
instanceTier -> (string)
The tier of the instance i.e. on-demand/spot.
instanceCount -> (integer)
The initial number of instance node.
name -> (string)
The unique name of the instance group.
ingressRules -> (array)
The networking rules for the ingress.
item -> (string)
rootVolume -> (object)
Configuration for instance root device volume.
size -> (integer)
The volume size in GB.
autoscaling -> (object)
Configuration for instance auto scaling.
minInstances -> (integer)
The minimum number of instance for auto scaling.
maxInstances -> (integer)
The maximum number of instance for auto scaling.
enabled -> (boolean)
The boolean flag to enable the auto scaling.
environmentName -> (string)
The name of the environment for the workspace to create.
tags -> (array)
Tags to add to the cloud provider resources created. This is in addition to any tags added by Cloudera.
item -> (object)
Contains a single tag entry that will be configured on cloud resources associated with a workspace.
key -> (string)
The name for the tag.
value -> (string)
The value for the tag.
network -> (object)
Contains the information about overlay network.
plugin -> (string)
The plugin specifies specific cni vendor, ex: calico, weave etc.
topology -> (object)
Contains the information about topology.
subnets -> (array)
The options for subnets.
item -> (string)
usePublicLoadBalancer -> (boolean)
The boolean flag to request public load balancer. By default, private load balancer is used.
disableTLS -> (boolean)
The boolean flag to disable TLS setup for workspace. By default, the TLS is enabled.
enableMonitoring -> (boolean)
The boolean flag is used to enable monitoring. By default, monitoring is disabled.
enableGovernance -> (boolean)
Enables Cloudera Machine Learning governance by integrating with Cloudera Atlas. By default, this flag is disabled.
existingNFS -> (string)
Optionally use an existing NFS by providing the hostname and desired path (Azure and Private Cloud only).
loadBalancerIPWhitelists -> (array)
The whitelist of IPs for load balancer.
item -> (string)
nfsVersion -> (string)
The NFS Protocol version of the NFS server we are using for Azure and Private Cloud.
mlVersion -> (string)
The version of ML workload app to install.
enableModelMetrics -> (boolean)
Enables the model metrics service for exporting metrics for models to a metrics store.
existingDatabaseConfig -> (object)
Configurations for bringing an existing database for model metrics
existingDatabaseHost -> (string)
Optionally provide a Postgresql database host to export model metrics to.
existingDatabasePort -> (string)
Optionally provide a Postgresql database port to export model metrics to.
existingDatabaseName -> (string)
Optionally provide a Postgresql database name to export model metrics to.
existingDatabaseUser -> (string)
Optionally provide a Postgresql database user to use when exporting model metrics.
existingDatabasePassword -> (string)
Optionally provide a Postgresql database password to use when exporting model metrics.
whitelistAuthorizedIPRanges -> (boolean)
Whether to whitelist only ‘authorizedIPRanges’ given or all public IPs.
authorizedIPRanges -> (array)
The whitelist of CIDR blocks which can access the API server.
item -> (string)
skipValidation -> (boolean)
Skip pre-flight validations if requested.
privateCluster -> (boolean)
Whether to create a private cluster.
subnetsForLoadBalancers -> (array)
The list of subnets used for the load balancer that CML creates.
item -> (string)
staticSubdomain -> (string)
The static subdomain to be used for the workspace.
cdswMigrationMode -> (string)
Toggle for cdsw migration preflight validation
outboundTypes -> (array)
Outbound Types provided for the workspace.
item -> (string)
List of possible Outbound types.
JSON Syntax:
{
"environmentName": "string",
"workspaceName": "string",
"provisionK8sRequest": {
"instanceGroups": [
{
"instanceType": "string",
"instanceTier": "string",
"instanceCount": integer,
"name": "string",
"ingressRules": ["string", ...],
"rootVolume": {
"size": integer
},
"autoscaling": {
"minInstances": integer,
"maxInstances": integer,
"enabled": true|false
}
}
...
],
"environmentName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
...
],
"network": {
"plugin": "string",
"topology": {
"subnets": ["string", ...]
}
}
},
"usePublicLoadBalancer": true|false,
"disableTLS": true|false,
"enableMonitoring": true|false,
"enableGovernance": true|false,
"existingNFS": "string",
"loadBalancerIPWhitelists": ["string", ...],
"nfsVersion": "string",
"mlVersion": "string",
"enableModelMetrics": true|false,
"existingDatabaseConfig": {
"existingDatabaseHost": "string",
"existingDatabasePort": "string",
"existingDatabaseName": "string",
"existingDatabaseUser": "string",
"existingDatabasePassword": "string"
},
"whitelistAuthorizedIPRanges": true|false,
"authorizedIPRanges": ["string", ...],
"skipValidation": true|false,
"privateCluster": true|false,
"subnetsForLoadBalancers": ["string", ...],
"staticSubdomain": "string",
"cdswMigrationMode": "string",
"outboundTypes": ["UNKNOWN"|"OUTBOUND_TYPE_UDR", ...]
}
--backup-crn
(string)
The CRN of the backup snapshot to used for restoring.
--use-static-subdomain
| --no-use-static-subdomain
(boolean)
A boolean value to check if subdomain must be used or not.
--restore-job-timeout-minutes
(integer)
The timeout to restore the backup snapshots, in minutes.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton
(boolean)
Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for
--cli-input-json
.
Output¶
workspaceCrn -> (string)
The CRN of the Cloudera Machine Learning workspace being provisioned.
Form Factors¶
public, private