yellowdog-python-examples 7.10.3__tar.gz → 7.11.0__tar.gz

{yellowdog_python_examples-7.10.3/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: yellowdog-python-examples
-Version: 7.10.3
+Version: 7.11.0
 Summary: Example Python commands using the YellowDog Python SDK
 Home-page: https://github.com/yellowdog/python-examples
 Author: YellowDog Limited
@@ -15,7 +15,7 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: yellowdog-sdk>=8.0.2
+Requires-Dist: yellowdog-sdk==8.1.2
 Requires-Dist: toml
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: PyPAC>=0.16.4

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/README.md

@@ -90,6 +90,7 @@
    * [Attribute Definitions](#attribute-definitions)
       * [String Attribute Definitions](#string-attribute-definitions)
       * [Numeric Attribute Definitions](#numeric-attribute-definitions)
+   * [Namespace Policies](#namespace-policies)
 * [Jsonnet Support](#jsonnet-support)
    * [Jsonnet Installation](#jsonnet-installation)
    * [Variable Substitutions in Jsonnet Files](#variable-substitutions-in-jsonnet-files)
@@ -118,7 +119,7 @@
    * [yd-show](#yd-show)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: pwt, at: Wed Jun 12 11:55:06 BST 2024 -->
+<!-- Added by: pwt, at: Wed Jun 26 20:59:32 BST 2024 -->
 
 <!--te-->
 
@@ -1808,6 +1809,7 @@ The commands **yd-create** and **yd-remove** allow the creation, update and remo
 - Configured Worker Pools
 - Allowances
 - String Attribute Definitions
+- Namespace Policies
 
 ## Overview of Operation
 
@@ -2209,6 +2211,20 @@ Example:
 
 The `name`, `title` and `defaultRankOrder` properties are required, while the rest are optional. Either the `range` property or the `options` property (with numeric option values) can be specified, but not both. The `user.` prefix is required when specifying the `name` property.
 
+## Namespace Policies
+
+The Namespace Policies example and schema can be found at: (TBD).
+
+```json
+{
+  "resource": "NamespacePolicy",
+  "namespace": "test_namespace",
+  "autoscalingMaxNodes": 3
+}
+```
+
+Namespace Policies are matched by their `namespace` property when using `yd-create` and `yd-remove`. The `autoscalingMaxNodes` property can be omitted or set to `null` to remove an existing limit for a namespace.
+
 # Jsonnet Support
 
 In all circumstances where JSON files are used by the Python Examples commands,  **[Jsonnet](https://jsonnet.org)** files can be used instead. This allows the use of Jsonnet's powerful JSON extensions, including comments, variables, functions, etc.
@@ -2591,19 +2607,23 @@ The `yd-terminate` command immediately terminates Compute Requirements that matc
 
 ## yd-list
 
-The `yd-list` command is used to list various YellowDog items, using the `namespace` and `tag` properties to target the scope of what to list:
+The `yd-list` command is used to list various YellowDog items, using the `namespace` and `tag` properties (if applicable) to target the scope of what to list:
 
+- Allowances
+- Attribute Definitions
 - Compute Requirements
-- Worker Pools
+- Compute Templates
+- Image Families, Image Groups, and Images
+- Instances
+- Keyrings
+- Namespace Policies
+- Namespace Storage Configurations
 - Objects in the Object Store
-- Work Requirements
+- Source Templates
 - Task Groups
 - Tasks
-- Compute Sources
-- Compute Templates
-- Namespace Storage Configurations
-- Keyrings
-- Image Families
+- Work Requirements
+- Worker Pools
 
 Please use `yd-list --help` to inspect the various options.
 

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/requirements.txt

@@ -1,4 +1,4 @@
-yellowdog-sdk >= 8.0.2
+yellowdog-sdk == 8.1.2
 toml
 tabulate >= 0.9.0
 PyPAC >= 0.16.4

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/tests/test_entrypoints.py

@@ -48,3 +48,5 @@ def test_entrypoints():
     assert result.exit_code == 0
     result = shell("yd-boost --help")
     assert result.exit_code == 0
+    result = shell("yd-show --help")
+    assert result.exit_code == 0

yellowdog_python_examples-7.11.0/yd_commands/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.11.0"

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/args.py

@@ -536,6 +536,13 @@ class CLIParser:
                 required=False,
                 help="list user attribute definitions",
             )
+            parser.add_argument(
+                "--namespace-policies",
+                "-P",
+                action="store_true",
+                required=False,
+                help="list namespace policies",
+            )
 
         if any(module in sys.argv[0] for module in ["upload"]):
             parser.add_argument(
@@ -1331,6 +1338,11 @@ class CLIParser:
     def attribute_definitions(self) -> Optional[bool]:
         return self.args.attribute_definitions
 
+    @property
+    @allow_missing_attribute
+    def namespace_policies(self) -> Optional[bool]:
+        return self.args.namespace_policies
+
     @property
     @allow_missing_attribute
     def show_keyring_passwords(self) -> Optional[bool]:

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/create.py

@@ -25,6 +25,7 @@ from yellowdog_client.model import (
     MachineImage,
     MachineImageFamily,
     MachineImageGroup,
+    NamespacePolicy,
     NamespaceStorageConfiguration,
     RequirementsAllowance,
     SourceAllowance,
@@ -51,6 +52,7 @@ from yd_commands.settings import (
     RN_CREDENTIAL,
     RN_IMAGE_FAMILY,
     RN_KEYRING,
+    RN_NAMESPACE_POLICY,
     RN_NUMERIC_ATTRIBUTE_DEFINITION,
     RN_REQUIREMENT_TEMPLATE,
     RN_SOURCE_TEMPLATE,
@@ -125,6 +127,8 @@ def create_resources(
                 RN_NUMERIC_ATTRIBUTE_DEFINITION,
             ]:
                 create_attribute_definition(resource, resource_type)
+            elif resource_type == RN_NAMESPACE_POLICY:
+                create_namespace_policy(resource)
             else:
                 print_error(f"Unknown resource type '{resource_type}'")
         except Exception as e:
@@ -856,6 +860,45 @@ def create_attribute_definition(resource: Dict, resource_type: str):
     raise Exception(f"HTTP {response.status_code} ({response.text})")
 
 
+def create_namespace_policy(resource: Dict):
+    """
+    Create or update a namespace policy.
+    """
+    try:
+        namespace_policy = NamespacePolicy(
+            namespace=resource["namespace"],
+            autoscalingMaxNodes=resource.get("autoscalingMaxNodes"),
+        )
+    except KeyError as e:
+        raise Exception(f"Expected property to be defined ({e})")
+
+    # Test for existing policy
+    try:
+        CLIENT.namespaces_client.get_namespace_policy(
+            namespace=namespace_policy.namespace
+        )
+        if not confirmed(
+            f"Update existing Namespace Policy '{namespace_policy.namespace}'?"
+        ):
+            return
+    except Exception:
+        # Assume it's not found ... 404 from API
+        pass
+
+    try:
+        CLIENT.namespaces_client.save_namespace_policy(namespace_policy)
+    except Exception as e:
+        print_error(
+            f"Unable to create or update Namespace Policy for '{namespace_policy.namespace}': {e}"
+        )
+        return
+
+    print_log(
+        f"Created or updated  Namespace Policy '{namespace_policy.namespace}' with "
+        f"'autoscalingMaxNodes={namespace_policy.autoscalingMaxNodes}'"
+    )
+
+
 # Entry point
 if __name__ == "__main__":
     main()

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/items.py

@@ -14,6 +14,7 @@ from yellowdog_client.model import (
     Instance,
     KeyringSummary,
     MachineImageFamilySummary,
+    NamespacePolicy,
     NamespaceStorageConfiguration,
     ObjectPath,
     ProvisionedWorkerPool,
@@ -37,6 +38,7 @@ Item = TypeVar(
     Instance,
     KeyringSummary,
     MachineImageFamilySummary,
+    NamespacePolicy,
     NamespaceStorageConfiguration,
     ObjectPath,
     ProvisionedWorkerPool,

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/list.py

@@ -27,6 +27,8 @@ from yellowdog_client.model import (
     KeyringSummary,
     MachineImageFamilySearch,
     MachineImageFamilySummary,
+    NamespacePolicy,
+    NamespacePolicySearch,
     NamespaceStorageConfiguration,
     ObjectDetail,
     Task,
@@ -51,6 +53,7 @@ from yd_commands.printing import (
     print_log,
     print_numbered_object_list,
     print_table_core,
+    print_warning,
     print_yd_object,
     sorted_objects,
 )
@@ -88,6 +91,8 @@ def main():
         list_allowances()
     elif ARGS_PARSER.attribute_definitions:
         list_attribute_definitions()
+    elif ARGS_PARSER.namespace_policies:
+        list_namespace_policies()
 
 
 def check_for_valid_option() -> bool:
@@ -109,6 +114,7 @@ def check_for_valid_option() -> bool:
         ARGS_PARSER.instances,
         ARGS_PARSER.allowances,
         ARGS_PARSER.attribute_definitions,
+        ARGS_PARSER.namespace_policies,
     ].count(True) == 1:
         return True
     else:
@@ -592,6 +598,54 @@ def list_attribute_definitions():
         print_json(selected_attribute_definition)
 
 
+def list_namespace_policies():
+    """
+    List namespace policies.
+    """
+
+    np_search = NamespacePolicySearch()
+    search_client: SearchClient = CLIENT.namespaces_client.get_namespace_policies(
+        np_search
+    )
+    namespace_policies: List[NamespacePolicy] = search_client.list_all()
+    if len(namespace_policies) == 0:
+        print_log("No Namespace Policies to display")
+        return
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(CLIENT, namespace_policies)
+        return
+
+    for selected_namespace_policy in select(
+        CLIENT, namespace_policies, object_type_name="Namespace Policy"
+    ):
+        if selected_namespace_policy.autoscalingMaxNodes is None:
+            print_yd_object(selected_namespace_policy)
+        else:
+            details = get_autoscaling_capacity(selected_namespace_policy.namespace)
+            details["autoscalingMaxNodes"] = (
+                selected_namespace_policy.autoscalingMaxNodes
+            )
+            print_json(details)
+
+
+def get_autoscaling_capacity(namespace: str) -> Dict:
+    """
+    Get the current autoscaling values for a namespace.
+    """
+    response = get(
+        url=f"{CONFIG_COMMON.url}/workerPools/namespaces/{namespace}/autoscalingCapacity",
+        headers={"Authorization": f"yd-key {CONFIG_COMMON.key}:{CONFIG_COMMON.secret}"},
+    )
+    if response.status_code == 200:
+        return response.json()
+    else:
+        print_warning(
+            f"Failed to get autoscaling details for namespace '{namespace}' ({response.text})"
+        )
+        return {"namespace": namespace}
+
+
 # Entry point
 if __name__ == "__main__":
     main()

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/load_resources.py

@@ -2,7 +2,7 @@
 Load data for resource creation/update/removal requests.
 """
 
-from sys import exit
+from sys import argv, exit
 from typing import Dict, List
 
 from yd_commands.args import ARGS_PARSER
@@ -13,6 +13,7 @@ from yd_commands.settings import (
     RN_CREDENTIAL,
     RN_IMAGE_FAMILY,
     RN_KEYRING,
+    RN_NAMESPACE_POLICY,
     RN_NUMERIC_ATTRIBUTE_DEFINITION,
     RN_REQUIREMENT_TEMPLATE,
     RN_SOURCE_TEMPLATE,
@@ -49,10 +50,13 @@ def load_resource_specifications(creation_or_update: bool = True) -> List[Dict]:
         elif resource_spec.lower().endswith(".json"):
             resources_loaded = load_json_file_with_variable_substitutions(resource_spec)
         else:
-            raise Exception(
-                f"['{resource_spec}'] Resource specifications must end in '.toml',"
-                " '.json' or '.jsonnet'"
+            exception_message = (
+                f"['{resource_spec}'] Resource specifications must end in '.toml', "
+                "'.json' or '.jsonnet'"
             )
+            if resource_spec.startswith("ydid:") and "":
+                exception_message += "; did you mean to use the '--ids' option?"
+            raise Exception(exception_message)
 
         # Transform single resource items into lists
         if isinstance(resources_loaded, dict):
@@ -101,6 +105,7 @@ def _resequence_resources(
         RN_SOURCE_TEMPLATE,
         RN_REQUIREMENT_TEMPLATE,
         RN_ALLOWANCE,
+        RN_NAMESPACE_POLICY,
         RN_STORAGE_CONFIGURATION,
         RN_CONFIGURED_POOL,
     ]

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/printing.py

@@ -32,6 +32,7 @@ from yellowdog_client.model import (
     Instance,
     KeyringSummary,
     MachineImageFamilySummary,
+    NamespacePolicy,
     NodeStatus,
     NodeSummary,
     ObjectDetail,
@@ -202,20 +203,21 @@ def print_warning(
 
 
 TYPE_MAP = {
-    ConfiguredWorkerPool: "Configured Worker Pool",
-    ProvisionedWorkerPool: "Provisioned Worker Pool",
-    WorkerPoolSummary: "Worker Pool",
+    AWSAvailabilityZone: "AWS Availability Zones",
+    Allowance: "Allowance",
     ComputeRequirement: "Compute Requirement",
-    Task: "Task",
-    TaskGroup: "Task Group",
-    WorkRequirementSummary: "Work Requirement",
-    ObjectPath: "Object Path",
     ComputeRequirementTemplateSummary: "Compute Requirement Template",
     ComputeSourceTemplateSummary: "Compute Source Template",
+    ConfiguredWorkerPool: "Configured Worker Pool",
     KeyringSummary: "Keyring",
     MachineImageFamilySummary: "Machine Image Family",
-    AWSAvailabilityZone: "AWS Availability Zones",
-    Allowance: "Allowance",
+    NamespacePolicy: "Namespace Policy",
+    ObjectPath: "Object Path",
+    ProvisionedWorkerPool: "Provisioned Worker Pool",
+    Task: "Task",
+    TaskGroup: "Task Group",
+    WorkRequirementSummary: "Work Requirement",
+    WorkerPoolSummary: "Worker Pool",
 }
 
 
@@ -613,6 +615,26 @@ def aws_availability_zone_table(
     return headers, table
 
 
+def namespace_policies_table(
+    ns_policies: List[NamespacePolicy],
+) -> (List[str], List[List]):
+    headers = [
+        "#",
+        "Namespace",
+        "AutoscalingMaxNodes",
+    ]
+    table = []
+    for index, ns_policy in enumerate(ns_policies):
+        table.append(
+            [
+                index + 1,
+                ns_policy.namespace,
+                ns_policy.autoscalingMaxNodes,
+            ]
+        )
+    return headers, table
+
+
 def print_numbered_object_list(
     client: PlatformClient,
     objects: List[Union[Item, str, Dict]],
@@ -667,6 +689,8 @@ def print_numbered_object_list(
         headers, table = aws_availability_zone_table(objects)
     elif object_type_name == "Attribute Definition":
         headers, table = attribute_definitions_table(objects)
+    elif isinstance(objects[0], NamespacePolicy):
+        headers, table = namespace_policies_table(objects)
     else:
         table = []
         for index, obj in enumerate(objects):

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/remove.py

@@ -32,6 +32,7 @@ from yd_commands.settings import (
     RN_CREDENTIAL,
     RN_IMAGE_FAMILY,
     RN_KEYRING,
+    RN_NAMESPACE_POLICY,
     RN_NUMERIC_ATTRIBUTE_DEFINITION,
     RN_REQUIREMENT_TEMPLATE,
     RN_SOURCE_TEMPLATE,
@@ -100,6 +101,8 @@ def remove_resources(resources: Optional[List[Dict]] = None):
                 RN_NUMERIC_ATTRIBUTE_DEFINITION,
             ]:
                 remove_attribute_definition(resource)
+            elif resource_type == RN_NAMESPACE_POLICY:
+                remove_namespace_policy(resource)
             else:
                 print_error(f"Unknown resource type '{resource_type}'")
         except Exception as e:
@@ -438,6 +441,33 @@ def remove_attribute_definition(resource: Dict):
     raise Exception(f"HTTP {response.status_code} ({response.text})")
 
 
+def remove_namespace_policy(resource: Dict):
+    """
+    Remove a Namespace Policy (if it exists).
+    """
+    try:
+        namespace = resource["namespace"]
+    except KeyError as e:
+        print_error(f"Expected property to be defined ({e})")
+        return
+
+    # Test for existing policy
+    try:
+        CLIENT.namespaces_client.get_namespace_policy(namespace=namespace)
+        if not confirmed(f"Remove Namespace Policy '{namespace}'?"):
+            return
+    except Exception:
+        # Assume it's not found ... 404 from API
+        print_error(f"Namespace Policy '{namespace}' not found")
+        return
+
+    try:
+        CLIENT.namespaces_client.delete_namespace_policy(namespace)
+        print_log(f"Removed Namespace Policy '{namespace}'")
+    except Exception as e:
+        print_error(f"Unable to remove Namespace Policy '{namespace}': {e}")
+
+
 # Entry point
 if __name__ == "__main__":
     main()

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/settings.py

@@ -107,3 +107,4 @@ RN_SOURCE_TEMPLATE = "ComputeSourceTemplate"
 RN_STORAGE_CONFIGURATION = "NamespaceStorageConfiguration"
 RN_STRING_ATTRIBUTE_DEFINITION = "StringAttributeDefinition"
 RN_NUMERIC_ATTRIBUTE_DEFINITION = "NumericAttributeDefinition"
+RN_NAMESPACE_POLICY = "NamespacePolicy"

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yd_commands/wrapper.py

@@ -104,7 +104,7 @@ def main_wrapper(func):
                 print_log("Cancelled")
                 exit_code = 1
             finally:
-                CLIENT.close()
+                # CLIENT.close()
                 if exit_code == 0:
                     print_log("Done")
                 exit(exit_code)
@@ -112,7 +112,7 @@ def main_wrapper(func):
             set_proxy()
             print_account()
             func()
-            CLIENT.close()
+            # CLIENT.close()
             print_log("Done")
             exit(0)
 

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: yellowdog-python-examples
-Version: 7.10.3
+Version: 7.11.0
 Summary: Example Python commands using the YellowDog Python SDK
 Home-page: https://github.com/yellowdog/python-examples
 Author: YellowDog Limited
@@ -15,7 +15,7 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: yellowdog-sdk>=8.0.2
+Requires-Dist: yellowdog-sdk==8.1.2
 Requires-Dist: toml
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: PyPAC>=0.16.4

{yellowdog_python_examples-7.10.3 → yellowdog_python_examples-7.11.0}/yellowdog_python_examples.egg-info/requires.txt

@@ -1,4 +1,4 @@
-yellowdog-sdk>=8.0.2
+yellowdog-sdk==8.1.2
 toml
 tabulate>=0.9.0
 PyPAC>=0.16.4

yellowdog_python_examples-7.10.3/yd_commands/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.10.3"