Skip to content

Fix aws deployment docs - #136

Merged
yada merged 1 commit into
microcks:mainfrom
Vaishnav88sk:fix-aws-deployment-docs
Sep 2, 2026
Merged

Fix aws deployment docs#136
yada merged 1 commit into
microcks:mainfrom
Vaishnav88sk:fix-aws-deployment-docs

Conversation

@Vaishnav88sk

@Vaishnav88sk Vaishnav88sk commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Description

This PR introduces strategic enhancements and modernizations to the AWS Deployment Guides (install/aws/README.md and install/aws/keycloak-installation.md).

What has changed?

  1. Enhanced TLS Security: Updated the DocumentDB instructions to explicitly utilize the AWS RDS CA bundle for TLS verification, ensuring maximum security out-of-the-box.
  2. Secure Secrets Injection: Shifted the MongoDB credential management in our Helm values from environment variables to native Kubernetes secretRef mapping, aligning with GitOps and enterprise security standards.
  3. VPC Networking Clarity: Added explicit guidance regarding DocumentDB's private networking constraints, ensuring users execute their initialization scripts from within the correct VPC boundaries.
  4. Documentation Polish: Improved the flow, formatting, and technical accuracy of the README files (e.g., clarifying NGINX vs ALB provisioning).

Why were these changes made?

  • Production-Readiness: Enabling TLS and securely injecting credentials ensures that companies using this guide as a reference can deploy Microcks directly into strict compliance environments.

@Vaishnav88sk
docs: Modernize AWS deployment documentation for production readiness
3431682 
- Ensure TLS is enabled for DocumentDB with proper CA bundle mounting
- Clarify IAM policy requirements and attach steps
- Correct Load Balancer nomenclature to NGINX
- Secure MongoDB credentials using Helm secretRef
- Replace unsupported markdown alerts with standard formatting

Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
@Vaishnav88sk
Vaishnav88sk force-pushed the fix-aws-deployment-docs branch from ee32aa8 to 3431682 Compare June 21, 2026 19:36
yada
yada approved these changes Sep 2, 2026
View reviewed changes

@yada yada left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and sorry for the delay

@yada
yada merged commit 58a8dc4 into microcks:main Sep 2, 2026
1 check passed
@Vaishnav88sk

Vaishnav88sk commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

No worries Sir 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yada yada yada approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Vaishnav88sk @yada