Audit: CMS docs for upstream/downstream dependencies and API users re: Forms / Facilities #18230
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jilladams
commented
May 24, 2024
| @@ -6,15 +6,14 @@ This document lists known services which depend on the CMS. Information on **API | |||
|
|
|||
| ## Services | |||
|
|
|||
| | ServiceName | Monitoring | Mode | Data | Alerts | Team POC | API Username | GQL Downstream integartion | | |||
There was a problem hiding this comment.
Just whitespace changes
jilladams
commented
May 24, 2024
| | Feature flags endpoint (/flags_list) | [Datadog](https://vagov.ddog-gov.com/synthetics/details/9z4-5uh-k7r) | GET endpoint at `/flags_list` that provides a list of feature flags for the content build (https://github.com/department-of-veterans-affairs/content-build/actions/workflows/content-release.yml) to consume ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/interfaces.md#featureflags)) | Feature flags that control whether certain products are enabled | None | N/A | N/A | N/A | ||
| | Virtual Agent Chatbot | N/A | N/A | N/A | N/A | Slack [#va-virtual-agent-public](https://dsva.slack.com/archives/C01KTS3F493) | virtual_agent_api | Currently pulls from tugboat: https://main-0jm2a1h08xb0nzpger8iko49kskarwcm.ci.cms.va.gov/graphql | ||
| | Datadog Monitoring Platform | | Datadog uses Synthetic metrics to monitor GQL endpoints with authenticated HTTP requests. | N/A | N/A | Slack [#cms-platform](https://dsva.slack.com/archives/C02HX4AQZ33) | datadog_api | | ||
| | Lighthouse Forms API (push) | [Datadog](https://vagov.ddog-gov.com/synthetics/details/f83-ca6-cu2)| Lighthouse pulls data with GraphQL ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/migrations-forms.md#cms-forms-data-to-lighthouse))| Form data (manually edited auxiliary fields) from “VA Form” nodes| Pager Duty - Non Critical | [#va-forms](https://dsva.slack.com/archives/CUB5X5MGF), @public-websites-team | forms_api | Nightly Frequency (0100 ET), ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/migrations-forms.md#cms-forms-data-to-lighthouse)) |
There was a problem hiding this comment.
Renamed to be more accurate about the Service we depend on
| | Forms API | [Datadog](https://vagov.ddog-gov.com/synthetics/details/f83-ca6-cu2) | Lighthouse pulls data with GraphQL ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/migrations-forms.md#cms-forms-data-to-lighthouse)) | form data (manually edited auxiliary fields) from “VA Form” nodes | Pager Duty - Non Critical | [#va-forms](https://dsva.slack.com/archives/CUB5X5MGF) | forms_api | Nightly Frequency (0100 ET) Forms API = form data (manually edited auxiliary fields) from “VA Form” nodes ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/migrations-forms.md#cms-forms-data-to-lighthouse)) | ||
| | [GraphQL (Content API)](#graphql-content-api-notes) | [Datadog](https://vagov.ddog-gov.com/synthetics/details/f83-ca6-cu2) | GraphQL contrib module provides endpoint and explorer ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/graph_ql.md)) | All Drupal entities (content & config) | Pager Duty - Non Critical | Slack [#vsp-tools-fe](https://dsva.slack.com/archives/CQH357ZTP) | content_build_api | Hourly frequency 8am-5pm ET for Content build | ||
| | Facility Statuses (push to lighthouse) | Slack notification to `#cms-notifications` channel via Drupal [here](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/modules/custom/va_gov_post_api/src/EventSubscriber/QueueItemProcessedEventSubscriber.php#L104) and [here](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/modules/custom/va_gov_post_api/src/EventSubscriber/QueueProcessedEventSubscriber.php#L107) | post_api contrib module is used to POST updates to lighthouse’s API every 10-15 minutes (when updates are available in queue) ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/vamc-facilities.md#status-changes-to-lighthouse)) | Facility statuses (certain fields on VAMC statuses, operating status, additional status info, facility API locator ID used as GID) | Slack | Slack [#vsa-facilities](https://dsva.slack.com/archives/C0FQSS30V) | facility_api | N/A | ||
| | Health service descriptions | Slack notification to `#cms-notifications` channel via Drupal [here](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/modules/custom/va_gov_post_api/src/EventSubscriber/QueueItemProcessedEventSubscriber.php#L104) and [here](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/modules/custom/va_gov_post_api/src/EventSubscriber/QueueProcessedEventSubscriber.php#L107) | post_api contrib module is used to POST updates to the Lighthouse API on cron every 10-15 minutes (when updates are available in queue) ([README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/vamc-facilities.md#status-changes-to-lighthouse)) | Only Covid 19 vaccine service descriptions at this time, but soon to be all health service descriptions. | Slack | N/A | N/A | N/A |
There was a problem hiding this comment.
Consolidated this Health service description line into the line above, to be a single line re: dependency on the Lighthouse Facilities API. If that's not right conceptually for how it works in Drupal, I can revert that change
| 1. Discuss the need for a new user with the Platform CMS tech lead (currently @ndouglas) and propose a name. | ||
| 2. Complete/approve/merge any pull requests providing functionality the user account will rely upon: | ||
| - roles, permissions, etc that should be assigned to the user at creation | ||
| - roles, permissions, etc that should be assigned to the user at creation |
There was a problem hiding this comment.
fixing bullet indentation
| | Slack (notifications) | Post API failure alerts, Teamsite facility status failure alerts | Drupal calls Slack webhook | [https://status.slack.com/](https://status.slack.com/) | | | | ||
| | [SSOi](https://dvagov.sharepoint.com/sites/OITEPMOIAM/playbooks/Pages/IAM%20URLs.aspx) (must be on VA network to access doc) | CMS users are authenticated with the VA Single Sign On service (SSOi) | See [README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/cms-login.md#technical-details) | https://iamportal.iam.va.gov/iamv2/index.php (must be on VA network) | https://iamportal.iam.va.gov/iamv2/help/contactUs.php (must be on VA network) | | | ||
| | [GovDelivery](https://granicus.com/solution/govdelivery/)| Situation updates & alerts are sent to subscribed users via GovDelivery| Uses [govdelivery_bulletins](https://github.com/department-of-veterans-affairs/va.gov-cms/tree/main/docroot/modules/custom/va_gov_govdelivery) module to post data to the GovDelivery API endpoint| [See Below](#govdelivery)| [https://support.granicus.com/s/contactsupport](https://support.granicus.com/s/contactsupport)||| | ||
| | Lighthouse Facilities API | VAMC, Vet Center, Regional Office, Cemetery, and health services data [See Below](#facility-cemetery-and-health-services-via-lighthouse-api)| [Nightly Facility Migration](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/migrations-facility.md); [See Below](#lighthouse-facilities-api)| https://valighthouse.statuspage.io | [#cms-lighthouse](https://app.slack.com/client/T03FECE8V/C02BTJTDFTN) slack channel - @facilities-team <br/> Adam Stinton (LH engineer)<br/> VA PO = Michelle Middaugh | API paths are [overridden](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/modules/custom/va_gov_migrate/config/install/migrate_plus.migration.va_node_facility_nca.yml#L22) by [settings.php](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/sites/default/settings.php#L146) | |
There was a problem hiding this comment.
Updated service name, description of the dependency, and POCs / Slack contact info
| | [SSOi](https://dvagov.sharepoint.com/sites/OITEPMOIAM/playbooks/Pages/IAM%20URLs.aspx) (must be on VA network to access doc) | CMS users are authenticated with the VA Single Sign On service (SSOi) | See [README](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/cms-login.md#technical-details) | https://iamportal.iam.va.gov/iamv2/index.php (must be on VA network) | https://iamportal.iam.va.gov/iamv2/help/contactUs.php (must be on VA network) | | | ||
| | [GovDelivery](https://granicus.com/solution/govdelivery/)| Situation updates & alerts are sent to subscribed users via GovDelivery| Uses [govdelivery_bulletins](https://github.com/department-of-veterans-affairs/va.gov-cms/tree/main/docroot/modules/custom/va_gov_govdelivery) module to post data to the GovDelivery API endpoint| [See Below](#govdelivery)| [https://support.granicus.com/s/contactsupport](https://support.granicus.com/s/contactsupport)||| | ||
| | Lighthouse Facilities API | VAMC, Vet Center, Regional Office, Cemetery, and health services data [See Below](#facility-cemetery-and-health-services-via-lighthouse-api)| [Nightly Facility Migration](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/migrations-facility.md); [See Below](#lighthouse-facilities-api)| https://valighthouse.statuspage.io | [#cms-lighthouse](https://app.slack.com/client/T03FECE8V/C02BTJTDFTN) slack channel - @facilities-team <br/> Adam Stinton (LH engineer)<br/> VA PO = Michelle Middaugh | API paths are [overridden](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/modules/custom/va_gov_migrate/config/install/migrate_plus.migration.va_node_facility_nca.yml#L22) by [settings.php](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/docroot/sites/default/settings.php#L146) | | ||
| | Lighthouse Forms API | Migration imports from VA Forms DB & creates/updates “VA Form” nodes and forms metadata (Form name, dates, PDF filename, status, administration) | [Nightly Forms Migration](https://github.com/department-of-veterans-affairs/va.gov-cms/blob/main/READMES/migrations-forms.md)| https://valighthouse.statuspage.io | #va-forms slack channel <br/> @public-websites-team | | |
There was a problem hiding this comment.
Updated service name & POC
| * VHA: VAMC & Vet Center Facility metadata and statuses | ||
| * NCA: Cemetery metdata and statuses | ||
| * VBA: Regional Office metadata and statuses | ||
| * Facility services for VAMC, Vet Centers, and Regional Offices |
There was a problem hiding this comment.
Took a pass at this, but in general we know we need to better document the state of what's pulled / pushed between CMS / LIghthouse Facilities API, and I don't know that this is the exact right place to do it. Once we work out where is (probably the migration doc), we can udpate this part as needed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs update only.
Updating the following 3 docs for accuracy re: Sitewide's up/downstream dependencies and API users, related to Forms and Facilities.