Skip to content

Commit

Permalink
Update Readme and makefile to smooth installation flow (#312)
Browse files Browse the repository at this point in the history
* Enhance readme and makefile with installation steps
Signed-off-by: Piotr Pawłowski <ppawl@google.com>

---------

Signed-off-by: Piotr Pawłowski <ppawl@google.com>
  • Loading branch information
pawloch00 authored Jan 9, 2025
1 parent bad83f7 commit 06022b9
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/build_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: '3.10'
- uses: google-github-actions/setup-gcloud@v2
with:
version: '>= 363.0.0'
install_components: 'beta, gke-gcloud-auth-plugin'
- name: Install dependencies
run : make install-dev
- name: Run unit tests
Expand All @@ -76,7 +80,7 @@ jobs:
- uses: google-github-actions/setup-gcloud@v2
with:
version: '>= 363.0.0'
install_components: 'beta,gke-gcloud-auth-plugin'
install_components: 'beta,gke-gcloud-auth-plugin, gke-gcloud-auth-plugin'
- name: Verify gcp setup
run: gcloud info
- name: Install dependencies
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ mkdir-bin:

.PHONY: install-kubectl
install-kubectl: mkdir-bin
curl -Lo $(BIN_PATH)/kubectl $(KUBECTL_URL)
chmod +x $(BIN_PATH)/kubectl
sudo apt-get install kubectl
gcloud components install gke-gcloud-auth-plugin

.PHONY: install-kueuectl
install-kueuectl: install-kubectl
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,24 @@ and the following CPU types:
Following tools must be installed:

- python >= 3.10 (download from [here](https://www.python.org/downloads/))
- gcloud (install from [here](https://cloud.google.com/sdk/gcloud#download_and_install_the))
- docker ([installation instruction](https://docs.docker.com/engine/install/))
- pip ([installation instruction](https://pip.pypa.io/en/stable/installation/))
- python venv ([installation instruction](https://virtualenv.pypa.io/en/latest/installation.html))
(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))
- gcloud (install from [here](https://cloud.google.com/sdk/gcloud#download_and_install_the))
- Run `gcloud init`
- [Authenticate](https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login) to Google Cloud
- docker ([installation instruction](https://docs.docker.com/engine/install/))
- Run `gcloud auth configure-docker` to ensure images can be uploaded to registry
- make - please run below command.
```shell
#sudo may be required
apt install make
# sudo may be required
apt-get -y install make
```
In addition, below dependencies will be installed with `make install` command:
- kubectl (install from [here](https://kubernetes.io/docs/tasks/tools/))
- kueuectl (install from [here](https://kueue.sigs.k8s.io/docs/reference/kubectl-kueue/installation/))
- kjob (installation instructions [here](https://github.com/kubernetes-sigs/kjob/blob/main/docs/installation.md))


# Installation
To install xpk, run the following command and install additional tools, mentioned in [prerequisites](#prerequisites). [Makefile](https://github.com/AI-Hypercomputer/xpk/blob/main/Makefile) provides a way to install all neccessary tools:

Expand Down

0 comments on commit 06022b9

Please sign in to comment.