xpk 0.5.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

xpk/commands/storage.py

@@ -0,0 +1,267 @@
+"""
+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 argparse import Namespace
+
+from kubernetes import client as k8s_client
+from kubernetes.client import ApiClient
+from kubernetes.client.rest import ApiException
+
+from ..core import gcsfuse
+from ..core.cluster import (
+    DEFAULT_NAMESPACE,
+    add_zone_and_project,
+    get_cluster_network,
+    setup_k8s_env,
+    update_cluster_with_gcpfilestore_driver_if_necessary,
+    update_cluster_with_gcsfuse_driver_if_necessary,
+    update_cluster_with_workload_identity_if_necessary,
+)
+from ..core.filestore import FilestoreClient, get_storage_class_name
+from ..core.kjob import (
+    KJOB_API_GROUP_NAME,
+    KJOB_API_GROUP_VERSION,
+    KJOB_API_VOLUME_BUNDLE_PLURAL,
+    create_volume_bundle_instance,
+)
+from ..core.storage import (
+    GCP_FILESTORE_TYPE,
+    GCS_FUSE_TYPE,
+    STORAGE_CRD_PLURAL,
+    XPK_API_GROUP_NAME,
+    XPK_API_GROUP_VERSION,
+    Storage,
+    create_storage_crds,
+    get_storage,
+    list_storages,
+    print_storages_for_cluster,
+)
+from ..utils.console import get_user_input, xpk_exit, xpk_print
+from ..utils.kubectl import apply_kubectl_manifest
+
+
+def storage_create(args: Namespace) -> None:
+  add_zone_and_project(args)
+  if args.type == GCP_FILESTORE_TYPE:
+    if args.instance is None:
+      args.instance = args.name
+
+    filestore_client = FilestoreClient(args.zone, args.instance, args.project)
+    filestore_exists = filestore_client.check_instance_exists()
+    if filestore_exists:
+      xpk_print(f"Filestore instance {args.instance} already exists.")
+      xpk_exit(1)
+    filestore_network = get_cluster_network(args)
+    xpk_print(
+        f"Creating Filestore instance {args.instance} in network:"
+        f" {filestore_network}"
+    )
+    filestore_client.create_instance(
+        vol=args.vol, size=args.size, tier=args.tier, network=filestore_network
+    )
+    manifest = filestore_client.manifest(
+        args.name, args.vol, args.access_mode, filestore_network
+    )
+
+    k8s_api_client = setup_k8s_env(args)
+    create_storage_crds(k8s_api_client, args, manifest)
+    create_volume_bundle_instance(
+        k8s_api_client, args.name, manifest, args.readonly, args.mount_point
+    )
+    return_code = update_cluster_with_workload_identity_if_necessary(args)
+    if return_code > 0:
+      xpk_exit(return_code)
+    return_code = update_cluster_with_gcpfilestore_driver_if_necessary(args)
+    if return_code > 0:
+      xpk_exit(return_code)
+    apply_kubectl_manifest(k8s_api_client, manifest)
+
+
+def storage_delete(args: Namespace) -> None:
+  add_zone_and_project(args)
+  k8s_api_client = setup_k8s_env(args)
+  storages = list_storages(k8s_api_client)
+  filestore_client = FilestoreClient(args.zone, args.name, args.project)
+
+  if not filestore_client.check_instance_exists():
+    xpk_print(f"Filestore instance {args.name} does not exist.")
+    xpk_exit(1)
+
+  filestore_instance_name = filestore_client.get_instance_fullname()
+
+  children = [
+      storage
+      for storage in storages
+      if storage.bucket.startswith(filestore_instance_name)
+  ]
+
+  if children and not args.force:
+    detach = get_user_input(
+        "Deleting a filestore storage will destroy your filestore instance and"
+        " all its data in all volumes will be lost. Do you wish to delete the"
+        f" filestore instance {filestore_instance_name}?\n y (yes) / n (no):\n'"
+    )
+    if not detach:
+      xpk_print("Deleting storage canceled.")
+      xpk_exit(0)
+
+  for child in children:
+    delete_storage_resources(k8s_api_client, child)
+
+  filestore_client.delete_filestore_instance()
+
+
+def storage_attach(args: Namespace) -> None:
+  add_zone_and_project(args)
+  if args.type == GCP_FILESTORE_TYPE:
+    if args.instance is None:
+      args.instance = args.name
+
+    filestore_client = FilestoreClient(args.zone, args.instance, args.project)
+
+    filestore_exists = filestore_client.check_instance_exists()
+    if not filestore_exists:
+      xpk_print(f"Filestore instance {args.instance} does not exists.")
+      xpk_exit(1)
+
+    filestore_network = get_cluster_network(args)
+    manifest = filestore_client.manifest(
+        args.name, args.vol, args.access_mode, filestore_network
+    )
+
+  else:  # args.type == GCS_FUSE_TYPE:
+    if args.size is None:
+      xpk_print("--size is required when attaching gcsfuse storage.")
+      xpk_exit(1)
+
+    if args.bucket is None:
+      args.bucket = args.name
+
+    manifest = gcsfuse.manifest(
+        name=args.name, bucket=args.bucket, size=args.size
+    )
+
+  k8s_api_client = setup_k8s_env(args)
+  create_storage_crds(k8s_api_client, args, manifest)
+  create_volume_bundle_instance(
+      k8s_api_client, args.name, manifest, args.readonly, args.mount_point
+  )
+  return_code = update_cluster_with_workload_identity_if_necessary(args)
+  if return_code > 0:
+    xpk_exit(return_code)
+
+  # args.type can have only two values after parsing
+  return_code = (
+      update_cluster_with_gcsfuse_driver_if_necessary(args)
+      if args.type == GCS_FUSE_TYPE
+      else update_cluster_with_gcpfilestore_driver_if_necessary(args)
+  )
+  if return_code > 0:
+    xpk_exit(return_code)
+
+  apply_kubectl_manifest(k8s_api_client, manifest)
+
+
+def storage_list(args: Namespace) -> None:
+  k8s_api_client = setup_k8s_env(args)
+  storages = list_storages(k8s_api_client)
+  print_storages_for_cluster(storages)
+
+
+def storage_detach(args: Namespace) -> None:
+  k8s_api_client = setup_k8s_env(args)
+  storage = get_storage(k8s_api_client, args.name)
+  delete_storage_resources(k8s_api_client, storage)
+
+
+def delete_resource(api_call, resource_name: str, resource_kind: str) -> None:
+  """
+  Deletes a Kubernetes resource and handles potential API exceptions.
+
+  Args:
+    api_call: The function to call for deleting the resource.
+    resource_name: The name of the resource to delete.
+    resource_type: The type of the resource (e.g., "Persistent Volume Claim").
+  """
+  xpk_print(f"Deleting {resource_kind}:{resource_name}")
+  try:
+    api_call(resource_name)
+  except ApiException as e:
+    if e.status == 404:
+      xpk_print(
+          f"{resource_kind}: {resource_name} not found. "
+          f"Might be already deleted. Error: {e}"
+      )
+      return
+    else:
+      xpk_print(f"Encountered error during {resource_kind} deletion: {e}")
+      xpk_exit(1)
+  xpk_print(f"Deleted {resource_kind}:{resource_name}")
+
+
+def delete_storage_resources(k8s_api_client: ApiClient, storage: Storage):
+  """
+  Deletes storage PV, PVC, SC and custom resources (if they exist).
+
+  Args:
+    k8s_api_client: An ApiClient object for interacting with the Kubernetes API.
+    storage: Storage to delete
+  """
+  api_instance = k8s_client.CustomObjectsApi(k8s_api_client)
+  core_api = k8s_client.CoreV1Api()
+  storage_api = k8s_client.StorageV1Api()
+
+  delete_resource(
+      lambda name: core_api.delete_namespaced_persistent_volume_claim(
+          name, "default"
+      ),
+      storage.pvc,
+      "Persistent Volume Claim",
+  )
+
+  delete_resource(
+      core_api.delete_persistent_volume, storage.pv, "Persistent Volume"
+  )
+
+  if storage.type == GCP_FILESTORE_TYPE:
+    delete_resource(
+        storage_api.delete_storage_class,
+        get_storage_class_name(storage.name),
+        "Storage Class",
+    )
+
+  delete_resource(
+      lambda name: api_instance.delete_namespaced_custom_object(
+          namespace=DEFAULT_NAMESPACE,
+          name=name,
+          group=KJOB_API_GROUP_NAME,
+          version=KJOB_API_GROUP_VERSION,
+          plural=KJOB_API_VOLUME_BUNDLE_PLURAL,
+      ),
+      storage.name,
+      "VolumeBundle",
+  )
+
+  delete_resource(
+      lambda name: api_instance.delete_cluster_custom_object(
+          name=name,
+          group=XPK_API_GROUP_NAME,
+          version=XPK_API_GROUP_VERSION,
+          plural=STORAGE_CRD_PLURAL,
+      ),
+      storage.name,
+      "Storage",
+  )

xpk/commands/version.py

@@ -0,0 +1,27 @@
+"""
+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 ..core.config import __version__
+from ..utils.console import xpk_print
+
+
+def get_xpk_version() -> str:
+  return __version__
+
+
+def version(args) -> None:  # pylint: disable=unused-argument
+  """Get version of xpk."""
+  xpk_print('xpk_version:', __version__)