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

[Docs] Beta TestNet - Supplier Cheatsheet #947

Merged
merged 34 commits into from
Dec 18, 2024
Merged

Conversation

Olshansk
Copy link
Member

@Olshansk Olshansk commented Nov 21, 2024

Summary

Adding the Supplier cheatsheet!

Issue

Type of change

Select one or more from the following:

Testing

  • Testing things manually by following the instructions

@Olshansk Olshansk force-pushed the supplier_cheatsheet branch from 2948a54 to 2db06ee Compare November 25, 2024 20:38
@Olshansk Olshansk changed the base branch from main to service_cheasheet November 25, 2024 21:48
@Olshansk Olshansk changed the title [WIP] Supplier cheatsheet [WIP][Make sure to update the base] Supplier cheatsheet Nov 25, 2024
@Olshansk Olshansk changed the title [WIP][Make sure to update the base] Supplier cheatsheet [WIP][UPDATE BASE][Docs] Beta TestNet - Supplier Cheatsheet Nov 25, 2024
@Olshansk Olshansk self-assigned this Nov 25, 2024
@Olshansk Olshansk added the documentation Improvements or additions to documentation label Nov 25, 2024
@Olshansk Olshansk added this to the Shannon Beta TestNet Launch milestone Nov 25, 2024
Base automatically changed from service_cheasheet to main November 26, 2024 20:57
@Olshansk Olshansk changed the title [WIP][UPDATE BASE][Docs] Beta TestNet - Supplier Cheatsheet [WIP][Docs] Beta TestNet - Supplier Cheatsheet Dec 3, 2024
Copy link

gitguardian bot commented Dec 12, 2024

⚠️ GitGuardian has uncovered 3 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
13506804 Triggered Generic High Entropy Secret 8d64e2a localnet/kubernetes/config-path-1.yaml View secret
14150880 Triggered Generic High Entropy Secret 8d64e2a localnet/kubernetes/config-path-3.yaml View secret
14150881 Triggered Generic High Entropy Secret 8d64e2a localnet/kubernetes/config-path-2.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 requested review from red-0ne and okdas December 13, 2024 00:06
@Olshansk Olshansk marked this pull request as ready for review December 13, 2024 00:07
@Olshansk Olshansk changed the title [WIP][Docs] Beta TestNet - Supplier Cheatsheet [Docs] Beta TestNet - Supplier Cheatsheet Dec 13, 2024
@bryanchriswhite bryanchriswhite self-requested a review December 13, 2024 21:22
Copy link
Member

@okdas okdas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for putting this together!

Copy link
Contributor

@red-0ne red-0ne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Followed the instructions of the guide and had a flawless outcome.

Besides a couple of NITs, it looks good to me 👍

If `grpc-insecure=false`, then it **MUST** be an HTTPS port, with TLS.

The Grove team exposed one such endpoint on one of our validators for Beta Testnet at `https://shannon-testnet-grove-grpc.beta.poktroll.com:443`.
It can be validated with `grpcurl https://shannon-testnet-grove-grpc.beta.poktroll.com:443`; note no `-plaintext` flag meaning no TLS encryption.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It can be validated with `grpcurl https://shannon-testnet-grove-grpc.beta.poktroll.com:443`; note no `-plaintext` flag meaning no TLS encryption.
It can be validated with `grpcurl https://shannon-testnet-grove-grpc.beta.poktroll.com:443`; note the absence of the `-plaintext` flag meaning no TLS encryption.

Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have to bail here for now:
image

Will finish before EOD.

docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
Copy link
Contributor

@bryanchriswhite bryanchriswhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice one @red-0ne @Olshansk ( 😅 )! 🙌

docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
docusaurus/docs/operate/quickstart/supplier_cheatsheet.md Outdated Show resolved Hide resolved
Copy link
Contributor

@red-0ne red-0ne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great improvements!

  • Warning emojis are catching attention very well
  • Noticeable improvement on the --grpc-insecure section

@Olshansk Olshansk merged commit 7ed0e99 into main Dec 18, 2024
13 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.

4 participants