diff --git a/api/config/appstudio.redhat.com_enterprisecontractpolicies.yaml b/api/config/appstudio.redhat.com_enterprisecontractpolicies.yaml index e7d48da..0249c48 100644 --- a/api/config/appstudio.redhat.com_enterprisecontractpolicies.yaml +++ b/api/config/appstudio.redhat.com_enterprisecontractpolicies.yaml @@ -23,10 +23,19 @@ spec: description: EnterpriseContractPolicy is the Schema for the enterprisecontractpolicies API properties: apiVersion: - description: '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' + description: |- + 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 type: string kind: - description: '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' + description: |- + 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 type: string metadata: type: object @@ -37,19 +46,25 @@ spec: description: Configuration handles policy modification configuration (exclusions and inclusions) properties: collections: - description: 'Collections set of predefined rules. DEPRECATED: Collections can be listed in include with the "@" prefix.' + description: |- + Collections set of predefined rules. DEPRECATED: Collections can be listed in include + with the "@" prefix. items: type: string type: array x-kubernetes-list-type: set exclude: - description: Exclude set of policy exclusions that, in case of failure, do not block the success of the outcome. + description: |- + Exclude set of policy exclusions that, in case of failure, do not block + the success of the outcome. items: type: string type: array x-kubernetes-list-type: set include: - description: Include set of policy inclusions that are added to the policy evaluation. These override excluded rules. + description: |- + Include set of policy inclusions that are added to the policy evaluation. + These override excluded rules. items: type: string type: array @@ -65,13 +80,17 @@ spec: description: Issuer is the URL of the certificate OIDC issuer for keyless verification. type: string issuerRegExp: - description: IssuerRegExp is a regular expression to match the URL of the certificate OIDC issuer for keyless verification. + description: |- + IssuerRegExp is a regular expression to match the URL of the certificate OIDC issuer for + keyless verification. type: string subject: description: Subject is the URL of the certificate identity for keyless verification. type: string subjectRegExp: - description: SubjectRegExp is a regular expression to match the URL of the certificate identity for keyless verification. + description: |- + SubjectRegExp is a regular expression to match the URL of the certificate identity for + keyless verification. type: string type: object name: @@ -89,16 +108,22 @@ spec: description: Source defines policies and data that are evaluated together properties: config: - description: Config specifies which policy rules are included, or excluded, from the provided policy source urls. + description: |- + Config specifies which policy rules are included, or excluded, from the + provided policy source urls. properties: exclude: - description: Exclude is a set of policy exclusions that, in case of failure, do not block the success of the outcome. + description: |- + Exclude is a set of policy exclusions that, in case of failure, do not block + the success of the outcome. items: type: string type: array x-kubernetes-list-type: set include: - description: Include is a set of policy inclusions that are added to the policy evaluation. These take precedence over policy exclusions. + description: |- + Include is a set of policy inclusions that are added to the policy evaluation. + These take precedence over policy exclusions. items: type: string type: array @@ -123,10 +148,14 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true volatileConfig: - description: Specifies volatile configuration that can include or exclude policy rules based on effective time. + description: |- + Specifies volatile configuration that can include or exclude policy rules + based on effective time. properties: exclude: - description: Exclude is a set of policy exclusions that, in case of failure, do not block the success of the outcome. + description: |- + Exclude is a set of policy exclusions that, in case of failure, do not block + the success of the outcome. items: description: VolatileCriteria includes or excludes a policy rule with effective dates as an option. properties: @@ -146,7 +175,9 @@ spec: - value x-kubernetes-list-type: map include: - description: Include is a set of policy inclusions that are added to the policy evaluation. These take precedence over policy exclusions. + description: |- + Include is a set of policy inclusions that are added to the policy evaluation. + These take precedence over policy exclusions. items: description: VolatileCriteria includes or excludes a policy rule with effective dates as an option. properties: diff --git a/config/crd/bases/appstudio.redhat.com_enterprisecontractpolicies.yaml b/config/crd/bases/appstudio.redhat.com_enterprisecontractpolicies.yaml index e7d48da..0249c48 100644 --- a/config/crd/bases/appstudio.redhat.com_enterprisecontractpolicies.yaml +++ b/config/crd/bases/appstudio.redhat.com_enterprisecontractpolicies.yaml @@ -23,10 +23,19 @@ spec: description: EnterpriseContractPolicy is the Schema for the enterprisecontractpolicies API properties: apiVersion: - description: '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' + description: |- + 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 type: string kind: - description: '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' + description: |- + 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 type: string metadata: type: object @@ -37,19 +46,25 @@ spec: description: Configuration handles policy modification configuration (exclusions and inclusions) properties: collections: - description: 'Collections set of predefined rules. DEPRECATED: Collections can be listed in include with the "@" prefix.' + description: |- + Collections set of predefined rules. DEPRECATED: Collections can be listed in include + with the "@" prefix. items: type: string type: array x-kubernetes-list-type: set exclude: - description: Exclude set of policy exclusions that, in case of failure, do not block the success of the outcome. + description: |- + Exclude set of policy exclusions that, in case of failure, do not block + the success of the outcome. items: type: string type: array x-kubernetes-list-type: set include: - description: Include set of policy inclusions that are added to the policy evaluation. These override excluded rules. + description: |- + Include set of policy inclusions that are added to the policy evaluation. + These override excluded rules. items: type: string type: array @@ -65,13 +80,17 @@ spec: description: Issuer is the URL of the certificate OIDC issuer for keyless verification. type: string issuerRegExp: - description: IssuerRegExp is a regular expression to match the URL of the certificate OIDC issuer for keyless verification. + description: |- + IssuerRegExp is a regular expression to match the URL of the certificate OIDC issuer for + keyless verification. type: string subject: description: Subject is the URL of the certificate identity for keyless verification. type: string subjectRegExp: - description: SubjectRegExp is a regular expression to match the URL of the certificate identity for keyless verification. + description: |- + SubjectRegExp is a regular expression to match the URL of the certificate identity for + keyless verification. type: string type: object name: @@ -89,16 +108,22 @@ spec: description: Source defines policies and data that are evaluated together properties: config: - description: Config specifies which policy rules are included, or excluded, from the provided policy source urls. + description: |- + Config specifies which policy rules are included, or excluded, from the + provided policy source urls. properties: exclude: - description: Exclude is a set of policy exclusions that, in case of failure, do not block the success of the outcome. + description: |- + Exclude is a set of policy exclusions that, in case of failure, do not block + the success of the outcome. items: type: string type: array x-kubernetes-list-type: set include: - description: Include is a set of policy inclusions that are added to the policy evaluation. These take precedence over policy exclusions. + description: |- + Include is a set of policy inclusions that are added to the policy evaluation. + These take precedence over policy exclusions. items: type: string type: array @@ -123,10 +148,14 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true volatileConfig: - description: Specifies volatile configuration that can include or exclude policy rules based on effective time. + description: |- + Specifies volatile configuration that can include or exclude policy rules + based on effective time. properties: exclude: - description: Exclude is a set of policy exclusions that, in case of failure, do not block the success of the outcome. + description: |- + Exclude is a set of policy exclusions that, in case of failure, do not block + the success of the outcome. items: description: VolatileCriteria includes or excludes a policy rule with effective dates as an option. properties: @@ -146,7 +175,9 @@ spec: - value x-kubernetes-list-type: map include: - description: Include is a set of policy inclusions that are added to the policy evaluation. These take precedence over policy exclusions. + description: |- + Include is a set of policy inclusions that are added to the policy evaluation. + These take precedence over policy exclusions. items: description: VolatileCriteria includes or excludes a policy rule with effective dates as an option. properties: diff --git a/docs/modules/ROOT/pages/reference.adoc b/docs/modules/ROOT/pages/reference.adoc index 87d4ae3..6222d2e 100644 --- a/docs/modules/ROOT/pages/reference.adoc +++ b/docs/modules/ROOT/pages/reference.adoc @@ -32,8 +32,22 @@ Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contr | 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 +| *`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`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | *`spec`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicyspec[$$EnterpriseContractPolicySpec$$]__ | @@ -44,7 +58,8 @@ Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contr [id="{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicyconfiguration"] === EnterpriseContractPolicyConfiguration -EnterpriseContractPolicyConfiguration configuration of modifications to policy evaluation. DEPRECATED: Use the config for a policy source instead. +EnterpriseContractPolicyConfiguration configuration of modifications to policy evaluation. +DEPRECATED: Use the config for a policy source instead. [quote] Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicyspec[$$EnterpriseContractPolicySpec$$] @@ -52,9 +67,15 @@ Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contr [cols="25a,75a", options="header"] |=== | 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. +| *`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. |=== @@ -70,8 +91,22 @@ 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 +| *`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`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`. | *`items`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-enterprisecontractpolicy[$$EnterpriseContractPolicy$$] array__ | @@ -121,9 +156,13 @@ Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contr |=== | 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. +| *`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. +| *`issuerRegExp`* __string__ | IssuerRegExp is a regular expression to match the URL of the certificate OIDC issuer for + + +keyless verification. |=== @@ -142,8 +181,12 @@ Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contr | *`policy`* __string array__ | List of go-getter style policy source urls | *`data`* __string array__ | List of go-getter style policy data source urls | *`ruleData`* __xref:{anchor_prefix}-k8s-io-apiextensions-apiserver-pkg-apis-apiextensions-v1-json[$$JSON$$]__ | Arbitrary rule data that will be visible to policy rules -| *`config`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-sourceconfig[$$SourceConfig$$]__ | Config specifies which policy rules are included, or excluded, from the provided policy source urls. -| *`volatileConfig`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-volatilesourceconfig[$$VolatileSourceConfig$$]__ | Specifies volatile configuration that can include or exclude policy rules based on effective time. +| *`config`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-sourceconfig[$$SourceConfig$$]__ | Config specifies which policy rules are included, or excluded, from the + + +provided policy source urls. +| *`volatileConfig`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-volatilesourceconfig[$$VolatileSourceConfig$$]__ | Specifies volatile configuration that can include or exclude policy rules + + +based on effective time. |=== @@ -158,8 +201,12 @@ Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contr [cols="25a,75a", options="header"] |=== | 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. +| *`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. |=== @@ -191,8 +238,12 @@ Appears In: xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contr [cols="25a,75a", options="header"] |=== | Field | Description -| *`exclude`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-volatilecriteria[$$VolatileCriteria$$] array__ | Exclude is a set of policy exclusions that, in case of failure, do not block the success of the outcome. -| *`include`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-volatilecriteria[$$VolatileCriteria$$] array__ | Include is a set of policy inclusions that are added to the policy evaluation. These take precedence over policy exclusions. +| *`exclude`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-volatilecriteria[$$VolatileCriteria$$] array__ | Exclude is a set of policy exclusions that, in case of failure, do not block + + +the success of the outcome. +| *`include`* __xref:{anchor_prefix}-github-com-enterprise-contract-enterprise-contract-controller-api-v1alpha1-volatilecriteria[$$VolatileCriteria$$] array__ | Include is a set of policy inclusions that are added to the policy evaluation. + + +These take precedence over policy exclusions. |===