Extend options for setting security context #1647
+74
−6
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
| # The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other) | ||
| component: clusterReceiver | ||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Add an option to set the security context for the container. | ||
| # One or more tracking issues related to the change | ||
| issues: [1647] |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
| # The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other) | ||
| component: gateway | ||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Add an option to set the security context for the container. | ||
| # One or more tracking issues related to the change | ||
| issues: [1647] |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: deprecation | ||
| # The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other) | ||
| component: clusterReceiver | ||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Deprecate the `securityContext` field in favor of the `podSecurityContext`. | ||
| # One or more tracking issues related to the change | ||
| issues: [1647] |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: deprecation | ||
| # The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other) | ||
| component: gateway | ||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Deprecate the `securityContext` field in favor of the `podSecurityContext`. | ||
| # One or more tracking issues related to the change | ||
| issues: [1647] |
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -81,3 +81,9 @@ Splunk OpenTelemetry Collector is installed and configured to send data to Splun | |||||||||||||||||||||
| - Status: Instrumentation language maturity varies. See `operator.instrumentation.spec` and documentation for utilized instrumentation details. | ||||||||||||||||||||||
| - Splunk Support: We offer full support for Splunk distributions and best-effort support for native OpenTelemetry distributions of auto-instrumentation libraries. | ||||||||||||||||||||||
| {{- end }} | ||||||||||||||||||||||
| {{- if not (eq (toString .Values.gateway.securityContext) "<nil>") }} | ||||||||||||||||||||||
| [WARNING] "gateway.securityContext" parameter is deprecated. Please use "gateway.podSecurityContext" instead. | ||||||||||||||||||||||
| {{ end }} | ||||||||||||||||||||||
| {{- if not (eq (toString .Values.clusterReceiver.securityContext) "<nil>") }} | ||||||||||||||||||||||
| [WARNING] "clusterReceiver.securityContext" parameter is deprecated. Please use "clusterReceiver.podSecurityContext" instead. | ||||||||||||||||||||||
| {{ end }} | ||||||||||||||||||||||
|
Comment on lines
+87
to
+89
There was a problem hiding this comment.
Suggested change
@jvoravong is this what you are suggesting? How does the PR you referenced relate to this one? Tmk this is a different ask |
||||||||||||||||||||||
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -61,9 +61,10 @@ spec: | |||||
| affinity: | ||||||
| {{- toYaml $gateway.affinity | nindent 8 }} | ||||||
| {{- end }} | ||||||
| {{- $podSecurityContext := $gateway.podSecurityContext | default $gateway.securityContext }} | ||||||
| {{- if $podSecurityContext }} | ||||||
| securityContext: | ||||||
| {{- include "splunk-otel-collector.securityContext" (dict "isWindows" .Values.isWindows "securityContext" $podSecurityContext) | nindent 8 }} | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| {{- end }} | ||||||
| containers: | ||||||
| - name: otel-collector | ||||||
|
|
@@ -80,6 +81,10 @@ spec: | |||||
| {{- if .Values.gateway.featureGates }} | ||||||
| - --feature-gates={{ .Values.gateway.featureGates }} | ||||||
| {{- end }} | ||||||
| {{- with .Values.gateway.containerSecurityContext }} | ||||||
| securityContext: | ||||||
| {{- toYaml . | nindent 10 }} | ||||||
| {{- end }} | ||||||
| image: {{ template "splunk-otel-collector.image.otelcol" . }} | ||||||
| imagePullPolicy: {{ .Values.image.otelcol.pullPolicy }} | ||||||
| env: | ||||||
|
|
||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -731,6 +731,13 @@ | |
| "type": "object" | ||
| }, | ||
| "securityContext": { | ||
| "description": "[DEPRECATED] Use podSecurityContext instead.", | ||
| "type": "object" | ||
| }, | ||
| "podSecurityContext": { | ||
| "type": "object" | ||
| }, | ||
| "containerSecurityContext": { | ||
| "type": "object" | ||
| }, | ||
| "terminationGracePeriodSeconds": { | ||
|
|
@@ -1348,6 +1355,13 @@ | |
| "type": "object" | ||
| }, | ||
| "securityContext": { | ||
| "description": "[DEPRECATED] Use podSecurityContext instead.", | ||
| "type": "object" | ||
| }, | ||
| "podSecurityContext": { | ||
| "type": "object" | ||
| }, | ||
| "containerSecurityContext": { | ||
| "type": "object" | ||
| }, | ||
| "terminationGracePeriodSeconds": { | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -475,10 +475,13 @@ clusterReceiver: | |
| affinity: {} | ||
|
|
||
| # Pod configurations | ||
| podSecurityContext: {} | ||
| terminationGracePeriodSeconds: 600 | ||
| priorityClassName: "" | ||
|
|
||
| # Security context applied to the otel-collector container in the cluster receiver deployment. | ||
| containerSecurityContext: {} | ||
|
|
||
| # k8s cluster receiver collector annotations | ||
| annotations: {} | ||
| podAnnotations: {} | ||
|
|
@@ -1138,10 +1141,13 @@ gateway: | |
| affinity: {} | ||
|
|
||
| # Pod configurations | ||
| podSecurityContext: {} | ||
| terminationGracePeriodSeconds: 600 | ||
| priorityClassName: "" | ||
|
|
||
| # Security context applied to the otel-collector container in the gateway deployment. | ||
| containerSecurityContext: {} | ||
|
|
||
| # OTel collector annotations | ||
| annotations: {} | ||
| podAnnotations: {} | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Nit: Can we throw a failure or print a warning if one of the following cases happens? I just want to avoid confusion about which of the two available values (securityContext vs podSecurityContext) will be used. Maybe just update the message to say
podSecurityContexttakes priority.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.
I'm not sure I understand your suggestion. Please submit a suggesting diff
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.
Working on this. Need to state this PR relates to #1342