Skip to content

You are viewing documentation for Immuta version 2022.5.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

cancel

Run Sensitive Data Discovery on Data Sources

Audience: Data Owners

Content Summary: This page details the immuta sdd run command, its subcommands, and its arguments.

Configure Sensitive Data Discovery

When SDD is triggered on a data source, it will use the classifiers and settings in its configured template to run the detection job. See Manage Sensitive Data Discovery Templates for configuration options.

Prerequisite

Command Overview: immuta sdd run

This command allows you to run SDD on specific data sources or all data sources in your instance of Immuta.

Options

Use these options to get more details about the sdd run command or any of its subcommands:

  • -h
  • --help
$ immuta sdd -h
Run Sensitive Data Discovery with provided options

Usage:
  immuta sdd run [datasourceName(s)] [flags]

Examples:
# run SDD as a dry run on the specified data sources
$ immuta sdd run "Datasource One" "Datasource Two" --dryRun --template "someTemplate"
# run SDD on ALL data sources in immuta
$ immuta sdd run


Flags:
  -d, --dryRun                  No updates will actually be made
  -f, --force                   Do not prompt for confirmation when attempting to run sdd on all data sources
  -h, --help                    Help for run
  -o, --output json | yaml      Output format
      --outputTemplate string   Format the response using a Go template
  -t, --template string   Run SDD with this template, can only be used with the dryRun flag
  -w, --wait int                The number of seconds to wait for the SDD job(s) to finish. Default is until the SDD job(s) finish (default -1)

Global Flags:
      --config string    Config file (default $HOME/.immutacfg.yaml)
  -p, --profile string   Specifies the profile for what instance/api the cli will use (default "default")

Run SDD on Specific Data Sources

Run immuta sdd run <dataSourceName> [flags], naming the data source you want to run SDD on. The options you can specify include

  • -d, --dryRun: No updates will actually be made.
  • -f, --force: Do not prompt for confirmation when attempting to run SDD on all data sources.
  • -h or --help: Get more information about the command.
  • -o or --output json | yaml: Specify the output format.
  • --outputTemplate string: Format the response using a Go template.
  • -t, --outputTemplate string: Run SDD with this template. This flag can only be used with the dryRun flag.
  • -w, --wait int: The number of seconds to wait for the SDD job(s) to finish. Default is until the SDD job(s) finish (default -1).

Example

The example below illustrates a user running SDD on a single data source.

$ immuta sdd run "Credit Accounts"
Running SDD
Credit Accounts  06b71830-aebc-11ec-970b-51ffefcbfd0c  completed

Run SDD on All Data Sources

  1. Run immuta sdd run. The options you can specify include

    • -d, --dryRun: No updates will actually be made.
    • -f, --force: Do not prompt for confirmation when attempting to run SDD on all data sources.
    • -h or --help: Get more information about the command.
    • -o or --output json | yaml: Specify the output format.
    • --outputTemplate string: Format the response using a Go template.
    • -t, --outputTemplate string: Run SDD with this template. This flag can only be used with the dryRun flag.
    • -w, --wait int: The number of seconds to wait for the SDD job(s) to finish. Default is until the SDD job(s) finish (default -1).

  2. Confirm that you want to run SDD on all data sources.

Example

$ immuta sdd run
Running SDD
Started 8 SDD jobs