-
Notifications
You must be signed in to change notification settings - Fork 13
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
[UPDATE BASE BEFORE MERGING][Docs] Update docker walkthrough & cheatsheet #982
Conversation
docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md
Outdated
Show resolved
Hide resolved
c253303
to
ec6fd67
Compare
…update-docker-walkthrough
…update-docker-walkthrough
|
GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
---|---|---|---|---|---|
14150880 | Triggered | Generic High Entropy Secret | 5ebee56 | localnet/kubernetes/config-path-3.yaml | View secret |
14150881 | Triggered | Generic High Entropy Secret | 5ebee56 | localnet/kubernetes/config-path-2.yaml | View secret |
13506804 | Triggered | Generic High Entropy Secret | 5ebee56 | localnet/kubernetes/config-path-1.yaml | View secret |
13506804 | Triggered | Generic High Entropy Secret | 82c141b | localnet/kubernetes/config-path-1.yaml | View secret |
14150881 | Triggered | Generic High Entropy Secret | 82c141b | localnet/kubernetes/config-path-2.yaml | View secret |
14150880 | Triggered | Generic High Entropy Secret | 82c141b | localnet/kubernetes/config-path-3.yaml | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secrets safely. Learn here the best practices.
- Revoke and rotate these secrets.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
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.
@red-0ne I did not go through the motions myself, but looks good to me.
Once the dust settles and everyone is on main & deployed, I'm sure we'll find a bunch of opportunities for improvements and just keep iterating on main.
I took the liberty to push some things to get it over the finish line.
- See this commit: pokt-network/poktroll-docker-compose-example@3f1779a
- See this commit:
ec2aecf
(#982)
If all looks good to you, feel free to merge (after updating the base branch)!
Summary
Adapt docker-compose walkthrough and cheatsheet to use PATH instead of AppGate.
This is a follow-up to AppGate-to-Path documentation PR #945
It will be applicable once pokt-network/poktroll-docker-compose-example#31 is merged.
Issue
AppGate Server deprecation and removal requires documentation update to use PATH Gateway instead.
Type of change
Select one or more from the following:
consensus-breaking
label if so. See [Infra] Automatically add theconsensus-breaking
label #791 for detailsTesting
make docusaurus_start
; only needed if you make doc changesSanity Checklist