Skip to content

Resources Methods

resources.aws.init

as_api().resources.aws.init(org, ssh_key_path=None, region=None, queue=None)

Authorize MissingLink resource management to access an AWS account using standard AWS cross-account authorization.

Parameters

  • org: String. Organization to use.
  • ssh_key_path: Optional. String. SSH Key to use for git clone commands and for connecting to virtual machines. By default, your default SSH key (stored in ~/.ssh/id_rsa) will be used.
  • region: Optional. String. AWS region to use.
  • queue: Optional. String. Queue to use at cloud initialization. If provided, the value is the name (or id) of a pre-existing queue. The default server group for this cloud is assigned to that queue. If no queue is specified, the group is created inside the default queue.

resources.azure.init

as_api().resources.azure.init(org, location=None, queue=None, acr=None)

Authorize MissingLink resource management to access an Azure account.

Parameters

  • org: String. Organization to use.
  • location: Optional. String. Azure location to use.
  • queue: Optional. String. Queue to use at cloud initialization. If provided, the value is the name (or id) of a pre-existing queue. The default server group for this cloud is assigned to that queue. If no queue is specified, the group is created inside the default queue.
  • acr: Optional. List of strings. Authorizes access to Docker images in a private ACR. See details about the image parameter when running jobs that require access to private ACRs.

    Notes

    • If you do not specify acr during initialization, MissingLink will create a default container registry for you.
    • Whether or not you specify acr during initialization, you will still be able to use Docker Hub.

resources.local_grid.init

as_api().resources.local_grid.init(org, ssh_key_path=None, force=False, resource_token=None, link_aws=True, env_aws=True, link_gcp=True, link_azure= True, capacity= 1, cache_path=None)

Initialize Resource Management on a local server. Initialization must be performed on each machine that requires authorization.

Parameters

  • org: String. Organization to use.
  • ssh_key_path: Optional. String. SSH Key to use for git clone commands and for connecting to virtual machines. By default, your default SSH key (stored in ~/.ssh/id_rsa) will be used.
  • force: Optional. Boolean. Force installation (stop current Resource Manager if present)? Default is False.
  • resource_token: Optional. String. MissingLink resource token. One will be generated if this instance of MissingLink is authorized.
  • link_aws: Optional. Boolean. Link .aws folder? When configuring the aws-cli an .aws folder is created in your home directory. The folder contains your AWS credentials. When “linked,” the folder will be mounted in your jobs and Resource Manager, allowing them to use the credentials of the host to access AWS services. Default is True.
  • env_aws: Optional. Boolean. Similar to the .aws folder, AWS allows authentication using environment variables. Default is True.
  • link_gcp: Optional. Boolean. Similar to AWS, GCP also has its default directory and this flag allows the folder to be mounted in your jobs and Resource Manager to call GCP APIs. Default is True.
  • link_azure: Optional. Boolean. Similar to AWS. Azure works exactly like the link-aws and link-gcp options, mounting the .azure folder into a container. Default is True.
  • capacity: Optional. Integer. Number of jobs that can be run in parallel on this machine. Default is 1.
  • cache_path: Optional. String. Path for pip, conda, and MissingLink caches.

resources.local_grid.change_group

Configure resource groups.

as_api().resources.local_grid.change_group(org, server, new_group)
Change the group a server is assigned to.

Parameters

  • org: String. Organization to use.
  • server: String. Server id.
  • new_group: String. Group to assign the server to. Required.

resources.queue

as_api().resources.queue(org, name, create=False, description=None, display=None, disable=False)

Manage resource queues.

Parameters

  • org: String. Organization to use.
  • name: String. Update the name of the specified queue to this name.
  • create: Optional. Boolean. Create a new resource queue? Default is False.
  • description: Optional. String. Update the description of the given queue.
  • display: Optional. String. Update the name of the specified queue to this name.
  • disable: Optional. Boolean. Disable the specified queue? Default is False.

resources.group

as_api().resources.group(org, group, advanced=False, show_defaults=False, create=None, show_description=False, configured_only=False, set=None, unset=[])

Configure resource groups.

Parameters

  • org: String. Organization to use.
  • group: String. Group name.
  • advanced: Optional. String. Show advanced configuration parameters in addition to the basic parameters. Default is False.
  • show_defaults: Optional. Boolean. Show default values also? Default is False.
  • create: Optional. String. Create new group or update existing group? Default is False.
  • show_description: Optional. Boolean. Show parameter descriptions? Default is False.
  • configured_only: Optional. Show only parameters with configured values? Default is False.
  • set: Optional. A list, whose members are Tuples of two values: the first is the parameter name (string) and the second the parameter value (string).
  • unset: Optional. A list of strings. Parameters to unset. Reverts one or more parameters to their previous settings, before they were set with set.

resources.job

as_api().resources.job(org, name)

Query status and details for the specified job Id.

Parameters

  • org: String. Organization to use.
  • name: String. Job Id.