pulumi-kubernetes 4.10.0a1710355461__py3-none-any.whl → 4.20.0__py3-none-any.whl

pulumi_kubernetes/yaml/v2/ConfigFile.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from ... import _utilities
 
 __all__ = ['ConfigFileArgs', 'ConfigFile']
@@ -76,16 +81,52 @@ class ConfigFile(pulumi.ComponentResource):
                  skip_await: Optional[pulumi.Input[bool]] = None,
                  __props__=None):
         """
-        ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+        ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+        (If you have in-memory YAML a ConfigGroup may be more appropriate.)
+
+        ## Dependency ordering
+        Sometimes resources must be applied in a specific order. For example, a namespace resource must be
+        created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.
+
+        Pulumi uses heuristics to determine which order to apply and delete objects within the ConfigFile.  Pulumi also
+        waits for each object to be fully reconciled, unless `skipAwait` is enabled.
+
+        ### Explicit Dependency Ordering
+        Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource.
+        The annotation accepts a list of resource references, delimited by commas.
+
+        Note that references to resources outside the ConfigFile aren't supported.
+
+        **Resource reference**
+
+        A resource reference is a string that uniquely identifies a resource.
+
+        It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.
+
+        | Resource Scope   | Format                                         |
+        | :--------------- | :--------------------------------------------- |
+        | namespace-scoped | `<group>/namespaces/<namespace>/<kind>/<name>` |
+        | cluster-scoped   | `<group>/<kind>/<name>`                        |
+
+        For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).
+
+        ### Ordering across ConfigFiles
+        The `dependsOn` resource option creates a list of explicit dependencies between Pulumi resources.
+        Use it on another resource to make it dependent on the ConfigFile and to wait for the resources within
+        the group to be deployed.
+
+        A best practice is to deploy each application using its own ConfigFile, especially when that application
+        installs custom resource definitions.
 
         ## Example Usage
         ### Local File
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigFile
 
         example = ConfigFile(
             "example",
-            file="foo.yaml",
+            file="./manifest.yaml"
         )
         ```
         {% /examples %}}
@@ -103,16 +144,52 @@ class ConfigFile(pulumi.ComponentResource):
                  args: ConfigFileArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        ConfigFile creates a set of Kubernetes resources from a Kubernetes YAML file.
+        ConfigFile creates a set of Kubernetes resources from a remote or on-disk Kubernetes YAML file.
+        (If you have in-memory YAML a ConfigGroup may be more appropriate.)
+
+        ## Dependency ordering
+        Sometimes resources must be applied in a specific order. For example, a namespace resource must be
+        created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.
+
+        Pulumi uses heuristics to determine which order to apply and delete objects within the ConfigFile.  Pulumi also
+        waits for each object to be fully reconciled, unless `skipAwait` is enabled.
+
+        ### Explicit Dependency Ordering
+        Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource.
+        The annotation accepts a list of resource references, delimited by commas.
+
+        Note that references to resources outside the ConfigFile aren't supported.
+
+        **Resource reference**
+
+        A resource reference is a string that uniquely identifies a resource.
+
+        It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.
+
+        | Resource Scope   | Format                                         |
+        | :--------------- | :--------------------------------------------- |
+        | namespace-scoped | `<group>/namespaces/<namespace>/<kind>/<name>` |
+        | cluster-scoped   | `<group>/<kind>/<name>`                        |
+
+        For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).
+
+        ### Ordering across ConfigFiles
+        The `dependsOn` resource option creates a list of explicit dependencies between Pulumi resources.
+        Use it on another resource to make it dependent on the ConfigFile and to wait for the resources within
+        the group to be deployed.
+
+        A best practice is to deploy each application using its own ConfigFile, especially when that application
+        installs custom resource definitions.
 
         ## Example Usage
         ### Local File
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigFile
 
         example = ConfigFile(
             "example",
-            file="foo.yaml",
+            file="./manifest.yaml"
         )
         ```
         {% /examples %}}

pulumi_kubernetes/yaml/v2/ConfigGroup.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from ... import _utilities
 
 __all__ = ['ConfigGroupArgs', 'ConfigGroup']
@@ -119,55 +124,93 @@ class ConfigGroup(pulumi.ComponentResource):
         3. Using a literal string containing YAML, or a list of such strings:
         4. Any combination of files, patterns, or YAML strings:
 
-        ## Example Usage
-        ### Local File
-        ```python
-        from pulumi_kubernetes.yaml.v2 import ConfigGroup
+        ## Dependency ordering
+        Sometimes resources must be applied in a specific order. For example, a namespace resource must be
+        created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.
 
-        example = ConfigGroup(
-            "example",
-            files=["foo.yaml"],
-        )
-        ```
-        ### Multiple Local Files
+        Pulumi uses heuristics to determine which order to apply and delete objects within the ConfigGroup.  Pulumi also
+        waits for each object to be fully reconciled, unless `skipAwait` is enabled.
+
+        ### Explicit Dependency Ordering
+        Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource.
+        The annotation accepts a list of resource references, delimited by commas.
+
+        Note that references to resources outside the ConfigGroup aren't supported.
+
+        **Resource reference**
+
+        A resource reference is a string that uniquely identifies a resource.
+
+        It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.
+
+        | Resource Scope   | Format                                         |
+        | :--------------- | :--------------------------------------------- |
+        | namespace-scoped | `<group>/namespaces/<namespace>/<kind>/<name>` |
+        | cluster-scoped   | `<group>/<kind>/<name>`                        |
+
+        For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).
+
+        ### Ordering across ConfigGroups
+        The `dependsOn` resource option creates a list of explicit dependencies between Pulumi resources.
+        Use it on another resource to make it dependent on the ConfigGroup and to wait for the resources within
+        the group to be deployed.
+
+        A best practice is to deploy each application using its own ConfigGroup, especially when that application
+        installs custom resource definitions.
+
+        ## Example Usage
+        ### Local File(s)
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            files=["foo.yaml", "bar.yaml"],
+            files=["./manifest.yaml"]
         )
         ```
         ### Local File Pattern
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            files=["yaml/*.yaml"],
+            files=["./manifests/*.yaml"]
         )
         ```
-        ### Multiple Local File Patterns
+        {{% /example %}}
+        ### Literal YAML String
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            files=["foo/*.yaml", "bar/*.yaml"],
+            yaml=\"\"\"
+        apiVersion: v1
+        kind: ConfigMap
+        metadata:
+          name: my-map
+        \"\"\"
         )
         ```
-        ### Literal YAML String
+        ### Literal Object
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            yaml=['''
-        apiVersion: v1
-        kind: Namespace
-        metadata:
-          name: foo
-        ''']
+            objs=[
+                {
+                    "apiVersion": "v1",
+                    "kind": "ConfigMap",
+                    "metadata": {
+                        "name": "my-map",
+                    },
+                }
+            ]
         )
         ```
         {% /examples %}}
@@ -195,55 +238,93 @@ class ConfigGroup(pulumi.ComponentResource):
         3. Using a literal string containing YAML, or a list of such strings:
         4. Any combination of files, patterns, or YAML strings:
 
-        ## Example Usage
-        ### Local File
-        ```python
-        from pulumi_kubernetes.yaml.v2 import ConfigGroup
+        ## Dependency ordering
+        Sometimes resources must be applied in a specific order. For example, a namespace resource must be
+        created before any namespaced resources, or a Custom Resource Definition (CRD) must be pre-installed.
 
-        example = ConfigGroup(
-            "example",
-            files=["foo.yaml"],
-        )
-        ```
-        ### Multiple Local Files
+        Pulumi uses heuristics to determine which order to apply and delete objects within the ConfigGroup.  Pulumi also
+        waits for each object to be fully reconciled, unless `skipAwait` is enabled.
+
+        ### Explicit Dependency Ordering
+        Pulumi supports the `config.kubernetes.io/depends-on` annotation to declare an explicit dependency on a given resource.
+        The annotation accepts a list of resource references, delimited by commas.
+
+        Note that references to resources outside the ConfigGroup aren't supported.
+
+        **Resource reference**
+
+        A resource reference is a string that uniquely identifies a resource.
+
+        It consists of the group, kind, name, and optionally the namespace, delimited by forward slashes.
+
+        | Resource Scope   | Format                                         |
+        | :--------------- | :--------------------------------------------- |
+        | namespace-scoped | `<group>/namespaces/<namespace>/<kind>/<name>` |
+        | cluster-scoped   | `<group>/<kind>/<name>`                        |
+
+        For resources in the “core” group, the empty string is used instead (for example: `/namespaces/test/Pod/pod-a`).
+
+        ### Ordering across ConfigGroups
+        The `dependsOn` resource option creates a list of explicit dependencies between Pulumi resources.
+        Use it on another resource to make it dependent on the ConfigGroup and to wait for the resources within
+        the group to be deployed.
+
+        A best practice is to deploy each application using its own ConfigGroup, especially when that application
+        installs custom resource definitions.
+
+        ## Example Usage
+        ### Local File(s)
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            files=["foo.yaml", "bar.yaml"],
+            files=["./manifest.yaml"]
         )
         ```
         ### Local File Pattern
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            files=["yaml/*.yaml"],
+            files=["./manifests/*.yaml"]
         )
         ```
-        ### Multiple Local File Patterns
+        {{% /example %}}
+        ### Literal YAML String
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            files=["foo/*.yaml", "bar/*.yaml"],
+            yaml=\"\"\"
+        apiVersion: v1
+        kind: ConfigMap
+        metadata:
+          name: my-map
+        \"\"\"
         )
         ```
-        ### Literal YAML String
+        ### Literal Object
         ```python
+        import pulumi
         from pulumi_kubernetes.yaml.v2 import ConfigGroup
 
         example = ConfigGroup(
             "example",
-            yaml=['''
-        apiVersion: v1
-        kind: Namespace
-        metadata:
-          name: foo
-        ''']
+            objs=[
+                {
+                    "apiVersion": "v1",
+                    "kind": "ConfigMap",
+                    "metadata": {
+                        "name": "my-map",
+                    },
+                }
+            ]
         )
         ```
         {% /examples %}}