API Reference

appstudio.redhat.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the appstudio.redhat.com v1alpha1 API group

Resource Types

EnterpriseContractPolicy

EnterpriseContractPolicy is the Schema for the enterprisecontractpolicies API

Appears In: EnterpriseContractPolicyList
Field Description

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

EnterpriseContractPolicy

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec EnterpriseContractPolicySpec

status EnterpriseContractPolicyStatus

EnterpriseContractPolicyConfiguration

EnterpriseContractPolicyConfiguration configuration of modifications to policy evaluation. DEPRECATED: Use the config for a policy source instead.

Appears In: EnterpriseContractPolicySpec
Field Description

exclude string array

Exclude set of policy exclusions that, in case of failure, do not block the success of the outcome.

include string array

Include set of policy inclusions that are added to the policy evaluation. These override excluded rules.

collections string array

Collections set of predefined rules. DEPRECATED: Collections can be listed in include with the "@" prefix.

EnterpriseContractPolicyList

EnterpriseContractPolicyList contains a list of EnterpriseContractPolicy

Field Description

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

EnterpriseContractPolicyList

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items EnterpriseContractPolicy array

EnterpriseContractPolicySpec

EnterpriseContractPolicySpec is used to configure the Enterprise Contract Policy

Appears In: EnterpriseContractPolicy
Field Description

name string

Optional name of the policy

description string

Description of the policy or its intended use

sources Source array

One or more groups of policy rules

configuration EnterpriseContractPolicyConfiguration

Configuration handles policy modification configuration (exclusions and inclusions)

rekorUrl string

URL of the Rekor instance. Empty string disables Rekor integration

publicKey string

Public key used to validate the signature of images and attestations

identity Identity

Identity to be used for keyless verification. This is an experimental feature.

EnterpriseContractPolicyStatus

EnterpriseContractPolicyStatus defines the observed state of EnterpriseContractPolicy

Appears In: EnterpriseContractPolicy

Identity

Identity defines the allowed identity for keyless signing.

Appears In: EnterpriseContractPolicySpec
Field Description

subject string

Subject is the URL of the certificate identity for keyless verification.

subjectRegExp string

SubjectRegExp is a regular expression to match the URL of the certificate identity for keyless verification.

issuer string

Issuer is the URL of the certificate OIDC issuer for keyless verification.

issuerRegExp string

IssuerRegExp is a regular expression to match the URL of the certificate OIDC issuer for keyless verification.

Source

Source defines policies and data that are evaluated together

Appears In: EnterpriseContractPolicySpec
Field Description

name string

Optional name for the source

policy string array

List of go-getter style policy source urls

data string array

List of go-getter style policy data source urls

ruleData JSON

Arbitrary rule data that will be visible to policy rules

config SourceConfig

Config specifies which policy rules are included, or excluded, from the provided policy source urls.

volatileConfig VolatileSourceConfig

Specifies volatile configuration that can include or exclude policy rules based on effective time.

SourceConfig

SourceConfig specifies config options for a policy source.

Appears In: Source
Field Description

exclude string array

Exclude is a set of policy exclusions that, in case of failure, do not block the success of the outcome.

include string array

Include is a set of policy inclusions that are added to the policy evaluation. These take precedence over policy exclusions.

VolatileCriteria (struct{Value string "json:\"value\""; EffectiveOn string "json:\"effectiveOn,omitempty\""; EffectiveUntil string "json:\"effectiveUntil,omitempty\""})

Appears In: VolatileSourceConfig

VolatileSourceConfig

VolatileSourceConfig specifies volatile configuration for a policy source.

Appears In: Source
Field Description

exclude VolatileCriteria array

Exclude is a set of policy exclusions that, in case of failure, do not block the success of the outcome.

include VolatileCriteria array

Include is a set of policy inclusions that are added to the policy evaluation. These take precedence over policy exclusions.