Skip to content
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

docs(charts): 更新 Helm chart 包和索引 #5310

Merged
merged 1 commit into from
Jan 12, 2025

Conversation

lambda-hj
Copy link
Contributor

@lambda-hj lambda-hj commented Jan 10, 2025

  • 添加了多个版本的 apollo-portal 和 apollo-service 的 Helm chart 包
  • 添加annotation的说明

What's the purpose of this PR

update helm charts and notes on annotations in the docs

Which issue(s) this PR fixes:

Brief changelog

  • 添加了多个版本的 apollo-portal 和 apollo-service 的 Helm chart 包
  • 添加annotation的说明

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Updated deployment guides for Apollo Configuration Center in English and Chinese
    • Added new configuration options for Kubernetes service annotations in apollo-configservice and apollo-adminservice

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jan 10, 2025
Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Walkthrough

This pull request updates the Apollo Configuration Center's distributed deployment guide for both English and Chinese documentation. The changes introduce new configuration options for configService and adminService in Kubernetes deployments, specifically adding service annotation fields. These new options allow users to specify annotations for apollo-configservice and apollo-adminservice, enhancing the flexibility of service configuration in Kubernetes environments.

Changes

File Change Summary
docs/en/deployment/distributed-deployment-guide.md Added configService.service.annotations and adminService.service.annotations configuration options
docs/zh/deployment/distributed-deployment-guide.md Added configService.service.annotations and adminService.service.annotations configuration options

Possibly related PRs

Suggested labels

size:M, lgtm

Suggested reviewers

  • nobodyiam

Poem

🐰 Annotations dance with glee,
Kubernetes services now set free!
Config options bloom so bright,
Apollo's deployment takes flight!
Flexibility springs to life! 🚀


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
🪧 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 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

github-actions bot commented Jan 10, 2025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/charts/index.yaml (1)

Line range hint 916-916: New service annotation support added

Added new configuration options for service annotations:

  • configService.service.annotations: Allows customizing annotations for apollo-configservice
  • adminService.service.annotations: Allows customizing annotations for apollo-adminservice

This enhancement provides more flexibility in Kubernetes service configuration.

Consider documenting common annotation use cases and examples in the deployment guide.

Also applies to: 947-947

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a44455 and 8af017c.

📒 Files selected for processing (3)
  • docs/charts/index.yaml (17 hunks)
  • docs/en/deployment/distributed-deployment-guide.md (3 hunks)
  • docs/zh/deployment/distributed-deployment-guide.md (3 hunks)
🔇 Additional comments (3)
docs/charts/index.yaml (1)

5-19: Version upgrade to 2.3.0 with improved configuration capabilities

The chart has been upgraded from 1.9.1 to 2.3.0 with the following notable changes:

  • Updated repository URLs from ctripcorp to apolloconfig
  • Added support for service annotations
  • Updated timestamps to reflect recent changes
docs/zh/deployment/distributed-deployment-guide.md (1)

916-916: LGTM! Documentation for new Kubernetes service annotations.

The addition of configService.service.annotations and adminService.service.annotations configuration options is well documented and properly integrated into the Helm chart configuration section.

Also applies to: 947-947

docs/en/deployment/distributed-deployment-guide.md (1)

966-966: LGTM! Documentation for new Kubernetes service annotations.

The addition of configService.service.annotations and adminService.service.annotations configuration options is well documented and properly integrated into the Helm chart configuration section. The English translation matches the Chinese version.

Also applies to: 997-997

@lambda-hj
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@lambda-hj
Copy link
Contributor Author

@nobodyiam

@nobodyiam
Copy link
Member

The root of https://charts.apolloconfig.com/ now points to https://github.com/apolloconfig/apollo-helm-chart/tree/main/docs, so adding packages to docs/charts is unnecessary.

…tal 的服务添加注解配置

- 在 apollo-configservice、apollo-adminservice 和 apollo-portal 的服务配置中添加了 annotations 参数
- 新增的注解配置项适用于图表版本 0.9.0 及以上
- 更新了英文和中文的分布式部署指南文档,添加了新的配置项说明
@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jan 11, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/en/deployment/distributed-deployment-guide.md (1)

Line range hint 966-1157: Documentation structure and clarity

The documentation clearly explains the new configuration options with:

  1. Proper formatting and indentation
  2. Consistent style with existing documentation
  3. Clear examples and default values

Consider adding example annotations to demonstrate common use cases, such as:

configService:
  service:
    annotations:
      prometheus.io/scrape: "true"
      prometheus.io/port: "8080"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc00ada and 1531062.

📒 Files selected for processing (2)
  • docs/en/deployment/distributed-deployment-guide.md (3 hunks)
  • docs/zh/deployment/distributed-deployment-guide.md (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/zh/deployment/distributed-deployment-guide.md
🔇 Additional comments (3)
docs/en/deployment/distributed-deployment-guide.md (3)

966-966: New configuration option added for configService service annotations

The addition of configService.service.annotations configuration allows users to specify custom annotations for the apollo-configservice Kubernetes service, enhancing service management capabilities.


997-997: New configuration option added for adminService service annotations

The addition of adminService.service.annotations configuration allows users to specify custom annotations for the apollo-adminservice Kubernetes service, enhancing service management capabilities.


1157-1157: New configuration option added for portal service annotations

The addition of service.annotations configuration allows users to specify custom annotations for the apollo-portal Kubernetes service, enhancing service management capabilities.

Copy link
Member

@nobodyiam nobodyiam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 12, 2025
@nobodyiam nobodyiam merged commit 1d0c448 into apolloconfig:master Jan 12, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants