gen5-deploy Documentation

This repository is the DevOps and deployment support project for TerraGo Streetlights, StreetlightOps, and GridOps environments. It includes the packaged slservice and sladmin command-line tools, deployment configuration, support scripts, scheduled task code, and Lambda-related utilities.

Use this documentation set as the source of truth in Git. When content needs to move into Confluence, convert the relevant Markdown pages to .docx and import them there rather than maintaining a second copy by hand.

If you are new to the project, start here:

  1. Read slservice Reinstall Quickstart if you need the fastest path to a working local slservice.
  2. Read Install for local prerequisites and package installation options.
  3. Read Developer Setup for cloning the repository and preparing a working environment.
  4. Read Deployment for package publishing and deployment-specific notes.
  5. Use the CLI reference when you need exact command-line arguments.

Repository Areas

  • deploy/: packaged Python CLI code, config files, tests, Dockerfile, and supporting modules.
  • scripts/: one-off and operational scripts for AWS, Cognito, ECS, SSM, database, and event workflows.
  • scheduled-tasks/: containerized scheduled jobs.
  • lambdas/: Lambda functions and SAM templates.

Documentation Principles

  • Keep the canonical documentation in this repository.
  • Update docs in the same pull request as behavior changes.
  • Treat live CLI help output as the source of truth for flags and arguments.
  • Keep Confluence as a publication target, not the authoring system.