Docs Packages
  1. Packages
  2. Harbor
  3. API Docs
  4. RetentionPolicy
Harbor v3.9.1 published on Tuesday, May 30, 2023 by Pulumiverse
pulumiverse/pulumi-harbor

harbor.RetentionPolicy

Explore with Pulumi AI

harbor logo
Harbor v3.9.1 published on Tuesday, May 30, 2023 by Pulumiverse
pulumiverse/pulumi-harbor

    Import

    Harbor retention policy can be imported using the retention_policy id eg, `

     $ pulumi import harbor:index/retentionPolicy:RetentionPolicy main /retentions/10

    `

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harbor = Pulumiverse.Harbor;

return await Deployment.RunAsync(() => 
{
    var mainProject = new Harbor.Project("mainProject");

    var mainRetentionPolicy = new Harbor.RetentionPolicy("mainRetentionPolicy", new()
    {
        Scope = mainProject.Id,
        Schedule = "daily",
        Rules = new[]
        {
            new Harbor.Inputs.RetentionPolicyRuleArgs
            {
                NDaysSinceLastPull = 5,
                RepoMatching = "**",
                TagMatching = "latest",
            },
            new Harbor.Inputs.RetentionPolicyRuleArgs
            {
                NDaysSinceLastPush = 10,
                RepoMatching = "**",
                TagMatching = "latest",
            },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-harbor/sdk/v3/go/harbor"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mainProject, err := harbor.NewProject(ctx, "mainProject", nil)
		if err != nil {
			return err
		}
		_, err = harbor.NewRetentionPolicy(ctx, "mainRetentionPolicy", &harbor.RetentionPolicyArgs{
			Scope:    mainProject.ID(),
			Schedule: pulumi.String("daily"),
			Rules: harbor.RetentionPolicyRuleArray{
				&harbor.RetentionPolicyRuleArgs{
					NDaysSinceLastPull: pulumi.Int(5),
					RepoMatching:       pulumi.String("**"),
					TagMatching:        pulumi.String("latest"),
				},
				&harbor.RetentionPolicyRuleArgs{
					NDaysSinceLastPush: pulumi.Int(10),
					RepoMatching:       pulumi.String("**"),
					TagMatching:        pulumi.String("latest"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harbor.Project;
import com.pulumi.harbor.RetentionPolicy;
import com.pulumi.harbor.RetentionPolicyArgs;
import com.pulumi.harbor.inputs.RetentionPolicyRuleArgs;
import java.util.List;
import java.util.ArrayList;
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 mainProject = new Project("mainProject");

        var mainRetentionPolicy = new RetentionPolicy("mainRetentionPolicy", RetentionPolicyArgs.builder()        
            .scope(mainProject.id())
            .schedule("daily")
            .rules(            
                RetentionPolicyRuleArgs.builder()
                    .nDaysSinceLastPull(5)
                    .repoMatching("**")
                    .tagMatching("latest")
                    .build(),
                RetentionPolicyRuleArgs.builder()
                    .nDaysSinceLastPush(10)
                    .repoMatching("**")
                    .tagMatching("latest")
                    .build())
            .build());

    }
}

    import pulumi
import pulumiverse_harbor as harbor

main_project = harbor.Project("mainProject")
main_retention_policy = harbor.RetentionPolicy("mainRetentionPolicy",
    scope=main_project.id,
    schedule="daily",
    rules=[
        harbor.RetentionPolicyRuleArgs(
            n_days_since_last_pull=5,
            repo_matching="**",
            tag_matching="latest",
        ),
        harbor.RetentionPolicyRuleArgs(
            n_days_since_last_push=10,
            repo_matching="**",
            tag_matching="latest",
        ),
    ])

    import * as pulumi from "@pulumi/pulumi";
import * as harbor from "@pulumiverse/harbor";

const mainProject = new harbor.Project("mainProject", {});
const mainRetentionPolicy = new harbor.RetentionPolicy("mainRetentionPolicy", {
    scope: mainProject.id,
    schedule: "daily",
    rules: [
        {
            nDaysSinceLastPull: 5,
            repoMatching: "**",
            tagMatching: "latest",
        },
        {
            nDaysSinceLastPush: 10,
            repoMatching: "**",
            tagMatching: "latest",
        },
    ],
});

    resources:
  mainProject:
    type: harbor:Project
  mainRetentionPolicy:
    type: harbor:RetentionPolicy
    properties:
      scope: ${mainProject.id}
      schedule: daily
      rules:
        - nDaysSinceLastPull: 5
          repoMatching: '**'
          tagMatching: latest
        - nDaysSinceLastPush: 10
          repoMatching: '**'
          tagMatching: latest

    Create RetentionPolicy Resource

    new RetentionPolicy(name: string, args: RetentionPolicyArgs, opts?: CustomResourceOptions);
    @overload
def RetentionPolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    rules: Optional[Sequence[RetentionPolicyRuleArgs]] = None,
                    schedule: Optional[str] = None,
                    scope: Optional[str] = None)
@overload
def RetentionPolicy(resource_name: str,
                    args: RetentionPolicyArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewRetentionPolicy(ctx *Context, name string, args RetentionPolicyArgs, opts ...ResourceOption) (*RetentionPolicy, error)
    public RetentionPolicy(string name, RetentionPolicyArgs args, CustomResourceOptions? opts = null)
    public RetentionPolicy(String name, RetentionPolicyArgs args)
public RetentionPolicy(String name, RetentionPolicyArgs args, CustomResourceOptions options)

    type: harbor:RetentionPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RetentionPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RetentionPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RetentionPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RetentionPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RetentionPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RetentionPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The RetentionPolicy resource accepts the following input properties:

    Rules List<Pulumiverse.Harbor.Inputs.RetentionPolicyRuleArgs>

    Al collection of rule blocks as documented below.

    Scope string

    The project id of which you would like to apply this policy.

    Schedule string

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    Rules []RetentionPolicyRuleArgs

    Al collection of rule blocks as documented below.

    Scope string

    The project id of which you would like to apply this policy.

    Schedule string

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    rules List<RetentionPolicyRuleArgs>

    Al collection of rule blocks as documented below.

    scope String

    The project id of which you would like to apply this policy.

    schedule String

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    rules RetentionPolicyRuleArgs[]

    Al collection of rule blocks as documented below.

    scope string

    The project id of which you would like to apply this policy.

    schedule string

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    rules Sequence[RetentionPolicyRuleArgs]

    Al collection of rule blocks as documented below.

    scope str

    The project id of which you would like to apply this policy.

    schedule str

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    rules List<Property Map>

    Al collection of rule blocks as documented below.

    scope String

    The project id of which you would like to apply this policy.

    schedule String

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RetentionPolicy resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing RetentionPolicy Resource

    Get an existing RetentionPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RetentionPolicyState, opts?: CustomResourceOptions): RetentionPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        rules: Optional[Sequence[RetentionPolicyRuleArgs]] = None,
        schedule: Optional[str] = None,
        scope: Optional[str] = None) -> RetentionPolicy
    func GetRetentionPolicy(ctx *Context, name string, id IDInput, state *RetentionPolicyState, opts ...ResourceOption) (*RetentionPolicy, error)
    public static RetentionPolicy Get(string name, Input<string> id, RetentionPolicyState? state, CustomResourceOptions? opts = null)
    public static RetentionPolicy get(String name, Output<String> id, RetentionPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Rules List<Pulumiverse.Harbor.Inputs.RetentionPolicyRuleArgs>

    Al collection of rule blocks as documented below.

    Schedule string

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    Scope string

    The project id of which you would like to apply this policy.

    Rules []RetentionPolicyRuleArgs

    Al collection of rule blocks as documented below.

    Schedule string

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    Scope string

    The project id of which you would like to apply this policy.

    rules List<RetentionPolicyRuleArgs>

    Al collection of rule blocks as documented below.

    schedule String

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    scope String

    The project id of which you would like to apply this policy.

    rules RetentionPolicyRuleArgs[]

    Al collection of rule blocks as documented below.

    schedule string

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    scope string

    The project id of which you would like to apply this policy.

    rules Sequence[RetentionPolicyRuleArgs]

    Al collection of rule blocks as documented below.

    schedule str

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    scope str

    The project id of which you would like to apply this policy.

    rules List<Property Map>

    Al collection of rule blocks as documented below.

    schedule String

    The schedule of when you would like the policy to run. This can be hourly, daily, weekly or can be a custom cron string.

    scope String

    The project id of which you would like to apply this policy.

    Supporting Types

    RetentionPolicyRule

    AlwaysRetain bool

    retain always.

    Disabled bool

    Specify if the rule is disable or not. Defaults to false

    MostRecentlyPulled int

    retain the most recently pulled n artifacts.

    MostRecentlyPushed int

    retain the most recently pushed n artifacts.

    NDaysSinceLastPull int

    retains the artifacts pulled within the lasts n days.

    NDaysSinceLastPush int

    retains the artifacts pushed within the lasts n days.

    RepoExcluding string

    For the repositories excuding.

    RepoMatching string

    For the repositories matching.

    TagExcluding string

    For the tag excuding.

    TagMatching string

    For the tag matching.

    UntaggedArtifacts bool

    with untagged artifacts. Defaults to true

    AlwaysRetain bool

    retain always.

    Disabled bool

    Specify if the rule is disable or not. Defaults to false

    MostRecentlyPulled int

    retain the most recently pulled n artifacts.

    MostRecentlyPushed int

    retain the most recently pushed n artifacts.

    NDaysSinceLastPull int

    retains the artifacts pulled within the lasts n days.

    NDaysSinceLastPush int

    retains the artifacts pushed within the lasts n days.

    RepoExcluding string

    For the repositories excuding.

    RepoMatching string

    For the repositories matching.

    TagExcluding string

    For the tag excuding.

    TagMatching string

    For the tag matching.

    UntaggedArtifacts bool

    with untagged artifacts. Defaults to true

    alwaysRetain Boolean

    retain always.

    disabled Boolean

    Specify if the rule is disable or not. Defaults to false

    mostRecentlyPulled Integer

    retain the most recently pulled n artifacts.

    mostRecentlyPushed Integer

    retain the most recently pushed n artifacts.

    nDaysSinceLastPull Integer

    retains the artifacts pulled within the lasts n days.

    nDaysSinceLastPush Integer

    retains the artifacts pushed within the lasts n days.

    repoExcluding String

    For the repositories excuding.

    repoMatching String

    For the repositories matching.

    tagExcluding String

    For the tag excuding.

    tagMatching String

    For the tag matching.

    untaggedArtifacts Boolean

    with untagged artifacts. Defaults to true

    alwaysRetain boolean

    retain always.

    disabled boolean

    Specify if the rule is disable or not. Defaults to false

    mostRecentlyPulled number

    retain the most recently pulled n artifacts.

    mostRecentlyPushed number

    retain the most recently pushed n artifacts.

    nDaysSinceLastPull number

    retains the artifacts pulled within the lasts n days.

    nDaysSinceLastPush number

    retains the artifacts pushed within the lasts n days.

    repoExcluding string

    For the repositories excuding.

    repoMatching string

    For the repositories matching.

    tagExcluding string

    For the tag excuding.

    tagMatching string

    For the tag matching.

    untaggedArtifacts boolean

    with untagged artifacts. Defaults to true

    always_retain bool

    retain always.

    disabled bool

    Specify if the rule is disable or not. Defaults to false

    most_recently_pulled int

    retain the most recently pulled n artifacts.

    most_recently_pushed int

    retain the most recently pushed n artifacts.

    n_days_since_last_pull int

    retains the artifacts pulled within the lasts n days.

    n_days_since_last_push int

    retains the artifacts pushed within the lasts n days.

    repo_excluding str

    For the repositories excuding.

    repo_matching str

    For the repositories matching.

    tag_excluding str

    For the tag excuding.

    tag_matching str

    For the tag matching.

    untagged_artifacts bool

    with untagged artifacts. Defaults to true

    alwaysRetain Boolean

    retain always.

    disabled Boolean

    Specify if the rule is disable or not. Defaults to false

    mostRecentlyPulled Number

    retain the most recently pulled n artifacts.

    mostRecentlyPushed Number

    retain the most recently pushed n artifacts.

    nDaysSinceLastPull Number

    retains the artifacts pulled within the lasts n days.

    nDaysSinceLastPush Number

    retains the artifacts pushed within the lasts n days.

    repoExcluding String

    For the repositories excuding.

    repoMatching String

    For the repositories matching.

    tagExcluding String

    For the tag excuding.

    tagMatching String

    For the tag matching.

    untaggedArtifacts Boolean

    with untagged artifacts. Defaults to true

    Package Details

    Repository
    harbor pulumiverse/pulumi-harbor
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the harbor Terraform Provider.

    harbor logo
    Harbor v3.9.1 published on Tuesday, May 30, 2023 by Pulumiverse
    pulumiverse/pulumi-harbor