xpk 0.15.0__tar.gz → 0.16.1__tar.gz

xpk-0.16.1/.dockerignore

@@ -0,0 +1,142 @@
+# editor and IDE paraphernalia
+.idea/
+
+*__pycache__*
+tmp/
+.pytype
+.mypy_cache
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+bin/
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# DS_Store files
+**/.DS_Store
+
+# XPK/Cluster Toolkit working directory
+xpkclusters/*

xpk-0.16.1/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @scaliby @jamOne- @SikaGrr @FIoannides @stony-tark

xpk-0.16.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+# Description
+<!--
+Describe your change. 
+What does it introduce?
+Why do we need it?
+If you are releasing a feature, have you updated documentation?
+-->
+
+# Issue
+<!--
+Is there any related issue this change is trying to fix?
+-->
+
+# Testing
+<!--
+Have you performed any manual testing on your change?
+Have you verified use cases affected by goldens?
+-->

xpk-0.16.1/.github/actions/install-kjob/action.yml

@@ -0,0 +1,35 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+
+name: "Install kjob"
+description: "Installs kjob"
+
+inputs:
+  version:
+    description: "The version to install"
+    required: false
+    default: "0.1.0"
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/download-artifact@v4
+      with:
+        name: kjob-artifact
+    - name: Set permissions
+      shell: bash
+      run: chmod +x kubectl-kjob
+    - name: Move binary
+      shell: bash
+      run: mv ./kubectl-kjob /usr/local/bin/kubectl-kjob

xpk-0.16.1/.github/actions/install-kueue/action.yml

@@ -0,0 +1,32 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+
+name: "Install kueue"
+description: "Installs kueue"
+
+inputs:
+  version:
+    description: "The version to install"
+    required: false
+    default: "0.14.3"
+
+runs:
+  using: composite
+  steps:
+    - name: Install kubectl-kueue
+      shell: bash
+      run: |
+        curl -Lo ./kubectl-kueue https://github.com/kubernetes-sigs/kueue/releases/download/v${{inputs.version}}/kubectl-kueue-linux-amd64
+        chmod +x ./kubectl-kueue
+        mv ./kubectl-kueue /usr/local/bin/kubectl-kueue

xpk-0.16.1/.github/actions/setup-test-env/action.yml

@@ -0,0 +1,53 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+
+name: "Setup test environment"
+description: "Sets up integration test environment"
+
+inputs:
+  credentials_json:
+    description: "GCP Service Account Key"
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+    - uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Set permissions
+      run: chmod +x ./backoff_retry.sh
+      shell: bash
+    - uses: "google-github-actions/auth@v2"
+      with:
+        credentials_json: "${{ inputs.credentials_json }}"
+    - uses: google-github-actions/setup-gcloud@v2
+      with:
+        version: ">= 363.0.0"
+        install_components: "beta,gke-gcloud-auth-plugin"
+    - name: Authenticate Docker
+      run: gcloud auth configure-docker --quiet
+      shell: bash
+    - uses: ./.github/actions/install-kueue
+    - uses: ./.github/actions/install-kjob
+    - name: Install XPK
+      run: pip install dist/xpk-*.whl
+      shell: bash
+    - name: Install expect package
+      run: sudo apt-get install expect
+      shell: bash

xpk-0.16.1/.github/release.yaml

@@ -0,0 +1,25 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+# For more info, see:
+# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuration-options
+
+
+changelog:
+  categories:
+  - title: New Features
+    labels: [release-features]
+  - title: Improvments
+    labels: [release-improvments]
+  - title: Bug fixes
+    labels: [release-bugfix]

xpk-0.16.1/.github/workflows/README.md

@@ -0,0 +1,30 @@
+<!--
+ Copyright 2024 Google LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+
+# Integration Test Workflows
+The following tests are currently implemented through Github Actions:
+* Create an XPK Cluster with zero node pools
+* Delete the cluster created
+* Create a Private XPK Cluster with 2x v4-8 nodepools
+* Delete the cluster created
+* Create an XPK Cluster with 2x v4-8 nodepools
+* Delete the cluster created
+
+## Nightly Tests:
+A cron job is scheduled to run at 12AM PST daily. The details of the jobs run are in `xpk/.github/workflows/nightly_tests.yaml`
+
+## Integration Tests:
+Integration tests are run on a push to the `main` branch and on an approved PR. The details of the jobs run are in `xpk/.github/workflows/build_tests.yaml`

xpk-0.16.1/.github/workflows/build_tests.yaml

@@ -0,0 +1,71 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+
+name: Build Tests
+
+on:
+  pull_request:
+  merge_group:
+    types: [checks_requested]
+
+permissions:
+  contents: read
+
+jobs:
+  install-dependencies:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: google-github-actions/setup-gcloud@v2
+      with:
+        version: '>= 363.0.0'
+        install_components: 'beta, gke-gcloud-auth-plugin'
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Check if cache exists
+      id: check-cache
+      uses: actions/cache@v3
+      with:
+        path: |
+          usr/local/bin/
+          ~/.cache/pip
+          ${{env.pythonLocation}}
+        key: xpk-deps-${{ matrix.python-version }}-${{github.run_id}}-${{github.run_attempt}}
+        lookup-only: true
+    - name: install dependencies
+      if : steps.check-cache.outputs.cache-hit != 'true'
+      run: make install-dev && cp ./bin/kubectl-kueue /usr/local/bin/kubectl-kueue && cp ./bin/kubectl-kjob /usr/local/bin/kubectl-kjob
+    - name: Cache dependencies
+      if : steps.check-cache.outputs.cache-hit != 'true'
+      uses: actions/cache/save@v3
+      with:
+        path: |
+          /usr/local/bin/kubectl-kueue
+          /usr/local/bin/kubectl-kjob
+          ~/.cache/pip
+          ${{env.pythonLocation}}
+        key: xpk-deps-${{ matrix.python-version }}-${{github.run_id}}-${{github.run_attempt}}
+  linter:
+    needs: [install-dependencies]
+    uses: ./.github/workflows/reusable_lint_and_format.yml
+  verify-goldens:
+    needs: [install-dependencies]
+    uses: ./.github/workflows/reusable_goldens.yaml
+  run-unit-tests:
+    needs: [install-dependencies]
+    uses: ./.github/workflows/reusable_unit_tests.yaml

xpk-0.16.1/.github/workflows/build_wheels.yaml

@@ -0,0 +1,71 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+
+# Note: Name of this file needs to be build_wheels.yaml as this is the value that has been specified in pypi
+# If you want to change the name of this file, please update pypi publisher:
+# https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+
+name: PyPi releases
+
+permissions:
+  contents: read
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  build_wheel:
+    uses: ./.github/workflows/reusable_build_wheel.yaml
+  approval:
+    name: Wait for approval
+    needs: [build_wheel]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    steps:
+      - run: echo "Deployment approved!"
+  github_release:
+    name: Create GitHub release
+    runs-on: ubuntu-latest
+    needs: [approval]
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Create Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release create ${{ github.ref_name }} --generate-notes --draft=false --prerelease=false
+  publish-to-pypi:
+    name: Publish Python distribution to PyPI
+    needs: [approval]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    environment:
+      # We should configure trusted publishing as specified here:
+      # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#configuring-trusted-publishing
+      name: pypi
+      url: https://pypi.org/p/xpk # Replace <package-name> with your PyPI project name
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

xpk-0.16.1/.github/workflows/cleanup.yaml

@@ -0,0 +1,45 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+
+name: Cleanup caches by a branch
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cleanup
+        run: |
+          echo "Fetching list of cache key"
+          cacheKeysForPR=$(gh cache list --ref $BRANCH --limit 100 --json id --jq '.[].id')
+
+          ## Setting this to not fail the workflow while deleting cache keys.
+          set +e
+          echo "Deleting caches..."
+          for cacheKey in $cacheKeysForPR
+          do
+              gh cache delete $cacheKey
+          done
+          echo "Done"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_REPO: ${{ github.repository }}
+          BRANCH: refs/pull/${{ github.event.pull_request.number }}/merge