@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
657 lines (656 loc) • 24.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A Google Bare Metal Admin Cluster.
*
* ## Example Usage
*
* ### Gkeonprem Bare Metal Admin Cluster Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin_cluster_basic = new gcp.gkeonprem.BareMetalAdminCluster("admin-cluster-basic", {
* name: "my-cluster",
* location: "us-west1",
* bareMetalVersion: "1.13.4",
* networkConfig: {
* islandModeCidr: {
* serviceAddressCidrBlocks: ["172.26.0.0/16"],
* podAddressCidrBlocks: ["10.240.0.0/13"],
* },
* },
* nodeConfig: {
* maxPodsPerNode: 250,
* },
* controlPlane: {
* controlPlaneNodePoolConfig: {
* nodePoolConfig: {
* labels: {},
* operatingSystem: "LINUX",
* nodeConfigs: [
* {
* labels: {},
* nodeIp: "10.200.0.2",
* },
* {
* labels: {},
* nodeIp: "10.200.0.3",
* },
* {
* labels: {},
* nodeIp: "10.200.0.4",
* },
* ],
* },
* },
* },
* loadBalancer: {
* portConfig: {
* controlPlaneLoadBalancerPort: 443,
* },
* vipConfig: {
* controlPlaneVip: "10.200.0.5",
* },
* },
* storage: {
* lvpShareConfig: {
* lvpConfig: {
* path: "/mnt/localpv-share",
* storageClass: "local-shared",
* },
* sharedPathPvCount: 5,
* },
* lvpNodeMountsConfig: {
* path: "/mnt/localpv-disk",
* storageClass: "local-disks",
* },
* },
* nodeAccessConfig: {
* loginUser: "root",
* },
* });
* ```
* ### Gkeonprem Bare Metal Admin Cluster Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin_cluster_basic = new gcp.gkeonprem.BareMetalAdminCluster("admin-cluster-basic", {
* name: "my-cluster",
* location: "us-west1",
* description: "test description",
* bareMetalVersion: "1.13.4",
* annotations: {
* env: "test",
* },
* networkConfig: {
* islandModeCidr: {
* serviceAddressCidrBlocks: ["172.26.0.0/16"],
* podAddressCidrBlocks: ["10.240.0.0/13"],
* },
* },
* nodeConfig: {
* maxPodsPerNode: 250,
* },
* controlPlane: {
* controlPlaneNodePoolConfig: {
* nodePoolConfig: {
* labels: {},
* operatingSystem: "LINUX",
* nodeConfigs: [
* {
* labels: {},
* nodeIp: "10.200.0.2",
* },
* {
* labels: {},
* nodeIp: "10.200.0.3",
* },
* {
* labels: {},
* nodeIp: "10.200.0.4",
* },
* ],
* taints: [{
* key: "test-key",
* value: "test-value",
* effect: "NO_EXECUTE",
* }],
* },
* },
* apiServerArgs: [{
* argument: "test argument",
* value: "test value",
* }],
* },
* loadBalancer: {
* portConfig: {
* controlPlaneLoadBalancerPort: 443,
* },
* vipConfig: {
* controlPlaneVip: "10.200.0.5",
* },
* manualLbConfig: {
* enabled: true,
* },
* },
* storage: {
* lvpShareConfig: {
* lvpConfig: {
* path: "/mnt/localpv-share",
* storageClass: "local-shared",
* },
* sharedPathPvCount: 5,
* },
* lvpNodeMountsConfig: {
* path: "/mnt/localpv-disk",
* storageClass: "local-disks",
* },
* },
* nodeAccessConfig: {
* loginUser: "root",
* },
* securityConfig: {
* authorization: {
* adminUsers: [{
* username: "admin@hashicorptest.com",
* }],
* },
* },
* maintenanceConfig: {
* maintenanceAddressCidrBlocks: [
* "10.0.0.1/32",
* "10.0.0.2/32",
* ],
* },
* clusterOperations: {
* enableApplicationLogs: true,
* },
* proxy: {
* uri: "test proxy uri",
* noProxies: ["127.0.0.1"],
* },
* });
* ```
*
* ## Import
*
* BareMetalAdminCluster can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/bareMetalAdminClusters/{{name}}`
*
* * `{{project}}/{{location}}/{{name}}`
*
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, BareMetalAdminCluster can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:gkeonprem/bareMetalAdminCluster:BareMetalAdminCluster default projects/{{project}}/locations/{{location}}/bareMetalAdminClusters/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:gkeonprem/bareMetalAdminCluster:BareMetalAdminCluster default {{project}}/{{location}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:gkeonprem/bareMetalAdminCluster:BareMetalAdminCluster default {{location}}/{{name}}
* ```
*/
export declare class BareMetalAdminCluster extends pulumi.CustomResource {
/**
* Get an existing BareMetalAdminCluster 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?: BareMetalAdminClusterState, opts?: pulumi.CustomResourceOptions): BareMetalAdminCluster;
/**
* Returns true if the given object is an instance of BareMetalAdminCluster. 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 BareMetalAdminCluster;
/**
* Annotations on the Bare Metal Admin Cluster.
* This field has the same restrictions as Kubernetes annotations.
* The total size of all keys and values combined is limited to 256k.
* Key can have 2 segments: prefix (optional) and name (required),
* separated by a slash (/).
* Prefix must be a DNS subdomain.
* Name must be 63 characters or less, begin and end with alphanumerics,
* with dashes (-), underscores (_), dots (.), and alphanumerics between.
*
* **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.
* Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource.
*/
readonly annotations: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A human readable description of this Bare Metal Admin Cluster.
*/
readonly bareMetalVersion: pulumi.Output<string | undefined>;
/**
* Specifies the Admin Cluster's observability infrastructure.
* Structure is documented below.
*/
readonly clusterOperations: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterClusterOperations | undefined>;
/**
* Specifies the control plane configuration.
* Structure is documented below.
*/
readonly controlPlane: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterControlPlane | undefined>;
/**
* The time the cluster was created, in RFC3339 text format.
*/
readonly createTime: pulumi.Output<string>;
/**
* The time the cluster was deleted, in RFC3339 text format.
*/
readonly deleteTime: pulumi.Output<string>;
/**
* A human readable description of this Bare Metal Admin Cluster.
*/
readonly description: pulumi.Output<string | undefined>;
readonly effectiveAnnotations: pulumi.Output<{
[key: string]: string;
}>;
/**
* The IP address name of Bare Metal Admin Cluster's API server.
*/
readonly endpoint: pulumi.Output<string>;
/**
* This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
* Allows clients to perform consistent read-modify-writes
* through optimistic concurrency control.
*/
readonly etag: pulumi.Output<string>;
/**
* Fleet related configuration.
* Fleets are a Google Cloud concept for logically organizing clusters,
* letting you use and manage multi-cluster capabilities and apply
* consistent policies across your systems.
* See [Anthos Fleets](https://cloud.google.com/anthos/multicluster-management/fleets) for
* more details on Anthos multi-cluster capabilities using Fleets.
* Structure is documented below.
*/
readonly fleets: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterFleet[]>;
/**
* Specifies the load balancer configuration.
* Structure is documented below.
*/
readonly loadBalancer: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterLoadBalancer | undefined>;
/**
* The object name of the Bare Metal Admin Cluster custom resource on the
* associated admin cluster. This field is used to support conflicting
* names when enrolling existing clusters to the API. When used as a part of
* cluster enrollment, this field will differ from the ID in the resource
* name. For new clusters, this field will match the user provided cluster ID
* and be visible in the last component of the resource name. It is not
* modifiable.
* All users should use this name to access their cluster using gkectl or
* kubectl and should expect to see the local name when viewing admin
* cluster controller logs.
*/
readonly localName: pulumi.Output<string>;
/**
* The location of the resource.
*
*
* - - -
*/
readonly location: pulumi.Output<string>;
/**
* Specifies the workload node configurations.
* Structure is documented below.
*/
readonly maintenanceConfig: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterMaintenanceConfig | undefined>;
/**
* The bare metal admin cluster name.
*/
readonly name: pulumi.Output<string>;
/**
* Network configuration.
* Structure is documented below.
*/
readonly networkConfig: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterNetworkConfig | undefined>;
/**
* Specifies the node access related settings for the bare metal user cluster.
* Structure is documented below.
*/
readonly nodeAccessConfig: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterNodeAccessConfig | undefined>;
/**
* Specifies the workload node configurations.
* Structure is documented below.
*/
readonly nodeConfig: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterNodeConfig | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Specifies the cluster proxy configuration.
* Structure is documented below.
*/
readonly proxy: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterProxy | undefined>;
/**
* If set, there are currently changes in flight to the Bare Metal Admin Cluster.
*/
readonly reconciling: pulumi.Output<boolean>;
/**
* Specifies the security related settings for the Bare Metal User Cluster.
* Structure is documented below.
*/
readonly securityConfig: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterSecurityConfig | undefined>;
/**
* (Output)
* The lifecycle state of the condition.
*/
readonly state: pulumi.Output<string>;
/**
* (Output)
* Specifies the detailed validation check status
* Structure is documented below.
*/
readonly statuses: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterStatus[]>;
/**
* Specifies the cluster storage configuration.
* Structure is documented below.
*/
readonly storage: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterStorage | undefined>;
/**
* The unique identifier of the Bare Metal Admin Cluster.
*/
readonly uid: pulumi.Output<string>;
/**
* The time the cluster was last updated, in RFC3339 text format.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Specifies the security related settings for the Bare Metal Admin Cluster.
* Structure is documented below.
*/
readonly validationChecks: pulumi.Output<outputs.gkeonprem.BareMetalAdminClusterValidationCheck[]>;
/**
* Create a BareMetalAdminCluster 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: BareMetalAdminClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BareMetalAdminCluster resources.
*/
export interface BareMetalAdminClusterState {
/**
* Annotations on the Bare Metal Admin Cluster.
* This field has the same restrictions as Kubernetes annotations.
* The total size of all keys and values combined is limited to 256k.
* Key can have 2 segments: prefix (optional) and name (required),
* separated by a slash (/).
* Prefix must be a DNS subdomain.
* Name must be 63 characters or less, begin and end with alphanumerics,
* with dashes (-), underscores (_), dots (.), and alphanumerics between.
*
* **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.
* Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource.
*/
annotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A human readable description of this Bare Metal Admin Cluster.
*/
bareMetalVersion?: pulumi.Input<string>;
/**
* Specifies the Admin Cluster's observability infrastructure.
* Structure is documented below.
*/
clusterOperations?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterClusterOperations>;
/**
* Specifies the control plane configuration.
* Structure is documented below.
*/
controlPlane?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterControlPlane>;
/**
* The time the cluster was created, in RFC3339 text format.
*/
createTime?: pulumi.Input<string>;
/**
* The time the cluster was deleted, in RFC3339 text format.
*/
deleteTime?: pulumi.Input<string>;
/**
* A human readable description of this Bare Metal Admin Cluster.
*/
description?: pulumi.Input<string>;
effectiveAnnotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The IP address name of Bare Metal Admin Cluster's API server.
*/
endpoint?: pulumi.Input<string>;
/**
* This checksum is computed by the server based on the value of other
* fields, and may be sent on update and delete requests to ensure the
* client has an up-to-date value before proceeding.
* Allows clients to perform consistent read-modify-writes
* through optimistic concurrency control.
*/
etag?: pulumi.Input<string>;
/**
* Fleet related configuration.
* Fleets are a Google Cloud concept for logically organizing clusters,
* letting you use and manage multi-cluster capabilities and apply
* consistent policies across your systems.
* See [Anthos Fleets](https://cloud.google.com/anthos/multicluster-management/fleets) for
* more details on Anthos multi-cluster capabilities using Fleets.
* Structure is documented below.
*/
fleets?: pulumi.Input<pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterFleet>[]>;
/**
* Specifies the load balancer configuration.
* Structure is documented below.
*/
loadBalancer?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterLoadBalancer>;
/**
* The object name of the Bare Metal Admin Cluster custom resource on the
* associated admin cluster. This field is used to support conflicting
* names when enrolling existing clusters to the API. When used as a part of
* cluster enrollment, this field will differ from the ID in the resource
* name. For new clusters, this field will match the user provided cluster ID
* and be visible in the last component of the resource name. It is not
* modifiable.
* All users should use this name to access their cluster using gkectl or
* kubectl and should expect to see the local name when viewing admin
* cluster controller logs.
*/
localName?: pulumi.Input<string>;
/**
* The location of the resource.
*
*
* - - -
*/
location?: pulumi.Input<string>;
/**
* Specifies the workload node configurations.
* Structure is documented below.
*/
maintenanceConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterMaintenanceConfig>;
/**
* The bare metal admin cluster name.
*/
name?: pulumi.Input<string>;
/**
* Network configuration.
* Structure is documented below.
*/
networkConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterNetworkConfig>;
/**
* Specifies the node access related settings for the bare metal user cluster.
* Structure is documented below.
*/
nodeAccessConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterNodeAccessConfig>;
/**
* Specifies the workload node configurations.
* Structure is documented below.
*/
nodeConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterNodeConfig>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Specifies the cluster proxy configuration.
* Structure is documented below.
*/
proxy?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterProxy>;
/**
* If set, there are currently changes in flight to the Bare Metal Admin Cluster.
*/
reconciling?: pulumi.Input<boolean>;
/**
* Specifies the security related settings for the Bare Metal User Cluster.
* Structure is documented below.
*/
securityConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterSecurityConfig>;
/**
* (Output)
* The lifecycle state of the condition.
*/
state?: pulumi.Input<string>;
/**
* (Output)
* Specifies the detailed validation check status
* Structure is documented below.
*/
statuses?: pulumi.Input<pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterStatus>[]>;
/**
* Specifies the cluster storage configuration.
* Structure is documented below.
*/
storage?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterStorage>;
/**
* The unique identifier of the Bare Metal Admin Cluster.
*/
uid?: pulumi.Input<string>;
/**
* The time the cluster was last updated, in RFC3339 text format.
*/
updateTime?: pulumi.Input<string>;
/**
* Specifies the security related settings for the Bare Metal Admin Cluster.
* Structure is documented below.
*/
validationChecks?: pulumi.Input<pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterValidationCheck>[]>;
}
/**
* The set of arguments for constructing a BareMetalAdminCluster resource.
*/
export interface BareMetalAdminClusterArgs {
/**
* Annotations on the Bare Metal Admin Cluster.
* This field has the same restrictions as Kubernetes annotations.
* The total size of all keys and values combined is limited to 256k.
* Key can have 2 segments: prefix (optional) and name (required),
* separated by a slash (/).
* Prefix must be a DNS subdomain.
* Name must be 63 characters or less, begin and end with alphanumerics,
* with dashes (-), underscores (_), dots (.), and alphanumerics between.
*
* **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.
* Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource.
*/
annotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A human readable description of this Bare Metal Admin Cluster.
*/
bareMetalVersion?: pulumi.Input<string>;
/**
* Specifies the Admin Cluster's observability infrastructure.
* Structure is documented below.
*/
clusterOperations?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterClusterOperations>;
/**
* Specifies the control plane configuration.
* Structure is documented below.
*/
controlPlane?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterControlPlane>;
/**
* A human readable description of this Bare Metal Admin Cluster.
*/
description?: pulumi.Input<string>;
/**
* Specifies the load balancer configuration.
* Structure is documented below.
*/
loadBalancer?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterLoadBalancer>;
/**
* The location of the resource.
*
*
* - - -
*/
location: pulumi.Input<string>;
/**
* Specifies the workload node configurations.
* Structure is documented below.
*/
maintenanceConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterMaintenanceConfig>;
/**
* The bare metal admin cluster name.
*/
name?: pulumi.Input<string>;
/**
* Network configuration.
* Structure is documented below.
*/
networkConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterNetworkConfig>;
/**
* Specifies the node access related settings for the bare metal user cluster.
* Structure is documented below.
*/
nodeAccessConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterNodeAccessConfig>;
/**
* Specifies the workload node configurations.
* Structure is documented below.
*/
nodeConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterNodeConfig>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* Specifies the cluster proxy configuration.
* Structure is documented below.
*/
proxy?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterProxy>;
/**
* Specifies the security related settings for the Bare Metal User Cluster.
* Structure is documented below.
*/
securityConfig?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterSecurityConfig>;
/**
* Specifies the cluster storage configuration.
* Structure is documented below.
*/
storage?: pulumi.Input<inputs.gkeonprem.BareMetalAdminClusterStorage>;
}