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

Documentation: No explanation for endpoint when defining initial credentials in cluster #733

Open
2 tasks done
richard-copperdata opened this issue Aug 2, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@richard-copperdata
Copy link

richard-copperdata commented Aug 2, 2024

Description

In section 4 for defining credentials in the cluster of the Deploy on Kubernetes guide, there is no indication of what endpoint to use to make the initial connection.

Are we supposed to exec into the pod first and issue this command or is there a way to do it locally? Either way, what endpoint is supposed to replace ... in http://...?

Is there an existing issue for this?

  • I have searched the existing issues

Code of Conduct

  • I agree to follow this project's Code of Conduct
@richard-copperdata richard-copperdata added the documentation Improvements or additions to documentation label Aug 2, 2024
@richard-copperdata
Copy link
Author

I figured this out, though I'm not sure if there is a better way that could be added to the documentation.

  1. Start a proxy server via kubectl:
k proxy --port=8080
Starting to serve on 127.0.0.1:8080
  1. Access the surrealdb-tikv service via proxy (i.e. replacing the ... in the current docs):
surreal sql -u root -p 'StrongSecretPassword!' -e http://localhost:8080/api/v1/namespaces/default/services/surrealdb-tikv:8000/proxy/

#
#  Welcome to the SurrealDB SQL shell
...

Hope this helps someone else that might be stuck. I'll try to get a PR for adding this as a note to this section.

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
None yet
Development

No branches or pull requests

1 participant