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 README and solo node start to provide commands to setup kubectl port forward for network nodes #516

Closed
Tracked by #47
jeromy-cannon opened this issue Aug 27, 2024 · 4 comments · Fixed by #620
Assignees
Labels
P2 Required to be completed in the assigned milestone, but may or may not impact release schedule. released Requested by Stakeholder Requested by an individual or team that uses Solo

Comments

@jeromy-cannon
Copy link
Contributor

jeromy-cannon commented Aug 27, 2024

requested by Simi for uses to be able to leverage to setup a connection against the network.

@jeromy-cannon jeromy-cannon added P2 Required to be completed in the assigned milestone, but may or may not impact release schedule. Requested by Stakeholder Requested by an individual or team that uses Solo labels Aug 27, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in Solo Aug 27, 2024
@jeromy-cannon jeromy-cannon moved this from 🆕 New to 🔖 Ready in Solo Aug 27, 2024
@JeffreyDallas
Copy link
Contributor

JeffreyDallas commented Sep 12, 2024

Need more elaboration on this, is ths about to adding new flags to enable port forwarding for
haproxy--svc ?

@jeromy-cannon jeromy-cannon self-assigned this Sep 18, 2024
@jeromy-cannon jeromy-cannon added the Needs Refinement The issue needs more refinement and/or design before it can be worked label Sep 18, 2024
@jeromy-cannon
Copy link
Contributor Author

Need more elaboration on this, is ths about to adding new flags to enable port forwarding for haproxy--svc ?

Just write up the kubectl commands that they can execute that will setup the port forwards and add them into a section of the README.md. I think that something like that got dumped to sysout in some of our dev scripts in the FST helm chart tests. Yes, I think point them at the haproxy service, as that is what we connect to to build our SDK connections as well.

@jeromy-cannon
Copy link
Contributor Author

jeromy-cannon commented Sep 19, 2024

This is from our FST deployment notes.txt:

Get the name of the envoy gateway system:
  export ENVOY_SERVICE=$(kubectl get svc -n envoy-gateway-system --selector=gateway.envoyproxy.io/owning-gateway-namespace="${NAMESPACE}",gateway.envoyproxy.io/owning-gateway-name=fst -o jsonpath="{.items[0].metadata.name}")

Forward a port on the gateway to a local port:
  kubectl port-forward "svc/${ENVOY_SERVICE}" -n envoy-gateway-system "${LOCAL_PORT}":"${GATEWAY_PORT}" &

Some examples, that for convenience, use the same local port as that on the gateway:

To access the Hedera Mirror Node Explorer locally (port 8888 on the gateway):
  kubectl port-forward "svc/${ENVOY_SERVICE}" -n envoy-gateway-system 8888:8888 &
  open http://127.0.0.1:8888

To access the GRPC port of node 2 (starting port 52000 for node 0 on the gateway):
  kubectl port-forward "svc/${ENVOY_SERVICE}" -n envoy-gateway-system 52002:52002 &

To access the GRPC secure (TLS) port of node 1 (starting port 53000 for node 0 on the gateway):
  kubectl port-forward "svc/${ENVOY_SERVICE}" -n envoy-gateway-system 53001:53001 &

To access the gossip port of node 0 (starting port 51000 for node 0 on the gateway):
  kubectl port-forward "svc/${ENVOY_SERVICE}" -n envoy-gateway-system 51000:51000 &

To access the GRPC web port of node 5 (starting port 18000 for node 0 on the gateway):
  kubectl port-forward "svc/${ENVOY_SERVICE}" -n envoy-gateway-system 18005:18005 &

So, something like this, except use our haproxy grpc port. test the commands to make sure they are good, then add them to a section in the README.md to help those less familiar with Kubernetes and kubectl expose the ports locally so they can use their network nodes to run tests against.

The envoy-gateway is gone, so ignore that. this is just an example.

@jeromy-cannon jeromy-cannon removed the Needs Refinement The issue needs more refinement and/or design before it can be worked label Sep 19, 2024
@jeromy-cannon jeromy-cannon removed their assignment Sep 19, 2024
@github-project-automation github-project-automation bot moved this from 🔖 Ready to ✅ Done in Solo Sep 19, 2024
@swirlds-automation
Copy link
Contributor

🎉 This issue has been resolved in version 0.31.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 Required to be completed in the assigned milestone, but may or may not impact release schedule. released Requested by Stakeholder Requested by an individual or team that uses Solo
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

3 participants