Skip to content

Plugin: ats: IBM Aspera Transfer Service🔗

ATS is usable either:

  • From an AoC subscription: ascli aoc admin ats: use AoC authentication

  • Or from an IBM Cloud subscription: ascli ats: use IBM Cloud API key authentication

IBM Cloud ATS: Creation of API key🔗

Note

If you are using ATS as part of AoC, then authentication is through AoC, not IBM Cloud. See the AoC section instead.

This section is about using ATS with an IBM Cloud subscription.

First get your IBM Cloud API key. For instance, it can be created using the IBM Cloud web interface, or using command line:

ibmcloud iam api-key-create <KEY_NAME> -d '<DESCRIPTION>'
OK
API key <KEY_NAME> was created

Please preserve the API key! It cannot be retrieved after it's created.

Name          <KEY_NAME>
Description   <DESCRIPTION>
Created At    2019-09-30T12:17+0000
API Key       <API_KEY>
Locked        false
UUID          ApiKey-05b8fadf-e7fe-abcd-93a9-6fd348c5ab1f

References:

Then, to register the key by default for the ats plugin, create a preset. Execute:

ascli config preset update <PRESET_NAME> --ibm-api-key=<API_KEY>
ascli config preset set default ats <PRESET_NAME>
ascli ats api_key instances
aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
ascli config preset update <PRESET_NAME> --instance=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
ascli ats api_key create --out.secrets=yes
╭────────┬──────────────╮
│ field  │ value        │
╞════════╪══════════════╡
│ id     │ <ATS_KEY>    │
│ secret │ <ATS_SECRET> │
╰────────┴──────────────╯
ascli config preset update <PRESET_NAME> --ats-key=<ATS_KEY> --ats-secret=<ATS_SECRET>

ATS Access key creation parameters🔗

When creating an ATS access key, the creation parameters are provided as a positional argument of access_key create, as a Hash Extended Value. If key transfer_server_id is not provided, the transfer server is selected with options cloud and region. Those are directly the parameters expected by the ATS API.

Misc. Examples🔗

Example: create access key on IBM Cloud (Softlayer):

ascli ats access_key create @json:'{"storage":{"type":"softlayer_swift","container":"_container_name_","credentials":{"api_key":"<SECRET>","username":"_name_:_usr_name_"},"path":"/"},"id":"_optional_id_","name":"_optional_name_"}' --cloud=softlayer --region=ams

Example: create access key on AWS:

ascli ats access_key create @json:'{"id":"<ACCESS_KEY>","name":"laurent key AWS","storage":{"type":"aws_s3","bucket":"my-bucket","credentials":{"access_key_id":"<ACCESS_KEY_ID>","secret_access_key":"<SECRET>"},"path":"/laurent"}}' --cloud=aws --region=eu-west-1

Example: create access key on Azure SAS:

ascli ats access_key create @json:'{"id":"<ACCESS_KEY>","name":"laurent key azure","storage":{"type":"azure_sas","credentials":{"shared_access_signature":"https://containername.blob.core.windows.net/blobname?sr=c&..."},"path":"/"}}' --cloud=azure --region=eastus

Note

The blob name is mandatory after the server address and before the parameters, and parameter sr=c is mandatory.

Example: create access key on Azure:

ascli ats access_key create @json:'{"id":"<ACCESS_KEY>","name":"laurent key azure","storage":{"type":"azure","credentials":{"account":"myaccount","key":"<ACCESS_KEY>","storage_endpoint":"myblob"},"path":"/"}}' --cloud=azure --region=eastus

Delete all access keys:

ascli ats access_key list --fields=id --format=csv | ascli ats access_key delete @lines:@stdin: --bulk=yes

The parameters provided to ATS for access key creation are the ones of ATS API for the POST /access_keys endpoint.

Tested commands for ats🔗

Note

Add ascli ats in front of the following commands:

access_key cluster ak2ibmcloud --secret=<SECRET>
access_key create --cloud=aws --region=my_region @json:'{"id":"ak_aws","name":"my test key AWS","storage":{"type":"aws_s3","bucket":"my_bucket","credentials":{"access_key_id":"<ACCESS_KEY>","secret_access_key":"<SECRET_KEY>"},"path":"/"}}'
access_key create --cloud=softlayer --region=my_region @json:'{"id":"ak2ibmcloud","secret":"<SECRET>","name":"my test key","storage":{"type":"ibm-s3","bucket":"my_bucket","credentials":{"access_key_id":"<ACCESS_KEY>","secret_access_key":"<SECRET_KEY>"},"path":"/"}}'
access_key delete ak2ibmcloud
access_key entitlement ak2ibmcloud
access_key list --fields=name,id
access_key node ak2ibmcloud browse / --secret=<SECRET>
access_key show ak2ibmcloud
api_key create
api_key instances
api_key list
aws_trust_policy --region=us-east-1
cluster clouds
cluster list
cluster show --cloud=aws --region=eu-west-1
cluster show 1f412ae7-869a-445c-9c05-02ad16813be2