@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
494 lines • 17 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Contains information about a GKEHub Feature Memberships. Feature Memberships configure GKEHub Features that apply to specific memberships rather than the project as a whole. The googleGkeHub is the Fleet API.
*
* ## Example Usage
*
* ### Config Management With Git
*
* ```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: "configmanagement",
* location: "global",
* labels: {
* foo: "bar",
* },
* });
* const featureMember = new gcp.gkehub.FeatureMembership("feature_member", {
* location: "global",
* feature: feature.name,
* membership: membership.membershipId,
* configmanagement: {
* version: "1.19.0",
* configSync: {
* enabled: true,
* git: {
* syncRepo: "https://github.com/hashicorp/terraform",
* },
* },
* },
* });
* ```
*
* ### Config Management With OCI
*
* ```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: "configmanagement",
* location: "global",
* labels: {
* foo: "bar",
* },
* });
* const featureMember = new gcp.gkehub.FeatureMembership("feature_member", {
* location: "global",
* feature: feature.name,
* membership: membership.membershipId,
* configmanagement: {
* version: "1.19.0",
* configSync: {
* enabled: true,
* oci: {
* syncRepo: "us-central1-docker.pkg.dev/sample-project/config-repo/config-sync-gke:latest",
* policyDir: "config-connector",
* syncWaitSecs: "20",
* secretType: "gcpserviceaccount",
* gcpServiceAccountEmail: "sa@project-id.iam.gserviceaccount.com",
* },
* },
* },
* });
* ```
*
* ### Config Management With Deployment Override
*
* ```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: "configmanagement",
* location: "global",
* labels: {
* foo: "bar",
* },
* });
* const featureMember = new gcp.gkehub.FeatureMembership("feature_member", {
* location: "global",
* feature: feature.name,
* membership: membership.membershipId,
* configmanagement: {
* version: "1.20.1",
* configSync: {
* enabled: true,
* deploymentOverrides: [{
* deploymentName: "reconciler-manager",
* deploymentNamespace: "config-management-system",
* containers: [{
* containerName: "reconciler-manager",
* cpuRequest: "100m",
* memoryRequest: "64Mi",
* cpuLimit: "250m",
* memoryLimit: "128Mi",
* }],
* }],
* },
* },
* });
* ```
*
* ### Config Management With Regional Membership
*
* ```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",
* location: "us-central1",
* endpoint: {
* gkeCluster: {
* resourceLink: pulumi.interpolate`//container.googleapis.com/${cluster.id}`,
* },
* },
* });
* const feature = new gcp.gkehub.Feature("feature", {
* name: "configmanagement",
* location: "global",
* labels: {
* foo: "bar",
* },
* });
* const featureMember = new gcp.gkehub.FeatureMembership("feature_member", {
* location: "global",
* feature: feature.name,
* membership: membership.membershipId,
* membershipLocation: membership.location,
* configmanagement: {
* version: "1.19.0",
* configSync: {
* enabled: true,
* git: {
* syncRepo: "https://github.com/hashicorp/terraform",
* },
* },
* },
* });
* ```
*
* ### 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",
* },
* });
* ```
*
* ### Service Mesh
*
* ```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: "servicemesh",
* location: "global",
* });
* const featureMember = new gcp.gkehub.FeatureMembership("feature_member", {
* location: "global",
* feature: feature.name,
* membership: membership.membershipId,
* mesh: {
* management: "MANAGEMENT_AUTOMATIC",
* },
* });
* ```
*
* ### Policy Controller With Minimal Configuration
*
* ```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: "policycontroller",
* location: "global",
* });
* const featureMember = new gcp.gkehub.FeatureMembership("feature_member", {
* location: "global",
* feature: feature.name,
* membership: membership.membershipId,
* policycontroller: {
* policyControllerHubConfig: {
* installSpec: "INSTALL_SPEC_ENABLED",
* },
* },
* });
* ```
*
* ### Policy Controller With Custom Configurations
*
* ```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: "policycontroller",
* location: "global",
* });
* const featureMember = new gcp.gkehub.FeatureMembership("feature_member", {
* location: "global",
* feature: feature.name,
* membership: membership.membershipId,
* policycontroller: {
* policyControllerHubConfig: {
* installSpec: "INSTALL_SPEC_SUSPENDED",
* policyContent: {
* templateLibrary: {
* installation: "NOT_INSTALLED",
* },
* },
* constraintViolationLimit: 50,
* auditIntervalSeconds: 120,
* referentialRulesEnabled: true,
* logDeniesEnabled: true,
* mutationEnabled: true,
* },
* version: "1.17.0",
* },
* });
* ```
*
* ## Import
*
* FeatureMembership can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/features/{{feature}}/membershipId/{{membership}}`
* * `{{project}}/{{location}}/{{feature}}/{{membership}}`
* * `{{location}}/{{feature}}/{{membership}}`
*
* When using the `pulumi import` command, FeatureMembership can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:gkehub/featureMembership:FeatureMembership default projects/{{project}}/locations/{{location}}/features/{{feature}}/membershipId/{{membership}}
* $ pulumi import gcp:gkehub/featureMembership:FeatureMembership default {{project}}/{{location}}/{{feature}}/{{membership}}
* $ pulumi import gcp:gkehub/featureMembership:FeatureMembership default {{location}}/{{feature}}/{{membership}}
* ```
*/
export declare class FeatureMembership extends pulumi.CustomResource {
/**
* Get an existing FeatureMembership 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?: FeatureMembershipState, opts?: pulumi.CustomResourceOptions): FeatureMembership;
/**
* Returns true if the given object is an instance of FeatureMembership. 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 FeatureMembership;
/**
* Config Management-specific spec. Structure is documented below.
*/
readonly configmanagement: pulumi.Output<outputs.gkehub.FeatureMembershipConfigmanagement | 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.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The name of the feature
*/
readonly feature: pulumi.Output<string>;
/**
* The location of the feature
*/
readonly location: pulumi.Output<string>;
/**
* The name of the membership
*/
readonly membership: pulumi.Output<string>;
/**
* The location of the membership, for example, "us-central1". Default is "global".
*/
readonly membershipLocation: pulumi.Output<string | undefined>;
/**
* Service mesh specific spec. Structure is documented below.
*/
readonly mesh: pulumi.Output<outputs.gkehub.FeatureMembershipMesh | undefined>;
/**
* Policy Controller-specific spec. Structure is documented below.
*/
readonly policycontroller: pulumi.Output<outputs.gkehub.FeatureMembershipPolicycontroller | undefined>;
/**
* The project of the feature
*/
readonly project: pulumi.Output<string>;
/**
* Create a FeatureMembership 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: FeatureMembershipArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FeatureMembership resources.
*/
export interface FeatureMembershipState {
/**
* Config Management-specific spec. Structure is documented below.
*/
configmanagement?: pulumi.Input<inputs.gkehub.FeatureMembershipConfigmanagement | 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>;
/**
* The name of the feature
*/
feature?: pulumi.Input<string | undefined>;
/**
* The location of the feature
*/
location?: pulumi.Input<string | undefined>;
/**
* The name of the membership
*/
membership?: pulumi.Input<string | undefined>;
/**
* The location of the membership, for example, "us-central1". Default is "global".
*/
membershipLocation?: pulumi.Input<string | undefined>;
/**
* Service mesh specific spec. Structure is documented below.
*/
mesh?: pulumi.Input<inputs.gkehub.FeatureMembershipMesh | undefined>;
/**
* Policy Controller-specific spec. Structure is documented below.
*/
policycontroller?: pulumi.Input<inputs.gkehub.FeatureMembershipPolicycontroller | undefined>;
/**
* The project of the feature
*/
project?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a FeatureMembership resource.
*/
export interface FeatureMembershipArgs {
/**
* Config Management-specific spec. Structure is documented below.
*/
configmanagement?: pulumi.Input<inputs.gkehub.FeatureMembershipConfigmanagement | 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>;
/**
* The name of the feature
*/
feature: pulumi.Input<string>;
/**
* The location of the feature
*/
location: pulumi.Input<string>;
/**
* The name of the membership
*/
membership: pulumi.Input<string>;
/**
* The location of the membership, for example, "us-central1". Default is "global".
*/
membershipLocation?: pulumi.Input<string | undefined>;
/**
* Service mesh specific spec. Structure is documented below.
*/
mesh?: pulumi.Input<inputs.gkehub.FeatureMembershipMesh | undefined>;
/**
* Policy Controller-specific spec. Structure is documented below.
*/
policycontroller?: pulumi.Input<inputs.gkehub.FeatureMembershipPolicycontroller | undefined>;
/**
* The project of the feature
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=featureMembership.d.ts.map