@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
232 lines (231 loc) • 10.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage veecp cluster
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@pulumi/volcengine";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooZones = volcengine.ecs.getZones({});
* const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
* vpcName: "acc-test-project1",
* cidrBlock: "172.16.0.0/16",
* });
* const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
* subnetName: "acc-subnet-test-2",
* cidrBlock: "172.16.0.0/24",
* zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
* vpcId: fooVpc.id,
* });
* const fooSecurityGroup = new volcengine.vpc.SecurityGroup("fooSecurityGroup", {
* vpcId: fooVpc.id,
* securityGroupName: "acc-test-security-group2",
* });
* const fooCluster = new volcengine.veecp.Cluster("fooCluster", {
* description: "created by terraform",
* deleteProtectionEnabled: false,
* kubernetesVersion: "v1.24.15-veecp.1",
* profile: "Edge",
* clusterConfig: {
* subnetIds: [fooSubnet.id],
* apiServerPublicAccessEnabled: true,
* apiServerPublicAccessConfig: {
* publicAccessNetworkConfig: {
* billingType: "PostPaidByBandwidth",
* bandwidth: 1,
* },
* },
* resourcePublicAccessDefaultEnabled: true,
* },
* podsConfig: {
* podNetworkMode: "Flannel",
* flannelConfig: {
* podCidrs: ["172.22.224.0/20"],
* maxPodsPerNode: 64,
* },
* },
* servicesConfig: {
* serviceCidrsv4s: ["172.30.0.0/18"],
* },
* });
* ```
*
* ## Import
*
* VeecpCluster can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:veecp/cluster:Cluster default resource_id
* ```
*/
export declare class Cluster extends pulumi.CustomResource {
/**
* Get an existing Cluster resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster;
/**
* Returns true if the given object is an instance of Cluster. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Cluster;
/**
* ClientToken is a case-sensitive string of no more than 64 ASCII characters passed in by the caller.
*/
readonly clientToken: pulumi.Output<string | undefined>;
/**
* Network configuration of cluster control plane and nodes.
*/
readonly clusterConfig: pulumi.Output<outputs.veecp.ClusterClusterConfig>;
/**
* Cluster deletion protection. Values: false: (default value) Deletion protection is off. true: Enable deletion protection. The cluster cannot be directly deleted. After creating a cluster, when calling Delete edge cluster, configure the Force parameter and choose to forcibly delete the cluster.
*/
readonly deleteProtectionEnabled: pulumi.Output<boolean>;
/**
* Cluster description. Length is limited to within 300 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Whether to enable the edge tunnel. Values: false: (default value) Edge tunnel is off. true: Enable edge tunnel. Note: This parameter is not supported to be modified after the cluster is created.
*/
readonly edgeTunnelEnabled: pulumi.Output<boolean>;
/**
* Specify the Kubernetes version when creating a cluster. The format is x.xx. The default value is the latest version in the supported Kubernetes version list (currently 1.20).
*/
readonly kubernetesVersion: pulumi.Output<string>;
/**
* Cluster log configuration information.
*/
readonly loggingConfig: pulumi.Output<outputs.veecp.ClusterLoggingConfig | undefined>;
/**
* Cluster name. Under the same region, the name must be unique. Supports upper and lower case English letters, Chinese characters, numbers, and hyphens (-). Numbers cannot be at the first position, and hyphens (-) cannot be at the first or last position. The length is limited to 2 to 64 characters.
*/
readonly name: pulumi.Output<string>;
/**
* Container (Pod) network configuration of the cluster.
*/
readonly podsConfig: pulumi.Output<outputs.veecp.ClusterPodsConfig>;
/**
* Edge cluster: Edge. Non-edge cluster: Cloud. When using edge hosting, set this item to Edge.
*/
readonly profile: pulumi.Output<string>;
/**
* Cluster service (Service) network configuration.
*/
readonly servicesConfig: pulumi.Output<outputs.veecp.ClusterServicesConfig>;
/**
* Create a Cluster resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Cluster resources.
*/
export interface ClusterState {
/**
* ClientToken is a case-sensitive string of no more than 64 ASCII characters passed in by the caller.
*/
clientToken?: pulumi.Input<string>;
/**
* Network configuration of cluster control plane and nodes.
*/
clusterConfig?: pulumi.Input<inputs.veecp.ClusterClusterConfig>;
/**
* Cluster deletion protection. Values: false: (default value) Deletion protection is off. true: Enable deletion protection. The cluster cannot be directly deleted. After creating a cluster, when calling Delete edge cluster, configure the Force parameter and choose to forcibly delete the cluster.
*/
deleteProtectionEnabled?: pulumi.Input<boolean>;
/**
* Cluster description. Length is limited to within 300 characters.
*/
description?: pulumi.Input<string>;
/**
* Whether to enable the edge tunnel. Values: false: (default value) Edge tunnel is off. true: Enable edge tunnel. Note: This parameter is not supported to be modified after the cluster is created.
*/
edgeTunnelEnabled?: pulumi.Input<boolean>;
/**
* Specify the Kubernetes version when creating a cluster. The format is x.xx. The default value is the latest version in the supported Kubernetes version list (currently 1.20).
*/
kubernetesVersion?: pulumi.Input<string>;
/**
* Cluster log configuration information.
*/
loggingConfig?: pulumi.Input<inputs.veecp.ClusterLoggingConfig>;
/**
* Cluster name. Under the same region, the name must be unique. Supports upper and lower case English letters, Chinese characters, numbers, and hyphens (-). Numbers cannot be at the first position, and hyphens (-) cannot be at the first or last position. The length is limited to 2 to 64 characters.
*/
name?: pulumi.Input<string>;
/**
* Container (Pod) network configuration of the cluster.
*/
podsConfig?: pulumi.Input<inputs.veecp.ClusterPodsConfig>;
/**
* Edge cluster: Edge. Non-edge cluster: Cloud. When using edge hosting, set this item to Edge.
*/
profile?: pulumi.Input<string>;
/**
* Cluster service (Service) network configuration.
*/
servicesConfig?: pulumi.Input<inputs.veecp.ClusterServicesConfig>;
}
/**
* The set of arguments for constructing a Cluster resource.
*/
export interface ClusterArgs {
/**
* ClientToken is a case-sensitive string of no more than 64 ASCII characters passed in by the caller.
*/
clientToken?: pulumi.Input<string>;
/**
* Network configuration of cluster control plane and nodes.
*/
clusterConfig: pulumi.Input<inputs.veecp.ClusterClusterConfig>;
/**
* Cluster deletion protection. Values: false: (default value) Deletion protection is off. true: Enable deletion protection. The cluster cannot be directly deleted. After creating a cluster, when calling Delete edge cluster, configure the Force parameter and choose to forcibly delete the cluster.
*/
deleteProtectionEnabled?: pulumi.Input<boolean>;
/**
* Cluster description. Length is limited to within 300 characters.
*/
description?: pulumi.Input<string>;
/**
* Whether to enable the edge tunnel. Values: false: (default value) Edge tunnel is off. true: Enable edge tunnel. Note: This parameter is not supported to be modified after the cluster is created.
*/
edgeTunnelEnabled?: pulumi.Input<boolean>;
/**
* Specify the Kubernetes version when creating a cluster. The format is x.xx. The default value is the latest version in the supported Kubernetes version list (currently 1.20).
*/
kubernetesVersion?: pulumi.Input<string>;
/**
* Cluster log configuration information.
*/
loggingConfig?: pulumi.Input<inputs.veecp.ClusterLoggingConfig>;
/**
* Cluster name. Under the same region, the name must be unique. Supports upper and lower case English letters, Chinese characters, numbers, and hyphens (-). Numbers cannot be at the first position, and hyphens (-) cannot be at the first or last position. The length is limited to 2 to 64 characters.
*/
name?: pulumi.Input<string>;
/**
* Container (Pod) network configuration of the cluster.
*/
podsConfig: pulumi.Input<inputs.veecp.ClusterPodsConfig>;
/**
* Edge cluster: Edge. Non-edge cluster: Cloud. When using edge hosting, set this item to Edge.
*/
profile: pulumi.Input<string>;
/**
* Cluster service (Service) network configuration.
*/
servicesConfig: pulumi.Input<inputs.veecp.ClusterServicesConfig>;
}