rancher2.ClusterV2
Explore with Pulumi AI
Import
Clusters v2 can be imported using the Rancher Cluster v2 ID, that is in the form <FLEET_NAMESPACE>/<CLUSTER_NAME>
$ pulumi import rancher2:index/clusterV2:ClusterV2 foo <FLEET_NAMESPACE>/<CLUSTER_NAME>
Create ClusterV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClusterV2(name: string, args: ClusterV2Args, opts?: CustomResourceOptions);
@overload
def ClusterV2(resource_name: str,
args: ClusterV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def ClusterV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
kubernetes_version: Optional[str] = None,
default_pod_security_policy_template_name: Optional[str] = None,
fleet_agent_deployment_customizations: Optional[Sequence[ClusterV2FleetAgentDeploymentCustomizationArgs]] = None,
cluster_agent_deployment_customizations: Optional[Sequence[ClusterV2ClusterAgentDeploymentCustomizationArgs]] = None,
default_cluster_role_for_project_members: Optional[str] = None,
default_pod_security_admission_configuration_template_name: Optional[str] = None,
agent_env_vars: Optional[Sequence[ClusterV2AgentEnvVarArgs]] = None,
enable_network_policy: Optional[bool] = None,
cloud_credential_secret_name: Optional[str] = None,
fleet_namespace: Optional[str] = None,
annotations: Optional[Mapping[str, Any]] = None,
labels: Optional[Mapping[str, Any]] = None,
local_auth_endpoint: Optional[ClusterV2LocalAuthEndpointArgs] = None,
name: Optional[str] = None,
rke_config: Optional[ClusterV2RkeConfigArgs] = None)
func NewClusterV2(ctx *Context, name string, args ClusterV2Args, opts ...ResourceOption) (*ClusterV2, error)
public ClusterV2(string name, ClusterV2Args args, CustomResourceOptions? opts = null)
public ClusterV2(String name, ClusterV2Args args)
public ClusterV2(String name, ClusterV2Args args, CustomResourceOptions options)
type: rancher2:ClusterV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ClusterV2Args
- 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 ClusterV2Args
- 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 ClusterV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterV2Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var clusterV2Resource = new Rancher2.ClusterV2("clusterV2Resource", new()
{
KubernetesVersion = "string",
DefaultPodSecurityPolicyTemplateName = "string",
FleetAgentDeploymentCustomizations = new[]
{
new Rancher2.Inputs.ClusterV2FleetAgentDeploymentCustomizationArgs
{
AppendTolerations = new[]
{
new Rancher2.Inputs.ClusterV2FleetAgentDeploymentCustomizationAppendTolerationArgs
{
Key = "string",
Effect = "string",
Operator = "string",
Seconds = 0,
Value = "string",
},
},
OverrideAffinity = "string",
OverrideResourceRequirements = new[]
{
new Rancher2.Inputs.ClusterV2FleetAgentDeploymentCustomizationOverrideResourceRequirementArgs
{
CpuLimit = "string",
CpuRequest = "string",
MemoryLimit = "string",
MemoryRequest = "string",
},
},
},
},
ClusterAgentDeploymentCustomizations = new[]
{
new Rancher2.Inputs.ClusterV2ClusterAgentDeploymentCustomizationArgs
{
AppendTolerations = new[]
{
new Rancher2.Inputs.ClusterV2ClusterAgentDeploymentCustomizationAppendTolerationArgs
{
Key = "string",
Effect = "string",
Operator = "string",
Seconds = 0,
Value = "string",
},
},
OverrideAffinity = "string",
OverrideResourceRequirements = new[]
{
new Rancher2.Inputs.ClusterV2ClusterAgentDeploymentCustomizationOverrideResourceRequirementArgs
{
CpuLimit = "string",
CpuRequest = "string",
MemoryLimit = "string",
MemoryRequest = "string",
},
},
},
},
DefaultClusterRoleForProjectMembers = "string",
DefaultPodSecurityAdmissionConfigurationTemplateName = "string",
AgentEnvVars = new[]
{
new Rancher2.Inputs.ClusterV2AgentEnvVarArgs
{
Name = "string",
Value = "string",
},
},
EnableNetworkPolicy = false,
CloudCredentialSecretName = "string",
FleetNamespace = "string",
Annotations =
{
{ "string", "any" },
},
Labels =
{
{ "string", "any" },
},
LocalAuthEndpoint = new Rancher2.Inputs.ClusterV2LocalAuthEndpointArgs
{
CaCerts = "string",
Enabled = false,
Fqdn = "string",
},
Name = "string",
RkeConfig = new Rancher2.Inputs.ClusterV2RkeConfigArgs
{
AdditionalManifest = "string",
ChartValues = "string",
Etcd = new Rancher2.Inputs.ClusterV2RkeConfigEtcdArgs
{
DisableSnapshots = false,
S3Config = new Rancher2.Inputs.ClusterV2RkeConfigEtcdS3ConfigArgs
{
Bucket = "string",
Endpoint = "string",
CloudCredentialName = "string",
EndpointCa = "string",
Folder = "string",
Region = "string",
SkipSslVerify = false,
},
SnapshotRetention = 0,
SnapshotScheduleCron = "string",
},
EtcdSnapshotCreate = new Rancher2.Inputs.ClusterV2RkeConfigEtcdSnapshotCreateArgs
{
Generation = 0,
},
EtcdSnapshotRestore = new Rancher2.Inputs.ClusterV2RkeConfigEtcdSnapshotRestoreArgs
{
Generation = 0,
Name = "string",
RestoreRkeConfig = "string",
},
MachineGlobalConfig = "string",
MachinePoolDefaults = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachinePoolDefaultArgs
{
HostnameLengthLimit = 0,
},
},
MachinePools = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachinePoolArgs
{
MachineConfig = new Rancher2.Inputs.ClusterV2RkeConfigMachinePoolMachineConfigArgs
{
Kind = "string",
Name = "string",
ApiVersion = "string",
},
Name = "string",
HostnameLengthLimit = 0,
NodeDrainTimeout = 0,
EtcdRole = false,
Annotations =
{
{ "string", "any" },
},
Labels =
{
{ "string", "any" },
},
ControlPlaneRole = false,
MachineLabels =
{
{ "string", "any" },
},
MaxUnhealthy = "string",
CloudCredentialSecretName = "string",
DrainBeforeDelete = false,
NodeStartupTimeoutSeconds = 0,
Paused = false,
Quantity = 0,
RollingUpdate = new Rancher2.Inputs.ClusterV2RkeConfigMachinePoolRollingUpdateArgs
{
MaxSurge = "string",
MaxUnavailable = "string",
},
Taints = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachinePoolTaintArgs
{
Key = "string",
Value = "string",
Effect = "string",
},
},
UnhealthyNodeTimeoutSeconds = 0,
UnhealthyRange = "string",
WorkerRole = false,
},
},
MachineSelectorConfigs = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorConfigArgs
{
Config = "string",
MachineLabelSelector = new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorArgs
{
MatchExpressions = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorMatchExpressionArgs
{
Key = "string",
Operator = "string",
Values = new[]
{
"string",
},
},
},
MatchLabels =
{
{ "string", "any" },
},
},
},
},
MachineSelectorFiles = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileArgs
{
FileSources = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileFileSourceArgs
{
Configmap = new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapArgs
{
Name = "string",
DefaultPermissions = "string",
Items = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapItemArgs
{
Key = "string",
Path = "string",
Dynamic = false,
Hash = "string",
Permissions = "string",
},
},
},
Secret = new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileFileSourceSecretArgs
{
Name = "string",
DefaultPermissions = "string",
Items = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileFileSourceSecretItemArgs
{
Key = "string",
Path = "string",
Dynamic = false,
Hash = "string",
Permissions = "string",
},
},
},
},
},
MachineLabelSelector = new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorArgs
{
MatchExpressions = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorMatchExpressionArgs
{
Key = "string",
Operator = "string",
Values = new[]
{
"string",
},
},
},
MatchLabels =
{
{ "string", "any" },
},
},
},
},
Registries = new Rancher2.Inputs.ClusterV2RkeConfigRegistriesArgs
{
Configs = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigRegistriesConfigArgs
{
Hostname = "string",
AuthConfigSecretName = "string",
CaBundle = "string",
Insecure = false,
TlsSecretName = "string",
},
},
Mirrors = new[]
{
new Rancher2.Inputs.ClusterV2RkeConfigRegistriesMirrorArgs
{
Hostname = "string",
Endpoints = new[]
{
"string",
},
Rewrites =
{
{ "string", "any" },
},
},
},
},
RotateCertificates = new Rancher2.Inputs.ClusterV2RkeConfigRotateCertificatesArgs
{
Generation = 0,
Services = new[]
{
"string",
},
},
UpgradeStrategy = new Rancher2.Inputs.ClusterV2RkeConfigUpgradeStrategyArgs
{
ControlPlaneConcurrency = "string",
ControlPlaneDrainOptions = new Rancher2.Inputs.ClusterV2RkeConfigUpgradeStrategyControlPlaneDrainOptionsArgs
{
DeleteEmptyDirData = false,
DisableEviction = false,
Enabled = false,
Force = false,
GracePeriod = 0,
IgnoreDaemonSets = false,
IgnoreErrors = false,
SkipWaitForDeleteTimeoutSeconds = 0,
Timeout = 0,
},
WorkerConcurrency = "string",
WorkerDrainOptions = new Rancher2.Inputs.ClusterV2RkeConfigUpgradeStrategyWorkerDrainOptionsArgs
{
DeleteEmptyDirData = false,
DisableEviction = false,
Enabled = false,
Force = false,
GracePeriod = 0,
IgnoreDaemonSets = false,
IgnoreErrors = false,
SkipWaitForDeleteTimeoutSeconds = 0,
Timeout = 0,
},
},
},
});
example, err := rancher2.NewClusterV2(ctx, "clusterV2Resource", &rancher2.ClusterV2Args{
KubernetesVersion: pulumi.String("string"),
DefaultPodSecurityPolicyTemplateName: pulumi.String("string"),
FleetAgentDeploymentCustomizations: rancher2.ClusterV2FleetAgentDeploymentCustomizationArray{
&rancher2.ClusterV2FleetAgentDeploymentCustomizationArgs{
AppendTolerations: rancher2.ClusterV2FleetAgentDeploymentCustomizationAppendTolerationArray{
&rancher2.ClusterV2FleetAgentDeploymentCustomizationAppendTolerationArgs{
Key: pulumi.String("string"),
Effect: pulumi.String("string"),
Operator: pulumi.String("string"),
Seconds: pulumi.Int(0),
Value: pulumi.String("string"),
},
},
OverrideAffinity: pulumi.String("string"),
OverrideResourceRequirements: rancher2.ClusterV2FleetAgentDeploymentCustomizationOverrideResourceRequirementArray{
&rancher2.ClusterV2FleetAgentDeploymentCustomizationOverrideResourceRequirementArgs{
CpuLimit: pulumi.String("string"),
CpuRequest: pulumi.String("string"),
MemoryLimit: pulumi.String("string"),
MemoryRequest: pulumi.String("string"),
},
},
},
},
ClusterAgentDeploymentCustomizations: rancher2.ClusterV2ClusterAgentDeploymentCustomizationArray{
&rancher2.ClusterV2ClusterAgentDeploymentCustomizationArgs{
AppendTolerations: rancher2.ClusterV2ClusterAgentDeploymentCustomizationAppendTolerationArray{
&rancher2.ClusterV2ClusterAgentDeploymentCustomizationAppendTolerationArgs{
Key: pulumi.String("string"),
Effect: pulumi.String("string"),
Operator: pulumi.String("string"),
Seconds: pulumi.Int(0),
Value: pulumi.String("string"),
},
},
OverrideAffinity: pulumi.String("string"),
OverrideResourceRequirements: rancher2.ClusterV2ClusterAgentDeploymentCustomizationOverrideResourceRequirementArray{
&rancher2.ClusterV2ClusterAgentDeploymentCustomizationOverrideResourceRequirementArgs{
CpuLimit: pulumi.String("string"),
CpuRequest: pulumi.String("string"),
MemoryLimit: pulumi.String("string"),
MemoryRequest: pulumi.String("string"),
},
},
},
},
DefaultClusterRoleForProjectMembers: pulumi.String("string"),
DefaultPodSecurityAdmissionConfigurationTemplateName: pulumi.String("string"),
AgentEnvVars: rancher2.ClusterV2AgentEnvVarArray{
&rancher2.ClusterV2AgentEnvVarArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
EnableNetworkPolicy: pulumi.Bool(false),
CloudCredentialSecretName: pulumi.String("string"),
FleetNamespace: pulumi.String("string"),
Annotations: pulumi.Map{
"string": pulumi.Any("any"),
},
Labels: pulumi.Map{
"string": pulumi.Any("any"),
},
LocalAuthEndpoint: &rancher2.ClusterV2LocalAuthEndpointArgs{
CaCerts: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Fqdn: pulumi.String("string"),
},
Name: pulumi.String("string"),
RkeConfig: &rancher2.ClusterV2RkeConfigArgs{
AdditionalManifest: pulumi.String("string"),
ChartValues: pulumi.String("string"),
Etcd: &rancher2.ClusterV2RkeConfigEtcdArgs{
DisableSnapshots: pulumi.Bool(false),
S3Config: &rancher2.ClusterV2RkeConfigEtcdS3ConfigArgs{
Bucket: pulumi.String("string"),
Endpoint: pulumi.String("string"),
CloudCredentialName: pulumi.String("string"),
EndpointCa: pulumi.String("string"),
Folder: pulumi.String("string"),
Region: pulumi.String("string"),
SkipSslVerify: pulumi.Bool(false),
},
SnapshotRetention: pulumi.Int(0),
SnapshotScheduleCron: pulumi.String("string"),
},
EtcdSnapshotCreate: &rancher2.ClusterV2RkeConfigEtcdSnapshotCreateArgs{
Generation: pulumi.Int(0),
},
EtcdSnapshotRestore: &rancher2.ClusterV2RkeConfigEtcdSnapshotRestoreArgs{
Generation: pulumi.Int(0),
Name: pulumi.String("string"),
RestoreRkeConfig: pulumi.String("string"),
},
MachineGlobalConfig: pulumi.String("string"),
MachinePoolDefaults: rancher2.ClusterV2RkeConfigMachinePoolDefaultArray{
&rancher2.ClusterV2RkeConfigMachinePoolDefaultArgs{
HostnameLengthLimit: pulumi.Int(0),
},
},
MachinePools: rancher2.ClusterV2RkeConfigMachinePoolArray{
&rancher2.ClusterV2RkeConfigMachinePoolArgs{
MachineConfig: &rancher2.ClusterV2RkeConfigMachinePoolMachineConfigArgs{
Kind: pulumi.String("string"),
Name: pulumi.String("string"),
ApiVersion: pulumi.String("string"),
},
Name: pulumi.String("string"),
HostnameLengthLimit: pulumi.Int(0),
NodeDrainTimeout: pulumi.Int(0),
EtcdRole: pulumi.Bool(false),
Annotations: pulumi.Map{
"string": pulumi.Any("any"),
},
Labels: pulumi.Map{
"string": pulumi.Any("any"),
},
ControlPlaneRole: pulumi.Bool(false),
MachineLabels: pulumi.Map{
"string": pulumi.Any("any"),
},
MaxUnhealthy: pulumi.String("string"),
CloudCredentialSecretName: pulumi.String("string"),
DrainBeforeDelete: pulumi.Bool(false),
NodeStartupTimeoutSeconds: pulumi.Int(0),
Paused: pulumi.Bool(false),
Quantity: pulumi.Int(0),
RollingUpdate: &rancher2.ClusterV2RkeConfigMachinePoolRollingUpdateArgs{
MaxSurge: pulumi.String("string"),
MaxUnavailable: pulumi.String("string"),
},
Taints: rancher2.ClusterV2RkeConfigMachinePoolTaintArray{
&rancher2.ClusterV2RkeConfigMachinePoolTaintArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Effect: pulumi.String("string"),
},
},
UnhealthyNodeTimeoutSeconds: pulumi.Int(0),
UnhealthyRange: pulumi.String("string"),
WorkerRole: pulumi.Bool(false),
},
},
MachineSelectorConfigs: rancher2.ClusterV2RkeConfigMachineSelectorConfigArray{
&rancher2.ClusterV2RkeConfigMachineSelectorConfigArgs{
Config: pulumi.String("string"),
MachineLabelSelector: &rancher2.ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorArgs{
MatchExpressions: rancher2.ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorMatchExpressionArray{
&rancher2.ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorMatchExpressionArgs{
Key: pulumi.String("string"),
Operator: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
MatchLabels: pulumi.Map{
"string": pulumi.Any("any"),
},
},
},
},
MachineSelectorFiles: rancher2.ClusterV2RkeConfigMachineSelectorFileArray{
&rancher2.ClusterV2RkeConfigMachineSelectorFileArgs{
FileSources: rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceArray{
&rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceArgs{
Configmap: &rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapArgs{
Name: pulumi.String("string"),
DefaultPermissions: pulumi.String("string"),
Items: rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapItemArray{
&rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapItemArgs{
Key: pulumi.String("string"),
Path: pulumi.String("string"),
Dynamic: pulumi.Bool(false),
Hash: pulumi.String("string"),
Permissions: pulumi.String("string"),
},
},
},
Secret: &rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceSecretArgs{
Name: pulumi.String("string"),
DefaultPermissions: pulumi.String("string"),
Items: rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceSecretItemArray{
&rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceSecretItemArgs{
Key: pulumi.String("string"),
Path: pulumi.String("string"),
Dynamic: pulumi.Bool(false),
Hash: pulumi.String("string"),
Permissions: pulumi.String("string"),
},
},
},
},
},
MachineLabelSelector: &rancher2.ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorArgs{
MatchExpressions: rancher2.ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorMatchExpressionArray{
&rancher2.ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorMatchExpressionArgs{
Key: pulumi.String("string"),
Operator: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
MatchLabels: pulumi.Map{
"string": pulumi.Any("any"),
},
},
},
},
Registries: &rancher2.ClusterV2RkeConfigRegistriesArgs{
Configs: rancher2.ClusterV2RkeConfigRegistriesConfigArray{
&rancher2.ClusterV2RkeConfigRegistriesConfigArgs{
Hostname: pulumi.String("string"),
AuthConfigSecretName: pulumi.String("string"),
CaBundle: pulumi.String("string"),
Insecure: pulumi.Bool(false),
TlsSecretName: pulumi.String("string"),
},
},
Mirrors: rancher2.ClusterV2RkeConfigRegistriesMirrorArray{
&rancher2.ClusterV2RkeConfigRegistriesMirrorArgs{
Hostname: pulumi.String("string"),
Endpoints: pulumi.StringArray{
pulumi.String("string"),
},
Rewrites: pulumi.Map{
"string": pulumi.Any("any"),
},
},
},
},
RotateCertificates: &rancher2.ClusterV2RkeConfigRotateCertificatesArgs{
Generation: pulumi.Int(0),
Services: pulumi.StringArray{
pulumi.String("string"),
},
},
UpgradeStrategy: &rancher2.ClusterV2RkeConfigUpgradeStrategyArgs{
ControlPlaneConcurrency: pulumi.String("string"),
ControlPlaneDrainOptions: &rancher2.ClusterV2RkeConfigUpgradeStrategyControlPlaneDrainOptionsArgs{
DeleteEmptyDirData: pulumi.Bool(false),
DisableEviction: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Force: pulumi.Bool(false),
GracePeriod: pulumi.Int(0),
IgnoreDaemonSets: pulumi.Bool(false),
IgnoreErrors: pulumi.Bool(false),
SkipWaitForDeleteTimeoutSeconds: pulumi.Int(0),
Timeout: pulumi.Int(0),
},
WorkerConcurrency: pulumi.String("string"),
WorkerDrainOptions: &rancher2.ClusterV2RkeConfigUpgradeStrategyWorkerDrainOptionsArgs{
DeleteEmptyDirData: pulumi.Bool(false),
DisableEviction: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Force: pulumi.Bool(false),
GracePeriod: pulumi.Int(0),
IgnoreDaemonSets: pulumi.Bool(false),
IgnoreErrors: pulumi.Bool(false),
SkipWaitForDeleteTimeoutSeconds: pulumi.Int(0),
Timeout: pulumi.Int(0),
},
},
},
})
var clusterV2Resource = new ClusterV2("clusterV2Resource", ClusterV2Args.builder()
.kubernetesVersion("string")
.defaultPodSecurityPolicyTemplateName("string")
.fleetAgentDeploymentCustomizations(ClusterV2FleetAgentDeploymentCustomizationArgs.builder()
.appendTolerations(ClusterV2FleetAgentDeploymentCustomizationAppendTolerationArgs.builder()
.key("string")
.effect("string")
.operator("string")
.seconds(0)
.value("string")
.build())
.overrideAffinity("string")
.overrideResourceRequirements(ClusterV2FleetAgentDeploymentCustomizationOverrideResourceRequirementArgs.builder()
.cpuLimit("string")
.cpuRequest("string")
.memoryLimit("string")
.memoryRequest("string")
.build())
.build())
.clusterAgentDeploymentCustomizations(ClusterV2ClusterAgentDeploymentCustomizationArgs.builder()
.appendTolerations(ClusterV2ClusterAgentDeploymentCustomizationAppendTolerationArgs.builder()
.key("string")
.effect("string")
.operator("string")
.seconds(0)
.value("string")
.build())
.overrideAffinity("string")
.overrideResourceRequirements(ClusterV2ClusterAgentDeploymentCustomizationOverrideResourceRequirementArgs.builder()
.cpuLimit("string")
.cpuRequest("string")
.memoryLimit("string")
.memoryRequest("string")
.build())
.build())
.defaultClusterRoleForProjectMembers("string")
.defaultPodSecurityAdmissionConfigurationTemplateName("string")
.agentEnvVars(ClusterV2AgentEnvVarArgs.builder()
.name("string")
.value("string")
.build())
.enableNetworkPolicy(false)
.cloudCredentialSecretName("string")
.fleetNamespace("string")
.annotations(Map.of("string", "any"))
.labels(Map.of("string", "any"))
.localAuthEndpoint(ClusterV2LocalAuthEndpointArgs.builder()
.caCerts("string")
.enabled(false)
.fqdn("string")
.build())
.name("string")
.rkeConfig(ClusterV2RkeConfigArgs.builder()
.additionalManifest("string")
.chartValues("string")
.etcd(ClusterV2RkeConfigEtcdArgs.builder()
.disableSnapshots(false)
.s3Config(ClusterV2RkeConfigEtcdS3ConfigArgs.builder()
.bucket("string")
.endpoint("string")
.cloudCredentialName("string")
.endpointCa("string")
.folder("string")
.region("string")
.skipSslVerify(false)
.build())
.snapshotRetention(0)
.snapshotScheduleCron("string")
.build())
.etcdSnapshotCreate(ClusterV2RkeConfigEtcdSnapshotCreateArgs.builder()
.generation(0)
.build())
.etcdSnapshotRestore(ClusterV2RkeConfigEtcdSnapshotRestoreArgs.builder()
.generation(0)
.name("string")
.restoreRkeConfig("string")
.build())
.machineGlobalConfig("string")
.machinePoolDefaults(ClusterV2RkeConfigMachinePoolDefaultArgs.builder()
.hostnameLengthLimit(0)
.build())
.machinePools(ClusterV2RkeConfigMachinePoolArgs.builder()
.machineConfig(ClusterV2RkeConfigMachinePoolMachineConfigArgs.builder()
.kind("string")
.name("string")
.apiVersion("string")
.build())
.name("string")
.hostnameLengthLimit(0)
.nodeDrainTimeout(0)
.etcdRole(false)
.annotations(Map.of("string", "any"))
.labels(Map.of("string", "any"))
.controlPlaneRole(false)
.machineLabels(Map.of("string", "any"))
.maxUnhealthy("string")
.cloudCredentialSecretName("string")
.drainBeforeDelete(false)
.nodeStartupTimeoutSeconds(0)
.paused(false)
.quantity(0)
.rollingUpdate(ClusterV2RkeConfigMachinePoolRollingUpdateArgs.builder()
.maxSurge("string")
.maxUnavailable("string")
.build())
.taints(ClusterV2RkeConfigMachinePoolTaintArgs.builder()
.key("string")
.value("string")
.effect("string")
.build())
.unhealthyNodeTimeoutSeconds(0)
.unhealthyRange("string")
.workerRole(false)
.build())
.machineSelectorConfigs(ClusterV2RkeConfigMachineSelectorConfigArgs.builder()
.config("string")
.machineLabelSelector(ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorArgs.builder()
.matchExpressions(ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorMatchExpressionArgs.builder()
.key("string")
.operator("string")
.values("string")
.build())
.matchLabels(Map.of("string", "any"))
.build())
.build())
.machineSelectorFiles(ClusterV2RkeConfigMachineSelectorFileArgs.builder()
.fileSources(ClusterV2RkeConfigMachineSelectorFileFileSourceArgs.builder()
.configmap(ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapArgs.builder()
.name("string")
.defaultPermissions("string")
.items(ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapItemArgs.builder()
.key("string")
.path("string")
.dynamic(false)
.hash("string")
.permissions("string")
.build())
.build())
.secret(ClusterV2RkeConfigMachineSelectorFileFileSourceSecretArgs.builder()
.name("string")
.defaultPermissions("string")
.items(ClusterV2RkeConfigMachineSelectorFileFileSourceSecretItemArgs.builder()
.key("string")
.path("string")
.dynamic(false)
.hash("string")
.permissions("string")
.build())
.build())
.build())
.machineLabelSelector(ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorArgs.builder()
.matchExpressions(ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorMatchExpressionArgs.builder()
.key("string")
.operator("string")
.values("string")
.build())
.matchLabels(Map.of("string", "any"))
.build())
.build())
.registries(ClusterV2RkeConfigRegistriesArgs.builder()
.configs(ClusterV2RkeConfigRegistriesConfigArgs.builder()
.hostname("string")
.authConfigSecretName("string")
.caBundle("string")
.insecure(false)
.tlsSecretName("string")
.build())
.mirrors(ClusterV2RkeConfigRegistriesMirrorArgs.builder()
.hostname("string")
.endpoints("string")
.rewrites(Map.of("string", "any"))
.build())
.build())
.rotateCertificates(ClusterV2RkeConfigRotateCertificatesArgs.builder()
.generation(0)
.services("string")
.build())
.upgradeStrategy(ClusterV2RkeConfigUpgradeStrategyArgs.builder()
.controlPlaneConcurrency("string")
.controlPlaneDrainOptions(ClusterV2RkeConfigUpgradeStrategyControlPlaneDrainOptionsArgs.builder()
.deleteEmptyDirData(false)
.disableEviction(false)
.enabled(false)
.force(false)
.gracePeriod(0)
.ignoreDaemonSets(false)
.ignoreErrors(false)
.skipWaitForDeleteTimeoutSeconds(0)
.timeout(0)
.build())
.workerConcurrency("string")
.workerDrainOptions(ClusterV2RkeConfigUpgradeStrategyWorkerDrainOptionsArgs.builder()
.deleteEmptyDirData(false)
.disableEviction(false)
.enabled(false)
.force(false)
.gracePeriod(0)
.ignoreDaemonSets(false)
.ignoreErrors(false)
.skipWaitForDeleteTimeoutSeconds(0)
.timeout(0)
.build())
.build())
.build())
.build());
cluster_v2_resource = rancher2.ClusterV2("clusterV2Resource",
kubernetes_version="string",
default_pod_security_policy_template_name="string",
fleet_agent_deployment_customizations=[rancher2.ClusterV2FleetAgentDeploymentCustomizationArgs(
append_tolerations=[rancher2.ClusterV2FleetAgentDeploymentCustomizationAppendTolerationArgs(
key="string",
effect="string",
operator="string",
seconds=0,
value="string",
)],
override_affinity="string",
override_resource_requirements=[rancher2.ClusterV2FleetAgentDeploymentCustomizationOverrideResourceRequirementArgs(
cpu_limit="string",
cpu_request="string",
memory_limit="string",
memory_request="string",
)],
)],
cluster_agent_deployment_customizations=[rancher2.ClusterV2ClusterAgentDeploymentCustomizationArgs(
append_tolerations=[rancher2.ClusterV2ClusterAgentDeploymentCustomizationAppendTolerationArgs(
key="string",
effect="string",
operator="string",
seconds=0,
value="string",
)],
override_affinity="string",
override_resource_requirements=[rancher2.ClusterV2ClusterAgentDeploymentCustomizationOverrideResourceRequirementArgs(
cpu_limit="string",
cpu_request="string",
memory_limit="string",
memory_request="string",
)],
)],
default_cluster_role_for_project_members="string",
default_pod_security_admission_configuration_template_name="string",
agent_env_vars=[rancher2.ClusterV2AgentEnvVarArgs(
name="string",
value="string",
)],
enable_network_policy=False,
cloud_credential_secret_name="string",
fleet_namespace="string",
annotations={
"string": "any",
},
labels={
"string": "any",
},
local_auth_endpoint=rancher2.ClusterV2LocalAuthEndpointArgs(
ca_certs="string",
enabled=False,
fqdn="string",
),
name="string",
rke_config=rancher2.ClusterV2RkeConfigArgs(
additional_manifest="string",
chart_values="string",
etcd=rancher2.ClusterV2RkeConfigEtcdArgs(
disable_snapshots=False,
s3_config=rancher2.ClusterV2RkeConfigEtcdS3ConfigArgs(
bucket="string",
endpoint="string",
cloud_credential_name="string",
endpoint_ca="string",
folder="string",
region="string",
skip_ssl_verify=False,
),
snapshot_retention=0,
snapshot_schedule_cron="string",
),
etcd_snapshot_create=rancher2.ClusterV2RkeConfigEtcdSnapshotCreateArgs(
generation=0,
),
etcd_snapshot_restore=rancher2.ClusterV2RkeConfigEtcdSnapshotRestoreArgs(
generation=0,
name="string",
restore_rke_config="string",
),
machine_global_config="string",
machine_pool_defaults=[rancher2.ClusterV2RkeConfigMachinePoolDefaultArgs(
hostname_length_limit=0,
)],
machine_pools=[rancher2.ClusterV2RkeConfigMachinePoolArgs(
machine_config=rancher2.ClusterV2RkeConfigMachinePoolMachineConfigArgs(
kind="string",
name="string",
api_version="string",
),
name="string",
hostname_length_limit=0,
node_drain_timeout=0,
etcd_role=False,
annotations={
"string": "any",
},
labels={
"string": "any",
},
control_plane_role=False,
machine_labels={
"string": "any",
},
max_unhealthy="string",
cloud_credential_secret_name="string",
drain_before_delete=False,
node_startup_timeout_seconds=0,
paused=False,
quantity=0,
rolling_update=rancher2.ClusterV2RkeConfigMachinePoolRollingUpdateArgs(
max_surge="string",
max_unavailable="string",
),
taints=[rancher2.ClusterV2RkeConfigMachinePoolTaintArgs(
key="string",
value="string",
effect="string",
)],
unhealthy_node_timeout_seconds=0,
unhealthy_range="string",
worker_role=False,
)],
machine_selector_configs=[rancher2.ClusterV2RkeConfigMachineSelectorConfigArgs(
config="string",
machine_label_selector=rancher2.ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorArgs(
match_expressions=[rancher2.ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorMatchExpressionArgs(
key="string",
operator="string",
values=["string"],
)],
match_labels={
"string": "any",
},
),
)],
machine_selector_files=[rancher2.ClusterV2RkeConfigMachineSelectorFileArgs(
file_sources=[rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceArgs(
configmap=rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapArgs(
name="string",
default_permissions="string",
items=[rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapItemArgs(
key="string",
path="string",
dynamic=False,
hash="string",
permissions="string",
)],
),
secret=rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceSecretArgs(
name="string",
default_permissions="string",
items=[rancher2.ClusterV2RkeConfigMachineSelectorFileFileSourceSecretItemArgs(
key="string",
path="string",
dynamic=False,
hash="string",
permissions="string",
)],
),
)],
machine_label_selector=rancher2.ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorArgs(
match_expressions=[rancher2.ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorMatchExpressionArgs(
key="string",
operator="string",
values=["string"],
)],
match_labels={
"string": "any",
},
),
)],
registries=rancher2.ClusterV2RkeConfigRegistriesArgs(
configs=[rancher2.ClusterV2RkeConfigRegistriesConfigArgs(
hostname="string",
auth_config_secret_name="string",
ca_bundle="string",
insecure=False,
tls_secret_name="string",
)],
mirrors=[rancher2.ClusterV2RkeConfigRegistriesMirrorArgs(
hostname="string",
endpoints=["string"],
rewrites={
"string": "any",
},
)],
),
rotate_certificates=rancher2.ClusterV2RkeConfigRotateCertificatesArgs(
generation=0,
services=["string"],
),
upgrade_strategy=rancher2.ClusterV2RkeConfigUpgradeStrategyArgs(
control_plane_concurrency="string",
control_plane_drain_options=rancher2.ClusterV2RkeConfigUpgradeStrategyControlPlaneDrainOptionsArgs(
delete_empty_dir_data=False,
disable_eviction=False,
enabled=False,
force=False,
grace_period=0,
ignore_daemon_sets=False,
ignore_errors=False,
skip_wait_for_delete_timeout_seconds=0,
timeout=0,
),
worker_concurrency="string",
worker_drain_options=rancher2.ClusterV2RkeConfigUpgradeStrategyWorkerDrainOptionsArgs(
delete_empty_dir_data=False,
disable_eviction=False,
enabled=False,
force=False,
grace_period=0,
ignore_daemon_sets=False,
ignore_errors=False,
skip_wait_for_delete_timeout_seconds=0,
timeout=0,
),
),
))
const clusterV2Resource = new rancher2.ClusterV2("clusterV2Resource", {
kubernetesVersion: "string",
defaultPodSecurityPolicyTemplateName: "string",
fleetAgentDeploymentCustomizations: [{
appendTolerations: [{
key: "string",
effect: "string",
operator: "string",
seconds: 0,
value: "string",
}],
overrideAffinity: "string",
overrideResourceRequirements: [{
cpuLimit: "string",
cpuRequest: "string",
memoryLimit: "string",
memoryRequest: "string",
}],
}],
clusterAgentDeploymentCustomizations: [{
appendTolerations: [{
key: "string",
effect: "string",
operator: "string",
seconds: 0,
value: "string",
}],
overrideAffinity: "string",
overrideResourceRequirements: [{
cpuLimit: "string",
cpuRequest: "string",
memoryLimit: "string",
memoryRequest: "string",
}],
}],
defaultClusterRoleForProjectMembers: "string",
defaultPodSecurityAdmissionConfigurationTemplateName: "string",
agentEnvVars: [{
name: "string",
value: "string",
}],
enableNetworkPolicy: false,
cloudCredentialSecretName: "string",
fleetNamespace: "string",
annotations: {
string: "any",
},
labels: {
string: "any",
},
localAuthEndpoint: {
caCerts: "string",
enabled: false,
fqdn: "string",
},
name: "string",
rkeConfig: {
additionalManifest: "string",
chartValues: "string",
etcd: {
disableSnapshots: false,
s3Config: {
bucket: "string",
endpoint: "string",
cloudCredentialName: "string",
endpointCa: "string",
folder: "string",
region: "string",
skipSslVerify: false,
},
snapshotRetention: 0,
snapshotScheduleCron: "string",
},
etcdSnapshotCreate: {
generation: 0,
},
etcdSnapshotRestore: {
generation: 0,
name: "string",
restoreRkeConfig: "string",
},
machineGlobalConfig: "string",
machinePoolDefaults: [{
hostnameLengthLimit: 0,
}],
machinePools: [{
machineConfig: {
kind: "string",
name: "string",
apiVersion: "string",
},
name: "string",
hostnameLengthLimit: 0,
nodeDrainTimeout: 0,
etcdRole: false,
annotations: {
string: "any",
},
labels: {
string: "any",
},
controlPlaneRole: false,
machineLabels: {
string: "any",
},
maxUnhealthy: "string",
cloudCredentialSecretName: "string",
drainBeforeDelete: false,
nodeStartupTimeoutSeconds: 0,
paused: false,
quantity: 0,
rollingUpdate: {
maxSurge: "string",
maxUnavailable: "string",
},
taints: [{
key: "string",
value: "string",
effect: "string",
}],
unhealthyNodeTimeoutSeconds: 0,
unhealthyRange: "string",
workerRole: false,
}],
machineSelectorConfigs: [{
config: "string",
machineLabelSelector: {
matchExpressions: [{
key: "string",
operator: "string",
values: ["string"],
}],
matchLabels: {
string: "any",
},
},
}],
machineSelectorFiles: [{
fileSources: [{
configmap: {
name: "string",
defaultPermissions: "string",
items: [{
key: "string",
path: "string",
dynamic: false,
hash: "string",
permissions: "string",
}],
},
secret: {
name: "string",
defaultPermissions: "string",
items: [{
key: "string",
path: "string",
dynamic: false,
hash: "string",
permissions: "string",
}],
},
}],
machineLabelSelector: {
matchExpressions: [{
key: "string",
operator: "string",
values: ["string"],
}],
matchLabels: {
string: "any",
},
},
}],
registries: {
configs: [{
hostname: "string",
authConfigSecretName: "string",
caBundle: "string",
insecure: false,
tlsSecretName: "string",
}],
mirrors: [{
hostname: "string",
endpoints: ["string"],
rewrites: {
string: "any",
},
}],
},
rotateCertificates: {
generation: 0,
services: ["string"],
},
upgradeStrategy: {
controlPlaneConcurrency: "string",
controlPlaneDrainOptions: {
deleteEmptyDirData: false,
disableEviction: false,
enabled: false,
force: false,
gracePeriod: 0,
ignoreDaemonSets: false,
ignoreErrors: false,
skipWaitForDeleteTimeoutSeconds: 0,
timeout: 0,
},
workerConcurrency: "string",
workerDrainOptions: {
deleteEmptyDirData: false,
disableEviction: false,
enabled: false,
force: false,
gracePeriod: 0,
ignoreDaemonSets: false,
ignoreErrors: false,
skipWaitForDeleteTimeoutSeconds: 0,
timeout: 0,
},
},
},
});
type: rancher2:ClusterV2
properties:
agentEnvVars:
- name: string
value: string
annotations:
string: any
cloudCredentialSecretName: string
clusterAgentDeploymentCustomizations:
- appendTolerations:
- effect: string
key: string
operator: string
seconds: 0
value: string
overrideAffinity: string
overrideResourceRequirements:
- cpuLimit: string
cpuRequest: string
memoryLimit: string
memoryRequest: string
defaultClusterRoleForProjectMembers: string
defaultPodSecurityAdmissionConfigurationTemplateName: string
defaultPodSecurityPolicyTemplateName: string
enableNetworkPolicy: false
fleetAgentDeploymentCustomizations:
- appendTolerations:
- effect: string
key: string
operator: string
seconds: 0
value: string
overrideAffinity: string
overrideResourceRequirements:
- cpuLimit: string
cpuRequest: string
memoryLimit: string
memoryRequest: string
fleetNamespace: string
kubernetesVersion: string
labels:
string: any
localAuthEndpoint:
caCerts: string
enabled: false
fqdn: string
name: string
rkeConfig:
additionalManifest: string
chartValues: string
etcd:
disableSnapshots: false
s3Config:
bucket: string
cloudCredentialName: string
endpoint: string
endpointCa: string
folder: string
region: string
skipSslVerify: false
snapshotRetention: 0
snapshotScheduleCron: string
etcdSnapshotCreate:
generation: 0
etcdSnapshotRestore:
generation: 0
name: string
restoreRkeConfig: string
machineGlobalConfig: string
machinePoolDefaults:
- hostnameLengthLimit: 0
machinePools:
- annotations:
string: any
cloudCredentialSecretName: string
controlPlaneRole: false
drainBeforeDelete: false
etcdRole: false
hostnameLengthLimit: 0
labels:
string: any
machineConfig:
apiVersion: string
kind: string
name: string
machineLabels:
string: any
maxUnhealthy: string
name: string
nodeDrainTimeout: 0
nodeStartupTimeoutSeconds: 0
paused: false
quantity: 0
rollingUpdate:
maxSurge: string
maxUnavailable: string
taints:
- effect: string
key: string
value: string
unhealthyNodeTimeoutSeconds: 0
unhealthyRange: string
workerRole: false
machineSelectorConfigs:
- config: string
machineLabelSelector:
matchExpressions:
- key: string
operator: string
values:
- string
matchLabels:
string: any
machineSelectorFiles:
- fileSources:
- configmap:
defaultPermissions: string
items:
- dynamic: false
hash: string
key: string
path: string
permissions: string
name: string
secret:
defaultPermissions: string
items:
- dynamic: false
hash: string
key: string
path: string
permissions: string
name: string
machineLabelSelector:
matchExpressions:
- key: string
operator: string
values:
- string
matchLabels:
string: any
registries:
configs:
- authConfigSecretName: string
caBundle: string
hostname: string
insecure: false
tlsSecretName: string
mirrors:
- endpoints:
- string
hostname: string
rewrites:
string: any
rotateCertificates:
generation: 0
services:
- string
upgradeStrategy:
controlPlaneConcurrency: string
controlPlaneDrainOptions:
deleteEmptyDirData: false
disableEviction: false
enabled: false
force: false
gracePeriod: 0
ignoreDaemonSets: false
ignoreErrors: false
skipWaitForDeleteTimeoutSeconds: 0
timeout: 0
workerConcurrency: string
workerDrainOptions:
deleteEmptyDirData: false
disableEviction: false
enabled: false
force: false
gracePeriod: 0
ignoreDaemonSets: false
ignoreErrors: false
skipWaitForDeleteTimeoutSeconds: 0
timeout: 0
ClusterV2 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 ClusterV2 resource accepts the following input properties:
- Kubernetes
Version string - The RKE2 or K3s version for the cluster.
- Agent
Env List<ClusterVars V2Agent Env Var> - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - Annotations Dictionary<string, object>
- Annotations for the Cluster.
- Cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- Cluster
Agent List<ClusterDeployment Customizations V2Cluster Agent Deployment Customization> - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - Default
Cluster stringRole For Project Members - Default cluster role for project members.
- Default
Pod stringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- Default
Pod stringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- Enable
Network boolPolicy - Enable k8s network policy on the cluster.
- Fleet
Agent List<ClusterDeployment Customizations V2Fleet Agent Deployment Customization> - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - Fleet
Namespace string - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- Labels Dictionary<string, object>
- Labels for the Cluster.
- Local
Auth ClusterEndpoint V2Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- Name string
- The name of the cluster.
- Rke
Config ClusterV2Rke Config - The RKE configuration for the cluster.
- Kubernetes
Version string - The RKE2 or K3s version for the cluster.
- Agent
Env []ClusterVars V2Agent Env Var Args - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - Annotations map[string]interface{}
- Annotations for the Cluster.
- Cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- Cluster
Agent []ClusterDeployment Customizations V2Cluster Agent Deployment Customization Args - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - Default
Cluster stringRole For Project Members - Default cluster role for project members.
- Default
Pod stringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- Default
Pod stringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- Enable
Network boolPolicy - Enable k8s network policy on the cluster.
- Fleet
Agent []ClusterDeployment Customizations V2Fleet Agent Deployment Customization Args - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - Fleet
Namespace string - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- Labels map[string]interface{}
- Labels for the Cluster.
- Local
Auth ClusterEndpoint V2Local Auth Endpoint Args - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- Name string
- The name of the cluster.
- Rke
Config ClusterV2Rke Config Args - The RKE configuration for the cluster.
- kubernetes
Version String - The RKE2 or K3s version for the cluster.
- agent
Env List<ClusterVars V2Agent Env Var> - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations Map<String,Object>
- Annotations for the Cluster.
- cloud
Credential StringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster
Agent List<ClusterDeployment Customizations V2Cluster Agent Deployment Customization> - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - default
Cluster StringRole For Project Members - Default cluster role for project members.
- default
Pod StringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default
Pod StringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable
Network BooleanPolicy - Enable k8s network policy on the cluster.
- fleet
Agent List<ClusterDeployment Customizations V2Fleet Agent Deployment Customization> - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet
Namespace String - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- labels Map<String,Object>
- Labels for the Cluster.
- local
Auth ClusterEndpoint V2Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name String
- The name of the cluster.
- rke
Config ClusterV2Rke Config - The RKE configuration for the cluster.
- kubernetes
Version string - The RKE2 or K3s version for the cluster.
- agent
Env ClusterVars V2Agent Env Var[] - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations {[key: string]: any}
- Annotations for the Cluster.
- cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster
Agent ClusterDeployment Customizations V2Cluster Agent Deployment Customization[] - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - default
Cluster stringRole For Project Members - Default cluster role for project members.
- default
Pod stringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default
Pod stringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable
Network booleanPolicy - Enable k8s network policy on the cluster.
- fleet
Agent ClusterDeployment Customizations V2Fleet Agent Deployment Customization[] - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet
Namespace string - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- labels {[key: string]: any}
- Labels for the Cluster.
- local
Auth ClusterEndpoint V2Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name string
- The name of the cluster.
- rke
Config ClusterV2Rke Config - The RKE configuration for the cluster.
- kubernetes_
version str - The RKE2 or K3s version for the cluster.
- agent_
env_ Sequence[Clustervars V2Agent Env Var Args] - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations Mapping[str, Any]
- Annotations for the Cluster.
- cloud_
credential_ strsecret_ name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster_
agent_ Sequence[Clusterdeployment_ customizations V2Cluster Agent Deployment Customization Args] - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - default_
cluster_ strrole_ for_ project_ members - Default cluster role for project members.
- default_
pod_ strsecurity_ admission_ configuration_ template_ name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default_
pod_ strsecurity_ policy_ template_ name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable_
network_ boolpolicy - Enable k8s network policy on the cluster.
- fleet_
agent_ Sequence[Clusterdeployment_ customizations V2Fleet Agent Deployment Customization Args] - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet_
namespace str - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- labels Mapping[str, Any]
- Labels for the Cluster.
- local_
auth_ Clusterendpoint V2Local Auth Endpoint Args - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name str
- The name of the cluster.
- rke_
config ClusterV2Rke Config Args - The RKE configuration for the cluster.
- kubernetes
Version String - The RKE2 or K3s version for the cluster.
- agent
Env List<Property Map>Vars - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations Map<Any>
- Annotations for the Cluster.
- cloud
Credential StringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster
Agent List<Property Map>Deployment Customizations - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - default
Cluster StringRole For Project Members - Default cluster role for project members.
- default
Pod StringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default
Pod StringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable
Network BooleanPolicy - Enable k8s network policy on the cluster.
- fleet
Agent List<Property Map>Deployment Customizations - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet
Namespace String - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- labels Map<Any>
- Labels for the Cluster.
- local
Auth Property MapEndpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name String
- The name of the cluster.
- rke
Config Property Map - The RKE configuration for the cluster.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterV2 resource produces the following output properties:
- Cluster
Registration ClusterToken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- Cluster
V1Id string - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - Id string
- The provider-assigned unique ID for this managed resource.
- Kube
Config string - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - Resource
Version string - (Computed, string) Cluster's k8s resource version.
- Cluster
Registration ClusterToken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- Cluster
V1Id string - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - Id string
- The provider-assigned unique ID for this managed resource.
- Kube
Config string - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - Resource
Version string - (Computed, string) Cluster's k8s resource version.
- cluster
Registration ClusterToken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster
V1Id String - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - id String
- The provider-assigned unique ID for this managed resource.
- kube
Config String - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - resource
Version String - (Computed, string) Cluster's k8s resource version.
- cluster
Registration ClusterToken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster
V1Id string - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - id string
- The provider-assigned unique ID for this managed resource.
- kube
Config string - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - resource
Version string - (Computed, string) Cluster's k8s resource version.
- cluster_
registration_ Clustertoken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster_
v1_ strid - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - id str
- The provider-assigned unique ID for this managed resource.
- kube_
config str - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - resource_
version str - (Computed, string) Cluster's k8s resource version.
- cluster
Registration Property MapToken - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster
V1Id String - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - id String
- The provider-assigned unique ID for this managed resource.
- kube
Config String - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - resource
Version String - (Computed, string) Cluster's k8s resource version.
Look up Existing ClusterV2 Resource
Get an existing ClusterV2 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?: ClusterV2State, opts?: CustomResourceOptions): ClusterV2
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
agent_env_vars: Optional[Sequence[ClusterV2AgentEnvVarArgs]] = None,
annotations: Optional[Mapping[str, Any]] = None,
cloud_credential_secret_name: Optional[str] = None,
cluster_agent_deployment_customizations: Optional[Sequence[ClusterV2ClusterAgentDeploymentCustomizationArgs]] = None,
cluster_registration_token: Optional[ClusterV2ClusterRegistrationTokenArgs] = None,
cluster_v1_id: Optional[str] = None,
default_cluster_role_for_project_members: Optional[str] = None,
default_pod_security_admission_configuration_template_name: Optional[str] = None,
default_pod_security_policy_template_name: Optional[str] = None,
enable_network_policy: Optional[bool] = None,
fleet_agent_deployment_customizations: Optional[Sequence[ClusterV2FleetAgentDeploymentCustomizationArgs]] = None,
fleet_namespace: Optional[str] = None,
kube_config: Optional[str] = None,
kubernetes_version: Optional[str] = None,
labels: Optional[Mapping[str, Any]] = None,
local_auth_endpoint: Optional[ClusterV2LocalAuthEndpointArgs] = None,
name: Optional[str] = None,
resource_version: Optional[str] = None,
rke_config: Optional[ClusterV2RkeConfigArgs] = None) -> ClusterV2
func GetClusterV2(ctx *Context, name string, id IDInput, state *ClusterV2State, opts ...ResourceOption) (*ClusterV2, error)
public static ClusterV2 Get(string name, Input<string> id, ClusterV2State? state, CustomResourceOptions? opts = null)
public static ClusterV2 get(String name, Output<String> id, ClusterV2State 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.
- Agent
Env List<ClusterVars V2Agent Env Var> - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - Annotations Dictionary<string, object>
- Annotations for the Cluster.
- Cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- Cluster
Agent List<ClusterDeployment Customizations V2Cluster Agent Deployment Customization> - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - Cluster
Registration ClusterToken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- Cluster
V1Id string - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - Default
Cluster stringRole For Project Members - Default cluster role for project members.
- Default
Pod stringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- Default
Pod stringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- Enable
Network boolPolicy - Enable k8s network policy on the cluster.
- Fleet
Agent List<ClusterDeployment Customizations V2Fleet Agent Deployment Customization> - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - Fleet
Namespace string - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- Kube
Config string - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - Kubernetes
Version string - The RKE2 or K3s version for the cluster.
- Labels Dictionary<string, object>
- Labels for the Cluster.
- Local
Auth ClusterEndpoint V2Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- Name string
- The name of the cluster.
- Resource
Version string - (Computed, string) Cluster's k8s resource version.
- Rke
Config ClusterV2Rke Config - The RKE configuration for the cluster.
- Agent
Env []ClusterVars V2Agent Env Var Args - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - Annotations map[string]interface{}
- Annotations for the Cluster.
- Cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- Cluster
Agent []ClusterDeployment Customizations V2Cluster Agent Deployment Customization Args - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - Cluster
Registration ClusterToken V2Cluster Registration Token Args - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- Cluster
V1Id string - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - Default
Cluster stringRole For Project Members - Default cluster role for project members.
- Default
Pod stringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- Default
Pod stringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- Enable
Network boolPolicy - Enable k8s network policy on the cluster.
- Fleet
Agent []ClusterDeployment Customizations V2Fleet Agent Deployment Customization Args - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - Fleet
Namespace string - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- Kube
Config string - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - Kubernetes
Version string - The RKE2 or K3s version for the cluster.
- Labels map[string]interface{}
- Labels for the Cluster.
- Local
Auth ClusterEndpoint V2Local Auth Endpoint Args - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- Name string
- The name of the cluster.
- Resource
Version string - (Computed, string) Cluster's k8s resource version.
- Rke
Config ClusterV2Rke Config Args - The RKE configuration for the cluster.
- agent
Env List<ClusterVars V2Agent Env Var> - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations Map<String,Object>
- Annotations for the Cluster.
- cloud
Credential StringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster
Agent List<ClusterDeployment Customizations V2Cluster Agent Deployment Customization> - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - cluster
Registration ClusterToken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster
V1Id String - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - default
Cluster StringRole For Project Members - Default cluster role for project members.
- default
Pod StringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default
Pod StringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable
Network BooleanPolicy - Enable k8s network policy on the cluster.
- fleet
Agent List<ClusterDeployment Customizations V2Fleet Agent Deployment Customization> - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet
Namespace String - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- kube
Config String - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - kubernetes
Version String - The RKE2 or K3s version for the cluster.
- labels Map<String,Object>
- Labels for the Cluster.
- local
Auth ClusterEndpoint V2Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name String
- The name of the cluster.
- resource
Version String - (Computed, string) Cluster's k8s resource version.
- rke
Config ClusterV2Rke Config - The RKE configuration for the cluster.
- agent
Env ClusterVars V2Agent Env Var[] - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations {[key: string]: any}
- Annotations for the Cluster.
- cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster
Agent ClusterDeployment Customizations V2Cluster Agent Deployment Customization[] - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - cluster
Registration ClusterToken V2Cluster Registration Token - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster
V1Id string - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - default
Cluster stringRole For Project Members - Default cluster role for project members.
- default
Pod stringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default
Pod stringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable
Network booleanPolicy - Enable k8s network policy on the cluster.
- fleet
Agent ClusterDeployment Customizations V2Fleet Agent Deployment Customization[] - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet
Namespace string - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- kube
Config string - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - kubernetes
Version string - The RKE2 or K3s version for the cluster.
- labels {[key: string]: any}
- Labels for the Cluster.
- local
Auth ClusterEndpoint V2Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name string
- The name of the cluster.
- resource
Version string - (Computed, string) Cluster's k8s resource version.
- rke
Config ClusterV2Rke Config - The RKE configuration for the cluster.
- agent_
env_ Sequence[Clustervars V2Agent Env Var Args] - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations Mapping[str, Any]
- Annotations for the Cluster.
- cloud_
credential_ strsecret_ name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster_
agent_ Sequence[Clusterdeployment_ customizations V2Cluster Agent Deployment Customization Args] - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - cluster_
registration_ Clustertoken V2Cluster Registration Token Args - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster_
v1_ strid - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - default_
cluster_ strrole_ for_ project_ members - Default cluster role for project members.
- default_
pod_ strsecurity_ admission_ configuration_ template_ name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default_
pod_ strsecurity_ policy_ template_ name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable_
network_ boolpolicy - Enable k8s network policy on the cluster.
- fleet_
agent_ Sequence[Clusterdeployment_ customizations V2Fleet Agent Deployment Customization Args] - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet_
namespace str - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- kube_
config str - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - kubernetes_
version str - The RKE2 or K3s version for the cluster.
- labels Mapping[str, Any]
- Labels for the Cluster.
- local_
auth_ Clusterendpoint V2Local Auth Endpoint Args - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name str
- The name of the cluster.
- resource_
version str - (Computed, string) Cluster's k8s resource version.
- rke_
config ClusterV2Rke Config Args - The RKE configuration for the cluster.
- agent
Env List<Property Map>Vars - Agent env vars is a list of additional environment variables to be appended to the
cattle-cluster-agent
andfleet-agent
deployment, and the plan for the system upgrade controller to upgrade nodes. - annotations Map<Any>
- Annotations for the Cluster.
- cloud
Credential StringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- cluster
Agent List<Property Map>Deployment Customizations - Cluster agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
cattle-cluster-agent
deployment. This argument is available in Rancher v2.7.5 and above. - cluster
Registration Property MapToken - (Computed, sensitive, list, max length: 1) Cluster Registration Token generated for the cluster.
- cluster
V1Id String - (Computed, string) Cluster v1 id for cluster v2. (e.g. to be used with
rancher2_sync
). - default
Cluster StringRole For Project Members - Default cluster role for project members.
- default
Pod StringSecurity Admission Configuration Template Name - The name of the pre-defined pod security admission configuration template to be applied to the cluster. Rancher admins (or those with the right permissions) can create, manage, and edit those templates. For more information, please refer to Rancher Documentation. The argument is available in Rancher v2.7.2 and above.
- default
Pod StringSecurity Policy Template Name - Default pod security policy template name specifies the default PSP for the cluster. For more information, please refer to Rancher Documentation.
- enable
Network BooleanPolicy - Enable k8s network policy on the cluster.
- fleet
Agent List<Property Map>Deployment Customizations - Fleet agent deployment customization specifies the additional tolerations, new affinity rules, and new resource requirements on the
fleet-agent
deployment. The argument is available in Rancher v2.7.5 and above. - fleet
Namespace String - Fleet namespace is the namespace where the cluster is to create in the local cluster. It is recommended to leave it as the default value.
- kube
Config String - (Computed/Sensitive) Kube Config generated for the cluster. Note: When the cluster has
local_auth_endpoint
enabled, the kube_config will not be available until the cluster isconnected
. - kubernetes
Version String - The RKE2 or K3s version for the cluster.
- labels Map<Any>
- Labels for the Cluster.
- local
Auth Property MapEndpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- name String
- The name of the cluster.
- resource
Version String - (Computed, string) Cluster's k8s resource version.
- rke
Config Property Map - The RKE configuration for the cluster.
Supporting Types
ClusterV2AgentEnvVar, ClusterV2AgentEnvVarArgs
ClusterV2ClusterAgentDeploymentCustomization, ClusterV2ClusterAgentDeploymentCustomizationArgs
- Append
Tolerations List<ClusterV2Cluster Agent Deployment Customization Append Toleration> - A list of tolerations to be appended to the default tolerations.
- Override
Affinity string - Override affinity overrides the global default affinity setting.
- Override
Resource List<ClusterRequirements V2Cluster Agent Deployment Customization Override Resource Requirement> - Override resource requirements overrides the default value for requests and/or limits.
- Append
Tolerations []ClusterV2Cluster Agent Deployment Customization Append Toleration - A list of tolerations to be appended to the default tolerations.
- Override
Affinity string - Override affinity overrides the global default affinity setting.
- Override
Resource []ClusterRequirements V2Cluster Agent Deployment Customization Override Resource Requirement - Override resource requirements overrides the default value for requests and/or limits.
- append
Tolerations List<ClusterV2Cluster Agent Deployment Customization Append Toleration> - A list of tolerations to be appended to the default tolerations.
- override
Affinity String - Override affinity overrides the global default affinity setting.
- override
Resource List<ClusterRequirements V2Cluster Agent Deployment Customization Override Resource Requirement> - Override resource requirements overrides the default value for requests and/or limits.
- append
Tolerations ClusterV2Cluster Agent Deployment Customization Append Toleration[] - A list of tolerations to be appended to the default tolerations.
- override
Affinity string - Override affinity overrides the global default affinity setting.
- override
Resource ClusterRequirements V2Cluster Agent Deployment Customization Override Resource Requirement[] - Override resource requirements overrides the default value for requests and/or limits.
- append_
tolerations Sequence[ClusterV2Cluster Agent Deployment Customization Append Toleration] - A list of tolerations to be appended to the default tolerations.
- override_
affinity str - Override affinity overrides the global default affinity setting.
- override_
resource_ Sequence[Clusterrequirements V2Cluster Agent Deployment Customization Override Resource Requirement] - Override resource requirements overrides the default value for requests and/or limits.
- append
Tolerations List<Property Map> - A list of tolerations to be appended to the default tolerations.
- override
Affinity String - Override affinity overrides the global default affinity setting.
- override
Resource List<Property Map>Requirements - Override resource requirements overrides the default value for requests and/or limits.
ClusterV2ClusterAgentDeploymentCustomizationAppendToleration, ClusterV2ClusterAgentDeploymentCustomizationAppendTolerationArgs
- Key string
- Key is the name of the key of the item to retrieve.
- Effect string
- The taint effect. Default:
\"NoExecute\"
. - Operator string
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- Seconds int
- The number of seconds a pod will stay bound to a node with a matching taint.
- Value string
- The taint value.
- Key string
- Key is the name of the key of the item to retrieve.
- Effect string
- The taint effect. Default:
\"NoExecute\"
. - Operator string
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- Seconds int
- The number of seconds a pod will stay bound to a node with a matching taint.
- Value string
- The taint value.
- key String
- Key is the name of the key of the item to retrieve.
- effect String
- The taint effect. Default:
\"NoExecute\"
. - operator String
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds Integer
- The number of seconds a pod will stay bound to a node with a matching taint.
- value String
- The taint value.
- key string
- Key is the name of the key of the item to retrieve.
- effect string
- The taint effect. Default:
\"NoExecute\"
. - operator string
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds number
- The number of seconds a pod will stay bound to a node with a matching taint.
- value string
- The taint value.
- key str
- Key is the name of the key of the item to retrieve.
- effect str
- The taint effect. Default:
\"NoExecute\"
. - operator str
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds int
- The number of seconds a pod will stay bound to a node with a matching taint.
- value str
- The taint value.
- key String
- Key is the name of the key of the item to retrieve.
- effect String
- The taint effect. Default:
\"NoExecute\"
. - operator String
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds Number
- The number of seconds a pod will stay bound to a node with a matching taint.
- value String
- The taint value.
ClusterV2ClusterAgentDeploymentCustomizationOverrideResourceRequirement, ClusterV2ClusterAgentDeploymentCustomizationOverrideResourceRequirementArgs
- Cpu
Limit string - The maximum CPU limit for agent.
- Cpu
Request string - The minimum CPU required for agent.
- Memory
Limit string - The maximum memory limit for agent.
- Memory
Request string - The minimum memory required for agent.
- Cpu
Limit string - The maximum CPU limit for agent.
- Cpu
Request string - The minimum CPU required for agent.
- Memory
Limit string - The maximum memory limit for agent.
- Memory
Request string - The minimum memory required for agent.
- cpu
Limit String - The maximum CPU limit for agent.
- cpu
Request String - The minimum CPU required for agent.
- memory
Limit String - The maximum memory limit for agent.
- memory
Request String - The minimum memory required for agent.
- cpu
Limit string - The maximum CPU limit for agent.
- cpu
Request string - The minimum CPU required for agent.
- memory
Limit string - The maximum memory limit for agent.
- memory
Request string - The minimum memory required for agent.
- cpu_
limit str - The maximum CPU limit for agent.
- cpu_
request str - The minimum CPU required for agent.
- memory_
limit str - The maximum memory limit for agent.
- memory_
request str - The minimum memory required for agent.
- cpu
Limit String - The maximum CPU limit for agent.
- cpu
Request String - The minimum CPU required for agent.
- memory
Limit String - The maximum memory limit for agent.
- memory
Request String - The minimum memory required for agent.
ClusterV2ClusterRegistrationToken, ClusterV2ClusterRegistrationTokenArgs
- Annotations Dictionary<string, object>
- Annotations for the Cluster.
- Cluster
Id string - Cluster ID.
- Command string
- Command to execute in an imported k8s cluster.
- Id string
- (Computed, string) The ID of the resource.
- Insecure
Command string - Insecure command to execute in an imported k8s cluster.
- Insecure
Node stringCommand - Insecure node command to execute in an imported k8s cluster.
- Insecure
Windows stringNode Command - Insecure windows command to execute in an imported k8s cluster.
- Labels Dictionary<string, object>
- Labels for the Cluster.
- Manifest
Url string - K8s manifest url to execute with
kubectl
to import an existing k8s cluster. - Name string
- The name of the cluster.
- Node
Command string - Node command to execute in Linux nodes for custom k8s cluster.
- Token string
- Token for cluster registration token object.
- Windows
Node stringCommand - Node command to execute in Windows nodes for custom k8s cluster.
- Annotations map[string]interface{}
- Annotations for the Cluster.
- Cluster
Id string - Cluster ID.
- Command string
- Command to execute in an imported k8s cluster.
- Id string
- (Computed, string) The ID of the resource.
- Insecure
Command string - Insecure command to execute in an imported k8s cluster.
- Insecure
Node stringCommand - Insecure node command to execute in an imported k8s cluster.
- Insecure
Windows stringNode Command - Insecure windows command to execute in an imported k8s cluster.
- Labels map[string]interface{}
- Labels for the Cluster.
- Manifest
Url string - K8s manifest url to execute with
kubectl
to import an existing k8s cluster. - Name string
- The name of the cluster.
- Node
Command string - Node command to execute in Linux nodes for custom k8s cluster.
- Token string
- Token for cluster registration token object.
- Windows
Node stringCommand - Node command to execute in Windows nodes for custom k8s cluster.
- annotations Map<String,Object>
- Annotations for the Cluster.
- cluster
Id String - Cluster ID.
- command String
- Command to execute in an imported k8s cluster.
- id String
- (Computed, string) The ID of the resource.
- insecure
Command String - Insecure command to execute in an imported k8s cluster.
- insecure
Node StringCommand - Insecure node command to execute in an imported k8s cluster.
- insecure
Windows StringNode Command - Insecure windows command to execute in an imported k8s cluster.
- labels Map<String,Object>
- Labels for the Cluster.
- manifest
Url String - K8s manifest url to execute with
kubectl
to import an existing k8s cluster. - name String
- The name of the cluster.
- node
Command String - Node command to execute in Linux nodes for custom k8s cluster.
- token String
- Token for cluster registration token object.
- windows
Node StringCommand - Node command to execute in Windows nodes for custom k8s cluster.
- annotations {[key: string]: any}
- Annotations for the Cluster.
- cluster
Id string - Cluster ID.
- command string
- Command to execute in an imported k8s cluster.
- id string
- (Computed, string) The ID of the resource.
- insecure
Command string - Insecure command to execute in an imported k8s cluster.
- insecure
Node stringCommand - Insecure node command to execute in an imported k8s cluster.
- insecure
Windows stringNode Command - Insecure windows command to execute in an imported k8s cluster.
- labels {[key: string]: any}
- Labels for the Cluster.
- manifest
Url string - K8s manifest url to execute with
kubectl
to import an existing k8s cluster. - name string
- The name of the cluster.
- node
Command string - Node command to execute in Linux nodes for custom k8s cluster.
- token string
- Token for cluster registration token object.
- windows
Node stringCommand - Node command to execute in Windows nodes for custom k8s cluster.
- annotations Mapping[str, Any]
- Annotations for the Cluster.
- cluster_
id str - Cluster ID.
- command str
- Command to execute in an imported k8s cluster.
- id str
- (Computed, string) The ID of the resource.
- insecure_
command str - Insecure command to execute in an imported k8s cluster.
- insecure_
node_ strcommand - Insecure node command to execute in an imported k8s cluster.
- insecure_
windows_ strnode_ command - Insecure windows command to execute in an imported k8s cluster.
- labels Mapping[str, Any]
- Labels for the Cluster.
- manifest_
url str - K8s manifest url to execute with
kubectl
to import an existing k8s cluster. - name str
- The name of the cluster.
- node_
command str - Node command to execute in Linux nodes for custom k8s cluster.
- token str
- Token for cluster registration token object.
- windows_
node_ strcommand - Node command to execute in Windows nodes for custom k8s cluster.
- annotations Map<Any>
- Annotations for the Cluster.
- cluster
Id String - Cluster ID.
- command String
- Command to execute in an imported k8s cluster.
- id String
- (Computed, string) The ID of the resource.
- insecure
Command String - Insecure command to execute in an imported k8s cluster.
- insecure
Node StringCommand - Insecure node command to execute in an imported k8s cluster.
- insecure
Windows StringNode Command - Insecure windows command to execute in an imported k8s cluster.
- labels Map<Any>
- Labels for the Cluster.
- manifest
Url String - K8s manifest url to execute with
kubectl
to import an existing k8s cluster. - name String
- The name of the cluster.
- node
Command String - Node command to execute in Linux nodes for custom k8s cluster.
- token String
- Token for cluster registration token object.
- windows
Node StringCommand - Node command to execute in Windows nodes for custom k8s cluster.
ClusterV2FleetAgentDeploymentCustomization, ClusterV2FleetAgentDeploymentCustomizationArgs
- Append
Tolerations List<ClusterV2Fleet Agent Deployment Customization Append Toleration> - A list of tolerations to be appended to the default tolerations.
- Override
Affinity string - Override affinity overrides the global default affinity setting.
- Override
Resource List<ClusterRequirements V2Fleet Agent Deployment Customization Override Resource Requirement> - Override resource requirements overrides the default value for requests and/or limits.
- Append
Tolerations []ClusterV2Fleet Agent Deployment Customization Append Toleration - A list of tolerations to be appended to the default tolerations.
- Override
Affinity string - Override affinity overrides the global default affinity setting.
- Override
Resource []ClusterRequirements V2Fleet Agent Deployment Customization Override Resource Requirement - Override resource requirements overrides the default value for requests and/or limits.
- append
Tolerations List<ClusterV2Fleet Agent Deployment Customization Append Toleration> - A list of tolerations to be appended to the default tolerations.
- override
Affinity String - Override affinity overrides the global default affinity setting.
- override
Resource List<ClusterRequirements V2Fleet Agent Deployment Customization Override Resource Requirement> - Override resource requirements overrides the default value for requests and/or limits.
- append
Tolerations ClusterV2Fleet Agent Deployment Customization Append Toleration[] - A list of tolerations to be appended to the default tolerations.
- override
Affinity string - Override affinity overrides the global default affinity setting.
- override
Resource ClusterRequirements V2Fleet Agent Deployment Customization Override Resource Requirement[] - Override resource requirements overrides the default value for requests and/or limits.
- append_
tolerations Sequence[ClusterV2Fleet Agent Deployment Customization Append Toleration] - A list of tolerations to be appended to the default tolerations.
- override_
affinity str - Override affinity overrides the global default affinity setting.
- override_
resource_ Sequence[Clusterrequirements V2Fleet Agent Deployment Customization Override Resource Requirement] - Override resource requirements overrides the default value for requests and/or limits.
- append
Tolerations List<Property Map> - A list of tolerations to be appended to the default tolerations.
- override
Affinity String - Override affinity overrides the global default affinity setting.
- override
Resource List<Property Map>Requirements - Override resource requirements overrides the default value for requests and/or limits.
ClusterV2FleetAgentDeploymentCustomizationAppendToleration, ClusterV2FleetAgentDeploymentCustomizationAppendTolerationArgs
- Key string
- Key is the name of the key of the item to retrieve.
- Effect string
- The taint effect. Default:
\"NoExecute\"
. - Operator string
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- Seconds int
- The number of seconds a pod will stay bound to a node with a matching taint.
- Value string
- The taint value.
- Key string
- Key is the name of the key of the item to retrieve.
- Effect string
- The taint effect. Default:
\"NoExecute\"
. - Operator string
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- Seconds int
- The number of seconds a pod will stay bound to a node with a matching taint.
- Value string
- The taint value.
- key String
- Key is the name of the key of the item to retrieve.
- effect String
- The taint effect. Default:
\"NoExecute\"
. - operator String
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds Integer
- The number of seconds a pod will stay bound to a node with a matching taint.
- value String
- The taint value.
- key string
- Key is the name of the key of the item to retrieve.
- effect string
- The taint effect. Default:
\"NoExecute\"
. - operator string
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds number
- The number of seconds a pod will stay bound to a node with a matching taint.
- value string
- The taint value.
- key str
- Key is the name of the key of the item to retrieve.
- effect str
- The taint effect. Default:
\"NoExecute\"
. - operator str
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds int
- The number of seconds a pod will stay bound to a node with a matching taint.
- value str
- The taint value.
- key String
- Key is the name of the key of the item to retrieve.
- effect String
- The taint effect. Default:
\"NoExecute\"
. - operator String
- Operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- seconds Number
- The number of seconds a pod will stay bound to a node with a matching taint.
- value String
- The taint value.
ClusterV2FleetAgentDeploymentCustomizationOverrideResourceRequirement, ClusterV2FleetAgentDeploymentCustomizationOverrideResourceRequirementArgs
- Cpu
Limit string - The maximum CPU limit for agent.
- Cpu
Request string - The minimum CPU required for agent.
- Memory
Limit string - The maximum memory limit for agent.
- Memory
Request string - The minimum memory required for agent.
- Cpu
Limit string - The maximum CPU limit for agent.
- Cpu
Request string - The minimum CPU required for agent.
- Memory
Limit string - The maximum memory limit for agent.
- Memory
Request string - The minimum memory required for agent.
- cpu
Limit String - The maximum CPU limit for agent.
- cpu
Request String - The minimum CPU required for agent.
- memory
Limit String - The maximum memory limit for agent.
- memory
Request String - The minimum memory required for agent.
- cpu
Limit string - The maximum CPU limit for agent.
- cpu
Request string - The minimum CPU required for agent.
- memory
Limit string - The maximum memory limit for agent.
- memory
Request string - The minimum memory required for agent.
- cpu_
limit str - The maximum CPU limit for agent.
- cpu_
request str - The minimum CPU required for agent.
- memory_
limit str - The maximum memory limit for agent.
- memory_
request str - The minimum memory required for agent.
- cpu
Limit String - The maximum CPU limit for agent.
- cpu
Request String - The minimum CPU required for agent.
- memory
Limit String - The maximum memory limit for agent.
- memory
Request String - The minimum memory required for agent.
ClusterV2LocalAuthEndpoint, ClusterV2LocalAuthEndpointArgs
- Ca
Certs string - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Fqdn string
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- Ca
Certs string - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Fqdn string
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca
Certs String - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn String
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca
Certs string - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn string
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca_
certs str - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn str
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca
Certs String - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn String
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
ClusterV2RkeConfig, ClusterV2RkeConfigArgs
- Additional
Manifest string - The value of the additional manifest is delivered to the path
/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml
or/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml
on the control plane nodes. - Chart
Values string - The value for the system charts installed by the distribution. For more information about how RKE2 or K3s manage packaged components, please refer to RKE2 documentation or K3s documentation.
- Etcd
Cluster
V2Rke Config Etcd - Etcd configures the behavior of the automatic etcd snapshot feature.
- Etcd
Snapshot ClusterCreate V2Rke Config Etcd Snapshot Create - Cluster V2 etcd snapshot create.
- Etcd
Snapshot ClusterRestore V2Rke Config Etcd Snapshot Restore - Cluster V2 etcd snapshot restore.
- Local
Auth ClusterEndpoint V2Rke Config Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- Machine
Global stringConfig - Machine global config specifies the distribution-specified server configuration applied to all nodes. For the full list of server configurations, please refer to RKE2 server configuration or K3s server configuration.
- Machine
Pool List<ClusterDefaults V2Rke Config Machine Pool Default> - Default values for machine pool configurations if unset
- Machine
Pools List<ClusterV2Rke Config Machine Pool> - Cluster V2 machine pools.
- Machine
Selector List<ClusterConfigs V2Rke Config Machine Selector Config> - Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later.
- Machine
Selector List<ClusterFiles V2Rke Config Machine Selector File> - Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later.
- Registries
Cluster
V2Rke Config Registries - Docker registries from which the cluster pulls images.
- Rotate
Certificates ClusterV2Rke Config Rotate Certificates - Cluster V2 certificate rotation.
- Upgrade
Strategy ClusterV2Rke Config Upgrade Strategy - Cluster upgrade strategy.
- Additional
Manifest string - The value of the additional manifest is delivered to the path
/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml
or/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml
on the control plane nodes. - Chart
Values string - The value for the system charts installed by the distribution. For more information about how RKE2 or K3s manage packaged components, please refer to RKE2 documentation or K3s documentation.
- Etcd
Cluster
V2Rke Config Etcd - Etcd configures the behavior of the automatic etcd snapshot feature.
- Etcd
Snapshot ClusterCreate V2Rke Config Etcd Snapshot Create - Cluster V2 etcd snapshot create.
- Etcd
Snapshot ClusterRestore V2Rke Config Etcd Snapshot Restore - Cluster V2 etcd snapshot restore.
- Local
Auth ClusterEndpoint V2Rke Config Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- Machine
Global stringConfig - Machine global config specifies the distribution-specified server configuration applied to all nodes. For the full list of server configurations, please refer to RKE2 server configuration or K3s server configuration.
- Machine
Pool []ClusterDefaults V2Rke Config Machine Pool Default - Default values for machine pool configurations if unset
- Machine
Pools []ClusterV2Rke Config Machine Pool - Cluster V2 machine pools.
- Machine
Selector []ClusterConfigs V2Rke Config Machine Selector Config - Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later.
- Machine
Selector []ClusterFiles V2Rke Config Machine Selector File - Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later.
- Registries
Cluster
V2Rke Config Registries - Docker registries from which the cluster pulls images.
- Rotate
Certificates ClusterV2Rke Config Rotate Certificates - Cluster V2 certificate rotation.
- Upgrade
Strategy ClusterV2Rke Config Upgrade Strategy - Cluster upgrade strategy.
- additional
Manifest String - The value of the additional manifest is delivered to the path
/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml
or/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml
on the control plane nodes. - chart
Values String - The value for the system charts installed by the distribution. For more information about how RKE2 or K3s manage packaged components, please refer to RKE2 documentation or K3s documentation.
- etcd
Cluster
V2Rke Config Etcd - Etcd configures the behavior of the automatic etcd snapshot feature.
- etcd
Snapshot ClusterCreate V2Rke Config Etcd Snapshot Create - Cluster V2 etcd snapshot create.
- etcd
Snapshot ClusterRestore V2Rke Config Etcd Snapshot Restore - Cluster V2 etcd snapshot restore.
- local
Auth ClusterEndpoint V2Rke Config Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- machine
Global StringConfig - Machine global config specifies the distribution-specified server configuration applied to all nodes. For the full list of server configurations, please refer to RKE2 server configuration or K3s server configuration.
- machine
Pool List<ClusterDefaults V2Rke Config Machine Pool Default> - Default values for machine pool configurations if unset
- machine
Pools List<ClusterV2Rke Config Machine Pool> - Cluster V2 machine pools.
- machine
Selector List<ClusterConfigs V2Rke Config Machine Selector Config> - Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later.
- machine
Selector List<ClusterFiles V2Rke Config Machine Selector File> - Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later.
- registries
Cluster
V2Rke Config Registries - Docker registries from which the cluster pulls images.
- rotate
Certificates ClusterV2Rke Config Rotate Certificates - Cluster V2 certificate rotation.
- upgrade
Strategy ClusterV2Rke Config Upgrade Strategy - Cluster upgrade strategy.
- additional
Manifest string - The value of the additional manifest is delivered to the path
/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml
or/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml
on the control plane nodes. - chart
Values string - The value for the system charts installed by the distribution. For more information about how RKE2 or K3s manage packaged components, please refer to RKE2 documentation or K3s documentation.
- etcd
Cluster
V2Rke Config Etcd - Etcd configures the behavior of the automatic etcd snapshot feature.
- etcd
Snapshot ClusterCreate V2Rke Config Etcd Snapshot Create - Cluster V2 etcd snapshot create.
- etcd
Snapshot ClusterRestore V2Rke Config Etcd Snapshot Restore - Cluster V2 etcd snapshot restore.
- local
Auth ClusterEndpoint V2Rke Config Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- machine
Global stringConfig - Machine global config specifies the distribution-specified server configuration applied to all nodes. For the full list of server configurations, please refer to RKE2 server configuration or K3s server configuration.
- machine
Pool ClusterDefaults V2Rke Config Machine Pool Default[] - Default values for machine pool configurations if unset
- machine
Pools ClusterV2Rke Config Machine Pool[] - Cluster V2 machine pools.
- machine
Selector ClusterConfigs V2Rke Config Machine Selector Config[] - Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later.
- machine
Selector ClusterFiles V2Rke Config Machine Selector File[] - Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later.
- registries
Cluster
V2Rke Config Registries - Docker registries from which the cluster pulls images.
- rotate
Certificates ClusterV2Rke Config Rotate Certificates - Cluster V2 certificate rotation.
- upgrade
Strategy ClusterV2Rke Config Upgrade Strategy - Cluster upgrade strategy.
- additional_
manifest str - The value of the additional manifest is delivered to the path
/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml
or/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml
on the control plane nodes. - chart_
values str - The value for the system charts installed by the distribution. For more information about how RKE2 or K3s manage packaged components, please refer to RKE2 documentation or K3s documentation.
- etcd
Cluster
V2Rke Config Etcd - Etcd configures the behavior of the automatic etcd snapshot feature.
- etcd_
snapshot_ Clustercreate V2Rke Config Etcd Snapshot Create - Cluster V2 etcd snapshot create.
- etcd_
snapshot_ Clusterrestore V2Rke Config Etcd Snapshot Restore - Cluster V2 etcd snapshot restore.
- local_
auth_ Clusterendpoint V2Rke Config Local Auth Endpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- machine_
global_ strconfig - Machine global config specifies the distribution-specified server configuration applied to all nodes. For the full list of server configurations, please refer to RKE2 server configuration or K3s server configuration.
- machine_
pool_ Sequence[Clusterdefaults V2Rke Config Machine Pool Default] - Default values for machine pool configurations if unset
- machine_
pools Sequence[ClusterV2Rke Config Machine Pool] - Cluster V2 machine pools.
- machine_
selector_ Sequence[Clusterconfigs V2Rke Config Machine Selector Config] - Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later.
- machine_
selector_ Sequence[Clusterfiles V2Rke Config Machine Selector File] - Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later.
- registries
Cluster
V2Rke Config Registries - Docker registries from which the cluster pulls images.
- rotate_
certificates ClusterV2Rke Config Rotate Certificates - Cluster V2 certificate rotation.
- upgrade_
strategy ClusterV2Rke Config Upgrade Strategy - Cluster upgrade strategy.
- additional
Manifest String - The value of the additional manifest is delivered to the path
/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml
or/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml
on the control plane nodes. - chart
Values String - The value for the system charts installed by the distribution. For more information about how RKE2 or K3s manage packaged components, please refer to RKE2 documentation or K3s documentation.
- etcd Property Map
- Etcd configures the behavior of the automatic etcd snapshot feature.
- etcd
Snapshot Property MapCreate - Cluster V2 etcd snapshot create.
- etcd
Snapshot Property MapRestore - Cluster V2 etcd snapshot restore.
- local
Auth Property MapEndpoint - Local auth endpoint configures the Authorized Cluster Endpoint (ACE) which can be used to directly access the Kubernetes API server, without requiring communication through Rancher. For more information, please refer to Rancher Documentation.
- machine
Global StringConfig - Machine global config specifies the distribution-specified server configuration applied to all nodes. For the full list of server configurations, please refer to RKE2 server configuration or K3s server configuration.
- machine
Pool List<Property Map>Defaults - Default values for machine pool configurations if unset
- machine
Pools List<Property Map> - Cluster V2 machine pools.
- machine
Selector List<Property Map>Configs - Machine selector config is the same as machine_global_config except that a label selector can be specified with the configuration. The configuration will only be applied to nodes that match the provided label selector. The configuration from machine_selector_config takes precedence over the one from machine_global_config. This argument is available in Rancher v2.7.2 and later.
- machine
Selector List<Property Map>Files - Machine selector files provide a means to deliver files to nodes so that the files can be in place before initiating RKE2/K3s server or agent processes. Please refer to Rancher documentation for RKE2 Cluster Configuration Reference and K3s Cluster Configuration Reference. This argument is available in Rancher v2.7.2 and later.
- registries Property Map
- Docker registries from which the cluster pulls images.
- rotate
Certificates Property Map - Cluster V2 certificate rotation.
- upgrade
Strategy Property Map - Cluster upgrade strategy.
ClusterV2RkeConfigEtcd, ClusterV2RkeConfigEtcdArgs
- Disable
Snapshots bool - Disable ETCD snapshots.
- S3Config
Cluster
V2Rke Config Etcd S3Config - Creation option for etcd service.
- Snapshot
Retention int - ETCD snapshot retention.
- Snapshot
Schedule stringCron - ETCD snapshot schedule cron (e.g
\"0 */5 * * *\"
).
- Disable
Snapshots bool - Disable ETCD snapshots.
- S3Config
Cluster
V2Rke Config Etcd S3Config - Creation option for etcd service.
- Snapshot
Retention int - ETCD snapshot retention.
- Snapshot
Schedule stringCron - ETCD snapshot schedule cron (e.g
\"0 */5 * * *\"
).
- disable
Snapshots Boolean - Disable ETCD snapshots.
- s3Config
Cluster
V2Rke Config Etcd S3Config - Creation option for etcd service.
- snapshot
Retention Integer - ETCD snapshot retention.
- snapshot
Schedule StringCron - ETCD snapshot schedule cron (e.g
\"0 */5 * * *\"
).
- disable
Snapshots boolean - Disable ETCD snapshots.
- s3Config
Cluster
V2Rke Config Etcd S3Config - Creation option for etcd service.
- snapshot
Retention number - ETCD snapshot retention.
- snapshot
Schedule stringCron - ETCD snapshot schedule cron (e.g
\"0 */5 * * *\"
).
- disable_
snapshots bool - Disable ETCD snapshots.
- s3_
config ClusterV2Rke Config Etcd S3Config - Creation option for etcd service.
- snapshot_
retention int - ETCD snapshot retention.
- snapshot_
schedule_ strcron - ETCD snapshot schedule cron (e.g
\"0 */5 * * *\"
).
- disable
Snapshots Boolean - Disable ETCD snapshots.
- s3Config Property Map
- Creation option for etcd service.
- snapshot
Retention Number - ETCD snapshot retention.
- snapshot
Schedule StringCron - ETCD snapshot schedule cron (e.g
\"0 */5 * * *\"
).
ClusterV2RkeConfigEtcdS3Config, ClusterV2RkeConfigEtcdS3ConfigArgs
- Bucket string
- Bucket name for S3 service.
- Endpoint string
- ETCD snapshot S3 endpoint.
- Cloud
Credential stringName - ETCD snapshot S3 cloud credential name.
- Endpoint
Ca string - ETCD snapshot S3 endpoint CA.
- Folder string
- ETCD snapshot S3 folder.
- Region string
- ETCD snapshot S3 region.
- Skip
Ssl boolVerify - Disable ETCD skip ssl verify.
- Bucket string
- Bucket name for S3 service.
- Endpoint string
- ETCD snapshot S3 endpoint.
- Cloud
Credential stringName - ETCD snapshot S3 cloud credential name.
- Endpoint
Ca string - ETCD snapshot S3 endpoint CA.
- Folder string
- ETCD snapshot S3 folder.
- Region string
- ETCD snapshot S3 region.
- Skip
Ssl boolVerify - Disable ETCD skip ssl verify.
- bucket String
- Bucket name for S3 service.
- endpoint String
- ETCD snapshot S3 endpoint.
- cloud
Credential StringName - ETCD snapshot S3 cloud credential name.
- endpoint
Ca String - ETCD snapshot S3 endpoint CA.
- folder String
- ETCD snapshot S3 folder.
- region String
- ETCD snapshot S3 region.
- skip
Ssl BooleanVerify - Disable ETCD skip ssl verify.
- bucket string
- Bucket name for S3 service.
- endpoint string
- ETCD snapshot S3 endpoint.
- cloud
Credential stringName - ETCD snapshot S3 cloud credential name.
- endpoint
Ca string - ETCD snapshot S3 endpoint CA.
- folder string
- ETCD snapshot S3 folder.
- region string
- ETCD snapshot S3 region.
- skip
Ssl booleanVerify - Disable ETCD skip ssl verify.
- bucket str
- Bucket name for S3 service.
- endpoint str
- ETCD snapshot S3 endpoint.
- cloud_
credential_ strname - ETCD snapshot S3 cloud credential name.
- endpoint_
ca str - ETCD snapshot S3 endpoint CA.
- folder str
- ETCD snapshot S3 folder.
- region str
- ETCD snapshot S3 region.
- skip_
ssl_ boolverify - Disable ETCD skip ssl verify.
- bucket String
- Bucket name for S3 service.
- endpoint String
- ETCD snapshot S3 endpoint.
- cloud
Credential StringName - ETCD snapshot S3 cloud credential name.
- endpoint
Ca String - ETCD snapshot S3 endpoint CA.
- folder String
- ETCD snapshot S3 folder.
- region String
- ETCD snapshot S3 region.
- skip
Ssl BooleanVerify - Disable ETCD skip ssl verify.
ClusterV2RkeConfigEtcdSnapshotCreate, ClusterV2RkeConfigEtcdSnapshotCreateArgs
- Generation int
- ETCD snapshot desired generation.
- Generation int
- ETCD snapshot desired generation.
- generation Integer
- ETCD snapshot desired generation.
- generation number
- ETCD snapshot desired generation.
- generation int
- ETCD snapshot desired generation.
- generation Number
- ETCD snapshot desired generation.
ClusterV2RkeConfigEtcdSnapshotRestore, ClusterV2RkeConfigEtcdSnapshotRestoreArgs
- Generation int
- ETCD snapshot desired generation.
- Name string
- The name of the cluster.
- Restore
Rke stringConfig - ETCD restore RKE config (set to none, all, or kubernetesVersion).
- Generation int
- ETCD snapshot desired generation.
- Name string
- The name of the cluster.
- Restore
Rke stringConfig - ETCD restore RKE config (set to none, all, or kubernetesVersion).
- generation Integer
- ETCD snapshot desired generation.
- name String
- The name of the cluster.
- restore
Rke StringConfig - ETCD restore RKE config (set to none, all, or kubernetesVersion).
- generation number
- ETCD snapshot desired generation.
- name string
- The name of the cluster.
- restore
Rke stringConfig - ETCD restore RKE config (set to none, all, or kubernetesVersion).
- generation int
- ETCD snapshot desired generation.
- name str
- The name of the cluster.
- restore_
rke_ strconfig - ETCD restore RKE config (set to none, all, or kubernetesVersion).
- generation Number
- ETCD snapshot desired generation.
- name String
- The name of the cluster.
- restore
Rke StringConfig - ETCD restore RKE config (set to none, all, or kubernetesVersion).
ClusterV2RkeConfigLocalAuthEndpoint, ClusterV2RkeConfigLocalAuthEndpointArgs
- Ca
Certs string - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Fqdn string
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- Ca
Certs string - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Fqdn string
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca
Certs String - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn String
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca
Certs string - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn string
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca_
certs str - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn str
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
- ca
Certs String - CA certs for the authorized cluster endpoint. It is only needed if there is a load balancer in front of the downstream cluster that is using an untrusted certificate. If you have a valid certificate, then nothing needs to be added to the CA Certificates field.
- enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - fqdn String
- FQDN for the authorized cluster endpoint. If one is entered, it should point to the downstream cluster.
ClusterV2RkeConfigMachinePool, ClusterV2RkeConfigMachinePoolArgs
- Machine
Config ClusterV2Rke Config Machine Pool Machine Config - Machine pool node config.
- Name string
- The name of the cluster.
- Annotations Dictionary<string, object>
- Annotations for the Cluster.
- Cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- Control
Plane boolRole - Machine pool control plane role?
- Drain
Before boolDelete - Machine Pool Drain Before Delete?
- Etcd
Role bool - Machine pool etcd role?
- Hostname
Length intLimit - maximum length for autogenerated hostname
- Labels Dictionary<string, object>
- Labels for the Cluster.
- Machine
Labels Dictionary<string, object> - Labels for Machine pool nodes.
- Max
Unhealthy string - Max unhealthy nodes for automated replacement to be allowed.
- Node
Drain intTimeout - Seconds a machine has to drain before deletion.
- Node
Startup intTimeout Seconds - Seconds a new node has to become active before it is replaced.
- Paused bool
- Machine pool paused?
- Quantity int
- Machine pool quantity.
- Rolling
Update ClusterV2Rke Config Machine Pool Rolling Update - Machine pool rolling update.
- Taints
List<Cluster
V2Rke Config Machine Pool Taint> - Machine pool taints.
- Unhealthy
Node intTimeout Seconds - Seconds an unhealthy node has to become active before it is replaced.
- Unhealthy
Range string - Range of unhealthy nodes for automated replacement to be allowed.
- Worker
Role bool - Machine pool worker role?
- Machine
Config ClusterV2Rke Config Machine Pool Machine Config - Machine pool node config.
- Name string
- The name of the cluster.
- Annotations map[string]interface{}
- Annotations for the Cluster.
- Cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- Control
Plane boolRole - Machine pool control plane role?
- Drain
Before boolDelete - Machine Pool Drain Before Delete?
- Etcd
Role bool - Machine pool etcd role?
- Hostname
Length intLimit - maximum length for autogenerated hostname
- Labels map[string]interface{}
- Labels for the Cluster.
- Machine
Labels map[string]interface{} - Labels for Machine pool nodes.
- Max
Unhealthy string - Max unhealthy nodes for automated replacement to be allowed.
- Node
Drain intTimeout - Seconds a machine has to drain before deletion.
- Node
Startup intTimeout Seconds - Seconds a new node has to become active before it is replaced.
- Paused bool
- Machine pool paused?
- Quantity int
- Machine pool quantity.
- Rolling
Update ClusterV2Rke Config Machine Pool Rolling Update - Machine pool rolling update.
- Taints
[]Cluster
V2Rke Config Machine Pool Taint - Machine pool taints.
- Unhealthy
Node intTimeout Seconds - Seconds an unhealthy node has to become active before it is replaced.
- Unhealthy
Range string - Range of unhealthy nodes for automated replacement to be allowed.
- Worker
Role bool - Machine pool worker role?
- machine
Config ClusterV2Rke Config Machine Pool Machine Config - Machine pool node config.
- name String
- The name of the cluster.
- annotations Map<String,Object>
- Annotations for the Cluster.
- cloud
Credential StringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- control
Plane BooleanRole - Machine pool control plane role?
- drain
Before BooleanDelete - Machine Pool Drain Before Delete?
- etcd
Role Boolean - Machine pool etcd role?
- hostname
Length IntegerLimit - maximum length for autogenerated hostname
- labels Map<String,Object>
- Labels for the Cluster.
- machine
Labels Map<String,Object> - Labels for Machine pool nodes.
- max
Unhealthy String - Max unhealthy nodes for automated replacement to be allowed.
- node
Drain IntegerTimeout - Seconds a machine has to drain before deletion.
- node
Startup IntegerTimeout Seconds - Seconds a new node has to become active before it is replaced.
- paused Boolean
- Machine pool paused?
- quantity Integer
- Machine pool quantity.
- rolling
Update ClusterV2Rke Config Machine Pool Rolling Update - Machine pool rolling update.
- taints
List<Cluster
V2Rke Config Machine Pool Taint> - Machine pool taints.
- unhealthy
Node IntegerTimeout Seconds - Seconds an unhealthy node has to become active before it is replaced.
- unhealthy
Range String - Range of unhealthy nodes for automated replacement to be allowed.
- worker
Role Boolean - Machine pool worker role?
- machine
Config ClusterV2Rke Config Machine Pool Machine Config - Machine pool node config.
- name string
- The name of the cluster.
- annotations {[key: string]: any}
- Annotations for the Cluster.
- cloud
Credential stringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- control
Plane booleanRole - Machine pool control plane role?
- drain
Before booleanDelete - Machine Pool Drain Before Delete?
- etcd
Role boolean - Machine pool etcd role?
- hostname
Length numberLimit - maximum length for autogenerated hostname
- labels {[key: string]: any}
- Labels for the Cluster.
- machine
Labels {[key: string]: any} - Labels for Machine pool nodes.
- max
Unhealthy string - Max unhealthy nodes for automated replacement to be allowed.
- node
Drain numberTimeout - Seconds a machine has to drain before deletion.
- node
Startup numberTimeout Seconds - Seconds a new node has to become active before it is replaced.
- paused boolean
- Machine pool paused?
- quantity number
- Machine pool quantity.
- rolling
Update ClusterV2Rke Config Machine Pool Rolling Update - Machine pool rolling update.
- taints
Cluster
V2Rke Config Machine Pool Taint[] - Machine pool taints.
- unhealthy
Node numberTimeout Seconds - Seconds an unhealthy node has to become active before it is replaced.
- unhealthy
Range string - Range of unhealthy nodes for automated replacement to be allowed.
- worker
Role boolean - Machine pool worker role?
- machine_
config ClusterV2Rke Config Machine Pool Machine Config - Machine pool node config.
- name str
- The name of the cluster.
- annotations Mapping[str, Any]
- Annotations for the Cluster.
- cloud_
credential_ strsecret_ name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- control_
plane_ boolrole - Machine pool control plane role?
- drain_
before_ booldelete - Machine Pool Drain Before Delete?
- etcd_
role bool - Machine pool etcd role?
- hostname_
length_ intlimit - maximum length for autogenerated hostname
- labels Mapping[str, Any]
- Labels for the Cluster.
- machine_
labels Mapping[str, Any] - Labels for Machine pool nodes.
- max_
unhealthy str - Max unhealthy nodes for automated replacement to be allowed.
- node_
drain_ inttimeout - Seconds a machine has to drain before deletion.
- node_
startup_ inttimeout_ seconds - Seconds a new node has to become active before it is replaced.
- paused bool
- Machine pool paused?
- quantity int
- Machine pool quantity.
- rolling_
update ClusterV2Rke Config Machine Pool Rolling Update - Machine pool rolling update.
- taints
Sequence[Cluster
V2Rke Config Machine Pool Taint] - Machine pool taints.
- unhealthy_
node_ inttimeout_ seconds - Seconds an unhealthy node has to become active before it is replaced.
- unhealthy_
range str - Range of unhealthy nodes for automated replacement to be allowed.
- worker_
role bool - Machine pool worker role?
- machine
Config Property Map - Machine pool node config.
- name String
- The name of the cluster.
- annotations Map<Any>
- Annotations for the Cluster.
- cloud
Credential StringSecret Name - Cloud credential secret name is the secret to be used when a cloud credential secret name is not specified at the machine pool level.
- control
Plane BooleanRole - Machine pool control plane role?
- drain
Before BooleanDelete - Machine Pool Drain Before Delete?
- etcd
Role Boolean - Machine pool etcd role?
- hostname
Length NumberLimit - maximum length for autogenerated hostname
- labels Map<Any>
- Labels for the Cluster.
- machine
Labels Map<Any> - Labels for Machine pool nodes.
- max
Unhealthy String - Max unhealthy nodes for automated replacement to be allowed.
- node
Drain NumberTimeout - Seconds a machine has to drain before deletion.
- node
Startup NumberTimeout Seconds - Seconds a new node has to become active before it is replaced.
- paused Boolean
- Machine pool paused?
- quantity Number
- Machine pool quantity.
- rolling
Update Property Map - Machine pool rolling update.
- taints List<Property Map>
- Machine pool taints.
- unhealthy
Node NumberTimeout Seconds - Seconds an unhealthy node has to become active before it is replaced.
- unhealthy
Range String - Range of unhealthy nodes for automated replacement to be allowed.
- worker
Role Boolean - Machine pool worker role?
ClusterV2RkeConfigMachinePoolDefault, ClusterV2RkeConfigMachinePoolDefaultArgs
- Hostname
Length intLimit - maximum length for autogenerated hostname
- Hostname
Length intLimit - maximum length for autogenerated hostname
- hostname
Length IntegerLimit - maximum length for autogenerated hostname
- hostname
Length numberLimit - maximum length for autogenerated hostname
- hostname_
length_ intlimit - maximum length for autogenerated hostname
- hostname
Length NumberLimit - maximum length for autogenerated hostname
ClusterV2RkeConfigMachinePoolMachineConfig, ClusterV2RkeConfigMachinePoolMachineConfigArgs
- Kind string
- Machine config kind.
- Name string
- The name of the cluster.
- Api
Version string - Api version of the machine_config.
- Kind string
- Machine config kind.
- Name string
- The name of the cluster.
- Api
Version string - Api version of the machine_config.
- kind String
- Machine config kind.
- name String
- The name of the cluster.
- api
Version String - Api version of the machine_config.
- kind string
- Machine config kind.
- name string
- The name of the cluster.
- api
Version string - Api version of the machine_config.
- kind str
- Machine config kind.
- name str
- The name of the cluster.
- api_
version str - Api version of the machine_config.
- kind String
- Machine config kind.
- name String
- The name of the cluster.
- api
Version String - Api version of the machine_config.
ClusterV2RkeConfigMachinePoolRollingUpdate, ClusterV2RkeConfigMachinePoolRollingUpdateArgs
- Max
Surge string - Rolling update max surge.
- string
- Rolling update max unavailable.
- Max
Surge string - Rolling update max surge.
- string
- Rolling update max unavailable.
- max
Surge String - Rolling update max surge.
- String
- Rolling update max unavailable.
- max
Surge string - Rolling update max surge.
- string
- Rolling update max unavailable.
- max_
surge str - Rolling update max surge.
- str
- Rolling update max unavailable.
- max
Surge String - Rolling update max surge.
- String
- Rolling update max unavailable.
ClusterV2RkeConfigMachinePoolTaint, ClusterV2RkeConfigMachinePoolTaintArgs
ClusterV2RkeConfigMachineSelectorConfig, ClusterV2RkeConfigMachineSelectorConfigArgs
- Config string
- Config is the distribution-specify configuration to be applied to nodes that match the provided label selector. For more information, please refer to Rancher's documentation for RKE2 Cluster Configuration or K3s Cluster Configuration
- Machine
Label ClusterSelector V2Rke Config Machine Selector Config Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- Config string
- Config is the distribution-specify configuration to be applied to nodes that match the provided label selector. For more information, please refer to Rancher's documentation for RKE2 Cluster Configuration or K3s Cluster Configuration
- Machine
Label ClusterSelector V2Rke Config Machine Selector Config Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- config String
- Config is the distribution-specify configuration to be applied to nodes that match the provided label selector. For more information, please refer to Rancher's documentation for RKE2 Cluster Configuration or K3s Cluster Configuration
- machine
Label ClusterSelector V2Rke Config Machine Selector Config Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- config string
- Config is the distribution-specify configuration to be applied to nodes that match the provided label selector. For more information, please refer to Rancher's documentation for RKE2 Cluster Configuration or K3s Cluster Configuration
- machine
Label ClusterSelector V2Rke Config Machine Selector Config Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- config str
- Config is the distribution-specify configuration to be applied to nodes that match the provided label selector. For more information, please refer to Rancher's documentation for RKE2 Cluster Configuration or K3s Cluster Configuration
- machine_
label_ Clusterselector V2Rke Config Machine Selector Config Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- config String
- Config is the distribution-specify configuration to be applied to nodes that match the provided label selector. For more information, please refer to Rancher's documentation for RKE2 Cluster Configuration or K3s Cluster Configuration
- machine
Label Property MapSelector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelector, ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorArgs
- Match
Expressions List<ClusterV2Rke Config Machine Selector Config Machine Label Selector Match Expression> - Match expressions is a list of label selector requirements. The requirements are ANDed.
- Match
Labels Dictionary<string, object> - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- Match
Expressions []ClusterV2Rke Config Machine Selector Config Machine Label Selector Match Expression - Match expressions is a list of label selector requirements. The requirements are ANDed.
- Match
Labels map[string]interface{} - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match
Expressions List<ClusterV2Rke Config Machine Selector Config Machine Label Selector Match Expression> - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels Map<String,Object> - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match
Expressions ClusterV2Rke Config Machine Selector Config Machine Label Selector Match Expression[] - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels {[key: string]: any} - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match_
expressions Sequence[ClusterV2Rke Config Machine Selector Config Machine Label Selector Match Expression] - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match_
labels Mapping[str, Any] - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match
Expressions List<Property Map> - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels Map<Any> - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorMatchExpression, ClusterV2RkeConfigMachineSelectorConfigMachineLabelSelectorMatchExpressionArgs
ClusterV2RkeConfigMachineSelectorFile, ClusterV2RkeConfigMachineSelectorFileArgs
- File
Sources List<ClusterV2Rke Config Machine Selector File File Source> - File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector.
- Machine
Label ClusterSelector V2Rke Config Machine Selector File Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- File
Sources []ClusterV2Rke Config Machine Selector File File Source - File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector.
- Machine
Label ClusterSelector V2Rke Config Machine Selector File Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- file
Sources List<ClusterV2Rke Config Machine Selector File File Source> - File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector.
- machine
Label ClusterSelector V2Rke Config Machine Selector File Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- file
Sources ClusterV2Rke Config Machine Selector File File Source[] - File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector.
- machine
Label ClusterSelector V2Rke Config Machine Selector File Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- file_
sources Sequence[ClusterV2Rke Config Machine Selector File File Source] - File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector.
- machine_
label_ Clusterselector V2Rke Config Machine Selector File Machine Label Selector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
- file
Sources List<Property Map> - File sources represents the source of the files. Multiple files can be delivered to nodes that match the provided label selector.
- machine
Label Property MapSelector - Machine selector label is a label query over a set of resources. The result of match_labels and match_expressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
ClusterV2RkeConfigMachineSelectorFileFileSource, ClusterV2RkeConfigMachineSelectorFileFileSourceArgs
- Configmap
Cluster
V2Rke Config Machine Selector File File Source Configmap - Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret.
- Secret
Cluster
V2Rke Config Machine Selector File File Source Secret - Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap.
- Configmap
Cluster
V2Rke Config Machine Selector File File Source Configmap - Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret.
- Secret
Cluster
V2Rke Config Machine Selector File File Source Secret - Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap.
- configmap
Cluster
V2Rke Config Machine Selector File File Source Configmap - Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret.
- secret
Cluster
V2Rke Config Machine Selector File File Source Secret - Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap.
- configmap
Cluster
V2Rke Config Machine Selector File File Source Configmap - Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret.
- secret
Cluster
V2Rke Config Machine Selector File File Source Secret - Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap.
- configmap
Cluster
V2Rke Config Machine Selector File File Source Configmap - Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret.
- secret
Cluster
V2Rke Config Machine Selector File File Source Secret - Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap.
- configmap Property Map
- Configmap represents a K8s configmap which is the source of files. It is mutually exclusive with secret.
- secret Property Map
- Secret represents a K8s secret which is the source of files. It is mutually exclusive with configmap.
ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmap, ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapArgs
- Name string
- The name of the cluster.
- Default
Permissions string - The numeric representation of the default file permissions for all files defined under the items.
- Items
List<Cluster
V2Rke Config Machine Selector File File Source Configmap Item> - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- Name string
- The name of the cluster.
- Default
Permissions string - The numeric representation of the default file permissions for all files defined under the items.
- Items
[]Cluster
V2Rke Config Machine Selector File File Source Configmap Item - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name String
- The name of the cluster.
- default
Permissions String - The numeric representation of the default file permissions for all files defined under the items.
- items
List<Cluster
V2Rke Config Machine Selector File File Source Configmap Item> - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name string
- The name of the cluster.
- default
Permissions string - The numeric representation of the default file permissions for all files defined under the items.
- items
Cluster
V2Rke Config Machine Selector File File Source Configmap Item[] - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name str
- The name of the cluster.
- default_
permissions str - The numeric representation of the default file permissions for all files defined under the items.
- items
Sequence[Cluster
V2Rke Config Machine Selector File File Source Configmap Item] - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name String
- The name of the cluster.
- default
Permissions String - The numeric representation of the default file permissions for all files defined under the items.
- items List<Property Map>
- Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapItem, ClusterV2RkeConfigMachineSelectorFileFileSourceConfigmapItemArgs
- Key string
- Key is the name of the key of the item to retrieve.
- Path string
- Path is the absolute path to put the file in the target node.
- Dynamic bool
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- Hash string
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- Permissions string
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- Key string
- Key is the name of the key of the item to retrieve.
- Path string
- Path is the absolute path to put the file in the target node.
- Dynamic bool
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- Hash string
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- Permissions string
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key String
- Key is the name of the key of the item to retrieve.
- path String
- Path is the absolute path to put the file in the target node.
- dynamic Boolean
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash String
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions String
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key string
- Key is the name of the key of the item to retrieve.
- path string
- Path is the absolute path to put the file in the target node.
- dynamic boolean
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash string
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions string
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key str
- Key is the name of the key of the item to retrieve.
- path str
- Path is the absolute path to put the file in the target node.
- dynamic bool
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash str
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions str
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key String
- Key is the name of the key of the item to retrieve.
- path String
- Path is the absolute path to put the file in the target node.
- dynamic Boolean
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash String
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions String
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
ClusterV2RkeConfigMachineSelectorFileFileSourceSecret, ClusterV2RkeConfigMachineSelectorFileFileSourceSecretArgs
- Name string
- The name of the cluster.
- Default
Permissions string - The numeric representation of the default file permissions for all files defined under the items.
- Items
List<Cluster
V2Rke Config Machine Selector File File Source Secret Item> - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- Name string
- The name of the cluster.
- Default
Permissions string - The numeric representation of the default file permissions for all files defined under the items.
- Items
[]Cluster
V2Rke Config Machine Selector File File Source Secret Item - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name String
- The name of the cluster.
- default
Permissions String - The numeric representation of the default file permissions for all files defined under the items.
- items
List<Cluster
V2Rke Config Machine Selector File File Source Secret Item> - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name string
- The name of the cluster.
- default
Permissions string - The numeric representation of the default file permissions for all files defined under the items.
- items
Cluster
V2Rke Config Machine Selector File File Source Secret Item[] - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name str
- The name of the cluster.
- default_
permissions str - The numeric representation of the default file permissions for all files defined under the items.
- items
Sequence[Cluster
V2Rke Config Machine Selector File File Source Secret Item] - Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
- name String
- The name of the cluster.
- default
Permissions String - The numeric representation of the default file permissions for all files defined under the items.
- items List<Property Map>
- Items is a list of configurations for files, such as where to retrieve the content from the source, where to put the file on nodes, etc.
ClusterV2RkeConfigMachineSelectorFileFileSourceSecretItem, ClusterV2RkeConfigMachineSelectorFileFileSourceSecretItemArgs
- Key string
- Key is the name of the key of the item to retrieve.
- Path string
- Path is the absolute path to put the file in the target node.
- Dynamic bool
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- Hash string
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- Permissions string
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- Key string
- Key is the name of the key of the item to retrieve.
- Path string
- Path is the absolute path to put the file in the target node.
- Dynamic bool
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- Hash string
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- Permissions string
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key String
- Key is the name of the key of the item to retrieve.
- path String
- Path is the absolute path to put the file in the target node.
- dynamic Boolean
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash String
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions String
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key string
- Key is the name of the key of the item to retrieve.
- path string
- Path is the absolute path to put the file in the target node.
- dynamic boolean
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash string
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions string
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key str
- Key is the name of the key of the item to retrieve.
- path str
- Path is the absolute path to put the file in the target node.
- dynamic bool
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash str
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions str
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
- key String
- Key is the name of the key of the item to retrieve.
- path String
- Path is the absolute path to put the file in the target node.
- dynamic Boolean
- If true, the file is ignored when determining whether the node should be drained before updating the node plan.
- hash String
- Hash is the base64 encoded value of the SHA256 checksum of the file's content. If specified, it is used to validate the integrity of the file content.
- permissions String
- Permissions is the numeric representation of the file permission. It takes precedence over the default permissions at the outer level.
ClusterV2RkeConfigMachineSelectorFileMachineLabelSelector, ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorArgs
- Match
Expressions List<ClusterV2Rke Config Machine Selector File Machine Label Selector Match Expression> - Match expressions is a list of label selector requirements. The requirements are ANDed.
- Match
Labels Dictionary<string, object> - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- Match
Expressions []ClusterV2Rke Config Machine Selector File Machine Label Selector Match Expression - Match expressions is a list of label selector requirements. The requirements are ANDed.
- Match
Labels map[string]interface{} - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match
Expressions List<ClusterV2Rke Config Machine Selector File Machine Label Selector Match Expression> - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels Map<String,Object> - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match
Expressions ClusterV2Rke Config Machine Selector File Machine Label Selector Match Expression[] - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels {[key: string]: any} - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match_
expressions Sequence[ClusterV2Rke Config Machine Selector File Machine Label Selector Match Expression] - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match_
labels Mapping[str, Any] - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
- match
Expressions List<Property Map> - Match expressions is a list of label selector requirements. The requirements are ANDed.
- match
Labels Map<Any> - Machine selector label is a map of {key,value} pairs, the requirements are ANDed.
ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorMatchExpression, ClusterV2RkeConfigMachineSelectorFileMachineLabelSelectorMatchExpressionArgs
ClusterV2RkeConfigRegistries, ClusterV2RkeConfigRegistriesArgs
- Configs
List<Cluster
V2Rke Config Registries Config> - Cluster V2 docker registries config.
- Mirrors
List<Cluster
V2Rke Config Registries Mirror> - Cluster V2 docker registries mirror.
- Configs
[]Cluster
V2Rke Config Registries Config - Cluster V2 docker registries config.
- Mirrors
[]Cluster
V2Rke Config Registries Mirror - Cluster V2 docker registries mirror.
- configs
List<Cluster
V2Rke Config Registries Config> - Cluster V2 docker registries config.
- mirrors
List<Cluster
V2Rke Config Registries Mirror> - Cluster V2 docker registries mirror.
- configs
Cluster
V2Rke Config Registries Config[] - Cluster V2 docker registries config.
- mirrors
Cluster
V2Rke Config Registries Mirror[] - Cluster V2 docker registries mirror.
- configs
Sequence[Cluster
V2Rke Config Registries Config] - Cluster V2 docker registries config.
- mirrors
Sequence[Cluster
V2Rke Config Registries Mirror] - Cluster V2 docker registries mirror.
- configs List<Property Map>
- Cluster V2 docker registries config.
- mirrors List<Property Map>
- Cluster V2 docker registries mirror.
ClusterV2RkeConfigRegistriesConfig, ClusterV2RkeConfigRegistriesConfigArgs
- Hostname string
- Registry hostname.
- Auth
Config stringSecret Name - Name of the secret that contains two keys with base64 encoded values: the username and password for the specified custom registry. No secret is required if the system-default-registry is not authenticated.
- Ca
Bundle string - Registry CA bundle.
- Insecure bool
- Registry insecure connectivity.
- Tls
Secret stringName - Registry TLS secret name. TLS is a pair of Cert/Key.
- Hostname string
- Registry hostname.
- Auth
Config stringSecret Name - Name of the secret that contains two keys with base64 encoded values: the username and password for the specified custom registry. No secret is required if the system-default-registry is not authenticated.
- Ca
Bundle string - Registry CA bundle.
- Insecure bool
- Registry insecure connectivity.
- Tls
Secret stringName - Registry TLS secret name. TLS is a pair of Cert/Key.
- hostname String
- Registry hostname.
- auth
Config StringSecret Name - Name of the secret that contains two keys with base64 encoded values: the username and password for the specified custom registry. No secret is required if the system-default-registry is not authenticated.
- ca
Bundle String - Registry CA bundle.
- insecure Boolean
- Registry insecure connectivity.
- tls
Secret StringName - Registry TLS secret name. TLS is a pair of Cert/Key.
- hostname string
- Registry hostname.
- auth
Config stringSecret Name - Name of the secret that contains two keys with base64 encoded values: the username and password for the specified custom registry. No secret is required if the system-default-registry is not authenticated.
- ca
Bundle string - Registry CA bundle.
- insecure boolean
- Registry insecure connectivity.
- tls
Secret stringName - Registry TLS secret name. TLS is a pair of Cert/Key.
- hostname str
- Registry hostname.
- auth_
config_ strsecret_ name - Name of the secret that contains two keys with base64 encoded values: the username and password for the specified custom registry. No secret is required if the system-default-registry is not authenticated.
- ca_
bundle str - Registry CA bundle.
- insecure bool
- Registry insecure connectivity.
- tls_
secret_ strname - Registry TLS secret name. TLS is a pair of Cert/Key.
- hostname String
- Registry hostname.
- auth
Config StringSecret Name - Name of the secret that contains two keys with base64 encoded values: the username and password for the specified custom registry. No secret is required if the system-default-registry is not authenticated.
- ca
Bundle String - Registry CA bundle.
- insecure Boolean
- Registry insecure connectivity.
- tls
Secret StringName - Registry TLS secret name. TLS is a pair of Cert/Key.
ClusterV2RkeConfigRegistriesMirror, ClusterV2RkeConfigRegistriesMirrorArgs
ClusterV2RkeConfigRotateCertificates, ClusterV2RkeConfigRotateCertificatesArgs
- Generation int
- ETCD snapshot desired generation.
- Services List<string>
- Service certificates to rotate with this generation.
- Generation int
- ETCD snapshot desired generation.
- Services []string
- Service certificates to rotate with this generation.
- generation Integer
- ETCD snapshot desired generation.
- services List<String>
- Service certificates to rotate with this generation.
- generation number
- ETCD snapshot desired generation.
- services string[]
- Service certificates to rotate with this generation.
- generation int
- ETCD snapshot desired generation.
- services Sequence[str]
- Service certificates to rotate with this generation.
- generation Number
- ETCD snapshot desired generation.
- services List<String>
- Service certificates to rotate with this generation.
ClusterV2RkeConfigUpgradeStrategy, ClusterV2RkeConfigUpgradeStrategyArgs
- Control
Plane stringConcurrency - How many control plane nodes should be upgraded at a time, 0 is infinite. Percentages are also accepted.
- Control
Plane ClusterDrain Options V2Rke Config Upgrade Strategy Control Plane Drain Options - Controlplane nodes drain options.
- Worker
Concurrency string - How many worker nodes should be upgraded at a time. Percentages are also accepted.
- Worker
Drain ClusterOptions V2Rke Config Upgrade Strategy Worker Drain Options - Worker nodes drain options.
- Control
Plane stringConcurrency - How many control plane nodes should be upgraded at a time, 0 is infinite. Percentages are also accepted.
- Control
Plane ClusterDrain Options V2Rke Config Upgrade Strategy Control Plane Drain Options - Controlplane nodes drain options.
- Worker
Concurrency string - How many worker nodes should be upgraded at a time. Percentages are also accepted.
- Worker
Drain ClusterOptions V2Rke Config Upgrade Strategy Worker Drain Options - Worker nodes drain options.
- control
Plane StringConcurrency - How many control plane nodes should be upgraded at a time, 0 is infinite. Percentages are also accepted.
- control
Plane ClusterDrain Options V2Rke Config Upgrade Strategy Control Plane Drain Options - Controlplane nodes drain options.
- worker
Concurrency String - How many worker nodes should be upgraded at a time. Percentages are also accepted.
- worker
Drain ClusterOptions V2Rke Config Upgrade Strategy Worker Drain Options - Worker nodes drain options.
- control
Plane stringConcurrency - How many control plane nodes should be upgraded at a time, 0 is infinite. Percentages are also accepted.
- control
Plane ClusterDrain Options V2Rke Config Upgrade Strategy Control Plane Drain Options - Controlplane nodes drain options.
- worker
Concurrency string - How many worker nodes should be upgraded at a time. Percentages are also accepted.
- worker
Drain ClusterOptions V2Rke Config Upgrade Strategy Worker Drain Options - Worker nodes drain options.
- control_
plane_ strconcurrency - How many control plane nodes should be upgraded at a time, 0 is infinite. Percentages are also accepted.
- control_
plane_ Clusterdrain_ options V2Rke Config Upgrade Strategy Control Plane Drain Options - Controlplane nodes drain options.
- worker_
concurrency str - How many worker nodes should be upgraded at a time. Percentages are also accepted.
- worker_
drain_ Clusteroptions V2Rke Config Upgrade Strategy Worker Drain Options - Worker nodes drain options.
- control
Plane StringConcurrency - How many control plane nodes should be upgraded at a time, 0 is infinite. Percentages are also accepted.
- control
Plane Property MapDrain Options - Controlplane nodes drain options.
- worker
Concurrency String - How many worker nodes should be upgraded at a time. Percentages are also accepted.
- worker
Drain Property MapOptions - Worker nodes drain options.
ClusterV2RkeConfigUpgradeStrategyControlPlaneDrainOptions, ClusterV2RkeConfigUpgradeStrategyControlPlaneDrainOptionsArgs
- Delete
Empty boolDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - Disable
Eviction bool - If
disable_eviction
is set to true, force drain to use delete rather than evict. - Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Force bool
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - Grace
Period int - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- Ignore
Daemon boolSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - Ignore
Errors bool - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - Skip
Wait intFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- Timeout int
- Time to wait (in seconds) before giving up for one try.
- Delete
Empty boolDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - Disable
Eviction bool - If
disable_eviction
is set to true, force drain to use delete rather than evict. - Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Force bool
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - Grace
Period int - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- Ignore
Daemon boolSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - Ignore
Errors bool - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - Skip
Wait intFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- Timeout int
- Time to wait (in seconds) before giving up for one try.
- delete
Empty BooleanDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable
Eviction Boolean - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - force Boolean
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace
Period Integer - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore
Daemon BooleanSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore
Errors Boolean - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip
Wait IntegerFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout Integer
- Time to wait (in seconds) before giving up for one try.
- delete
Empty booleanDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable
Eviction boolean - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - force boolean
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace
Period number - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore
Daemon booleanSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore
Errors boolean - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip
Wait numberFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout number
- Time to wait (in seconds) before giving up for one try.
- delete_
empty_ booldir_ data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable_
eviction bool - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - force bool
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace_
period int - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore_
daemon_ boolsets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore_
errors bool - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip_
wait_ intfor_ delete_ timeout_ seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout int
- Time to wait (in seconds) before giving up for one try.
- delete
Empty BooleanDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable
Eviction Boolean - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - force Boolean
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace
Period Number - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore
Daemon BooleanSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore
Errors Boolean - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip
Wait NumberFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout Number
- Time to wait (in seconds) before giving up for one try.
ClusterV2RkeConfigUpgradeStrategyWorkerDrainOptions, ClusterV2RkeConfigUpgradeStrategyWorkerDrainOptionsArgs
- Delete
Empty boolDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - Disable
Eviction bool - If
disable_eviction
is set to true, force drain to use delete rather than evict. - Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Force bool
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - Grace
Period int - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- Ignore
Daemon boolSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - Ignore
Errors bool - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - Skip
Wait intFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- Timeout int
- Time to wait (in seconds) before giving up for one try.
- Delete
Empty boolDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - Disable
Eviction bool - If
disable_eviction
is set to true, force drain to use delete rather than evict. - Enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - Force bool
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - Grace
Period int - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- Ignore
Daemon boolSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - Ignore
Errors bool - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - Skip
Wait intFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- Timeout int
- Time to wait (in seconds) before giving up for one try.
- delete
Empty BooleanDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable
Eviction Boolean - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - force Boolean
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace
Period Integer - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore
Daemon BooleanSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore
Errors Boolean - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip
Wait IntegerFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout Integer
- Time to wait (in seconds) before giving up for one try.
- delete
Empty booleanDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable
Eviction boolean - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - force boolean
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace
Period number - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore
Daemon booleanSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore
Errors boolean - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip
Wait numberFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout number
- Time to wait (in seconds) before giving up for one try.
- delete_
empty_ booldir_ data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable_
eviction bool - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled bool
- If
enabled
is set to true, nodes will be drained before upgrade. - force bool
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace_
period int - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore_
daemon_ boolsets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore_
errors bool - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip_
wait_ intfor_ delete_ timeout_ seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout int
- Time to wait (in seconds) before giving up for one try.
- delete
Empty BooleanDir Data - if
delete_empty_dir_data
is set to true, continue draining even if there are pods using emptyDir (local storage). - disable
Eviction Boolean - If
disable_eviction
is set to true, force drain to use delete rather than evict. - enabled Boolean
- If
enabled
is set to true, nodes will be drained before upgrade. - force Boolean
- If
force
is set to true, drain nodes even if there are standalone pods that are not managed by a ReplicationController, Job, or DaemonSet. Drain will not proceed withoutforce
set to true if there are such pods. - grace
Period Number - Time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
- ignore
Daemon BooleanSets - If
ignore_daemon_sets
is set to false, drain will not proceed if there are DaemonSet-managed pods. - ignore
Errors Boolean - If
ignore_errors
is set to true, errors that occurred between drain nodes in group are ignored. - skip
Wait NumberFor Delete Timeout Seconds - Skip waiting for the pods that have a DeletionTimeStamp > N seconds to be deleted. Seconds must be greater than 0 to skip. Such pods will be force deleted.
- timeout Number
- Time to wait (in seconds) before giving up for one try.
Package Details
- Repository
- Rancher2 pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
rancher2
Terraform Provider.