Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 2.84 KB

drupal_api_users.md

File metadata and controls

39 lines (32 loc) · 2.84 KB

Content API Consumers

Background

This document lists known services which depend on the CMS and the Drupal users required to consume content via Drupal's API. For a list of all of VA.gov-CMS's down stream dependencies look here.

Users

Team POC Username Usage
Release Tools #vsp-tools-fe content_build_api Building content for VA.gov requires querying Drupal for that content in an authenticated way.
Lighthouse Forms API #va-forms forms_api Forms migration daily tasks must be authenticated
Facilities #cms-lighthouse slack channel - @facilities-team
Adam Stinton (LH engineer)
VA PO = Michelle Middaugh		 facility_api Facilities API migration daily tasks must be authenticated. Upstream notes; Downstream notes
Virtual Agent #va-virtual-agent-public virtual_agent_api ?
CMS #cms-platform datadog_api Datadog Synthetic metrics monitor GraphQL endpoint and require HTTP basic authentication

Creating a New API User

  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
  3. Create a task issue for the account, assign it to CMS Team and DevOps, and assign the tech lead.
    • include the name
    • include desired permissions
    • include any other information that may be desirable
    • any IAM users/roles/etc that may need access to the username and password
  4. DevOps engineers will perform the following procedure:
    • create a new user in Drupal
    • assign it appropriate roles and permissions
    • assign it a temporary password
    • create an entry in SSM Parameter Store for:
      • the username (cms/prod/drupal_api_users/<name>/username)
      • the password (cms/prod/drupal_api_users/<name>/password)
  • communicate the name of the user to you.
  1. Followup issue(s) should be opened for:
    • tests to ensure accurate roles and permissions
    • tests to ensure retrievability of the SSM Parameter Store values
    • additional functionality