SigNoz / charts

Helm Charts for SigNoz
MIT License
77 stars 80 forks source link

Split migrator job to sync and async #526

Closed srikanthccv closed 1 month ago

srikanthccv commented 1 month ago

Fixes https://github.com/SigNoz/signoz/issues/5433

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve significant updates to the Helm templates and configuration files for the SigNoz application. Key modifications include the introduction of new functions for schema migrator and otelCollector components, adjustments to initialization processes, and the addition of roles, role bindings, and service accounts. The updates aim to enhance the structure and consistency of the Kubernetes configurations, particularly focusing on asynchronous operations and improved RBAC management.

Changes

File Path Change Summary
charts/signoz/templates/_helpers.tpl Added functions: schemaMigrator.roleName, schemaMigrator.roleBindingName, schemaMigrator.serviceAccountName, otelCollector.clusterRoleName, otelCollector.clusterRoleBindingName. Removed selector labels for init and upgrade jobs.
charts/signoz/templates/otel-collector-metrics/deployment.yaml Updated init container argument to -sync. Adjusted indentation for clarity.
charts/signoz/templates/otel-collector/deployment.yaml Renamed init container argument to -sync. Corrected indentation for imagePullPolicy.
charts/signoz/templates/schema-migrator-async/migrations.yaml Renamed Job to -async, simplified execution condition, updated labels, added ttlSecondsAfterFinished, and added new init container.
charts/signoz/templates/schema-migrator-async/role.yaml Introduced a new Role resource for schema migrator with dynamic naming and conditional creation.
charts/signoz/templates/schema-migrator-async/rolebinding.yaml Introduced a new RoleBinding resource with dynamic naming and conditional creation.
charts/signoz/templates/schema-migrator-async/serviceaccount.yaml Introduced a new ServiceAccount resource with dynamic naming and conditional creation.
charts/signoz/templates/schema-migrator/migrations.yaml Renamed Job to -sync, simplified creation condition, updated labels, added ttlSecondsAfterFinished, and modified service account name.
charts/signoz/templates/schema-migrator/role.yaml Introduced a new Role resource for schema migrator with dynamic naming and conditional creation.
charts/signoz/templates/schema-migrator/rolebinding.yaml Introduced a new RoleBinding resource with dynamic naming and conditional creation.
charts/signoz/templates/schema-migrator/serviceaccount.yaml Introduced a new ServiceAccount resource with dynamic naming and conditional creation.
charts/signoz/values.yaml Updated image tags and added configurations for service accounts, roles, and role bindings for schema migrator and otelCollector.

Assessment against linked issues

Objective Addressed Explanation
Implement asynchronous schema migrations to avoid failures during data mutations. (#5433)
Ensure that the collector can operate independently of the migrator's success. (#5433)

Poem

In the garden of code, we hop and play,
With roles and bindings, we pave the way.
Schema migrator, now swift and bright,
Asynchronous dreams take flight at night.
With every change, our templates sing,
A joyful dance, let the updates ring! 🐇✨


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 6d23a73deee8d21072d51c80c0d7e1a1baf9e179 and fda5b5f1034be3030b3f205c01262084e9fae02d.
📒 Files selected for processing (1) * charts/signoz/templates/otel-collector-metrics/deployment.yaml (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * charts/signoz/templates/otel-collector-metrics/deployment.yaml
--- 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.