Skip to content

ec2bat documentation feedback #2

@spyder-guy

Description

@spyder-guy

Specific

Description:

If audience is customer-facing, then lead with what the bat does (fetches metadata tags) instead of how it does it (runs using the picoagent -- a term not yet explained)

Dependencies

  • put the section on pico agent in the depency section.
  • every dependency on a single line
  • dependency on boto3 as well as on requests
  • consider making a requirement.txt so we can tell people to pip install that or have script to install deps

Configuration fields

  • API key - make clear this is the spyderbat api key, people will assume it's AWS. Where can i get a spyderbat API key
  • Org ID - spyderbat organization id - where do i find my org id?
  • URL - if customerfacing we probably should preset this to production and tell them to not touch it

Your code is doing the right thing and trying to get the AWS creds from the environment or the aws configs, but the docs don't mention this, and customers will likely grumble about having to put their keys in a config file. We need to lead with this information

  • source field in config should be empty in config or you'll get errors

General

  • might want a general picoagent repo, with refereneces to all agents and their readmes

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions