Merge branch 'main' into ppawl-comment-flaky

.github/workflows/build_tests.yaml

@@ -37,7 +37,8 @@ env:
   CLUSTER_ARGUMENTS: "--network=${{secrets.NETWORK_NAME}} --subnetwork=${{secrets.SUBNETWORK_NAME}} --maintenance-window=23:50"
   RUN_ID: "pr-${{ github.event.number }}"
   PROJECT_ID: ${{secrets.PROJECT_NAME}}
-  DEPLOYMENT_NAME: "xpk-ctk-int"
+  A3_MEGA_TEST_CLUSTER_NAME: "xpk-ctk-int"
+  GKE_ML_TEST_CLUSTER_NAME: "xpk-gke-ml"
   ZONE: us-central2-a
   REGION: us-central2
 

.gitignore

@@ -136,3 +136,6 @@ dmypy.json
 
 # DS_Store files
 **/.DS_Store
+
+# XPK/Cluster Toolkit working directory
+xpkclusters/*

Makefile

@@ -15,7 +15,7 @@ PROJECT_DIR := $(realpath $(shell dirname $(firstword $(MAKEFILE_LIST))))
 BIN_PATH=$(PROJECT_DIR)/bin
 
 .PHONY: install
-install: check-python check-gcloud install-kueuectl install-kjob pip-install
+install: check-python check-go check-gcloud install-kueuectl install-kjob pip-install
 
 .PHONY: install-dev
 install-dev: check-python check-gcloud mkdir-bin install-kubectl install-kueuectl install-kjob pip-install install-pytest
@@ -56,6 +56,10 @@ install-kueuectl: install-kubectl
 	curl -Lo $(BIN_PATH)/kubectl-kueue $(KUEUECTL_URL)
 	chmod +x $(BIN_PATH)/kubectl-kueue
 
+.PHONY: check-go
+check-go:
+	go version || (echo "go not installed, use this link to install: https://cloud.google.com/sdk/docs/install" && exit 1)
+
 .PHONY: check-gcloud
 check-gcloud:
 	gcloud version || (echo "gcloud not installed, use this link to install: https://cloud.google.com/sdk/docs/install" && exit 1)

README.md

@@ -65,14 +65,25 @@ and the following CPU types:
 
 # Prerequisites
 
-xpk uses many tool to provide all neccessary functionalities. User must install following tools:
+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))
+- go ([installation instructions](https://go.dev/doc/install))
+- 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))
+- make - please run below command.
+```shell
+#sudo may be required
+apt 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:
 

src/xpk/blueprints/a3mega/kueue-xpk-configuration.yaml.tftpl

@@ -1,12 +1,23 @@
+apiVersion: kueue.x-k8s.io/v1alpha1
+kind: Topology
+metadata:
+  name: "gke-default"
+spec:
+  levels:
+  - nodeLabel: "cloud.google.com/gce-topology-block"
+  - nodeLabel: "cloud.google.com/gce-topology-subblock"
+  - nodeLabel: "cloud.google.com/gce-topology-host"
+  - nodeLabel: "kubernetes.io/hostname"
+---
 apiVersion: kueue.x-k8s.io/v1beta1
 kind: ResourceFlavor
 metadata:
   name: 1xh100-mega-80gb-8
 spec:
   nodeLabels:
     cloud.google.com/gke-accelerator: nvidia-h100-mega-80gb
+  topologyName: "gke-default"
 ---
-
 apiVersion: kueue.x-k8s.io/v1beta1
 kind: ClusterQueue
 metadata:

src/xpk/commands/cluster.py

@@ -61,6 +61,7 @@
 from ..core.workload import get_workload_list
 from ..utils.file import write_tmp_file
 from ..utils.console import xpk_exit, xpk_print
+from . import cluster_gcluster
 
 
 def cluster_create(args) -> None:
@@ -81,6 +82,14 @@ def cluster_create(args) -> None:
   xpk_print(f'Starting cluster create for cluster {args.cluster}:', flush=True)
   add_zone_and_project(args)
 
+  if system.device_type in cluster_gcluster.supported_device_types:
+    xpk_print(
+        'Creating the cluster using Cluster Toolkit. Machine Type:'
+        f' {system.gce_machine_type} ...'
+    )
+    cluster_gcluster.cluster_create(args)
+    xpk_exit(0)
+
   return_code, gke_server_config = get_gke_server_config(args)
   if return_code != 0:
     xpk_exit(return_code)
@@ -232,6 +241,12 @@ def cluster_delete(args) -> None:
   """
   xpk_print(f'Starting cluster delete for cluster: {args.cluster}', flush=True)
   add_zone_and_project(args)
+
+  if cluster_gcluster.created_by_gcluster(args):
+    xpk_print(f'Deleting {args.cluster} cluster using Cluster Toolkit...')
+    cluster_gcluster.cluster_delete(args)
+    xpk_exit(0)
+
   run_gke_cluster_delete_command_code = run_gke_cluster_delete_command(args)
   if run_gke_cluster_delete_command_code != 0:
     xpk_exit(run_gke_cluster_delete_command_code)

src/xpk/commands/cluster_gcluster.py

@@ -0,0 +1,183 @@
+"""
+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.
+"""
+
+from ..core.blueprint.blueprint_generator import BlueprintGenerator, BlueprintGeneratorOutput, supported_device_types, a3mega_device_type
+from ..core.docker_manager import DockerManager
+from ..core.gcluster_manager import GclusterManager
+from ..core.core import zone_to_region
+from ..utils.console import xpk_exit, xpk_print
+from ..utils.network import all_IPs_cidr
+from ..utils.file import ensure_directory_exists
+from ..utils.objects import hash_string
+import os
+
+blueprints_path = os.path.abspath('xpkclusters/blueprints')
+gcluster_working_dir = os.path.abspath('xpkclusters/gcluster-out')
+gcloud_cfg_path = os.path.expanduser('~/.config/gcloud')
+
+
+def cluster_create(args) -> None:
+  """Function around cluster creation using Cluster toolkit.
+
+  Args:
+    args: user provided arguments for running the command.
+
+  Returns:
+    0 if successful and 1 otherwise.
+  """
+  check_gcloud_authenticated()
+  prepare_directories()
+  gcm = prepare_gcluster_manager()
+  region = zone_to_region(args.zone)
+
+  # unique_name uses shortened hash string, so still name collision is possible
+  unique_name = get_unique_name(args.project, region, args.cluster)
+  # prefix is to prevent name collisions for blueprints and also deployments by storing them in prefix directory. Ex.: blueprints/{prefix}/cluster_name_hash
+  prefix = get_prefix_path(args.project, region)
+
+  bp = generate_blueprint(blueprint_name=unique_name, args=args, prefix=prefix)
+
+  # staging: sending the blueprint file(s) to gcluster's working directory
+  bp_staged_path = gcm.stage_files(
+      blueprint_file=bp.blueprint_file,
+      blueprint_dependencies=bp.blueprint_dependencies,
+      prefix=prefix,
+  )
+  gcm.deploy(
+      blueprint_path=bp_staged_path,
+      deployment_name=unique_name,
+      prefix=prefix,
+  )
+
+  xpk_exit(0)
+
+
+def cluster_delete(args) -> None:
+  """Function around cluster delete for the clusters created by Cluster toolkit.
+
+  Args:
+    args: user provided arguments for running the command.
+
+  Returns:
+    0 if successful and 1 otherwise.
+  """
+  check_gcloud_authenticated()
+  prepare_directories()
+  gcm = prepare_gcluster_manager()
+  region = zone_to_region(args.zone)
+
+  # unique_name uses shortened hash string, so still name collision is possible
+  unique_name = get_unique_name(args.project, region, args.cluster)
+  # prefix is to prevent name collisions for blueprints and also deployments by storing them in prefix directory. Ex.: blueprints/{prefix}/cluster_name_hash
+  prefix_path = get_prefix_path(args.project, region)
+
+  gcm.destroy_deployment(deployment_name=unique_name, prefix=prefix_path)
+
+  xpk_exit(0)
+
+
+def created_by_gcluster(args) -> bool:
+  prepare_directories()
+  unique_name = get_unique_name(
+      args.project, zone_to_region(args.zone), args.cluster
+  )
+  bpg = prepare_blueprint_generator()
+  return bpg.blueprint_exists(unique_name)
+
+
+def get_unique_name(project_id, region, cluster_name):
+  unique_string_hash = hash_string(
+      input_string=f'{project_id}-{region}-{cluster_name}'.lower(), length=5
+  )
+  return f'{cluster_name}-{unique_string_hash}'
+
+
+def get_prefix_path(project_id, region):
+  return f'{project_id}-{region}'.lower()
+
+
+def prepare_directories() -> None:
+  ensure_directory_exists(blueprints_path)
+  ensure_directory_exists(gcluster_working_dir)
+
+
+def check_gcloud_authenticated():
+  if not os.path.exists(gcloud_cfg_path):
+    xpk_print(
+        'Failed to find gcloud credential directory.'
+        f' {gcloud_cfg_path} {blueprints_path} {gcluster_working_dir}'
+    )
+    xpk_print(
+        'Please authenticate to gcloud ("gcloud auth application-default'
+        ' login") and then run your command.'
+    )
+    xpk_exit(1)
+
+
+def prepare_gcluster_manager() -> GclusterManager:
+  dm = DockerManager(
+      working_dir=gcluster_working_dir, gcloud_cfg_path=gcloud_cfg_path
+  )
+  dm.initialize()
+  return GclusterManager(gcluster_command_runner=dm)
+
+
+def prepare_blueprint_generator() -> BlueprintGenerator:
+  return BlueprintGenerator(storage_path=blueprints_path)
+
+
+def generate_blueprint(
+    blueprint_name, args, prefix=None
+) -> BlueprintGeneratorOutput:
+  validate_consumption_args(args)
+  bpg = prepare_blueprint_generator()
+
+  if args.device_type in supported_device_types:
+    if args.device_type == a3mega_device_type:
+      num_nodes = args.num_nodes if not args.num_nodes is None else 2
+      return bpg.generate_a3_mega_blueprint(
+          blueprint_name=blueprint_name,
+          prefix=prefix,
+          cluster_name=args.cluster,
+          region=zone_to_region(args.zone),
+          project_id=args.project,
+          zone=args.zone,
+          auth_cidr=all_IPs_cidr,
+          num_nodes=num_nodes,
+          autoscaling_total_min_nodes=num_nodes,
+          reservation=args.reservation if args.reservation else None,
+          spot=args.spot if args.spot else False,
+          system_node_pool_machine_type=args.default_pool_cpu_machine_type,
+          system_node_pool_min_node_count=args.default_pool_cpu_num_nodes,
+      )
+  return None
+
+
+def validate_consumption_args(args):
+  args_set = []
+  if not args.reservation is None:
+    args_set.append('--reservation')
+  if not args.spot is None and args.spot:
+    args_set.append('--spot')
+  if not args.on_demand is None and args.on_demand:
+    args_set.append('--on-demand')
+
+  if len(args_set) > 1:
+    xpk_print(
+        f"Error: only one of {' or '.join(args_set)} can be set at the same"
+        ' time.'
+    )
+    xpk_exit(1)