fix(schema-migrator): update async helm hook and remove unnecessary resources

prashant-shahi commented 3 weeks ago

Summary

remove unnecessary files related to schema-migrator-sync role and service account
update schema-migrator-async job helm hook to post-upgrade
set argocd equivalent of helm hooks using template
set progressDeadlineSeconds to 600s for otel-collector and otel-collector-metrics
bump up signoz chart to 0.55.1

Summary by CodeRabbit

New Features
- Updated Helm chart version to 0.55.1, enhancing overall stability.
- Simplified deployment process for the schema migrator with automatic inclusion of ArgoCD hooks.
Bug Fixes
- Removed outdated role, role binding, and service account configurations for the schema migrator, streamlining functionality.
Modifications
- Updated naming conventions for roles and service accounts to reflect asynchronous processing.
- Adjusted annotations for Kubernetes jobs to improve hook management during upgrades.
- Extended deployment timeout for the otelCollector to enhance readiness under certain conditions.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes in this pull request primarily involve updates to the Helm Chart for SigNoz. The Chart.yaml file's version is incremented from 0.55.0 to 0.55.1. Additionally, several YAML files related to the schema migrator have been removed, including those defining a Role, RoleBinding, and ServiceAccount, which eliminates their respective functionalities. Other YAML files have been modified to reflect changes in naming conventions from synchronous to asynchronous processing, along with adjustments to Helm hook annotations.

Changes

File Path	Change Summary
charts/signoz/Chart.yaml	Updated `version` from `0.55.0` to `0.55.1`.
charts/signoz/templates/schema-migrator-async/role.yaml	Entire file removed, defining a Kubernetes Role for the schema migrator.
charts/signoz/templates/schema-migrator-async/rolebinding.yaml	Entire file removed, defining a RoleBinding resource for the schema migrator.
charts/signoz/templates/schema-migrator-async/serviceaccount.yaml	Entire file removed, defining a ServiceAccount for the schema migrator.
charts/signoz/templates/schema-migrator/role.yaml	Role name updated from `-sync` to `-async`.
charts/signoz/templates/schema-migrator/rolebinding.yaml	RoleBinding name and associated entities updated from `-sync` to `-async`; annotations added conditionally.
charts/signoz/templates/schema-migrator/serviceaccount.yaml	ServiceAccount name updated from `-sync` to `-async`.
charts/signoz/templates/schema-migrator/migrations-async.yaml	Annotation modified from `pre-upgrade` to `post-upgrade`.
charts/signoz/templates/schema-migrator/migrations-sync.yaml	Removed `serviceAccountName` field from the Job spec.
charts/signoz/values.yaml	Annotations for schema migrator updated to `{}`; `upgradeHelmHooks` set to `true`.

Possibly related PRs

#507: This PR updates the Chart.yaml file for the SigNoz Helm chart, incrementing the version from 0.52.0 to 0.53.0, which is related to the version update in the main PR from 0.55.0 to 0.55.1.
#508: This PR updates the Chart.yaml file for the SigNoz Helm chart, changing the version from 0.53.0 to 0.53.1, which is relevant to the versioning changes in the main PR.
#520: The version in the Chart.yaml file is updated from 0.53.1 to 0.54.0, indicating a progression in versioning that aligns with the version updates seen in the main PR.
#534: This PR includes an update to the Chart.yaml file for the SigNoz Helm chart, changing the version from 0.54.0 to 0.54.1, which is directly related to the version increment in the main PR.
#541: This PR updates the Chart.yaml file for the SigNoz Helm chart, changing the version from 0.54.2 to 0.55.0, which is relevant to the versioning context of the main PR.

Suggested reviewers

grandwizard28
srikanthccv

Poem

🐇 In the meadow where changes bloom,
A version rises, dispelling gloom.
With roles and bindings now set free,
Async awaits, as bright as can be!
Annotations dance, in YAML's embrace,
A hop of joy in this coding space! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

prashant-shahi commented 3 weeks ago

Included helm hooks for schema-migrator dependency resources as well.

Pros:

solve the migrator job stuck issue for old users where dependent service account, role, and role bindings are not created for upgrade

Cons:

for every upgrade, these dependent resources are re-created alongside the migrator jobs.
removal of the helm hooks annotation in these resources with cause issue - will have to opt for the resource name change as well if we were to drop helm hooks in future

Alternatively, we can use the post-upgrade helm hook for migrator jobs.

However, the possible edge that existed previously there would be back i.e. collector pods getting created before the latest migrator job is created.

grandwizard28 commented 3 weeks ago

Why does the schema-migrator need a Role, RoleBinding at all?

prashant-shahi commented 3 weeks ago

Why does the schema-migrator need a Role, RoleBinding at all?

For the k8s-wait-for to watch the creation and completion of the migrator jobs.

Async Job and Collectors --- depends on ----> Sync Job completion

SigNoz / charts