pulumi-nomad 2.3.0__py3-none-any.whl → 2.3.0a1710918439__py3-none-any.whl

pulumi_nomad/acl_auth_method.py

@@ -32,8 +32,8 @@ class AclAuthMethodArgs:
         :param pulumi.Input[str] token_locality: `(string: <required>)` - Defines whether the ACL Auth Method
                creates a local or global token when performing SSO login. This field must be
                set to either `local` or `global`.
-        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
-               are `OIDC` and `JWT`.
+        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Currently,
+               the only supported type is `OIDC`.
         :param pulumi.Input[bool] default: `(bool: false)` - Defines whether this ACL Auth Method is to be set
                as default.
         :param pulumi.Input[str] name: `(string: <required>)` - The identifier of the ACL Auth Method.
@@ -96,8 +96,8 @@ class AclAuthMethodArgs:
     @pulumi.getter
     def type(self) -> pulumi.Input[str]:
         """
-        `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
-        are `OIDC` and `JWT`.
+        `(string: <required>)` - ACL Auth Method SSO workflow type. Currently,
+        the only supported type is `OIDC`.
         """
         return pulumi.get(self, "type")
 
@@ -170,8 +170,8 @@ class _AclAuthMethodState:
         :param pulumi.Input[str] token_name_format: `(string: "${auth_method_type}-${auth_method_name}")` -
                Defines the token name format for the generated tokens This can be lightly
                templated using HIL '${foo}' syntax.
-        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
-               are `OIDC` and `JWT`.
+        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Currently,
+               the only supported type is `OIDC`.
         """
         if config is not None:
             pulumi.set(__self__, "config", config)
@@ -271,8 +271,8 @@ class _AclAuthMethodState:
     @pulumi.getter
     def type(self) -> Optional[pulumi.Input[str]]:
         """
-        `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
-        are `OIDC` and `JWT`.
+        `(string: <required>)` - ACL Auth Method SSO workflow type. Currently,
+        the only supported type is `OIDC`.
         """
         return pulumi.get(self, "type")
 
@@ -301,12 +301,12 @@ class AclAuthMethod(pulumi.CustomResource):
 
         Creating an ALC Auth Method:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
-        my_nomad_acl_auth_method = nomad.AclAuthMethod("my_nomad_acl_auth_method",
-            name="my-nomad-acl-auth-method",
+        my_nomad_acl_auth_method = nomad.AclAuthMethod("myNomadAclAuthMethod",
             type="OIDC",
             token_locality="global",
             max_token_ttl="10m0s",
@@ -326,6 +326,7 @@ class AclAuthMethod(pulumi.CustomResource):
                 },
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -342,8 +343,8 @@ class AclAuthMethod(pulumi.CustomResource):
         :param pulumi.Input[str] token_name_format: `(string: "${auth_method_type}-${auth_method_name}")` -
                Defines the token name format for the generated tokens This can be lightly
                templated using HIL '${foo}' syntax.
-        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
-               are `OIDC` and `JWT`.
+        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Currently,
+               the only supported type is `OIDC`.
         """
         ...
     @overload
@@ -358,12 +359,12 @@ class AclAuthMethod(pulumi.CustomResource):
 
         Creating an ALC Auth Method:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
-        my_nomad_acl_auth_method = nomad.AclAuthMethod("my_nomad_acl_auth_method",
-            name="my-nomad-acl-auth-method",
+        my_nomad_acl_auth_method = nomad.AclAuthMethod("myNomadAclAuthMethod",
             type="OIDC",
             token_locality="global",
             max_token_ttl="10m0s",
@@ -383,6 +384,7 @@ class AclAuthMethod(pulumi.CustomResource):
                 },
             ))
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param AclAuthMethodArgs args: The arguments to use to populate this resource's properties.
@@ -467,8 +469,8 @@ class AclAuthMethod(pulumi.CustomResource):
         :param pulumi.Input[str] token_name_format: `(string: "${auth_method_type}-${auth_method_name}")` -
                Defines the token name format for the generated tokens This can be lightly
                templated using HIL '${foo}' syntax.
-        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
-               are `OIDC` and `JWT`.
+        :param pulumi.Input[str] type: `(string: <required>)` - ACL Auth Method SSO workflow type. Currently,
+               the only supported type is `OIDC`.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -542,8 +544,8 @@ class AclAuthMethod(pulumi.CustomResource):
     @pulumi.getter
     def type(self) -> pulumi.Output[str]:
         """
-        `(string: <required>)` - ACL Auth Method SSO workflow type. Valid values,
-        are `OIDC` and `JWT`.
+        `(string: <required>)` - ACL Auth Method SSO workflow type. Currently,
+        the only supported type is `OIDC`.
         """
         return pulumi.get(self, "type")
 

pulumi_nomad/acl_policy.py

@@ -173,6 +173,38 @@ class AclPolicy(pulumi.CustomResource):
         """
         Manages an ACL policy registered in Nomad.
 
+        ## Example Usage
+
+        Registering a policy from a HCL file:
+
+        <!--Start PulumiCodeChooser -->
+        ```python
+        import pulumi
+        import pulumi_nomad as nomad
+
+        dev = nomad.AclPolicy("dev",
+            description="Submit jobs to the dev environment.",
+            rules_hcl=(lambda path: open(path).read())(f"{path['module']}/dev.hcl"))
+        ```
+        <!--End PulumiCodeChooser -->
+
+        Registering a policy from inline HCL:
+
+        <!--Start PulumiCodeChooser -->
+        ```python
+        import pulumi
+        import pulumi_nomad as nomad
+
+        dev = nomad.AclPolicy("dev",
+            description="Submit jobs to the dev environment.",
+            rules_hcl=\"\"\"namespace "dev" {
+          policy = "write"
+        }
+
+        \"\"\")
+        ```
+        <!--End PulumiCodeChooser -->
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] description: `(string: "")` - A description of the policy.
@@ -190,6 +222,38 @@ class AclPolicy(pulumi.CustomResource):
         """
         Manages an ACL policy registered in Nomad.
 
+        ## Example Usage
+
+        Registering a policy from a HCL file:
+
+        <!--Start PulumiCodeChooser -->
+        ```python
+        import pulumi
+        import pulumi_nomad as nomad
+
+        dev = nomad.AclPolicy("dev",
+            description="Submit jobs to the dev environment.",
+            rules_hcl=(lambda path: open(path).read())(f"{path['module']}/dev.hcl"))
+        ```
+        <!--End PulumiCodeChooser -->
+
+        Registering a policy from inline HCL:
+
+        <!--Start PulumiCodeChooser -->
+        ```python
+        import pulumi
+        import pulumi_nomad as nomad
+
+        dev = nomad.AclPolicy("dev",
+            description="Submit jobs to the dev environment.",
+            rules_hcl=\"\"\"namespace "dev" {
+          policy = "write"
+        }
+
+        \"\"\")
+        ```
+        <!--End PulumiCodeChooser -->
+
         :param str resource_name: The name of the resource.
         :param AclPolicyArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_nomad/acl_token.py

@@ -351,48 +351,51 @@ class AclToken(pulumi.CustomResource):
 
         Creating a token with limited policies:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
         dakota = nomad.AclToken("dakota",
-            name="Dakota",
-            type="client",
             policies=[
                 "dev",
                 "qa",
-            ])
+            ],
+            type="client")
         ```
+        <!--End PulumiCodeChooser -->
 
         Creating a global token that will be replicated to all regions:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
         dakota = nomad.AclToken("dakota",
-            name="Dakota",
-            type="client",
+            global_=True,
             policies=[
                 "dev",
                 "qa",
             ],
-            global_=True)
+            type="client")
         ```
+        <!--End PulumiCodeChooser -->
 
         Creating a token with full access to the cluster:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
-        iman = nomad.AclToken("iman",
-            name="Iman",
-            type="management")
+        iman = nomad.AclToken("iman", type="management")
         ```
+        <!--End PulumiCodeChooser -->
 
         Accessing the token:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
@@ -402,6 +405,7 @@ class AclToken(pulumi.CustomResource):
             policies=["dev"])
         pulumi.export("nomadToken", token.secret_id)
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -434,48 +438,51 @@ class AclToken(pulumi.CustomResource):
 
         Creating a token with limited policies:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
         dakota = nomad.AclToken("dakota",
-            name="Dakota",
-            type="client",
             policies=[
                 "dev",
                 "qa",
-            ])
+            ],
+            type="client")
         ```
+        <!--End PulumiCodeChooser -->
 
         Creating a global token that will be replicated to all regions:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
         dakota = nomad.AclToken("dakota",
-            name="Dakota",
-            type="client",
+            global_=True,
             policies=[
                 "dev",
                 "qa",
             ],
-            global_=True)
+            type="client")
         ```
+        <!--End PulumiCodeChooser -->
 
         Creating a token with full access to the cluster:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
 
-        iman = nomad.AclToken("iman",
-            name="Iman",
-            type="management")
+        iman = nomad.AclToken("iman", type="management")
         ```
+        <!--End PulumiCodeChooser -->
 
         Accessing the token:
 
+        <!--Start PulumiCodeChooser -->
         ```python
         import pulumi
         import pulumi_nomad as nomad
@@ -485,6 +492,7 @@ class AclToken(pulumi.CustomResource):
             policies=["dev"])
         pulumi.export("nomadToken", token.secret_id)
         ```
+        <!--End PulumiCodeChooser -->
 
         :param str resource_name: The name of the resource.
         :param AclTokenArgs args: The arguments to use to populate this resource's properties.

pulumi_nomad/csi_volume.py

@@ -261,14 +261,23 @@ class _CsiVolumeState:
         :param pulumi.Input[str] capacity_max: `(string: <optional>)` - Option to signal a maximum volume size. This may not be supported by all storage providers.
         :param pulumi.Input[str] capacity_min: `(string: <optional>)` - Option to signal a minimum volume size. This may not be supported by all storage providers.
         :param pulumi.Input[str] clone_id: `(string: <optional>)` - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with `snapshot_id`.
+        :param pulumi.Input[bool] controller_required: `(boolean)`
+        :param pulumi.Input[int] controllers_expected: `(integer)`
+        :param pulumi.Input[int] controllers_healthy: `(integer)`
         :param pulumi.Input[str] external_id: The ID of the physical volume from the storage provider.
         :param pulumi.Input['CsiVolumeMountOptionsArgs'] mount_options: `(block: optional)` Options for mounting `block-device` volumes without a pre-formatted file system.
         :param pulumi.Input[str] name: `(string: <required>)` - The display name for the volume.
         :param pulumi.Input[str] namespace: `(string: "default")` - The namespace in which to register the volume.
+        :param pulumi.Input[int] nodes_expected: `(integer)`
+        :param pulumi.Input[int] nodes_healthy: `(integer)`
         :param pulumi.Input[Mapping[str, pulumi.Input[str]]] parameters: `(map[string]string: optional)` An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
         :param pulumi.Input[str] plugin_id: `(string: <required>)` - The ID of the Nomad plugin for registering this volume.
+        :param pulumi.Input[str] plugin_provider: `(string)`
+        :param pulumi.Input[str] plugin_provider_version: `(string)`
+        :param pulumi.Input[bool] schedulable: `(boolean)`
         :param pulumi.Input[Mapping[str, pulumi.Input[str]]] secrets: `(map[string]string: optional)` An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
         :param pulumi.Input[str] snapshot_id: `(string: <optional>)` - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with `clone_id`.
+        :param pulumi.Input[Sequence[pulumi.Input['CsiVolumeTopologyArgs']]] topologies: `(List of topologies)`
         :param pulumi.Input['CsiVolumeTopologyRequestArgs'] topology_request: `(``TopologyRequest``: <optional>)` - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
         :param pulumi.Input[str] volume_id: `(string: <required>)` - The unique ID of the volume.
         """
@@ -403,6 +412,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter(name="controllerRequired")
     def controller_required(self) -> Optional[pulumi.Input[bool]]:
+        """
+        `(boolean)`
+        """
         return pulumi.get(self, "controller_required")
 
     @controller_required.setter
@@ -412,6 +424,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter(name="controllersExpected")
     def controllers_expected(self) -> Optional[pulumi.Input[int]]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "controllers_expected")
 
     @controllers_expected.setter
@@ -421,6 +436,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter(name="controllersHealthy")
     def controllers_healthy(self) -> Optional[pulumi.Input[int]]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "controllers_healthy")
 
     @controllers_healthy.setter
@@ -478,6 +496,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter(name="nodesExpected")
     def nodes_expected(self) -> Optional[pulumi.Input[int]]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "nodes_expected")
 
     @nodes_expected.setter
@@ -487,6 +508,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter(name="nodesHealthy")
     def nodes_healthy(self) -> Optional[pulumi.Input[int]]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "nodes_healthy")
 
     @nodes_healthy.setter
@@ -520,6 +544,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter(name="pluginProvider")
     def plugin_provider(self) -> Optional[pulumi.Input[str]]:
+        """
+        `(string)`
+        """
         return pulumi.get(self, "plugin_provider")
 
     @plugin_provider.setter
@@ -529,6 +556,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter(name="pluginProviderVersion")
     def plugin_provider_version(self) -> Optional[pulumi.Input[str]]:
+        """
+        `(string)`
+        """
         return pulumi.get(self, "plugin_provider_version")
 
     @plugin_provider_version.setter
@@ -538,6 +568,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter
     def schedulable(self) -> Optional[pulumi.Input[bool]]:
+        """
+        `(boolean)`
+        """
         return pulumi.get(self, "schedulable")
 
     @schedulable.setter
@@ -571,6 +604,9 @@ class _CsiVolumeState:
     @property
     @pulumi.getter
     def topologies(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['CsiVolumeTopologyArgs']]]]:
+        """
+        `(List of topologies)`
+        """
         return pulumi.get(self, "topologies")
 
     @topologies.setter
@@ -765,14 +801,23 @@ class CsiVolume(pulumi.CustomResource):
         :param pulumi.Input[str] capacity_max: `(string: <optional>)` - Option to signal a maximum volume size. This may not be supported by all storage providers.
         :param pulumi.Input[str] capacity_min: `(string: <optional>)` - Option to signal a minimum volume size. This may not be supported by all storage providers.
         :param pulumi.Input[str] clone_id: `(string: <optional>)` - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with `snapshot_id`.
+        :param pulumi.Input[bool] controller_required: `(boolean)`
+        :param pulumi.Input[int] controllers_expected: `(integer)`
+        :param pulumi.Input[int] controllers_healthy: `(integer)`
         :param pulumi.Input[str] external_id: The ID of the physical volume from the storage provider.
         :param pulumi.Input[pulumi.InputType['CsiVolumeMountOptionsArgs']] mount_options: `(block: optional)` Options for mounting `block-device` volumes without a pre-formatted file system.
         :param pulumi.Input[str] name: `(string: <required>)` - The display name for the volume.
         :param pulumi.Input[str] namespace: `(string: "default")` - The namespace in which to register the volume.
+        :param pulumi.Input[int] nodes_expected: `(integer)`
+        :param pulumi.Input[int] nodes_healthy: `(integer)`
         :param pulumi.Input[Mapping[str, pulumi.Input[str]]] parameters: `(map[string]string: optional)` An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
         :param pulumi.Input[str] plugin_id: `(string: <required>)` - The ID of the Nomad plugin for registering this volume.
+        :param pulumi.Input[str] plugin_provider: `(string)`
+        :param pulumi.Input[str] plugin_provider_version: `(string)`
+        :param pulumi.Input[bool] schedulable: `(boolean)`
         :param pulumi.Input[Mapping[str, pulumi.Input[str]]] secrets: `(map[string]string: optional)` An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
         :param pulumi.Input[str] snapshot_id: `(string: <optional>)` - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with `clone_id`.
+        :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['CsiVolumeTopologyArgs']]]] topologies: `(List of topologies)`
         :param pulumi.Input[pulumi.InputType['CsiVolumeTopologyRequestArgs']] topology_request: `(``TopologyRequest``: <optional>)` - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
         :param pulumi.Input[str] volume_id: `(string: <required>)` - The unique ID of the volume.
         """
@@ -858,16 +903,25 @@ class CsiVolume(pulumi.CustomResource):
     @property
     @pulumi.getter(name="controllerRequired")
     def controller_required(self) -> pulumi.Output[bool]:
+        """
+        `(boolean)`
+        """
         return pulumi.get(self, "controller_required")
 
     @property
     @pulumi.getter(name="controllersExpected")
     def controllers_expected(self) -> pulumi.Output[int]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "controllers_expected")
 
     @property
     @pulumi.getter(name="controllersHealthy")
     def controllers_healthy(self) -> pulumi.Output[int]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "controllers_healthy")
 
     @property
@@ -905,11 +959,17 @@ class CsiVolume(pulumi.CustomResource):
     @property
     @pulumi.getter(name="nodesExpected")
     def nodes_expected(self) -> pulumi.Output[int]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "nodes_expected")
 
     @property
     @pulumi.getter(name="nodesHealthy")
     def nodes_healthy(self) -> pulumi.Output[int]:
+        """
+        `(integer)`
+        """
         return pulumi.get(self, "nodes_healthy")
 
     @property
@@ -931,16 +991,25 @@ class CsiVolume(pulumi.CustomResource):
     @property
     @pulumi.getter(name="pluginProvider")
     def plugin_provider(self) -> pulumi.Output[str]:
+        """
+        `(string)`
+        """
         return pulumi.get(self, "plugin_provider")
 
     @property
     @pulumi.getter(name="pluginProviderVersion")
     def plugin_provider_version(self) -> pulumi.Output[str]:
+        """
+        `(string)`
+        """
         return pulumi.get(self, "plugin_provider_version")
 
     @property
     @pulumi.getter
     def schedulable(self) -> pulumi.Output[bool]:
+        """
+        `(boolean)`
+        """
         return pulumi.get(self, "schedulable")
 
     @property
@@ -962,6 +1031,9 @@ class CsiVolume(pulumi.CustomResource):
     @property
     @pulumi.getter
     def topologies(self) -> pulumi.Output[Sequence['outputs.CsiVolumeTopology']]:
+        """
+        `(List of topologies)`
+        """
         return pulumi.get(self, "topologies")
 
     @property