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

config: allow exposing real secret value through marshal #487

Merged
merged 1 commit into from
Apr 15, 2024

Conversation

GiedriusS
Copy link
Contributor

There are external projects out there that marshal/unmarshal the Prometheus config that has secrets. To get the real value currently such horrible workarounds are in place:
https://github.com/tkestack/kvass/blob/master/pkg/sidecar/injector.go#L175-L214

Let's add a way to get the original values through the Secret type to avoid such things.

There are external projects out there that marshal/unmarshal the
Prometheus config that has secrets. To get the real value currently such
horrible workarounds are in place:
https://github.com/tkestack/kvass/blob/master/pkg/sidecar/injector.go#L175-L214

Let's add a way to get the original values through the `Secret` type to
avoid such things.

Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>
desc string
data tmp
expected string
trueValue bool
Copy link
Member

Choose a reason for hiding this comment

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

"trueValue" isn't a very descriptive name. How about:

Suggested change
trueValue bool
marshalSecret bool

@SuperQ
Copy link
Member

SuperQ commented Feb 28, 2024

Good idea, minor nit about the test setup.

@alita1991
Copy link

Is there any plan to merge the code in the next period of time?

@roidelapluie roidelapluie merged commit de5ed88 into prometheus:main Apr 15, 2024
@roidelapluie
Copy link
Member

thanks, I think we can do the test improvement later on.

SuperQ added a commit that referenced this pull request Apr 15, 2024
Make code more readable by replacing overly generic `trueValue` with the
actual meaning `marshalSecret`.

Fixes: #487

Signed-off-by: SuperQ <superq@gmail.com>
@SuperQ SuperQ mentioned this pull request Apr 15, 2024
SuperQ added a commit that referenced this pull request Apr 15, 2024
Make code more readable by replacing overly generic `trueValue` with the
actual meaning `marshalSecret`.

Fixes: #487

Signed-off-by: SuperQ <superq@gmail.com>
codeboten referenced this pull request in open-telemetry/opentelemetry-collector Apr 23, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/prometheus/common](https://github.com/prometheus/common)
| `v0.52.3` -> `v0.53.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fprometheus%2fcommon/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fprometheus%2fcommon/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fprometheus%2fcommon/v0.52.3/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fprometheus%2fcommon/v0.52.3/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>prometheus/common (github.com/prometheus/common)</summary>

###
[`v0.53.0`](https://github.com/prometheus/common/releases/tag/v0.53.0)

[Compare
Source](https://github.com/prometheus/common/compare/v0.52.3...v0.53.0)

#### What's Changed

- Add StatusAt method for Alert struct by
[@&#8203;grobinson-grafana](https://github.com/grobinson-grafana) in
[https://github.com/prometheus/common/pull/618](https://github.com/prometheus/common/pull/618)
- config: allow exposing real secret value through marshal by
[@&#8203;GiedriusS](https://github.com/GiedriusS) in
[https://github.com/prometheus/common/pull/487](https://github.com/prometheus/common/pull/487)
- Fix up config test by [@&#8203;SuperQ](https://github.com/SuperQ) in
[https://github.com/prometheus/common/pull/621](https://github.com/prometheus/common/pull/621)
- LabelSet.String: restore faster sort call by
[@&#8203;bboreham](https://github.com/bboreham) in
[https://github.com/prometheus/common/pull/619](https://github.com/prometheus/common/pull/619)
- LabelSet: add unit test for String method by
[@&#8203;bboreham](https://github.com/bboreham) in
[https://github.com/prometheus/common/pull/620](https://github.com/prometheus/common/pull/620)

#### New Contributors

- [@&#8203;grobinson-grafana](https://github.com/grobinson-grafana)
made their first contribution in
[https://github.com/prometheus/common/pull/618](https://github.com/prometheus/common/pull/618)
- [@&#8203;GiedriusS](https://github.com/GiedriusS) made their first
contribution in
[https://github.com/prometheus/common/pull/487](https://github.com/prometheus/common/pull/487)

**Full Changelog**:
prometheus/common@v0.52.3...v0.53.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any
time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMTMuMSIsInVwZGF0ZWRJblZlciI6IjM3LjMxMy4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJyZW5vdmF0ZWJvdCJdfQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
codeboten referenced this pull request in open-telemetry/opentelemetry-collector-contrib Apr 23, 2024
)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/prometheus/common](https://github.com/prometheus/common)
| `v0.52.3` -> `v0.53.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fprometheus%2fcommon/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fprometheus%2fcommon/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fprometheus%2fcommon/v0.52.3/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fprometheus%2fcommon/v0.52.3/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

> [!WARNING]
> Some dependencies could not be looked up. Check the Dependency
Dashboard for more information.

---

### Release Notes

<details>
<summary>prometheus/common (github.com/prometheus/common)</summary>

###
[`v0.53.0`](https://github.com/prometheus/common/releases/tag/v0.53.0)

[Compare
Source](https://github.com/prometheus/common/compare/v0.52.3...v0.53.0)

#### What's Changed

- Add StatusAt method for Alert struct by
[@&#8203;grobinson-grafana](https://github.com/grobinson-grafana) in
[https://github.com/prometheus/common/pull/618](https://github.com/prometheus/common/pull/618)
- config: allow exposing real secret value through marshal by
[@&#8203;GiedriusS](https://github.com/GiedriusS) in
[https://github.com/prometheus/common/pull/487](https://github.com/prometheus/common/pull/487)
- Fix up config test by [@&#8203;SuperQ](https://github.com/SuperQ) in
[https://github.com/prometheus/common/pull/621](https://github.com/prometheus/common/pull/621)
- LabelSet.String: restore faster sort call by
[@&#8203;bboreham](https://github.com/bboreham) in
[https://github.com/prometheus/common/pull/619](https://github.com/prometheus/common/pull/619)
- LabelSet: add unit test for String method by
[@&#8203;bboreham](https://github.com/bboreham) in
[https://github.com/prometheus/common/pull/620](https://github.com/prometheus/common/pull/620)

#### New Contributors

- [@&#8203;grobinson-grafana](https://github.com/grobinson-grafana)
made their first contribution in
[https://github.com/prometheus/common/pull/618](https://github.com/prometheus/common/pull/618)
- [@&#8203;GiedriusS](https://github.com/GiedriusS) made their first
contribution in
[https://github.com/prometheus/common/pull/487](https://github.com/prometheus/common/pull/487)

**Full Changelog**:
prometheus/common@v0.52.3...v0.53.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any
time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector-contrib).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMTMuMSIsInVwZGF0ZWRJblZlciI6IjM3LjMxMy4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJyZW5vdmF0ZWJvdCJdfQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
Co-authored-by: Yang Song <songy23@users.noreply.github.com>
andrzej-stencel referenced this pull request in andrzej-stencel/opentelemetry-collector May 27, 2024
…#10021)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [github.com/prometheus/common](https://github.com/prometheus/common)
| `v0.52.3` -> `v0.53.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fprometheus%2fcommon/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fprometheus%2fcommon/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fprometheus%2fcommon/v0.52.3/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fprometheus%2fcommon/v0.52.3/v0.53.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>prometheus/common (github.com/prometheus/common)</summary>

###
[`v0.53.0`](https://github.com/prometheus/common/releases/tag/v0.53.0)

[Compare
Source](https://github.com/prometheus/common/compare/v0.52.3...v0.53.0)

#### What's Changed

- Add StatusAt method for Alert struct by
[@&open-telemetry#8203;grobinson-grafana](https://github.com/grobinson-grafana) in
[https://github.com/prometheus/common/pull/618](https://github.com/prometheus/common/pull/618)
- config: allow exposing real secret value through marshal by
[@&open-telemetry#8203;GiedriusS](https://github.com/GiedriusS) in
[https://github.com/prometheus/common/pull/487](https://github.com/prometheus/common/pull/487)
- Fix up config test by [@&open-telemetry#8203;SuperQ](https://github.com/SuperQ) in
[https://github.com/prometheus/common/pull/621](https://github.com/prometheus/common/pull/621)
- LabelSet.String: restore faster sort call by
[@&open-telemetry#8203;bboreham](https://github.com/bboreham) in
[https://github.com/prometheus/common/pull/619](https://github.com/prometheus/common/pull/619)
- LabelSet: add unit test for String method by
[@&open-telemetry#8203;bboreham](https://github.com/bboreham) in
[https://github.com/prometheus/common/pull/620](https://github.com/prometheus/common/pull/620)

#### New Contributors

- [@&open-telemetry#8203;grobinson-grafana](https://github.com/grobinson-grafana)
made their first contribution in
[https://github.com/prometheus/common/pull/618](https://github.com/prometheus/common/pull/618)
- [@&open-telemetry#8203;GiedriusS](https://github.com/GiedriusS) made their first
contribution in
[https://github.com/prometheus/common/pull/487](https://github.com/prometheus/common/pull/487)

**Full Changelog**:
prometheus/common@v0.52.3...v0.53.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on tuesday" (UTC), Automerge - At any
time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/open-telemetry/opentelemetry-collector).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMTMuMSIsInVwZGF0ZWRJblZlciI6IjM3LjMxMy4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJyZW5vdmF0ZWJvdCJdfQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants