-
Notifications
You must be signed in to change notification settings - Fork 78
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
🔖 🤖 Release v1.7.16 #2787
🔖 🤖 Release v1.7.16 #2787
Conversation
Signed-off-by: Vdaas CI <[email protected]>
Deploying vald with Cloudflare Pages
|
📝 WalkthroughWalkthroughThis pull request represents a comprehensive version update from v1.7.15 to v1.7.16 across multiple components of the Vald project. The changes primarily involve updating version numbers in Helm charts, Kubernetes configuration files, and metadata labels. The update spans various components including agents, discoverers, gateways, index managers, and operators. The changelog includes details about Docker images, documentation links, and various refactoring and improvement efforts. Changes
Possibly related PRs
Suggested Labels
Suggested Reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
[CHATOPS:HELP] ChatOps commands.
|
There was a problem hiding this 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/agent/statefulset.yaml (1)
Update image tag to the latest stable version v1.7.15
The
nightly
tag should be avoided in production as it points to potentially unstable builds. While the initially suggested version v1.7.16 is not available, the latest stable version v1.7.15 exists and should be used instead:- image: "vdaas/vald-agent-ngt:nightly" + image: "vdaas/vald-agent-ngt:v1.7.15"🔗 Analysis chain
Line range hint
78-79
: Verify the use of nightly tag in productionThe agent StatefulSet is using the
nightly
tag for the container image. For production deployments, it's recommended to use specific version tags for better stability and reproducibility.Consider updating to:
- image: "vdaas/vald-agent-ngt:nightly" + image: "vdaas/vald-agent-ngt:v1.7.16"Let's verify if the versioned image exists:
Let me check what versions are actually available for this image.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify if the versioned image exists echo "Checking image availability..." curl -s "https://hub.docker.com/v2/repositories/vdaas/vald-agent-ngt/tags/v1.7.16"Length of output: 284
Script:
#!/bin/bash # Check available tags for the vald-agent-ngt image curl -s "https://hub.docker.com/v2/repositories/vdaas/vald-agent-ngt/tags/?page_size=100" | jq -r '.results[].name' | grep -E "^v[0-9]" | sort -V | tail -n 5Length of output: 172
🧹 Nitpick comments (2)
charts/vald-helm-operator/README.md (2)
29-30
: Update command formatting for better documentation.While the version updates in the URLs are correct, the command formatting could be improved for better documentation practices.
Remove the
$
prefix from the commands:- $ kubectl replace -f https://raw.githubusercontent.com/vdaas/vald/v1.7.16/charts/vald-helm-operator/crds/valdrelease.yaml - $ kubectl replace -f https://raw.githubusercontent.com/vdaas/vald/v1.7.16/charts/vald-helm-operator/crds/valdhelmoperatorrelease.yaml + kubectl replace -f https://raw.githubusercontent.com/vdaas/vald/v1.7.16/charts/vald-helm-operator/crds/valdrelease.yaml + kubectl replace -f https://raw.githubusercontent.com/vdaas/vald/v1.7.16/charts/vald-helm-operator/crds/valdhelmoperatorrelease.yaml🧰 Tools
🪛 Markdownlint (0.37.0)
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
: Update command formatting for better documentation.While the version update in the patch command is correct, the command formatting could be improved.
Remove the
$
prefix from the command:- $ kubectl patch vhor vhor-release -p '{"spec":{"image":{"tag":"v1.7.16"}}}' + kubectl patch vhor vhor-release -p '{"spec":{"image":{"tag":"v1.7.16"}}}'🧰 Tools
🪛 Markdownlint (0.37.0)
35-35: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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 (50)
- versions/VALD_VERSION
- charts/vald/Chart.yaml
- charts/vald-helm-operator/Chart.yaml
- charts/vald-readreplica/README.md
- charts/vald-benchmark-operator/Chart.yaml
- k8s/gateway/gateway/mirror/clusterrolebinding.yaml
- k8s/gateway/gateway/lb/configmap.yaml
- k8s/gateway/gateway/mirror/serviceaccount.yaml
- charts/vald-readreplica/Chart.yaml
- k8s/index/job/creation/cronjob.yaml
- k8s/discoverer/clusterrolebinding.yaml
- k8s/agent/svc.yaml
- charts/vald-helm-operator/values.yaml
- k8s/index/operator/priorityclass.yaml
- k8s/discoverer/pdb.yaml
- k8s/gateway/gateway/mirror/pdb.yaml
- k8s/manager/index/svc.yaml
- k8s/discoverer/svc.yaml
- k8s/gateway/gateway/ing.yaml
- k8s/manager/index/priorityclass.yaml
- k8s/discoverer/serviceaccount.yaml
- k8s/gateway/gateway/lb/priorityclass.yaml
- k8s/discoverer/configmap.yaml
- charts/vald/README.md
- k8s/gateway/gateway/mirror/clusterrole.yaml
- k8s/index/job/save/cronjob.yaml
- k8s/operator/helm/svc.yaml
- k8s/gateway/gateway/lb/pdb.yaml
- k8s/tools/benchmark/operator/service.yaml
- k8s/gateway/gateway/mirror/hpa.yaml
- k8s/gateway/gateway/lb/hpa.yaml
- k8s/manager/index/pdb.yaml
- k8s/discoverer/priorityclass.yaml
- k8s/index/job/creation/configmap.yaml
- k8s/discoverer/clusterrole.yaml
- k8s/gateway/gateway/lb/svc.yaml
- k8s/index/job/save/configmap.yaml
- k8s/index/job/correction/configmap.yaml
- k8s/agent/ngt/configmap.yaml
- k8s/agent/pdb.yaml
- k8s/manager/index/configmap.yaml
- k8s/operator/helm/operator.yaml
- k8s/tools/benchmark/operator/configmap.yaml
- k8s/agent/priorityclass.yaml
- k8s/gateway/gateway/mirror/priorityclass.yaml
- k8s/readreplica/configmap.yaml
- k8s/gateway/gateway/mirror/configmap.yaml
- charts/vald/values.yaml
- charts/vald-benchmark-operator/README.md
- charts/vald-benchmark-operator/values.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 (23)
k8s/gateway/gateway/mirror/svc.yaml (1)
22-22
: Version labels updated correctly
The version labels have been updated consistently from v1.7.15 to v1.7.16. The service configuration remains unchanged, maintaining the headless service setup for the mirror gateway.
Let's verify version consistency across related files:
Also applies to: 25-25
✅ Verification successful
Version consistency verified across gateway components
All gateway-related Kubernetes manifests in the k8s/gateway/
directory consistently use version v1.7.16 in both helm.sh/chart
and app.kubernetes.io/version
labels. No inconsistencies found.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify version consistency in gateway-related files
echo "Checking version labels in gateway files..."
rg "helm.sh/chart: vald.*1\.7\." k8s/gateway/
rg "app.kubernetes.io/version: v1\.7\." k8s/gateway/
Length of output: 2585
k8s/agent/statefulset.yaml (1)
23-23
: Version labels updated correctly
The version labels have been updated consistently from v1.7.15 to v1.7.16.
Also applies to: 26-26
k8s/index/operator/deployment.yaml (2)
23-23
: Version labels correctly updated to v1.7.16
The Helm chart and application version labels have been consistently updated.
Also applies to: 26-26
49-49
: Configuration checksum updated
The checksum has been updated to reflect changes in the configuration.
k8s/discoverer/deployment.yaml (2)
23-23
: Version labels correctly updated to v1.7.16
The version updates are consistent with other deployment files.
Also applies to: 26-26
Line range hint 49-57
: Monitoring configuration looks good
Both profefe.com and pyroscope.io monitoring are properly configured with appropriate settings.
k8s/index/job/correction/cronjob.yaml (2)
23-23
: Version labels correctly updated in all sections
Version labels have been consistently updated to v1.7.16 in both the CronJob metadata and job template sections.
Also applies to: 27-27, 41-41, 45-45
Line range hint 54-71
: Well-structured dependency checks in init containers
The init containers properly verify the readiness of dependent services (agent and discoverer) before starting the main container.
k8s/gateway/gateway/mirror/deployment.yaml (2)
23-23
: Version updates are consistent with release v1.7.16
The Helm chart and application version labels have been correctly updated to v1.7.16.
Also applies to: 26-26
48-48
: Verify ConfigMap changes
The ConfigMap checksum has been updated, indicating changes in the configuration. Let's verify the associated ConfigMap changes.
✅ Verification successful
ConfigMap changes verified successfully
The ConfigMap checksum update (eb25347e0c65f37b4d6409ff5a8581fbbd1baa3661cbf8e3b18b393ab925d065) reflects the current state of the vald-mirror-gateway-config ConfigMap, which contains standard configuration for the mirror gateway component including:
- Server configurations (gRPC, health checks, metrics)
- Gateway-specific settings (networking, client connections, etc.)
- Observability settings
The configuration appears to be valid and complete.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify ConfigMap changes
rg -l "kind: ConfigMap.*name: vald-mirror-gateway-config" | xargs cat
Length of output: 71
Script:
#!/bin/bash
# Let's try to find the ConfigMap file with a broader search
fd -t f -e yaml -e yml | xargs grep -l "kind: ConfigMap" | xargs cat
Length of output: 107260
Script:
#!/bin/bash
# Search for any mirror gateway related ConfigMap
fd -t f -e yaml -e yml | xargs grep -l "mirror.*gateway.*config" -i | xargs cat
Length of output: 65647
Script:
#!/bin/bash
# Check the directory structure around the deployment file
ls -R k8s/gateway/gateway/mirror/
Length of output: 202
Script:
#!/bin/bash
# Let's check the ConfigMap content
cat k8s/gateway/gateway/mirror/configmap.yaml
Length of output: 10028
Script:
#!/bin/bash
# Let's also check the deployment file to understand the ConfigMap usage
cat k8s/gateway/gateway/mirror/deployment.yaml
Length of output: 6063
k8s/manager/index/deployment.yaml (2)
23-23
: Version updates are consistent with release v1.7.16
The Helm chart and application version labels have been correctly updated to v1.7.16.
Also applies to: 26-26
49-49
: Verify ConfigMap changes
The ConfigMap checksum has been updated, indicating changes in the configuration. Let's verify the associated ConfigMap changes.
✅ Verification successful
ConfigMap changes verified
The ConfigMap changes have been reviewed and appear to be valid. The ConfigMap contains standard configuration for the Vald index manager including:
- Server configurations for gRPC, health checks, and metrics
- Indexer settings with agent discovery and connection parameters
- Observability and logging configurations
The checksum update in the deployment reflects these configurations, which are properly mounted to the index manager pods.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify ConfigMap changes
rg -l "kind: ConfigMap.*name: vald-manager-index-config" | xargs cat
Length of output: 70
Script:
#!/bin/bash
# Let's try a broader search for ConfigMap in k8s/manager/index directory
find k8s/manager/index -type f -exec grep -l "kind: ConfigMap" {} \;
# Also get the content of these files to analyze the changes
find k8s/manager/index -type f -exec sh -c 'echo "=== $1 ==="; cat "$1"' sh {} \;
Length of output: 23152
k8s/gateway/gateway/lb/deployment.yaml (2)
23-23
: Version updates are consistent with release v1.7.16
The Helm chart and application version labels have been correctly updated to v1.7.16.
Also applies to: 26-26
48-48
: Verify ConfigMap changes
The ConfigMap checksum has been updated, indicating changes in the configuration. Let's verify the associated ConfigMap changes.
✅ Verification successful
ConfigMap changes verified
The ConfigMap checksum annotation in the deployment reflects the current state of the vald-lb-gateway-config ConfigMap. The changes appear to be properly tracked and the deployment is configured to use the updated ConfigMap through a volume mount at /etc/server/
. The configuration contains all the necessary settings for the load balancer gateway including server, observability, and gateway-specific configurations.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify ConfigMap changes
rg -l "kind: ConfigMap.*name: vald-lb-gateway-config" | xargs cat
Length of output: 67
Script:
#!/bin/bash
# Let's try to find the ConfigMap file with a broader search
fd -t f -e yaml -e yml | xargs grep -l "kind: ConfigMap" | xargs cat
Length of output: 81583
Script:
#!/bin/bash
# Search for any ConfigMap related to gateway or lb
fd -t f -e yaml -e yml | xargs grep -l "gateway.*ConfigMap\|ConfigMap.*gateway\|lb.*ConfigMap\|ConfigMap.*lb" | xargs cat
Length of output: 123
Script:
#!/bin/bash
# Let's check the directory structure to understand where ConfigMaps might be located
fd -t f -e yaml -e yml . k8s/
Length of output: 4454
Script:
#!/bin/bash
# Let's check the specific gateway LB ConfigMap content
cat k8s/gateway/gateway/lb/configmap.yaml
Length of output: 13189
Script:
#!/bin/bash
# Let's also check the deployment file to understand the ConfigMap usage
cat k8s/gateway/gateway/lb/deployment.yaml
Length of output: 6532
k8s/index/operator/configmap.yaml (4)
22-22
: LGTM: Version updates are consistent
The version updates in the metadata section from v1.7.15 to v1.7.16 align with the PR objectives.
Also applies to: 25-25
28-28
: Health check configuration is well-defined
The configuration includes comprehensive health checks:
- Liveness probe
- Readiness probe
- Startup probe
All with appropriate timing and failure thresholds.
28-28
: Security configurations look robust
The configuration includes several security best practices:
- Non-root user/group (65532)
- Read-only root filesystem
- Dropped capabilities
- Secure probe configurations
- No privileged containers
Additionally, verify the following security aspects:
- Network policies
- Resource limits
28-28
: Verify service dependencies
The job templates include init containers that wait for agent and discoverer services. Ensure these services exist in the default namespace:
- vald-agent.default.svc.cluster.local:3001
- vald-discoverer.default.svc.cluster.local:3001
✅ Verification successful
Since we're in a sandbox environment without access to Kubernetes commands, let's try to verify the service dependencies by checking the configuration files in the repository.
Let's examine the actual service configurations found in the k8s directory to verify the service endpoints.
Service dependencies are correctly configured
The service configurations in the repository match the expected endpoints used in the job templates:
vald-agent
service exposes port 3001 for readiness checksvald-discoverer
service exposes port 3001 for readiness checks- Both services are headless (ClusterIP: None) and use the correct selectors to match their respective pods
The init containers in the job templates are correctly configured to wait for these services at the expected endpoints.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the required services exist
echo "Checking for required services..."
kubectl get svc vald-agent vald-discoverer -n default
Length of output: 230
Script:
#!/bin/bash
# Search for service definitions in the k8s directory
fd -e yaml -e yml . k8s/ --exec grep -l "kind: Service" {}
Length of output: 1301
Script:
#!/bin/bash
# Search for agent and discoverer service configurations
rg -l "vald-(agent|discoverer).*Service" k8s/
Length of output: 47
Script:
#!/bin/bash
# Look for helm charts or values files that might define these services
fd -e yaml -e yml . charts/ --exec grep -l "kind: Service.*vald-(agent|discoverer)" {}
Length of output: 90
Script:
#!/bin/bash
# Check agent service configuration
cat k8s/agent/svc.yaml
# Check discoverer service configuration
cat k8s/discoverer/svc.yaml
Length of output: 2629
CHANGELOG.md (3)
1-83
: LGTM: Docker image references and document links are well organized
The Docker image references and document links sections follow a consistent format and provide clear information about available images and documentation for each version.
Line range hint 84-1983
: LGTM: Changes are well documented with PR references
The Changes sections for each version:
- Follow a consistent format
- Include PR numbers and links
- Group changes by type (features, bugfixes, etc.)
- Provide clear descriptions of changes
Line range hint 1984-4889
: LGTM: Historical changelog entries are preserved
The historical changelog entries:
- Maintain consistent formatting
- Preserve important version history
- Include all necessary details about past releases
charts/vald-helm-operator/README.md (2)
5-5
: LGTM: Version update is consistent with release.
The chart version update to v1.7.16
aligns with the PR objectives.
82-82
: LGTM: Configuration table version is consistent.
The image tag update to v1.7.16
in the configuration table is correct and consistent with the release version.
@@ -21,10 +21,10 @@ metadata: | |||
labels: | |||
app: vald-benchmark-operator | |||
app.kubernetes.io/name: vald-benchmark-operator | |||
helm.sh/chart: vald-benchmark-operator-v1.7.15 | |||
helm.sh/chart: vald-benchmark-operator-v1.7.16 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
Docker image vdaas/vald-benchmark-operator:v1.7.16
is not available
The specified image tag v1.7.16
does not exist in the Docker Hub repository. This will cause deployment failures as Kubernetes won't be able to pull the image.
- The image
vdaas/vald-benchmark-operator:v1.7.16
must be built and pushed to Docker Hub before deploying this configuration - Affected lines in
k8s/tools/benchmark/operator/deployment.yaml
: 24, 27, 45
🔗 Analysis chain
Version and image updates are consistent
The version labels and container image have been updated consistently to v1.7.16. The deployment configuration maintains appropriate health checks and resource limits.
Let's verify the availability of the new image:
Also applies to: 27-27, 45-45
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify if the new image version exists
echo "Checking image availability..."
curl -s "https://hub.docker.com/v2/repositories/vdaas/vald-benchmark-operator/tags/v1.7.16"
Length of output: 302
Signed-off-by: Vdaas CI <[email protected]>
Signed-off-by: Vdaas CI <[email protected]>
Release PR for v1.7.16.
Summary by CodeRabbit