To enable end to end quality analysis, from the VA.gov CMS through to the public facing website, new feature review, and stakeholder demonstrations, multiple joined CMS/WEB environments may be created by any user with access to DevShop.
The following table lists all environments and CMS/WEB sites used in the development process for VA.gov:
| Environment | Drupal (CMS) | Frontend (FE / WEB / Static) | Management |
|---|---|---|---|
| PROD Live Site |
prod.cms.va.gov | www.va.gov | BRD: Jenkins |
| STAGING Pre-release testing. |
staging.cms.va.gov | staging.va.gov | BRD: Jenkins |
| DEV Latest approved code. |
dev.cms.va.gov | dev.va.gov | BRD: Jenkins |
| LOCAL Local development |
va-gov-cms.lndo.site | va-gov-cms.lndo.site va-gov-cms.lndo.site/static va-gov-cms.lndo.site/$URL?_format=static_html |
|
| CI / PR Pull Requests & Automated Testing |
pr###.ci.cms.va.gov | pr###.web.ci.cms.va.gov pr###.ci.cms.va.gov/static pr###.ci.cms.va.gov/$URL?_format=static_html |
CMS-CI: DevShop |
| Demos Demos & Training |
NAME.demo.ci.cms.va.gov | NAME.web.demo.ci.cms.va.gov NAME.demo.ci.cms.va.gov/static NAME.demo.ci.cms.va.gov/$URL?_format=static_html |
CMS-CI: DevShop |
For more information on how access these environments see Access
Environments are copies of the production site that are running newer code or have different content that needs to be tested before going live.
Environments can also be used for demonstrations or training, without worrying about disrupting production content.
Each Environment has both a CMS and a WEB site. The CMS is a content management system built with Drupal, and the WEB site is a static HTML site, built with Metalsmith.
The WEB build process consumes the content from the CMS in the same environment.
- Each WEB site is made up of generated "static" files. This means that the WEB site reflects the content from the CMS at the time the WEB Build process was run.
- CMS Editors will not see changes in the WEB site until a "WEB Build" is triggered and the process completes successfully.
- The WEB site will not be accessible until at least one "WEB Build" has run successfully. This happens automatically for CI environments, but not yet for Demo environments. If you get an error such as "Forbidden" when visiting the WEB site, try running the Rebuild WEB process again.
Within the CMS-CI platform, in the "demo" project, users can "Create New Environments" using the big green button.
-
Visit http://devshop.cms.va.gov/ and click "G" icon to log in with GitHub.
-
Click demo link to visit the "Demos Dashboard".
-
Scroll down if needed and press the "Create New Environment" button.
-
Enter a "name" for your environment, using only letters and numbers, all lowercase.
-
If you wish to copy prod.cms.va.gov using the latest content, do not change any additional options.
For advanced users, such as those testing out new functionality: 6. If you want to test out the CMS on a developer's branch, click the Branch, Tag, or Pull Request field, and start typing the name or pull request title you wish to use. 7. If you wish to copy a existing demo environment, instead of prod, click Advanced Options and select Clone Environment under Install Method. 8. If you wish to add additional Domain Names to this environment, click Advanced Options and then Domain Names. Any extra domain names must be in the pattern "*.ci.cms.va.gov".
-
Finally, Press the "Create New Environment" button. After about 10-15 minutes, you will have a running site!
-
Click the URLs for your environment to visit, once "install" step is complete.
NOTE: The WEB site for this environment will not work until you trigger a WEB Build process.
Within each environment, the static HTML for the WEB site is occasionally "rebuilt" so that the latest content from that environment's CMS is used.
The WEB build process is tested in the CI system to ensure compatiblity with the CMS content schema.
The WEB build process is triggered automatically by certain actions in the CMS or manually via the command line or the DevShop Dashboard.
The WEB instance of an environment is rebuilt when any of the following actions take place in the CMS:
- Facility Alert or Individual Facility Operating Status is created or updated.
- The "Rebuild WEB" button is pressed.
- @TODO: Document all current build triggers.
Note to Developers: Keep this list up to date to help content editors understand the process.
There is a special button and form for rebuilding VA.gov environments. Use this to manually trigger either a WEB or CMS rebuild (or both), and optionally check out different code.
-
Find the environment you would like to build in the CMS-CI site.
-
Click the "Hamburger Menu" button, then the "Rebuild Environment" button.
-
If you wish to just trigger a WEB rebuild with the existing content, do not change any other options.
For advanced users and developers:
- If you wish to change the branch of the CMS or WEB, click "Change Code Versions".
- If you wish to reset your environment's Content or Configuration, click "Advanced Options".
-
Press the "Rebuild Environment" button.
-
Once the REBUILD process is complete, you can click the "WEB" site link for the environment in the DevShop UI.
-
That's it! If the process completed, you should see a site that looks like VA.gov.
Environments are copies of the production site that are running newer code or have different content that needs to be tested before going live.
Environments can also be used for demonstrations or training, without worrying about disrupting production content.
Each Environment has both a CMS and a WEB site. The CMS is a content management system built with Drupal, and the WEB site is a static HTML site, built with Metalsmith.
The WEB build process consumes the content from the CMS in the same environment.
- Each WEB site is made up of generated "static" files. This means that the WEB site reflects the content from the CMS at the time the WEB Build process was run.
- CMS Editors will not see changes in the WEB site until a "WEB Build" is triggered and the process completes successfully.
- The WEB site will not be accessible until at least one "WEB Build" has run successfully. This happens automatically for CI environments, but not yet for Demo environments. If you get an error such as "Forbidden" when visiting the WEB site, try running the Rebuild WEB process again.
Within the CMS-CI platform, in the "demo" project, users can "Create New Environments" using the big green button.
-
Visit http://devshop.cms.va.gov/ and click "G" icon to log in with GitHub.
-
Click demo link to visit the "Demos Dashboard".
-
Scroll down if needed and press the "Create New Environment" button.
-
Enter a "name" for your environment, using only letters and numbers, all lowercase.
-
If you wish to copy prod.cms.va.gov using the latest content, do not change any additional options.
For advanced users, such as those testing out new functionality:
- If you want to test out the CMS on a developer's branch, click the Branch, Tag, or Pull Request field, and start typing the name or pull request title you wish to use.
- If you wish to copy a existing demo environment, instead of prod, click Advanced Options and select Clone Environment under Install Method.
- If you wish to add additional Domain Names to this environment, click Advanced Options and then Domain Names. Any extra domain names must be in the pattern "*.ci.cms.va.gov".
-
Finally, Press the "Create New Environment" button. After about 10-15 minutes, you will have a running site!
-
Click the URLs for your environment to visit, once "install" step is complete.
NOTE: The WEB site for this environment will not work until you trigger a WEB Build process.
Within each environment, the static HTML for the WEB site is occasionally "rebuilt" so that the latest content from that environment's CMS is used.
The WEB build process is tested in the CI system to ensure compatiblity with the CMS content schema.
The WEB build process is triggered automatically by certain actions in the CMS or manually via the command line or the DevShop Dashboard.
The WEB instance of an environment is rebuilt when any of the following actions take place in the CMS:
- Facility Alert or Individual Facility Operating Status is created or updated.
- The "Rebuild WEB" button is pressed.
- @TODO: Document all current build triggers.
Note to Developers: Keep this list up to date to help content editors understand the process.
There is a special button and form for rebuilding VA.gov environments. Use this to manually trigger either a WEB or CMS rebuild (or both), and optionally check out different code.
-
Find the environment you would like to build in the CMS-CI site.
-
Click the "Hamburger Menu" button, then the "Rebuild Environment" button.
-
If you wish to just trigger a WEB rebuild with the existing content, do not change any other options.
For advanced users and developers:
- If you wish to change the branch of the CMS or WEB, click "Change Code Versions".
- If you wish to reset your environment's Content or Configuration, click "Advanced Options".
-
Press the "Rebuild Environment" button.
-
Once the REBUILD process is complete, you can click the "WEB" site link for the environment in the DevShop UI.
-
That's it! If the process completed, you should see a site that looks like VA.gov.
All environments are hosted on VA GovCloud in AWS GovCloud.
The primary environments, DEV, STAGING, and PROD, are hosted in the BRD system.
Pull Request Environments and Ad Hoc environments are hosted in the CMS-CI system.
SOCKS proxy or PIV+GFE hardware is required for accessing VA internal network.
Build, Release, Deploy
- Source Code: https://github.com/department-of-veterans-affairs/devops/tree/master/ansible/build/roles/cms
- Runs Continuous Integration for about a dozen different applications with different requirements, including
vets-website,vets-api,cms, and sooncms-ci. - BRD Process is standardized across apps using Ansible playbooks and roles. See the DevOps Repo Documentation for more information.
-
The "Build" process creates the entire server image and permantently tags and archives it as an AMI.
-
The "Deploy" process delivers those images to the 3 "environments", DEV, STAGING, and PROD and runs whatever hooks are needed.
-
The "Release" process continuously delivers code to each BRD Environment
- Primary branch commits are automatically deployed to DEV and STAGING Environments.
- Git Tags and GitHub Releases are created automatically if those commits pass testing.
- "Environments" in the context of BRD are really different networks.
- The "servers" that actually run the apps are activated AMI images, placed into the desired "environment".
-
Open Source Drupal CI Platform
- CMS-CI refers to the VA's implementation of DevShop. There are some extra modules and settings that are added to DevShop specific for the VA. The extra tools are contained in the CMS-CI role in the DevOps Repo.
- Provides an environment per Pull Request, and allows creation of ad-hoc environments with any name, on any desired branch or Pull Request.
- Provides a Web UI for getting information and managing these environments
- Installed with open source Ansible roles, plus a custom playbook.
- Deployment of new releases of CMS-CI and DevShop is handled by BRD in way very similar to CMS.
- Provides a complete SDLC pipeline for Drupal code:
- Creates new environments when a PR is open.
- Automatically tests the environment and passes status to GitHub to allow or block merging.
- Destroys and rebuilds PR Environments and runs the full test suite again on every git push.
- If the PR is merged or closed, environment is destroyed.
- Notifies GitHub of deployment success or failure, with lnks to the environments.
- Includes the FE/WEB Build process in the Drupal CI pipeline.
- Front-end WEB project is built inside PR environments automatically.
- End-to-end testing of CMS+WEB with Behat:
- Make CMS updates: Change content, publish state, etc.
- Run WEB build command to rebuild static assets.
- Confirm CMS change is visible in WEB static assets.
- Runs on a single EC2 instance.
To access a CI environment via ssh you will need to do an initial setup:
- Get socks access
- Install sshuttle
- Login to devshop.cms.va.gov, click on "My Account" and an then "SSH keys" and add your public ssh key.
- Edit your /etc/host file and add
10.247.104.242 devshop.cms.va.gov
To connect:
- In terminal run
composer va:proxy:sshuttle, should result inclient: Connected - Open a new tab in your terminal and run
ssh aegir@devshop.cms.va.gov - To get to a specific pr environment run
cdd @pr1234. This will take you to the docroot of that environment. Proceed to run drush commands.