search

cyverse / cyverse-sdk

A resource for CyVerse developers
Other
13 stars 19 forks source link

Add status check CLI command #4

Open mwvaughn opened 7 years ago

mwvaughn commented 7 years ago
  1. I would like to be able to tell users to run a local CLI command when they report problems. This would poll the status page (or its machine-readable version) at http://status.agaveapi.co/ and report to the user whether there is anything wrong w/ the platform or the Cyverse tenant. This would include scheduled maintenance.
  2. Then, I would like to extend the core CLI to direct users to either the status page or to use of this command when a 503 or other error is encountered by the CLI.
deardooley commented 7 years ago

Last weekend I built this into the Agave CLI. I also added a ttyrec and ttygif to the docker image so they could record problems as they see them and send us the recording along with a description.

The use case is as follows:

A user has an issue while using the CLI. They don’t know where to send it, so they run the issues-create command. Their problem is reproducible, so they include the —with-tty and —with-attachment arguments to record a session where they replicate the problem and attach a sample json file/folder. When the recording stops, they add a message about their issue and submit the issue.

The request is sent to a relay service in their tenant where the assets are collected, stored in a drop area managed by the platform. The admin contact associated with that tenant is notified by Slack and a HelpDesk issue for their tenant. Any additional webhooks registered for tenant issues are fired.

The user is given a reference id for their issue and a contact address based on the tenant admin settings. The user can list their outstanding issues from the cli using issues-list. Full message threading isn’t currently available.

Currently I have a branch with the tierce support, initial command draft, and simple node service to handle the integrations on the server side. Need to push a couple additional fields into the tenants api to support multiple tenant stakeholders.

— Rion

On Jan 24, 2017, at 1:56 PM, Matthew Vaughn notifications@github.com<mailto:notifications@github.com> wrote:

  1. I would like to be able to tell users to run a local CLI command when they report problems. This would poll the status page (or its machine-readable version) at http://status.agaveapi.co/ and report to the user whether there is anything wrong w/ the platform or the Cyverse tenant. This would include scheduled maintenance.
  2. Then, I would like to extend the core CLI to direct users to either the status page or to use of this command when a 503 or other error is encountered by the CLI.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/cyverse/cyverse-sdk/issues/4, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AAv7MkFTf-SL-Tl7InmL9jQy_QwNGzoSks5rVldygaJpZM4Lstsh.