IBM COS SDK with IAM auth example

[ricellis]

Add an example using IBM Cloud COS with IAM credentials (that don't include HMAC).

• [ ] Prepare for multiple example projects
  • [ ] Move AWS examples/s3-backup-*.js files into new sub-folder examples/cos-s3
  • [ ] Move examples/package.json into examples/cos-s3 renaming the module from couchbackup-examples to couchbackup-examples-cos-s3
  • [ ] Add a new README in examples/cos-s3 and move the existing examples/README content from the IBM Cloud Object Store S3 API / AWS S3 header into it
  • [ ] Update the remaining examples/README Current examples block to link the IBM Cloud Object Store S3 API / AWS S3 to the new cos-s3 folder
• [ ] Create new COS SDK example
  • [ ] Add a new folder examples/cos-sdk
  • [ ] Add a package.json with name couchbackup-examples-cos-sdk
  • [ ] Add dependencies:
    • [ ] @cloudant/couchbackup
    • [ ] ibm-cos-sdk
    • [ ] verror
    • [ ] yargs
  • [ ] Create new example code
    • [ ] The ibm-cos-sdk S3 API is forked from the old AWS SDK S3 API so the old example https://github.com/IBM/couchbackup/blob/2.9.16/examples/s3-backup-stream.js is a good starting point
    • [ ] Replace aws-sdk usage with the ibm-cos-sdk
    • [ ] Create a README for the new example folder
      • [ ] Document the configuration of the IBM COS SDK
      • [ ] Document the use of service credentials without HMAC
    • [ ] Update the top level README
      • [ ] New Current Examples sub-heading IBM Cloud Object Store SDK
      • [ ] link to the new example folder

Related docs:

• https://www.npmjs.com/package/ibm-cos-sdk
• https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-node
• https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-service-credentials

[IamLRBA]

Hello @ricellis , may i be assigned this issue please. Thanks!

[ricellis]

Thanks for offering to contribute. This is a very old issue and things changed a lot in the meantime. I updated the issue title/description to be more current and to outline the changes that would be expected.

With those updates in mind, if you are still interested in contributing, then please feel free to open a PR following what is outlined in the issue description. Please note that:

• Contributions must have DCO sign off
• We are unable to provide IBM Cloud resources (e.g. for testing)