spectrocloud.ClusterGke
Explore with Pulumi AI
Resource for managing GKE clusters through Palette.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as spectrocloud from "@pulumi/spectrocloud";
const account = spectrocloud.getCloudaccountGcp({
name: _var.gcp_cloud_account_name,
});
const profile = spectrocloud.getClusterProfile({
name: _var.gke_cluster_profile_name,
});
const cluster = new spectrocloud.ClusterGke("cluster", {
description: "Gke Cluster",
tags: [
"dev",
"department:pax",
],
cloudAccountId: account.then(account => account.id),
context: "project",
clusterProfiles: [{
id: profile.then(profile => profile.id),
}],
cloudConfig: {
project: _var.gcp_project,
region: _var.gcp_region,
},
updateWorkerPoolInParallel: true,
machinePools: [{
name: "worker-basic",
count: 3,
instanceType: "n2-standard-4",
}],
});
import pulumi
import pulumi_spectrocloud as spectrocloud
account = spectrocloud.get_cloudaccount_gcp(name=var["gcp_cloud_account_name"])
profile = spectrocloud.get_cluster_profile(name=var["gke_cluster_profile_name"])
cluster = spectrocloud.ClusterGke("cluster",
description="Gke Cluster",
tags=[
"dev",
"department:pax",
],
cloud_account_id=account.id,
context="project",
cluster_profiles=[{
"id": profile.id,
}],
cloud_config={
"project": var["gcp_project"],
"region": var["gcp_region"],
},
update_worker_pool_in_parallel=True,
machine_pools=[{
"name": "worker-basic",
"count": 3,
"instance_type": "n2-standard-4",
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/spectrocloud/spectrocloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
account, err := spectrocloud.LookupCloudaccountGcp(ctx, &spectrocloud.LookupCloudaccountGcpArgs{
Name: pulumi.StringRef(_var.Gcp_cloud_account_name),
}, nil)
if err != nil {
return err
}
profile, err := spectrocloud.LookupClusterProfile(ctx, &spectrocloud.LookupClusterProfileArgs{
Name: pulumi.StringRef(_var.Gke_cluster_profile_name),
}, nil)
if err != nil {
return err
}
_, err = spectrocloud.NewClusterGke(ctx, "cluster", &spectrocloud.ClusterGkeArgs{
Description: pulumi.String("Gke Cluster"),
Tags: pulumi.StringArray{
pulumi.String("dev"),
pulumi.String("department:pax"),
},
CloudAccountId: pulumi.String(account.Id),
Context: pulumi.String("project"),
ClusterProfiles: spectrocloud.ClusterGkeClusterProfileArray{
&spectrocloud.ClusterGkeClusterProfileArgs{
Id: pulumi.String(profile.Id),
},
},
CloudConfig: &spectrocloud.ClusterGkeCloudConfigArgs{
Project: pulumi.Any(_var.Gcp_project),
Region: pulumi.Any(_var.Gcp_region),
},
UpdateWorkerPoolInParallel: pulumi.Bool(true),
MachinePools: spectrocloud.ClusterGkeMachinePoolArray{
&spectrocloud.ClusterGkeMachinePoolArgs{
Name: pulumi.String("worker-basic"),
Count: pulumi.Float64(3),
InstanceType: pulumi.String("n2-standard-4"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Spectrocloud = Pulumi.Spectrocloud;
return await Deployment.RunAsync(() =>
{
var account = Spectrocloud.GetCloudaccountGcp.Invoke(new()
{
Name = @var.Gcp_cloud_account_name,
});
var profile = Spectrocloud.GetClusterProfile.Invoke(new()
{
Name = @var.Gke_cluster_profile_name,
});
var cluster = new Spectrocloud.ClusterGke("cluster", new()
{
Description = "Gke Cluster",
Tags = new[]
{
"dev",
"department:pax",
},
CloudAccountId = account.Apply(getCloudaccountGcpResult => getCloudaccountGcpResult.Id),
Context = "project",
ClusterProfiles = new[]
{
new Spectrocloud.Inputs.ClusterGkeClusterProfileArgs
{
Id = profile.Apply(getClusterProfileResult => getClusterProfileResult.Id),
},
},
CloudConfig = new Spectrocloud.Inputs.ClusterGkeCloudConfigArgs
{
Project = @var.Gcp_project,
Region = @var.Gcp_region,
},
UpdateWorkerPoolInParallel = true,
MachinePools = new[]
{
new Spectrocloud.Inputs.ClusterGkeMachinePoolArgs
{
Name = "worker-basic",
Count = 3,
InstanceType = "n2-standard-4",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.spectrocloud.SpectrocloudFunctions;
import com.pulumi.spectrocloud.inputs.GetCloudaccountGcpArgs;
import com.pulumi.spectrocloud.inputs.GetClusterProfileArgs;
import com.pulumi.spectrocloud.ClusterGke;
import com.pulumi.spectrocloud.ClusterGkeArgs;
import com.pulumi.spectrocloud.inputs.ClusterGkeClusterProfileArgs;
import com.pulumi.spectrocloud.inputs.ClusterGkeCloudConfigArgs;
import com.pulumi.spectrocloud.inputs.ClusterGkeMachinePoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var account = SpectrocloudFunctions.getCloudaccountGcp(GetCloudaccountGcpArgs.builder()
.name(var_.gcp_cloud_account_name())
.build());
final var profile = SpectrocloudFunctions.getClusterProfile(GetClusterProfileArgs.builder()
.name(var_.gke_cluster_profile_name())
.build());
var cluster = new ClusterGke("cluster", ClusterGkeArgs.builder()
.description("Gke Cluster")
.tags(
"dev",
"department:pax")
.cloudAccountId(account.applyValue(getCloudaccountGcpResult -> getCloudaccountGcpResult.id()))
.context("project")
.clusterProfiles(ClusterGkeClusterProfileArgs.builder()
.id(profile.applyValue(getClusterProfileResult -> getClusterProfileResult.id()))
.build())
.cloudConfig(ClusterGkeCloudConfigArgs.builder()
.project(var_.gcp_project())
.region(var_.gcp_region())
.build())
.updateWorkerPoolInParallel(true)
.machinePools(ClusterGkeMachinePoolArgs.builder()
.name("worker-basic")
.count(3)
.instanceType("n2-standard-4")
.build())
.build());
}
}
resources:
cluster:
type: spectrocloud:ClusterGke
properties:
description: Gke Cluster
tags:
- dev
- department:pax
cloudAccountId: ${account.id}
context: project
clusterProfiles:
- id: ${profile.id}
cloudConfig:
project: ${var.gcp_project}
region: ${var.gcp_region}
updateWorkerPoolInParallel: true
machinePools:
- name: worker-basic
count: 3
instanceType: n2-standard-4
variables:
account:
fn::invoke:
function: spectrocloud:getCloudaccountGcp
arguments:
name: ${var.gcp_cloud_account_name}
profile:
fn::invoke:
function: spectrocloud:getClusterProfile
arguments:
name: ${var.gke_cluster_profile_name}
Create ClusterGke Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClusterGke(name: string, args: ClusterGkeArgs, opts?: CustomResourceOptions);
@overload
def ClusterGke(resource_name: str,
args: ClusterGkeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClusterGke(resource_name: str,
opts: Optional[ResourceOptions] = None,
cloud_config: Optional[ClusterGkeCloudConfigArgs] = None,
machine_pools: Optional[Sequence[ClusterGkeMachinePoolArgs]] = None,
cloud_account_id: Optional[str] = None,
host_configs: Optional[Sequence[ClusterGkeHostConfigArgs]] = None,
name: Optional[str] = None,
cluster_meta_attribute: Optional[str] = None,
cluster_profiles: Optional[Sequence[ClusterGkeClusterProfileArgs]] = None,
cluster_rbac_bindings: Optional[Sequence[ClusterGkeClusterRbacBindingArgs]] = None,
context: Optional[str] = None,
description: Optional[str] = None,
force_delete: Optional[bool] = None,
force_delete_delay: Optional[float] = None,
apply_setting: Optional[str] = None,
backup_policy: Optional[ClusterGkeBackupPolicyArgs] = None,
cluster_gke_id: Optional[str] = None,
namespaces: Optional[Sequence[ClusterGkeNamespaceArgs]] = None,
os_patch_after: Optional[str] = None,
os_patch_on_boot: Optional[bool] = None,
os_patch_schedule: Optional[str] = None,
pause_agent_upgrades: Optional[str] = None,
review_repave_state: Optional[str] = None,
scan_policy: Optional[ClusterGkeScanPolicyArgs] = None,
skip_completion: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ClusterGkeTimeoutsArgs] = None,
update_worker_pool_in_parallel: Optional[bool] = None)
func NewClusterGke(ctx *Context, name string, args ClusterGkeArgs, opts ...ResourceOption) (*ClusterGke, error)
public ClusterGke(string name, ClusterGkeArgs args, CustomResourceOptions? opts = null)
public ClusterGke(String name, ClusterGkeArgs args)
public ClusterGke(String name, ClusterGkeArgs args, CustomResourceOptions options)
type: spectrocloud:ClusterGke
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 ClusterGkeArgs
- 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 ClusterGkeArgs
- 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 ClusterGkeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterGkeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterGkeArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var clusterGkeResource = new Spectrocloud.ClusterGke("clusterGkeResource", new()
{
CloudConfig = new Spectrocloud.Inputs.ClusterGkeCloudConfigArgs
{
Project = "string",
Region = "string",
},
MachinePools = new[]
{
new Spectrocloud.Inputs.ClusterGkeMachinePoolArgs
{
Count = 0,
InstanceType = "string",
Name = "string",
AdditionalLabels =
{
{ "string", "string" },
},
DiskSizeGb = 0,
Nodes = new[]
{
new Spectrocloud.Inputs.ClusterGkeMachinePoolNodeArgs
{
Action = "string",
NodeId = "string",
},
},
Taints = new[]
{
new Spectrocloud.Inputs.ClusterGkeMachinePoolTaintArgs
{
Effect = "string",
Key = "string",
Value = "string",
},
},
UpdateStrategy = "string",
},
},
CloudAccountId = "string",
HostConfigs = new[]
{
new Spectrocloud.Inputs.ClusterGkeHostConfigArgs
{
ExternalTrafficPolicy = "string",
HostEndpointType = "string",
IngressHost = "string",
LoadBalancerSourceRanges = "string",
},
},
Name = "string",
ClusterMetaAttribute = "string",
ClusterProfiles = new[]
{
new Spectrocloud.Inputs.ClusterGkeClusterProfileArgs
{
Id = "string",
Packs = new[]
{
new Spectrocloud.Inputs.ClusterGkeClusterProfilePackArgs
{
Name = "string",
Manifests = new[]
{
new Spectrocloud.Inputs.ClusterGkeClusterProfilePackManifestArgs
{
Content = "string",
Name = "string",
Uid = "string",
},
},
RegistryUid = "string",
Tag = "string",
Type = "string",
Uid = "string",
Values = "string",
},
},
Variables =
{
{ "string", "string" },
},
},
},
ClusterRbacBindings = new[]
{
new Spectrocloud.Inputs.ClusterGkeClusterRbacBindingArgs
{
Type = "string",
Namespace = "string",
Role =
{
{ "string", "string" },
},
Subjects = new[]
{
new Spectrocloud.Inputs.ClusterGkeClusterRbacBindingSubjectArgs
{
Name = "string",
Type = "string",
Namespace = "string",
},
},
},
},
Context = "string",
Description = "string",
ForceDelete = false,
ForceDeleteDelay = 0,
ApplySetting = "string",
BackupPolicy = new Spectrocloud.Inputs.ClusterGkeBackupPolicyArgs
{
BackupLocationId = "string",
ExpiryInHour = 0,
Prefix = "string",
Schedule = "string",
ClusterUids = new[]
{
"string",
},
IncludeAllClusters = false,
IncludeClusterResources = false,
IncludeClusterResourcesMode = "string",
IncludeDisks = false,
Namespaces = new[]
{
"string",
},
},
ClusterGkeId = "string",
Namespaces = new[]
{
new Spectrocloud.Inputs.ClusterGkeNamespaceArgs
{
Name = "string",
ResourceAllocation =
{
{ "string", "string" },
},
ImagesBlacklists = new[]
{
"string",
},
},
},
OsPatchAfter = "string",
OsPatchOnBoot = false,
OsPatchSchedule = "string",
PauseAgentUpgrades = "string",
ReviewRepaveState = "string",
ScanPolicy = new Spectrocloud.Inputs.ClusterGkeScanPolicyArgs
{
ConfigurationScanSchedule = "string",
ConformanceScanSchedule = "string",
PenetrationScanSchedule = "string",
},
SkipCompletion = false,
Tags = new[]
{
"string",
},
Timeouts = new Spectrocloud.Inputs.ClusterGkeTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
UpdateWorkerPoolInParallel = false,
});
example, err := spectrocloud.NewClusterGke(ctx, "clusterGkeResource", &spectrocloud.ClusterGkeArgs{
CloudConfig: &spectrocloud.ClusterGkeCloudConfigArgs{
Project: pulumi.String("string"),
Region: pulumi.String("string"),
},
MachinePools: spectrocloud.ClusterGkeMachinePoolArray{
&spectrocloud.ClusterGkeMachinePoolArgs{
Count: pulumi.Float64(0),
InstanceType: pulumi.String("string"),
Name: pulumi.String("string"),
AdditionalLabels: pulumi.StringMap{
"string": pulumi.String("string"),
},
DiskSizeGb: pulumi.Float64(0),
Nodes: spectrocloud.ClusterGkeMachinePoolNodeArray{
&spectrocloud.ClusterGkeMachinePoolNodeArgs{
Action: pulumi.String("string"),
NodeId: pulumi.String("string"),
},
},
Taints: spectrocloud.ClusterGkeMachinePoolTaintArray{
&spectrocloud.ClusterGkeMachinePoolTaintArgs{
Effect: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
UpdateStrategy: pulumi.String("string"),
},
},
CloudAccountId: pulumi.String("string"),
HostConfigs: spectrocloud.ClusterGkeHostConfigArray{
&spectrocloud.ClusterGkeHostConfigArgs{
ExternalTrafficPolicy: pulumi.String("string"),
HostEndpointType: pulumi.String("string"),
IngressHost: pulumi.String("string"),
LoadBalancerSourceRanges: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
ClusterMetaAttribute: pulumi.String("string"),
ClusterProfiles: spectrocloud.ClusterGkeClusterProfileArray{
&spectrocloud.ClusterGkeClusterProfileArgs{
Id: pulumi.String("string"),
Packs: spectrocloud.ClusterGkeClusterProfilePackArray{
&spectrocloud.ClusterGkeClusterProfilePackArgs{
Name: pulumi.String("string"),
Manifests: spectrocloud.ClusterGkeClusterProfilePackManifestArray{
&spectrocloud.ClusterGkeClusterProfilePackManifestArgs{
Content: pulumi.String("string"),
Name: pulumi.String("string"),
Uid: pulumi.String("string"),
},
},
RegistryUid: pulumi.String("string"),
Tag: pulumi.String("string"),
Type: pulumi.String("string"),
Uid: pulumi.String("string"),
Values: pulumi.String("string"),
},
},
Variables: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
ClusterRbacBindings: spectrocloud.ClusterGkeClusterRbacBindingArray{
&spectrocloud.ClusterGkeClusterRbacBindingArgs{
Type: pulumi.String("string"),
Namespace: pulumi.String("string"),
Role: pulumi.StringMap{
"string": pulumi.String("string"),
},
Subjects: spectrocloud.ClusterGkeClusterRbacBindingSubjectArray{
&spectrocloud.ClusterGkeClusterRbacBindingSubjectArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Namespace: pulumi.String("string"),
},
},
},
},
Context: pulumi.String("string"),
Description: pulumi.String("string"),
ForceDelete: pulumi.Bool(false),
ForceDeleteDelay: pulumi.Float64(0),
ApplySetting: pulumi.String("string"),
BackupPolicy: &spectrocloud.ClusterGkeBackupPolicyArgs{
BackupLocationId: pulumi.String("string"),
ExpiryInHour: pulumi.Float64(0),
Prefix: pulumi.String("string"),
Schedule: pulumi.String("string"),
ClusterUids: pulumi.StringArray{
pulumi.String("string"),
},
IncludeAllClusters: pulumi.Bool(false),
IncludeClusterResources: pulumi.Bool(false),
IncludeClusterResourcesMode: pulumi.String("string"),
IncludeDisks: pulumi.Bool(false),
Namespaces: pulumi.StringArray{
pulumi.String("string"),
},
},
ClusterGkeId: pulumi.String("string"),
Namespaces: spectrocloud.ClusterGkeNamespaceArray{
&spectrocloud.ClusterGkeNamespaceArgs{
Name: pulumi.String("string"),
ResourceAllocation: pulumi.StringMap{
"string": pulumi.String("string"),
},
ImagesBlacklists: pulumi.StringArray{
pulumi.String("string"),
},
},
},
OsPatchAfter: pulumi.String("string"),
OsPatchOnBoot: pulumi.Bool(false),
OsPatchSchedule: pulumi.String("string"),
PauseAgentUpgrades: pulumi.String("string"),
ReviewRepaveState: pulumi.String("string"),
ScanPolicy: &spectrocloud.ClusterGkeScanPolicyArgs{
ConfigurationScanSchedule: pulumi.String("string"),
ConformanceScanSchedule: pulumi.String("string"),
PenetrationScanSchedule: pulumi.String("string"),
},
SkipCompletion: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &spectrocloud.ClusterGkeTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
UpdateWorkerPoolInParallel: pulumi.Bool(false),
})
var clusterGkeResource = new ClusterGke("clusterGkeResource", ClusterGkeArgs.builder()
.cloudConfig(ClusterGkeCloudConfigArgs.builder()
.project("string")
.region("string")
.build())
.machinePools(ClusterGkeMachinePoolArgs.builder()
.count(0)
.instanceType("string")
.name("string")
.additionalLabels(Map.of("string", "string"))
.diskSizeGb(0)
.nodes(ClusterGkeMachinePoolNodeArgs.builder()
.action("string")
.nodeId("string")
.build())
.taints(ClusterGkeMachinePoolTaintArgs.builder()
.effect("string")
.key("string")
.value("string")
.build())
.updateStrategy("string")
.build())
.cloudAccountId("string")
.hostConfigs(ClusterGkeHostConfigArgs.builder()
.externalTrafficPolicy("string")
.hostEndpointType("string")
.ingressHost("string")
.loadBalancerSourceRanges("string")
.build())
.name("string")
.clusterMetaAttribute("string")
.clusterProfiles(ClusterGkeClusterProfileArgs.builder()
.id("string")
.packs(ClusterGkeClusterProfilePackArgs.builder()
.name("string")
.manifests(ClusterGkeClusterProfilePackManifestArgs.builder()
.content("string")
.name("string")
.uid("string")
.build())
.registryUid("string")
.tag("string")
.type("string")
.uid("string")
.values("string")
.build())
.variables(Map.of("string", "string"))
.build())
.clusterRbacBindings(ClusterGkeClusterRbacBindingArgs.builder()
.type("string")
.namespace("string")
.role(Map.of("string", "string"))
.subjects(ClusterGkeClusterRbacBindingSubjectArgs.builder()
.name("string")
.type("string")
.namespace("string")
.build())
.build())
.context("string")
.description("string")
.forceDelete(false)
.forceDeleteDelay(0)
.applySetting("string")
.backupPolicy(ClusterGkeBackupPolicyArgs.builder()
.backupLocationId("string")
.expiryInHour(0)
.prefix("string")
.schedule("string")
.clusterUids("string")
.includeAllClusters(false)
.includeClusterResources(false)
.includeClusterResourcesMode("string")
.includeDisks(false)
.namespaces("string")
.build())
.clusterGkeId("string")
.namespaces(ClusterGkeNamespaceArgs.builder()
.name("string")
.resourceAllocation(Map.of("string", "string"))
.imagesBlacklists("string")
.build())
.osPatchAfter("string")
.osPatchOnBoot(false)
.osPatchSchedule("string")
.pauseAgentUpgrades("string")
.reviewRepaveState("string")
.scanPolicy(ClusterGkeScanPolicyArgs.builder()
.configurationScanSchedule("string")
.conformanceScanSchedule("string")
.penetrationScanSchedule("string")
.build())
.skipCompletion(false)
.tags("string")
.timeouts(ClusterGkeTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.updateWorkerPoolInParallel(false)
.build());
cluster_gke_resource = spectrocloud.ClusterGke("clusterGkeResource",
cloud_config={
"project": "string",
"region": "string",
},
machine_pools=[{
"count": 0,
"instance_type": "string",
"name": "string",
"additional_labels": {
"string": "string",
},
"disk_size_gb": 0,
"nodes": [{
"action": "string",
"node_id": "string",
}],
"taints": [{
"effect": "string",
"key": "string",
"value": "string",
}],
"update_strategy": "string",
}],
cloud_account_id="string",
host_configs=[{
"external_traffic_policy": "string",
"host_endpoint_type": "string",
"ingress_host": "string",
"load_balancer_source_ranges": "string",
}],
name="string",
cluster_meta_attribute="string",
cluster_profiles=[{
"id": "string",
"packs": [{
"name": "string",
"manifests": [{
"content": "string",
"name": "string",
"uid": "string",
}],
"registry_uid": "string",
"tag": "string",
"type": "string",
"uid": "string",
"values": "string",
}],
"variables": {
"string": "string",
},
}],
cluster_rbac_bindings=[{
"type": "string",
"namespace": "string",
"role": {
"string": "string",
},
"subjects": [{
"name": "string",
"type": "string",
"namespace": "string",
}],
}],
context="string",
description="string",
force_delete=False,
force_delete_delay=0,
apply_setting="string",
backup_policy={
"backup_location_id": "string",
"expiry_in_hour": 0,
"prefix": "string",
"schedule": "string",
"cluster_uids": ["string"],
"include_all_clusters": False,
"include_cluster_resources": False,
"include_cluster_resources_mode": "string",
"include_disks": False,
"namespaces": ["string"],
},
cluster_gke_id="string",
namespaces=[{
"name": "string",
"resource_allocation": {
"string": "string",
},
"images_blacklists": ["string"],
}],
os_patch_after="string",
os_patch_on_boot=False,
os_patch_schedule="string",
pause_agent_upgrades="string",
review_repave_state="string",
scan_policy={
"configuration_scan_schedule": "string",
"conformance_scan_schedule": "string",
"penetration_scan_schedule": "string",
},
skip_completion=False,
tags=["string"],
timeouts={
"create": "string",
"delete": "string",
"update": "string",
},
update_worker_pool_in_parallel=False)
const clusterGkeResource = new spectrocloud.ClusterGke("clusterGkeResource", {
cloudConfig: {
project: "string",
region: "string",
},
machinePools: [{
count: 0,
instanceType: "string",
name: "string",
additionalLabels: {
string: "string",
},
diskSizeGb: 0,
nodes: [{
action: "string",
nodeId: "string",
}],
taints: [{
effect: "string",
key: "string",
value: "string",
}],
updateStrategy: "string",
}],
cloudAccountId: "string",
hostConfigs: [{
externalTrafficPolicy: "string",
hostEndpointType: "string",
ingressHost: "string",
loadBalancerSourceRanges: "string",
}],
name: "string",
clusterMetaAttribute: "string",
clusterProfiles: [{
id: "string",
packs: [{
name: "string",
manifests: [{
content: "string",
name: "string",
uid: "string",
}],
registryUid: "string",
tag: "string",
type: "string",
uid: "string",
values: "string",
}],
variables: {
string: "string",
},
}],
clusterRbacBindings: [{
type: "string",
namespace: "string",
role: {
string: "string",
},
subjects: [{
name: "string",
type: "string",
namespace: "string",
}],
}],
context: "string",
description: "string",
forceDelete: false,
forceDeleteDelay: 0,
applySetting: "string",
backupPolicy: {
backupLocationId: "string",
expiryInHour: 0,
prefix: "string",
schedule: "string",
clusterUids: ["string"],
includeAllClusters: false,
includeClusterResources: false,
includeClusterResourcesMode: "string",
includeDisks: false,
namespaces: ["string"],
},
clusterGkeId: "string",
namespaces: [{
name: "string",
resourceAllocation: {
string: "string",
},
imagesBlacklists: ["string"],
}],
osPatchAfter: "string",
osPatchOnBoot: false,
osPatchSchedule: "string",
pauseAgentUpgrades: "string",
reviewRepaveState: "string",
scanPolicy: {
configurationScanSchedule: "string",
conformanceScanSchedule: "string",
penetrationScanSchedule: "string",
},
skipCompletion: false,
tags: ["string"],
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
updateWorkerPoolInParallel: false,
});
type: spectrocloud:ClusterGke
properties:
applySetting: string
backupPolicy:
backupLocationId: string
clusterUids:
- string
expiryInHour: 0
includeAllClusters: false
includeClusterResources: false
includeClusterResourcesMode: string
includeDisks: false
namespaces:
- string
prefix: string
schedule: string
cloudAccountId: string
cloudConfig:
project: string
region: string
clusterGkeId: string
clusterMetaAttribute: string
clusterProfiles:
- id: string
packs:
- manifests:
- content: string
name: string
uid: string
name: string
registryUid: string
tag: string
type: string
uid: string
values: string
variables:
string: string
clusterRbacBindings:
- namespace: string
role:
string: string
subjects:
- name: string
namespace: string
type: string
type: string
context: string
description: string
forceDelete: false
forceDeleteDelay: 0
hostConfigs:
- externalTrafficPolicy: string
hostEndpointType: string
ingressHost: string
loadBalancerSourceRanges: string
machinePools:
- additionalLabels:
string: string
count: 0
diskSizeGb: 0
instanceType: string
name: string
nodes:
- action: string
nodeId: string
taints:
- effect: string
key: string
value: string
updateStrategy: string
name: string
namespaces:
- imagesBlacklists:
- string
name: string
resourceAllocation:
string: string
osPatchAfter: string
osPatchOnBoot: false
osPatchSchedule: string
pauseAgentUpgrades: string
reviewRepaveState: string
scanPolicy:
configurationScanSchedule: string
conformanceScanSchedule: string
penetrationScanSchedule: string
skipCompletion: false
tags:
- string
timeouts:
create: string
delete: string
update: string
updateWorkerPoolInParallel: false
ClusterGke Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ClusterGke resource accepts the following input properties:
- Cloud
Account stringId - Cloud
Config ClusterGke Cloud Config - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- Machine
Pools List<ClusterGke Machine Pool> - The machine pool configuration for the cluster.
- Apply
Setting string - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - Backup
Policy ClusterGke Backup Policy - The backup policy for the cluster. If not specified, no backups will be taken.
- Cluster
Gke stringId - The ID of this resource.
- Cluster
Meta stringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- Cluster
Profiles List<ClusterGke Cluster Profile> - Cluster
Rbac List<ClusterBindings Gke Cluster Rbac Binding> - The RBAC binding for the cluster.
- Context string
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- The description of the cluster. Default value is empty string.
- Force
Delete bool - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - Force
Delete doubleDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- Host
Configs List<ClusterGke Host Config> - The host configuration for the cluster.
- Name string
- The name of the cluster.
- Namespaces
List<Cluster
Gke Namespace> - The namespaces for the cluster.
- Os
Patch stringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- Os
Patch boolOn Boot - Whether to apply OS patch on boot. Default is
false
. - Os
Patch stringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - Pause
Agent stringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - Review
Repave stringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - Scan
Policy ClusterGke Scan Policy - The scan policy for the cluster.
- Skip
Completion bool - If
true
, the cluster will be created asynchronously. Default value isfalse
. - List<string>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Gke Timeouts - Update
Worker boolPool In Parallel
- Cloud
Account stringId - Cloud
Config ClusterGke Cloud Config Args - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- Machine
Pools []ClusterGke Machine Pool Args - The machine pool configuration for the cluster.
- Apply
Setting string - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - Backup
Policy ClusterGke Backup Policy Args - The backup policy for the cluster. If not specified, no backups will be taken.
- Cluster
Gke stringId - The ID of this resource.
- Cluster
Meta stringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- Cluster
Profiles []ClusterGke Cluster Profile Args - Cluster
Rbac []ClusterBindings Gke Cluster Rbac Binding Args - The RBAC binding for the cluster.
- Context string
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- The description of the cluster. Default value is empty string.
- Force
Delete bool - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - Force
Delete float64Delay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- Host
Configs []ClusterGke Host Config Args - The host configuration for the cluster.
- Name string
- The name of the cluster.
- Namespaces
[]Cluster
Gke Namespace Args - The namespaces for the cluster.
- Os
Patch stringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- Os
Patch boolOn Boot - Whether to apply OS patch on boot. Default is
false
. - Os
Patch stringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - Pause
Agent stringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - Review
Repave stringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - Scan
Policy ClusterGke Scan Policy Args - The scan policy for the cluster.
- Skip
Completion bool - If
true
, the cluster will be created asynchronously. Default value isfalse
. - []string
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Gke Timeouts Args - Update
Worker boolPool In Parallel
- cloud
Account StringId - cloud
Config ClusterGke Cloud Config - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- machine
Pools List<ClusterGke Machine Pool> - The machine pool configuration for the cluster.
- apply
Setting String - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup
Policy ClusterGke Backup Policy - The backup policy for the cluster. If not specified, no backups will be taken.
- cluster
Gke StringId - The ID of this resource.
- cluster
Meta StringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster
Profiles List<ClusterGke Cluster Profile> - cluster
Rbac List<ClusterBindings Gke Cluster Rbac Binding> - The RBAC binding for the cluster.
- context String
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- The description of the cluster. Default value is empty string.
- force
Delete Boolean - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force
Delete DoubleDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host
Configs List<ClusterGke Host Config> - The host configuration for the cluster.
- name String
- The name of the cluster.
- namespaces
List<Cluster
Gke Namespace> - The namespaces for the cluster.
- os
Patch StringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os
Patch BooleanOn Boot - Whether to apply OS patch on boot. Default is
false
. - os
Patch StringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause
Agent StringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review
Repave StringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan
Policy ClusterGke Scan Policy - The scan policy for the cluster.
- skip
Completion Boolean - If
true
, the cluster will be created asynchronously. Default value isfalse
. - List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Gke Timeouts - update
Worker BooleanPool In Parallel
- cloud
Account stringId - cloud
Config ClusterGke Cloud Config - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- machine
Pools ClusterGke Machine Pool[] - The machine pool configuration for the cluster.
- apply
Setting string - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup
Policy ClusterGke Backup Policy - The backup policy for the cluster. If not specified, no backups will be taken.
- cluster
Gke stringId - The ID of this resource.
- cluster
Meta stringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster
Profiles ClusterGke Cluster Profile[] - cluster
Rbac ClusterBindings Gke Cluster Rbac Binding[] - The RBAC binding for the cluster.
- context string
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description string
- The description of the cluster. Default value is empty string.
- force
Delete boolean - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force
Delete numberDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host
Configs ClusterGke Host Config[] - The host configuration for the cluster.
- name string
- The name of the cluster.
- namespaces
Cluster
Gke Namespace[] - The namespaces for the cluster.
- os
Patch stringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os
Patch booleanOn Boot - Whether to apply OS patch on boot. Default is
false
. - os
Patch stringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause
Agent stringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review
Repave stringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan
Policy ClusterGke Scan Policy - The scan policy for the cluster.
- skip
Completion boolean - If
true
, the cluster will be created asynchronously. Default value isfalse
. - string[]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Gke Timeouts - update
Worker booleanPool In Parallel
- cloud_
account_ strid - cloud_
config ClusterGke Cloud Config Args - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- machine_
pools Sequence[ClusterGke Machine Pool Args] - The machine pool configuration for the cluster.
- apply_
setting str - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup_
policy ClusterGke Backup Policy Args - The backup policy for the cluster. If not specified, no backups will be taken.
- cluster_
gke_ strid - The ID of this resource.
- cluster_
meta_ strattribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster_
profiles Sequence[ClusterGke Cluster Profile Args] - cluster_
rbac_ Sequence[Clusterbindings Gke Cluster Rbac Binding Args] - The RBAC binding for the cluster.
- context str
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description str
- The description of the cluster. Default value is empty string.
- force_
delete bool - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force_
delete_ floatdelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host_
configs Sequence[ClusterGke Host Config Args] - The host configuration for the cluster.
- name str
- The name of the cluster.
- namespaces
Sequence[Cluster
Gke Namespace Args] - The namespaces for the cluster.
- os_
patch_ strafter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os_
patch_ boolon_ boot - Whether to apply OS patch on boot. Default is
false
. - os_
patch_ strschedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause_
agent_ strupgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review_
repave_ strstate - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan_
policy ClusterGke Scan Policy Args - The scan policy for the cluster.
- skip_
completion bool - If
true
, the cluster will be created asynchronously. Default value isfalse
. - Sequence[str]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Gke Timeouts Args - update_
worker_ boolpool_ in_ parallel
- cloud
Account StringId - cloud
Config Property Map - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- machine
Pools List<Property Map> - The machine pool configuration for the cluster.
- apply
Setting String - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup
Policy Property Map - The backup policy for the cluster. If not specified, no backups will be taken.
- cluster
Gke StringId - The ID of this resource.
- cluster
Meta StringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster
Profiles List<Property Map> - cluster
Rbac List<Property Map>Bindings - The RBAC binding for the cluster.
- context String
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- The description of the cluster. Default value is empty string.
- force
Delete Boolean - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force
Delete NumberDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host
Configs List<Property Map> - The host configuration for the cluster.
- name String
- The name of the cluster.
- namespaces List<Property Map>
- The namespaces for the cluster.
- os
Patch StringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os
Patch BooleanOn Boot - Whether to apply OS patch on boot. Default is
false
. - os
Patch StringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause
Agent StringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review
Repave StringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan
Policy Property Map - The scan policy for the cluster.
- skip
Completion Boolean - If
true
, the cluster will be created asynchronously. Default value isfalse
. - List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts Property Map
- update
Worker BooleanPool In Parallel
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterGke resource produces the following output properties:
- Admin
Kube stringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - Cloud
Config stringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - Id string
- The provider-assigned unique ID for this managed resource.
- Kubeconfig string
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - Location
Configs List<ClusterGke Location Config> - The location of the cluster.
- Admin
Kube stringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - Cloud
Config stringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - Id string
- The provider-assigned unique ID for this managed resource.
- Kubeconfig string
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - Location
Configs []ClusterGke Location Config - The location of the cluster.
- admin
Kube StringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - cloud
Config StringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - id String
- The provider-assigned unique ID for this managed resource.
- kubeconfig String
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location
Configs List<ClusterGke Location Config> - The location of the cluster.
- admin
Kube stringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - cloud
Config stringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - id string
- The provider-assigned unique ID for this managed resource.
- kubeconfig string
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location
Configs ClusterGke Location Config[] - The location of the cluster.
- admin_
kube_ strconfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - cloud_
config_ strid - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - id str
- The provider-assigned unique ID for this managed resource.
- kubeconfig str
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location_
configs Sequence[ClusterGke Location Config] - The location of the cluster.
- admin
Kube StringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - cloud
Config StringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - id String
- The provider-assigned unique ID for this managed resource.
- kubeconfig String
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location
Configs List<Property Map> - The location of the cluster.
Look up Existing ClusterGke Resource
Get an existing ClusterGke 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?: ClusterGkeState, opts?: CustomResourceOptions): ClusterGke
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
admin_kube_config: Optional[str] = None,
apply_setting: Optional[str] = None,
backup_policy: Optional[ClusterGkeBackupPolicyArgs] = None,
cloud_account_id: Optional[str] = None,
cloud_config: Optional[ClusterGkeCloudConfigArgs] = None,
cloud_config_id: Optional[str] = None,
cluster_gke_id: Optional[str] = None,
cluster_meta_attribute: Optional[str] = None,
cluster_profiles: Optional[Sequence[ClusterGkeClusterProfileArgs]] = None,
cluster_rbac_bindings: Optional[Sequence[ClusterGkeClusterRbacBindingArgs]] = None,
context: Optional[str] = None,
description: Optional[str] = None,
force_delete: Optional[bool] = None,
force_delete_delay: Optional[float] = None,
host_configs: Optional[Sequence[ClusterGkeHostConfigArgs]] = None,
kubeconfig: Optional[str] = None,
location_configs: Optional[Sequence[ClusterGkeLocationConfigArgs]] = None,
machine_pools: Optional[Sequence[ClusterGkeMachinePoolArgs]] = None,
name: Optional[str] = None,
namespaces: Optional[Sequence[ClusterGkeNamespaceArgs]] = None,
os_patch_after: Optional[str] = None,
os_patch_on_boot: Optional[bool] = None,
os_patch_schedule: Optional[str] = None,
pause_agent_upgrades: Optional[str] = None,
review_repave_state: Optional[str] = None,
scan_policy: Optional[ClusterGkeScanPolicyArgs] = None,
skip_completion: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ClusterGkeTimeoutsArgs] = None,
update_worker_pool_in_parallel: Optional[bool] = None) -> ClusterGke
func GetClusterGke(ctx *Context, name string, id IDInput, state *ClusterGkeState, opts ...ResourceOption) (*ClusterGke, error)
public static ClusterGke Get(string name, Input<string> id, ClusterGkeState? state, CustomResourceOptions? opts = null)
public static ClusterGke get(String name, Output<String> id, ClusterGkeState state, CustomResourceOptions options)
resources: _: type: spectrocloud:ClusterGke get: id: ${id}
- 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.
- Admin
Kube stringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - Apply
Setting string - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - Backup
Policy ClusterGke Backup Policy - The backup policy for the cluster. If not specified, no backups will be taken.
- Cloud
Account stringId - Cloud
Config ClusterGke Cloud Config - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- Cloud
Config stringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - Cluster
Gke stringId - The ID of this resource.
- Cluster
Meta stringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- Cluster
Profiles List<ClusterGke Cluster Profile> - Cluster
Rbac List<ClusterBindings Gke Cluster Rbac Binding> - The RBAC binding for the cluster.
- Context string
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- The description of the cluster. Default value is empty string.
- Force
Delete bool - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - Force
Delete doubleDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- Host
Configs List<ClusterGke Host Config> - The host configuration for the cluster.
- Kubeconfig string
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - Location
Configs List<ClusterGke Location Config> - The location of the cluster.
- Machine
Pools List<ClusterGke Machine Pool> - The machine pool configuration for the cluster.
- Name string
- The name of the cluster.
- Namespaces
List<Cluster
Gke Namespace> - The namespaces for the cluster.
- Os
Patch stringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- Os
Patch boolOn Boot - Whether to apply OS patch on boot. Default is
false
. - Os
Patch stringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - Pause
Agent stringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - Review
Repave stringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - Scan
Policy ClusterGke Scan Policy - The scan policy for the cluster.
- Skip
Completion bool - If
true
, the cluster will be created asynchronously. Default value isfalse
. - List<string>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Gke Timeouts - Update
Worker boolPool In Parallel
- Admin
Kube stringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - Apply
Setting string - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - Backup
Policy ClusterGke Backup Policy Args - The backup policy for the cluster. If not specified, no backups will be taken.
- Cloud
Account stringId - Cloud
Config ClusterGke Cloud Config Args - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- Cloud
Config stringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - Cluster
Gke stringId - The ID of this resource.
- Cluster
Meta stringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- Cluster
Profiles []ClusterGke Cluster Profile Args - Cluster
Rbac []ClusterBindings Gke Cluster Rbac Binding Args - The RBAC binding for the cluster.
- Context string
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- The description of the cluster. Default value is empty string.
- Force
Delete bool - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - Force
Delete float64Delay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- Host
Configs []ClusterGke Host Config Args - The host configuration for the cluster.
- Kubeconfig string
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - Location
Configs []ClusterGke Location Config Args - The location of the cluster.
- Machine
Pools []ClusterGke Machine Pool Args - The machine pool configuration for the cluster.
- Name string
- The name of the cluster.
- Namespaces
[]Cluster
Gke Namespace Args - The namespaces for the cluster.
- Os
Patch stringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- Os
Patch boolOn Boot - Whether to apply OS patch on boot. Default is
false
. - Os
Patch stringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - Pause
Agent stringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - Review
Repave stringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - Scan
Policy ClusterGke Scan Policy Args - The scan policy for the cluster.
- Skip
Completion bool - If
true
, the cluster will be created asynchronously. Default value isfalse
. - []string
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Gke Timeouts Args - Update
Worker boolPool In Parallel
- admin
Kube StringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - apply
Setting String - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup
Policy ClusterGke Backup Policy - The backup policy for the cluster. If not specified, no backups will be taken.
- cloud
Account StringId - cloud
Config ClusterGke Cloud Config - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- cloud
Config StringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - cluster
Gke StringId - The ID of this resource.
- cluster
Meta StringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster
Profiles List<ClusterGke Cluster Profile> - cluster
Rbac List<ClusterBindings Gke Cluster Rbac Binding> - The RBAC binding for the cluster.
- context String
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- The description of the cluster. Default value is empty string.
- force
Delete Boolean - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force
Delete DoubleDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host
Configs List<ClusterGke Host Config> - The host configuration for the cluster.
- kubeconfig String
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location
Configs List<ClusterGke Location Config> - The location of the cluster.
- machine
Pools List<ClusterGke Machine Pool> - The machine pool configuration for the cluster.
- name String
- The name of the cluster.
- namespaces
List<Cluster
Gke Namespace> - The namespaces for the cluster.
- os
Patch StringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os
Patch BooleanOn Boot - Whether to apply OS patch on boot. Default is
false
. - os
Patch StringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause
Agent StringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review
Repave StringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan
Policy ClusterGke Scan Policy - The scan policy for the cluster.
- skip
Completion Boolean - If
true
, the cluster will be created asynchronously. Default value isfalse
. - List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Gke Timeouts - update
Worker BooleanPool In Parallel
- admin
Kube stringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - apply
Setting string - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup
Policy ClusterGke Backup Policy - The backup policy for the cluster. If not specified, no backups will be taken.
- cloud
Account stringId - cloud
Config ClusterGke Cloud Config - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- cloud
Config stringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - cluster
Gke stringId - The ID of this resource.
- cluster
Meta stringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster
Profiles ClusterGke Cluster Profile[] - cluster
Rbac ClusterBindings Gke Cluster Rbac Binding[] - The RBAC binding for the cluster.
- context string
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description string
- The description of the cluster. Default value is empty string.
- force
Delete boolean - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force
Delete numberDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host
Configs ClusterGke Host Config[] - The host configuration for the cluster.
- kubeconfig string
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location
Configs ClusterGke Location Config[] - The location of the cluster.
- machine
Pools ClusterGke Machine Pool[] - The machine pool configuration for the cluster.
- name string
- The name of the cluster.
- namespaces
Cluster
Gke Namespace[] - The namespaces for the cluster.
- os
Patch stringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os
Patch booleanOn Boot - Whether to apply OS patch on boot. Default is
false
. - os
Patch stringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause
Agent stringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review
Repave stringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan
Policy ClusterGke Scan Policy - The scan policy for the cluster.
- skip
Completion boolean - If
true
, the cluster will be created asynchronously. Default value isfalse
. - string[]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Gke Timeouts - update
Worker booleanPool In Parallel
- admin_
kube_ strconfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - apply_
setting str - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup_
policy ClusterGke Backup Policy Args - The backup policy for the cluster. If not specified, no backups will be taken.
- cloud_
account_ strid - cloud_
config ClusterGke Cloud Config Args - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- cloud_
config_ strid - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - cluster_
gke_ strid - The ID of this resource.
- cluster_
meta_ strattribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster_
profiles Sequence[ClusterGke Cluster Profile Args] - cluster_
rbac_ Sequence[Clusterbindings Gke Cluster Rbac Binding Args] - The RBAC binding for the cluster.
- context str
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description str
- The description of the cluster. Default value is empty string.
- force_
delete bool - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force_
delete_ floatdelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host_
configs Sequence[ClusterGke Host Config Args] - The host configuration for the cluster.
- kubeconfig str
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location_
configs Sequence[ClusterGke Location Config Args] - The location of the cluster.
- machine_
pools Sequence[ClusterGke Machine Pool Args] - The machine pool configuration for the cluster.
- name str
- The name of the cluster.
- namespaces
Sequence[Cluster
Gke Namespace Args] - The namespaces for the cluster.
- os_
patch_ strafter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os_
patch_ boolon_ boot - Whether to apply OS patch on boot. Default is
false
. - os_
patch_ strschedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause_
agent_ strupgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review_
repave_ strstate - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan_
policy ClusterGke Scan Policy Args - The scan policy for the cluster.
- skip_
completion bool - If
true
, the cluster will be created asynchronously. Default value isfalse
. - Sequence[str]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Gke Timeouts Args - update_
worker_ boolpool_ in_ parallel
- admin
Kube StringConfig - Admin Kube-config for the cluster. This can be used to connect to the cluster using
kubectl
, With admin privilege. - apply
Setting String - The setting to apply the cluster profile.
DownloadAndInstall
will download and install packs in one action.DownloadAndInstallLater
will only download artifact and postpone install for later. Default value isDownloadAndInstall
. - backup
Policy Property Map - The backup policy for the cluster. If not specified, no backups will be taken.
- cloud
Account StringId - cloud
Config Property Map - The GKE environment configuration settings such as project parameters and region parameters that apply to this cluster.
- cloud
Config StringId - ID of the cloud config used for the cluster. This cloud config must be of type
azure
. - cluster
Gke StringId - The ID of this resource.
- cluster
Meta StringAttribute cluster_meta_attribute
can be used to set additional cluster metadata information, eg{'nic_name': 'test', 'env': 'stage'}
- cluster
Profiles List<Property Map> - cluster
Rbac List<Property Map>Bindings - The RBAC binding for the cluster.
- context String
- The context of the GKE cluster. Allowed values are
project
ortenant
. Default isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- The description of the cluster. Default value is empty string.
- force
Delete Boolean - If set to
true
, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources. - force
Delete NumberDelay - Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
- host
Configs List<Property Map> - The host configuration for the cluster.
- kubeconfig String
- Kubeconfig for the cluster. This can be used to connect to the cluster using
kubectl
. - location
Configs List<Property Map> - The location of the cluster.
- machine
Pools List<Property Map> - The machine pool configuration for the cluster.
- name String
- The name of the cluster.
- namespaces List<Property Map>
- The namespaces for the cluster.
- os
Patch StringAfter - Date and time after which to patch cluster
RFC3339: 2006-01-02T15:04:05Z07:00
- os
Patch BooleanOn Boot - Whether to apply OS patch on boot. Default is
false
. - os
Patch StringSchedule - Cron schedule for OS patching. This must be in the form of
0 0 * * *
. - pause
Agent StringUpgrades - The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is
unlock
, meaning upgrades occur automatically. Setting it tolock
pauses automatic agent upgrades for the cluster. - review
Repave StringState - To authorize the cluster repave, set the value to
Approved
for approval and""
to decline. Default value is""
. - scan
Policy Property Map - The scan policy for the cluster.
- skip
Completion Boolean - If
true
, the cluster will be created asynchronously. Default value isfalse
. - List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts Property Map
- update
Worker BooleanPool In Parallel
Supporting Types
ClusterGkeBackupPolicy, ClusterGkeBackupPolicyArgs
- Backup
Location stringId - The ID of the backup location to use for the backup.
- Expiry
In doubleHour - The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
- Prefix string
- Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
- Schedule string
- The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to
0 1 * * *
. - Cluster
Uids List<string> - The list of cluster UIDs to include in the backup. If
include_all_clusters
is set totrue
, then all clusters will be included. - Include
All boolClusters - Whether to include all clusters in the backup. If set to false, only the clusters specified in
cluster_uids
will be included. - Include
Cluster boolResources - Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
- Include
Cluster stringResources Mode - Specifies whether to include the cluster resources in the backup. Supported values are
always
,never
, andauto
. - Include
Disks bool - Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
- Namespaces List<string>
- The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
- Backup
Location stringId - The ID of the backup location to use for the backup.
- Expiry
In float64Hour - The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
- Prefix string
- Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
- Schedule string
- The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to
0 1 * * *
. - Cluster
Uids []string - The list of cluster UIDs to include in the backup. If
include_all_clusters
is set totrue
, then all clusters will be included. - Include
All boolClusters - Whether to include all clusters in the backup. If set to false, only the clusters specified in
cluster_uids
will be included. - Include
Cluster boolResources - Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
- Include
Cluster stringResources Mode - Specifies whether to include the cluster resources in the backup. Supported values are
always
,never
, andauto
. - Include
Disks bool - Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
- Namespaces []string
- The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
- backup
Location StringId - The ID of the backup location to use for the backup.
- expiry
In DoubleHour - The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
- prefix String
- Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
- schedule String
- The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to
0 1 * * *
. - cluster
Uids List<String> - The list of cluster UIDs to include in the backup. If
include_all_clusters
is set totrue
, then all clusters will be included. - include
All BooleanClusters - Whether to include all clusters in the backup. If set to false, only the clusters specified in
cluster_uids
will be included. - include
Cluster BooleanResources - Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
- include
Cluster StringResources Mode - Specifies whether to include the cluster resources in the backup. Supported values are
always
,never
, andauto
. - include
Disks Boolean - Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
- namespaces List<String>
- The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
- backup
Location stringId - The ID of the backup location to use for the backup.
- expiry
In numberHour - The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
- prefix string
- Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
- schedule string
- The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to
0 1 * * *
. - cluster
Uids string[] - The list of cluster UIDs to include in the backup. If
include_all_clusters
is set totrue
, then all clusters will be included. - include
All booleanClusters - Whether to include all clusters in the backup. If set to false, only the clusters specified in
cluster_uids
will be included. - include
Cluster booleanResources - Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
- include
Cluster stringResources Mode - Specifies whether to include the cluster resources in the backup. Supported values are
always
,never
, andauto
. - include
Disks boolean - Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
- namespaces string[]
- The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
- backup_
location_ strid - The ID of the backup location to use for the backup.
- expiry_
in_ floathour - The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
- prefix str
- Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
- schedule str
- The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to
0 1 * * *
. - cluster_
uids Sequence[str] - The list of cluster UIDs to include in the backup. If
include_all_clusters
is set totrue
, then all clusters will be included. - include_
all_ boolclusters - Whether to include all clusters in the backup. If set to false, only the clusters specified in
cluster_uids
will be included. - include_
cluster_ boolresources - Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
- include_
cluster_ strresources_ mode - Specifies whether to include the cluster resources in the backup. Supported values are
always
,never
, andauto
. - include_
disks bool - Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
- namespaces Sequence[str]
- The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
- backup
Location StringId - The ID of the backup location to use for the backup.
- expiry
In NumberHour - The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
- prefix String
- Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
- schedule String
- The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to
0 1 * * *
. - cluster
Uids List<String> - The list of cluster UIDs to include in the backup. If
include_all_clusters
is set totrue
, then all clusters will be included. - include
All BooleanClusters - Whether to include all clusters in the backup. If set to false, only the clusters specified in
cluster_uids
will be included. - include
Cluster BooleanResources - Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
- include
Cluster StringResources Mode - Specifies whether to include the cluster resources in the backup. Supported values are
always
,never
, andauto
. - include
Disks Boolean - Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
- namespaces List<String>
- The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
ClusterGkeCloudConfig, ClusterGkeCloudConfigArgs
ClusterGkeClusterProfile, ClusterGkeClusterProfileArgs
- Id string
- The ID of the cluster profile.
- Packs
List<Cluster
Gke Cluster Profile Pack> - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - Variables Dictionary<string, string>
- A map of cluster profile variables, specified as key-value pairs. For example:
priority = "5"
.
- Id string
- The ID of the cluster profile.
- Packs
[]Cluster
Gke Cluster Profile Pack - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - Variables map[string]string
- A map of cluster profile variables, specified as key-value pairs. For example:
priority = "5"
.
- id String
- The ID of the cluster profile.
- packs
List<Cluster
Gke Cluster Profile Pack> - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - variables Map<String,String>
- A map of cluster profile variables, specified as key-value pairs. For example:
priority = "5"
.
- id string
- The ID of the cluster profile.
- packs
Cluster
Gke Cluster Profile Pack[] - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - variables {[key: string]: string}
- A map of cluster profile variables, specified as key-value pairs. For example:
priority = "5"
.
- id str
- The ID of the cluster profile.
- packs
Sequence[Cluster
Gke Cluster Profile Pack] - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - variables Mapping[str, str]
- A map of cluster profile variables, specified as key-value pairs. For example:
priority = "5"
.
- id String
- The ID of the cluster profile.
- packs List<Property Map>
- For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - variables Map<String>
- A map of cluster profile variables, specified as key-value pairs. For example:
priority = "5"
.
ClusterGkeClusterProfilePack, ClusterGkeClusterProfilePackArgs
- Name string
- The name of the pack. The name must be unique within the cluster profile.
- Manifests
List<Cluster
Gke Cluster Profile Pack Manifest> - Registry
Uid string - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- Tag string
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - Type string
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - Uid string
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - Values string
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- Name string
- The name of the pack. The name must be unique within the cluster profile.
- Manifests
[]Cluster
Gke Cluster Profile Pack Manifest - Registry
Uid string - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- Tag string
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - Type string
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - Uid string
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - Values string
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name String
- The name of the pack. The name must be unique within the cluster profile.
- manifests
List<Cluster
Gke Cluster Profile Pack Manifest> - registry
Uid String - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag String
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type String
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid String
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values String
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name string
- The name of the pack. The name must be unique within the cluster profile.
- manifests
Cluster
Gke Cluster Profile Pack Manifest[] - registry
Uid string - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag string
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type string
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid string
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values string
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name str
- The name of the pack. The name must be unique within the cluster profile.
- manifests
Sequence[Cluster
Gke Cluster Profile Pack Manifest] - registry_
uid str - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag str
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type str
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid str
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values str
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name String
- The name of the pack. The name must be unique within the cluster profile.
- manifests List<Property Map>
- registry
Uid String - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag String
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type String
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid String
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values String
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
ClusterGkeClusterProfilePackManifest, ClusterGkeClusterProfilePackManifestArgs
ClusterGkeClusterRbacBinding, ClusterGkeClusterRbacBindingArgs
- Type string
- The type of the RBAC binding. Can be one of the following values:
RoleBinding
, orClusterRoleBinding
. - Namespace string
- The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- Role Dictionary<string, string>
- The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- Subjects
List<Cluster
Gke Cluster Rbac Binding Subject>
- Type string
- The type of the RBAC binding. Can be one of the following values:
RoleBinding
, orClusterRoleBinding
. - Namespace string
- The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- Role map[string]string
- The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- Subjects
[]Cluster
Gke Cluster Rbac Binding Subject
- type String
- The type of the RBAC binding. Can be one of the following values:
RoleBinding
, orClusterRoleBinding
. - namespace String
- The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- role Map<String,String>
- The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- subjects
List<Cluster
Gke Cluster Rbac Binding Subject>
- type string
- The type of the RBAC binding. Can be one of the following values:
RoleBinding
, orClusterRoleBinding
. - namespace string
- The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- role {[key: string]: string}
- The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- subjects
Cluster
Gke Cluster Rbac Binding Subject[]
- type str
- The type of the RBAC binding. Can be one of the following values:
RoleBinding
, orClusterRoleBinding
. - namespace str
- The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- role Mapping[str, str]
- The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- subjects
Sequence[Cluster
Gke Cluster Rbac Binding Subject]
- type String
- The type of the RBAC binding. Can be one of the following values:
RoleBinding
, orClusterRoleBinding
. - namespace String
- The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- role Map<String>
- The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
- subjects List<Property Map>
ClusterGkeClusterRbacBindingSubject, ClusterGkeClusterRbacBindingSubjectArgs
ClusterGkeHostConfig, ClusterGkeHostConfigArgs
- External
Traffic stringPolicy - The external traffic policy for the cluster.
- Host
Endpoint stringType - The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
- Ingress
Host string - The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
- Load
Balancer stringSource Ranges - The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
- External
Traffic stringPolicy - The external traffic policy for the cluster.
- Host
Endpoint stringType - The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
- Ingress
Host string - The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
- Load
Balancer stringSource Ranges - The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
- external
Traffic StringPolicy - The external traffic policy for the cluster.
- host
Endpoint StringType - The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
- ingress
Host String - The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
- load
Balancer StringSource Ranges - The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
- external
Traffic stringPolicy - The external traffic policy for the cluster.
- host
Endpoint stringType - The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
- ingress
Host string - The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
- load
Balancer stringSource Ranges - The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
- external_
traffic_ strpolicy - The external traffic policy for the cluster.
- host_
endpoint_ strtype - The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
- ingress_
host str - The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
- load_
balancer_ strsource_ ranges - The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
- external
Traffic StringPolicy - The external traffic policy for the cluster.
- host
Endpoint StringType - The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
- ingress
Host String - The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
- load
Balancer StringSource Ranges - The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
ClusterGkeLocationConfig, ClusterGkeLocationConfigArgs
- Country
Code string - Country
Name string - Latitude double
- Longitude double
- Region
Code string - Region
Name string
- Country
Code string - Country
Name string - Latitude float64
- Longitude float64
- Region
Code string - Region
Name string
- country
Code String - country
Name String - latitude Double
- longitude Double
- region
Code String - region
Name String
- country
Code string - country
Name string - latitude number
- longitude number
- region
Code string - region
Name string
- country_
code str - country_
name str - latitude float
- longitude float
- region_
code str - region_
name str
- country
Code String - country
Name String - latitude Number
- longitude Number
- region
Code String - region
Name String
ClusterGkeMachinePool, ClusterGkeMachinePoolArgs
- Count double
- Number of nodes in the machine pool.
- Instance
Type string - Name string
- Additional
Labels Dictionary<string, string> - Disk
Size doubleGb - Nodes
List<Cluster
Gke Machine Pool Node> - Taints
List<Cluster
Gke Machine Pool Taint> - Update
Strategy string - Update strategy for the machine pool. Valid values are
RollingUpdateScaleOut
andRollingUpdateScaleIn
.
- Count float64
- Number of nodes in the machine pool.
- Instance
Type string - Name string
- Additional
Labels map[string]string - Disk
Size float64Gb - Nodes
[]Cluster
Gke Machine Pool Node - Taints
[]Cluster
Gke Machine Pool Taint - Update
Strategy string - Update strategy for the machine pool. Valid values are
RollingUpdateScaleOut
andRollingUpdateScaleIn
.
- count Double
- Number of nodes in the machine pool.
- instance
Type String - name String
- additional
Labels Map<String,String> - disk
Size DoubleGb - nodes
List<Cluster
Gke Machine Pool Node> - taints
List<Cluster
Gke Machine Pool Taint> - update
Strategy String - Update strategy for the machine pool. Valid values are
RollingUpdateScaleOut
andRollingUpdateScaleIn
.
- count number
- Number of nodes in the machine pool.
- instance
Type string - name string
- additional
Labels {[key: string]: string} - disk
Size numberGb - nodes
Cluster
Gke Machine Pool Node[] - taints
Cluster
Gke Machine Pool Taint[] - update
Strategy string - Update strategy for the machine pool. Valid values are
RollingUpdateScaleOut
andRollingUpdateScaleIn
.
- count float
- Number of nodes in the machine pool.
- instance_
type str - name str
- additional_
labels Mapping[str, str] - disk_
size_ floatgb - nodes
Sequence[Cluster
Gke Machine Pool Node] - taints
Sequence[Cluster
Gke Machine Pool Taint] - update_
strategy str - Update strategy for the machine pool. Valid values are
RollingUpdateScaleOut
andRollingUpdateScaleIn
.
- count Number
- Number of nodes in the machine pool.
- instance
Type String - name String
- additional
Labels Map<String> - disk
Size NumberGb - nodes List<Property Map>
- taints List<Property Map>
- update
Strategy String - Update strategy for the machine pool. Valid values are
RollingUpdateScaleOut
andRollingUpdateScaleIn
.
ClusterGkeMachinePoolNode, ClusterGkeMachinePoolNodeArgs
ClusterGkeMachinePoolTaint, ClusterGkeMachinePoolTaintArgs
ClusterGkeNamespace, ClusterGkeNamespaceArgs
- Name string
- Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
- Resource
Allocation Dictionary<string, string> - Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example,
{cpu_cores: '2', memory_MiB: '2048'}
- Images
Blacklists List<string> - List of images to disallow for the namespace. For example,
['nginx:latest', 'redis:latest']
- Name string
- Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
- Resource
Allocation map[string]string - Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example,
{cpu_cores: '2', memory_MiB: '2048'}
- Images
Blacklists []string - List of images to disallow for the namespace. For example,
['nginx:latest', 'redis:latest']
- name String
- Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
- resource
Allocation Map<String,String> - Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example,
{cpu_cores: '2', memory_MiB: '2048'}
- images
Blacklists List<String> - List of images to disallow for the namespace. For example,
['nginx:latest', 'redis:latest']
- name string
- Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
- resource
Allocation {[key: string]: string} - Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example,
{cpu_cores: '2', memory_MiB: '2048'}
- images
Blacklists string[] - List of images to disallow for the namespace. For example,
['nginx:latest', 'redis:latest']
- name str
- Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
- resource_
allocation Mapping[str, str] - Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example,
{cpu_cores: '2', memory_MiB: '2048'}
- images_
blacklists Sequence[str] - List of images to disallow for the namespace. For example,
['nginx:latest', 'redis:latest']
- name String
- Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
- resource
Allocation Map<String> - Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example,
{cpu_cores: '2', memory_MiB: '2048'}
- images
Blacklists List<String> - List of images to disallow for the namespace. For example,
['nginx:latest', 'redis:latest']
ClusterGkeScanPolicy, ClusterGkeScanPolicyArgs
- Configuration
Scan stringSchedule - The schedule for configuration scan.
- Conformance
Scan stringSchedule - The schedule for conformance scan.
- Penetration
Scan stringSchedule - The schedule for penetration scan.
- Configuration
Scan stringSchedule - The schedule for configuration scan.
- Conformance
Scan stringSchedule - The schedule for conformance scan.
- Penetration
Scan stringSchedule - The schedule for penetration scan.
- configuration
Scan StringSchedule - The schedule for configuration scan.
- conformance
Scan StringSchedule - The schedule for conformance scan.
- penetration
Scan StringSchedule - The schedule for penetration scan.
- configuration
Scan stringSchedule - The schedule for configuration scan.
- conformance
Scan stringSchedule - The schedule for conformance scan.
- penetration
Scan stringSchedule - The schedule for penetration scan.
- configuration_
scan_ strschedule - The schedule for configuration scan.
- conformance_
scan_ strschedule - The schedule for conformance scan.
- penetration_
scan_ strschedule - The schedule for penetration scan.
- configuration
Scan StringSchedule - The schedule for configuration scan.
- conformance
Scan StringSchedule - The schedule for conformance scan.
- penetration
Scan StringSchedule - The schedule for penetration scan.
ClusterGkeTimeouts, ClusterGkeTimeoutsArgs
Import
Using pulumi import
, import the cluster using the id
colon separated with context
. For example:
$ pulumi import spectrocloud:index/clusterGke:ClusterGke example example_id:project
Refer to the Import section to learn more.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- spectrocloud spectrocloud/terraform-provider-spectrocloud
- License
- Notes
- This Pulumi package is based on the
spectrocloud
Terraform Provider.