Upload from Supervisor's list of backups; use HA's name

[ryansch]

Instead of using aws s3 sync, I loop through the backups from supervisor's backup endpoint.

The backup API gives us the friendly name from the UI along with metadata we can send along to S3.

Example:

I'm using this alongside https://github.com/jcwillox/hass-auto-backup to automate taking the actual backups.

[ehbush]

Love this @ryansch. @thomasfr, are you able to verify and approve this merge request?

[thomasfr]

First of all: LOVE IT! 🚀 I was already trying around to get the name and replace it, so happy to see your PR. Thank you.

See my comments, happy to discuss and hear your opinions

[thomasfr]

Could you add a more descriptive debug message please. Just a string what to expect to see, to make it obvious if there is an empty string echoed

[thomasfr]

Remove additional empty line please

[thomasfr]

I think we should also handle special characters. See limitations for object keys: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#:~:text=Characters%20that%20might%20require%20special%20handling

I suggest to use $name as is in the metadata and create a separate variable (for instance $object_key_name) for the object key with replaced/removed characters which need special handling and should be avoided, mentioned in the above link.
Logic could be something like:

1. Replace spaces/multiple whitespace characters with a single _
2. Replace all characters not mentioned here with -, and with a single - if there are multiple consecutive unsafe characters.

What do you think?

[thomasfr]

I think we could/should extract the date information we get from the /backups/info response (date ), and use year, month, day, hour as object key prefix.

For example:

{
  "backups": [
    {
      "slug": "skuwe823",
      "date": "2020-09-30T20:25:34.273Z",
      "name": "Awesome backup with     : some@weird=//characters",
      "type": "partial",
      "size": 44,
      "protected": true,
      "compressed": true,
      "content": {
        "homeassistant": true,
        "addons": ["awesome_addon"],
        "folders": ["ssl", "media"]
      }
    }
  ],
  "days_until_stale": 30
}

Together with my previous comment, this would result in:

object_key_name="Awesome_backup_with_some-weird-characters"
object_key="$year/$month/$day/$hour/$object_key_name"
# Would result in: '2020/09/30/20/Awesome_backup_with_some-weird-characters.tar'

Would also make it easier to manually delete older files via the console or create rules based on the key and we would not need the additional aws s3 ls - (although theoretically there could still be an object with the same key, but very very unlikely).

[ryansch]

This is still on my radar.

[ehbush]

@ryansch and @thomasfr: Any update(s) on this? Would really love to have this feature to make this addon perfect :-)

[ryansch]

I swear I'm not dead.