docs-website icon indicating copy to clipboard operation
docs-website copied to clipboard

docs: Fix documentation about using environment variables to obfuscate sensitive values

Open lmbaschiera opened this issue 1 year ago • 5 comments

Please follow conventional commit standards in your commit messages and pull request title.

Give us some context

  • What problems does this PR solve? Adds missing whitespaces between the curly brackets and the environment variable name. Without them, these are interpreted literally.
  • Add any context that will help us review your changes such as testing notes, In the tests that fixed an issue with variable passthrough, they do have whitespaces https://github.com/newrelic/nri-kubernetes/blob/main/charts/newrelic-infrastructure/tests/configmap_integrations_test.yaml#L231 We spent quite some time trying to figure out why the variables were not working, only to find out it was due to the whitespaces 😅

lmbaschiera avatar Aug 20 '24 20:08 lmbaschiera

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Aug 20 '24 20:08 CLAassistant

Hi @lmbaschiera 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

github-actions[bot] avatar Aug 20 '24 20:08 github-actions[bot]

Deploy Preview for docs-website-netlify ready!

Name Link
Latest commit 3f8ff7775050f14ec340cae2d172ee08f44ff688
Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/66c50199e8e75d0008536dca
Deploy Preview https://deploy-preview-18432--docs-website-netlify.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Aug 20 '24 20:08 netlify[bot]

@lmbaschiera I spoke with one of our devlopers and they said they have tests that confirm this syntax should work with or without spaces inside the curly braces. Have you spoken with our support team about this?

rhetoric101 avatar Aug 30 '24 15:08 rhetoric101

Hi @rhetoric101 - I have not reached out to the support, after some trial and error we figured it was because of the spaces when it worked after adding them. I don't think it was something else.

lmbaschiera avatar Sep 02 '24 21:09 lmbaschiera

As confirmed by @rhetoric101 and New Relic devs, the example will work with or without the spaces. Hence, closing the PR.

WriteMayur avatar Mar 10 '25 14:03 WriteMayur