@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
602 lines • 21.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Feature represents the settings and status of any Hub Feature.
*
* To get more information about Feature, see:
*
* * [API documentation](https://cloud.google.com/anthos/fleet-management/docs/reference/rest/v1/projects.locations.features)
* * How-to Guides
* * [Registering a Cluster](https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster#register_cluster)
*
* ## Example Usage
*
* ### Gkehub Feature Multi Cluster Ingress
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const cluster = new gcp.container.Cluster("cluster", {
* name: "my-cluster",
* location: "us-central1-a",
* initialNodeCount: 1,
* });
* const membership = new gcp.gkehub.Membership("membership", {
* membershipId: "my-membership",
* endpoint: {
* gkeCluster: {
* resourceLink: pulumi.interpolate`//container.googleapis.com/${cluster.id}`,
* },
* },
* });
* const feature = new gcp.gkehub.Feature("feature", {
* name: "multiclusteringress",
* location: "global",
* spec: {
* multiclusteringress: {
* configMembership: membership.id,
* },
* },
* });
* ```
* ### Gkehub Feature Multi Cluster Service Discovery
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "multiclusterservicediscovery",
* location: "global",
* labels: {
* foo: "bar",
* },
* });
* ```
* ### Gkehub Feature Anthos Service Mesh
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "servicemesh",
* location: "global",
* });
* ```
* ### Enable Fleet Observability For Default Logs With Copy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "fleetobservability",
* location: "global",
* spec: {
* fleetobservability: {
* loggingConfig: {
* defaultConfig: {
* mode: "COPY",
* },
* },
* },
* },
* });
* ```
* ### Enable Fleet Observability For Scope Logs With Move
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "fleetobservability",
* location: "global",
* spec: {
* fleetobservability: {
* loggingConfig: {
* fleetScopeLogsConfig: {
* mode: "MOVE",
* },
* },
* },
* },
* });
* ```
* ### Enable Fleet Observability For Both Default And Scope Logs
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "fleetobservability",
* location: "global",
* spec: {
* fleetobservability: {
* loggingConfig: {
* defaultConfig: {
* mode: "COPY",
* },
* fleetScopeLogsConfig: {
* mode: "MOVE",
* },
* },
* },
* },
* });
* ```
* ### Enable Fleet Default Member Config Service Mesh
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "servicemesh",
* location: "global",
* fleetDefaultMemberConfig: {
* mesh: {
* management: "MANAGEMENT_AUTOMATIC",
* },
* },
* });
* ```
* ### Enable Fleet Default Member Config Configmanagement
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "configmanagement",
* location: "global",
* fleetDefaultMemberConfig: {
* configmanagement: {
* configSync: {
* git: {
* syncRepo: "https://github.com/hashicorp/terraform",
* },
* },
* },
* },
* });
* ```
* ### Enable Fleet Default Member Config Policycontroller
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "policycontroller",
* location: "global",
* fleetDefaultMemberConfig: {
* policycontroller: {
* policyControllerHubConfig: {
* installSpec: "INSTALL_SPEC_ENABLED",
* exemptableNamespaces: ["foo"],
* policyContent: {
* bundles: [{
* bundle: "policy-essentials-v2022",
* exemptedNamespaces: [
* "foo",
* "bar",
* ],
* }],
* templateLibrary: {
* installation: "ALL",
* },
* },
* auditIntervalSeconds: 30,
* referentialRulesEnabled: true,
* },
* },
* },
* });
* ```
* ### Enable Fleet Default Member Config Policycontroller Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "policycontroller",
* location: "global",
* fleetDefaultMemberConfig: {
* policycontroller: {
* policyControllerHubConfig: {
* installSpec: "INSTALL_SPEC_SUSPENDED",
* policyContent: {
* bundles: [
* {
* bundle: "pci-dss-v3.2.1",
* exemptedNamespaces: [
* "baz",
* "bar",
* ],
* },
* {
* bundle: "nist-sp-800-190",
* exemptedNamespaces: [],
* },
* ],
* templateLibrary: {
* installation: "ALL",
* },
* },
* constraintViolationLimit: 50,
* referentialRulesEnabled: true,
* logDeniesEnabled: true,
* mutationEnabled: true,
* deploymentConfigs: [
* {
* component: "admission",
* replicaCount: 2,
* podAffinity: "ANTI_AFFINITY",
* },
* {
* component: "audit",
* containerResources: {
* limits: {
* memory: "1Gi",
* cpu: "1.5",
* },
* requests: {
* memory: "500Mi",
* cpu: "150m",
* },
* },
* podTolerations: [{
* key: "key1",
* operator: "Equal",
* value: "value1",
* effect: "NoSchedule",
* }],
* },
* ],
* monitoring: {
* backends: ["PROMETHEUS"],
* },
* },
* },
* },
* });
* ```
* ### Enable Fleet Default Member Config Policycontroller Minimal
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "policycontroller",
* location: "global",
* fleetDefaultMemberConfig: {
* policycontroller: {
* policyControllerHubConfig: {
* installSpec: "INSTALL_SPEC_ENABLED",
* policyContent: {},
* constraintViolationLimit: 50,
* referentialRulesEnabled: true,
* logDeniesEnabled: true,
* mutationEnabled: true,
* deploymentConfigs: [{
* component: "admission",
* }],
* monitoring: {},
* },
* },
* },
* });
* ```
* ### Gkehub Feature Clusterupgrade
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "clusterupgrade",
* location: "global",
* spec: {
* clusterupgrade: {
* upstreamFleets: [],
* postConditions: {
* soaking: "60s",
* },
* },
* },
* });
* ```
* ### Gkehub Feature Rbacrolebinding Actuation
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const feature = new gcp.gkehub.Feature("feature", {
* name: "rbacrolebindingactuation",
* location: "global",
* spec: {
* rbacrolebindingactuation: {
* allowedCustomRoles: [
* "custom-role1",
* "custom-role2",
* "custom-role3",
* ],
* },
* },
* });
* ```
* ### Gkehub Feature Workload Identity
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const pool = new gcp.iam.WorkloadIdentityPool("pool", {
* workloadIdentityPoolId: "example-pool",
* mode: "TRUST_DOMAIN",
* });
* const feature = new gcp.gkehub.Feature("feature", {
* name: "workloadidentity",
* location: "global",
* spec: {
* workloadidentity: {
* scopeTenancyPool: pool.name,
* },
* },
* });
* ```
*
* ## Import
*
* Feature can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/features/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, Feature can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:gkehub/feature:Feature default projects/{{project}}/locations/{{location}}/features/{{name}}
* $ pulumi import gcp:gkehub/feature:Feature default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:gkehub/feature:Feature default {{location}}/{{name}}
* ```
*/
export declare class Feature extends pulumi.CustomResource {
/**
* Get an existing Feature 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?: FeatureState, opts?: pulumi.CustomResourceOptions): Feature;
/**
* Returns true if the given object is an instance of Feature. 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 Feature;
/**
* Output only. When the Feature resource was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Output only. When the Feature resource was deleted.
*/
readonly deleteTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Optional. Fleet Default Membership Configuration.
* Structure is documented below.
*/
readonly fleetDefaultMemberConfig: pulumi.Output<outputs.gkehub.FeatureFleetDefaultMemberConfig | undefined>;
/**
* GCP labels for this Feature.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The location for the resource
*/
readonly location: pulumi.Output<string>;
/**
* The full, unique name of this Feature resource
*/
readonly name: pulumi.Output<string>;
/**
* 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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* State of the Feature resource itself.
* Structure is documented below.
*/
readonly resourceStates: pulumi.Output<outputs.gkehub.FeatureResourceState[]>;
/**
* Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
* Structure is documented below.
*/
readonly spec: pulumi.Output<outputs.gkehub.FeatureSpec | undefined>;
/**
* (Output)
* Output only. The "running state" of the Feature in this Hub.
* Structure is documented below.
*/
readonly states: pulumi.Output<outputs.gkehub.FeatureState[]>;
/**
* (Output)
* The time this status and any related Feature-specific details were updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Feature 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: FeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Feature resources.
*/
export interface FeatureState {
/**
* Output only. When the Feature resource was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Output only. When the Feature resource was deleted.
*/
deleteTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Optional. Fleet Default Membership Configuration.
* Structure is documented below.
*/
fleetDefaultMemberConfig?: pulumi.Input<inputs.gkehub.FeatureFleetDefaultMemberConfig | undefined>;
/**
* GCP labels for this Feature.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The location for the resource
*/
location?: pulumi.Input<string | undefined>;
/**
* The full, unique name of this Feature resource
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* State of the Feature resource itself.
* Structure is documented below.
*/
resourceStates?: pulumi.Input<pulumi.Input<inputs.gkehub.FeatureResourceState>[] | undefined>;
/**
* Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
* Structure is documented below.
*/
spec?: pulumi.Input<inputs.gkehub.FeatureSpec | undefined>;
/**
* (Output)
* Output only. The "running state" of the Feature in this Hub.
* Structure is documented below.
*/
states?: pulumi.Input<pulumi.Input<inputs.gkehub.FeatureState>[] | undefined>;
/**
* (Output)
* The time this status and any related Feature-specific details were updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Feature resource.
*/
export interface FeatureArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Optional. Fleet Default Membership Configuration.
* Structure is documented below.
*/
fleetDefaultMemberConfig?: pulumi.Input<inputs.gkehub.FeatureFleetDefaultMemberConfig | undefined>;
/**
* GCP labels for this Feature.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The location for the resource
*/
location: pulumi.Input<string>;
/**
* The full, unique name of this Feature resource
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Optional. Hub-wide Feature configuration. If this Feature does not support any Hub-wide configuration, this field may be unused.
* Structure is documented below.
*/
spec?: pulumi.Input<inputs.gkehub.FeatureSpec | undefined>;
}
//# sourceMappingURL=feature.d.ts.map