Skip to content

Refactor code structure for improved readability and maintainability#10

Merged
codedesignplus-wliscano merged 1 commit intomainfrom
feature/startlight-blog
Aug 5, 2025
Merged

Refactor code structure for improved readability and maintainability#10
codedesignplus-wliscano merged 1 commit intomainfrom
feature/startlight-blog

Conversation

@codedesignplus-wliscano
Copy link
Contributor

This pull request updates documentation for deploying microservices in the CodeDesignPlus ecosystem, focusing on improving clarity and best practices for configuration management and deployment. The changes include a major rewrite of the secrets/configuration section for ms-services, updates to deployment instructions for both REST and gRPC entrypoints, and refinements to the ms-catalog article to better reflect domain-driven terminology.

Configuration and Secrets Management:

  • Updated the section on storing secrets in Vault to emphasize a hybrid strategy: sensitive data is stored in Vault, while non-sensitive configuration is passed as environment variables via Helm. The example Vault command and image descriptions were adjusted to reflect this focus on confidential data.
  • Revised the explanation of configuration precedence for .NET and CodeDesignPlus SDK, detailing how environment variables and Vault secrets override defaults for secure and flexible deployments.

Deployment Instructions:

  • Changed deployment instructions for both REST and gRPC entrypoints of ms-services to use separate values-rest.yaml and values-grpc.yaml files, with explicit environment variable examples and streamlined Helm commands. [1] [2]
  • Updated the Helm deployment commands and clarified the configuration files used for each entrypoint. [1] [2]

Terminology and Metadata Improvements:

  • Renamed the ms-catalog documentation article to "Desplegando Nuestro Primer Servicio de Dominio: ms-catalog", updated tags and excerpt for better alignment with domain-driven design concepts, and added the "Catalogs" tag.

These changes enhance the documentation's clarity, security, and alignment with best practices for microservice deployment in Kubernetes environments.

@codedesignplus-wliscano codedesignplus-wliscano merged commit 8146bf3 into main Aug 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant