ST with secrets - mysql, elasticsearch, postgresql. Customer facing doc for setting secrets as env variable #4945
Conversation
This file contains 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
…support in different version of otel agent and postgresql
kimsauce
reviewed
Jan 9, 2025
sidebars.ts
Outdated
Comment on lines
206
to
215
| //{ | ||
| //type: 'category', | ||
| //label: 'PostgreSQL', | ||
| //collapsible: true, | ||
| //collapsed: true, | ||
| //link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/postgresql/index'}, | ||
| //items:[ | ||
| //'send-data/opentelemetry-collector/remote-management/source-templates/postgresql/changelog', | ||
| //] | ||
| //}, |
There was a problem hiding this comment.
@sumoanema since you've labeled the docs as beta, I've added them to the sidebars and commented them out. When you're ready, you can uncomment these lines.
There was a problem hiding this comment.
Since OTRM has gone GA these ST are not beta anymore. Have uncommented the entry in sidebar.js and added two more - mysql and elasticsearch doc for which are added to this PR.
There was a problem hiding this comment.
Since these are GA, you'll need to remove beta code, which looks like this @sumoanema
<head>
<meta name="robots" content="noindex" />
</head>
<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>
kimsauce
reviewed
Jan 9, 2025
...send-data/opentelemetry-collector/remote-management/source-templates/postgresql/changelog.md
Outdated
Show resolved
Hide resolved
… and redirection link for them. Added an additional note for setting env in windows for stwith secrets
sumoanema
requested review from
jpipkin1,
mafsumo,
JV0812,
amee-sumo and
a team
as code owners
kimsauce
reviewed
Jan 27, 2025
Comment on lines
+12
to
+16
| <head> | ||
| <meta name="robots" content="noindex" /> | ||
| </head> | ||
|
|
||
| <p><a href="/docs/beta"><span className="beta">Beta</span></a></p> |
There was a problem hiding this comment.
Remove beta docs code (you indicated these are GA)
Suggested change
| <head> | |
| <meta name="robots" content="noindex" /> | |
| </head> | |
| <p><a href="/docs/beta"><span className="beta">Beta</span></a></p> |
kimsauce
reviewed
Jan 27, 2025
Comment on lines
+12
to
+16
| <head> | ||
| <meta name="robots" content="noindex" /> | ||
| </head> | ||
|
|
||
| <p><a href="/docs/beta"><span className="beta">Beta</span></a></p> |
There was a problem hiding this comment.
Remove beta docs code (you indicated these are GA)
Suggested change
| <head> | |
| <meta name="robots" content="noindex" /> | |
| </head> | |
| <p><a href="/docs/beta"><span className="beta">Beta</span></a></p> |
sumoanema
changed the title
kimsauce
reviewed
Jan 27, 2025
|
|
||
| ## Windows | ||
|
|
||
| 1. On your windows machine, open Registry Editor. |
There was a problem hiding this comment.
Suggested change
| 1. On your windows machine, open Registry Editor. | |
| 1. On your Windows machine, open the Registry Editor. |
kimsauce
reviewed
Jan 27, 2025
|
|
||
| 1. On your windows machine, open Registry Editor. | ||
| 2. Go to `Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\OtelcolSumo`. | ||
| 3. Right click on the right pane and select `New > Multi-String Value`. You need to name this as `environment`. |
There was a problem hiding this comment.
Suggested change
| 3. Right click on the right pane and select `New > Multi-String Value`. You need to name this as `environment`. | |
| 3. Right-click on the right pane and select **New** > **Multi-String Value**. You need to name this as `environment`. |
kimsauce
reviewed
Jan 27, 2025
| 1. On your windows machine, open Registry Editor. | ||
| 2. Go to `Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\OtelcolSumo`. | ||
| 3. Right click on the right pane and select `New > Multi-String Value`. You need to name this as `environment`. | ||
| 4. Right click on newly created entity `environment` in the step above and select `modify` |
There was a problem hiding this comment.
Suggested change
| 4. Right click on newly created entity `environment` in the step above and select `modify` | |
| 4. Right click on newly created entity `environment` in the step above and select `modify`. |
kimsauce
reviewed
Jan 27, 2025
| 2. Go to `Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\OtelcolSumo`. | ||
| 3. Right click on the right pane and select `New > Multi-String Value`. You need to name this as `environment`. | ||
| 4. Right click on newly created entity `environment` in the step above and select `modify` | ||
| 5. You can set the environment variable as per your needs. For example in the below screenshot we have set `TEST_VAR` env variable with value `sumoemp`:<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/set_env_varibale_windows.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/> |
There was a problem hiding this comment.
Suggested change
| 5. You can set the environment variable as per your needs. For example in the below screenshot we have set `TEST_VAR` env variable with value `sumoemp`:<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/set_env_varibale_windows.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/> | |
| 5. You can set the environment variable as per your needs. For example, in the below screenshot, we have set `TEST_VAR` env variable with value `sumoemp`:<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/set_env_varibale_windows.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/> |
kimsauce
reviewed
Jan 27, 2025
| 4. Right click on newly created entity `environment` in the step above and select `modify` | ||
| 5. You can set the environment variable as per your needs. For example in the below screenshot we have set `TEST_VAR` env variable with value `sumoemp`:<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/set_env_varibale_windows.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/> | ||
| 6. Click on **OK**. | ||
| 7. **Optional Step** Since by default the variable set as part of registry are visible to all user, you can follow the below steps to manage the ACL of the service registry and environment variable set in above steps : |
There was a problem hiding this comment.
Suggested change
| 7. **Optional Step** Since by default the variable set as part of registry are visible to all user, you can follow the below steps to manage the ACL of the service registry and environment variable set in above steps : | |
| 7. (Optional step) By default, any variables stored in the registry are visible to all users. To control visibility and permissions, follow the steps below to manage the ACLs for both the service registry and the environment variables you set previously. |
kimsauce
reviewed
Jan 27, 2025
Comment on lines
+90
to
+94
| - Right click on OtelcolSumo service in the left pane of the registry editor and click on permissions | ||
| - Go to advance section by pressing Advanced button | ||
| - Since the permissions are inherited by services from its parent by default, you will need to disable inheritance in the Advanced Security Settings popup. | ||
| - While disabling inheritance you will get two options to either convert inherited permission or to remove inherit permissions and create the permission list from scrath. You can choose either of the two depending on your case. | ||
| - You can then edit Users from this list to ensure appropriate access of this registry and environment variable set under it.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/ACL_windows_registry.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/> |
There was a problem hiding this comment.
Suggested change
| - Right click on OtelcolSumo service in the left pane of the registry editor and click on permissions | |
| - Go to advance section by pressing Advanced button | |
| - Since the permissions are inherited by services from its parent by default, you will need to disable inheritance in the Advanced Security Settings popup. | |
| - While disabling inheritance you will get two options to either convert inherited permission or to remove inherit permissions and create the permission list from scrath. You can choose either of the two depending on your case. | |
| - You can then edit Users from this list to ensure appropriate access of this registry and environment variable set under it.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/ACL_windows_registry.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/> | |
| 1. Right-click on OtelcolSumo service in the left pane of the registry editor and click on permissions. | |
| 1. Go to the advanced section by pressing the Advanced button. | |
| 1. Since the permissions are inherited by services from its parent by default, you will need to disable inheritance in the Advanced Security Settings popup. | |
| 1. When you disable inheritance, you’ll be given two options: you can either convert the existing inherited permissions, or remove them entirely and build a new permission list from scratch. Choose whichever option best fits your requirements. | |
| 1. You can then edit Users from this list to ensure appropriate access of this registry and environment variable set under it.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/ACL_windows_registry.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose of this pull request
This pull request is to introduce documentation of Postgresql source template
Select the type of change
Adding a new page with the instruction to use postgresql Source template
Ticket (if applicable)
https://sumologic.atlassian.net/browse/SUMO-245421