chore(indexer): cosmetic changes for graph-network-indexer chart

[calinah]

Summary by CodeRabbit

• New Features

  • Incremented version number to 0.5.0-canary.3 for better tracking of updates.
  • Added required query URLs for Graph Escrow and Graph Network subgraphs to improve configuration clarity.

• Documentation

  • Updated README to reflect new versioning and provide guidance on optimal performance practices.
  • Enhanced comments in configuration files to clarify required settings for subgraphs.

• Refactor

  • Modified StatefulSet name in Kubernetes configuration for improved deployment strategy.

[coderabbitai]

Walkthrough

The pull request introduces several changes to the Graph Network Indexer chart, including an increment in the version number from 0.5.0-canary.2 to 0.5.0-canary.3. The README.md has been updated to include new configuration options for subgraphs, specifically query_url, and the StatefulSet name in statefulset.yaml has been modified to remove the -headless suffix. Additionally, the values.yaml file has been clarified regarding configuration options for subgraphs.

Changes

Files	Change Summary
charts/graph-network-indexer/Chart.yaml	Version incremented from 0.5.0-canary.2 to 0.5.0-canary.3.
charts/graph-network-indexer/README.md	Updated to reflect new versioning and added required query_url fields for subgraphs.
charts/graph-network-indexer/templates/indexer-tap-agent/statefulset.yaml	Renamed StatefulSet from ...-headless to ... to adjust deployment strategy.
charts/graph-network-indexer/values.yaml	Clarified configuration options for subgraphs, emphasizing required query_url with example URLs.

Possibly related PRs

• feat(graph-network-indexer): docs and tap-agent update #351: The changes in the Chart.yaml file regarding version updates are directly related to the version increment from 0.5.0-canary.2 to 0.5.0-canary.3, which is also reflected in this PR.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4f61328 and 1dd5ed3.

Files selected for processing (4)

• charts/graph-network-indexer/Chart.yaml (1 hunks)
• charts/graph-network-indexer/README.md (2 hunks)
• charts/graph-network-indexer/templates/indexer-tap-agent/statefulset.yaml (1 hunks)
• charts/graph-network-indexer/values.yaml (1 hunks)

Files skipped from review due to trivial changes (1)

• charts/graph-network-indexer/Chart.yaml

Additional context used

yamllint

charts/graph-network-indexer/values.yaml

[error] 81-81: trailing spaces

(trailing-spaces)

Additional comments not posted (10)

charts/graph-network-indexer/templates/indexer-tap-agent/statefulset.yaml (1)

13-13: Verify the impact of the StatefulSet name change.

The StatefulSet name has been changed to remove the -headless suffix. This change suggests that the StatefulSet is no longer intended to be a headless service. Please ensure that:

1. The removal of the -headless suffix is intentional and aligns with the desired deployment strategy.
2. Any references to the old StatefulSet name in other parts of the system (e.g., configuration files, scripts, documentation) are updated to reflect the new name.
3. The change does not disrupt any existing communication patterns or integrations that rely on the StatefulSet being a headless service.

Run the following script to verify the StatefulSet name usage across the codebase:

Verification successful

---

StatefulSet name change appears to be intentional and safe.

After a thorough investigation of the codebase, I can confirm that the removal of the "-headless" suffix from the StatefulSet name for the indexer-tap-agent appears to be intentional and doesn't have any negative impact on the system. Here are the key findings:

1. The StatefulSet is defined in charts/graph-network-indexer/templates/indexer-tap-agent/statefulset.yaml.
2. The StatefulSet is intentionally used to maintain a single instance of the indexer-tap-agent, as stated in the file comments.
3. There are no references to a "headless" version of the tap-agent StatefulSet in the codebase.
4. The change aligns with the deployment strategy of maintaining a single instance of the indexer-tap-agent.

Based on these observations, the StatefulSet name change is verified to be safe and doesn't require any additional modifications to other parts of the system.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of the old StatefulSet name across the codebase.

# Test 1: Search for the old StatefulSet name usage. Expect: No occurrences of the old name.
rg --type-add 'configs:*.{yaml,yml,toml,properties}' --type configs $'graph-network-indexer.*tap-agent-headless'

# Test 2: Search for the new StatefulSet name usage. Expect: Only occurrences of the new name.
rg --type-add 'configs:*.{yaml,yml,toml,properties}' --type configs $'graph-network-indexer.*tap-agent'

Length of output: 218

---

Script:

#!/bin/bash
# Description: Perform a broader search for tap-agent and StatefulSet configurations

# Search for any occurrences of "tap-agent" in yaml files
echo "Searching for 'tap-agent' in yaml files:"
rg --type yaml "tap-agent"

# Search for StatefulSet configurations
echo -e "\nSearching for StatefulSet configurations:"
rg --type yaml "kind:\s*StatefulSet"

# Search for template files that might generate StatefulSet configurations
echo -e "\nSearching for template files that might generate StatefulSet configurations:"
fd -e yaml -e tpl | xargs rg "kind:\s*StatefulSet"

Length of output: 5666

charts/graph-network-indexer/values.yaml (5)

67-71: LGTM!

The updated comments provide clearer guidance on configuring the query_url for the network subgraph based on whether it's locally indexed or not. The changes enhance clarity without introducing any issues.

---

73-74: Looks good!

The comment clarifies that deployment_id is optional and should be used in combination with query_url for locally indexed subgraphs. This provides helpful guidance without introducing any issues.

---

77-78: Nice example!

The example query_url for non-locally indexed subgraphs using the gateway URL provides a helpful illustration without introducing any issues. This enhances clarity and aligns with the PR objective.

---

82-86: Looks good to me!

The updated comments provide clearer guidance on configuring the query_url for the escrow subgraph based on whether it's locally indexed or not. The changes enhance clarity without introducing any issues, aligning with the PR objective.

---

88-93: Great clarification and example!

The comment clarifies that deployment_id is optional and should be used in combination with query_url for locally indexed subgraphs. The example query_url for non-locally indexed subgraphs using the gateway URL provides a helpful illustration. These changes enhance clarity without introducing any issues, aligning perfectly with the PR objective.

charts/graph-network-indexer/README.md (4)

5-5: LGTM!

The version badge update is cosmetic and does not affect the functionality.

---

125-125: LGTM!

The addition of subgraph query URL fields enhances the documentation by providing guidance on optimal performance practices. Marking them as required ensures users configure them appropriately.

---

126-126: LGTM!

The indexerDefaults.config."subgraphs.escrow".query_url field provides clear guidance on configuring the query URL for the Graph Escrow subgraph. The description recommends local indexing for optimal performance and provides the appropriate URL format. The default value serves as a placeholder and must be updated by the user.

---

127-127: LGTM!

The indexerDefaults.config."subgraphs.network".query_url field provides clear guidance on configuring the query URL for the Graph Network subgraph. The description recommends local indexing for optimal performance and provides the appropriate URL format. The default value serves as a placeholder and must be updated by the user.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, 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 generate interesting stats about this repository and render them as a table.
  -- @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.