xpk 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

xpk/parser/core.py

@@ -0,0 +1,109 @@
+"""
+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.
+"""
+
+import argparse
+
+from ..utils.console import xpk_print
+from .cluster import set_cluster_parser
+from .inspector import set_inspector_parser
+from .workload import set_workload_parsers
+from .batch import set_batch_parser
+from .job import set_job_parser
+from .info import set_info_parser
+from .kind import set_kind_parser
+from .shell import set_shell_parser
+from .version import set_version_parser
+
+
+def set_parser(parser: argparse.ArgumentParser):
+  xpk_subcommands = parser.add_subparsers(
+      title="xpk subcommands", dest="xpk_subcommands", help="Top level commands"
+  )
+  workload_parser = xpk_subcommands.add_parser(
+      "workload", help="Commands around workload management."
+  )
+  cluster_parser = xpk_subcommands.add_parser(
+      "cluster",
+      help="Commands around creating, deleting, and viewing clusters.",
+  )
+  inspector_parser = xpk_subcommands.add_parser(
+      "inspector",
+      help="Commands around investigating workload, and Kueue failures.",
+  )
+  info_parser = xpk_subcommands.add_parser(
+      "info",
+      help="Commands around listing kueue clusterqueues and localqueues.",
+  )
+  batch_parser = xpk_subcommands.add_parser(
+      "batch",
+      help="commands around running batch job",
+  )
+  job_parser = xpk_subcommands.add_parser(
+      "job", help="commands around listing, cancelling and investigating jobs"
+  )
+  kind_parser = xpk_subcommands.add_parser(
+      "kind",
+      help="commands around Kind cluster management",
+  )
+  shell_parser = xpk_subcommands.add_parser(
+      "shell", help="Commands around configuring and using interactive shell."
+  )
+  version_parser = xpk_subcommands.add_parser(
+      "version", help="Command to get xpk version"
+  )
+
+  def default_subcommand_function(
+      _args,
+  ) -> int:  # args is unused, so pylint: disable=invalid-name
+    """Default subcommand function.
+
+    Args:
+      _args: user provided arguments for running the command.
+
+    Returns:
+      0 if successful and 1 otherwise.
+    """
+    xpk_print("Welcome to XPK! See below for overall commands:", flush=True)
+    parser.print_help()
+    cluster_parser.print_help()
+    workload_parser.print_help()
+    batch_parser.print_help()
+    info_parser.print_help()
+    job_parser.print_help()
+    shell_parser.print_help()
+    version_parser.print_help()
+    kind_parser.print_help()
+
+    return 0
+
+  parser.set_defaults(func=default_subcommand_function)
+  workload_parser.set_defaults(func=default_subcommand_function)
+  cluster_parser.set_defaults(func=default_subcommand_function)
+  batch_parser.set_defaults(func=default_subcommand_function)
+  info_parser.set_defaults(func=default_subcommand_function)
+  job_parser.set_defaults(func=default_subcommand_function)
+  kind_parser.set_defaults(func=default_subcommand_function)
+  shell_parser.set_defaults(func=default_subcommand_function)
+  version_parser.set_defaults(func=default_subcommand_function)
+  set_workload_parsers(workload_parser=workload_parser)
+  set_cluster_parser(cluster_parser=cluster_parser)
+  set_inspector_parser(inspector_parser=inspector_parser)
+  set_batch_parser(batch_parser=batch_parser)
+  set_info_parser(info_parser=info_parser)
+  set_job_parser(job_parser=job_parser)
+  set_kind_parser(kind_parser=kind_parser)
+  set_shell_parser(shell_parser=shell_parser)
+  set_version_parser(version_parser=version_parser)

xpk/parser/info.py

@@ -0,0 +1,63 @@
+"""
+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 ..commands.info import info
+from .common import add_shared_arguments
+import argparse
+
+
+def set_info_parser(info_parser: argparse.ArgumentParser) -> None:
+  info_required_arguments = info_parser.add_argument_group(
+      'Required Arguments', 'Arguments required for info.'
+  )
+  info_optional_arguments = info_parser.add_argument_group(
+      'Optional Arguments', 'Arguments optional for info.'
+  )
+
+  info_required_arguments.add_argument(
+      '--cluster',
+      type=str,
+      default=None,
+      help='Cluster to which command applies.',
+      required=True,
+  )
+
+  info_optional_arguments.add_argument(
+      '--namespace',
+      type=str,
+      default='',
+      help='Namespace to which resources and queues belong',
+  )
+
+  queues_flitering_group = (
+      info_optional_arguments.add_mutually_exclusive_group()
+  )
+
+  queues_flitering_group.add_argument(
+      '--clusterqueue',
+      action='store_true',
+      default=None,
+      help='Show only clusterqueues resources and usage',
+  )
+
+  queues_flitering_group.add_argument(
+      '--localqueue',
+      action='store_true',
+      default=None,
+      help='Show only localqueues resources and usage',
+  )
+  add_shared_arguments(info_optional_arguments)
+  info_parser.set_defaults(func=info)

xpk/parser/inspector.py

@@ -0,0 +1,65 @@
+"""
+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 ..commands.inspector import inspector
+from .validators import workload_name_type
+from .common import add_shared_arguments
+
+
+def set_inspector_parser(inspector_parser):
+  inspector_parser.add_subparsers(
+      title='inspector subcommands',
+      dest='xpk_inspector_subcommands',
+      help='Investigate workload, and Kueue failures.',
+  )
+
+  inspector_parser_required_arguments = inspector_parser.add_argument_group(
+      'inspector Built-in Arguments', 'Arguments required for `inspector`.'
+  )
+  inspector_parser_optional_arguments = inspector_parser.add_argument_group(
+      'Optional Arguments', 'Arguments optional for `inspector`.'
+  )
+
+  ### "inspector" Required arguments
+
+  inspector_parser_required_arguments.add_argument(
+      '--cluster',
+      type=str,
+      default=None,
+      help='The name of the cluster to investigate.',
+      required=True,
+  )
+
+  ### "inspector" Optional Arguments
+  add_shared_arguments(inspector_parser_optional_arguments)
+
+  inspector_parser_optional_arguments.add_argument(
+      '--workload',
+      type=workload_name_type,
+      default=None,
+      help='The name of the workload to investigate.',
+  )
+
+  inspector_parser_optional_arguments.add_argument(
+      '--print-to-terminal',
+      action='store_true',
+      help=(
+          'Prints inspector output to terminal. A user can always look at the'
+          ' returned file.'
+      ),
+  )
+
+  inspector_parser.set_defaults(func=inspector)

xpk/parser/job.py

@@ -0,0 +1,126 @@
+"""
+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.
+"""
+
+import argparse
+from ..commands.job import job_info, job_list, job_cancel
+
+from .common import add_shared_arguments
+
+
+def set_job_parser(job_parser: argparse.ArgumentParser):
+  job_subcommands = job_parser.add_subparsers(
+      title='job subcommands',
+      dest='xpk_job_subcommands',
+      help=(
+          'These are commands related to job management. Look at help for'
+          ' specific subcommands for more details.'
+      ),
+  )
+  set_job_info_parser(
+      job_info_parser=job_subcommands.add_parser(
+          'info', help='Show information about specified job.'
+      )
+  )
+  set_job_list_parser(
+      job_list_parser=job_subcommands.add_parser('ls', help='List jobs.')
+  )
+  set_job_cancel_parser(
+      job_cancel_parser=job_subcommands.add_parser(
+          'cancel', help='Cancel job execution.'
+      )
+  )
+
+
+def set_job_info_parser(job_info_parser: argparse.ArgumentParser):
+  job_info_parser_required_arguments = job_info_parser.add_argument_group(
+      'Required arguments',
+      'The basic information required to identify the job.',
+  )
+  job_info_parser_required_arguments.add_argument(
+      'name',
+      type=str,
+      default=None,
+      help='Name of the job.',
+  )
+  job_info_parser.set_defaults(func=job_info)
+  add_shared_arguments(job_info_parser)
+
+
+def set_job_list_parser(job_list_parser: argparse.ArgumentParser):
+  job_list_required_arguments = job_list_parser.add_argument_group(
+      'Required Arguments',
+      'Arguments required for job list.',
+  )
+  job_list_optional_arguments = job_list_parser.add_argument_group(
+      'Optional Arguments', 'Arguments optional for job list.'
+  )
+
+  ### Required arguments
+  job_list_required_arguments.add_argument(
+      '--cluster',
+      type=str,
+      default=None,
+      help='The name of the cluster to list jobs on.',
+      required=True,
+  )
+
+  job_list_optional_arguments.add_argument(
+      '--kind-cluster',
+      type=bool,
+      action=argparse.BooleanOptionalAction,
+      default=False,
+      help='Apply command to a local test cluster.',
+  )
+
+  job_list_parser.set_defaults(func=job_list)
+  add_shared_arguments(job_list_optional_arguments)
+
+
+def set_job_cancel_parser(job_cancel_parser: argparse.ArgumentParser):
+  job_cancel_required_arguments = job_cancel_parser.add_argument_group(
+      'Required Arguments',
+      'Arguments required for job cancel.',
+  )
+  job_cancel_optional_arguments = job_cancel_parser.add_argument_group(
+      'Optional Arguments', 'Arguments optional for job cancel.'
+  )
+
+  job_cancel_required_arguments.add_argument(
+      'name',
+      type=str,
+      default=None,
+      help='The name of the job to be cancelled.',
+      nargs='+',
+  )
+
+  job_cancel_required_arguments.add_argument(
+      '--cluster',
+      type=str,
+      default=None,
+      help='The name of the cluster to delete the job on.',
+      required=True,
+  )
+
+  job_cancel_optional_arguments.add_argument(
+      '--kind-cluster',
+      type=bool,
+      action=argparse.BooleanOptionalAction,
+      default=False,
+      help='Apply command to a local test cluster.',
+  )
+
+  job_cancel_parser.set_defaults(func=job_cancel)
+  add_shared_arguments(job_cancel_optional_arguments)

xpk/parser/kind.py

@@ -0,0 +1,94 @@
+"""
+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 ..commands.kind import (
+    cluster_create,
+    cluster_delete,
+    cluster_list,
+)
+from .common import add_global_arguments
+
+
+def set_kind_parser(kind_parser):
+  cluster_subcommands = kind_parser.add_subparsers(
+      title='kind subcommands',
+      dest='xpk_kind_subcommands',
+      help=(
+          'These are commands related to kind management. Look at help for'
+          ' specific subcommands for more details.'
+      ),
+  )
+
+  ### "cluster create" command parser ###
+  cluster_create_parser = cluster_subcommands.add_parser(
+      'create', help='Create local clusters.'
+  )
+
+  ### Optional Arguments
+  cluster_create_parser.add_argument(
+      '--cluster',
+      type=str,
+      default='kind',
+      help=(
+          'The name of the cluster. Will be used as the prefix for internal'
+          ' objects in the cluster.'
+      ),
+      required=False,
+  )
+
+  cluster_create_parser.add_argument(
+      '--k8s-version',
+      type=str,
+      default='',
+      help='The Kubernetes version of the cluster.',
+      required=False,
+  )
+
+  add_global_arguments(cluster_create_parser)
+  cluster_create_parser.set_defaults(func=cluster_create)
+
+  ### "cluster delete" command parser ###
+  cluster_delete_parser = cluster_subcommands.add_parser(
+      'delete',
+      help='Delete cloud clusters.',
+  )
+
+  cluster_delete_required_arguments = cluster_delete_parser.add_argument_group(
+      'Required Arguments',
+      'Arguments required for cluster delete.',
+  )
+
+  ### Required arguments
+  cluster_delete_required_arguments.add_argument(
+      '--cluster',
+      type=str,
+      default=None,
+      help='The name of the cluster to be deleted.',
+      required=True,
+  )
+
+  ### Optional Arguments
+  add_global_arguments(cluster_delete_parser)
+  cluster_delete_parser.set_defaults(func=cluster_delete)
+
+  # "cluster list" command parser.
+  cluster_list_parser = cluster_subcommands.add_parser(
+      'list', help='List cloud clusters.'
+  )
+
+  ### Optional Arguments
+  add_global_arguments(cluster_list_parser)
+  cluster_list_parser.set_defaults(func=cluster_list)

xpk/parser/shell.py

@@ -0,0 +1,50 @@
+"""
+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 ..commands.shell import shell, shell_stop
+from .common import add_shared_arguments
+import argparse
+
+
+def set_shell_parser(shell_parser: argparse.ArgumentParser) -> None:
+  shell_optional_arguments = shell_parser.add_argument_group(
+      'Optional Arguments', 'Arguments optional for shell.'
+  )
+  add_shared_arguments(shell_optional_arguments)
+  shell_parser.set_defaults(func=shell)
+
+  shell_subcommands = shell_parser.add_subparsers(
+      title='shell subcommands',
+      dest='xpk_shell_subcommands',
+      help=(
+          'These are commands related to interactive shell. Look at help for'
+          ' specific subcommands for more details.'
+      ),
+  )
+
+  set_shell_stop_parser(
+      shell_stop_parser=shell_subcommands.add_parser(
+          name='stop', help='Stop the running shell.'
+      )
+  )
+
+
+def set_shell_stop_parser(shell_stop_parser: argparse.ArgumentParser):
+  shell_stop_optional_arguments = shell_stop_parser.add_argument_group(
+      'Optional Arguments', 'Arguments optional for shell stop.'
+  )
+  add_shared_arguments(shell_stop_optional_arguments)
+  shell_stop_parser.set_defaults(func=shell_stop)

xpk/parser/validators.py

@@ -0,0 +1,39 @@
+"""
+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.
+"""
+
+import argparse
+import os
+import re
+
+
+def workload_name_type(value, pat=re.compile(r'[a-z]([-a-z0-9]*[a-z0-9])?')):
+  """Validate that the workload name matches the expected pattern."""
+  match = pat.fullmatch(value)
+  if not match or len(match.group(0)) > 40:
+    raise argparse.ArgumentTypeError(
+        'Workload name must be less than 40 characters and match the pattern'
+        f' `{pat.pattern}`'
+        f' Name is currently {value}'
+    )
+  return value
+
+
+def directory_path_type(value):
+  if not os.path.isdir(value):
+    raise argparse.ArgumentTypeError(
+        f'Directory path is invalid. User provided path was {value}'
+    )
+  return value

xpk/parser/version.py

@@ -0,0 +1,23 @@
+"""
+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.
+"""
+
+from ..commands.version import (version)
+from .common import add_shared_arguments
+
+
+def set_version_parser(version_parser):
+  add_shared_arguments(version_parser)
+  version_parser.set_defaults(func=version)