Add 'agent.dependencyURLs' array and download listed URLs via initContainer to the agent's deployment folder - #290
Open
htreu wants to merge 1 commit into
Open
Conversation
…tainer to the agent's deployment folder
hint: AI generated code
konrad-ohms
requested changes
Aug 7, 2025
konrad-ohms
left a comment
konrad-ohms
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the feature update.
Could you open the PR on the main project instead of your fork? Otherwise CI is not running by default.
Also, there are a few changes required in existing files (see above) and an addition is necessary in an existing test:
$ git diff pkg/k8s/object/builders/agent/daemonset/daemonset_test.go
diff --git i/pkg/k8s/object/builders/agent/daemonset/daemonset_test.go w/pkg/k8s/object/builders/agent/daemonset/daemonset_test.go
index 5c3e2a8..1f36e05 100644
--- i/pkg/k8s/object/builders/agent/daemonset/daemonset_test.go
+++ w/pkg/k8s/object/builders/agent/daemonset/daemonset_test.go
@@ -344,6 +344,7 @@ func TestDaemonSetBuilder_getVolumes(t *testing.T) {
gomock.Eq(volume.TlsVolume),
gomock.Eq(volume.RepoVolume),
gomock.Eq(volume.NamespacesDetailsVolume),
+ gomock.Eq(volume.DeployVolume),
).Return(expectedVolumes, expectedVolumeMounts)
db := &daemonSetBuilder{
A context question.
Will it be sufficient to download artifacts in the /instana folder?
Your example will pull files like this
curl https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar --output /instana/mysql-connector-java-8.0.28.jar && curl https://repo1.maven.org/maven2/org/postgresql/postgresql/42.3.3/postgresql-42.3.3.jar --output /instana/postgresql-42.3.3.jar```
In the final agent pod, the files are available in `/opt/instana/agent/deploy`.
I am not fully sure, if sensors would be fine with that location or if that must be configurable/somewhere else.
Also, I guess this would be required for the remote agent deployment as well? See pkg/k8s/object/remote-agent.
But other than the remarks, the feature seem to work in general on my dev OCP cluster, thanks :+1:
| return []corev1.Container{ | ||
| { | ||
| Name: "init-dependency-downloader", | ||
| Image: "registry.access.redhat.com/ubi8/ubi:latest", |
Contributor
There was a problem hiding this comment.
Suggested change
| Image: "registry.access.redhat.com/ubi8/ubi:latest", | |
| Image: "registry.access.redhat.com/ubi9/ubi-minimal:latest", |
We should use the same base image as on the operator level, the minimal image is sufficient as well and smaller in size.
| } | ||
|
|
||
| // Create builder | ||
| builder := NewDaemonSetBuilder(agent, false, status.NewAgentStatusManager()) |
Contributor
There was a problem hiding this comment.
Suggested change
| builder := NewDaemonSetBuilder(agent, false, status.NewAgentStatusManager()) | |
| builder := NewDaemonSetBuilder(agent, false, status.NewAgentStatusManager(nil, nil)) |
The constructor requires parameters, but you can pass in nil values. Try running make, it will fail without these parameters.
Comment on lines
+8
to
+18
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| appsv1 "k8s.io/api/apps/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
|
|
||
| instanav1 "github.com/instana/instana-agent-operator/api/v1" | ||
| "github.com/instana/instana-agent-operator/pkg/k8s/operator/status" | ||
| "github.com/instana/instana-agent-operator/pkg/pointer" |
Contributor
There was a problem hiding this comment.
Suggested change
| "testing" | |
| "github.com/stretchr/testify/assert" | |
| "github.com/stretchr/testify/require" | |
| appsv1 "k8s.io/api/apps/v1" | |
| corev1 "k8s.io/api/core/v1" | |
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | |
| instanav1 "github.com/instana/instana-agent-operator/api/v1" | |
| "github.com/instana/instana-agent-operator/pkg/k8s/operator/status" | |
| "github.com/instana/instana-agent-operator/pkg/pointer" | |
| "testing" | |
| "github.com/stretchr/testify/assert" | |
| "github.com/stretchr/testify/require" | |
| appsv1 "k8s.io/api/apps/v1" | |
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | |
| instanav1 "github.com/instana/instana-agent-operator/api/v1" | |
| "github.com/instana/instana-agent-operator/pkg/k8s/operator/status" |
There are unused imports for corev1 and pointer, please remove those.
| - The original filenames from the URLs will be preserved | ||
| - You can specify multiple dependency URLs, and all files will be downloaded to the same directory | ||
| - Make sure the URLs are accessible from the Kubernetes cluster where the agent is running | ||
| - For security reasons, consider using HTTPS URLs and trusted sources No newline at end of file |
Contributor
There was a problem hiding this comment.
Looks good, we should add that to the helm chart's readme as well once we have that merged.
| http: | ||
| enabled: true | ||
|
|
||
| # Made with Bob |
Contributor
There was a problem hiding this comment.
probably we won't want IDE comments on public examples, in source code I don't think it's an issue, but I guess it adds unneeded clutter to example yamls.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
hint: AI generated code
Why
Instana agent might require external Java dependencies, which can not be served by IBM directly nor shipped with the agent installation. Those additional dependencies were previously downloaded via manual initContainer into the agent's container. The manual initContainer was part of the static agent YAML deployment. Since this is deprecated and about to be removed end of 2025, this PR introduces the replacement option for external Java dependencies.
What
Provide a new array option "dependencyURLs" to list external jar files, which get downloaded into the Agent's
/opt/instana/agent/deployfolder.References
Checklist
Note: Remember to run a helm chart release after the the operator release to make the changes available thru helm.