Skip to main content
Version: v2.7.0

Command-Line-Interface

PyPI version

CLI(Command Line Interface) is a standard CLI to run interactively with Yeedu's RESTful-API.

CLI Features

CLI Setup

To set up the Yeedu CLI on the environment, execute the following command from the project directory.

Windows​

pip install --editable .

Generate Executable file for Yeedu CLI​

  • Need to install pyinstaller using below-mentioned command
pip install pyinstaller
  • From the project directory execute the mention command
pyinstaller --onefile yeedu.py

Traverse to \dist directory and get the executable file yeedu.exe

  • The yeedu.exe commands can be formed as shown below:
yeedu.exe [-h]
yeedu.exe <command> [-h]
yeedu.exe <command> <subcommand> [-h]
  • Example of Yeedu CLI command using the executable file
yeedu.exe resource list-providers

Linux​

  • WSL
sudo apt install python3-pip
pip3 install --editable .
  • Bash
sudo python3 setup.py develop

Tab-Autocomplete​

  • Navigate to the /scripts directory from the project directory and obtain the yeedu_autocompletion.sh file.
# Add the following to ~/.bashrc
source /path/to/yeedu_autocompletion.sh
  • After adding the above information to ~/.bashrc, restart the shell or open a new shell session.

Environment Variable Setup​

Create a .env file in the project directory and provide below environment variables.

# Below mentioned values are the default values of Environment Variables
YEEDU_RESTAPI_URL="http://localhost:8080"
YEEDU_CLI_LOG_DIR="/.yeedu/cli/logs/"
YEEDU_USERNAME=USER
YEEDU_PASSWORD=PASS
YEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08
YEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/yeedu_cli.config"
YEEDU_CLI_VERIFY_SSL=true

# Provide the YEEDU_SSL_CERT_FILE path if YEEDU_CLI_VERIFY_SSL is set to true.
YEEDU_SSL_CERT_FILE="/home/user/crt"

Alternative of .env file

  • Windows CMD
SET YEEDU_RESTAPI_URL="http://localhost:8080"
SET YEEDU_CLI_LOG_DIR=/.yeedu/cli/logs/
SET YEEDU_USERNAME=USER
SET YEEDU_PASSWORD=PASS
SET YEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08
SET YEEDU_RESTAPI_TOKEN_FILE_PATH=/home/user/yeedu_cli.config
SET YEEDU_CLI_VERIFY_SSL=true

# Provide the YEEDU_SSL_CERT_FILE path if YEEDU_CLI_VERIFY_SSL is set to true.
SET YEEDU_SSL_CERT_FILE="/home/user/crt"
  • Linux
export YEEDU_RESTAPI_URL="http://localhost:8080"
export YEEDU_CLI_LOG_DIR="/.yeedu/cli/logs/"
export YEEDU_USERNAME=USER
export YEEDU_PASSWORD=PASS
export YEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08
export YEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/yeedu_cli.config"
export YEEDU_CLI_VERIFY_SSL=true

# Provide the YEEDU_SSL_CERT_FILE path if YEEDU_CLI_VERIFY_SSL is set to true.
export YEEDU_SSL_CERT_FILE="/home/user/crt"

Authentication Setup​

  • The following describes the ways of storing credentials, which will be used to generate the token [Environment Variables being given priority].

Storing the credentials as Environment Variables​

YEEDU_USERNAME=USER
YEEDU_PASSWORD=PASS

Storing the credentials inside a yeedu_credentials.config file​

  • The yeedu_credentials.config file needs to be created inside the directory home/user/.yeedu/ which consists of JSON as shown below:
{
  "YEEDU_USERNAME": "USER",
  "YEEDU_PASSWORD": "PASS"
}

Storing the Yeedu Session Token inside a file​

  • If the user is already having the Yeedu Session Token. The user can save the token at any location and provide the file path in environment variable YEEDU_RESTAPI_TOKEN_FILE_PATH
    • For example YEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/Documents/YeeduToken/{FileName}"
  • The format to store the token is as shown below:
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJpYXQiOjE2ODg3MjA0MjIsImV4cCI6MTY4ODg5MzIyMn0.EfxuXKPBISQB4ep-sPQbo6R7tg2irlnAC_krqnuXJ5Q"
}
Command NameUtility
configureUsed to generate the token.
list-tenantsTo list all the available tenants for the session user.
associate-tenantTo associate the tenant with the current user's session Token.

Configure​

yeedu configure -h
Yeedu CLI

positional arguments:
  {configure}

options:
  -h, --help            Show this help message and exit.
  --timeout [TIMEOUT]   Provide token expiration timeout in hour Example: --timeout=24,
                        --timeout=infinity (infinity for no expiration time) to generate
                        Yeedu Token. (default: 48)
  --no-browser [{true,false}]
                        If 'no-browser=true' is provided, the browser will not open
                        automatically for the SSO login URL. (default: false)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • User can provide the file path to store the configured token using the environment variable YEEDU_RESTAPI_TOKEN_FILE_PATH.
    • For example YEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/Documents/YeeduToken/{FileName}"
  • configure example with the optional argument passed.
yeedu configure --timeout=72
  • Console output
{
  "message": "The token has been configured for the username: USER and stored at location: /home/user/.yeedu/yeedu_cli.config"
}

The generated token will be used internally for accessing the yeedu features based on the acess level provided to the given username

  • To list the tenants a user has access to, execute the yeedu iam list-tenants command.

list-tenants​

yeedu iam list-tenants -h
usage:  list-tenants [-h] [--page_number PAGE_NUMBER] [--limit LIMIT]
                     [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --page_number PAGE_NUMBER
                        Specifies the page number for the items to return. (default: 1)
  --limit LIMIT         Specifies the numbers of items to return. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-tenants example without optional arguments passed.
yeedu iam list-tenants
  • Console output
{
  "data": [
    {
      "tenant_id": "6423f466-ff56-4ba4-8c2d-8229beb67e38",
      "name": "tenant1",
      "description": "Yeedu Tenant 1"
    },
    {
      "tenant_id": "066a702d-6b9d-4176-afc5-51c24a651739",
      "name": "tenant2",
      "description": "Yeedu Tenant 2"
    },
    {
      "tenant_id": "cf1f945f-01ce-4ac6-a070-8c733f2fa791",
      "name": "tenant3",
      "description": "Yeedu Tenant 3"
    },
    {
      "tenant_id": "6b682ef1-ede4-4d96-bab6-cd008aadd534",
      "name": "tenant4",
      "description": "Yeedu Tenant 4"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 4,
    "total_pages": 1,
    "limit": 100
  }
}
  • Execute yeedu iam associate-tenant --tenant_id={tenant_id} to associate a tenant id from the yeedu iam list-tenants response to the session token.

associate-tenant​

yeedu iam associate-tenant -h
usage:  associate-tenant [-h] --tenant_id TENANT_ID [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide tenant_id to associate it with session token
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • associate-tenant example with required argument '--tenant_id' passed.
yeedu iam associate-tenant --tenant_id="6423f466-ff56-4ba4-8c2d-8229beb67e38"
  • Console output
{
  "message": "Successfully associated Tenant"
}

Resource

Lookup​

Command NameUtility
list-providersTo get information about all Cloud Providers.
get-providerTo get information about a specific Cloud Provider.
list-provider-availability-zonesTo get information about Availability Zones for a specific Cloud Provider.
get-provider-availability-zoneTo get information about a specific Availability Zone for a specific Cloud Provider.
list-provider-machine-typesTo get information about Machine Types for a specific Cloud Provider.
get-provider-machine-typeTo get information about a specific Machine Type for a specific Cloud Provider.
list-disk-machine-typesTo get information about all disk machine types.
list-credential-typesTo get information about all credential types.
list-engine-cluster-instance-statusTo get information about all available engine cluster instance status.
list-spark-compute-typesTo get information about all spark compute types.
list-spark-infra-versionsTo get information about spark infra version.
list-spark-job-statusTo get information about spark job status.
list-workflow-execution-statesTo get information about workflow execution state.
list-workflow-typesTo get information about workflow type.

list-providers​

yeedu resource list-providers -h
usage:  list-providers [-h] [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-providers example without any optional argument passed for output format.
yeedu resource list-providers
  • Console output
[
  {
    "cloud_provider_id": "0",
    "name": "GCP",
    "description": "Provider for creating infrastructure on Google Cloud Platform",
    "from_date": "2023-09-27T06:11:53.179Z",
    "to_date": null
  },
  {
    "cloud_provider_id": "1",
    "name": "AWS",
    "description": "Provider for creating infrastructure on Amazon Web Services",
    "from_date": "2023-09-27T06:11:53.179Z",
    "to_date": null
  },
  {
    "cloud_provider_id": "2",
    "name": "Azure",
    "description": "Provider for creating infrastructure on Azure Cloud Platform",
    "from_date": "2023-09-27T06:11:53.179Z",
    "to_date": null
  }
]

get-provider​

yeedu resource get-provider -h
usage:  get-provider [-h] --cloud_provider_id CLOUD_PROVIDER_ID
                     [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide specific cloud provider id to get-provider.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-provider example with required '--cloud_provider_id' argument passed.
yeedu resource get-provider --cloud_provider_id=0
  • Console output
{
  "cloud_provider_id": "0",
  "name": "GCP",
  "description": "Provider for creating infrastructure on Google Cloud Platform",
  "from_date": "2023-09-27T06:11:53.179Z",
  "to_date": null
}

list-provider-availability-zones​

yeedu resource list-provider-availability-zones -h
usage:  list-provider-availability-zones [-h] --cloud_provider_id CLOUD_PROVIDER_ID [--limit LIMIT] [--page_number PAGE_NUMBER]
                                         [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide specific Cloud Provider id to list-provider-availability-zones.
  --limit LIMIT         Provide limit to list number of availability zones. (default: 100)
  --page_number PAGE_NUMBER
                        To list availability zones for a specific page_number. (default: 1)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-provider-availability-zones example with required '--cloud_provider_id' argument passed.
yeedu resource list-provider-availability-zones --cloud_provider_id=0 --limit=2
  • Console output
{
"data": [
  {
    "availability_zone_id": "0",
    "cloud_provider": {
      "cloud_provider_id": 0,
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    },
    "name": "asia-east1-a",
    "region": "asia-east1",
    "description": "Changhua County, Taiwan, APAC",
    "from_date": "2023-09-27T06:11:53.246Z",
    "to_date": null
  },
  ...
  {
    "availability_zone_id": "102",
    "cloud_provider": {
      "cloud_provider_id": 0,
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    },
    "name": "us-south1-c",
    "region": "us-south1",
    "description": "Dallas, Texas, North America",
    "from_date": "2023-09-27T06:11:53.246Z",
    "to_date": null
  }
],
  "result_set": {
    "current_page": 1,
    "total_objects": 102,
    "total_pages": 103,
    "limit": 1,
    "next_page": 2
  }
}

get-provider-availability-zone​

yeedu resource get-provider-availability-zone -h
usage:  get-provider-availability-zone [-h] --cloud_provider_id CLOUD_PROVIDER_ID
                                       --availability_zone_id AVAILABILITY_ZONE_ID
                                       [--json-output [{pretty,default}]]
                                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide specific cloud provider id to get-provider-
                        availability-zone.
  --availability_zone_id AVAILABILITY_ZONE_ID
                        Provide specific Availability Zone id to get-provider-
                        availability-zone.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-provider-availability-zone example with required arguments passed.
yeedu resource get-provider-availability-zone --cloud_provider_id=1 --availability_zone_id=116
  • Console output
{
  "availability_zone_id": "116",
  "cloud_provider": {
    "name": "AWS",
    "description": "Provider for creating infrastructure on Amazon Web Services"
  },
  "name": "ca-central-1",
  "region": "ca-central-1",
  "description": "central, Canada",
  "from_date": "2024-06-06T07:55:47.752Z",
  "to_date": null
}

list-provider-machine-types​

yeedu resource list-provider-machine-types -h
usage:  list-provider-machine-types [-h] --cloud_provider_id CLOUD_PROVIDER_ID [--limit LIMIT] [--page_number PAGE_NUMBER]
                                    [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide specific cloud provider id to list-provider-machine-types.
  --limit LIMIT         Provide limit to list number of machine types. (default: 100)
  --page_number PAGE_NUMBER
                        To list machine types for a specific page_number. (default: 1)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-provider-machine-types example with required '--cloud_provider_id' argument passed.
yeedu resource list-provider-machine-types --cloud_provider_id=0
  • Console output
{
  "data": [
    {
      "machine_type_id": 2,
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "name": "n2-highcpu-16",
      "vCPUs": 16,
      "memory": "16 GiB",
      "has_cuda": false,
      "gpu_model": null,
      "gpus": 0,
      "gpu_memory": null,
      "cpu_model": [
        "Intel Xeon Scalable (Ice Lake) 3rd Generation",
        "Intel Xeon Scalable (Cascade Lake) 2nd Generation"
      ],
      "cpu_min_frequency_GHz": [
        "2.6",
        "2.8"
      ],
      "cpu_max_frequency_GHz": [
        "3.5",
        "3.9"
      ],
      "has_local_disk": false,
      "local_disk_size_GB": null,
      "local_num_of_disks": null,
      "local_disk_bus_type": null,
      "local_disk_throughput_MB": null,
      "machine_price_ycu": 5.6,
      "from_date": "2024-06-06T07:55:47.735016+00:00",
      "to_date": "infinity"
    },
    {
      "machine_type_id": 1,
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "name": "n1-highcpu-16",
      "vCPUs": 16,
      "memory": "14.4 GiB",
      "has_cuda": false,
      "gpu_model": null,
      "gpus": 0,
      "gpu_memory": null,
      "cpu_model": [
        "Intel Xeon Scalable (Skylake) 1st Generation",
        "Intel Xeon E5 v4 (Broadwell E5)",
        "Intel Xeon E5 v3 (Haswell)",
        "Intel Xeon E5 v2 (Ivy Bridge)",
        "Intel Xeon E5 (Sandy Bridge)"
      ],
      "cpu_min_frequency_GHz": [
        "2.0",
        "2.2",
        "2.3",
        "2.5",
        "2.6"
      ],
      "cpu_max_frequency_GHz": [
        "3.5",
        "3.7",
        "3.8",
        "3.5",
        "3.6"
      ],
      "has_local_disk": false,
      "local_disk_size_GB": null,
      "local_num_of_disks": null,
      "local_disk_bus_type": null,
      "local_disk_throughput_MB": null,
      "machine_price_ycu": 5.44,
      "from_date": "2024-06-06T07:55:47.735016+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 48,
    "total_pages": 24,
    "limit": 2,
    "next_page": 2
  }
}

get-provider-machine-type​

yeedu resource get-provider-machine-type -h
usage:  get-provider-machine-type [-h] --cloud_provider_id CLOUD_PROVIDER_ID
                                  --machine_type_id MACHINE_TYPE_ID
                                  [--json-output [{pretty,default}]]
                                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide specific cloud provider id to get-provider-machine-type.
  --machine_type_id MACHINE_TYPE_ID
                        Provide specific machine type id to get-provider-machine-type.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-provider-machine-type example with all the required arguments passed.
yeedu resource get-provider-machine-type --cloud_provider_id=0 --machine_type_id=1
  • Console output
{
  "machine_type_id": 1,
  "cloud_provider": {
    "cloud_provider_id": 0,
    "name": "GCP",
    "description": "Provider for creating infrastructure on Google Cloud Platform"
  },
  "name": "n1-highcpu-16",
  "vCPUs": 16,
  "memory": "14.4 GiB",
  "has_cuda": false,
  "gpu_model": null,
  "gpus": 0,
  "gpu_memory": null,
  "cpu_model": [
    "Intel Xeon Scalable (Skylake) 1st Generation",
    "Intel Xeon E5 v4 (Broadwell E5)",
    "Intel Xeon E5 v3 (Haswell)",
    "Intel Xeon E5 v2 (Ivy Bridge)",
    "Intel Xeon E5 (Sandy Bridge)"
  ],
  "cpu_min_frequency_GHz": [
    "2.0",
    "2.2",
    "2.3",
    "2.5",
    "2.6"
  ],
  "cpu_max_frequency_GHz": [
    "3.5",
    "3.7",
    "3.8",
    "3.5",
    "3.6"
  ],
  "has_local_disk": false,
  "local_disk_size_GB": null,
  "local_num_of_disks": null,
  "local_disk_bus_type": null,
  "local_disk_throughput_MB": null,
  "machine_price_ycu": 5.44,
  "from_date": "2024-06-06T07:55:47.735016+00:00",
  "to_date": "infinity"
}

list-disk-machine-types​

yeedu resource list-disk-machine-types -h
usage:  list-disk-machine-types [-h] [--json-output [{pretty,default}]]
                                [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-disk-machine-types example without optional arguments passed for the output format.
yeedu resource list-disk-machine-types
  • Console output
[
  {
    "disk_type_id": "0",
    "cloud_provider": {
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    },
    "name": "pd-ssd",
    "has_fixed_size": false,
    "min_size": 10,
    "max_size": 64000,
    "from_date": "2023-09-27T06:11:53.242Z",
    "to_date": null
  },
  ...
  {
    "disk_type_id": "8",
    "cloud_provider": {
      "name": "Azure",
      "description": "Provider for creating infrastructure on Azure Cloud Platform"
    },
    "name": "Premiumv2_LRS",
    "has_fixed_size": false,
    "min_size": 1,
    "max_size": 65536,
    "from_date": "2024-06-06T07:55:47.750Z",
    "to_date": null
  }
]

list-credential-types​

yeedu resource list-credential-types -h
usage:  list-credential-types [-h] [--cloud_provider [{GCP,AWS,Azure}]] [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        Provide specific cloud_provider to get information about related credential types.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-credential-types example without optional argument passed for output format.
yeedu resource list-credential-types
  • Console output
[
  {
    "credential_type_id": 0,
    "name": "Google Service Account",
    "cloud_provider": {
      "cloud_provider_id": 0,
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    },
    "from_date": "2024-05-29T16:09:48.788269+00:00",
    "to_date": "infinity"
  },
  {
    "credential_type_id": 1,
    "name": "AWS Access Secret Key Pair",
    "cloud_provider": {
      "cloud_provider_id": 1,
      "name": "AWS",
      "description": "Provider for creating infrastructure on Amazon Web Services"
    },
    "from_date": "2024-05-29T16:09:48.788269+00:00",
    "to_date": "infinity"
  },
  {
    "credential_type_id": 2,
    "name": "Azure Service Principal",
    "cloud_provider": {
      "cloud_provider_id": 2,
      "name": "Azure",
      "description": "Provider for creating infrastructure on Azure Cloud Platform"
    },
    "from_date": "2024-05-29T16:09:48.788269+00:00",
    "to_date": "infinity"
  }
]

list-engine-cluster-instance-status​

yeedu resource list-engine-cluster-instance-status -h
usage:  list-engine-cluster-instance-status [-h] [--json-output [{pretty,default}]]
                                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-engine-cluster-instance-status example without optional arguments passed for the output format.
yeedu resource list-engine-cluster-instance-status
  • Console output
[
  {
    "engine_cluster_instance_status_id": "0",
    "name": "INITIATING",
    "description": "Cluster will be eventually created",
    "from_date": "2023-09-27T06:11:53.186Z",
    "to_date": null
  },
  ...
  {
    "engine_cluster_instance_status_id": "8",
    "name": "RESIZING_DOWN",
    "description": "The cluster instance will scale down",
    "from_date": "2023-09-27T06:11:53.186Z",
    "to_date": null
  }
]

list-spark-compute-types​

yeedu resource list-spark-compute-types -h
usage:  list-spark-compute-types [-h] [--json-output [{pretty,default}]]
                                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-spark-compute-types example without optional arguments passed for the output format.
yeedu resource list-spark-compute-types
  • Console output
[
  {
    "spark_compute_type_id": "0",
    "name": "YEEDU",
    "description": null,
    "from_date": "2023-09-27T06:11:53.265Z",
    "to_date": null
  }
]

list-spark-infra-versions​

yeedu resource list-spark-infra-versions -h
usage:  list-spark-infra-versions [-h] [--json-output [{pretty,default}]]
                                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-spark-infra-versions example without optional arguments passed for the output format.
yeedu resource list-spark-infra-versions
  • Console output
[
  {
    "spark_infra_version_id": "0",
    "spark_docker_image_name": "2.4.8",
    "spark_version": "2.4.8",
    "hive_version": "3.2.3",
    "hadoop_version": "2.10.1",
    "scala_version": "2.11.12",
    "python_version": "2.7.18",
    "notebook_support": false,
    "has_cuda_support": false,
    "from_date": "2024-06-06T07:55:47.731Z",
    "to_date": null
  },
  {
    "spark_infra_version_id": "1",
    "spark_docker_image_name": "v3.2.2-20",
    "spark_version": "3.2.2",
    "hive_version": "3.2.3",
    "hadoop_version": "3.2.4",
    "scala_version": "2.12.15",
    "python_version": "3.9.5",
    "notebook_support": true,
    "has_cuda_support": true,
    "from_date": "2024-06-06T07:55:47.731Z",
    "to_date": null
  },
  {
    "spark_infra_version_id": "2",
    "spark_docker_image_name": "v3.3.4-3",
    "spark_version": "3.3.4",
    "hive_version": "3.2.3",
    "hadoop_version": "3.2.4",
    "scala_version": "2.12.15",
    "python_version": "3.9.5",
    "notebook_support": true,
    "has_cuda_support": false,
    "from_date": "2024-06-06T07:55:47.731Z",
    "to_date": null
  }
]

list-spark-job-status​

yeedu resource list-spark-job-status -h
usage:  list-spark-job-status [-h] [--json-output [{pretty,default}]]
                              [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-spark-job-status example without optional arguments passed for the output format.
yeedu resource list-spark-job-status
  • Console output
[
  {
    "spark_job_status_id": "0",
    "name": "SUBMITTED",
    "description": "Job was submitted, waiting for Application ID",
    "from_date": "2023-09-27T06:11:53.266Z",
    "to_date": null
  },
  ...
  {
    "spark_job_status_id": "8",
    "name": "STOPPED",
    "description": "The process was successfully stopped",
    "from_date": "2023-09-27T06:11:53.266Z",
    "to_date": null
  }
]

list-workflow-execution-states​

yeedu resource list-workflow-execution-states -h
usage:  list-workflow-execution-states [-h] [--json-output [{pretty,default}]]
                                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-workflow-execution-states example without optional arguments passed for the output format.
yeedu resource list-workflow-execution-states
  • Console output
[
  {
    "workflow_execution_state_id": -1,
    "name": "NONE",
    "description": "NONE",
    "from_date": "2023-09-27T06:11:53.255Z",
    "to_date": null
  },
  ...
  {
    "workflow_execution_state_id": 99,
    "name": "DONE",
    "description": "NONE",
    "from_date": "2023-09-27T06:11:53.255Z",
    "to_date": null
  }
]

list-workflow-types​

yeedu resource list-workflow-types -h
usage:  list-workflow-types [-h] [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-workflow-types example without optional arguments passed for the output format.
yeedu resource list-workflow-types
  • Console output
[
  {
    "workflow_type_id": "0",
    "name": "spark_start",
    "queue_name": "yeedu.workflows.usi.start",
    "description": null,
    "from_date": "2023-09-27T06:11:53.257Z",
    "to_date": null
  },
  ...
  {
    "workflow_type_id": "8",
    "name": "cosi_resize_down",
    "queue_name": "yeedu.workflows.cosi",
    "description": null,
    "from_date": "2023-09-27T06:11:53.257Z",
    "to_date": null
  }
]

list-linux-distros​

yeedu resource list-linux-distros -h
usage:  list-linux-distros [-h] [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-workflow-types example without optional argument passed for output format.
yeedu resource list-linux-distros
  • Console output
[
  {
    "linux_distro_id": 2,
    "distro_name": "RHEL",
    "distro_version": "8",
    "from_date": "2024-05-29T16:09:48.784Z",
    "to_date": null
  },
  {
    "linux_distro_id": 1,
    "distro_name": "UBUNTU",
    "distro_version": "22.04 LTS",
    "from_date": "2024-05-29T16:09:48.784Z",
    "to_date": null
  },
  {
    "linux_distro_id": 0,
    "distro_name": "UBUNTU",
    "distro_version": "20.04 LTS",
    "from_date": "2024-05-29T16:09:48.784Z",
    "to_date": null
  }
]

Volume Configuration​

Command NameUtility
create-volume-confTo create the Volume Configuration.
list-volume-confsTo list all the available Volume Configurations.
search-volume-confsTo search all the available Volume Configurations.
get-volume-confTo get information about a specific Volume Configuration.
edit-volume-confTo edit a specific Volume Configuration.
delete-volume-confTo delete a specific Volume Configuration.

create-volume-conf​

yeedu resource create-volume-conf -h
usage:  create-volume-conf [-h] --name [NAME] [--description [DESCRIPTION]] --encrypted {true,false} [--size [SIZE]] --disk_type_id DISK_TYPE_ID
                           --machine_volume_num MACHINE_VOLUME_NUM --machine_volume_strip_num MACHINE_VOLUME_STRIP_NUM [--disk_iops DISK_IOPS]
                           [--disk_throughput_MB DISK_THROUGHPUT_MB] [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name [NAME]         Provide name to create-volume-conf.
  --description [DESCRIPTION]
                        Provide description to create-volume-conf.
  --encrypted {true,false}
                        Provide encrypted to create-volume-conf.
  --size [SIZE]         Provide size to create-volume-conf.
  --disk_type_id DISK_TYPE_ID
                        Provide disk_type to create-volume-conf.
  --machine_volume_num MACHINE_VOLUME_NUM
                        Provide machine_volume_num to create-volume-conf.
  --machine_volume_strip_num MACHINE_VOLUME_STRIP_NUM
                        Provide machine_volume_strip_num to create-volume-conf.
  --disk_iops DISK_IOPS
                        Provide disk_iops to create-volume-conf.
  --disk_throughput_MB DISK_THROUGHPUT_MB
                        Provide disk_throughput_MB to create-volume-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-volume-conf example with all the required arguments passed.
yeedu resource create-volume-conf --name="yeedu_volume" --encrypted=false --disk_type_id=2  --machine_volume_num=1 --machine_volume_strip_num=1
  • Console output
{
  "volume_conf_id": "1",
  "name": "yeedu_volume",
  "description": null,
  "encrypted": false,
  "size": "375",
  "disk_type_id": "2",
  "disk_type_name": "local-ssd",
  "machine_volume_num": 1,
  "machine_volume_strip_num": 1,
  "disk_iops": null,
  "disk_throughput_MB": null,
  "created_by_user_id": "1",
  "modified_by__user_id": "1",
  "last_update_date": "2023-07-20T10:57:08.387Z",
  "from_date": "2023-07-20T10:57:08.387Z",
  "to_date": null
}

list-volume-confs​

yeedu resource list-volume-confs -h
usage:  list-volume-confs [-h] [--cloud_provider [{GCP,AWS,Azure}]] [--page_number PAGE_NUMBER] [--limit LIMIT]
                          [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        To list volume configurations for a specific cloud provider.
  --page_number PAGE_NUMBER
                        To list Volume Configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Volume Configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-volume-confs example with optional arguments passed for the output format.
yeedu resource list-volume-confs --cloud_provider="GCP"
  • Console output
{
  "data": [
  {
      "volume_conf_id": 1,
      "name": "yeedu_volume",
      "description": null,
      "encrypted": true,
      "size": 375,
      "disk_type": {
        "disk_type_id": 2,
        "cloud_provider": {
          "cloud_provider_id": 0,
          "name": "GCP"
      },
      },
      "machine_volume_num": 1,
      "machine_volume_strip_num": 1,
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-01-05T09:27:59.407362+00:00",
      "from_date": "2024-01-05T09:27:59.407362+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-volume-confs​

yeedu resource search-volume-confs -h
usage:  search-volume-confs [-h] --volume_conf_name VOLUME_CONF_NAME [--page_number PAGE_NUMBER] [--limit LIMIT]
                            [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --volume_conf_name VOLUME_CONF_NAME
                        Provide volume_conf_name to search all the available Volume Configurations.
  --page_number PAGE_NUMBER
                        To search Volume Configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of Volume Configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-volume-confs example with required argument '--volume_conf_name' passed.
yeedu resource search-volume-confs --volume_conf_name="yeedu_"
  • Console output
{
  "data": [
    {
      "volume_conf_id": 1,
      "name": "yeedu_volume",
      "description": null,
      "encrypted": false,
      "size": 375,
      "disk_type": {
        "disk_type_id": 4,
        "name": "local-ssd",
        "has_fixed_size": true,
        "min_size": 375,
        "max_size": 375
      },
      "machine_volume_num": 1,
      "machine_volume_strip_num": 1,
      "disk_iops": null,
      "disk_throughput_MB": null,
      "created_by": null,
      "modified_by": null,
      "last_update_date": "2024-05-29T16:09:48.824776+00:00",
      "from_date": "2024-05-29T16:09:48.824776+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-volume-conf​

yeedu resource get-volume-conf -h
usage:  get-volume-conf [-h] [--volume_conf_id VOLUME_CONF_ID] [--volume_conf_name VOLUME_CONF_NAME] [--json-output [{pretty,default}]]
                        [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --volume_conf_id VOLUME_CONF_ID
                        Provide volume_conf_id to get information about a specific Volume Configuration.
  --volume_conf_name VOLUME_CONF_NAME
                        Provide volume_conf_name to get information about a specific Volume Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-volume-conf example with the required argument '--volume_conf_id' passed.
yeedu resource get-volume-conf --volume_conf_id=1
  • Console output
{
  "volume_conf_id": 1,
  "name": "yeedu_volume",
  "description": null,
  "encrypted": true,
  "size": 375,
  "disk_type": {
    "disk_type_id": 2,
    "cloud_provider": {
      "cloud_provider_id": 0,
      "name": "GCP"
    },
    "name": "local-ssd",
    "has_fixed_size": true,
    "min_size": 375,
    "max_size": 375
  },
  "machine_volume_num": 1,
  "machine_volume_strip_num": 1,
  "disk_iops": null,
  "disk_throughput_MB": null,
  "created_by": null,
  "modified_by": null,
  "last_update_date": "2024-05-29T16:09:48.824776+00:00",
  "from_date": "2024-05-29T16:09:48.824776+00:00",
  "to_date": "infinity"
}

edit-volume-conf​

yeedu resource edit-volume-conf -h
usage:  edit-volume-conf [-h] [--volume_conf_id VOLUME_CONF_ID] [--volume_conf_name VOLUME_CONF_NAME] [--name [NAME]]
                         [--description [DESCRIPTION]] [--encrypted [{true,false}]] [--disk_type_id DISK_TYPE_ID] [--size [SIZE]]
                         [--machine_volume_num MACHINE_VOLUME_NUM] [--machine_volume_strip_num MACHINE_VOLUME_STRIP_NUM] [--disk_iops DISK_IOPS]
                         [--disk_throughput_MB DISK_THROUGHPUT_MB] [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --volume_conf_id VOLUME_CONF_ID
                        Provide specific volume_conf_id to edit-volume-conf.
  --volume_conf_name VOLUME_CONF_NAME
                        Provide specific volume_conf_name to edit-volume-conf.
  --name [NAME]         Provide name to edit-volume-conf.
  --description [DESCRIPTION]
                        Provide description to edit-volume-conf.
  --encrypted [{true,false}]
                        Provide encrypted to edit-volume-conf.
  --disk_type_id DISK_TYPE_ID
                        Provide disk_type to edit-volume-conf.
  --size [SIZE]         Provide size to edit-volume-conf.
  --machine_volume_num MACHINE_VOLUME_NUM
                        Provide machine_volume_num to edit-volume-conf.
  --machine_volume_strip_num MACHINE_VOLUME_STRIP_NUM
                        Provide machine_volume_strip_num to edit-volume-conf.
  --disk_iops DISK_IOPS
                        Provide disk_iops to edit-volume-conf.
  --disk_throughput_MB DISK_THROUGHPUT_MB
                        Provide disk_throughput_MB to edit-volume-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit-volume-conf example with the required '--volume_conf_id' argument and other optional argument is passed which is to be updated.
yeedu resource edit-volume-conf --volume_conf_id=1 --encrypted=true
  • Console output
{
  "volume_conf_id": "1",
  "name": "yeedu_volume",
  "description": null,
  "encrypted": true,
  "size": "375",
  "disk_type_id": "2",
  "disk_type_name": "local-ssd",
  "machine_volume_num": 1,
  "machine_volume_strip_num": 1,
  "disk_iops": null,
  "disk_throughput_MB": null,
  "created_by_user_id": "1",
  "modified_by__user_id": "1",
  "last_update_date": "2023-07-20T10:57:08.387Z",
  "from_date": "2023-07-20T10:57:08.387Z",
  "to_date": null
}

delete-volume-conf​

yeedu resource delete-volume-conf -h
usage:  delete-volume-conf [-h] [--volume_conf_id VOLUME_CONF_ID] [--volume_conf_name VOLUME_CONF_NAME] [--json-output [{pretty,default}]]
                           [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --volume_conf_id VOLUME_CONF_ID
                        Provide volume_conf_id to delete a specific Volume Configuration.
  --volume_conf_name VOLUME_CONF_NAME
                        Provide volume_conf_name to delete a specific Volume Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-volume-conf example with any one of the required argument '--volume_conf_name' which is to be deleted.
yeedu resource delete-volume-conf --volume_conf_id=1
  • Console output
{
  "message": "Deleted machine volume configuration ID: 1."
}

Network Configuration​

Command NameUtility
create-network-confTo create the Network Configuration.
list-network-confsTo get information about Network Configurations for a specific Cloud Provider.
search-network-confsTo search information about Network Configurations.
get-network-confTo get information about a specific Network Configuration for a specific Cloud Provider.
edit-network-confTo edit a specific Network Configuration based on cloud provider Id and network Id.
delete-network-confTo delete a specific Network Configuration.

create-network-conf​

yeedu resource create-network-conf -h
usage:  create-network-conf [-h] --name NAME [--description DESCRIPTION] --network_project_id NETWORK_PROJECT_ID --network_name NETWORK_NAME
                            --subnet SUBNET --availability_zone_id AVAILABILITY_ZONE_ID [--network_tags ['value1,value2']]
                            [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create-network-conf.
  --description DESCRIPTION
                        Provide description to create-network-conf.
  --network_project_id NETWORK_PROJECT_ID
                        Provide network_project_id to create-network-conf.
  --network_name NETWORK_NAME
                        Provide network_name to create-network-conf.
  --subnet SUBNET       Provide subnet to create-network-conf.
  --availability_zone_id AVAILABILITY_ZONE_ID
                        Provide availability_zone_id to create-network-conf.
  --network_tags ['value1,value2']
                        Provide network_tags to create-network-conf. (default: [])
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-network-conf example with all the required and optional arguments passed.
yeedu resource create-network-conf --name="yeedu_network" --network_project_id="yeedu" --network_name='yeedu-spark-vpc' --subnet='custom-subnet--yeedu' --availability_zone_id=75
  • Console output
{
  "name":"yeedu_network",
  "description": null,
  "network_conf_id": "1",
  "network_project_id": "yeedu",
  "network_name": "yeedu-spark-vpc",
  "subnet": "subnet-yeedu",
  "availability_zone_id": "75",
  "tenant_id": "0b5017a9-6099-497f-81ba-d4e537e23538",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-05-30T07:59:26.316752+00:00",
  "from_date": "2024-05-30T07:59:26.316752+00:00",
  "to_date": null
}

list-network-confs​

yeedu resource list-network-confs -h
usage:  list-network-confs [-h] [--cloud_provider [{GCP,AWS,Azure}]] [--page_number PAGE_NUMBER] [--limit LIMIT]
                           [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        Provide specific cloud_provider to get information about related Network Configurations.
  --page_number PAGE_NUMBER
                        To list Network Configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Network Configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-network-confs example with the --cloud_provider optional arguments passed.
yeedu resource list-network-confs --cloud_provider="GCP"
  • Console output
{
  "data": [
    {
      "network_conf_id": "1",
      "network_conf_name": "yeedu_network",
      "description": null,
      "network_project_id": "yeedu",
      "network_name": "yeedu-spark-vpc",
      "network_tags": [
          "yeedu"
        ],
      "subnet": "subnet-yeedu",
      "availability_zone": {
        "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP",
            "description": "Provider for creating infrastructure on Google Cloud Platform"
          },
        "name": "us-central1-a",
        "region": "us-central1",
        "description": "Council Bluffs, Iowa, North America"
      },
      "tenant_id": "0b5017a9-6099-497f-81ba-d4e537e23538",
      "created_by": {
        "user_id": "1",
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": "1",
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T07:59:26.316752+00:00",
      "from_date": "2024-05-30T07:59:26.316752+00:00",
      "to_date": null
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-network-confs​

yeedu resource search-network-confs -h
usage:  search-network-confs [-h] --network_conf_name NETWORK_CONF_NAME [--cloud_provider [{GCP,AWS,Azure}]] [--page_number PAGE_NUMBER]
                             [--limit LIMIT] [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --network_conf_name NETWORK_CONF_NAME
                        Provide network_conf_name to search Network Configuration.
  --cloud_provider [{GCP,AWS,Azure}]
                        Provide specific cloud_provider to search about related Network Configurations.
  --page_number PAGE_NUMBER
                        To search Network Configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of Network Configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-network-confs example with the required argument --network_conf_name and --cloud_provider optional arguments passed.
yeedu resource search-network-confs --network_conf_name="yeedu" --cloud_provider="GCP"
  • Console output
{
  "data": [
    {
      "network_conf_id": "1",
      "network_conf_name": "yeedu_network",
      "description": null,
      "network_project_id": "yeedu",
      "network_name": "yeedu-spark-vpc",
      "network_tags": [
          "yeedu"
        ],
      "subnet": "custom-subnet--yeedu",
      "availability_zone": {
        "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP",
            "description": "Provider for creating infrastructure on Google Cloud Platform"
          },
        "name": "us-central1-a",
        "region": "us-central1",
        "description": "Council Bluffs, Iowa, North America"
      },
      "tenant_id": "0b5017a9-6099-497f-81ba-d4e537e23538",
      "created_by": {
        "user_id": "1",
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": "1",
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T07:59:26.316752+00:00",
      "from_date": "2024-05-30T07:59:26.316752+00:00",
      "to_date": null
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-network-conf​

yeedu resource get-network-conf -h
usage:  get-network-conf [-h] [--network_conf_id NETWORK_CONF_ID] [--network_conf_name NETWORK_CONF_NAME] [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --network_conf_id NETWORK_CONF_ID
                        Provide network_conf_id to get information about a specific network Configuration.
  --network_conf_name NETWORK_CONF_NAME
                        Provide network_conf_name to get information about a specific network Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-network-conf example with the required '--network_conf_id' argument passed.
yeedu resource get-network-conf --network_conf_id=1
  • Console output
{
  "network_conf_id": "1",
  "network_conf_name": "yeedu_network",
  "description": null,
  "network_project_id": "yeedu",
  "network_name": "yeedu-spark-vpc",
  "network_tags": [
      "yeedu"
    ],
  "subnet": "custom-subnet--yeedu",
  "availability_zone": {
    "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
    "name": "us-central1-a",
    "region": "us-central1",
    "description": "Council Bluffs, Iowa, North America"
  },
  "tenant_id": "0b5017a9-6099-497f-81ba-d4e537e23538",
  "created_by": {
    "user_id": "1",
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": "1",
    "username": "YSU0000"
  },
  "last_update_date": "2024-05-30T07:59:26.316752+00:00",
  "from_date": "2024-05-30T07:59:26.316752+00:00",
  "to_date": null
}

edit-network-conf​

yeedu resource edit-network-conf -h
usage:  edit-network-conf [-h] [--network_conf_id NETWORK_CONF_ID] [--network_conf_name NETWORK_CONF_NAME] [--name NAME]
                          [--description DESCRIPTION] [--network_name [NETWORK_NAME]] [--network_project_id [NETWORK_PROJECT_ID]]
                          [--availability_zone_id AVAILABILITY_ZONE_ID] [--subnet [SUBNET]] [--network_tags ['value1,value2']]
                          [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --network_conf_id NETWORK_CONF_ID
                        Provide a specific Network Configuration network_conf_id to edit-network-conf.
  --network_conf_name NETWORK_CONF_NAME
                        Provide a specific Network Configuration network_conf_name to edit-network-conf.
  --name NAME           Provide name to edit-network-conf.
  --description DESCRIPTION
                        Provide description to edit-network-conf.
  --network_name [NETWORK_NAME]
                        Provide network_name to edit-network-conf.
  --network_project_id [NETWORK_PROJECT_ID]
                        Provide network_project_id to edit-network-conf.
  --availability_zone_id AVAILABILITY_ZONE_ID
                        Provide availability_zone_id to edit-network-conf.
  --subnet [SUBNET]     Provide subnet to edit-network-conf.
  --network_tags ['value1,value2']
                        Provide network_tags to edit-network-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit-network-conf example with the required '--network_conf_id' and '--cloud_provider_id' argument and other optional argument is passed which is to be updated.
yeedu resource edit-network-conf --network_conf_id=1 --network_name="yeedu-spark-vpc"
  • Console output
{
  "name":"yeedu_network",
  "description": null,
  "network_conf_id": "1",
  "network_project_id": "yeedu",
  "network_name": "yeedu-spark-vpc",
  "subnet": "custom-subnet--yeedu",
  "availability_zone_id": "75",
  "tenant_id": "0b5017a9-6099-497f-81ba-d4e537e23538",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-05-30T07:59:26.316752+00:00",
  "from_date": "2024-05-30T07:59:26.316752+00:00",
  "to_date": null
}

delete-network-conf​

yeedu resource delete-network-conf -h
usage:  delete-network-conf [-h] [--network_conf_id NETWORK_CONF_ID] [--network_conf_name NETWORK_CONF_NAME] [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --network_conf_id NETWORK_CONF_ID
                        Provide network_conf_id to delete a specific network Configuration.
  --network_conf_name NETWORK_CONF_NAME
                        Provide network_conf_name to delete a specific network Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-network-conf example with the required '--network_conf_id' argument.
yeedu resource delete-network-conf --network_conf_id=1
  • Console output
{
  "message": "Deleted network configuration ID: 1."
}

Boot Disk Image Config​

Command NameUtility
create-boot-disk-image-confTo create a Boot Disk Image Configuration.
get-boot-disk-image-confTo get the information about a specific Boot Disk Image Configuration.
list-boot-disk-image-confsTo list all the available Boot Disk Image Configurations.
search-boot-disk-image-confsTo search all the available boot disk image configurations.
edit-boot-disk-image-confTo edit a specific boot disk image configuration.
delete-boot-disk-image-confTo delete a specific boot disk image configuration.

create-boot-disk-image-conf​

yeedu resource create-boot-disk-image-conf -h
usage:  create-boot-disk-image-conf [-h] --name NAME [--description DESCRIPTION] --cloud_provider_id CLOUD_PROVIDER_ID --linux_distro_id
                                    LINUX_DISTRO_ID --boot_disk_image BOOT_DISK_IMAGE [--json-output [{pretty,default}]]
                                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create-boot-disk-image-conf.
  --description DESCRIPTION
                        Provide description to create-boot-disk-image-conf.
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide cloud_provider_id to create-boot-disk-image-conf.
  --linux_distro_id LINUX_DISTRO_ID
                        Provide linux_distro_id to create-boot-disk-image-conf.
  --boot_disk_image BOOT_DISK_IMAGE
                        Provide boot_disk_image to create-boot-disk-image-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-boot-disk-image-conf example with all the required arguments passed.
yeedu resource create-boot-disk-image-conf --name="gcp_ubuntu" --cloud_provider_id=0 --linux_distro_id=0 --boot_disk_image="ubuntu-os-cloud/ubuntu-2004-lts"
  • Console output
{
  "boot_disk_image_id": "2",
  "boot_disk_image_name": "yeedu_boot_disk_image",
  "description": null,
  "cloud_provider_id": 0,
  "linux_distro_id": 1,
  "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-05-29T16:09:48.84463+00:00",
  "from_date": "2024-05-29T16:09:48.84463+00:00",
  "to_date": null
}

get-boot-disk-image-conf​

yeedu resource get-boot-disk-image-conf -h
usage:  get-boot-disk-image-conf [-h] [--boot_disk_image_id BOOT_DISK_IMAGE_ID] [--boot_disk_image_name BOOT_DISK_IMAGE_NAME]
                                 [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --boot_disk_image_id BOOT_DISK_IMAGE_ID
                        Provide Boot Disk Image Id to get information about a specific boot disk image configuration.
  --boot_disk_image_name BOOT_DISK_IMAGE_NAME
                        Provide Boot Disk Image Name to get information about a specific boot disk image configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-boot-disk-image-conf example with required arguments passed.
yeedu resource get-boot-disk-image-conf --boot_disk_image_id=1
  • Console output
{
  "boot_disk_image_id": 1,
  "boot_disk_image_name": "gcp_ubuntu",
  "description": "Base image for GCP Ubuntu",
  "cloud_provider": {
    "cloud_provider_id": 0,
    "name": "GCP",
    "description": "Provider for creating infrastructure on Google Cloud Platform"
  },
  "linux_distro": {
    "linux_distro_id": 0,
    "distro_name": "UBUNTU",
    "distro_version": "20.04 LTS"
  },
  "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-05-29T16:09:48.84463+00:00",
  "from_date": "2024-05-29T16:09:48.84463+00:00",
  "to_date": "infinity"
}

list-boot-disk-image-confs​

yeedu resource list-boot-disk-image-confs -h
usage:  list-boot-disk-image-confs [-h] [--cloud_provider [{GCP,AWS,Azure}]] [--page_number PAGE_NUMBER] [--limit LIMIT]
                                   [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        Provide cloud_provider to list all the related boot disk image configs for a specific Cloud Provider.
  --page_number PAGE_NUMBER
                        To list boot disk image configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of boot disk image configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-boot-disk-image-confs example with an optional argument passed.
yeedu resource list-boot-disk-image-confs --cloud_provider="GCP"
  • Console output
{
  "data": [
    {
      "boot_disk_image_id": 1,
      "boot_disk_image_name": "gcp_ubuntu",
      "description": "Base image for GCP Ubuntu",
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "linux_distro": {
        "linux_distro_id": 0,
        "distro_name": "UBUNTU",
        "distro_version": "20.04 LTS"
      },
      "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts",
      "created_by": {
      "user_id": "1",
      "username": "YSU0000"
      },
      "modified_by": {
        "user_id": "1",
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-29T16:09:48.84463+00:00",
      "from_date": "2024-05-29T16:09:48.84463+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 52,
    "total_pages": 1,
    "limit": 100
  }
}

search-boot-disk-image-confs​

yeedu resource search-boot-disk-image-confs -h
usage:  search-boot-disk-image-confs [-h] --boot_disk_image_name
                                     BOOT_DISK_IMAGE_NAME
                                     [--cloud_provider [{GCP,AWS,Azure}]]
                                     [--page_number PAGE_NUMBER]
                                     [--limit LIMIT]
                                     [--json-output [{pretty,default}]]
                                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --boot_disk_image_name BOOT_DISK_IMAGE_NAME
                        Provide Boot Disk Image Name to search information about all the related boot disk image configs.
  --cloud_provider [{GCP,AWS,Azure}]
                        Provide cloud_provider to search all the related boot disk image configs for a specific Cloud Provider.
  --page_number PAGE_NUMBER
                        To list boot disk image configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of boot disk image configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default:pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-boot-disk-image-confs example with the required argument '--boot_disk_image_name' passed.
yeedu resource search-boot-disk-image-confs --boot_disk_image_name="yeedu_"
  • Console output
{
  "data": [
    {
      "boot_disk_image_id": 1,
      "boot_disk_image_name": "yeedu_boot_disk_image",
      "description": "Base image for GCP Ubuntu",
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "linux_distro": {
        "linux_distro_id": 0,
        "distro_name": "UBUNTU",
        "distro_version": "20.04 LTS"
      },
      "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts",
      "created_by": {
      "user_id": "1",
      "username": "YSU0000"
      },
      "modified_by": {
        "user_id": "1",
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-29T16:09:48.84463+00:00",
      "from_date": "2024-05-29T16:09:48.84463+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 52,
    "total_pages": 1,
    "limit": 100
  }
}

edit-boot-disk-image-conf​

yeedu resource edit-boot-disk-image-conf -h
usage:  edit-boot-disk-image-conf [-h] [--boot_disk_image_id BOOT_DISK_IMAGE_ID] [--boot_disk_image_name BOOT_DISK_IMAGE_NAME] [--name NAME]
                                  [--description DESCRIPTION] [--linux_distro_id LINUX_DISTRO_ID] [--boot_disk_image BOOT_DISK_IMAGE]
                                  [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --boot_disk_image_id BOOT_DISK_IMAGE_ID
                        Provide boot_disk_image_id to edit a specific boot disk image configuration.
  --boot_disk_image_name BOOT_DISK_IMAGE_NAME
                        Provide boot_disk_image_name to edit a specific boot disk image configuration.
  --name NAME           Provide name to edit a specific boot disk image configuration.
  --description DESCRIPTION
                        Provide description to edit a specific boot disk image configuration.
  --linux_distro_id LINUX_DISTRO_ID
                        Provide linux_distro_id to edit a specific boot disk image configuration.
  --boot_disk_image BOOT_DISK_IMAGE
                        Provide boot_disk_image to edit a specific boot disk image configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Provide true to edit output in YAML format. (default: false)
  • edit-boot-disk-image-conf example with any one of the required argument '--boot_disk_image_id' and other optional argument is passed which is to be updated.
yeedu resource edit-boot-disk-image-conf --boot_disk_image_id=1 --description="dev boot disk"
  • Console output
{
  "boot_disk_image_id": "1",
  "boot_disk_image_name": "yeedu_boot_disk_image",
  "description": "dev boot disk",
  "cloud_provider_id": 0,
  "linux_distro_id": 0,
  "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-01-05T10:22:54.395Z",
  "from_date": "2024-01-05T10:09:27.590Z",
  "to_date": null
}

delete-boot-disk-image-conf​

yeedu resource delete-boot-disk-image-conf -h
usage:  delete-boot-disk-image-conf [-h] [--boot_disk_image_id BOOT_DISK_IMAGE_ID] [--boot_disk_image_name BOOT_DISK_IMAGE_NAME]
                                    [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --boot_disk_image_id BOOT_DISK_IMAGE_ID
                        Provide boot_disk_image_id to delete a specific boot disk image configuration.
  --boot_disk_image_name BOOT_DISK_IMAGE_NAME
                        Provide boot_disk_image_name to delete a specific boot disk image configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Provide true to delete output in YAML format. (default: false)
  • delete-boot-disk-image-conf example with any one of the required argument '--boot_disk_image_id' is passed which is to be deleted.
yeedu resource delete-boot-disk-image-conf --boot_disk_image_id=1
  • Console output
{
  "message": "Deleted boot disk image configuration id: 1."
}

Credentials Configuration​

Command NameUtility
create-credential-confTo create a Credential Configuration.
list-credential-confsTo list all the available Credential Configurations.
search-credential-confsTo search all the Credential Configurations based on name.
get-credential-confTo get the information about a specific Credential Configuration.
edit-credential-confTo edit a specific Credential Configuration.
delete-credential-confTo delete a specific Credential Configuration.

create-credential-conf​

yeedu resource create-credential-conf -h
usage:  create-credential-conf [-h] --name NAME --credential_type_id CREDENTIAL_TYPE_ID
                               --base64_encoded_credentials BASE64_ENCODED_CREDENTIALS
                               [--json-output [{pretty,default}]]
                               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create-credential-conf.
  --description DESCRIPTION
                        Provide description to create-credential-conf.
  --credential_type_id CREDENTIAL_TYPE_ID
                        Provide credential_type_id to create-credential-conf.
  --base64_encoded_credentials BASE64_ENCODED_CREDENTIALS
                        Provide base64_encoded_credentials to create-credential-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-credential-conf example with all the required arguments passed.
yeedu resource create-credential-conf  --name='yeedu-svc' --credential_type_id=0 --base64_encoded_credentials='ew0KICAieWVlZHVfY3JlZGVudGlhbHMiOiAiRHVtbXkgQ3JlZGVudGlhbHMgQ29uZmlndXJhdGlvbiINCn0'
  • Console output
{
  "credentials_conf_id": "1",
  "name": "yeedu-svc",
  "description": null,
  "credential_type_id": "0",
  "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2023-09-28T17:28:11.325Z",
  "from_date": "2023-09-28T17:28:11.325Z",
  "to_date": null
}

list-credential-confs​

yeedu resource list-credential-confs -h
usage:  list-credential-confs [-h] [--cloud_provider [{GCP,AWS,Azure}]]
                              [--page_number PAGE_NUMBER] [--limit LIMIT]
                              [--json-output [{pretty,default}]]
                              [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        Cloud Provider that will be used for filtering Credential
                        Configurations.
  --page_number PAGE_NUMBER
                        To list Credential Configurations for a specific page_number.
                        (default: 1)
  --limit LIMIT         Provide limit to list number of Credential Configurations.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-credential-confs example with optional arguments passed.
yeedu resource list-credential-confs --cloud_provider="GCP"
  • Console output
{
  "data": [
    {
      "credentials_conf_id": 1,
      "credentials_conf_name": "yeedu-svc",
      "description": null,
      "credential_type": {
        "credential_type_id": 0,
        "name": "Google Service Account",
        "cloud_provider": {
          "name": "GCP",
          "description": "Provider for creating infrastructure on Google Cloud Platform"
        }
      },
      "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T07:59:47.616616+00:00",
      "from_date": "2024-05-30T07:59:47.616616+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-credential-confs​

yeedu resource search-credential-confs -h
usage:  search-credential-confs [-h] --credentials_conf_name CREDENTIALS_CONF_NAME
                                [--cloud_provider [{GCP,AWS,Azure}]]
                                [--page_number PAGE_NUMBER] [--limit LIMIT]
                                [--json-output [{pretty,default}]]
                                [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --credentials_conf_name CREDENTIALS_CONF_NAME
                        Provide credentials_conf_name to search credential
                        configuration.
  --cloud_provider [{GCP,AWS,Azure}]
                        Cloud Provider that will be used for filtering Credential
                        Configurations.
  --page_number PAGE_NUMBER
                        To search Credential Configurations for a specific page_number.
                        (default: 1)
  --limit LIMIT         Provide limit to search number of Credential Configurations.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-credential-confs example with required argument '--credentials_conf_name' passed.
yeedu resource search-credential-confs --credentials_conf_name="yeedu"
  • Console output
{
  "data": [
    {
      "credentials_conf_id": 1,
      "credentials_conf_name": "yeedu-svc",
      "description": null,
      "credential_type": {
        "credential_type_id": 0,
        "name": "Google Service Account",
        "cloud_provider": {
          "name": "GCP",
          "description": "Provider for creating infrastructure on Google Cloud Platform"
        }
      },
      "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T07:59:47.616616+00:00",
      "from_date": "2024-05-30T07:59:47.616616+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-credential-conf​

yeedu resource get-credential-conf -h
usage:  get-credential-conf [-h] [--credentials_conf_id CREDENTIALS_CONF_ID]
                            [--credentials_conf_name CREDENTIALS_CONF_NAME]
                            [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --credentials_conf_id CREDENTIALS_CONF_ID
                        Provide credentials_conf_id to get information about a specific
                        credential configuration.
  --credentials_conf_name CREDENTIALS_CONF_NAME
                        Provide credentials_conf_name to get information about a
                        specific credential configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-credential-conf example with any one of the required '--credentials_conf_name' arguments passed.
yeedu resource get-credential-conf --credentials_conf_name=""
  • Console output
{
  "credentials_conf_id": 1,
  "credentials_conf_name": "yeedu-svc",
  "description": null,
  "credential_type": {
    "credential_type_id": 0,
    "name": "Google Service Account",
    "cloud_provider": {
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    }
  },
  "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-05-30T07:59:47.616616+00:00",
  "from_date": "2024-05-30T07:59:47.616616+00:00",
  "to_date": "infinity"
}

edit-credential-conf​

yeedu resource edit-credential-conf -h
usage:  edit-credential-conf [-h] [--credentials_conf_id CREDENTIALS_CONF_ID]
                             [--credentials_conf_name CREDENTIALS_CONF_NAME]
                             [--name NAME]
                             [--base64_encoded_credentials BASE64_ENCODED_CREDENTIALS]
                             [--json-output [{pretty,default}]]
                             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --credentials_conf_id CREDENTIALS_CONF_ID
                        Provide credentials_conf_id to edit a specific Credential Configuration.
  --credentials_conf_name CREDENTIALS_CONF_NAME
                        Provide credentials_conf_name to edit a specific Credential Configuration.
  --name NAME           Provide name to edit-credential-conf.
  --description DESCRIPTION
                        Provide description to edit-credential-conf.
  --base64_encoded_credentials BASE64_ENCODED_CREDENTIALS
                        Provide base64_encoded_credentials to edit-credential-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit-credential-conf example with any one of the required '--credentials_conf_id' argument and other optional argument is passed which is to be updated.
yeedu resource edit-credential-conf --credentials_conf_id=1 --name='yeedu-svc'
  • Console output
{
  "credentials_conf_id": "1",
  "name": "yeedu-svc",
  "credential_type_id": "0",
  "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2023-09-28T17:33:36.788Z",
  "from_date": "2023-09-28T17:28:11.325Z",
  "to_date": null
}

delete-credential-conf​

yeedu resource delete-credential-conf -h
usage:  delete-credential-conf [-h] [--credentials_conf_id CREDENTIALS_CONF_ID]
                               [--credentials_conf_name CREDENTIALS_CONF_NAME]
                               [--json-output [{pretty,default}]]
                               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --credentials_conf_id CREDENTIALS_CONF_ID
                        Provide credentials_conf_id to delete a specific Credential
                        Configuration.
  --credentials_conf_name CREDENTIALS_CONF_NAME
                        Provide credentials_conf_name to delete a specific Credential
                        Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-credential-conf example with any one of the required '--credentials_conf_name' argument passed.
yeedu resource delete-credential-conf --credentials_conf_name="yeedu-svc"
  • Console output
{
  "message": "Deleted Credentials Configuration Name: 'yeedu-svc'."
}

Cloud Env​

Command NameUtility
create-cloud-envTo create a Object Storage Manager.
list-cloud-envsTo list all the available Object Storage Manager Configurations.
search-cloud-envsTo search Object Storage Manager Configurations.
get-cloud-envTo get information about a specific Object Storage Manager.
edit-cloud-envTo edit a specific Object Storage Manager Configuration.
delete-cloud-envTo delete a specific Object Storage Manager.

create-cloud-env​

yeedu resource create-cloud-env -h
usage:  create-cloud-env [-h] --name NAME [--description DESCRIPTION]
                         --cloud_provider_id CLOUD_PROVIDER_ID
                         --availability_zone_id AVAILABILITY_ZONE_ID
                         --network_conf_id NETWORK_CONF_ID
                         --cloud_project CLOUD_PROJECT
                         --credential_config_id CREDENTIAL_CONFIG_ID
                         --boot_disk_image_id BOOT_DISK_IMAGE_ID
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create a cloud environment.
  --description DESCRIPTION
                        Provide description to create a cloud environment.
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide cloud_provider_id to create a cloud environment.
  --availability_zone_id AVAILABILITY_ZONE_ID
                        Provide availability_zone_id to create a cloud environment.
  --network_conf_id NETWORK_CONF_ID
                        Provide network_conf_id to create a cloud environment.
  --cloud_project CLOUD_PROJECT
                        Provide cloud_project to create a cloud environment.
  --credential_config_id CREDENTIAL_CONFIG_ID
                        Provide credential_config_id to create a cloud environment.
  --boot_disk_image_id BOOT_DISK_IMAGE_ID
                        Provide boot_disk_image_id to create a cloud environment.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-cloud-env example with all the required arguments passed.
yeedu resource create-cloud-env --name="gcp_cloud_env" --cloud_provider_id=0 --availability_zone_id=75 --network_conf_id=1 --cloud_project="yeedu" --credential_config_id=1 --boot_disk_image_id=1
  • Console output
{
  "cloud_env_id": "1",
  "name": "gcp_cloud_env",
  "description": null,
  "cloud_provider_id": "0",
  "availability_zone_id": "75",
  "network_conf_id": "1",
  "cloud_project": "yeedu",
  "credential_config_id": "1",
  "boot_disk_image_id": "1",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-01-08T09:07:25.748Z",
  "from_date": "2024-01-08T09:07:25.748Z",
  "to_date": null
}

list-cloud-envs​

yeedu resource list-cloud-envs -h
usage:  list-cloud-envs [-h] [--cloud_provider [{GCP,AWS,Azure}]]
                        [--page_number PAGE_NUMBER] [--limit LIMIT]
                        [--json-output [{pretty,default}]]
                        [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        Provide cloud_provider to list all the related cloud environments of a specific cloud provider.
  --page_number PAGE_NUMBER
                        To list cloud environments for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of cloud environments. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default:pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-cloud-envs example with an optional argument passed.
yeedu resource list-cloud-envs --cloud_provider="GCP"
  • Console output
{
  "data": [
    {
      "cloud_env_id": 1,
      "cloud_env_name": "gcp_cloud_env",
      "description": "yeedu cloud environment",
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "availability_zone": {
        "availability_zone_id": 75,
        "name": "us-central1-a",
        "cloud_provider_id": 0,
        "region": "us-central1",
        "description": "Council Bluffs, Iowa, North America"
      },
      "network_config": {
        "network_conf_id": 1,
        "network_conf_name": "yeedu_gcp_network",
        "description": null,
        "network_project_id": "yeedu",
        "network_name": "yeedu-vpc",
        "network_tags": [
          "yeedu"
        ],
        "subnet": "custom-subnet-yeedu",
        "availability_zone": {
          "availability_zone_id": 75,
          "name": "us-central1-a",
          "cloud_provider_id": 0,
          "region": "us-central1",
          "description": "Council Bluffs, Iowa, North America"
        }
      },
      "cloud_project": "yeedu",
      "credential_config": {
        "credential_conf_id": 1,
        "credentials_conf_name": "yeedu-svc",
        "description": null,
        "credential_type": {
          "credential_type_id": 0,
          "name": "Google Service Account",
          "cloud_provider_id": 0
        }
      },
      "boot_disk_image": {
        "boot_disk_image_id": 1,
        "boot_disk_image_name": "gcp_boot_disk",
        "description": "dev boot disk",
        "linux_distro": {
          "linux_distro_id": 0,
          "distro_name": "UBUNTU",
          "distro_version": "20.04 LTS"
        },
        "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts"
      },
      "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T08:00:41.996333+00:00",
      "from_date": "2024-05-30T08:00:41.996333+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-cloud-envs​

yeedu resource search-cloud-envs -h
usage:  search-cloud-envs [-h] --cloud_env_name CLOUD_ENV_NAME
                          [--cloud_provider [{GCP,AWS,Azure}]]
                          [--page_number PAGE_NUMBER] [--limit LIMIT]
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_env_name CLOUD_ENV_NAME
                        Provide cloud_env_name to search matching cloud environments.
  --cloud_provider [{GCP,AWS,Azure}]
                        Provide cloud_provider to search all the related cloud environments of a specific cloud provider.
  --page_number PAGE_NUMBER
                        To list cloud environments for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of cloud environments. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-cloud-envs example with required argument '--cloud_env_name' passed.
yeedu resource search-cloud-envs --cloud_env_name="gcp_"
  • Console output
{
  "data": [
    {
      "cloud_env_id": 1,
      "cloud_env_name": "gcp_cloud_env",
      "description": "yeedu cloud environment",
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "availability_zone": {
        "availability_zone_id": 75,
        "name": "us-central1-a",
        "cloud_provider_id": 0,
        "region": "us-central1",
        "description": "Council Bluffs, Iowa, North America"
      },
      "network_config": {
        "network_conf_id": 1,
        "network_conf_name": "yeedu_gcp_network",
        "description": null,
        "network_project_id": "yeedu",
        "network_name": "yeedu-vpc",
        "network_tags": [
          "yeedu"
        ],
        "subnet": "custom-subnet-yeedu",
        "availability_zone": {
          "availability_zone_id": 75,
          "name": "us-central1-a",
          "cloud_provider_id": 0,
          "region": "us-central1",
          "description": "Council Bluffs, Iowa, North America"
        }
      },
      "cloud_project": "yeedu",
      "credential_config": {
        "credential_conf_id": 1,
        "credentials_conf_name": "yeedu-svc",
        "description": null,
        "credential_type": {
          "credential_type_id": 0,
          "name": "Google Service Account",
          "cloud_provider_id": 0
        }
      },
      "boot_disk_image": {
        "boot_disk_image_id": 1,
        "boot_disk_image_name": "gcp_boot_disk",
        "description": "dev boot disk",
        "linux_distro": {
          "linux_distro_id": 0,
          "distro_name": "UBUNTU",
          "distro_version": "20.04 LTS"
        },
        "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts"
      },
      "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T08:00:41.996333+00:00",
      "from_date": "2024-05-30T08:00:41.996333+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-cloud-env​

yeedu resource get-cloud-env -h
usage:  get-cloud-env [-h] [--cloud_env_id CLOUD_ENV_ID]
                      [--cloud_env_name CLOUD_ENV_NAME]
                      [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_env_id CLOUD_ENV_ID
                        Provide cloud_env_id to get detials about a specific cloud environment.
  --cloud_env_name CLOUD_ENV_NAME
                        Provide cloud_env_name to get detials about a specific cloud environment.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-cloud-env example with any one of the required argument passed.
yeedu resource get-cloud-env --cloud_env_id=1
  • Console output
{
  "cloud_env_id": 1,
  "cloud_env_name": "gcp_cloud_env",
  "description": "yeedu cloud environment",
  "cloud_provider": {
    "cloud_provider_id": 0,
    "name": "GCP",
    "description": "Provider for creating infrastructure on Google Cloud Platform"
  },
  "availability_zone": {
    "availability_zone_id": 75,
    "name": "us-central1-a",
    "cloud_provider_id": 0,
    "region": "us-central1",
    "description": "Council Bluffs, Iowa, North America"
  },
  "network_config": {
    "network_conf_id": 1,
    "network_conf_name": "yeedu_gcp_network",
    "description": null,
    "network_project_id": "yeedu",
    "network_name": "yeedu-vpc",
    "network_tags": [
      "yeedu"
    ],
    "subnet": "custom-subnet-yeedu",
    "availability_zone": {
      "availability_zone_id": 75,
      "name": "us-central1-a",
      "cloud_provider_id": 0,
      "region": "us-central1",
      "description": "Council Bluffs, Iowa, North America"
    }
  },
  "cloud_project": "yeedu",
  "credential_config": {
    "credential_conf_id": 1,
    "credentials_conf_name": "yeedu-svc",
    "description": null,
    "credential_type": {
      "credential_type_id": 0,
      "name": "Google Service Account",
      "cloud_provider_id": 0
    }
  },
  "boot_disk_image": {
    "boot_disk_image_id": 1,
    "boot_disk_image_name": "gcp_boot_disk",
    "description": "dev boot disk",
    "linux_distro": {
      "linux_distro_id": 0,
      "distro_name": "UBUNTU",
      "distro_version": "20.04 LTS"
    },
    "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts"
  },
  "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-05-30T08:00:41.996333+00:00",
  "from_date": "2024-05-30T08:00:41.996333+00:00",
  "to_date": "infinity"
}

edit-cloud-env​

yeedu resource edit-cloud-env -h
usage:  edit-cloud-env [-h] [--cloud_env_id CLOUD_ENV_ID]
                       [--cloud_env_name CLOUD_ENV_NAME] [--name NAME]
                       [--description DESCRIPTION]
                       [--availability_zone_id AVAILABILITY_ZONE_ID]
                       [--network_conf_id NETWORK_CONF_ID]
                       [--cloud_project CLOUD_PROJECT]
                       [--credential_config_id CREDENTIAL_CONFIG_ID]
                       [--boot_disk_image_id BOOT_DISK_IMAGE_ID]
                       [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_env_id CLOUD_ENV_ID
                        Provide cloud_env_id to edit a specific cloud environment.
  --cloud_env_name CLOUD_ENV_NAME
                        Provide cloud_env_name to edit a specific cloud environment.
  --name NAME           Provide name to edit a specific cloud environment.
  --description DESCRIPTION
                        Provide description to edit a specific cloud environment.
  --availability_zone_id AVAILABILITY_ZONE_ID
                        Provide availability_zone_id to edit a specific cloud environment.
  --network_conf_id NETWORK_CONF_ID
                        Provide network_conf_id to edit a specific cloud environment.
  --cloud_project CLOUD_PROJECT
                        Provide cloud_project to edit a specific cloud environment.
  --credential_config_id CREDENTIAL_CONFIG_ID
                        Provide credential_config_id to edit a specific cloud environment.
  --boot_disk_image_id BOOT_DISK_IMAGE_ID
                        Provide boot_disk_image_id to edit a specific cloud environment.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Provide true to edit output in YAML format. (default: false)
  • edit-cloud-env example with all the required arguments passed which needs to be updated.
yeedu resource edit-cloud-env --cloud_env_id=1 --name="gcp_cloud_env_dev"
  • Console output
{
  "cloud_env_id": "1",
  "name": "gcp_cloud_env_dev",
  "description": null,
  "cloud_provider_id": "0",
  "availability_zone_id": "75",
  "network_conf_id": "1",
  "cloud_project": "yeedu",
  "credential_config_id": "1",
  "boot_disk_image_id": "1",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-01-08T09:07:25.748Z",
  "from_date": "2024-01-08T09:07:25.748Z",
  "to_date": null
}

delete-cloud-env​

yeedu resource delete-cloud-env -h
usage:  delete-cloud-env [-h] [--cloud_env_id CLOUD_ENV_ID]
                         [--cloud_env_name CLOUD_ENV_NAME]
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_env_id CLOUD_ENV_ID
                        Provide cloud_env_id to delete a specific cloud environment.
  --cloud_env_name CLOUD_ENV_NAME
                        Provide cloud_env_name to delete a specific cloud environment.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Provide true to delete output in YAML format. (default: false)
  • delete-cloud-env example with any one of the required argument passed.
yeedu resource delete-cloud-env --cloud_env_id=1
  • Console output
{
  "message": "Deleted cloud environment id: 1"
}

Object Storage Manager​

Command NameUtility
create-object-storage-managerTo create a Object Storage Manager.
list-object-storage-managersTo list all the available Object Storage Manager Configurations.
search-object-storage-managersTo search Object Storage Manager Configurations.
get-object-storage-managerTo get information about a specific Object Storage Manager.
edit-object-storage-managerTo edit a specific Object Storage Manager Configuration.
delete-object-storage-managerTo delete a specific Object Storage Manager.

create-object-storage-manager​

yeedu resource create-object-storage-manager -h
usage:  create-object-storage-manager [-h] --name NAME [--description DESCRIPTION] --cloud_provider_id CLOUD_PROVIDER_ID --credentials_conf_id
                                      CREDENTIALS_CONF_ID --object_storage_bucket_name OBJECT_STORAGE_BUCKET_NAME
                                      [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create-object-storage-manager.
  --description DESCRIPTION
                        Provide description to create-object-storage-manager.
  --cloud_provider_id CLOUD_PROVIDER_ID
                        Provide cloud_provider_id to create-object-storage-manager.
  --credentials_conf_id CREDENTIALS_CONF_ID
                        Provide credentials_conf_id to create-object-storage-manager.
  --object_storage_bucket_name OBJECT_STORAGE_BUCKET_NAME
                        Provide object_storage_bucket_name to create-object-storage-manager.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-object-storage-manager example with all the required arguments passed.
yeedu resource create-object-storage-manager --name="yeedu_osm" --cloud_provider_id=0 --credentials_conf_id=1 --object_storage_bucket_name="yeedu"
  • Console output
{
  "object_storage_manager_id": "1",
  "name": "yeedu_object_storage_manager",
  "description": null,
  "cloud_provider_id": "0",
  "credentials_conf_id": "1",
  "object_storage_bucket_name": "yeedu",
  "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-01-08T09:32:24.643Z",
  "from_date": "2024-01-08T09:32:24.643Z",
  "to_date": null
}

list-object-storage-managers​

yeedu resource list-object-storage-managers -h
usage:  list-object-storage-managers [-h] [--cloud_provider [{GCP,AWS,Azure}]]
                                     [--page_number PAGE_NUMBER] [--limit LIMIT]
                                     [--json-output [{pretty,default}]]
                                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        Cloud Provider that will be used for filtering list.
  --page_number PAGE_NUMBER
                        To list Object Storage Managers for a specific page_number.
                        (default: 1)
  --limit LIMIT         Provide limit to list number of Object Storage Managers.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-object-storage-managers example with an optional argument passed.
yeedu resource list-object-storage-managers --cloud_provider="GCP"
  • Console output
{
  "data": [
    {
      "object_storage_manager_id": 1,
      "object_storage_manager_name": "yeedu_object_storage_manager",
      "description": null,
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "object_storage_bucket_name": "yeedu",
      "credentials_config": {
        "credentials_conf_id": 1,
        "credentials_conf_name": "gcp_credential",
        "description": null,
        "credential_type": {
          "credential_type_id": 0,
          "name": "Google Service Account"
        }
      },
      "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T08:07:10.727231+00:00",
      "from_date": "2024-05-30T08:07:10.727231+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-object-storage-managers​

yeedu resource search-object-storage-managers -h
usage:  search-object-storage-managers [-h]
                                       --object_storage_manager_name
                                       OBJECT_STORAGE_MANAGER_NAME
                                       [--cloud_provider [{GCP,AWS,Azure}]]
                                       [--page_number PAGE_NUMBER]
                                       [--limit LIMIT]
                                       [--json-output [{pretty,default}]]
                                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide Object Storage Manager Name to search information about a specific Object Storage Manager.
  --cloud_provider [{GCP,AWS,Azure}]
                        Cloud Provider that will be used for filtering list.
  --page_number PAGE_NUMBER
                        To search Object Storage Managers for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of Object Storage Managers. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-object-storage-managers example with required argument '--object_storage_manager_name' passed.
yeedu resource search-object-storage-managers --object_storage_manager_name="gcp_"
  • Console output
{
  "data": [
    {
      "object_storage_manager_id": 1,
      "object_storage_manager_name": "yeedu_object_storage_manager",
      "description": null,
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP",
        "description": "Provider for creating infrastructure on Google Cloud Platform"
      },
      "object_storage_bucket_name": "yeedu",
      "credentials_config": {
        "credentials_conf_id": 1,
        "credentials_conf_name": "gcp_credential",
        "description": null,
        "credential_type": {
          "credential_type_id": 0,
          "name": "Google Service Account"
        }
      },
      "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-05-30T08:07:10.727231+00:00",
      "from_date": "2024-05-30T08:07:10.727231+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-object-storage-manager​

yeedu resource get-object-storage-manager -h
usage:  get-object-storage-manager [-h]
                                   [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                   [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME]
                                   [--json-output [{pretty,default}]]
                                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide Object Storage Manager Id to get information about a specific Object Storage Manager.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide Object Storage Manager Name to get information about a specific Object Storage Manager.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-object-storage-manager example with any one of the required argument passed.
yeedu resource get-object-storage-manager --object_storage_manager_id=1
  • Console output
{
  "object_storage_manager_id": 1,
  "object_storage_manager_name": "yeedu_object_storage_manager",
  "description": null,
  "cloud_provider": {
    "cloud_provider_id": 0,
    "name": "GCP",
    "description": "Provider for creating infrastructure on Google Cloud Platform"
  },
  "object_storage_bucket_name": "yeedu",
  "credentials_config": {
    "credentials_conf_id": 1,
    "credentials_conf_name": "gcp_credential",
    "description": null,
    "credential_type": {
      "credential_type_id": 0,
      "name": "Google Service Account"
    }
  },
  "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-05-30T08:07:10.727231+00:00",
  "from_date": "2024-05-30T08:07:10.727231+00:00",
  "to_date": "infinity"
}

edit-object-storage-manager​

yeedu resource edit-object-storage-manager -h
usage:  edit-object-storage-manager [-h] [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                    [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME] [--name NAME] [--description DESCRIPTION]
                                    [--credentials_conf_id CREDENTIALS_CONF_ID] [--json-output [{pretty,default}]]
                                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide object_storage_manager_id to edit information about a specific Object Storage Manager.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide object_storage_manager_name to edit information about a specific Object Storage Manager.
  --name NAME           Provide name to edit-object-storage-manager.
  --description DESCRIPTION
                        Provide description to edit-object-storage-manager.
  --credentials_conf_id CREDENTIALS_CONF_ID
                        Provide credentials_conf_id to edit-object-storage-manager.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit-object-storage-manager example with all the required arguments passed which needs to be updated.
yeedu resource edit-object-storage-manager --object_storage_manager_id=1 --name="yeedu_object_storage_manager"
  • Console output
{
  "object_storage_manager_id": "1",
  "name": "yeedu_object_storage_manager",
  "description": null,
  "cloud_provider_id": "0",
  "credentials_conf_id": "1",
  "object_storage_bucket_name": "yeedu",
  "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-01-08T09:32:24.643Z",
  "from_date": "2024-01-08T09:32:24.643Z",
  "to_date": null
}

delete-object-storage-manager​

yeedu resource delete-object-storage-manager -h
usage:  delete-object-storage-manager [-h] [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                      [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME] [--json-output [{pretty,default}]]
                                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide object_storage_manager_id to delete a specific Object Storage Manager.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide object_storage_manager_name to delete a specific Object Storage Manager.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-object-storage-manager example with any one of the required argument passed.
yeedu resource delete-object-storage-manager --object_storage_manager_name="yeedu_object_storage_manager"
  • Console output
{
  "message": "Deleted Object Storage Manager Configuration Name: 'yeedu_object_storage_manager'."
}

Object Storage Manager Files​

Command NameUtility
create-object-storage-manager-fileTo create a Object Storage Manager Files.
list-object-storage-manager-filesTo list all the available Object Storage Manager Files.
search-object-storage-manager-filesTo search all the available Object Storage Manager Files.
get-object-storage-manager-fileTo get information about a specific Object Storage Manager File.
delete-object-storage-manager-fileTo delete a specific Object Storage Manager File.

create-object-storage-manager-file​

yeedu resource create-object-storage-manager-file -h
usage:  create-object-storage-manager-file [-h]
                                           [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                           [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME]
                                           --local_file_path LOCAL_FILE_PATH
                                           [--overwrite [{true,false}]]
                                           [--json-output [{pretty,default}]]
                                           [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide Object Storage Manager Id to create-object-storage-
                        manager-file.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide Object Storage Manager Name to to create-object-storage-
                        manager-file.
  --local_file_path LOCAL_FILE_PATH
                        Provide local_file_path to create-object-storage-manager-file.
  --overwrite [{true,false}]
                        Provide overwrite to create-object-storage-manager-file.
                        (default: false)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-object-storage-manager-file example with all the required arguments passed.
yeedu resource create-object-storage-manager-file --object_storage_manager_id=1 --local_file_path='/home/user/Downloads/spark-examples_2.12-3.2.2.jar'
  • Console output
{
  "object_storage_manager_file_id": "1",
  "object_storage_manager_id": "1",
  "file_name": "spark-examples_2.12-3.2.2.jar",
  "full_file_path": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
  "file_size_bytes": "2017856",
  "file_type": "jar",
  "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-01-08T09:58:48.760Z",
  "from_date": "2024-01-08T09:58:48.760Z",
  "to_date": null
}

list-object-storage-manager-files​

yeedu resource list-object-storage-manager-files -h
usage:  list-object-storage-manager-files [-h] [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                          [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME] [--page_number PAGE_NUMBER]
                                          [--limit LIMIT] [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide Object Storage Manager Id to list all the available Object Storage Manager Files.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide Object Storage Manager Name to list all the available Object Storage Manager Files.
  --page_number PAGE_NUMBER
                        To list Object Storage Manager Files for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Object Storage Manager Files. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-object-storage-manager-files example with any one of the required argument passed.
yeedu resource list-object-storage-manager-files --object_storage_manager_name="yeedu_object_storage_manager"
  • Console output
{
  "data": [
    {
      "object_storage_manager_file_id": 1,
      "object_storage_manager": {
        "object_storage_manager_id": 1,
        "object_storage_manager_name": "yeedu_object_storage_manager",
        "description": null,
        "cloud_provider": {
          "name": "GCP",
          "description": "Provider for creating infrastructure on Google Cloud Platform"
        },
        "credentials_config": {
          "credential_config_id": 1,
          "name": "yeedu-svc",
          "description": null,
          "credential_type": {
            "credential_type_id": 0,
            "name": "Google Service Account"
          }
        },
        "object_storage_bucket_name": "yeedu"
      },
      "file_name": "spark-examples_2.12-3.2.2.jar",
      "full_file_path": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
      "file_size_bytes": "1560870",
      "file_type": "jar",
      "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-06T12:52:46.851934+00:00",
      "from_date": "2024-06-06T12:52:46.851934+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-object-storage-manager-files​

yeedu resource search-object-storage-manager-files -h
usage:  search-object-storage-manager-files [-h] --file_name FILE_NAME
                                            [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                            [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME]
                                            [--page_number PAGE_NUMBER]
                                            [--limit LIMIT]
                                            [--json-output [{pretty,default}]]
                                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --file_name FILE_NAME
                        Provide File Name to search all the available Object Storage Manager Files.
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide Object Storage Manager Id to search all the available Object Storage Manager Files.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide Object Storage Manager Name to search all the available Object Storage Manager Files.
  --page_number PAGE_NUMBER
                        To search Object Storage Manager Files for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of Object Storage Manager Files. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-object-storage-manager-files example with any one of the required argument passed.
yeedu resource search-object-storage-manager-files --object_storage_manager_name="yeedu_object_storage_manager" --file_name="spark-examples_"
  • Console output
{
  "data": [
    {
      "object_storage_manager_file_id": 1,
      "object_storage_manager": {
        "object_storage_manager_id": 1,
        "object_storage_manager_name": "yeedu_object_storage_manager",
        "description": null,
        "cloud_provider": {
          "name": "GCP",
          "description": "Provider for creating infrastructure on Google Cloud Platform"
        },
        "credentials_config": {
          "credential_config_id": 1,
          "name": "yeedu-svc",
          "description": null,
          "credential_type": {
            "credential_type_id": 0,
            "name": "Google Service Account"
          }
        },
        "object_storage_bucket_name": "yeedu"
      },
      "file_name": "spark-examples_2.12-3.2.2.jar",
      "full_file_path": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
      "file_size_bytes": "1560870",
      "file_type": "jar",
      "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-06T12:52:46.851934+00:00",
      "from_date": "2024-06-06T12:52:46.851934+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-object-storage-manager-file​

yeedu resource get-object-storage-manager-file -h
usage:  get-object-storage-manager-file [-h] [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                        [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME] [--file_id FILE_ID] [--file_name FILE_NAME]
                                        [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide Object Storage Manager Id to get information about a specific Object Storage Manager Files.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide Object Storage Manager Name to get information about a specific Object Storage Manager Files.
  --file_id FILE_ID     Provide File Id to get information about a specific Object Storage Manager Files.
  --file_name FILE_NAME
                        Provide File Name to get information about a specific Object Storage Manager Files.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-object-storage-manager-file example with any one of the required arguments passed.
yeedu resource get-object-storage-manager-file --object_storage_manager_id=1 --file_id=1
  • Console output
{
  "object_storage_manager_file_id": 1,
  "object_storage_manager": {
    "object_storage_manager_id": 1,
    "object_storage_manager_name": "yeedu_object_storage_manager",
    "description": null,
    "cloud_provider": {
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    },
    "credentials_config": {
      "credential_config_id": 1,
      "name": "yeedu-svc",
      "description": null,
      "credential_type": {
        "credential_type_id": 0,
        "name": "Google Service Account"
      }
    },
    "object_storage_bucket_name": "yeedu"
  },
  "file_name": "spark-examples_2.12-3.2.2.jar",
  "full_file_path": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
  "file_size_bytes": "1560870",
  "file_type": "jar",
  "tenant_id": "1ea17e91-257b-4a6c-82aa-265568d31615",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-06T12:52:46.851934+00:00",
  "from_date": "2024-06-06T12:52:46.851934+00:00",
  "to_date": "infinity"
}

delete-object-storage-manager-file​

yeedu resource delete-object-storage-manager-file -h
usage:  delete-object-storage-manager-file [-h] [--object_storage_manager_id OBJECT_STORAGE_MANAGER_ID]
                                           [--object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME] [--file_id FILE_ID]
                                           [--file_name FILE_NAME] [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide Object Storage Manager Id to delete a specific Object Storage Manager File.
  --object_storage_manager_name OBJECT_STORAGE_MANAGER_NAME
                        Provide Object Storage Manager Name to delete a specific Object Storage Manager File.
  --file_id FILE_ID     Provide File Id to delete a specific Object Storage Manager Files.
  --file_name FILE_NAME
                        Provide File Name to delete a specific Object Storage Manager Files.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-object-storage-manager-file example with any one of the required arguments passed.
yeedu resource delete-object-storage-manager-file --object_storage_manager_id=1 --file_id=1
  • Console output
{
  "message": "The File: 'spark-examples_2.12-3.2.2.jar' has been deleted."
}

Hive Metastore Configuration​

Command NameUtility
create-hive-metastore-confTo create a Hive Metastore Configuration.
list-hive-metastore-confsTo list all the available Hive Metastore Configurations.
search-hive-metastore-confsTo list all the available Hive Metastore Configurations.
get-hive-metastore-confTo get the information about a specific Hive Metastore Configuration.
edit-hive-metastore-confTo edit a specific Hive Metastore Configuration.
delete-hive-metastore-confTo delete a specific Hive Metastore Configuration.

create-hive-metastore-conf​

yeedu resource create-hive-metastore-conf -h
usage:  create-hive-metastore-conf [-h] --name NAME [--description DESCRIPTION]
                                   [--hive_site_xml_file_path HIVE_SITE_XML_FILE_PATH]
                                   [--core_site_xml_file_path CORE_SITE_XML_FILE_PATH]
                                   [--hdfs_site_xml_file_path HDFS_SITE_XML_FILE_PATH]
                                   [--krb5_conf_file_path KRB5_CONF_FILE_PATH]
                                   [--json-output [{pretty,default}]]
                                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create-hive-metastore-conf.
  --description DESCRIPTION
                        Provide description to create-hive-metastore-conf.
  --hive_site_xml_file_path HIVE_SITE_XML_FILE_PATH
                        Provide hive_site_xml_file_path to create-hive-metastore-conf.
  --core_site_xml_file_path CORE_SITE_XML_FILE_PATH
                        Provide core_site_xml_file_path to create-hive-metastore-conf.
  --hdfs_site_xml_file_path HDFS_SITE_XML_FILE_PATH
                        Provide hdfs_site_xml_file_path to create-hive-metastore-conf.
  --krb5_conf_file_path KRB5_CONF_FILE_PATH
                        Provide krb5_conf_file_path to create-hive-metastore-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • create-hive-metastore-conf example with all the required arguments passed.
yeedu resource create-hive-metastore-conf --name="yeedu_hive_conf" --hive_site_xml_file_path="/home/user/Documents/hive-site.xml" --core_site_xml_file_path="/home/user/Documents/core-site.xml" --hdfs_site_xml_file_path="/home/user/Documents/hdfs-site.xml"
  • Console output
{
  "hive_metastore_conf_id": "1",
  "name": "yeedu_hive_conf",
  "description": null,
  "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2023-09-29T07:37:52.309Z",
  "from_date": "2023-09-29T07:37:52.309Z",
  "to_date": null
}

list-hive-metastore-confs​

yeedu resource list-hive-metastore-confs -h
usage:  list-hive-metastore-confs [-h] [--page_number PAGE_NUMBER] [--limit LIMIT]
                                  [--json-output [{pretty,default}]]
                                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --page_number PAGE_NUMBER
                        To list Hive Metastore Configurations for a specific
                        page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Hive Metastore Configurations.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-hive-metastore-confs example without any optional argument passed for the output format.
yeedu resource list-hive-metastore-confs
  • Console output
{
  "data": [
    {
      "hive_metastore_conf_id": 1,
      "hive_metastore_conf_name": "yeedu_hive_conf",
      "description": null,
      "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-06T08:13:46.055227+00:00",
      "from_date": "2024-06-06T08:13:46.055227+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-hive-metastore-confs​

yeedu resource search-hive-metastore-confs -h
usage:  search-hive-metastore-confs [-h] --hive_metastore_conf_name
                                    HIVE_METASTORE_CONF_NAME [--page_number PAGE_NUMBER]
                                    [--limit LIMIT] [--json-output [{pretty,default}]]
                                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --hive_metastore_conf_name HIVE_METASTORE_CONF_NAME
                        Provide hive_metastore_conf_name to search information about
                        Hive Metastore Configurations.
  --page_number PAGE_NUMBER
                        To search Hive Metastore Configurations for a specific
                        page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of Hive Metastore Configurations.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-hive-metastore-confs example with required argument '--hive_metastore_conf_name' passed.
yeedu resource search-hive-metastore-confs --hive_metastore_conf_name="yeedu_"
  • Console output
{
  "data": [
    {
      "hive_metastore_conf_id": 1,
      "hive_metastore_conf_name": "yeedu_hive_conf",
      "description": null,
      "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-06T08:13:46.055227+00:00",
      "from_date": "2024-06-06T08:13:46.055227+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-hive-metastore-conf​

yeedu resource get-hive-metastore-conf -h
usage:  get-hive-metastore-conf [-h] [--hive_metastore_conf_id HIVE_METASTORE_CONF_ID]
                                [--hive_metastore_conf_name HIVE_METASTORE_CONF_NAME]
                                [--json-output [{pretty,default}]]
                                [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --hive_metastore_conf_id HIVE_METASTORE_CONF_ID
                        Provide hive_metastore_conf_id to get information about a
                        specific Hive Metastore Configuration.
  --hive_metastore_conf_name HIVE_METASTORE_CONF_NAME
                        Provide hive_metastore_conf_name to get information about a
                        specific Hive Metastore Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-hive-metastore-conf example with any one of the required '--hive_metastore_conf_id' argument passed.
yeedu resource get-hive-metastore-conf --hive_metastore_conf_id=1
  • Console output
{
  "hive_metastore_conf_id": 1,
  "hive_metastore_conf_name": "yeedu_hive_conf",
  "description": null,
  "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-06T08:13:46.055227+00:00",
  "from_date": "2024-06-06T08:13:46.055227+00:00",
  "to_date": "infinity"
}

edit-hive-metastore-conf​

yeedu resource edit-hive-metastore-conf -h
usage:  edit-hive-metastore-conf [-h] [--hive_metastore_conf_id HIVE_METASTORE_CONF_ID]
                                 [--hive_metastore_conf_name HIVE_METASTORE_CONF_NAME]
                                 [--name NAME] [--description DESCRIPTION]
                                 [--hive_site_xml_file_path HIVE_SITE_XML_FILE_PATH]
                                 [--core_site_xml_file_path CORE_SITE_XML_FILE_PATH]
                                 [--hdfs_site_xml_file_path HDFS_SITE_XML_FILE_PATH]
                                 [--krb5_conf_file_path KRB5_CONF_FILE_PATH]
                                 [--json-output [{pretty,default}]]
                                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --hive_metastore_conf_id HIVE_METASTORE_CONF_ID
                        Provide a specific hive_metastore_conf_id to edit-hive-metastore-
                        conf.
  --hive_metastore_conf_name HIVE_METASTORE_CONF_NAME
                        Provide a specific hive_metastore_conf_name to edit-hive-
                        metastore-conf.
  --name NAME           Provide name to edit-hive-metastore-conf.
  --description DESCRIPTION
                        Provide description to edit-hive-metastore-conf.
  --hive_site_xml_file_path HIVE_SITE_XML_FILE_PATH
                        Provide hive_site_xml_file_path to edit-hive-metastore-conf.
  --core_site_xml_file_path CORE_SITE_XML_FILE_PATH
                        Provide core_site_xml_file_path to edit-hive-metastore-conf.
  --hdfs_site_xml_file_path HDFS_SITE_XML_FILE_PATH
                        Provide hdfs_site_xml_file_path to edit-hive-metastore-conf.
  --krb5_conf_file_path KRB5_CONF_FILE_PATH
                        Provide krb5_conf_file_path to edit-hive-metastore-conf.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • edit-hive-metastore-conf example with any one of the required '--hive_metastore_conf_id' argument and other optional argument is passed which is to be updated.
yeedu resource edit-hive-metastore-conf --hive_metastore_conf_id=1 --krb5_conf_file_path="/home/user/Documents/krb5.conf"
  • Console output
{
  "hive_metastore_conf_id": "1",
  "hive_metastore_conf_name": "yeedu_hive_conf",
  "description": null,
  "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-06T08:13:46.055227+00:00",
  "from_date": "2024-06-06T08:13:46.055227+00:00",
  "to_date": null
}

delete-hive-metastore-conf​

yeedu resource delete-hive-metastore-conf -h
usage:  delete-hive-metastore-conf [-h]
                                   [--hive_metastore_conf_id HIVE_METASTORE_CONF_ID]
                                   [--hive_metastore_conf_name HIVE_METASTORE_CONF_NAME]
                                   [--json-output [{pretty,default}]]
                                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --hive_metastore_conf_id HIVE_METASTORE_CONF_ID
                        Provide hive_metastore_conf_id to delete a specific Hive
                        Metastore Configuration.
  --hive_metastore_conf_name HIVE_METASTORE_CONF_NAME
                        Provide hive_metastore_conf_name to delete a specific Hive
                        Metastore Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-hive-metastore-conf example with any one of the required argument '--hive_metastore_conf_id' passed.
yeedu resource delete-hive-metastore-conf --hive_metastore_conf_id=1
  • Console output
{
  "message": "Deleted Hive Metastore Configuration Id: 1"
}

Cluster

Cluster Configuration​

Command NameUtility
create-confCreate a new cluster configuration.
list-confsList all the cluster configurations.
search-confsSearch cluster configurations based on configuration name.
get-confGet details of a specific cluster configuration.
edit-confModify details of a specific cluster configuration.
delete-confDelete a specific cluster configuration.

create-conf​

yeedu cluster create-conf -h
usage:  create-conf [-h] --name NAME [--description DESCRIPTION]
                    --machine_type_category_id MACHINE_TYPE_CATEGORY_ID --machine_type_id
                    MACHINE_TYPE_ID [--volume_conf_id VOLUME_CONF_ID]
                    [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Assigns a name to the cluster configuration.
  --description DESCRIPTION
                        Provides a description for the cluster configuration.
  --machine_type_category_id MACHINE_TYPE_CATEGORY_ID
                        Sets the machine type category ID for the cluster configuration.
  --machine_type_id MACHINE_TYPE_ID
                        Sets the machine type ID for the cluster configuration.
  --volume_conf_id VOLUME_CONF_ID
                        Sets the volume configuration ID for the cluster configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-conf example with all the required arguments passed.
yeedu cluster create-conf --name="yeedu_cluster_config" --description="Cluster Configurations test" --machine_type_id=1 --machine_type_category_id=2 --volume_conf_id=1
  • Console output
{
  "cluster_conf_id": "242",
  "name": "yeedu_cluster_config",
  "description": "Cluster Configurations test",
  "machine_type_category_id": "2",
  "machine_type_id": "1",
  "volume_conf_id": "1",
  "created_by_user_id": "3",
  "modified_by_user_id": "3",
  "last_update_date": "2024-06-06T09:55:54.581Z",
  "from_date": "2024-06-06T09:55:54.581Z",
  "to_date": null
}

list-confs​

yeedu cluster list-confs -h
usage:  list-confs [-h] [--cloud_provider [{GCP,AWS,Azure}]]
                   [--compute_type [{compute_optimized,memory_optimized,general_purpose,gpu_accelerated}]]
                   [--page_number PAGE_NUMBER] [--limit LIMIT]
                   [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cloud_provider [{GCP,AWS,Azure}]
                        Specifies the cloud provider to filter the cluster
                        configurations.
  --compute_type [{compute_optimized,memory_optimized,general_purpose,gpu_accelerated}]
                        Specifies the compute type to filter the cluster configurations.
  --page_number PAGE_NUMBER
                        Specifies the page number for results pagination. (default: 1)
  --limit LIMIT         Specifies the maximum number of configurations to list per page.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-confs example with optional arguments passed.
yeedu cluster list-confs --cloud_provider="GCP" --limit=1
  • Console output
{
  "data": [
    {
      "cluster_conf_id": 1,
      "cluster_conf_name": "n1-highcpu-16",
      "description": null,
      "machine_type_category": "compute_optimized",
      "machine_type": {
        "machine_type_id": 1,
        "cloud_provider": {
          "cloud_provider_id": 0,
          "name": "GCP"
        },
        "name": "n1-highcpu-16",
        "vCPUs": 16,
        "memory": "14.4 GiB",
        "has_cuda": false,
        "gpu_model": null,
        "gpus": 0,
        "gpu_memory": null,
        "cpu_model": [
          "Intel Xeon Scalable (Skylake) 1st Generation",
          "Intel Xeon E5 v4 (Broadwell E5)",
          "Intel Xeon E5 v3 (Haswell)",
          "Intel Xeon E5 v2 (Ivy Bridge)",
          "Intel Xeon E5 (Sandy Bridge)"
        ],
        "cpu_min_frequency_GHz": [
          "2.0",
          "2.2",
          "2.3",
          "2.5",
          "2.6"
        ],
        "cpu_max_frequency_GHz": [
          "3.5",
          "3.7",
          "3.8",
          "3.5",
          "3.6"
        ],
        "has_local_disk": false,
        "local_disk_size_GB": null,
        "local_num_of_disks": null,
        "local_disk_bus_type": {
          "local_disk_bus_type_id": null,
          "local_disk_bus_type": null
        },
        "local_disk_throughput_MB": null,
        "machine_price_ycu": 5.44
      },
      "machine_volume_conf": {
        "volume_conf_id": 3,
        "name": "volume_gcp_3",
        "encrypted": true,
        "size": 375,
        "disk_type": {
          "disk_type_id": 2,
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          },
          "name": "local-ssd",
          "has_fixed_size": true,
          "min_size": 375,
          "max_size": 375
        },
        "machine_volume_num": 3,
        "machine_volume_strip_num": 3,
        "disk_iops": null,
        "disk_throughput_MB": null,
        "disk_num": 1,
        "disk_size": 1125
      },
      "created_by": null,
      "modified_by": null,
      "last_update_date": "2024-05-29T16:09:48.827146+00:00",
      "from_date": "2024-05-29T16:09:48.827146+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 49,
    "total_pages": 49,
    "limit": 1,
    "next_page": 2
  }
}

search-confs​

yeedu cluster search-confs -h
usage:  search-confs [-h] --cluster_conf_name CLUSTER_CONF_NAME
                     [--cloud_provider [{GCP,AWS,Azure}]]
                     [--compute_type {compute_optimized,memory_optimized,general_purpose,gpu_accelerated}]
                     [--page_number PAGE_NUMBER] [--limit LIMIT]
                     [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_conf_name CLUSTER_CONF_NAME
                        Specifies the name of the cluster configuration to search for.
  --cloud_provider [{GCP,AWS,Azure}]
                        Specifies the cloud provider to filter the cluster
                        configurations.
  --compute_type {compute_optimized,memory_optimized,general_purpose,gpu_accelerated}
                        Specifies the compute type to filter the cluster configurations.
  --page_number PAGE_NUMBER
                        Specifies the page number for results pagination. (default: 1)
  --limit LIMIT         Specifies the maximum number of configurations to search per
                        page. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-confs example with required argument '--cluster_conf_name' passed.
yeedu cluster search-confs --cluster_conf_name="yeedu_"
  • Console output
{
  "data": [
    {
      "cluster_conf_id": 242,
      "cluster_conf_name": "yeedu_cluster_config",
      "description": "Cluster Configurations test",
      "machine_type_category": "general_purpose",
      "machine_type": {
        "machine_type_id": 1,
        "cloud_provider": {
          "cloud_provider_id": 0,
          "name": "GCP"
        },
        "name": "n1-highcpu-16",
        "vCPUs": 16,
        "memory": "14.4 GiB",
        "has_cuda": false,
        "gpu_model": null,
        "gpus": 0,
        "gpu_memory": null,
        "cpu_model": [
          "Intel Xeon Scalable (Skylake) 1st Generation",
          "Intel Xeon E5 v4 (Broadwell E5)",
          "Intel Xeon E5 v3 (Haswell)",
          "Intel Xeon E5 v2 (Ivy Bridge)",
          "Intel Xeon E5 (Sandy Bridge)"
        ],
        "cpu_min_frequency_GHz": [
          "2.0",
          "2.2",
          "2.3",
          "2.5",
          "2.6"
        ],
        "cpu_max_frequency_GHz": [
          "3.5",
          "3.7",
          "3.8",
          "3.5",
          "3.6"
        ],
        "has_local_disk": false,
        "local_disk_size_GB": null,
        "local_num_of_disks": null,
        "local_disk_bus_type": {
          "local_disk_bus_type_id": null,
          "local_disk_bus_type": null
        },
        "local_disk_throughput_MB": null,
        "machine_price_ycu": 5.44
      },
      "machine_volume_conf": {
        "volume_conf_id": 1,
        "name": "volume_gcp_1",
        "encrypted": true,
        "size": 375,
        "disk_type": {
          "disk_type_id": 2,
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          },
          "name": "local-ssd",
          "has_fixed_size": true,
          "min_size": 375,
          "max_size": 375
        },
        "machine_volume_num": 1,
        "machine_volume_strip_num": 1,
        "disk_iops": null,
        "disk_throughput_MB": null,
        "disk_num": 1,
        "disk_size": 375
      },
      "created_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "last_update_date": "2024-06-06T09:55:54.581268+00:00",
      "from_date": "2024-06-06T09:55:54.581268+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-conf​

yeedu cluster get-conf -h
usage:  get-conf [-h] [--cluster_conf_id CLUSTER_CONF_ID]
                 [--cluster_conf_name CLUSTER_CONF_NAME]
                 [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_conf_id CLUSTER_CONF_ID
                        Specifies the ID of the cluster configuration to retrieve
                        details.
  --cluster_conf_name CLUSTER_CONF_NAME
                        Specifies the name of the cluster configuration to retrieve
                        details.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-conf example showing the command with either required argument provided.
yeedu cluster get-conf --cluster_conf_id=9
  • Console output
{
  "cluster_conf_id": 9,
  "cluster_conf_name": "n1-highcpu-96",
  "description": null,
  "machine_type_category": "compute_optimized",
  "machine_type": {
    "machine_type_id": 9,
    "cloud_provider": {
      "cloud_provider_id": 0,
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    },
    "name": "n1-highcpu-96",
    "vCPUs": 96,
    "memory": "86.4 GiB",
    "has_cuda": false,
    "gpu_model": null,
    "gpus": 0,
    "gpu_memory": null,
    "cpu_model": [
      "Intel Xeon Scalable (Skylake) 1st Generation",
      "Intel Xeon E5 v4 (Broadwell E5)",
      "Intel Xeon E5 v3 (Haswell)",
      "Intel Xeon E5 v2 (Ivy Bridge)",
      "Intel Xeon E5 (Sandy Bridge)"
    ],
    "cpu_min_frequency_GHz": [
      "2.0",
      "2.2",
      "2.3",
      "2.5",
      "2.6"
    ],
    "cpu_max_frequency_GHz": [
      "3.5",
      "3.7",
      "3.8",
      "3.5",
      "3.6"
    ],
    "has_local_disk": false,
    "local_disk_size_GB": null,
    "local_num_of_disks": null,
    "local_disk_bus_type": {
      "local_disk_bus_type_id": null,
      "local_disk_bus_type": null
    },
    "local_disk_throughput_MB": null,
    "machine_price_ycu": 32.64
  },
  "machine_volume_conf": {
    "volume_conf_id": 16,
    "name": "volume_gcp_16",
    "encrypted": true,
    "size": 375,
    "disk_type": {
      "disk_type_id": 2,
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP"
      },
      "name": "local-ssd",
      "has_fixed_size": true,
      "min_size": 375,
      "max_size": 375
    },
    "machine_volume_num": 16,
    "machine_volume_strip_num": 16,
    "disk_iops": null,
    "disk_throughput_MB": null,
    "disk_num": 1,
    "disk_size": 6000
  },
  "created_by": null,
  "modified_by": null,
  "last_update_date": "2024-05-29T16:09:48.827146+00:00",
  "from_date": "2024-05-29T16:09:48.827146+00:00",
  "to_date": "infinity"
}

edit-conf​

yeedu cluster edit-conf -h
usage:  edit-conf [-h] [--cluster_conf_id CLUSTER_CONF_ID]
                  [--cluster_conf_name CLUSTER_CONF_NAME] [--name [NAME]]
                  [--description [DESCRIPTION]]
                  [--machine_type_category_id MACHINE_TYPE_CATEGORY_ID]
                  [--machine_type_id MACHINE_TYPE_ID] [--volume_conf_id VOLUME_CONF_ID]
                  [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_conf_id CLUSTER_CONF_ID
                        Specifies the ID of the cluster configuration to edit.
  --cluster_conf_name CLUSTER_CONF_NAME
                        Specifies the name of the cluster configuration to edit.
  --name [NAME]         Assigns a new name to the cluster configuration.
  --description [DESCRIPTION]
                        Provides a new description for the cluster configuration.
  --machine_type_category_id MACHINE_TYPE_CATEGORY_ID
                        Sets a new machine type category ID for the cluster
                        configuration.
  --machine_type_id MACHINE_TYPE_ID
                        Sets a new machine type ID for the cluster configuration.
  --volume_conf_id VOLUME_CONF_ID
                        Sets a new volume configuration ID for the cluster configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • Example of edit-conf with the required argument '--cluster_conf_id' and additional optional arguments to update.
yeedu cluster edit-conf --cluster_conf_id=1 --description="Yeedu General Purpose Configuration"
  • Console output
{
  "cluster_conf_id": "242",
  "name": "yeedu_cluster_config",
  "description": "Yeedu General Purpose Configuration",
  "machine_type_category_id": "2",
  "machine_type_id": "1",
  "volume_conf_id": "1",
  "created_by_user_id": "3",
  "modified_by_user_id": "3",
  "last_update_date": "2024-06-06T14:46:44.905Z",
  "from_date": "2024-06-06T09:55:54.581Z",
  "to_date": null
}

delete-conf​

yeedu cluster delete-conf -h
usage:  delete-conf [-h] [--cluster_conf_id CLUSTER_CONF_ID]
                    [--cluster_conf_name CLUSTER_CONF_NAME]
                    [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_conf_id CLUSTER_CONF_ID
                        Specifies the ID of the cluster configuration to delete.
  --cluster_conf_name CLUSTER_CONF_NAME
                        Specifies the name of the cluster configuration to delete.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-conf example with any one of the required argument passed.
yeedu cluster delete-conf --cluster_conf_name="yeedu_cluster_config"
  • Console output
{
  "message": "Deleted Cluster Config Name: 'yeedu_cluster_config'"
}

Cluster Instance​

Command NameUtility
createCreate a new cluster instance.
listList all available cluster instances.
searchSearch for cluster instances based on instance name.
getGet details of a specific cluster instance.
editModify the configuration of an existing cluster instance.
startStart a specific cluster instance.
stopStop a specific cluster instance.
destroyDestroy a specific cluster instance.
get-statsRetrieve Spark job statistics for a specific cluster instance.
list-statusList status events for a specific cluster instance.
list-errorsList errors for a specific cluster instance.
logsDownload log files for a specific cluster instance.

create​

yeedu cluster create -h
usage:  create [-h] --name [NAME] [--description DESCRIPTION]
               [--idle_timeout_ms [IDLE_TIMEOUT_MS]] [--auto_shutdown [{true,false}]]
               [--labels LABELS [LABELS ...]] [--is_spot_instance [{true,false}]]
               [--enable_public_ip [{true,false}]]
               [--block_project_ssh_keys [{true,false}]]
               [--bootstrap_shell_script_file_path BOOTSTRAP_SHELL_SCRIPT_FILE_PATH]
               --cloud_env_id CLOUD_ENV_ID --object_storage_manager_id
               OBJECT_STORAGE_MANAGER_ID [--conf CONF [CONF ...]] [--packages [PACKAGES]]
               [--repositories [REPOSITORIES]] [--files [FILES]] [--py-files [PY_FILES]]
               [--jars [JARS]] [--archives [ARCHIVES]] [--env_var ENV_VAR [ENV_VAR ...]]
               [--conf_secret CONF_SECRET [CONF_SECRET ...]]
               [--env_var_secret ENV_VAR_SECRET [ENV_VAR_SECRET ...]]
               [--hive_metastore_conf_id [HIVE_METASTORE_CONF_ID]] --spark_infra_version_id
               SPARK_INFRA_VERSION_ID
               [--max_parallel_spark_job_execution_per_instance [MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]]
               [--num_of_workers [NUM_OF_WORKERS]] --cluster_type
               [YEEDU, STANDALONE, CLUSTER] [--min_instances [MIN_INSTANCES]] [--max_instances
               [MAX_INSTANCES]] --cluster_conf_id CLUSTER_CONF_ID
               [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name [NAME]         Provide name to create a cluster instance.
  --description DESCRIPTION
                        Provide description to create a cluster instance.
  --idle_timeout_ms [IDLE_TIMEOUT_MS]
                        Provide idle_timeout_ms to create a cluster instance.
  --auto_shutdown [{true,false}]
                        Provide auto_shutdown to create a cluster instance. (default: true)
  --labels LABELS [LABELS ...]
                        Provide labels to create a cluster instance.
  --is_spot_instance [{true,false}]
                        Provide is_spot_instance to create a cluster instance. (default: false)
  --enable_public_ip [{true,false}]
                        Provide enable_public_ip to create a cluster instance. (default: false)
  --block_project_ssh_keys [{true,false}]
                        Provide block_project_ssh_keys to create a cluster instance. (default: true)
  --bootstrap_shell_script_file_path BOOTSTRAP_SHELL_SCRIPT_FILE_PATH
                        Provide bootstrap_shell_script_file_path to create a cluster instance.
  --cloud_env_id CLOUD_ENV_ID
                        Provide cloud_env_id to create a cluster instance.
  --object_storage_manager_id OBJECT_STORAGE_MANAGER_ID
                        Provide object_storage_manager_id to create a cluster instance.
  --conf CONF [CONF ...]
                        Provide conf to create a cluster instance.
  --packages [PACKAGES]
                        Provide packages to create a cluster instance.
  --repositories [REPOSITORIES]
                        Provide repositories to create a cluster instance.
  --files [FILES]       Provide files to create a cluster instance.
  --py-files [PY_FILES]
                        Provide py-files to create a cluster instance.
  --jars [JARS]         Provide jars to create a cluster instance.
  --archives [ARCHIVES]
                        Provide archives to create a cluster instance.
  --env_var ENV_VAR [ENV_VAR ...]
                        Provide env_var to create a cluster instance.
  --conf_secret CONF_SECRET [CONF_SECRET ...]
                        Provide conf_secret to create a cluster instance.
  --env_var_secret ENV_VAR_SECRET [ENV_VAR_SECRET ...]
                        Provide env_var_secret to create a cluster instance.
  --hive_metastore_conf_id [HIVE_METASTORE_CONF_ID]
                        Provide hive_metastore_conf_id to create a cluster instance.
  --spark_infra_version_id SPARK_INFRA_VERSION_ID
                        Provide spark_infra_version_id to create a cluster instance.
  --max_parallel_spark_job_execution_per_instance [MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]
                        Provide max_parallel_spark_job_execution_per_instance to create a
                        cluster instance. (default: 5)
  --num_of_workers [NUM_OF_WORKERS]
                        Provide num_of_workers to create a cluster instance.
  --cluster_type [YEEDU, STANDALONE, CLUSTER]
                        Provide cluster_type to create a cluster instance.
  --min_instances [MIN_INSTANCES]
                        Provide min_instances to create a cluster instance.
  --max_instances [MAX_INSTANCES]
                        Provide max_instances to create a cluster instance.
  --cluster_conf_id CLUSTER_CONF_ID
                        Provide cluster_conf_id to create a cluster instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create example with all the required and optional arguments passed.
yeedu cluster create --name="yeedu_cluster_instance" --description="Yeedu Instance" --idle_timeout_ms=600000 --auto_shutdown=true --labels="env=test" --is_spot_instance=false --enable_public_ip=true --block_project_ssh_keys=true --object_storage_manager_id=1 --cloud_env_id=1 --spark_infra_version_id=2 --max_parallel_spark_job_execution_per_instance=5 --cluster_type="YEEDU" --min_instances=1 --max_instances=1 --cluster_conf_id=1
  • Console output
{
  "cluster_id": "11",
  "name": "yeedu_cluster_instance",
  "description": "Yeedu Instance",
  "cloud_env_id": "1",
  "idle_timeout_ms": "600000",
  "auto_shutdown": true,
  "labels": {
    "env": "test",
    "resource": "yeedu",
    "vm": "yeedu_node",
    "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44"
  },
  "is_spot_instance": false,
  "enable_public_ip": true,
  "block_project_ssh_keys": true,
  "bootstrap_shell_script": null,
  "object_storage_manager_id": "1",
  "cluster_conf_id": "1",
  "spark_config": {
    "conf": null,
    "packages": null,
    "repositories": null,
    "jars": null,
    "archives": null,
    "env_var": null,
    "conf_secret": null,
    "env_var_secret": null,
    "files": null,
    "py-files": null
  },
  "hive_metastore_conf_id": null,
  "spark_infra_version_id": "2",
  "engine_cluster_spark_config": {
    "max_parallel_spark_job_execution_per_instance": 5,
    "num_of_workers": null
  },
  "cluster_type": "YEEDU",
  "min_instances": 1,
  "max_instances": 1,
  "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44",
  "created_by_user_id": "3",
  "modified_by_user_id": "3",
  "last_update_date": "2024-06-07T10:07:58.902Z",
  "from_date": "2024-06-07T10:07:58.902Z",
  "to_date": null
}

list​

yeedu cluster list -h
usage:  list [-h] [--cluster_status [CLUSTER_STATUS]] [--cluster_conf_id CLUSTER_CONF_ID]
             [--cluster_conf_name CLUSTER_CONF_NAME] [--page_number PAGE_NUMBER]
             [--limit LIMIT] [--json-output [{pretty,default}]]
             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_status [CLUSTER_STATUS]
                        Provide cluster instance status from ["INITIATING", "RUNNING",
                        "STOPPING", "STOPPED", "DESTROYING", "DESTROYED", "ERROR",
                        "RESIZING_UP", "RESIZING_DOWN"] to list, For example
                        --cluster_status="RUNNING,DESTROYED".
  --cluster_conf_id CLUSTER_CONF_ID
                        Provide Cluster Conf Id to list all the Cluster Instances.
  --cluster_conf_name CLUSTER_CONF_NAME
                        Provide Engine Cluster Config Name to list all the Cluster
                        Instances.
  --page_number PAGE_NUMBER
                        To list cluster instance for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of cluster instance. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list example with all the optional arguments passed.
yeedu cluster list --cluster_status="RUNNING" --limit=1
  • Console output
{
  "data": [
    {
      "cluster_id": 11,
      "name": "yeedu_cluster_instance",
      "cluster_status": "RUNNING",
      "cluster_type": "YEEDU",
      "instance_size": 1,
      "min_instances": 1,
      "max_instances": 1,
      "total_ycu": 0,
      "cloud_env": {
        "cloud_env_id": 1,
        "name": "gcp_cloud_env",
        "cloud_provider": {
          "cloud_provider_id": 0,
          "name": "GCP"
        }
      },
      "cluster_conf": {
        "cluster_conf_id": 1,
        "cluster_conf_name": "n1-highcpu-16",
        "machine_type_category": "compute_optimized",
        "machine_type": {
          "machine_type_id": 1,
          "name": "n1-highcpu-16",
          "vCPUs": 16,
          "memory": "14.4 GiB",
          "has_cuda": false,
          "gpu_model": null,
          "gpus": 0,
          "gpu_memory": null,
          "cpu_model": [
            "Intel Xeon Scalable (Skylake) 1st Generation",
            "Intel Xeon E5 v4 (Broadwell E5)",
            "Intel Xeon E5 v3 (Haswell)",
            "Intel Xeon E5 v2 (Ivy Bridge)",
            "Intel Xeon E5 (Sandy Bridge)"
          ],
          "cpu_min_frequency_GHz": [
            "2.0",
            "2.2",
            "2.3",
            "2.5",
            "2.6"
          ],
          "cpu_max_frequency_GHz": [
            "3.5",
            "3.7",
            "3.8",
            "3.5",
            "3.6"
          ],
          "has_local_disk": false,
          "local_disk_size_GB": null,
          "local_num_of_disks": null,
          "local_disk_throughput_MB": null,
          "machine_price_ycu": 5.44
        },
        "machine_volume_conf": {
          "volume_conf_id": 3,
          "name": "volume_gcp_3",
          "size": 375,
          "machine_volume_num": 3,
          "machine_volume_strip_num": 3
        }
      },
      "spark_infra_version": {
        "spark_infra_version_id": 2,
        "spark_docker_image_name": "v3.3.4-3",
        "spark_version": "3.3.4",
        "hive_version": "3.2.3",
        "hadoop_version": "3.2.4",
        "scala_version": "2.12.15",
        "python_version": "3.9.5",
        "notebook_support": true,
        "has_cuda_support": false
      },
      "engine_cluster_spark_config": {
        "max_parallel_spark_job_execution_per_instance": 5,
        "num_of_workers": null
      },
      "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44",
      "created_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "last_update_date": "2024-06-07T10:07:58.902644+00:00",
      "from_date": "2024-06-07T10:07:58.902644+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 6,
    "total_pages": 6,
    "limit": 1,
    "next_page": 2
  }
}
yeedu cluster search -h
usage:  search [-h] --cluster_name CLUSTER_NAME [--page_number PAGE_NUMBER]
               [--limit LIMIT] [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_name CLUSTER_NAME
                        Provide cluster name to search cluster instances.
  --page_number PAGE_NUMBER
                        To search cluster instances for a specific page_number. (default:
                        1)
  --limit LIMIT         Provide limit to search number of cluster instances. (default:
                        100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search example with all the optional arguments passed.
yeedu cluster search --cluster_name="yeedu_" --limit=1
  • Console output
{
  "data": [
    {
      "cluster_id": 11,
      "name": "yeedu_cluster_instance",
      "cluster_status": "RUNNING",
      "cluster_type": "YEEDU",
      "instance_size": 1,
      "min_instances": 1,
      "max_instances": 1,
      "total_ycu": 0,
      "cloud_env": {
        "cloud_env_id": 1,
        "name": "gcp_cloud_env",
        "cloud_provider": {
          "cloud_provider_id": 0,
          "name": "GCP"
        }
      },
      "cluster_conf": {
        "cluster_conf_id": 1,
        "cluster_conf_name": "n1-highcpu-16",
        "machine_type_category": "compute_optimized",
        "machine_type": {
          "machine_type_id": 1,
          "name": "n1-highcpu-16",
          "vCPUs": 16,
          "memory": "14.4 GiB",
          "has_cuda": false,
          "gpu_model": null,
          "gpus": 0,
          "gpu_memory": null,
          "cpu_model": [
            "Intel Xeon Scalable (Skylake) 1st Generation",
            "Intel Xeon E5 v4 (Broadwell E5)",
            "Intel Xeon E5 v3 (Haswell)",
            "Intel Xeon E5 v2 (Ivy Bridge)",
            "Intel Xeon E5 (Sandy Bridge)"
          ],
          "cpu_min_frequency_GHz": [
            "2.0",
            "2.2",
            "2.3",
            "2.5",
            "2.6"
          ],
          "cpu_max_frequency_GHz": [
            "3.5",
            "3.7",
            "3.8",
            "3.5",
            "3.6"
          ],
          "has_local_disk": false,
          "local_disk_size_GB": null,
          "local_num_of_disks": null,
          "local_disk_throughput_MB": null,
          "machine_price_ycu": 5.44
        },
        "machine_volume_conf": {
          "volume_conf_id": 3,
          "name": "volume_gcp_3",
          "size": 375,
          "machine_volume_num": 3,
          "machine_volume_strip_num": 3
        }
      },
      "spark_infra_version": {
        "spark_infra_version_id": 2,
        "spark_docker_image_name": "v3.3.4-3",
        "spark_version": "3.3.4",
        "hive_version": "3.2.3",
        "hadoop_version": "3.2.4",
        "scala_version": "2.12.15",
        "python_version": "3.9.5",
        "notebook_support": true,
        "has_cuda_support": false
      },
      "engine_cluster_spark_config": {
        "max_parallel_spark_job_execution_per_instance": 5,
        "num_of_workers": null
      },
      "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44",
      "created_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "last_update_date": "2024-06-07T10:07:58.902644+00:00",
      "from_date": "2024-06-07T10:07:58.902644+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 1
  }
}

get​

yeedu cluster get -h
usage:  get [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
            [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster instance id to get information about a specific
                        cluster instance.
  --cluster_name CLUSTER_NAME
                        Provide cluster instance name to get information about a specific
                        cluster instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get example with any one of the required argument '--cluster_name' passed.
yeedu cluster get --cluster_name="yeedu_cluster_instance"
  • Console output
{
  "cluster_id": 11,
  "name": "yeedu_cluster_instance",
  "description": "Yeedu Instance",
  "labels": {
    "env": "test",
    "resource": "yeedu",
    "vm": "yeedu_node",
    "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44"
  },
  "idle_timeout_ms": 600000,
  "auto_shutdown": true,
  "cluster_status": "RUNNING",
  "cluster_type": "YEEDU",
  "instance_size": 1,
  "is_spot_instance": false,
  "enable_public_ip": true,
  "block_project_ssh_keys": true,
  "min_instances": 1,
  "max_instances": 1,
  "total_ycu": 0,
  "bootstrap_shell_script": null,
  "cluster_conf": {
    "cluster_conf_id": 1,
    "cluster_conf_name": "n1-highcpu-16",
    "description": null,
    "machine_type_category": "compute_optimized",
    "machine_type": {
      "machine_type_id": 1,
      "name": "n1-highcpu-16",
      "vCPUs": 16,
      "memory": "14.4 GiB",
      "has_cuda": false,
      "gpu_model": null,
      "gpus": 0,
      "gpu_memory": null,
      "cpu_model": [
        "Intel Xeon Scalable (Skylake) 1st Generation",
        "Intel Xeon E5 v4 (Broadwell E5)",
        "Intel Xeon E5 v3 (Haswell)",
        "Intel Xeon E5 v2 (Ivy Bridge)",
        "Intel Xeon E5 (Sandy Bridge)"
      ],
      "cpu_min_frequency_GHz": [
        "2.0",
        "2.2",
        "2.3",
        "2.5",
        "2.6"
      ],
      "cpu_max_frequency_GHz": [
        "3.5",
        "3.7",
        "3.8",
        "3.5",
        "3.6"
      ],
      "has_local_disk": false,
      "local_disk_size_GB": null,
      "local_num_of_disks": null,
      "local_disk_bus_type": {
        "local_disk_bus_type_id": null,
        "local_disk_bus_type": null
      },
      "local_disk_throughput_MB": null,
      "machine_price_ycu": 5.44
    },
    "machine_volume_conf": {
      "volume_conf_id": 3,
      "name": "volume_gcp_3",
      "description": null,
      "encrypted": true,
      "size": 375,
      "disk_type": {
        "disk_type_id": 2,
        "cloud_provider_id": 0,
        "name": "local-ssd",
        "has_fixed_size": true,
        "min_size": 375,
        "max_size": 375
      },
      "machine_volume_num": 3,
      "machine_volume_strip_num": 3,
      "disk_iops": null,
      "disk_throughput_MB": null,
      "disk_num": 1,
      "disk_size": 1125
    }
  },
  "cloud_env": {
    "cloud_env_id": 1,
    "cloud_env_name": "gcp_cloud_env",
    "description": "",
    "cloud_provider": {
      "cloud_provider_id": 0,
      "name": "GCP",
      "description": "Provider for creating infrastructure on Google Cloud Platform"
    },
    "availability_zone": {
      "availability_zone_id": 75,
      "name": "us-central1-a",
      "cloud_provider_id": 0,
      "region": "us-central1",
      "description": "Council Bluffs, Iowa, North America"
    },
    "network_config": {
      "network_conf_id": 1,
      "network_conf_name": "gcp_network_conf",
      "description": "creating gcp network config",
      "network_project_id": "yeedu",
      "network_name": "yeedu-spark-vpc",
      "network_tags": [
        "yeedu",
        "iap-allow"
      ],
      "subnet": "custom-subnet-yeedu",
      "availability_zone": {
        "availability_zone_id": 75,
        "name": "us-central1-a",
        "cloud_provider_id": 0,
        "region": "us-central1",
        "description": "Council Bluffs, Iowa, North America"
      }
    },
    "cloud_project": "yeedu",
    "credentials_config": {
      "credentials_conf_id": 1,
      "credentials_conf_name": "gcp_credential_conf",
      "description": null,
      "credential_type": {
        "credential_type_id": 0,
        "name": "Google Service Account",
        "cloud_provider_id": 0
      }
    },
    "boot_disk_image": {
      "boot_disk_image_id": 1,
      "boot_disk_image_name": "gcp_ubuntu",
      "description": "Base image for GCP Ubuntu",
      "cloud_provider_id": 0,
      "linux_distro": {
        "linux_distro_id": 0,
        "distro_name": "UBUNTU",
        "distro_version": "20.04 LTS"
      },
      "boot_disk_image": "ubuntu-os-cloud/ubuntu-2004-lts"
    }
  },
  "hive_metastore_conf": {
    "hive_metastore_conf_id": null,
    "hive_metastore_conf_name": null
  },
  "spark_infra_version": {
    "spark_infra_version_id": 2,
    "spark_docker_image_name": "v3.3.4-3",
    "spark_version": "3.3.4",
    "hive_version": "3.2.3",
    "hadoop_version": "3.2.4",
    "scala_version": "2.12.15",
    "python_version": "3.9.5",
    "notebook_support": true,
    "has_cuda_support": false
  },
  "spark_config": {
    "conf": null,
    "packages": null,
    "repositories": null,
    "jars": null,
    "archives": null,
    "env_var": null,
    "conf_secret": null,
    "env_var_secret": null,
    "files": null,
    "py-files": null
  },
  "engine_cluster_spark_config": {
    "max_parallel_spark_job_execution_per_instance": 5,
    "num_of_workers": null
  },
  "object_storage_manager": {
    "object_storage_manager_id": 1,
    "object_storage_manager_name": "gcp_osm",
    "description": null,
    "credentials_config": {
      "credential_config_id": 1,
      "name": "gcp_credential_conf",
      "description": null,
      "credential_type_name": "Google Service Account"
    },
    "object_storage_bucket_name": "yeedu"
  },
  "workflow_job_instance_details": {
    "workflow_job_instance_status": {
      "workflow_job_instance_id": 154,
      "workflow_job_id": 154,
      "status": "EXECUTING",
      "from_date": "2024-06-07T10:07:58.902644+00:00",
      "to_date": "infinity"
    }
  },
  "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44",
  "created_by": {
    "user_id": 3,
    "username": "ysu0000@yeedu.io"
  },
  "modified_by": {
    "user_id": 3,
    "username": "ysu0000@yeedu.io"
  },
  "last_update_date": "2024-06-07T10:07:58.902644+00:00",
  "from_date": "2024-06-07T10:07:58.902644+00:00",
  "to_date": "infinity"
}

edit​

yeedu cluster edit -h
usage:  edit [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME] [--name NAME]
             [--description DESCRIPTION] [--idle_timeout_ms [IDLE_TIMEOUT_MS]]
             [--auto_shutdown [{true,false}]] [--labels LABELS [LABELS ...]]
             [--enable_public_ip [{true,false}]]
             [--block_project_ssh_keys [{true,false}]]
             [--bootstrap_shell_script_file_path [BOOTSTRAP_SHELL_SCRIPT_FILE_PATH]]
             [--cloud_env_id [CLOUD_ENV_ID]]
             [--object_storage_manager_id [OBJECT_STORAGE_MANAGER_ID]]
             [--hive_metastore_conf_id [HIVE_METASTORE_CONF_ID]]
             [--spark_infra_version_id SPARK_INFRA_VERSION_ID]
             [--cluster_conf_id [CLUSTER_CONF_ID]] [--conf CONF [CONF ...]]
             [--packages [PACKAGES]] [--repositories [REPOSITORIES]] [--jars [JARS]]
             [--archives [ARCHIVES]] [--files [FILES]] [--py-files [PY_FILES]]
             [--env_var ENV_VAR [ENV_VAR ...]]
             [--conf_secret CONF_SECRET [CONF_SECRET ...]]
             [--env_var_secret ENV_VAR_SECRET [ENV_VAR_SECRET ...]]
             [--max_parallel_spark_job_execution_per_instance [MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]]
             [--num_of_workers [NUM_OF_WORKERS]]
             [--min_instances [MIN_INSTANCES]] [--max_instances [MAX_INSTANCES]]
             [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide a specific cluster instance id to edit.
  --cluster_name CLUSTER_NAME
                        Provide a specific cluster instance name to edit.
  --name NAME           Provide name to edit a cluster instance.
  --description DESCRIPTION
                        Provide description to edit a cluster instance.
  --idle_timeout_ms [IDLE_TIMEOUT_MS]
                        Provide idle_timeout_ms to edit a cluster instance.
  --auto_shutdown [{true,false}]
                        Provide auto_shutdown to edit a cluster instance.
  --labels LABELS [LABELS ...]
                        Provide labels to edit a cluster instance.
  --enable_public_ip [{true,false}]
                        Provide enable_public_ip to edit a cluster instance.
  --block_project_ssh_keys [{true,false}]
                        Provide block_project_ssh_keys to edit a cluster instance.
  --bootstrap_shell_script_file_path [BOOTSTRAP_SHELL_SCRIPT_FILE_PATH]
                        Provide bootstrap_shell_script_file_path to edit a cluster instance.
  --cloud_env_id [CLOUD_ENV_ID]
                        Provide cloud_env_id to edit a cluster instance.
  --object_storage_manager_id [OBJECT_STORAGE_MANAGER_ID]
                        Provide object_storage_manager_id to edit a cluster instance.
  --hive_metastore_conf_id [HIVE_METASTORE_CONF_ID]
                        Provide hive_metastore_conf_id to edit a cluster instance.
  --spark_infra_version_id SPARK_INFRA_VERSION_ID
                        Provide spark_infra_version_id to edit a cluster instance.
  --cluster_conf_id [CLUSTER_CONF_ID]
                        Provide cluster_conf_id to edit a cluster instance.
  --conf CONF [CONF ...]
                        Provide conf to edit a cluster instance.
  --packages [PACKAGES]
                        Provide packages to edit a cluster instance.
  --repositories [REPOSITORIES]
                        Provide repositories to edit a cluster instance.
  --jars [JARS]         Provide jars to edit a cluster instance.
  --archives [ARCHIVES]
                        Provide archives to edit a cluster instance.
  --files [FILES]       Provide files to edit a cluster instance.
  --py-files [PY_FILES]
                        Provide py-files to edit a cluster instance.
  --env_var ENV_VAR [ENV_VAR ...]
                        Provide env_var to edit a cluster instance.
  --conf_secret CONF_SECRET [CONF_SECRET ...]
                        Provide conf_secret to edit a cluster instance.
  --env_var_secret ENV_VAR_SECRET [ENV_VAR_SECRET ...]
                        Provide env_var_secret to edit a cluster instance.
  --max_parallel_spark_job_execution_per_instance [MAX_PARALLEL_SPARK_JOB_EXECUTION_PER_INSTANCE]
                        Provide max_parallel_spark_job_execution_per_instance to edit a cluster instance.
  --num_of_workers [NUM_OF_WORKERS]
                        Provide num_of_workers to edit a cluster instance.
  --min_instances [MIN_INSTANCES]
                        Provide min_instances to edit a cluster instance.
  --max_instances [MAX_INSTANCES]
                        Provide max_instances to edit a cluster instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit example with one of the required '--cluster_id' argument and other optional argument is passed which is to be updated.
yeedu cluster edit --cluster_id=11 --idle_timeout_ms=600000
  • Console output
{
  "cluster_id": "11",
  "name": "yeedu_cluster_instance",
  "description": "Yeedu Instance",
  "cloud_env_id": "1",
  "idle_timeout_ms": "600000",
  "auto_shutdown": true,
  "labels": {
    "env": "test",
    "resource": "yeedu",
    "vm": "yeedu_node",
    "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44"
  },
  "is_spot_instance": false,
  "enable_public_ip": true,
  "block_project_ssh_keys": true,
  "bootstrap_shell_script": null,
  "object_storage_manager_id": "1",
  "cluster_conf_id": "1",
  "spark_config_id": "11",
  "hive_metastore_conf_id": null,
  "spark_infra_version_id": "2",
  "spark_config": {
    "conf": null,
    "packages": null,
    "repositories": null,
    "jars": null,
    "archives": null,
    "env_var": null,
    "conf_secret": null,
    "env_var_secret": null,
    "files": null,
    "py-files": null
  },
  "engine_cluster_spark_config": {
    "max_parallel_spark_job_execution_per_instance": 5
  },
  "cluster_type": "YEEDU",
  "min_instances": 1,
  "max_instances": 1,
  "tenant_id": "c5b2ade3-2385-4dbe-95d7-1fb4c373dc44",
  "created_by_user_id": "3",
  "modified_by_user_id": "3",
  "last_update_date": "2024-06-07T10:21:30.017Z",
  "from_date": "2024-06-07T10:07:58.902Z",
  "to_date": null
}

start​

yeedu cluster start -h
usage:  start [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
              [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster instance id to start a cluster instance.
  --cluster_name CLUSTER_NAME
                        Provide cluster instance name to start a cluster instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • start example with one of the required argument '--cluster_id' passed.
yeedu cluster start --cluster_id=1
  • Console output
{
  "CosiStart": {
    "workflow_job_id": 1,
    "workflow_job_instance_id": 1,
    "engine_cluster_instance_id": 1
  }
}

stop​

yeedu cluster stop -h
usage:  stop [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
             [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster instance id to stop a cluster instance.
  --cluster_name CLUSTER_NAME
                        Provide cluster instance name to stop a cluster instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • stop example with one of the required argument '--cluster_id' passed.
yeedu cluster stop --cluster_id=1
  • Console output
{
  "CosiStop": {
    "workflow_job_id": 1,
    "workflow_job_instance_id": 1,
    "engine_cluster_instance_id": 1
  }
}

destroy​

yeedu cluster destroy -h
usage:  destroy [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
                [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster instance id to destroy a cluster instance.
  --cluster_name CLUSTER_NAME
                        Provide cluster instance name to destroy a cluster instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • destroy example with one of the required argument '--cluster_id' passed.
yeedu cluster destroy --cluster_id=1
  • Console output
{
  "CosiDestroy": {
    "workflow_job_id": 1,
    "workflow_job_instance_id": 1,
    "engine_cluster_instance_id": 1
  }
}

get-stats​

yeedu cluster get-stats -h
usage:  get-stats [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
                  [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster instance id to get the spark job statistics of a
                        cluster instance.
  --cluster_name CLUSTER_NAME
                        Provide cluster instance name to get the spark job statistics of
                        a cluster instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-stats example with one of the optional arguments '--cluster_name' passed.
yeedu cluster get-stats --cluster_name="yeedu_cluster_instance"
  • Console output
{
  "SUBMITTED": 1,
  "RUNNING": 2,
  "DONE": 4,
  "ERROR": 0,
  "TERMINATED": 0,
  "STOPPING": 1,
  "STOPPED": 1,
  "TOTAL_JOB_COUNT": 9
}

list-status​

yeedu cluster list-status -h
usage:  list-status [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
                    [--page_number PAGE_NUMBER] [--limit LIMIT]
                    [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster id to list all the cluster instance status.
  --cluster_name CLUSTER_NAME
                        Provide cluster name to list all the cluster instance status.
  --page_number PAGE_NUMBER
                        To list the cluster instance status for a specific page_number.
                        (default: 1)
  --limit LIMIT         Provide limit to list number of cluster instance status.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-status example with one of the required argument '--cluster_id' and other optional argument passed.
yeedu cluster list-status --cluster_id=1 --limit=4
  • Console output
{
  "data": [
    {
      "cluster_status_id": 185,
      "cluster_status": "INITIATING",
      "current_node_size": 1,
      "created_by": "ysu0000@yeedu.io",
      "start_time": "2024-06-06T12:08:09.501317+00:00",
      "end_time": "infinity"
    },
    {
      "cluster_status_id": 164,
      "cluster_status": "STOPPED",
      "current_node_size": 0,
      "created_by": null,
      "start_time": "2024-06-03T13:41:13.403337+00:00",
      "end_time": "2024-06-06T12:08:09.577+00:00"
    },
    {
      "cluster_status_id": 163,
      "cluster_status": "STOPPING",
      "current_node_size": 0,
      "created_by": "ysu0001@yeedu.io",
      "start_time": "2024-06-03T13:39:52.903881+00:00",
      "end_time": "2024-06-03T13:41:13.403337+00:00"
    },
    {
      "cluster_status_id": 160,
      "cluster_status": "RUNNING",
      "current_node_size": 1,
      "created_by": null,
      "start_time": "2024-06-03T09:04:56.679352+00:00",
      "end_time": "2024-06-03T13:39:52.916+00:00"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 41,
    "total_pages": 11,
    "limit": 4,
    "next_page": 2
  }
}

stop-all-jobs​

yeedu cluster stop-all-jobs -h
usage:  stop-all-jobs [-h] --cluster_id CLUSTER_ID [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Specifies the ID of the cluster instance to stop all the jobs.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • stop-all-jobs example with the required argument '--cluster_id' passed.
yeedu cluster stop-all-jobs --cluster_id=1
  • Console output
{
  "CosiKillAllJobsByCluster": {
    "workflow_job_id": 0,
    "workflow_job_instance_id": 0,
    "engine_cluster_instance_id": 1,
    "created_by_user_id": 1
  }
}

list-errors​

yeedu cluster list-errors -h
usage:  list-errors [-h] [--cluster_id CLUSTER_ID]
                    [--cluster_status_id CLUSTER_STATUS_ID] [--page_number PAGE_NUMBER]
                    [--limit LIMIT] [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster id to list all the cluster errors.
  --cluster_status_id CLUSTER_STATUS_ID
                        Provide Cluster Status Id to list all the cluster errors.
  --page_number PAGE_NUMBER
                        To list all the cluster errors for a specific page_number.
                        (default: 1)
  --limit LIMIT         Provide limit to list number of cluster errors. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-errors example with one of the required argument '--cluster_id' passed.
yeedu cluster list-errors --cluster_id=1
  • Console output
{
  "error_code": "RFA-000043",
  "error_message": "No workflow instance errors found for the provided cluster instance id: 1."
}

logs​

yeedu cluster logs -h
usage:  logs [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
             [--log_type {stdout,stderr}] [--cluster_status_id CLUSTER_STATUS_ID]
             [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide Cluster Instance Id to download log records.
  --cluster_name CLUSTER_NAME
                        Provide Cluster Instance Name to download log records.
  --log_type {stdout,stderr}
                        Provide log_type to download Cluster Instance log records.
                        (default: stdout)
  --cluster_status_id CLUSTER_STATUS_ID
                        Provide Cluster Status Id to download log records.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • logs example with one of the required '--cluster_id' argument passed.
yeedu cluster logs --cluster_id=1
  • Console output
Initializing modules...
- local-node in module
- master-standalone-cluster in module
- standalone-node in module
- worker-standalone-cluster in module
Initializing the backend...

Successfully configured the backend "pg"! Terraform will automatically
use this backend unless the backend configuration changes.
Initializing provider plugins...
- Finding latest version of hashicorp/random...
- Finding latest version of hashicorp/template...
- Finding latest version of hashicorp/google...
- Installing hashicorp/template v2.2.0...
- Installed hashicorp/template v2.2.0 (signed by HashiCorp)
- Installing hashicorp/google v4.50.0...
- Installed hashicorp/google v4.50.0 (signed by HashiCorp)
- Installing hashicorp/random v3.4.3...
- Installed hashicorp/random v3.4.3 (signed by HashiCorp)
Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.
Terraform has been successfully initialized!

...

Apply complete! Resources: 3 added, 0 changed, 0 destroyed.

Outputs:
local-node-uuids = [
  {
    "instance_uuid" = tomap({
      "292a79d6-7967-3284-6e19-31aecf9977f4" = 0
    })
    "reserved_ip" = [
      "10.101.1.41",
    ]
  },
]
master-standalone-cluster-uuids = []
standalone-node-uuids = []
worker-standalone-cluster-uuids = []

Cluster Access Control​

Command NameUtility
associate-workspaceAssociate a cluster with a workspace.
dissociate-workspaceDissociate a cluster from a workspace.
list-workspacesList all workspaces associated with a cluster.
search-workspacesSearch workspaces associated with a cluster.
list-workspace-clustersList all clusters associated with a workspace.
search-workspace-clustersSearch clusters associated with a workspace.

associate-workspace​

yeedu cluster associate-workspace -h
usage:  associate-workspace [-h] --workspace_id WORKSPACE_ID --cluster_id CLUSTER_ID
                            [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to associate it with a cluster.
  --cluster_id CLUSTER_ID
                        Provide Cluster Id to to associate it with a workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • associate-workspace example with all the required arguments passed.
yeedu cluster associate-workspace --workspace_id=1 --cluster_id=1
  • Console output
{
  "workspace_id": "1",
  "cluster_id": "1",
  "created_by_user_id": "3",
  "modified_by_user_id": "3",
  "last_update_date": "2024-06-07T10:46:31.979Z",
  "from_date": "2024-06-07T10:46:31.979Z",
  "to_date": null
}

dissociate-workspace​

yeedu cluster dissociate-workspace -h
usage:  dissociate-workspace [-h] --workspace_id WORKSPACE_ID --cluster_id CLUSTER_ID
                             [--json-output [{pretty,default}]]
                             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to dissociate it with a cluster.
  --cluster_id CLUSTER_ID
                        Provide Cluster Id to dissociate it with a workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • dissociate-workspace example with all the required arguments passed.
yeedu cluster dissociate-workspace --workspace_id=1 --cluster_id=1
  • Console output
{
  "message": "Deleted Cluster and Workspace association successfully."
}

list-workspaces​

yeedu cluster list-workspaces -h
usage:  list-workspaces [-h] --cluster_id CLUSTER_ID [--page_number PAGE_NUMBER]
                        [--limit LIMIT] [--json-output [{pretty,default}]]
                        [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide Cluster Id to list all the associated workspaces.
  --page_number PAGE_NUMBER
                        To list Clusters for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Clusters. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-workspaces example with the required and optional arguments passed.
yeedu cluster list-workspaces --cluster_id=1 --limit=2
  • Console output
{
  "data": [
    {
      "workspace": {
        "workspace_id": 4,
        "name": "stopped_submitted_jobs",
        "description": ""
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test_cluster",
        "cluster_status": "INITIATING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp_cloud_env",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 2,
          "spark_docker_image_name": "v3.3.4-3",
          "spark_version": "3.3.4",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": false
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "created_by": {
        "user_id": 6,
        "username": "rt0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 6,
        "username": "rt0000@yeedu.io"
      },
      "last_update_date": "2024-05-31T12:56:02.641984+00:00",
      "from_date": "2024-05-31T12:56:02.641984+00:00",
      "to_date": "infinity"
    },
    {
      "workspace": {
        "workspace_id": 3,
        "name": "notebook_lock_workspace",
        "description": ""
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test_cluster",
        "cluster_status": "INITIATING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp_cloud_env",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 2,
          "spark_docker_image_name": "v3.3.4-3",
          "spark_version": "3.3.4",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": false
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "created_by": {
        "user_id": 4,
        "username": "rp0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 4,
        "username": "rp0000@yeedu.io"
      },
      "last_update_date": "2024-05-30T09:22:05.820297+00:00",
      "from_date": "2024-05-30T09:22:05.820297+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 4,
    "total_pages": 2,
    "limit": 2,
    "next_page": 2
  }
}

search-workspaces​

yeedu cluster search-workspaces -h
usage:  search-workspaces [-h] --cluster_id CLUSTER_ID --workspace_name [WORKSPACE_NAME]
                          [--page_number PAGE_NUMBER] [--limit LIMIT]
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide Cluster Id to list all the associated workspaces.
  --workspace_name [WORKSPACE_NAME]
                        Provide workspace name to search all the workspaces having access
                        to a cluster.
  --page_number PAGE_NUMBER
                        To list Clusters for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Clusters. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-workspaces example with all the required argument passed.
yeedu cluster search-workspaces --cluster_id=1 --workspace_name='_jobs' --limit=2
  • Console output
{
  "data": [
    {
      "workspace": {
        "workspace_id": 4,
        "name": "stopped_submitted_jobs",
        "description": ""
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test_cluster",
        "cluster_status": "INITIATING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp_cloud_env",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 2,
          "spark_docker_image_name": "v3.3.4-3",
          "spark_version": "3.3.4",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": false
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "created_by": {
        "user_id": 6,
        "username": "rt0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 6,
        "username": "rt0000@yeedu.io"
      },
      "last_update_date": "2024-05-31T12:56:02.641984+00:00",
      "from_date": "2024-05-31T12:56:02.641984+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 2
  }
}

list-workspace-clusters​

yeedu cluster list-workspace-clusters -h
usage:  list-workspace-clusters [-h] --workspace_id WORKSPACE_ID
                                [--cluster_status [CLUSTER_STATUS]]
                                [--job_type [{SPARK_JOB,SPARK_SQL,NOTEBOOK}]]
                                [--page_number PAGE_NUMBER] [--limit LIMIT]
                                [--json-output [{pretty,default}]]
                                [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to list all the associated clusters.
  --cluster_status [CLUSTER_STATUS]
                        Provide Cluster Instance Status from ["INITIATING", "RUNNING",
                        "STOPPING", "STOPPED", "DESTROYING", "DESTROYED", "ERROR",
                        "RESIZING_UP", "RESIZING_DOWN"] to list, For example
                        --cluster_status="RUNNING,DESTROYED".
  --job_type [{SPARK_JOB,SPARK_SQL,NOTEBOOK}]
                        To list Clusters for a specific job_type.
  --page_number PAGE_NUMBER
                        To list Clusters for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Clusters. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-workspace-clusters example with all the required arguments passed.
yeedu cluster list-workspace-clusters --workspace_id=1
  • Console output
{
  "data": [
    {
      "workspace": {
        "workspace_id": 1,
        "name": "notebook_workspace",
        "description": ""
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test_cluster",
        "cluster_status": "INITIATING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp_cloud_env",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 2,
          "spark_docker_image_name": "v3.3.4-3",
          "spark_version": "3.3.4",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": false
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "created_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "last_update_date": "2024-06-07T10:51:22.247082+00:00",
      "from_date": "2024-06-07T10:51:22.247082+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-workspace-clusters​

yeedu cluster search-workspace-clusters -h
usage:  search-workspace-clusters [-h] --workspace_id WORKSPACE_ID
                                  [--cluster_name [CLUSTER_NAME]]
                                  [--cluster_status [CLUSTER_STATUS]]
                                  [--job_type [{SPARK_JOB,SPARK_SQL,NOTEBOOK}]]
                                  [--page_number PAGE_NUMBER] [--limit LIMIT]
                                  [--json-output [{pretty,default}]]
                                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to search all the associated clusters.
  --cluster_name [CLUSTER_NAME]
                        Provide cluster name to search all the associated workspace
                        clusters.
  --cluster_status [CLUSTER_STATUS]
                        Provide cluster instance status from ["INITIATING", "RUNNING",
                        "STOPPING", "STOPPED", "DESTROYING", "DESTROYED", "ERROR",
                        "RESIZING_UP", "RESIZING_DOWN"] to search, for example
                        --cluster_status="RUNNING,DESTROYED".
  --job_type [{SPARK_JOB,SPARK_SQL,NOTEBOOK}]
                        To search clusters of a specific job_type.
  --page_number PAGE_NUMBER
                        To search clusters for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of clusters. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-confs example with required argument '--cluster_conf_name' passed.
yeedu cluster search-workspace-clusters --workspace_id=1 --cluster_name="yeedu_"
  • Console output
{
  "data": [
    {
      "workspace": {
        "workspace_id": 1,
        "name": "notebook_workspace",
        "description": ""
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test_cluster",
        "cluster_status": "INITIATING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp_cloud_env",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 2,
          "spark_docker_image_name": "v3.3.4-3",
          "spark_version": "3.3.4",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": false
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "created_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "modified_by": {
        "user_id": 3,
        "username": "ysu0000@yeedu.io"
      },
      "last_update_date": "2024-06-07T10:51:22.247082+00:00",
      "from_date": "2024-06-07T10:51:22.247082+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

Workspace

Command NameUtility
createCreate a new workspace.
listList all available workspaces.
searchSearch for workspaces by name.
getGet details of a specific workspace.
editModify details of a specific workspace.
enableEnable a specific workspace.
disableDisable a specific workspace.
exportExport a specific workspace.
importImport a specific workspace.

create​

yeedu workspace create -h
usage:  create [-h] [--name NAME] [--description DESCRIPTION]
               [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create workspace.
  --description DESCRIPTION
                        Provide description to create workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create example with all the required arguments passed.
yeedu workspace create --name="spark_jobs_test" --description="Test Spark Jobs"
  • Console output
{
  "workspace_id": "1",
  "name": "spark_jobs_test",
  "description": "Test Spark Jobs",
  "tenant_id": "59608f6e-cb14-4687-98dc-e0f80e608f05",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-13T09:50:32.306Z",
  "from_date": "2024-06-13T09:50:32.306Z",
  "to_date": null
}

list​

  yeedu workspace list -h
usage:  list [-h] [--enable [{true,false}]] [--page_number PAGE_NUMBER] [--limit LIMIT]
             [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --enable [{true,false}]
                        Provide enable as true or false to list Workspaces.
  --page_number PAGE_NUMBER
                        To list Workspaces for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Workspaces. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list example with optional arguments passed.
yeedu workspace list --limit=1 --page_number=1
  • Console output
{
  "data": [
    {
      "workspace_id": 3,
      "name": "spark_jobs_test",
      "job_conf_count": 0,
      "notebook_conf_count": 0,
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "tenant_id": "59608f6e-cb14-4687-98dc-e0f80e608f05",
      "last_update_date": "2024-06-13T09:50:32.306341+00:00",
      "from_date": "2024-06-13T09:50:32.306341+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 3,
    "total_pages": 3,
    "limit": 1,
    "next_page": 2
  }
}

search​

yeedu workspace search -h
usage:  search [-h] --workspace_name WORKSPACE_NAME
               [--enable [{true,false}]] [--page_number PAGE_NUMBER]
               [--limit LIMIT] [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_name WORKSPACE_NAME
                        Provide workspace name to search workspaces.
  --enable [{true,false}]
                        Provide enable as true or false to search workspaces.
  --page_number PAGE_NUMBER
                        To search workspaces for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of workspaces. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search example with the required argument passed.
yeedu workspace search --workspace_name="spark_"
  • Console output
{
  "data": [
    {
      "workspace_id": 3,
      "name": "spark_jobs_test",
      "job_conf_count": 0,
      "notebook_conf_count": 0,
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "tenant_id": "59608f6e-cb14-4687-98dc-e0f80e608f05",
      "last_update_date": "2024-06-13T09:50:32.306341+00:00",
      "from_date": "2024-06-13T09:50:32.306341+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get​

yeedu workspace get -h
usage:  get [-h] [--workspace_id WORKSPACE_ID]
            [--workspace_name WORKSPACE_NAME]
            [--json-output [{pretty,default}]]
            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to get information about a specific Workspace.
  --workspace_name WORKSPACE_NAME
                        Provide workspace_name to get information about a specific Workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get example with any one of the required argument passed.
yeedu workspace get --workspace_id=1
  • Console output
{
  "workspace_id": 3,
  "name": "spark_jobs_test",
  "description": "Test Spark Jobs",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "tenant_id": "59608f6e-cb14-4687-98dc-e0f80e608f05",
  "last_update_date": "2024-06-13T09:50:32.306341+00:00",
  "from_date": "2024-06-13T09:50:32.306341+00:00",
  "to_date": "infinity"
}

get-stats​

yeedu workspace get-stats -h
usage:  get-stats [-h] [--workspace_id WORKSPACE_ID] [--workspace_name WORKSPACE_NAME]
                  [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Specifies the ID of the workspace to retrieve stats.
  --workspace_name WORKSPACE_NAME
                        Specifies the name of the workspace to retrieve stats.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • get-stats example with any one of the required argument passed.
yeedu workspace get-stats --workspace_id=1
  • Console output
{
  "SUBMITTED": 1,
  "RUNNING": 2,
  "DONE": 4,
  "ERROR": 0,
  "TERMINATED": 0,
  "STOPPING": 1,
  "STOPPED": 1,
  "TOTAL_JOB_COUNT": 9
}

edit​

yeedu workspace edit -h
usage:  edit [-h] [--workspace_id WORKSPACE_ID]
             [--workspace_name WORKSPACE_NAME] [--name NAME]
             [--description DESCRIPTION]
             [--json-output [{pretty,default}]]
             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to edit a specific Workspace.
  --workspace_name WORKSPACE_NAME
                        Provide workspace_name to edit a specific Workspace.
  --name NAME           Provide name to edit a specific Workspace.
  --description DESCRIPTION
                        Provide description to edit a specific Workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit example with any one of the required argument '--workspace_id' and other optional argument is passed which is to be updated.
yeedu workspace edit --workspace_id=1 --description="Test Spark Curation Jobs"
  • Console output
{
  "workspace_id": "1",
  "name": "spark_jobs_test",
  "description": "Test Spark Curation Jobs",
  "tenant_id": "59608f6e-cb14-4687-98dc-e0f80e608f05",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-13T10:12:51.975Z",
  "from_date": "2024-06-13T09:50:32.306Z",
  "to_date": null
}

enable​

yeedu workspace enable -h
usage:  enable [-h] [--workspace_id WORKSPACE_ID]
               [--workspace_name WORKSPACE_NAME]
               [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to enable a specific Workspace.
  --workspace_name WORKSPACE_NAME
                        Provide workspace_name to enable a specific Workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • enable example with any one of the required argument passed.
yeedu workspace enable --workspace_id=1
  • Console output
{
  "workspace_id": "1",
  "name": "spark_jobs_test",
  "description": "Test Spark Curation Jobs",
  "tenant_id": "59608f6e-cb14-4687-98dc-e0f80e608f05",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-13T10:15:13.222Z",
  "from_date": "2024-06-13T09:50:32.306Z",
  "to_date": null
}

disable​

yeedu workspace disable -h
usage:  disable [-h] [--workspace_id WORKSPACE_ID]
                [--workspace_name WORKSPACE_NAME]
                [--json-output [{pretty,default}]]
                [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to disable a specific Workspace.
  --workspace_name WORKSPACE_NAME
                        Provide workspace_name to disable a specific Workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • disable example with any one of the required argument passed.
yeedu workspace disable --workspace_id=1
  • Console output
{
  "workspace_id": "1",
  "name": "spark_jobs_test",
  "description": "Test Spark Curation Jobs",
  "tenant_id": "59608f6e-cb14-4687-98dc-e0f80e608f05",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-13T10:14:43.906Z",
  "from_date": "2024-06-13T09:50:32.306Z",
  "to_date": "2024-06-13T10:14:43.906Z"
}

export​

yeedu workspace export -h
usage:  export [-h] [--workspace_id WORKSPACE_ID] [--workspace_name WORKSPACE_NAME]
               [--enable [{true,false}]] [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to export a specific workspace.
  --workspace_name WORKSPACE_NAME
                        Provide workspace name to export a specific workspace.
  --enable [{true,false}]
                        Provide enable to export active job and notebook configurations
                        of a specific workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • export example with any one of the required argument passed.
yeedu workspace export --workspace_id=1
  • Console output
{
  "jobs": [
    {
      "name": "yeedu_test_job",
      "spark_job_type": {
        "job_type": "SPARK_JOB",
        "language": "Jar"
      },
      "cluster_info": {
        "cluster_name": "aws_test_cluster",
        "cluster_type": "YEEDU"
      },
      "max_concurrency": 0,
      "files": [],
      "properties_file": null,
      "conf": [],
      "packages": [],
      "repositories": [],
      "jars": [],
      "archives": [],
      "driver_memory": null,
      "driver_java_options": "-Dderby.system.home=/yeedu/spark_metastores/1721298078-74183",
      "driver_library_path": null,
      "driver_class_path": null,
      "executor_memory": null,
      "principal": null,
      "keytab": null,
      "queue": null,
      "job_class_name": "org.apache.spark.examples.SparkPi",
      "job_command": "/opt/spark/examples/jars/spark-examples_2.12-3.2.2.jar",
      "job_arguments": "10000",
      "job_rawScalaCode": null,
      "job_timeout_min": 5,
      "driver_cores": null,
      "total_executor_cores": null,
      "executor_cores": null,
      "num_executors": null
    },
    .....
    {
      "name": "yeedu_test_job_n",
      "spark_job_type": {
        "job_type": "SPARK_JOB",
        "language": "Jar"
      },
      "cluster_info": {
        "cluster_name": "yeedu_cluster_instance",
        "cluster_type": "YEEDU"
      },
      "max_concurrency": 0,
      "files": [],
      "properties_file": null,
      "conf": [],
      "packages": [],
      "repositories": [],
      "jars": [],
      "archives": [],
      "driver_memory": null,
      "driver_java_options": null,
      "driver_library_path": null,
      "driver_class_path": null,
      "executor_memory": null,
      "principal": null,
      "keytab": null,
      "queue": null,
      "job_class_name": "org.apache.spark.examples.SparkPi",
      "job_command": "/opt/spark/examples/jars/spark-examples_2.12-3.2.2.jar",
      "job_arguments": "10",
      "job_rawScalaCode": null,
      "job_timeout_min": null,
      "driver_cores": null,
      "total_executor_cores": null,
      "executor_cores": null,
      "num_executors": null
    }
  ],
  "notebooks": [
    {
      "name": "test_notebook_1",
      "spark_job_type": {
        "job_type": "NOTEBOOK",
        "language": "Python3"
      },
      "cluster_info": {
        "cluster_name": "gcp_cluster",
        "cluster_type": "YEEDU"
      },
      "notebook_cells": {
        "cells": [
          {
            "code": "print(\"hello\")",
            "cell_uuid": "f98e6834-09e2-4c59-84d6-130769c9d182"
          }
        ]
      },
      "conf": [],
      "packages": [],
      "jars": [],
      "files": [],
      "driver_memory": null,
      "executor_memory": null,
      "driver_cores": null,
      "total_executor_cores": null,
      "executor_cores": null,
      "num_executors": null
    },
    ......
    {
      "name": "test_notebook_n",
      "spark_job_type": {
        "job_type": "NOTEBOOK",
        "language": "Python3"
      },
      "cluster_info": null,
      "notebook_cells": {
        "cells": [
          {
            "code": "",
            "cell_uuid": "a894a53f-391a-4c10-8f4f-6ea72ae1f1af"
          }
        ]
      },
      "conf": [],
      "packages": [],
      "jars": [],
      "files": [],
      "driver_memory": null,
      "executor_memory": null,
      "driver_cores": null,
      "total_executor_cores": null,
      "executor_cores": null,
      "num_executors": null
    }
  ]
}

import​

yeedu workspace import -h
usage:  import [-h] [--workspace_id WORKSPACE_ID]
               [--workspace_name WORKSPACE_NAME]
               [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
               [--permissive [{true,false}]]
               [--overwrite [{true,false}]] --file_path FILE_PATH
               [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to import a specific
                        workspace to it.
  --workspace_name WORKSPACE_NAME
                        Provide workspace name to import a specific
                        workspace.
  --cluster_id CLUSTER_ID
                        Provide cluster instance id to attach with job
                        configurations in the workspace to be
                        imported.
  --cluster_name CLUSTER_NAME
                        Provide cluster instance name to attach with
                        job configurations in the workspace to be
                        imported.
  --permissive [{true,false}]
                        Provide permissive option for partial imports
                        when encountering errors. (default: false)
  --overwrite [{true,false}]
                        Provide overwrite option to override any
                        existsing workspace. (default: false)
  --file_path FILE_PATH
                        Provide file path from where a specific
                        workspace is to be imported.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default:
                        pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set
                        to 'true'. (default: false)
  • import example with any one of the required argument passed.
yeedu workspace import --workspace_id=1 --file_path='/home/user/workspace.yeedu'
  • Console output
{
  "message": "All job configurations were successfully imported. All notebook configurations were successfully imported.",
  "job_conf_details": {
    "successful_imports": [
      {
        "message": "The job: 'yeedu_test_job' of type: 'SPARK_JOB' is overwritten and imported successfully.",
        "warnings": [
          "The file path specified in 'job_command': '/opt/spark/examples/jars/spark-examples_2.12-3.2.2.jar' does not exist in the object storage manager of cluster ID: 13."
        ]
      },
      .....
      {
        "message": "The job: 'yeedu_test_job_n' of type: 'SPARK_JOB' is overwritten and imported successfully."
      }
    ]
  },
  "notebook_conf_details": {
    "successful_imports": [
      {
        "message": "The notebook: 'yeedu_test_notebook' of type: 'NOTEBOOK' is overwritten and imported successfully.",
        "warnings": [
          "The cluster was not attached, and Spark parameters were ignored because the cluster name: 'gcp_cluster' was not found or has been destroyed."
        ]
      },
      ....
      {
        "message": "The notebook: 'yeedu_test_notebook_n' of type: 'NOTEBOOK' is overwritten and imported successfully.",
        "warnings": [
          "The cluster was not attached, and Spark parameters were ignored because no cluster was provided."
        ]
      }
    ]
  }
}

Workspace Access Control​

Command NameUtility
create-user-accessAssign access to a user on a specific workspace
create-group-accessAssign access to a group on a specific workspace
delete-user-accessDelete access of a user on a specific workspace
delete-group-accessDelete access of a group on a specific workspace
list-usersTo list users who have no permissions in a workspace.
search-usersTo search for users by username who have no permissions in a workspace.
match-userTo match the exact username having access to a workspace.
list-groupsTo list groups who have no permissions in a workspace.
search-groupsTo search for groups by groupname who have no permissions in a workspace.
match-groupTo match the exact groupname having access to a workspace.
get-user-accessTo get the permission of the user having access to a workspace.
get-group-accessTo get the permission of the group having access to a workspace.
list-users-accessTo list all the permissions of the users having access to a workspace.
search-users-accessTo search all the users for the provided username having access to a workspace.
list-groups-accessTo list all the permissions of the groups having access to a workspace.
search-groups-accessTo search all the groups for the provided groupname having access to a workspace.

create-user-access​

  yeedu workspace create-user-access -h
usage:  create-user-access [-h] --workspace_id WORKSPACE_ID --user_id
                           USER_ID --permission_id PERMISSION_ID
                           [--json-output [{pretty,default}]]
                           [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to assign user access on a workspace.
  --user_id USER_ID     Provide User Id to assign user access on a workspace.
  --permission_id PERMISSION_ID
                        Provide Permission Id to assign user access on a workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default:pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-user-access example with all the required arguments passed.
yeedu workspace create-user-access --workspace_id=1 --user_id=1 --permission_id=2
  • Console output
{
  "auth_workspace_user_id": "2",
  "workspace_id": "1",
  "auth_workspace_perm_id": 2,
  "user_id": "1",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-13T11:33:08.443Z",
  "from_date": "2024-06-13T11:33:08.443Z",
  "to_date": null
}

create-group-access​

yeedu workspace create-group-access -h
usage:  create-group-access [-h] --workspace_id WORKSPACE_ID
                            --group_id GROUP_ID --permission_id
                            PERMISSION_ID
                            [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to assign group access on a workspace.
  --group_id GROUP_ID   Provide group Id to assign group access on a workspace.
  --permission_id PERMISSION_ID
                        Provide Permission Id to assign group access on a workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-group-access example with optional arguments passed.
yeedu workspace create-group-access --workspace_id=1 --group_id=1 --permission_id=2
  • Console output
{
  "auth_workspace_group_id": "1",
  "workspace_id": "1",
  "auth_workspace_perm_id": 2,
  "group_id": "1",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-13T11:34:14.175Z",
  "from_date": "2024-06-13T11:34:14.175Z",
  "to_date": null
}

delete-user-access​

yeedu workspace delete-user-access -h
usage:  delete-user-access [-h] --workspace_id WORKSPACE_ID --user_id USER_ID
                           --permission_id PERMISSION_ID
                           [--json-output [{pretty,default}]]
                           [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to delete user access on a workspace.
  --user_id USER_ID     Provide User Id to delete user access on a workspace.
  --permission_id PERMISSION_ID
                        Provide Permission Id to delete user access on a workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-user-access example with the required argument passed.
yeedu workspace delete-user-access --workspace_id=1 --user_id=1 --permission_id=2
  • Console output
{
  "message": "Deleted Permission successfully."
}

delete-group-access​

yeedu workspace delete-group-access -h
usage:  delete-group-access [-h] --workspace_id WORKSPACE_ID --group_id GROUP_ID
                            --permission_id PERMISSION_ID
                            [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to delete group access on a workspace.
  --group_id GROUP_ID   Provide group Id to delete group access on a workspace.
  --permission_id PERMISSION_ID
                        Provide Permission Id to delete group access on a workspace.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-group-access example with all the required arguments passed.
yeedu workspace delete-group-access --workspace_id=1 --group_id=1 --permission_id=2
  • Console output
{
  "message": "Deleted Permission successfully."
}

list-users​

yeedu workspace list-users -h
usage:  list-users [-h] --workspace_id WORKSPACE_ID [--page_number PAGE_NUMBER]
                   [--limit LIMIT] [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to list all the users.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-users example with the required argument '--workspace_id' passed.
yeedu workspace list-users --workspace_id=1
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "display_name": "YSU0000",
      "email": "ysu0000@yeedu.com"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-users​

yeedu workspace search-users -h
usage:  search-users [-h] --workspace_id WORKSPACE_ID --username USERNAME
                     [--page_number PAGE_NUMBER] [--limit LIMIT]
                     [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to search all the users.
  --username USERNAME   Provide username to search all the users.
  --page_number PAGE_NUMBER
                        To search users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search example with the required argument passed.
yeedu workspace search-users --workspace_id=1 --username="YSU"
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "display_name": "YSU0000",
      "email": "ysu0000@yeedu.com"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

match-user​

yeedu workspace match-user -h
usage:  match-user [-h] --workspace_id WORKSPACE_ID --username USERNAME
                   [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to match all the users.
  --username USERNAME   Provide username to match all the users.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • match example with the required argument passed.
yeedu workspace match-user --workspace_id=1 --username="YSU0000"
  • Console output
{
  "user_id": 1,
  "username": "YSU0000",
  "display_name": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

list-groups​

yeedu workspace list-groups -h
usage:  list-groups [-h] --workspace_id WORKSPACE_ID [--page_number PAGE_NUMBER]
                    [--limit LIMIT] [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to list all the groups.
  --page_number PAGE_NUMBER
                        To list groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-groups example with the required argument '--workspace_id' passed.
yeedu workspace list-groups --workspace_id=1 --limit=1
  • Console output
{
  "data": [
    {
      "group_id": 2,
      "group_name": "Yeedu",
      "group_type": "DynamicMembership",
      "from_date": "2023-12-28T14:01:50.367429+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 13,
    "total_pages": 13,
    "limit": 1,
    "next_page": 2
  }
}

search-groups​

yeedu workspace search-groups -h
usage:  search-groups [-h] --workspace_id WORKSPACE_ID --groupname GROUPNAME
                      [--page_number PAGE_NUMBER] [--limit LIMIT]
                      [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to search all the groups.
  --groupname GROUPNAME
                        Provide groupname to search all the groups.
  --page_number PAGE_NUMBER
                        To search groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search example with the required argument passed.
yeedu workspace search-groups --workspace_id=1 --groupname="Yeedu"
  • Console output
{
  "data": [
    {
      "group_id": 7,
      "group_name": "Yeedu",
      "group_type": null,
      "from_date": "2023-12-28T14:01:50.367429+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 11,
      "group_name": "Yeedu Dev_Team",
      "group_type": null,
      "from_date": "2023-12-28T14:01:50.367429+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 25,
      "group_name": "Yeedu_Backend",
      "group_type": null,
      "from_date": "2024-01-02T09:19:25.770823+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 3,
    "total_pages": 1,
    "limit": 100
  }
}

match-group​

yeedu workspace match-group -h
usage:  match-group [-h] --workspace_id WORKSPACE_ID --groupname GROUPNAME
                    [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to match all the groups.
  --groupname GROUPNAME
                        Provide groupname to match all the groups.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • match example with the required argument passed.
yeedu workspace match-group --workspace_id=1 --groupname="Yeedu"
  • Console output
[
  {
    "group_id": 8,
    "group_name": "Yeedu",
    "group_type": "Unified",
    "from_date": "2023-12-28T14:01:50.367429+00:00",
    "to_date": "infinity"
  },
  {
    "group_id": 7,
    "group_name": "Yeedu",
    "group_type": null,
    "from_date": "2023-12-28T14:01:50.367429+00:00",
    "to_date": "infinity"
  }
]

get-user-access​

yeedu workspace get-user-access -h
usage:  get-user-access [-h] --workspace_id WORKSPACE_ID --user_id USER_ID
                        [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to get the permission of a user.
  --user_id USER_ID     Provide User Id to get the permission of a user.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-user-access example with all the required arguments passed.
yeedu workspace get-user-access --workspace_id=1 --user_id=1
  • Console output
{
  "user_id": "1",
  "username": "YSU0000",
  "workspace": {
    "workspace_id": "1",
    "name": "spark_jobs_test",
    "description": "Test Spark Curation Jobs"
  },
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "user_permission": {
    "auth_workspace_user_id": 3,
    "permission": {
      "auth_workspace_perm_id": 2,
      "name": "EDIT",
      "description": "To list, run and edit a spark job configuration in a workspace"
    },
    "created_by": {
      "user_id": 1,
      "username": "YSU0000"
    },
    "modified_by": {
      "user_id": 1,
      "username": "YSU0000"
    },
    "last_update_date": "2024-06-13T11:59:27.373872+00:00",
    "from_date": "2024-06-13T11:59:27.373872+00:00",
    "to_date": "infinity"
  },
  "group_permission": [
    {
      "auth_workspace_group_id": 2,
      "permission": {
        "auth_workspace_perm_id": 2,
        "name": "EDIT",
        "description": "To list, run and edit a spark job configuration in a workspace"
      },
      "group_id": 1,
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-13T12:01:10.81785+00:00",
      "from_date": "2024-06-13T12:01:10.81785+00:00",
      "to_date": "infinity"
    }
  ]
}

get-group-access​

yeedu workspace get-group-access -h
usage:  get-group-access [-h] --workspace_id WORKSPACE_ID --group_id GROUP_ID
                         [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to get the permission of a group.
  --group_id GROUP_ID   Provide Group Id to get the permission of a group.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-group-access example with all the required arguments passed.
yeedu workspace get-group-access --workspace_id=1 --group_id=1
  • Console output
{
  "group_id": "1",
  "group_name": "yeedu-manager",
  "workspace": {
    "workspace_id": "1",
    "name": "spark_jobs_test",
    "description": "Test Spark Curation Jobs"
  },
  "tenant_id": "e67f00ad-68aa-46d0-b32e-f3f8dac5427d",
  "group_permission": {
    "auth_workspace_group_id": "1",
    "permission": {
      "auth_workspace_perm_id": 2,
      "name": "EDIT",
      "description": "To list, run and edit a spark job configuration in a workspace"
    },
    "created_by": {
      "user_id": "1",
      "username": "YSU0000"
    },
    "modified_by": {
      "user_id": "1",
      "username": "YSU0000"
    },
    "last_update_date": "2024-01-08T14:00:26.953Z",
    "from_date": "2024-01-08T14:00:26.953Z",
    "to_date": null
  }
}

list-users-access​

yeedu workspace list-users-access -h
usage:  list-users-access [-h] --workspace_id WORKSPACE_ID
                          [--permission_id PERMISSION_ID] [--page_number PAGE_NUMBER]
                          [--limit LIMIT] [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Specifies the ID of the workspace to retrieve users from.
  --permission_id PERMISSION_ID
                        Specifies the ID of the permission to retrieve users.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-users-access example with the required argument '--workspace_id' passed.
yeedu workspace list-users-access --workspace_id=1
  • Console output
{
  "data": {
    "workspace_id": 1,
    "workspace_name": "yeedu_workspace",
    "description": null,
    "users": [
      {
        "user_id": 50,
        "username": "yeedu@yeedu.io",
        "email": "yeedu@yeedu.io",
        "display_name": "Yeedu",
        "permission": {
          "permission_id": 3,
          "name": "MANAGE",
          "description": "To list jobs, run jobs, edit Spark job configurations, and manage workspace access by adding or removing permissions"
        }
      },
      ...
      {
        "user_id": 1,
        "username": "yeedu.test@yeedu.io",
        "email": "yeedu-test@yeedu.io",
        "display_name": "Yeedu Test",
        "permission": {
          "permission_id": 2,
          "name": "EDIT",
          "description": "To list, run and edit a spark job configuration in a workspace"
        }
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 50,
    "total_pages": 1,
    "limit": 100
  }
}

search-users-access​

yeedu workspace search-users-access -h
usage:  search-users-access [-h] --workspace_id WORKSPACE_ID --username USERNAME
                            [--permission_id PERMISSION_ID] [--page_number PAGE_NUMBER]
                            [--limit LIMIT] [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Specifies the ID of the workspace to search users from.
  --username USERNAME   Specifies username to retrieve users.
  --permission_id PERMISSION_ID
                        Specifies the ID of the permission to retrieve users.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search-users-access example with the required argument '--workspace_id' and '--username' passed.
yeedu workspace search-users-access --workspace_id=1 --username='yeedu'
  • Console output
{
  "data": {
    "workspace_id": 1,
    "workspace_name": "yeedu_workspace",
    "description": null,
    "users": [
      {
        "user_id": 1,
        "username": "yeedu@yeedu.io",
        "email": "yeedu@yeedu.io",
        "display_name": "Yeedu",
        "permission": {
          "permission_id": 3,
          "name": "MANAGE",
          "description": "To list jobs, run jobs, edit Spark job configurations, and manage workspace access by adding or removing permissions"
        }
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

list-groups-access​

yeedu workspace list-groups-access -h
usage:  list-groups-access [-h] --workspace_id WORKSPACE_ID
                           [--permission_id PERMISSION_ID] [--page_number PAGE_NUMBER]
                           [--limit LIMIT] [--json-output [{pretty,default}]]
                           [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Specifies the ID of the workspace to list groups from.
  --permission_id PERMISSION_ID
                        Specifies the ID of the permission to retrieve groups.
  --page_number PAGE_NUMBER
                        To list groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-groups-access example with the required argument '--workspace_id' passed.
yeedu workspace list-groups-access --workspace_id=1
  • Console output
{
  "data": {
    "workspace_id": 1,
    "workspace_name": "yeed_workspace",
    "description": null,
    "groups": [
      {
        "group_id": 1,
        "group_name": "Yeedu Dev",
        "group_mail": yeedu-dev@yeedu.io,
        "group_object_id": "bbdfd7a7-d0d3-4f32-8d7c-c33a1292222",
        "group_type": null,
        "permission": {
          "permission_id": 2,
          "name": "EDIT",
          "description": "To list, run and edit a spark job configuration in a workspace"
        }
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-groups-access​

yeedu workspace search-groups-access -h
usage:  search-groups-access [-h] --workspace_id WORKSPACE_ID --groupname GROUPNAME
                             [--permission_id PERMISSION_ID] [--page_number PAGE_NUMBER]
                             [--limit LIMIT] [--json-output [{pretty,default}]]
                             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Specifies the ID of the workspace to search groups from.
  --groupname GROUPNAME
                        Specifies groupname to retrieve groups.
  --permission_id PERMISSION_ID
                        Specifies the ID of the permission to retrieve groups.
  --page_number PAGE_NUMBER
                        To list groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-groups-access example with the required argument '--workspace_id' passed.
yeedu workspace search-groups-access --workspace_id=1 --groupname="Yeedu"
  • Console output
{
  "data": {
    "workspace_id": 1,
    "workspace_name": "yeed_workspace",
    "description": null,
    "groups": [
      {
        "group_id": 1,
        "group_name": "Yeedu Dev",
        "group_mail": yeedu-dev@yeedu.io,
        "group_object_id": "bbdfd7a7-d0d3-4f32-8d7c-c33a1292222",
        "group_type": null,
        "permission": {
          "permission_id": 2,
          "name": "EDIT",
          "description": "To list, run and edit a spark job configuration in a workspace"
        }
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

Job

Spark Job Configuration​

Command NameUtility
create-confTo create the Spark Job Configuration.
list-confsTo list all the available Job Configurations.
search-confsTo search job configurations by job conf name in a workspace.
get-confTo get the information about a specific Spark Job Configuration.
edit-confTo edit the Spark Job Configuration.
enable-confTo enable a specific Spark Job Configuration.
disable-confTo disable a specific Spark Job Configuration.
exportExport a specific Spark Job Configuration.

create-conf​

yeedu job create-conf -h
usage:  create-conf [-h] [--cluster_id CLUSTER_ID] [--cluster_name CLUSTER_NAME]
                    --workspace_id WORKSPACE_ID --name NAME [--files [FILES]]
                    [--properties-file [PROPERTIES_FILE]] [--conf CONF [CONF ...]]
                    [--packages [PACKAGES]] [--repositories [REPOSITORIES]] [--jars [JARS]]
                    [--archives [ARCHIVES]] [--driver-memory [DRIVER_MEMORY]]
                    [--driver-java-options [DRIVER_JAVA_OPTIONS]]
                    [--driver-library-path [DRIVER_LIBRARY_PATH]]
                    [--driver-class-path [DRIVER_CLASS_PATH]]
                    [--executor-memory [EXECUTOR_MEMORY]] [--driver-cores [DRIVER_CORES]]
                    [--total-executor-cores [TOTAL_EXECUTOR_CORES]]
                    [--executor-cores [EXECUTOR_CORES]] [--num-executors [NUM_EXECUTORS]]
                    [--principal [PRINCIPAL]] [--keytab [KEYTAB]] [--queue [QUEUE]]
                    [--job-class-name [JOB_CLASS_NAME]] [--job-command [JOB_COMMAND]]
                    [--job-arguments [JOB_ARGUMENTS]]
                    [--job-raw-scala-code JOB_RAW_SCALA_CODE] --job-type
                    {RAW_SCALA,Jar,Python3,SQL,THRIFT_SQL}
                    [--job-timeout-min JOB_TIMEOUT_MIN] [--max_concurrency MAX_CONCURRENCY]
                    [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --cluster_id CLUSTER_ID
                        Provide cluster_id to create a Spark Job Configuration.
  --cluster_name CLUSTER_NAME
                        Provide cluster_name to create a Spark Job Configuration.
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to create a Spark Job Configuration.
  --name NAME           Provide name to create a Spark Job Configuration.
  --files [FILES]       Provide files to create a Spark Job Configuration.
  --properties-file [PROPERTIES_FILE]
                        Provide properties-file to create a Spark Job Configuration.
  --conf CONF [CONF ...]
                        Provide conf to create a Spark Job Configuration.
  --packages [PACKAGES]
                        Provide packages to create a Spark Job Configuration.
  --repositories [REPOSITORIES]
                        Provide repositories to create a Spark Job Configuration.
  --jars [JARS]         Provide jars to create a Spark Job Configuration.
  --archives [ARCHIVES]
                        Provide archives to create a Spark Job Configuration.
  --driver-memory [DRIVER_MEMORY]
                        Provide driver-memory to create a Spark Job Configuration.
  --driver-java-options [DRIVER_JAVA_OPTIONS]
                        Provide driver-java-options to create a Spark Job Configuration.
  --driver-library-path [DRIVER_LIBRARY_PATH]
                        Provide driver-library-path to create a Spark Job Configuration.
  --driver-class-path [DRIVER_CLASS_PATH]
                        Provide driver-class-path to create a Spark Job Configuration.
  --executor-memory [EXECUTOR_MEMORY]
                        Provide executor-memory to create a Spark Job Configuration.
  --driver-cores [DRIVER_CORES]
                        Provide driver-cores to create a Spark Job Configuration.
  --total-executor-cores [TOTAL_EXECUTOR_CORES]
                        Provide total-executor-cores to create a Spark Job Configuration.
  --executor-cores [EXECUTOR_CORES]
                        Provide executor-cores to create a Spark Job Configuration.
  --num-executors [NUM_EXECUTORS]
                        Provide num-executors to create a Spark Job Configuration.
  --principal [PRINCIPAL]
                        Provide principal to create a Spark Job Configuration.
  --keytab [KEYTAB]     Provide keytab to create a Spark Job Configuration.
  --queue [QUEUE]       Provide queue to create a Spark Job Configuration.
  --job-class-name [JOB_CLASS_NAME]
                        Provide job-class-name to create a Spark Job Configuration.
  --job-command [JOB_COMMAND]
                        Provide job-command to create a Spark Job Configuration.
  --job-arguments [JOB_ARGUMENTS]
                        Provide job-arguments to create a Spark Job Configuration.
  --job-raw-scala-code JOB_RAW_SCALA_CODE
                        Provide job-raw-scala-code file path to create a Spark Job
                        Configuration.
  --job-type {RAW_SCALA,Jar,Python3,SQL,THRIFT_SQL}
                        Provide job-type to create a Spark Job Configuration.
  --job-timeout-min JOB_TIMEOUT_MIN
                        Provide job-timeout-min to create a Spark Job Configuration.
  --max_concurrency MAX_CONCURRENCY
                        Provide max_concurrency number to limit the number of jobs
                        submitted.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • create-conf example with all the required and optional arguments passed.
yeedu job create-conf --cluster_id=1 --workspace_id=1 --name="spark_examples" --job-class-name="org.apache.spark.examples.SparkPi" --job-command="file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar" --job-arguments=500 --job-type=Jar
  • Console output
{
  "job_conf_id": "1",
  "name": "spark_examples",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 1,
  "max_concurrency": "0",
  "job_class_name": "org.apache.spark.examples.SparkPi",
  "job_command": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
  "job_arguments": "500",
  "job_rawScalaCode": null,
  "files": null,
  "properties_file": null,
  "conf": null,
  "packages": null,
  "repositories": null,
  "jars": null,
  "archives": null,
  "driver_memory": null,
  "driver_java_options": null,
  "driver_library_path": null,
  "driver_class_path": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "principal": null,
  "keytab": null,
  "queue": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T06:29:47.214Z",
  "from_date": "2024-06-14T06:29:47.214Z",
  "to_date": null
}

list-confs​

yeedu job list-confs -h
usage:  list-confs [-h] --workspace_id WORKSPACE_ID [--enable [{true,false}]]
                   [--cluster_ids [CLUSTER_IDS]] [--job_type [JOB_TYPE]]
                   [--job_type_langs [JOB_TYPE_LANGS]]
                   [--last_run_status [LAST_RUN_STATUS]]
                   [--created_by_ids [CREATED_BY_IDS]]
                   [--modified_by_ids [MODIFIED_BY_IDS]] [--page_number PAGE_NUMBER]
                   [--limit LIMIT] [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To list Job Configurations of a specific workspace.
  --enable [{true,false}]
                        Provide enable as true or false to list Job Configurations of a
                        specific workspace.
  --cluster_ids [CLUSTER_IDS]
                        An optional set of cluster instance IDs to filter on.
  --job_type [JOB_TYPE]
                        An optional set of job types filter for Spark job configurations.
                        Choices are: SPARK_JOB, SPARK_SQL, THRIFT_SQL
  --job_type_langs [JOB_TYPE_LANGS]
                        An optional set of language filter for Spark job configurations.
                        Choices are: RAW_SCALA, Jar, Python3, SQL
  --last_run_status [LAST_RUN_STATUS]
                        An optional set of last run statuses to filter Spark job
                        configurations. Choices are: submitted, running, done, error,
                        terminated, stopping, stopped
  --created_by_ids [CREATED_BY_IDS]
                        An optional set of created by user IDs to filter on.
  --modified_by_ids [MODIFIED_BY_IDS]
                        An optional set of modified by user IDs to filter on.
  --page_number PAGE_NUMBER
                        To list Job Configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Job Configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-confs example with required and optional arguments passed.
yeedu job list-confs --workspace_id=1 --limit=1
  • Console output
{
  "data": [
    {
      "job_conf_id": 1,
      "name": "spark_examples",
      "spark_job_type": {
        "job_type": "SPARK_JOB",
        "language": "Jar"
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test",
        "cluster_status": "RUNNING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 1,
          "spark_docker_image_name": "v3.2.2-20",
          "spark_version": "3.2.2",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": true
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "last_job_run": {
        "job_id": null,
        "job_status": null
      },
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T06:29:47.214219+00:00",
      "from_date": "2024-06-14T06:29:47.214219+00:00",
      "to_date": "infinity"
    }
  ]
}

search-confs​

yeedu job search-confs -h
usage:  search-confs [-h] --workspace_id WORKSPACE_ID --job_conf_name JOB_CONF_NAME
                     [--enable [{true,false}]] [--cluster_ids [CLUSTER_IDS]]
                     [--job_type [JOB_TYPE]] [--job_type_langs [JOB_TYPE_LANGS]]
                     [--last_run_status [LAST_RUN_STATUS]]
                     [--created_by_ids [CREATED_BY_IDS]]
                     [--modified_by_ids [MODIFIED_BY_IDS]] [--page_number PAGE_NUMBER]
                     [--limit LIMIT] [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to search job configurations in it.
  --job_conf_name JOB_CONF_NAME
                        Provide job_conf_name to search job configurations.
  --enable [{true,false}]
                        Provide enable as true or false to search job configurations.
  --cluster_ids [CLUSTER_IDS]
                        An optional set of cluster instance IDs to filter on.
  --job_type [JOB_TYPE]
                        An optional set of job types filter for Spark job configurations.
                        Choices are: SPARK_JOB, SPARK_SQL, THRIFT_SQL
  --job_type_langs [JOB_TYPE_LANGS]
                        An optional set of language filter for Spark job configurations.
                        Choices are: RAW_SCALA, Jar, Python3, SQL
  --last_run_status [LAST_RUN_STATUS]
                        An optional set of last run statuses to filter Spark job
                        configurations. Choices are: submitted, running, done, error,
                        terminated, stopping, stopped
  --created_by_ids [CREATED_BY_IDS]
                        An optional set of created by user IDs to filter on.
  --modified_by_ids [MODIFIED_BY_IDS]
                        An optional set of modified by user IDs to filter on.
  --page_number PAGE_NUMBER
                        To search job configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of job configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search-confs example with required and optional arguments passed.
yeedu job search-confs --workspace_id=1 --job_conf_name="spark_" --enable=true --limit=2
  • Console output
{
  "data": [
    {
      "job_conf_id": 1,
      "name": "spark_examples",
      "spark_job_type": {
        "job_type": "SPARK_JOB",
        "language": "Jar"
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test",
        "cluster_status": "RUNNING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 1,
          "spark_docker_image_name": "v3.2.2-20",
          "spark_version": "3.2.2",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": true
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "last_job_run": {
        "job_id": null,
        "job_status": null
      },
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T06:29:47.214219+00:00",
      "from_date": "2024-06-14T06:29:47.214219+00:00",
      "to_date": "infinity"
    }
  ]
}

get-conf​

yeedu job get-conf -h
usage:  get-conf [-h] --workspace_id WORKSPACE_ID
                 [--job_conf_id JOB_CONF_ID]
                 [--job_conf_name JOB_CONF_NAME]
                 [--json-output [{pretty,default}]]
                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to get information about a specific Spark Job Configuration.
  --job_conf_id JOB_CONF_ID
                        Provide Job Config Id to get information about a specific Spark Job Configuration.
  --job_conf_name JOB_CONF_NAME
                        Provide Job Config name to get information about a specific Spark Job Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-conf example with the optional and required argument passed.
yeedu job get-conf --workspace_id=1 --job_conf_id=1
  • Console output
{
  "job_conf_id": 1,
  "name": "spark_examples",
  "cluster_info": {
    "cluster_id": 1,
    "name": "gcp_test",
    "cluster_status": "RUNNING",
    "cluster_type": "YEEDU",
    "instance_size": 1,
    "min_instances": 1,
    "max_instances": 1,
    "cluster_conf": {
      "cluster_conf_id": 10,
      "cluster_conf_name": "n1-standard-4",
      "machine_type_category": "general_purpose",
      "machine_type": {
        "machine_type_id": 10,
        "name": "n1-standard-4",
        "vCPUs": 4,
        "memory": "15 GiB",
        "has_cuda": false,
        "gpu_model": null,
        "gpus": 0,
        "gpu_memory": null,
        "cpu_model": [
          "Intel Xeon Scalable (Skylake) 1st Generation",
          "Intel Xeon E5 v4 (Broadwell E5)",
          "Intel Xeon E5 v3 (Haswell)",
          "Intel Xeon E5 v2 (Ivy Bridge)",
          "Intel Xeon E5 (Sandy Bridge)"
        ],
        "cpu_min_frequency_GHz": [
          "2.0",
          "2.2",
          "2.3",
          "2.5",
          "2.6"
        ],
        "cpu_max_frequency_GHz": [
          "3.5",
          "3.7",
          "3.8",
          "3.5",
          "3.6"
        ],
        "has_local_disk": false,
        "local_disk_size_GB": null,
        "local_num_of_disks": null,
        "local_disk_throughput_MB": null,
        "machine_price_ycu": 2.5
      },
      "machine_volume_conf": {
        "volume_conf_id": 2,
        "name": "volume_gcp_2",
        "size": 375,
        "machine_volume_num": 2,
        "machine_volume_strip_num": 2
      }
    },
    "cloud_env": {
      "cloud_env_id": 1,
      "name": "gcp",
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP"
      }
    },
    "spark_infra_version": {
      "spark_infra_version_id": 1,
      "spark_docker_image_name": "v3.2.2-20",
      "spark_version": "3.2.2",
      "hive_version": "3.2.3",
      "hadoop_version": "3.2.4",
      "scala_version": "2.12.15",
      "python_version": "3.9.5",
      "notebook_support": true,
      "has_cuda_support": true
    },
    "engine_cluster_spark_config": {
      "max_parallel_spark_job_execution_per_instance": 5,
      "num_of_workers": null
    }
  },
  "spark_job_type": {
    "job_type": "SPARK_JOB",
    "language": "Jar"
  },
  "max_concurrency": 0,
  "job_class_name": "org.apache.spark.examples.SparkPi",
  "job_command": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
  "job_arguments": "500",
  "job_rawScalaCode": null,
  "job_timeout_min": null,
  "files": null,
  "properties_file": null,
  "conf": null,
  "packages": null,
  "repositories": null,
  "jars": null,
  "archives": null,
  "driver_memory": null,
  "driver_java_options": null,
  "driver_library_path": null,
  "driver_class_path": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "principal": null,
  "keytab": null,
  "queue": null,
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-14T06:29:47.214219+00:00",
  "from_date": "2024-06-14T06:29:47.214219+00:00",
  "to_date": "infinity"
}

edit-conf​

yeedu job edit-conf -h
usage:  edit-conf [-h] --workspace_id WORKSPACE_ID [--job_conf_id JOB_CONF_ID]
                  [--job_conf_name JOB_CONF_NAME] [--cluster_id CLUSTER_ID]
                  [--cluster_name CLUSTER_NAME] [--files [FILES]]
                  [--properties-file [PROPERTIES_FILE]] [--conf CONF [CONF ...]]
                  [--packages [PACKAGES]] [--repositories [REPOSITORIES]] [--jars [JARS]]
                  [--archives [ARCHIVES]] [--driver-memory [DRIVER_MEMORY]]
                  [--driver-java-options [DRIVER_JAVA_OPTIONS]]
                  [--driver-library-path [DRIVER_LIBRARY_PATH]]
                  [--driver-class-path [DRIVER_CLASS_PATH]]
                  [--executor-memory [EXECUTOR_MEMORY]] [--driver-cores [DRIVER_CORES]]
                  [--total-executor-cores [TOTAL_EXECUTOR_CORES]]
                  [--executor-cores [EXECUTOR_CORES]] [--num-executors [NUM_EXECUTORS]]
                  [--principal [PRINCIPAL]] [--keytab [KEYTAB]] [--queue [QUEUE]]
                  [--job-class-name [JOB_CLASS_NAME]] [--name [NAME]]
                  [--job-command [JOB_COMMAND]] [--job-arguments [JOB_ARGUMENTS]]
                  [--job-raw-scala-code JOB_RAW_SCALA_CODE]
                  [--job-timeout-min JOB_TIMEOUT_MIN] [--max_concurrency MAX_CONCURRENCY]
                  [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to edit a Spark Job Configuration.
  --job_conf_id JOB_CONF_ID
                        Provide Job Config Id to edit a Spark Job Configuration.
  --job_conf_name JOB_CONF_NAME
                        Provide Job Config Name to edit a Spark Job Configuration.
  --cluster_id CLUSTER_ID
                        Provide cluster_id to edit a Spark Job Configuration.
  --cluster_name CLUSTER_NAME
                        Provide cluster_name to edit a Spark Job Configuration.
  --files [FILES]       Provide files to edit a Spark Job Configuration.
  --properties-file [PROPERTIES_FILE]
                        Provide properties-file to edit a Spark Job Configuration.
  --conf CONF [CONF ...]
                        Provide conf to edit a Spark Job Configuration.
  --packages [PACKAGES]
                        Provide packages to edit a Spark Job Configuration.
  --repositories [REPOSITORIES]
                        Provide repositories to edit a Spark Job Configuration.
  --jars [JARS]         Provide jars to edit a Spark Job Configuration.
  --archives [ARCHIVES]
                        Provide archives to edit a Spark Job Configuration.
  --driver-memory [DRIVER_MEMORY]
                        Provide driver-memory to edit a Spark Job Configuration.
  --driver-java-options [DRIVER_JAVA_OPTIONS]
                        Provide driver-java-options to edit a Spark Job Configuration.
  --driver-library-path [DRIVER_LIBRARY_PATH]
                        Provide driver-library-path to edit a Spark Job Configuration.
  --driver-class-path [DRIVER_CLASS_PATH]
                        Provide driver-class-path to edit a Spark Job Configuration.
  --executor-memory [EXECUTOR_MEMORY]
                        Provide executor-memory to edit a Spark Job Configuration.
  --driver-cores [DRIVER_CORES]
                        Provide driver-cores to edit a Spark Job Configuration.
  --total-executor-cores [TOTAL_EXECUTOR_CORES]
                        Provide total-executor-cores to edit a Spark Job Configuration.
  --executor-cores [EXECUTOR_CORES]
                        Provide executor-cores to edit a Spark Job Configuration.
  --num-executors [NUM_EXECUTORS]
                        Provide num-executors to edit a Spark Job Configuration.
  --principal [PRINCIPAL]
                        Provide principal to edit a Spark Job Configuration.
  --keytab [KEYTAB]     Provide keytab to edit a Spark Job Configuration.
  --queue [QUEUE]       Provide queue to edit a Spark Job Configuration.
  --job-class-name [JOB_CLASS_NAME]
                        Provide job-class-name to edit a Spark Job Configuration.
  --name [NAME]         Provide name to edit a Spark Job Configuration.
  --job-command [JOB_COMMAND]
                        Provide job-command to edit a Spark Job Configuration.
  --job-arguments [JOB_ARGUMENTS]
                        Provide job-arguments to edit a Spark Job Configuration.
  --job-raw-scala-code JOB_RAW_SCALA_CODE
                        Provide job-raw-scala-code file path to edit a Spark Job
                        Configuration.
  --job-timeout-min JOB_TIMEOUT_MIN
                        Provide job-timeout-min to edit a Spark Job Configuration.
  --max_concurrency MAX_CONCURRENCY
                        Provide max_concurrency number to limit the number of jobs
                        submitted.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit-conf example with the required arguments and other optional arguments passed which is to be updated.
yeedu job edit-conf --workspace_id=1 --job_conf_name="spark_examples" --job-arguments=1000
  • Console output
{
  "job_conf_id": "1",
  "name": "spark_examples",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 1,
  "max_concurrency": "0",
  "job_class_name": "org.apache.spark.examples.SparkPi",
  "job_command": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
  "job_arguments": "1000",
  "job_rawScalaCode": null,
  "files": null,
  "properties_file": null,
  "conf": null,
  "packages": null,
  "repositories": null,
  "jars": null,
  "archives": null,
  "driver_memory": null,
  "driver_java_options": null,
  "driver_library_path": null,
  "driver_class_path": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "principal": null,
  "keytab": null,
  "queue": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T06:35:54.789Z",
  "from_date": "2024-06-14T06:29:47.214Z",
  "to_date": null
}

enable-conf​

yeedu job enable-conf -h
usage:  enable-conf [-h] --workspace_id WORKSPACE_ID
                    [--job_conf_id JOB_CONF_ID]
                    [--job_conf_name JOB_CONF_NAME]
                    [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to enable the Spark Job Configuration.
  --job_conf_id JOB_CONF_ID
                        Provide Job Config Id to enable the Spark Job Configuration.
  --job_conf_name JOB_CONF_NAME
                        Provide Job Config Name to enable the Spark Job Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • enable-conf example with the required arguments passed.
yeedu job enable-conf --workspace_id=1 --job_conf_id=1
  • Console output
{
  "job_conf_id": "1",
  "name": "spark_examples",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 1,
  "max_concurrency": "0",
  "job_class_name": "org.apache.spark.examples.SparkPi",
  "job_command": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
  "job_arguments": "1000",
  "job_rawScalaCode": null,
  "files": null,
  "properties_file": null,
  "conf": null,
  "packages": null,
  "repositories": null,
  "jars": null,
  "archives": null,
  "driver_memory": null,
  "driver_java_options": null,
  "driver_library_path": null,
  "driver_class_path": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "principal": null,
  "keytab": null,
  "queue": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T06:37:13.951Z",
  "from_date": "2024-06-14T06:29:47.214Z",
  "to_date": null
}

disable-conf​

yeedu job disable-conf -h
usage:  disable-conf [-h] --workspace_id WORKSPACE_ID
                     [--job_conf_id JOB_CONF_ID]
                     [--job_conf_name JOB_CONF_NAME]
                     [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to disable the Spark Job Configuration.
  --job_conf_id JOB_CONF_ID
                        Provide Job Config Id to disable the Spark Job Configuration.
  --job_conf_name JOB_CONF_NAME
                        Provide Job Config Name to disable the Spark Job Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • disable-conf example with the required arguments passed.
yeedu job disable-conf --workspace_id=1 --job_conf_id=1
  • Console output
{
  "job_conf_id": "1",
  "name": "spark_examples",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 1,
  "max_concurrency": "0",
  "job_class_name": "org.apache.spark.examples.SparkPi",
  "job_command": "file:///yeedu/object-storage-manager/spark-examples_2.12-3.2.2.jar",
  "job_arguments": "1000",
  "job_rawScalaCode": null,
  "files": null,
  "properties_file": null,
  "conf": null,
  "packages": null,
  "repositories": null,
  "jars": null,
  "archives": null,
  "driver_memory": null,
  "driver_java_options": null,
  "driver_library_path": null,
  "driver_class_path": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "principal": null,
  "keytab": null,
  "queue": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T06:36:57.297Z",
  "from_date": "2024-06-14T06:29:47.214Z",
  "to_date": "2024-06-14T06:36:57.297Z"
}

export​

yeedu job export -h
usage:  export [-h] --workspace_id WORKSPACE_ID [--job_conf_id JOB_CONF_ID]
               [--job_conf_name JOB_CONF_NAME] [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to export a specific Spark Job Configuration
                        from it.
  --job_conf_id JOB_CONF_ID
                        Provide Job Config Id to export a specific Spark Job
                        Configuration.
  --job_conf_name JOB_CONF_NAME
                        Provide Job Config name to export a specific Spark Job
                        Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • export example with the required arguments passed.
yeedu job export --workspace_id=1 --job_conf_id=1
  • Console output
{
  "jobs": [
    {
      "name": "yeedu_test_job",
      "spark_job_type": {
        "job_type": "SPARK_JOB",
        "language": "Jar"
      },
      "cluster_info": {
        "cluster_name": "aws_test_cluster",
        "cluster_type": "YEEDU"
      },
      "max_concurrency": 0,
      "files": [],
      "properties_file": null,
      "conf": [],
      "packages": [],
      "repositories": [],
      "jars": [],
      "archives": [],
      "driver_memory": null,
      "driver_java_options": "-Dderby.system.home=/yeedu/spark_metastores/1721298078-74183",
      "driver_library_path": null,
      "driver_class_path": null,
      "executor_memory": null,
      "principal": null,
      "keytab": null,
      "queue": null,
      "job_class_name": "org.apache.spark.examples.SparkPi",
      "job_command": "/opt/spark/examples/jars/spark-examples_2.12-3.2.2.jar",
      "job_arguments": "10000",
      "job_rawScalaCode": null,
      "job_timeout_min": 5,
      "driver_cores": null,
      "total_executor_cores": null,
      "executor_cores": null,
      "num_executors": null
    }
  ]
}

Spark Job Instance​

Command NameUtility
startTo run a Spark Job Instance.
listTo list all the available Spark Job Instances.
searchTo search Spark Job Instances by similar job id.
getTo get information about a specific Spark Job Instance.
stopTo stop a specific Spark Job Instance.
get-statusTo get all the status information about a specific Spark Job Instance.
logsTo download Spark Job Instance logs by job id.

start​

yeedu job start -h
usage:  start [-h] [--job_conf_id JOB_CONF_ID]
              [--job_conf_name JOB_CONF_NAME] --workspace_id
              WORKSPACE_ID [--json-output [{pretty,default}]]
              [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --job_conf_id JOB_CONF_ID
                        To run a Spark Job Instance, enter job_conf_id.
  --job_conf_name JOB_CONF_NAME
                        To run a Spark Job Instance, enter job_conf_name.
  --workspace_id WORKSPACE_ID
                        To run a Spark Job Instance, enter workspace_id.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • start example with one of the required argument passed.
yeedu job start --workspace_id=1 --job_conf_id=1
  • Console output
{
  "job_id": "1",
  "job_conf_id": "1",
  "cluster_id": "1",
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T06:38:03.054Z",
  "from_date": "2024-06-14T06:38:03.054Z",
  "to_date": null
}

list​

yeedu job list -h
usage:  list [-h] --workspace_id WORKSPACE_ID [--cluster_ids [CLUSTER_IDS]]
             [--job_conf_ids [JOB_CONF_IDS]] [--job_status [JOB_STATUS]]
             [--job_type [JOB_TYPE]] [--job_type_langs [JOB_TYPE_LANGS]]
             [--created_by_ids [CREATED_BY_IDS]] [--modified_by_ids [MODIFIED_BY_IDS]]
             [--page_number PAGE_NUMBER] [--limit LIMIT] [--json-output [{pretty,default}]]
             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To list Spark Job Instances of a specific workspace_id.
  --cluster_ids [CLUSTER_IDS]
                        To list Spark Job Instances for optional set of cluster Ids.
  --job_conf_ids [JOB_CONF_IDS]
                        To list Spark Job Instances for optional set of Spark job
                        configuration Ids.
  --job_status [JOB_STATUS]
                        To list Spark Job Instances for optional set of job_status. Choices
                        are: submitted, running, done, error, terminated, stopping, stopped
  --job_type [JOB_TYPE]
                        To list Spark Job Instances for optional set of job_type. Choices
                        are: SPARK_JOB, SPARK_SQL, NOTEBOOK, THRIFT_SQL
  --job_type_langs [JOB_TYPE_LANGS]
                        An optional set of language filter for Spark job Instances. Choices
                        are: RAW_SCALA, Jar, Python3, Scala, SQL
  --created_by_ids [CREATED_BY_IDS]
                        To list Spark Job Instances for optional set of created by user Ids.
  --modified_by_ids [MODIFIED_BY_IDS]
                        To list Spark Job Instances for optional set of modified by user
                        Ids.
  --page_number PAGE_NUMBER
                        To list Spark Job Instances for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of job instances. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list example with required and optional arguments passed.
yeedu job list --workspace_id=1 --limit=2
  • Console output
{
  "data": [
    {
      "job_id": 2,
      "job_application_id": null,
      "job_status": "RUNNING",
      "total_job_time_sec": 4.499798,
      "job_execution_time_sec": 2.005716,
      "job_conf": {
        "job_conf_id": 1,
        "name": "spark_examples",
        "spark_job_type": {
          "job_type": "SPARK_JOB",
          "language": "Jar"
        },
        "cluster_info": {
          "cluster_id": 1,
          "name": "gcp_test",
          "cluster_status": "RUNNING",
          "cluster_type": "YEEDU",
          "instance_size": 1,
          "min_instances": 1,
          "max_instances": 1,
          "cloud_env": {
            "cloud_env_id": 1,
            "name": "gcp",
            "cloud_provider": {
              "cloud_provider_id": 0,
              "name": "GCP"
            }
          },
          "cluster_conf": {
            "cluster_conf_id": 10,
            "cluster_conf_name": "n1-standard-4",
            "machine_type_category": "general_purpose",
            "machine_type": {
              "machine_type_id": 10,
              "name": "n1-standard-4",
              "vCPUs": 4,
              "memory": "15 GiB",
              "has_cuda": false,
              "gpu_model": null,
              "gpus": 0,
              "gpu_memory": null,
              "cpu_model": [
                "Intel Xeon Scalable (Skylake) 1st Generation",
                "Intel Xeon E5 v4 (Broadwell E5)",
                "Intel Xeon E5 v3 (Haswell)",
                "Intel Xeon E5 v2 (Ivy Bridge)",
                "Intel Xeon E5 (Sandy Bridge)"
              ],
              "cpu_min_frequency_GHz": [
                "2.0",
                "2.2",
                "2.3",
                "2.5",
                "2.6"
              ],
              "cpu_max_frequency_GHz": [
                "3.5",
                "3.7",
                "3.8",
                "3.5",
                "3.6"
              ],
              "has_local_disk": false,
              "local_disk_size_GB": null,
              "local_num_of_disks": null,
              "local_disk_throughput_MB": null,
              "machine_price_ycu": 2.5
            },
            "machine_volume_conf": {
              "volume_conf_id": 2,
              "name": "volume_gcp_2",
              "size": 375,
              "machine_volume_num": 2,
              "machine_volume_strip_num": 2
            }
          },
          "spark_infra_version": {
            "spark_infra_version_id": 1,
            "spark_docker_image_name": "v3.2.2-20",
            "spark_version": "3.2.2",
            "hive_version": "3.2.3",
            "hadoop_version": "3.2.4",
            "scala_version": "2.12.15",
            "python_version": "3.9.5",
            "notebook_support": true,
            "has_cuda_support": true
          },
          "engine_cluster_spark_config": {
            "max_parallel_spark_job_execution_per_instance": 5,
            "num_of_workers": null
          }
        }
      },
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T06:39:16.11221+00:00",
      "from_date": "2024-06-14T06:39:16.11221+00:00",
      "to_date": "infinity"
    },
    {
      "job_id": 1,
      "job_application_id": null,
      "job_status": "ERROR",
      "total_job_time_sec": 5.671385,
      "job_execution_time_sec": 2.488786,
      "job_conf": {
        "job_conf_id": 1,
        "name": "spark_examples",
        "spark_job_type": {
          "job_type": "SPARK_JOB",
          "language": "Jar"
        },
        "cluster_info": {
          "cluster_id": 1,
          "name": "gcp_test",
          "cluster_status": "RUNNING",
          "cluster_type": "YEEDU",
          "instance_size": 1,
          "min_instances": 1,
          "max_instances": 1,
          "cloud_env": {
            "cloud_env_id": 1,
            "name": "gcp",
            "cloud_provider": {
              "cloud_provider_id": 0,
              "name": "GCP"
            }
          },
          "cluster_conf": {
            "cluster_conf_id": 10,
            "cluster_conf_name": "n1-standard-4",
            "machine_type_category": "general_purpose",
            "machine_type": {
              "machine_type_id": 10,
              "name": "n1-standard-4",
              "vCPUs": 4,
              "memory": "15 GiB",
              "has_cuda": false,
              "gpu_model": null,
              "gpus": 0,
              "gpu_memory": null,
              "cpu_model": [
                "Intel Xeon Scalable (Skylake) 1st Generation",
                "Intel Xeon E5 v4 (Broadwell E5)",
                "Intel Xeon E5 v3 (Haswell)",
                "Intel Xeon E5 v2 (Ivy Bridge)",
                "Intel Xeon E5 (Sandy Bridge)"
              ],
              "cpu_min_frequency_GHz": [
                "2.0",
                "2.2",
                "2.3",
                "2.5",
                "2.6"
              ],
              "cpu_max_frequency_GHz": [
                "3.5",
                "3.7",
                "3.8",
                "3.5",
                "3.6"
              ],
              "has_local_disk": false,
              "local_disk_size_GB": null,
              "local_num_of_disks": null,
              "local_disk_throughput_MB": null,
              "machine_price_ycu": 2.5
            },
            "machine_volume_conf": {
              "volume_conf_id": 2,
              "name": "volume_gcp_2",
              "size": 375,
              "machine_volume_num": 2,
              "machine_volume_strip_num": 2
            }
          },
          "spark_infra_version": {
            "spark_infra_version_id": 1,
            "spark_docker_image_name": "v3.2.2-20",
            "spark_version": "3.2.2",
            "hive_version": "3.2.3",
            "hadoop_version": "3.2.4",
            "scala_version": "2.12.15",
            "python_version": "3.9.5",
            "notebook_support": true,
            "has_cuda_support": true
          },
          "engine_cluster_spark_config": {
            "max_parallel_spark_job_execution_per_instance": 5,
            "num_of_workers": null
          }
        }
      },
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T06:38:03.054482+00:00",
      "from_date": "2024-06-14T06:38:03.054482+00:00",
      "to_date": "2024-06-14T06:38:08.725867+00:00"
    }
  ]
}
  • list example to list spark jobs of a particular workspace having specific spark job status.
yeedu job list --workspace_id=1 --job_status=done --limit=1
  • Console output
{
  "data": [
    {
      "job_id": 1,
      "job_application_id": "local-1718347762051",
      "job_status": "DONE",
      "total_job_time_sec": 25.057991,
      "job_execution_time_sec": 22.512167,
      "job_conf": {
        "job_conf_id": 1,
        "name": "spark_examples",
        "spark_job_type": {
          "job_type": "SPARK_JOB",
          "language": "Jar"
        },
        "cluster_info": {
          "cluster_id": 1,
          "name": "gcp_test",
          "cluster_status": "RUNNING",
          "cluster_type": "YEEDU",
          "instance_size": 1,
          "min_instances": 1,
          "max_instances": 1,
          "cloud_env": {
            "cloud_env_id": 1,
            "name": "gcp",
            "cloud_provider": {
              "cloud_provider_id": 0,
              "name": "GCP"
            }
          },
          "cluster_conf": {
            "cluster_conf_id": 10,
            "cluster_conf_name": "n1-standard-4",
            "machine_type_category": "general_purpose",
            "machine_type": {
              "machine_type_id": 10,
              "name": "n1-standard-4",
              "vCPUs": 4,
              "memory": "15 GiB",
              "has_cuda": false,
              "gpu_model": null,
              "gpus": 0,
              "gpu_memory": null,
              "cpu_model": [
                "Intel Xeon Scalable (Skylake) 1st Generation",
                "Intel Xeon E5 v4 (Broadwell E5)",
                "Intel Xeon E5 v3 (Haswell)",
                "Intel Xeon E5 v2 (Ivy Bridge)",
                "Intel Xeon E5 (Sandy Bridge)"
              ],
              "cpu_min_frequency_GHz": [
                "2.0",
                "2.2",
                "2.3",
                "2.5",
                "2.6"
              ],
              "cpu_max_frequency_GHz": [
                "3.5",
                "3.7",
                "3.8",
                "3.5",
                "3.6"
              ],
              "has_local_disk": false,
              "local_disk_size_GB": null,
              "local_num_of_disks": null,
              "local_disk_throughput_MB": null,
              "machine_price_ycu": 2.5
            },
            "machine_volume_conf": {
              "volume_conf_id": 2,
              "name": "volume_gcp_2",
              "size": 375,
              "machine_volume_num": 2,
              "machine_volume_strip_num": 2
            }
          },
          "spark_infra_version": {
            "spark_infra_version_id": 1,
            "spark_docker_image_name": "v3.2.2-20",
            "spark_version": "3.2.2",
            "hive_version": "3.2.3",
            "hadoop_version": "3.2.4",
            "scala_version": "2.12.15",
            "python_version": "3.9.5",
            "notebook_support": true,
            "has_cuda_support": true
          },
          "engine_cluster_spark_config": {
            "max_parallel_spark_job_execution_per_instance": 5,
            "num_of_workers": null
          }
        }
      },
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T06:49:16.511361+00:00",
      "from_date": "2024-06-14T06:49:16.511361+00:00",
      "to_date": "2024-06-14T06:49:41.569352+00:00"
    }
  ]
}

search​

yeedu job search -h
usage:  search [-h] --workspace_id WORKSPACE_ID --job_conf_name JOB_CONF_NAME
               [--cluster_ids [CLUSTER_IDS]] [--job_status [JOB_STATUS]]
               [--job_type [JOB_TYPE]] [--job_type_langs [JOB_TYPE_LANGS]]
               [--created_by_ids [CREATED_BY_IDS]] [--modified_by_ids [MODIFIED_BY_IDS]]
               [--page_number PAGE_NUMBER] [--limit LIMIT]
               [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to search Spark Job Instances in it.
  --job_conf_name JOB_CONF_NAME
                        To search Spark Job Instances of a specific job_conf_name.
  --cluster_ids [CLUSTER_IDS]
                        To search Spark Job Instances for optional set of cluster Ids.
  --job_status [JOB_STATUS]
                        To search Spark Job Instances for optional set of job_status.
                        Choices are: submitted, running, done, error, terminated, stopping,
                        stopped
  --job_type [JOB_TYPE]
                        To search Spark Job Instances for optional set of job_type. Choices
                        are: SPARK_JOB, SPARK_SQL, NOTEBOOK, THRIFT_SQL
  --job_type_langs [JOB_TYPE_LANGS]
                        An optional set of language filter for Spark job Instances. Choices
                        are: RAW_SCALA, Jar, Python3, Scala, SQL
  --created_by_ids [CREATED_BY_IDS]
                        To search Spark Job Instances for optional set of created by user
                        Ids.
  --modified_by_ids [MODIFIED_BY_IDS]
                        To search Spark Job Instances for optional set of modified by user
                        Ids.
  --page_number PAGE_NUMBER
                        To search Spark Job Instances for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of Spark Job Instances. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search example with required and optional arguments passed.
yeedu job search --workspace_id=1 --job_conf_name=spark_examples --limit=1
  • Console output
{
  "data": [
    {
      "job_id": 1,
      "job_application_id": "local-1718347762051",
      "job_status": "DONE",
      "total_job_time_sec": 25.057991,
      "job_execution_time_sec": 22.512167,
      "job_conf": {
        "job_conf_id": 1,
        "name": "spark_examples",
        "spark_job_type": {
          "job_type": "SPARK_JOB",
          "language": "Jar"
        },
        "cluster_info": {
          "cluster_id": 1,
          "name": "gcp_test",
          "cluster_status": "RUNNING",
          "cluster_type": "YEEDU",
          "instance_size": 1,
          "min_instances": 1,
          "max_instances": 1,
          "cloud_env": {
            "cloud_env_id": 1,
            "name": "gcp",
            "cloud_provider": {
              "cloud_provider_id": 0,
              "name": "GCP"
            }
          },
          "cluster_conf": {
            "cluster_conf_id": 10,
            "cluster_conf_name": "n1-standard-4",
            "machine_type_category": "general_purpose",
            "machine_type": {
              "machine_type_id": 10,
              "name": "n1-standard-4",
              "vCPUs": 4,
              "memory": "15 GiB",
              "has_cuda": false,
              "gpu_model": null,
              "gpus": 0,
              "gpu_memory": null,
              "cpu_model": [
                "Intel Xeon Scalable (Skylake) 1st Generation",
                "Intel Xeon E5 v4 (Broadwell E5)",
                "Intel Xeon E5 v3 (Haswell)",
                "Intel Xeon E5 v2 (Ivy Bridge)",
                "Intel Xeon E5 (Sandy Bridge)"
              ],
              "cpu_min_frequency_GHz": [
                "2.0",
                "2.2",
                "2.3",
                "2.5",
                "2.6"
              ],
              "cpu_max_frequency_GHz": [
                "3.5",
                "3.7",
                "3.8",
                "3.5",
                "3.6"
              ],
              "has_local_disk": false,
              "local_disk_size_GB": null,
              "local_num_of_disks": null,
              "local_disk_throughput_MB": null,
              "machine_price_ycu": 2.5
            },
            "machine_volume_conf": {
              "volume_conf_id": 2,
              "name": "volume_gcp_2",
              "size": 375,
              "machine_volume_num": 2,
              "machine_volume_strip_num": 2
            }
          },
          "spark_infra_version": {
            "spark_infra_version_id": 1,
            "spark_docker_image_name": "v3.2.2-20",
            "spark_version": "3.2.2",
            "hive_version": "3.2.3",
            "hadoop_version": "3.2.4",
            "scala_version": "2.12.15",
            "python_version": "3.9.5",
            "notebook_support": true,
            "has_cuda_support": true
          },
          "engine_cluster_spark_config": {
            "max_parallel_spark_job_execution_per_instance": 5,
            "num_of_workers": null
          }
        }
      },
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T06:49:16.511361+00:00",
      "from_date": "2024-06-14T06:49:16.511361+00:00",
      "to_date": "2024-06-14T06:49:41.569352+00:00"
    }
  ]
}

get​

yeedu job get -h
usage:  get [-h] --job_id JOB_ID --workspace_id WORKSPACE_ID
            [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --job_id JOB_ID       Provide job_id to get information about a specific Spark Job
                        Instance.
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to get information about a specific Spark
                        Job Instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get example with all the required arguments passed.
yeedu job get --workspace_id=1 --job_id=4
  • Console output
{
  "job_id": 4,
  "job_application_id": "local-1718347762051",
  "job_status": "DONE",
  "job_execution_time_sec": 22.512167,
  "total_job_time_sec": 25.057991,
  "job_conf": {
    "job_conf_id": 1,
    "name": "spark_examples",
    "spark_job_type": {
      "job_type": "SPARK_JOB",
      "language": "Jar"
    },
    "cluster_info": {
      "cluster_id": 1,
      "name": "gcp_test",
      "cluster_status": "RUNNING",
      "cluster_type": "YEEDU",
      "instance_size": 1,
      "min_instances": 1,
      "max_instances": 1,
      "cloud_env": {
        "cloud_env_id": 1,
        "name": "gcp",
        "cloud_provider": {
          "cloud_provider_id": 0,
          "name": "GCP"
        }
      },
      "cluster_conf": {
        "cluster_conf_id": 10,
        "cluster_conf_name": "n1-standard-4",
        "machine_type_category": "general_purpose",
        "machine_type": {
          "machine_type_id": 10,
          "name": "n1-standard-4",
          "vCPUs": 4,
          "memory": "15 GiB",
          "has_cuda": false,
          "gpu_model": null,
          "gpus": 0,
          "gpu_memory": null,
          "cpu_model": [
            "Intel Xeon Scalable (Skylake) 1st Generation",
            "Intel Xeon E5 v4 (Broadwell E5)",
            "Intel Xeon E5 v3 (Haswell)",
            "Intel Xeon E5 v2 (Ivy Bridge)",
            "Intel Xeon E5 (Sandy Bridge)"
          ],
          "cpu_min_frequency_GHz": [
            "2.0",
            "2.2",
            "2.3",
            "2.5",
            "2.6"
          ],
          "cpu_max_frequency_GHz": [
            "3.5",
            "3.7",
            "3.8",
            "3.5",
            "3.6"
          ],
          "has_local_disk": false,
          "local_disk_size_GB": null,
          "local_num_of_disks": null,
          "local_disk_throughput_MB": null,
          "machine_price_ycu": 2.5
        },
        "machine_volume_conf": {
          "volume_conf_id": 2,
          "name": "volume_gcp_2",
          "size": 375,
          "machine_volume_num": 2,
          "machine_volume_strip_num": 2
        }
      },
      "spark_infra_version": {
        "spark_infra_version_id": 1,
        "spark_docker_image_name": "v3.2.2-20",
        "spark_version": "3.2.2",
        "hive_version": "3.2.3",
        "hadoop_version": "3.2.4",
        "scala_version": "2.12.15",
        "python_version": "3.9.5",
        "notebook_support": true,
        "has_cuda_support": true
      },
      "engine_cluster_spark_config": {
        "max_parallel_spark_job_execution_per_instance": 5,
        "num_of_workers": null
      }
    }
  },
  "workflow_job_instance_details": {
    "workflow_job_instance_status": {
      "workflow_job_instance_id": 5,
      "workflow_job_id": 5,
      "status": "DONE",
      "from_date": "2024-06-14T06:49:16.511361+00:00",
      "to_date": "2024-06-14T06:49:41.569352+00:00"
    },
    "workflow_execution_process": {
      "machine_pid_number": "425",
      "machine_hostname": "yeedu1-bcd2b294-deb1-10c9-0b8e-8e471e5c46f3",
      "machine_id": "bcd2b294-deb1-10c9-0b8e-8e471e5c46f3",
      "machine_pid_user": "root",
      "machine_node_number": "0"
    }
  },
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-14T06:49:16.511361+00:00",
  "from_date": "2024-06-14T06:49:16.511361+00:00",
  "to_date": "2024-06-14T06:49:41.569352+00:00"
}

stop​

yeedu job stop -h
usage:  stop [-h] --job_id JOB_ID --workspace_id WORKSPACE_ID
             [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --job_id JOB_ID       Provide job_id to stop a specific Spark Job Instance.
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to stop a specific Spark Job Instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • stop example with all the required argument passed.
yeedu job stop --workspace_id=1 --job_id=5
  • Console output
{
  "SparkKill": {
    "workflow_job_id": 6,
    "workflow_job_instance_id": 6,
    "spark_job_instance_id": 5,
    "spark_job_id": 1,
    "compute_engine_id": 1
  }
}

get-status​

yeedu job get-status -h
usage:  get-status [-h] --job_id JOB_ID --workspace_id WORKSPACE_ID
                   [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --job_id JOB_ID       Provide job_id to get all the status information about a
                        specific Spark Job Instance.
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to get all the status information about a
                        specific Spark Job Instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-status example with all the required argument passed.
yeedu job get-status --workspace_id=1 --job_id=5
  • Console output
[
  {
    "job_status": "SUBMITTED",
    "created_by": "YSU0000",
    "start_time": "2024-06-14T06:49:16.511361+00:00",
    "end_time": "2024-06-14T06:49:19.057185+00:00"
  },
  {
    "job_status": "RUNNING",
    "created_by": "YSU0000",
    "start_time": "2024-06-14T06:49:19.057185+00:00",
    "end_time": "2024-06-14T06:49:41.569352+00:00"
  },
  {
    "job_status": "DONE",
    "created_by": "YSU0000",
    "start_time": "2024-06-14T06:49:41.569352+00:00",
    "end_time": "infinity"
  }
]

logs​

yeedu job logs -h
usage:  logs [-h] --workspace_id WORKSPACE_ID --job_id JOB_ID
             [--log_type {stdout,stderr}] [--json-output [{pretty,default}]]
             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to download Spark Job Instance log records.
  --job_id JOB_ID       Provide job_id to download Spark Job Instance log records.
  --log_type {stdout,stderr}
                        Provide log_type to download Spark Job Instance log records.
                        (default: stdout)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • logs example with all the required arguments passed.
yeedu job logs --workspace_id=1 --job_id=4
  • Console output
Pi is roughly 3.141355706778534

Workflow Details By Spark Job Application ID​

Command NameUtility
get-workflow-job-instanceTo get information about a specific Workflow Job Instance.

get-workflow-job-instance​

yeedu job get-workflow-job-instance -h
usage:  get-workflow-job-instance [-h] --job_application_id JOB_APPLICATION_ID
                                  --workspace_id WORKSPACE_ID
                                  [--json-output [{pretty,default}]]
                                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --job_application_id JOB_APPLICATION_ID
                        Provide a job_application_id to get information about a specific
                        Workflow Job Instance.
  --workspace_id WORKSPACE_ID
                        Provide a workspace_id to get information about a specific
                        Workflow Job Instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-workflow-job-instance example with all the required arguments passed.
yeedu job get-workflow-job-instance --workspace_id=1 --job_application_id=local-1718347762051
  • Console output
{
  "job_id": 4,
  "job_application_id": "local-1718347762051",
  "job_status": "DONE",
  "compute_engine": 1,
  "cluster_id": "1",
  "workflow_job_instance_details": {
    "workflow_job_instance_status": {
      "workflow_job_instance_id": 5,
      "workflow_job_id": 5,
      "status": "DONE",
      "previous_status": [
        "NONE",
        "INIT",
        "SENT",
        "RECEIVED",
        "EXECUTING"
      ],
      "from_date": "2024-06-14T06:49:41.569352+00:00",
      "to_date": "infinity"
    },
    "workflow_execution_process": {
      "machine_pid_number": "425",
      "machine_hostname": "yeedu1-bcd2b294-deb1-10c9-0b8e-8e471e5c46f3",
      "machine_id": "bcd2b294-deb1-10c9-0b8e-8e471e5c46f3",
      "machine_pid_user": "root",
      "machine_node_number": "0"
    }
  },
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-14T06:49:16.511361+00:00",
  "from_date": "2024-06-14T06:49:16.511361+00:00",
  "to_date": "2024-06-14T06:49:41.569352+00:00"
}

Notebook

Notebook Configuration​

Command NameUtility
create-confTo create a Notebook Configuration.
list-confsTo list all the available Notebook Configurations.
search-confsTo search Notebook Configurations by notebook name in a workspace.
get-confTo get the information about a specific Notebook Configuration.
edit-confTo edit the Notebook Configuration.
enable-confTo enable a specific Notebook Configuration.
disable-confTo disable a specific Notebook Configuration.
exportExport a specific Notebook Configuration.

create-conf​

yeedu notebook create-conf -h
usage:  create-conf [-h] --workspace_id WORKSPACE_ID
                    [--cluster_id CLUSTER_ID]
                    [--cluster_name CLUSTER_NAME] --notebook_name
                    NOTEBOOK_NAME --notebook_type python3,scala
                    [--conf CONF [CONF ...]] [--files [FILES]]
                    [--jars [JARS]] [--packages [PACKAGES]]
                    [--driver-memory [DRIVER_MEMORY]]
                    [--executor-memory [EXECUTOR_MEMORY]]
                    [--driver-cores [DRIVER_CORES]]
                    [--total-executor-cores [TOTAL_EXECUTOR_CORES]]
                    [--executor-cores [EXECUTOR_CORES]]
                    [--num-executors [NUM_EXECUTORS]]
                    [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to create a Notebook Configuration.
  --cluster_id CLUSTER_ID
                        Provide cluster_id to create a Notebook Configuration.
  --cluster_name CLUSTER_NAME
                        Provide cluster_name to create a Notebook Configuration.
  --notebook_name NOTEBOOK_NAME
                        Provide notebook_name to create a Notebook Configuration.
  --notebook_type python3,scala
                        Provide notebook type to create a Notebook Configuration.
  --conf CONF [CONF ...]
                        Provide conf to create a Notebook Configuration.
  --files [FILES]       Provide files to create a Notebook Configuration.
  --jars [JARS]         Provide jars to create a Notebook Configuration.
  --packages [PACKAGES]
                        Provide packages to create a Notebook Configuration.
  --driver-memory [DRIVER_MEMORY]
                        Provide driver-memory to create a Notebook Configuration.
  --executor-memory [EXECUTOR_MEMORY]
                        Provide executor-memory to create a Notebook Configuration.
  --driver-cores [DRIVER_CORES]
                        Provide driver-cores to create a Notebook Configuration.
  --total-executor-cores [TOTAL_EXECUTOR_CORES]
                        Provide total-executor-cores to create a Notebook Configuration.
  --executor-cores [EXECUTOR_CORES]
                        Provide executor-cores to create a Notebook Configuration.
  --num-executors [NUM_EXECUTORS]
                        Provide num-executors to create a Notebook Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-conf example with all the required and optional arguments passed.
yeedu notebook create-conf --cluster_id=1 --workspace_id=1 --notebook_name="test_notebook" --notebook_type="python3"
  • Console output
{
  "notebook_conf_id": "2",
  "notebook_name": "test_notebook",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 3,
  "max_concurrency": "1",
  "notebook_cells": {
    "cells": [
      {
        "cell_uuid": "9b6c637d-1183-4ac6-90a4-7a23f2b9ecae",
        "order": 0,
        "code": "",
        "output": [],
        "runStatus": false,
        "executionCount": 0,
        "isOutputError": false
      }
    ]
  },
  "notebook_cells_auto_save": null,
  "conf": null,
  "packages": null,
  "jars": null,
  "files": null,
  "driver_memory": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T07:05:31.507Z",
  "from_date": "2024-06-14T07:05:31.507Z",
  "to_date": null
}

list-confs​

yeedu notebook list-confs -h
usage:  list-confs [-h] --workspace_id WORKSPACE_ID [--enable [{true,false}]]
                   [--cluster_ids [CLUSTER_IDS]] [--language [LANGUAGE]]
                   [--last_run_status [LAST_RUN_STATUS]] [--created_by_ids [CREATED_BY_IDS]]
                   [--modified_by_ids [MODIFIED_BY_IDS]] [--page_number PAGE_NUMBER]
                   [--limit LIMIT] [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To list Notebook Configurations of a specific workspace.
  --enable [{true,false}]
                        Provide enable as true or false to list Notebook Configurations of a
                        specific workspace.
  --cluster_ids [CLUSTER_IDS]
                        An optional set of cluster instance IDs to filter on.
  --language [LANGUAGE]
                        An optional set of language filter for notebook configurations.
                        Choices are: Python3, Scala
  --last_run_status [LAST_RUN_STATUS]
                        An optional set of last run statuses to filter notebook
                        configurations. Choices are: submitted, running, done, error,
                        terminated, stopping, stopped
  --created_by_ids [CREATED_BY_IDS]
                        An optional set of created by user IDs to filter on.
  --modified_by_ids [MODIFIED_BY_IDS]
                        An optional set of modified by user IDs to filter on.
  --page_number PAGE_NUMBER
                        To list Notebook Configurations for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of Notebook Configurations. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list-confs example with required and optional arguments passed.
yeedu notebook list-confs --workspace_id=1 --limit=1
  • Console output
{
  "data": [
    {
      "notebook_conf_id": 2,
      "notebook_name": "test_notebook",
      "spark_job_type": {
        "job_type": "NOTEBOOK",
        "language": "Python3"
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test",
        "cluster_status": "RUNNING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 1,
          "spark_docker_image_name": "v3.2.2-20",
          "spark_version": "3.2.2",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": true
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "last_notebook_run": {
        "notebook_id": null,
        "notebook_status": null
      },
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T07:05:31.507399+00:00",
      "from_date": "2024-06-14T07:05:31.507399+00:00",
      "to_date": "infinity"
    }
  ]
}

search-confs​

yeedu notebook search-confs -h
usage:  search-confs [-h] --workspace_id WORKSPACE_ID --notebook_name NOTEBOOK_NAME
                     [--enable [{true,false}]] [--cluster_ids [CLUSTER_IDS]]
                     [--language [LANGUAGE]] [--last_run_status [LAST_RUN_STATUS]]
                     [--created_by_ids [CREATED_BY_IDS]]
                     [--modified_by_ids [MODIFIED_BY_IDS]] [--page_number PAGE_NUMBER]
                     [--limit LIMIT] [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace_id to search Notebook Configurations in it.
  --notebook_name NOTEBOOK_NAME
                        Provide notebook_name to search Notebook Configurations.
  --enable [{true,false}]
                        Provide enable as true or false to search Notebook Configurations.
  --cluster_ids [CLUSTER_IDS]
                        An optional set of cluster instance IDs to filter on.
  --language [LANGUAGE]
                        An optional set of language filter for notebook configurations.
                        Choices are: Python3, Scala
  --last_run_status [LAST_RUN_STATUS]
                        An optional set of last run statuses to filter notebook
                        configurations. Choices are: submitted, running, done, error,
                        terminated, stopping, stopped
  --created_by_ids [CREATED_BY_IDS]
                        An optional set of created by user IDs to filter on.
  --modified_by_ids [MODIFIED_BY_IDS]
                        An optional set of modified by user IDs to filter on.
  --page_number PAGE_NUMBER
                        To search Notebook Configurations for a specific page_number.
                        (default: 1)
  --limit LIMIT         Provide limit to search number of Notebook Configurations.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search-confs example with required and optional arguments passed.
yeedu notebook search-confs --workspace_id=1 --notebook_name="test_" --enable=true --limit=1
  • Console output
{
  "data": [
    {
      "notebook_conf_id": 2,
      "notebook_name": "test_notebook",
      "spark_job_type": {
        "job_type": "NOTEBOOK",
        "language": "Python3"
      },
      "cluster_info": {
        "cluster_id": 1,
        "name": "gcp_test",
        "cluster_status": "RUNNING",
        "cluster_type": "YEEDU",
        "instance_size": 1,
        "min_instances": 1,
        "max_instances": 1,
        "cloud_env": {
          "cloud_env_id": 1,
          "name": "gcp",
          "cloud_provider": {
            "cloud_provider_id": 0,
            "name": "GCP"
          }
        },
        "cluster_conf": {
          "cluster_conf_id": 10,
          "cluster_conf_name": "n1-standard-4",
          "machine_type_category": "general_purpose",
          "machine_type": {
            "machine_type_id": 10,
            "name": "n1-standard-4",
            "vCPUs": 4,
            "memory": "15 GiB",
            "has_cuda": false,
            "gpu_model": null,
            "gpus": 0,
            "gpu_memory": null,
            "cpu_model": [
              "Intel Xeon Scalable (Skylake) 1st Generation",
              "Intel Xeon E5 v4 (Broadwell E5)",
              "Intel Xeon E5 v3 (Haswell)",
              "Intel Xeon E5 v2 (Ivy Bridge)",
              "Intel Xeon E5 (Sandy Bridge)"
            ],
            "cpu_min_frequency_GHz": [
              "2.0",
              "2.2",
              "2.3",
              "2.5",
              "2.6"
            ],
            "cpu_max_frequency_GHz": [
              "3.5",
              "3.7",
              "3.8",
              "3.5",
              "3.6"
            ],
            "has_local_disk": false,
            "local_disk_size_GB": null,
            "local_num_of_disks": null,
            "local_disk_throughput_MB": null,
            "machine_price_ycu": 2.5
          },
          "machine_volume_conf": {
            "volume_conf_id": 2,
            "name": "volume_gcp_2",
            "size": 375,
            "machine_volume_num": 2,
            "machine_volume_strip_num": 2
          }
        },
        "spark_infra_version": {
          "spark_infra_version_id": 1,
          "spark_docker_image_name": "v3.2.2-20",
          "spark_version": "3.2.2",
          "hive_version": "3.2.3",
          "hadoop_version": "3.2.4",
          "scala_version": "2.12.15",
          "python_version": "3.9.5",
          "notebook_support": true,
          "has_cuda_support": true
        },
        "engine_cluster_spark_config": {
          "max_parallel_spark_job_execution_per_instance": 5,
          "num_of_workers": null
        }
      },
      "last_notebook_run": {
        "notebook_id": null,
        "notebook_status": null
      },
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T07:05:31.507399+00:00",
      "from_date": "2024-06-14T07:05:31.507399+00:00",
      "to_date": "infinity"
    }
  ]
}

get-conf​

yeedu notebook get-conf -h
usage:  get-conf [-h] --workspace_id WORKSPACE_ID [--notebook_conf_id NOTEBOOK_CONF_ID]
                 [--notebook_name NOTEBOOK_NAME] [--json-output [{pretty,default}]]
                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to get information about a specific Notebook
                        Configuration.
  --notebook_conf_id NOTEBOOK_CONF_ID
                        Provide Notebook Conf Id to get information about a specific
                        Notebook Configuration.
  --notebook_name NOTEBOOK_NAME
                        Provide Notebook Name to get information about a specific Notebook
                        Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • get-conf example with the optional and required arguments passed.
yeedu notebook get-conf --workspace_id=1 --notebook_conf_id=2
  • Console output
{
  "notebook_conf_id": 2,
  "notebook_name": "test_notebook",
  "cluster_info": {
    "cluster_id": 1,
    "name": "gcp_test",
    "cluster_status": "RUNNING",
    "cluster_type": "YEEDU",
    "instance_size": 1,
    "min_instances": 1,
    "max_instances": 1,
    "cluster_conf": {
      "cluster_conf_id": 10,
      "cluster_conf_name": "n1-standard-4",
      "machine_type_category": "general_purpose",
      "machine_type": {
        "machine_type_id": 10,
        "name": "n1-standard-4",
        "vCPUs": 4,
        "memory": "15 GiB",
        "has_cuda": false,
        "gpu_model": null,
        "gpus": 0,
        "gpu_memory": null,
        "cpu_model": [
          "Intel Xeon Scalable (Skylake) 1st Generation",
          "Intel Xeon E5 v4 (Broadwell E5)",
          "Intel Xeon E5 v3 (Haswell)",
          "Intel Xeon E5 v2 (Ivy Bridge)",
          "Intel Xeon E5 (Sandy Bridge)"
        ],
        "cpu_min_frequency_GHz": [
          "2.0",
          "2.2",
          "2.3",
          "2.5",
          "2.6"
        ],
        "cpu_max_frequency_GHz": [
          "3.5",
          "3.7",
          "3.8",
          "3.5",
          "3.6"
        ],
        "has_local_disk": false,
        "local_disk_size_GB": null,
        "local_num_of_disks": null,
        "local_disk_throughput_MB": null,
        "machine_price_ycu": 2.5
      },
      "machine_volume_conf": {
        "volume_conf_id": 2,
        "name": "volume_gcp_2",
        "size": 375,
        "machine_volume_num": 2,
        "machine_volume_strip_num": 2
      }
    },
    "cloud_env": {
      "cloud_env_id": 1,
      "name": "gcp",
      "cloud_provider": {
        "cloud_provider_id": 0,
        "name": "GCP"
      }
    },
    "spark_infra_version": {
      "spark_infra_version_id": 1,
      "spark_docker_image_name": "v3.2.2-20",
      "spark_version": "3.2.2",
      "hive_version": "3.2.3",
      "hadoop_version": "3.2.4",
      "scala_version": "2.12.15",
      "python_version": "3.9.5",
      "notebook_support": true,
      "has_cuda_support": true
    },
    "engine_cluster_spark_config": {
      "max_parallel_spark_job_execution_per_instance": 5,
      "num_of_workers": null
    }
  },
  "spark_job_type": {
    "job_type": "NOTEBOOK",
    "language": "Python3"
  },
  "max_concurrency": 1,
  "notebook_cells": {
    "cells": [
      {
        "cell_uuid": "9b6c637d-1183-4ac6-90a4-7a23f2b9ecae",
        "order": 0,
        "code": "",
        "output": [],
        "runStatus": false,
        "executionCount": 0,
        "isOutputError": false
      }
    ]
  },
  "files": null,
  "conf": null,
  "packages": null,
  "jars": null,
  "driver_memory": null,
  "driver_java_options": null,
  "driver_library_path": null,
  "driver_class_path": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-14T07:05:31.507399+00:00",
  "from_date": "2024-06-14T07:05:31.507399+00:00",
  "to_date": "infinity"
}

edit-conf​

yeedu notebook edit-conf -h
usage:  edit-conf [-h] --workspace_id WORKSPACE_ID
                  [--notebook_conf_id NOTEBOOK_CONF_ID]
                  [--notebook_name NOTEBOOK_NAME]
                  [--cluster_id CLUSTER_ID]
                  [--cluster_name CLUSTER_NAME] [--name [NAME]]
                  [--conf CONF [CONF ...]] [--files [FILES]]
                  [--jars [JARS]] [--packages [PACKAGES]]
                  [--driver-memory [DRIVER_MEMORY]]
                  [--executor-memory [EXECUTOR_MEMORY]]
                  [--driver-cores [DRIVER_CORES]]
                  [--total-executor-cores [TOTAL_EXECUTOR_CORES]]
                  [--executor-cores [EXECUTOR_CORES]]
                  [--num-executors [NUM_EXECUTORS]]
                  [--json-output [{pretty,default}]]
                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to edit a Notebook Configuration.
  --notebook_conf_id NOTEBOOK_CONF_ID
                        Provide Notbeook Conf Id to edit a Notebook Configuration.
  --notebook_name NOTEBOOK_NAME
                        Provide Notebook Name to edit a Notebook Configuration.
  --cluster_id CLUSTER_ID
                        Provide cluster_id to edit a Notebook Configuration.
  --cluster_name CLUSTER_NAME
                        Provide cluster_name to edit a Notebook Configuration.
  --name [NAME]         Provide name to edit notebook_name of a Notebook Configuration.
  --conf CONF [CONF ...]
                        Provide conf to edit a Notebook Configuration.
  --files [FILES]       Provide files to edit a Notebook Configuration.
  --jars [JARS]         Provide jars to edit a Notebook Configuration.
  --packages [PACKAGES]
                        Provide packages to edit a Notebook Configuration.
  --driver-memory [DRIVER_MEMORY]
                        Provide driver-memory to edit a Notebook Configuration.
  --executor-memory [EXECUTOR_MEMORY]
                        Provide executor-memory to edit a Notebook Configuration.
  --driver-cores [DRIVER_CORES]
                        Provide driver-cores to edit a Notebook Configuration.
  --total-executor-cores [TOTAL_EXECUTOR_CORES]
                        Provide total-executor-cores to edit a Notebook Configuration.
  --executor-cores [EXECUTOR_CORES]
                        Provide executor-cores to edit a Notebook Configuration.
  --num-executors [NUM_EXECUTORS]
                        Provide num-executors to edit a Notebook Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit-conf example with the required arguments and other optional arguments passed which is to be updated.
yeedu notebook edit-conf --workspace_id=1 --notebook_conf_id=2 --name=Notebook_01
  • Console output
{
  "notebook_conf_id": "2",
  "notebook_name": "Notebook_01",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 3,
  "max_concurrency": "1",
  "notebook_cells": {
    "cells": [
      {
        "cell_uuid": "9b6c637d-1183-4ac6-90a4-7a23f2b9ecae",
        "order": 0,
        "code": "",
        "output": [],
        "runStatus": false,
        "executionCount": 0,
        "isOutputError": false
      }
    ]
  },
  "notebook_cells_auto_save": null,
  "conf": null,
  "packages": null,
  "jars": null,
  "files": null,
  "driver_memory": null,
  "executor_memory": null,
  "driver_cores": null,
  "total_executor_cores": null,
  "executor_cores": null,
  "num_executors": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T07:12:00.012Z",
  "from_date": "2024-06-14T07:05:31.507Z",
  "to_date": null
}

enable-conf​

yeedu notebook enable-conf -h
usage:  enable-conf [-h] --workspace_id WORKSPACE_ID
                    [--notebook_conf_id NOTEBOOK_CONF_ID]
                    [--notebook_name NOTEBOOK_NAME]
                    [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to enable the Notebook Configuration.
  --notebook_conf_id NOTEBOOK_CONF_ID
                        Provide Notebook Conf Id to enable the Notebook Configuration.
  --notebook_name NOTEBOOK_NAME
                        Provide Notebook Name to enable the Notebook Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • enable-conf example with the required arguments passed.
yeedu notebook enable-conf --workspace_id=1 --notebook_conf_id=2
  • Console output
{
  "notebook_conf_id": "2",
  "notebook_name": "Notebook_01",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 3,
  "max_concurrency": "1",
  "notebook_cells": {
    "cells": [
      {
        "cell_uuid": "9b6c637d-1183-4ac6-90a4-7a23f2b9ecae",
        "order": 0,
        "code": "",
        "output": [],
        "runStatus": false,
        "executionCount": 0,
        "isOutputError": false
      }
    ]
  },
  "notebook_cells_auto_save": null,
  "conf": null,
  "packages": null,
  "jars": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T07:13:24.656Z",
  "from_date": "2024-06-14T07:05:31.507Z",
  "to_date": null
}

disable-conf​

yeedu notebook disable-conf -h
usage:  disable-conf [-h] --workspace_id WORKSPACE_ID
                     [--notebook_conf_id NOTEBOOK_CONF_ID]
                     [--notebook_name NOTEBOOK_NAME]
                     [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to disable the Notebook Configuration.
  --notebook_conf_id NOTEBOOK_CONF_ID
                        Provide Notebook Conf Id to disable the Notebook Configuration.
  --notebook_name NOTEBOOK_NAME
                        Provide Notebook Name to disable the Notebook Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • disable-conf example with the required arguments passed.
yeedu notebook disable-conf --workspace_id=1 --notebook_conf_id=2
  • Console output
{
  "notebook_conf_id": "2",
  "notebook_name": "Notebook_01",
  "cluster_id": "1",
  "workspace_id": "1",
  "spark_job_type_lang_id": 3,
  "max_concurrency": "1",
  "notebook_cells": {
    "cells": [
      {
        "cell_uuid": "9b6c637d-1183-4ac6-90a4-7a23f2b9ecae",
        "order": 0,
        "code": "",
        "output": [],
        "runStatus": false,
        "executionCount": 0,
        "isOutputError": false
      }
    ]
  },
  "notebook_cells_auto_save": null,
  "conf": null,
  "packages": null,
  "jars": null,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T07:12:37.380Z",
  "from_date": "2024-06-14T07:05:31.507Z",
  "to_date": "2024-06-14T07:12:37.380Z"
}

export​

yeedu notebook export -h
usage:  export [-h] --workspace_id WORKSPACE_ID [--notebook_conf_id NOTEBOOK_CONF_ID]
               [--notebook_name NOTEBOOK_NAME] [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to export a specific Notebook Configuration
                        from it.
  --notebook_conf_id NOTEBOOK_CONF_ID
                        Provide Notebook Config Id to export a specific Notebook
                        Configuration.
  --notebook_name NOTEBOOK_NAME
                        Provide Notebook name to export a specific Notebook
                        Configuration.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • export example with the required arguments passed.
yeedu notebook export --workspace_id=1 --notebook_conf_id=1
  • Console output
{
  "jobs": [
    {
      "name": "test_notebook_1",
      "spark_job_type": {
        "job_type": "NOTEBOOK",
        "language": "Python3"
      },
      "cluster_info": {
        "cluster_name": "gcp_cluster",
        "cluster_type": "YEEDU"
      },
      "notebook_cells": {
        "cells": [
          {
            "code": "print(\"hello\")",
            "cell_uuid": "f98e6834-09e2-4c59-84d6-130769c9d182"
          }
        ]
      },
      "conf": [],
      "packages": [],
      "jars": [],
      "files": [],
      "driver_memory": null,
      "executor_memory": null,
      "driver_cores": null,
      "total_executor_cores": null,
      "executor_cores": null,
      "num_executors": null
    }
  ]
}

Notebook Instance​

Command NameUtility
startTo start a Notebook Instance.
kernel-startTo start a kernel of a Notebook Instance.
kernel-statusTo get the status of the kernel of a Notebook Instance.
kernel-interruptTo interrupt a kernel of a Notebook Instance.
kernel-restartTo restart a kernel of a Notebook Instance.
listTo list all the available Notebook Instances.
searchTo search Notebook Instances by similar notebook name.
getTo get information about a specific Notebook Instance.
stopTo stop a specific Notebook Instance.
logsTo download Notebook Instance logs.

start​

yeedu notebook start -h
usage:  start [-h] --workspace_id WORKSPACE_ID
              [--notebook_conf_id NOTEBOOK_CONF_ID]
              [--notebook_name NOTEBOOK_NAME]
              [--json-output [{pretty,default}]]
              [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To start a Notebook Instance, enter workspace_id.
  --notebook_conf_id NOTEBOOK_CONF_ID
                        To start a Notebook Instance, enter notebook_conf_id.
  --notebook_name NOTEBOOK_NAME
                        To start a Notebook Instance, enter notebook_name.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • start example with one of the required argument passed.
yeedu notebook start --workspace_id=1 --notebook_conf_id=2
  • Console output
{
  "notebook_id": "6",
  "notebook_conf_id": "2",
  "cluster_id": "1",
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T07:14:00.801Z",
  "from_date": "2024-06-14T07:14:00.801Z",
  "to_date": null
}

kernel-start​

yeedu notebook kernel-start -h
usage:  kernel-start [-h] --workspace_id WORKSPACE_ID --notebook_id NOTEBOOK_ID
                     [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To start a kernel of a Notebook Instance, enter workspace_id.
  --notebook_id NOTEBOOK_ID
                        To start a kernel of a Notebook Instance, enter notebook
                        instance id.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • kernel-start example with all the required arguments passed.
yeedu notebook kernel-start --workspace_id=1 --notebook_id=6
  • Console output
{
  "notebook_id": 6,
  "kernel_info": {
    "kernel_id": "bb1e6741-dac6-4bdb-83f6-8e683979248e",
    "kernel_status": "starting"
  }
}

kernel-status​

yeedu notebook kernel-status -h
usage:  kernel-status [-h] --workspace_id WORKSPACE_ID --notebook_id NOTEBOOK_ID [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To get the status of the kernel, enter workspace_id.
  --notebook_id NOTEBOOK_ID
                        To get the status of the kernel for a Notebook Instance, enter notebook instance id.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • kernel-status example with all the required arguments passed.
yeedu notebook kernel-status --workspace_id=1 --notebook_id=1
  • Console output
{
  "notebook_id": 1,
  "kernel_info": {
    "kernel_id": "71e6acb5-d4d8-4311-a4a3-7f8a8d6a0291",
    "kernel_status": "idle"
  }
}

kernel-interrupt​

yeedu notebook kernel-interrupt -h
usage:  kernel-interrupt [-h] --workspace_id WORKSPACE_ID --notebook_id NOTEBOOK_ID
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To interrupt a kernel of a Notebook Instance, enter
                        workspace_id.
  --notebook_id NOTEBOOK_ID
                        To interrupt a kernel of a Notebook Instance, enter notebook
                        instance id.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • kernel-interrupt example with required and optional arguments passed.
yeedu notebook kernel-interrupt --workspace_id=1 --notebook_id=6
  • Console output
{
  "notebook_id": 6,
  "kernel_info": {
    "kernel_id": "bb1e6741-dac6-4bdb-83f6-8e683979248e",
    "kernel_status": "starting"
  }
}

kernel-restart​

yeedu notebook kernel-restart -h
usage:  kernel-restart [-h] --workspace_id WORKSPACE_ID --notebook_id NOTEBOOK_ID
                       [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To restart a kernel of a Notebook Instance, enter workspace_id.
  --notebook_id NOTEBOOK_ID
                        To restart a kernel of a Notebook Instance, enter notebook
                        instance id.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • kernel-restart example with all the required arguments passed.
yeedu notebook kernel-restart --workspace_id=1 --notebook_id=6
  • Console output
{
  "notebook_id": 6,
  "kernel_info": {
    "kernel_id": "bb1e6741-dac6-4bdb-83f6-8e683979248e",
    "kernel_status": "busy"
  }
}

list​

yeedu notebook list -h
usage:  list [-h] --workspace_id WORKSPACE_ID [--cluster_ids [CLUSTER_IDS]]
             [--notebook_conf_ids [NOTEBOOK_CONF_IDS]]
             [--notebook_status [NOTEBOOK_STATUS]]
             [--job_type_langs [JOB_TYPE_LANGS]]
             [--created_by_ids [CREATED_BY_IDS]]
             [--modified_by_ids [MODIFIED_BY_IDS]] [--page_number PAGE_NUMBER]
             [--limit LIMIT] [--json-output [{pretty,default}]]
             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        To list Notebook Instances of a specific workspace_id.
  --cluster_ids [CLUSTER_IDS]
                        To list Notebook Instances for optional set of cluster
                        Ids.
  --notebook_conf_ids [NOTEBOOK_CONF_IDS]
                        To list Notebook Instances for optional set of Notebook
                        configuration Ids.
  --notebook_status [NOTEBOOK_STATUS]
                        To list Notebook Instances for optional set of
                        notebook_status. Choices are: submitted, running, done,
                        error, terminated, stopping, stopped
  --job_type_langs [JOB_TYPE_LANGS]
                        An optional set of language filter for Notebook Instances.
                        Choices are: Python3, Scala
  --created_by_ids [CREATED_BY_IDS]
                        To list Notebook Instances for optional set of created by
                        user Ids.
  --modified_by_ids [MODIFIED_BY_IDS]
                        To list Notebook Instances for optional set of modified by
                        user Ids.
  --page_number PAGE_NUMBER
                        To list Notebook Instances for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of job instances. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • list example with all the required and optional arguments passed.
yeedu notebook list --workspace_id=1 --notebook_status=running
  • Console output
{
  "data": [
    {
      "notebook_id": 6,
      "notebook_url": "http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.yeedu.internal:8888",
      "notebook_status": "RUNNING",
      "notebook_conf": {
        "notebook_conf_id": 2,
        "notebook_name": "Notebook_01",
        "notebook_job_type": {
          "job_type": "NOTEBOOK",
          "language": "Python3"
        },
        "cluster_info": {
          "cluster_id": 1,
          "name": "gcp_test",
          "cluster_status": "RUNNING",
          "cluster_type": "YEEDU",
          "instance_size": 1,
          "min_instances": 1,
          "max_instances": 1,
          "cloud_env": {
            "cloud_env_id": 1,
            "name": "gcp",
            "cloud_provider": {
              "cloud_provider_id": 0,
              "name": "GCP"
            }
          },
          "cluster_conf": {
            "cluster_conf_id": 10,
            "cluster_conf_name": "n1-standard-4",
            "machine_type_category": "general_purpose",
            "machine_type": {
              "machine_type_id": 10,
              "name": "n1-standard-4",
              "vCPUs": 4,
              "memory": "15 GiB",
              "has_cuda": false,
              "gpu_model": null,
              "gpus": 0,
              "gpu_memory": null,
              "cpu_model": [
                "Intel Xeon Scalable (Skylake) 1st Generation",
                "Intel Xeon E5 v4 (Broadwell E5)",
                "Intel Xeon E5 v3 (Haswell)",
                "Intel Xeon E5 v2 (Ivy Bridge)",
                "Intel Xeon E5 (Sandy Bridge)"
              ],
              "cpu_min_frequency_GHz": [
                "2.0",
                "2.2",
                "2.3",
                "2.5",
                "2.6"
              ],
              "cpu_max_frequency_GHz": [
                "3.5",
                "3.7",
                "3.8",
                "3.5",
                "3.6"
              ],
              "has_local_disk": false,
              "local_disk_size_GB": null,
              "local_num_of_disks": null,
              "local_disk_throughput_MB": null,
              "machine_price_ycu": 2.5
            },
            "machine_volume_conf": {
              "volume_conf_id": 2,
              "name": "volume_gcp_2",
              "size": 375,
              "machine_volume_num": 2,
              "machine_volume_strip_num": 2
            }
          },
          "spark_infra_version": {
            "spark_infra_version_id": 1,
            "spark_docker_image_name": "v3.2.2-20",
            "spark_version": "3.2.2",
            "hive_version": "3.2.3",
            "hadoop_version": "3.2.4",
            "scala_version": "2.12.15",
            "python_version": "3.9.5",
            "notebook_support": true,
            "has_cuda_support": true
          },
          "engine_cluster_spark_config": {
            "max_parallel_spark_job_execution_per_instance": 5,
            "num_of_workers": null
          }
        }
      },
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T07:14:00.801317+00:00",
      "from_date": "2024-06-14T07:14:00.801317+00:00",
      "to_date": "infinity"
    }
  ]
}

search​

yeedu notebook search -h
usage:  search [-h] --workspace_id WORKSPACE_ID --notebook_name NOTEBOOK_NAME
               [--cluster_ids [CLUSTER_IDS]]
               [--notebook_conf_ids [NOTEBOOK_CONF_IDS]]
               [--notebook_status [NOTEBOOK_STATUS]]
               [--job_type_langs [JOB_TYPE_LANGS]]
               [--created_by_ids [CREATED_BY_IDS]]
               [--modified_by_ids [MODIFIED_BY_IDS]] [--page_number PAGE_NUMBER]
               [--limit LIMIT] [--json-output [{pretty,default}]]
               [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to search Notebook Instances in it.
  --notebook_name NOTEBOOK_NAME
                        Provide notebook_name to search Notebook Instances.
  --cluster_ids [CLUSTER_IDS]
                        To search Notebook Instances for optional set of cluster
                        Ids.
  --notebook_conf_ids [NOTEBOOK_CONF_IDS]
                        To search Notebook Instances for optional set of Notebook
                        configuration Ids.
  --notebook_status [NOTEBOOK_STATUS]
                        To search Notebook Instances for optional set of
                        notebook_status. Choices are: submitted, running, done,
                        error, terminated, stopping, stopped
  --job_type_langs [JOB_TYPE_LANGS]
                        An optional set of language filter for Notebook Instances.
                        Choices are: Python3, Scala
  --created_by_ids [CREATED_BY_IDS]
                        To search Notebook Instances for optional set of created
                        by user Ids.
  --modified_by_ids [MODIFIED_BY_IDS]
                        To search Notebook Instances for optional set of modified
                        by user Ids.
  --page_number PAGE_NUMBER
                        To search Notebook Instances for a specific page_number.
                        (default: 1)
  --limit LIMIT         Provide limit to search number of Notebook Instances.
                        (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search example with all the required and optional arguments passed.
yeedu notebook search --workspace_id=1 --notebook_name="Note" --limit=1
  • Console output
{
  "data": [
    {
      "notebook_id": 6,
      "notebook_url": "http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.yeedu.internal:8888",
      "notebook_status": "RUNNING",
      "notebook_conf": {
        "notebook_conf_id": 2,
        "notebook_name": "Notebook_01",
        "notebook_job_type": {
          "job_type": "NOTEBOOK",
          "language": "Python3"
        },
        "cluster_info": {
          "cluster_id": 1,
          "name": "gcp_test",
          "cluster_status": "RUNNING",
          "cluster_type": "YEEDU",
          "instance_size": 1,
          "min_instances": 1,
          "max_instances": 1,
          "cloud_env": {
            "cloud_env_id": 1,
            "name": "gcp",
            "cloud_provider": {
              "cloud_provider_id": 0,
              "name": "GCP"
            }
          },
          "cluster_conf": {
            "cluster_conf_id": 10,
            "cluster_conf_name": "n1-standard-4",
            "machine_type_category": "general_purpose",
            "machine_type": {
              "machine_type_id": 10,
              "name": "n1-standard-4",
              "vCPUs": 4,
              "memory": "15 GiB",
              "has_cuda": false,
              "gpu_model": null,
              "gpus": 0,
              "gpu_memory": null,
              "cpu_model": [
                "Intel Xeon Scalable (Skylake) 1st Generation",
                "Intel Xeon E5 v4 (Broadwell E5)",
                "Intel Xeon E5 v3 (Haswell)",
                "Intel Xeon E5 v2 (Ivy Bridge)",
                "Intel Xeon E5 (Sandy Bridge)"
              ],
              "cpu_min_frequency_GHz": [
                "2.0",
                "2.2",
                "2.3",
                "2.5",
                "2.6"
              ],
              "cpu_max_frequency_GHz": [
                "3.5",
                "3.7",
                "3.8",
                "3.5",
                "3.6"
              ],
              "has_local_disk": false,
              "local_disk_size_GB": null,
              "local_num_of_disks": null,
              "local_disk_throughput_MB": null,
              "machine_price_ycu": 2.5
            },
            "machine_volume_conf": {
              "volume_conf_id": 2,
              "name": "volume_gcp_2",
              "size": 375,
              "machine_volume_num": 2,
              "machine_volume_strip_num": 2
            }
          },
          "spark_infra_version": {
            "spark_infra_version_id": 1,
            "spark_docker_image_name": "v3.2.2-20",
            "spark_version": "3.2.2",
            "hive_version": "3.2.3",
            "hadoop_version": "3.2.4",
            "scala_version": "2.12.15",
            "python_version": "3.9.5",
            "notebook_support": true,
            "has_cuda_support": true
          },
          "engine_cluster_spark_config": {
            "max_parallel_spark_job_execution_per_instance": 5,
            "num_of_workers": null
          }
        }
      },
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T07:14:00.801317+00:00",
      "from_date": "2024-06-14T07:14:00.801317+00:00",
      "to_date": "infinity"
    }
  ]
}

get​

yeedu notebook get -h
usage:  get [-h] --workspace_id WORKSPACE_ID --notebook_id NOTEBOOK_ID
            [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to get information about a specific
                        Notebook Instance.
  --notebook_id NOTEBOOK_ID
                        Provide notebook instance id to get information about a specific
                        Notebook Instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get example with all the required arguments passed.
yeedu notebook get --workspace_id=1 --notebook_id=6
  • Console output
{
  "notebook_id": 6,
  "notebook_url": "http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.yeedu.internal:8888",
  "notebook_status": "RUNNING",
  "job_execution_time_sec": 484.339894,
  "total_job_time_sec": 486.846376,
  "notebook_conf": {
    "notebook_conf_id": 2,
    "notebook_name": "Notebook_01",
    "notebook_job_type": {
      "job_type": "NOTEBOOK",
      "language": "Python3"
    },
    "cluster_info": {
      "cluster_id": 1,
      "name": "gcp_test",
      "cluster_status": "RUNNING",
      "cluster_type": "YEEDU",
      "instance_size": 1,
      "min_instances": 1,
      "max_instances": 1,
      "cloud_env": {
        "cloud_env_id": 1,
        "name": "gcp",
        "cloud_provider": {
          "cloud_provider_id": 0,
          "name": "GCP"
        }
      },
      "cluster_conf": {
        "cluster_conf_id": 10,
        "cluster_conf_name": "n1-standard-4",
        "machine_type_category": "general_purpose",
        "machine_type": {
          "machine_type_id": 10,
          "name": "n1-standard-4",
          "vCPUs": 4,
          "memory": "15 GiB",
          "has_cuda": false,
          "gpu_model": null,
          "gpus": 0,
          "gpu_memory": null,
          "cpu_model": [
            "Intel Xeon Scalable (Skylake) 1st Generation",
            "Intel Xeon E5 v4 (Broadwell E5)",
            "Intel Xeon E5 v3 (Haswell)",
            "Intel Xeon E5 v2 (Ivy Bridge)",
            "Intel Xeon E5 (Sandy Bridge)"
          ],
          "cpu_min_frequency_GHz": [
            "2.0",
            "2.2",
            "2.3",
            "2.5",
            "2.6"
          ],
          "cpu_max_frequency_GHz": [
            "3.5",
            "3.7",
            "3.8",
            "3.5",
            "3.6"
          ],
          "has_local_disk": false,
          "local_disk_size_GB": null,
          "local_num_of_disks": null,
          "local_disk_throughput_MB": null,
          "machine_price_ycu": 2.5
        },
        "machine_volume_conf": {
          "volume_conf_id": 2,
          "name": "volume_gcp_2",
          "size": 375,
          "machine_volume_num": 2,
          "machine_volume_strip_num": 2
        }
      },
      "spark_infra_version": {
        "spark_infra_version_id": 1,
        "spark_docker_image_name": "v3.2.2-20",
        "spark_version": "3.2.2",
        "hive_version": "3.2.3",
        "hadoop_version": "3.2.4",
        "scala_version": "2.12.15",
        "python_version": "3.9.5",
        "notebook_support": true,
        "has_cuda_support": true
      },
      "engine_cluster_spark_config": {
        "max_parallel_spark_job_execution_per_instance": 5,
        "num_of_workers": null
      }
    }
  },
  "workflow_job_instance_details": {
    "workflow_job_instance_status": {
      "workflow_job_instance_id": 7,
      "workflow_job_id": 7,
      "status": "EXECUTING",
      "from_date": "2024-06-14T07:14:00.801317+00:00",
      "to_date": "infinity"
    },
    "workflow_execution_process": {
      "machine_pid_number": "940",
      "machine_hostname": "yeedu1-bcd2b294-deb1-10c9-0b8e-8e471e5c46f3",
      "machine_id": "bcd2b294-deb1-10c9-0b8e-8e471e5c46f3",
      "machine_pid_user": "root",
      "machine_node_number": "0"
    }
  },
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-14T07:14:00.801317+00:00",
  "from_date": "2024-06-14T07:14:00.801317+00:00",
  "to_date": "infinity"
}

stop​

yeedu notebook stop -h
usage:  stop [-h] --workspace_id WORKSPACE_ID --notebook_id NOTEBOOK_ID
             [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide workspace id to stop a specific Notebook Instance.
  --notebook_id NOTEBOOK_ID
                        Provide notebook instance id to stop a specific Notebook
                        Instance.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • stop example with all the required argument passed.
yeedu notebook stop --workspace_id=1 --notebook_id=6
  • Console output
{
  "SparkKill": {
    "workflow_job_id": 7,
    "workflow_job_instance_id": 7,
    "spark_job_instance_id": 6,
    "spark_job_id": 2,
    "compute_engine_id": 1
  }
}

logs​

yeedu notebook logs -h
usage:  logs [-h] --workspace_id WORKSPACE_ID --notebook_id NOTEBOOK_ID
             [--log_type {stdout,stderr}] [--json-output [{pretty,default}]]
             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --workspace_id WORKSPACE_ID
                        Provide Workspace Id to download Notebook Instance logs.
  --notebook_id NOTEBOOK_ID
                        Provide Notebook Id to download Notebook Instance logs.
  --log_type {stdout,stderr}
                        Provide log type to download Notebook Instance logs. (default:
                        stdout)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • logs example with all the required arguments passed.
yeedu notebook logs --workspace_id=1 --notebook_id=6 --log_type="stderr"
  • Console output
[I 2024-06-14 07:28:42.657 ServerApp] jupyter_lsp | extension was successfully linked.
[I 2024-06-14 07:28:42.663 ServerApp] jupyter_server_terminals | extension was successfully linked.
[I 2024-06-14 07:28:42.669 ServerApp] jupyterlab | extension was successfully linked.
[I 2024-06-14 07:28:42.675 ServerApp] notebook | extension was successfully linked.
[I 2024-06-14 07:28:42.974 ServerApp] notebook_shim | extension was successfully linked.
[I 2024-06-14 07:28:43.000 ServerApp] notebook_shim | extension was successfully loaded.
[I 2024-06-14 07:28:43.003 ServerApp] jupyter_lsp | extension was successfully loaded.
[I 2024-06-14 07:28:43.005 ServerApp] jupyter_server_terminals | extension was successfully loaded.
[I 2024-06-14 07:28:43.007 LabApp] JupyterLab extension loaded from /usr/local/lib/python3.9/dist-packages/jupyterlab
[I 2024-06-14 07:28:43.007 LabApp] JupyterLab application directory is /usr/local/share/jupyter/lab
[I 2024-06-14 07:28:43.008 LabApp] Extension Manager is 'pypi'.
[I 2024-06-14 07:28:43.026 ServerApp] jupyterlab | extension was successfully loaded.
[I 2024-06-14 07:28:43.031 ServerApp] notebook | extension was successfully loaded.
[I 2024-06-14 07:28:43.032 ServerApp] Serving notebooks from local directory: /opt/spark
[I 2024-06-14 07:28:43.032 ServerApp] Jupyter Server 2.14.1 is running at:
[I 2024-06-14 07:28:43.032 ServerApp] http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.yeedu.internal:8888/tree?token=5d2d7e2eeb0c96faf0f8b34dcbf29ca6fcfd643140fe7b38
[I 2024-06-14 07:28:43.032 ServerApp]     http://127.0.0.1:8888/tree?token=5d2d7e2eeb0c96faf0f8b34dcbf29ca6fcfd643140fe7b38
[I 2024-06-14 07:28:43.032 ServerApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
[C 2024-06-14 07:28:43.038 ServerApp]

...
...
    To access the server, open this file in a browser:
        file:///root/.local/share/jupyter/runtime/jpserver-1694-open.html
    Or copy and paste one of these URLs:
        http://yeedu3-87cdc71b-e8ad-cbda-15b3-ec4694e7826a.us-central1-a.c.yeedu.internal:8888/tree?token=5d2d7e2eeb0c96faf0f8b34dcbf29ca6fcfd643140fe7b38
        http://127.0.0.1:8888/tree?token=5d2d7e2eeb0c96faf0f8b34dcbf29ca6fcfd643140fe7b38
...

Using Spark's default log4j profile: org/apache/spark/log4j-defaults.properties
Setting default log level to "WARN".
To adjust logging level use sc.setLogLevel(newLevel). For SparkR, use setLogLevel(newLevel).
...

Billing

Command NameUtility
tenantsTo retrieve a list of billed tenants.
date-rangeTo retrieve a list of billed date range.
clustersTo retrieve a list of billed clusters.
machine-typesTo retrieve a list of billed machine types.
labelsTo retrieve a list of billed cluster labels.
usageTo list the billed usage.
invoiceTo list the billed invoice.

tenants​

yeedu billing tenants -h
usage:  tenants [-h] [--billing_type [{usage,invoice}]]
                [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --billing_type [{usage,invoice}]
                        Specifies the billing type to be used as a filter. (default:
                        usage)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • tenants example.
yeedu billing tenants
  • Console output
[
  {
    "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289",
    "tenant_name": "yeedu_dev_gang"
  },
  {
    "tenant_id": "ec234745-4625-4abc-9ae7-1f8a9a9090b3",
    "tenant_name": "demo_tenant"
  }
]

date-range​

yeedu billing date-range -h
usage:  date-range [-h] [--billing_type [{usage,invoice}]] [--tenant_ids [TENANT_IDS]]
                   [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --billing_type [{usage,invoice}]
                        Specifies the billing type to be used as a filter. (default:
                        usage)
  --tenant_ids [TENANT_IDS]
                        Specifies the tenant IDs to be used as a filter.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • date-range example with an optional argument passed.
yeedu billing date-range --billing_type=usage
  • Console output
{
  "dates": [
    "2024-06-26",
    "2024-06-25"
  ]
}

clusters​

yeedu billing clusters -h
usage:  clusters [-h] [--billing_type [{usage,invoice}]] [--tenant_ids [TENANT_IDS]]
                 [--cloud_providers [CLOUD_PROVIDERS]]
                 [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --billing_type [{usage,invoice}]
                        Specifies the billing type to be used as a filter. (default:
                        usage)
  --tenant_ids [TENANT_IDS]
                        Specifies the tenant IDs to be used as a filter.
  --cloud_providers [CLOUD_PROVIDERS]
                        Specifies the cloud providers to be used as a filter. Choices
                        are: GCP, AWS, Azure
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • clusters example with one of the optional argument passed.
yeedu billing clusters --billing_type=usage
  • Console output
[
  {
    "cluster_id": 8,
    "cluster_name": "gcp_cluster",
    "tenant_id": "ec234745-4625-4abc-9ae7-1f8a9a9090b3",
    "tenant_name": "demo_tenant",
    "cloud_provider_id": 0,
    "cloud_provider_name": "GCP"
  },
  {
    "cluster_id": 7,
    "cluster_name": "aws_cluster",
    "tenant_id": "ec234745-4625-4abc-9ae7-1f8a9a9090b3",
    "tenant_name": "demo_tenant",
    "cloud_provider_id": 1,
    "cloud_provider_name": "AWS"
  },
  {
    "cluster_id": 6,
    "cluster_name": "spring",
    "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289",
    "tenant_name": "yeedu_dev_gang",
    "cloud_provider_id": 2,
    "cloud_provider_name": "Azure"
  },
  {
    "cluster_id": 5,
    "cluster_name": "winter",
    "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289",
    "tenant_name": "yeedu_dev_gang",
    "cloud_provider_id": 1,
    "cloud_provider_name": "AWS"
  },
  {
    "cluster_id": 4,
    "cluster_name": "summer",
    "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289",
    "tenant_name": "yeedu_dev_gang",
    "cloud_provider_id": 0,
    "cloud_provider_name": "GCP"
  },
  {
    "cluster_id": 3,
    "cluster_name": "performance_test",
    "tenant_id": "ec234745-4625-4abc-9ae7-1f8a9a9090b3",
    "tenant_name": "demo_tenant",
    "cloud_provider_id": 1,
    "cloud_provider_name": "AWS"
  },
  {
    "cluster_id": 2,
    "cluster_name": "dev_test_cluster",
    "tenant_id": "ec234745-4625-4abc-9ae7-1f8a9a9090b3",
    "tenant_name": "demo_tenant",
    "cloud_provider_id": 1,
    "cloud_provider_name": "AWS"
  },
  {
    "cluster_id": 1,
    "cluster_name": "500k_jobs_load_test_cluster",
    "tenant_id": "ec234745-4625-4abc-9ae7-1f8a9a9090b3",
    "tenant_name": "demo_tenant",
    "cloud_provider_id": 1,
    "cloud_provider_name": "AWS"
  }
]

machine-types​

yeedu billing machine-types -h
usage:  machine-types [-h] [--billing_type [{usage,invoice}]]
                      [--tenant_ids [TENANT_IDS]] [--cloud_providers [CLOUD_PROVIDERS]]
                      [--cluster_ids [CLUSTER_IDS]] [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --billing_type [{usage,invoice}]
                        Specifies the billing type to be used as a filter. (default:
                        usage)
  --tenant_ids [TENANT_IDS]
                        Specifies the tenant IDs to be used as a filter.
  --cloud_providers [CLOUD_PROVIDERS]
                        Specifies the cloud providers to be used as a filter. Choices
                        are: GCP, AWS, Azure
  --cluster_ids [CLUSTER_IDS]
                        Specifies the cluster instance IDs to be used as a filter.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • machine-types example with one of the optional argument passed.
yeedu billing machine-types --billing_type=usage
  • Console output
[
  {
    "machine_type_id": 87,
    "machine_type_name": "m5d.4xlarge"
  },
  {
    "machine_type_id": 10,
    "machine_type_name": "n1-standard-4"
  },
  {
    "machine_type_id": 86,
    "machine_type_name": "m5d.2xlarge"
  },
  {
    "machine_type_id": 89,
    "machine_type_name": "m5d.xlarge"
  },
  {
    "machine_type_id": 213,
    "machine_type_name": "Standard_D4ads_v5"
  }
]

labels​

yeedu billing labels -h
usage:  labels [-h] [--billing_type [{usage,invoice}]] [--tenant_ids [TENANT_IDS]]
               [--cloud_providers [CLOUD_PROVIDERS]] [--cluster_ids [CLUSTER_IDS]]
               [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --billing_type [{usage,invoice}]
                        Specifies the billing type to be used as a filter. (default:
                        usage)
  --tenant_ids [TENANT_IDS]
                        Specifies the tenant IDs to be used as a filter.
  --cloud_providers [CLOUD_PROVIDERS]
                        Specifies the cloud providers to be used as a filter. Choices
                        are: GCP, AWS, Azure
  --cluster_ids [CLUSTER_IDS]
                        Specifies the cluster instance IDs to be used as a filter.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • labels example with one of the optional argument passed.
yeedu billing labels --billing_type=usage
  • Console output
{
  "created-for": [
    "dev_jobs_test",
    "load-test"
  ],
  "resource": [
    "yeedu"
  ],
  "team": [
    "summer",
    "spring"
  ],
  "tenant_id": [
    "d1061751-19f2-49d0-8072-270144ddf289",
    "ec234745-4625-4abc-9ae7-1f8a9a9090b3"
  ],
  "vm": [
    "yeedu_node"
  ]
}

usage​

yeedu billing usage -h
usage:  usage [-h] [--tenant_ids [TENANT_IDS]] --start_date START_DATE --end_date
              END_DATE [--cloud_providers [CLOUD_PROVIDERS]]
              [--cluster_ids [CLUSTER_IDS]] [--machine_type_ids [MACHINE_TYPE_IDS]]
              [--labels LABELS [LABELS ...]] [--json-output [{pretty,default}]]
              [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_ids [TENANT_IDS]
                        Provide the tenant_ids to list billed usage.
  --start_date START_DATE
                        Provide the start_date of billed date.
  --end_date END_DATE   Provide the end_date of billed date.
  --cloud_providers [CLOUD_PROVIDERS]
                        Provide cloud_providers to list billed usage for given cloud
                        providers. Choices are: GCP, AWS, Azure
  --cluster_ids [CLUSTER_IDS]
                        Provide the cluster_ids to list billed usage.
  --machine_type_ids [MACHINE_TYPE_IDS]
                        Provide the machine_type_ids to list billed usage.
  --labels LABELS [LABELS ...]
                        Provide the labels key-value pair to list billed usage.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • usage example with the optional and required arguments passed.
yeedu billing usage --start_date="2024-06-26" --end_date="2024-06-27" --labels="team=summer"
  • Console output
{
  "usage": [
    {
      "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289",
      "tenant_name": "yeedu_dev_gang",
      "cluster_id": 4,
      "cluster_name": "summer",
      "cluster_labels": {
        "team": "summer",
        "resource": "yeedu",
        "vm": "yeedu_node",
        "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289"
      },
      "cloud_provider_id": 0,
      "cloud_provider_name": "GCP",
      "machine_type_id": 10,
      "machine_type": "n1-standard-4",
      "machine_price_ycu_hour": 2.5,
      "total_daily_minutes": 28,
      "total_daily_ycu": 1.1666666666666667,
      "checkpoint_day": "2024-06-26T00:00:00+00:00",
      "from_date": "2024-06-27T00:24:23.11089+00:00",
      "to_date": "infinity"
    }
  ],
  "usage_overview": {
    "overall_total_minutes": 28,
    "overall_total_ycu": 1.1666666666666667,
    "total_clusters_count": 1,
    "total_tenants": 1
  }
}

invoice​

yeedu billing invoice -h
usage:  invoice [-h] [--tenant_ids [TENANT_IDS]] --start_month_year START_MONTH_YEAR
                --end_month_year END_MONTH_YEAR [--cloud_providers [CLOUD_PROVIDERS]]
                [--cluster_ids [CLUSTER_IDS]] [--machine_type_ids [MACHINE_TYPE_IDS]]
                [--labels LABELS [LABELS ...]] [--json-output [{pretty,default}]]
                [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_ids [TENANT_IDS]
                        Provide the tenant_ids.
  --start_month_year START_MONTH_YEAR
                        Provide the start_month_year of billed date.
  --end_month_year END_MONTH_YEAR
                        Provide the end_month_year of billed date.
  --cloud_providers [CLOUD_PROVIDERS]
                        Provide cloud_providers to list billed invoice for given cloud
                        providers. Choices are: GCP, AWS, Azure
  --cluster_ids [CLUSTER_IDS]
                        Provide the cluster_ids to list billed invoice.
  --machine_type_ids [MACHINE_TYPE_IDS]
                        Provide the machine_type_ids list billed invoice.
  --labels LABELS [LABELS ...]
                        Provide the labels as key-value pair list billed invoice.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • invoice example with the optional and required arguments passed.
yeedu billing invoice --start_month_year="2024-05-01" --end_month_year="2024-06-01" --labels="team=summer"
  • Console output
{
  "invoice": [
    {
      "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289",
      "tenant_name": "yeedu_dev_gang",
      "cluster_id": 4,
      "cluster_name": "summer",
      "cluster_labels": {
        "team": "summer",
        "resource": "yeedu",
        "vm": "yeedu_node",
        "tenant_id": "d1061751-19f2-49d0-8072-270144ddf289"
      },
      "cloud_provider_id": 0,
      "cloud_provider_name": "GCP",
      "machine_type_id": 10,
      "machine_type": "n1-standard-4",
      "machine_price_ycu_hour": 2.5,
      "total_monthly_minutes": 236,
      "total_monthly_ycu": 9.833333333333334,
      "checkpoint_month": "2024-06-01T00:00:00+00:00",
      "from_date": "2024-06-30T00:00:00+00:00",
      "to_date": "infinity"
    }
  ],
  "invoice_overview": {
    "overall_total_minutes": 236,
    "overall_total_ycu": 9.833333333333334,
    "total_clusters_count": 1,
    "total_tenants": 1
  }
}

IAM (Identity and Access Management)

User​

Command NameUtility
search-tenantsRetrieves a list of tenants based on a search by tenant name.
get-user-infoTo get information about current session user.
get-user-rolesTo get all the roles of current session user.

search-tenants​

yeedu iam search-tenants -h
usage:  search-tenants [-h] --tenant_name TENANT_NAME [--page_number PAGE_NUMBER]
                       [--limit LIMIT] [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_name TENANT_NAME
                        Specifies the name of the tenant to search for.
  --page_number PAGE_NUMBER
                        Specifies the page number for the items to return. (default: 1)
  --limit LIMIT         Specifies the numbers of items to return. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'.
                        (default: false)
  • search-tenants example with required arguments passed.
yeedu iam search-tenants --tenant_name="tenant"
  • Console output
{
  "data": [
    {
      "tenant_id": "dc16df84-8ded-46be-9cc1-3caf57bded1b",
      "name": "test-tenant",
      "description": "Yeedu Tenant"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-user-info​

yeedu iam get-user-info -h
usage:  get-user-info [-h] [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-user-info example without any optional arguments passed.
yeedu iam get-user-info
  • Console output
{
  "user_id": "1",
  "tenant_id": null,
  "username": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "group_info": null,
  "from_date": "2024-06-13T11:29:51.951Z",
  "to_date": null
}

get-user-roles​

yeedu iam get-user-roles -h
usage:  get-user-roles [-h] [--tenant_id TENANT_ID]
                       [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide tenant_id to get the user roles in that tenant.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-user-roles example without any optional arguments passed.
yeedu iam get-user-roles
  • Console output
{
  "user_id": 1,
  "username": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "user_roles": [
    {
      "roles_id": 3,
      "user_role": "Platform Admin"
    }
  ],
  "group_roles": null,
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

Shared Platform and Admin​

Command NameUtility
sync-userTo get the information about a specific User.
sync-groupTo get the information about a specific Group.
list-user-groupsTo list all the Groups for a specific User.
list-usersTo list all the available Users.
search-usersTo search the users based on username.
match-userTo match exactly the user for the given username.
list-group-usersTo list all the Users for a specific Group.
list-groupsTo list all the available Groups.
search-groupsTo search the groups based on groupname.
match-groupTo match exactly the group for the given groupname.

sync-user​

yeedu iam sync-user -h
usage:  sync-user [-h] --username USERNAME
                  [--json-output [{pretty,default}]]
                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --username USERNAME   Provide username to get information about a specific User.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • sync-user example with required argument '--username' passed.
yeedu iam sync-user --username="RU0000"
  • Console output
{
  "user_id": "2",
  "username": "RU0000",
  "display_name": "RU0000",
  "email": "ru0000@yeedu.com",
  "from_date": "2024-06-14T07:37:25.892Z",
  "to_date": null
}

sync-group​

yeedu iam sync-group -h
usage:  sync-group [-h] --groupname GROUPNAME
                   [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --groupname GROUPNAME
                        Provide groupname to get information about a specific Group.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • sync-group example with required argument '--groupname' passed.
yeedu iam sync-group --groupname="yeedu-provider"
  • Console output
[
  {
    "group_id": 15,
    "group_name": "yeedu-provider",
    "group_mail": null,
    "group_object_id": null,
    "group_type": null,
    "from_date": "2024-06-14T07:39:05.171932+00:00",
    "to_date": "infinity"
  }
]

list-user-groups​

yeedu iam list-user-groups -h
usage:  list-user-groups [-h] --user_id USER_ID
                         [--page_number PAGE_NUMBER] [--limit LIMIT]
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --user_id USER_ID     Provide user_id to list all the groups for a specific User.
  --page_number PAGE_NUMBER
                        To list groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-user-groups example with required argument '--user_id' passed.
yeedu iam list-user-groups --user_id=1
  • Console output
{
  "data": [
    {
      "group_id": 4,
      "group_name": "GRP-RU00",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 3,
      "group_name": "GRP-RP00",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 2,
      "group_name": "test-yeedu-group",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 4,
    "total_pages": 1,
    "limit": 100
  }
}

list-users​

yeedu iam list-users -h
usage:  list-users [-h] [--group_id GROUP_ID]
                   [--page_number PAGE_NUMBER] [--limit LIMIT]
                   [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --group_id GROUP_ID   Provide group_id to list all the users for a specific group.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-users example without any optional arguments passed.
yeedu iam list-users
  • Console output
{
  "data": [
    {
      "user_id": 2,
      "username": "RU0000",
      "display_name": "RU0000",
      "email": "ru0000@yeedu.com"
    },
    {
      "user_id": 1,
      "username": "YSU0000",
      "display_name": "YSU0000",
      "email": "ysu0000@yeedu.com"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 2,
    "total_pages": 1,
    "limit": 100
  }
}

search-users​

yeedu iam search-users -h
usage:  search-users [-h] --username USERNAME [--group_id GROUP_ID]
                     [--page_number PAGE_NUMBER] [--limit LIMIT]
                     [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --username USERNAME   Provide username to search users matching username.
  --group_id GROUP_ID   Provide group_id to search all the users of a specific group.
  --page_number PAGE_NUMBER
                        To search users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-users example with the required argument passed.
yeedu iam search-users --username="Y"
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "display_name": "YSU0000",
      "email": "ysu0000@yeedu.com"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

match-user​

yeedu iam match-user -h
usage:  match-user [-h] --username USERNAME
                   [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --username USERNAME   Provide username to get user details.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • match-user example with the required argument passed.
yeedu iam match-user --username="YSU0000"
  • Console output
{
  "user_id": 1,
  "username": "YSU0000",
  "display_name": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

list-group-users​

yeedu iam list-group-users -h
usage:  list-group-users [-h] --group_id GROUP_ID
                         [--page_number PAGE_NUMBER] [--limit LIMIT]
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --group_id GROUP_ID   Provide group_id to list all the users for a specific Group.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-group-users example with the required argument '--group_id' passed.
yeedu iam list-group-users --group_id=2
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "display_name": "YSU0000",
      "email": "ysu0000@yeedu.com"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

list-groups​

yeedu iam list-groups -h
usage:  list-groups [-h] [--user_id USER_ID]
                    [--page_number PAGE_NUMBER] [--limit LIMIT]
                    [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --user_id USER_ID     Provide user_id to list all the groups of a specific user.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-groups example without any optional arguments passed.
yeedu iam list-groups
  • Console output
{
  "data": [
    {
      "group_id": 15,
      "group_name": "yeedu-provider",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-14T07:39:05.171932+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 13,
      "group_name": "yeedu-user",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-14T07:37:25.892197+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 4,
      "group_name": "GRP-RU00",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 3,
      "group_name": "GRP-RP00",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 2,
      "group_name": "test-yeedu-group",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 6,
    "total_pages": 1,
    "limit": 100
  }
}

search-groups​

yeedu iam search-groups -h
usage:  search-groups [-h] --groupname GROUPNAME [--user_id USER_ID]
                      [--page_number PAGE_NUMBER] [--limit LIMIT]
                      [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --groupname GROUPNAME
                        To search all the groups matching provided groupname.
  --user_id USER_ID     Provide user_id to search all the groups of a specific user.
  --page_number PAGE_NUMBER
                        To search groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-groups example with required argument passed.
yeedu iam search-groups --groupname="yeedu"
  • Console output
{
  "data": [
    {
      "group_id": 15,
      "group_name": "yeedu-provider",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-14T07:39:05.171932+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 13,
      "group_name": "yeedu-user",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-14T07:37:25.892197+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 2,
      "group_name": "test-yeedu-group",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    },
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_type": null,
      "group_mail": null,
      "group_object_id": null,
      "from_date": "2024-06-13T11:29:51.951785+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 4,
    "total_pages": 1,
    "limit": 100
  }
}

match-group​

yeedu iam match-group -h
usage:  match-group [-h] --groupname GROUPNAME
                    [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --groupname GROUPNAME
                        Provide groupname to get information about matching groups.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • match-group example with required argument passed.
yeedu iam match-group --groupname="yeedu-manager"
  • Console output
[
  {
    "group_id": 1,
    "group_name": "yeedu-manager",
    "group_mail": null,
    "group_object_id": null,
    "group_type": null,
    "from_date": "2024-06-13T11:29:51.951785+00:00",
    "to_date": "infinity"
  }
]

Lookup​

Command NameUtility
list-resourcesTo get all the resources.
get-resourceTo get resource details for a specific Resource.
list-permissionsTo get all the Permission Types.
get-permissionTo get resource details for a specific Permission Type.
list-rolesTo get all the Roles.
get-roleTo get resource details for a specific Role.
list-rulesTo get all the Rules.
get-ruleTo get resource details for a specific Rule.

list-resources​

yeedu iam list-resources -h
usage:  list-resources [-h] [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-resources example without optional argument passed for the output format.
yeedu iam list-resources
  • Console output
[
  {
    "resource_id": 0,
    "resource_path": "/api/v1/lookup_cloud_providers",
    "from_date": "2023-09-29T15:47:59.340Z",
    "to_date": null
  },
  {
    "resource_id": 1,
    "resource_path": "/api/v1/lookup_cloud_providers/:cloud_provider_id",
    "from_date": "2023-09-29T15:47:59.340Z",
    "to_date": null
  },
  ...
  {
    "resource_id": 194,
    "resource_path": "/api/v1/workspace/stats",
    "from_date": "2024-06-13T10:40:53.269Z",
    "to_date": null
  }
]

get-resource​

yeedu iam get-resource -h
usage:  get-resource [-h] --resource_id RESOURCE_ID [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --resource_id RESOURCE_ID
                        Provide the resource_id to get information about a specific
                        Resource.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-resource example with required argument '--resource_id' passed.
yeedu iam get-resource --resource_id=18
  • Console output
{
  "resource_id": 18,
  "resource_path": "/api/v1/machine/networks",
  "from_date": "2024-06-13T10:40:53.269Z",
  "to_date": null
}

list-permissions​

yeedu iam list-permissions -h
usage:  list-permissions [-h] [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-permissions example without optional argument passed for the output format.
yeedu iam list-permissions
  • Console output
[
  {
    "permission_id": 0,
    "permission": "GET",
    "description": "To list a resource",
    "from_date": "2024-06-13T10:40:53.267Z",
    "to_date": null
  },
  {
    "permission_id": 1,
    "permission": "POST",
    "description": "To create a resource",
    "from_date": "2024-06-13T10:40:53.267Z",
    "to_date": null
  },
  {
    "permission_id": 2,
    "permission": "PUT",
    "description": "To update a resource",
    "from_date": "2024-06-13T10:40:53.267Z",
    "to_date": null
  },
  {
    "permission_id": 3,
    "permission": "DELETE",
    "description": "To delete a resource",
    "from_date": "2024-06-13T10:40:53.267Z",
    "to_date": null
  }
]

get-permission​

yeedu iam get-permission -h
usage:  get-permission [-h] --permission_id PERMISSION_ID
                       [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --permission_id PERMISSION_ID
                        Provide the permission_id to get information about a specific
                        Permission Type.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-permission example with required argument '--permission_id' passed.
yeedu iam get-permission --permission_id=1
  • Console output
{
  "permission_id": 1,
  "permission": "POST",
  "description": "To create a resource",
  "from_date": "2024-06-13T10:40:53.267Z",
  "to_date": null
}

list-roles​

yeedu iam list-roles -h
usage:  list-roles [-h] [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-roles example without any optional arguments passed.
yeedu iam list-roles
  • Console output
[
  {
    "role_id": 4,
    "role": "Platform Billing",
    "description": "Can access all the billing APIs",
    "from_date": "2024-06-13T10:40:53.271Z",
    "to_date": null
  },
  {
    "role_id": 3,
    "role": "Platform Admin",
    "description": "Can access and add or remove tenants across all tenants",
    "from_date": "2024-06-13T10:40:53.271Z",
    "to_date": null
  },
  {
    "role_id": 2,
    "role": "Admin",
    "description": "Can add and remove user and group roles and perform all actions within a tenant.",
    "from_date": "2024-06-13T10:40:53.271Z",
    "to_date": null
  },
  {
    "role_id": 1,
    "role": "Can Manage Cluster",
    "description": "GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance, User) PUT (Cluster Instance, Spark Job Config, Workspace, Notebook Config) POST (Object Storage Manager Files, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance) DELETE (Object Storage Manager Files, Cluster Access Control, Workspace Access Control)",
    "from_date": "2024-06-13T10:40:53.271Z",
    "to_date": null
  },
  {
    "role_id": 0,
    "role": "User",
    "description": "GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance, User) PUT (Spark Job Config, Workspace, Notebook Config) POST (Object Storage Manager Files, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance) DELETE (Workspace Access Control)",
    "from_date": "2024-06-13T10:40:53.271Z",
    "to_date": null
  }
]

get-role​

yeedu iam get-role -h
usage:  get-role [-h] --role_id ROLE_ID [--json-output [{pretty,default}]]
                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --role_id ROLE_ID     Provide the role_id to get information about a specific Role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-role example with required argument '--role_id' passed.
yeedu iam get-role --role_id=1
  • Console output
{
  "role_id": 1,
  "role": "Can Manage Cluster",
  "description": "GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance, User) PUT (Cluster Instance, Spark Job Config, Workspace, Notebook Config) POST (Object Storage Manager Files, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance) DELETE (Object Storage Manager Files, Cluster Access Control, Workspace Access Control)",
  "from_date": "2024-06-13T10:40:53.271Z",
  "to_date": null
}

list-rules​

yeedu iam list-rules -h
usage:  list-rules [-h] [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-rules example without any optional arguments passed.
yeedu iam list-rules
  • Console output
[
  {
    "rule_id": "1",
    "permission_type": {
      "permission_id": 0,
      "permission": "GET",
      "description": "To list a resource"
    },
    "resource": {
      "resource_id": 1,
      "resource_path": "/api/v1/lookup_cloud_providers/:cloud_provider_id"
    },
    "role": {
      "role_id": 0,
      "role": "User",
      "description": "GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance, User) PUT (Spark Job Config, Workspace, Notebook Config) POST (Object Storage Manager Files, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance) DELETE (Workspace Access Control)"
    },
    "from_date": "2024-06-13T10:40:53.272Z",
    "to_date": null
},
  ...
  {
    "rule_id": "754",
    "permission_type": {
      "permission_id": 0,
      "permission": "GET",
      "description": "To list a resource"
    },
    "resource": {
      "resource_id": 194,
      "resource_path": "/api/v1/workspace/stats"
    },
    "role": {
      "role_id": 3,
      "role": "Platform Admin",
      "description": "Can access and add or remove tenants across all tenants"
    },
    "from_date": "2024-06-13T10:40:53.272Z",
    "to_date": null
  }
]

get-rule​

yeedu iam get-rule -h
usage:  get-rule [-h] --rule_id RULE_ID [--json-output [{pretty,default}]]
                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --rule_id RULE_ID     Provide the rule_id to get information about a specific Rule.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-rule example with required argument '--rule_id' passed.
yeedu iam get-rule --rule_id=108
  • Console output
{
  "rule_id": "108",
  "permission_type": {
    "permission_id": 0,
    "permission": "GET",
    "description": "To list a resource"
  },
  "resource": {
    "resource_id": 39,
    "resource_path": "/api/v1/cluster/stats"
  },
  "role": {
    "role_id": 1,
    "role": "Can Manage Cluster",
    "description": "GET (Lookup, Volume Config, Network Config, Boot Disk Image Config, Credentials Config, Object Storage Manager, Object Storage Manager Files, Hive Metastore Config, Cluster Configuration, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance, User) PUT (Cluster Instance, Spark Job Config, Workspace, Notebook Config) POST (Object Storage Manager Files, Cluster Instance, Cluster Access Control, Workspace, Workspace Access Control, Spark Job Config, Spark Job Instance, Notebook Config, Notebook Instance) DELETE (Object Storage Manager Files, Cluster Access Control, Workspace Access Control)"
  },
  "from_date": "2024-06-13T10:40:53.272Z",
  "to_date": null
}

list-workspace-permissions​

yeedu iam list-workspace-permissions -h
usage:  list-workspace-permissions [-h] [--json-output [{pretty,default}]]
                                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-workspace-permissions example.
yeedu iam list-workspace-permissions
  • Console output
[
  {
    "permission_id": 3,
    "name": "MANAGE",
    "description": "To list jobs, run jobs, edit Spark job configurations, and manage workspace access by adding or removing permissions",
    "from_date": "2024-06-13T10:40:53.392Z",
    "to_date": null
  },
  {
    "permission_id": 2,
    "name": "EDIT",
    "description": "To list, run and edit a spark job configuration in a workspace",
    "from_date": "2024-06-13T10:40:53.392Z",
    "to_date": null
  },
  {
    "permission_id": 1,
    "name": "RUN",
    "description": "To list and run the jobs within a workspace",
    "from_date": "2024-06-13T10:40:53.392Z",
    "to_date": null
  },
  {
    "permission_id": 0,
    "name": "VIEW",
    "description": "To list the jobs inside the workspace",
    "from_date": "2024-06-13T10:40:53.392Z",
    "to_date": null
  }
]

get-workspace-permission​

yeedu iam get-workspace-permission -h
usage:  get-workspace-permission [-h] --permission_id PERMISSION_ID
                                 [--json-output [{pretty,default}]]
                                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --permission_id PERMISSION_ID
                        Provide the permission_id to get information about a specific
                        Workspace Access Control Permission.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-workspace-permission example with required argument '--permission_id' passed.
yeedu iam get-workspace-permission --permission_id=1
  • Console output
{
  "permission_id": 1,
  "name": "RUN",
  "description": "To list and run the jobs within a workspace",
  "from_date": "2024-06-13T10:40:53.392Z",
  "to_date": null
}

Platform-Admin

Tenant​

Command NameUtility
create-tenantTo create a Tenant.
list-tenantsTo list all the available Tenants.
search-tenantsTo search the tenants with the given name.
get-tenantTo get information about a specific Tenant.
edit-tenantTo edit a specific Tenant.
delete-tenantTo delete a specific Tenant.

create-tenant​

yeedu platform-admin create-tenant -h
usage:  create-tenant [-h] --name NAME [--description DESCRIPTION]
                      [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --name NAME           Provide name to create-tenant.
  --description DESCRIPTION
                        Provide description to create-tenant.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-tenant example with all the required and optional arguments passed.
yeedu platform-admin create-tenant --name="tenant_01" --description="Yeedu Tenant-1"
  • Console output
{
  "tenant_id": "414e44d2-6f0f-4edc-a298-427a8a7e6a17",
  "name": "tenant_01",
  "description": "Yeedu Tenant-1",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T08:10:39.163Z",
  "from_date": "2024-06-14T08:10:39.163Z",
  "to_date": null
}

list-tenants​

yeedu platform-admin list-tenants -h
usage:  list-tenants [-h] [--page_number PAGE_NUMBER] [--limit LIMIT]
                     [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]
options:
  -h, --help            show this help message and exit
  --page_number PAGE_NUMBER
                        To list tenants for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of tenants. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-tenants example without any optional arguments passed.
yeedu platform-admin list-tenants
  • Console output
{
  "data": [
    {
      "tenant_id": "414e44d2-6f0f-4edc-a298-427a8a7e6a17",
      "name": "tenant_01",
      "description": "Yeedu Tenant-1",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T08:10:39.163282+00:00",
      "from_date": "2024-06-14T08:10:39.163282+00:00",
      "to_date": "infinity"
    },
    {
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "name": "test",
      "description": null,
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-13T11:30:03.255245+00:00",
      "from_date": "2024-06-13T11:30:03.255245+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 2,
    "total_pages": 1,
    "limit": 100
  }
}

search-tenants​

yeedu platform-admin search-tenants -h
usage:  search-tenants [-h] --tenant_name TENANT_NAME
                       [--page_number PAGE_NUMBER] [--limit LIMIT]
                       [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_name TENANT_NAME
                        Provide the tenant name to get all the matching tenants.
  --page_number PAGE_NUMBER
                        To search tenants on a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of tenants. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-tenants example with required arguments passed.
yeedu platform-admin search-tenants --tenant_name="tenant"
  • Console output
{
  "data": [
    {
      "tenant_id": "414e44d2-6f0f-4edc-a298-427a8a7e6a17",
      "name": "tenant_01",
      "description": "Yeedu Tenant-1",
      "created_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "modified_by": {
        "user_id": 1,
        "username": "YSU0000"
      },
      "last_update_date": "2024-06-14T08:10:39.163282+00:00",
      "from_date": "2024-06-14T08:10:39.163282+00:00",
      "to_date": "infinity"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-tenant​

yeedu platform-admin get-tenant -h
usage:  get-tenant [-h] [--tenant_id TENANT_ID]
                   [--tenant_name TENANT_NAME]
                   [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide the tenant_id to get information about a specific Tenant.
  --tenant_name TENANT_NAME
                        Provide the tenant_name to get information about a specific Tenant.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-tenant example with any one of the required argument passed.
yeedu platform-admin get-tenant --tenant_name="tenant_01"
  • Console output
{
  "tenant_id": "414e44d2-6f0f-4edc-a298-427a8a7e6a17",
  "name": "tenant_01",
  "description": "Yeedu Tenant-1",
  "created_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "modified_by": {
    "user_id": 1,
    "username": "YSU0000"
  },
  "last_update_date": "2024-06-14T08:10:39.163282+00:00",
  "from_date": "2024-06-14T08:10:39.163282+00:00",
  "to_date": "infinity"
}

edit-tenant​

yeedu platform-admin edit-tenant -h
usage:  edit-tenant [-h] [--tenant_id TENANT_ID]
                    [--tenant_name TENANT_NAME] [--name [NAME]]
                    [--description [DESCRIPTION]]
                    [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide a specific tenant Id to edit-tenant.
  --tenant_name TENANT_NAME
                        Provide a specific tenant Name to edit-tenant.
  --name [NAME]         Provide name to edit-tenant.
  --description [DESCRIPTION]
                        Provide description to edit-tenant.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • edit-tenant example with any one of the required arguments and other optional argument is passed which is to be updated.
yeedu platform-admin edit-tenant --tenant_id="414e44d2-6f0f-4edc-a298-427a8a7e6a17" --description="Yeedu Tenant 1"
  • Console output
{
  "tenant_id": "414e44d2-6f0f-4edc-a298-427a8a7e6a17",
  "name": "tenant_01",
  "description": "Yeedu Tenant 1",
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T08:12:38.020Z",
  "from_date": "2024-06-14T08:10:39.163Z",
  "to_date": null
}

delete-tenant​

yeedu platform-admin delete-tenant -h
usage:  delete-tenant [-h] [--tenant_id TENANT_ID]
                      [--tenant_name TENANT_NAME]
                      [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide the tenant_id to delete a specific Tenant.
  --tenant_name TENANT_NAME
                        Provide the tenant_name to delete a specific Tenant.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-tenant example with any one of the required argument passed.
yeedu platform-admin delete-tenant --tenant_id="414e44d2-6f0f-4edc-a298-427a8a7e6a17"
  • Console output
{
  "message": "Deleted tenant id: 414e44d2-6f0f-4edc-a298-427a8a7e6a17."
}

User​

Command NameUtility
list-user-tenantsTo list all the tenants associated to an user.
list-tenant-usersTo list all the users present in a tenant.
search-tenant-usersTo search all the users present in a tenant.
get-tenant-userTo get information about a User present in a specific tenant.
get-user-rolesTo get all the roles of an User present in a specific tenant.
list-users-rolesTo list all the Users Roles in a specific tenant.
get-role-usersTo get all the users of a Role present in a specific tenant.
create-user-roleTo create an User Role for a specific tenant.
delete-user-roleTo delete an User Role of a specific tenant.

list-user-tenants​

yeedu platform-admin list-user-tenants -h
usage:  list-user-tenants [-h] --user_id USER_ID
                          [--page_number PAGE_NUMBER] [--limit LIMIT]
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --user_id USER_ID     Provide User Id to list all the tenants.
  --page_number PAGE_NUMBER
                        To list tenants for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of tenants. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-user-tenants example with the required argument passed.
yeedu platform-admin list-user-tenants --user_id=1
  • Console output
{
  "data": [
    {
      "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
      "name": "test",
      "description": null
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

list-tenant-users​

yeedu platform-admin list-tenant-users -h
usage:  list-tenant-users [-h] --tenant_id TENANT_ID
                          [--page_number PAGE_NUMBER] [--limit LIMIT]
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to list all the users present in it.
  --page_number PAGE_NUMBER
                        To list tenant users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of tenant users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-tenant-users example with required arguments passed.
yeedu platform-admin list-tenant-users --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870"
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "display_name": "YSU0000",
      "email": "ysu0000@yeedu.com"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-tenant-users​

yeedu platform-admin search-tenant-users -h
usage:  search-tenant-users [-h] --username USERNAME --tenant_id TENANT_ID
                            [--page_number PAGE_NUMBER] [--limit LIMIT]
                            [--json-output [{pretty,default}]]
                            [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --username USERNAME   Provide username to search all the matching users present in it.
  --tenant_id TENANT_ID
                        Provide Tenant Id to search all the users present in it.
  --page_number PAGE_NUMBER
                        To search tenant users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of tenant users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-tenant-users example with required arguments passed.
yeedu platform-admin search-tenant-users --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --username="YS"
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "user_roles": [
        "Platform Admin"
      ],
      "group_roles": [
        null
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-tenant-user​

yeedu platform-admin get-tenant-user -h
usage:  get-tenant-user [-h] --tenant_id TENANT_ID --user_id USER_ID
                        [--json-output [{pretty,default}]]
                        [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to get information about a specific User.
  --user_id USER_ID     Provide User Id to get information about a specific User.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-tenant-user example with all the required arguments passed.
yeedu platform-admin get-tenant-user --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --user_id=1
  • Console output
{
  "user_id": 1,
  "username": "YSU0000",
  "display_name": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

get-user-roles​

yeedu platform-admin get-user-roles -h
usage:  get-user-roles [-h] --tenant_id TENANT_ID --user_id USER_ID
                       [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to get roles of a specific User.
  --user_id USER_ID     Provide User Id to get roles of a specific User.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-user-roles example with the required arguments '--tenant_id' and '--user_id' passed.
yeedu platform-admin get-user-roles --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --user_id=1
  • Console output
{
  "user_id": 1,
  "username": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "user_roles": [
    {
      "role_id": 3,
      "user_role": "Platform Admin"
    }
  ],
  "group_roles": null,
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

list-users-roles​

yeedu platform-admin list-users-roles -h
usage:  list-users-roles [-h] --tenant_id TENANT_ID
                         [--page_number PAGE_NUMBER] [--limit LIMIT]
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to list User roles.
  --page_number PAGE_NUMBER
                        To list users roles for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users roles. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-users-roles example with the required argument '--tenant_id' passed.
yeedu platform-admin list-users-roles --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870"
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "user_roles": [
        "Platform Admin"
      ],
      "group_roles": [
        null
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-role-users​

yeedu platform-admin get-role-users -h
usage:  get-role-users [-h] --tenant_id TENANT_ID --role_id ROLE_ID
                       [--page_number PAGE_NUMBER] [--limit LIMIT]
                       [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to get users in a specific Role.
  --role_id ROLE_ID     Provide Role Id to get users in a specific Role.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-role-users example with the required '--tenant_id' arguments passed.
yeedu platform-admin get-role-users --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --role_id=3
  • Console output
{
  "data": {
    "role_id": 3,
    "users": [
      {
        "user_id": 1,
        "username": "YSU0000",
        "display_name": "YSU0000",
        "email": "ysu0000@yeedu.com"
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

create-user-role​

yeedu platform-admin create-user-role -h
usage:  create-user-role [-h] [--tenant_id TENANT_ID] --user_id
                         USER_ID --role_id ROLE_ID
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to create-user-role.
  --user_id USER_ID     Provide User Id to create-user-role.
  --role_id ROLE_ID     Provide Role Id to create-user-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-user-role example with all the required and optional arguments passed.
yeedu platform-admin create-user-role --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --user_id=2 --role_id=1
  • Console output
{
  "user_roles_id": "2",
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "user_id": "2",
  "role_id": 1,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T08:18:18.541Z",
  "from_date": "2024-06-14T08:18:18.541Z",
  "to_date": null
}

delete-user-role​

yeedu platform-admin delete-user-role -h
usage:  delete-user-role [-h] [--tenant_id TENANT_ID] --user_id USER_ID --role_id ROLE_ID
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to delete-user-role.
  --user_id USER_ID     Provide User Id to delete-user-role.
  --role_id ROLE_ID     Provide Role Id to delete-user-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-user-role example with the required '--tenant_id' argument passed.
yeedu platform-admin delete-user-role --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --user_id=2 --role_id=1
  • Console output
{
  "message": "Deleted User Roles for the provided tenant_id: '8ad4bd62-839f-4aa7-ba1e-c3112cbbf870', user_id: 2 and role_id: 1."
}

Group​

Command NameUtility
list-tenant-groupsTo list all the groups present in a tenant.
search-tenant-groupsTo search all the groups present in a tenant.
get-tenant-groupTo get information about a Group present in a specific tenant.
get-group-rolesTo get all the roles of a Group present in a specific tenant.
list-groups-rolesTo list all the Groups Roles in a specific tenant.
get-role-groupsTo get all the groups having a specific Role present in a specific tenant.
create-group-roleTo create a Group Role for a specific tenant.
delete-group-roleTo delete a Group Role of a specific tenant.

list-tenant-groups​

yeedu platform-admin list-tenant-groups -h
usage:  list-tenant-groups [-h] --tenant_id TENANT_ID
                           [--page_number PAGE_NUMBER] [--limit LIMIT]
                           [--json-output [{pretty,default}]]
                           [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to list all the groups present in it.
  --page_number PAGE_NUMBER
                        To list tenant groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of tenant groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-tenant-groups example with required and optional arguments passed.
yeedu platform-admin list-tenant-groups --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870"
  • Console output
{
  "data": [
    {
      "group_id": 15,
      "group_name": "yeedu-provider",
      "group_mail": null,
      "group_object_id": null,
      "group_type": null
    },
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_object_id": null,
      "group_type": null
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 2,
    "total_pages": 1,
    "limit": 100
  }
}

search-tenant-groups​

yeedu platform-admin search-tenant-groups -h
usage:  search-tenant-groups [-h] --groupname GROUPNAME --tenant_id TENANT_ID
                             [--page_number PAGE_NUMBER] [--limit LIMIT]
                             [--json-output [{pretty,default}]]
                             [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --groupname GROUPNAME
                        Provide groupname to search all the matching groups present in
                        it.
  --tenant_id TENANT_ID
                        Provide Tenant Id to search all the groups present in it.
  --page_number PAGE_NUMBER
                        To search tenant groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of tenant groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-tenant-groups example with required and optional arguments passed.
yeedu platform-admin search-tenant-groups --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --groupname="yeed"
  • Console output
{
  "data": [
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_type": null,
      "group_object_id": null,
      "roles": [
        "User"
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-tenant-group​

yeedu platform-admin get-tenant-group -h
usage:  get-tenant-group [-h] --tenant_id TENANT_ID --group_id GROUP_ID
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID Provide Tenant Id to get information about a specific Group.
  --group_id GROUP_ID   Provide Group Id to get information about a specific Group.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-tenant-group example with required arguments passed.
yeedu platform-admin get-tenant-group --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --group_id=1
  • Console output
{
  "group_id": 1,
  "group_name": "yeedu-manager",
  "group_object_id": null,
  "group_type": null,
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

get-group-roles​

yeedu platform-admin get-group-roles -h
usage:  get-group-roles [-h] --tenant_id TENANT_ID --group_id GROUP_ID
                        [--json-output [{pretty,default}]] [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to get roles of a specific Group.
  --group_id GROUP_ID   Provide Group Id to get roles of a specific Group.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-group-roles example with the required '--tenant_id' and '--group_id' arguments passed.
yeedu platform-admin get-group-roles --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --group_id=1
  • Console output
{
  "group_id": 1,
  "group_name": "yeedu-manager",
  "group_type": null,
  "roles": [
    "User"
  ]
}

list-groups-roles​

yeedu platform-admin list-groups-roles -h
usage:  list-groups-roles [-h] --tenant_id TENANT_ID
                          [--page_number PAGE_NUMBER] [--limit LIMIT]
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to list Group roles.
  --page_number PAGE_NUMBER
                        To list groups roles for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups roles. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-groups-roles example with the required arguments '--tenant_id' passed.
yeedu platform-admin list-groups-roles --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --limit=1
  • Console output
{
  "data": [
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_type": null,
      "group_object_id": null,
      "roles": [
        "User"
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 1
  }
}

get-role-groups​

yeedu platform-admin get-role-groups -h
usage:  get-role-groups [-h] --tenant_id TENANT_ID --role_id ROLE_ID
                        [--page_number PAGE_NUMBER] [--limit LIMIT]
                        [--json-output [{pretty,default}]]
                        [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to get groups in a specific Role.
  --role_id ROLE_ID     Provide Role Id to get groups in a specific Role.
  --page_number PAGE_NUMBER
                        To list groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups. (default: 100)

  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-role-groups example with the required arguments '--tenant_id' and '--role_id' passed.
yeedu platform-admin get-role-groups --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --role_id=0
  • Console output
{
  "data": {
    "role_id": 0,
    "groups": [
      {
        "group_id": 1,
        "group_name": "yeedu-manager",
        "group_mail": null,
        "group_object_id": null,
        "group_type": null
      },
      {
        "group_id": 15,
        "group_name": "yeedu-provider",
        "group_mail": null,
        "group_object_id": null,
        "group_type": null
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 2,
    "total_pages": 1,
    "limit": 100
  }
}

create-group-role​

yeedu platform-admin create-group-role -h
usage:  create-group-role [-h] [--tenant_id TENANT_ID] --group_id GROUP_ID --role_id
                          ROLE_ID [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to create-group-role.
  --group_id GROUP_ID   Provide Group Id to create-group-role.
  --role_id ROLE_ID     Provide Role Id to create-group-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-group-role example with all the required and optional arguments passed.
yeedu platform-admin create-group-role --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --group_id=1 --role_id=1
  • Console output
{
  "group_roles_id": "3",
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "group_id": "1",
  "role_id": 1,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T08:33:16.920Z",
  "from_date": "2024-06-14T08:33:16.920Z",
  "to_date": null
}

delete-group-role​

yeedu platform-admin delete-group-role -h
usage:  delete-group-role [-h] [--tenant_id TENANT_ID] --group_id GROUP_ID --role_id
                          ROLE_ID [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --tenant_id TENANT_ID
                        Provide Tenant Id to delete-group-role.
  --group_id GROUP_ID   Provide Group Id to delete-group-role.
  --role_id ROLE_ID     Provide Role Id to delete-group-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-group-role example with all the required argument passed.
yeedu platform-admin delete-group-role --tenant_id="8ad4bd62-839f-4aa7-ba1e-c3112cbbf870" --group_id=15 --role_id=0
  • Console output
{
  "message": "Deleted Group Role for the provided tenant ID: '8ad4bd62-839f-4aa7-ba1e-c3112cbbf870', group ID: 15, and role ID: 0."
}

Admin

User​

Command NameUtility
list-usersTo list all the users present in tenant.
search-usersTo search all the users present in tenant.
get-userTo get information about a specific User.
get-user-rolesTo get all the roles of a specific User.
list-users-rolesTo list all the Users Roles.
get-role-usersTo get all the users in a specific Role.
create-user-roleTo create an User Role.
delete-user-roleTo delete an User Role.

list-users​

yeedu admin list-users -h
usage:  list-users [-h] [--page_number PAGE_NUMBER] [--limit LIMIT]
                   [--json-output [{pretty,default}]]
                   [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-users example with optional arguments passed.
yeedu admin list-users --limit=1
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "display_name": "YSU0000",
      "email": "ysu0000@yeedu.com"
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 1
  }
}

search-users​

yeedu admin search-users -h
usage:  search-users [-h] --username USERNAME
                     [--page_number PAGE_NUMBER] [--limit LIMIT]
                     [--json-output [{pretty,default}]]
                     [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --username USERNAME   Provide username to search matching users.
  --page_number PAGE_NUMBER
                        To search users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-users example with required and optional arguments passed.
yeedu admin search-users --username="YS"
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "user_roles": [
        "Platform Admin"
      ],
      "group_roles": [
        "Admin",
        "Can Manage Cluster",
        "User"
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-user​

yeedu admin get-user -h
usage:  get-user [-h] --user_id USER_ID
                 [--json-output [{pretty,default}]]
                 [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --user_id USER_ID     Provide User Id to get information about a specific User.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-user example with the required argument passed.
yeedu admin get-user --user_id=1
  • Console output
{
  "user_id": 1,
  "username": "YSU0000",
  "display_name": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

get-user-roles​

yeedu admin get-user-roles -h
usage:  get-user-roles [-h] --user_id USER_ID
                       [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --user_id USER_ID     Provide User Id to get roles of a specific User.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-user-roles example with the required arguments '--user_id' passed.
yeedu admin get-user-roles --user_id=1
  • Console output
{
  "user_id": 1,
  "username": "YSU0000",
  "email": "ysu0000@yeedu.com",
  "user_roles": [
    {
      "role_id": 3,
      "user_role": "Platform Admin"
    }
  ],
  "group_roles": [
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_object_id": null,
      "group_type": null,
      "role_id": 2,
      "group_role": "Admin"
    },
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_object_id": null,
      "group_type": null,
      "role_id": 1,
      "group_role": "Can Manage Cluster"
    },
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_object_id": null,
      "group_type": null,
      "role_id": 0,
      "group_role": "User"
    }
  ],
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

list-users-roles​

yeedu admin list-users-roles -h
usage:  list-users-roles [-h] [--page_number PAGE_NUMBER]
                         [--limit LIMIT]
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --page_number PAGE_NUMBER
                        To list users roles for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users roles. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-users-roles example with optional arguments passed.
yeedu admin list-users-roles
  • Console output
{
  "data": [
    {
      "user_id": 1,
      "username": "YSU0000",
      "user_roles": [
        "Platform Admin"
      ],
      "group_roles": [
        "Admin",
        "Can Manage Cluster",
        "User"
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-role-users​

yeedu admin get-role-users -h
usage:  get-role-users [-h] --role_id ROLE_ID
                       [--page_number PAGE_NUMBER] [--limit LIMIT]
                       [--json-output [{pretty,default}]]
                       [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --role_id ROLE_ID     Provide Role Id to get users in a specific Role.
  --page_number PAGE_NUMBER
                        To list users for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of users. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-role-users example with the required '--role_id' arguments passed.
yeedu admin get-role-users --role_id=3
  • Console output
{
  "data": {
    "role_id": 3,
    "users": [
      {
        "user_id": 1,
        "username": "YSU0000",
        "display_name": "YSU0000",
        "email": "ysu0000@yeedu.com"
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

create-user-role​

yeedu admin create-user-role -h
usage:  create-user-role [-h] --user_id USER_ID --role_id ROLE_ID
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --user_id USER_ID     Provide User Id to create-user-role.
  --role_id ROLE_ID     Provide Role Id to create-user-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-user-role example with all the required and optional arguments passed.
yeedu admin create-user-role --user_id=2 --role_id=1
  • Console output
{
  "user_roles_id": "3",
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "user_id": "2",
  "role_id": 1,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T08:42:08.226Z",
  "from_date": "2024-06-14T08:42:08.226Z",
  "to_date": null
}

delete-user-role​

yeedu admin delete-user-role -h
usage:  delete-user-role [-h] --user_id USER_ID --role_id ROLE_ID
                         [--json-output [{pretty,default}]]
                         [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --user_id USER_ID     Provide User Id to delete-user-role.
  --role_id ROLE_ID     Provide Role Id to delete-user-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-user-role example with all the required argument passed.
yeedu admin delete-user-role --user_id=2 --role_id=1
  • Console output
{
  "message": "Deleted User Roles for the provided User Id: 2 and Role Id: 1."
}

Group​

Command NameUtility
list-groupsTo list all the groups present in tenant.
search-groupsTo search all the groups present in tenant.
get-groupTo get information about a specific Group.
get-group-rolesTo get all the roles of a specific Group.
list-groups-rolesTo list all the Groups Roles.
get-role-groupsTo get all the groups in a specific Role.
create-group-roleTo create a Group Role.
delete-group-roleTo delete a group Role.

list-groups​

yeedu admin list-groups -h
usage:  list-groups [-h] [--page_number PAGE_NUMBER] [--limit LIMIT]
                    [--json-output [{pretty,default}]]
                    [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --page_number PAGE_NUMBER
                        To list groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-groups example with the optional argument passed.
yeedu admin list-groups
  • Console output
{
  "data": [
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_object_id": null,
      "group_type": null
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

search-groups​

yeedu admin search-groups -h
usage:  search-groups [-h] --groupname GROUPNAME
                      [--page_number PAGE_NUMBER] [--limit LIMIT]
                      [--json-output [{pretty,default}]]
                      [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --groupname GROUPNAME
                        Provide groupname to search matching groups.
  --page_number PAGE_NUMBER
                        To search groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to search number of groups. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • search-groups example with required and optional arguments passed.
yeedu admin search-groups --groupname="yeed"
  • Console output
{
  "data": [
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_type": null,
      "group_object_id": null,
      "roles": [
        "Admin",
        "Can Manage Cluster",
        "User"
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-group​

yeedu admin get-group -h
usage:  get-group [-h] --group_id GROUP_ID
                  [--json-output [{pretty,default}]]
                  [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --group_id GROUP_ID   Provide Group Id to get information about a specific Group.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-group example with the required argument '--group_id' passed.
yeedu admin get-group --group_id=1
  • Console output
{
  "group_id": 1,
  "group_name": "yeedu-manager",
  "group_object_id": null,
  "group_type": null,
  "from_date": "2024-06-13T11:29:51.951785+00:00",
  "to_date": "infinity"
}

get-group-roles​

yeedu admin get-group-roles -h
usage:  get-group-roles [-h] --group_id GROUP_ID
                        [--json-output [{pretty,default}]]
                        [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --group_id GROUP_ID   Provide Group Id to get roles of a specific Group.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-group-roles example with the required argument '--group_id' passed.
yeedu admin get-group-roles --group_id=1
  • Console output
{
  "group_id": 1,
  "group_name": "yeedu-manager",
  "group_type": null,
  "roles": [
    "Admin",
    "Can Manage Cluster",
    "User"
  ]
}

list-groups-roles​

yeedu admin list-groups-roles -h
usage:  list-groups-roles [-h] [--page_number PAGE_NUMBER] [--limit LIMIT]
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --page_number PAGE_NUMBER
                        To list groups roles for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups roles. (default: 100)
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • list-groups-roles example without any optional arguments passed.
yeedu admin list-groups-roles
  • Console output
{
  "data": [
    {
      "group_id": 1,
      "group_name": "yeedu-manager",
      "group_mail": null,
      "group_type": null,
      "group_object_id": null,
      "roles": [
        "Admin",
        "Can Manage Cluster",
        "User"
      ]
    }
  ],
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

get-role-groups​

yeedu admin get-role-groups -h
usage:  get-role-groups [-h] --role_id ROLE_ID [--json-output [{pretty,default}]]
                        [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --role_id ROLE_ID     Provide Role Id to get groups in a specific Role.
  --page_number PAGE_NUMBER
                        To list groups for a specific page_number. (default: 1)
  --limit LIMIT         Provide limit to list number of groups. (default: 100)

  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • get-role-groups example with the required argument '--role_id' passed.
yeedu admin get-role-groups --role_id=2
  • Console output
{
  "data": {
    "role_id": 2,
    "groups": [
      {
        "group_id": 1,
        "group_name": "yeedu-manager",
        "group_mail": null,
        "group_object_id": null,
        "group_type": null
      }
    ]
  },
  "result_set": {
    "current_page": 1,
    "total_objects": 1,
    "total_pages": 1,
    "limit": 100
  }
}

create-group-role​

yeedu admin create-group-role -h
usage:  create-group-role [-h] --group_id GROUP_ID --role_id ROLE_ID
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --group_id GROUP_ID   Provide Group Id to create-group-role.
  --role_id ROLE_ID     Provide Role Id to create-group-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • create-group-role example with all the required arguments passed.
yeedu admin create-group-role --group_id=15 --role_id=0
  • Console output
{
  "group_roles_id": "5",
  "tenant_id": "8ad4bd62-839f-4aa7-ba1e-c3112cbbf870",
  "group_id": "15",
  "role_id": 0,
  "created_by_user_id": "1",
  "modified_by_user_id": "1",
  "last_update_date": "2024-06-14T08:46:04.846Z",
  "from_date": "2024-06-14T08:46:04.846Z",
  "to_date": null
}

delete-group-role​

yeedu admin delete-group-role -h
usage:  delete-group-role [-h] --group_id GROUP_ID --role_id ROLE_ID
                          [--json-output [{pretty,default}]]
                          [--yaml-output [{true,false}]]

options:
  -h, --help            show this help message and exit
  --group_id GROUP_ID   Provide Group Id to delete-group-role.
  --role_id ROLE_ID     Provide Role Id to delete-group-role.
  --json-output [{pretty,default}]
                        Specifies the format of JSON output. (default: pretty)
  --yaml-output [{true,false}]
                        Displays the information in YAML format if set to 'true'. (default: false)
  • delete-group-role example with all the required argument passed.
yeedu admin delete-group-role --group_id=15 --role_id=0
  • Console output
{
  "message": "Deleted Group Role for the provided group ID: 15, and role ID: 0."
}