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 MINIKUBE_HOME usage #18648

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

Tony-Sol
Copy link

Resolves #15835

Make MINIKUBE_HOME env variable usage more convenient with backward compatibility.

Current logic of MINIKUBE_HOME env usage isn't really obvious:

  • If env var is not set, it uses ${HOME}/.minikube as default.
  • If env var is set, it checks its basename (for some reason??):
    • If basename equals .minikube - use env var
    • Else it appends .minikube to env var value (for some reason??)

It's very implicit logic and goes against the conventional use of *_HOME env vars.

With this changes, the logic changes a bit:

  • If env var is not set, it uses ${HOME}/.minikube as default (as it's now)
  • If env var is set, it checks its basename (as it's now)
    • If basename equals .minikube - use env var (as it's now)
    • Else it checks existence of .minikube inside path, provided via env var (for backward compatibility)
      • If ${MINIKUBE_HOME}/.minikube exists - use this legacy path (for backward compatibility)
      • Else - use MINIKUBE_HOME as is (new)

So, here is example cases:

  1. Env is unset:
    $ export MINIKUBE_HOME=""
    $ # run minikube
    $ ls -hAF ~ | grep minikube
    .minikube/
    $ ls -hAF ~/.minikube
    addons/   cache/    certs/    config/   files/    logs/     machines/
    
  2. Env is set AND its basename is .minikube:
    $ export MINIKUBE_HOME="${XDG_DATA_HOME}/.minikube"
    $ # run minikube
    $ ls -hAF $XDG_DATA_HOME | grep minikube
    .minikube/
    $ ls -hAF $XDG_DATA_HOME/.minikube
    addons/   cache/    certs/    config/   files/    logs/     machines/
    
  3. Env is set AND its basename is not .minikube AND there is NO .minikube inside:
    $ export MINIKUBE_HOME="${XDG_DATA_HOME}/minikube"
    $ ls -hAF $MINIKUBE_HOME
    $ # MINIKUBE_HOME is empty
    $ # run minikube
    $ ls -hAF $MINIKUBE_HOME
    addons/   cache/    certs/    config/   files/    logs/     machines/
    
  4. Env is set AND its basename is not .minikube AND there is .minikube inside provided path:
    $ export MINIKUBE_HOME="${XDG_DATA_HOME}/minikube"
    $ ls -hAF $MINIKUBE_HOME
    .minikube/
    $ # MINIKUBE_HOME has state from previous version
    $ # run minikube
    $ ls -hAF $MINIKUBE_HOME
    .minikube/
    $ ls -hAF $MINIKUBE_HOME/.minikube
    addons/   cache/    certs/    config/   files/    logs/     machines/
    

Copy link

linux-foundation-easycla bot commented Apr 15, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: Tony-Sol / name: Tony Soloveyv (5036c9f)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Tony-Sol
Once this PR has been reviewed and has the lgtm label, please assign spowelljr for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 15, 2024
@minikube-bot
Copy link
Collaborator

Can one of the admins verify this patch?

@k8s-ci-robot
Copy link
Contributor

Welcome @Tony-Sol!

It looks like this is your first PR to kubernetes/minikube 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/minikube has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 15, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @Tony-Sol. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Current MINIKUBE_HOME environment variable setting logic is confusing
3 participants