AmericanRedCross / damage-assessment-bot

Chatbot for immediate damage and needs assessments
BSD 3-Clause "New" or "Revised" License
7 stars 3 forks source link

Add an authenticated endpoint for health check of application dependencies #121

Closed maxnorth closed 5 years ago

maxnorth commented 5 years ago

in addition to our GET api/health endpoint, which tells us if the application is running, we should have an endpoint that can verify that our dependency integrations are working correctly. This endpoint should be authenticated to prevent excessive calling of our dependent services, probably using a function key.

Acceptance Criteria New endpoint is added which calls our dependencies in a harmless way (GET requests) Should include any external integrations, cosmos, luis, Ifrc, facebook, (chat channel registration?). Store authentication credential (function key?) in key vault (unless this can be accessed by the deploy agent by using the app service rest api - this may be preferable to reduce configuration management overhead). Add this step to the deployment script after deploying to the swap slot and before performing the actual swap to the live instance.

maxnorth commented 5 years ago

@blueelvis I updated the acceptance criteria with a suggestion of querying the function key out of the azure management REST API instead of putting this in key vault. I think this is preferable. I can assist with this if needed, I have a postman collection to help with using that API that I created while developing the deployment script.

blueelvis commented 5 years ago

Closing this since this has been merged.