feat: Fully operational Amazon Q module v2.0.0 #362

harleylrn · 2025-08-22T15:06:43Z

Title:

feat: complete amazon-q module v2.0.0 with comprehensive enhancements

Description:

Closes #240

This PR introduces a complete rewrite and enhancement of the amazon-q module, bringing it to version 2.0.0. The module now provides AgentAPI support.

Type of Change

Module Information

Path: registry/coder/modules/amazon-q
New version: v2.0.0
Breaking change: [x] Yes [ ] No

Key Features & Enhancements

🚀 Core Functionality

AgentAPI Support: Web and CLI app integration with health checks
Amazon Q CLI Integration: Automatic installation and configuration of Amazon Q CLI
MCP Integration: Model Context Protocol support for task reporting to Coder
Authentication System: Tarball-based authentication with environment variable management

🛠️ Customization & Configuration

Pre/Post Install Scripts: Support for custom setup and finalization scripts
Agent Configuration: Templated agent config with tool and resource management
Custom System Prompts: Configurable AI behavior and task reporting instructions
Version Pinning: Support for specific Amazon Q CLI and AgentAPI versions

📚 Documentation & Testing

Comprehensive README: Complete user guide with examples, configuration details, and troubleshooting
Visual Documentation: Updated screenshots and interface examples
Terraform Testing: Complete .tftest.hcl with 8 test cases (all passing)
Registry Compliance: Full adherence to Coder Registry contributing guidelines

d## Breaking Changes

This is a major version update (v2.0.0) with breaking changes:

Renamed variables names (Removed experimantal_ prefix)
Updated AgentAPI integration method
Modified default configuration structure

Testing & Validation

Tests pass (terraform test - 8/8 tests passing)
Code formatted (bun run fmt)
Changes tested locally
Registry compliance verified
Documentation reviewed and updated

Related Issues

Closes #240 - Amazon Q module enhancement request

Additional Notes

Module is now production-ready with professional quality code and documentation
Full compliance with Coder Registry contributing guidelines
Comprehensive test coverage ensures reliability
Ready for registry submission and community use

Screenshots:

bpmct · 2025-08-22T22:05:15Z

Is this ready for review? I see its still marked as a draft PR @harleylrn

harleylrn · 2025-08-22T22:51:05Z

@bpmct Will be ready Monday 😄
WE want to verify it again internally first 😄

keirans · 2025-08-25T01:28:32Z

registry/coder/modules/amazon-q/amazon-q.tftest.hcl

@@ -0,0 +1,144 @@
+run "required_variables" {


This is good, I think it is probably a better approach to testing on this code to use the native Terraform testing framework for unit tests.

2 Items for this

As this is new for the Coder team, can you put some light documentation in the README about how to contribute and execute the tests. Link to the official documentation predominantly and feed free to steal some of the language from our ADRs

For these tests, can you pin versions, etc to key versions, such as AgentAPI and Q - We want to certify this module with a specific configuration of AgentAPI and Q and know what breaks when things change from other contributors.

The terraform tests are fully supported by the coder team, it is mentioned in the contribution guide. I don't think anything need to be added there

Yes, agree, will add this.

registry/coder/modules/amazon-q/main.tf

keirans · 2025-08-25T01:43:12Z

registry/coder/modules/amazon-q/main.tf

-  type        = string
-  description = "Custom script to run after installing Amazon Q."
-  default     = null
+variable "trust_all_tools" {


This is inherently dangerous, and we should put some guidance around its use here given that we are saying this is suitable for production like use cases.

2 Options here

We opt for Safety and remove this functionality and drive the users towards allow listing the configuration in the configuration file which has some sane, safe configuration they can compliment.

We add a warning in the variable description such as "WARNING: Enabling this removes all restrictions on the Amazon Q to perform actions on the launched Workspace Environment, Available CLIs and Configured MCP Services and to local and remote services. DO NOT USE THIS OUTSIDE OF TEST ENVIRONMENTS.

Either way, the default should be false. As we need to put some guidance on tool trust in the readme.

The more i think about this and the danger it exposes, the more i think we should opt for removal - Happy to discuss it with you in more detail internally.

keirans · 2025-08-25T01:50:19Z

registry/coder/modules/amazon-q/main.tf

@@ -116,204 +105,106 @@ variable "system_prompt" {
  EOT
 }

-variable "ai_prompt" {
+variable "auth_tarball" {


Lets transition this to a new var name called var.auth_bundle or var.auth_key as it is a bit cleaner, and in the fortunate event we get something else in this space such as an API key we can re-use this var without breaking the module interface and having to bump a full version as per semver.

keirans · 2025-08-25T01:51:42Z

registry/coder/modules/amazon-q/main.tf

  type        = string
-  description = "The initial task prompt to send to Amazon Q."
-  default     = "Please help me with my coding tasks. I'll provide specific instructions as needed."
+  description = "Base64 encoded, zstd compressed tarball of a pre-authenticated ~/.local/share/amazon-q directory. After running `q login` on another machine, you may generate it with: `cd ~/.local/share/amazon-q && tar -c . | zstd | base64 -w 0`"


Lets shorten this to description and pass the creation of the content into the README.

keirans · 2025-08-25T01:58:00Z

registry/coder/modules/amazon-q/main.tf

+}
+
+# Expose auth tarball as environment variable for install script
+resource "coder_env" "auth_tarball" {


See comment above about the transition of this to another var name.

- Enhanced module configuration and functionality - Improved variable handling and resource management - Updated for better compatibility and performance

keirans · 2025-08-25T02:01:17Z

registry/coder/modules/amazon-q/main.tf

+  install_script  = file("${path.module}/scripts/install.sh")
+  start_script    = file("${path.module}/scripts/start.sh")
+  module_dir_name = ".amazonq"
+  agent_config = var.agent_config == null ? templatefile("${path.module}/templates/agent-config.json.tpl", {


This is good, however I think we should provide a bit more guidance on how to use agent_config, ie, do we pass in an explicit config block, or should we keep the interface consistent and allow the user to pass through the path to an alternate tpl file outside of the module dir based on the environment configuration ?

The documentation will need to be updated to reflect this.

keirans · 2025-08-25T02:14:49Z

registry/coder/modules/amazon-q/scripts/install.sh

+    ARCH="$(uname -m)"
+    case "$ARCH" in
+    "x86_64")
+      Q_URL="https://desktop-release.q.us-east-1.amazonaws.com/${ARG_VERSION}/q-x86_64-linux.zip"


Just thinking about enterprise use cases where direct internet access is unlikely to be allowed, we should consider the introduction of a new var for specifying the Q install URL Prefix.

ie, var.q_install_url with a default value of "https://desktop-release.q.us-east-1.amazonaws.com" so that users can control this. The same naming format, etc that Amazon us for versioning and filenames still apply however.

Given that the URLs for x86 and arm are different, it might be worth passing in a map that covers both of the URLs in one go.

keirans · 2025-08-25T02:19:54Z

registry/coder/modules/amazon-q/main.tf

+
+module "agentapi" {
+  source  = "registry.coder.com/coder/agentapi/coder"
+  version = "1.1.1"


I'm not sure if we can pass this version through as a var , however we will need to call it out as a dependancy in the documentation.

keirans · 2025-08-25T02:58:39Z

registry/coder/modules/amazon-q/main.tf

+    ARG_TRUST_ALL_TOOLS='${var.trust_all_tools}' \
+    ARG_AI_PROMPT='${base64encode(local.full_prompt)}' \
+    ARG_MODULE_DIR_NAME='${local.module_dir_name}' \
+    ARG_FOLDER='${var.folder}' \


Can we transition away from 'folder' and the var name, I feel it is too vague a descriptor - Something like 'homedir' or similar i feel would be easier to work with.

Feedback on this welcome :)

keirans

Hey Matey,
Have dropped some comments through this, let me know if you have any questions.

Appreciate the work, it's shaping up nicely.

Michael Orlov added 2 commits August 22, 2025 11:05

feat: Fully operational Amazon Q module v2.0.0

cfdf844

docs: Updated README

83a9dfb

keirans reviewed Aug 25, 2025

View reviewed changes

registry/coder/modules/amazon-q/main.tf Outdated Show resolved Hide resolved

keirans reviewed Aug 25, 2025

View reviewed changes

registry/coder/modules/amazon-q/main.tf Outdated Show resolved Hide resolved

keirans reviewed Aug 25, 2025

View reviewed changes

feat: update amazon-q module main.tf configuration

87d2fa0

- Enhanced module configuration and functionality - Improved variable handling and resource management - Updated for better compatibility and performance

keirans reviewed Aug 25, 2025

View reviewed changes

keirans suggested changes Aug 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Fully operational Amazon Q module v2.0.0 #362

feat: Fully operational Amazon Q module v2.0.0 #362

harleylrn commented Aug 22, 2025 •

edited

Loading

Uh oh!

bpmct commented Aug 22, 2025

Uh oh!

harleylrn commented Aug 22, 2025

Uh oh!

keirans Aug 25, 2025

Uh oh!

harleylrn Aug 25, 2025

Uh oh!

Uh oh!

Uh oh!

keirans Aug 25, 2025

Uh oh!

keirans Aug 25, 2025

Uh oh!

keirans Aug 25, 2025

Uh oh!

keirans Aug 25, 2025

Uh oh!

keirans Aug 25, 2025 •

edited

Loading

Uh oh!

keirans Aug 25, 2025 •

edited

Loading

Uh oh!

keirans Aug 25, 2025

Uh oh!

keirans Aug 25, 2025

Uh oh!

keirans left a comment

Uh oh!

Uh oh!

feat: Fully operational Amazon Q module v2.0.0 #362

Are you sure you want to change the base?

feat: Fully operational Amazon Q module v2.0.0 #362

Conversation

harleylrn commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Title:

Description:

Type of Change

Module Information

Key Features & Enhancements

🚀 Core Functionality

🛠️ Customization & Configuration

📚 Documentation & Testing

Testing & Validation

Related Issues

Additional Notes

Screenshots:

Uh oh!

bpmct commented Aug 22, 2025

Uh oh!

harleylrn commented Aug 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keirans Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keirans Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keirans left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

harleylrn commented Aug 22, 2025 •

edited

Loading

keirans Aug 25, 2025 •

edited

Loading

keirans Aug 25, 2025 •

edited

Loading