Skip to content

[Doc]Add doc for deploying with minikube and kubectl#21646

Closed
huandzh wants to merge 1 commit into
StarRocks:mainfrom
huandzh:add_doc_for_k8s_minikube_deployment
Closed

[Doc]Add doc for deploying with minikube and kubectl#21646
huandzh wants to merge 1 commit into
StarRocks:mainfrom
huandzh:add_doc_for_k8s_minikube_deployment

Conversation

@huandzh
Copy link
Copy Markdown
Contributor

@huandzh huandzh commented Apr 14, 2023

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Which issues of this PR fixes :

Add a new doc page for deploying StarRocks with minikube and kubectl.

Problem Summary(Required) :

Developers or preview users of StarRocks-powered apps using Kubernetes would appreciate a guide on how to start the services using 'Minikube' or 'kubectl', as these commands are likely available and easily accessible.

This PR should be blocked from merging until StarRocks/demo#26 is accepted.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr will affect users' behaviors
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function

Bugfix cherry-pick branch check:

  • I have checked the version labels which the pr will be auto backported to target branch
    • 3.0
    • 2.5
    • 2.4
    • 2.3

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 14, 2023
Signed-off-by: Huan Di <huandzh@gmail.com>
@huandzh huandzh force-pushed the add_doc_for_k8s_minikube_deployment branch from a7b7705 to 6400978 Compare April 28, 2023 03:31
@DanRoscigno
Copy link
Copy Markdown
Contributor

Hi @huandzh thanks so much for your contribution. I am going to spin up Minikube and give it a go. Sorry for leaving it sitting here for so long.

@DanRoscigno
Copy link
Copy Markdown
Contributor

notes while testing on macOS with M2 chip:

  • Tunnel does not work with minikube start on macOS Ventura with an M2 chip, I don't know if it works on any Mac. I found PRs for Minikube that fixed this, but I am running the Minikube release from only four weeks ago and it is not working.
  • The demo manifest file works fine with Kubernetes in Docker for Mac, so how about we merge the manifest in the demo repo first, and then edit this PR to say "You can use Minikube on Linux with the manifest file, or Docker Desktop with Kubernetes enabled on macOS"?

What do you think @huandzh and @alberttwong ?

@alberttwong
Copy link
Copy Markdown
Contributor

It's only helm chart or operator. as far as I know, you can't do straight yaml.

@alberttwong
Copy link
Copy Markdown
Contributor

why we do we want to go backwards from helm chart and operator?

@huandzh
Copy link
Copy Markdown
Contributor Author

huandzh commented Sep 14, 2023

It's only helm chart or operator. as far as I know, you can't do straight yaml.

A single-file demo to set up a front-end and back-end pair is available at StarRocks/demo#26 .

@huandzh
Copy link
Copy Markdown
Contributor Author

huandzh commented Sep 14, 2023

notes while testing on macOS with M2 chip:

  • Tunnel does not work with minikube start on macOS Ventura with an M2 chip, I don't know if it works on any Mac. I found PRs for Minikube that fixed this, but I am running the Minikube release from only four weeks ago and it is not working.
  • The demo manifest file works fine with Kubernetes in Docker for Mac, so how about we merge the manifest in the demo repo first, and then edit this PR to say "You can use Minikube on Linux with the manifest file, or Docker Desktop with Kubernetes enabled on macOS"?

What do you think @huandzh and @alberttwong ?

Thank you for getting back to me. I had tested the demo in Windows and Linux/Nixos at that time. However, I'm not sure about the compatibility of minikube tunnel on Mac.

If there is indeed an issue, how about edit this PR and state that "In case minikube tunnel doesn't works as expected on macOS, you can use Docker Desktop with Kubernetes enabled as an alternative."

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

Successfully merging this pull request may close these issues.

3 participants