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

[UPDATE BASE BEFORE MERGING][Docs] Update docker walkthrough & cheatsheet #982

Merged
merged 22 commits into from
Dec 11, 2024

Conversation

red-0ne
Copy link
Contributor

@red-0ne red-0ne commented Dec 4, 2024

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:

Testing

  • Documentation: make docusaurus_start; only needed if you make doc changes

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have commented my code
  • I have performed a self-review of my own code; both comments & source code
  • I create and reference any new tickets, if applicable
  • I have left TODOs throughout the codebase, if applicable

@red-0ne red-0ne added the documentation Improvements or additions to documentation label Dec 4, 2024
@red-0ne red-0ne added this to the Shannon Beta TestNet Support milestone Dec 4, 2024
@red-0ne red-0ne requested review from Olshansk and okdas December 4, 2024 23:56
@red-0ne red-0ne self-assigned this Dec 4, 2024
@red-0ne red-0ne changed the base branch from main to docs/appgate-to-path December 4, 2024 23:57
@red-0ne red-0ne changed the base branch from docs/appgate-to-path to main December 4, 2024 23:59
@red-0ne red-0ne changed the base branch from main to feat/localnet-path December 4, 2024 23:59
@red-0ne red-0ne force-pushed the docs/update-docker-walkthrough branch from c253303 to ec6fd67 Compare December 5, 2024 00:01
@red-0ne red-0ne changed the base branch from feat/localnet-path to docs/appgate-to-path December 5, 2024 00:01
@red-0ne red-0ne changed the title [Docs] Update docker walkthrough [Docs] Update docker walkthrough & cheatsheet Dec 5, 2024
@red-0ne red-0ne mentioned this pull request Dec 5, 2024
12 tasks
@red-0ne red-0ne requested review from Olshansk and removed request for Olshansk December 5, 2024 17:04
Copy link

gitguardian bot commented Dec 10, 2024

⚠️ GitGuardian has uncovered 6 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
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
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. 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


🦉 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.

@Olshansk Olshansk changed the title [Docs] Update docker walkthrough & cheatsheet [UPDATE BASE BEFORE MERGING][Docs] Update docker walkthrough & cheatsheet Dec 10, 2024
Copy link
Member

@Olshansk Olshansk left a 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.

  1. See this commit: pokt-network/poktroll-docker-compose-example@3f1779a
  2. See this commit: ec2aecf (#982)

If all looks good to you, feel free to merge (after updating the base branch)!

@red-0ne red-0ne changed the base branch from docs/appgate-to-path to main December 11, 2024 00:01
@red-0ne red-0ne merged commit 5d8c6dc into main Dec 11, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants