Skip to content

Edit Storage System Definition

Andrew Magill edited this page Jul 9, 2016 · 26 revisions

#####Previous Step - Generate Agave API Authorization Token


Agave supports about a dozen authentication protocols for accessing systems, including iRODS and Amazon S3. I will provide a couple simple examples that will allow you to register a system using either username/password or SSH keys; refer to this documentation for a more comprehensive set of examples.

Option 1 - Authenticate with Username and Password:

Create a text file on your system called my-system.json (or another name that you prefer) in an easily accessible directory.

my-system.json:

{
  "id": "sftp.storage.example.com",
  "name": "Example SFTP Storage System",
  "type": "STORAGE",
  "description": "My example storage system using SFTP to store data for testing",
  "storage": {
    "host": "storage.example.com",
    "port": 22,
    "protocol": "SFTP",
    "rootDir": "/",
    "homeDir": "/home/apiuser",
    "auth": {
      "username": "apiuser",
      "password": "changeit",
      "type": "PASSWORD"
    }
  }
}

Option 2 - Authenticate with SSH keys:


#####Next Step - Upload System Definition File