Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harbor
  3. API Docs
  4. ConfigSystem
Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

harbor.ConfigSystem

Explore with Pulumi AI

Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor

Example Usage

resource "harbor_config_system" "main" {
  project_creation_restriction = "adminonly"
  robot_token_expiration       = 30
  robot_name_prefix            = "harbor@"
  storage_per_project          = 100
}
Copy

Create ConfigSystem Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ConfigSystem(name: string, args?: ConfigSystemArgs, opts?: CustomResourceOptions);
@overload
def ConfigSystem(resource_name: str,
                 args: Optional[ConfigSystemArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def ConfigSystem(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 audit_log_forward_endpoint: Optional[str] = None,
                 banner_message: Optional[ConfigSystemBannerMessageArgs] = None,
                 project_creation_restriction: Optional[str] = None,
                 read_only: Optional[bool] = None,
                 robot_name_prefix: Optional[str] = None,
                 robot_token_expiration: Optional[int] = None,
                 scanner_skip_update_pulltime: Optional[bool] = None,
                 skip_audit_log_database: Optional[bool] = None,
                 storage_per_project: Optional[int] = None)
func NewConfigSystem(ctx *Context, name string, args *ConfigSystemArgs, opts ...ResourceOption) (*ConfigSystem, error)
public ConfigSystem(string name, ConfigSystemArgs? args = null, CustomResourceOptions? opts = null)
public ConfigSystem(String name, ConfigSystemArgs args)
public ConfigSystem(String name, ConfigSystemArgs args, CustomResourceOptions options)

type: harbor:ConfigSystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ConfigSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ConfigSystemArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ConfigSystemArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ConfigSystemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConfigSystemArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var configSystemResource = new Harbor.ConfigSystem("configSystemResource", new()
{
    AuditLogForwardEndpoint = "string",
    BannerMessage = new Harbor.Inputs.ConfigSystemBannerMessageArgs
    {
        Message = "string",
        Closable = false,
        FromDate = "string",
        ToDate = "string",
        Type = "string",
    },
    ProjectCreationRestriction = "string",
    ReadOnly = false,
    RobotNamePrefix = "string",
    RobotTokenExpiration = 0,
    ScannerSkipUpdatePulltime = false,
    SkipAuditLogDatabase = false,
    StoragePerProject = 0,
});
Copy
example, err := harbor.NewConfigSystem(ctx, "configSystemResource", &harbor.ConfigSystemArgs{
	AuditLogForwardEndpoint: pulumi.String("string"),
	BannerMessage: &harbor.ConfigSystemBannerMessageArgs{
		Message:  pulumi.String("string"),
		Closable: pulumi.Bool(false),
		FromDate: pulumi.String("string"),
		ToDate:   pulumi.String("string"),
		Type:     pulumi.String("string"),
	},
	ProjectCreationRestriction: pulumi.String("string"),
	ReadOnly:                   pulumi.Bool(false),
	RobotNamePrefix:            pulumi.String("string"),
	RobotTokenExpiration:       pulumi.Int(0),
	ScannerSkipUpdatePulltime:  pulumi.Bool(false),
	SkipAuditLogDatabase:       pulumi.Bool(false),
	StoragePerProject:          pulumi.Int(0),
})
Copy
var configSystemResource = new ConfigSystem("configSystemResource", ConfigSystemArgs.builder()
    .auditLogForwardEndpoint("string")
    .bannerMessage(ConfigSystemBannerMessageArgs.builder()
        .message("string")
        .closable(false)
        .fromDate("string")
        .toDate("string")
        .type("string")
        .build())
    .projectCreationRestriction("string")
    .readOnly(false)
    .robotNamePrefix("string")
    .robotTokenExpiration(0)
    .scannerSkipUpdatePulltime(false)
    .skipAuditLogDatabase(false)
    .storagePerProject(0)
    .build());
Copy
config_system_resource = harbor.ConfigSystem("configSystemResource",
    audit_log_forward_endpoint="string",
    banner_message={
        "message": "string",
        "closable": False,
        "from_date": "string",
        "to_date": "string",
        "type": "string",
    },
    project_creation_restriction="string",
    read_only=False,
    robot_name_prefix="string",
    robot_token_expiration=0,
    scanner_skip_update_pulltime=False,
    skip_audit_log_database=False,
    storage_per_project=0)
Copy
const configSystemResource = new harbor.ConfigSystem("configSystemResource", {
    auditLogForwardEndpoint: "string",
    bannerMessage: {
        message: "string",
        closable: false,
        fromDate: "string",
        toDate: "string",
        type: "string",
    },
    projectCreationRestriction: "string",
    readOnly: false,
    robotNamePrefix: "string",
    robotTokenExpiration: 0,
    scannerSkipUpdatePulltime: false,
    skipAuditLogDatabase: false,
    storagePerProject: 0,
});
Copy
type: harbor:ConfigSystem
properties:
    auditLogForwardEndpoint: string
    bannerMessage:
        closable: false
        fromDate: string
        message: string
        toDate: string
        type: string
    projectCreationRestriction: string
    readOnly: false
    robotNamePrefix: string
    robotTokenExpiration: 0
    scannerSkipUpdatePulltime: false
    skipAuditLogDatabase: false
    storagePerProject: 0
Copy

ConfigSystem Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ConfigSystem resource accepts the following input properties:

AuditLogForwardEndpoint string
The endpoint to forward audit logs to.
BannerMessage Pulumiverse.Harbor.Inputs.ConfigSystemBannerMessage
ProjectCreationRestriction string
Who can create projects within Harbor. Can be "adminonly" or "everyone"
ReadOnly bool
Whether or not the system is in read only mode.
RobotNamePrefix string
Robot account prefix.
RobotTokenExpiration int
The amount of time in days a robot account will expire.
ScannerSkipUpdatePulltime bool
Whether or not to skip update pull time for scanner.
SkipAuditLogDatabase bool
Whether or not to skip audit log database.
StoragePerProject int
Default quota space per project in GIB. Default is -1 (unlimited).
AuditLogForwardEndpoint string
The endpoint to forward audit logs to.
BannerMessage ConfigSystemBannerMessageArgs
ProjectCreationRestriction string
Who can create projects within Harbor. Can be "adminonly" or "everyone"
ReadOnly bool
Whether or not the system is in read only mode.
RobotNamePrefix string
Robot account prefix.
RobotTokenExpiration int
The amount of time in days a robot account will expire.
ScannerSkipUpdatePulltime bool
Whether or not to skip update pull time for scanner.
SkipAuditLogDatabase bool
Whether or not to skip audit log database.
StoragePerProject int
Default quota space per project in GIB. Default is -1 (unlimited).
auditLogForwardEndpoint String
The endpoint to forward audit logs to.
bannerMessage ConfigSystemBannerMessage
projectCreationRestriction String
Who can create projects within Harbor. Can be "adminonly" or "everyone"
readOnly Boolean
Whether or not the system is in read only mode.
robotNamePrefix String
Robot account prefix.
robotTokenExpiration Integer
The amount of time in days a robot account will expire.
scannerSkipUpdatePulltime Boolean
Whether or not to skip update pull time for scanner.
skipAuditLogDatabase Boolean
Whether or not to skip audit log database.
storagePerProject Integer
Default quota space per project in GIB. Default is -1 (unlimited).
auditLogForwardEndpoint string
The endpoint to forward audit logs to.
bannerMessage ConfigSystemBannerMessage
projectCreationRestriction string
Who can create projects within Harbor. Can be "adminonly" or "everyone"
readOnly boolean
Whether or not the system is in read only mode.
robotNamePrefix string
Robot account prefix.
robotTokenExpiration number
The amount of time in days a robot account will expire.
scannerSkipUpdatePulltime boolean
Whether or not to skip update pull time for scanner.
skipAuditLogDatabase boolean
Whether or not to skip audit log database.
storagePerProject number
Default quota space per project in GIB. Default is -1 (unlimited).
audit_log_forward_endpoint str
The endpoint to forward audit logs to.
ConfigSystemBannerMessageArgs
project_creation_restriction str
Who can create projects within Harbor. Can be "adminonly" or "everyone"
read_only bool
Whether or not the system is in read only mode.
robot_name_prefix str
Robot account prefix.
robot_token_expiration int
The amount of time in days a robot account will expire.
scanner_skip_update_pulltime bool
Whether or not to skip update pull time for scanner.
skip_audit_log_database bool
Whether or not to skip audit log database.
storage_per_project int
Default quota space per project in GIB. Default is -1 (unlimited).
auditLogForwardEndpoint String
The endpoint to forward audit logs to.
bannerMessage Property Map
projectCreationRestriction String
Who can create projects within Harbor. Can be "adminonly" or "everyone"
readOnly Boolean
Whether or not the system is in read only mode.
robotNamePrefix String
Robot account prefix.
robotTokenExpiration Number
The amount of time in days a robot account will expire.
scannerSkipUpdatePulltime Boolean
Whether or not to skip update pull time for scanner.
skipAuditLogDatabase Boolean
Whether or not to skip audit log database.
storagePerProject Number
Default quota space per project in GIB. Default is -1 (unlimited).

Outputs

All input properties are implicitly available as output properties. Additionally, the ConfigSystem 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 ConfigSystem Resource

Get an existing ConfigSystem 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?: ConfigSystemState, opts?: CustomResourceOptions): ConfigSystem
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_log_forward_endpoint: Optional[str] = None,
        banner_message: Optional[ConfigSystemBannerMessageArgs] = None,
        project_creation_restriction: Optional[str] = None,
        read_only: Optional[bool] = None,
        robot_name_prefix: Optional[str] = None,
        robot_token_expiration: Optional[int] = None,
        scanner_skip_update_pulltime: Optional[bool] = None,
        skip_audit_log_database: Optional[bool] = None,
        storage_per_project: Optional[int] = None) -> ConfigSystem
func GetConfigSystem(ctx *Context, name string, id IDInput, state *ConfigSystemState, opts ...ResourceOption) (*ConfigSystem, error)
public static ConfigSystem Get(string name, Input<string> id, ConfigSystemState? state, CustomResourceOptions? opts = null)
public static ConfigSystem get(String name, Output<String> id, ConfigSystemState state, CustomResourceOptions options)
resources:  _:    type: harbor:ConfigSystem    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AuditLogForwardEndpoint string
The endpoint to forward audit logs to.
BannerMessage Pulumiverse.Harbor.Inputs.ConfigSystemBannerMessage
ProjectCreationRestriction string
Who can create projects within Harbor. Can be "adminonly" or "everyone"
ReadOnly bool
Whether or not the system is in read only mode.
RobotNamePrefix string
Robot account prefix.
RobotTokenExpiration int
The amount of time in days a robot account will expire.
ScannerSkipUpdatePulltime bool
Whether or not to skip update pull time for scanner.
SkipAuditLogDatabase bool
Whether or not to skip audit log database.
StoragePerProject int
Default quota space per project in GIB. Default is -1 (unlimited).
AuditLogForwardEndpoint string
The endpoint to forward audit logs to.
BannerMessage ConfigSystemBannerMessageArgs
ProjectCreationRestriction string
Who can create projects within Harbor. Can be "adminonly" or "everyone"
ReadOnly bool
Whether or not the system is in read only mode.
RobotNamePrefix string
Robot account prefix.
RobotTokenExpiration int
The amount of time in days a robot account will expire.
ScannerSkipUpdatePulltime bool
Whether or not to skip update pull time for scanner.
SkipAuditLogDatabase bool
Whether or not to skip audit log database.
StoragePerProject int
Default quota space per project in GIB. Default is -1 (unlimited).
auditLogForwardEndpoint String
The endpoint to forward audit logs to.
bannerMessage ConfigSystemBannerMessage
projectCreationRestriction String
Who can create projects within Harbor. Can be "adminonly" or "everyone"
readOnly Boolean
Whether or not the system is in read only mode.
robotNamePrefix String
Robot account prefix.
robotTokenExpiration Integer
The amount of time in days a robot account will expire.
scannerSkipUpdatePulltime Boolean
Whether or not to skip update pull time for scanner.
skipAuditLogDatabase Boolean
Whether or not to skip audit log database.
storagePerProject Integer
Default quota space per project in GIB. Default is -1 (unlimited).
auditLogForwardEndpoint string
The endpoint to forward audit logs to.
bannerMessage ConfigSystemBannerMessage
projectCreationRestriction string
Who can create projects within Harbor. Can be "adminonly" or "everyone"
readOnly boolean
Whether or not the system is in read only mode.
robotNamePrefix string
Robot account prefix.
robotTokenExpiration number
The amount of time in days a robot account will expire.
scannerSkipUpdatePulltime boolean
Whether or not to skip update pull time for scanner.
skipAuditLogDatabase boolean
Whether or not to skip audit log database.
storagePerProject number
Default quota space per project in GIB. Default is -1 (unlimited).
audit_log_forward_endpoint str
The endpoint to forward audit logs to.
banner_message ConfigSystemBannerMessageArgs
project_creation_restriction str
Who can create projects within Harbor. Can be "adminonly" or "everyone"
read_only bool
Whether or not the system is in read only mode.
robot_name_prefix str
Robot account prefix.
robot_token_expiration int
The amount of time in days a robot account will expire.
scanner_skip_update_pulltime bool
Whether or not to skip update pull time for scanner.
skip_audit_log_database bool
Whether or not to skip audit log database.
storage_per_project int
Default quota space per project in GIB. Default is -1 (unlimited).
auditLogForwardEndpoint String
The endpoint to forward audit logs to.
bannerMessage Property Map
projectCreationRestriction String
Who can create projects within Harbor. Can be "adminonly" or "everyone"
readOnly Boolean
Whether or not the system is in read only mode.
robotNamePrefix String
Robot account prefix.
robotTokenExpiration Number
The amount of time in days a robot account will expire.
scannerSkipUpdatePulltime Boolean
Whether or not to skip update pull time for scanner.
skipAuditLogDatabase Boolean
Whether or not to skip audit log database.
storagePerProject Number
Default quota space per project in GIB. Default is -1 (unlimited).

Supporting Types

ConfigSystemBannerMessage
, ConfigSystemBannerMessageArgs

Message This property is required. string
The message to display in the banner.
Closable bool
Whether or not the banner message is closable.
FromDate string
The date the banner message will start displaying. (Format: MM/DD/YYYY)
ToDate string
The date the banner message will stop displaying. (Format: MM/DD/YYYY)
Type string
The type of banner message. Can be "info", "warning", "success" or "danger".
Message This property is required. string
The message to display in the banner.
Closable bool
Whether or not the banner message is closable.
FromDate string
The date the banner message will start displaying. (Format: MM/DD/YYYY)
ToDate string
The date the banner message will stop displaying. (Format: MM/DD/YYYY)
Type string
The type of banner message. Can be "info", "warning", "success" or "danger".
message This property is required. String
The message to display in the banner.
closable Boolean
Whether or not the banner message is closable.
fromDate String
The date the banner message will start displaying. (Format: MM/DD/YYYY)
toDate String
The date the banner message will stop displaying. (Format: MM/DD/YYYY)
type String
The type of banner message. Can be "info", "warning", "success" or "danger".
message This property is required. string
The message to display in the banner.
closable boolean
Whether or not the banner message is closable.
fromDate string
The date the banner message will start displaying. (Format: MM/DD/YYYY)
toDate string
The date the banner message will stop displaying. (Format: MM/DD/YYYY)
type string
The type of banner message. Can be "info", "warning", "success" or "danger".
message This property is required. str
The message to display in the banner.
closable bool
Whether or not the banner message is closable.
from_date str
The date the banner message will start displaying. (Format: MM/DD/YYYY)
to_date str
The date the banner message will stop displaying. (Format: MM/DD/YYYY)
type str
The type of banner message. Can be "info", "warning", "success" or "danger".
message This property is required. String
The message to display in the banner.
closable Boolean
Whether or not the banner message is closable.
fromDate String
The date the banner message will start displaying. (Format: MM/DD/YYYY)
toDate String
The date the banner message will stop displaying. (Format: MM/DD/YYYY)
type String
The type of banner message. Can be "info", "warning", "success" or "danger".

Package Details

Repository
harbor pulumiverse/pulumi-harbor
License
Apache-2.0
Notes
This Pulumi package is based on the harbor Terraform Provider.
Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse
pulumiverse/pulumi-harbor