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

Backport PR #2787 to main for 🔖 🤖 Release v1.7.16 #2788

Merged
merged 1 commit into from
Dec 24, 2024

Conversation

vdaas-ci
Copy link
Collaborator

@vdaas-ci vdaas-ci commented Dec 24, 2024

Release PR for v1.7.16.

Summary by CodeRabbit

  • New Features
    • Introduced version v1.7.16 for various components, including Docker images and Helm charts.
    • Updated documentation links and Docker pull commands in the changelog.
  • Bug Fixes
    • Resolved formatting issues in proto files and merged workflow generation logic.
  • Documentation
    • Enhanced documentation for symlink API and added detailed changelog entries.
  • Chores
    • Updated image tags and version numbers across multiple Kubernetes configuration files.

Signed-off-by: Vdaas CI <vald@vdaas.org>
Copy link

cloudflare-workers-and-pages bot commented Dec 24, 2024

Deploying vald with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5abfc53
Status: ✅  Deploy successful!
Preview URL: https://58310e9e.vald.pages.dev
Branch Preview URL: https://backport-main-prepare-releas.vald.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

📝 Walkthrough

Walkthrough

This pull request introduces version 1.7.16 of the Vald project, involving comprehensive updates across multiple Kubernetes configuration files, Helm charts, and version-related documents. The changes primarily focus on incrementing version numbers from v1.7.15 to v1.7.16 across various components, including Docker image tags, Helm chart configurations, and Kubernetes resource manifests. The update ensures consistency in versioning across the entire project ecosystem.

Changes

File/Directory Change Summary
CHANGELOG.md Added new version entry for v1.7.16 with Docker pull commands and documentation links
charts/*/Chart.yaml Updated chart versions from v1.7.15 to v1.7.16
charts/*/README.md Updated chart version references
charts/*/values.yaml Updated image tags to v1.7.16
k8s/*/configmap.yaml Updated Helm chart and application version labels
k8s/*/deployment.yaml Updated version labels and configuration checksums
versions/VALD_VERSION Updated version from v1.7.15 to v1.7.16

Possibly related PRs

Suggested Labels

priority/low, size/XXXL

Suggested Reviewers

  • vankichi
  • kpango

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
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: 1

🔭 Outside diff range comments (1)
k8s/gateway/gateway/lb/deployment.yaml (1)

Consider using explicit version tag instead of nightly

The deployment is using the nightly tag which can lead to inconsistent behavior across environments. Based on the repository documentation and chart version information found, you should use the explicit version tag v1.7.16 to ensure consistency.

  • Location: k8s/gateway/gateway/lb/deployment.yaml
    image: "vdaas/vald-lb-gateway:nightly"
    should be changed to:
    image: "vdaas/vald-lb-gateway:v1.7.16"
🔗 Analysis chain

Line range hint 102-103: Consider using explicit version tag instead of nightly

The deployment is using the nightly tag which can lead to inconsistent behavior across environments. Consider using the explicit version tag v1.7.16 to ensure consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the image with v1.7.16 tag exists
gh api \
  -H "Accept: application/vnd.oci.image.index.v1+json" \
  /v2/vdaas/vald-lb-gateway/manifests/v1.7.16

Length of output: 411


Script:

#!/bin/bash
# Let's check if we can find any version tags in the repository
rg -g '*.yaml' -g '*.yml' 'vdaas/vald-lb-gateway:' -A 1 -B 1

# Also check if there's any version information in the docs
fd README.md --exec cat {} \; | rg -i "version|release"

# Check if there are any version constraints or recommendations in the repository
fd . -e yaml -e yml --exec grep -l "vdaas/vald-lb-gateway" {} \; | xargs cat | grep -A 2 -B 2 "vdaas/vald-lb-gateway"

Length of output: 56051

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d1e7f4c and 5abfc53.

📒 Files selected for processing (62)
  • CHANGELOG.md (1 hunks)
  • charts/vald-benchmark-operator/Chart.yaml (1 hunks)
  • charts/vald-benchmark-operator/README.md (3 hunks)
  • charts/vald-benchmark-operator/values.yaml (2 hunks)
  • charts/vald-helm-operator/Chart.yaml (1 hunks)
  • charts/vald-helm-operator/README.md (3 hunks)
  • charts/vald-helm-operator/values.yaml (1 hunks)
  • charts/vald-readreplica/Chart.yaml (1 hunks)
  • charts/vald-readreplica/README.md (1 hunks)
  • charts/vald/Chart.yaml (1 hunks)
  • charts/vald/README.md (2 hunks)
  • charts/vald/values.yaml (1 hunks)
  • k8s/agent/ngt/configmap.yaml (1 hunks)
  • k8s/agent/pdb.yaml (1 hunks)
  • k8s/agent/priorityclass.yaml (1 hunks)
  • k8s/agent/statefulset.yaml (1 hunks)
  • k8s/agent/svc.yaml (1 hunks)
  • k8s/discoverer/clusterrole.yaml (1 hunks)
  • k8s/discoverer/clusterrolebinding.yaml (1 hunks)
  • k8s/discoverer/configmap.yaml (1 hunks)
  • k8s/discoverer/deployment.yaml (2 hunks)
  • k8s/discoverer/pdb.yaml (1 hunks)
  • k8s/discoverer/priorityclass.yaml (1 hunks)
  • k8s/discoverer/serviceaccount.yaml (1 hunks)
  • k8s/discoverer/svc.yaml (1 hunks)
  • k8s/gateway/gateway/ing.yaml (1 hunks)
  • k8s/gateway/gateway/lb/configmap.yaml (1 hunks)
  • k8s/gateway/gateway/lb/deployment.yaml (2 hunks)
  • k8s/gateway/gateway/lb/hpa.yaml (1 hunks)
  • k8s/gateway/gateway/lb/pdb.yaml (1 hunks)
  • k8s/gateway/gateway/lb/priorityclass.yaml (1 hunks)
  • k8s/gateway/gateway/lb/svc.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/clusterrole.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/clusterrolebinding.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/configmap.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/deployment.yaml (2 hunks)
  • k8s/gateway/gateway/mirror/hpa.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/pdb.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/priorityclass.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/serviceaccount.yaml (1 hunks)
  • k8s/gateway/gateway/mirror/svc.yaml (1 hunks)
  • k8s/index/job/correction/configmap.yaml (1 hunks)
  • k8s/index/job/correction/cronjob.yaml (2 hunks)
  • k8s/index/job/creation/configmap.yaml (1 hunks)
  • k8s/index/job/creation/cronjob.yaml (2 hunks)
  • k8s/index/job/save/configmap.yaml (1 hunks)
  • k8s/index/job/save/cronjob.yaml (2 hunks)
  • k8s/index/operator/configmap.yaml (1 hunks)
  • k8s/index/operator/deployment.yaml (2 hunks)
  • k8s/index/operator/priorityclass.yaml (1 hunks)
  • k8s/manager/index/configmap.yaml (1 hunks)
  • k8s/manager/index/deployment.yaml (2 hunks)
  • k8s/manager/index/pdb.yaml (1 hunks)
  • k8s/manager/index/priorityclass.yaml (1 hunks)
  • k8s/manager/index/svc.yaml (1 hunks)
  • k8s/operator/helm/operator.yaml (2 hunks)
  • k8s/operator/helm/svc.yaml (1 hunks)
  • k8s/readreplica/configmap.yaml (1 hunks)
  • k8s/tools/benchmark/operator/configmap.yaml (2 hunks)
  • k8s/tools/benchmark/operator/deployment.yaml (2 hunks)
  • k8s/tools/benchmark/operator/service.yaml (1 hunks)
  • versions/VALD_VERSION (1 hunks)
✅ Files skipped from review due to trivial changes (53)
  • charts/vald-readreplica/README.md
  • charts/vald-benchmark-operator/Chart.yaml
  • charts/vald-readreplica/Chart.yaml
  • charts/vald-helm-operator/Chart.yaml
  • versions/VALD_VERSION
  • k8s/gateway/gateway/mirror/clusterrolebinding.yaml
  • charts/vald/Chart.yaml
  • k8s/tools/benchmark/operator/service.yaml
  • k8s/agent/ngt/configmap.yaml
  • k8s/gateway/gateway/mirror/pdb.yaml
  • k8s/discoverer/clusterrole.yaml
  • k8s/gateway/gateway/mirror/serviceaccount.yaml
  • k8s/discoverer/svc.yaml
  • k8s/index/job/save/configmap.yaml
  • k8s/index/job/creation/configmap.yaml
  • k8s/discoverer/pdb.yaml
  • k8s/index/job/creation/cronjob.yaml
  • k8s/operator/helm/svc.yaml
  • k8s/agent/statefulset.yaml
  • k8s/manager/index/priorityclass.yaml
  • k8s/gateway/gateway/lb/hpa.yaml
  • k8s/gateway/gateway/mirror/hpa.yaml
  • k8s/gateway/gateway/lb/configmap.yaml
  • k8s/gateway/gateway/lb/svc.yaml
  • k8s/index/job/save/cronjob.yaml
  • k8s/discoverer/serviceaccount.yaml
  • k8s/discoverer/priorityclass.yaml
  • k8s/index/operator/priorityclass.yaml
  • k8s/manager/index/configmap.yaml
  • k8s/agent/svc.yaml
  • k8s/gateway/gateway/lb/pdb.yaml
  • k8s/manager/index/svc.yaml
  • k8s/index/job/correction/cronjob.yaml
  • charts/vald-benchmark-operator/README.md
  • k8s/discoverer/clusterrolebinding.yaml
  • k8s/gateway/gateway/mirror/svc.yaml
  • k8s/manager/index/pdb.yaml
  • k8s/gateway/gateway/mirror/priorityclass.yaml
  • k8s/index/job/correction/configmap.yaml
  • k8s/agent/pdb.yaml
  • k8s/agent/priorityclass.yaml
  • k8s/gateway/gateway/ing.yaml
  • k8s/gateway/gateway/lb/priorityclass.yaml
  • k8s/gateway/gateway/mirror/configmap.yaml
  • k8s/tools/benchmark/operator/configmap.yaml
  • k8s/gateway/gateway/mirror/clusterrole.yaml
  • k8s/tools/benchmark/operator/deployment.yaml
  • charts/vald/README.md
  • k8s/readreplica/configmap.yaml
  • charts/vald/values.yaml
  • charts/vald-benchmark-operator/values.yaml
  • k8s/operator/helm/operator.yaml
  • k8s/discoverer/configmap.yaml
🧰 Additional context used
🪛 Markdownlint (0.37.0)
charts/vald-helm-operator/README.md

29-29: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


30-30: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)


35-35: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

🔇 Additional comments (15)
k8s/index/operator/deployment.yaml (1)

23-23: Version updates are consistent

The version updates from v1.7.15 to v1.7.16 are correctly applied to both the Helm chart and application version labels.

Also applies to: 26-26

k8s/discoverer/deployment.yaml (1)

23-23: Version updates are consistent

The version updates from v1.7.15 to v1.7.16 are correctly applied to both the Helm chart and application version labels.

Also applies to: 26-26

k8s/gateway/gateway/mirror/deployment.yaml (2)

23-23: Version updates are consistent

The version updates from v1.7.15 to v1.7.16 are correctly applied to both the Helm chart and application version labels.

Also applies to: 26-26


Line range hint 57-65: Verify gateway-lb service dependency

The init container waits for the gateway-lb service to be ready. Please ensure that the service name and namespace are correct for your deployment environment:

  • Service: vald-lb-gateway
  • Namespace: default
✅ Verification successful

Service dependency verification completed

The service vald-lb-gateway exists in the default namespace as confirmed by the service definition in k8s/gateway/gateway/lb/svc.yaml. The service is correctly referenced in the init container's readiness check:

  • Service name: vald-lb-gateway
  • Namespace: default
  • Port: 3001 (readiness endpoint)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the existence of the gateway-lb service
kubectl get svc vald-lb-gateway -n default 2>/dev/null || echo "Service not found"

# Check if there are any other services matching the pattern
kubectl get svc -A | grep -i "lb-gateway"

Length of output: 229


Script:

#!/bin/bash
# Search for service definitions in k8s manifests
fd -e yaml -e yml | xargs rg -l "kind:\s*Service.*vald-lb-gateway" || echo "No service definitions found"

# Search for any references to the service name in k8s manifests
fd -e yaml -e yml | xargs rg "vald-lb-gateway" -C2 || echo "No references found"

Length of output: 29440

k8s/manager/index/deployment.yaml (2)

23-23: Version updates are consistent

The version numbers have been correctly updated from v1.7.15 to v1.7.16 in both the Helm chart and application version labels.

Also applies to: 26-26


Line range hint 91-92: Consider using explicit version tag instead of nightly

The deployment is using the nightly tag which can lead to inconsistent behavior across environments. Consider using the explicit version tag v1.7.16 to ensure consistency.

k8s/gateway/gateway/lb/deployment.yaml (1)

23-23: Version updates are consistent

The version numbers have been correctly updated from v1.7.15 to v1.7.16 in both the Helm chart and application version labels.

Also applies to: 26-26

charts/vald-helm-operator/values.yaml (1)

30-30: Version update is consistent

The image tag has been correctly updated from v1.7.15 to v1.7.16, maintaining version consistency across the project.

k8s/index/operator/configmap.yaml (5)

22-22: Version labels updated correctly for v1.7.16

The version labels in the ConfigMap metadata have been consistently updated from v1.7.15 to v1.7.16, aligning with the release objectives.

Also applies to: 25-25


28-28: Security configuration review

The configuration includes several security-related settings that should be reviewed:

  1. All containers run as non-root (user 65532)
  2. Read-only root filesystem is enabled
  3. Security contexts drop all capabilities
  4. TLS configuration is present but disabled by default

28-28: Resource configuration review

The job templates include several important configurations that look good:

  1. Proper TTL settings (86400s) for job cleanup
  2. Appropriate probe configurations (liveness, readiness, startup)
  3. Well-defined port configurations
  4. Proper volume mounts for configurations

28-28: Verify the configuration changes

The entire configuration has been replaced. While the structure remains similar, please verify:

  1. The server configurations (ports, timeouts, etc.) are appropriate for your environment
  2. The operator namespace and agent configurations are correct
  3. The security settings (TLS, etc.) match your requirements
✅ Verification successful

Configuration changes appear to be version update only

After comparing the configurations, the only changes are version updates from v1.7.15 to v1.7.16 in the chart and component versions. All other configurations including:

  • Server settings (ports, timeouts, etc.)
  • Operator namespace and agent configurations
  • Security settings (TLS, etc.)
  • Job templates and their configurations

remain identical to the previous version. No manual verification needed as these are standard version bump changes.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Compare the configuration changes between versions
# Get the old config from the previous version for comparison

# Fetch the old version's config
git fetch origin
git show origin/main:k8s/index/operator/configmap.yaml > old_config.yaml

# Extract and compare the config.yaml sections
yq '.data["config.yaml"]' old_config.yaml > old_config_section.yaml
yq '.data["config.yaml"]' k8s/index/operator/configmap.yaml > new_config_section.yaml

# Show differences
diff -u old_config_section.yaml new_config_section.yaml

Length of output: 427


Script:

#!/bin/bash
# Let's try a different approach using grep and diff directly on the YAML files
git fetch origin
git show origin/main:k8s/index/operator/configmap.yaml > old_configmap.yaml
diff -u old_configmap.yaml k8s/index/operator/configmap.yaml

Length of output: 54464


28-28: Verify service dependencies

The configuration references several services. Please ensure these services exist and are properly configured:

  • vald-agent.default.svc.cluster.local:3001
  • vald-discoverer.default.svc.cluster.local:3001
✅ Verification successful

Service dependencies are properly configured

The required services are correctly defined in the Kubernetes configuration:

  • vald-agent service is defined in k8s/agent/svc.yaml with readiness port 3001
  • vald-discoverer service is defined in k8s/discoverer/svc.yaml with readiness port 3001

Both services match the expected endpoints referenced in the configuration:

  • vald-agent.default.svc.cluster.local:3001
  • vald-discoverer.default.svc.cluster.local:3001
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for service definitions in the repository

# Search for service definitions
echo "Checking for agent service definition..."
rg -l "kind:\s+Service.*name:\s+vald-agent" --type yaml

echo "Checking for discoverer service definition..."
rg -l "kind:\s+Service.*name:\s+vald-discoverer" --type yaml

Length of output: 312


Script:

#!/bin/bash
# Let's try a different search pattern to find service definitions

# Search for agent service
echo "Searching for agent service..."
fd -t f -e yaml -e yml . | xargs grep -l "vald-agent" 

# Search for discoverer service
echo "Searching for discoverer service..."
fd -t f -e yaml -e yml . | xargs grep -l "vald-discoverer"

# Also check for Helm charts that might define these services
echo "Checking Helm charts..."
fd -t f values.yaml | xargs cat

Length of output: 69783


Script:

#!/bin/bash
# Let's check for service definitions in k8s directory

echo "Checking for agent service definition..."
cat k8s/agent/svc.yaml

echo "Checking for discoverer service definition..."
cat k8s/discoverer/svc.yaml

Length of output: 2821

CHANGELOG.md (1)

Line range hint 1-5000: LGTM! The changelog follows best practices.

The changelog is well-structured with:

  • Consistent format across versions
  • Clear semantic versioning
  • Organized sections for Docker images, documents and changes
  • Proper categorization of changes (features, bugfixes, etc)
  • Good traceability through links to PRs
charts/vald-helm-operator/README.md (1)

5-5: LGTM! Version updates are consistent.

All version references have been correctly updated from v1.7.15 to v1.7.16 across:

  • Chart version declaration
  • CRD URLs in upgrade instructions
  • Patch command example
  • Image tag in configuration table

The changes align well with the PR objective of releasing version 1.7.16.

Also applies to: 29-30, 35-35, 82-82

k8s/index/operator/configmap.yaml Show resolved Hide resolved
@vdaas-ci
Copy link
Collaborator Author

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

@kpango kpango merged commit 6f77b59 into main Dec 24, 2024
41 checks passed
@kpango kpango deleted the backport/main/prepare/release/v1.7 branch December 24, 2024 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants