Docs
Packagesnomad.CsiVolumeRegistration
Explore with Pulumi AI
Example Usage
Registering a volume
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nomad = Pulumi.Nomad;
return await Deployment.RunAsync(() =>
{
var ebs = Nomad.GetPlugin.Invoke(new()
{
PluginId = "aws-ebs0",
WaitForHealthy = true,
});
var mysqlVolume = new Nomad.Volume("mysqlVolume", new()
{
PluginId = "aws-ebs0",
VolumeId = "mysql_volume",
ExternalId = module.Hashistack.Ebs_test_volume_id,
Capabilities = new[]
{
new Nomad.Inputs.VolumeCapabilityArgs
{
AccessMode = "single-node-writer",
AttachmentMode = "file-system",
},
},
MountOptions = new Nomad.Inputs.VolumeMountOptionsArgs
{
FsType = "ext4",
},
TopologyRequest = new Nomad.Inputs.VolumeTopologyRequestArgs
{
Required = new Nomad.Inputs.VolumeTopologyRequestRequiredArgs
{
Topologies = new[]
{
new Nomad.Inputs.VolumeTopologyRequestRequiredTopologyArgs
{
Segments =
{
{ "rack", "R1" },
{ "zone", "us-east-1a" },
},
},
new Nomad.Inputs.VolumeTopologyRequestRequiredTopologyArgs
{
Segments =
{
{ "rack", "R2" },
},
},
},
},
},
}, new CustomResourceOptions
{
DependsOn = new[]
{
ebs,
},
});
});
package main
import (
"github.com/pulumi/pulumi-nomad/sdk/v2/go/nomad"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
ebs, err := nomad.GetPlugin(ctx, &nomad.GetPluginArgs{
PluginId: "aws-ebs0",
WaitForHealthy: pulumi.BoolRef(true),
}, nil)
if err != nil {
return err
}
_, err = nomad.NewVolume(ctx, "mysqlVolume", &nomad.VolumeArgs{
PluginId: pulumi.String("aws-ebs0"),
VolumeId: pulumi.String("mysql_volume"),
ExternalId: pulumi.Any(module.Hashistack.Ebs_test_volume_id),
Capabilities: nomad.VolumeCapabilityArray{
&nomad.VolumeCapabilityArgs{
AccessMode: pulumi.String("single-node-writer"),
AttachmentMode: pulumi.String("file-system"),
},
},
MountOptions: &nomad.VolumeMountOptionsArgs{
FsType: pulumi.String("ext4"),
},
TopologyRequest: &nomad.VolumeTopologyRequestArgs{
Required: &nomad.VolumeTopologyRequestRequiredArgs{
Topologies: nomad.VolumeTopologyRequestRequiredTopologyArray{
&nomad.VolumeTopologyRequestRequiredTopologyArgs{
Segments: pulumi.StringMap{
"rack": pulumi.String("R1"),
"zone": pulumi.String("us-east-1a"),
},
},
&nomad.VolumeTopologyRequestRequiredTopologyArgs{
Segments: pulumi.StringMap{
"rack": pulumi.String("R2"),
},
},
},
},
},
}, pulumi.DependsOn([]pulumi.Resource{
ebs,
}))
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nomad.NomadFunctions;
import com.pulumi.nomad.inputs.GetPluginArgs;
import com.pulumi.nomad.Volume;
import com.pulumi.nomad.VolumeArgs;
import com.pulumi.nomad.inputs.VolumeCapabilityArgs;
import com.pulumi.nomad.inputs.VolumeMountOptionsArgs;
import com.pulumi.nomad.inputs.VolumeTopologyRequestArgs;
import com.pulumi.nomad.inputs.VolumeTopologyRequestRequiredArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var ebs = NomadFunctions.getPlugin(GetPluginArgs.builder()
.pluginId("aws-ebs0")
.waitForHealthy(true)
.build());
var mysqlVolume = new Volume("mysqlVolume", VolumeArgs.builder()
.pluginId("aws-ebs0")
.volumeId("mysql_volume")
.externalId(module.hashistack().ebs_test_volume_id())
.capabilities(VolumeCapabilityArgs.builder()
.accessMode("single-node-writer")
.attachmentMode("file-system")
.build())
.mountOptions(VolumeMountOptionsArgs.builder()
.fsType("ext4")
.build())
.topologyRequest(VolumeTopologyRequestArgs.builder()
.required(VolumeTopologyRequestRequiredArgs.builder()
.topologies(
VolumeTopologyRequestRequiredTopologyArgs.builder()
.segments(Map.ofEntries(
Map.entry("rack", "R1"),
Map.entry("zone", "us-east-1a")
))
.build(),
VolumeTopologyRequestRequiredTopologyArgs.builder()
.segments(Map.of("rack", "R2"))
.build())
.build())
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(ebs.applyValue(getPluginResult -> getPluginResult))
.build());
}
}
import pulumi
import pulumi_nomad as nomad
ebs = nomad.get_plugin(plugin_id="aws-ebs0",
wait_for_healthy=True)
mysql_volume = nomad.Volume("mysqlVolume",
plugin_id="aws-ebs0",
volume_id="mysql_volume",
external_id=module["hashistack"]["ebs_test_volume_id"],
capabilities=[nomad.VolumeCapabilityArgs(
access_mode="single-node-writer",
attachment_mode="file-system",
)],
mount_options=nomad.VolumeMountOptionsArgs(
fs_type="ext4",
),
topology_request=nomad.VolumeTopologyRequestArgs(
required=nomad.VolumeTopologyRequestRequiredArgs(
topologies=[
nomad.VolumeTopologyRequestRequiredTopologyArgs(
segments={
"rack": "R1",
"zone": "us-east-1a",
},
),
nomad.VolumeTopologyRequestRequiredTopologyArgs(
segments={
"rack": "R2",
},
),
],
),
),
opts=pulumi.ResourceOptions(depends_on=[ebs]))
import * as pulumi from "@pulumi/pulumi";
import * as nomad from "@pulumi/nomad";
const ebs = nomad.getPlugin({
pluginId: "aws-ebs0",
waitForHealthy: true,
});
const mysqlVolume = new nomad.Volume("mysqlVolume", {
pluginId: "aws-ebs0",
volumeId: "mysql_volume",
externalId: module.hashistack.ebs_test_volume_id,
capabilities: [{
accessMode: "single-node-writer",
attachmentMode: "file-system",
}],
mountOptions: {
fsType: "ext4",
},
topologyRequest: {
required: {
topologies: [
{
segments: {
rack: "R1",
zone: "us-east-1a",
},
},
{
segments: {
rack: "R2",
},
},
],
},
},
}, {
dependsOn: [ebs],
});
resources:
mysqlVolume:
type: nomad:Volume
properties:
pluginId: aws-ebs0
volumeId: mysql_volume
externalId: ${module.hashistack.ebs_test_volume_id}
capabilities:
- accessMode: single-node-writer
attachmentMode: file-system
mountOptions:
fsType: ext4
topologyRequest:
required:
topologies:
- segments:
rack: R1
zone: us-east-1a
- segments:
rack: R2
options:
dependson:
- ${ebs}
variables:
ebs:
fn::invoke:
Function: nomad:getPlugin
Arguments:
pluginId: aws-ebs0
waitForHealthy: true
Create CsiVolumeRegistration Resource
new CsiVolumeRegistration(name: string, args: CsiVolumeRegistrationArgs, opts?: CustomResourceOptions);@overload
def CsiVolumeRegistration(resource_name: str,
opts: Optional[ResourceOptions] = None,
capabilities: Optional[Sequence[CsiVolumeRegistrationCapabilityArgs]] = None,
context: Optional[Mapping[str, str]] = None,
deregister_on_destroy: Optional[bool] = None,
external_id: Optional[str] = None,
mount_options: Optional[CsiVolumeRegistrationMountOptionsArgs] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
parameters: Optional[Mapping[str, str]] = None,
plugin_id: Optional[str] = None,
secrets: Optional[Mapping[str, str]] = None,
topology_request: Optional[CsiVolumeRegistrationTopologyRequestArgs] = None,
volume_id: Optional[str] = None)
@overload
def CsiVolumeRegistration(resource_name: str,
args: CsiVolumeRegistrationArgs,
opts: Optional[ResourceOptions] = None)func NewCsiVolumeRegistration(ctx *Context, name string, args CsiVolumeRegistrationArgs, opts ...ResourceOption) (*CsiVolumeRegistration, error)public CsiVolumeRegistration(string name, CsiVolumeRegistrationArgs args, CustomResourceOptions? opts = null)
public CsiVolumeRegistration(String name, CsiVolumeRegistrationArgs args)
public CsiVolumeRegistration(String name, CsiVolumeRegistrationArgs args, CustomResourceOptions options)
type: nomad:CsiVolumeRegistration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CsiVolumeRegistrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CsiVolumeRegistrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CsiVolumeRegistrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CsiVolumeRegistrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CsiVolumeRegistrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CsiVolumeRegistration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The CsiVolumeRegistration resource accepts the following input properties:
- External
Id string (string: <required>)- The ID of the physical volume from the storage provider.- Plugin
Id string (string: <required>)- The ID of the Nomad plugin for registering this volume.- Volume
Id string (string: <required>)- The unique ID of the volume.- Capabilities
List<Csi
Volume Registration Capability> (``Capability``: <required>)- Options for validating the capability of a volume.- Context Dictionary<string, string>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- Deregister
On boolDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- Mount
Options CsiVolume Registration Mount Options (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- Name string
(string: <required>)- The display name for the volume.- Namespace string
(string: "default")- The namespace in which to register the volume.- Parameters Dictionary<string, string>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- Secrets Dictionary<string, string>
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- Topology
Request CsiVolume Registration Topology Request (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- External
Id string (string: <required>)- The ID of the physical volume from the storage provider.- Plugin
Id string (string: <required>)- The ID of the Nomad plugin for registering this volume.- Volume
Id string (string: <required>)- The unique ID of the volume.- Capabilities
[]Csi
Volume Registration Capability Args (``Capability``: <required>)- Options for validating the capability of a volume.- Context map[string]string
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- Deregister
On boolDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- Mount
Options CsiVolume Registration Mount Options Args (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- Name string
(string: <required>)- The display name for the volume.- Namespace string
(string: "default")- The namespace in which to register the volume.- Parameters map[string]string
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- Secrets map[string]string
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- Topology
Request CsiVolume Registration Topology Request Args (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- external
Id String (string: <required>)- The ID of the physical volume from the storage provider.- plugin
Id String (string: <required>)- The ID of the Nomad plugin for registering this volume.- volume
Id String (string: <required>)- The unique ID of the volume.- capabilities
List<Csi
Volume Registration Capability> (``Capability``: <required>)- Options for validating the capability of a volume.- context Map<String,String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- deregister
On BooleanDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- mount
Options CsiVolume Registration Mount Options (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name String
(string: <required>)- The display name for the volume.- namespace String
(string: "default")- The namespace in which to register the volume.- parameters Map<String,String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- secrets Map<String,String>
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topology
Request CsiVolume Registration Topology Request (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- external
Id string (string: <required>)- The ID of the physical volume from the storage provider.- plugin
Id string (string: <required>)- The ID of the Nomad plugin for registering this volume.- volume
Id string (string: <required>)- The unique ID of the volume.- capabilities
Csi
Volume Registration Capability[] (``Capability``: <required>)- Options for validating the capability of a volume.- context {[key: string]: string}
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- deregister
On booleanDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- mount
Options CsiVolume Registration Mount Options (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name string
(string: <required>)- The display name for the volume.- namespace string
(string: "default")- The namespace in which to register the volume.- parameters {[key: string]: string}
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- secrets {[key: string]: string}
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topology
Request CsiVolume Registration Topology Request (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- external_
id str (string: <required>)- The ID of the physical volume from the storage provider.- plugin_
id str (string: <required>)- The ID of the Nomad plugin for registering this volume.- volume_
id str (string: <required>)- The unique ID of the volume.- capabilities
Sequence[Csi
Volume Registration Capability Args] (``Capability``: <required>)- Options for validating the capability of a volume.- context Mapping[str, str]
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- deregister_
on_ booldestroy (boolean: false)- If true, the volume will be deregistered on destroy.- mount_
options CsiVolume Registration Mount Options Args (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name str
(string: <required>)- The display name for the volume.- namespace str
(string: "default")- The namespace in which to register the volume.- parameters Mapping[str, str]
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- secrets Mapping[str, str]
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topology_
request CsiVolume Registration Topology Request Args (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- external
Id String (string: <required>)- The ID of the physical volume from the storage provider.- plugin
Id String (string: <required>)- The ID of the Nomad plugin for registering this volume.- volume
Id String (string: <required>)- The unique ID of the volume.- capabilities List<Property Map>
(``Capability``: <required>)- Options for validating the capability of a volume.- context Map<String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- deregister
On BooleanDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- mount
Options Property Map (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name String
(string: <required>)- The display name for the volume.- namespace String
(string: "default")- The namespace in which to register the volume.- parameters Map<String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- secrets Map<String>
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topology
Request Property Map (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
Outputs
All input properties are implicitly available as output properties. Additionally, the CsiVolumeRegistration resource produces the following output properties:
- Controller
Required bool (boolean)- Controllers
Expected int (integer)- Controllers
Healthy int (integer)- Id string
The provider-assigned unique ID for this managed resource.
- Nodes
Expected int (integer)- Nodes
Healthy int (integer)- Plugin
Provider string (string)- Plugin
Provider stringVersion (string)- Schedulable bool
(boolean)- Topologies
List<Csi
Volume Registration Topology> (List of topologies)
- Controller
Required bool (boolean)- Controllers
Expected int (integer)- Controllers
Healthy int (integer)- Id string
The provider-assigned unique ID for this managed resource.
- Nodes
Expected int (integer)- Nodes
Healthy int (integer)- Plugin
Provider string (string)- Plugin
Provider stringVersion (string)- Schedulable bool
(boolean)- Topologies
[]Csi
Volume Registration Topology (List of topologies)
- controller
Required Boolean (boolean)- controllers
Expected Integer (integer)- controllers
Healthy Integer (integer)- id String
The provider-assigned unique ID for this managed resource.
- nodes
Expected Integer (integer)- nodes
Healthy Integer (integer)- plugin
Provider String (string)- plugin
Provider StringVersion (string)- schedulable Boolean
(boolean)- topologies
List<Csi
Volume Registration Topology> (List of topologies)
- controller
Required boolean (boolean)- controllers
Expected number (integer)- controllers
Healthy number (integer)- id string
The provider-assigned unique ID for this managed resource.
- nodes
Expected number (integer)- nodes
Healthy number (integer)- plugin
Provider string (string)- plugin
Provider stringVersion (string)- schedulable boolean
(boolean)- topologies
Csi
Volume Registration Topology[] (List of topologies)
- controller_
required bool (boolean)- controllers_
expected int (integer)- controllers_
healthy int (integer)- id str
The provider-assigned unique ID for this managed resource.
- nodes_
expected int (integer)- nodes_
healthy int (integer)- plugin_
provider str (string)- plugin_
provider_ strversion (string)- schedulable bool
(boolean)- topologies
Sequence[Csi
Volume Registration Topology] (List of topologies)
- controller
Required Boolean (boolean)- controllers
Expected Number (integer)- controllers
Healthy Number (integer)- id String
The provider-assigned unique ID for this managed resource.
- nodes
Expected Number (integer)- nodes
Healthy Number (integer)- plugin
Provider String (string)- plugin
Provider StringVersion (string)- schedulable Boolean
(boolean)- topologies List<Property Map>
(List of topologies)
Look up Existing CsiVolumeRegistration Resource
Get an existing CsiVolumeRegistration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CsiVolumeRegistrationState, opts?: CustomResourceOptions): CsiVolumeRegistration@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
capabilities: Optional[Sequence[CsiVolumeRegistrationCapabilityArgs]] = None,
context: Optional[Mapping[str, str]] = None,
controller_required: Optional[bool] = None,
controllers_expected: Optional[int] = None,
controllers_healthy: Optional[int] = None,
deregister_on_destroy: Optional[bool] = None,
external_id: Optional[str] = None,
mount_options: Optional[CsiVolumeRegistrationMountOptionsArgs] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
nodes_expected: Optional[int] = None,
nodes_healthy: Optional[int] = None,
parameters: Optional[Mapping[str, str]] = None,
plugin_id: Optional[str] = None,
plugin_provider: Optional[str] = None,
plugin_provider_version: Optional[str] = None,
schedulable: Optional[bool] = None,
secrets: Optional[Mapping[str, str]] = None,
topologies: Optional[Sequence[CsiVolumeRegistrationTopologyArgs]] = None,
topology_request: Optional[CsiVolumeRegistrationTopologyRequestArgs] = None,
volume_id: Optional[str] = None) -> CsiVolumeRegistrationfunc GetCsiVolumeRegistration(ctx *Context, name string, id IDInput, state *CsiVolumeRegistrationState, opts ...ResourceOption) (*CsiVolumeRegistration, error)public static CsiVolumeRegistration Get(string name, Input<string> id, CsiVolumeRegistrationState? state, CustomResourceOptions? opts = null)public static CsiVolumeRegistration get(String name, Output<String> id, CsiVolumeRegistrationState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Capabilities
List<Csi
Volume Registration Capability> (``Capability``: <required>)- Options for validating the capability of a volume.- Context Dictionary<string, string>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- Controller
Required bool (boolean)- Controllers
Expected int (integer)- Controllers
Healthy int (integer)- Deregister
On boolDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- External
Id string (string: <required>)- The ID of the physical volume from the storage provider.- Mount
Options CsiVolume Registration Mount Options (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- Name string
(string: <required>)- The display name for the volume.- Namespace string
(string: "default")- The namespace in which to register the volume.- Nodes
Expected int (integer)- Nodes
Healthy int (integer)- Parameters Dictionary<string, string>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- Plugin
Id string (string: <required>)- The ID of the Nomad plugin for registering this volume.- Plugin
Provider string (string)- Plugin
Provider stringVersion (string)- Schedulable bool
(boolean)- Secrets Dictionary<string, string>
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- Topologies
List<Csi
Volume Registration Topology> (List of topologies)- Topology
Request CsiVolume Registration Topology Request (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- Volume
Id string (string: <required>)- The unique ID of the volume.
- Capabilities
[]Csi
Volume Registration Capability Args (``Capability``: <required>)- Options for validating the capability of a volume.- Context map[string]string
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- Controller
Required bool (boolean)- Controllers
Expected int (integer)- Controllers
Healthy int (integer)- Deregister
On boolDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- External
Id string (string: <required>)- The ID of the physical volume from the storage provider.- Mount
Options CsiVolume Registration Mount Options Args (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- Name string
(string: <required>)- The display name for the volume.- Namespace string
(string: "default")- The namespace in which to register the volume.- Nodes
Expected int (integer)- Nodes
Healthy int (integer)- Parameters map[string]string
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- Plugin
Id string (string: <required>)- The ID of the Nomad plugin for registering this volume.- Plugin
Provider string (string)- Plugin
Provider stringVersion (string)- Schedulable bool
(boolean)- Secrets map[string]string
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- Topologies
[]Csi
Volume Registration Topology Args (List of topologies)- Topology
Request CsiVolume Registration Topology Request Args (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- Volume
Id string (string: <required>)- The unique ID of the volume.
- capabilities
List<Csi
Volume Registration Capability> (``Capability``: <required>)- Options for validating the capability of a volume.- context Map<String,String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- controller
Required Boolean (boolean)- controllers
Expected Integer (integer)- controllers
Healthy Integer (integer)- deregister
On BooleanDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- external
Id String (string: <required>)- The ID of the physical volume from the storage provider.- mount
Options CsiVolume Registration Mount Options (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name String
(string: <required>)- The display name for the volume.- namespace String
(string: "default")- The namespace in which to register the volume.- nodes
Expected Integer (integer)- nodes
Healthy Integer (integer)- parameters Map<String,String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- plugin
Id String (string: <required>)- The ID of the Nomad plugin for registering this volume.- plugin
Provider String (string)- plugin
Provider StringVersion (string)- schedulable Boolean
(boolean)- secrets Map<String,String>
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topologies
List<Csi
Volume Registration Topology> (List of topologies)- topology
Request CsiVolume Registration Topology Request (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume
Id String (string: <required>)- The unique ID of the volume.
- capabilities
Csi
Volume Registration Capability[] (``Capability``: <required>)- Options for validating the capability of a volume.- context {[key: string]: string}
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- controller
Required boolean (boolean)- controllers
Expected number (integer)- controllers
Healthy number (integer)- deregister
On booleanDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- external
Id string (string: <required>)- The ID of the physical volume from the storage provider.- mount
Options CsiVolume Registration Mount Options (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name string
(string: <required>)- The display name for the volume.- namespace string
(string: "default")- The namespace in which to register the volume.- nodes
Expected number (integer)- nodes
Healthy number (integer)- parameters {[key: string]: string}
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- plugin
Id string (string: <required>)- The ID of the Nomad plugin for registering this volume.- plugin
Provider string (string)- plugin
Provider stringVersion (string)- schedulable boolean
(boolean)- secrets {[key: string]: string}
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topologies
Csi
Volume Registration Topology[] (List of topologies)- topology
Request CsiVolume Registration Topology Request (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume
Id string (string: <required>)- The unique ID of the volume.
- capabilities
Sequence[Csi
Volume Registration Capability Args] (``Capability``: <required>)- Options for validating the capability of a volume.- context Mapping[str, str]
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- controller_
required bool (boolean)- controllers_
expected int (integer)- controllers_
healthy int (integer)- deregister_
on_ booldestroy (boolean: false)- If true, the volume will be deregistered on destroy.- external_
id str (string: <required>)- The ID of the physical volume from the storage provider.- mount_
options CsiVolume Registration Mount Options Args (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name str
(string: <required>)- The display name for the volume.- namespace str
(string: "default")- The namespace in which to register the volume.- nodes_
expected int (integer)- nodes_
healthy int (integer)- parameters Mapping[str, str]
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- plugin_
id str (string: <required>)- The ID of the Nomad plugin for registering this volume.- plugin_
provider str (string)- plugin_
provider_ strversion (string)- schedulable bool
(boolean)- secrets Mapping[str, str]
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topologies
Sequence[Csi
Volume Registration Topology Args] (List of topologies)- topology_
request CsiVolume Registration Topology Request Args (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume_
id str (string: <required>)- The unique ID of the volume.
- capabilities List<Property Map>
(``Capability``: <required>)- Options for validating the capability of a volume.- context Map<String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to validate the volume.- controller
Required Boolean (boolean)- controllers
Expected Number (integer)- controllers
Healthy Number (integer)- deregister
On BooleanDestroy (boolean: false)- If true, the volume will be deregistered on destroy.- external
Id String (string: <required>)- The ID of the physical volume from the storage provider.- mount
Options Property Map (block: <optional>)Options for mountingblock-devicevolumes without a pre-formatted file system.- name String
(string: <required>)- The display name for the volume.- namespace String
(string: "default")- The namespace in which to register the volume.- nodes
Expected Number (integer)- nodes
Healthy Number (integer)- parameters Map<String>
(map[string]string: <optional>)- An optional key-value map of strings passed directly to the CSI plugin to configure the volume.- plugin
Id String (string: <required>)- The ID of the Nomad plugin for registering this volume.- plugin
Provider String (string)- plugin
Provider StringVersion (string)- schedulable Boolean
(boolean)- secrets Map<String>
(map[string]string: <optional>)- An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- topologies List<Property Map>
(List of topologies)- topology
Request Property Map (``TopologyRequest``: <optional>)- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume
Id String (string: <required>)- The unique ID of the volume.
Supporting Types
CsiVolumeRegistrationCapability, CsiVolumeRegistrationCapabilityArgs
- Access
Mode string (string: <required>)- Defines whether a volume should be available concurrently. Possible values are:single-node-reader-onlysingle-node-writermulti-node-reader-onlymulti-node-single-writermulti-node-multi-writer
- Attachment
Mode string (string: <required>)- The storage API that will be used by the volume. Possible values are:block-devicefile-system
- Access
Mode string (string: <required>)- Defines whether a volume should be available concurrently. Possible values are:single-node-reader-onlysingle-node-writermulti-node-reader-onlymulti-node-single-writermulti-node-multi-writer
- Attachment
Mode string (string: <required>)- The storage API that will be used by the volume. Possible values are:block-devicefile-system
- access
Mode String (string: <required>)- Defines whether a volume should be available concurrently. Possible values are:single-node-reader-onlysingle-node-writermulti-node-reader-onlymulti-node-single-writermulti-node-multi-writer
- attachment
Mode String (string: <required>)- The storage API that will be used by the volume. Possible values are:block-devicefile-system
- access
Mode string (string: <required>)- Defines whether a volume should be available concurrently. Possible values are:single-node-reader-onlysingle-node-writermulti-node-reader-onlymulti-node-single-writermulti-node-multi-writer
- attachment
Mode string (string: <required>)- The storage API that will be used by the volume. Possible values are:block-devicefile-system
- access_
mode str (string: <required>)- Defines whether a volume should be available concurrently. Possible values are:single-node-reader-onlysingle-node-writermulti-node-reader-onlymulti-node-single-writermulti-node-multi-writer
- attachment_
mode str (string: <required>)- The storage API that will be used by the volume. Possible values are:block-devicefile-system
- access
Mode String (string: <required>)- Defines whether a volume should be available concurrently. Possible values are:single-node-reader-onlysingle-node-writermulti-node-reader-onlymulti-node-single-writermulti-node-multi-writer
- attachment
Mode String (string: <required>)- The storage API that will be used by the volume. Possible values are:block-devicefile-system
CsiVolumeRegistrationMountOptions, CsiVolumeRegistrationMountOptionsArgs
- Fs
Type string (string: <optional>)- The file system type.- Mount
Flags List<string> ([]string: <optional>)- The flags passed tomount.
- Fs
Type string (string: <optional>)- The file system type.- Mount
Flags []string ([]string: <optional>)- The flags passed tomount.
- fs
Type String (string: <optional>)- The file system type.- mount
Flags List<String> ([]string: <optional>)- The flags passed tomount.
- fs
Type string (string: <optional>)- The file system type.- mount
Flags string[] ([]string: <optional>)- The flags passed tomount.
- fs_
type str (string: <optional>)- The file system type.- mount_
flags Sequence[str] ([]string: <optional>)- The flags passed tomount.
- fs
Type String (string: <optional>)- The file system type.- mount
Flags List<String> ([]string: <optional>)- The flags passed tomount.
CsiVolumeRegistrationTopology, CsiVolumeRegistrationTopologyArgs
- Segments Dictionary<string, string>
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- Segments map[string]string
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments Map<String,String>
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments {[key: string]: string}
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments Mapping[str, str]
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments Map<String>
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
CsiVolumeRegistrationTopologyRequest, CsiVolumeRegistrationTopologyRequestArgs
- Required
Csi
Volume Registration Topology Request Required (``Topology``: <optional>)- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- Required
Csi
Volume Registration Topology Request Required (``Topology``: <optional>)- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- required
Csi
Volume Registration Topology Request Required (``Topology``: <optional>)- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- required
Csi
Volume Registration Topology Request Required (``Topology``: <optional>)- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- required
Csi
Volume Registration Topology Request Required (``Topology``: <optional>)- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- required Property Map
(``Topology``: <optional>)- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
CsiVolumeRegistrationTopologyRequestRequired, CsiVolumeRegistrationTopologyRequestRequiredArgs
CsiVolumeRegistrationTopologyRequestRequiredTopology, CsiVolumeRegistrationTopologyRequestRequiredTopologyArgs
- Segments Dictionary<string, string>
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- Segments map[string]string
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments Map<String,String>
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments {[key: string]: string}
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments Mapping[str, str]
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
- segments Map<String>
(map[string]string)- Define the attributes for the topology request.In addition to the above arguments, the following attributes are exported and can be referenced:
Package Details
- Repository
- HashiCorp Nomad pulumi/pulumi-nomad
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
nomadTerraform Provider.