Updates secrets settings #1535
Merged
Updates secrets settings #1535
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
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
kenjenkins
reviewed
Jul 25, 2024
|
|
||
| :::tip **Note** | ||
| \* Standalone Pomerium Core configurations do not require a `shared_secret` or `shared_secret_file`. If you don't set a shared secret, Pomerium will generate one for you. |
There was a problem hiding this comment.
I don't know if this is completely accurate. I believe you would also need to set the same shared secret on each service if running in split service mode.
(Feel free to leave this for a separate follow-up item.)
There was a problem hiding this comment.
OK. I created an issue so we can track work on this: #1538
kenjenkins
reviewed
Jul 25, 2024
Revert the addition of some #shared-secret anchor tags in links, the change to the sidebar label for the Signing Key page, and remove two unnecessary redirects.
kenjenkins
reviewed
Jul 30, 2024
| @@ -94,4 +94,4 @@ Configuration options for each backend are detailed in the [**databroker configu | |||
|
|
|||
| ## Troubleshooting | |||
|
|
|||
| Most issues with the Databroker service are caused by a [`shared_secret`](/docs/reference/shared-secret) mismatch between services. See [Troubleshooting - Shared Secret Mismatch](/docs/reference/shared-secret) for details. | |||
| Most issues with the Databroker service are caused by a [`shared_secret`](/docs/reference/shared-secret#shared-secret) mismatch between services. See [Troubleshooting - Shared Secret Mismatch](/docs/reference/shared-secret#shared-secret) for details. | |||
There was a problem hiding this comment.
We should revert this change now as well, right?
(I'll go ahead and push a commit to do that.)
content/docs/troubleshooting.mdx
Outdated
| @@ -148,7 +148,7 @@ Events: | |||
|
|
|||
| ### Shared Secret Mismatch | |||
|
|
|||
| Pomerium's independent services communicate securely using a [shared secret](/docs/reference/shared-secret). When services or the databroker have mismatched secrets, Pomerium will fail. | |||
| Pomerium's independent services communicate securely using a [shared secret](/docs/reference/shared-secret#shared-secret). When Pomerium services share a mismatched secret, or these services share a secret that is not the same secret set in the Databroker service, Pomerium will fail. | |||
There was a problem hiding this comment.
I'm not sure this is an improvement. "Share" feels like the wrong verb to use if we're talking about different secrets set on different services.
kenjenkins
approved these changes
Jul 30, 2024
backport-actions-token bot
pushed a commit
that referenced
this pull request
Jul 30, 2024
* adds redirects and merges settings * moves shared secret, redirects * fixes breaking links * runs prettier * Update content/docs/reference/shared-secret.mdx Co-authored-by: Kenneth Jenkins <[email protected]> * updates signign key settings * updates shared secret * fixes breaking links * runs prettier * incorporates feedback * runs prettier * revert some unnecessary changes Revert the addition of some #shared-secret anchor tags in links, the change to the sidebar label for the Signing Key page, and remove two unnecessary redirects. * Update content/docs/capabilities/getting-users-identity.md Co-authored-by: Kenneth Jenkins <[email protected]> * updates 'share' to 'contain' * updates contain to exchange * updates wording --------- Co-authored-by: Kenneth Jenkins <[email protected]>
ZPain8464
added a commit
that referenced
this pull request
Jul 30, 2024
Updates secrets settings (#1535) * adds redirects and merges settings * moves shared secret, redirects * fixes breaking links * runs prettier * Update content/docs/reference/shared-secret.mdx * updates signign key settings * updates shared secret * fixes breaking links * runs prettier * incorporates feedback * runs prettier * revert some unnecessary changes Revert the addition of some #shared-secret anchor tags in links, the change to the sidebar label for the Signing Key page, and remove two unnecessary redirects. * Update content/docs/capabilities/getting-users-identity.md * updates 'share' to 'contain' * updates contain to exchange * updates wording --------- Co-authored-by: zachary painter <[email protected]> Co-authored-by: Kenneth Jenkins <[email protected]>
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.
This PR consolidates the Shared Secret/File and Signing Key/File settings into two reference pages:
Resolves https://github.com/pomerium/internal/issues/1856