You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
(all three of above can be installed at once from [here](https://packaging.python.org/en/latest/guides/installing-using-linux-tools/#installing-pip-setuptools-wheel-with-linux-package-managers))
81
-
- gcloud (install from [here](https://cloud.google.com/sdk/gcloud#download_and_install_the))
88
+
- gcloud: install from [here](https://cloud.google.com/sdk/gcloud#download_and_install_the) and then:
82
89
- Run `gcloud init`
83
90
-[Authenticate](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login) to Google Cloud
84
-
- kubectl (install from [here](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#install_kubectl))
91
+
- kubectl: install from [here](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#install_kubectl) and then:
85
92
- Install `gke-gcloud-auth-plugin` from [here](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl#install_plugin)
- Run `gcloud auth configure-docker` to ensure images can be uploaded to registry
88
-
- make - please run below command.
89
-
```shell
90
-
# sudo may be required
91
-
apt-get -y install make
92
-
```
93
-
In addition, below dependencies can be installed either using provided links or using `make install` command, if xpk is downloaded via `git clone` command:
94
-
- kueuectl (install from [here](https://kueue.sigs.k8s.io/docs/reference/kubectl-kueue/installation/))
To install xpk, install required tools mentioned in [prerequisites](#prerequisites). [Makefile](https://github.com/AI-Hypercomputer/xpk/blob/main/Makefile) provides a way to install all neccessary tools. XPK can be installed via pip:
97
+
### Additional prerequisites when installing from pip
98
+
99
+
- kueuectl: install from [here](https://kueue.sigs.k8s.io/docs/reference/kubectl-kueue/installation/)
- make: install by running `apt-get -y install make` (`sudo` might be required)
106
+
107
+
## Installation via pip
108
+
109
+
To install XPK using pip, first install required tools mentioned in [prerequisites](#prerequisites) and [additional prerequisites](#additional-prerequisites-when-installing-from-pip). Then you can install XPK simply by running:
99
110
100
111
```shell
101
112
pip install xpk
102
113
```
103
114
104
-
If you see an error saying: `This environment is externally managed`, please use a virtual environment.
115
+
If you see an error saying: `This environment is externally managed`, please use a virtual environment. For example:
105
116
106
117
```shell
107
-
## One time step of creating the venv
108
-
VENV_DIR=~/venvp3
109
-
python3 -m venv $VENV_DIR
110
-
## Enter your venv.
111
-
source$VENV_DIR/bin/activate
112
-
## Clone the repository and installing dependencies.
113
-
pip install xpk
118
+
# One time step of creating the virtual environment
119
+
VENV_DIR=~/venvp3
120
+
python3 -m venv $VENV_DIR
121
+
122
+
# Activate your virtual environment
123
+
source$VENV_DIR/bin/activate
124
+
125
+
# Install XPK in virtual environment using pip
126
+
pip install xpk
114
127
```
115
128
116
-
If you are running XPK by cloning GitHub repository, first run the
117
-
following commands to begin using XPK commands:
129
+
## Installation from source
130
+
131
+
To install XPK from source, first install required tools mentioned in [prerequisites](#prerequisites) and [additional prerequisites](#additional-prerequisites-when-installing-from-source). Afterwards you can install XPK from source using `make`
118
132
119
133
```shell
134
+
# Clone the XPK repository
120
135
git clone https://github.com/google/xpk.git
121
136
cd xpk
122
-
# Install required dependencies with make
137
+
138
+
# Install required dependencies and build XPK with make
123
139
make install &&export PATH=$PATH:$PWD/bin
124
140
```
125
141
126
-
If you want to have installed dependecies persist in your PATH please run:
127
-
`echo $PWD/bin` and add its value to `PATH` in .bashrc or .zshrc
128
-
129
-
If you see an error saying: `This environment is externally managed`, please use a virtual environment.
142
+
If you want the dependecies to be available in your PATH please run: `echo $PWD/bin` and add its value to `PATH` in .bashrc or .zshrc file.
130
143
131
-
Example:
144
+
If you see an error saying: `This environment is externally managed`, please use a virtual environment. For example:
132
145
133
146
```shell
134
-
## One time step of creating the venv
135
-
VENV_DIR=~/venvp3
136
-
python3 -m venv $VENV_DIR
137
-
## Enter your venv.
138
-
source$VENV_DIR/bin/activate
139
-
## Clone the repository and installing dependencies.
140
-
git clone https://github.com/google/xpk.git
141
-
cd xpk
142
-
# Install required dependencies with make
143
-
make install &&export PATH=$PATH:$PWD/bin
147
+
# One time step of creating the virtual environment
148
+
VENV_DIR=~/venvp3
149
+
python3 -m venv $VENV_DIR
150
+
151
+
# Activate your virtual environment
152
+
source$VENV_DIR/bin/activate
153
+
154
+
# Clone the XPK repository
155
+
git clone https://github.com/google/xpk.git
156
+
cd xpk
157
+
158
+
# Install required dependencies and build XPK with make
0 commit comments