-
Notifications
You must be signed in to change notification settings - Fork 2
feat: add gitlab_agent_enabled_deploy variable to control whether GitLab Agent components are deployed #18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add gitlab_agent_enabled_deploy variable to control whether GitLab Agent components are deployed #18
Conversation
…Lab Agent components are deployed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a feature flag to control whether the GitLab Agent Helm release is deployed, updates the default Helm chart version, and records the change in the changelog.
- Introduce
gitlab_agent_enabled_deploy
variable to toggle agent deployment - Use
count
onhelm_release.this
to conditionally create the Helm release - Bump default
helm_chart_version
to2.13.0
and add a0.10.0
changelog entry
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
variables.tf | Add new gitlab_agent_enabled_deploy boolean variable |
main.tf | Apply count to the Helm release resource based on the new flag |
README.md | Document the new input and bump helm_chart_version default |
CHANGELOG.md | Add release section for version 0.10.0 |
Comments suppressed due to low confidence (4)
variables.tf:6
- [nitpick] The variable name ordering deviates from the existing pattern (e.g.,
gitlab_agent_deploy_enabled
may read more naturally and sort alphabetically with other inputs).
variable "gitlab_agent_enabled_deploy" {
main.tf:132
- Add or update tests (e.g., in a Terraform integration suite) to verify that when
gitlab_agent_enabled_deploy
isfalse
, the Helm release resource is not created.
count = var.gitlab_agent_enabled_deploy ? 1 : 0
README.md:60
- Consider adding a short usage example showing how to set
gitlab_agent_enabled_deploy = false
and what resources are created or skipped as a result.
| <a name="input_gitlab_agent_enabled_deploy"></a> [gitlab_agent_enabled_deploy](#input_gitlab_agent_enabled_deploy) | Whether to deploy the GitLab Agent components. If false, only creates the GitLab Agent token, Kubernetes namespace and secret without deploying the agent itself. | `bool` | `true` | no |
README.md:71
- Since the default Helm chart version was bumped from
2.11.0
to2.13.0
, add upgrade notes or call out potential breaking changes for users updating the module.
| <a name="input_helm_chart_version"></a> [helm_chart_version](#input_helm_chart_version) | The version of the gitlab-agent Helm chart. You can see the available versions at https://gitlab.com/gitlab-org/charts/gitlab-agent/-/tags, or using the command `helm search repo gitlab/gitlab-agent -l` after adding the Gitlab Helm repository. | `string` | `"2.13.0"` | no |
/describe |
/review |
PR Description updated to latest commit (281688b) |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
/improve |
PR Code Suggestions ✨No code suggestions found for the PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
PR Type
Enhancement, Documentation
Description
Add
gitlab_agent_enabled_deploy
variable to control agent deploymentUpdate Helm release to be conditional on new variable
Document new variable in README and CHANGELOG
Bump default Helm chart version in documentation to 2.13.0
Changes walkthrough 📝
main.tf
Conditional deployment of Helm release based on new variable
main.tf
gitlab_agent_enabled_deploy
variables.tf
Add variable to control agent deployment
variables.tf
gitlab_agent_enabled_deploy
variable definitionREADME.md
Document new deployment control variable and chart version
README.md
gitlab_agent_enabled_deploy
variable in inputs tableCHANGELOG.md
Add changelog for agent deployment control variable
CHANGELOG.md