Skip to content
This repository has been archived by the owner on Feb 1, 2022. It is now read-only.

small installation tips for windows user #88

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

small installation tips for windows user #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ cd manifests/xgboost-job/xgboost-operator
kubectl create namespace kubeflow
kustomize build base | kubectl apply -f -
```
Note: for windows user, you might have invalid path error when you clone kubeflow/manifests repository, please use WSL instead
Copy link
Member

Choose a reason for hiding this comment

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

Add link to WSL?

Also remove “note :”

Why would they have issue git cloning the repo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If I use powershell to do the git clone for kubeflow/manifest repository will have following error
error: invalid path 'tests/tests/legacy_kustomizations/cert-manager-kube-system-resources/test_data/expected/rbac.authorization.k8s.io_v1beta1_role_cert-manager-cainjector:leaderelection.yaml'
fatal: unable to checkout working tree
warning: Clone succeeded, but checkout failed.
You can inspect what was checked out with 'git status'
and retry with 'git restore --source=HEAD :/'

I think this is a common error for windows user

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are some other ways to solve this problem for Windows user, some method might be a little bit easier if the user haven't installed WSL in their computer. But I guess most developer who use Windows has already installed WSL in their computer, then use WSL seems the easiest solution

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can also put a link for other solution if the windows user don't want to install WSL.
https://brendanforster.com/notes/fixing-invalid-git-paths-on-windows/

Copy link
Member

Choose a reason for hiding this comment

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

I am not sure if it makes sense to add this specific note that's git and OS specific. It sounds like this should be something a user would be figure out on their own by Googling around.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree


Note that since Kubernetes v1.14, `kustomize` became a subcommand in `kubectl` so you can also run the following command instead:

Expand Down