Policy class

A policy for container image binary authorization.

To get more information about Policy, see:

Example Usage

Binary Authorization Policy Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const note = new gcp.containeranalysis.Note("note", {
    name: "test-attestor-note",
    attestationAuthority: {
        hint: {
            humanReadableName: "My attestor",
        },
    },
});
const attestor = new gcp.binaryauthorization.Attestor("attestor", {
    name: "test-attestor",
    attestationAuthorityNote: {
        noteReference: note.name,
    },
});
const policy = new gcp.binaryauthorization.Policy("policy", {
    admissionWhitelistPatterns: [{
        namePattern: "gcr.io/google_containers/*",
    }],
    defaultAdmissionRule: {
        evaluationMode: "ALWAYS_ALLOW",
        enforcementMode: "ENFORCED_BLOCK_AND_AUDIT_LOG",
    },
    clusterAdmissionRules: [{
        cluster: "us-central1-a.prod-cluster",
        evaluationMode: "REQUIRE_ATTESTATION",
        enforcementMode: "ENFORCED_BLOCK_AND_AUDIT_LOG",
        requireAttestationsBies: [attestor.name],
    }],
});

import pulumi
import pulumi_gcp as gcp

note = gcp.containeranalysis.Note("note",
    name="test-attestor-note",
    attestation_authority={
        "hint": {
            "human_readable_name": "My attestor",
        },
    })
attestor = gcp.binaryauthorization.Attestor("attestor",
    name="test-attestor",
    attestation_authority_note={
        "note_reference": note.name,
    })
policy = gcp.binaryauthorization.Policy("policy",
    admission_whitelist_patterns=[{
        "name_pattern": "gcr.io/google_containers/*",
    }],
    default_admission_rule={
        "evaluation_mode": "ALWAYS_ALLOW",
        "enforcement_mode": "ENFORCED_BLOCK_AND_AUDIT_LOG",
    },
    cluster_admission_rules=[{
        "cluster": "us-central1-a.prod-cluster",
        "evaluation_mode": "REQUIRE_ATTESTATION",
        "enforcement_mode": "ENFORCED_BLOCK_AND_AUDIT_LOG",
        "require_attestations_bies": [attestor.name],
    }])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var note = new Gcp.ContainerAnalysis.Note("note", new()
    {
        Name = "test-attestor-note",
        AttestationAuthority = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityArgs
        {
            Hint = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityHintArgs
            {
                HumanReadableName = "My attestor",
            },
        },
    });

    var attestor = new Gcp.BinaryAuthorization.Attestor("attestor", new()
    {
        Name = "test-attestor",
        AttestationAuthorityNote = new Gcp.BinaryAuthorization.Inputs.AttestorAttestationAuthorityNoteArgs
        {
            NoteReference = note.Name,
        },
    });

    var policy = new Gcp.BinaryAuthorization.Policy("policy", new()
    {
        AdmissionWhitelistPatterns = new[]
        {
            new Gcp.BinaryAuthorization.Inputs.PolicyAdmissionWhitelistPatternArgs
            {
                NamePattern = "gcr.io/google_containers/*",
            },
        },
        DefaultAdmissionRule = new Gcp.BinaryAuthorization.Inputs.PolicyDefaultAdmissionRuleArgs
        {
            EvaluationMode = "ALWAYS_ALLOW",
            EnforcementMode = "ENFORCED_BLOCK_AND_AUDIT_LOG",
        },
        ClusterAdmissionRules = new[]
        {
            new Gcp.BinaryAuthorization.Inputs.PolicyClusterAdmissionRuleArgs
            {
                Cluster = "us-central1-a.prod-cluster",
                EvaluationMode = "REQUIRE_ATTESTATION",
                EnforcementMode = "ENFORCED_BLOCK_AND_AUDIT_LOG",
                RequireAttestationsBies = new[]
                {
                    attestor.Name,
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/binaryauthorization"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/containeranalysis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		note, err := containeranalysis.NewNote(ctx, "note", &containeranalysis.NoteArgs{
			Name: pulumi.String("test-attestor-note"),
			AttestationAuthority: &containeranalysis.NoteAttestationAuthorityArgs{
				Hint: &containeranalysis.NoteAttestationAuthorityHintArgs{
					HumanReadableName: pulumi.String("My attestor"),
				},
			},
		})
		if err != nil {
			return err
		}
		attestor, err := binaryauthorization.NewAttestor(ctx, "attestor", &binaryauthorization.AttestorArgs{
			Name: pulumi.String("test-attestor"),
			AttestationAuthorityNote: &binaryauthorization.AttestorAttestationAuthorityNoteArgs{
				NoteReference: note.Name,
			},
		})
		if err != nil {
			return err
		}
		_, err = binaryauthorization.NewPolicy(ctx, "policy", &binaryauthorization.PolicyArgs{
			AdmissionWhitelistPatterns: binaryauthorization.PolicyAdmissionWhitelistPatternArray{
				&binaryauthorization.PolicyAdmissionWhitelistPatternArgs{
					NamePattern: pulumi.String("gcr.io/google_containers/*"),
				},
			},
			DefaultAdmissionRule: &binaryauthorization.PolicyDefaultAdmissionRuleArgs{
				EvaluationMode:  pulumi.String("ALWAYS_ALLOW"),
				EnforcementMode: pulumi.String("ENFORCED_BLOCK_AND_AUDIT_LOG"),
			},
			ClusterAdmissionRules: binaryauthorization.PolicyClusterAdmissionRuleArray{
				&binaryauthorization.PolicyClusterAdmissionRuleArgs{
					Cluster:         pulumi.String("us-central1-a.prod-cluster"),
					EvaluationMode:  pulumi.String("REQUIRE_ATTESTATION"),
					EnforcementMode: pulumi.String("ENFORCED_BLOCK_AND_AUDIT_LOG"),
					RequireAttestationsBies: pulumi.StringArray{
						attestor.Name,
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_binaryauthorization_policy" "policy" {
  admission_whitelist_patterns {
    name_pattern = "gcr.io/google_containers/*"
  }
  default_admission_rule = {
    evaluation_mode  = "ALWAYS_ALLOW"
    enforcement_mode = "ENFORCED_BLOCK_AND_AUDIT_LOG"
  }
  cluster_admission_rules {
    cluster                   = "us-central1-a.prod-cluster"
    evaluation_mode           = "REQUIRE_ATTESTATION"
    enforcement_mode          = "ENFORCED_BLOCK_AND_AUDIT_LOG"
    require_attestations_bies = [gcp_binaryauthorization_attestor.attestor.name]
  }
}
resource "gcp_containeranalysis_note" "note" {
  name = "test-attestor-note"
  attestation_authority = {
    hint = {
      human_readable_name = "My attestor"
    }
  }
}
resource "gcp_binaryauthorization_attestor" "attestor" {
  name = "test-attestor"
  attestation_authority_note = {
    note_reference = gcp_containeranalysis_note.note.name
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.containeranalysis.Note;
import com.pulumi.gcp.containeranalysis.NoteArgs;
import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityArgs;
import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityHintArgs;
import com.pulumi.gcp.binaryauthorization.Attestor;
import com.pulumi.gcp.binaryauthorization.AttestorArgs;
import com.pulumi.gcp.binaryauthorization.inputs.AttestorAttestationAuthorityNoteArgs;
import com.pulumi.gcp.binaryauthorization.Policy;
import com.pulumi.gcp.binaryauthorization.PolicyArgs;
import com.pulumi.gcp.binaryauthorization.inputs.PolicyAdmissionWhitelistPatternArgs;
import com.pulumi.gcp.binaryauthorization.inputs.PolicyDefaultAdmissionRuleArgs;
import com.pulumi.gcp.binaryauthorization.inputs.PolicyClusterAdmissionRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var note = new Note("note", NoteArgs.builder()
            .name("test-attestor-note")
            .attestationAuthority(NoteAttestationAuthorityArgs.builder()
                .hint(NoteAttestationAuthorityHintArgs.builder()
                    .humanReadableName("My attestor")
                    .build())
                .build())
            .build());

        var attestor = new Attestor("attestor", AttestorArgs.builder()
            .name("test-attestor")
            .attestationAuthorityNote(AttestorAttestationAuthorityNoteArgs.builder()
                .noteReference(note.name())
                .build())
            .build());

        var policy = new Policy("policy", PolicyArgs.builder()
            .admissionWhitelistPatterns(PolicyAdmissionWhitelistPatternArgs.builder()
                .namePattern("gcr.io/google_containers/*")
                .build())
            .defaultAdmissionRule(PolicyDefaultAdmissionRuleArgs.builder()
                .evaluationMode("ALWAYS_ALLOW")
                .enforcementMode("ENFORCED_BLOCK_AND_AUDIT_LOG")
                .build())
            .clusterAdmissionRules(PolicyClusterAdmissionRuleArgs.builder()
                .cluster("us-central1-a.prod-cluster")
                .evaluationMode("REQUIRE_ATTESTATION")
                .enforcementMode("ENFORCED_BLOCK_AND_AUDIT_LOG")
                .requireAttestationsBies(attestor.name())
                .build())
            .build());

    }
}

resources:
  policy:
    type: gcp:binaryauthorization:Policy
    properties:
      admissionWhitelistPatterns:
        - namePattern: gcr.io/google_containers/*
      defaultAdmissionRule:
        evaluationMode: ALWAYS_ALLOW
        enforcementMode: ENFORCED_BLOCK_AND_AUDIT_LOG
      clusterAdmissionRules:
        - cluster: us-central1-a.prod-cluster
          evaluationMode: REQUIRE_ATTESTATION
          enforcementMode: ENFORCED_BLOCK_AND_AUDIT_LOG
          requireAttestationsBies:
            - ${attestor.name}
  note:
    type: gcp:containeranalysis:Note
    properties:
      name: test-attestor-note
      attestationAuthority:
        hint:
          humanReadableName: My attestor
  attestor:
    type: gcp:binaryauthorization:Attestor
    properties:
      name: test-attestor
      attestationAuthorityNote:
        noteReference: ${note.name}

Binary Authorization Policy Global Evaluation

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const note = new gcp.containeranalysis.Note("note", {
    name: "test-attestor-note",
    attestationAuthority: {
        hint: {
            humanReadableName: "My attestor",
        },
    },
});
const attestor = new gcp.binaryauthorization.Attestor("attestor", {
    name: "test-attestor",
    attestationAuthorityNote: {
        noteReference: note.name,
    },
});
const policy = new gcp.binaryauthorization.Policy("policy", {
    defaultAdmissionRule: {
        evaluationMode: "REQUIRE_ATTESTATION",
        enforcementMode: "ENFORCED_BLOCK_AND_AUDIT_LOG",
        requireAttestationsBies: [attestor.name],
    },
    globalPolicyEvaluationMode: "ENABLE",
});

import pulumi
import pulumi_gcp as gcp

note = gcp.containeranalysis.Note("note",
    name="test-attestor-note",
    attestation_authority={
        "hint": {
            "human_readable_name": "My attestor",
        },
    })
attestor = gcp.binaryauthorization.Attestor("attestor",
    name="test-attestor",
    attestation_authority_note={
        "note_reference": note.name,
    })
policy = gcp.binaryauthorization.Policy("policy",
    default_admission_rule={
        "evaluation_mode": "REQUIRE_ATTESTATION",
        "enforcement_mode": "ENFORCED_BLOCK_AND_AUDIT_LOG",
        "require_attestations_bies": [attestor.name],
    },
    global_policy_evaluation_mode="ENABLE")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var note = new Gcp.ContainerAnalysis.Note("note", new()
    {
        Name = "test-attestor-note",
        AttestationAuthority = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityArgs
        {
            Hint = new Gcp.ContainerAnalysis.Inputs.NoteAttestationAuthorityHintArgs
            {
                HumanReadableName = "My attestor",
            },
        },
    });

    var attestor = new Gcp.BinaryAuthorization.Attestor("attestor", new()
    {
        Name = "test-attestor",
        AttestationAuthorityNote = new Gcp.BinaryAuthorization.Inputs.AttestorAttestationAuthorityNoteArgs
        {
            NoteReference = note.Name,
        },
    });

    var policy = new Gcp.BinaryAuthorization.Policy("policy", new()
    {
        DefaultAdmissionRule = new Gcp.BinaryAuthorization.Inputs.PolicyDefaultAdmissionRuleArgs
        {
            EvaluationMode = "REQUIRE_ATTESTATION",
            EnforcementMode = "ENFORCED_BLOCK_AND_AUDIT_LOG",
            RequireAttestationsBies = new[]
            {
                attestor.Name,
            },
        },
        GlobalPolicyEvaluationMode = "ENABLE",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/binaryauthorization"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/containeranalysis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		note, err := containeranalysis.NewNote(ctx, "note", &containeranalysis.NoteArgs{
			Name: pulumi.String("test-attestor-note"),
			AttestationAuthority: &containeranalysis.NoteAttestationAuthorityArgs{
				Hint: &containeranalysis.NoteAttestationAuthorityHintArgs{
					HumanReadableName: pulumi.String("My attestor"),
				},
			},
		})
		if err != nil {
			return err
		}
		attestor, err := binaryauthorization.NewAttestor(ctx, "attestor", &binaryauthorization.AttestorArgs{
			Name: pulumi.String("test-attestor"),
			AttestationAuthorityNote: &binaryauthorization.AttestorAttestationAuthorityNoteArgs{
				NoteReference: note.Name,
			},
		})
		if err != nil {
			return err
		}
		_, err = binaryauthorization.NewPolicy(ctx, "policy", &binaryauthorization.PolicyArgs{
			DefaultAdmissionRule: &binaryauthorization.PolicyDefaultAdmissionRuleArgs{
				EvaluationMode:  pulumi.String("REQUIRE_ATTESTATION"),
				EnforcementMode: pulumi.String("ENFORCED_BLOCK_AND_AUDIT_LOG"),
				RequireAttestationsBies: pulumi.StringArray{
					attestor.Name,
				},
			},
			GlobalPolicyEvaluationMode: pulumi.String("ENABLE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_binaryauthorization_policy" "policy" {
  default_admission_rule = {
    evaluation_mode           = "REQUIRE_ATTESTATION"
    enforcement_mode          = "ENFORCED_BLOCK_AND_AUDIT_LOG"
    require_attestations_bies = [gcp_binaryauthorization_attestor.attestor.name]
  }
  global_policy_evaluation_mode = "ENABLE"
}
resource "gcp_containeranalysis_note" "note" {
  name = "test-attestor-note"
  attestation_authority = {
    hint = {
      human_readable_name = "My attestor"
    }
  }
}
resource "gcp_binaryauthorization_attestor" "attestor" {
  name = "test-attestor"
  attestation_authority_note = {
    note_reference = gcp_containeranalysis_note.note.name
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.containeranalysis.Note;
import com.pulumi.gcp.containeranalysis.NoteArgs;
import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityArgs;
import com.pulumi.gcp.containeranalysis.inputs.NoteAttestationAuthorityHintArgs;
import com.pulumi.gcp.binaryauthorization.Attestor;
import com.pulumi.gcp.binaryauthorization.AttestorArgs;
import com.pulumi.gcp.binaryauthorization.inputs.AttestorAttestationAuthorityNoteArgs;
import com.pulumi.gcp.binaryauthorization.Policy;
import com.pulumi.gcp.binaryauthorization.PolicyArgs;
import com.pulumi.gcp.binaryauthorization.inputs.PolicyDefaultAdmissionRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var note = new Note("note", NoteArgs.builder()
            .name("test-attestor-note")
            .attestationAuthority(NoteAttestationAuthorityArgs.builder()
                .hint(NoteAttestationAuthorityHintArgs.builder()
                    .humanReadableName("My attestor")
                    .build())
                .build())
            .build());

        var attestor = new Attestor("attestor", AttestorArgs.builder()
            .name("test-attestor")
            .attestationAuthorityNote(AttestorAttestationAuthorityNoteArgs.builder()
                .noteReference(note.name())
                .build())
            .build());

        var policy = new Policy("policy", PolicyArgs.builder()
            .defaultAdmissionRule(PolicyDefaultAdmissionRuleArgs.builder()
                .evaluationMode("REQUIRE_ATTESTATION")
                .enforcementMode("ENFORCED_BLOCK_AND_AUDIT_LOG")
                .requireAttestationsBies(attestor.name())
                .build())
            .globalPolicyEvaluationMode("ENABLE")
            .build());

    }
}

resources:
  policy:
    type: gcp:binaryauthorization:Policy
    properties:
      defaultAdmissionRule:
        evaluationMode: REQUIRE_ATTESTATION
        enforcementMode: ENFORCED_BLOCK_AND_AUDIT_LOG
        requireAttestationsBies:
          - ${attestor.name}
      globalPolicyEvaluationMode: ENABLE
  note:
    type: gcp:containeranalysis:Note
    properties:
      name: test-attestor-note
      attestationAuthority:
        hint:
          humanReadableName: My attestor
  attestor:
    type: gcp:binaryauthorization:Attestor
    properties:
      name: test-attestor
      attestationAuthorityNote:
        noteReference: ${note.name}

Import

Policy can be imported using any of these accepted formats:

projects/{{project}}
{{project}}

When using the pulumi import command, Policy can be imported using one of the formats above. For example:

$ pulumi import gcp:binaryauthorization/policy:Policy default projects/{{project}}
$ pulumi import gcp:binaryauthorization/policy:Policy default {{project}}

Constructors

Policy(String name, {PolicyArgs? args, CustomResourceOptions? options}): Creates a new Policy. name The Pulumi resource name. args Arguments used to configure this Policy. The set of arguments for Policy. options Resource options controlling this resource's behavior.
Policy.reference(String urn): Creates a typed reference to an existing Policy resource.

Properties

admissionWhitelistPatterns ↔ Output<List<PolicyAdmissionWhitelistPattern>?>: A whitelist of image patterns to exclude from admission rules. If an image's name matches a whitelist pattern, the image's admission requests will always be permitted regardless of your admission rules. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
clusterAdmissionRules ↔ Output<List<PolicyClusterAdmissionRule>?>: Per-cluster admission rules. An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. There can be at most one admission rule per cluster spec. Identifier format: {{location}}.{{clusterId}}. A location is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). Structure is documented below.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
defaultAdmissionRule ↔ Output<PolicyDefaultAdmissionRule>: Default admission rule for a cluster without a per-cluster admission rule. Structure is documented below.
latefinal
deletionPolicy ↔ 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.
latefinal
description ↔ Output<String?>: A descriptive comment.
latefinal
globalPolicyEvaluationMode ↔ Output<String>: Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. Possible values are: ENABLE, DISABLE.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PolicyState? state, CustomResourceOptions? options}) → Policy: Gets an existing Policy resource's state with the given name and id.