diff --git a/config/v1/tests/schedulers.config.openshift.io/DynamicResourceAllocation.yaml b/config/v1/tests/schedulers.config.openshift.io/DynamicResourceAllocation.yaml
deleted file mode 100644
index 2fab9a1aafd..00000000000
--- a/config/v1/tests/schedulers.config.openshift.io/DynamicResourceAllocation.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1 # Hack because controller-gen complains if we don't have this
-name: "Scheduler"
-crdName: schedulers.config.openshift.io
-featureGates:
-- DynamicResourceAllocation
-tests:
- onCreate:
- - name: Should be able to create a minimal Scheduler
- initial: |
- apiVersion: config.openshift.io/v1
- kind: Scheduler
- spec: {} # No spec is required for a Scheduler
- expected: |
- apiVersion: config.openshift.io/v1
- kind: Scheduler
- spec: {}
diff --git a/config/v1/types_scheduling.go b/config/v1/types_scheduling.go
index c90d5633f68..04717f18614 100644
--- a/config/v1/types_scheduling.go
+++ b/config/v1/types_scheduling.go
@@ -47,10 +47,6 @@ type SchedulerSpec struct {
// Defaults to "LowNodeUtilization"
// +optional
Profile SchedulerProfile `json:"profile,omitempty"`
- // profileCustomizations contains configuration for modifying the default behavior of existing scheduler profiles.
- // +openshift:enable:FeatureGate=DynamicResourceAllocation
- // +optional
- ProfileCustomizations ProfileCustomizations `json:"profileCustomizations"`
// defaultNodeSelector helps set the cluster-wide default node selector to
// restrict pod placement to specific nodes. This is applied to the pods
// created in all namespaces and creates an intersection with any existing
@@ -102,30 +98,6 @@ var (
NoScoring SchedulerProfile = "NoScoring"
)
-// ProfileCustomizations contains various parameters for modifying the default behavior of certain profiles
-type ProfileCustomizations struct {
- // dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- // Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- // Third-party resource drivers are responsible for tracking and allocating resources.
- // Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- // Valid values are Enabled, Disabled and omitted.
- // When omitted, this means no opinion and the platform is left to choose a reasonable default,
- // which is subject to change over time.
- // The current default is Disabled.
- // +optional
- DynamicResourceAllocation DRAEnablement `json:"dynamicResourceAllocation"`
-}
-
-// +kubebuilder:validation:Enum:="";"Enabled";"Disabled"
-type DRAEnablement string
-
-var (
- // DRAEnablementEnabled enables dynamic resource allocation feature
- DRAEnablementEnabled DRAEnablement = "Enabled"
- // DRAEnablementDisabled disables dynamic resource allocation feature
- DRAEnablementDisabled DRAEnablement = "Disabled"
-)
-
type SchedulerStatus struct {
}
diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-CustomNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-CustomNoUpgrade.crd.yaml
deleted file mode 100644
index d058dd7dccc..00000000000
--- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-CustomNoUpgrade.crd.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- annotations:
- api-approved.openshift.io: https://github.com/openshift/api/pull/470
- api.openshift.io/merged-by-featuregates: "true"
- include.release.openshift.io/ibm-cloud-managed: "true"
- include.release.openshift.io/self-managed-high-availability: "true"
- release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: CustomNoUpgrade
- name: schedulers.config.openshift.io
-spec:
- group: config.openshift.io
- names:
- kind: Scheduler
- listKind: SchedulerList
- plural: schedulers
- singular: scheduler
- scope: Cluster
- versions:
- - name: v1
- schema:
- openAPIV3Schema:
- description: |-
- Scheduler holds cluster-wide config information to run the Kubernetes Scheduler
- and influence its placement decisions. The canonical name for this config is `cluster`.
-
- Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- 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
- 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
- type: string
- metadata:
- type: object
- spec:
- description: spec holds user settable values for configuration
- properties:
- defaultNodeSelector:
- description: |-
- defaultNodeSelector helps set the cluster-wide default node selector to
- restrict pod placement to specific nodes. This is applied to the pods
- created in all namespaces and creates an intersection with any existing
- nodeSelectors already set on a pod, additionally constraining that pod's selector.
- For example,
- defaultNodeSelector: "type=user-node,region=east" would set nodeSelector
- field in pod spec to "type=user-node,region=east" to all pods created
- in all namespaces. Namespaces having project-wide node selectors won't be
- impacted even if this field is set. This adds an annotation section to
- the namespace.
- For example, if a new namespace is created with
- node-selector='type=user-node,region=east',
- the annotation openshift.io/node-selector: type=user-node,region=east
- gets added to the project. When the openshift.io/node-selector annotation
- is set on the project the value is used in preference to the value we are setting
- for defaultNodeSelector field.
- For instance,
- openshift.io/node-selector: "type=user-node,region=west" means
- that the default of "type=user-node,region=east" set in defaultNodeSelector
- would not be applied.
- type: string
- mastersSchedulable:
- description: |-
- mastersSchedulable allows masters nodes to be schedulable. When this flag is
- turned on, all the master nodes in the cluster will be made schedulable,
- so that workload pods can run on them. The default value for this field is false,
- meaning none of the master nodes are schedulable.
- Important Note: Once the workload pods start running on the master nodes,
- extreme care must be taken to ensure that cluster-critical control plane components
- are not impacted.
- Please turn on this field after doing due diligence.
- type: boolean
- policy:
- description: |-
- DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release.
- policy is a reference to a ConfigMap containing scheduler policy which has
- user specified predicates and priorities. If this ConfigMap is not available
- scheduler will default to use DefaultAlgorithmProvider.
- The namespace for this configmap is openshift-config.
- properties:
- name:
- description: name is the metadata.name of the referenced config
- map
- type: string
- required:
- - name
- type: object
- profile:
- description: |-
- profile sets which scheduling profile should be set in order to configure scheduling
- decisions for new pods.
-
- Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring"
- Defaults to "LowNodeUtilization"
- enum:
- - ""
- - LowNodeUtilization
- - HighNodeUtilization
- - NoScoring
- type: string
- profileCustomizations:
- description: profileCustomizations contains configuration for modifying
- the default behavior of existing scheduler profiles.
- properties:
- dynamicResourceAllocation:
- description: |-
- dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- Third-party resource drivers are responsible for tracking and allocating resources.
- Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- Valid values are Enabled, Disabled and omitted.
- When omitted, this means no opinion and the platform is left to choose a reasonable default,
- which is subject to change over time.
- The current default is Disabled.
- enum:
- - ""
- - Enabled
- - Disabled
- type: string
- type: object
- type: object
- status:
- description: status holds observed values from the cluster. They may not
- be overridden.
- type: object
- required:
- - spec
- type: object
- served: true
- storage: true
- subresources:
- status: {}
diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-DevPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-DevPreviewNoUpgrade.crd.yaml
deleted file mode 100644
index a62eb09733f..00000000000
--- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-DevPreviewNoUpgrade.crd.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- annotations:
- api-approved.openshift.io: https://github.com/openshift/api/pull/470
- api.openshift.io/merged-by-featuregates: "true"
- include.release.openshift.io/ibm-cloud-managed: "true"
- include.release.openshift.io/self-managed-high-availability: "true"
- release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: DevPreviewNoUpgrade
- name: schedulers.config.openshift.io
-spec:
- group: config.openshift.io
- names:
- kind: Scheduler
- listKind: SchedulerList
- plural: schedulers
- singular: scheduler
- scope: Cluster
- versions:
- - name: v1
- schema:
- openAPIV3Schema:
- description: |-
- Scheduler holds cluster-wide config information to run the Kubernetes Scheduler
- and influence its placement decisions. The canonical name for this config is `cluster`.
-
- Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- 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
- 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
- type: string
- metadata:
- type: object
- spec:
- description: spec holds user settable values for configuration
- properties:
- defaultNodeSelector:
- description: |-
- defaultNodeSelector helps set the cluster-wide default node selector to
- restrict pod placement to specific nodes. This is applied to the pods
- created in all namespaces and creates an intersection with any existing
- nodeSelectors already set on a pod, additionally constraining that pod's selector.
- For example,
- defaultNodeSelector: "type=user-node,region=east" would set nodeSelector
- field in pod spec to "type=user-node,region=east" to all pods created
- in all namespaces. Namespaces having project-wide node selectors won't be
- impacted even if this field is set. This adds an annotation section to
- the namespace.
- For example, if a new namespace is created with
- node-selector='type=user-node,region=east',
- the annotation openshift.io/node-selector: type=user-node,region=east
- gets added to the project. When the openshift.io/node-selector annotation
- is set on the project the value is used in preference to the value we are setting
- for defaultNodeSelector field.
- For instance,
- openshift.io/node-selector: "type=user-node,region=west" means
- that the default of "type=user-node,region=east" set in defaultNodeSelector
- would not be applied.
- type: string
- mastersSchedulable:
- description: |-
- mastersSchedulable allows masters nodes to be schedulable. When this flag is
- turned on, all the master nodes in the cluster will be made schedulable,
- so that workload pods can run on them. The default value for this field is false,
- meaning none of the master nodes are schedulable.
- Important Note: Once the workload pods start running on the master nodes,
- extreme care must be taken to ensure that cluster-critical control plane components
- are not impacted.
- Please turn on this field after doing due diligence.
- type: boolean
- policy:
- description: |-
- DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release.
- policy is a reference to a ConfigMap containing scheduler policy which has
- user specified predicates and priorities. If this ConfigMap is not available
- scheduler will default to use DefaultAlgorithmProvider.
- The namespace for this configmap is openshift-config.
- properties:
- name:
- description: name is the metadata.name of the referenced config
- map
- type: string
- required:
- - name
- type: object
- profile:
- description: |-
- profile sets which scheduling profile should be set in order to configure scheduling
- decisions for new pods.
-
- Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring"
- Defaults to "LowNodeUtilization"
- enum:
- - ""
- - LowNodeUtilization
- - HighNodeUtilization
- - NoScoring
- type: string
- profileCustomizations:
- description: profileCustomizations contains configuration for modifying
- the default behavior of existing scheduler profiles.
- properties:
- dynamicResourceAllocation:
- description: |-
- dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- Third-party resource drivers are responsible for tracking and allocating resources.
- Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- Valid values are Enabled, Disabled and omitted.
- When omitted, this means no opinion and the platform is left to choose a reasonable default,
- which is subject to change over time.
- The current default is Disabled.
- enum:
- - ""
- - Enabled
- - Disabled
- type: string
- type: object
- type: object
- status:
- description: status holds observed values from the cluster. They may not
- be overridden.
- type: object
- required:
- - spec
- type: object
- served: true
- storage: true
- subresources:
- status: {}
diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-TechPreviewNoUpgrade.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-TechPreviewNoUpgrade.crd.yaml
deleted file mode 100644
index 24fbbb3021f..00000000000
--- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-TechPreviewNoUpgrade.crd.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- annotations:
- api-approved.openshift.io: https://github.com/openshift/api/pull/470
- api.openshift.io/merged-by-featuregates: "true"
- include.release.openshift.io/ibm-cloud-managed: "true"
- include.release.openshift.io/self-managed-high-availability: "true"
- release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: TechPreviewNoUpgrade
- name: schedulers.config.openshift.io
-spec:
- group: config.openshift.io
- names:
- kind: Scheduler
- listKind: SchedulerList
- plural: schedulers
- singular: scheduler
- scope: Cluster
- versions:
- - name: v1
- schema:
- openAPIV3Schema:
- description: |-
- Scheduler holds cluster-wide config information to run the Kubernetes Scheduler
- and influence its placement decisions. The canonical name for this config is `cluster`.
-
- Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- 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
- 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
- type: string
- metadata:
- type: object
- spec:
- description: spec holds user settable values for configuration
- properties:
- defaultNodeSelector:
- description: |-
- defaultNodeSelector helps set the cluster-wide default node selector to
- restrict pod placement to specific nodes. This is applied to the pods
- created in all namespaces and creates an intersection with any existing
- nodeSelectors already set on a pod, additionally constraining that pod's selector.
- For example,
- defaultNodeSelector: "type=user-node,region=east" would set nodeSelector
- field in pod spec to "type=user-node,region=east" to all pods created
- in all namespaces. Namespaces having project-wide node selectors won't be
- impacted even if this field is set. This adds an annotation section to
- the namespace.
- For example, if a new namespace is created with
- node-selector='type=user-node,region=east',
- the annotation openshift.io/node-selector: type=user-node,region=east
- gets added to the project. When the openshift.io/node-selector annotation
- is set on the project the value is used in preference to the value we are setting
- for defaultNodeSelector field.
- For instance,
- openshift.io/node-selector: "type=user-node,region=west" means
- that the default of "type=user-node,region=east" set in defaultNodeSelector
- would not be applied.
- type: string
- mastersSchedulable:
- description: |-
- mastersSchedulable allows masters nodes to be schedulable. When this flag is
- turned on, all the master nodes in the cluster will be made schedulable,
- so that workload pods can run on them. The default value for this field is false,
- meaning none of the master nodes are schedulable.
- Important Note: Once the workload pods start running on the master nodes,
- extreme care must be taken to ensure that cluster-critical control plane components
- are not impacted.
- Please turn on this field after doing due diligence.
- type: boolean
- policy:
- description: |-
- DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release.
- policy is a reference to a ConfigMap containing scheduler policy which has
- user specified predicates and priorities. If this ConfigMap is not available
- scheduler will default to use DefaultAlgorithmProvider.
- The namespace for this configmap is openshift-config.
- properties:
- name:
- description: name is the metadata.name of the referenced config
- map
- type: string
- required:
- - name
- type: object
- profile:
- description: |-
- profile sets which scheduling profile should be set in order to configure scheduling
- decisions for new pods.
-
- Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring"
- Defaults to "LowNodeUtilization"
- enum:
- - ""
- - LowNodeUtilization
- - HighNodeUtilization
- - NoScoring
- type: string
- profileCustomizations:
- description: profileCustomizations contains configuration for modifying
- the default behavior of existing scheduler profiles.
- properties:
- dynamicResourceAllocation:
- description: |-
- dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- Third-party resource drivers are responsible for tracking and allocating resources.
- Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- Valid values are Enabled, Disabled and omitted.
- When omitted, this means no opinion and the platform is left to choose a reasonable default,
- which is subject to change over time.
- The current default is Disabled.
- enum:
- - ""
- - Enabled
- - Disabled
- type: string
- type: object
- type: object
- status:
- description: status holds observed values from the cluster. They may not
- be overridden.
- type: object
- required:
- - spec
- type: object
- served: true
- storage: true
- subresources:
- status: {}
diff --git a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-Default.crd.yaml b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers.crd.yaml
similarity index 99%
rename from config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-Default.crd.yaml
rename to config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers.crd.yaml
index 37abbe9a533..96993e1399c 100644
--- a/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers-Default.crd.yaml
+++ b/config/v1/zz_generated.crd-manifests/0000_10_config-operator_01_schedulers.crd.yaml
@@ -7,7 +7,6 @@ metadata:
include.release.openshift.io/ibm-cloud-managed: "true"
include.release.openshift.io/self-managed-high-availability: "true"
release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: Default
name: schedulers.config.openshift.io
spec:
group: config.openshift.io
diff --git a/config/v1/zz_generated.deepcopy.go b/config/v1/zz_generated.deepcopy.go
index 0863934f22a..406dde4aa91 100644
--- a/config/v1/zz_generated.deepcopy.go
+++ b/config/v1/zz_generated.deepcopy.go
@@ -5580,22 +5580,6 @@ func (in *PrefixedClaimMapping) DeepCopy() *PrefixedClaimMapping {
return out
}
-// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
-func (in *ProfileCustomizations) DeepCopyInto(out *ProfileCustomizations) {
- *out = *in
- return
-}
-
-// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProfileCustomizations.
-func (in *ProfileCustomizations) DeepCopy() *ProfileCustomizations {
- if in == nil {
- return nil
- }
- out := new(ProfileCustomizations)
- in.DeepCopyInto(out)
- return out
-}
-
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *Project) DeepCopyInto(out *Project) {
*out = *in
@@ -6076,7 +6060,6 @@ func (in *SchedulerList) DeepCopyObject() runtime.Object {
func (in *SchedulerSpec) DeepCopyInto(out *SchedulerSpec) {
*out = *in
out.Policy = in.Policy
- out.ProfileCustomizations = in.ProfileCustomizations
return
}
diff --git a/config/v1/zz_generated.featuregated-crd-manifests.yaml b/config/v1/zz_generated.featuregated-crd-manifests.yaml
index 03b091ead53..460772cc074 100644
--- a/config/v1/zz_generated.featuregated-crd-manifests.yaml
+++ b/config/v1/zz_generated.featuregated-crd-manifests.yaml
@@ -573,8 +573,7 @@ schedulers.config.openshift.io:
CRDName: schedulers.config.openshift.io
Capability: ""
Category: ""
- FeatureGates:
- - DynamicResourceAllocation
+ FeatureGates: []
FilenameOperatorName: config-operator
FilenameOperatorOrdering: "01"
FilenameRunLevel: "0000_10"
diff --git a/config/v1/zz_generated.featuregated-crd-manifests/schedulers.config.openshift.io/DynamicResourceAllocation.yaml b/config/v1/zz_generated.featuregated-crd-manifests/schedulers.config.openshift.io/DynamicResourceAllocation.yaml
deleted file mode 100644
index 405806d2e96..00000000000
--- a/config/v1/zz_generated.featuregated-crd-manifests/schedulers.config.openshift.io/DynamicResourceAllocation.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- annotations:
- api-approved.openshift.io: https://github.com/openshift/api/pull/470
- api.openshift.io/filename-cvo-runlevel: "0000_10"
- api.openshift.io/filename-operator: config-operator
- api.openshift.io/filename-ordering: "01"
- feature-gate.release.openshift.io/DynamicResourceAllocation: "true"
- release.openshift.io/bootstrap-required: "true"
- name: schedulers.config.openshift.io
-spec:
- group: config.openshift.io
- names:
- kind: Scheduler
- listKind: SchedulerList
- plural: schedulers
- singular: scheduler
- scope: Cluster
- versions:
- - name: v1
- schema:
- openAPIV3Schema:
- description: |-
- Scheduler holds cluster-wide config information to run the Kubernetes Scheduler
- and influence its placement decisions. The canonical name for this config is `cluster`.
-
- Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- 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
- 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
- type: string
- metadata:
- type: object
- spec:
- description: spec holds user settable values for configuration
- properties:
- defaultNodeSelector:
- description: |-
- defaultNodeSelector helps set the cluster-wide default node selector to
- restrict pod placement to specific nodes. This is applied to the pods
- created in all namespaces and creates an intersection with any existing
- nodeSelectors already set on a pod, additionally constraining that pod's selector.
- For example,
- defaultNodeSelector: "type=user-node,region=east" would set nodeSelector
- field in pod spec to "type=user-node,region=east" to all pods created
- in all namespaces. Namespaces having project-wide node selectors won't be
- impacted even if this field is set. This adds an annotation section to
- the namespace.
- For example, if a new namespace is created with
- node-selector='type=user-node,region=east',
- the annotation openshift.io/node-selector: type=user-node,region=east
- gets added to the project. When the openshift.io/node-selector annotation
- is set on the project the value is used in preference to the value we are setting
- for defaultNodeSelector field.
- For instance,
- openshift.io/node-selector: "type=user-node,region=west" means
- that the default of "type=user-node,region=east" set in defaultNodeSelector
- would not be applied.
- type: string
- mastersSchedulable:
- description: |-
- mastersSchedulable allows masters nodes to be schedulable. When this flag is
- turned on, all the master nodes in the cluster will be made schedulable,
- so that workload pods can run on them. The default value for this field is false,
- meaning none of the master nodes are schedulable.
- Important Note: Once the workload pods start running on the master nodes,
- extreme care must be taken to ensure that cluster-critical control plane components
- are not impacted.
- Please turn on this field after doing due diligence.
- type: boolean
- policy:
- description: |-
- DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release.
- policy is a reference to a ConfigMap containing scheduler policy which has
- user specified predicates and priorities. If this ConfigMap is not available
- scheduler will default to use DefaultAlgorithmProvider.
- The namespace for this configmap is openshift-config.
- properties:
- name:
- description: name is the metadata.name of the referenced config
- map
- type: string
- required:
- - name
- type: object
- profile:
- description: |-
- profile sets which scheduling profile should be set in order to configure scheduling
- decisions for new pods.
-
- Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring"
- Defaults to "LowNodeUtilization"
- enum:
- - ""
- - LowNodeUtilization
- - HighNodeUtilization
- - NoScoring
- type: string
- profileCustomizations:
- description: profileCustomizations contains configuration for modifying
- the default behavior of existing scheduler profiles.
- properties:
- dynamicResourceAllocation:
- description: |-
- dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- Third-party resource drivers are responsible for tracking and allocating resources.
- Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- Valid values are Enabled, Disabled and omitted.
- When omitted, this means no opinion and the platform is left to choose a reasonable default,
- which is subject to change over time.
- The current default is Disabled.
- enum:
- - ""
- - Enabled
- - Disabled
- type: string
- type: object
- type: object
- status:
- description: status holds observed values from the cluster. They may not
- be overridden.
- type: object
- required:
- - spec
- type: object
- served: true
- storage: true
- subresources:
- status: {}
diff --git a/config/v1/zz_generated.swagger_doc_generated.go b/config/v1/zz_generated.swagger_doc_generated.go
index be7d462a507..ec0882c2124 100644
--- a/config/v1/zz_generated.swagger_doc_generated.go
+++ b/config/v1/zz_generated.swagger_doc_generated.go
@@ -2864,15 +2864,6 @@ func (ProxyStatus) SwaggerDoc() map[string]string {
return map_ProxyStatus
}
-var map_ProfileCustomizations = map[string]string{
- "": "ProfileCustomizations contains various parameters for modifying the default behavior of certain profiles",
- "dynamicResourceAllocation": "dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler. Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod. Third-party resource drivers are responsible for tracking and allocating resources. Different kinds of resources support arbitrary parameters for defining requirements and initialization. Valid values are Enabled, Disabled and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is Disabled.",
-}
-
-func (ProfileCustomizations) SwaggerDoc() map[string]string {
- return map_ProfileCustomizations
-}
-
var map_Scheduler = map[string]string{
"": "Scheduler holds cluster-wide config information to run the Kubernetes Scheduler and influence its placement decisions. The canonical name for this config is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
@@ -2894,11 +2885,10 @@ func (SchedulerList) SwaggerDoc() map[string]string {
}
var map_SchedulerSpec = map[string]string{
- "policy": "DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release. policy is a reference to a ConfigMap containing scheduler policy which has user specified predicates and priorities. If this ConfigMap is not available scheduler will default to use DefaultAlgorithmProvider. The namespace for this configmap is openshift-config.",
- "profile": "profile sets which scheduling profile should be set in order to configure scheduling decisions for new pods.\n\nValid values are \"LowNodeUtilization\", \"HighNodeUtilization\", \"NoScoring\" Defaults to \"LowNodeUtilization\"",
- "profileCustomizations": "profileCustomizations contains configuration for modifying the default behavior of existing scheduler profiles.",
- "defaultNodeSelector": "defaultNodeSelector helps set the cluster-wide default node selector to restrict pod placement to specific nodes. This is applied to the pods created in all namespaces and creates an intersection with any existing nodeSelectors already set on a pod, additionally constraining that pod's selector. For example, defaultNodeSelector: \"type=user-node,region=east\" would set nodeSelector field in pod spec to \"type=user-node,region=east\" to all pods created in all namespaces. Namespaces having project-wide node selectors won't be impacted even if this field is set. This adds an annotation section to the namespace. For example, if a new namespace is created with node-selector='type=user-node,region=east', the annotation openshift.io/node-selector: type=user-node,region=east gets added to the project. When the openshift.io/node-selector annotation is set on the project the value is used in preference to the value we are setting for defaultNodeSelector field. For instance, openshift.io/node-selector: \"type=user-node,region=west\" means that the default of \"type=user-node,region=east\" set in defaultNodeSelector would not be applied.",
- "mastersSchedulable": "mastersSchedulable allows masters nodes to be schedulable. When this flag is turned on, all the master nodes in the cluster will be made schedulable, so that workload pods can run on them. The default value for this field is false, meaning none of the master nodes are schedulable. Important Note: Once the workload pods start running on the master nodes, extreme care must be taken to ensure that cluster-critical control plane components are not impacted. Please turn on this field after doing due diligence.",
+ "policy": "DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release. policy is a reference to a ConfigMap containing scheduler policy which has user specified predicates and priorities. If this ConfigMap is not available scheduler will default to use DefaultAlgorithmProvider. The namespace for this configmap is openshift-config.",
+ "profile": "profile sets which scheduling profile should be set in order to configure scheduling decisions for new pods.\n\nValid values are \"LowNodeUtilization\", \"HighNodeUtilization\", \"NoScoring\" Defaults to \"LowNodeUtilization\"",
+ "defaultNodeSelector": "defaultNodeSelector helps set the cluster-wide default node selector to restrict pod placement to specific nodes. This is applied to the pods created in all namespaces and creates an intersection with any existing nodeSelectors already set on a pod, additionally constraining that pod's selector. For example, defaultNodeSelector: \"type=user-node,region=east\" would set nodeSelector field in pod spec to \"type=user-node,region=east\" to all pods created in all namespaces. Namespaces having project-wide node selectors won't be impacted even if this field is set. This adds an annotation section to the namespace. For example, if a new namespace is created with node-selector='type=user-node,region=east', the annotation openshift.io/node-selector: type=user-node,region=east gets added to the project. When the openshift.io/node-selector annotation is set on the project the value is used in preference to the value we are setting for defaultNodeSelector field. For instance, openshift.io/node-selector: \"type=user-node,region=west\" means that the default of \"type=user-node,region=east\" set in defaultNodeSelector would not be applied.",
+ "mastersSchedulable": "mastersSchedulable allows masters nodes to be schedulable. When this flag is turned on, all the master nodes in the cluster will be made schedulable, so that workload pods can run on them. The default value for this field is false, meaning none of the master nodes are schedulable. Important Note: Once the workload pods start running on the master nodes, extreme care must be taken to ensure that cluster-critical control plane components are not impacted. Please turn on this field after doing due diligence.",
}
func (SchedulerSpec) SwaggerDoc() map[string]string {
diff --git a/features.md b/features.md
index df45c853f3a..8a87ac99b36 100644
--- a/features.md
+++ b/features.md
@@ -39,7 +39,6 @@
| DNSNameResolver| | | Enabled | Enabled | Enabled | Enabled |
| DualReplica| | | Enabled | Enabled | Enabled | Enabled |
| DyanmicServiceEndpointIBMCloud| | | Enabled | Enabled | Enabled | Enabled |
-| DynamicResourceAllocation| | | Enabled | Enabled | Enabled | Enabled |
| EtcdBackendQuota| | | Enabled | Enabled | Enabled | Enabled |
| EventTTL| | | Enabled | Enabled | Enabled | Enabled |
| Example| | | Enabled | Enabled | Enabled | Enabled |
diff --git a/features/features.go b/features/features.go
index 33e51639c2f..2397363ccd9 100644
--- a/features/features.go
+++ b/features/features.go
@@ -84,14 +84,6 @@ var (
enableIn(configv1.Default, configv1.DevPreviewNoUpgrade, configv1.TechPreviewNoUpgrade).
mustRegister()
- FeatureGateDynamicResourceAllocation = newFeatureGate("DynamicResourceAllocation").
- reportProblemsToJiraComponent("scheduling").
- contactPerson("jchaloup").
- productScope(kubernetes).
- enhancementPR("https://github.com/kubernetes/enhancements/issues/4381").
- enableIn(configv1.DevPreviewNoUpgrade, configv1.TechPreviewNoUpgrade).
- mustRegister()
-
FeatureGateAzureWorkloadIdentity = newFeatureGate("AzureWorkloadIdentity").
reportProblemsToJiraComponent("cloud-credential-operator").
contactPerson("abutcher").
diff --git a/openapi/generated_openapi/zz_generated.openapi.go b/openapi/generated_openapi/zz_generated.openapi.go
index 4085b738481..78d38da1365 100644
--- a/openapi/generated_openapi/zz_generated.openapi.go
+++ b/openapi/generated_openapi/zz_generated.openapi.go
@@ -374,7 +374,6 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
"github.com/openshift/api/config/v1.PowerVSPlatformStatus": schema_openshift_api_config_v1_PowerVSPlatformStatus(ref),
"github.com/openshift/api/config/v1.PowerVSServiceEndpoint": schema_openshift_api_config_v1_PowerVSServiceEndpoint(ref),
"github.com/openshift/api/config/v1.PrefixedClaimMapping": schema_openshift_api_config_v1_PrefixedClaimMapping(ref),
- "github.com/openshift/api/config/v1.ProfileCustomizations": schema_openshift_api_config_v1_ProfileCustomizations(ref),
"github.com/openshift/api/config/v1.Project": schema_openshift_api_config_v1_Project(ref),
"github.com/openshift/api/config/v1.ProjectList": schema_openshift_api_config_v1_ProjectList(ref),
"github.com/openshift/api/config/v1.ProjectSpec": schema_openshift_api_config_v1_ProjectSpec(ref),
@@ -18965,27 +18964,6 @@ func schema_openshift_api_config_v1_PrefixedClaimMapping(ref common.ReferenceCal
}
}
-func schema_openshift_api_config_v1_ProfileCustomizations(ref common.ReferenceCallback) common.OpenAPIDefinition {
- return common.OpenAPIDefinition{
- Schema: spec.Schema{
- SchemaProps: spec.SchemaProps{
- Description: "ProfileCustomizations contains various parameters for modifying the default behavior of certain profiles",
- Type: []string{"object"},
- Properties: map[string]spec.Schema{
- "dynamicResourceAllocation": {
- SchemaProps: spec.SchemaProps{
- Description: "dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler. Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod. Third-party resource drivers are responsible for tracking and allocating resources. Different kinds of resources support arbitrary parameters for defining requirements and initialization. Valid values are Enabled, Disabled and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is Disabled.",
- Default: "",
- Type: []string{"string"},
- Format: "",
- },
- },
- },
- },
- },
- }
-}
-
func schema_openshift_api_config_v1_Project(ref common.ReferenceCallback) common.OpenAPIDefinition {
return common.OpenAPIDefinition{
Schema: spec.Schema{
@@ -19943,13 +19921,6 @@ func schema_openshift_api_config_v1_SchedulerSpec(ref common.ReferenceCallback)
Format: "",
},
},
- "profileCustomizations": {
- SchemaProps: spec.SchemaProps{
- Description: "profileCustomizations contains configuration for modifying the default behavior of existing scheduler profiles.",
- Default: map[string]interface{}{},
- Ref: ref("github.com/openshift/api/config/v1.ProfileCustomizations"),
- },
- },
"defaultNodeSelector": {
SchemaProps: spec.SchemaProps{
Description: "defaultNodeSelector helps set the cluster-wide default node selector to restrict pod placement to specific nodes. This is applied to the pods created in all namespaces and creates an intersection with any existing nodeSelectors already set on a pod, additionally constraining that pod's selector. For example, defaultNodeSelector: \"type=user-node,region=east\" would set nodeSelector field in pod spec to \"type=user-node,region=east\" to all pods created in all namespaces. Namespaces having project-wide node selectors won't be impacted even if this field is set. This adds an annotation section to the namespace. For example, if a new namespace is created with node-selector='type=user-node,region=east', the annotation openshift.io/node-selector: type=user-node,region=east gets added to the project. When the openshift.io/node-selector annotation is set on the project the value is used in preference to the value we are setting for defaultNodeSelector field. For instance, openshift.io/node-selector: \"type=user-node,region=west\" means that the default of \"type=user-node,region=east\" set in defaultNodeSelector would not be applied.",
@@ -19969,7 +19940,7 @@ func schema_openshift_api_config_v1_SchedulerSpec(ref common.ReferenceCallback)
},
},
Dependencies: []string{
- "github.com/openshift/api/config/v1.ConfigMapNameReference", "github.com/openshift/api/config/v1.ProfileCustomizations"},
+ "github.com/openshift/api/config/v1.ConfigMapNameReference"},
}
}
diff --git a/openapi/openapi.json b/openapi/openapi.json
index 86d5da21ac4..5b01eff5e71 100644
--- a/openapi/openapi.json
+++ b/openapi/openapi.json
@@ -6,8 +6,8 @@
},
"paths": null,
"definitions": {
- "com.github.openshift.api.apiserver.v1.APIRequestCount": {
- "description": "APIRequestCount tracks requests made to an API. The instance name must be of the form `resource.version.group`, matching the resource.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.APIServer": {
+ "description": "APIServer holds configuration (like serving certificates, client CA and CORS domains) shared by all API servers in the system, among them especially kube-apiserver and openshift-apiserver. The canonical name of an instance is 'cluster'.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"spec"
@@ -27,19 +27,41 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec defines the characteristics of the resource.",
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.APIRequestCountSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerSpec"
},
"status": {
- "description": "status contains the observed state of the resource.",
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.APIRequestCountStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerStatus"
}
}
},
- "com.github.openshift.api.apiserver.v1.APIRequestCountList": {
- "description": "APIRequestCountList is a list of APIRequestCount resources.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.APIServerEncryption": {
+ "description": "APIServerEncryption is used to encrypt sensitive resources on the cluster.",
+ "type": "object",
+ "properties": {
+ "kms": {
+ "description": "kms defines the configuration for the external KMS instance that manages the encryption keys, when KMS encryption is enabled sensitive resources will be encrypted using keys managed by an externally configured KMS instance.\n\nThe Key Management Service (KMS) instance provides symmetric encryption and is responsible for managing the lifecyle of the encryption keys outside of the control plane. This allows integration with an external provider to manage the data encryption keys securely.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.KMSConfig"
+ },
+ "type": {
+ "description": "type defines what encryption type should be used to encrypt resources at the datastore layer. When this field is unset (i.e. when it is set to the empty string), identity is implied. The behavior of unset can and will change over time. Even if encryption is enabled by default, the meaning of unset may change to a different encryption type based on changes in best practices.\n\nWhen encryption is enabled, all sensitive resources shipped with the platform are encrypted. This list of sensitive resources can and will change over time. The current authoritative list is:\n\n 1. secrets\n 2. configmaps\n 3. routes.route.openshift.io\n 4. oauthaccesstokens.oauth.openshift.io\n 5. oauthauthorizetokens.oauth.openshift.io",
+ "type": "string"
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {
+ "kms": "KMS"
+ }
+ }
+ ]
+ },
+ "com.github.openshift.api.config.v1.APIServerList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -54,7 +76,7 @@
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.APIRequestCount"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServer"
}
},
"kind": {
@@ -68,266 +90,448 @@
}
}
},
- "com.github.openshift.api.apiserver.v1.APIRequestCountSpec": {
+ "com.github.openshift.api.config.v1.APIServerNamedServingCert": {
+ "description": "APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate.",
"type": "object",
+ "required": [
+ "servingCertificate"
+ ],
"properties": {
- "numberOfUsersToReport": {
- "description": "numberOfUsersToReport is the number of users to include in the report. If unspecified or zero, the default is ten. This is default is subject to change.",
- "type": "integer",
- "format": "int64",
- "default": 0
+ "names": {
+ "description": "names is a optional list of explicit DNS names (leading wildcards allowed) that should use this certificate to serve secure traffic. If no names are provided, the implicit names will be extracted from the certificates. Exact names trump over wildcard names. Explicit names defined here trump over extracted implicit names.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "servingCertificate": {
+ "description": "servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic. The secret must exist in the openshift-config namespace and contain the following required fields: - Secret.Data[\"tls.key\"] - TLS private key. - Secret.Data[\"tls.crt\"] - TLS certificate.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
}
}
},
- "com.github.openshift.api.apiserver.v1.APIRequestCountStatus": {
+ "com.github.openshift.api.config.v1.APIServerServingCerts": {
"type": "object",
- "required": [
- "requestCount"
- ],
"properties": {
- "conditions": {
- "description": "conditions contains details of the current status of this API Resource.",
+ "namedCertificates": {
+ "description": "namedCertificates references secrets containing the TLS cert info for serving secure traffic to specific hostnames. If no named certificates are provided, or no named certificates match the server name as understood by a client, the defaultServingCertificate will be used.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerNamedServingCert"
},
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
+ "x-kubernetes-list-type": "atomic"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.APIServerSpec": {
+ "type": "object",
+ "properties": {
+ "additionalCORSAllowedOrigins": {
+ "description": "additionalCORSAllowedOrigins lists additional, user-defined regular expressions describing hosts for which the API server allows access using the CORS headers. This may be needed to access the API and the integrated OAuth server from JavaScript applications. The values are regular expressions that correspond to the Golang regular expression language.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "currentHour": {
- "description": "currentHour contains request history for the current hour. This is porcelain to make the API easier to read by humans seeing if they addressed a problem. This field is reset on the hour.",
+ "audit": {
+ "description": "audit specifies the settings for audit configuration to be applied to all OpenShift-provided API servers in the cluster.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.PerResourceAPIRequestLog"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Audit"
},
- "last24h": {
- "description": "last24h contains request history for the last 24 hours, indexed by the hour, so 12:00AM-12:59 is in index 0, 6am-6:59am is index 6, etc. The index of the current hour is updated live and then duplicated into the requestsLastHour field.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.PerResourceAPIRequestLog"
- }
+ "clientCA": {
+ "description": "clientCA references a ConfigMap containing a certificate bundle for the signers that will be recognized for incoming client certificates in addition to the operator managed signers. If this is empty, then only operator managed signers are valid. You usually only have to set this if you have your own PKI you wish to honor client certificates from. The ConfigMap must exist in the openshift-config namespace and contain the following required fields: - ConfigMap.Data[\"ca-bundle.crt\"] - CA bundle.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "removedInRelease": {
- "description": "removedInRelease is when the API will be removed.",
- "type": "string"
+ "encryption": {
+ "description": "encryption allows the configuration of encryption of resources at the datastore layer.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerEncryption"
},
- "requestCount": {
- "description": "requestCount is a sum of all requestCounts across all current hours, nodes, and users.",
- "type": "integer",
- "format": "int64",
- "default": 0
+ "servingCerts": {
+ "description": "servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates will be used for serving secure traffic.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerServingCerts"
+ },
+ "tlsSecurityProfile": {
+ "description": "tlsSecurityProfile specifies settings for TLS connections for externally exposed servers.\n\nWhen omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is the Intermediate profile.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TLSSecurityProfile"
}
}
},
- "com.github.openshift.api.apiserver.v1.PerNodeAPIRequestLog": {
- "description": "PerNodeAPIRequestLog contains logs of requests to a certain node.",
+ "com.github.openshift.api.config.v1.APIServerStatus": {
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.AWSDNSSpec": {
+ "description": "AWSDNSSpec contains DNS configuration specific to the Amazon Web Services cloud provider.",
"type": "object",
- "required": [
- "nodeName",
- "requestCount",
- "byUser"
- ],
"properties": {
- "byUser": {
- "description": "byUser contains request details by top .spec.numberOfUsersToReport users. Note that because in the case of an apiserver, restart the list of top users is determined on a best-effort basis, the list might be imprecise. In addition, some system users may be explicitly included in the list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.PerUserAPIRequestCount"
- }
- },
- "nodeName": {
- "description": "nodeName where the request are being handled.",
+ "privateZoneIAMRole": {
+ "description": "privateZoneIAMRole contains the ARN of an IAM role that should be assumed when performing operations on the cluster's private hosted zone specified in the cluster DNS config. When left empty, no role should be assumed.",
"type": "string",
"default": ""
- },
- "requestCount": {
- "description": "requestCount is a sum of all requestCounts across all users, even those outside of the top 10 users.",
- "type": "integer",
- "format": "int64",
- "default": 0
}
}
},
- "com.github.openshift.api.apiserver.v1.PerResourceAPIRequestLog": {
- "description": "PerResourceAPIRequestLog logs request for various nodes.",
+ "com.github.openshift.api.config.v1.AWSIngressSpec": {
+ "description": "AWSIngressSpec holds the desired state of the Ingress for Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.",
"type": "object",
"required": [
- "requestCount"
+ "type"
],
"properties": {
- "byNode": {
- "description": "byNode contains logs of requests per node.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.PerNodeAPIRequestLog"
- }
- },
- "requestCount": {
- "description": "requestCount is a sum of all requestCounts across nodes.",
- "type": "integer",
- "format": "int64",
- "default": 0
+ "type": {
+ "description": "type allows user to set a load balancer type. When this field is set the default ingresscontroller will get created using the specified LBType. If this field is not set then the default ingress controller of LBType Classic will be created. Valid values are:\n\n* \"Classic\": A Classic Load Balancer that makes routing decisions at either\n the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See\n the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb\n\n* \"NLB\": A Network Load Balancer that makes routing decisions at the\n transport layer (TCP/SSL). See the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb",
+ "type": "string",
+ "default": ""
}
- }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {}
+ }
+ ]
},
- "com.github.openshift.api.apiserver.v1.PerUserAPIRequestCount": {
- "description": "PerUserAPIRequestCount contains logs of a user's requests.",
+ "com.github.openshift.api.config.v1.AWSKMSConfig": {
+ "description": "AWSKMSConfig defines the KMS config specific to AWS KMS provider",
"type": "object",
"required": [
- "username",
- "userAgent",
- "requestCount",
- "byVerb"
+ "keyARN",
+ "region"
],
"properties": {
- "byVerb": {
- "description": "byVerb details by verb.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apiserver.v1.PerVerbAPIRequestCount"
- }
- },
- "requestCount": {
- "description": "requestCount of requests by the user across all verbs.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "userAgent": {
- "description": "userAgent that made the request. The same user often has multiple binaries which connect (pods with many containers). The different binaries will have different userAgents, but the same user. In addition, we have userAgents with version information embedded and the userName isn't likely to change.",
+ "keyARN": {
+ "description": "keyARN specifies the Amazon Resource Name (ARN) of the AWS KMS key used for encryption. The value must adhere to the format `arn:aws:kms:::key/`, where: - `` is the AWS region consisting of lowercase letters and hyphens followed by a number. - `` is a 12-digit numeric identifier for the AWS account. - `` is a unique identifier for the KMS key, consisting of lowercase hexadecimal characters and hyphens.",
"type": "string",
"default": ""
},
- "username": {
- "description": "username that made the request.",
+ "region": {
+ "description": "region specifies the AWS region where the KMS instance exists, and follows the format `--`, e.g.: `us-east-1`. Only lowercase letters and hyphens followed by numbers are allowed.",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.apiserver.v1.PerVerbAPIRequestCount": {
- "description": "PerVerbAPIRequestCount requestCounts requests by API request verb.",
+ "com.github.openshift.api.config.v1.AWSPlatformSpec": {
+ "description": "AWSPlatformSpec holds the desired state of the Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.",
"type": "object",
- "required": [
- "verb",
- "requestCount"
- ],
"properties": {
- "requestCount": {
- "description": "requestCount of requests for verb.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "verb": {
- "description": "verb of API request (get, list, create, etc...)",
- "type": "string",
- "default": ""
+ "serviceEndpoints": {
+ "description": "serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSServiceEndpoint"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.apps.v1.CustomDeploymentStrategyParams": {
- "description": "CustomDeploymentStrategyParams are the input to the Custom deployment strategy.",
+ "com.github.openshift.api.config.v1.AWSPlatformStatus": {
+ "description": "AWSPlatformStatus holds the current status of the Amazon Web Services infrastructure provider.",
"type": "object",
+ "required": [
+ "region"
+ ],
"properties": {
- "command": {
- "description": "command is optional and overrides CMD in the container Image.",
+ "cloudLoadBalancerConfig": {
+ "description": "cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer.",
+ "default": {
+ "dnsType": "PlatformDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerConfig"
+ },
+ "ipFamily": {
+ "description": "ipFamily specifies the IP protocol family that should be used for AWS network resources. This controls whether AWS resources are created with IPv4-only, or dual-stack networking with IPv4 or IPv6 as the primary protocol family.",
+ "type": "string",
+ "default": "IPv4"
+ },
+ "region": {
+ "description": "region holds the default AWS region for new AWS resources created by the cluster.",
+ "type": "string",
+ "default": ""
+ },
+ "resourceTags": {
+ "description": "resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.",
"type": "array",
"items": {
- "type": "string",
- "default": ""
- }
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSResourceTag"
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "environment": {
- "description": "environment holds the environment which will be given to the container for Image.",
+ "serviceEndpoints": {
+ "description": "serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "image": {
- "description": "image specifies a container image which can carry out a deployment.",
- "type": "string"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSServiceEndpoint"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.apps.v1.DeploymentCause": {
- "description": "DeploymentCause captures information about a particular cause of a deployment.",
+ "com.github.openshift.api.config.v1.AWSResourceTag": {
+ "description": "AWSResourceTag is a tag to apply to AWS resources created for the cluster.",
"type": "object",
"required": [
- "type"
+ "key",
+ "value"
],
"properties": {
- "imageTrigger": {
- "description": "imageTrigger contains the image trigger details, if this trigger was fired based on an image change",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentCauseImageTrigger"
+ "key": {
+ "description": "key sets the key of the AWS resource tag key-value pair. Key is required when defining an AWS resource tag. Key should consist of between 1 and 128 characters, and may contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'.",
+ "type": "string",
+ "default": ""
},
- "type": {
- "description": "type of the trigger that resulted in the creation of a new deployment",
+ "value": {
+ "description": "value sets the value of the AWS resource tag key-value pair. Value is required when defining an AWS resource tag. Value should consist of between 1 and 256 characters, and may contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services.",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.apps.v1.DeploymentCauseImageTrigger": {
- "description": "DeploymentCauseImageTrigger represents details about the cause of a deployment originating from an image change trigger",
+ "com.github.openshift.api.config.v1.AWSServiceEndpoint": {
+ "description": "AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.",
"type": "object",
"required": [
- "from"
+ "name",
+ "url"
],
"properties": {
- "from": {
- "description": "from is a reference to the changed object which triggered a deployment. The field may have the kinds DockerImage, ImageStreamTag, or ImageStreamImage.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
+ "name": {
+ "description": "name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.",
+ "type": "string",
+ "default": ""
+ },
+ "url": {
+ "description": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.apps.v1.DeploymentCondition": {
- "description": "DeploymentCondition describes the state of a deployment config at a certain point.",
+ "com.github.openshift.api.config.v1.AdmissionConfig": {
+ "type": "object",
+ "properties": {
+ "disabledPlugins": {
+ "description": "disabledPlugins is a list of admission plugins that must be off. Putting something in this list is almost always a mistake and likely to result in cluster instability.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "enabledPlugins": {
+ "description": "enabledPlugins is a list of admission plugins that must be on in addition to the default list. Some admission plugins are disabled by default, but certain configurations require them. This is fairly uncommon and can result in performance penalties and unexpected behavior.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "pluginConfig": {
+ "type": "object",
+ "additionalProperties": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AdmissionPluginConfig"
+ }
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.AdmissionPluginConfig": {
+ "description": "AdmissionPluginConfig holds the necessary configuration options for admission plugins",
"type": "object",
"required": [
- "type",
- "status"
+ "location",
+ "configuration"
],
"properties": {
- "lastTransitionTime": {
- "description": "The last time the condition transitioned from one status to another.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
+ "configuration": {
+ "description": "configuration is an embedded configuration object to be used as the plugin's configuration. If present, it will be used instead of the path to the configuration file.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
},
- "lastUpdateTime": {
- "description": "The last time this condition was updated.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
+ "location": {
+ "description": "location is the path to a configuration file that contains the plugin's configuration",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.AlibabaCloudPlatformSpec": {
+ "description": "AlibabaCloudPlatformSpec holds the desired state of the Alibaba Cloud infrastructure provider. This only includes fields that can be modified in the cluster.",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.AlibabaCloudPlatformStatus": {
+ "description": "AlibabaCloudPlatformStatus holds the current status of the Alibaba Cloud infrastructure provider.",
+ "type": "object",
+ "required": [
+ "region"
+ ],
+ "properties": {
+ "region": {
+ "description": "region specifies the region for Alibaba Cloud resources created for the cluster.",
+ "type": "string",
+ "default": ""
},
- "message": {
- "description": "A human readable message indicating details about the transition.",
+ "resourceGroupID": {
+ "description": "resourceGroupID is the ID of the resource group for the cluster.",
"type": "string"
},
- "reason": {
- "description": "The reason for the condition's last transition.",
+ "resourceTags": {
+ "description": "resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AlibabaCloudResourceTag"
+ },
+ "x-kubernetes-list-map-keys": [
+ "key"
+ ],
+ "x-kubernetes-list-type": "map"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.AlibabaCloudResourceTag": {
+ "description": "AlibabaCloudResourceTag is the set of tags to add to apply to resources.",
+ "type": "object",
+ "required": [
+ "key",
+ "value"
+ ],
+ "properties": {
+ "key": {
+ "description": "key is the key of the tag.",
+ "type": "string",
+ "default": ""
+ },
+ "value": {
+ "description": "value is the value of the tag.",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.Audit": {
+ "type": "object",
+ "properties": {
+ "customRules": {
+ "description": "customRules specify profiles per group. These profile take precedence over the top-level profile field if they apply. They are evaluation from top to bottom and the first one that matches, applies.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AuditCustomRule"
+ },
+ "x-kubernetes-list-map-keys": [
+ "group"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "profile": {
+ "description": "profile specifies the name of the desired top-level audit profile to be applied to all requests sent to any of the OpenShift-provided API servers in the cluster (kube-apiserver, openshift-apiserver and oauth-apiserver), with the exception of those requests that match one or more of the customRules.\n\nThe following profiles are provided: - Default: default policy which means MetaData level logging with the exception of events\n (not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody\n level).\n- WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.\n\nWarning: It is not recommended to disable audit logging by using the `None` profile unless you are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues. If you disable audit logging and a support situation arises, you might need to enable audit logging and reproduce the issue in order to troubleshoot properly.\n\nIf unset, the 'Default' profile is used as the default.",
"type": "string"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.AuditConfig": {
+ "description": "AuditConfig holds configuration for the audit capabilities",
+ "type": "object",
+ "required": [
+ "enabled",
+ "auditFilePath",
+ "maximumFileRetentionDays",
+ "maximumRetainedFiles",
+ "maximumFileSizeMegabytes",
+ "policyFile",
+ "policyConfiguration",
+ "logFormat",
+ "webHookKubeConfig",
+ "webHookMode"
+ ],
+ "properties": {
+ "auditFilePath": {
+ "description": "All requests coming to the apiserver will be logged to this file.",
+ "type": "string",
+ "default": ""
},
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
+ "enabled": {
+ "description": "If this flag is set, audit log will be printed in the logs. The logs contains, method, user and a requested URL.",
+ "type": "boolean",
+ "default": false
+ },
+ "logFormat": {
+ "description": "Format of saved audits (legacy or json).",
"type": "string",
"default": ""
},
- "type": {
- "description": "type of deployment condition.",
+ "maximumFileRetentionDays": {
+ "description": "Maximum number of days to retain old log files based on the timestamp encoded in their filename.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ "maximumFileSizeMegabytes": {
+ "description": "Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ "maximumRetainedFiles": {
+ "description": "Maximum number of old log files to retain.",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ },
+ "policyConfiguration": {
+ "description": "policyConfiguration is an embedded policy configuration object to be used as the audit policy configuration. If present, it will be used instead of the path to the policy file.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ },
+ "policyFile": {
+ "description": "policyFile is a path to the file that defines the audit policy configuration.",
+ "type": "string",
+ "default": ""
+ },
+ "webHookKubeConfig": {
+ "description": "Path to a .kubeconfig formatted file that defines the audit webhook configuration.",
+ "type": "string",
+ "default": ""
+ },
+ "webHookMode": {
+ "description": "Strategy for sending audit events (block or batch).",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.AuditCustomRule": {
+ "description": "AuditCustomRule describes a custom rule for an audit profile that takes precedence over the top-level profile.",
+ "type": "object",
+ "required": [
+ "group",
+ "profile"
+ ],
+ "properties": {
+ "group": {
+ "description": "group is a name of group a request user must be member of in order to this profile to apply.",
+ "type": "string",
+ "default": ""
+ },
+ "profile": {
+ "description": "profile specifies the name of the desired audit policy configuration to be deployed to all OpenShift-provided API servers in the cluster.\n\nThe following profiles are provided: - Default: the existing default policy. - WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.\n\nIf unset, the 'Default' profile is used as the default.",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.apps.v1.DeploymentConfig": {
- "description": "Deployment Configs define the template for a pod and manages deploying new images or configuration changes. A single deployment configuration is usually analogous to a single micro-service. Can support many different deployment patterns, including full restart, customizable rolling updates, and fully custom behaviors, as well as pre- and post- deployment hooks. Each individual deployment is represented as a replication controller.\n\nA deployment is \"triggered\" when its configuration is changed or a tag in an Image Stream is changed. Triggers can be disabled to allow manual control over a deployment. The \"strategy\" determines how the deployment is carried out and may be changed at any time. The `latestVersion` field is updated when a new deployment is triggered by any means.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Deprecated: Use deployments or other means for declarative updates for pods instead.",
+ "com.github.openshift.api.config.v1.Authentication": {
+ "description": "Authentication specifies cluster-wide settings for authentication (like OAuth and webhook token authenticators). The canonical name of an instance is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"spec"
@@ -347,21 +551,22 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec represents a desired deployment state and how to deploy to it.",
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentConfigSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AuthenticationSpec"
},
"status": {
- "description": "status represents the current deployment state.",
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentConfigStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AuthenticationStatus"
}
}
},
- "com.github.openshift.api.apps.v1.DeploymentConfigList": {
- "description": "DeploymentConfigList is a collection of deployment configs.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.AuthenticationList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -370,11 +575,10 @@
"type": "string"
},
"items": {
- "description": "items is a list of deployment configs",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentConfig"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Authentication"
}
},
"kind": {
@@ -388,31700 +592,286 @@
}
}
},
- "com.github.openshift.api.apps.v1.DeploymentConfigRollback": {
- "description": "DeploymentConfigRollback provides the input to rollback generation.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.AuthenticationSpec": {
"type": "object",
- "required": [
- "name",
- "spec"
- ],
"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",
- "type": "string"
+ "oauthMetadata": {
+ "description": "oauthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for an external OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 If oauthMetadata.name is non-empty, this value has precedence over any metadata reference stored in status. The key \"oauthMetadata\" is used to locate the data. If specified and the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "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",
- "type": "string"
+ "oidcProviders": {
+ "description": "oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if \"Type\" is set to \"OIDC\".\n\nAt most one provider can be configured.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCProvider"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
},
- "name": {
- "description": "name of the deployment config that will be rolled back.",
+ "serviceAccountIssuer": {
+ "description": "serviceAccountIssuer is the identifier of the bound service account token issuer. The default is https://kubernetes.default.svc WARNING: Updating this field will not result in immediate invalidation of all bound tokens with the previous issuer value. Instead, the tokens issued by previous service account issuer will continue to be trusted for a time period chosen by the platform (currently set to 24h). This time period is subject to change over time. This allows internal components to transition to use new service account issuer without service distruption.",
"type": "string",
"default": ""
},
- "spec": {
- "description": "spec defines the options to rollback generation.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentConfigRollbackSpec"
+ "type": {
+ "description": "type identifies the cluster managed, user facing authentication mode in use. Specifically, it manages the component that responds to login attempts. The default is IntegratedOAuth.",
+ "type": "string",
+ "default": ""
},
- "updatedAnnotations": {
- "description": "updatedAnnotations is a set of new annotations that will be added in the deployment config.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentConfigRollbackSpec": {
- "description": "DeploymentConfigRollbackSpec represents the options for rollback generation.",
- "type": "object",
- "required": [
- "from",
- "includeTriggers",
- "includeTemplate",
- "includeReplicationMeta",
- "includeStrategy"
- ],
- "properties": {
- "from": {
- "description": "from points to a ReplicationController which is a deployment.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "includeReplicationMeta": {
- "description": "includeReplicationMeta specifies whether to include the replica count and selector.",
- "type": "boolean",
- "default": false
- },
- "includeStrategy": {
- "description": "includeStrategy specifies whether to include the deployment Strategy.",
- "type": "boolean",
- "default": false
- },
- "includeTemplate": {
- "description": "includeTemplate specifies whether to include the PodTemplateSpec.",
- "type": "boolean",
- "default": false
- },
- "includeTriggers": {
- "description": "includeTriggers specifies whether to include config Triggers.",
- "type": "boolean",
- "default": false
- },
- "revision": {
- "description": "revision to rollback to. If set to 0, rollback to the last revision.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentConfigSpec": {
- "description": "DeploymentConfigSpec represents the desired state of the deployment.",
- "type": "object",
- "properties": {
- "minReadySeconds": {
- "description": "minReadySeconds is the minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)",
- "type": "integer",
- "format": "int32"
- },
- "paused": {
- "description": "paused indicates that the deployment config is paused resulting in no new deployments on template changes or changes in the template caused by other triggers.",
- "type": "boolean"
- },
- "replicas": {
- "description": "replicas is the number of desired replicas.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "revisionHistoryLimit": {
- "description": "revisionHistoryLimit is the number of old ReplicationControllers to retain to allow for rollbacks. This field is a pointer to allow for differentiation between an explicit zero and not specified. Defaults to 10. (This only applies to DeploymentConfigs created via the new group API resource, not the legacy resource.)",
- "type": "integer",
- "format": "int32"
- },
- "selector": {
- "description": "selector is a label query over pods that should match the Replicas count.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "strategy": {
- "description": "strategy describes how a deployment is executed.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentStrategy"
- },
- "template": {
- "description": "template is the object that describes the pod that will be created if insufficient replicas are detected.",
- "$ref": "#/definitions/io.k8s.api.core.v1.PodTemplateSpec"
- },
- "test": {
- "description": "test ensures that this deployment config will have zero replicas except while a deployment is running. This allows the deployment config to be used as a continuous deployment test - triggering on images, running the deployment, and then succeeding or failing. Post strategy hooks and After actions can be used to integrate successful deployment with an action.",
- "type": "boolean",
- "default": false
- },
- "triggers": {
- "description": "triggers determine how updates to a DeploymentConfig result in new deployments. If no triggers are defined, a new deployment can only occur as a result of an explicit client update to the DeploymentConfig with a new LatestVersion. If null, defaults to having a config change trigger.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentTriggerPolicy"
- }
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentConfigStatus": {
- "description": "DeploymentConfigStatus represents the current deployment state.",
- "type": "object",
- "properties": {
- "availableReplicas": {
- "description": "availableReplicas is the total number of available pods targeted by this deployment config.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "conditions": {
- "description": "conditions represents the latest available observations of a deployment config's current state.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentCondition"
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "details": {
- "description": "details are the reasons for the update to this deployment config. This could be based on a change made by the user or caused by an automatic trigger",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentDetails"
- },
- "latestVersion": {
- "description": "latestVersion is used to determine whether the current deployment associated with a deployment config is out of sync.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "observedGeneration": {
- "description": "observedGeneration is the most recent generation observed by the deployment config controller.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "readyReplicas": {
- "description": "Total number of ready pods targeted by this deployment.",
- "type": "integer",
- "format": "int32"
- },
- "replicas": {
- "description": "replicas is the total number of pods targeted by this deployment config.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "unavailableReplicas": {
- "description": "unavailableReplicas is the total number of unavailable pods targeted by this deployment config.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "updatedReplicas": {
- "description": "updatedReplicas is the total number of non-terminated pods targeted by this deployment config that have the desired template spec.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentDetails": {
- "description": "DeploymentDetails captures information about the causes of a deployment.",
- "type": "object",
- "required": [
- "causes"
- ],
- "properties": {
- "causes": {
- "description": "causes are extended data associated with all the causes for creating a new deployment",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentCause"
- }
- },
- "message": {
- "description": "message is the user specified change message, if this deployment was triggered manually by the user",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentLog": {
- "description": "DeploymentLog represents the logs for a deployment\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentLogOptions": {
- "description": "DeploymentLogOptions is the REST options for a deployment log\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "container": {
- "description": "The container for which to stream logs. Defaults to only container if there is one container in the pod.",
- "type": "string"
- },
- "follow": {
- "description": "follow if true indicates that the build log should be streamed until the build terminates.",
- "type": "boolean"
- },
- "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",
- "type": "string"
- },
- "limitBytes": {
- "description": "If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.",
- "type": "integer",
- "format": "int64"
- },
- "nowait": {
- "description": "nowait if true causes the call to return immediately even if the deployment is not available yet. Otherwise the server will wait until the deployment has started.",
- "type": "boolean"
- },
- "previous": {
- "description": "Return previous deployment logs. Defaults to false.",
- "type": "boolean"
- },
- "sinceSeconds": {
- "description": "A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.",
- "type": "integer",
- "format": "int64"
- },
- "sinceTime": {
- "description": "An RFC3339 timestamp from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "tailLines": {
- "description": "If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime",
- "type": "integer",
- "format": "int64"
- },
- "timestamps": {
- "description": "If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.",
- "type": "boolean"
- },
- "version": {
- "description": "version of the deployment for which to view logs.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentRequest": {
- "description": "DeploymentRequest is a request to a deployment config for a new deployment.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "name",
- "latest",
- "force"
- ],
- "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",
- "type": "string"
- },
- "excludeTriggers": {
- "description": "excludeTriggers instructs the instantiator to avoid processing the specified triggers. This field overrides the triggers from latest and allows clients to control specific logic. This field is ignored if not specified.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "force": {
- "description": "force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error.",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "latest": {
- "description": "latest will update the deployment config with the latest state from all triggers.",
- "type": "boolean",
- "default": false
- },
- "name": {
- "description": "name of the deployment config for requesting a new deployment.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentStrategy": {
- "description": "DeploymentStrategy describes how to perform a deployment.",
- "type": "object",
- "properties": {
- "activeDeadlineSeconds": {
- "description": "activeDeadlineSeconds is the duration in seconds that the deployer pods for this deployment config may be active on a node before the system actively tries to terminate them.",
- "type": "integer",
- "format": "int64"
- },
- "annotations": {
- "description": "annotations is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "customParams": {
- "description": "customParams are the input to the Custom deployment strategy, and may also be specified for the Recreate and Rolling strategies to customize the execution process that runs the deployment.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.CustomDeploymentStrategyParams"
- },
- "labels": {
- "description": "labels is a set of key, value pairs added to custom deployer and lifecycle pre/post hook pods.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "recreateParams": {
- "description": "recreateParams are the input to the Recreate deployment strategy.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.RecreateDeploymentStrategyParams"
- },
- "resources": {
- "description": "resources contains resource requirements to execute the deployment and any hooks.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
- },
- "rollingParams": {
- "description": "rollingParams are the input to the Rolling deployment strategy.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.RollingDeploymentStrategyParams"
- },
- "type": {
- "description": "type is the name of a deployment strategy.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentTriggerImageChangeParams": {
- "description": "DeploymentTriggerImageChangeParams represents the parameters to the ImageChange trigger.",
- "type": "object",
- "required": [
- "from"
- ],
- "properties": {
- "automatic": {
- "description": "automatic means that the detection of a new tag value should result in an image update inside the pod template.",
- "type": "boolean"
- },
- "containerNames": {
- "description": "containerNames is used to restrict tag updates to the specified set of container names in a pod. If multiple triggers point to the same containers, the resulting behavior is undefined. Future API versions will make this a validation error. If ContainerNames does not point to a valid container, the trigger will be ignored. Future API versions will make this a validation error.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "from": {
- "description": "from is a reference to an image stream tag to watch for changes. From.Name is the only required subfield - if From.Namespace is blank, the namespace of the current deployment trigger will be used.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "lastTriggeredImage": {
- "description": "lastTriggeredImage is the last image to be triggered.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.apps.v1.DeploymentTriggerPolicy": {
- "description": "DeploymentTriggerPolicy describes a policy for a single trigger that results in a new deployment.",
- "type": "object",
- "properties": {
- "imageChangeParams": {
- "description": "imageChangeParams represents the parameters for the ImageChange trigger.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.DeploymentTriggerImageChangeParams"
- },
- "type": {
- "description": "type of the trigger",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.apps.v1.ExecNewPodHook": {
- "description": "ExecNewPodHook is a hook implementation which runs a command in a new pod based on the specified container which is assumed to be part of the deployment template.",
- "type": "object",
- "required": [
- "command",
- "containerName"
- ],
- "properties": {
- "command": {
- "description": "command is the action command and its arguments.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "containerName": {
- "description": "containerName is the name of a container in the deployment pod template whose container image will be used for the hook pod's container.",
- "type": "string",
- "default": ""
- },
- "env": {
- "description": "env is a set of environment variables to supply to the hook pod's container.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "volumes": {
- "description": "volumes is a list of named volumes from the pod template which should be copied to the hook pod. Volumes names not found in pod spec are ignored. An empty list means no volumes will be copied.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.apps.v1.LifecycleHook": {
- "description": "LifecycleHook defines a specific deployment lifecycle action. Only one type of action may be specified at any time.",
- "type": "object",
- "required": [
- "failurePolicy"
- ],
- "properties": {
- "execNewPod": {
- "description": "execNewPod specifies the options for a lifecycle hook backed by a pod.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.ExecNewPodHook"
- },
- "failurePolicy": {
- "description": "failurePolicy specifies what action to take if the hook fails.",
- "type": "string",
- "default": ""
- },
- "tagImages": {
- "description": "tagImages instructs the deployer to tag the current image referenced under a container onto an image stream tag.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.TagImageHook"
- }
- }
- }
- },
- "com.github.openshift.api.apps.v1.RecreateDeploymentStrategyParams": {
- "description": "RecreateDeploymentStrategyParams are the input to the Recreate deployment strategy.",
- "type": "object",
- "properties": {
- "mid": {
- "description": "mid is a lifecycle hook which is executed while the deployment is scaled down to zero before the first new pod is created. All LifecycleHookFailurePolicy values are supported.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.LifecycleHook"
- },
- "post": {
- "description": "post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.LifecycleHook"
- },
- "pre": {
- "description": "pre is a lifecycle hook which is executed before the strategy manipulates the deployment. All LifecycleHookFailurePolicy values are supported.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.LifecycleHook"
- },
- "timeoutSeconds": {
- "description": "timeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.apps.v1.RollingDeploymentStrategyParams": {
- "description": "RollingDeploymentStrategyParams are the input to the Rolling deployment strategy.",
- "type": "object",
- "properties": {
- "intervalSeconds": {
- "description": "intervalSeconds is the time to wait between polling deployment status after update. If the value is nil, a default will be used.",
- "type": "integer",
- "format": "int64"
- },
- "maxSurge": {
- "description": "maxSurge is the maximum number of pods that can be scheduled above the original number of pods. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up.\n\nThis cannot be 0 if MaxUnavailable is 0. By default, 25% is used.\n\nExample: when this is set to 30%, the new RC can be scaled up by 30% immediately when the rolling update starts. Once old pods have been killed, new RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 130% of original pods.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
- },
- "maxUnavailable": {
- "description": "maxUnavailable is the maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total pods at the start of update (ex: 10%). Absolute number is calculated from percentage by rounding down.\n\nThis cannot be 0 if MaxSurge is 0. By default, 25% is used.\n\nExample: when this is set to 30%, the old RC can be scaled down by 30% immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that at least 70% of original number of pods are available at all times during the update.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
- },
- "post": {
- "description": "post is a lifecycle hook which is executed after the strategy has finished all deployment logic. All LifecycleHookFailurePolicy values are supported.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.LifecycleHook"
- },
- "pre": {
- "description": "pre is a lifecycle hook which is executed before the deployment process begins. All LifecycleHookFailurePolicy values are supported.",
- "$ref": "#/definitions/com.github.openshift.api.apps.v1.LifecycleHook"
- },
- "timeoutSeconds": {
- "description": "timeoutSeconds is the time to wait for updates before giving up. If the value is nil, a default will be used.",
- "type": "integer",
- "format": "int64"
- },
- "updatePeriodSeconds": {
- "description": "updatePeriodSeconds is the time to wait between individual pod updates. If the value is nil, a default will be used.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.apps.v1.TagImageHook": {
- "description": "TagImageHook is a request to tag the image in a particular container onto an ImageStreamTag.",
- "type": "object",
- "required": [
- "containerName",
- "to"
- ],
- "properties": {
- "containerName": {
- "description": "containerName is the name of a container in the deployment config whose image value will be used as the source of the tag. If there is only a single container this value will be defaulted to the name of that container.",
- "type": "string",
- "default": ""
- },
- "to": {
- "description": "to is the target ImageStreamTag to set the container's image onto.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.Action": {
- "description": "Action describes a request to the API server",
- "type": "object",
- "required": [
- "namespace",
- "verb",
- "resourceAPIGroup",
- "resourceAPIVersion",
- "resource",
- "resourceName",
- "path",
- "isNonResourceURL"
- ],
- "properties": {
- "content": {
- "description": "content is the actual content of the request for create and update",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "isNonResourceURL": {
- "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)",
- "type": "boolean",
- "default": false
- },
- "namespace": {
- "description": "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces",
- "type": "string",
- "default": ""
- },
- "path": {
- "description": "path is the path of a non resource URL",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is one of the existing resource types",
- "type": "string",
- "default": ""
- },
- "resourceAPIGroup": {
- "description": "Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined",
- "type": "string",
- "default": ""
- },
- "resourceAPIVersion": {
- "description": "Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined",
- "type": "string",
- "default": ""
- },
- "resourceName": {
- "description": "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"",
- "type": "string",
- "default": ""
- },
- "verb": {
- "description": "verb is one of: get, list, watch, create, update, delete",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ClusterRole": {
- "description": "ClusterRole is a logical grouping of PolicyRules that can be referenced as a unit by ClusterRoleBindings.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "rules"
- ],
- "properties": {
- "aggregationRule": {
- "description": "aggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.",
- "$ref": "#/definitions/io.k8s.api.rbac.v1.AggregationRule"
- },
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "rules": {
- "description": "rules holds all the PolicyRules for this ClusterRole",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.PolicyRule"
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ClusterRoleBinding": {
- "description": "ClusterRoleBinding references a ClusterRole, but not contain it. It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "subjects",
- "roleRef"
- ],
- "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",
- "type": "string"
- },
- "groupNames": {
- "description": "groupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "roleRef": {
- "description": "roleRef can only reference the current namespace and the global namespace. If the ClusterRoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "subjects": {
- "description": "subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- }
- },
- "userNames": {
- "description": "userNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ClusterRoleBindingList": {
- "description": "ClusterRoleBindingList is a collection of ClusterRoleBindings\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of ClusterRoleBindings",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ClusterRoleBinding"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ClusterRoleList": {
- "description": "ClusterRoleList is a collection of ClusterRoles\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of ClusterRoles",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ClusterRole"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.GroupRestriction": {
- "description": "GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.",
- "type": "object",
- "required": [
- "groups",
- "labels"
- ],
- "properties": {
- "groups": {
- "description": "groups is a list of groups used to match against an individual user's groups. If the user is a member of one of the whitelisted groups, the user is allowed to be bound to a role.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "labels": {
- "description": "Selectors specifies a list of label selectors over group labels.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.IsPersonalSubjectAccessReview": {
- "description": "IsPersonalSubjectAccessReview is a marker for PolicyRule.AttributeRestrictions that denotes that subjectaccessreviews on self should be allowed\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.LocalResourceAccessReview": {
- "description": "LocalResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec in a particular namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "namespace",
- "verb",
- "resourceAPIGroup",
- "resourceAPIVersion",
- "resource",
- "resourceName",
- "path",
- "isNonResourceURL"
- ],
- "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",
- "type": "string"
- },
- "content": {
- "description": "content is the actual content of the request for create and update",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "isNonResourceURL": {
- "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "namespace": {
- "description": "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces",
- "type": "string",
- "default": ""
- },
- "path": {
- "description": "path is the path of a non resource URL",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is one of the existing resource types",
- "type": "string",
- "default": ""
- },
- "resourceAPIGroup": {
- "description": "Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined",
- "type": "string",
- "default": ""
- },
- "resourceAPIVersion": {
- "description": "Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined",
- "type": "string",
- "default": ""
- },
- "resourceName": {
- "description": "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"",
- "type": "string",
- "default": ""
- },
- "verb": {
- "description": "verb is one of: get, list, watch, create, update, delete",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.authorization.v1.LocalSubjectAccessReview": {
- "description": "LocalSubjectAccessReview is an object for requesting information about whether a user or group can perform an action in a particular namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "namespace",
- "verb",
- "resourceAPIGroup",
- "resourceAPIVersion",
- "resource",
- "resourceName",
- "path",
- "isNonResourceURL",
- "user",
- "groups",
- "scopes"
- ],
- "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",
- "type": "string"
- },
- "content": {
- "description": "content is the actual content of the request for create and update",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "groups": {
- "description": "groups is optional. Groups is the list of groups to which the User belongs.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "isNonResourceURL": {
- "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "namespace": {
- "description": "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces",
- "type": "string",
- "default": ""
- },
- "path": {
- "description": "path is the path of a non resource URL",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is one of the existing resource types",
- "type": "string",
- "default": ""
- },
- "resourceAPIGroup": {
- "description": "Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined",
- "type": "string",
- "default": ""
- },
- "resourceAPIVersion": {
- "description": "Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined",
- "type": "string",
- "default": ""
- },
- "resourceName": {
- "description": "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"",
- "type": "string",
- "default": ""
- },
- "scopes": {
- "description": "scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\". Nil for a self-SAR, means \"use the scopes on this request\". Nil for a regular SAR, means the same as empty.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "user": {
- "description": "user is optional. If both User and Groups are empty, the current authenticated user is used.",
- "type": "string",
- "default": ""
- },
- "verb": {
- "description": "verb is one of: get, list, watch, create, update, delete",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.authorization.v1.NamedClusterRole": {
- "description": "NamedClusterRole relates a name with a cluster role",
- "type": "object",
- "required": [
- "name",
- "role"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the cluster role",
- "type": "string",
- "default": ""
- },
- "role": {
- "description": "role is the cluster role being named",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ClusterRole"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.NamedClusterRoleBinding": {
- "description": "NamedClusterRoleBinding relates a name with a cluster role binding",
- "type": "object",
- "required": [
- "name",
- "roleBinding"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the cluster role binding",
- "type": "string",
- "default": ""
- },
- "roleBinding": {
- "description": "roleBinding is the cluster role binding being named",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ClusterRoleBinding"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.NamedRole": {
- "description": "NamedRole relates a Role with a name",
- "type": "object",
- "required": [
- "name",
- "role"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the role",
- "type": "string",
- "default": ""
- },
- "role": {
- "description": "role is the role being named",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.Role"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.NamedRoleBinding": {
- "description": "NamedRoleBinding relates a role binding with a name",
- "type": "object",
- "required": [
- "name",
- "roleBinding"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the role binding",
- "type": "string",
- "default": ""
- },
- "roleBinding": {
- "description": "roleBinding is the role binding being named",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.RoleBinding"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.PolicyRule": {
- "description": "PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.",
- "type": "object",
- "required": [
- "verbs",
- "resources"
- ],
- "properties": {
- "apiGroups": {
- "description": "apiGroups is the name of the APIGroup that contains the resources. If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "attributeRestrictions": {
- "description": "attributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "nonResourceURLs": {
- "description": "NonResourceURLsSlice is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "resourceNames": {
- "description": "resourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "resources": {
- "description": "resources is a list of resources this rule applies to. ResourceAll represents all resources.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "verbs": {
- "description": "verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ResourceAccessReview": {
- "description": "ResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "namespace",
- "verb",
- "resourceAPIGroup",
- "resourceAPIVersion",
- "resource",
- "resourceName",
- "path",
- "isNonResourceURL"
- ],
- "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",
- "type": "string"
- },
- "content": {
- "description": "content is the actual content of the request for create and update",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "isNonResourceURL": {
- "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "namespace": {
- "description": "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces",
- "type": "string",
- "default": ""
- },
- "path": {
- "description": "path is the path of a non resource URL",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is one of the existing resource types",
- "type": "string",
- "default": ""
- },
- "resourceAPIGroup": {
- "description": "Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined",
- "type": "string",
- "default": ""
- },
- "resourceAPIVersion": {
- "description": "Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined",
- "type": "string",
- "default": ""
- },
- "resourceName": {
- "description": "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"",
- "type": "string",
- "default": ""
- },
- "verb": {
- "description": "verb is one of: get, list, watch, create, update, delete",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ResourceAccessReviewResponse": {
- "description": "ResourceAccessReviewResponse describes who can perform the action\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "users",
- "groups",
- "evalutionError"
- ],
- "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",
- "type": "string"
- },
- "evalutionError": {
- "description": "EvaluationError is an indication that some error occurred during resolution, but partial results can still be returned. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. This is most common when a bound role is missing, but enough roles are still present and bound to reason about the request.",
- "type": "string",
- "default": ""
- },
- "groups": {
- "description": "GroupsSlice is the list of groups who can perform the action",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "namespace": {
- "description": "namespace is the namespace used for the access review",
- "type": "string"
- },
- "users": {
- "description": "UsersSlice is the list of users who can perform the action",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.Role": {
- "description": "Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "rules"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "rules": {
- "description": "rules holds all the PolicyRules for this Role",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.PolicyRule"
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.RoleBinding": {
- "description": "RoleBinding references a Role, but not contain it. It can reference any Role in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "subjects",
- "roleRef"
- ],
- "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",
- "type": "string"
- },
- "groupNames": {
- "description": "groupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "roleRef": {
- "description": "roleRef can only reference the current namespace and the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "subjects": {
- "description": "subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- }
- },
- "userNames": {
- "description": "userNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.RoleBindingList": {
- "description": "RoleBindingList is a collection of RoleBindings\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of RoleBindings",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.RoleBinding"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.RoleBindingRestriction": {
- "description": "RoleBindingRestriction is an object that can be matched against a subject (user, group, or service account) to determine whether rolebindings on that subject are allowed in the namespace to which the RoleBindingRestriction belongs. If any one of those RoleBindingRestriction objects matches a subject, rolebindings on that subject in the namespace are allowed.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec defines the matcher.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.RoleBindingRestrictionSpec"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.RoleBindingRestrictionList": {
- "description": "RoleBindingRestrictionList is a collection of RoleBindingRestriction objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of RoleBindingRestriction objects.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.RoleBindingRestriction"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.RoleBindingRestrictionSpec": {
- "description": "RoleBindingRestrictionSpec defines a rolebinding restriction. Exactly one field must be non-nil.",
- "type": "object",
- "required": [
- "userrestriction",
- "grouprestriction",
- "serviceaccountrestriction"
- ],
- "properties": {
- "grouprestriction": {
- "description": "grouprestriction matches against group subjects.",
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.GroupRestriction"
- },
- "serviceaccountrestriction": {
- "description": "serviceaccountrestriction matches against service-account subjects.",
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ServiceAccountRestriction"
- },
- "userrestriction": {
- "description": "userrestriction matches against user subjects.",
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.UserRestriction"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.RoleList": {
- "description": "RoleList is a collection of Roles\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of Roles",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.Role"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.SelfSubjectRulesReview": {
- "description": "SelfSubjectRulesReview is a resource you can create to determine which actions you can perform in a namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec adds information about how to conduct the check",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.SelfSubjectRulesReviewSpec"
- },
- "status": {
- "description": "status is completed by the server to tell which permissions you have",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.SubjectRulesReviewStatus"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.SelfSubjectRulesReviewSpec": {
- "description": "SelfSubjectRulesReviewSpec adds information about how to conduct the check",
- "type": "object",
- "required": [
- "scopes"
- ],
- "properties": {
- "scopes": {
- "description": "scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\". Nil means \"use the scopes on this request\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ServiceAccountReference": {
- "description": "ServiceAccountReference specifies a service account and namespace by their names.",
- "type": "object",
- "required": [
- "name",
- "namespace"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the service account.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace is the namespace of the service account. Service accounts from inside the whitelisted namespaces are allowed to be bound to roles. If Namespace is empty, then the namespace of the RoleBindingRestriction in which the ServiceAccountReference is embedded is used.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.authorization.v1.ServiceAccountRestriction": {
- "description": "ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account's namespace.",
- "type": "object",
- "required": [
- "serviceaccounts",
- "namespaces"
- ],
- "properties": {
- "namespaces": {
- "description": "namespaces specifies a list of literal namespace names.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "serviceaccounts": {
- "description": "serviceaccounts specifies a list of literal service-account names.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.ServiceAccountReference"
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.SubjectAccessReview": {
- "description": "SubjectAccessReview is an object for requesting information about whether a user or group can perform an action\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "namespace",
- "verb",
- "resourceAPIGroup",
- "resourceAPIVersion",
- "resource",
- "resourceName",
- "path",
- "isNonResourceURL",
- "user",
- "groups",
- "scopes"
- ],
- "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",
- "type": "string"
- },
- "content": {
- "description": "content is the actual content of the request for create and update",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "groups": {
- "description": "GroupsSlice is optional. Groups is the list of groups to which the User belongs.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "isNonResourceURL": {
- "description": "isNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "namespace": {
- "description": "namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces",
- "type": "string",
- "default": ""
- },
- "path": {
- "description": "path is the path of a non resource URL",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is one of the existing resource types",
- "type": "string",
- "default": ""
- },
- "resourceAPIGroup": {
- "description": "Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined",
- "type": "string",
- "default": ""
- },
- "resourceAPIVersion": {
- "description": "Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined",
- "type": "string",
- "default": ""
- },
- "resourceName": {
- "description": "resourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"",
- "type": "string",
- "default": ""
- },
- "scopes": {
- "description": "scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\". Nil for a self-SAR, means \"use the scopes on this request\". Nil for a regular SAR, means the same as empty.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "user": {
- "description": "user is optional. If both User and Groups are empty, the current authenticated user is used.",
- "type": "string",
- "default": ""
- },
- "verb": {
- "description": "verb is one of: get, list, watch, create, update, delete",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.authorization.v1.SubjectAccessReviewResponse": {
- "description": "SubjectAccessReviewResponse describes whether or not a user or group can perform an action\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "allowed"
- ],
- "properties": {
- "allowed": {
- "description": "allowed is required. True if the action would be allowed, false otherwise.",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "evaluationError": {
- "description": "evaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. This is most common when a bound role is missing, but enough roles are still present and bound to reason about the request.",
- "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",
- "type": "string"
- },
- "namespace": {
- "description": "namespace is the namespace used for the access review",
- "type": "string"
- },
- "reason": {
- "description": "reason is optional. It indicates why a request was allowed or denied.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.SubjectRulesReview": {
- "description": "SubjectRulesReview is a resource you can create to determine which actions another user can perform in a namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec adds information about how to conduct the check",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.SubjectRulesReviewSpec"
- },
- "status": {
- "description": "status is completed by the server to tell which permissions you have",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.SubjectRulesReviewStatus"
- }
- }
- },
- "com.github.openshift.api.authorization.v1.SubjectRulesReviewSpec": {
- "description": "SubjectRulesReviewSpec adds information about how to conduct the check",
- "type": "object",
- "required": [
- "user",
- "groups",
- "scopes"
- ],
- "properties": {
- "groups": {
- "description": "groups is optional. Groups is the list of groups to which the User belongs. At least one of User and Groups must be specified.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "scopes": {
- "description": "scopes to use for the evaluation. Empty means \"use the unscoped (full) permissions of the user/groups\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "user": {
- "description": "user is optional. At least one of User and Groups must be specified.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.authorization.v1.SubjectRulesReviewStatus": {
- "description": "SubjectRulesReviewStatus is contains the result of a rules check",
- "type": "object",
- "properties": {
- "evaluationError": {
- "description": "evaluationError can appear in combination with Rules. It means some error happened during evaluation that may have prevented additional rules from being populated.",
- "type": "string"
- },
- "rules": {
- "description": "rules is the list of rules (no particular sort) that are allowed for the subject",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.authorization.v1.PolicyRule"
- }
- }
- }
- },
- "com.github.openshift.api.authorization.v1.UserRestriction": {
- "description": "UserRestriction matches a user either by a string match on the user name, a string match on the name of a group to which the user belongs, or a label selector applied to the user labels.",
- "type": "object",
- "required": [
- "users",
- "groups",
- "labels"
- ],
- "properties": {
- "groups": {
- "description": "groups specifies a list of literal group names.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "labels": {
- "description": "Selectors specifies a list of label selectors over user labels.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- }
- },
- "users": {
- "description": "users specifies a list of literal user names.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.build.v1.BinaryBuildRequestOptions": {
- "description": "BinaryBuildRequestOptions are the options required to fully speficy a binary build request\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "asFile": {
- "description": "asFile determines if the binary should be created as a file within the source rather than extracted as an archive",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "revision.authorEmail": {
- "description": "revision.authorEmail of the source control user",
- "type": "string"
- },
- "revision.authorName": {
- "description": "revision.authorName of the source control user",
- "type": "string"
- },
- "revision.commit": {
- "description": "revision.commit is the value identifying a specific commit",
- "type": "string"
- },
- "revision.committerEmail": {
- "description": "revision.committerEmail of the source control user",
- "type": "string"
- },
- "revision.committerName": {
- "description": "revision.committerName of the source control user",
- "type": "string"
- },
- "revision.message": {
- "description": "revision.message is the description of a specific commit",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BinaryBuildSource": {
- "description": "BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source.",
- "type": "object",
- "properties": {
- "asFile": {
- "description": "asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying \"webapp.war\" would place the provided binary as `/webapp.war` for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BitbucketWebHookCause": {
- "description": "BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build.",
- "type": "object",
- "properties": {
- "revision": {
- "description": "revision is the git source revision information of the trigger.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "secret": {
- "description": "secret is the obfuscated webhook secret that triggered a build.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.Build": {
- "description": "Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the execution and a reference to the Pod which executed the build.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is all the inputs used to execute the build.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildSpec"
- },
- "status": {
- "description": "status is the current status of the build.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildStatus"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildCondition": {
- "description": "BuildCondition describes the state of a build at a certain point.",
- "type": "object",
- "required": [
- "type",
- "status"
- ],
- "properties": {
- "lastTransitionTime": {
- "description": "The last time the condition transitioned from one status to another.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "lastUpdateTime": {
- "description": "The last time this condition was updated.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "A human readable message indicating details about the transition.",
- "type": "string"
- },
- "reason": {
- "description": "The reason for the condition's last transition.",
- "type": "string"
- },
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type of build condition.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildConfig": {
- "description": "Build configurations define a build process for new container images. There are three types of builds possible - a container image build using a Dockerfile, a Source-to-Image build that uses a specially prepared base image that accepts source code that it can make runnable, and a custom build that can run // arbitrary container images as a base and accept the build parameters. Builds run on the cluster and on completion are pushed to the container image registry specified in the \"output\" section. A build can be triggered via a webhook, when the base image changes, or when a user manually requests a new build be // created.\n\nEach build created by a build configuration is numbered and refers back to its parent configuration. Multiple builds can be triggered at once. Builds that do not have \"output\" set can be used to test code or run a verification build.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds all the input necessary to produce a new build, and the conditions when to trigger them.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildConfigSpec"
- },
- "status": {
- "description": "status holds any relevant information about a build config",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildConfigStatus"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildConfigList": {
- "description": "BuildConfigList is a collection of BuildConfigs.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of build configs",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildConfig"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildConfigSpec": {
- "description": "BuildConfigSpec describes when and how builds are created",
- "type": "object",
- "required": [
- "strategy"
- ],
- "properties": {
- "completionDeadlineSeconds": {
- "description": "completionDeadlineSeconds is an optional duration in seconds, counted from the time when a build pod gets scheduled in the system, that the build may be active on a node before the system actively tries to terminate the build; value must be positive integer",
- "type": "integer",
- "format": "int64"
- },
- "failedBuildsHistoryLimit": {
- "description": "failedBuildsHistoryLimit is the number of old failed builds to retain. When a BuildConfig is created, the 5 most recent failed builds are retained unless this value is set. If removed after the BuildConfig has been created, all failed builds are retained.",
- "type": "integer",
- "format": "int32"
- },
- "mountTrustedCA": {
- "description": "mountTrustedCA bind mounts the cluster's trusted certificate authorities, as defined in the cluster's proxy configuration, into the build. This lets processes within a build trust components signed by custom PKI certificate authorities, such as private artifact repositories and HTTPS proxies.\n\nWhen this field is set to true, the contents of `/etc/pki/ca-trust` within the build are managed by the build container, and any changes to this directory or its subdirectories (for example - within a Dockerfile `RUN` instruction) are not persisted in the build's output image.",
- "type": "boolean"
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "output": {
- "description": "output describes the container image the Strategy should produce.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildOutput"
- },
- "postCommit": {
- "description": "postCommit is a build hook executed after the build output image is committed, before it is pushed to a registry.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildPostCommitSpec"
- },
- "resources": {
- "description": "resources computes resource requirements to execute the build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
- },
- "revision": {
- "description": "revision is the information from the source for a specific repo snapshot. This is optional.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "runPolicy": {
- "description": "runPolicy describes how the new build created from this build configuration will be scheduled for execution. This is optional, if not specified we default to \"Serial\".",
- "type": "string"
- },
- "serviceAccount": {
- "description": "serviceAccount is the name of the ServiceAccount to use to run the pod created by this build. The pod will be allowed to use secrets referenced by the ServiceAccount",
- "type": "string"
- },
- "source": {
- "description": "source describes the SCM in use.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildSource"
- },
- "strategy": {
- "description": "strategy defines how to perform a build.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildStrategy"
- },
- "successfulBuildsHistoryLimit": {
- "description": "successfulBuildsHistoryLimit is the number of old successful builds to retain. When a BuildConfig is created, the 5 most recent successful builds are retained unless this value is set. If removed after the BuildConfig has been created, all successful builds are retained.",
- "type": "integer",
- "format": "int32"
- },
- "triggers": {
- "description": "triggers determine how new Builds can be launched from a BuildConfig. If no triggers are defined, a new build can only occur as a result of an explicit client build creation.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildTriggerPolicy"
- }
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildConfigStatus": {
- "description": "BuildConfigStatus contains current state of the build config object.",
- "type": "object",
- "properties": {
- "imageChangeTriggers": {
- "description": "imageChangeTriggers captures the runtime state of any ImageChangeTrigger specified in the BuildConfigSpec, including the value reconciled by the OpenShift APIServer for the lastTriggeredImageID. There is a single entry in this array for each image change trigger in spec. Each trigger status references the ImageStreamTag that acts as the source of the trigger.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageChangeTriggerStatus"
- }
- },
- "lastVersion": {
- "description": "lastVersion is used to inform about number of last triggered build.",
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildList": {
- "description": "BuildList is a collection of Builds.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of builds",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.Build"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildLog": {
- "description": "BuildLog is the (unused) resource associated with the build log redirector\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildLogOptions": {
- "description": "BuildLogOptions is the REST options for a build log\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "container": {
- "description": "cointainer for which to stream logs. Defaults to only container if there is one container in the pod.",
- "type": "string"
- },
- "follow": {
- "description": "follow if true indicates that the build log should be streamed until the build terminates.",
- "type": "boolean"
- },
- "insecureSkipTLSVerifyBackend": {
- "description": "insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).",
- "type": "boolean"
- },
- "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",
- "type": "string"
- },
- "limitBytes": {
- "description": "limitBytes, If set, is the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.",
- "type": "integer",
- "format": "int64"
- },
- "nowait": {
- "description": "nowait if true causes the call to return immediately even if the build is not available yet. Otherwise the server will wait until the build has started.",
- "type": "boolean"
- },
- "previous": {
- "description": "previous returns previous build logs. Defaults to false.",
- "type": "boolean"
- },
- "sinceSeconds": {
- "description": "sinceSeconds is a relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.",
- "type": "integer",
- "format": "int64"
- },
- "sinceTime": {
- "description": "sinceTime is an RFC3339 timestamp from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "tailLines": {
- "description": "tailLines, If set, is the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime",
- "type": "integer",
- "format": "int64"
- },
- "timestamps": {
- "description": "timestamps, If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.",
- "type": "boolean"
- },
- "version": {
- "description": "version of the build for which to view logs.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildOutput": {
- "description": "BuildOutput is input to a build strategy and describes the container image that the strategy should produce.",
- "type": "object",
- "properties": {
- "imageLabels": {
- "description": "imageLabels define a list of labels that are applied to the resulting image. If there are multiple labels with the same name then the last one in the list is used.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageLabel"
- }
- },
- "pushSecret": {
- "description": "pushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub).",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "to": {
- "description": "to defines an optional location to push the output of this build to. Kind must be one of 'ImageStreamTag' or 'DockerImage'. This value will be used to look up a container image repository to push to. In the case of an ImageStreamTag, the ImageStreamTag will be looked for in the namespace of the build unless Namespace is specified.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildPostCommitSpec": {
- "description": "A BuildPostCommitSpec holds a build post commit hook specification. The hook executes a command in a temporary container running the build output image, immediately after the last layer of the image is committed and before the image is pushed to a registry. The command is executed with the current working directory ($PWD) set to the image's WORKDIR.\n\nThe build will be marked as failed if the hook execution fails. It will fail if the script or command return a non-zero exit code, or if there is any other error related to starting the temporary container.\n\nThere are five different ways to configure the hook. As an example, all forms below are equivalent and will execute `rake test --verbose`.\n\n1. Shell script:\n\n\t \"postCommit\": {\n\t \"script\": \"rake test --verbose\",\n\t }\n\n\tThe above is a convenient form which is equivalent to:\n\n\t \"postCommit\": {\n\t \"command\": [\"/bin/sh\", \"-ic\"],\n\t \"args\": [\"rake test --verbose\"]\n\t }\n\n2. A command as the image entrypoint:\n\n\t \"postCommit\": {\n\t \"commit\": [\"rake\", \"test\", \"--verbose\"]\n\t }\n\n\tCommand overrides the image entrypoint in the exec form, as documented in\n\tDocker: https://docs.docker.com/engine/reference/builder/#entrypoint.\n\n3. Pass arguments to the default entrypoint:\n\n\t \"postCommit\": {\n\t\t\t \"args\": [\"rake\", \"test\", \"--verbose\"]\n\t\t }\n\n\t This form is only useful if the image entrypoint can handle arguments.\n\n4. Shell script with arguments:\n\n\t \"postCommit\": {\n\t \"script\": \"rake test $1\",\n\t \"args\": [\"--verbose\"]\n\t }\n\n\tThis form is useful if you need to pass arguments that would otherwise be\n\thard to quote properly in the shell script. In the script, $0 will be\n\t\"/bin/sh\" and $1, $2, etc, are the positional arguments from Args.\n\n5. Command with arguments:\n\n\t \"postCommit\": {\n\t \"command\": [\"rake\", \"test\"],\n\t \"args\": [\"--verbose\"]\n\t }\n\n\tThis form is equivalent to appending the arguments to the Command slice.\n\nIt is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed.",
- "type": "object",
- "properties": {
- "args": {
- "description": "args is a list of arguments that are provided to either Command, Script or the container image's default entrypoint. The arguments are placed immediately after the command to be run.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "command": {
- "description": "command is the command to run. It may not be specified with Script. This might be needed if the image doesn't have `/bin/sh`, or if you do not want to use a shell. In all other cases, using Script might be more convenient.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "script": {
- "description": "script is a shell script to be run with `/bin/sh -ic`. It may not be specified with Command. Use Script when a shell script is appropriate to execute the post build hook, for example for running unit tests with `rake test`. If you need control over the image entrypoint, or if the image does not have `/bin/sh`, use Command and/or Args. The `-i` flag is needed to support CentOS and RHEL images that use Software Collections (SCL), in order to have the appropriate collections enabled in the shell. E.g., in the Ruby image, this is necessary to make `ruby`, `bundle` and other binaries available in the PATH.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildRequest": {
- "description": "BuildRequest is the resource used to pass parameters to build generator\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "binary": {
- "description": "binary indicates a request to build from a binary provided to the builder",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BinaryBuildSource"
- },
- "dockerStrategyOptions": {
- "description": "dockerStrategyOptions contains additional docker-strategy specific options for the build",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.DockerStrategyOptions"
- },
- "env": {
- "description": "env contains additional environment variables you want to pass into a builder container.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "from": {
- "description": "from is the reference to the ImageStreamTag that triggered the build.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "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",
- "type": "string"
- },
- "lastVersion": {
- "description": "lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn't match, a build will not be generated.",
- "type": "integer",
- "format": "int64"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "revision": {
- "description": "revision is the information from the source for a specific repo snapshot.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "sourceStrategyOptions": {
- "description": "sourceStrategyOptions contains additional source-strategy specific options for the build",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceStrategyOptions"
- },
- "triggeredBy": {
- "description": "triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildTriggerCause"
- }
- },
- "triggeredByImage": {
- "description": "triggeredByImage is the Image that triggered this build.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildSource": {
- "description": "BuildSource is the SCM used for the build.",
- "type": "object",
- "properties": {
- "binary": {
- "description": "binary builds accept a binary as their input. The binary is generally assumed to be a tar, gzipped tar, or zip file depending on the strategy. For container image builds, this is the build context and an optional Dockerfile may be specified to override any Dockerfile in the build context. For Source builds, this is assumed to be an archive as described above. For Source and container image builds, if binary.asFile is set the build will receive a directory with a single file. contextDir may be used when an archive is provided. Custom builds will receive this binary as input on STDIN.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BinaryBuildSource"
- },
- "configMaps": {
- "description": "configMaps represents a list of configMaps and their destinations that will be used for the build.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ConfigMapBuildSource"
- }
- },
- "contextDir": {
- "description": "contextDir specifies the sub-directory where the source code for the application exists. This allows to have buildable sources in directory other than root of repository.",
- "type": "string"
- },
- "dockerfile": {
- "description": "dockerfile is the raw contents of a Dockerfile which should be built. When this option is specified, the FROM may be modified based on your strategy base image and additional ENV stanzas from your strategy environment will be added after the FROM, but before the rest of your Dockerfile stanzas. The Dockerfile source type may be used with other options like git - in those cases the Git repo will have any innate Dockerfile replaced in the context dir.",
- "type": "string"
- },
- "git": {
- "description": "git contains optional information about git build source",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.GitBuildSource"
- },
- "images": {
- "description": "images describes a set of images to be used to provide source for the build",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageSource"
- }
- },
- "secrets": {
- "description": "secrets represents a list of secrets and their destinations that will be used only for the build.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SecretBuildSource"
- }
- },
- "sourceSecret": {
- "description": "sourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data's key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "type": {
- "description": "type of build input to accept",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildSpec": {
- "description": "BuildSpec has the information to represent a build and also additional information about a build",
- "type": "object",
- "required": [
- "strategy"
- ],
- "properties": {
- "completionDeadlineSeconds": {
- "description": "completionDeadlineSeconds is an optional duration in seconds, counted from the time when a build pod gets scheduled in the system, that the build may be active on a node before the system actively tries to terminate the build; value must be positive integer",
- "type": "integer",
- "format": "int64"
- },
- "mountTrustedCA": {
- "description": "mountTrustedCA bind mounts the cluster's trusted certificate authorities, as defined in the cluster's proxy configuration, into the build. This lets processes within a build trust components signed by custom PKI certificate authorities, such as private artifact repositories and HTTPS proxies.\n\nWhen this field is set to true, the contents of `/etc/pki/ca-trust` within the build are managed by the build container, and any changes to this directory or its subdirectories (for example - within a Dockerfile `RUN` instruction) are not persisted in the build's output image.",
- "type": "boolean"
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "output": {
- "description": "output describes the container image the Strategy should produce.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildOutput"
- },
- "postCommit": {
- "description": "postCommit is a build hook executed after the build output image is committed, before it is pushed to a registry.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildPostCommitSpec"
- },
- "resources": {
- "description": "resources computes resource requirements to execute the build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
- },
- "revision": {
- "description": "revision is the information from the source for a specific repo snapshot. This is optional.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "serviceAccount": {
- "description": "serviceAccount is the name of the ServiceAccount to use to run the pod created by this build. The pod will be allowed to use secrets referenced by the ServiceAccount",
- "type": "string"
- },
- "source": {
- "description": "source describes the SCM in use.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildSource"
- },
- "strategy": {
- "description": "strategy defines how to perform a build.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildStrategy"
- },
- "triggeredBy": {
- "description": "triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildTriggerCause"
- }
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildStatus": {
- "description": "BuildStatus contains the status of a build",
- "type": "object",
- "properties": {
- "cancelled": {
- "description": "cancelled describes if a cancel event was triggered for the build.",
- "type": "boolean"
- },
- "completionTimestamp": {
- "description": "completionTimestamp is a timestamp representing the server time when this Build was finished, whether that build failed or succeeded. It reflects the time at which the Pod running the Build terminated. It is represented in RFC3339 form and is in UTC.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "conditions": {
- "description": "conditions represents the latest available observations of a build's current state.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildCondition"
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "config": {
- "description": "config is an ObjectReference to the BuildConfig this Build is based on.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "duration": {
- "description": "duration contains time.Duration object describing build time.",
- "type": "integer",
- "format": "int64"
- },
- "logSnippet": {
- "description": "logSnippet is the last few lines of the build log. This value is only set for builds that failed.",
- "type": "string"
- },
- "message": {
- "description": "message is a human-readable message indicating details about why the build has this status.",
- "type": "string"
- },
- "output": {
- "description": "output describes the container image the build has produced.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildStatusOutput"
- },
- "outputDockerImageReference": {
- "description": "outputDockerImageReference contains a reference to the container image that will be built by this build. Its value is computed from Build.Spec.Output.To, and should include the registry address, so that it can be used to push and pull the image.",
- "type": "string"
- },
- "phase": {
- "description": "phase is the point in the build lifecycle. Possible values are \"New\", \"Pending\", \"Running\", \"Complete\", \"Failed\", \"Error\", and \"Cancelled\".",
- "type": "string",
- "default": ""
- },
- "reason": {
- "description": "reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.",
- "type": "string"
- },
- "stages": {
- "description": "stages contains details about each stage that occurs during the build including start time, duration (in milliseconds), and the steps that occured within each stage.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.StageInfo"
- }
- },
- "startTimestamp": {
- "description": "startTimestamp is a timestamp representing the server time when this Build started running in a Pod. It is represented in RFC3339 form and is in UTC.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildStatusOutput": {
- "description": "BuildStatusOutput contains the status of the built image.",
- "type": "object",
- "properties": {
- "to": {
- "description": "to describes the status of the built image being pushed to a registry.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildStatusOutputTo"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildStatusOutputTo": {
- "description": "BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed.",
- "type": "object",
- "properties": {
- "imageDigest": {
- "description": "imageDigest is the digest of the built container image. The digest uniquely identifies the image in the registry to which it was pushed.\n\nPlease note that this field may not always be set even if the push completes successfully - e.g. when the registry returns no digest or returns it in a format that the builder doesn't understand.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildStrategy": {
- "description": "BuildStrategy contains the details of how to perform a build.",
- "type": "object",
- "properties": {
- "customStrategy": {
- "description": "customStrategy holds the parameters to the Custom build strategy",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.CustomBuildStrategy"
- },
- "dockerStrategy": {
- "description": "dockerStrategy holds the parameters to the container image build strategy.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.DockerBuildStrategy"
- },
- "jenkinsPipelineStrategy": {
- "description": "jenkinsPipelineStrategy holds the parameters to the Jenkins Pipeline build strategy. Deprecated: use OpenShift Pipelines",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.JenkinsPipelineBuildStrategy"
- },
- "sourceStrategy": {
- "description": "sourceStrategy holds the parameters to the Source build strategy.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceBuildStrategy"
- },
- "type": {
- "description": "type is the kind of build strategy.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildTriggerCause": {
- "description": "BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration.",
- "type": "object",
- "properties": {
- "bitbucketWebHook": {
- "description": "bitbucketWebHook represents data for a Bitbucket webhook that fired a specific build.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BitbucketWebHookCause"
- },
- "genericWebHook": {
- "description": "genericWebHook holds data about a builds generic webhook trigger.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.GenericWebHookCause"
- },
- "githubWebHook": {
- "description": "githubWebHook represents data for a GitHub webhook that fired a specific build.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.GitHubWebHookCause"
- },
- "gitlabWebHook": {
- "description": "gitlabWebHook represents data for a GitLab webhook that fired a specific build.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.GitLabWebHookCause"
- },
- "imageChangeBuild": {
- "description": "imageChangeBuild stores information about an imagechange event that triggered a new build.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageChangeCause"
- },
- "message": {
- "description": "message is used to store a human readable message for why the build was triggered. E.g.: \"Manually triggered by user\", \"Configuration change\",etc.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildTriggerPolicy": {
- "description": "BuildTriggerPolicy describes a policy for a single trigger that results in a new Build.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "bitbucket": {
- "description": "BitbucketWebHook contains the parameters for a Bitbucket webhook type of trigger",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.WebHookTrigger"
- },
- "generic": {
- "description": "generic contains the parameters for a Generic webhook type of trigger",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.WebHookTrigger"
- },
- "github": {
- "description": "github contains the parameters for a GitHub webhook type of trigger",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.WebHookTrigger"
- },
- "gitlab": {
- "description": "GitLabWebHook contains the parameters for a GitLab webhook type of trigger",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.WebHookTrigger"
- },
- "imageChange": {
- "description": "imageChange contains parameters for an ImageChange type of trigger",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageChangeTrigger"
- },
- "type": {
- "description": "type is the type of build trigger. Valid values:\n\n- GitHub GitHubWebHookBuildTriggerType represents a trigger that launches builds on GitHub webhook invocations\n\n- Generic GenericWebHookBuildTriggerType represents a trigger that launches builds on generic webhook invocations\n\n- GitLab GitLabWebHookBuildTriggerType represents a trigger that launches builds on GitLab webhook invocations\n\n- Bitbucket BitbucketWebHookBuildTriggerType represents a trigger that launches builds on Bitbucket webhook invocations\n\n- ImageChange ImageChangeBuildTriggerType represents a trigger that launches builds on availability of a new version of an image\n\n- ConfigChange ConfigChangeBuildTriggerType will trigger a build on an initial build config creation WARNING: In the future the behavior will change to trigger a build on any config change",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildVolume": {
- "description": "BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported.",
- "type": "object",
- "required": [
- "name",
- "source",
- "mounts"
- ],
- "properties": {
- "mounts": {
- "description": "mounts represents the location of the volume in the image build container",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildVolumeMount"
- },
- "x-kubernetes-list-map-keys": [
- "destinationPath"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "destinationPath",
- "x-kubernetes-patch-strategy": "merge"
- },
- "name": {
- "description": "name is a unique identifier for this BuildVolume. It must conform to the Kubernetes DNS label standard and be unique within the pod. Names that collide with those added by the build controller will result in a failed build with an error message detailing which name caused the error. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
- "type": "string",
- "default": ""
- },
- "source": {
- "description": "source represents the location and type of the mounted volume.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildVolumeSource"
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildVolumeMount": {
- "description": "BuildVolumeMount describes the mounting of a Volume within buildah's runtime environment.",
- "type": "object",
- "required": [
- "destinationPath"
- ],
- "properties": {
- "destinationPath": {
- "description": "destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.BuildVolumeSource": {
- "description": "BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "configMap": {
- "description": "configMap represents a ConfigMap that should populate this volume",
- "$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapVolumeSource"
- },
- "csi": {
- "description": "csi represents ephemeral storage provided by external CSI drivers which support this capability",
- "$ref": "#/definitions/io.k8s.api.core.v1.CSIVolumeSource"
- },
- "secret": {
- "description": "secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
- "$ref": "#/definitions/io.k8s.api.core.v1.SecretVolumeSource"
- },
- "type": {
- "description": "type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.CommonSpec": {
- "description": "CommonSpec encapsulates all the inputs necessary to represent a build.",
- "type": "object",
- "required": [
- "strategy"
- ],
- "properties": {
- "completionDeadlineSeconds": {
- "description": "completionDeadlineSeconds is an optional duration in seconds, counted from the time when a build pod gets scheduled in the system, that the build may be active on a node before the system actively tries to terminate the build; value must be positive integer",
- "type": "integer",
- "format": "int64"
- },
- "mountTrustedCA": {
- "description": "mountTrustedCA bind mounts the cluster's trusted certificate authorities, as defined in the cluster's proxy configuration, into the build. This lets processes within a build trust components signed by custom PKI certificate authorities, such as private artifact repositories and HTTPS proxies.\n\nWhen this field is set to true, the contents of `/etc/pki/ca-trust` within the build are managed by the build container, and any changes to this directory or its subdirectories (for example - within a Dockerfile `RUN` instruction) are not persisted in the build's output image.",
- "type": "boolean"
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "output": {
- "description": "output describes the container image the Strategy should produce.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildOutput"
- },
- "postCommit": {
- "description": "postCommit is a build hook executed after the build output image is committed, before it is pushed to a registry.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildPostCommitSpec"
- },
- "resources": {
- "description": "resources computes resource requirements to execute the build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
- },
- "revision": {
- "description": "revision is the information from the source for a specific repo snapshot. This is optional.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "serviceAccount": {
- "description": "serviceAccount is the name of the ServiceAccount to use to run the pod created by this build. The pod will be allowed to use secrets referenced by the ServiceAccount",
- "type": "string"
- },
- "source": {
- "description": "source describes the SCM in use.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildSource"
- },
- "strategy": {
- "description": "strategy defines how to perform a build.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildStrategy"
- }
- }
- },
- "com.github.openshift.api.build.v1.CommonWebHookCause": {
- "description": "CommonWebHookCause factors out the identical format of these webhook causes into struct so we can share it in the specific causes; it is too late for GitHub and Generic but we can leverage this pattern with GitLab and Bitbucket.",
- "type": "object",
- "properties": {
- "revision": {
- "description": "revision is the git source revision information of the trigger.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "secret": {
- "description": "secret is the obfuscated webhook secret that triggered a build.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.ConfigMapBuildSource": {
- "description": "ConfigMapBuildSource describes a configmap and its destination directory that will be used only at the build time. The content of the configmap referenced here will be copied into the destination directory instead of mounting.",
- "type": "object",
- "required": [
- "configMap"
- ],
- "properties": {
- "configMap": {
- "description": "configMap is a reference to an existing configmap that you want to use in your build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "destinationDir": {
- "description": "destinationDir is the directory where the files from the configmap should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.CustomBuildStrategy": {
- "description": "CustomBuildStrategy defines input parameters specific to Custom build.",
- "type": "object",
- "required": [
- "from"
- ],
- "properties": {
- "buildAPIVersion": {
- "description": "buildAPIVersion is the requested API version for the Build object serialized and passed to the custom builder",
- "type": "string"
- },
- "env": {
- "description": "env contains additional environment variables you want to pass into a builder container.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "exposeDockerSocket": {
- "description": "exposeDockerSocket will allow running Docker commands (and build container images) from inside the container.",
- "type": "boolean"
- },
- "forcePull": {
- "description": "forcePull describes if the controller should configure the build pod to always pull the images for the builder or only pull if it is not present locally",
- "type": "boolean"
- },
- "from": {
- "description": "from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "pullSecret": {
- "description": "pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "secrets": {
- "description": "secrets is a list of additional secrets that will be included in the build pod",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SecretSpec"
- }
- }
- }
- },
- "com.github.openshift.api.build.v1.DockerBuildStrategy": {
- "description": "DockerBuildStrategy defines input parameters specific to container image build.",
- "type": "object",
- "properties": {
- "buildArgs": {
- "description": "buildArgs contains build arguments that will be resolved in the Dockerfile. See https://docs.docker.com/engine/reference/builder/#/arg for more details. NOTE: Only the 'name' and 'value' fields are supported. Any settings on the 'valueFrom' field are ignored.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "dockerfilePath": {
- "description": "dockerfilePath is the path of the Dockerfile that will be used to build the container image, relative to the root of the context (contextDir). Defaults to `Dockerfile` if unset.",
- "type": "string"
- },
- "env": {
- "description": "env contains additional environment variables you want to pass into a builder container.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "forcePull": {
- "description": "forcePull describes if the builder should pull the images from registry prior to building.",
- "type": "boolean"
- },
- "from": {
- "description": "from is a reference to an DockerImage, ImageStreamTag, or ImageStreamImage which overrides the FROM image in the Dockerfile for the build. If the Dockerfile uses multi-stage builds, this will replace the image in the last FROM directive of the file.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "imageOptimizationPolicy": {
- "description": "imageOptimizationPolicy describes what optimizations the system can use when building images to reduce the final size or time spent building the image. The default policy is 'None' which means the final build image will be equivalent to an image created by the container image build API. The experimental policy 'SkipLayers' will avoid commiting new layers in between each image step, and will fail if the Dockerfile cannot provide compatibility with the 'None' policy. An additional experimental policy 'SkipLayersAndWarn' is the same as 'SkipLayers' but simply warns if compatibility cannot be preserved.",
- "type": "string"
- },
- "noCache": {
- "description": "noCache if set to true indicates that the container image build must be executed with the --no-cache=true flag",
- "type": "boolean"
- },
- "pullSecret": {
- "description": "pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "volumes": {
- "description": "volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildVolume"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "name",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.build.v1.DockerStrategyOptions": {
- "description": "DockerStrategyOptions contains extra strategy options for container image builds",
- "type": "object",
- "properties": {
- "buildArgs": {
- "description": "Args contains any build arguments that are to be passed to Docker. See https://docs.docker.com/engine/reference/builder/#/arg for more details",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "noCache": {
- "description": "noCache overrides the docker-strategy noCache option in the build config",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.build.v1.GenericWebHookCause": {
- "description": "GenericWebHookCause holds information about a generic WebHook that triggered a build.",
- "type": "object",
- "properties": {
- "revision": {
- "description": "revision is an optional field that stores the git source revision information of the generic webhook trigger when it is available.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "secret": {
- "description": "secret is the obfuscated webhook secret that triggered a build.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.GenericWebHookEvent": {
- "description": "GenericWebHookEvent is the payload expected for a generic webhook post",
- "type": "object",
- "properties": {
- "dockerStrategyOptions": {
- "description": "dockerStrategyOptions contains additional docker-strategy specific options for the build",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.DockerStrategyOptions"
- },
- "env": {
- "description": "env contains additional environment variables you want to pass into a builder container. ValueFrom is not supported.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "git": {
- "description": "git is the git information if the Type is BuildSourceGit",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.GitInfo"
- },
- "type": {
- "description": "type is the type of source repository",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.GitBuildSource": {
- "description": "GitBuildSource defines the parameters of a Git SCM",
- "type": "object",
- "required": [
- "uri"
- ],
- "properties": {
- "httpProxy": {
- "description": "httpProxy is a proxy used to reach the git repository over http",
- "type": "string"
- },
- "httpsProxy": {
- "description": "httpsProxy is a proxy used to reach the git repository over https",
- "type": "string"
- },
- "noProxy": {
- "description": "noProxy is the list of domains for which the proxy should not be used",
- "type": "string"
- },
- "ref": {
- "description": "ref is the branch/tag/ref to build.",
- "type": "string"
- },
- "uri": {
- "description": "uri points to the source that will be built. The structure of the source will depend on the type of build to run",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.GitHubWebHookCause": {
- "description": "GitHubWebHookCause has information about a GitHub webhook that triggered a build.",
- "type": "object",
- "properties": {
- "revision": {
- "description": "revision is the git revision information of the trigger.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "secret": {
- "description": "secret is the obfuscated webhook secret that triggered a build.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.GitInfo": {
- "description": "GitInfo is the aggregated git information for a generic webhook post",
- "type": "object",
- "required": [
- "uri",
- "refs"
- ],
- "properties": {
- "author": {
- "description": "author is the author of a specific commit",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceControlUser"
- },
- "commit": {
- "description": "commit is the commit hash identifying a specific commit",
- "type": "string"
- },
- "committer": {
- "description": "committer is the committer of a specific commit",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceControlUser"
- },
- "httpProxy": {
- "description": "httpProxy is a proxy used to reach the git repository over http",
- "type": "string"
- },
- "httpsProxy": {
- "description": "httpsProxy is a proxy used to reach the git repository over https",
- "type": "string"
- },
- "message": {
- "description": "message is the description of a specific commit",
- "type": "string"
- },
- "noProxy": {
- "description": "noProxy is the list of domains for which the proxy should not be used",
- "type": "string"
- },
- "ref": {
- "description": "ref is the branch/tag/ref to build.",
- "type": "string"
- },
- "refs": {
- "description": "refs is a list of GitRefs for the provided repo - generally sent when used from a post-receive hook. This field is optional and is used when sending multiple refs",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.GitRefInfo"
- }
- },
- "uri": {
- "description": "uri points to the source that will be built. The structure of the source will depend on the type of build to run",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.GitLabWebHookCause": {
- "description": "GitLabWebHookCause has information about a GitLab webhook that triggered a build.",
- "type": "object",
- "properties": {
- "revision": {
- "description": "revision is the git source revision information of the trigger.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceRevision"
- },
- "secret": {
- "description": "secret is the obfuscated webhook secret that triggered a build.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.GitRefInfo": {
- "description": "GitRefInfo is a single ref",
- "type": "object",
- "required": [
- "uri"
- ],
- "properties": {
- "author": {
- "description": "author is the author of a specific commit",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceControlUser"
- },
- "commit": {
- "description": "commit is the commit hash identifying a specific commit",
- "type": "string"
- },
- "committer": {
- "description": "committer is the committer of a specific commit",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceControlUser"
- },
- "httpProxy": {
- "description": "httpProxy is a proxy used to reach the git repository over http",
- "type": "string"
- },
- "httpsProxy": {
- "description": "httpsProxy is a proxy used to reach the git repository over https",
- "type": "string"
- },
- "message": {
- "description": "message is the description of a specific commit",
- "type": "string"
- },
- "noProxy": {
- "description": "noProxy is the list of domains for which the proxy should not be used",
- "type": "string"
- },
- "ref": {
- "description": "ref is the branch/tag/ref to build.",
- "type": "string"
- },
- "uri": {
- "description": "uri points to the source that will be built. The structure of the source will depend on the type of build to run",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.GitSourceRevision": {
- "description": "GitSourceRevision is the commit information from a git source for a build",
- "type": "object",
- "properties": {
- "author": {
- "description": "author is the author of a specific commit",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceControlUser"
- },
- "commit": {
- "description": "commit is the commit hash identifying a specific commit",
- "type": "string"
- },
- "committer": {
- "description": "committer is the committer of a specific commit",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SourceControlUser"
- },
- "message": {
- "description": "message is the description of a specific commit",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.ImageChangeCause": {
- "description": "ImageChangeCause contains information about the image that triggered a build",
- "type": "object",
- "properties": {
- "fromRef": {
- "description": "fromRef contains detailed information about an image that triggered a build.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "imageID": {
- "description": "imageID is the ID of the image that triggered a new build.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.ImageChangeTrigger": {
- "description": "ImageChangeTrigger allows builds to be triggered when an ImageStream changes",
- "type": "object",
- "properties": {
- "from": {
- "description": "from is a reference to an ImageStreamTag that will trigger a build when updated It is optional. If no From is specified, the From image from the build strategy will be used. Only one ImageChangeTrigger with an empty From reference is allowed in a build configuration.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "lastTriggeredImageID": {
- "description": "lastTriggeredImageID is used internally by the ImageChangeController to save last used image ID for build This field is deprecated and will be removed in a future release. Deprecated",
- "type": "string"
- },
- "paused": {
- "description": "paused is true if this trigger is temporarily disabled. Optional.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.build.v1.ImageChangeTriggerStatus": {
- "description": "ImageChangeTriggerStatus tracks the latest resolved status of the associated ImageChangeTrigger policy specified in the BuildConfigSpec.Triggers struct.",
- "type": "object",
- "properties": {
- "from": {
- "description": "from is the ImageStreamTag that is the source of the trigger.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageStreamTagReference"
- },
- "lastTriggerTime": {
- "description": "lastTriggerTime is the last time this particular ImageStreamTag triggered a Build to start. This field is only updated when this trigger specifically started a Build.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "lastTriggeredImageID": {
- "description": "lastTriggeredImageID represents the sha/id of the ImageStreamTag when a Build for this BuildConfig was started. The lastTriggeredImageID is updated each time a Build for this BuildConfig is started, even if this ImageStreamTag is not the reason the Build is started.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.ImageLabel": {
- "description": "ImageLabel represents a label applied to the resulting image.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name defines the name of the label. It must have non-zero length.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value defines the literal value of the label.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.ImageSource": {
- "description": "ImageSource is used to describe build source that will be extracted from an image or used during a multi stage build. A reference of type ImageStreamTag, ImageStreamImage or DockerImage may be used. A pull secret can be specified to pull the image from an external registry or override the default service account secret if pulling from the internal registry. Image sources can either be used to extract content from an image and place it into the build context along with the repository source, or used directly during a multi-stage container image build to allow content to be copied without overwriting the contents of the repository source (see the 'paths' and 'as' fields).",
- "type": "object",
- "required": [
- "from"
- ],
- "properties": {
- "as": {
- "description": "A list of image names that this source will be used in place of during a multi-stage container image build. For instance, a Dockerfile that uses \"COPY --from=nginx:latest\" will first check for an image source that has \"nginx:latest\" in this field before attempting to pull directly. If the Dockerfile does not reference an image source it is ignored. This field and paths may both be set, in which case the contents will be used twice.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "from": {
- "description": "from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "paths": {
- "description": "paths is a list of source and destination paths to copy from the image. This content will be copied into the build context prior to starting the build. If no paths are set, the build context will not be altered.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageSourcePath"
- }
- },
- "pullSecret": {
- "description": "pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- }
- }
- },
- "com.github.openshift.api.build.v1.ImageSourcePath": {
- "description": "ImageSourcePath describes a path to be copied from a source image and its destination within the build directory.",
- "type": "object",
- "required": [
- "sourcePath",
- "destinationDir"
- ],
- "properties": {
- "destinationDir": {
- "description": "destinationDir is the relative directory within the build directory where files copied from the image are placed.",
- "type": "string",
- "default": ""
- },
- "sourcePath": {
- "description": "sourcePath is the absolute path of the file or directory inside the image to copy to the build directory. If the source path ends in /. then the content of the directory will be copied, but the directory itself will not be created at the destination.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.ImageStreamTagReference": {
- "description": "ImageStreamTagReference references the ImageStreamTag in an image change trigger by namespace and name.",
- "type": "object",
- "properties": {
- "name": {
- "description": "name is the name of the ImageStreamTag for an ImageChangeTrigger",
- "type": "string"
- },
- "namespace": {
- "description": "namespace is the namespace where the ImageStreamTag for an ImageChangeTrigger is located",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.JenkinsPipelineBuildStrategy": {
- "description": "JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines",
- "type": "object",
- "properties": {
- "env": {
- "description": "env contains additional environment variables you want to pass into a build pipeline.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "jenkinsfile": {
- "description": "jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.",
- "type": "string"
- },
- "jenkinsfilePath": {
- "description": "jenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline relative to the root of the context (contextDir). If both JenkinsfilePath & Jenkinsfile are both not specified, this defaults to Jenkinsfile in the root of the specified contextDir.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.ProxyConfig": {
- "description": "ProxyConfig defines what proxies to use for an operation",
- "type": "object",
- "properties": {
- "httpProxy": {
- "description": "httpProxy is a proxy used to reach the git repository over http",
- "type": "string"
- },
- "httpsProxy": {
- "description": "httpsProxy is a proxy used to reach the git repository over https",
- "type": "string"
- },
- "noProxy": {
- "description": "noProxy is the list of domains for which the proxy should not be used",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.SecretBuildSource": {
- "description": "SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting.",
- "type": "object",
- "required": [
- "secret"
- ],
- "properties": {
- "destinationDir": {
- "description": "destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build.",
- "type": "string"
- },
- "secret": {
- "description": "secret is a reference to an existing secret that you want to use in your build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- }
- }
- },
- "com.github.openshift.api.build.v1.SecretLocalReference": {
- "description": "SecretLocalReference contains information that points to the local secret being used",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the resource in the same namespace being referenced",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.SecretSpec": {
- "description": "SecretSpec specifies a secret to be included in a build pod and its corresponding mount point",
- "type": "object",
- "required": [
- "secretSource",
- "mountPath"
- ],
- "properties": {
- "mountPath": {
- "description": "mountPath is the path at which to mount the secret",
- "type": "string",
- "default": ""
- },
- "secretSource": {
- "description": "secretSource is a reference to the secret",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- }
- }
- },
- "com.github.openshift.api.build.v1.SourceBuildStrategy": {
- "description": "SourceBuildStrategy defines input parameters specific to an Source build.",
- "type": "object",
- "required": [
- "from"
- ],
- "properties": {
- "env": {
- "description": "env contains additional environment variables you want to pass into a builder container.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "forcePull": {
- "description": "forcePull describes if the builder should pull the images from registry prior to building.",
- "type": "boolean"
- },
- "from": {
- "description": "from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "incremental": {
- "description": "incremental flag forces the Source build to do incremental builds if true.",
- "type": "boolean"
- },
- "pullSecret": {
- "description": "pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "scripts": {
- "description": "scripts is the location of Source scripts",
- "type": "string"
- },
- "volumes": {
- "description": "volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.BuildVolume"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "name",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.build.v1.SourceControlUser": {
- "description": "SourceControlUser defines the identity of a user of source control",
- "type": "object",
- "properties": {
- "email": {
- "description": "email of the source control user",
- "type": "string"
- },
- "name": {
- "description": "name of the source control user",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.build.v1.SourceRevision": {
- "description": "SourceRevision is the revision or commit information from the source for the build",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "git": {
- "description": "git contains information about git-based build source",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.GitSourceRevision"
- },
- "type": {
- "description": "type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.build.v1.SourceStrategyOptions": {
- "description": "SourceStrategyOptions contains extra strategy options for Source builds",
- "type": "object",
- "properties": {
- "incremental": {
- "description": "incremental overrides the source-strategy incremental option in the build config",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.build.v1.StageInfo": {
- "description": "StageInfo contains details about a build stage.",
- "type": "object",
- "properties": {
- "durationMilliseconds": {
- "description": "durationMilliseconds identifies how long the stage took to complete in milliseconds. Note: the duration of a stage can exceed the sum of the duration of the steps within the stage as not all actions are accounted for in explicit build steps.",
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "description": "name is a unique identifier for each build stage that occurs.",
- "type": "string"
- },
- "startTime": {
- "description": "startTime is a timestamp representing the server time when this Stage started. It is represented in RFC3339 form and is in UTC.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "steps": {
- "description": "steps contains details about each step that occurs during a build stage including start time and duration in milliseconds.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.StepInfo"
- }
- }
- }
- },
- "com.github.openshift.api.build.v1.StepInfo": {
- "description": "StepInfo contains details about a build step.",
- "type": "object",
- "properties": {
- "durationMilliseconds": {
- "description": "durationMilliseconds identifies how long the step took to complete in milliseconds.",
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "description": "name is a unique identifier for each build step.",
- "type": "string"
- },
- "startTime": {
- "description": "startTime is a timestamp representing the server time when this Step started. it is represented in RFC3339 form and is in UTC.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- }
- }
- },
- "com.github.openshift.api.build.v1.WebHookTrigger": {
- "description": "WebHookTrigger is a trigger that gets invoked using a webhook type of post",
- "type": "object",
- "properties": {
- "allowEnv": {
- "description": "allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook.",
- "type": "boolean"
- },
- "secret": {
- "description": "secret used to validate requests. Deprecated: use SecretReference instead.",
- "type": "string"
- },
- "secretReference": {
- "description": "secretReference is a reference to a secret in the same namespace, containing the value to be validated when the webhook is invoked. The secret being referenced must contain a key named \"WebHookSecretKey\", the value of which will be checked against the value supplied in the webhook invocation.",
- "$ref": "#/definitions/com.github.openshift.api.build.v1.SecretLocalReference"
- }
- }
- },
- "com.github.openshift.api.cloudnetwork.v1.CloudPrivateIPConfig": {
- "description": "CloudPrivateIPConfig performs an assignment of a private IP address to the primary NIC associated with cloud VMs. This is done by specifying the IP and Kubernetes node which the IP should be assigned to. This CRD is intended to be used by the network plugin which manages the cluster network. The spec side represents the desired state requested by the network plugin, and the status side represents the current state that this CRD's controller has executed. No users will have permission to modify it, and if a cluster-admin decides to edit it for some reason, their changes will be overwritten the next time the network plugin reconciles the object. Note: the CR's name must specify the requested private IP address (can be IPv4 or IPv6).\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the definition of the desired private IP request.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.cloudnetwork.v1.CloudPrivateIPConfigSpec"
- },
- "status": {
- "description": "status is the observed status of the desired private IP request. Read-only.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.cloudnetwork.v1.CloudPrivateIPConfigStatus"
- }
- }
- },
- "com.github.openshift.api.cloudnetwork.v1.CloudPrivateIPConfigSpec": {
- "description": "CloudPrivateIPConfigSpec consists of a node name which the private IP should be assigned to.",
- "type": "object",
- "properties": {
- "node": {
- "description": "node is the node name, as specified by the Kubernetes field: node.metadata.name",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.cloudnetwork.v1.CloudPrivateIPConfigStatus": {
- "description": "CloudPrivateIPConfigStatus specifies the node assignment together with its assignment condition.",
- "type": "object",
- "required": [
- "conditions"
- ],
- "properties": {
- "conditions": {
- "description": "condition is the assignment condition of the private IP and its status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "node": {
- "description": "node is the node name, as specified by the Kubernetes field: node.metadata.name",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.APIServer": {
- "description": "APIServer holds configuration (like serving certificates, client CA and CORS domains) shared by all API servers in the system, among them especially kube-apiserver and openshift-apiserver. The canonical name of an instance is 'cluster'.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.APIServerEncryption": {
- "description": "APIServerEncryption is used to encrypt sensitive resources on the cluster.",
- "type": "object",
- "properties": {
- "kms": {
- "description": "kms defines the configuration for the external KMS instance that manages the encryption keys, when KMS encryption is enabled sensitive resources will be encrypted using keys managed by an externally configured KMS instance.\n\nThe Key Management Service (KMS) instance provides symmetric encryption and is responsible for managing the lifecyle of the encryption keys outside of the control plane. This allows integration with an external provider to manage the data encryption keys securely.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KMSConfig"
- },
- "type": {
- "description": "type defines what encryption type should be used to encrypt resources at the datastore layer. When this field is unset (i.e. when it is set to the empty string), identity is implied. The behavior of unset can and will change over time. Even if encryption is enabled by default, the meaning of unset may change to a different encryption type based on changes in best practices.\n\nWhen encryption is enabled, all sensitive resources shipped with the platform are encrypted. This list of sensitive resources can and will change over time. The current authoritative list is:\n\n 1. secrets\n 2. configmaps\n 3. routes.route.openshift.io\n 4. oauthaccesstokens.oauth.openshift.io\n 5. oauthauthorizetokens.oauth.openshift.io",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "kms": "KMS"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.APIServerList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServer"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.APIServerNamedServingCert": {
- "description": "APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate.",
- "type": "object",
- "required": [
- "servingCertificate"
- ],
- "properties": {
- "names": {
- "description": "names is a optional list of explicit DNS names (leading wildcards allowed) that should use this certificate to serve secure traffic. If no names are provided, the implicit names will be extracted from the certificates. Exact names trump over wildcard names. Explicit names defined here trump over extracted implicit names.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "servingCertificate": {
- "description": "servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic. The secret must exist in the openshift-config namespace and contain the following required fields: - Secret.Data[\"tls.key\"] - TLS private key. - Secret.Data[\"tls.crt\"] - TLS certificate.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- }
- }
- },
- "com.github.openshift.api.config.v1.APIServerServingCerts": {
- "type": "object",
- "properties": {
- "namedCertificates": {
- "description": "namedCertificates references secrets containing the TLS cert info for serving secure traffic to specific hostnames. If no named certificates are provided, or no named certificates match the server name as understood by a client, the defaultServingCertificate will be used.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerNamedServingCert"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.APIServerSpec": {
- "type": "object",
- "properties": {
- "additionalCORSAllowedOrigins": {
- "description": "additionalCORSAllowedOrigins lists additional, user-defined regular expressions describing hosts for which the API server allows access using the CORS headers. This may be needed to access the API and the integrated OAuth server from JavaScript applications. The values are regular expressions that correspond to the Golang regular expression language.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "audit": {
- "description": "audit specifies the settings for audit configuration to be applied to all OpenShift-provided API servers in the cluster.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Audit"
- },
- "clientCA": {
- "description": "clientCA references a ConfigMap containing a certificate bundle for the signers that will be recognized for incoming client certificates in addition to the operator managed signers. If this is empty, then only operator managed signers are valid. You usually only have to set this if you have your own PKI you wish to honor client certificates from. The ConfigMap must exist in the openshift-config namespace and contain the following required fields: - ConfigMap.Data[\"ca-bundle.crt\"] - CA bundle.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "encryption": {
- "description": "encryption allows the configuration of encryption of resources at the datastore layer.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerEncryption"
- },
- "servingCerts": {
- "description": "servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates will be used for serving secure traffic.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.APIServerServingCerts"
- },
- "tlsSecurityProfile": {
- "description": "tlsSecurityProfile specifies settings for TLS connections for externally exposed servers.\n\nWhen omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is the Intermediate profile.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TLSSecurityProfile"
- }
- }
- },
- "com.github.openshift.api.config.v1.APIServerStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1.AWSDNSSpec": {
- "description": "AWSDNSSpec contains DNS configuration specific to the Amazon Web Services cloud provider.",
- "type": "object",
- "properties": {
- "privateZoneIAMRole": {
- "description": "privateZoneIAMRole contains the ARN of an IAM role that should be assumed when performing operations on the cluster's private hosted zone specified in the cluster DNS config. When left empty, no role should be assumed.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.AWSIngressSpec": {
- "description": "AWSIngressSpec holds the desired state of the Ingress for Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "type allows user to set a load balancer type. When this field is set the default ingresscontroller will get created using the specified LBType. If this field is not set then the default ingress controller of LBType Classic will be created. Valid values are:\n\n* \"Classic\": A Classic Load Balancer that makes routing decisions at either\n the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See\n the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb\n\n* \"NLB\": A Network Load Balancer that makes routing decisions at the\n transport layer (TCP/SSL). See the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.config.v1.AWSKMSConfig": {
- "description": "AWSKMSConfig defines the KMS config specific to AWS KMS provider",
- "type": "object",
- "required": [
- "keyARN",
- "region"
- ],
- "properties": {
- "keyARN": {
- "description": "keyARN specifies the Amazon Resource Name (ARN) of the AWS KMS key used for encryption. The value must adhere to the format `arn:aws:kms:::key/`, where: - `` is the AWS region consisting of lowercase letters and hyphens followed by a number. - `` is a 12-digit numeric identifier for the AWS account. - `` is a unique identifier for the KMS key, consisting of lowercase hexadecimal characters and hyphens.",
- "type": "string",
- "default": ""
- },
- "region": {
- "description": "region specifies the AWS region where the KMS instance exists, and follows the format `--`, e.g.: `us-east-1`. Only lowercase letters and hyphens followed by numbers are allowed.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.AWSPlatformSpec": {
- "description": "AWSPlatformSpec holds the desired state of the Amazon Web Services infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object",
- "properties": {
- "serviceEndpoints": {
- "description": "serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSServiceEndpoint"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.AWSPlatformStatus": {
- "description": "AWSPlatformStatus holds the current status of the Amazon Web Services infrastructure provider.",
- "type": "object",
- "required": [
- "region"
- ],
- "properties": {
- "cloudLoadBalancerConfig": {
- "description": "cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer.",
- "default": {
- "dnsType": "PlatformDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerConfig"
- },
- "ipFamily": {
- "description": "ipFamily specifies the IP protocol family that should be used for AWS network resources. This controls whether AWS resources are created with IPv4-only, or dual-stack networking with IPv4 or IPv6 as the primary protocol family.",
- "type": "string",
- "default": "IPv4"
- },
- "region": {
- "description": "region holds the default AWS region for new AWS resources created by the cluster.",
- "type": "string",
- "default": ""
- },
- "resourceTags": {
- "description": "resourceTags is a list of additional tags to apply to AWS resources created for the cluster. See https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html for information on tagging AWS resources. AWS supports a maximum of 50 tags per resource. OpenShift reserves 25 tags for its use, leaving 25 tags available for the user.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSResourceTag"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "serviceEndpoints": {
- "description": "serviceEndpoints list contains custom endpoints which will override default service endpoint of AWS Services. There must be only one ServiceEndpoint for a service.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSServiceEndpoint"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.AWSResourceTag": {
- "description": "AWSResourceTag is a tag to apply to AWS resources created for the cluster.",
- "type": "object",
- "required": [
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key sets the key of the AWS resource tag key-value pair. Key is required when defining an AWS resource tag. Key should consist of between 1 and 128 characters, and may contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value sets the value of the AWS resource tag key-value pair. Value is required when defining an AWS resource tag. Value should consist of between 1 and 256 characters, and may contain only the set of alphanumeric characters, space (' '), '_', '.', '/', '=', '+', '-', ':', and '@'. Some AWS service do not support empty values. Since tags are added to resources in many services, the length of the tag value must meet the requirements of all services.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.AWSServiceEndpoint": {
- "description": "AWSServiceEndpoint store the configuration of a custom url to override existing defaults of AWS Services.",
- "type": "object",
- "required": [
- "name",
- "url"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the AWS service. The list of all the service names can be found at https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html This must be provided and cannot be empty.",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.AdmissionConfig": {
- "type": "object",
- "properties": {
- "disabledPlugins": {
- "description": "disabledPlugins is a list of admission plugins that must be off. Putting something in this list is almost always a mistake and likely to result in cluster instability.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "enabledPlugins": {
- "description": "enabledPlugins is a list of admission plugins that must be on in addition to the default list. Some admission plugins are disabled by default, but certain configurations require them. This is fairly uncommon and can result in performance penalties and unexpected behavior.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "pluginConfig": {
- "type": "object",
- "additionalProperties": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AdmissionPluginConfig"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.AdmissionPluginConfig": {
- "description": "AdmissionPluginConfig holds the necessary configuration options for admission plugins",
- "type": "object",
- "required": [
- "location",
- "configuration"
- ],
- "properties": {
- "configuration": {
- "description": "configuration is an embedded configuration object to be used as the plugin's configuration. If present, it will be used instead of the path to the configuration file.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "location": {
- "description": "location is the path to a configuration file that contains the plugin's configuration",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.AlibabaCloudPlatformSpec": {
- "description": "AlibabaCloudPlatformSpec holds the desired state of the Alibaba Cloud infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.AlibabaCloudPlatformStatus": {
- "description": "AlibabaCloudPlatformStatus holds the current status of the Alibaba Cloud infrastructure provider.",
- "type": "object",
- "required": [
- "region"
- ],
- "properties": {
- "region": {
- "description": "region specifies the region for Alibaba Cloud resources created for the cluster.",
- "type": "string",
- "default": ""
- },
- "resourceGroupID": {
- "description": "resourceGroupID is the ID of the resource group for the cluster.",
- "type": "string"
- },
- "resourceTags": {
- "description": "resourceTags is a list of additional tags to apply to Alibaba Cloud resources created for the cluster.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AlibabaCloudResourceTag"
- },
- "x-kubernetes-list-map-keys": [
- "key"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.AlibabaCloudResourceTag": {
- "description": "AlibabaCloudResourceTag is the set of tags to add to apply to resources.",
- "type": "object",
- "required": [
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key is the key of the tag.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value is the value of the tag.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Audit": {
- "type": "object",
- "properties": {
- "customRules": {
- "description": "customRules specify profiles per group. These profile take precedence over the top-level profile field if they apply. They are evaluation from top to bottom and the first one that matches, applies.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AuditCustomRule"
- },
- "x-kubernetes-list-map-keys": [
- "group"
- ],
- "x-kubernetes-list-type": "map"
- },
- "profile": {
- "description": "profile specifies the name of the desired top-level audit profile to be applied to all requests sent to any of the OpenShift-provided API servers in the cluster (kube-apiserver, openshift-apiserver and oauth-apiserver), with the exception of those requests that match one or more of the customRules.\n\nThe following profiles are provided: - Default: default policy which means MetaData level logging with the exception of events\n (not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody\n level).\n- WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.\n\nWarning: It is not recommended to disable audit logging by using the `None` profile unless you are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues. If you disable audit logging and a support situation arises, you might need to enable audit logging and reproduce the issue in order to troubleshoot properly.\n\nIf unset, the 'Default' profile is used as the default.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.AuditConfig": {
- "description": "AuditConfig holds configuration for the audit capabilities",
- "type": "object",
- "required": [
- "enabled",
- "auditFilePath",
- "maximumFileRetentionDays",
- "maximumRetainedFiles",
- "maximumFileSizeMegabytes",
- "policyFile",
- "policyConfiguration",
- "logFormat",
- "webHookKubeConfig",
- "webHookMode"
- ],
- "properties": {
- "auditFilePath": {
- "description": "All requests coming to the apiserver will be logged to this file.",
- "type": "string",
- "default": ""
- },
- "enabled": {
- "description": "If this flag is set, audit log will be printed in the logs. The logs contains, method, user and a requested URL.",
- "type": "boolean",
- "default": false
- },
- "logFormat": {
- "description": "Format of saved audits (legacy or json).",
- "type": "string",
- "default": ""
- },
- "maximumFileRetentionDays": {
- "description": "Maximum number of days to retain old log files based on the timestamp encoded in their filename.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "maximumFileSizeMegabytes": {
- "description": "Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "maximumRetainedFiles": {
- "description": "Maximum number of old log files to retain.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "policyConfiguration": {
- "description": "policyConfiguration is an embedded policy configuration object to be used as the audit policy configuration. If present, it will be used instead of the path to the policy file.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "policyFile": {
- "description": "policyFile is a path to the file that defines the audit policy configuration.",
- "type": "string",
- "default": ""
- },
- "webHookKubeConfig": {
- "description": "Path to a .kubeconfig formatted file that defines the audit webhook configuration.",
- "type": "string",
- "default": ""
- },
- "webHookMode": {
- "description": "Strategy for sending audit events (block or batch).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.AuditCustomRule": {
- "description": "AuditCustomRule describes a custom rule for an audit profile that takes precedence over the top-level profile.",
- "type": "object",
- "required": [
- "group",
- "profile"
- ],
- "properties": {
- "group": {
- "description": "group is a name of group a request user must be member of in order to this profile to apply.",
- "type": "string",
- "default": ""
- },
- "profile": {
- "description": "profile specifies the name of the desired audit policy configuration to be deployed to all OpenShift-provided API servers in the cluster.\n\nThe following profiles are provided: - Default: the existing default policy. - WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', but also logs request and response HTTP payloads for read requests (get, list). - None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.\n\nIf unset, the 'Default' profile is used as the default.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Authentication": {
- "description": "Authentication specifies cluster-wide settings for authentication (like OAuth and webhook token authenticators). The canonical name of an instance is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AuthenticationSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AuthenticationStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.AuthenticationList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Authentication"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.AuthenticationSpec": {
- "type": "object",
- "properties": {
- "oauthMetadata": {
- "description": "oauthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for an external OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 If oauthMetadata.name is non-empty, this value has precedence over any metadata reference stored in status. The key \"oauthMetadata\" is used to locate the data. If specified and the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "oidcProviders": {
- "description": "oidcProviders are OIDC identity providers that can issue tokens for this cluster Can only be set if \"Type\" is set to \"OIDC\".\n\nAt most one provider can be configured.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCProvider"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "serviceAccountIssuer": {
- "description": "serviceAccountIssuer is the identifier of the bound service account token issuer. The default is https://kubernetes.default.svc WARNING: Updating this field will not result in immediate invalidation of all bound tokens with the previous issuer value. Instead, the tokens issued by previous service account issuer will continue to be trusted for a time period chosen by the platform (currently set to 24h). This time period is subject to change over time. This allows internal components to transition to use new service account issuer without service distruption.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type identifies the cluster managed, user facing authentication mode in use. Specifically, it manages the component that responds to login attempts. The default is IntegratedOAuth.",
- "type": "string",
- "default": ""
- },
- "webhookTokenAuthenticator": {
- "description": "webhookTokenAuthenticator configures a remote token reviewer. These remote authentication webhooks can be used to verify bearer tokens via the tokenreviews.authentication.k8s.io REST API. This is required to honor bearer tokens that are provisioned by an external authentication service.\n\nCan only be set if \"Type\" is set to \"None\".",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.WebhookTokenAuthenticator"
- },
- "webhookTokenAuthenticators": {
- "description": "webhookTokenAuthenticators is DEPRECATED, setting it has no effect.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DeprecatedWebhookTokenAuthenticator"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.AuthenticationStatus": {
- "type": "object",
- "properties": {
- "integratedOAuthMetadata": {
- "description": "integratedOAuthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for the in-cluster integrated OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This contains the observed value based on cluster state. An explicitly set value in spec.oauthMetadata has precedence over this field. This field has no meaning if authentication spec.type is not set to IntegratedOAuth. The key \"oauthMetadata\" is used to locate the data. If the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config-managed.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "oidcClients": {
- "description": "oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCClientStatus"
- },
- "x-kubernetes-list-map-keys": [
- "componentNamespace",
- "componentName"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.AzurePlatformSpec": {
- "description": "AzurePlatformSpec holds the desired state of the Azure infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.AzurePlatformStatus": {
- "description": "AzurePlatformStatus holds the current status of the Azure infrastructure provider.",
- "type": "object",
- "required": [
- "resourceGroupName"
- ],
- "properties": {
- "armEndpoint": {
- "description": "armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack.",
- "type": "string"
- },
- "cloudLoadBalancerConfig": {
- "description": "cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer.",
- "default": {
- "dnsType": "PlatformDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerConfig"
- },
- "cloudName": {
- "description": "cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK with the appropriate Azure API endpoints. If empty, the value is equal to `AzurePublicCloud`.",
- "type": "string"
- },
- "ipFamily": {
- "description": "ipFamily specifies the IP protocol family that should be used for Azure network resources. This controls whether Azure resources are created with IPv4-only, or dual-stack networking with IPv4 or IPv6 as the primary protocol family.",
- "type": "string",
- "default": "IPv4"
- },
- "networkResourceGroupName": {
- "description": "networkResourceGroupName is the Resource Group for network resources like the Virtual Network and Subnets used by the cluster. If empty, the value is same as ResourceGroupName.",
- "type": "string"
- },
- "resourceGroupName": {
- "description": "resourceGroupName is the Resource Group for new Azure resources created for the cluster.",
- "type": "string",
- "default": ""
- },
- "resourceTags": {
- "description": "resourceTags is a list of additional tags to apply to Azure resources created for the cluster. See https://docs.microsoft.com/en-us/rest/api/resources/tags for information on tagging Azure resources. Due to limitations on Automation, Content Delivery Network, DNS Azure resources, a maximum of 15 tags may be applied. OpenShift reserves 5 tags for internal use, allowing 10 tags for user configuration.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AzureResourceTag"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.AzureResourceTag": {
- "description": "AzureResourceTag is a tag to apply to Azure resources created for the cluster.",
- "type": "object",
- "required": [
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key is the key part of the tag. A tag key can have a maximum of 128 characters and cannot be empty. Key must begin with a letter, end with a letter, number or underscore, and must contain only alphanumeric characters and the following special characters `_ . -`.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value is the value part of the tag. A tag value can have a maximum of 256 characters and cannot be empty. Value must contain only alphanumeric characters and the following special characters `_ + , - . / : ; < = > ? @`.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.BareMetalPlatformLoadBalancer": {
- "description": "BareMetalPlatformLoadBalancer defines the load balancer used by the cluster on BareMetal platform.",
- "type": "object",
- "properties": {
- "type": {
- "description": "type defines the type of load balancer used by the cluster on BareMetal platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
- "type": "string",
- "default": "OpenShiftManagedDefault"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.config.v1.BareMetalPlatformSpec": {
- "description": "BareMetalPlatformSpec holds the desired state of the BareMetal infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object",
- "properties": {
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "machineNetworks": {
- "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example \"10.0.0.0/8\" or \"fd00::/8\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.BareMetalPlatformStatus": {
- "description": "BareMetalPlatformStatus holds the current status of the BareMetal infrastructure provider. For more information about the network architecture used with the BareMetal platform type, see: https://github.com/openshift/installer/blob/master/docs/design/baremetal/networking-infrastructure.md",
- "type": "object",
- "required": [
- "apiServerInternalIPs",
- "ingressIPs"
- ],
- "properties": {
- "apiServerInternalIP": {
- "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
- "type": "string"
- },
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "ingressIP": {
- "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
- "type": "string"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "loadBalancer": {
- "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
- "default": {
- "type": "OpenShiftManagedDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BareMetalPlatformLoadBalancer"
- },
- "machineNetworks": {
- "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "nodeDNSIP": {
- "description": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for BareMetal deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.BasicAuthIdentityProvider": {
- "description": "BasicAuthPasswordIdentityProvider provides identities for users authenticating using HTTP basic auth credentials",
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "tlsClientCert": {
- "description": "tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key \"tls.crt\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "tlsClientKey": {
- "description": "tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key \"tls.key\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Build": {
- "description": "Build configures the behavior of OpenShift builds for the entire cluster. This includes default settings that can be overridden in BuildConfig objects, and overrides which are applied to all builds.\n\nThe canonical name is \"cluster\"\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user-settable values for the build controller configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildSpec"
- }
- }
- },
- "com.github.openshift.api.config.v1.BuildDefaults": {
- "type": "object",
- "properties": {
- "defaultProxy": {
- "description": "defaultProxy contains the default proxy settings for all build operations, including image pull/push and source download.\n\nValues can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables in the build config's strategy.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxySpec"
- },
- "env": {
- "description": "env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "gitProxy": {
- "description": "gitProxy contains the proxy settings for git operations only. If set, this will override any Proxy settings for all git commands, such as git clone.\n\nValues that are not set here will be inherited from DefaultProxy.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxySpec"
- },
- "imageLabels": {
- "description": "imageLabels is a list of docker labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageLabel"
- }
- },
- "resources": {
- "description": "resources defines resource requirements to execute the build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
- }
- }
- },
- "com.github.openshift.api.config.v1.BuildList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Build"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.BuildOverrides": {
- "type": "object",
- "properties": {
- "forcePull": {
- "description": "forcePull overrides, if set, the equivalent value in the builds, i.e. false disables force pull for all builds, true enables force pull for all builds, independently of what each build specifies itself",
- "type": "boolean"
- },
- "imageLabels": {
- "description": "imageLabels is a list of docker labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user's label will be overwritten.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageLabel"
- }
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "tolerations": {
- "description": "tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.BuildSpec": {
- "type": "object",
- "properties": {
- "additionalTrustedCA": {
- "description": "additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted for image pushes and pulls during builds. The namespace for this config map is openshift-config.\n\nDEPRECATED: Additional CAs for image pull and push should be set on image.config.openshift.io/cluster instead.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "buildDefaults": {
- "description": "buildDefaults controls the default information for Builds",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildDefaults"
- },
- "buildOverrides": {
- "description": "buildOverrides controls override settings for builds",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildOverrides"
- }
- }
- },
- "com.github.openshift.api.config.v1.CertInfo": {
- "description": "CertInfo relates a certificate with a private key",
- "type": "object",
- "required": [
- "certFile",
- "keyFile"
- ],
- "properties": {
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ClientConnectionOverrides": {
- "type": "object",
- "required": [
- "acceptContentTypes",
- "contentType",
- "qps",
- "burst"
- ],
- "properties": {
- "acceptContentTypes": {
- "description": "acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular client.",
- "type": "string",
- "default": ""
- },
- "burst": {
- "description": "burst allows extra queries to accumulate when a client is exceeding its rate.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "contentType": {
- "description": "contentType is the content type used when sending data to the server from this client.",
- "type": "string",
- "default": ""
- },
- "qps": {
- "description": "qps controls the number of queries per second allowed for this connection.",
- "type": "number",
- "format": "float",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.config.v1.CloudControllerManagerStatus": {
- "description": "CloudControllerManagerStatus holds the state of Cloud Controller Manager (a.k.a. CCM or CPI) related settings",
- "type": "object",
- "properties": {
- "state": {
- "description": "state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager\n\nValid values are \"External\", \"None\" and omitted. When set to \"External\", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to \"None\", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.CloudLoadBalancerConfig": {
- "description": "CloudLoadBalancerConfig contains an union discriminator indicating the type of DNS solution in use within the cluster. When the DNSType is `ClusterHosted`, the cloud's Load Balancer configuration needs to be provided so that the DNS solution hosted within the cluster can be configured with those values.",
- "type": "object",
- "properties": {
- "clusterHosted": {
- "description": "clusterHosted holds the IP addresses of API, API-Int and Ingress Load Balancers on Cloud Platforms. The DNS solution hosted within the cluster use these IP addresses to provide resolution for API, API-Int and Ingress services.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerIPs"
- },
- "dnsType": {
- "description": "dnsType indicates the type of DNS solution in use within the cluster. Its default value of `PlatformDefault` indicates that the cluster's DNS is the default provided by the cloud platform. It can be set to `ClusterHosted` to bypass the configuration of the cloud default DNS. In this mode, the cluster needs to provide a self-hosted DNS solution for the cluster's installation to succeed. The cluster's use of the cloud's Load Balancers is unaffected by this setting. The value is immutable after it has been set at install time. Currently, there is no way for the customer to add additional DNS entries into the cluster hosted DNS. Enabling this functionality allows the user to start their own DNS solution outside the cluster after installation is complete. The customer would be responsible for configuring this custom DNS solution, and it can be run in addition to the in-cluster DNS solution.",
- "type": "string",
- "default": "PlatformDefault"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "dnsType",
- "fields-to-discriminateBy": {
- "clusterHosted": "ClusterHosted"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.CloudLoadBalancerIPs": {
- "description": "CloudLoadBalancerIPs contains the Load Balancer IPs for the cloud's API, API-Int and Ingress Load balancers. They will be populated as soon as the respective Load Balancers have been configured. These values are utilized to configure the DNS solution hosted within the cluster.",
- "type": "object",
- "properties": {
- "apiIntLoadBalancerIPs": {
- "description": "apiIntLoadBalancerIPs holds Load Balancer IPs for the internal API service. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Entries in the apiIntLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "apiLoadBalancerIPs": {
- "description": "apiLoadBalancerIPs holds Load Balancer IPs for the API service. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Could be empty for private clusters. Entries in the apiLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "ingressLoadBalancerIPs": {
- "description": "ingressLoadBalancerIPs holds IPs for Ingress Load Balancers. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Entries in the ingressLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterCondition": {
- "description": "ClusterCondition is a union of typed cluster conditions. The 'type' property determines which of the type-specific properties are relevant. When evaluated on a cluster, the condition may match, not match, or fail to evaluate.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "promql": {
- "description": "promql represents a cluster condition based on PromQL.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PromQLClusterCondition"
- },
- "type": {
- "description": "type represents the cluster-condition type. This defines the members and semantics of any additional properties.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterImagePolicy": {
- "description": "ClusterImagePolicy holds cluster-wide configuration for image signature verification\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec contains the configuration for the cluster image policy.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterImagePolicySpec"
- },
- "status": {
- "description": "status contains the observed state of the resource.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterImagePolicyStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterImagePolicyList": {
- "description": "ClusterImagePolicyList is a list of ClusterImagePolicy resources\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of ClusterImagePolices",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterImagePolicy"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterImagePolicySpec": {
- "description": "CLusterImagePolicySpec is the specification of the ClusterImagePolicy custom resource.",
- "type": "object",
- "required": [
- "scopes",
- "policy"
- ],
- "properties": {
- "policy": {
- "description": "policy is a required field that contains configuration to allow scopes to be verified, and defines how images not matching the verification policy will be treated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Policy"
- },
- "scopes": {
- "description": "scopes is a required field that defines the list of image identities assigned to a policy. Each item refers to a scope in a registry implementing the \"Docker Registry HTTP API V2\". Scopes matching individual images are named Docker references in the fully expanded form, either using a tag or digest. For example, docker.io/library/busybox:latest (not busybox:latest). More general scopes are prefixes of individual-image scopes, and specify a repository (by omitting the tag or digest), a repository namespace, or a registry host (by only specifying the host name and possibly a port number) or a wildcard expression starting with `*.`, for matching all subdomains (not including a port number). Wildcards are only supported for subdomain matching, and may not be used in the middle of the host, i.e. *.example.com is a valid case, but example*.*.com is not. This support no more than 256 scopes in one object. If multiple scopes match a given image, only the policy requirements for the most specific scope apply. The policy requirements for more general scopes are ignored. In addition to setting a policy appropriate for your own deployed applications, make sure that a policy on the OpenShift image repositories quay.io/openshift-release-dev/ocp-release, quay.io/openshift-release-dev/ocp-v4.0-art-dev (or on a more general scope) allows deployment of the OpenShift images required for cluster operation. If a scope is configured in both the ClusterImagePolicy and the ImagePolicy, or if the scope in ImagePolicy is nested under one of the scopes from the ClusterImagePolicy, only the policy from the ClusterImagePolicy will be applied. For additional details about the format, please refer to the document explaining the docker transport field, which can be found at: https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md#docker",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterImagePolicyStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of this API Resource.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterNetworkEntry": {
- "description": "ClusterNetworkEntry is a contiguous block of IP addresses from which pod IPs are allocated.",
- "type": "object",
- "required": [
- "cidr"
- ],
- "properties": {
- "cidr": {
- "description": "The complete block for pod IPs.",
- "type": "string",
- "default": ""
- },
- "hostPrefix": {
- "description": "The size (prefix) of block to allocate to each node. If this field is not used by the plugin, it can be left unset.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterOperator": {
- "description": "ClusterOperator holds the status of a core or optional OpenShift component managed by the Cluster Version Operator (CVO). This object is used by operators to convey their state to the rest of the cluster. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds configuration that could apply to any operator.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorSpec"
- },
- "status": {
- "description": "status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterOperatorList": {
- "description": "ClusterOperatorList is a list of OperatorStatus resources.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperator"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterOperatorSpec": {
- "description": "ClusterOperatorSpec is empty for now, but you could imagine holding information like \"pause\".",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.ClusterOperatorStatus": {
- "description": "ClusterOperatorStatus provides information about the status of the operator.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions describes the state of the operator's managed and monitored components.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorStatusCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "extension": {
- "description": "extension contains any additional status information specific to the operator which owns this status object.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "relatedObjects": {
- "description": "relatedObjects is a list of objects that are \"interesting\" or related to this operator. Common uses are: 1. the detailed resource driving the operator 2. operator namespaces 3. operand namespaces",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ObjectReference"
- }
- },
- "versions": {
- "description": "versions is a slice of operator and operand version tuples. Operators which manage multiple operands will have multiple operand entries in the array. Available operators must report the version of the operator itself with the name \"operator\". An operator reports a new \"operator\" version when it has rolled out the new version to all of its operands.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OperandVersion"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterOperatorStatusCondition": {
- "description": "ClusterOperatorStatusCondition represents the state of the operator's managed and monitored components.",
- "type": "object",
- "required": [
- "type",
- "status",
- "lastTransitionTime"
- ],
- "properties": {
- "lastTransitionTime": {
- "description": "lastTransitionTime is the time of the last update to the current status property.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "message provides additional information about the current condition. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
- "type": "string"
- },
- "reason": {
- "description": "reason is the CamelCase reason for the condition's current status.",
- "type": "string"
- },
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type specifies the aspect reported by this condition.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterVersion": {
- "description": "ClusterVersion is the configuration for the ClusterVersionOperator. This is where parameters related to automatic updates can be set.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the desired state of the cluster version - the operator will work to ensure that the desired version is applied to the cluster.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionSpec"
- },
- "status": {
- "description": "status contains information about the available updates and any in-progress updates.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterVersionCapabilitiesSpec": {
- "description": "ClusterVersionCapabilitiesSpec selects the managed set of optional, core cluster components.",
- "type": "object",
- "properties": {
- "additionalEnabledCapabilities": {
- "description": "additionalEnabledCapabilities extends the set of managed capabilities beyond the baseline defined in baselineCapabilitySet. The default is an empty set.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "baselineCapabilitySet": {
- "description": "baselineCapabilitySet selects an initial set of optional capabilities to enable, which can be extended via additionalEnabledCapabilities. If unset, the cluster will choose a default, and the default may change over time. The current default is vCurrent.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterVersionCapabilitiesStatus": {
- "description": "ClusterVersionCapabilitiesStatus describes the state of optional, core cluster components.",
- "type": "object",
- "properties": {
- "enabledCapabilities": {
- "description": "enabledCapabilities lists all the capabilities that are currently managed.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "knownCapabilities": {
- "description": "knownCapabilities lists all the capabilities known to the current cluster.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterVersionList": {
- "description": "ClusterVersionList is a list of ClusterVersion resources.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersion"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterVersionSpec": {
- "description": "ClusterVersionSpec is the desired version state of the cluster. It includes the version the cluster should be at, how the cluster is identified, and where the cluster should look for version updates.",
- "type": "object",
- "required": [
- "clusterID"
- ],
- "properties": {
- "capabilities": {
- "description": "capabilities configures the installation of optional, core cluster components. A null value here is identical to an empty object; see the child properties for default semantics.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionCapabilitiesSpec"
- },
- "channel": {
- "description": "channel is an identifier for explicitly requesting a non-default set of updates to be applied to this cluster. The default channel will contain stable updates that are appropriate for production clusters.",
- "type": "string"
- },
- "clusterID": {
- "description": "clusterID uniquely identifies this cluster. This is expected to be an RFC4122 UUID value (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx in hexadecimal values). This is a required field.",
- "type": "string",
- "default": ""
- },
- "desiredUpdate": {
- "description": "desiredUpdate is an optional field that indicates the desired value of the cluster version. Setting this value will trigger an upgrade (if the current version does not match the desired version). The set of recommended update values is listed as part of available updates in status, and setting values outside that range may cause the upgrade to fail.\n\nSome of the fields are inter-related with restrictions and meanings described here. 1. image is specified, version is specified, architecture is specified. API validation error. 2. image is specified, version is specified, architecture is not specified. The version extracted from the referenced image must match the specified version. 3. image is specified, version is not specified, architecture is specified. API validation error. 4. image is specified, version is not specified, architecture is not specified. image is used. 5. image is not specified, version is specified, architecture is specified. version and desired architecture are used to select an image. 6. image is not specified, version is specified, architecture is not specified. version and current architecture are used to select an image. 7. image is not specified, version is not specified, architecture is specified. API validation error. 8. image is not specified, version is not specified, architecture is not specified. API validation error.\n\nIf an upgrade fails the operator will halt and report status about the failing component. Setting the desired update value back to the previous version will cause a rollback to be attempted if the previous version is within the current minor version. Not all rollbacks will succeed, and some may unrecoverably break the cluster.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Update"
- },
- "overrides": {
- "description": "overrides is list of overides for components that are managed by cluster version operator. Marking a component unmanaged will prevent the operator from creating or updating the object.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ComponentOverride"
- },
- "x-kubernetes-list-map-keys": [
- "kind",
- "group",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "signatureStores": {
- "description": "signatureStores contains the upstream URIs to verify release signatures and optional reference to a config map by name containing the PEM-encoded CA bundle.\n\nBy default, CVO will use existing signature stores if this property is empty. The CVO will check the release signatures in the local ConfigMaps first. It will search for a valid signature in these stores in parallel only when local ConfigMaps did not include a valid signature. Validation will fail if none of the signature stores reply with valid signature before timeout. Setting signatureStores will replace the default signature stores with custom signature stores. Default stores can be used with custom signature stores by adding them manually.\n\nA maximum of 32 signature stores may be configured.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SignatureStore"
- },
- "x-kubernetes-list-map-keys": [
- "url"
- ],
- "x-kubernetes-list-type": "map"
- },
- "upstream": {
- "description": "upstream may be used to specify the preferred update server. By default it will use the appropriate update server for the cluster and region.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.ClusterVersionStatus": {
- "description": "ClusterVersionStatus reports the status of the cluster versioning, including any upgrades that are in progress. The current field will be set to whichever version the cluster is reconciling to, and the conditions array will report whether the update succeeded, is in progress, or is failing.",
- "type": "object",
- "required": [
- "desired",
- "observedGeneration",
- "versionHash",
- "availableUpdates"
- ],
- "properties": {
- "availableUpdates": {
- "description": "availableUpdates contains updates recommended for this cluster. Updates which appear in conditionalUpdates but not in availableUpdates may expose this cluster to known issues. This list may be empty if no updates are recommended, if the update service is unavailable, or if an invalid channel has been specified.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Release"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "capabilities": {
- "description": "capabilities describes the state of optional, core cluster components.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionCapabilitiesStatus"
- },
- "conditionalUpdates": {
- "description": "conditionalUpdates contains the list of updates that may be recommended for this cluster if it meets specific required conditions. Consumers interested in the set of updates that are actually recommended for this cluster should use availableUpdates. This list may be empty if no updates are recommended, if the update service is unavailable, or if an empty or invalid channel has been specified.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConditionalUpdate"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "conditions": {
- "description": "conditions provides information about the cluster version. The condition \"Available\" is set to true if the desiredUpdate has been reached. The condition \"Progressing\" is set to true if an update is being applied. The condition \"Degraded\" is set to true if an update is currently blocked by a temporary or permanent error. Conditions are only valid for the current desiredUpdate when metadata.generation is equal to status.generation.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorStatusCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "desired": {
- "description": "desired is the version that the cluster is reconciling towards. If the cluster is not yet fully initialized desired will be set with the information available, which may be an image or a tag.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Release"
- },
- "history": {
- "description": "history contains a list of the most recent versions applied to the cluster. This value may be empty during cluster startup, and then will be updated when a new update is being applied. The newest update is first in the list and it is ordered by recency. Updates in the history have state Completed if the rollout completed - if an update was failing or halfway applied the state will be Partial. Only a limited amount of update history is preserved.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.UpdateHistory"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "observedGeneration": {
- "description": "observedGeneration reports which version of the spec is being synced. If this value is not equal to metadata.generation, then the desired and conditions fields may represent a previous version.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "versionHash": {
- "description": "versionHash is a fingerprint of the content that the cluster will be updated with. It is used by the operator to avoid unnecessary work and is for internal use only.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ComponentOverride": {
- "description": "ComponentOverride allows overriding cluster version operator's behavior for a component.",
- "type": "object",
- "required": [
- "kind",
- "group",
- "namespace",
- "name",
- "unmanaged"
- ],
- "properties": {
- "group": {
- "description": "group identifies the API group that the kind is in.",
- "type": "string",
- "default": ""
- },
- "kind": {
- "description": "kind indentifies which object to override.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is the component's name.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace is the component's namespace. If the resource is cluster scoped, the namespace should be empty.",
- "type": "string",
- "default": ""
- },
- "unmanaged": {
- "description": "unmanaged controls if cluster version operator should stop managing the resources in this cluster. Default: false",
- "type": "boolean",
- "default": false
- }
- }
- },
- "com.github.openshift.api.config.v1.ComponentRouteSpec": {
- "description": "ComponentRouteSpec allows for configuration of a route's hostname and serving certificate.",
- "type": "object",
- "required": [
- "namespace",
- "name",
- "hostname"
- ],
- "properties": {
- "hostname": {
- "description": "hostname is the hostname that should be used by the route.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is the logical name of the route to customize.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of status.componentRoutes if the route is to be customized.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace is the namespace of the route to customize.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of status.componentRoutes if the route is to be customized.",
- "type": "string",
- "default": ""
- },
- "servingCertKeyPairSecret": {
- "description": "servingCertKeyPairSecret is a reference to a secret of type `kubernetes.io/tls` in the openshift-config namespace. The serving cert/key pair must match and will be used by the operator to fulfill the intent of serving with this name. If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- }
- }
- },
- "com.github.openshift.api.config.v1.ComponentRouteStatus": {
- "description": "ComponentRouteStatus contains information allowing configuration of a route's hostname and serving certificate.",
- "type": "object",
- "required": [
- "namespace",
- "name",
- "defaultHostname",
- "relatedObjects"
- ],
- "properties": {
- "conditions": {
- "description": "conditions are used to communicate the state of the componentRoutes entry.\n\nSupported conditions include Available, Degraded and Progressing.\n\nIf available is true, the content served by the route can be accessed by users. This includes cases where a default may continue to serve content while the customized route specified by the cluster-admin is being configured.\n\nIf Degraded is true, that means something has gone wrong trying to handle the componentRoutes entry. The currentHostnames field may or may not be in effect.\n\nIf Progressing is true, that means the component is taking some action related to the componentRoutes entry.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "consumingUsers": {
- "description": "consumingUsers is a slice of ServiceAccounts that need to have read permission on the servingCertKeyPairSecret secret.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "currentHostnames": {
- "description": "currentHostnames is the list of current names used by the route. Typically, this list should consist of a single hostname, but if multiple hostnames are supported by the route the operator may write multiple entries to this list.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "defaultHostname": {
- "description": "defaultHostname is the hostname of this route prior to customization.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is the logical name of the route to customize. It does not have to be the actual name of a route resource but it cannot be renamed.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of spec.componentRoutes if the route is to be customized.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace is the namespace of the route to customize. It must be a real namespace. Using an actual namespace ensures that no two components will conflict and the same component can be installed multiple times.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of spec.componentRoutes if the route is to be customized.",
- "type": "string",
- "default": ""
- },
- "relatedObjects": {
- "description": "relatedObjects is a list of resources which are useful when debugging or inspecting how spec.componentRoutes is applied.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ObjectReference"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.ConditionalUpdate": {
- "description": "ConditionalUpdate represents an update which is recommended to some clusters on the version the current cluster is reconciling, but which may not be recommended for the current cluster.",
- "type": "object",
- "required": [
- "release",
- "risks"
- ],
- "properties": {
- "conditions": {
- "description": "conditions represents the observations of the conditional update's current status. Known types are: * Recommended, for whether the update is recommended for the current cluster.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "release": {
- "description": "release is the target of the update.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Release"
- },
- "risks": {
- "description": "risks represents the range of issues associated with updating to the target release. The cluster-version operator will evaluate all entries, and only recommend the update if there is at least one entry and all entries recommend the update.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConditionalUpdateRisk"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "name",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.config.v1.ConditionalUpdateRisk": {
- "description": "ConditionalUpdateRisk represents a reason and cluster-state for not recommending a conditional update.",
- "type": "object",
- "required": [
- "url",
- "name",
- "message",
- "matchingRules"
- ],
- "properties": {
- "matchingRules": {
- "description": "matchingRules is a slice of conditions for deciding which clusters match the risk and which do not. The slice is ordered by decreasing precedence. The cluster-version operator will walk the slice in order, and stop after the first it can successfully evaluate. If no condition can be successfully evaluated, the update will not be recommended.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterCondition"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "message": {
- "description": "message provides additional information about the risk of updating, in the event that matchingRules match the cluster state. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is the CamelCase reason for not recommending a conditional update, in the event that matchingRules match the cluster state.",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url contains information about this risk.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ConfigMapFileReference": {
- "description": "ConfigMapFileReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "key": {
- "description": "key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ConfigMapNameReference": {
- "description": "ConfigMapNameReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the metadata.name of the referenced config map",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Console": {
- "description": "Console holds cluster-wide configuration for the web console, including the logout URL, and reports the public URL of the console. The canonical name is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConsoleSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConsoleStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ConsoleAuthentication": {
- "description": "ConsoleAuthentication defines a list of optional configuration for console authentication.",
- "type": "object",
- "properties": {
- "logoutRedirect": {
- "description": "An optional, absolute URL to redirect web browsers to after logging out of the console. If not specified, it will redirect to the default login page. This is required when using an identity provider that supports single sign-on (SSO) such as: - OpenID (Keycloak, Azure) - RequestHeader (GSSAPI, SSPI, SAML) - OAuth (GitHub, GitLab, Google) Logging out of the console will destroy the user's token. The logoutRedirect provides the user the option to perform single logout (SLO) through the identity provider to destroy their single sign-on session.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.ConsoleList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Console"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ConsoleSpec": {
- "description": "ConsoleSpec is the specification of the desired behavior of the Console.",
- "type": "object",
- "properties": {
- "authentication": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConsoleAuthentication"
- }
- }
- },
- "com.github.openshift.api.config.v1.ConsoleStatus": {
- "description": "ConsoleStatus defines the observed status of the Console.",
- "type": "object",
- "properties": {
- "consoleURL": {
- "description": "The URL for the console. This will be derived from the host for the route that is created for the console.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Custom": {
- "description": "Custom provides the custom configuration of gatherers",
- "type": "object",
- "required": [
- "configs"
- ],
- "properties": {
- "configs": {
- "description": "configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers. It may not exceed 100 items and each gatherer can be present only once. It is possible to disable an entire set of gatherers while allowing a specific function within that set. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GathererConfig"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.CustomFeatureGates": {
- "type": "object",
- "properties": {
- "disabled": {
- "description": "disabled is a list of all feature gates that you want to force off",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "enabled": {
- "description": "enabled is a list of all feature gates that you want to force on",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.CustomTLSProfile": {
- "description": "CustomTLSProfile is a user-defined TLS security profile. Be extremely careful using a custom TLS profile as invalid configurations can be catastrophic.",
- "type": "object",
- "required": [
- "ciphers",
- "minTLSVersion"
- ],
- "properties": {
- "ciphers": {
- "description": "ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake. Operators may remove entries their operands do not support. For example, to use DES-CBC3-SHA (yaml):\n\n ciphers:\n - DES-CBC3-SHA",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "minTLSVersion": {
- "description": "minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml):\n\n minTLSVersion: VersionTLS11\n\nNOTE: currently the highest minTLSVersion allowed is VersionTLS12",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.DNS": {
- "description": "DNS holds cluster-wide information about DNS. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.DNSList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DNS"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.DNSPlatformSpec": {
- "description": "DNSPlatformSpec holds cloud-provider-specific configuration for DNS administration.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "aws": {
- "description": "aws contains DNS configuration specific to the Amazon Web Services cloud provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSDNSSpec"
- },
- "type": {
- "description": "type is the underlying infrastructure provider for the cluster. Allowed values: \"\", \"AWS\".\n\nIndividual components may not support all platforms, and must handle unrecognized platforms with best-effort defaults.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "aws": "AWS"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.DNSSpec": {
- "type": "object",
- "required": [
- "baseDomain"
- ],
- "properties": {
- "baseDomain": {
- "description": "baseDomain is the base domain of the cluster. All managed DNS records will be sub-domains of this base.\n\nFor example, given the base domain `openshift.example.com`, an API server DNS record may be created for `cluster-api.openshift.example.com`.\n\nOnce set, this field cannot be changed.",
- "type": "string",
- "default": ""
- },
- "platform": {
- "description": "platform holds configuration specific to the underlying infrastructure provider for DNS. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSPlatformSpec"
- },
- "privateZone": {
- "description": "privateZone is the location where all the DNS records that are only available internally to the cluster exist.\n\nIf this field is nil, no private records should be created.\n\nOnce set, this field cannot be changed.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSZone"
- },
- "publicZone": {
- "description": "publicZone is the location where all the DNS records that are publicly accessible to the internet exist.\n\nIf this field is nil, no public records should be created.\n\nOnce set, this field cannot be changed.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSZone"
- }
- }
- },
- "com.github.openshift.api.config.v1.DNSStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1.DNSZone": {
- "description": "DNSZone is used to define a DNS hosted zone. A zone can be identified by an ID or tags.",
- "type": "object",
- "properties": {
- "id": {
- "description": "id is the identifier that can be used to find the DNS hosted zone.\n\non AWS zone can be fetched using `ID` as id in [1] on Azure zone can be fetched using `ID` as a pre-determined name in [2], on GCP zone can be fetched using `ID` as a pre-determined name in [3].\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get",
- "type": "string"
- },
- "tags": {
- "description": "tags can be used to query the DNS hosted zone.\n\non AWS, resourcegroupstaggingapi [1] can be used to fetch a zone using `Tags` as tag-filters,\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.DelegatedAuthentication": {
- "description": "DelegatedAuthentication allows authentication to be disabled.",
- "type": "object",
- "properties": {
- "disabled": {
- "description": "disabled indicates that authentication should be disabled. By default it will use delegated authentication.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.config.v1.DelegatedAuthorization": {
- "description": "DelegatedAuthorization allows authorization to be disabled.",
- "type": "object",
- "properties": {
- "disabled": {
- "description": "disabled indicates that authorization should be disabled. By default it will use delegated authorization.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.config.v1.DeprecatedWebhookTokenAuthenticator": {
- "description": "deprecatedWebhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator. It's the same as WebhookTokenAuthenticator but it's missing the 'required' validation on KubeConfig field.",
- "type": "object",
- "required": [
- "kubeConfig"
- ],
- "properties": {
- "kubeConfig": {
- "description": "kubeConfig contains kube config file data which describes how to access the remote webhook service. For further details, see: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication The key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored. The namespace for this secret is determined by the point of use.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- }
- }
- },
- "com.github.openshift.api.config.v1.EquinixMetalPlatformSpec": {
- "description": "EquinixMetalPlatformSpec holds the desired state of the Equinix Metal infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.EquinixMetalPlatformStatus": {
- "description": "EquinixMetalPlatformStatus holds the current status of the Equinix Metal infrastructure provider.",
- "type": "object",
- "properties": {
- "apiServerInternalIP": {
- "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
- "type": "string"
- },
- "ingressIP": {
- "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.EtcdConnectionInfo": {
- "description": "EtcdConnectionInfo holds information necessary for connecting to an etcd server",
- "type": "object",
- "required": [
- "ca",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "ca": {
- "description": "ca is a file containing trusted roots for the etcd server certificates",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "urls": {
- "description": "urls are the URLs for etcd",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.EtcdStorageConfig": {
- "type": "object",
- "required": [
- "ca",
- "certFile",
- "keyFile",
- "storagePrefix"
- ],
- "properties": {
- "ca": {
- "description": "ca is a file containing trusted roots for the etcd server certificates",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "storagePrefix": {
- "description": "storagePrefix is the path within etcd that the OpenShift resources will be rooted under. This value, if changed, will mean existing objects in etcd will no longer be located.",
- "type": "string",
- "default": ""
- },
- "urls": {
- "description": "urls are the URLs for etcd",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.ExternalIPConfig": {
- "description": "ExternalIPConfig specifies some IP blocks relevant for the ExternalIP field of a Service resource.",
- "type": "object",
- "properties": {
- "autoAssignCIDRs": {
- "description": "autoAssignCIDRs is a list of CIDRs from which to automatically assign Service.ExternalIP. These are assigned when the service is of type LoadBalancer. In general, this is only useful for bare-metal clusters. In Openshift 3.x, this was misleadingly called \"IngressIPs\". Automatically assigned External IPs are not affected by any ExternalIPPolicy rules. Currently, only one entry may be provided.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "policy": {
- "description": "policy is a set of restrictions applied to the ExternalIP field. If nil or empty, then ExternalIP is not allowed to be set.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalIPPolicy"
- }
- }
- },
- "com.github.openshift.api.config.v1.ExternalIPPolicy": {
- "description": "ExternalIPPolicy configures exactly which IPs are allowed for the ExternalIP field in a Service. If the zero struct is supplied, then none are permitted. The policy controller always allows automatically assigned external IPs.",
- "type": "object",
- "properties": {
- "allowedCIDRs": {
- "description": "allowedCIDRs is the list of allowed CIDRs.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "rejectedCIDRs": {
- "description": "rejectedCIDRs is the list of disallowed CIDRs. These take precedence over allowedCIDRs.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.ExternalPlatformSpec": {
- "description": "ExternalPlatformSpec holds the desired state for the generic External infrastructure provider.",
- "type": "object",
- "properties": {
- "platformName": {
- "description": "platformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. This field is solely for informational and reporting purposes and is not expected to be used for decision-making.",
- "type": "string",
- "default": "Unknown"
- }
- }
- },
- "com.github.openshift.api.config.v1.ExternalPlatformStatus": {
- "description": "ExternalPlatformStatus holds the current status of the generic External infrastructure provider.",
- "type": "object",
- "properties": {
- "cloudControllerManager": {
- "description": "cloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI). When omitted, new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudControllerManagerStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ExtraMapping": {
- "description": "ExtraMapping allows specifying a key and CEL expression to evaluate the keys' value. It is used to create additional mappings and attributes added to a cluster identity from a provided authentication token.",
- "type": "object",
- "required": [
- "key",
- "valueExpression"
- ],
- "properties": {
- "key": {
- "description": "key is a required field that specifies the string to use as the extra attribute key.\n\nkey must be a domain-prefix path (e.g 'example.org/foo'). key must not exceed 510 characters in length. key must contain the '/' character, separating the domain and path characters. key must not be empty.\n\nThe domain portion of the key (string of characters prior to the '/') must be a valid RFC1123 subdomain. It must not exceed 253 characters in length. It must start and end with an alphanumeric character. It must only contain lower case alphanumeric characters and '-' or '.'. It must not use the reserved domains, or be subdomains of, \"kubernetes.io\", \"k8s.io\", and \"openshift.io\".\n\nThe path portion of the key (string of characters after the '/') must not be empty and must consist of at least one alphanumeric character, percent-encoded octets, '-', '.', '_', '~', '!', '$', '&', ''', '(', ')', '*', '+', ',', ';', '=', and ':'. It must not exceed 256 characters in length.",
- "type": "string",
- "default": ""
- },
- "valueExpression": {
- "description": "valueExpression is a required field to specify the CEL expression to extract the extra attribute value from a JWT token's claims. valueExpression must produce a string or string array value. \"\", [], and null are treated as the extra mapping not being present. Empty string values within an array are filtered out.\n\nCEL expressions have access to the token claims through a CEL variable, 'claims'. 'claims' is a map of claim names to claim values. For example, the 'sub' claim value can be accessed as 'claims.sub'. Nested claims can be accessed using dot notation ('claims.foo.bar').\n\nvalueExpression must not exceed 1024 characters in length. valueExpression must not be empty.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.FeatureGate": {
- "description": "Feature holds cluster-wide information about feature gates. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.FeatureGateAttributes": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the FeatureGate.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.FeatureGateDetails": {
- "type": "object",
- "required": [
- "version"
- ],
- "properties": {
- "disabled": {
- "description": "disabled is a list of all feature gates that are disabled in the cluster for the named version.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateAttributes"
- }
- },
- "enabled": {
- "description": "enabled is a list of all feature gates that are enabled in the cluster for the named version.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateAttributes"
- }
- },
- "version": {
- "description": "version matches the version provided by the ClusterVersion and in the ClusterOperator.Status.Versions field.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.FeatureGateList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGate"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.FeatureGateSelection": {
- "type": "object",
- "properties": {
- "customNoUpgrade": {
- "description": "customNoUpgrade allows the enabling or disabling of any feature. Turning this feature set on IS NOT SUPPORTED, CANNOT BE UNDONE, and PREVENTS UPGRADES. Because of its nature, this setting cannot be validated. If you have any typos or accidentally apply invalid combinations your cluster may fail in an unrecoverable way. featureSet must equal \"CustomNoUpgrade\" must be set to use this field.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CustomFeatureGates"
- },
- "featureSet": {
- "description": "featureSet changes the list of features in the cluster. The default is empty. Be very careful adjusting this setting. Turning on or off features may cause irreversible changes in your cluster which cannot be undone.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "featureSet",
- "fields-to-discriminateBy": {
- "customNoUpgrade": "CustomNoUpgrade"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.FeatureGateSpec": {
- "type": "object",
- "properties": {
- "customNoUpgrade": {
- "description": "customNoUpgrade allows the enabling or disabling of any feature. Turning this feature set on IS NOT SUPPORTED, CANNOT BE UNDONE, and PREVENTS UPGRADES. Because of its nature, this setting cannot be validated. If you have any typos or accidentally apply invalid combinations your cluster may fail in an unrecoverable way. featureSet must equal \"CustomNoUpgrade\" must be set to use this field.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CustomFeatureGates"
- },
- "featureSet": {
- "description": "featureSet changes the list of features in the cluster. The default is empty. Be very careful adjusting this setting. Turning on or off features may cause irreversible changes in your cluster which cannot be undone.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "featureSet",
- "fields-to-discriminateBy": {
- "customNoUpgrade": "CustomNoUpgrade"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.FeatureGateStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions represent the observations of the current state. Known .status.conditions.type are: \"DeterminationDegraded\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "featureGates": {
- "description": "featureGates contains a list of enabled and disabled featureGates that are keyed by payloadVersion. Operators other than the CVO and cluster-config-operator, must read the .status.featureGates, locate the version they are managing, find the enabled/disabled featuregates and make the operand and operator match. The enabled/disabled values for a particular version may change during the life of the cluster as various .spec.featureSet values are selected. Operators may choose to restart their processes to pick up these changes, but remembering past enable/disable lists is beyond the scope of this API and is the responsibility of individual operators. Only featureGates with .version in the ClusterVersion.status will be present in this list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateDetails"
- },
- "x-kubernetes-list-map-keys": [
- "version"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.FeatureGateTests": {
- "type": "object",
- "required": [
- "featureGate",
- "tests"
- ],
- "properties": {
- "featureGate": {
- "description": "featureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance.",
- "type": "string",
- "default": ""
- },
- "tests": {
- "description": "tests contains an item for every TestName",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TestDetails"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.FulcioCAWithRekor": {
- "description": "FulcioCAWithRekor defines the root of trust based on the Fulcio certificate and the Rekor public key.",
- "type": "object",
- "required": [
- "fulcioCAData",
- "rekorKeyData",
- "fulcioSubject"
- ],
- "properties": {
- "fulcioCAData": {
- "description": "fulcioCAData is a required field contains inline base64-encoded data for the PEM format fulcio CA. fulcioCAData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- },
- "fulcioSubject": {
- "description": "fulcioSubject is a required field specifies OIDC issuer and the email of the Fulcio authentication configuration.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyFulcioSubject"
- },
- "rekorKeyData": {
- "description": "rekorKeyData is a required field contains inline base64-encoded data for the PEM format from the Rekor public key. rekorKeyData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- }
- }
- },
- "com.github.openshift.api.config.v1.GCPPlatformSpec": {
- "description": "GCPPlatformSpec holds the desired state of the Google Cloud Platform infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.GCPPlatformStatus": {
- "description": "GCPPlatformStatus holds the current status of the Google Cloud Platform infrastructure provider.",
- "type": "object",
- "required": [
- "projectID",
- "region"
- ],
- "properties": {
- "cloudLoadBalancerConfig": {
- "description": "cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer.",
- "default": {
- "dnsType": "PlatformDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerConfig"
- },
- "projectID": {
- "description": "resourceGroupName is the Project ID for new GCP resources created for the cluster.",
- "type": "string",
- "default": ""
- },
- "region": {
- "description": "region holds the region for new GCP resources created for the cluster.",
- "type": "string",
- "default": ""
- },
- "resourceLabels": {
- "description": "resourceLabels is a list of additional labels to apply to GCP resources created for the cluster. See https://cloud.google.com/compute/docs/labeling-resources for information on labeling GCP resources. GCP supports a maximum of 64 labels per resource. OpenShift reserves 32 labels for internal use, allowing 32 labels for user configuration.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPResourceLabel"
- },
- "x-kubernetes-list-map-keys": [
- "key"
- ],
- "x-kubernetes-list-type": "map"
- },
- "resourceTags": {
- "description": "resourceTags is a list of additional tags to apply to GCP resources created for the cluster. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for information on tagging GCP resources. GCP supports a maximum of 50 tags per resource.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPResourceTag"
- },
- "x-kubernetes-list-map-keys": [
- "key"
- ],
- "x-kubernetes-list-type": "map"
- },
- "serviceEndpoints": {
- "description": "serviceEndpoints specifies endpoints that override the default endpoints used when creating clients to interact with GCP services. When not specified, the default endpoint for the GCP region will be used. Only 1 endpoint override is permitted for each GCP service. The maximum number of endpoint overrides allowed is 11.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPServiceEndpoint"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.GCPResourceLabel": {
- "description": "GCPResourceLabel is a label to apply to GCP resources created for the cluster.",
- "type": "object",
- "required": [
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key is the key part of the label. A label key can have a maximum of 63 characters and cannot be empty. Label key must begin with a lowercase letter, and must contain only lowercase letters, numeric characters, and the following special characters `_-`. Label key must not have the reserved prefixes `kubernetes-io` and `openshift-io`.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value is the value part of the label. A label value can have a maximum of 63 characters and cannot be empty. Value must contain only lowercase letters, numeric characters, and the following special characters `_-`.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.GCPResourceTag": {
- "description": "GCPResourceTag is a tag to apply to GCP resources created for the cluster.",
- "type": "object",
- "required": [
- "parentID",
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key is the key part of the tag. A tag key can have a maximum of 63 characters and cannot be empty. Tag key must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters `._-`.",
- "type": "string",
- "default": ""
- },
- "parentID": {
- "description": "parentID is the ID of the hierarchical resource where the tags are defined, e.g. at the Organization or the Project level. To find the Organization or Project ID refer to the following pages: https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id, https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects. An OrganizationID must consist of decimal numbers, and cannot have leading zeroes. A ProjectID must be 6 to 30 characters in length, can only contain lowercase letters, numbers, and hyphens, and must start with a letter, and cannot end with a hyphen.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value is the value part of the tag. A tag value can have a maximum of 63 characters and cannot be empty. Tag value must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters `_-.@%=+:,*#&(){}[]` and spaces.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.GCPServiceEndpoint": {
- "description": "GCPServiceEndpoint store the configuration of a custom url to override existing defaults of GCP Services.",
- "type": "object",
- "required": [
- "name",
- "url"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the GCP service whose endpoint is being overridden. This must be provided and cannot be empty.\n\nAllowed values are Compute, Container, CloudResourceManager, DNS, File, IAM, ServiceUsage, Storage, and TagManager.\n\nAs an example, when setting the name to Compute all requests made by the caller to the GCP Compute Service will be directed to the endpoint specified in the url field.",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url is a fully qualified URI that overrides the default endpoint for a client using the GCP service specified in the name field. url is required, must use the scheme https, must not be more than 253 characters in length, and must be a valid URL according to Go's net/url package (https://pkg.go.dev/net/url#URL)\n\nAn example of a valid endpoint that overrides the Compute Service: \"https://compute-myendpoint1.p.googleapis.com\"",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.GatherConfig": {
- "description": "GatherConfig provides data gathering configuration options.",
- "type": "object",
- "required": [
- "gatherers"
- ],
- "properties": {
- "dataPolicy": {
- "description": "dataPolicy is an optional list of DataPolicyOptions that allows user to enable additional obfuscation of the Insights archive data. It may not exceed 2 items and must not contain duplicates. Valid values are ObfuscateNetworking and WorkloadNames. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When set to WorkloadNames, the gathered data about cluster resources will not contain the workload names for your deployments. Resources UIDs will be used instead. When omitted no obfuscation is applied.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "gatherers": {
- "description": "gatherers is a required field that specifies the configuration of the gatherers.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Gatherers"
- },
- "storage": {
- "description": "storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Storage"
- }
- }
- },
- "com.github.openshift.api.config.v1.GathererConfig": {
- "description": "GathererConfig allows to configure specific gatherers",
- "type": "object",
- "required": [
- "name",
- "state"
- ],
- "properties": {
- "name": {
- "description": "name is the required name of a specific gatherer. It may not exceed 256 characters. The format for a gatherer name is: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (_). Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/). The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "string"
- },
- "state": {
- "description": "state is a required field that allows you to configure specific gatherer. Valid values are \"Enabled\" and \"Disabled\". When set to Enabled the gatherer will run. When set to Disabled the gatherer will not run.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.Gatherers": {
- "description": "Gatherers specifies the configuration of the gatherers",
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "custom": {
- "description": "custom provides gathering configuration. It is required when mode is Custom, and forbidden otherwise. Custom configuration allows user to disable only a subset of gatherers. Gatherers that are not explicitly disabled in custom configuration will run.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Custom"
- },
- "mode": {
- "description": "mode is a required field that specifies the mode for gatherers. Allowed values are All, None, and Custom. When set to All, all gatherers will run and gather data. When set to None, all gatherers will be disabled and no data will be gathered. When set to Custom, the custom configuration from the custom field will be applied.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "custom": "Custom"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.GenericAPIServerConfig": {
- "description": "GenericAPIServerConfig is an inline-able struct for aggregated apiservers that need to store data in etcd",
- "type": "object",
- "required": [
- "servingInfo",
- "corsAllowedOrigins",
- "auditConfig",
- "storageConfig",
- "admission",
- "kubeClientConfig"
- ],
- "properties": {
- "admission": {
- "description": "admissionConfig holds information about how to configure admission.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AdmissionConfig"
- },
- "auditConfig": {
- "description": "auditConfig describes how to configure audit information",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AuditConfig"
- },
- "corsAllowedOrigins": {
- "description": "corsAllowedOrigins",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "kubeClientConfig": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KubeClientConfig"
- },
- "servingInfo": {
- "description": "servingInfo describes how to start serving",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
- },
- "storageConfig": {
- "description": "storageConfig contains information about how to use",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.EtcdStorageConfig"
- }
- }
- },
- "com.github.openshift.api.config.v1.GenericControllerConfig": {
- "description": "GenericControllerConfig provides information to configure a controller",
- "type": "object",
- "required": [
- "servingInfo",
- "leaderElection",
- "authentication",
- "authorization"
- ],
- "properties": {
- "authentication": {
- "description": "authentication allows configuration of authentication for the endpoints",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DelegatedAuthentication"
- },
- "authorization": {
- "description": "authorization allows configuration of authentication for the endpoints",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DelegatedAuthorization"
- },
- "leaderElection": {
- "description": "leaderElection provides information to elect a leader. Only override this if you have a specific need",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.LeaderElection"
- },
- "servingInfo": {
- "description": "servingInfo is the HTTP serving information for the controller's endpoints",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
- }
- }
- },
- "com.github.openshift.api.config.v1.GitHubIdentityProvider": {
- "description": "GitHubIdentityProvider provides identities for users authenticating using GitHub credentials",
- "type": "object",
- "required": [
- "clientID",
- "clientSecret"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "hostname": {
- "description": "hostname is the optional domain (e.g. \"mycompany.com\") for use with a hosted instance of GitHub Enterprise. It must match the GitHub Enterprise settings value configured at /setup/settings#hostname.",
- "type": "string",
- "default": ""
- },
- "organizations": {
- "description": "organizations optionally restricts which organizations are allowed to log in",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "teams": {
- "description": "teams optionally restricts which teams are allowed to log in. Format is /.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.GitLabIdentityProvider": {
- "description": "GitLabIdentityProvider provides identities for users authenticating using GitLab credentials",
- "type": "object",
- "required": [
- "clientID",
- "clientSecret",
- "url"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "url": {
- "description": "url is the oauth server base URL",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.GoogleIdentityProvider": {
- "description": "GoogleIdentityProvider provides identities for users authenticating using Google credentials",
- "type": "object",
- "required": [
- "clientID",
- "clientSecret"
- ],
- "properties": {
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "hostedDomain": {
- "description": "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.HTPasswdIdentityProvider": {
- "description": "HTPasswdPasswordIdentityProvider provides identities for users authenticating using htpasswd credentials",
- "type": "object",
- "required": [
- "fileData"
- ],
- "properties": {
- "fileData": {
- "description": "fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key \"htpasswd\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- }
- }
- },
- "com.github.openshift.api.config.v1.HTTPServingInfo": {
- "description": "HTTPServingInfo holds configuration for serving HTTP",
- "type": "object",
- "required": [
- "bindAddress",
- "bindNetwork",
- "certFile",
- "keyFile",
- "maxRequestsInFlight",
- "requestTimeoutSeconds"
- ],
- "properties": {
- "bindAddress": {
- "description": "bindAddress is the ip:port to serve on",
- "type": "string",
- "default": ""
- },
- "bindNetwork": {
- "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "cipherSuites": {
- "description": "cipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "clientCA": {
- "description": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
- "type": "string"
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "maxRequestsInFlight": {
- "description": "maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "minTLSVersion": {
- "description": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "string"
- },
- "namedCertificates": {
- "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NamedCertificate"
- }
- },
- "requestTimeoutSeconds": {
- "description": "requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.",
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.config.v1.HubSource": {
- "description": "HubSource is used to specify the hub source and its configuration",
- "type": "object",
- "required": [
- "name",
- "disabled"
- ],
- "properties": {
- "disabled": {
- "description": "disabled is used to disable a default hub source on cluster",
- "type": "boolean",
- "default": false
- },
- "name": {
- "description": "name is the name of one of the default hub sources",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.HubSourceStatus": {
- "description": "HubSourceStatus is used to reflect the current state of applying the configuration to a default source",
- "type": "object",
- "properties": {
- "message": {
- "description": "message provides more information regarding failures",
- "type": "string"
- },
- "status": {
- "description": "status indicates success or failure in applying the configuration",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.IBMCloudPlatformSpec": {
- "description": "IBMCloudPlatformSpec holds the desired state of the IBMCloud infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object",
- "properties": {
- "serviceEndpoints": {
- "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of an IBM service. These endpoints are used by components within the cluster when trying to reach the IBM Cloud Services that have been overridden. The CCCMO reads in the IBMCloudPlatformSpec and validates each endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus are updated to reflect the same custom endpoints. A maximum of 13 service endpoints overrides are supported.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudServiceEndpoint"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.IBMCloudPlatformStatus": {
- "description": "IBMCloudPlatformStatus holds the current status of the IBMCloud infrastructure provider.",
- "type": "object",
- "properties": {
- "cisInstanceCRN": {
- "description": "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain",
- "type": "string"
- },
- "dnsInstanceCRN": {
- "description": "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain",
- "type": "string"
- },
- "location": {
- "description": "location is where the cluster has been deployed",
- "type": "string"
- },
- "providerType": {
- "description": "providerType indicates the type of cluster that was created",
- "type": "string"
- },
- "resourceGroupName": {
- "description": "resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.",
- "type": "string"
- },
- "serviceEndpoints": {
- "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of an IBM service. These endpoints are used by components within the cluster when trying to reach the IBM Cloud Services that have been overridden. The CCCMO reads in the IBMCloudPlatformSpec and validates each endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus are updated to reflect the same custom endpoints.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudServiceEndpoint"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.IBMCloudServiceEndpoint": {
- "description": "IBMCloudServiceEndpoint stores the configuration of a custom url to override existing defaults of IBM Cloud Services.",
- "type": "object",
- "required": [
- "name",
- "url"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the IBM Cloud service. Possible values are: CIS, COS, COSConfig, DNSServices, GlobalCatalog, GlobalSearch, GlobalTagging, HyperProtect, IAM, KeyProtect, ResourceController, ResourceManager, or VPC. For example, the IBM Cloud Private IAM service could be configured with the service `name` of `IAM` and `url` of `https://private.iam.cloud.ibm.com` Whereas the IBM Cloud Private VPC service for US South (Dallas) could be configured with the service `name` of `VPC` and `url` of `https://us.south.private.iaas.cloud.ibm.com`",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. The path must follow the pattern /v[0,9]+ or /api/v[0,9]+",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.IdentityProvider": {
- "description": "IdentityProvider provides identities for users authenticating using credentials",
- "type": "object",
- "required": [
- "name",
- "type"
- ],
- "properties": {
- "basicAuth": {
- "description": "basicAuth contains configuration options for the BasicAuth IdP",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BasicAuthIdentityProvider"
- },
- "github": {
- "description": "github enables user authentication using GitHub credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GitHubIdentityProvider"
- },
- "gitlab": {
- "description": "gitlab enables user authentication using GitLab credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GitLabIdentityProvider"
- },
- "google": {
- "description": "google enables user authentication using Google credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GoogleIdentityProvider"
- },
- "htpasswd": {
- "description": "htpasswd enables user authentication using an HTPasswd file to validate credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTPasswdIdentityProvider"
- },
- "keystone": {
- "description": "keystone enables user authentication using keystone password credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KeystoneIdentityProvider"
- },
- "ldap": {
- "description": "ldap enables user authentication using LDAP credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.LDAPIdentityProvider"
- },
- "mappingMethod": {
- "description": "mappingMethod determines how identities from this provider are mapped to users Defaults to \"claim\"",
- "type": "string"
- },
- "name": {
- "description": "name is used to qualify the identities returned by this provider. - It MUST be unique and not shared by any other identity provider used - It MUST be a valid path segment: name cannot equal \".\" or \"..\" or contain \"/\" or \"%\" or \":\"\n Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName",
- "type": "string",
- "default": ""
- },
- "openID": {
- "description": "openID enables user authentication using OpenID credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenIDIdentityProvider"
- },
- "requestHeader": {
- "description": "requestHeader enables user authentication using request header credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.RequestHeaderIdentityProvider"
- },
- "type": {
- "description": "type identifies the identity provider type for this entry.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.IdentityProviderConfig": {
- "description": "IdentityProviderConfig contains configuration for using a specific identity provider",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "basicAuth": {
- "description": "basicAuth contains configuration options for the BasicAuth IdP",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BasicAuthIdentityProvider"
- },
- "github": {
- "description": "github enables user authentication using GitHub credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GitHubIdentityProvider"
- },
- "gitlab": {
- "description": "gitlab enables user authentication using GitLab credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GitLabIdentityProvider"
- },
- "google": {
- "description": "google enables user authentication using Google credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GoogleIdentityProvider"
- },
- "htpasswd": {
- "description": "htpasswd enables user authentication using an HTPasswd file to validate credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTPasswdIdentityProvider"
- },
- "keystone": {
- "description": "keystone enables user authentication using keystone password credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KeystoneIdentityProvider"
- },
- "ldap": {
- "description": "ldap enables user authentication using LDAP credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.LDAPIdentityProvider"
- },
- "openID": {
- "description": "openID enables user authentication using OpenID credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenIDIdentityProvider"
- },
- "requestHeader": {
- "description": "requestHeader enables user authentication using request header credentials",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.RequestHeaderIdentityProvider"
- },
- "type": {
- "description": "type identifies the identity provider type for this entry.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Image": {
- "description": "Image governs policies related to imagestream imports and runtime configuration for external registries. It allows cluster admins to configure which registries OpenShift is allowed to import images from, extra CA trust bundles for external registries, and policies to block or allow registry hostnames. When exposing OpenShift's image registry to the public, this also lets cluster admins specify the external hostname.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageContentPolicy": {
- "description": "ImageContentPolicy holds cluster-wide information about how to handle registry mirror rules. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageContentPolicySpec"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageContentPolicyList": {
- "description": "ImageContentPolicyList lists the items in the ImageContentPolicy CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageContentPolicy"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageContentPolicySpec": {
- "description": "ImageContentPolicySpec is the specification of the ImageContentPolicy CRD.",
- "type": "object",
- "properties": {
- "repositoryDigestMirrors": {
- "description": "repositoryDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in RepositoryDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To pull image from mirrors by tags, should set the \"allowMirrorByTags\".\n\nEach “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.RepositoryDigestMirrors"
- },
- "x-kubernetes-list-map-keys": [
- "source"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageDigestMirrorSet": {
- "description": "ImageDigestMirrorSet holds cluster-wide information about how to handle registry mirror rules on using digest pull specification. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrorSetSpec"
- },
- "status": {
- "description": "status contains the observed state of the resource.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrorSetStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageDigestMirrorSetList": {
- "description": "ImageDigestMirrorSetList lists the items in the ImageDigestMirrorSet CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrorSet"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageDigestMirrorSetSpec": {
- "description": "ImageDigestMirrorSetSpec is the specification of the ImageDigestMirrorSet CRD.",
- "type": "object",
- "properties": {
- "imageDigestMirrors": {
- "description": "imageDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in imageDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To use mirrors to pull images using tag specification, users should configure a list of mirrors using \"ImageTagMirrorSet\" CRD.\n\nIf the image pull specification matches the repository of \"source\" in multiple imagedigestmirrorset objects, only the objects which define the most specific namespace match will be used. For example, if there are objects using quay.io/libpod and quay.io/libpod/busybox as the \"source\", only the objects using quay.io/libpod/busybox are going to apply for pull specification quay.io/libpod/busybox. Each “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. Users who want to use a specific order of mirrors, should configure them into one list of mirrors using the expected order.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrors"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageDigestMirrorSetStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1.ImageDigestMirrors": {
- "description": "ImageDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
- "type": "object",
- "required": [
- "source"
- ],
- "properties": {
- "mirrorSourcePolicy": {
- "description": "mirrorSourcePolicy defines the fallback policy if fails to pull image from the mirrors. If unset, the image will continue to be pulled from the the repository in the pull spec. sourcePolicy is valid configuration only when one or more mirrors are in the mirror list.",
- "type": "string"
- },
- "mirrors": {
- "description": "mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their digests. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair *.redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec unless explicitly prohibited by \"mirrorSourcePolicy\" Other cluster configuration, including (but not limited to) other imageDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. \"mirrors\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "source": {
- "description": "source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname e.g. docker.io. quay.io, or registry.redhat.io, will match the image pull specification of corressponding registry. \"source\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo [*.]host for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageLabel": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name defines the name of the label. It must have non-zero length.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value defines the literal value of the label.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Image"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImagePolicy": {
- "description": "ImagePolicy holds namespace-wide configuration for image signature verification\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImagePolicySpec"
- },
- "status": {
- "description": "status contains the observed state of the resource.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImagePolicyStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImagePolicyList": {
- "description": "ImagePolicyList is a list of ImagePolicy resources\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of ImagePolicies",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImagePolicy"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImagePolicySpec": {
- "description": "ImagePolicySpec is the specification of the ImagePolicy CRD.",
- "type": "object",
- "required": [
- "scopes",
- "policy"
- ],
- "properties": {
- "policy": {
- "description": "policy is a required field that contains configuration to allow scopes to be verified, and defines how images not matching the verification policy will be treated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Policy"
- },
- "scopes": {
- "description": "scopes is a required field that defines the list of image identities assigned to a policy. Each item refers to a scope in a registry implementing the \"Docker Registry HTTP API V2\". Scopes matching individual images are named Docker references in the fully expanded form, either using a tag or digest. For example, docker.io/library/busybox:latest (not busybox:latest). More general scopes are prefixes of individual-image scopes, and specify a repository (by omitting the tag or digest), a repository namespace, or a registry host (by only specifying the host name and possibly a port number) or a wildcard expression starting with `*.`, for matching all subdomains (not including a port number). Wildcards are only supported for subdomain matching, and may not be used in the middle of the host, i.e. *.example.com is a valid case, but example*.*.com is not. This support no more than 256 scopes in one object. If multiple scopes match a given image, only the policy requirements for the most specific scope apply. The policy requirements for more general scopes are ignored. In addition to setting a policy appropriate for your own deployed applications, make sure that a policy on the OpenShift image repositories quay.io/openshift-release-dev/ocp-release, quay.io/openshift-release-dev/ocp-v4.0-art-dev (or on a more general scope) allows deployment of the OpenShift images required for cluster operation. If a scope is configured in both the ClusterImagePolicy and the ImagePolicy, or if the scope in ImagePolicy is nested under one of the scopes from the ClusterImagePolicy, only the policy from the ClusterImagePolicy will be applied. For additional details about the format, please refer to the document explaining the docker transport field, which can be found at: https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md#docker",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImagePolicyStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of this API Resource. condition type 'Pending' indicates that the customer resource contains a policy that cannot take effect. It is either overwritten by a global policy or the image scope is not valid.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageSpec": {
- "type": "object",
- "properties": {
- "additionalTrustedCA": {
- "description": "additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted during imagestream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "allowedRegistriesForImport": {
- "description": "allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.RegistryLocation"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "externalRegistryHostnames": {
- "description": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "imageStreamImportMode": {
- "description": "imageStreamImportMode controls the import mode behaviour of imagestreams. It can be set to `Legacy` or `PreserveOriginal` or the empty string. If this value is specified, this setting is applied to all newly created imagestreams which do not have the value set. `Legacy` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. `PreserveOriginal` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported. When empty, the behaviour will be decided based on the payload type advertised by the ClusterVersion status, i.e single arch payload implies the import mode is Legacy and multi payload implies PreserveOriginal.\n\nPossible enum values:\n - `\"Legacy\"` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. This mode is the default.\n - `\"PreserveOriginal\"` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported.",
- "type": "string",
- "default": "",
- "enum": [
- "Legacy",
- "PreserveOriginal"
- ]
- },
- "registrySources": {
- "description": "registrySources contains configuration that determines how the container runtime should treat individual registries when accessing images for builds+pods. (e.g. whether or not to allow insecure access). It does not contain configuration for the internal cluster registry.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.RegistrySources"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageStatus": {
- "type": "object",
- "properties": {
- "externalRegistryHostnames": {
- "description": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "imageStreamImportMode": {
- "description": "imageStreamImportMode controls the import mode behaviour of imagestreams. It can be `Legacy` or `PreserveOriginal`. `Legacy` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. `PreserveOriginal` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported. This value will be reconciled based on either the spec value or if no spec value is specified, the image registry operator would look at the ClusterVersion status to determine the payload type and set the import mode accordingly, i.e single arch payload implies the import mode is Legacy and multi payload implies PreserveOriginal.\n\nPossible enum values:\n - `\"Legacy\"` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. This mode is the default.\n - `\"PreserveOriginal\"` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported.",
- "type": "string",
- "enum": [
- "Legacy",
- "PreserveOriginal"
- ]
- },
- "internalRegistryHostname": {
- "description": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format. This value is set by the image registry operator which controls the internal registry hostname.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageTagMirrorSet": {
- "description": "ImageTagMirrorSet holds cluster-wide information about how to handle registry mirror rules on using tag pull specification. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrorSetSpec"
- },
- "status": {
- "description": "status contains the observed state of the resource.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrorSetStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageTagMirrorSetList": {
- "description": "ImageTagMirrorSetList lists the items in the ImageTagMirrorSet CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrorSet"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageTagMirrorSetSpec": {
- "description": "ImageTagMirrorSetSpec is the specification of the ImageTagMirrorSet CRD.",
- "type": "object",
- "properties": {
- "imageTagMirrors": {
- "description": "imageTagMirrors allows images referenced by image tags in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in imageTagMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To use mirrors to pull images using digest specification only, users should configure a list of mirrors using \"ImageDigestMirrorSet\" CRD.\n\nIf the image pull specification matches the repository of \"source\" in multiple imagetagmirrorset objects, only the objects which define the most specific namespace match will be used. For example, if there are objects using quay.io/libpod and quay.io/libpod/busybox as the \"source\", only the objects using quay.io/libpod/busybox are going to apply for pull specification quay.io/libpod/busybox. Each “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. Users who want to use a deterministic order of mirrors, should configure them into one list of mirrors using the expected order.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrors"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.ImageTagMirrorSetStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1.ImageTagMirrors": {
- "description": "ImageTagMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
- "type": "object",
- "required": [
- "source"
- ],
- "properties": {
- "mirrorSourcePolicy": {
- "description": "mirrorSourcePolicy defines the fallback policy if fails to pull image from the mirrors. If unset, the image will continue to be pulled from the repository in the pull spec. sourcePolicy is valid configuration only when one or more mirrors are in the mirror list.",
- "type": "string"
- },
- "mirrors": {
- "description": "mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their tags. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair *.redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. Pulling images by tag can potentially yield different images, depending on which endpoint we pull from. Configuring a list of mirrors using \"ImageDigestMirrorSet\" CRD and forcing digest-pulls for mirrors avoids that issue. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec unless explicitly prohibited by \"mirrorSourcePolicy\". Other cluster configuration, including (but not limited to) other imageTagMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. \"mirrors\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "source": {
- "description": "source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname e.g. docker.io. quay.io, or registry.redhat.io, will match the image pull specification of corressponding registry. \"source\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo [*.]host for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Infrastructure": {
- "description": "Infrastructure holds cluster-wide information about Infrastructure. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.InfrastructureSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.InfrastructureStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.InfrastructureList": {
- "description": "InfrastructureList is\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Infrastructure"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.InfrastructureSpec": {
- "description": "InfrastructureSpec contains settings that apply to the cluster infrastructure.",
- "type": "object",
- "properties": {
- "cloudConfig": {
- "description": "cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.\n\ncloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace with the kube cloud config is stored in `cloud.conf` key. All the clients are expected to use the generated ConfigMap only.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapFileReference"
- },
- "platformSpec": {
- "description": "platformSpec holds desired information specific to the underlying infrastructure provider.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PlatformSpec"
- }
- }
- },
- "com.github.openshift.api.config.v1.InfrastructureStatus": {
- "description": "InfrastructureStatus describes the infrastructure the cluster is leveraging.",
- "type": "object",
- "properties": {
- "apiServerInternalURI": {
- "description": "apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking.",
- "type": "string",
- "default": ""
- },
- "apiServerURL": {
- "description": "apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API.",
- "type": "string",
- "default": ""
- },
- "controlPlaneTopology": {
- "description": "controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a \"normal\" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster.",
- "type": "string",
- "default": ""
- },
- "cpuPartitioning": {
- "description": "cpuPartitioning expresses if CPU partitioning is a currently enabled feature in the cluster. CPU Partitioning means that this cluster can support partitioning workloads to specific CPU Sets. Valid values are \"None\" and \"AllNodes\". When omitted, the default value is \"None\". The default value of \"None\" indicates that no nodes will be setup with CPU partitioning. The \"AllNodes\" value indicates that all nodes have been setup with CPU partitioning, and can then be further configured via the PerformanceProfile API.",
- "type": "string",
- "default": "None"
- },
- "etcdDiscoveryDomain": {
- "description": "etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release.",
- "type": "string",
- "default": ""
- },
- "infrastructureName": {
- "description": "infrastructureName uniquely identifies a cluster with a human friendly name. Once set it should not be changed. Must be of max length 27 and must have only alphanumeric or hyphen characters.",
- "type": "string",
- "default": ""
- },
- "infrastructureTopology": {
- "description": "infrastructureTopology expresses the expectations for infrastructure services that do not run on control plane nodes, usually indicated by a node selector for a `role` value other than `master`. The default is 'HighlyAvailable', which represents the behavior operators have in a \"normal\" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation NOTE: External topology mode is not applicable for this field.",
- "type": "string"
- },
- "platform": {
- "description": "platform is the underlying infrastructure provider for the cluster.\n\nDeprecated: Use platformStatus.type instead.",
- "type": "string"
- },
- "platformStatus": {
- "description": "platformStatus holds status information specific to the underlying infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PlatformStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.Ingress": {
- "description": "Ingress holds cluster-wide information about ingress, including the default ingress domain used for routes. The canonical name is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IngressSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IngressStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.IngressList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Ingress"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.IngressPlatformSpec": {
- "description": "IngressPlatformSpec holds the desired state of Ingress specific to the underlying infrastructure provider of the current cluster. Since these are used at spec-level for the underlying cluster, it is supposed that only one of the spec structs is set.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "aws": {
- "description": "aws contains settings specific to the Amazon Web Services infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSIngressSpec"
- },
- "type": {
- "description": "type is the underlying infrastructure provider for the cluster. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"KubeVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "aws": "AWS"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.IngressSpec": {
- "type": "object",
- "required": [
- "domain"
- ],
- "properties": {
- "appsDomain": {
- "description": "appsDomain is an optional domain to use instead of the one specified in the domain field when a Route is created without specifying an explicit host. If appsDomain is nonempty, this value is used to generate default host values for Route. Unlike domain, appsDomain may be modified after installation. This assumes a new ingresscontroller has been setup with a wildcard certificate.",
- "type": "string"
- },
- "componentRoutes": {
- "description": "componentRoutes is an optional list of routes that are managed by OpenShift components that a cluster-admin is able to configure the hostname and serving certificate for. The namespace and name of each route in this list should match an existing entry in the status.componentRoutes list.\n\nTo determine the set of configurable Routes, look at namespace and name of entries in the .status.componentRoutes list, where participating operators write the status of configurable routes.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ComponentRouteSpec"
- },
- "x-kubernetes-list-map-keys": [
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "domain": {
- "description": "domain is used to generate a default host name for a route when the route's host name is empty. The generated host name will follow this pattern: \"..\".\n\nIt is also used as the default wildcard domain suffix for ingress. The default ingresscontroller domain will follow this pattern: \"*.\".\n\nOnce set, changing domain is not currently supported.",
- "type": "string",
- "default": ""
- },
- "loadBalancer": {
- "description": "loadBalancer contains the load balancer details in general which are not only specific to the underlying infrastructure provider of the current cluster and are required for Ingress Controller to work on OpenShift.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.LoadBalancer"
- },
- "requiredHSTSPolicies": {
- "description": "requiredHSTSPolicies specifies HSTS policies that are required to be set on newly created or updated routes matching the domainPattern/s and namespaceSelector/s that are specified in the policy. Each requiredHSTSPolicy must have at least a domainPattern and a maxAge to validate a route HSTS Policy route annotation, and affect route admission.\n\nA candidate route is checked for HSTS Policies if it has the HSTS Policy route annotation: \"haproxy.router.openshift.io/hsts_header\" E.g. haproxy.router.openshift.io/hsts_header: max-age=31536000;preload;includeSubDomains\n\n- For each candidate route, if it matches a requiredHSTSPolicy domainPattern and optional namespaceSelector, then the maxAge, preloadPolicy, and includeSubdomainsPolicy must be valid to be admitted. Otherwise, the route is rejected. - The first match, by domainPattern and optional namespaceSelector, in the ordering of the RequiredHSTSPolicies determines the route's admission status. - If the candidate route doesn't match any requiredHSTSPolicy domainPattern and optional namespaceSelector, then it may use any HSTS Policy annotation.\n\nThe HSTS policy configuration may be changed after routes have already been created. An update to a previously admitted route may then fail if the updated route does not conform to the updated HSTS policy configuration. However, changing the HSTS policy configuration will not cause a route that is already admitted to stop working.\n\nNote that if there are no RequiredHSTSPolicies, any HSTS Policy annotation on the route is valid.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.RequiredHSTSPolicy"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.IngressStatus": {
- "type": "object",
- "properties": {
- "componentRoutes": {
- "description": "componentRoutes is where participating operators place the current route status for routes whose hostnames and serving certificates can be customized by the cluster-admin.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ComponentRouteStatus"
- },
- "x-kubernetes-list-map-keys": [
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "defaultPlacement": {
- "description": "defaultPlacement is set at installation time to control which nodes will host the ingress router pods by default. The options are control-plane nodes or worker nodes.\n\nThis field works by dictating how the Cluster Ingress Operator will consider unset replicas and nodePlacement fields in IngressController resources when creating the corresponding Deployments.\n\nSee the documentation for the IngressController replicas and nodePlacement fields for more information.\n\nWhen omitted, the default value is Workers",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.InsightsDataGather": {
- "description": "InsightsDataGather provides data gather configuration options for the Insights Operator.\n\n\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.InsightsDataGatherSpec"
- }
- }
- },
- "com.github.openshift.api.config.v1.InsightsDataGatherList": {
- "description": "InsightsDataGatherList is a collection of items Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the required list of InsightsDataGather objects it may not exceed 100 items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.InsightsDataGather"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the required standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.InsightsDataGatherSpec": {
- "description": "InsightsDataGatherSpec contains the configuration for the data gathering.",
- "type": "object",
- "required": [
- "gatherConfig"
- ],
- "properties": {
- "gatherConfig": {
- "description": "gatherConfig is a required spec attribute that includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GatherConfig"
- }
- }
- },
- "com.github.openshift.api.config.v1.IntermediateTLSProfile": {
- "description": "IntermediateTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.KMSConfig": {
- "description": "KMSConfig defines the configuration for the KMS instance that will be used with KMSEncryptionProvider encryption",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "aws": {
- "description": "aws defines the key config for using an AWS KMS instance for the encryption. The AWS KMS instance is managed by the user outside the purview of the control plane.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSKMSConfig"
- },
- "type": {
- "description": "type defines the kind of platform for the KMS provider. Available provider types are AWS only.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "aws": "AWS"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.KeystoneIdentityProvider": {
- "description": "KeystonePasswordIdentityProvider provides identities for users authenticating using keystone password credentials",
- "type": "object",
- "required": [
- "url",
- "domainName"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "domainName": {
- "description": "domainName is required for keystone v3",
- "type": "string",
- "default": ""
- },
- "tlsClientCert": {
- "description": "tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key \"tls.crt\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "tlsClientKey": {
- "description": "tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key \"tls.key\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.KubeClientConfig": {
- "type": "object",
- "required": [
- "kubeConfig",
- "connectionOverrides"
- ],
- "properties": {
- "connectionOverrides": {
- "description": "connectionOverrides specifies client overrides for system components to loop back to this master.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClientConnectionOverrides"
- },
- "kubeConfig": {
- "description": "kubeConfig is a .kubeconfig filename for going to the owning kube-apiserver. Empty uses an in-cluster-config",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.KubevirtPlatformSpec": {
- "description": "KubevirtPlatformSpec holds the desired state of the kubevirt infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.KubevirtPlatformStatus": {
- "description": "KubevirtPlatformStatus holds the current status of the kubevirt infrastructure provider.",
- "type": "object",
- "properties": {
- "apiServerInternalIP": {
- "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
- "type": "string"
- },
- "ingressIP": {
- "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.LDAPAttributeMapping": {
- "description": "LDAPAttributeMapping maps LDAP attributes to OpenShift identity fields",
- "type": "object",
- "required": [
- "id"
- ],
- "properties": {
- "email": {
- "description": "email is the list of attributes whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "id": {
- "description": "id is the list of attributes whose values should be used as the user ID. Required. First non-empty attribute is used. At least one attribute is required. If none of the listed attribute have a value, authentication fails. LDAP standard identity attribute is \"dn\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "name": {
- "description": "name is the list of attributes whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity LDAP standard display name attribute is \"cn\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "preferredUsername": {
- "description": "preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.LDAPIdentityProvider": {
- "description": "LDAPPasswordIdentityProvider provides identities for users authenticating using LDAP credentials",
- "type": "object",
- "required": [
- "url",
- "insecure",
- "attributes"
- ],
- "properties": {
- "attributes": {
- "description": "attributes maps LDAP attributes to identities",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.LDAPAttributeMapping"
- },
- "bindDN": {
- "description": "bindDN is an optional DN to bind with during the search phase.",
- "type": "string",
- "default": ""
- },
- "bindPassword": {
- "description": "bindPassword is an optional reference to a secret by name containing a password to bind with during the search phase. The key \"bindPassword\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "insecure": {
- "description": "insecure, if true, indicates the connection should not use TLS WARNING: Should not be set to `true` with the URL scheme \"ldaps://\" as \"ldaps://\" URLs always\n attempt to connect using TLS, even when `insecure` is set to `true`\nWhen `true`, \"ldap://\" URLS connect insecurely. When `false`, \"ldap://\" URLs are upgraded to a TLS connection using StartTLS as specified in https://tools.ietf.org/html/rfc2830.",
- "type": "boolean",
- "default": false
- },
- "url": {
- "description": "url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is: ldap://host:port/basedn?attribute?scope?filter",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.LeaderElection": {
- "description": "LeaderElection provides information to elect a leader",
- "type": "object",
- "required": [
- "leaseDuration",
- "renewDeadline",
- "retryPeriod"
- ],
- "properties": {
- "disable": {
- "description": "disable allows leader election to be suspended while allowing a fully defaulted \"normal\" startup case.",
- "type": "boolean"
- },
- "leaseDuration": {
- "description": "leaseDuration is the duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "name": {
- "description": "name indicates what name to use for the resource",
- "type": "string"
- },
- "namespace": {
- "description": "namespace indicates which namespace the resource is in",
- "type": "string"
- },
- "renewDeadline": {
- "description": "renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "retryPeriod": {
- "description": "retryPeriod is the duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- }
- }
- },
- "com.github.openshift.api.config.v1.LoadBalancer": {
- "type": "object",
- "properties": {
- "platform": {
- "description": "platform holds configuration specific to the underlying infrastructure provider for the ingress load balancers. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IngressPlatformSpec"
- }
- }
- },
- "com.github.openshift.api.config.v1.MTUMigration": {
- "description": "MTUMigration contains infomation about MTU migration.",
- "type": "object",
- "properties": {
- "machine": {
- "description": "machine contains MTU migration configuration for the machine's uplink.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.MTUMigrationValues"
- },
- "network": {
- "description": "network contains MTU migration configuration for the default network.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.MTUMigrationValues"
- }
- }
- },
- "com.github.openshift.api.config.v1.MTUMigrationValues": {
- "description": "MTUMigrationValues contains the values for a MTU migration.",
- "type": "object",
- "required": [
- "to"
- ],
- "properties": {
- "from": {
- "description": "from is the MTU to migrate from.",
- "type": "integer",
- "format": "int64"
- },
- "to": {
- "description": "to is the MTU to migrate to.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.config.v1.MaxAgePolicy": {
- "description": "MaxAgePolicy contains a numeric range for specifying a compliant HSTS max-age for the enclosing RequiredHSTSPolicy",
- "type": "object",
- "properties": {
- "largestMaxAge": {
- "description": "The largest allowed value (in seconds) of the RequiredHSTSPolicy max-age This value can be left unspecified, in which case no upper limit is enforced.",
- "type": "integer",
- "format": "int32"
- },
- "smallestMaxAge": {
- "description": "The smallest allowed value (in seconds) of the RequiredHSTSPolicy max-age Setting max-age=0 allows the deletion of an existing HSTS header from a host. This is a necessary tool for administrators to quickly correct mistakes. This value can be left unspecified, in which case no lower limit is enforced.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.config.v1.ModernTLSProfile": {
- "description": "ModernTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.NamedCertificate": {
- "description": "NamedCertificate specifies a certificate/key, and the names it should be served for",
- "type": "object",
- "required": [
- "certFile",
- "keyFile"
- ],
- "properties": {
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "names": {
- "description": "names is a list of DNS names this certificate should be used to secure A name can be a normal DNS name, or can contain leading wildcard segments.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.Network": {
- "description": "Network holds cluster-wide information about Network. The canonical name is `cluster`. It is used to configure the desired network configuration, such as: IP address pools for services/pod IPs, network plugin, etc. Please view network.spec for an explanation on what applies when configuring this resource.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.NetworkDiagnostics": {
- "type": "object",
- "properties": {
- "mode": {
- "description": "mode controls the network diagnostics mode\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is All.",
- "type": "string",
- "default": ""
- },
- "sourcePlacement": {
- "description": "sourcePlacement controls the scheduling of network diagnostics source deployment\n\nSee NetworkDiagnosticsSourcePlacement for more details about default values.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkDiagnosticsSourcePlacement"
- },
- "targetPlacement": {
- "description": "targetPlacement controls the scheduling of network diagnostics target daemonset\n\nSee NetworkDiagnosticsTargetPlacement for more details about default values.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkDiagnosticsTargetPlacement"
- }
- }
- },
- "com.github.openshift.api.config.v1.NetworkDiagnosticsSourcePlacement": {
- "description": "NetworkDiagnosticsSourcePlacement defines node scheduling configuration network diagnostics source components",
- "type": "object",
- "properties": {
- "nodeSelector": {
- "description": "nodeSelector is the node selector applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `kubernetes.io/os: linux`.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "tolerations": {
- "description": "tolerations is a list of tolerations applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is an empty list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.NetworkDiagnosticsTargetPlacement": {
- "description": "NetworkDiagnosticsTargetPlacement defines node scheduling configuration network diagnostics target components",
- "type": "object",
- "properties": {
- "nodeSelector": {
- "description": "nodeSelector is the node selector applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `kubernetes.io/os: linux`.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "tolerations": {
- "description": "tolerations is a list of tolerations applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `- operator: \"Exists\"` which means that all taints are tolerated.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.NetworkList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Network"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.NetworkMigration": {
- "description": "NetworkMigration represents the network migration status.",
- "type": "object",
- "properties": {
- "mtu": {
- "description": "mtu is the MTU configuration that is being deployed.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.MTUMigration"
- },
- "networkType": {
- "description": "networkType is the target plugin that is being deployed. DEPRECATED: network type migration is no longer supported, so this should always be unset.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.NetworkSpec": {
- "description": "NetworkSpec is the desired network configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.",
- "type": "object",
- "required": [
- "clusterNetwork",
- "serviceNetwork",
- "networkType"
- ],
- "properties": {
- "clusterNetwork": {
- "description": "IP address pool to use for pod IPs. This field is immutable after installation.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterNetworkEntry"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "externalIP": {
- "description": "externalIP defines configuration for controllers that affect Service.ExternalIP. If nil, then ExternalIP is not allowed to be set.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalIPConfig"
- },
- "networkDiagnostics": {
- "description": "networkDiagnostics defines network diagnostics configuration.\n\nTakes precedence over spec.disableNetworkDiagnostics in network.operator.openshift.io. If networkDiagnostics is not specified or is empty, and the spec.disableNetworkDiagnostics flag in network.operator.openshift.io is set to true, the network diagnostics feature will be disabled.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkDiagnostics"
- },
- "networkType": {
- "description": "networkType is the plugin that is to be deployed (e.g. OVNKubernetes). This should match a value that the cluster-network-operator understands, or else no networking will be installed. Currently supported values are: - OVNKubernetes This field is immutable after installation.",
- "type": "string",
- "default": ""
- },
- "serviceNetwork": {
- "description": "IP address pool for services. Currently, we only support a single entry here. This field is immutable after installation.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "serviceNodePortRange": {
- "description": "The port range allowed for Services of type NodePort. If not specified, the default of 30000-32767 will be used. Such Services without a NodePort specified will have one automatically allocated from this range. This parameter can be updated after the cluster is installed.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.NetworkStatus": {
- "description": "NetworkStatus is the current network configuration.",
- "type": "object",
- "properties": {
- "clusterNetwork": {
- "description": "IP address pool to use for pod IPs.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterNetworkEntry"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "clusterNetworkMTU": {
- "description": "clusterNetworkMTU is the MTU for inter-pod networking.",
- "type": "integer",
- "format": "int32"
- },
- "conditions": {
- "description": "conditions represents the observations of a network.config current state. Known .status.conditions.type are: \"NetworkDiagnosticsAvailable\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "migration": {
- "description": "migration contains the cluster network migration configuration.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkMigration"
- },
- "networkType": {
- "description": "networkType is the plugin that is deployed (e.g. OVNKubernetes).",
- "type": "string"
- },
- "serviceNetwork": {
- "description": "IP address pool for services. Currently, we only support a single entry here.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.Node": {
- "description": "Node holds cluster-wide information about node specific features.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NodeSpec"
- },
- "status": {
- "description": "status holds observed values.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NodeStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.NodeList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Node"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.NodeSpec": {
- "type": "object",
- "properties": {
- "cgroupMode": {
- "description": "cgroupMode determines the cgroups version on the node",
- "type": "string"
- },
- "minimumKubeletVersion": {
- "description": "minimumKubeletVersion is the lowest version of a kubelet that can join the cluster. Specifically, the apiserver will deny most authorization requests of kubelets that are older than the specified version, only allowing the kubelet to get and update its node object, and perform subjectaccessreviews. This means any kubelet that attempts to join the cluster will not be able to run any assigned workloads, and will eventually be marked as not ready. Its max length is 8, so maximum version allowed is either \"9.999.99\" or \"99.99.99\". Since the kubelet reports the version of the kubernetes release, not Openshift, this field references the underlying kubernetes version this version of Openshift is based off of. In other words: if an admin wishes to ensure no nodes run an older version than Openshift 4.17, then they should set the minimumKubeletVersion to 1.30.0. When comparing versions, the kubelet's version is stripped of any contents outside of major.minor.patch version. Thus, a kubelet with version \"1.0.0-ec.0\" will be compatible with minimumKubeletVersion \"1.0.0\" or earlier.",
- "type": "string",
- "default": ""
- },
- "workerLatencyProfile": {
- "description": "workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.NodeStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions contain the details and the current state of the nodes.config object",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.NutanixFailureDomain": {
- "description": "NutanixFailureDomain configures failure domain information for the Nutanix platform.",
- "type": "object",
- "required": [
- "name",
- "cluster",
- "subnets"
- ],
- "properties": {
- "cluster": {
- "description": "cluster is to identify the cluster (the Prism Element under management of the Prism Central), in which the Machine's VM will be created. The cluster identifier (uuid or name) can be obtained from the Prism Central console or using the prism_central API.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixResourceIdentifier"
- },
- "name": {
- "description": "name defines the unique name of a failure domain. Name is required and must be at most 64 characters in length. It must consist of only lower case alphanumeric characters and hyphens (-). It must start and end with an alphanumeric character. This value is arbitrary and is used to identify the failure domain within the platform.",
- "type": "string",
- "default": ""
- },
- "subnets": {
- "description": "subnets holds a list of identifiers (one or more) of the cluster's network subnets If the feature gate NutanixMultiSubnets is enabled, up to 32 subnets may be configured. for the Machine's VM to connect to. The subnet identifiers (uuid or name) can be obtained from the Prism Central console or using the prism_central API.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixResourceIdentifier"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.NutanixPlatformLoadBalancer": {
- "description": "NutanixPlatformLoadBalancer defines the load balancer used by the cluster on Nutanix platform.",
- "type": "object",
- "properties": {
- "type": {
- "description": "type defines the type of load balancer used by the cluster on Nutanix platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
- "type": "string",
- "default": "OpenShiftManagedDefault"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.config.v1.NutanixPlatformSpec": {
- "description": "NutanixPlatformSpec holds the desired state of the Nutanix infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object",
- "required": [
- "prismCentral",
- "prismElements"
- ],
- "properties": {
- "failureDomains": {
- "description": "failureDomains configures failure domains information for the Nutanix platform. When set, the failure domains defined here may be used to spread Machines across prism element clusters to improve fault tolerance of the cluster.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixFailureDomain"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "prismCentral": {
- "description": "prismCentral holds the endpoint address and port to access the Nutanix Prism Central. When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPrismEndpoint"
- },
- "prismElements": {
- "description": "prismElements holds one or more endpoint address and port data to access the Nutanix Prism Elements (clusters) of the Nutanix Prism Central. Currently we only support one Prism Element (cluster) for an OpenShift cluster, where all the Nutanix resources (VMs, subnets, volumes, etc.) used in the OpenShift cluster are located. In the future, we may support Nutanix resources (VMs, etc.) spread over multiple Prism Elements (clusters) of the Prism Central.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPrismElementEndpoint"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.NutanixPlatformStatus": {
- "description": "NutanixPlatformStatus holds the current status of the Nutanix infrastructure provider.",
- "type": "object",
- "required": [
- "apiServerInternalIPs",
- "ingressIPs"
- ],
- "properties": {
- "apiServerInternalIP": {
- "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
- "type": "string"
- },
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "ingressIP": {
- "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
- "type": "string"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "loadBalancer": {
- "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
- "default": {
- "type": "OpenShiftManagedDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPlatformLoadBalancer"
- }
- }
- },
- "com.github.openshift.api.config.v1.NutanixPrismElementEndpoint": {
- "description": "NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster)",
- "type": "object",
- "required": [
- "name",
- "endpoint"
- ],
- "properties": {
- "endpoint": {
- "description": "endpoint holds the endpoint address and port data of the Prism Element (cluster). When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPrismEndpoint"
- },
- "name": {
- "description": "name is the name of the Prism Element (cluster). This value will correspond with the cluster field configured on other resources (eg Machines, PVCs, etc).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.NutanixPrismEndpoint": {
- "description": "NutanixPrismEndpoint holds the endpoint address and port to access the Nutanix Prism Central or Element (cluster)",
- "type": "object",
- "required": [
- "address",
- "port"
- ],
- "properties": {
- "address": {
- "description": "address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster)",
- "type": "string",
- "default": ""
- },
- "port": {
- "description": "port is the port number to access the Nutanix Prism Central or Element (cluster)",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.config.v1.NutanixResourceIdentifier": {
- "description": "NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.)",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "name": {
- "description": "name is the resource name in the PC. It cannot be empty if the type is Name.",
- "type": "string"
- },
- "type": {
- "description": "type is the identifier type to use for this resource.",
- "type": "string",
- "default": ""
- },
- "uuid": {
- "description": "uuid is the UUID of the resource in the PC. It cannot be empty if the type is UUID.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "name": "Name",
- "uuid": "UUID"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.OAuth": {
- "description": "OAuth holds cluster-wide information about OAuth. The canonical name is `cluster`. It is used to configure the integrated OAuth server. This configuration is only honored when the top level Authentication config has type set to IntegratedOAuth.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuthSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuthStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.OAuthList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuth"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.OAuthRemoteConnectionInfo": {
- "description": "OAuthRemoteConnectionInfo holds information necessary for establishing a remote connection",
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "tlsClientCert": {
- "description": "tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key \"tls.crt\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "tlsClientKey": {
- "description": "tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key \"tls.key\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.OAuthSpec": {
- "description": "OAuthSpec contains desired cluster auth configuration",
- "type": "object",
- "required": [
- "tokenConfig"
- ],
- "properties": {
- "identityProviders": {
- "description": "identityProviders is an ordered list of ways for a user to identify themselves. When this list is empty, no identities are provisioned for users.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IdentityProvider"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "templates": {
- "description": "templates allow you to customize pages like the login page.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuthTemplates"
- },
- "tokenConfig": {
- "description": "tokenConfig contains options for authorization and access tokens",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenConfig"
- }
- }
- },
- "com.github.openshift.api.config.v1.OAuthStatus": {
- "description": "OAuthStatus shows current known state of OAuth server in the cluster",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.OAuthTemplates": {
- "description": "OAuthTemplates allow for customization of pages like the login page",
- "type": "object",
- "properties": {
- "error": {
- "description": "error is the name of a secret that specifies a go template to use to render error pages during the authentication or grant flow. The key \"errors.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default error page is used. If the specified template is not valid, the default error page is used. If unspecified, the default error page is used. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "login": {
- "description": "login is the name of a secret that specifies a go template to use to render the login page. The key \"login.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default login page is used. If the specified template is not valid, the default login page is used. If unspecified, the default login page is used. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "providerSelection": {
- "description": "providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key \"providers.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- }
- }
- },
- "com.github.openshift.api.config.v1.OIDCClientConfig": {
- "description": "OIDCClientConfig configures how platform clients interact with identity providers as an authentication method",
- "type": "object",
- "required": [
- "componentName",
- "componentNamespace",
- "clientID"
- ],
- "properties": {
- "clientID": {
- "description": "clientID is a required field that configures the client identifier, from the identity provider, that the platform component uses for authentication requests made to the identity provider. The identity provider must accept this identifier for platform components to be able to use the identity provider as an authentication mode.\n\nclientID must not be an empty string (\"\").",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is an optional field that configures the client secret used by the platform component when making authentication requests to the identity provider.\n\nWhen not specified, no client secret will be used when making authentication requests to the identity provider.\n\nWhen specified, clientSecret references a Secret in the 'openshift-config' namespace that contains the client secret in the 'clientSecret' key of the '.data' field. The client secret will be used when making authentication requests to the identity provider.\n\nPublic clients do not require a client secret but private clients do require a client secret to work with the identity provider.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "componentName": {
- "description": "componentName is a required field that specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.\n\ncomponentName must not be an empty string (\"\") and must not exceed 256 characters in length.",
- "type": "string",
- "default": ""
- },
- "componentNamespace": {
- "description": "componentNamespace is a required field that specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.\n\ncomponentNamespace must not be an empty string (\"\") and must not exceed 63 characters in length.",
- "type": "string",
- "default": ""
- },
- "extraScopes": {
- "description": "extraScopes is an optional field that configures the extra scopes that should be requested by the platform component when making authentication requests to the identity provider. This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes.\n\nWhen omitted, no additional scopes are requested.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.config.v1.OIDCClientReference": {
- "description": "OIDCClientReference is a reference to a platform component client configuration.",
- "type": "object",
- "required": [
- "oidcProviderName",
- "issuerURL",
- "clientID"
- ],
- "properties": {
- "clientID": {
- "description": "clientID is a required field that specifies the client identifier, from the identity provider, that the platform component is using for authentication requests made to the identity provider.\n\nclientID must not be empty.",
- "type": "string",
- "default": ""
- },
- "issuerURL": {
- "description": "issuerURL is a required field that specifies the URL of the identity provider that this client is configured to make requests against.\n\nissuerURL must use the 'https' scheme.",
- "type": "string",
- "default": ""
- },
- "oidcProviderName": {
- "description": "oidcProviderName is a required reference to the 'name' of the identity provider configured in 'oidcProviders' that this client is associated with.\n\noidcProviderName must not be an empty string (\"\").",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.OIDCClientStatus": {
- "description": "OIDCClientStatus represents the current state of platform components and how they interact with the configured identity providers.",
- "type": "object",
- "required": [
- "componentName",
- "componentNamespace"
- ],
- "properties": {
- "componentName": {
- "description": "componentName is a required field that specifies the name of the platform component using the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.\n\ncomponentName must not be an empty string (\"\") and must not exceed 256 characters in length.",
- "type": "string",
- "default": ""
- },
- "componentNamespace": {
- "description": "componentNamespace is a required field that specifies the namespace in which the platform component using the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.\n\ncomponentNamespace must not be an empty string (\"\") and must not exceed 63 characters in length.",
- "type": "string",
- "default": ""
- },
- "conditions": {
- "description": "conditions are used to communicate the state of the `oidcClients` entry.\n\nSupported conditions include Available, Degraded and Progressing.\n\nIf Available is true, the component is successfully using the configured client. If Degraded is true, that means something has gone wrong trying to handle the client configuration. If Progressing is true, that means the component is taking some action related to the `oidcClients` entry.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "consumingUsers": {
- "description": "consumingUsers is an optional list of ServiceAccounts requiring read permissions on the `clientSecret` secret.\n\nconsumingUsers must not exceed 5 entries.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "currentOIDCClients": {
- "description": "currentOIDCClients is an optional list of clients that the component is currently using. Entries must have unique issuerURL/clientID pairs.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCClientReference"
- },
- "x-kubernetes-list-map-keys": [
- "issuerURL",
- "clientID"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.OIDCProvider": {
- "type": "object",
- "required": [
- "name",
- "issuer",
- "claimMappings"
- ],
- "properties": {
- "claimMappings": {
- "description": "claimMappings is a required field that configures the rules to be used by the Kubernetes API server for translating claims in a JWT token, issued by the identity provider, to a cluster identity.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenClaimMappings"
- },
- "claimValidationRules": {
- "description": "claimValidationRules is an optional field that configures the rules to be used by the Kubernetes API server for validating the claims in a JWT token issued by the identity provider.\n\nValidation rules are joined via an AND operation.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenClaimValidationRule"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "issuer": {
- "description": "issuer is a required field that configures how the platform interacts with the identity provider and how tokens issued from the identity provider are evaluated by the Kubernetes API server.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenIssuer"
- },
- "name": {
- "description": "name is a required field that configures the unique human-readable identifier associated with the identity provider. It is used to distinguish between multiple identity providers and has no impact on token validation or authentication mechanics.\n\nname must not be an empty string (\"\").",
- "type": "string",
- "default": ""
- },
- "oidcClients": {
- "description": "oidcClients is an optional field that configures how on-cluster, platform clients should request tokens from the identity provider. oidcClients must not exceed 20 entries and entries must have unique namespace/name pairs.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCClientConfig"
- },
- "x-kubernetes-list-map-keys": [
- "componentNamespace",
- "componentName"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.ObjectReference": {
- "description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
- "type": "object",
- "required": [
- "group",
- "resource",
- "name"
- ],
- "properties": {
- "group": {
- "description": "group of the referent.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name of the referent.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace of the referent.",
- "type": "string"
- },
- "resource": {
- "description": "resource of the referent.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.OldTLSProfile": {
- "description": "OldTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.OpenIDClaims": {
- "description": "OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider",
- "type": "object",
- "properties": {
- "email": {
- "description": "email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "groups": {
- "description": "groups is the list of claims value of which should be used to synchronize groups from the OIDC provider to OpenShift for the user. If multiple claims are specified, the first one with a non-empty value is used.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "name": {
- "description": "name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "preferredUsername": {
- "description": "preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the sub claim",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.OpenIDIdentityProvider": {
- "description": "OpenIDIdentityProvider provides identities for users authenticating using OpenID credentials",
- "type": "object",
- "required": [
- "clientID",
- "clientSecret",
- "issuer",
- "claims"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "claims": {
- "description": "claims mappings",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenIDClaims"
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "extraAuthorizeParameters": {
- "description": "extraAuthorizeParameters are any custom parameters to add to the authorize request.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "extraScopes": {
- "description": "extraScopes are any scopes to request in addition to the standard \"openid\" scope.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "issuer": {
- "description": "issuer is the URL that the OpenID Provider asserts as its Issuer Identifier. It must use the https scheme with no query or fragment component.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.OpenStackPlatformLoadBalancer": {
- "description": "OpenStackPlatformLoadBalancer defines the load balancer used by the cluster on OpenStack platform.",
- "type": "object",
- "properties": {
- "type": {
- "description": "type defines the type of load balancer used by the cluster on OpenStack platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
- "type": "string",
- "default": "OpenShiftManagedDefault"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.config.v1.OpenStackPlatformSpec": {
- "description": "OpenStackPlatformSpec holds the desired state of the OpenStack infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object",
- "properties": {
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "machineNetworks": {
- "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example \"10.0.0.0/8\" or \"fd00::/8\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.OpenStackPlatformStatus": {
- "description": "OpenStackPlatformStatus holds the current status of the OpenStack infrastructure provider.",
- "type": "object",
- "required": [
- "apiServerInternalIPs",
- "ingressIPs"
- ],
- "properties": {
- "apiServerInternalIP": {
- "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
- "type": "string"
- },
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "cloudName": {
- "description": "cloudName is the name of the desired OpenStack cloud in the client configuration file (`clouds.yaml`).",
- "type": "string"
- },
- "ingressIP": {
- "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
- "type": "string"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "loadBalancer": {
- "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
- "default": {
- "type": "OpenShiftManagedDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenStackPlatformLoadBalancer"
- },
- "machineNetworks": {
- "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "nodeDNSIP": {
- "description": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for OpenStack deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.OperandVersion": {
- "type": "object",
- "required": [
- "name",
- "version"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the particular operand this version is for. It usually matches container images, not operators.",
- "type": "string",
- "default": ""
- },
- "version": {
- "description": "version indicates which version of a particular operand is currently being managed. It must always match the Available operand. If 1.0.0 is Available, then this must indicate 1.0.0 even if the operator is trying to rollout 1.1.0",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.OperatorHub": {
- "description": "OperatorHub is the Schema for the operatorhubs API. It can be used to change the state of the default hub sources for OperatorHub on the cluster from enabled to disabled and vice versa.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec",
- "status"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OperatorHubSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OperatorHubStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.OperatorHubList": {
- "description": "OperatorHubList contains a list of OperatorHub\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OperatorHub"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.OperatorHubSpec": {
- "description": "OperatorHubSpec defines the desired state of OperatorHub",
- "type": "object",
- "properties": {
- "disableAllDefaultSources": {
- "description": "disableAllDefaultSources allows you to disable all the default hub sources. If this is true, a specific entry in sources can be used to enable a default source. If this is false, a specific entry in sources can be used to disable or enable a default source.",
- "type": "boolean"
- },
- "sources": {
- "description": "sources is the list of default hub sources and their configuration. If the list is empty, it implies that the default hub sources are enabled on the cluster unless disableAllDefaultSources is true. If disableAllDefaultSources is true and sources is not empty, the configuration present in sources will take precedence. The list of default hub sources and their current state will always be reflected in the status block.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HubSource"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.OperatorHubStatus": {
- "description": "OperatorHubStatus defines the observed state of OperatorHub. The current state of the default hub sources will always be reflected here.",
- "type": "object",
- "properties": {
- "sources": {
- "description": "sources encapsulates the result of applying the configuration for each hub source",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HubSourceStatus"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.OvirtPlatformLoadBalancer": {
- "description": "OvirtPlatformLoadBalancer defines the load balancer used by the cluster on Ovirt platform.",
- "type": "object",
- "properties": {
- "type": {
- "description": "type defines the type of load balancer used by the cluster on Ovirt platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
- "type": "string",
- "default": "OpenShiftManagedDefault"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.config.v1.OvirtPlatformSpec": {
- "description": "OvirtPlatformSpec holds the desired state of the oVirt infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object"
- },
- "com.github.openshift.api.config.v1.OvirtPlatformStatus": {
- "description": "OvirtPlatformStatus holds the current status of the oVirt infrastructure provider.",
- "type": "object",
- "required": [
- "apiServerInternalIPs",
- "ingressIPs"
- ],
- "properties": {
- "apiServerInternalIP": {
- "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
- "type": "string"
- },
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "ingressIP": {
- "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
- "type": "string"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "loadBalancer": {
- "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
- "default": {
- "type": "OpenShiftManagedDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OvirtPlatformLoadBalancer"
- },
- "nodeDNSIP": {
- "description": "deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.PKI": {
- "description": "PKI defines the root of trust based on Root CA(s) and corresponding intermediate certificates.",
- "type": "object",
- "required": [
- "caRootsData",
- "pkiCertificateSubject"
- ],
- "properties": {
- "caIntermediatesData": {
- "description": "caIntermediatesData contains base64-encoded data of a certificate bundle PEM file, which contains one or more intermediate certificates in the PEM format. The total length of the data must not exceed 8192 characters. caIntermediatesData requires caRootsData to be set.",
- "type": "string",
- "format": "byte"
- },
- "caRootsData": {
- "description": "caRootsData contains base64-encoded data of a certificate bundle PEM file, which contains one or more CA roots in the PEM format. The total length of the data must not exceed 8192 characters.",
- "type": "string",
- "format": "byte"
- },
- "pkiCertificateSubject": {
- "description": "pkiCertificateSubject defines the requirements imposed on the subject to which the certificate was issued.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PKICertificateSubject"
- }
- }
- },
- "com.github.openshift.api.config.v1.PKICertificateSubject": {
- "description": "PKICertificateSubject defines the requirements imposed on the subject to which the certificate was issued.",
- "type": "object",
- "properties": {
- "email": {
- "description": "email specifies the expected email address imposed on the subject to which the certificate was issued, and must match the email address listed in the Subject Alternative Name (SAN) field of the certificate. The email must be a valid email address and at most 320 characters in length.",
- "type": "string"
- },
- "hostname": {
- "description": "hostname specifies the expected hostname imposed on the subject to which the certificate was issued, and it must match the hostname listed in the Subject Alternative Name (SAN) DNS field of the certificate. The hostname must be a valid dns 1123 subdomain name, optionally prefixed by '*.', and at most 253 characters in length. It must consist only of lowercase alphanumeric characters, hyphens, periods and the optional preceding asterisk.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.PersistentVolumeClaimReference": {
- "description": "PersistentVolumeClaimReference is a reference to a PersistentVolumeClaim.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the PersistentVolumeClaim that will be used to store the Insights data archive. It is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.PersistentVolumeConfig": {
- "description": "PersistentVolumeConfig provides configuration options for PersistentVolume storage.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PersistentVolumeClaimReference"
- },
- "mountPath": {
- "description": "mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.PlatformSpec": {
- "description": "PlatformSpec holds the desired state specific to the underlying infrastructure provider of the current cluster. Since these are used at spec-level for the underlying cluster, it is supposed that only one of the spec structs is set.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "alibabaCloud": {
- "description": "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AlibabaCloudPlatformSpec"
- },
- "aws": {
- "description": "aws contains settings specific to the Amazon Web Services infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSPlatformSpec"
- },
- "azure": {
- "description": "azure contains settings specific to the Azure infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AzurePlatformSpec"
- },
- "baremetal": {
- "description": "baremetal contains settings specific to the BareMetal platform.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BareMetalPlatformSpec"
- },
- "equinixMetal": {
- "description": "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.EquinixMetalPlatformSpec"
- },
- "external": {
- "description": "ExternalPlatformType represents generic infrastructure provider. Platform-specific components should be supplemented separately.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalPlatformSpec"
- },
- "gcp": {
- "description": "gcp contains settings specific to the Google Cloud Platform infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPPlatformSpec"
- },
- "ibmcloud": {
- "description": "ibmcloud contains settings specific to the IBMCloud infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudPlatformSpec"
- },
- "kubevirt": {
- "description": "kubevirt contains settings specific to the kubevirt infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KubevirtPlatformSpec"
- },
- "nutanix": {
- "description": "nutanix contains settings specific to the Nutanix infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPlatformSpec"
- },
- "openstack": {
- "description": "openstack contains settings specific to the OpenStack infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenStackPlatformSpec"
- },
- "ovirt": {
- "description": "ovirt contains settings specific to the oVirt infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OvirtPlatformSpec"
- },
- "powervs": {
- "description": "powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSPlatformSpec"
- },
- "type": {
- "description": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"KubeVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.",
- "type": "string",
- "default": ""
- },
- "vsphere": {
- "description": "vsphere contains settings specific to the VSphere infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformSpec"
- }
- }
- },
- "com.github.openshift.api.config.v1.PlatformStatus": {
- "description": "PlatformStatus holds the current status specific to the underlying infrastructure provider of the current cluster. Since these are used at status-level for the underlying cluster, it is supposed that only one of the status structs is set.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "alibabaCloud": {
- "description": "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AlibabaCloudPlatformStatus"
- },
- "aws": {
- "description": "aws contains settings specific to the Amazon Web Services infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSPlatformStatus"
- },
- "azure": {
- "description": "azure contains settings specific to the Azure infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AzurePlatformStatus"
- },
- "baremetal": {
- "description": "baremetal contains settings specific to the BareMetal platform.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.BareMetalPlatformStatus"
- },
- "equinixMetal": {
- "description": "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.EquinixMetalPlatformStatus"
- },
- "external": {
- "description": "external contains settings specific to the generic External infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalPlatformStatus"
- },
- "gcp": {
- "description": "gcp contains settings specific to the Google Cloud Platform infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPPlatformStatus"
- },
- "ibmcloud": {
- "description": "ibmcloud contains settings specific to the IBMCloud infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudPlatformStatus"
- },
- "kubevirt": {
- "description": "kubevirt contains settings specific to the kubevirt infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KubevirtPlatformStatus"
- },
- "nutanix": {
- "description": "nutanix contains settings specific to the Nutanix infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPlatformStatus"
- },
- "openstack": {
- "description": "openstack contains settings specific to the OpenStack infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenStackPlatformStatus"
- },
- "ovirt": {
- "description": "ovirt contains settings specific to the oVirt infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OvirtPlatformStatus"
- },
- "powervs": {
- "description": "powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSPlatformStatus"
- },
- "type": {
- "description": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.\n\nThis value will be synced with to the `status.platform` and `status.platformStatus.type`. Currently this value cannot be changed once set.",
- "type": "string",
- "default": ""
- },
- "vsphere": {
- "description": "vsphere contains settings specific to the VSphere infrastructure provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.Policy": {
- "description": "Policy defines the verification policy for the items in the scopes list.",
- "type": "object",
- "required": [
- "rootOfTrust"
- ],
- "properties": {
- "rootOfTrust": {
- "description": "rootOfTrust is a required field that defines the root of trust for verifying image signatures during retrieval. This allows image consumers to specify policyType and corresponding configuration of the policy, matching how the policy was generated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyRootOfTrust"
- },
- "signedIdentity": {
- "description": "signedIdentity is an optional field specifies what image identity the signature claims about the image. This is useful when the image identity in the signature differs from the original image spec, such as when mirror registry is configured for the image scope, the signature from the mirror registry contains the image identity of the mirror instead of the original scope. The required matchPolicy field specifies the approach used in the verification process to verify the identity in the signature and the actual image identity, the default matchPolicy is \"MatchRepoDigestOrExact\".",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyIdentity"
- }
- }
- },
- "com.github.openshift.api.config.v1.PolicyFulcioSubject": {
- "description": "PolicyFulcioSubject defines the OIDC issuer and the email of the Fulcio authentication configuration.",
- "type": "object",
- "required": [
- "oidcIssuer",
- "signedEmail"
- ],
- "properties": {
- "oidcIssuer": {
- "description": "oidcIssuer is a required filed contains the expected OIDC issuer. The oidcIssuer must be a valid URL and at most 2048 characters in length. It will be verified that the Fulcio-issued certificate contains a (Fulcio-defined) certificate extension pointing at this OIDC issuer URL. When Fulcio issues certificates, it includes a value based on an URL inside the client-provided ID token. Example: \"https://expected.OIDC.issuer/\"",
- "type": "string",
- "default": ""
- },
- "signedEmail": {
- "description": "signedEmail is a required field holds the email address that the Fulcio certificate is issued for. The signedEmail must be a valid email address and at most 320 characters in length. Example: \"expected-signing-user@example.com\"",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.PolicyIdentity": {
- "description": "PolicyIdentity defines image identity the signature claims about the image. When omitted, the default matchPolicy is \"MatchRepoDigestOrExact\".",
- "type": "object",
- "required": [
- "matchPolicy"
- ],
- "properties": {
- "exactRepository": {
- "description": "exactRepository specifies the repository that must be exactly matched by the identity in the signature. exactRepository is required if matchPolicy is set to \"ExactRepository\". It is used to verify that the signature claims an identity matching this exact repository, rather than the original image identity.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyMatchExactRepository"
- },
- "matchPolicy": {
- "description": "matchPolicy is a required filed specifies matching strategy to verify the image identity in the signature against the image scope. Allowed values are \"MatchRepoDigestOrExact\", \"MatchRepository\", \"ExactRepository\", \"RemapIdentity\". When omitted, the default value is \"MatchRepoDigestOrExact\". When set to \"MatchRepoDigestOrExact\", the identity in the signature must be in the same repository as the image identity if the image identity is referenced by a digest. Otherwise, the identity in the signature must be the same as the image identity. When set to \"MatchRepository\", the identity in the signature must be in the same repository as the image identity. When set to \"ExactRepository\", the exactRepository must be specified. The identity in the signature must be in the same repository as a specific identity specified by \"repository\". When set to \"RemapIdentity\", the remapIdentity must be specified. The signature must be in the same as the remapped image identity. Remapped image identity is obtained by replacing the \"prefix\" with the specified “signedPrefix” if the the image identity matches the specified remapPrefix.",
- "type": "string",
- "default": ""
- },
- "remapIdentity": {
- "description": "remapIdentity specifies the prefix remapping rule for verifying image identity. remapIdentity is required if matchPolicy is set to \"RemapIdentity\". It is used to verify that the signature claims a different registry/repository prefix than the original image.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyMatchRemapIdentity"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "matchPolicy",
- "fields-to-discriminateBy": {
- "exactRepository": "PolicyMatchExactRepository",
- "remapIdentity": "PolicyMatchRemapIdentity"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.PolicyMatchExactRepository": {
- "type": "object",
- "required": [
- "repository"
- ],
- "properties": {
- "repository": {
- "description": "repository is the reference of the image identity to be matched. repository is required if matchPolicy is set to \"ExactRepository\". The value should be a repository name (by omitting the tag or digest) in a registry implementing the \"Docker Registry HTTP API V2\". For example, docker.io/library/busybox",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.PolicyMatchRemapIdentity": {
- "type": "object",
- "required": [
- "prefix",
- "signedPrefix"
- ],
- "properties": {
- "prefix": {
- "description": "prefix is required if matchPolicy is set to \"RemapIdentity\". prefix is the prefix of the image identity to be matched. If the image identity matches the specified prefix, that prefix is replaced by the specified “signedPrefix” (otherwise it is used as unchanged and no remapping takes place). This is useful when verifying signatures for a mirror of some other repository namespace that preserves the vendor’s repository structure. The prefix and signedPrefix values can be either host[:port] values (matching exactly the same host[:port], string), repository namespaces, or repositories (i.e. they must not contain tags/digests), and match as prefixes of the fully expanded form. For example, docker.io/library/busybox (not busybox) to specify that single repository, or docker.io/library (not an empty string) to specify the parent namespace of docker.io/library/busybox.",
- "type": "string",
- "default": ""
- },
- "signedPrefix": {
- "description": "signedPrefix is required if matchPolicy is set to \"RemapIdentity\". signedPrefix is the prefix of the image identity to be matched in the signature. The format is the same as \"prefix\". The values can be either host[:port] values (matching exactly the same host[:port], string), repository namespaces, or repositories (i.e. they must not contain tags/digests), and match as prefixes of the fully expanded form. For example, docker.io/library/busybox (not busybox) to specify that single repository, or docker.io/library (not an empty string) to specify the parent namespace of docker.io/library/busybox.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.PolicyRootOfTrust": {
- "description": "PolicyRootOfTrust defines the root of trust based on the selected policyType.",
- "type": "object",
- "required": [
- "policyType"
- ],
- "properties": {
- "fulcioCAWithRekor": {
- "description": "fulcioCAWithRekor defines the root of trust configuration based on the Fulcio certificate and the Rekor public key. fulcioCAWithRekor is required when policyType is FulcioCAWithRekor, and forbidden otherwise For more information about Fulcio and Rekor, please refer to the document at: https://github.com/sigstore/fulcio and https://github.com/sigstore/rekor",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FulcioCAWithRekor"
- },
- "pki": {
- "description": "pki defines the root of trust configuration based on Bring Your Own Public Key Infrastructure (BYOPKI) Root CA(s) and corresponding intermediate certificates. pki is required when policyType is PKI, and forbidden otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PKI"
- },
- "policyType": {
- "description": "policyType is a required field specifies the type of the policy for verification. This field must correspond to how the policy was generated. Allowed values are \"PublicKey\", \"FulcioCAWithRekor\", and \"PKI\". When set to \"PublicKey\", the policy relies on a sigstore publicKey and may optionally use a Rekor verification. When set to \"FulcioCAWithRekor\", the policy is based on the Fulcio certification and incorporates a Rekor verification. When set to \"PKI\", the policy is based on the certificates from Bring Your Own Public Key Infrastructure (BYOPKI). This value is enabled by turning on the SigstoreImageVerificationPKI feature gate.",
- "type": "string",
- "default": ""
- },
- "publicKey": {
- "description": "publicKey defines the root of trust configuration based on a sigstore public key. Optionally include a Rekor public key for Rekor verification. publicKey is required when policyType is PublicKey, and forbidden otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PublicKey"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "policyType",
- "fields-to-discriminateBy": {
- "fulcioCAWithRekor": "FulcioCAWithRekor",
- "pki": "PKI",
- "publicKey": "PublicKey"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.PowerVSPlatformSpec": {
- "description": "PowerVSPlatformSpec holds the desired state of the IBM Power Systems Virtual Servers infrastructure provider. This only includes fields that can be modified in the cluster.",
- "type": "object",
- "properties": {
- "serviceEndpoints": {
- "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSServiceEndpoint"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1.PowerVSPlatformStatus": {
- "description": "PowerVSPlatformStatus holds the current status of the IBM Power Systems Virtual Servers infrastrucutre provider.",
- "type": "object",
- "required": [
- "region",
- "zone"
- ],
- "properties": {
- "cisInstanceCRN": {
- "description": "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain",
- "type": "string"
- },
- "dnsInstanceCRN": {
- "description": "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain",
- "type": "string"
- },
- "region": {
- "description": "region holds the default Power VS region for new Power VS resources created by the cluster.",
- "type": "string",
- "default": ""
- },
- "resourceGroup": {
- "description": "resourceGroup is the resource group name for new IBMCloud resources created for a cluster. The resource group specified here will be used by cluster-image-registry-operator to set up a COS Instance in IBMCloud for the cluster registry. More about resource groups can be found here: https://cloud.ibm.com/docs/account?topic=account-rgs. When omitted, the image registry operator won't be able to configure storage, which results in the image registry cluster operator not being in an available state.",
- "type": "string",
- "default": ""
- },
- "serviceEndpoints": {
- "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSServiceEndpoint"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "zone": {
- "description": "zone holds the default zone for the new Power VS resources created by the cluster. Note: Currently only single-zone OCP clusters are supported",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.PowerVSServiceEndpoint": {
- "description": "PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.",
- "type": "object",
- "required": [
- "name",
- "url"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the Power VS service. Few of the services are IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.PrefixedClaimMapping": {
- "description": "PrefixedClaimMapping configures a claim mapping that allows for an optional prefix.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.",
- "type": "string",
- "default": ""
- },
- "prefix": {
- "description": "prefix is an optional field that configures the prefix that will be applied to the cluster identity attribute during the process of mapping JWT claims to cluster identity attributes.\n\nWhen omitted (\"\"), no prefix is applied to the cluster identity attribute.\n\nExample: if `prefix` is set to \"myoidc:\" and the `claim` in JWT contains an array of strings \"a\", \"b\" and \"c\", the mapping will result in an array of string \"myoidc:a\", \"myoidc:b\" and \"myoidc:c\".",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ProfileCustomizations": {
- "description": "ProfileCustomizations contains various parameters for modifying the default behavior of certain profiles",
- "type": "object",
- "properties": {
- "dynamicResourceAllocation": {
- "description": "dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler. Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod. Third-party resource drivers are responsible for tracking and allocating resources. Different kinds of resources support arbitrary parameters for defining requirements and initialization. Valid values are Enabled, Disabled and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is Disabled.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Project": {
- "description": "Project holds cluster-wide information about Project. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ProjectSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ProjectStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ProjectList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Project"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ProjectSpec": {
- "description": "ProjectSpec holds the project creation configuration.",
- "type": "object",
- "properties": {
- "projectRequestMessage": {
- "description": "projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint",
- "type": "string",
- "default": ""
- },
- "projectRequestTemplate": {
- "description": "projectRequestTemplate is the template to use for creating projects in response to projectrequest. This must point to a template in 'openshift-config' namespace. It is optional. If it is not specified, a default template is used.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TemplateReference"
- }
- }
- },
- "com.github.openshift.api.config.v1.ProjectStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1.PromQLClusterCondition": {
- "description": "PromQLClusterCondition represents a cluster condition based on PromQL.",
- "type": "object",
- "required": [
- "promql"
- ],
- "properties": {
- "promql": {
- "description": "promql is a PromQL query classifying clusters. This query query should return a 1 in the match case and a 0 in the does-not-match case. Queries which return no time series, or which return values besides 0 or 1, are evaluation failures.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Proxy": {
- "description": "Proxy holds cluster-wide information on how to configure default proxies for the cluster. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user-settable values for the proxy configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxySpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxyStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.ProxyList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Proxy"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.ProxySpec": {
- "description": "ProxySpec contains cluster proxy creation configuration.",
- "type": "object",
- "properties": {
- "httpProxy": {
- "description": "httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var.",
- "type": "string"
- },
- "httpsProxy": {
- "description": "httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var.",
- "type": "string"
- },
- "noProxy": {
- "description": "noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var.",
- "type": "string"
- },
- "readinessEndpoints": {
- "description": "readinessEndpoints is a list of endpoints used to verify readiness of the proxy.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "trustedCA": {
- "description": "trustedCA is a reference to a ConfigMap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key \"ca-bundle.crt\", merging it with the system default trust bundle, and writing the merged trust bundle to a ConfigMap named \"trusted-ca-bundle\" in the \"openshift-config-managed\" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well.\n\nThe namespace for the ConfigMap referenced by trustedCA is \"openshift-config\". Here is an example ConfigMap (in yaml):\n\napiVersion: v1 kind: ConfigMap metadata:\n name: user-ca-bundle\n namespace: openshift-config\n data:\n ca-bundle.crt: |\n -----BEGIN CERTIFICATE-----\n Custom CA certificate bundle.\n -----END CERTIFICATE-----",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- }
- }
- },
- "com.github.openshift.api.config.v1.ProxyStatus": {
- "description": "ProxyStatus shows current known state of the cluster proxy.",
- "type": "object",
- "properties": {
- "httpProxy": {
- "description": "httpProxy is the URL of the proxy for HTTP requests.",
- "type": "string"
- },
- "httpsProxy": {
- "description": "httpsProxy is the URL of the proxy for HTTPS requests.",
- "type": "string"
- },
- "noProxy": {
- "description": "noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.PublicKey": {
- "description": "PublicKey defines the root of trust based on a sigstore public key.",
- "type": "object",
- "required": [
- "keyData"
- ],
- "properties": {
- "keyData": {
- "description": "keyData is a required field contains inline base64-encoded data for the PEM format public key. keyData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- },
- "rekorKeyData": {
- "description": "rekorKeyData is an optional field contains inline base64-encoded data for the PEM format from the Rekor public key. rekorKeyData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- }
- }
- },
- "com.github.openshift.api.config.v1.RegistryLocation": {
- "description": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.",
- "type": "object",
- "required": [
- "domainName"
- ],
- "properties": {
- "domainName": {
- "description": "domainName specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.",
- "type": "string",
- "default": ""
- },
- "insecure": {
- "description": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.config.v1.RegistrySources": {
- "description": "RegistrySources holds cluster-wide information about how to handle the registries config.",
- "type": "object",
- "properties": {
- "allowedRegistries": {
- "description": "allowedRegistries are the only registries permitted for image pull and push actions. All other registries are denied.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "blockedRegistries": {
- "description": "blockedRegistries cannot be used for image pull and push actions. All other registries are permitted.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "containerRuntimeSearchRegistries": {
- "description": "containerRuntimeSearchRegistries are registries that will be searched when pulling images that do not have fully qualified domains in their pull specs. Registries will be searched in the order provided in the list. Note: this search list only works with the container runtime, i.e CRI-O. Will NOT work with builds or imagestream imports.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "insecureRegistries": {
- "description": "insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.Release": {
- "description": "Release represents an OpenShift release image and associated metadata.",
- "type": "object",
- "required": [
- "version",
- "image"
- ],
- "properties": {
- "architecture": {
- "description": "architecture is an optional field that indicates the value of the cluster architecture. In this context cluster architecture means either a single architecture or a multi architecture. Valid values are 'Multi' and empty.",
- "type": "string"
- },
- "channels": {
- "description": "channels is the set of Cincinnati channels to which the release currently belongs.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "image": {
- "description": "image is a container image location that contains the update. When this field is part of spec, image is optional if version is specified and the availableUpdates field contains a matching version.",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url contains information about this release. This URL is set by the 'url' metadata property on a release or the metadata returned by the update API and should be displayed as a link in user interfaces. The URL field may not be set for test or nightly releases.",
- "type": "string"
- },
- "version": {
- "description": "version is a semantic version identifying the update version. When this field is part of spec, version is optional if image is specified.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.RemoteConnectionInfo": {
- "description": "RemoteConnectionInfo holds information necessary for establishing a remote connection",
- "type": "object",
- "required": [
- "url",
- "ca",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "ca": {
- "description": "ca is the CA for verifying TLS connections",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.RepositoryDigestMirrors": {
- "description": "RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
- "type": "object",
- "required": [
- "source"
- ],
- "properties": {
- "allowMirrorByTags": {
- "description": "allowMirrorByTags if true, the mirrors can be used to pull the images that are referenced by their tags. Default is false, the mirrors only work when pulling the images that are referenced by their digests. Pulling images by tag can potentially yield different images, depending on which endpoint we pull from. Forcing digest-pulls for mirrors avoids that issue.",
- "type": "boolean"
- },
- "mirrors": {
- "description": "mirrors is zero or more repositories that may also contain the same images. If the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec. No mirror will be configured. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. Other cluster configuration, including (but not limited to) other repositoryDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "source": {
- "description": "source is the repository that users refer to, e.g. in image pull specifications.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.RequestHeaderIdentityProvider": {
- "description": "RequestHeaderIdentityProvider provides identities for users authenticating using request header credentials",
- "type": "object",
- "required": [
- "loginURL",
- "challengeURL",
- "ca",
- "headers",
- "preferredUsernameHeaders",
- "nameHeaders",
- "emailHeaders"
- ],
- "properties": {
- "ca": {
- "description": "ca is a required reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. Specifically, it allows verification of incoming requests to prevent header spoofing. The key \"ca.crt\" is used to locate the data. If the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "challengeURL": {
- "description": "challengeURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect WWW-Authenticate challenges will be redirected here. ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}\nRequired when challenge is set to true.",
- "type": "string",
- "default": ""
- },
- "clientCommonNames": {
- "description": "clientCommonNames is an optional list of common names to require a match from. If empty, any client certificate validated against the clientCA bundle is considered authoritative.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "emailHeaders": {
- "description": "emailHeaders is the set of headers to check for the email address",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "headers": {
- "description": "headers is the set of headers to check for identity information",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "loginURL": {
- "description": "loginURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect interactive logins will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}\nRequired when login is set to true.",
- "type": "string",
- "default": ""
- },
- "nameHeaders": {
- "description": "nameHeaders is the set of headers to check for the display name",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "preferredUsernameHeaders": {
- "description": "preferredUsernameHeaders is the set of headers to check for the preferred username",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.RequiredHSTSPolicy": {
- "type": "object",
- "required": [
- "domainPatterns",
- "maxAge"
- ],
- "properties": {
- "domainPatterns": {
- "description": "domainPatterns is a list of domains for which the desired HSTS annotations are required. If domainPatterns is specified and a route is created with a spec.host matching one of the domains, the route must specify the HSTS Policy components described in the matching RequiredHSTSPolicy.\n\nThe use of wildcards is allowed like this: *.foo.com matches everything under foo.com. foo.com only matches foo.com, so to cover foo.com and everything under it, you must specify *both*.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "includeSubDomainsPolicy": {
- "description": "includeSubDomainsPolicy means the HSTS Policy should apply to any subdomains of the host's domain name. Thus, for the host bar.foo.com, if includeSubDomainsPolicy was set to RequireIncludeSubDomains: - the host app.bar.foo.com would inherit the HSTS Policy of bar.foo.com - the host bar.foo.com would inherit the HSTS Policy of bar.foo.com - the host foo.com would NOT inherit the HSTS Policy of bar.foo.com - the host def.foo.com would NOT inherit the HSTS Policy of bar.foo.com",
- "type": "string"
- },
- "maxAge": {
- "description": "maxAge is the delta time range in seconds during which hosts are regarded as HSTS hosts. If set to 0, it negates the effect, and hosts are removed as HSTS hosts. If set to 0 and includeSubdomains is specified, all subdomains of the host are also removed as HSTS hosts. maxAge is a time-to-live value, and if this policy is not refreshed on a client, the HSTS policy will eventually expire on that client.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.MaxAgePolicy"
- },
- "namespaceSelector": {
- "description": "namespaceSelector specifies a label selector such that the policy applies only to those routes that are in namespaces with labels that match the selector, and are in one of the DomainPatterns. Defaults to the empty LabelSelector, which matches everything.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "preloadPolicy": {
- "description": "preloadPolicy directs the client to include hosts in its host preload list so that it never needs to do an initial load to get the HSTS header (note that this is not defined in RFC 6797 and is therefore client implementation-dependent).",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.Scheduler": {
- "description": "Scheduler holds cluster-wide config information to run the Kubernetes Scheduler and influence its placement decisions. The canonical name for this config is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SchedulerSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SchedulerStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.SchedulerList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.Scheduler"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1.SchedulerSpec": {
- "type": "object",
- "properties": {
- "defaultNodeSelector": {
- "description": "defaultNodeSelector helps set the cluster-wide default node selector to restrict pod placement to specific nodes. This is applied to the pods created in all namespaces and creates an intersection with any existing nodeSelectors already set on a pod, additionally constraining that pod's selector. For example, defaultNodeSelector: \"type=user-node,region=east\" would set nodeSelector field in pod spec to \"type=user-node,region=east\" to all pods created in all namespaces. Namespaces having project-wide node selectors won't be impacted even if this field is set. This adds an annotation section to the namespace. For example, if a new namespace is created with node-selector='type=user-node,region=east', the annotation openshift.io/node-selector: type=user-node,region=east gets added to the project. When the openshift.io/node-selector annotation is set on the project the value is used in preference to the value we are setting for defaultNodeSelector field. For instance, openshift.io/node-selector: \"type=user-node,region=west\" means that the default of \"type=user-node,region=east\" set in defaultNodeSelector would not be applied.",
- "type": "string"
- },
- "mastersSchedulable": {
- "description": "mastersSchedulable allows masters nodes to be schedulable. When this flag is turned on, all the master nodes in the cluster will be made schedulable, so that workload pods can run on them. The default value for this field is false, meaning none of the master nodes are schedulable. Important Note: Once the workload pods start running on the master nodes, extreme care must be taken to ensure that cluster-critical control plane components are not impacted. Please turn on this field after doing due diligence.",
- "type": "boolean",
- "default": false
- },
- "policy": {
- "description": "DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release. policy is a reference to a ConfigMap containing scheduler policy which has user specified predicates and priorities. If this ConfigMap is not available scheduler will default to use DefaultAlgorithmProvider. The namespace for this configmap is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "profile": {
- "description": "profile sets which scheduling profile should be set in order to configure scheduling decisions for new pods.\n\nValid values are \"LowNodeUtilization\", \"HighNodeUtilization\", \"NoScoring\" Defaults to \"LowNodeUtilization\"",
- "type": "string"
- },
- "profileCustomizations": {
- "description": "profileCustomizations contains configuration for modifying the default behavior of existing scheduler profiles.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ProfileCustomizations"
- }
- }
- },
- "com.github.openshift.api.config.v1.SchedulerStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1.SecretNameReference": {
- "description": "SecretNameReference references a secret in a specific namespace. The namespace must be specified at the point of use.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the metadata.name of the referenced secret",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.ServingInfo": {
- "description": "ServingInfo holds information about serving web pages",
- "type": "object",
- "required": [
- "bindAddress",
- "bindNetwork",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "bindAddress": {
- "description": "bindAddress is the ip:port to serve on",
- "type": "string",
- "default": ""
- },
- "bindNetwork": {
- "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "cipherSuites": {
- "description": "cipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "clientCA": {
- "description": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
- "type": "string"
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "minTLSVersion": {
- "description": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "string"
- },
- "namedCertificates": {
- "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.NamedCertificate"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.SignatureStore": {
- "description": "SignatureStore represents the URL of custom Signature Store",
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the signature store is not honored. If the specified ca data is not valid, the signature store is not honored. If empty, we fall back to the CA configured via Proxy, which is appended to the default system roots. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "url": {
- "description": "url contains the upstream custom signature store URL. url should be a valid absolute http/https URI of an upstream signature store as per rfc1738. This must be provided and cannot be empty.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Storage": {
- "description": "Storage provides persistent storage configuration options for gathering jobs. If the type is set to PersistentVolume, then the PersistentVolume must be defined. If the type is set to Ephemeral, then the PersistentVolume must not be defined.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "persistentVolume": {
- "description": "persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PersistentVolumeConfig"
- },
- "type": {
- "description": "type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are \"PersistentVolume\" and \"Ephemeral\". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the persistentVolume field.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "persistentVolume": "PersistentVolume"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.StringSource": {
- "description": "StringSource allows specifying a string inline, or externally via env var or file. When it contains only a string value, it marshals to a simple JSON string.",
- "type": "object",
- "required": [
- "value",
- "env",
- "file",
- "keyFile"
- ],
- "properties": {
- "env": {
- "description": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "file": {
- "description": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile references a file containing the key to use to decrypt the value.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.StringSourceSpec": {
- "description": "StringSourceSpec specifies a string value, or external location",
- "type": "object",
- "required": [
- "value",
- "env",
- "file",
- "keyFile"
- ],
- "properties": {
- "env": {
- "description": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "file": {
- "description": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile references a file containing the key to use to decrypt the value.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.TLSProfileSpec": {
- "description": "TLSProfileSpec is the desired behavior of a TLSSecurityProfile.",
- "type": "object",
- "required": [
- "ciphers",
- "minTLSVersion"
- ],
- "properties": {
- "ciphers": {
- "description": "ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake. Operators may remove entries their operands do not support. For example, to use DES-CBC3-SHA (yaml):\n\n ciphers:\n - DES-CBC3-SHA",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "minTLSVersion": {
- "description": "minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml):\n\n minTLSVersion: VersionTLS11\n\nNOTE: currently the highest minTLSVersion allowed is VersionTLS12",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.TLSSecurityProfile": {
- "description": "TLSSecurityProfile defines the schema for a TLS security profile. This object is used by operators to apply TLS security settings to operands.",
- "type": "object",
- "properties": {
- "custom": {
- "description": "custom is a user-defined TLS security profile. Be extremely careful using a custom profile as invalid configurations can be catastrophic. An example custom profile looks like this:\n\n ciphers:\n\n - ECDHE-ECDSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-AES128-GCM-SHA256\n\n - ECDHE-ECDSA-AES128-GCM-SHA256\n\n minTLSVersion: VersionTLS11",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CustomTLSProfile"
- },
- "intermediate": {
- "description": "intermediate is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29\n\nand looks like this (yaml):\n\n ciphers:\n\n - TLS_AES_128_GCM_SHA256\n\n - TLS_AES_256_GCM_SHA384\n\n - TLS_CHACHA20_POLY1305_SHA256\n\n - ECDHE-ECDSA-AES128-GCM-SHA256\n\n - ECDHE-RSA-AES128-GCM-SHA256\n\n - ECDHE-ECDSA-AES256-GCM-SHA384\n\n - ECDHE-RSA-AES256-GCM-SHA384\n\n - ECDHE-ECDSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-CHACHA20-POLY1305\n\n - DHE-RSA-AES128-GCM-SHA256\n\n - DHE-RSA-AES256-GCM-SHA384\n\n minTLSVersion: VersionTLS12",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.IntermediateTLSProfile"
- },
- "modern": {
- "description": "modern is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility\n\nand looks like this (yaml):\n\n ciphers:\n\n - TLS_AES_128_GCM_SHA256\n\n - TLS_AES_256_GCM_SHA384\n\n - TLS_CHACHA20_POLY1305_SHA256\n\n minTLSVersion: VersionTLS13",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ModernTLSProfile"
- },
- "old": {
- "description": "old is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility\n\nand looks like this (yaml):\n\n ciphers:\n\n - TLS_AES_128_GCM_SHA256\n\n - TLS_AES_256_GCM_SHA384\n\n - TLS_CHACHA20_POLY1305_SHA256\n\n - ECDHE-ECDSA-AES128-GCM-SHA256\n\n - ECDHE-RSA-AES128-GCM-SHA256\n\n - ECDHE-ECDSA-AES256-GCM-SHA384\n\n - ECDHE-RSA-AES256-GCM-SHA384\n\n - ECDHE-ECDSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-CHACHA20-POLY1305\n\n - DHE-RSA-AES128-GCM-SHA256\n\n - DHE-RSA-AES256-GCM-SHA384\n\n - DHE-RSA-CHACHA20-POLY1305\n\n - ECDHE-ECDSA-AES128-SHA256\n\n - ECDHE-RSA-AES128-SHA256\n\n - ECDHE-ECDSA-AES128-SHA\n\n - ECDHE-RSA-AES128-SHA\n\n - ECDHE-ECDSA-AES256-SHA384\n\n - ECDHE-RSA-AES256-SHA384\n\n - ECDHE-ECDSA-AES256-SHA\n\n - ECDHE-RSA-AES256-SHA\n\n - DHE-RSA-AES128-SHA256\n\n - DHE-RSA-AES256-SHA256\n\n - AES128-GCM-SHA256\n\n - AES256-GCM-SHA384\n\n - AES128-SHA256\n\n - AES256-SHA256\n\n - AES128-SHA\n\n - AES256-SHA\n\n - DES-CBC3-SHA\n\n minTLSVersion: VersionTLS10",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.OldTLSProfile"
- },
- "type": {
- "description": "type is one of Old, Intermediate, Modern or Custom. Custom provides the ability to specify individual TLS security profile parameters. Old, Intermediate and Modern are TLS security profiles based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations\n\nThe profiles are intent based, so they may change over time as new ciphers are developed and existing ciphers are found to be insecure. Depending on precisely which ciphers are available to a process, the list may be reduced.\n\nNote that the Modern profile is currently not supported because it is not yet well adopted by common software libraries.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "custom": "Custom",
- "intermediate": "Intermediate",
- "modern": "Modern",
- "old": "Old"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.TemplateReference": {
- "description": "TemplateReference references a template in a specific namespace. The namespace must be specified at the point of use.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the metadata.name of the referenced project request template",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.TestDetails": {
- "type": "object",
- "required": [
- "testName"
- ],
- "properties": {
- "testName": {
- "description": "testName is the name of the test as it appears in junit XMLs. It does not include the suite name since the same test can be executed in many suites.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.TestReporting": {
- "description": "TestReporting is used for origin (and potentially others) to report the test names for a given FeatureGate into the payload for later analysis on a per-payload basis. This doesn't need any CRD because it's never stored in the cluster.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TestReportingSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TestReportingStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1.TestReportingSpec": {
- "type": "object",
- "required": [
- "testsForFeatureGates"
- ],
- "properties": {
- "testsForFeatureGates": {
- "description": "testsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateTests"
- }
- }
- }
- },
- "com.github.openshift.api.config.v1.TestReportingStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1.TokenClaimMapping": {
- "description": "TokenClaimMapping allows specifying a JWT token claim to be used when mapping claims from an authentication token to cluster identities.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.TokenClaimMappings": {
- "type": "object",
- "required": [
- "username"
- ],
- "properties": {
- "extra": {
- "description": "extra is an optional field for configuring the mappings used to construct the extra attribute for the cluster identity. When omitted, no extra attributes will be present on the cluster identity. key values for extra mappings must be unique. A maximum of 32 extra attribute mappings may be provided.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ExtraMapping"
- },
- "x-kubernetes-list-map-keys": [
- "key"
- ],
- "x-kubernetes-list-type": "map"
- },
- "groups": {
- "description": "groups is an optional field that configures how the groups of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider. When referencing a claim, if the claim is present in the JWT token, its value must be a list of groups separated by a comma (','). For example - '\"example\"' and '\"exampleOne\", \"exampleTwo\", \"exampleThree\"' are valid claim values.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.PrefixedClaimMapping"
- },
- "uid": {
- "description": "uid is an optional field for configuring the claim mapping used to construct the uid for the cluster identity.\n\nWhen using uid.claim to specify the claim it must be a single string value. When using uid.expression the expression must result in a single string value.\n\nWhen omitted, this means the user has no opinion and the platform is left to choose a default, which is subject to change over time. The current default is to use the 'sub' claim.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenClaimOrExpressionMapping"
- },
- "username": {
- "description": "username is a required field that configures how the username of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.UsernameClaimMapping"
- }
- }
- },
- "com.github.openshift.api.config.v1.TokenClaimOrExpressionMapping": {
- "description": "TokenClaimOrExpressionMapping allows specifying either a JWT token claim or CEL expression to be used when mapping claims from an authentication token to cluster identities.",
- "type": "object",
- "properties": {
- "claim": {
- "description": "claim is an optional field for specifying the JWT token claim that is used in the mapping. The value of this claim will be assigned to the field in which this mapping is associated.\n\nPrecisely one of claim or expression must be set. claim must not be specified when expression is set. When specified, claim must be at least 1 character in length and must not exceed 256 characters in length.",
- "type": "string"
- },
- "expression": {
- "description": "expression is an optional field for specifying a CEL expression that produces a string value from JWT token claims.\n\nCEL expressions have access to the token claims through a CEL variable, 'claims'. 'claims' is a map of claim names to claim values. For example, the 'sub' claim value can be accessed as 'claims.sub'. Nested claims can be accessed using dot notation ('claims.foo.bar').\n\nPrecisely one of claim or expression must be set. expression must not be specified when claim is set. When specified, expression must be at least 1 character in length and must not exceed 1024 characters in length.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.TokenClaimValidationRule": {
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "requiredClaim": {
- "description": "requiredClaim is an optional field that configures the required claim and value that the Kubernetes API server will use to validate if an incoming JWT is valid for this identity provider.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenRequiredClaim"
- },
- "type": {
- "description": "type is an optional field that configures the type of the validation rule.\n\nAllowed values are 'RequiredClaim' and omitted (not provided or an empty string).\n\nWhen set to 'RequiredClaim', the Kubernetes API server will be configured to validate that the incoming JWT contains the required claim and that its value matches the required value.\n\nDefaults to 'RequiredClaim'.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.TokenConfig": {
- "description": "TokenConfig holds the necessary configuration options for authorization and access tokens",
- "type": "object",
- "properties": {
- "accessTokenInactivityTimeout": {
- "description": "accessTokenInactivityTimeout defines the token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Takes valid time duration string such as \"5m\", \"1.5h\" or \"2h45m\". The minimum allowed value for duration is 300s (5 minutes). If the timeout is configured per client, then that value takes precedence. If the timeout value is not specified and the client does not override the value, then tokens are valid until their lifetime.\n\nWARNING: existing tokens' timeout will not be affected (lowered) by changing this value",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "accessTokenInactivityTimeoutSeconds": {
- "description": "accessTokenInactivityTimeoutSeconds - DEPRECATED: setting this field has no effect.",
- "type": "integer",
- "format": "int32"
- },
- "accessTokenMaxAgeSeconds": {
- "description": "accessTokenMaxAgeSeconds defines the maximum age of access tokens",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.config.v1.TokenIssuer": {
- "type": "object",
- "required": [
- "issuerURL",
- "audiences"
- ],
- "properties": {
- "audiences": {
- "description": "audiences is a required field that configures the acceptable audiences the JWT token, issued by the identity provider, must be issued to. At least one of the entries must match the 'aud' claim in the JWT token.\n\naudiences must contain at least one entry and must not exceed ten entries.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "issuerCertificateAuthority": {
- "description": "issuerCertificateAuthority is an optional field that configures the certificate authority, used by the Kubernetes API server, to validate the connection to the identity provider when fetching discovery information.\n\nWhen not specified, the system trust is used.\n\nWhen specified, it must reference a ConfigMap in the openshift-config namespace containing the PEM-encoded CA certificates under the 'ca-bundle.crt' key in the data field of the ConfigMap.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "issuerURL": {
- "description": "issuerURL is a required field that configures the URL used to issue tokens by the identity provider. The Kubernetes API server determines how authentication tokens should be handled by matching the 'iss' claim in the JWT to the issuerURL of configured identity providers.\n\nMust be at least 1 character and must not exceed 512 characters in length. Must be a valid URL that uses the 'https' scheme and does not contain a query, fragment or user.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.TokenRequiredClaim": {
- "type": "object",
- "required": [
- "claim",
- "requiredValue"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that configures the name of the required claim. When taken from the JWT claims, claim must be a string value.\n\nclaim must not be an empty string (\"\").",
- "type": "string",
- "default": ""
- },
- "requiredValue": {
- "description": "requiredValue is a required field that configures the value that 'claim' must have when taken from the incoming JWT claims. If the value in the JWT claims does not match, the token will be rejected for authentication.\n\nrequiredValue must not be an empty string (\"\").",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.Update": {
- "description": "Update represents an administrator update request.",
- "type": "object",
- "properties": {
- "architecture": {
- "description": "architecture is an optional field that indicates the desired value of the cluster architecture. In this context cluster architecture means either a single architecture or a multi architecture. architecture can only be set to Multi thereby only allowing updates from single to multi architecture. If architecture is set, image cannot be set and version must be set. Valid values are 'Multi' and empty.",
- "type": "string",
- "default": ""
- },
- "force": {
- "description": "force allows an administrator to update to an image that has failed verification or upgradeable checks that are designed to keep your cluster safe. Only use this if: * you are testing unsigned release images in short-lived test clusters or * you are working around a known bug in the cluster-version\n operator and you have verified the authenticity of the provided\n image yourself.\nThe provided image will run with full administrative access to the cluster. Do not use this flag with images that come from unknown or potentially malicious sources.",
- "type": "boolean",
- "default": false
- },
- "image": {
- "description": "image is a container image location that contains the update. image should be used when the desired version does not exist in availableUpdates or history. When image is set, architecture cannot be specified. If both version and image are set, the version extracted from the referenced image must match the specified version.",
- "type": "string",
- "default": ""
- },
- "version": {
- "description": "version is a semantic version identifying the update version. version is required if architecture is specified. If both version and image are set, the version extracted from the referenced image must match the specified version.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.UpdateHistory": {
- "description": "UpdateHistory is a single attempted update to the cluster.",
- "type": "object",
- "required": [
- "state",
- "startedTime",
- "completionTime",
- "image",
- "verified"
- ],
- "properties": {
- "acceptedRisks": {
- "description": "acceptedRisks records risks which were accepted to initiate the update. For example, it may menition an Upgradeable=False or missing signature that was overridden via desiredUpdate.force, or an update that was initiated despite not being in the availableUpdates set of recommended update targets.",
- "type": "string"
- },
- "completionTime": {
- "description": "completionTime, if set, is when the update was fully applied. The update that is currently being applied will have a null completion time. Completion time will always be set for entries that are not the current update (usually to the started time of the next update).",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "image": {
- "description": "image is a container image location that contains the update. This value is always populated.",
- "type": "string",
- "default": ""
- },
- "startedTime": {
- "description": "startedTime is the time at which the update was started.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "state": {
- "description": "state reflects whether the update was fully applied. The Partial state indicates the update is not fully applied, while the Completed state indicates the update was successfully rolled out at least once (all parts of the update successfully applied).",
- "type": "string",
- "default": ""
- },
- "verified": {
- "description": "verified indicates whether the provided update was properly verified before it was installed. If this is false the cluster may not be trusted. Verified does not cover upgradeable checks that depend on the cluster state at the time when the update target was accepted.",
- "type": "boolean",
- "default": false
- },
- "version": {
- "description": "version is a semantic version identifying the update version. If the requested image does not define a version, or if a failure occurs retrieving the image, this value may be empty.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.UsernameClaimMapping": {
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.\n\nclaim must not be an empty string (\"\") and must not exceed 256 characters.",
- "type": "string",
- "default": ""
- },
- "prefix": {
- "description": "prefix configures the prefix that should be prepended to the value of the JWT claim.\n\nprefix must be set when prefixPolicy is set to 'Prefix' and must be unset otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.UsernamePrefix"
- },
- "prefixPolicy": {
- "description": "prefixPolicy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field.\n\nAllowed values are 'Prefix', 'NoPrefix', and omitted (not provided or an empty string).\n\nWhen set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'.\n\nWhen set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim.\n\nWhen omitted, this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends `{issuerURL}#` to the value of the JWT claim when the claim is not 'email'. As an example, consider the following scenario:\n `prefix` is unset, `issuerURL` is set to `https://myoidc.tld`,\n the JWT claims include \"username\":\"userA\" and \"email\":\"userA@myoidc.tld\",\n and `claim` is set to:\n - \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n - \"email\": the mapped value will be \"userA@myoidc.tld\"",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "prefixPolicy",
- "fields-to-discriminateBy": {
- "claim": "Claim",
- "prefix": "Prefix"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.UsernamePrefix": {
- "description": "UsernamePrefix configures the string that should be used as a prefix for username claim mappings.",
- "type": "object",
- "required": [
- "prefixString"
- ],
- "properties": {
- "prefixString": {
- "description": "prefixString is a required field that configures the prefix that will be applied to cluster identity username attribute during the process of mapping JWT claims to cluster identity attributes.\n\nprefixString must not be an empty string (\"\").",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.VSphereFailureDomainHostGroup": {
- "description": "VSphereFailureDomainHostGroup holds the vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.",
- "type": "object",
- "required": [
- "vmGroup",
- "hostGroup",
- "vmHostRule"
- ],
- "properties": {
- "hostGroup": {
- "description": "hostGroup is the name of the vm-host group of type host within vCenter for this failure domain. hostGroup is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup",
- "type": "string",
- "default": ""
- },
- "vmGroup": {
- "description": "vmGroup is the name of the vm-host group of type virtual machine within vCenter for this failure domain. vmGroup is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup",
- "type": "string",
- "default": ""
- },
- "vmHostRule": {
- "description": "vmHostRule is the name of the affinity vm-host rule within vCenter for this failure domain. vmHostRule is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.VSphereFailureDomainRegionAffinity": {
- "description": "VSphereFailureDomainRegionAffinity contains the region type which is the string representation of the VSphereFailureDomainRegionType with available options of Datacenter and ComputeCluster.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "type determines the vSphere object type for a region within this failure domain. Available types are Datacenter and ComputeCluster. When set to Datacenter, this means the vCenter Datacenter defined is the region. When set to ComputeCluster, this means the vCenter cluster defined is the region.\n\nPossible enum values:\n - `\"ComputeCluster\"` is a failure domain region for a vCenter compute cluster.\n - `\"Datacenter\"` is a failure domain region for a vCenter datacenter.",
- "type": "string",
- "default": "",
- "enum": [
- "ComputeCluster",
- "Datacenter"
- ]
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.config.v1.VSphereFailureDomainZoneAffinity": {
- "description": "VSphereFailureDomainZoneAffinity contains the vCenter cluster vm-host group (virtual machine and host types) and the vm-host affinity rule that together creates an affinity configuration for vm-host based zonal. This configuration within vCenter creates the required association between a failure domain, virtual machines and ESXi hosts to create a vm-host based zone.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "hostGroup": {
- "description": "hostGroup holds the vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSphereFailureDomainHostGroup"
- },
- "type": {
- "description": "type determines the vSphere object type for a zone within this failure domain. Available types are ComputeCluster and HostGroup. When set to ComputeCluster, this means the vCenter cluster defined is the zone. When set to HostGroup, hostGroup must be configured with hostGroup, vmGroup and vmHostRule and this means the zone is defined by the grouping of those fields.\n\nPossible enum values:\n - `\"ComputeCluster\"` is a failure domain zone for a vCenter compute cluster.\n - `\"HostGroup\"` is a failure domain zone for a vCenter vm-host group.",
- "type": "string",
- "default": "",
- "enum": [
- "ComputeCluster",
- "HostGroup"
- ]
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "hostGroup": "HostGroup"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1.VSpherePlatformFailureDomainSpec": {
- "description": "VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain.",
- "type": "object",
- "required": [
- "name",
- "region",
- "zone",
- "server",
- "topology"
- ],
- "properties": {
- "name": {
- "description": "name defines the arbitrary but unique name of a failure domain.",
- "type": "string",
- "default": ""
- },
- "region": {
- "description": "region defines the name of a region tag that will be attached to a vCenter datacenter. The tag category in vCenter must be named openshift-region.",
- "type": "string",
- "default": ""
- },
- "regionAffinity": {
- "description": "regionAffinity holds the type of region, Datacenter or ComputeCluster. When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology. When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSphereFailureDomainRegionAffinity"
- },
- "server": {
- "description": "server is the fully-qualified domain name or the IP address of the vCenter server.",
- "type": "string",
- "default": ""
- },
- "topology": {
- "description": "topology describes a given failure domain using vSphere constructs",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformTopology"
- },
- "zone": {
- "description": "zone defines the name of a zone tag that will be attached to a vCenter cluster. The tag category in vCenter must be named openshift-zone.",
- "type": "string",
- "default": ""
- },
- "zoneAffinity": {
- "description": "zoneAffinity holds the type of the zone and the hostGroup which vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSphereFailureDomainZoneAffinity"
- }
- }
- },
- "com.github.openshift.api.config.v1.VSpherePlatformLoadBalancer": {
- "description": "VSpherePlatformLoadBalancer defines the load balancer used by the cluster on VSphere platform.",
- "type": "object",
- "properties": {
- "type": {
- "description": "type defines the type of load balancer used by the cluster on VSphere platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
- "type": "string",
- "default": "OpenShiftManagedDefault"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.config.v1.VSpherePlatformNodeNetworking": {
- "description": "VSpherePlatformNodeNetworking holds the external and internal node networking spec.",
- "type": "object",
- "properties": {
- "external": {
- "description": "external represents the network configuration of the node that is externally routable.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformNodeNetworkingSpec"
- },
- "internal": {
- "description": "internal represents the network configuration of the node that is routable only within the cluster.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformNodeNetworkingSpec"
- }
- }
- },
- "com.github.openshift.api.config.v1.VSpherePlatformNodeNetworkingSpec": {
- "description": "VSpherePlatformNodeNetworkingSpec holds the network CIDR(s) and port group name for including and excluding IP ranges in the cloud provider. This would be used for example when multiple network adapters are attached to a guest to help determine which IP address the cloud config manager should use for the external and internal node networking.",
- "type": "object",
- "properties": {
- "excludeNetworkSubnetCidr": {
- "description": "excludeNetworkSubnetCidr IP addresses in subnet ranges will be excluded when selecting the IP address from the VirtualMachine's VM for use in the status.addresses fields.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "network": {
- "description": "network VirtualMachine's VM Network names that will be used to when searching for status.addresses fields. Note that if internal.networkSubnetCIDR and external.networkSubnetCIDR are not set, then the vNIC associated to this network must only have a single IP address assigned to it. The available networks (port groups) can be listed using `govc ls 'network/*'`",
- "type": "string"
- },
- "networkSubnetCidr": {
- "description": "networkSubnetCidr IP address on VirtualMachine's network interfaces included in the fields' CIDRs that will be used in respective status.addresses fields.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.config.v1.VSpherePlatformSpec": {
- "description": "VSpherePlatformSpec holds the desired state of the vSphere infrastructure provider. In the future the cloud provider operator, storage operator and machine operator will use these fields for configuration.",
- "type": "object",
- "properties": {
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "failureDomains": {
- "description": "failureDomains contains the definition of region, zone and the vCenter topology. If this is omitted failure domains (regions and zones) will not be used.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformFailureDomainSpec"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "machineNetworks": {
- "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example \"10.0.0.0/8\" or \"fd00::/8\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "nodeNetworking": {
- "description": "nodeNetworking contains the definition of internal and external network constraints for assigning the node's networking. If this field is omitted, networking defaults to the legacy address selection behavior which is to only support a single address and return the first one found.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformNodeNetworking"
- },
- "vcenters": {
- "description": "vcenters holds the connection details for services to communicate with vCenter. Currently, only a single vCenter is supported, but in tech preview 3 vCenters are supported. Once the cluster has been installed, you are unable to change the current number of defined vCenters except in the case where the cluster has been upgraded from a version of OpenShift where the vsphere platform spec was not present. You may make modifications to the existing vCenters that are defined in the vcenters list in order to match with any added or modified failure domains.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformVCenterSpec"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.config.v1.VSpherePlatformStatus": {
- "description": "VSpherePlatformStatus holds the current status of the vSphere infrastructure provider.",
- "type": "object",
- "required": [
- "apiServerInternalIPs",
- "ingressIPs"
- ],
- "properties": {
- "apiServerInternalIP": {
- "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
- "type": "string"
- },
- "apiServerInternalIPs": {
- "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "ingressIP": {
- "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
- "type": "string"
- },
- "ingressIPs": {
- "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "loadBalancer": {
- "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
- "default": {
- "type": "OpenShiftManagedDefault"
- },
- "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformLoadBalancer"
- },
- "machineNetworks": {
- "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "nodeDNSIP": {
- "description": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for vSphere deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.VSpherePlatformTopology": {
- "description": "VSpherePlatformTopology holds the required and optional vCenter objects - datacenter, computeCluster, networks, datastore and resourcePool - to provision virtual machines.",
- "type": "object",
- "required": [
- "datacenter",
- "computeCluster",
- "networks",
- "datastore"
- ],
- "properties": {
- "computeCluster": {
- "description": "computeCluster the absolute path of the vCenter cluster in which virtual machine will be located. The absolute path is of the form //host/. The maximum length of the path is 2048 characters.",
- "type": "string",
- "default": ""
- },
- "datacenter": {
- "description": "datacenter is the name of vCenter datacenter in which virtual machines will be located. The maximum length of the datacenter name is 80 characters.",
- "type": "string",
- "default": ""
- },
- "datastore": {
- "description": "datastore is the absolute path of the datastore in which the virtual machine is located. The absolute path is of the form //datastore/ The maximum length of the path is 2048 characters.",
- "type": "string",
- "default": ""
- },
- "folder": {
- "description": "folder is the absolute path of the folder where virtual machines are located. The absolute path is of the form //vm/. The maximum length of the path is 2048 characters.",
- "type": "string"
- },
- "networks": {
- "description": "networks is the list of port group network names within this failure domain. If feature gate VSphereMultiNetworks is enabled, up to 10 network adapters may be defined. 10 is the maximum number of virtual network devices which may be attached to a VM as defined by: https://configmax.esp.vmware.com/guest?vmwareproduct=vSphere&release=vSphere%208.0&categories=1-0 The available networks (port groups) can be listed using `govc ls 'network/*'` Networks should be in the form of an absolute path: //network/.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "resourcePool": {
- "description": "resourcePool is the absolute path of the resource pool where virtual machines will be created. The absolute path is of the form //host//Resources/. The maximum length of the path is 2048 characters.",
- "type": "string"
- },
- "template": {
- "description": "template is the full inventory path of the virtual machine or template that will be cloned when creating new machines in this failure domain. The maximum length of the path is 2048 characters.\n\nWhen omitted, the template will be calculated by the control plane machineset operator based on the region and zone defined in VSpherePlatformFailureDomainSpec. For example, for zone=zonea, region=region1, and infrastructure name=test, the template path would be calculated as //vm/test-rhcos-region1-zonea.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1.VSpherePlatformVCenterSpec": {
- "description": "VSpherePlatformVCenterSpec stores the vCenter connection fields. This is used by the vSphere CCM.",
- "type": "object",
- "required": [
- "server",
- "datacenters"
- ],
- "properties": {
- "datacenters": {
- "description": "The vCenter Datacenters in which the RHCOS vm guests are located. This field will be used by the Cloud Controller Manager. Each datacenter listed here should be used within a topology.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "port": {
- "description": "port is the TCP port that will be used to communicate to the vCenter endpoint. When omitted, this means the user has no opinion and it is up to the platform to choose a sensible default, which is subject to change over time.",
- "type": "integer",
- "format": "int32"
- },
- "server": {
- "description": "server is the fully-qualified domain name or the IP address of the vCenter server.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1.WebhookTokenAuthenticator": {
- "description": "webhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator",
- "type": "object",
- "required": [
- "kubeConfig"
- ],
- "properties": {
- "kubeConfig": {
- "description": "kubeConfig references a secret that contains kube config file data which describes how to access the remote webhook service. The namespace for the referenced secret is openshift-config.\n\nFor further details, see:\n\nhttps://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication\n\nThe key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.AlertmanagerConfig": {
- "description": "alertmanagerConfig provides configuration options for the default Alertmanager instance that runs in the `openshift-monitoring` namespace. Use this configuration to control whether the default Alertmanager is deployed, how it logs, and how its pods are scheduled.",
- "type": "object",
- "required": [
- "deploymentMode"
- ],
- "properties": {
- "customConfig": {
- "description": "customConfig must be set when deploymentMode is CustomConfig, and must be unset otherwise. When set to CustomConfig, the Alertmanager will be deployed with custom configuration.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.AlertmanagerCustomConfig"
- },
- "deploymentMode": {
- "description": "deploymentMode determines whether the default Alertmanager instance should be deployed as part of the monitoring stack. Allowed values are Disabled, DefaultConfig, and CustomConfig. When set to Disabled, the Alertmanager instance will not be deployed. When set to DefaultConfig, the platform will deploy Alertmanager with default settings. When set to CustomConfig, the Alertmanager will be deployed with custom configuration.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.AlertmanagerCustomConfig": {
- "description": "AlertmanagerCustomConfig represents the configuration for a custom Alertmanager deployment. alertmanagerCustomConfig provides configuration options for the default Alertmanager instance that runs in the `openshift-monitoring` namespace. Use this configuration to control whether the default Alertmanager is deployed, how it logs, and how its pods are scheduled.",
- "type": "object",
- "properties": {
- "logLevel": {
- "description": "logLevel defines the verbosity of logs emitted by Alertmanager. This field allows users to control the amount and severity of logs generated, which can be useful for debugging issues or reducing noise in production environments. Allowed values are Error, Warn, Info, and Debug. When set to Error, only errors will be logged. When set to Warn, both warnings and errors will be logged. When set to Info, general information, warnings, and errors will all be logged. When set to Debug, detailed debugging information will be logged. When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time. The current default value is `Info`.",
- "type": "string"
- },
- "nodeSelector": {
- "description": "nodeSelector defines the nodes on which the Pods are scheduled nodeSelector is optional.\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default value is `kubernetes.io/os: linux`.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "resources": {
- "description": "resources defines the compute resource requests and limits for the Alertmanager container. This includes CPU, memory and HugePages constraints to help control scheduling and resource usage. When not specified, defaults are used by the platform. Requests cannot exceed limits. This field is optional. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ This is a simplified API that maps to Kubernetes ResourceRequirements. The current default values are:\n resources:\n - name: cpu\n request: 4m\n limit: null\n - name: memory\n request: 40Mi\n limit: null\nMaximum length for this list is 10. Minimum length for this list is 1.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ContainerResource"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "secrets": {
- "description": "secrets defines a list of secrets that need to be mounted into the Alertmanager. The secrets must reside within the same namespace as the Alertmanager object. They will be added as volumes named secret- and mounted at /etc/alertmanager/secrets/ within the 'alertmanager' container of the Alertmanager Pods.\n\nThese secrets can be used to authenticate Alertmanager with endpoint receivers. For example, you can use secrets to: - Provide certificates for TLS authentication with receivers that require private CA certificates - Store credentials for Basic HTTP authentication with receivers that require password-based auth - Store any other authentication credentials needed by your alert receivers\n\nThis field is optional. Maximum length for this list is 10. Minimum length for this list is 1. Entries in this list must be unique.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "tolerations": {
- "description": "tolerations defines tolerations for the pods. tolerations is optional.\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. Defaults are empty/unset. Maximum length for this list is 10 Minimum length for this list is 1",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "topologySpreadConstraints": {
- "description": "topologySpreadConstraints defines rules for how Alertmanager Pods should be distributed across topology domains such as zones, nodes, or other user-defined labels. topologySpreadConstraints is optional. This helps improve high availability and resource efficiency by avoiding placing too many replicas in the same failure domain.\n\nWhen omitted, this means no opinion and the platform is left to choose a default, which is subject to change over time. This field maps directly to the `topologySpreadConstraints` field in the Pod spec. Default is empty list. Maximum length for this list is 10. Minimum length for this list is 1 Entries must have unique topologyKey and whenUnsatisfiable pairs.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint"
- },
- "x-kubernetes-list-map-keys": [
- "topologyKey",
- "whenUnsatisfiable"
- ],
- "x-kubernetes-list-type": "map"
- },
- "volumeClaimTemplate": {
- "description": "volumeClaimTemplate Defines persistent storage for Alertmanager. Use this setting to configure the persistent volume claim, including storage class, volume size, and name. If omitted, the Pod uses ephemeral storage and alert data will not persist across restarts. This field is optional.",
- "$ref": "#/definitions/io.k8s.api.core.v1.PersistentVolumeClaim"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.Audit": {
- "description": "Audit profile configurations",
- "type": "object",
- "required": [
- "profile"
- ],
- "properties": {
- "profile": {
- "description": "profile is a required field for configuring the audit log level of the Kubernetes Metrics Server. Allowed values are None, Metadata, Request, or RequestResponse. When set to None, audit logging is disabled and no audit events are recorded. When set to Metadata, only request metadata (such as requesting user, timestamp, resource, verb, etc.) is logged, but not the request or response body. When set to Request, event metadata and the request body are logged, but not the response body. When set to RequestResponse, event metadata, request body, and response body are all logged, providing the most detailed audit information.\n\nSee: https://kubernetes.io/docs/tasks/debug-application-cluster/audit/#audit-policy for more information about auditing and log levels.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.Backup": {
- "description": "Backup provides configuration for performing backups of the openshift cluster.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.BackupSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.BackupStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.BackupList": {
- "description": "BackupList is a collection of items\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.Backup"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.BackupSpec": {
- "type": "object",
- "required": [
- "etcd"
- ],
- "properties": {
- "etcd": {
- "description": "etcd specifies the configuration for periodic backups of the etcd cluster",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.EtcdBackupSpec"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.BackupStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1alpha1.ClusterImagePolicy": {
- "description": "ClusterImagePolicy holds cluster-wide configuration for image signature verification\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec contains the configuration for the cluster image policy.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ClusterImagePolicySpec"
- },
- "status": {
- "description": "status contains the observed state of the resource.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ClusterImagePolicyStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ClusterImagePolicyList": {
- "description": "ClusterImagePolicyList is a list of ClusterImagePolicy resources\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ClusterImagePolicy"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ClusterImagePolicySpec": {
- "description": "CLusterImagePolicySpec is the specification of the ClusterImagePolicy custom resource.",
- "type": "object",
- "required": [
- "scopes",
- "policy"
- ],
- "properties": {
- "policy": {
- "description": "policy contains configuration to allow scopes to be verified, and defines how images not matching the verification policy will be treated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.Policy"
- },
- "scopes": {
- "description": "scopes defines the list of image identities assigned to a policy. Each item refers to a scope in a registry implementing the \"Docker Registry HTTP API V2\". Scopes matching individual images are named Docker references in the fully expanded form, either using a tag or digest. For example, docker.io/library/busybox:latest (not busybox:latest). More general scopes are prefixes of individual-image scopes, and specify a repository (by omitting the tag or digest), a repository namespace, or a registry host (by only specifying the host name and possibly a port number) or a wildcard expression starting with `*.`, for matching all subdomains (not including a port number). Wildcards are only supported for subdomain matching, and may not be used in the middle of the host, i.e. *.example.com is a valid case, but example*.*.com is not. If multiple scopes match a given image, only the policy requirements for the most specific scope apply. The policy requirements for more general scopes are ignored. In addition to setting a policy appropriate for your own deployed applications, make sure that a policy on the OpenShift image repositories quay.io/openshift-release-dev/ocp-release, quay.io/openshift-release-dev/ocp-v4.0-art-dev (or on a more general scope) allows deployment of the OpenShift images required for cluster operation. If a scope is configured in both the ClusterImagePolicy and the ImagePolicy, or if the scope in ImagePolicy is nested under one of the scopes from the ClusterImagePolicy, only the policy from the ClusterImagePolicy will be applied. For additional details about the format, please refer to the document explaining the docker transport field, which can be found at: https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md#docker",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ClusterImagePolicyStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of this API Resource.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ClusterMonitoring": {
- "description": "ClusterMonitoring is the Custom Resource object which holds the current status of Cluster Monitoring Operator. CMO is a central component of the monitoring stack.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. ClusterMonitoring is the Schema for the Cluster Monitoring Operators API",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object metadata.",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user configuration for the Cluster Monitoring Operator",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ClusterMonitoringSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ClusterMonitoringStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ClusterMonitoringList": {
- "description": "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of ClusterMonitoring",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ClusterMonitoring"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list metadata.",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ClusterMonitoringSpec": {
- "description": "ClusterMonitoringSpec defines the desired state of Cluster Monitoring Operator",
- "type": "object",
- "properties": {
- "alertmanagerConfig": {
- "description": "alertmanagerConfig allows users to configure how the default Alertmanager instance should be deployed in the `openshift-monitoring` namespace. alertmanagerConfig is optional. When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time. The current default value is `DefaultConfig`.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.AlertmanagerConfig"
- },
- "metricsServerConfig": {
- "description": "metricsServerConfig is an optional field that can be used to configure the Kubernetes Metrics Server that runs in the openshift-monitoring namespace. Specifically, it can configure how the Metrics Server instance is deployed, pod scheduling, its audit policy and log verbosity. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.MetricsServerConfig"
- },
- "userDefined": {
- "description": "userDefined set the deployment mode for user-defined monitoring in addition to the default platform monitoring. userDefined is optional. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default value is `Disabled`.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.UserDefinedMonitoring"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ClusterMonitoringStatus": {
- "description": "ClusterMonitoringStatus defines the observed state of ClusterMonitoring",
- "type": "object"
- },
- "com.github.openshift.api.config.v1alpha1.ContainerResource": {
- "description": "ContainerResource defines a single resource requirement for a container.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "limit": {
- "description": "limit is the maximum amount of the resource allowed (e.g. \"2Mi\", \"1Gi\"). This field is optional. When request is specified, limit cannot be less than request. The value must be greater than 0 when specified.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
- },
- "name": {
- "description": "name of the resource (e.g. \"cpu\", \"memory\", \"hugepages-2Mi\"). This field is required. name must consist only of alphanumeric characters, `-`, `_` and `.` and must start and end with an alphanumeric character.",
- "type": "string"
- },
- "request": {
- "description": "request is the minimum amount of the resource required (e.g. \"2Mi\", \"1Gi\"). This field is optional. When limit is specified, request cannot be greater than limit.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.EtcdBackupSpec": {
- "description": "EtcdBackupSpec provides configuration for automated etcd backups to the cluster-etcd-operator",
- "type": "object",
- "properties": {
- "pvcName": {
- "description": "pvcName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the etcd backup files would be saved The PVC itself must always be created in the \"openshift-etcd\" namespace If the PVC is left unspecified \"\" then the platform will choose a reasonable default location to save the backup. In the future this would be backups saved across the control-plane master nodes.",
- "type": "string",
- "default": ""
- },
- "retentionPolicy": {
- "description": "retentionPolicy defines the retention policy for retaining and deleting existing backups.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.RetentionPolicy"
- },
- "schedule": {
- "description": "schedule defines the recurring backup schedule in Cron format every 2 hours: 0 */2 * * * every day at 3am: 0 3 * * * Empty string means no opinion and the platform is left to choose a reasonable default which is subject to change without notice. The current default is \"no backups\", but will change in the future.",
- "type": "string",
- "default": ""
- },
- "timeZone": {
- "description": "The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. See https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.FulcioCAWithRekor": {
- "description": "FulcioCAWithRekor defines the root of trust based on the Fulcio certificate and the Rekor public key.",
- "type": "object",
- "required": [
- "fulcioCAData",
- "rekorKeyData",
- "fulcioSubject"
- ],
- "properties": {
- "fulcioCAData": {
- "description": "fulcioCAData contains inline base64-encoded data for the PEM format fulcio CA. fulcioCAData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- },
- "fulcioSubject": {
- "description": "fulcioSubject specifies OIDC issuer and the email of the Fulcio authentication configuration.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PolicyFulcioSubject"
- },
- "rekorKeyData": {
- "description": "rekorKeyData contains inline base64-encoded data for the PEM format from the Rekor public key. rekorKeyData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.GatherConfig": {
- "description": "gatherConfig provides data gathering configuration options.",
- "type": "object",
- "properties": {
- "dataPolicy": {
- "description": "dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain in the Insights archive data. Valid values are \"None\" and \"ObfuscateNetworking\". When set to None the data is not obfuscated. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.",
- "type": "string"
- },
- "disabledGatherers": {
- "description": "disabledGatherers is a list of gatherers to be excluded from the gathering. All the gatherers can be disabled by providing \"all\" value. If all the gatherers are disabled, the Insights operator does not gather any data. The format for the disabledGatherer should be: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (_). Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/). The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\" An example of disabling gatherers looks like this: `disabledGatherers: [\"clusterconfig/machine_configs\", \"workloads/workload_info\"]`",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "storage": {
- "description": "storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.Storage"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ImagePolicy": {
- "description": "ImagePolicy holds namespace-wide configuration for image signature verification\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ImagePolicySpec"
- },
- "status": {
- "description": "status contains the observed state of the resource.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ImagePolicyStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ImagePolicyList": {
- "description": "ImagePolicyList is a list of ImagePolicy resources\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ImagePolicy"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ImagePolicySpec": {
- "description": "ImagePolicySpec is the specification of the ImagePolicy CRD.",
- "type": "object",
- "required": [
- "scopes",
- "policy"
- ],
- "properties": {
- "policy": {
- "description": "policy contains configuration to allow scopes to be verified, and defines how images not matching the verification policy will be treated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.Policy"
- },
- "scopes": {
- "description": "scopes defines the list of image identities assigned to a policy. Each item refers to a scope in a registry implementing the \"Docker Registry HTTP API V2\". Scopes matching individual images are named Docker references in the fully expanded form, either using a tag or digest. For example, docker.io/library/busybox:latest (not busybox:latest). More general scopes are prefixes of individual-image scopes, and specify a repository (by omitting the tag or digest), a repository namespace, or a registry host (by only specifying the host name and possibly a port number) or a wildcard expression starting with `*.`, for matching all subdomains (not including a port number). Wildcards are only supported for subdomain matching, and may not be used in the middle of the host, i.e. *.example.com is a valid case, but example*.*.com is not. If multiple scopes match a given image, only the policy requirements for the most specific scope apply. The policy requirements for more general scopes are ignored. In addition to setting a policy appropriate for your own deployed applications, make sure that a policy on the OpenShift image repositories quay.io/openshift-release-dev/ocp-release, quay.io/openshift-release-dev/ocp-v4.0-art-dev (or on a more general scope) allows deployment of the OpenShift images required for cluster operation. If a scope is configured in both the ClusterImagePolicy and the ImagePolicy, or if the scope in ImagePolicy is nested under one of the scopes from the ClusterImagePolicy, only the policy from the ClusterImagePolicy will be applied. For additional details about the format, please refer to the document explaining the docker transport field, which can be found at: https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md#docker",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.ImagePolicyStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of this API Resource.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.InsightsDataGather": {
- "description": "InsightsDataGather provides data gather configuration options for the the Insights Operator.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.InsightsDataGatherSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.InsightsDataGatherStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.InsightsDataGatherList": {
- "description": "InsightsDataGatherList is a collection of items\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.InsightsDataGather"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.InsightsDataGatherSpec": {
- "type": "object",
- "properties": {
- "gatherConfig": {
- "description": "gatherConfig spec attribute includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.GatherConfig"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.InsightsDataGatherStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1alpha1.MetricsServerConfig": {
- "description": "MetricsServerConfig provides configuration options for the Metrics Server instance that runs in the `openshift-monitoring` namespace. Use this configuration to control how the Metrics Server instance is deployed, how it logs, and how its pods are scheduled.",
- "type": "object",
- "properties": {
- "audit": {
- "description": "audit defines the audit configuration used by the Metrics Server instance. audit is optional. When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time. The current default sets audit.profile to Metadata",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.Audit"
- },
- "nodeSelector": {
- "description": "nodeSelector defines the nodes on which the Pods are scheduled nodeSelector is optional.\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default value is `kubernetes.io/os: linux`.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "resources": {
- "description": "resources defines the compute resource requests and limits for the Metrics Server container. This includes CPU, memory and HugePages constraints to help control scheduling and resource usage. When not specified, defaults are used by the platform. Requests cannot exceed limits. This field is optional. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ This is a simplified API that maps to Kubernetes ResourceRequirements. The current default values are:\n resources:\n - name: cpu\n request: 4m\n limit: null\n - name: memory\n request: 40Mi\n limit: null\nMaximum length for this list is 10. Minimum length for this list is 1.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.ContainerResource"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "tolerations": {
- "description": "tolerations defines tolerations for the pods. tolerations is optional.\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. Defaults are empty/unset. Maximum length for this list is 10 Minimum length for this list is 1",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "topologySpreadConstraints": {
- "description": "topologySpreadConstraints defines rules for how Metrics Server Pods should be distributed across topology domains such as zones, nodes, or other user-defined labels. topologySpreadConstraints is optional. This helps improve high availability and resource efficiency by avoiding placing too many replicas in the same failure domain.\n\nWhen omitted, this means no opinion and the platform is left to choose a default, which is subject to change over time. This field maps directly to the `topologySpreadConstraints` field in the Pod spec. Default is empty list. Maximum length for this list is 10. Minimum length for this list is 1 Entries must have unique topologyKey and whenUnsatisfiable pairs.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint"
- },
- "x-kubernetes-list-map-keys": [
- "topologyKey",
- "whenUnsatisfiable"
- ],
- "x-kubernetes-list-type": "map"
- },
- "verbosity": {
- "description": "verbosity defines the verbosity of log messages for Metrics Server. Valid values are Errors, Info, Trace, TraceAll and omitted. When set to Errors, only critical messages and errors are logged. When set to Info, only basic information messages are logged. When set to Trace, information useful for general debugging is logged. When set to TraceAll, detailed information about metric scraping is logged. When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time. The current default value is `Errors`",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PKI": {
- "description": "PKI defines the root of trust based on Root CA(s) and corresponding intermediate certificates.",
- "type": "object",
- "required": [
- "caRootsData",
- "pkiCertificateSubject"
- ],
- "properties": {
- "caIntermediatesData": {
- "description": "caIntermediatesData contains base64-encoded data of a certificate bundle PEM file, which contains one or more intermediate certificates in the PEM format. The total length of the data must not exceed 8192 characters. caIntermediatesData requires caRootsData to be set.",
- "type": "string",
- "format": "byte"
- },
- "caRootsData": {
- "description": "caRootsData contains base64-encoded data of a certificate bundle PEM file, which contains one or more CA roots in the PEM format. The total length of the data must not exceed 8192 characters.",
- "type": "string",
- "format": "byte"
- },
- "pkiCertificateSubject": {
- "description": "pkiCertificateSubject defines the requirements imposed on the subject to which the certificate was issued.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PKICertificateSubject"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PKICertificateSubject": {
- "description": "PKICertificateSubject defines the requirements imposed on the subject to which the certificate was issued.",
- "type": "object",
- "properties": {
- "email": {
- "description": "email specifies the expected email address imposed on the subject to which the certificate was issued, and must match the email address listed in the Subject Alternative Name (SAN) field of the certificate. The email should be a valid email address and at most 320 characters in length.",
- "type": "string"
- },
- "hostname": {
- "description": "hostname specifies the expected hostname imposed on the subject to which the certificate was issued, and it must match the hostname listed in the Subject Alternative Name (SAN) DNS field of the certificate. The hostname should be a valid dns 1123 subdomain name, optionally prefixed by '*.', and at most 253 characters in length. It should consist only of lowercase alphanumeric characters, hyphens, periods and the optional preceding asterisk.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PersistentVolumeClaimReference": {
- "description": "persistentVolumeClaimReference is a reference to a PersistentVolumeClaim.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PersistentVolumeConfig": {
- "description": "persistentVolumeConfig provides configuration options for PersistentVolume storage.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PersistentVolumeClaimReference"
- },
- "mountPath": {
- "description": "mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.Policy": {
- "description": "Policy defines the verification policy for the items in the scopes list.",
- "type": "object",
- "required": [
- "rootOfTrust"
- ],
- "properties": {
- "rootOfTrust": {
- "description": "rootOfTrust specifies the root of trust for the policy.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PolicyRootOfTrust"
- },
- "signedIdentity": {
- "description": "signedIdentity specifies what image identity the signature claims about the image. The required matchPolicy field specifies the approach used in the verification process to verify the identity in the signature and the actual image identity, the default matchPolicy is \"MatchRepoDigestOrExact\".",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PolicyIdentity"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PolicyFulcioSubject": {
- "description": "PolicyFulcioSubject defines the OIDC issuer and the email of the Fulcio authentication configuration.",
- "type": "object",
- "required": [
- "oidcIssuer",
- "signedEmail"
- ],
- "properties": {
- "oidcIssuer": {
- "description": "oidcIssuer contains the expected OIDC issuer. It will be verified that the Fulcio-issued certificate contains a (Fulcio-defined) certificate extension pointing at this OIDC issuer URL. When Fulcio issues certificates, it includes a value based on an URL inside the client-provided ID token. Example: \"https://expected.OIDC.issuer/\"",
- "type": "string",
- "default": ""
- },
- "signedEmail": {
- "description": "signedEmail holds the email address the the Fulcio certificate is issued for. Example: \"expected-signing-user@example.com\"",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PolicyIdentity": {
- "description": "PolicyIdentity defines image identity the signature claims about the image. When omitted, the default matchPolicy is \"MatchRepoDigestOrExact\".",
- "type": "object",
- "required": [
- "matchPolicy"
- ],
- "properties": {
- "exactRepository": {
- "description": "exactRepository is required if matchPolicy is set to \"ExactRepository\".",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PolicyMatchExactRepository"
- },
- "matchPolicy": {
- "description": "matchPolicy sets the type of matching to be used. Valid values are \"MatchRepoDigestOrExact\", \"MatchRepository\", \"ExactRepository\", \"RemapIdentity\". When omitted, the default value is \"MatchRepoDigestOrExact\". If set matchPolicy to ExactRepository, then the exactRepository must be specified. If set matchPolicy to RemapIdentity, then the remapIdentity must be specified. \"MatchRepoDigestOrExact\" means that the identity in the signature must be in the same repository as the image identity if the image identity is referenced by a digest. Otherwise, the identity in the signature must be the same as the image identity. \"MatchRepository\" means that the identity in the signature must be in the same repository as the image identity. \"ExactRepository\" means that the identity in the signature must be in the same repository as a specific identity specified by \"repository\". \"RemapIdentity\" means that the signature must be in the same as the remapped image identity. Remapped image identity is obtained by replacing the \"prefix\" with the specified “signedPrefix” if the the image identity matches the specified remapPrefix.",
- "type": "string",
- "default": ""
- },
- "remapIdentity": {
- "description": "remapIdentity is required if matchPolicy is set to \"RemapIdentity\".",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PolicyMatchRemapIdentity"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "matchPolicy",
- "fields-to-discriminateBy": {
- "exactRepository": "PolicyMatchExactRepository",
- "remapIdentity": "PolicyMatchRemapIdentity"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1alpha1.PolicyMatchExactRepository": {
- "type": "object",
- "required": [
- "repository"
- ],
- "properties": {
- "repository": {
- "description": "repository is the reference of the image identity to be matched. The value should be a repository name (by omitting the tag or digest) in a registry implementing the \"Docker Registry HTTP API V2\". For example, docker.io/library/busybox",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PolicyMatchRemapIdentity": {
- "type": "object",
- "required": [
- "prefix",
- "signedPrefix"
- ],
- "properties": {
- "prefix": {
- "description": "prefix is the prefix of the image identity to be matched. If the image identity matches the specified prefix, that prefix is replaced by the specified “signedPrefix” (otherwise it is used as unchanged and no remapping takes place). This useful when verifying signatures for a mirror of some other repository namespace that preserves the vendor’s repository structure. The prefix and signedPrefix values can be either host[:port] values (matching exactly the same host[:port], string), repository namespaces, or repositories (i.e. they must not contain tags/digests), and match as prefixes of the fully expanded form. For example, docker.io/library/busybox (not busybox) to specify that single repository, or docker.io/library (not an empty string) to specify the parent namespace of docker.io/library/busybox.",
- "type": "string",
- "default": ""
- },
- "signedPrefix": {
- "description": "signedPrefix is the prefix of the image identity to be matched in the signature. The format is the same as \"prefix\". The values can be either host[:port] values (matching exactly the same host[:port], string), repository namespaces, or repositories (i.e. they must not contain tags/digests), and match as prefixes of the fully expanded form. For example, docker.io/library/busybox (not busybox) to specify that single repository, or docker.io/library (not an empty string) to specify the parent namespace of docker.io/library/busybox.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.PolicyRootOfTrust": {
- "description": "PolicyRootOfTrust defines the root of trust based on the selected policyType.",
- "type": "object",
- "required": [
- "policyType"
- ],
- "properties": {
- "fulcioCAWithRekor": {
- "description": "fulcioCAWithRekor defines the root of trust based on the Fulcio certificate and the Rekor public key. For more information about Fulcio and Rekor, please refer to the document at: https://github.com/sigstore/fulcio and https://github.com/sigstore/rekor",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.FulcioCAWithRekor"
- },
- "pki": {
- "description": "pki defines the root of trust based on Bring Your Own Public Key Infrastructure (BYOPKI) Root CA(s) and corresponding intermediate certificates.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PKI"
- },
- "policyType": {
- "description": "policyType serves as the union's discriminator. Users are required to assign a value to this field, choosing one of the policy types that define the root of trust. \"PublicKey\" indicates that the policy relies on a sigstore publicKey and may optionally use a Rekor verification. \"FulcioCAWithRekor\" indicates that the policy is based on the Fulcio certification and incorporates a Rekor verification. \"PKI\" indicates that the policy is based on the certificates from Bring Your Own Public Key Infrastructure (BYOPKI). This value is enabled by turning on the SigstoreImageVerificationPKI feature gate.",
- "type": "string",
- "default": ""
- },
- "publicKey": {
- "description": "publicKey defines the root of trust based on a sigstore public key.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PublicKey"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "policyType",
- "fields-to-discriminateBy": {
- "fulcioCAWithRekor": "FulcioCAWithRekor",
- "pki": "PKI",
- "publicKey": "PublicKey"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1alpha1.PublicKey": {
- "description": "PublicKey defines the root of trust based on a sigstore public key.",
- "type": "object",
- "required": [
- "keyData"
- ],
- "properties": {
- "keyData": {
- "description": "keyData contains inline base64-encoded data for the PEM format public key. KeyData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- },
- "rekorKeyData": {
- "description": "rekorKeyData contains inline base64-encoded data for the PEM format from the Rekor public key. rekorKeyData must be at most 8192 characters.",
- "type": "string",
- "format": "byte"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.RetentionNumberConfig": {
- "description": "RetentionNumberConfig specifies the configuration of the retention policy on the number of backups",
- "type": "object",
- "required": [
- "maxNumberOfBackups"
- ],
- "properties": {
- "maxNumberOfBackups": {
- "description": "maxNumberOfBackups defines the maximum number of backups to retain. If the existing number of backups saved is equal to MaxNumberOfBackups then the oldest backup will be removed before a new backup is initiated.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.RetentionPolicy": {
- "description": "RetentionPolicy defines the retention policy for retaining and deleting existing backups. This struct is a discriminated union that allows users to select the type of retention policy from the supported types.",
- "type": "object",
- "required": [
- "retentionType"
- ],
- "properties": {
- "retentionNumber": {
- "description": "retentionNumber configures the retention policy based on the number of backups",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.RetentionNumberConfig"
- },
- "retentionSize": {
- "description": "retentionSize configures the retention policy based on the size of backups",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.RetentionSizeConfig"
- },
- "retentionType": {
- "description": "retentionType sets the type of retention policy. Currently, the only valid policies are retention by number of backups (RetentionNumber), by the size of backups (RetentionSize). More policies or types may be added in the future. Empty string means no opinion and the platform is left to choose a reasonable default which is subject to change without notice. The current default is RetentionNumber with 15 backups kept.\n\nPossible enum values:\n - `\"RetentionNumber\"` sets the retention policy based on the number of backup files saved\n - `\"RetentionSize\"` sets the retention policy based on the total size of the backup files saved",
- "type": "string",
- "default": "",
- "enum": [
- "RetentionNumber",
- "RetentionSize"
- ]
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "retentionType",
- "fields-to-discriminateBy": {
- "retentionNumber": "RetentionNumber",
- "retentionSize": "RetentionSize"
- }
- }
- ]
- },
- "com.github.openshift.api.config.v1alpha1.RetentionSizeConfig": {
- "description": "RetentionSizeConfig specifies the configuration of the retention policy on the total size of backups",
- "type": "object",
- "required": [
- "maxSizeOfBackupsGb"
- ],
- "properties": {
- "maxSizeOfBackupsGb": {
- "description": "maxSizeOfBackupsGb defines the total size in GB of backups to retain. If the current total size backups exceeds MaxSizeOfBackupsGb then the oldest backup will be removed before a new backup is initiated.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.Storage": {
- "description": "storage provides persistent storage configuration options for gathering jobs. If the type is set to PersistentVolume, then the PersistentVolume must be defined. If the type is set to Ephemeral, then the PersistentVolume must not be defined.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "persistentVolume": {
- "description": "persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha1.PersistentVolumeConfig"
- },
- "type": {
- "description": "type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are \"PersistentVolume\" and \"Ephemeral\". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the persistentVolume field.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha1.UserDefinedMonitoring": {
- "description": "UserDefinedMonitoring config for user-defined projects.",
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "mode": {
- "description": "mode defines the different configurations of UserDefinedMonitoring Valid values are Disabled and NamespaceIsolated Disabled disables monitoring for user-defined projects. This restricts the default monitoring stack, installed in the openshift-monitoring project, to monitor only platform namespaces, which prevents any custom monitoring configurations or resources from being applied to user-defined namespaces. NamespaceIsolated enables monitoring for user-defined projects with namespace-scoped tenancy. This ensures that metrics, alerts, and monitoring data are isolated at the namespace level. The current default value is `Disabled`.\n\nPossible enum values:\n - `\"Disabled\"` disables monitoring for user-defined projects. This restricts the default monitoring stack, installed in the openshift-monitoring project, to monitor only platform namespaces, which prevents any custom monitoring configurations or resources from being applied to user-defined namespaces.\n - `\"NamespaceIsolated\"` enables monitoring for user-defined projects with namespace-scoped tenancy. This ensures that metrics, alerts, and monitoring data are isolated at the namespace level.",
- "type": "string",
- "default": "",
- "enum": [
- "Disabled",
- "NamespaceIsolated"
- ]
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.Custom": {
- "description": "custom provides the custom configuration of gatherers",
- "type": "object",
- "required": [
- "configs"
- ],
- "properties": {
- "configs": {
- "description": "configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers. It may not exceed 100 items and each gatherer can be present only once. It is possible to disable an entire set of gatherers while allowing a specific function within that set. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.GathererConfig"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.GatherConfig": {
- "description": "gatherConfig provides data gathering configuration options.",
- "type": "object",
- "required": [
- "gatherers"
- ],
- "properties": {
- "dataPolicy": {
- "description": "dataPolicy is an optional list of DataPolicyOptions that allows user to enable additional obfuscation of the Insights archive data. It may not exceed 2 items and must not contain duplicates. Valid values are ObfuscateNetworking and WorkloadNames. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When set to WorkloadNames, the gathered data about cluster resources will not contain the workload names for your deployments. Resources UIDs will be used instead. When omitted no obfuscation is applied.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "gatherers": {
- "description": "gatherers is a required field that specifies the configuration of the gatherers.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.Gatherers"
- },
- "storage": {
- "description": "storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.Storage"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.GathererConfig": {
- "description": "gathererConfig allows to configure specific gatherers",
- "type": "object",
- "required": [
- "name",
- "state"
- ],
- "properties": {
- "name": {
- "description": "name is the required name of a specific gatherer It may not exceed 256 characters. The format for a gatherer name is: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (_). Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/). The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "string",
- "default": ""
- },
- "state": {
- "description": "state is a required field that allows you to configure specific gatherer. Valid values are \"Enabled\" and \"Disabled\". When set to Enabled the gatherer will run. When set to Disabled the gatherer will not run.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.Gatherers": {
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "custom": {
- "description": "custom provides gathering configuration. It is required when mode is Custom, and forbidden otherwise. Custom configuration allows user to disable only a subset of gatherers. Gatherers that are not explicitly disabled in custom configuration will run.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.Custom"
- },
- "mode": {
- "description": "mode is a required field that specifies the mode for gatherers. Allowed values are All, None, and Custom. When set to All, all gatherers wil run and gather data. When set to None, all gatherers will be disabled and no data will be gathered. When set to Custom, the custom configuration from the custom field will be applied.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.InsightsDataGather": {
- "description": "InsightsDataGather provides data gather configuration options for the the Insights Operator.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.InsightsDataGatherSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.InsightsDataGatherStatus"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.InsightsDataGatherList": {
- "description": "InsightsDataGatherList is a collection of items Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the required list of InsightsDataGather objects it may not exceed 100 items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.InsightsDataGather"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the required standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.InsightsDataGatherSpec": {
- "type": "object",
- "properties": {
- "gatherConfig": {
- "description": "gatherConfig is an optional spec attribute that includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.GatherConfig"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.InsightsDataGatherStatus": {
- "type": "object"
- },
- "com.github.openshift.api.config.v1alpha2.PersistentVolumeClaimReference": {
- "description": "persistentVolumeClaimReference is a reference to a PersistentVolumeClaim.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.PersistentVolumeConfig": {
- "description": "persistentVolumeConfig provides configuration options for PersistentVolume storage.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.PersistentVolumeClaimReference"
- },
- "mountPath": {
- "description": "mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.config.v1alpha2.Storage": {
- "description": "storage provides persistent storage configuration options for gathering jobs. If the type is set to PersistentVolume, then the PersistentVolume must be defined. If the type is set to Ephemeral, then the PersistentVolume must not be defined.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "persistentVolume": {
- "description": "persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1alpha2.PersistentVolumeConfig"
- },
- "type": {
- "description": "type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are \"PersistentVolume\" and \"Ephemeral\". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the persistentVolume field.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ApplicationMenuSpec": {
- "description": "ApplicationMenuSpec is the specification of the desired section and icon used for the link in the application menu.",
- "type": "object",
- "required": [
- "section"
- ],
- "properties": {
- "imageURL": {
- "description": "imageURL is the URL for the icon used in front of the link in the application menu. The URL must be an HTTPS URL or a Data URI. The image should be square and will be shown at 24x24 pixels.",
- "type": "string"
- },
- "section": {
- "description": "section is the section of the application menu in which the link should appear. This can be any text that will appear as a subheading in the application menu dropdown. A new section will be created if the text does not match text of an existing section.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.CLIDownloadLink": {
- "type": "object",
- "required": [
- "href"
- ],
- "properties": {
- "href": {
- "description": "href is the absolute secure URL for the link (must use https)",
- "type": "string",
- "default": ""
- },
- "text": {
- "description": "text is the display text for the link",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleCLIDownload": {
- "description": "ConsoleCLIDownload is an extension for configuring openshift web console command line interface (CLI) downloads.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleCLIDownloadSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleCLIDownloadList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleCLIDownload"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleCLIDownloadSpec": {
- "description": "ConsoleCLIDownloadSpec is the desired cli download configuration.",
- "type": "object",
- "required": [
- "displayName",
- "description",
- "links"
- ],
- "properties": {
- "description": {
- "description": "description is the description of the CLI download (can include markdown).",
- "type": "string",
- "default": ""
- },
- "displayName": {
- "description": "displayName is the display name of the CLI download.",
- "type": "string",
- "default": ""
- },
- "links": {
- "description": "links is a list of objects that provide CLI download link details.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.CLIDownloadLink"
- }
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleExternalLogLink": {
- "description": "ConsoleExternalLogLink is an extension for customizing OpenShift web console log links.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleExternalLogLinkSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleExternalLogLinkList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleExternalLogLink"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleExternalLogLinkSpec": {
- "description": "ConsoleExternalLogLinkSpec is the desired log link configuration. The log link will appear on the logs tab of the pod details page.",
- "type": "object",
- "required": [
- "text",
- "hrefTemplate"
- ],
- "properties": {
- "hrefTemplate": {
- "description": "hrefTemplate is an absolute secure URL (must use https) for the log link including variables to be replaced. Variables are specified in the URL with the format ${variableName}, for instance, ${containerName} and will be replaced with the corresponding values from the resource. Resource is a pod. Supported variables are: - ${resourceName} - name of the resource which containes the logs - ${resourceUID} - UID of the resource which contains the logs\n - e.g. `11111111-2222-3333-4444-555555555555`\n- ${containerName} - name of the resource's container that contains the logs - ${resourceNamespace} - namespace of the resource that contains the logs - ${resourceNamespaceUID} - namespace UID of the resource that contains the logs - ${podLabels} - JSON representation of labels matching the pod with the logs\n - e.g. `{\"key1\":\"value1\",\"key2\":\"value2\"}`\n\ne.g., https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}",
- "type": "string",
- "default": ""
- },
- "namespaceFilter": {
- "description": "namespaceFilter is a regular expression used to restrict a log link to a matching set of namespaces (e.g., `^openshift-`). The string is converted into a regular expression using the JavaScript RegExp constructor. If not specified, links will be displayed for all the namespaces.",
- "type": "string"
- },
- "text": {
- "description": "text is the display text for the link",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleLink": {
- "description": "ConsoleLink is an extension for customizing OpenShift web console links.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleLinkSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleLinkList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleLink"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleLinkSpec": {
- "description": "ConsoleLinkSpec is the desired console link configuration.",
- "type": "object",
- "required": [
- "text",
- "href",
- "location"
- ],
- "properties": {
- "applicationMenu": {
- "description": "applicationMenu holds information about section and icon used for the link in the application menu, and it is applicable only when location is set to ApplicationMenu.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ApplicationMenuSpec"
- },
- "href": {
- "description": "href is the absolute secure URL for the link (must use https)",
- "type": "string",
- "default": ""
- },
- "location": {
- "description": "location determines which location in the console the link will be appended to (ApplicationMenu, HelpMenu, UserMenu, NamespaceDashboard).",
- "type": "string",
- "default": ""
- },
- "namespaceDashboard": {
- "description": "namespaceDashboard holds information about namespaces in which the dashboard link should appear, and it is applicable only when location is set to NamespaceDashboard. If not specified, the link will appear in all namespaces.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.NamespaceDashboardSpec"
- },
- "text": {
- "description": "text is the display text for the link",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleNotification": {
- "description": "ConsoleNotification is the extension for configuring openshift web console notifications.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleNotificationSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleNotificationList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleNotification"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleNotificationSpec": {
- "description": "ConsoleNotificationSpec is the desired console notification configuration.",
- "type": "object",
- "required": [
- "text"
- ],
- "properties": {
- "backgroundColor": {
- "description": "backgroundColor is the color of the background for the notification as CSS data type color.",
- "type": "string"
- },
- "color": {
- "description": "color is the color of the text for the notification as CSS data type color.",
- "type": "string"
- },
- "link": {
- "description": "link is an object that holds notification link details.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.Link"
- },
- "location": {
- "description": "location is the location of the notification in the console. Valid values are: \"BannerTop\", \"BannerBottom\", \"BannerTopBottom\".",
- "type": "string"
- },
- "text": {
- "description": "text is the visible text of the notification.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePlugin": {
- "description": "ConsolePlugin is an extension for customizing OpenShift web console by dynamically loading code from another service running on the cluster.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec contains the desired configuration for the console plugin.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePluginBackend": {
- "description": "ConsolePluginBackend holds information about the endpoint which serves the console's plugin",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "service": {
- "description": "service is a Kubernetes Service that exposes the plugin using a deployment with an HTTP server. The Service must use HTTPS and Service serving certificate. The console backend will proxy the plugins assets from the Service using the service CA bundle.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginService"
- },
- "type": {
- "description": "type is the backend type which servers the console's plugin. Currently only \"Service\" is supported.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "service": "Service"
- }
- }
- ]
- },
- "com.github.openshift.api.console.v1.ConsolePluginCSP": {
- "description": "ConsolePluginCSP holds configuration for a specific CSP directive",
- "type": "object",
- "required": [
- "directive",
- "values"
- ],
- "properties": {
- "directive": {
- "description": "directive specifies which Content-Security-Policy directive to configure. Available directive types are DefaultSrc, ScriptSrc, StyleSrc, ImgSrc, FontSrc and ConnectSrc. DefaultSrc directive serves as a fallback for the other CSP fetch directives. For more information about the DefaultSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src ScriptSrc directive specifies valid sources for JavaScript. For more information about the ScriptSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src StyleSrc directive specifies valid sources for stylesheets. For more information about the StyleSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src ImgSrc directive specifies a valid sources of images and favicons. For more information about the ImgSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/img-src FontSrc directive specifies valid sources for fonts loaded using @font-face. For more information about the FontSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/font-src ConnectSrc directive restricts the URLs which can be loaded using script interfaces. For more information about the ConnectSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src\n\nPossible enum values:\n - `\"ConnectSrc\"` directive restricts the URLs which can be loaded using script interfaces. For more information about the ConnectSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src\n - `\"DefaultSrc\"` directive serves as a fallback for the other CSP fetch directives. For more information about the DefaultSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src\n - `\"FontSrc\"` directive specifies valid sources for fonts loaded using @font-face. For more information about the FontSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/font-src\n - `\"ImgSrc\"` directive specifies a valid sources of images and favicons. For more information about the ImgSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/img-src\n - `\"ScriptSrc\"` directive specifies valid sources for JavaScript. For more information about the ScriptSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src\n - `\"StyleSrc\"` directive specifies valid sources for stylesheets. For more information about the StyleSrc directive, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src",
- "type": "string",
- "default": "",
- "enum": [
- "ConnectSrc",
- "DefaultSrc",
- "FontSrc",
- "ImgSrc",
- "ScriptSrc",
- "StyleSrc"
- ]
- },
- "values": {
- "description": "values defines an array of values to append to the console defaults for this directive. Each ConsolePlugin may define their own directives with their values. These will be set by the OpenShift web console's backend, as part of its Content-Security-Policy header. The array can contain at most 16 values. Each directive value must have a maximum length of 1024 characters and must not contain whitespace, commas (,), semicolons (;) or single quotes ('). The value '*' is not permitted. Each value in the array must be unique.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePluginI18n": {
- "description": "ConsolePluginI18n holds information on localization resources that are served by the dynamic plugin.",
- "type": "object",
- "required": [
- "loadType"
- ],
- "properties": {
- "loadType": {
- "description": "loadType indicates how the plugin's localization resource should be loaded. Valid values are Preload, Lazy and the empty string. When set to Preload, all localization resources are fetched when the plugin is loaded. When set to Lazy, localization resources are lazily loaded as and when they are required by the console. When omitted or set to the empty string, the behaviour is equivalent to Lazy type.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePluginList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePlugin"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePluginProxy": {
- "description": "ConsolePluginProxy holds information on various service types to which console's backend will proxy the plugin's requests.",
- "type": "object",
- "required": [
- "endpoint",
- "alias"
- ],
- "properties": {
- "alias": {
- "description": "alias is a proxy name that identifies the plugin's proxy. An alias name should be unique per plugin. The console backend exposes following proxy endpoint:\n\n/api/proxy/plugin///?\n\nRequest example path:\n\n/api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver",
- "type": "string",
- "default": ""
- },
- "authorization": {
- "description": "authorization provides information about authorization type, which the proxied request should contain",
- "type": "string"
- },
- "caCertificate": {
- "description": "caCertificate provides the cert authority certificate contents, in case the proxied Service is using custom service CA. By default, the service CA bundle provided by the service-ca operator is used.",
- "type": "string"
- },
- "endpoint": {
- "description": "endpoint provides information about endpoint to which the request is proxied to.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginProxyEndpoint"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePluginProxyEndpoint": {
- "description": "ConsolePluginProxyEndpoint holds information about the endpoint to which request will be proxied to.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "service": {
- "description": "service is an in-cluster Service that the plugin will connect to. The Service must use HTTPS. The console backend exposes an endpoint in order to proxy communication between the plugin and the Service. Note: service field is required for now, since currently only \"Service\" type is supported.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginProxyServiceConfig"
- },
- "type": {
- "description": "type is the type of the console plugin's proxy. Currently only \"Service\" is supported.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "service": "Service"
- }
- }
- ]
- },
- "com.github.openshift.api.console.v1.ConsolePluginProxyServiceConfig": {
- "description": "ProxyTypeServiceConfig holds information on Service to which console's backend will proxy the plugin's requests.",
- "type": "object",
- "required": [
- "name",
- "namespace",
- "port"
- ],
- "properties": {
- "name": {
- "description": "name of Service that the plugin needs to connect to.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace of Service that the plugin needs to connect to",
- "type": "string",
- "default": ""
- },
- "port": {
- "description": "port on which the Service that the plugin needs to connect to is listening on.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePluginService": {
- "description": "ConsolePluginService holds information on Service that is serving console dynamic plugin assets.",
- "type": "object",
- "required": [
- "name",
- "namespace",
- "port"
- ],
- "properties": {
- "basePath": {
- "description": "basePath is the path to the plugin's assets. The primary asset it the manifest file called `plugin-manifest.json`, which is a JSON document that contains metadata about the plugin and the extensions.",
- "type": "string"
- },
- "name": {
- "description": "name of Service that is serving the plugin assets.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace of Service that is serving the plugin assets.",
- "type": "string",
- "default": ""
- },
- "port": {
- "description": "port on which the Service that is serving the plugin is listening to.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsolePluginSpec": {
- "description": "ConsolePluginSpec is the desired plugin configuration.",
- "type": "object",
- "required": [
- "displayName",
- "backend"
- ],
- "properties": {
- "backend": {
- "description": "backend holds the configuration of backend which is serving console's plugin .",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginBackend"
- },
- "contentSecurityPolicy": {
- "description": "contentSecurityPolicy is a list of Content-Security-Policy (CSP) directives for the plugin. Each directive specifies a list of values, appropriate for the given directive type, for example a list of remote endpoints for fetch directives such as ScriptSrc. Console web application uses CSP to detect and mitigate certain types of attacks, such as cross-site scripting (XSS) and data injection attacks. Dynamic plugins should specify this field if need to load assets from outside the cluster or if violation reports are observed. Dynamic plugins should always prefer loading their assets from within the cluster, either by vendoring them, or fetching from a cluster service. CSP violation reports can be viewed in the browser's console logs during development and testing of the plugin in the OpenShift web console. Available directive types are DefaultSrc, ScriptSrc, StyleSrc, ImgSrc, FontSrc and ConnectSrc. Each of the available directives may be defined only once in the list. The value 'self' is automatically included in all fetch directives by the OpenShift web console's backend. For more information about the CSP directives, see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy\n\nThe OpenShift web console server aggregates the CSP directives and values across its own default values and all enabled ConsolePlugin CRs, merging them into a single policy string that is sent to the browser via `Content-Security-Policy` HTTP response header.\n\nExample:\n ConsolePlugin A directives:\n script-src: https://script1.com/, https://script2.com/\n font-src: https://font1.com/\n\n ConsolePlugin B directives:\n script-src: https://script2.com/, https://script3.com/\n font-src: https://font2.com/\n img-src: https://img1.com/\n\n Unified set of CSP directives, passed to the OpenShift web console server:\n script-src: https://script1.com/, https://script2.com/, https://script3.com/\n font-src: https://font1.com/, https://font2.com/\n img-src: https://img1.com/\n\n OpenShift web console server CSP response header:\n Content-Security-Policy: default-src 'self'; base-uri 'self'; script-src 'self' https://script1.com/ https://script2.com/ https://script3.com/; font-src 'self' https://font1.com/ https://font2.com/; img-src 'self' https://img1.com/; style-src 'self'; frame-src 'none'; object-src 'none'",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginCSP"
- },
- "x-kubernetes-list-map-keys": [
- "directive"
- ],
- "x-kubernetes-list-type": "map"
- },
- "displayName": {
- "description": "displayName is the display name of the plugin. The dispalyName should be between 1 and 128 characters.",
- "type": "string",
- "default": ""
- },
- "i18n": {
- "description": "i18n is the configuration of plugin's localization resources.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginI18n"
- },
- "proxy": {
- "description": "proxy is a list of proxies that describe various service type to which the plugin needs to connect to.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsolePluginProxy"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleQuickStart": {
- "description": "ConsoleQuickStart is an extension for guiding user through various workflows in the OpenShift web console.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleQuickStartSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleQuickStartList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleQuickStart"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleQuickStartSpec": {
- "description": "ConsoleQuickStartSpec is the desired quick start configuration.",
- "type": "object",
- "required": [
- "displayName",
- "durationMinutes",
- "description",
- "introduction",
- "tasks"
- ],
- "properties": {
- "accessReviewResources": {
- "description": "accessReviewResources contains a list of resources that the user's access will be reviewed against in order for the user to complete the Quick Start. The Quick Start will be hidden if any of the access reviews fail.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.authorization.v1.ResourceAttributes"
- }
- },
- "conclusion": {
- "description": "conclusion sums up the Quick Start and suggests the possible next steps. (includes markdown)",
- "type": "string"
- },
- "description": {
- "description": "description is the description of the Quick Start. (includes markdown)",
- "type": "string",
- "default": ""
- },
- "displayName": {
- "description": "displayName is the display name of the Quick Start.",
- "type": "string",
- "default": ""
- },
- "durationMinutes": {
- "description": "durationMinutes describes approximately how many minutes it will take to complete the Quick Start.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "icon": {
- "description": "icon is a base64 encoded image that will be displayed beside the Quick Start display name. The icon should be an vector image for easy scaling. The size of the icon should be 40x40.",
- "type": "string"
- },
- "introduction": {
- "description": "introduction describes the purpose of the Quick Start. (includes markdown)",
- "type": "string",
- "default": ""
- },
- "nextQuickStart": {
- "description": "nextQuickStart is a list of the following Quick Starts, suggested for the user to try.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "prerequisites": {
- "description": "prerequisites contains all prerequisites that need to be met before taking a Quick Start. (includes markdown)",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "tags": {
- "description": "tags is a list of strings that describe the Quick Start.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "tasks": {
- "description": "tasks is the list of steps the user has to perform to complete the Quick Start.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleQuickStartTask"
- }
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleQuickStartTask": {
- "description": "ConsoleQuickStartTask is a single step in a Quick Start.",
- "type": "object",
- "required": [
- "title",
- "description"
- ],
- "properties": {
- "description": {
- "description": "description describes the steps needed to complete the task. (includes markdown)",
- "type": "string",
- "default": ""
- },
- "review": {
- "description": "review contains instructions to validate the task is complete. The user will select 'Yes' or 'No'. using a radio button, which indicates whether the step was completed successfully.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleQuickStartTaskReview"
- },
- "summary": {
- "description": "summary contains information about the passed step.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleQuickStartTaskSummary"
- },
- "title": {
- "description": "title describes the task and is displayed as a step heading.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleQuickStartTaskReview": {
- "description": "ConsoleQuickStartTaskReview contains instructions that validate a task was completed successfully.",
- "type": "object",
- "required": [
- "instructions",
- "failedTaskHelp"
- ],
- "properties": {
- "failedTaskHelp": {
- "description": "failedTaskHelp contains suggestions for a failed task review and is shown at the end of task. (includes markdown)",
- "type": "string",
- "default": ""
- },
- "instructions": {
- "description": "instructions contains steps that user needs to take in order to validate his work after going through a task. (includes markdown)",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleQuickStartTaskSummary": {
- "description": "ConsoleQuickStartTaskSummary contains information about a passed step.",
- "type": "object",
- "required": [
- "success",
- "failed"
- ],
- "properties": {
- "failed": {
- "description": "failed briefly describes the unsuccessfully passed task. (includes markdown)",
- "type": "string",
- "default": ""
- },
- "success": {
- "description": "success describes the succesfully passed task.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSample": {
- "description": "ConsoleSample is an extension to customizing OpenShift web console by adding samples.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec contains configuration for a console sample.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSampleSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSampleContainerImportSource": {
- "description": "ConsoleSampleContainerImportSource let the user import a container image.",
- "type": "object",
- "required": [
- "image"
- ],
- "properties": {
- "image": {
- "description": "reference to a container image that provides a HTTP service. The service must be exposed on the default port (8080) unless otherwise configured with the port field.\n\nSupported formats:\n - /\n - docker.io//\n - quay.io//\n - quay.io//@sha256:\n - quay.io//:",
- "type": "string",
- "default": ""
- },
- "service": {
- "description": "service contains configuration for the Service resource created for this sample.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSampleContainerImportSourceService"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSampleContainerImportSourceService": {
- "description": "ConsoleSampleContainerImportSourceService let the samples author define defaults for the Service created for this sample.",
- "type": "object",
- "properties": {
- "targetPort": {
- "description": "targetPort is the port that the service listens on for HTTP requests. This port will be used for Service and Route created for this sample. Port must be in the range 1 to 65535. Default port is 8080.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSampleGitImportSource": {
- "description": "ConsoleSampleGitImportSource let the user import code from a public Git repository.",
- "type": "object",
- "required": [
- "repository"
- ],
- "properties": {
- "repository": {
- "description": "repository contains the reference to the actual Git repository.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSampleGitImportSourceRepository"
- },
- "service": {
- "description": "service contains configuration for the Service resource created for this sample.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSampleGitImportSourceService"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSampleGitImportSourceRepository": {
- "description": "ConsoleSampleGitImportSourceRepository let the user import code from a public git repository.",
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "contextDir": {
- "description": "contextDir is used to specify a directory within the repository to build the component. Must start with `/` and have a maximum length of 256 characters. When omitted, the default value is to build from the root of the repository.",
- "type": "string",
- "default": ""
- },
- "revision": {
- "description": "revision is the git revision at which to clone the git repository Can be used to clone a specific branch, tag or commit SHA. Must be at most 256 characters in length. When omitted the repository's default branch is used.",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url of the Git repository that contains a HTTP service. The HTTP service must be exposed on the default port (8080) unless otherwise configured with the port field.\n\nOnly public repositories on GitHub, GitLab and Bitbucket are currently supported:\n\n - https://github.com//\n - https://gitlab.com//\n - https://bitbucket.org//\n\nThe url must have a maximum length of 256 characters.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSampleGitImportSourceService": {
- "description": "ConsoleSampleGitImportSourceService let the samples author define defaults for the Service created for this sample.",
- "type": "object",
- "properties": {
- "targetPort": {
- "description": "targetPort is the port that the service listens on for HTTP requests. This port will be used for Service created for this sample. Port must be in the range 1 to 65535. Default port is 8080.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSampleList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSample"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleSampleSource": {
- "description": "ConsoleSampleSource is the actual sample definition and can hold different sample types. Unsupported sample types will be ignored in the web console.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "containerImport": {
- "description": "containerImport allows the user import a container image.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSampleContainerImportSource"
- },
- "gitImport": {
- "description": "gitImport allows the user to import code from a git repository.",
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSampleGitImportSource"
- },
- "type": {
- "description": "type of the sample, currently supported: \"GitImport\";\"ContainerImport\"",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "containerImport": "ContainerImport",
- "gitImport": "GitImport"
- }
- }
- ]
- },
- "com.github.openshift.api.console.v1.ConsoleSampleSpec": {
- "description": "ConsoleSampleSpec is the desired sample for the web console. Samples will appear with their title, descriptions and a badge in a samples catalog.",
- "type": "object",
- "required": [
- "title",
- "abstract",
- "description",
- "source"
- ],
- "properties": {
- "abstract": {
- "description": "abstract is a short introduction to the sample.\n\nIt is required and must be no more than 100 characters in length.\n\nThe abstract is shown on the sample card tile below the title and provider and is limited to three lines of content.",
- "type": "string",
- "default": ""
- },
- "description": {
- "description": "description is a long form explanation of the sample.\n\nIt is required and can have a maximum length of **4096** characters.\n\nIt is a README.md-like content for additional information, links, pre-conditions, and other instructions. It will be rendered as Markdown so that it can contain line breaks, links, and other simple formatting.",
- "type": "string",
- "default": ""
- },
- "icon": {
- "description": "icon is an optional base64 encoded image and shown beside the sample title.\n\nThe format must follow the data: URL format and can have a maximum size of **10 KB**.\n\n data:[][;base64],\n\nFor example:\n\n data:image;base64, plus the base64 encoded image.\n\nVector images can also be used. SVG icons must start with:\n\n data:image/svg+xml;base64, plus the base64 encoded SVG image.\n\nAll sample catalog icons will be shown on a white background (also when the dark theme is used). The web console ensures that different aspect ratios work correctly. Currently, the surface of the icon is at most 40x100px.\n\nFor more information on the data URL format, please visit https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs.",
- "type": "string",
- "default": ""
- },
- "provider": {
- "description": "provider is an optional label to honor who provides the sample.\n\nIt is optional and must be no more than 50 characters in length.\n\nA provider can be a company like \"Red Hat\" or an organization like \"CNCF\" or \"Knative\".\n\nCurrently, the provider is only shown on the sample card tile below the title with the prefix \"Provided by \"",
- "type": "string",
- "default": ""
- },
- "source": {
- "description": "source defines where to deploy the sample service from. The sample may be sourced from an external git repository or container image.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleSampleSource"
- },
- "tags": {
- "description": "tags are optional string values that can be used to find samples in the samples catalog.\n\nExamples of common tags may be \"Java\", \"Quarkus\", etc.\n\nThey will be displayed on the samples details page.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "title": {
- "description": "title is the display name of the sample.\n\nIt is required and must be no more than 50 characters in length.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type is an optional label to group multiple samples.\n\nIt is optional and must be no more than 20 characters in length.\n\nRecommendation is a singular term like \"Builder Image\", \"Devfile\" or \"Serverless Function\".\n\nCurrently, the type is shown a badge on the sample card tile in the top right corner.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleYAMLSample": {
- "description": "ConsoleYAMLSample is an extension for customizing OpenShift web console YAML samples.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleYAMLSampleSpec"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleYAMLSampleList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.console.v1.ConsoleYAMLSample"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.console.v1.ConsoleYAMLSampleSpec": {
- "description": "ConsoleYAMLSampleSpec is the desired YAML sample configuration. Samples will appear with their descriptions in a samples sidebar when creating a resources in the web console.",
- "type": "object",
- "required": [
- "targetResource",
- "title",
- "description",
- "yaml"
- ],
- "properties": {
- "description": {
- "description": "description of the YAML sample.",
- "type": "string",
- "default": ""
- },
- "snippet": {
- "description": "snippet indicates that the YAML sample is not the full YAML resource definition, but a fragment that can be inserted into the existing YAML document at the user's cursor.",
- "type": "boolean",
- "default": false
- },
- "targetResource": {
- "description": "targetResource contains apiVersion and kind of the resource YAML sample is representating.",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.TypeMeta"
- },
- "title": {
- "description": "title of the YAML sample.",
- "type": "string",
- "default": ""
- },
- "yaml": {
- "description": "yaml is the YAML sample to display.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.Link": {
- "description": "Represents a standard link that could be generated in HTML",
- "type": "object",
- "required": [
- "text",
- "href"
- ],
- "properties": {
- "href": {
- "description": "href is the absolute secure URL for the link (must use https)",
- "type": "string",
- "default": ""
- },
- "text": {
- "description": "text is the display text for the link",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.console.v1.NamespaceDashboardSpec": {
- "description": "NamespaceDashboardSpec is a specification of namespaces in which the dashboard link should appear. If both namespaces and namespaceSelector are specified, the link will appear in namespaces that match either",
- "type": "object",
- "properties": {
- "namespaceSelector": {
- "description": "namespaceSelector is used to select the Namespaces that should contain dashboard link by label. If the namespace labels match, dashboard link will be shown for the namespaces.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "namespaces": {
- "description": "namespaces is an array of namespace names in which the dashboard link should appear.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.example.v1.CELUnion": {
- "description": "CELUnion demonstrates how to use a discriminated union and how to validate it using CEL.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "optionalMember": {
- "description": "optionalMember is a union member that is optional.",
- "type": "string"
- },
- "requiredMember": {
- "description": "requiredMember is a union member that is required.",
- "type": "string"
- },
- "type": {
- "description": "type determines which of the union members should be populated.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "optionalMember": "OptionalMember",
- "requiredMember": "RequiredMember"
- }
- }
- ]
- },
- "com.github.openshift.api.example.v1.EvolvingUnion": {
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "type is the discriminator. It has different values for Default and for TechPreviewNoUpgrade",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.example.v1.StableConfigType": {
- "description": "StableConfigType is a stable config type that may include TechPreviewNoUpgrade fields.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the StableConfigType.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1.StableConfigTypeSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the StableConfigType.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1.StableConfigTypeStatus"
- }
- }
- },
- "com.github.openshift.api.example.v1.StableConfigTypeList": {
- "description": "StableConfigTypeList contains a list of StableConfigTypes.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1.StableConfigType"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.example.v1.StableConfigTypeSpec": {
- "description": "StableConfigTypeSpec is the desired state",
- "type": "object",
- "required": [
- "immutableField"
- ],
- "properties": {
- "celUnion": {
- "description": "celUnion demonstrates how to validate a discrminated union using CEL",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1.CELUnion"
- },
- "coolNewField": {
- "description": "coolNewField is a field that is for tech preview only. On normal clusters this shouldn't be present",
- "type": "string",
- "default": ""
- },
- "evolvingCollection": {
- "description": "evolvingCollection demonstrates how to have a collection where the maximum number of items varies on cluster type. For default clusters, this will be \"1\" but on TechPreview clusters, this value will be \"3\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "evolvingUnion": {
- "description": "evolvingUnion demonstrates how to phase in new values into discriminated union",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1.EvolvingUnion"
- },
- "immutableField": {
- "description": "immutableField is a field that is immutable once the object has been created. It is required at all times.",
- "type": "string",
- "default": ""
- },
- "nonZeroDefault": {
- "description": "nonZeroDefault is a demonstration of creating an integer field that has a non zero default. It required two default tags (one for CRD generation, one for client generation) and must have `omitempty` and be optional. A minimum value is added to demonstrate that a zero value would not be accepted.",
- "type": "integer",
- "format": "int32",
- "default": 8
- },
- "optionalImmutableField": {
- "description": "optionalImmutableField is a field that is immutable once set. It is optional but may not be changed once set.",
- "type": "string",
- "default": ""
- },
- "set": {
- "description": "set demonstrates how to define and validate set of strings",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "stableField": {
- "description": "stableField is a field that is present on default clusters and on tech preview clusters\n\nIf empty, the platform will choose a good default, which may change over time without notice.",
- "type": "string",
- "default": ""
- },
- "subdomainNameField": {
- "description": "subdomainNameField represents a kubenetes name field. The intention is that it validates the name in the same way metadata.Name is validated. That is, it is a DNS-1123 subdomain.",
- "type": "string"
- },
- "subnetsWithExclusions": {
- "description": "subnetsWithExclusions demonstrates how to validate a list of subnets with exclusions",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1.SubnetsWithExclusions"
- }
- }
- },
- "com.github.openshift.api.example.v1.StableConfigTypeStatus": {
- "description": "StableConfigTypeStatus defines the observed status of the StableConfigType.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "Represents the observations of a foo's current state. Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "immutableField": {
- "description": "immutableField is a field that is immutable once the object has been created. It is required at all times.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.example.v1.SubnetsWithExclusions": {
- "description": "SubnetsWithExclusions is used to validate a list of subnets with exclusions. It demonstrates how exclusions should be validated as subnetworks of the networks listed in the subnets field.",
- "type": "object",
- "required": [
- "subnets"
- ],
- "properties": {
- "excludeSubnets": {
- "description": "excludeSubnets is a list of CIDR exclusions. The subnets in this list must be subnetworks of the subnets in the subnets list.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "subnets": {
- "description": "subnets is a list of subnets. It may contain up to 2 subnets. The list may be either 1 IPv4 subnet, 1 IPv6 subnet, or 1 of each.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.example.v1alpha1.NotStableConfigType": {
- "description": "NotStableConfigType is a stable config type that is TechPreviewNoUpgrade only.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the NotStableConfigType.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1alpha1.NotStableConfigTypeSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the NotStableConfigType.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1alpha1.NotStableConfigTypeStatus"
- }
- }
- },
- "com.github.openshift.api.example.v1alpha1.NotStableConfigTypeList": {
- "description": "NotStableConfigTypeList contains a list of NotStableConfigTypes.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.example.v1alpha1.NotStableConfigType"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.example.v1alpha1.NotStableConfigTypeSpec": {
- "description": "NotStableConfigTypeSpec is the desired state",
- "type": "object",
- "required": [
- "newField"
- ],
- "properties": {
- "newField": {
- "description": "newField is a field that is tech preview, but because the entire type is gated, there is no marker on the field.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.example.v1alpha1.NotStableConfigTypeStatus": {
- "description": "NotStableConfigTypeStatus defines the observed status of the NotStableConfigType.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "Represents the observations of a foo's current state. Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.ConnectionConfig": {
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca-bundle.crt\" is used to locate the data. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "tlsClientConfig": {
- "description": "tlsClientConfig is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate and private key to present when connecting to the server. The key \"tls.crt\" is used to locate the client certificate. The key \"tls.key\" is used to locate the private key. The namespace for this secret is openshift-config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "url": {
- "description": "Chart repository URL",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.ConnectionConfigNamespaceScoped": {
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "basicAuthConfig": {
- "description": "basicAuthConfig is an optional reference to a secret by name that contains the basic authentication credentials to present when connecting to the server. The key \"username\" is used locate the username. The key \"password\" is used to locate the password. The namespace for this secret must be same as the namespace where the project helm chart repository is getting instantiated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "ca": {
- "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca-bundle.crt\" is used to locate the data. If empty, the default system roots are used. The namespace for this configmap must be same as the namespace where the project helm chart repository is getting instantiated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "tlsClientConfig": {
- "description": "tlsClientConfig is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate and private key to present when connecting to the server. The key \"tls.crt\" is used to locate the client certificate. The key \"tls.key\" is used to locate the private key. The namespace for this secret must be same as the namespace where the project helm chart repository is getting instantiated.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- },
- "url": {
- "description": "Chart repository URL",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.HelmChartRepository": {
- "description": "HelmChartRepository holds cluster-wide configuration for proxied Helm chart repository\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.HelmChartRepositorySpec"
- },
- "status": {
- "description": "Observed status of the repository within the cluster..",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.HelmChartRepositoryStatus"
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.HelmChartRepositoryList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.HelmChartRepository"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.HelmChartRepositorySpec": {
- "description": "Helm chart repository exposed within the cluster",
- "type": "object",
- "required": [
- "connectionConfig"
- ],
- "properties": {
- "connectionConfig": {
- "description": "Required configuration for connecting to the chart repo",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.ConnectionConfig"
- },
- "description": {
- "description": "Optional human readable repository description, it can be used by UI for displaying purposes",
- "type": "string"
- },
- "disabled": {
- "description": "If set to true, disable the repo usage in the cluster/namespace",
- "type": "boolean"
- },
- "name": {
- "description": "Optional associated human readable repository name, it can be used by UI for displaying purposes",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.HelmChartRepositoryStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their statuses",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.ProjectHelmChartRepository": {
- "description": "ProjectHelmChartRepository holds namespace-wide configuration for proxied Helm chart repository\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.ProjectHelmChartRepositorySpec"
- },
- "status": {
- "description": "Observed status of the repository within the namespace..",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.HelmChartRepositoryStatus"
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.ProjectHelmChartRepositoryList": {
- "description": "Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.ProjectHelmChartRepository"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.helm.v1beta1.ProjectHelmChartRepositorySpec": {
- "description": "Project Helm chart repository exposed within a namespace",
- "type": "object",
- "required": [
- "connectionConfig"
- ],
- "properties": {
- "connectionConfig": {
- "description": "Required configuration for connecting to the chart repo",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.helm.v1beta1.ConnectionConfigNamespaceScoped"
- },
- "description": {
- "description": "Optional human readable repository description, it can be used by UI for displaying purposes",
- "type": "string"
- },
- "disabled": {
- "description": "If set to true, disable the repo usage in the namespace",
- "type": "boolean"
- },
- "name": {
- "description": "Optional associated human readable repository name, it can be used by UI for displaying purposes",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.image.v1.DockerImageReference": {
- "description": "DockerImageReference points to a container image.",
- "type": "object",
- "required": [
- "Registry",
- "Namespace",
- "Name",
- "Tag",
- "ID"
- ],
- "properties": {
- "ID": {
- "description": "ID is the identifier for the container image",
- "type": "string",
- "default": ""
- },
- "Name": {
- "description": "Name is the name of the container image",
- "type": "string",
- "default": ""
- },
- "Namespace": {
- "description": "Namespace is the namespace that contains the container image",
- "type": "string",
- "default": ""
- },
- "Registry": {
- "description": "Registry is the registry that contains the container image",
- "type": "string",
- "default": ""
- },
- "Tag": {
- "description": "Tag is which tag of the container image is being referenced",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.Image": {
- "description": "Image is an immutable representation of a container image and its metadata at a point in time. Images are named by taking a hash of their contents (metadata and content) and any change in format, content, or metadata results in a new name. The images resource is primarily for use by cluster administrators and integrations like the cluster image registry - end users, instead, access images via the imagestreamtags or imagestreamimages resources. While image metadata is stored in the API, any integration that implements the container image registry API must provide its own storage for the raw manifest data, image config, and layer contents.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "dockerImageConfig": {
- "description": "dockerImageConfig is a JSON blob that the runtime uses to set up the container. This is a part of manifest schema v2. Will not be set when the image represents a manifest list.",
- "type": "string"
- },
- "dockerImageLayers": {
- "description": "dockerImageLayers represents the layers in the image. May not be set if the image does not define that data or if the image represents a manifest list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageLayer"
- }
- },
- "dockerImageManifest": {
- "description": "dockerImageManifest is the raw JSON of the manifest",
- "type": "string"
- },
- "dockerImageManifestMediaType": {
- "description": "dockerImageManifestMediaType specifies the mediaType of manifest. This is a part of manifest schema v2.",
- "type": "string"
- },
- "dockerImageManifests": {
- "description": "dockerImageManifests holds information about sub-manifests when the image represents a manifest list. When this field is present, no DockerImageLayers should be specified.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageManifest"
- }
- },
- "dockerImageMetadata": {
- "description": "dockerImageMetadata contains metadata about this image",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension",
- "x-kubernetes-patch-strategy": "replace"
- },
- "dockerImageMetadataVersion": {
- "description": "dockerImageMetadataVersion conveys the version of the object, which if empty defaults to \"1.0\"",
- "type": "string"
- },
- "dockerImageReference": {
- "description": "dockerImageReference is the string that can be used to pull this image.",
- "type": "string"
- },
- "dockerImageSignatures": {
- "description": "dockerImageSignatures provides the signatures as opaque blobs. This is a part of manifest schema v1.",
- "type": "array",
- "items": {
- "type": "string",
- "format": "byte"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "signatures": {
- "description": "signatures holds all signatures of the image.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageSignature"
- },
- "x-kubernetes-patch-merge-key": "name",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageBlobReferences": {
- "description": "ImageBlobReferences describes the blob references within an image.",
- "type": "object",
- "properties": {
- "config": {
- "description": "config, if set, is the blob that contains the image config. Some images do not have separate config blobs and this field will be set to nil if so.",
- "type": "string"
- },
- "imageMissing": {
- "description": "imageMissing is true if the image is referenced by the image stream but the image object has been deleted from the API by an administrator. When this field is set, layers and config fields may be empty and callers that depend on the image metadata should consider the image to be unavailable for download or viewing.",
- "type": "boolean",
- "default": false
- },
- "layers": {
- "description": "layers is the list of blobs that compose this image, from base layer to top layer. All layers referenced by this array will be defined in the blobs map. Some images may have zero layers.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "manifests": {
- "description": "manifests is the list of other image names that this image points to. For a single architecture image, it is empty. For a multi-arch image, it consists of the digests of single architecture images, such images shouldn't have layers nor config.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageImportSpec": {
- "description": "ImageImportSpec describes a request to import a specific image.",
- "type": "object",
- "required": [
- "from"
- ],
- "properties": {
- "from": {
- "description": "from is the source of an image to import; only kind DockerImage is allowed",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "importPolicy": {
- "description": "importPolicy is the policy controlling how the image is imported",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagImportPolicy"
- },
- "includeManifest": {
- "description": "includeManifest determines if the manifest for each image is returned in the response",
- "type": "boolean"
- },
- "referencePolicy": {
- "description": "referencePolicy defines how other components should consume the image",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReferencePolicy"
- },
- "to": {
- "description": "to is a tag in the current image stream to assign the imported image to, if name is not specified the default tag from from.name will be used",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageImportStatus": {
- "description": "ImageImportStatus describes the result of an image import.",
- "type": "object",
- "required": [
- "status"
- ],
- "properties": {
- "image": {
- "description": "image is the metadata of that image, if the image was located",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.Image"
- },
- "manifests": {
- "description": "manifests holds sub-manifests metadata when importing a manifest list",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.Image"
- }
- },
- "status": {
- "description": "status is the status of the image import, including errors encountered while retrieving the image",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
- },
- "tag": {
- "description": "tag is the tag this image was located under, if any",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageLayer": {
- "description": "ImageLayer represents a single layer of the image. Some images may have multiple layers. Some may have none.",
- "type": "object",
- "required": [
- "name",
- "size",
- "mediaType"
- ],
- "properties": {
- "mediaType": {
- "description": "mediaType of the referenced object.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name of the layer as defined by the underlying store.",
- "type": "string",
- "default": ""
- },
- "size": {
- "description": "size of the layer in bytes as defined by the underlying store.",
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageLayerData": {
- "description": "ImageLayerData contains metadata about an image layer.",
- "type": "object",
- "required": [
- "size",
- "mediaType"
- ],
- "properties": {
- "mediaType": {
- "description": "mediaType of the referenced object.",
- "type": "string",
- "default": ""
- },
- "size": {
- "description": "size of the layer in bytes as defined by the underlying store. This field is optional if the necessary information about size is not available.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageList": {
- "description": "ImageList is a list of Image objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of images",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.Image"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageLookupPolicy": {
- "description": "ImageLookupPolicy describes how an image stream can be used to override the image references used by pods, builds, and other resources in a namespace.",
- "type": "object",
- "required": [
- "local"
- ],
- "properties": {
- "local": {
- "description": "local will change the docker short image references (like \"mysql\" or \"php:latest\") on objects in this namespace to the image ID whenever they match this image stream, instead of reaching out to a remote registry. The name will be fully qualified to an image ID if found. The tag's referencePolicy is taken into account on the replaced value. Only works within the current namespace.",
- "type": "boolean",
- "default": false
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageManifest": {
- "description": "ImageManifest represents sub-manifests of a manifest list. The Digest field points to a regular Image object.",
- "type": "object",
- "required": [
- "digest",
- "mediaType",
- "manifestSize",
- "architecture",
- "os"
- ],
- "properties": {
- "architecture": {
- "description": "architecture specifies the supported CPU architecture, for example `amd64` or `ppc64le`.",
- "type": "string",
- "default": ""
- },
- "digest": {
- "description": "digest is the unique identifier for the manifest. It refers to an Image object.",
- "type": "string",
- "default": ""
- },
- "manifestSize": {
- "description": "manifestSize represents the size of the raw object contents, in bytes.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "mediaType": {
- "description": "mediaType defines the type of the manifest, possible values are application/vnd.oci.image.manifest.v1+json, application/vnd.docker.distribution.manifest.v2+json or application/vnd.docker.distribution.manifest.v1+json.",
- "type": "string",
- "default": ""
- },
- "os": {
- "description": "os specifies the operating system, for example `linux`.",
- "type": "string",
- "default": ""
- },
- "variant": {
- "description": "variant is an optional field repreenting a variant of the CPU, for example v6 to specify a particular CPU variant of the ARM CPU.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageSignature": {
- "description": "ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "type",
- "content"
- ],
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions represent the latest available observations of a signature's current state.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.SignatureCondition"
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "content": {
- "description": "Required: An opaque binary string which is an image's signature.",
- "type": "string",
- "format": "byte"
- },
- "created": {
- "description": "If specified, it is the time of signature's creation.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "imageIdentity": {
- "description": "A human readable string representing image's identity. It could be a product name and version, or an image pull spec (e.g. \"registry.access.redhat.com/rhel7/rhel:7.2\").",
- "type": "string"
- },
- "issuedBy": {
- "description": "If specified, it holds information about an issuer of signing certificate or key (a person or entity who signed the signing certificate or key).",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.SignatureIssuer"
- },
- "issuedTo": {
- "description": "If specified, it holds information about a subject of signing certificate or key (a person or entity who signed the image).",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.SignatureSubject"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "signedClaims": {
- "description": "Contains claims from the signature.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "type": {
- "description": "Required: Describes a type of stored blob.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStream": {
- "description": "An ImageStream stores a mapping of tags to images, metadata overrides that are applied when images are tagged in a stream, and an optional reference to a container image repository on a registry. Users typically update the spec.tags field to point to external images which are imported from container registries using credentials in your namespace with the pull secret type, or to existing image stream tags and images which are immediately accessible for tagging or pulling. The history of images applied to a tag is visible in the status.tags field and any user who can view an image stream is allowed to tag that image into their own image streams. Access to pull images from the integrated registry is granted by having the \"get imagestreams/layers\" permission on a given image stream. Users may remove a tag by deleting the imagestreamtag resource, which causes both spec and status for that tag to be removed. Image stream history is retained until an administrator runs the prune operation, which removes references that are no longer in use. To preserve a historical image, ensure there is a tag in spec pointing to that image by its digest.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec describes the desired state of this stream",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStreamSpec"
- },
- "status": {
- "description": "status describes the current state of this stream",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStreamStatus"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamImage": {
- "description": "ImageStreamImage represents an Image that is retrieved by image name from an ImageStream. User interfaces and regular users can use this resource to access the metadata details of a tagged image in the image stream history for viewing, since Image resources are not directly accessible to end users. A not found error will be returned if no such image is referenced by a tag within the ImageStream. Images are created when spec tags are set on an image stream that represent an image in an external registry, when pushing to the integrated registry, or when tagging an existing image from one image stream to another. The name of an image stream image is in the form \"@\", where the digest is the content addressible identifier for the image (sha256:xxxxx...). You can use ImageStreamImages as the from.kind of an image stream spec tag to reference an image exactly. The only operations supported on the imagestreamimage endpoint are retrieving the image.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "image"
- ],
- "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",
- "type": "string"
- },
- "image": {
- "description": "image associated with the ImageStream and image name.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.Image"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamImport": {
- "description": "The image stream import resource provides an easy way for a user to find and import container images from other container image registries into the server. Individual images or an entire image repository may be imported, and users may choose to see the results of the import prior to tagging the resulting images into the specified image stream.\n\nThis API is intended for end-user tools that need to see the metadata of the image prior to import (for instance, to generate an application from it). Clients that know the desired image can continue to create spec.tags directly into their image streams.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec",
- "status"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is a description of the images that the user wishes to import",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStreamImportSpec"
- },
- "status": {
- "description": "status is the result of importing the image",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStreamImportStatus"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamImportSpec": {
- "description": "ImageStreamImportSpec defines what images should be imported.",
- "type": "object",
- "required": [
- "import"
- ],
- "properties": {
- "images": {
- "description": "images are a list of individual images to import.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageImportSpec"
- }
- },
- "import": {
- "description": "import indicates whether to perform an import - if so, the specified tags are set on the spec and status of the image stream defined by the type meta.",
- "type": "boolean",
- "default": false
- },
- "repository": {
- "description": "repository is an optional import of an entire container image repository. A maximum limit on the number of tags imported this way is imposed by the server.",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.RepositoryImportSpec"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamImportStatus": {
- "description": "ImageStreamImportStatus contains information about the status of an image stream import.",
- "type": "object",
- "properties": {
- "images": {
- "description": "images is set with the result of importing spec.images",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageImportStatus"
- }
- },
- "import": {
- "description": "import is the image stream that was successfully updated or created when 'to' was set.",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStream"
- },
- "repository": {
- "description": "repository is set if spec.repository was set to the outcome of the import",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.RepositoryImportStatus"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamLayers": {
- "description": "ImageStreamLayers describes information about the layers referenced by images in this image stream.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "blobs",
- "images"
- ],
- "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",
- "type": "string"
- },
- "blobs": {
- "description": "blobs is a map of blob name to metadata about the blob.",
- "type": "object",
- "additionalProperties": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageLayerData"
- }
- },
- "images": {
- "description": "images is a map between an image name and the names of the blobs and config that comprise the image.",
- "type": "object",
- "additionalProperties": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageBlobReferences"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamList": {
- "description": "ImageStreamList is a list of ImageStream objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of imageStreams",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStream"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamMapping": {
- "description": "ImageStreamMapping represents a mapping from a single image stream tag to a container image as well as the reference to the container image stream the image came from. This resource is used by privileged integrators to create an image resource and to associate it with an image stream in the status tags field. Creating an ImageStreamMapping will allow any user who can view the image stream to tag or pull that image, so only create mappings where the user has proven they have access to the image contents directly. The only operation supported for this resource is create and the metadata name and namespace should be set to the image stream containing the tag that should be updated.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "image",
- "tag"
- ],
- "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",
- "type": "string"
- },
- "image": {
- "description": "image is a container image.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.Image"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "tag": {
- "description": "tag is a string value this image can be located with inside the stream.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamSpec": {
- "description": "ImageStreamSpec represents options for ImageStreams.",
- "type": "object",
- "properties": {
- "dockerImageRepository": {
- "description": "dockerImageRepository is optional, if specified this stream is backed by a container repository on this server Deprecated: This field is deprecated as of v3.7 and will be removed in a future release. Specify the source for the tags to be imported in each tag via the spec.tags.from reference instead.",
- "type": "string"
- },
- "lookupPolicy": {
- "description": "lookupPolicy controls how other resources reference images within this namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageLookupPolicy"
- },
- "tags": {
- "description": "tags map arbitrary string values to specific image locators",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReference"
- },
- "x-kubernetes-patch-merge-key": "name",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamStatus": {
- "description": "ImageStreamStatus contains information about the state of this image stream.",
- "type": "object",
- "properties": {
- "dockerImageRepository": {
- "description": "dockerImageRepository represents the effective location this stream may be accessed at. May be empty until the server determines where the repository is located",
- "type": "string",
- "default": ""
- },
- "publicDockerImageRepository": {
- "description": "publicDockerImageRepository represents the public location from where the image can be pulled outside the cluster. This field may be empty if the administrator has not exposed the integrated registry externally.",
- "type": "string"
- },
- "tags": {
- "description": "tags are a historical record of images associated with each tag. The first entry in the TagEvent array is the currently tagged image.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.NamedTagEventList"
- },
- "x-kubernetes-patch-merge-key": "tag",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamTag": {
- "description": "ImageStreamTag represents an Image that is retrieved by tag name from an ImageStream. Use this resource to interact with the tags and images in an image stream by tag, or to see the image details for a particular tag. The image associated with this resource is the most recently successfully tagged, imported, or pushed image (as described in the image stream status.tags.items list for this tag). If an import is in progress or has failed the previous image will be shown. Deleting an image stream tag clears both the status and spec fields of an image stream. If no image can be retrieved for a given tag, a not found error will be returned.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "tag",
- "generation",
- "lookupPolicy",
- "image"
- ],
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is an array of conditions that apply to the image stream tag.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagEventCondition"
- }
- },
- "generation": {
- "description": "generation is the current generation of the tagged image - if tag is provided and this value is not equal to the tag generation, a user has requested an import that has not completed, or conditions will be filled out indicating any error.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "image": {
- "description": "image associated with the ImageStream and tag.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.Image"
- },
- "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",
- "type": "string"
- },
- "lookupPolicy": {
- "description": "lookupPolicy indicates whether this tag will handle image references in this namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageLookupPolicy"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "tag": {
- "description": "tag is the spec tag associated with this image stream tag, and it may be null if only pushes have occurred to this image stream.",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReference"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageStreamTagList": {
- "description": "ImageStreamTagList is a list of ImageStreamTag objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of image stream tags",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageStreamTag"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageTag": {
- "description": "ImageTag represents a single tag within an image stream and includes the spec, the status history, and the currently referenced image (if any) of the provided tag. This type replaces the ImageStreamTag by providing a full view of the tag. ImageTags are returned for every spec or status tag present on the image stream. If no tag exists in either form, a not found error will be returned by the API. A create operation will succeed if no spec tag has already been defined and the spec field is set. Delete will remove both spec and status elements from the image stream.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec",
- "status",
- "image"
- ],
- "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",
- "type": "string"
- },
- "image": {
- "description": "image is the details of the most recent image stream status tag, and it may be null if import has not completed or an administrator has deleted the image object. To verify this is the most recent image, you must verify the generation of the most recent status.items entry matches the spec tag (if a spec tag is set). This field will not be set when listing image tags.",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.Image"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the spec tag associated with this image stream tag, and it may be null if only pushes have occurred to this image stream.",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReference"
- },
- "status": {
- "description": "status is the status tag details associated with this image stream tag, and it may be null if no push or import has been performed.",
- "$ref": "#/definitions/com.github.openshift.api.image.v1.NamedTagEventList"
- }
- }
- },
- "com.github.openshift.api.image.v1.ImageTagList": {
- "description": "ImageTagList is a list of ImageTag objects. When listing image tags, the image field is not populated. Tags are returned in alphabetical order by image stream and then tag.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of image stream tags",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageTag"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.image.v1.NamedTagEventList": {
- "description": "NamedTagEventList relates a tag to its image history.",
- "type": "object",
- "required": [
- "tag",
- "items"
- ],
- "properties": {
- "conditions": {
- "description": "conditions is an array of conditions that apply to the tag event list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagEventCondition"
- }
- },
- "items": {
- "description": "Standard object's metadata.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagEvent"
- }
- },
- "tag": {
- "description": "tag is the tag for which the history is recorded",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.RepositoryImportSpec": {
- "description": "RepositoryImportSpec describes a request to import images from a container image repository.",
- "type": "object",
- "required": [
- "from"
- ],
- "properties": {
- "from": {
- "description": "from is the source for the image repository to import; only kind DockerImage and a name of a container image repository is allowed",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "importPolicy": {
- "description": "importPolicy is the policy controlling how the image is imported",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagImportPolicy"
- },
- "includeManifest": {
- "description": "includeManifest determines if the manifest for each image is returned in the response",
- "type": "boolean"
- },
- "referencePolicy": {
- "description": "referencePolicy defines how other components should consume the image",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReferencePolicy"
- }
- }
- },
- "com.github.openshift.api.image.v1.RepositoryImportStatus": {
- "description": "RepositoryImportStatus describes the result of an image repository import",
- "type": "object",
- "properties": {
- "additionalTags": {
- "description": "additionalTags are tags that exist in the repository but were not imported because a maximum limit of automatic imports was applied.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "images": {
- "description": "images is a list of images successfully retrieved by the import of the repository.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.ImageImportStatus"
- }
- },
- "status": {
- "description": "status reflects whether any failure occurred during import",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
- }
- }
- },
- "com.github.openshift.api.image.v1.SecretList": {
- "description": "SecretList is a list of Secret.",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Secret"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.image.v1.SignatureCondition": {
- "description": "SignatureCondition describes an image signature condition of particular kind at particular probe time.",
- "type": "object",
- "required": [
- "type",
- "status"
- ],
- "properties": {
- "lastProbeTime": {
- "description": "Last time the condition was checked.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "lastTransitionTime": {
- "description": "Last time the condition transit from one status to another.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "Human readable message indicating details about last transition.",
- "type": "string"
- },
- "reason": {
- "description": "(brief) reason for the condition's last transition.",
- "type": "string"
- },
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type of signature condition, Complete or Failed.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.SignatureGenericEntity": {
- "description": "SignatureGenericEntity holds a generic information about a person or entity who is an issuer or a subject of signing certificate or key.",
- "type": "object",
- "properties": {
- "commonName": {
- "description": "Common name (e.g. openshift-signing-service).",
- "type": "string"
- },
- "organization": {
- "description": "organization name.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.image.v1.SignatureIssuer": {
- "description": "SignatureIssuer holds information about an issuer of signing certificate or key.",
- "type": "object",
- "properties": {
- "commonName": {
- "description": "Common name (e.g. openshift-signing-service).",
- "type": "string"
- },
- "organization": {
- "description": "organization name.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.image.v1.SignatureSubject": {
- "description": "SignatureSubject holds information about a person or entity who created the signature.",
- "type": "object",
- "required": [
- "publicKeyID"
- ],
- "properties": {
- "commonName": {
- "description": "Common name (e.g. openshift-signing-service).",
- "type": "string"
- },
- "organization": {
- "description": "organization name.",
- "type": "string"
- },
- "publicKeyID": {
- "description": "If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key's fingerprint (e.g. 0x685ebe62bf278440).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.TagEvent": {
- "description": "TagEvent is used by ImageStreamStatus to keep a historical record of images associated with a tag.",
- "type": "object",
- "required": [
- "created",
- "dockerImageReference",
- "image",
- "generation"
- ],
- "properties": {
- "created": {
- "description": "created holds the time the TagEvent was created",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "dockerImageReference": {
- "description": "dockerImageReference is the string that can be used to pull this image",
- "type": "string",
- "default": ""
- },
- "generation": {
- "description": "generation is the spec tag generation that resulted in this tag being updated",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "image": {
- "description": "image is the image",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.TagEventCondition": {
- "description": "TagEventCondition contains condition information for a tag event.",
- "type": "object",
- "required": [
- "type",
- "status",
- "generation"
- ],
- "properties": {
- "generation": {
- "description": "generation is the spec tag generation that this status corresponds to",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "lastTransitionTime": {
- "description": "lastTransitionTime is the time the condition transitioned from one status to another.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "message is a human readable description of the details about last transition, complementing reason.",
- "type": "string"
- },
- "reason": {
- "description": "reason is a brief machine readable explanation for the condition's last transition.",
- "type": "string"
- },
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type of tag event condition, currently only ImportSuccess",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.image.v1.TagImportPolicy": {
- "description": "TagImportPolicy controls how images related to this tag will be imported.",
- "type": "object",
- "properties": {
- "importMode": {
- "description": "importMode describes how to import an image manifest.",
- "type": "string"
- },
- "insecure": {
- "description": "insecure is true if the server may bypass certificate verification or connect directly over HTTP during image import.",
- "type": "boolean"
- },
- "scheduled": {
- "description": "scheduled indicates to the server that this tag should be periodically checked to ensure it is up to date, and imported",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.image.v1.TagReference": {
- "description": "TagReference specifies optional annotations for images using this tag and an optional reference to an ImageStreamTag, ImageStreamImage, or DockerImage this tag should track.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "annotations": {
- "description": "Optional; if specified, annotations that are applied to images retrieved via ImageStreamTags.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "from": {
- "description": "Optional; if specified, a reference to another image that this tag should point to. Valid values are ImageStreamTag, ImageStreamImage, and DockerImage. ImageStreamTag references can only reference a tag within this same ImageStream.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "generation": {
- "description": "generation is a counter that tracks mutations to the spec tag (user intent). When a tag reference is changed the generation is set to match the current stream generation (which is incremented every time spec is changed). Other processes in the system like the image importer observe that the generation of spec tag is newer than the generation recorded in the status and use that as a trigger to import the newest remote tag. To trigger a new import, clients may set this value to zero which will reset the generation to the latest stream generation. Legacy clients will send this value as nil which will be merged with the current tag generation.",
- "type": "integer",
- "format": "int64"
- },
- "importPolicy": {
- "description": "importPolicy is information that controls how images may be imported by the server.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagImportPolicy"
- },
- "name": {
- "description": "name of the tag",
- "type": "string",
- "default": ""
- },
- "reference": {
- "description": "reference states if the tag will be imported. Default value is false, which means the tag will be imported.",
- "type": "boolean"
- },
- "referencePolicy": {
- "description": "referencePolicy defines how other components should consume the image.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.image.v1.TagReferencePolicy"
- }
- }
- },
- "com.github.openshift.api.image.v1.TagReferencePolicy": {
- "description": "TagReferencePolicy describes how pull-specs for images in this image stream tag are generated when image change triggers in deployment configs or builds are resolved. This allows the image stream author to control how images are accessed.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "type determines how the image pull spec should be transformed when the image stream tag is used in deployment config triggers or new builds. The default value is `Source`, indicating the original location of the image should be used (if imported). The user may also specify `Local`, indicating that the pull spec should point to the integrated container image registry and leverage the registry's ability to proxy the pull to an upstream registry. `Local` allows the credentials used to pull this image to be managed from the image stream's namespace, so others on the platform can access a remote image but have no access to the remote secret. It also allows the image layers to be mirrored into the local registry which the images can still be pulled even if the upstream registry is unavailable.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1.Custom": {
- "description": "Custom provides the custom configuration of gatherers",
- "type": "object",
- "required": [
- "configs"
- ],
- "properties": {
- "configs": {
- "description": "configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers. It may not exceed 100 items and each gatherer can be present only once. It is possible to disable an entire set of gatherers while allowing a specific function within that set. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.GathererConfig"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.insights.v1.DataGather": {
- "description": "DataGather provides data gather configuration options and status for the particular Insights data gathering.\n\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.DataGatherSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.DataGatherStatus"
- }
- }
- },
- "com.github.openshift.api.insights.v1.DataGatherList": {
- "description": "DataGatherList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains a list of DataGather resources.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.DataGather"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.insights.v1.DataGatherSpec": {
- "description": "DataGatherSpec contains the configuration for the DataGather.",
- "type": "object",
- "required": [
- "gatherers"
- ],
- "properties": {
- "dataPolicy": {
- "description": "dataPolicy is an optional list of DataPolicyOptions that allows user to enable additional obfuscation of the Insights archive data. It may not exceed 2 items and must not contain duplicates. Valid values are ObfuscateNetworking and WorkloadNames. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When set to WorkloadNames, the gathered data about cluster resources will not contain the workload names for your deployments. Resources UIDs will be used instead. When omitted no obfuscation is applied.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "gatherers": {
- "description": "gatherers is a required field that specifies the configuration of the gatherers.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.Gatherers"
- },
- "storage": {
- "description": "storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.Storage"
- }
- }
- },
- "com.github.openshift.api.insights.v1.DataGatherStatus": {
- "description": "DataGatherStatus contains information relating to the DataGather state.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is an optional field that provides details on the status of the gatherer job. It may not exceed 100 items and must not contain duplicates.\n\nThe current condition types are DataUploaded, DataRecorded, DataProcessed, RemoteConfigurationNotAvailable, RemoteConfigurationInvalid\n\nThe DataUploaded condition is used to represent whether or not the archive was successfully uploaded for further processing. When it has a status of True and a reason of Succeeded, the archive was successfully uploaded. When it has a status of Unknown and a reason of NoUploadYet, the upload has not occurred, or there was no data to upload. When it has a status of False and a reason Failed, the upload failed. The accompanying message will include the specific error encountered.\n\nThe DataRecorded condition is used to represent whether or not the archive was successfully recorded. When it has a status of True and a reason of Succeeded, the archive was recorded successfully. When it has a status of Unknown and a reason of NoDataGatheringYet, the data gathering process has not started yet. When it has a status of False and a reason of RecordingFailed, the recording failed and a message will include the specific error encountered.\n\nThe DataProcessed condition is used to represent whether or not the archive was processed by the processing service. When it has a status of True and a reason of Processed, the data was processed successfully. When it has a status of Unknown and a reason of NothingToProcessYet, there is no data to process at the moment. When it has a status of False and a reason of Failure, processing failed and a message will include the specific error encountered.\n\nThe RemoteConfigurationAvailable condition is used to represent whether the remote configuration is available. When it has a status of Unknown and a reason of Unknown or RemoteConfigNotRequestedYet, the state of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is available. When it has a status of False and a reason of NoToken, the configuration was disabled by removing the cloud.openshift.com field from the pull secret. When it has a status of False and a reason of DisabledByConfiguration, the configuration was disabled in insightsdatagather.config.openshift.io.\n\nThe RemoteConfigurationValid condition is used to represent whether the remote configuration is valid. When it has a status of Unknown and a reason of Unknown or NoValidationYet, the validity of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is valid. When it has a status of False and a reason of Invalid, the configuration is invalid.\n\nThe Progressing condition is used to represent the phase of gathering When it has a status of False and the reason is DataGatherPending, the gathering has not started yet. When it has a status of True and reason is Gathering, the gathering is running. When it has a status of False and reason is GatheringSucceeded, the gathering successfully finished. When it has a status of False and reason is GatheringFailed, the gathering failed.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "finishTime": {
- "description": "finishTime is the time when Insights data gathering finished.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "gatherers": {
- "description": "gatherers is a list of active gatherers (and their statuses) in the last gathering.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.GathererStatus"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "insightsReport": {
- "description": "insightsReport provides general Insights analysis results. When omitted, this means no data gathering has taken place yet or the corresponding Insights analysis (identified by \"insightsRequestID\") is not available.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.InsightsReport"
- },
- "insightsRequestID": {
- "description": "insightsRequestID is an optional Insights request ID to track the status of the Insights analysis (in console.redhat.com processing pipeline) for the corresponding Insights data archive. It may not exceed 256 characters and is immutable once set.",
- "type": "string"
- },
- "relatedObjects": {
- "description": "relatedObjects is an optional list of resources which are useful when debugging or inspecting the data gathering Pod It may not exceed 100 items and must not contain duplicates.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.ObjectReference"
- },
- "x-kubernetes-list-map-keys": [
- "name",
- "namespace"
- ],
- "x-kubernetes-list-type": "map"
- },
- "startTime": {
- "description": "startTime is the time when Insights data gathering started.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- }
- }
- },
- "com.github.openshift.api.insights.v1.GathererConfig": {
- "description": "GathererConfig allows to configure specific gatherers",
- "type": "object",
- "required": [
- "name",
- "state"
- ],
- "properties": {
- "name": {
- "description": "name is the required name of a specific gatherer. It may not exceed 256 characters. The format for a gatherer name is: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (_). Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/). The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "string"
- },
- "state": {
- "description": "state is a required field that allows you to configure specific gatherer. Valid values are \"Enabled\" and \"Disabled\". When set to Enabled the gatherer will run. When set to Disabled the gatherer will not run.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1.GathererStatus": {
- "description": "GathererStatus represents information about a particular data gatherer.",
- "type": "object",
- "required": [
- "name",
- "lastGatherSeconds"
- ],
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of each gatherer.\n\nThe current condition type is DataGathered\n\nThe DataGathered condition is used to represent whether or not the data was gathered by a gatherer specified by name. When it has a status of True and a reason of GatheredOK, the data has been successfully gathered as expected. When it has a status of False and a reason of NoData, no data was gathered—for example, when the resource is not present in the cluster. When it has a status of False and a reason of GatherError, an error occurred and no data was gathered. When it has a status of False and a reason of GatherPanic, a panic occurred during gathering and no data was collected. When it has a status of False and a reason of GatherWithErrorReason, data was partially gathered or gathered with an error message.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "lastGatherSeconds": {
- "description": "lastGatherSeconds is required field that represents the time spent gathering in seconds",
- "type": "integer",
- "format": "int32"
- },
- "name": {
- "description": "name is the required name of the gatherer. It must contain at least 5 characters and may not exceed 256 characters.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1.Gatherers": {
- "description": "Gatherers specifies the configuration of the gatherers",
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "custom": {
- "description": "custom provides gathering configuration. It is required when mode is Custom, and forbidden otherwise. Custom configuration allows user to disable only a subset of gatherers. Gatherers that are not explicitly disabled in custom configuration will run.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.Custom"
- },
- "mode": {
- "description": "mode is a required field that specifies the mode for gatherers. Allowed values are All and Custom. When set to All, all gatherers will run and gather data. When set to Custom, the custom configuration from the custom field will be applied.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "custom": "Custom"
- }
- }
- ]
- },
- "com.github.openshift.api.insights.v1.HealthCheck": {
- "description": "HealthCheck represents an Insights health check attributes.",
- "type": "object",
- "required": [
- "description",
- "totalRisk",
- "advisorURI"
- ],
- "properties": {
- "advisorURI": {
- "description": "advisorURI is required field that provides the URL link to the Insights Advisor. The link must be a valid HTTPS URL and the maximum length is 2048 characters.",
- "type": "string"
- },
- "description": {
- "description": "description is required field that provides basic description of the healthcheck. It must contain at least 10 characters and may not exceed 2048 characters.",
- "type": "string"
- },
- "totalRisk": {
- "description": "totalRisk is the required field of the healthcheck. It is indicator of the total risk posed by the detected issue; combination of impact and likelihood. Allowed values are Low, Moderate, Important and Critical. The value represents the severity of the issue.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1.InsightsReport": {
- "description": "InsightsReport provides Insights health check report based on the most recently sent Insights data.",
- "type": "object",
- "required": [
- "downloadedTime",
- "uri"
- ],
- "properties": {
- "downloadedTime": {
- "description": "downloadedTime is a required field that specifies when the Insights report was last downloaded.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "healthChecks": {
- "description": "healthChecks is an optional field that provides basic information about active Insights recommendations, which serve as proactive notifications for potential issues in the cluster. When omitted, it means that there are no active recommendations in the cluster.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.HealthCheck"
- },
- "x-kubernetes-list-map-keys": [
- "advisorURI",
- "totalRisk",
- "description"
- ],
- "x-kubernetes-list-type": "map"
- },
- "uri": {
- "description": "uri is a required field that provides the URL link from which the report was downloaded. The link must be a valid HTTPS URL and the maximum length is 2048 characters.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1.ObjectReference": {
- "description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
- "type": "object",
- "required": [
- "group",
- "resource",
- "name",
- "namespace"
- ],
- "properties": {
- "group": {
- "description": "group is required field that specifies the API Group of the Resource. Enter empty string for the core group. This value is empty or it should follow the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start with an alphabetic character and end with an alphanumeric character. Example: \"\", \"apps\", \"build.openshift.io\", etc.",
- "type": "string"
- },
- "name": {
- "description": "name is required field that specifies the referent that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start with an alphabetic character and end with an alphanumeric character..",
- "type": "string"
- },
- "namespace": {
- "description": "namespace if required field of the referent that follows the DNS1123 labels format. It must be at most 63 characters in length, and must must consist of only lowercase alphanumeric characters and hyphens, and must start with an alphabetic character and end with an alphanumeric character.",
- "type": "string"
- },
- "resource": {
- "description": "resource is required field of the type that is being referenced and follows the DNS1035 format. It is normally the plural form of the resource kind in lowercase. It must be at most 63 characters in length, and must must consist of only lowercase alphanumeric characters and hyphens, and must start with an alphabetic character and end with an alphanumeric character. Example: \"deployments\", \"deploymentconfigs\", \"pods\", etc.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1.PersistentVolumeClaimReference": {
- "description": "PersistentVolumeClaimReference is a reference to a PersistentVolumeClaim.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the PersistentVolumeClaim that will be used to store the Insights data archive. It is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1.PersistentVolumeConfig": {
- "description": "PersistentVolumeConfig provides configuration options for PersistentVolume storage.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.PersistentVolumeClaimReference"
- },
- "mountPath": {
- "description": "mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1.Storage": {
- "description": "Storage provides persistent storage configuration options for gathering jobs. If the type is set to PersistentVolume, then the PersistentVolume must be defined. If the type is set to Ephemeral, then the PersistentVolume must not be defined.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "persistentVolume": {
- "description": "persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1.PersistentVolumeConfig"
- },
- "type": {
- "description": "type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are \"PersistentVolume\" and \"Ephemeral\". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the PersistentVolume field.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "persistentVolume": "PersistentVolume"
- }
- }
- ]
- },
- "com.github.openshift.api.insights.v1alpha1.DataGather": {
- "description": "DataGather provides data gather configuration options and status for the particular Insights data gathering.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.DataGatherSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.DataGatherStatus"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.DataGatherList": {
- "description": "DataGatherList is a collection of items\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains a list of DataGather resources.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.DataGather"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.DataGatherSpec": {
- "description": "DataGatherSpec contains the configuration for the DataGather.",
- "type": "object",
- "properties": {
- "dataPolicy": {
- "description": "dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain in the Insights archive data. Valid values are \"ClearText\" and \"ObfuscateNetworking\". When set to ClearText the data is not obfuscated. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is ClearText.",
- "type": "string",
- "default": ""
- },
- "gatherers": {
- "description": "gatherers is an optional list of gatherers configurations. The list must not exceed 100 items. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.GathererConfig"
- }
- },
- "storage": {
- "description": "storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.",
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.Storage"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.DataGatherStatus": {
- "description": "DataGatherStatus contains information relating to the DataGather state.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of the gatherer job.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "dataGatherState": {
- "description": "dataGatherState reflects the current state of the data gathering process.",
- "type": "string"
- },
- "finishTime": {
- "description": "finishTime is the time when Insights data gathering finished.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "gatherers": {
- "description": "gatherers is a list of active gatherers (and their statuses) in the last gathering.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.GathererStatus"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "insightsReport": {
- "description": "insightsReport provides general Insights analysis results. When omitted, this means no data gathering has taken place yet or the corresponding Insights analysis (identified by \"insightsRequestID\") is not available.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.InsightsReport"
- },
- "insightsRequestID": {
- "description": "insightsRequestID is an Insights request ID to track the status of the Insights analysis (in console.redhat.com processing pipeline) for the corresponding Insights data archive.",
- "type": "string"
- },
- "relatedObjects": {
- "description": "relatedObjects is a list of resources which are useful when debugging or inspecting the data gathering Pod",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.ObjectReference"
- }
- },
- "startTime": {
- "description": "startTime is the time when Insights data gathering started.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.GathererConfig": {
- "description": "gathererConfig allows to configure specific gatherers",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the required name of specific gatherer It must be at most 256 characters in length. The format for the gatherer name should be: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (_). Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/). The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.",
- "type": "string",
- "default": ""
- },
- "state": {
- "description": "state allows you to configure specific gatherer. Valid values are \"Enabled\", \"Disabled\" and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default. The current default is Enabled.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.GathererStatus": {
- "description": "gathererStatus represents information about a particular data gatherer.",
- "type": "object",
- "required": [
- "conditions",
- "name",
- "lastGatherDuration"
- ],
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of each gatherer.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "lastGatherDuration": {
- "description": "lastGatherDuration represents the time spent gathering.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "name": {
- "description": "name is the name of the gatherer.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.HealthCheck": {
- "description": "healthCheck represents an Insights health check attributes.",
- "type": "object",
- "required": [
- "description",
- "totalRisk",
- "advisorURI",
- "state"
- ],
- "properties": {
- "advisorURI": {
- "description": "advisorURI is required field that provides the URL link to the Insights Advisor. The link must be a valid HTTPS URL and the maximum length is 2048 characters.",
- "type": "string",
- "default": ""
- },
- "description": {
- "description": "description provides basic description of the healtcheck.",
- "type": "string",
- "default": ""
- },
- "state": {
- "description": "state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor user interface.",
- "type": "string",
- "default": ""
- },
- "totalRisk": {
- "description": "totalRisk of the healthcheck. Indicator of the total risk posed by the detected issue; combination of impact and likelihood. The values can be from 1 to 4, and the higher the number, the more important the issue.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.InsightsReport": {
- "description": "insightsReport provides Insights health check report based on the most recently sent Insights data.",
- "type": "object",
- "properties": {
- "downloadedAt": {
- "description": "downloadedAt is the time when the last Insights report was downloaded. An empty value means that there has not been any Insights report downloaded yet and it usually appears in disconnected clusters (or clusters when the Insights data gathering is disabled).",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "healthChecks": {
- "description": "healthChecks provides basic information about active Insights health checks in a cluster.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.HealthCheck"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "uri": {
- "description": "uri is optional field that provides the URL link from which the report was downloaded. The link must be a valid HTTPS URL and the maximum length is 2048 characters.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.ObjectReference": {
- "description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
- "type": "object",
- "required": [
- "group",
- "resource",
- "name"
- ],
- "properties": {
- "group": {
- "description": "group is the API Group of the Resource. Enter empty string for the core group. This value is empty or should follow the DNS1123 subdomain format and it must be at most 253 characters in length. Example: \"\", \"apps\", \"build.openshift.io\", etc.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name of the referent that follows the DNS1123 subdomain format. It must be at most 256 characters in length.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace of the referent that follows the DNS1123 subdomain format. It must be at most 253 characters in length.",
- "type": "string"
- },
- "resource": {
- "description": "resource is required field of the type that is being referenced. It is normally the plural form of the resource kind in lowercase. This value should consist of only lowercase alphanumeric characters and hyphens. Example: \"deployments\", \"deploymentconfigs\", \"pods\", etc.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.PersistentVolumeClaimReference": {
- "description": "persistentVolumeClaimReference is a reference to a PersistentVolumeClaim.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.PersistentVolumeConfig": {
- "description": "persistentVolumeConfig provides configuration options for PersistentVolume storage.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.PersistentVolumeClaimReference"
- },
- "mountPath": {
- "description": "mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha1.Storage": {
- "description": "storage provides persistent storage configuration options for gathering jobs. If the type is set to PersistentVolume, then the PersistentVolume must be defined. If the type is set to Ephemeral, then the PersistentVolume must not be defined.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "persistentVolume": {
- "description": "persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.",
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha1.PersistentVolumeConfig"
- },
- "type": {
- "description": "type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are \"PersistentVolume\" and \"Ephemeral\". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the PersistentVolume field.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.Custom": {
- "description": "custom provides the custom configuration of gatherers",
- "type": "object",
- "required": [
- "configs"
- ],
- "properties": {
- "configs": {
- "description": "configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers. It may not exceed 100 items and each gatherer can be present only once. It is possible to disable an entire set of gatherers while allowing a specific function within that set. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.GathererConfig"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.DataGather": {
- "description": "DataGather provides data gather configuration options and status for the particular Insights data gathering.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.DataGatherSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.DataGatherStatus"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.DataGatherList": {
- "description": "DataGatherList is a collection of items\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains a list of DataGather resources.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.DataGather"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.DataGatherSpec": {
- "description": "DataGatherSpec contains the configuration for the DataGather.",
- "type": "object",
- "properties": {
- "dataPolicy": {
- "description": "dataPolicy is an optional list of DataPolicyOptions that allows user to enable additional obfuscation of the Insights archive data. It may not exceed 2 items and must not contain duplicates. Valid values are ObfuscateNetworking and WorkloadNames. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When set to WorkloadNames, the gathered data about cluster resources will not contain the workload names for your deployments. Resources UIDs will be used instead. When omitted no obfuscation is applied.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "gatherers": {
- "description": "gatherers is an optional field that specifies the configuration of the gatherers. If omitted, all gatherers will be run.",
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.Gatherers"
- },
- "storage": {
- "description": "storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.",
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.Storage"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.DataGatherStatus": {
- "description": "DataGatherStatus contains information relating to the DataGather state.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is an optional field that provides details on the status of the gatherer job. It may not exceed 100 items and must not contain duplicates.\n\nThe current condition types are DataUploaded, DataRecorded, DataProcessed, RemoteConfigurationNotAvailable, RemoteConfigurationInvalid\n\nThe DataUploaded condition is used to represent whether or not the archive was successfully uploaded for further processing. When it has a status of True and a reason of Succeeded, the archive was successfully uploaded. When it has a status of Unknown and a reason of NoUploadYet, the upload has not occurred, or there was no data to upload. When it has a status of False and a reason Failed, the upload failed. The accompanying message will include the specific error encountered.\n\nThe DataRecorded condition is used to represent whether or not the archive was successfully recorded. When it has a status of True and a reason of Succeeded, the archive was recorded successfully. When it has a status of Unknown and a reason of NoDataGatheringYet, the data gathering process has not started yet. When it has a status of False and a reason of RecordingFailed, the recording failed and a message will include the specific error encountered.\n\nThe DataProcessed condition is used to represent whether or not the archive was processed by the processing service. When it has a status of True and a reason of Processed, the data was processed successfully. When it has a status of Unknown and a reason of NothingToProcessYet, there is no data to process at the moment. When it has a status of False and a reason of Failure, processing failed and a message will include the specific error encountered.\n\nThe RemoteConfigurationAvailable condition is used to represent whether the remote configuration is available. When it has a status of Unknown and a reason of Unknown or RemoteConfigNotRequestedYet, the state of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is available. When it has a status of False and a reason of NoToken, the configuration was disabled by removing the cloud.openshift.com field from the pull secret. When it has a status of False and a reason of DisabledByConfiguration, the configuration was disabled in insightsdatagather.config.openshift.io.\n\nThe RemoteConfigurationValid condition is used to represent whether the remote configuration is valid. When it has a status of Unknown and a reason of Unknown or NoValidationYet, the validity of the remote configuration is unknown—typically at startup. When it has a status of True and a reason of Succeeded, the configuration is valid. When it has a status of False and a reason of Invalid, the configuration is invalid.\n\nThe Progressing condition is used to represent the phase of gathering When it has a status of False and the reason is DataGatherPending, the gathering has not started yet. When it has a status of True and reason is Gathering, the gathering is running. When it has a status of False and reason is GatheringSucceeded, the gathering succesfully finished. When it has a status of False and reason is GatheringFailed, the gathering failed.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "finishTime": {
- "description": "finishTime is the time when Insights data gathering finished.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "gatherers": {
- "description": "gatherers is a list of active gatherers (and their statuses) in the last gathering.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.GathererStatus"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "insightsReport": {
- "description": "insightsReport provides general Insights analysis results. When omitted, this means no data gathering has taken place yet or the corresponding Insights analysis (identified by \"insightsRequestID\") is not available.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.InsightsReport"
- },
- "insightsRequestID": {
- "description": "insightsRequestID is an optional Insights request ID to track the status of the Insights analysis (in console.redhat.com processing pipeline) for the corresponding Insights data archive. It may not exceed 256 characters and is immutable once set.",
- "type": "string"
- },
- "relatedObjects": {
- "description": "relatedObjects is an optional list of resources which are useful when debugging or inspecting the data gathering Pod It may not exceed 100 items and must not contain duplicates.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.ObjectReference"
- },
- "x-kubernetes-list-map-keys": [
- "name",
- "namespace"
- ],
- "x-kubernetes-list-type": "map"
- },
- "startTime": {
- "description": "startTime is the time when Insights data gathering started.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.GathererConfig": {
- "description": "gathererConfig allows to configure specific gatherers",
- "type": "object",
- "required": [
- "name",
- "state"
- ],
- "properties": {
- "name": {
- "description": "name is the required name of a specific gatherer It may not exceed 256 characters. The format for a gatherer name is: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (_). Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/). The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
- "type": "string",
- "default": ""
- },
- "state": {
- "description": "state is a required field that allows you to configure specific gatherer. Valid values are \"Enabled\" and \"Disabled\". When set to Enabled the gatherer will run. When set to Disabled the gatherer will not run.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.GathererStatus": {
- "description": "gathererStatus represents information about a particular data gatherer.",
- "type": "object",
- "required": [
- "name",
- "lastGatherSeconds"
- ],
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of each gatherer.\n\nThe current condition type is DataGathered\n\nThe DataGathered condition is used to represent whether or not the data was gathered by a gatherer specified by name. When it has a status of True and a reason of GatheredOK, the data has been successfully gathered as expected. When it has a status of False and a reason of NoData, no data was gathered—for example, when the resource is not present in the cluster. When it has a status of False and a reason of GatherError, an error occurred and no data was gathered. When it has a status of False and a reason of GatherPanic, a panic occurred during gathering and no data was collected. When it has a status of False and a reason of GatherWithErrorReason, data was partially gathered or gathered with an error message.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "lastGatherSeconds": {
- "description": "lastGatherSeconds is required field that represents the time spent gathering in seconds",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "name": {
- "description": "name is the required name of the gatherer. It must contain at least 5 characters and may not exceed 256 characters.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.Gatherers": {
- "description": "Gathereres specifies the configuration of the gatherers",
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "custom": {
- "description": "custom provides gathering configuration. It is required when mode is Custom, and forbidden otherwise. Custom configuration allows user to disable only a subset of gatherers. Gatherers that are not explicitly disabled in custom configuration will run.",
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.Custom"
- },
- "mode": {
- "description": "mode is a required field that specifies the mode for gatherers. Allowed values are All and Custom. When set to All, all gatherers wil run and gather data. When set to Custom, the custom configuration from the custom field will be applied.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "custom": "Custom"
- }
- }
- ]
- },
- "com.github.openshift.api.insights.v1alpha2.HealthCheck": {
- "description": "healthCheck represents an Insights health check attributes.",
- "type": "object",
- "required": [
- "description",
- "totalRisk",
- "advisorURI"
- ],
- "properties": {
- "advisorURI": {
- "description": "advisorURI is required field that provides the URL link to the Insights Advisor. The link must be a valid HTTPS URL and the maximum length is 2048 characters.",
- "type": "string",
- "default": ""
- },
- "description": {
- "description": "description is required field that provides basic description of the healtcheck. It must contain at least 10 characters and may not exceed 2048 characters.",
- "type": "string",
- "default": ""
- },
- "totalRisk": {
- "description": "totalRisk is the required field of the healthcheck. It is indicator of the total risk posed by the detected issue; combination of impact and likelihood. Allowed values are Low, Medium, Important and Critical. The value represents the severity of the issue.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.InsightsReport": {
- "description": "insightsReport provides Insights health check report based on the most recently sent Insights data.",
- "type": "object",
- "properties": {
- "downloadedTime": {
- "description": "downloadedTime is an optional time when the last Insights report was downloaded. An empty value means that there has not been any Insights report downloaded yet and it usually appears in disconnected clusters (or clusters when the Insights data gathering is disabled).",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "healthChecks": {
- "description": "healthChecks provides basic information about active Insights health checks in a cluster.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.HealthCheck"
- },
- "x-kubernetes-list-map-keys": [
- "advisorURI",
- "totalRisk",
- "description"
- ],
- "x-kubernetes-list-type": "map"
- },
- "uri": {
- "description": "uri is optional field that provides the URL link from which the report was downloaded. The link must be a valid HTTPS URL and the maximum length is 2048 characters.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.ObjectReference": {
- "description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
- "type": "object",
- "required": [
- "group",
- "resource",
- "name",
- "namespace"
- ],
- "properties": {
- "group": {
- "description": "group is required field that specifies the API Group of the Resource. Enter empty string for the core group. This value is empty or it should follow the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start with an alphabetic character and end with an alphanumeric character. Example: \"\", \"apps\", \"build.openshift.io\", etc.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is required field that specifies the referent that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start with an alphabetic character and end with an alphanumeric character..",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace if required field of the referent that follows the DNS1123 labels format. It must be at most 63 characters in length, and must must consist of only lowercase alphanumeric characters and hyphens, and must start with an alphabetic character and end with an alphanumeric character.",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is required field of the type that is being referenced and follows the DNS1035 format. It is normally the plural form of the resource kind in lowercase. It must be at most 63 characters in length, and must must consist of only lowercase alphanumeric characters and hyphens, and must start with an alphabetic character and end with an alphanumeric character. Example: \"deployments\", \"deploymentconfigs\", \"pods\", etc.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.PersistentVolumeClaimReference": {
- "description": "persistentVolumeClaimReference is a reference to a PersistentVolumeClaim.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.PersistentVolumeConfig": {
- "description": "persistentVolumeConfig provides configuration options for PersistentVolume storage.",
- "type": "object",
- "required": [
- "claim"
- ],
- "properties": {
- "claim": {
- "description": "claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.PersistentVolumeClaimReference"
- },
- "mountPath": {
- "description": "mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.insights.v1alpha2.Storage": {
- "description": "storage provides persistent storage configuration options for gathering jobs. If the type is set to PersistentVolume, then the PersistentVolume must be defined. If the type is set to Ephemeral, then the PersistentVolume must not be defined.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "persistentVolume": {
- "description": "persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.",
- "$ref": "#/definitions/com.github.openshift.api.insights.v1alpha2.PersistentVolumeConfig"
- },
- "type": {
- "description": "type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are \"PersistentVolume\" and \"Ephemeral\". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the PersistentVolume field.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "persistentVolume": "PersistentVolume"
- }
- }
- ]
- },
- "com.github.openshift.api.kubecontrolplane.v1.AggregatorConfig": {
- "description": "AggregatorConfig holds information required to make the aggregator function.",
- "type": "object",
- "required": [
- "proxyClientInfo"
- ],
- "properties": {
- "proxyClientInfo": {
- "description": "proxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CertInfo"
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.KubeAPIServerConfig": {
- "description": "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "servingInfo",
- "corsAllowedOrigins",
- "auditConfig",
- "storageConfig",
- "admission",
- "kubeClientConfig",
- "authConfig",
- "aggregatorConfig",
- "kubeletClientInfo",
- "servicesSubnet",
- "servicesNodePortRange",
- "consolePublicURL",
- "userAgentMatchingConfig",
- "imagePolicyConfig",
- "projectConfig",
- "serviceAccountPublicKeyFiles",
- "oauthConfig",
- "apiServerArguments"
- ],
- "properties": {
- "admission": {
- "description": "admissionConfig holds information about how to configure admission.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AdmissionConfig"
- },
- "aggregatorConfig": {
- "description": "aggregatorConfig has options for configuring the aggregator component of the API server.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.AggregatorConfig"
- },
- "apiServerArguments": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "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",
- "type": "string"
- },
- "auditConfig": {
- "description": "auditConfig describes how to configure audit information",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AuditConfig"
- },
- "authConfig": {
- "description": "authConfig configures authentication options in addition to the standard oauth token and client certificate authenticators",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.MasterAuthConfig"
- },
- "consolePublicURL": {
- "description": "DEPRECATED: consolePublicURL has been deprecated and setting it has no effect.",
- "type": "string",
- "default": ""
- },
- "corsAllowedOrigins": {
- "description": "corsAllowedOrigins",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "imagePolicyConfig": {
- "description": "imagePolicyConfig feeds the image policy admission plugin",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.KubeAPIServerImagePolicyConfig"
- },
- "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",
- "type": "string"
- },
- "kubeClientConfig": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KubeClientConfig"
- },
- "kubeletClientInfo": {
- "description": "kubeletClientInfo contains information about how to connect to kubelets",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.KubeletConnectionInfo"
- },
- "minimumKubeletVersion": {
- "description": "minimumKubeletVersion is the lowest version of a kubelet that can join the cluster. Specifically, the apiserver will deny most authorization requests of kubelets that are older than the specified version, only allowing the kubelet to get and update its node object, and perform subjectaccessreviews. This means any kubelet that attempts to join the cluster will not be able to run any assigned workloads, and will eventually be marked as not ready. Its max length is 8, so maximum version allowed is either \"9.999.99\" or \"99.99.99\". Since the kubelet reports the version of the kubernetes release, not Openshift, this field references the underlying kubernetes version this version of Openshift is based off of. In other words: if an admin wishes to ensure no nodes run an older version than Openshift 4.17, then they should set the minimumKubeletVersion to 1.30.0. When comparing versions, the kubelet's version is stripped of any contents outside of major.minor.patch version. Thus, a kubelet with version \"1.0.0-ec.0\" will be compatible with minimumKubeletVersion \"1.0.0\" or earlier.",
- "type": "string",
- "default": ""
- },
- "oauthConfig": {
- "description": "oauthConfig, if present start the /oauth endpoint in this process",
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.OAuthConfig"
- },
- "projectConfig": {
- "description": "projectConfig feeds an admission plugin",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.KubeAPIServerProjectConfig"
- },
- "serviceAccountPublicKeyFiles": {
- "description": "serviceAccountPublicKeyFiles is a list of files, each containing a PEM-encoded public RSA key. (If any file contains a private key, the public portion of the key is used) The list of public keys is used to verify presented service account tokens. Each key is tried in order until the list is exhausted or verification succeeds. If no keys are specified, no service account authentication will be available.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "servicesNodePortRange": {
- "description": "servicesNodePortRange is the range to use for assigning service public ports on a host.",
- "type": "string",
- "default": ""
- },
- "servicesSubnet": {
- "description": "servicesSubnet is the subnet to use for assigning service IPs",
- "type": "string",
- "default": ""
- },
- "servingInfo": {
- "description": "servingInfo describes how to start serving",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
- },
- "storageConfig": {
- "description": "storageConfig contains information about how to use",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.EtcdStorageConfig"
- },
- "userAgentMatchingConfig": {
- "description": "userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.UserAgentMatchingConfig"
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.KubeAPIServerImagePolicyConfig": {
- "type": "object",
- "required": [
- "internalRegistryHostname",
- "externalRegistryHostnames"
- ],
- "properties": {
- "externalRegistryHostnames": {
- "description": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "internalRegistryHostname": {
- "description": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.KubeAPIServerProjectConfig": {
- "type": "object",
- "required": [
- "defaultNodeSelector"
- ],
- "properties": {
- "defaultNodeSelector": {
- "description": "defaultNodeSelector holds default project node label selector",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.KubeControllerManagerConfig": {
- "description": "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "serviceServingCert",
- "projectConfig",
- "extendedArguments"
- ],
- "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",
- "type": "string"
- },
- "extendedArguments": {
- "description": "extendedArguments is used to configure the kube-controller-manager",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "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",
- "type": "string"
- },
- "projectConfig": {
- "description": "projectConfig is an optimization for the daemonset controller",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.KubeControllerManagerProjectConfig"
- },
- "serviceServingCert": {
- "description": "serviceServingCert provides support for the old alpha service serving cert signer CA bundle",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.ServiceServingCert"
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.KubeControllerManagerProjectConfig": {
- "type": "object",
- "required": [
- "defaultNodeSelector"
- ],
- "properties": {
- "defaultNodeSelector": {
- "description": "defaultNodeSelector holds default project node label selector",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.KubeletConnectionInfo": {
- "description": "KubeletConnectionInfo holds information necessary for connecting to a kubelet",
- "type": "object",
- "required": [
- "port",
- "ca",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "ca": {
- "description": "ca is the CA for verifying TLS connections to kubelets",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "port": {
- "description": "port is the port to connect to kubelets on",
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.MasterAuthConfig": {
- "description": "MasterAuthConfig configures authentication options in addition to the standard oauth token and client certificate authenticators",
- "type": "object",
- "required": [
- "requestHeader",
- "webhookTokenAuthenticators",
- "oauthMetadataFile"
- ],
- "properties": {
- "oauthMetadataFile": {
- "description": "oauthMetadataFile is a path to a file containing the discovery endpoint for OAuth 2.0 Authorization Server Metadata for an external OAuth server. See IETF Draft: // https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This option is mutually exclusive with OAuthConfig",
- "type": "string",
- "default": ""
- },
- "requestHeader": {
- "description": "requestHeader holds options for setting up a front proxy against the API. It is optional.",
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.RequestHeaderAuthenticationOptions"
- },
- "webhookTokenAuthenticators": {
- "description": "webhookTokenAuthenticators, if present configures remote token reviewers",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.WebhookTokenAuthenticator"
- }
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.RequestHeaderAuthenticationOptions": {
- "description": "RequestHeaderAuthenticationOptions provides options for setting up a front proxy against the entire API instead of against the /oauth endpoint.",
- "type": "object",
- "required": [
- "clientCA",
- "clientCommonNames",
- "usernameHeaders",
- "groupHeaders",
- "extraHeaderPrefixes"
- ],
- "properties": {
- "clientCA": {
- "description": "clientCA is a file with the trusted signer certs. It is required.",
- "type": "string",
- "default": ""
- },
- "clientCommonNames": {
- "description": "clientCommonNames is a required list of common names to require a match from.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "extraHeaderPrefixes": {
- "description": "extraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groupHeaders": {
- "description": "groupHeaders is the set of headers to check for group information. All are unioned.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "usernameHeaders": {
- "description": "usernameHeaders is the list of headers to check for user information. First hit wins.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.ServiceServingCert": {
- "description": "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.",
- "type": "object",
- "required": [
- "certFile"
- ],
- "properties": {
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.UserAgentDenyRule": {
- "description": "UserAgentDenyRule adds a rejection message that can be used to help a user figure out how to get an approved client",
- "type": "object",
- "required": [
- "regex",
- "httpVerbs",
- "rejectionMessage"
- ],
- "properties": {
- "httpVerbs": {
- "description": "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "regex": {
- "description": "regex is a regex that is checked against the User-Agent. Known variants of oc clients 1. oc accessing kube resources: oc/v1.2.0 (linux/amd64) kubernetes/bc4550d 2. oc accessing openshift resources: oc/v1.1.3 (linux/amd64) openshift/b348c2f 3. openshift kubectl accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 4. openshift kubectl accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f 5. oadm accessing kube resources: oadm/v1.2.0 (linux/amd64) kubernetes/bc4550d 6. oadm accessing openshift resources: oadm/v1.1.3 (linux/amd64) openshift/b348c2f 7. openshift cli accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 8. openshift cli accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f",
- "type": "string",
- "default": ""
- },
- "rejectionMessage": {
- "description": "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.UserAgentMatchRule": {
- "description": "UserAgentMatchRule describes how to match a given request based on User-Agent and HTTPVerb",
- "type": "object",
- "required": [
- "regex",
- "httpVerbs"
- ],
- "properties": {
- "httpVerbs": {
- "description": "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "regex": {
- "description": "regex is a regex that is checked against the User-Agent. Known variants of oc clients 1. oc accessing kube resources: oc/v1.2.0 (linux/amd64) kubernetes/bc4550d 2. oc accessing openshift resources: oc/v1.1.3 (linux/amd64) openshift/b348c2f 3. openshift kubectl accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 4. openshift kubectl accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f 5. oadm accessing kube resources: oadm/v1.2.0 (linux/amd64) kubernetes/bc4550d 6. oadm accessing openshift resources: oadm/v1.1.3 (linux/amd64) openshift/b348c2f 7. openshift cli accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 8. openshift cli accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.UserAgentMatchingConfig": {
- "description": "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!",
- "type": "object",
- "required": [
- "requiredClients",
- "deniedClients",
- "defaultRejectionMessage"
- ],
- "properties": {
- "defaultRejectionMessage": {
- "description": "defaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.",
- "type": "string",
- "default": ""
- },
- "deniedClients": {
- "description": "deniedClients if this list is non-empty, then a User-Agent must not match any of the UserAgentRegexes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.UserAgentDenyRule"
- }
- },
- "requiredClients": {
- "description": "requiredClients if this list is non-empty, then a User-Agent must match one of the UserAgentRegexes to be allowed",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.kubecontrolplane.v1.UserAgentMatchRule"
- }
- }
- }
- },
- "com.github.openshift.api.kubecontrolplane.v1.WebhookTokenAuthenticator": {
- "description": "WebhookTokenAuthenticators holds the necessary configuation options for external token authenticators",
- "type": "object",
- "required": [
- "configFile",
- "cacheTTL"
- ],
- "properties": {
- "cacheTTL": {
- "description": "cacheTTL indicates how long an authentication result should be cached. It takes a valid time duration string (e.g. \"5m\"). If empty, you get a default timeout of 2 minutes. If zero (e.g. \"0m\"), caching is disabled",
- "type": "string",
- "default": ""
- },
- "configFile": {
- "description": "configFile is a path to a Kubeconfig file with the webhook configuration",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ActiveDirectoryConfig": {
- "description": "ActiveDirectoryConfig holds the necessary configuration options to define how an LDAP group sync interacts with an LDAP server using the Active Directory schema",
- "type": "object",
- "required": [
- "usersQuery",
- "userNameAttributes",
- "groupMembershipAttributes"
- ],
- "properties": {
- "groupMembershipAttributes": {
- "description": "groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "userNameAttributes": {
- "description": "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "usersQuery": {
- "description": "AllUsersQuery holds the template for an LDAP query that returns user entries.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LDAPQuery"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.AdmissionConfig": {
- "description": "AdmissionConfig holds the necessary configuration options for admission",
- "type": "object",
- "required": [
- "pluginConfig"
- ],
- "properties": {
- "pluginConfig": {
- "description": "pluginConfig allows specifying a configuration file per admission control plugin",
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.AdmissionPluginConfig"
- }
- },
- "pluginOrderOverride": {
- "description": "pluginOrderOverride is a list of admission control plugin names that will be installed on the master. Order is significant. If empty, a default list of plugins is used.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.AdmissionPluginConfig": {
- "description": "AdmissionPluginConfig holds the necessary configuration options for admission plugins",
- "type": "object",
- "required": [
- "location",
- "configuration"
- ],
- "properties": {
- "configuration": {
- "description": "configuration is an embedded configuration object to be used as the plugin's configuration. If present, it will be used instead of the path to the configuration file.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "location": {
- "description": "location is the path to a configuration file that contains the plugin's configuration",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.AggregatorConfig": {
- "description": "AggregatorConfig holds information required to make the aggregator function.",
- "type": "object",
- "required": [
- "proxyClientInfo"
- ],
- "properties": {
- "proxyClientInfo": {
- "description": "proxyClientInfo specifies the client cert/key to use when proxying to aggregated API servers",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.CertInfo"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.AllowAllPasswordIdentityProvider": {
- "description": "AllowAllPasswordIdentityProvider provides identities for users authenticating using non-empty passwords\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "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",
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.AuditConfig": {
- "description": "AuditConfig holds configuration for the audit capabilities",
- "type": "object",
- "required": [
- "enabled",
- "auditFilePath",
- "maximumFileRetentionDays",
- "maximumRetainedFiles",
- "maximumFileSizeMegabytes",
- "policyFile",
- "policyConfiguration",
- "logFormat",
- "webHookKubeConfig",
- "webHookMode"
- ],
- "properties": {
- "auditFilePath": {
- "description": "All requests coming to the apiserver will be logged to this file.",
- "type": "string",
- "default": ""
- },
- "enabled": {
- "description": "If this flag is set, audit log will be printed in the logs. The logs contains, method, user and a requested URL.",
- "type": "boolean",
- "default": false
- },
- "logFormat": {
- "description": "Format of saved audits (legacy or json).",
- "type": "string",
- "default": ""
- },
- "maximumFileRetentionDays": {
- "description": "Maximum number of days to retain old log files based on the timestamp encoded in their filename.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "maximumFileSizeMegabytes": {
- "description": "Maximum size in megabytes of the log file before it gets rotated. Defaults to 100MB.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "maximumRetainedFiles": {
- "description": "Maximum number of old log files to retain.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "policyConfiguration": {
- "description": "policyConfiguration is an embedded policy configuration object to be used as the audit policy configuration. If present, it will be used instead of the path to the policy file.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "policyFile": {
- "description": "policyFile is a path to the file that defines the audit policy configuration.",
- "type": "string",
- "default": ""
- },
- "webHookKubeConfig": {
- "description": "Path to a .kubeconfig formatted file that defines the audit webhook configuration.",
- "type": "string",
- "default": ""
- },
- "webHookMode": {
- "description": "Strategy for sending audit events (block or batch).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.AugmentedActiveDirectoryConfig": {
- "description": "AugmentedActiveDirectoryConfig holds the necessary configuration options to define how an LDAP group sync interacts with an LDAP server using the augmented Active Directory schema",
- "type": "object",
- "required": [
- "usersQuery",
- "userNameAttributes",
- "groupMembershipAttributes",
- "groupsQuery",
- "groupUIDAttribute",
- "groupNameAttributes"
- ],
- "properties": {
- "groupMembershipAttributes": {
- "description": "groupMembershipAttributes defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groupNameAttributes": {
- "description": "groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groupUIDAttribute": {
- "description": "GroupUIDAttributes defines which attribute on an LDAP group entry will be interpreted as its unique identifier. (ldapGroupUID)",
- "type": "string",
- "default": ""
- },
- "groupsQuery": {
- "description": "AllGroupsQuery holds the template for an LDAP query that returns group entries.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LDAPQuery"
- },
- "userNameAttributes": {
- "description": "userNameAttributes defines which attributes on an LDAP user entry will be interpreted as its OpenShift user name.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "usersQuery": {
- "description": "AllUsersQuery holds the template for an LDAP query that returns user entries.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LDAPQuery"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.BasicAuthPasswordIdentityProvider": {
- "description": "BasicAuthPasswordIdentityProvider provides identities for users authenticating using HTTP basic auth credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "url",
- "ca",
- "certFile",
- "keyFile"
- ],
- "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",
- "type": "string"
- },
- "ca": {
- "description": "ca is the CA for verifying TLS connections",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- },
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.BuildDefaultsConfig": {
- "description": "BuildDefaultsConfig controls the default information for Builds\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "properties": {
- "annotations": {
- "description": "annotations are annotations that will be added to the build pod",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "env": {
- "description": "env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "gitHTTPProxy": {
- "description": "gitHTTPProxy is the location of the HTTPProxy for Git source",
- "type": "string"
- },
- "gitHTTPSProxy": {
- "description": "gitHTTPSProxy is the location of the HTTPSProxy for Git source",
- "type": "string"
- },
- "gitNoProxy": {
- "description": "gitNoProxy is the list of domains for which the proxy should not be used",
- "type": "string"
- },
- "imageLabels": {
- "description": "imageLabels is a list of labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageLabel"
- }
- },
- "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",
- "type": "string"
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "resources": {
- "description": "resources defines resource requirements to execute the build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
- },
- "sourceStrategyDefaults": {
- "description": "sourceStrategyDefaults are default values that apply to builds using the source strategy.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.SourceStrategyDefaultsConfig"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.BuildOverridesConfig": {
- "description": "BuildOverridesConfig controls override settings for builds\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "forcePull"
- ],
- "properties": {
- "annotations": {
- "description": "annotations are annotations that will be added to the build pod",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "forcePull": {
- "description": "forcePull indicates whether the build strategy should always be set to ForcePull=true",
- "type": "boolean",
- "default": false
- },
- "imageLabels": {
- "description": "imageLabels is a list of labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user's label will be overwritten.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageLabel"
- }
- },
- "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",
- "type": "string"
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "tolerations": {
- "description": "tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.CertInfo": {
- "description": "CertInfo relates a certificate with a private key",
- "type": "object",
- "required": [
- "certFile",
- "keyFile"
- ],
- "properties": {
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ClientConnectionOverrides": {
- "description": "ClientConnectionOverrides are a set of overrides to the default client connection settings.",
- "type": "object",
- "required": [
- "acceptContentTypes",
- "contentType",
- "qps",
- "burst"
- ],
- "properties": {
- "acceptContentTypes": {
- "description": "acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular client.",
- "type": "string",
- "default": ""
- },
- "burst": {
- "description": "burst allows extra queries to accumulate when a client is exceeding its rate.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "contentType": {
- "description": "contentType is the content type used when sending data to the server from this client.",
- "type": "string",
- "default": ""
- },
- "qps": {
- "description": "qps controls the number of queries per second allowed for this connection.",
- "type": "number",
- "format": "float",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ClusterNetworkEntry": {
- "description": "ClusterNetworkEntry defines an individual cluster network. The CIDRs cannot overlap with other cluster network CIDRs, CIDRs reserved for external ips, CIDRs reserved for service networks, and CIDRs reserved for ingress ips.",
- "type": "object",
- "required": [
- "cidr",
- "hostSubnetLength"
- ],
- "properties": {
- "cidr": {
- "description": "cidr defines the total range of a cluster networks address space.",
- "type": "string",
- "default": ""
- },
- "hostSubnetLength": {
- "description": "hostSubnetLength is the number of bits of the accompanying CIDR address to allocate to each node. eg, 8 would mean that each node would have a /24 slice of the overlay network for its pod.",
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ControllerConfig": {
- "description": "ControllerConfig holds configuration values for controllers",
- "type": "object",
- "required": [
- "controllers",
- "election",
- "serviceServingCert"
- ],
- "properties": {
- "controllers": {
- "description": "controllers is a list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller \"+ named 'foo', '-foo' disables the controller named 'foo'. Defaults to \"*\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "election": {
- "description": "election defines the configuration for electing a controller instance to make changes to the cluster. If unspecified, the ControllerTTL value is checked to determine whether the legacy direct etcd election code will be used.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ControllerElectionConfig"
- },
- "serviceServingCert": {
- "description": "serviceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ServiceServingCert"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ControllerElectionConfig": {
- "description": "ControllerElectionConfig contains configuration values for deciding how a controller will be elected to act as leader.",
- "type": "object",
- "required": [
- "lockName",
- "lockNamespace",
- "lockResource"
- ],
- "properties": {
- "lockName": {
- "description": "lockName is the resource name used to act as the lock for determining which controller instance should lead.",
- "type": "string",
- "default": ""
- },
- "lockNamespace": {
- "description": "lockNamespace is the resource namespace used to act as the lock for determining which controller instance should lead. It defaults to \"kube-system\"",
- "type": "string",
- "default": ""
- },
- "lockResource": {
- "description": "lockResource is the group and resource name to use to coordinate for the controller lock. If unset, defaults to \"configmaps\".",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.GroupResource"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.DNSConfig": {
- "description": "DNSConfig holds the necessary configuration options for DNS",
- "type": "object",
- "required": [
- "bindAddress",
- "bindNetwork",
- "allowRecursiveQueries"
- ],
- "properties": {
- "allowRecursiveQueries": {
- "description": "allowRecursiveQueries allows the DNS server on the master to answer queries recursively. Note that open resolvers can be used for DNS amplification attacks and the master DNS should not be made accessible to public networks.",
- "type": "boolean",
- "default": false
- },
- "bindAddress": {
- "description": "bindAddress is the ip:port to serve DNS on",
- "type": "string",
- "default": ""
- },
- "bindNetwork": {
- "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.DefaultAdmissionConfig": {
- "description": "DefaultAdmissionConfig can be used to enable or disable various admission plugins. When this type is present as the `configuration` object under `pluginConfig` and *if* the admission plugin supports it, this will cause an \"off by default\" admission plugin to be enabled\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "disable"
- ],
- "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",
- "type": "string"
- },
- "disable": {
- "description": "disable turns off an admission plugin that is enabled by default.",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.DenyAllPasswordIdentityProvider": {
- "description": "DenyAllPasswordIdentityProvider provides no identities for users\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "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",
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.DockerConfig": {
- "description": "DockerConfig holds Docker related configuration options.",
- "type": "object",
- "required": [
- "execHandlerName",
- "dockerShimSocket",
- "dockerShimRootDirectory"
- ],
- "properties": {
- "dockerShimRootDirectory": {
- "description": "dockerShimRootDirectory is the dockershim root directory.",
- "type": "string",
- "default": ""
- },
- "dockerShimSocket": {
- "description": "dockerShimSocket is the location of the dockershim socket the kubelet uses. Currently unix socket is supported on Linux, and tcp is supported on windows. Examples:'unix:///var/run/dockershim.sock', 'tcp://localhost:3735'",
- "type": "string",
- "default": ""
- },
- "execHandlerName": {
- "description": "execHandlerName is the name of the handler to use for executing commands in containers.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.EtcdConfig": {
- "description": "EtcdConfig holds the necessary configuration options for connecting with an etcd database",
- "type": "object",
- "required": [
- "servingInfo",
- "address",
- "peerServingInfo",
- "peerAddress",
- "storageDirectory"
- ],
- "properties": {
- "address": {
- "description": "address is the advertised host:port for client connections to etcd",
- "type": "string",
- "default": ""
- },
- "peerAddress": {
- "description": "peerAddress is the advertised host:port for peer connections to etcd",
- "type": "string",
- "default": ""
- },
- "peerServingInfo": {
- "description": "peerServingInfo describes how to start serving the etcd peer",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ServingInfo"
- },
- "servingInfo": {
- "description": "servingInfo describes how to start serving the etcd master",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ServingInfo"
- },
- "storageDirectory": {
- "description": "StorageDir is the path to the etcd storage directory",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.EtcdConnectionInfo": {
- "description": "EtcdConnectionInfo holds information necessary for connecting to an etcd server",
- "type": "object",
- "required": [
- "urls",
- "ca",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "ca": {
- "description": "ca is a file containing trusted roots for the etcd server certificates",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "urls": {
- "description": "urls are the URLs for etcd",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.EtcdStorageConfig": {
- "description": "EtcdStorageConfig holds the necessary configuration options for the etcd storage underlying OpenShift and Kubernetes",
- "type": "object",
- "required": [
- "kubernetesStorageVersion",
- "kubernetesStoragePrefix",
- "openShiftStorageVersion",
- "openShiftStoragePrefix"
- ],
- "properties": {
- "kubernetesStoragePrefix": {
- "description": "kubernetesStoragePrefix is the path within etcd that the Kubernetes resources will be rooted under. This value, if changed, will mean existing objects in etcd will no longer be located. The default value is 'kubernetes.io'.",
- "type": "string",
- "default": ""
- },
- "kubernetesStorageVersion": {
- "description": "kubernetesStorageVersion is the API version that Kube resources in etcd should be serialized to. This value should *not* be advanced until all clients in the cluster that read from etcd have code that allows them to read the new version.",
- "type": "string",
- "default": ""
- },
- "openShiftStoragePrefix": {
- "description": "openShiftStoragePrefix is the path within etcd that the OpenShift resources will be rooted under. This value, if changed, will mean existing objects in etcd will no longer be located. The default value is 'openshift.io'.",
- "type": "string",
- "default": ""
- },
- "openShiftStorageVersion": {
- "description": "openShiftStorageVersion is the API version that OS resources in etcd should be serialized to. This value should *not* be advanced until all clients in the cluster that read from etcd have code that allows them to read the new version.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.GitHubIdentityProvider": {
- "description": "GitHubIdentityProvider provides identities for users authenticating using GitHub credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "clientID",
- "clientSecret",
- "organizations",
- "teams",
- "hostname",
- "ca"
- ],
- "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",
- "type": "string"
- },
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value.",
- "type": "string",
- "default": ""
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.StringSource"
- },
- "hostname": {
- "description": "hostname is the optional domain (e.g. \"mycompany.com\") for use with a hosted instance of GitHub Enterprise. It must match the GitHub Enterprise settings value that is configured at /setup/settings#hostname.",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- },
- "organizations": {
- "description": "organizations optionally restricts which organizations are allowed to log in",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "teams": {
- "description": "teams optionally restricts which teams are allowed to log in. Format is /.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.GitLabIdentityProvider": {
- "description": "GitLabIdentityProvider provides identities for users authenticating using GitLab credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "ca",
- "url",
- "clientID",
- "clientSecret"
- ],
- "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",
- "type": "string"
- },
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used",
- "type": "string",
- "default": ""
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.StringSource"
- },
- "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",
- "type": "string"
- },
- "legacy": {
- "description": "legacy determines if OAuth2 or OIDC should be used If true, OAuth2 is used If false, OIDC is used If nil and the URL's host is gitlab.com, OIDC is used Otherwise, OAuth2 is used In a future release, nil will default to using OIDC Eventually this flag will be removed and only OIDC will be used",
- "type": "boolean"
- },
- "url": {
- "description": "url is the oauth server base URL",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.GoogleIdentityProvider": {
- "description": "GoogleIdentityProvider provides identities for users authenticating using Google credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "clientID",
- "clientSecret",
- "hostedDomain"
- ],
- "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",
- "type": "string"
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.StringSource"
- },
- "hostedDomain": {
- "description": "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.GrantConfig": {
- "description": "GrantConfig holds the necessary configuration options for grant handlers",
- "type": "object",
- "required": [
- "method",
- "serviceAccountMethod"
- ],
- "properties": {
- "method": {
- "description": "method determines the default strategy to use when an OAuth client requests a grant. This method will be used only if the specific OAuth client doesn't provide a strategy of their own. Valid grant handling methods are:\n - auto: always approves grant requests, useful for trusted clients\n - prompt: prompts the end user for approval of grant requests, useful for third-party clients\n - deny: always denies grant requests, useful for black-listed clients",
- "type": "string",
- "default": ""
- },
- "serviceAccountMethod": {
- "description": "serviceAccountMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.GroupResource": {
- "description": "GroupResource points to a resource by its name and API group.",
- "type": "object",
- "required": [
- "group",
- "resource"
- ],
- "properties": {
- "group": {
- "description": "group is the name of an API group",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is the name of a resource.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.HTPasswdPasswordIdentityProvider": {
- "description": "HTPasswdPasswordIdentityProvider provides identities for users authenticating using htpasswd credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "file"
- ],
- "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",
- "type": "string"
- },
- "file": {
- "description": "file is a reference to your htpasswd file",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.HTTPServingInfo": {
- "description": "HTTPServingInfo holds configuration for serving HTTP",
- "type": "object",
- "required": [
- "bindAddress",
- "bindNetwork",
- "certFile",
- "keyFile",
- "clientCA",
- "namedCertificates",
- "maxRequestsInFlight",
- "requestTimeoutSeconds"
- ],
- "properties": {
- "bindAddress": {
- "description": "bindAddress is the ip:port to serve on",
- "type": "string",
- "default": ""
- },
- "bindNetwork": {
- "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "cipherSuites": {
- "description": "cipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "clientCA": {
- "description": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "maxRequestsInFlight": {
- "description": "maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "minTLSVersion": {
- "description": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "string"
- },
- "namedCertificates": {
- "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.NamedCertificate"
- }
- },
- "requestTimeoutSeconds": {
- "description": "requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.IdentityProvider": {
- "description": "IdentityProvider provides identities for users authenticating using credentials",
- "type": "object",
- "required": [
- "name",
- "challenge",
- "login",
- "mappingMethod",
- "provider"
- ],
- "properties": {
- "challenge": {
- "description": "UseAsChallenger indicates whether to issue WWW-Authenticate challenges for this provider",
- "type": "boolean",
- "default": false
- },
- "login": {
- "description": "UseAsLogin indicates whether to use this identity provider for unauthenticated browsers to login against",
- "type": "boolean",
- "default": false
- },
- "mappingMethod": {
- "description": "mappingMethod determines how identities from this provider are mapped to users",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is used to qualify the identities returned by this provider",
- "type": "string",
- "default": ""
- },
- "provider": {
- "description": "provider contains the information about how to set up a specific identity provider",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ImageConfig": {
- "description": "ImageConfig holds the necessary configuration options for building image names for system components",
- "type": "object",
- "required": [
- "format",
- "latest"
- ],
- "properties": {
- "format": {
- "description": "format is the format of the name to be built for the system component",
- "type": "string",
- "default": ""
- },
- "latest": {
- "description": "latest determines if the latest tag will be pulled from the registry",
- "type": "boolean",
- "default": false
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ImagePolicyConfig": {
- "description": "ImagePolicyConfig holds the necessary configuration options for limits and behavior for importing images",
- "type": "object",
- "required": [
- "maxImagesBulkImportedPerRepository",
- "disableScheduledImport",
- "scheduledImageImportMinimumIntervalSeconds",
- "maxScheduledImageImportsPerMinute"
- ],
- "properties": {
- "additionalTrustedCA": {
- "description": "additionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted during imagestream import.",
- "type": "string"
- },
- "allowedRegistriesForImport": {
- "description": "allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.RegistryLocation"
- }
- },
- "disableScheduledImport": {
- "description": "disableScheduledImport allows scheduled background import of images to be disabled.",
- "type": "boolean",
- "default": false
- },
- "externalRegistryHostname": {
- "description": "externalRegistryHostname sets the hostname for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
- "type": "string"
- },
- "internalRegistryHostname": {
- "description": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format.",
- "type": "string"
- },
- "maxImagesBulkImportedPerRepository": {
- "description": "maxImagesBulkImportedPerRepository controls the number of images that are imported when a user does a bulk import of a container repository. This number defaults to 50 to prevent users from importing large numbers of images accidentally. Set -1 for no limit.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "maxScheduledImageImportsPerMinute": {
- "description": "maxScheduledImageImportsPerMinute is the maximum number of scheduled image streams that will be imported in the background per minute. The default value is 60. Set to -1 for unlimited.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "scheduledImageImportMinimumIntervalSeconds": {
- "description": "scheduledImageImportMinimumIntervalSeconds is the minimum number of seconds that can elapse between when image streams scheduled for background import are checked against the upstream repository. The default value is 15 minutes.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.JenkinsPipelineConfig": {
- "description": "JenkinsPipelineConfig holds configuration for the Jenkins pipeline strategy",
- "type": "object",
- "required": [
- "autoProvisionEnabled",
- "templateNamespace",
- "templateName",
- "serviceName",
- "parameters"
- ],
- "properties": {
- "autoProvisionEnabled": {
- "description": "autoProvisionEnabled determines whether a Jenkins server will be spawned from the provided template when the first build config in the project with type JenkinsPipeline is created. When not specified this option defaults to true.",
- "type": "boolean"
- },
- "parameters": {
- "description": "parameters specifies a set of optional parameters to the Jenkins template.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "serviceName": {
- "description": "serviceName is the name of the Jenkins service OpenShift uses to detect whether a Jenkins pipeline handler has already been installed in a project. This value *must* match a service name in the provided template.",
- "type": "string",
- "default": ""
- },
- "templateName": {
- "description": "templateName is the name of the default Jenkins template",
- "type": "string",
- "default": ""
- },
- "templateNamespace": {
- "description": "templateNamespace contains the namespace name where the Jenkins template is stored",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.KeystonePasswordIdentityProvider": {
- "description": "KeystonePasswordIdentityProvider provides identities for users authenticating using keystone password credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "url",
- "ca",
- "certFile",
- "keyFile",
- "domainName",
- "useKeystoneIdentity"
- ],
- "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",
- "type": "string"
- },
- "ca": {
- "description": "ca is the CA for verifying TLS connections",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "domainName": {
- "description": "Domain Name is required for keystone v3",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- },
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- },
- "useKeystoneIdentity": {
- "description": "useKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username",
- "type": "boolean",
- "default": false
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.KubeletConnectionInfo": {
- "description": "KubeletConnectionInfo holds information necessary for connecting to a kubelet",
- "type": "object",
- "required": [
- "port",
- "ca",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "ca": {
- "description": "ca is the CA for verifying TLS connections to kubelets",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "port": {
- "description": "port is the port to connect to kubelets on",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.KubernetesMasterConfig": {
- "description": "KubernetesMasterConfig holds the necessary configuration options for the Kubernetes master",
- "type": "object",
- "required": [
- "apiLevels",
- "disabledAPIGroupVersions",
- "masterIP",
- "masterEndpointReconcileTTL",
- "servicesSubnet",
- "servicesNodePortRange",
- "schedulerConfigFile",
- "podEvictionTimeout",
- "proxyClientInfo",
- "apiServerArguments",
- "controllerArguments",
- "schedulerArguments"
- ],
- "properties": {
- "apiLevels": {
- "description": "apiLevels is a list of API levels that should be enabled on startup: v1 as examples",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "apiServerArguments": {
- "description": "apiServerArguments are key value pairs that will be passed directly to the Kube apiserver that match the apiservers's command line arguments. These are not migrated, but if you reference a value that does not exist the server will not start. These values may override other settings in KubernetesMasterConfig which may cause invalid configurations.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "controllerArguments": {
- "description": "controllerArguments are key value pairs that will be passed directly to the Kube controller manager that match the controller manager's command line arguments. These are not migrated, but if you reference a value that does not exist the server will not start. These values may override other settings in KubernetesMasterConfig which may cause invalid configurations.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "disabledAPIGroupVersions": {
- "description": "disabledAPIGroupVersions is a map of groups to the versions (or *) that should be disabled.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "masterEndpointReconcileTTL": {
- "description": "masterEndpointReconcileTTL sets the time to live in seconds of an endpoint record recorded by each master. The endpoints are checked at an interval that is 2/3 of this value and this value defaults to 15s if unset. In very large clusters, this value may be increased to reduce the possibility that the master endpoint record expires (due to other load on the etcd server) and causes masters to drop in and out of the kubernetes service record. It is not recommended to set this value below 15s.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "masterIP": {
- "description": "masterIP is the public IP address of kubernetes stuff. If empty, the first result from net.InterfaceAddrs will be used.",
- "type": "string",
- "default": ""
- },
- "podEvictionTimeout": {
- "description": "podEvictionTimeout controls grace period for deleting pods on failed nodes. It takes valid time duration string. If empty, you get the default pod eviction timeout.",
- "type": "string",
- "default": ""
- },
- "proxyClientInfo": {
- "description": "proxyClientInfo specifies the client cert/key to use when proxying to pods",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.CertInfo"
- },
- "schedulerArguments": {
- "description": "schedulerArguments are key value pairs that will be passed directly to the Kube scheduler that match the scheduler's command line arguments. These are not migrated, but if you reference a value that does not exist the server will not start. These values may override other settings in KubernetesMasterConfig which may cause invalid configurations.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "schedulerConfigFile": {
- "description": "schedulerConfigFile points to a file that describes how to set up the scheduler. If empty, you get the default scheduling rules.",
- "type": "string",
- "default": ""
- },
- "servicesNodePortRange": {
- "description": "servicesNodePortRange is the range to use for assigning service public ports on a host.",
- "type": "string",
- "default": ""
- },
- "servicesSubnet": {
- "description": "servicesSubnet is the subnet to use for assigning service IPs",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.LDAPAttributeMapping": {
- "description": "LDAPAttributeMapping maps LDAP attributes to OpenShift identity fields",
- "type": "object",
- "required": [
- "id",
- "preferredUsername",
- "name",
- "email"
- ],
- "properties": {
- "email": {
- "description": "email is the list of attributes whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "id": {
- "description": "id is the list of attributes whose values should be used as the user ID. Required. LDAP standard identity attribute is \"dn\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "name": {
- "description": "name is the list of attributes whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity LDAP standard display name attribute is \"cn\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "preferredUsername": {
- "description": "preferredUsername is the list of attributes whose values should be used as the preferred username. LDAP standard login attribute is \"uid\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.LDAPPasswordIdentityProvider": {
- "description": "LDAPPasswordIdentityProvider provides identities for users authenticating using LDAP credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "url",
- "bindDN",
- "bindPassword",
- "insecure",
- "ca",
- "attributes"
- ],
- "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",
- "type": "string"
- },
- "attributes": {
- "description": "attributes maps LDAP attributes to identities",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LDAPAttributeMapping"
- },
- "bindDN": {
- "description": "bindDN is an optional DN to bind with during the search phase.",
- "type": "string",
- "default": ""
- },
- "bindPassword": {
- "description": "bindPassword is an optional password to bind with during the search phase.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.StringSource"
- },
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used",
- "type": "string",
- "default": ""
- },
- "insecure": {
- "description": "Insecure, if true, indicates the connection should not use TLS. Cannot be set to true with a URL scheme of \"ldaps://\" If false, \"ldaps://\" URLs connect using TLS, and \"ldap://\" URLs are upgraded to a TLS connection using StartTLS as specified in https://tools.ietf.org/html/rfc2830",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "url": {
- "description": "url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is\n ldap://host:port/basedn?attribute?scope?filter",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.LDAPQuery": {
- "description": "LDAPQuery holds the options necessary to build an LDAP query",
- "type": "object",
- "required": [
- "baseDN",
- "scope",
- "derefAliases",
- "timeout",
- "filter",
- "pageSize"
- ],
- "properties": {
- "baseDN": {
- "description": "The DN of the branch of the directory where all searches should start from",
- "type": "string",
- "default": ""
- },
- "derefAliases": {
- "description": "The (optional) behavior of the search with regards to alisases. Can be: never: never dereference aliases, search: only dereference in searching, base: only dereference in finding the base object, always: always dereference Defaults to always dereferencing if not set",
- "type": "string",
- "default": ""
- },
- "filter": {
- "description": "filter is a valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN",
- "type": "string",
- "default": ""
- },
- "pageSize": {
- "description": "pageSize is the maximum preferred page size, measured in LDAP entries. A page size of 0 means no paging will be done.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "scope": {
- "description": "The (optional) scope of the search. Can be: base: only the base object, one: all object on the base level, sub: the entire subtree Defaults to the entire subtree if not set",
- "type": "string",
- "default": ""
- },
- "timeout": {
- "description": "TimeLimit holds the limit of time in seconds that any request to the server can remain outstanding before the wait for a response is given up. If this is 0, no client-side limit is imposed",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.LDAPSyncConfig": {
- "description": "LDAPSyncConfig holds the necessary configuration options to define an LDAP group sync\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "url",
- "bindDN",
- "bindPassword",
- "insecure",
- "ca",
- "groupUIDNameMapping"
- ],
- "properties": {
- "activeDirectory": {
- "description": "ActiveDirectoryConfig holds the configuration for extracting data from an LDAP server set up in a fashion similar to that used in Active Directory: first-class user entries, with group membership determined by a multi-valued attribute on members listing groups they are a member of",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ActiveDirectoryConfig"
- },
- "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",
- "type": "string"
- },
- "augmentedActiveDirectory": {
- "description": "AugmentedActiveDirectoryConfig holds the configuration for extracting data from an LDAP server set up in a fashion similar to that used in Active Directory as described above, with one addition: first-class group entries exist and are used to hold metadata but not group membership",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.AugmentedActiveDirectoryConfig"
- },
- "bindDN": {
- "description": "bindDN is an optional DN to bind to the LDAP server with",
- "type": "string",
- "default": ""
- },
- "bindPassword": {
- "description": "bindPassword is an optional password to bind with during the search phase.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.StringSource"
- },
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used",
- "type": "string",
- "default": ""
- },
- "groupUIDNameMapping": {
- "description": "LDAPGroupUIDToOpenShiftGroupNameMapping is an optional direct mapping of LDAP group UIDs to OpenShift Group names",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "insecure": {
- "description": "Insecure, if true, indicates the connection should not use TLS. Cannot be set to true with a URL scheme of \"ldaps://\" If false, \"ldaps://\" URLs connect using TLS, and \"ldap://\" URLs are upgraded to a TLS connection using StartTLS as specified in https://tools.ietf.org/html/rfc2830",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "rfc2307": {
- "description": "RFC2307Config holds the configuration for extracting data from an LDAP server set up in a fashion similar to RFC2307: first-class group and user entries, with group membership determined by a multi-valued attribute on the group entry listing its members",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.RFC2307Config"
- },
- "url": {
- "description": "Host is the scheme, host and port of the LDAP server to connect to: scheme://host:port",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.LocalQuota": {
- "description": "LocalQuota contains options for controlling local volume quota on the node.",
- "type": "object",
- "required": [
- "perFSGroup"
- ],
- "properties": {
- "perFSGroup": {
- "description": "FSGroup can be specified to enable a quota on local storage use per unique FSGroup ID. At present this is only implemented for emptyDir volumes, and if the underlying volumeDirectory is on an XFS filesystem.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.MasterAuthConfig": {
- "description": "MasterAuthConfig configures authentication options in addition to the standard oauth token and client certificate authenticators",
- "type": "object",
- "required": [
- "requestHeader",
- "webhookTokenAuthenticators",
- "oauthMetadataFile"
- ],
- "properties": {
- "oauthMetadataFile": {
- "description": "oauthMetadataFile is a path to a file containing the discovery endpoint for OAuth 2.0 Authorization Server Metadata for an external OAuth server. See IETF Draft: // https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This option is mutually exclusive with OAuthConfig",
- "type": "string",
- "default": ""
- },
- "requestHeader": {
- "description": "requestHeader holds options for setting up a front proxy against the API. It is optional.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.RequestHeaderAuthenticationOptions"
- },
- "webhookTokenAuthenticators": {
- "description": "WebhookTokenAuthnConfig, if present configures remote token reviewers",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.WebhookTokenAuthenticator"
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.MasterClients": {
- "description": "MasterClients holds references to `.kubeconfig` files that qualify master clients for OpenShift and Kubernetes",
- "type": "object",
- "required": [
- "openshiftLoopbackKubeConfig",
- "openshiftLoopbackClientConnectionOverrides"
- ],
- "properties": {
- "openshiftLoopbackClientConnectionOverrides": {
- "description": "openshiftLoopbackClientConnectionOverrides specifies client overrides for system components to loop back to this master.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ClientConnectionOverrides"
- },
- "openshiftLoopbackKubeConfig": {
- "description": "openshiftLoopbackKubeConfig is a .kubeconfig filename for system components to loopback to this master",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.MasterConfig": {
- "description": "MasterConfig holds the necessary configuration options for the OpenShift master\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "servingInfo",
- "authConfig",
- "aggregatorConfig",
- "corsAllowedOrigins",
- "apiLevels",
- "masterPublicURL",
- "controllers",
- "admissionConfig",
- "controllerConfig",
- "etcdStorageConfig",
- "etcdClientInfo",
- "kubeletClientInfo",
- "kubernetesMasterConfig",
- "etcdConfig",
- "oauthConfig",
- "dnsConfig",
- "serviceAccountConfig",
- "masterClients",
- "imageConfig",
- "imagePolicyConfig",
- "policyConfig",
- "projectConfig",
- "routingConfig",
- "networkConfig",
- "volumeConfig",
- "jenkinsPipelineConfig",
- "auditConfig"
- ],
- "properties": {
- "admissionConfig": {
- "description": "admissionConfig contains admission control plugin configuration.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.AdmissionConfig"
- },
- "aggregatorConfig": {
- "description": "aggregatorConfig has options for configuring the aggregator component of the API server.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.AggregatorConfig"
- },
- "apiLevels": {
- "description": "apiLevels is a list of API levels that should be enabled on startup: v1 as examples",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "auditConfig": {
- "description": "auditConfig holds information related to auditing capabilities.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.AuditConfig"
- },
- "authConfig": {
- "description": "authConfig configures authentication options in addition to the standard oauth token and client certificate authenticators",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.MasterAuthConfig"
- },
- "controllerConfig": {
- "description": "controllerConfig holds configuration values for controllers",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ControllerConfig"
- },
- "controllers": {
- "description": "controllers is a list of the controllers that should be started. If set to \"none\", no controllers will start automatically. The default value is \"*\" which will start all controllers. When using \"*\", you may exclude controllers by prepending a \"-\" in front of their name. No other values are recognized at this time.",
- "type": "string",
- "default": ""
- },
- "corsAllowedOrigins": {
- "description": "CORSAllowedOrigins",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "dnsConfig": {
- "description": "DNSConfig, if present start the DNS server in this process",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.DNSConfig"
- },
- "etcdClientInfo": {
- "description": "etcdClientInfo contains information about how to connect to etcd",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.EtcdConnectionInfo"
- },
- "etcdConfig": {
- "description": "EtcdConfig, if present start etcd in this process",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.EtcdConfig"
- },
- "etcdStorageConfig": {
- "description": "etcdStorageConfig contains information about how API resources are stored in Etcd. These values are only relevant when etcd is the backing store for the cluster.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.EtcdStorageConfig"
- },
- "imageConfig": {
- "description": "imageConfig holds options that describe how to build image names for system components",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ImageConfig"
- },
- "imagePolicyConfig": {
- "description": "imagePolicyConfig controls limits and behavior for importing images",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ImagePolicyConfig"
- },
- "jenkinsPipelineConfig": {
- "description": "jenkinsPipelineConfig holds information about the default Jenkins template used for JenkinsPipeline build strategy.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.JenkinsPipelineConfig"
- },
- "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",
- "type": "string"
- },
- "kubeletClientInfo": {
- "description": "kubeletClientInfo contains information about how to connect to kubelets",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.KubeletConnectionInfo"
- },
- "kubernetesMasterConfig": {
- "description": "KubernetesMasterConfig, if present start the kubernetes master in this process",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.KubernetesMasterConfig"
- },
- "masterClients": {
- "description": "masterClients holds all the client connection information for controllers and other system components",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.MasterClients"
- },
- "masterPublicURL": {
- "description": "masterPublicURL is how clients can access the OpenShift API server",
- "type": "string",
- "default": ""
- },
- "networkConfig": {
- "description": "networkConfig to be passed to the compiled in network plugin",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.MasterNetworkConfig"
- },
- "oauthConfig": {
- "description": "OAuthConfig, if present start the /oauth endpoint in this process",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.OAuthConfig"
- },
- "policyConfig": {
- "description": "policyConfig holds information about where to locate critical pieces of bootstrapping policy",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.PolicyConfig"
- },
- "projectConfig": {
- "description": "projectConfig holds information about project creation and defaults",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ProjectConfig"
- },
- "routingConfig": {
- "description": "routingConfig holds information about routing and route generation",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.RoutingConfig"
- },
- "serviceAccountConfig": {
- "description": "serviceAccountConfig holds options related to service accounts",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ServiceAccountConfig"
- },
- "servingInfo": {
- "description": "servingInfo describes how to start serving",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.HTTPServingInfo"
- },
- "volumeConfig": {
- "description": "MasterVolumeConfig contains options for configuring volume plugins in the master node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.MasterVolumeConfig"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.MasterNetworkConfig": {
- "description": "MasterNetworkConfig to be passed to the compiled in network plugin",
- "type": "object",
- "required": [
- "networkPluginName",
- "clusterNetworks",
- "serviceNetworkCIDR",
- "externalIPNetworkCIDRs",
- "ingressIPNetworkCIDR"
- ],
- "properties": {
- "clusterNetworkCIDR": {
- "description": "clusterNetworkCIDR is the CIDR string to specify the global overlay network's L3 space. Deprecated, but maintained for backwards compatibility, use ClusterNetworks instead.",
- "type": "string"
- },
- "clusterNetworks": {
- "description": "clusterNetworks is a list of ClusterNetwork objects that defines the global overlay network's L3 space by specifying a set of CIDR and netmasks that the SDN can allocate addressed from. If this is specified, then ClusterNetworkCIDR and HostSubnetLength may not be set.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ClusterNetworkEntry"
- }
- },
- "externalIPNetworkCIDRs": {
- "description": "externalIPNetworkCIDRs controls what values are acceptable for the service external IP field. If empty, no externalIP may be set. It may contain a list of CIDRs which are checked for access. If a CIDR is prefixed with !, IPs in that CIDR will be rejected. Rejections will be applied first, then the IP checked against one of the allowed CIDRs. You should ensure this range does not overlap with your nodes, pods, or service CIDRs for security reasons.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "hostSubnetLength": {
- "description": "hostSubnetLength is the number of bits to allocate to each host's subnet e.g. 8 would mean a /24 network on the host. Deprecated, but maintained for backwards compatibility, use ClusterNetworks instead.",
- "type": "integer",
- "format": "int64"
- },
- "ingressIPNetworkCIDR": {
- "description": "ingressIPNetworkCIDR controls the range to assign ingress ips from for services of type LoadBalancer on bare metal. If empty, ingress ips will not be assigned. It may contain a single CIDR that will be allocated from. For security reasons, you should ensure that this range does not overlap with the CIDRs reserved for external ips, nodes, pods, or services.",
- "type": "string",
- "default": ""
- },
- "networkPluginName": {
- "description": "networkPluginName is the name of the network plugin to use",
- "type": "string",
- "default": ""
- },
- "serviceNetworkCIDR": {
- "description": "ServiceNetwork is the CIDR string to specify the service networks",
- "type": "string",
- "default": ""
- },
- "vxlanPort": {
- "description": "vxlanPort is the VXLAN port used by the cluster defaults. If it is not set, 4789 is the default value",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.MasterVolumeConfig": {
- "description": "MasterVolumeConfig contains options for configuring volume plugins in the master node.",
- "type": "object",
- "required": [
- "dynamicProvisioningEnabled"
- ],
- "properties": {
- "dynamicProvisioningEnabled": {
- "description": "dynamicProvisioningEnabled is a boolean that toggles dynamic provisioning off when false, defaults to true",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.NamedCertificate": {
- "description": "NamedCertificate specifies a certificate/key, and the names it should be served for",
- "type": "object",
- "required": [
- "names",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "names": {
- "description": "names is a list of DNS names this certificate should be used to secure A name can be a normal DNS name, or can contain leading wildcard segments.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.NodeAuthConfig": {
- "description": "NodeAuthConfig holds authn/authz configuration options",
- "type": "object",
- "required": [
- "authenticationCacheTTL",
- "authenticationCacheSize",
- "authorizationCacheTTL",
- "authorizationCacheSize"
- ],
- "properties": {
- "authenticationCacheSize": {
- "description": "authenticationCacheSize indicates how many authentication results should be cached. If 0, the default cache size is used.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "authenticationCacheTTL": {
- "description": "authenticationCacheTTL indicates how long an authentication result should be cached. It takes a valid time duration string (e.g. \"5m\"). If empty, you get the default timeout. If zero (e.g. \"0m\"), caching is disabled",
- "type": "string",
- "default": ""
- },
- "authorizationCacheSize": {
- "description": "authorizationCacheSize indicates how many authorization results should be cached. If 0, the default cache size is used.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "authorizationCacheTTL": {
- "description": "authorizationCacheTTL indicates how long an authorization result should be cached. It takes a valid time duration string (e.g. \"5m\"). If empty, you get the default timeout. If zero (e.g. \"0m\"), caching is disabled",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.NodeConfig": {
- "description": "NodeConfig is the fully specified config starting an OpenShift node\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "nodeName",
- "nodeIP",
- "servingInfo",
- "masterKubeConfig",
- "masterClientConnectionOverrides",
- "dnsDomain",
- "dnsIP",
- "dnsBindAddress",
- "dnsNameservers",
- "dnsRecursiveResolvConf",
- "networkConfig",
- "volumeDirectory",
- "imageConfig",
- "allowDisabledDocker",
- "podManifestConfig",
- "authConfig",
- "dockerConfig",
- "iptablesSyncPeriod",
- "enableUnidling",
- "volumeConfig"
- ],
- "properties": {
- "allowDisabledDocker": {
- "description": "allowDisabledDocker if true, the Kubelet will ignore errors from Docker. This means that a node can start on a machine that doesn't have docker started.",
- "type": "boolean",
- "default": false
- },
- "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",
- "type": "string"
- },
- "authConfig": {
- "description": "authConfig holds authn/authz configuration options",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.NodeAuthConfig"
- },
- "dnsBindAddress": {
- "description": "dnsBindAddress is the ip:port to serve DNS on. If this is not set, the DNS server will not be started. Because most DNS resolvers will only listen on port 53, if you select an alternative port you will need a DNS proxy like dnsmasq to answer queries for containers. A common configuration is dnsmasq configured on a node IP listening on 53 and delegating queries for dnsDomain to this process, while sending other queries to the host environments nameservers.",
- "type": "string",
- "default": ""
- },
- "dnsDomain": {
- "description": "dnsDomain holds the domain suffix that will be used for the DNS search path inside each container. Defaults to 'cluster.local'.",
- "type": "string",
- "default": ""
- },
- "dnsIP": {
- "description": "dnsIP is the IP address that pods will use to access cluster DNS. Defaults to the service IP of the Kubernetes master. This IP must be listening on port 53 for compatibility with libc resolvers (which cannot be configured to resolve names from any other port). When running more complex local DNS configurations, this is often set to the local address of a DNS proxy like dnsmasq, which then will consult either the local DNS (see dnsBindAddress) or the master DNS.",
- "type": "string",
- "default": ""
- },
- "dnsNameservers": {
- "description": "dnsNameservers is a list of ip:port values of recursive nameservers to forward queries to when running a local DNS server if dnsBindAddress is set. If this value is empty, the DNS server will default to the nameservers listed in /etc/resolv.conf. If you have configured dnsmasq or another DNS proxy on the system, this value should be set to the upstream nameservers dnsmasq resolves with.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "dnsRecursiveResolvConf": {
- "description": "dnsRecursiveResolvConf is a path to a resolv.conf file that contains settings for an upstream server. Only the nameservers and port fields are used. The file must exist and parse correctly. It adds extra nameservers to DNSNameservers if set.",
- "type": "string",
- "default": ""
- },
- "dockerConfig": {
- "description": "dockerConfig holds Docker related configuration options.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.DockerConfig"
- },
- "enableUnidling": {
- "description": "enableUnidling controls whether or not the hybrid unidling proxy will be set up",
- "type": "boolean"
- },
- "imageConfig": {
- "description": "imageConfig holds options that describe how to build image names for system components",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ImageConfig"
- },
- "iptablesSyncPeriod": {
- "description": "iptablesSyncPeriod is how often iptable rules are refreshed",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- },
- "kubeletArguments": {
- "description": "kubeletArguments are key value pairs that will be passed directly to the Kubelet that match the Kubelet's command line arguments. These are not migrated or validated, so if you use them they may become invalid. These values override other settings in NodeConfig which may cause invalid configurations.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "masterClientConnectionOverrides": {
- "description": "masterClientConnectionOverrides provides overrides to the client connection used to connect to the master.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ClientConnectionOverrides"
- },
- "masterKubeConfig": {
- "description": "masterKubeConfig is a filename for the .kubeconfig file that describes how to connect this node to the master",
- "type": "string",
- "default": ""
- },
- "networkConfig": {
- "description": "networkConfig provides network options for the node",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.NodeNetworkConfig"
- },
- "networkPluginName": {
- "description": "Deprecated and maintained for backward compatibility, use NetworkConfig.NetworkPluginName instead",
- "type": "string"
- },
- "nodeIP": {
- "description": "Node may have multiple IPs, specify the IP to use for pod traffic routing If not specified, network parse/lookup on the nodeName is performed and the first non-loopback address is used",
- "type": "string",
- "default": ""
- },
- "nodeName": {
- "description": "nodeName is the value used to identify this particular node in the cluster. If possible, this should be your fully qualified hostname. If you're describing a set of static nodes to the master, this value must match one of the values in the list",
- "type": "string",
- "default": ""
- },
- "podManifestConfig": {
- "description": "podManifestConfig holds the configuration for enabling the Kubelet to create pods based from a manifest file(s) placed locally on the node",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.PodManifestConfig"
- },
- "proxyArguments": {
- "description": "proxyArguments are key value pairs that will be passed directly to the Proxy that match the Proxy's command line arguments. These are not migrated or validated, so if you use them they may become invalid. These values override other settings in NodeConfig which may cause invalid configurations.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "servingInfo": {
- "description": "servingInfo describes how to start serving",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.ServingInfo"
- },
- "volumeConfig": {
- "description": "volumeConfig contains options for configuring volumes on the node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.NodeVolumeConfig"
- },
- "volumeDirectory": {
- "description": "volumeDirectory is the directory that volumes will be stored under",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.NodeNetworkConfig": {
- "description": "NodeNetworkConfig provides network options for the node",
- "type": "object",
- "required": [
- "networkPluginName",
- "mtu"
- ],
- "properties": {
- "mtu": {
- "description": "Maximum transmission unit for the network packets",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "networkPluginName": {
- "description": "networkPluginName is a string specifying the networking plugin",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.NodeVolumeConfig": {
- "description": "NodeVolumeConfig contains options for configuring volumes on the node.",
- "type": "object",
- "required": [
- "localQuota"
- ],
- "properties": {
- "localQuota": {
- "description": "localQuota contains options for controlling local volume quota on the node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LocalQuota"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.OAuthConfig": {
- "description": "OAuthConfig holds the necessary configuration options for OAuth authentication",
- "type": "object",
- "required": [
- "masterCA",
- "masterURL",
- "masterPublicURL",
- "assetPublicURL",
- "alwaysShowProviderSelection",
- "identityProviders",
- "grantConfig",
- "sessionConfig",
- "tokenConfig",
- "templates"
- ],
- "properties": {
- "alwaysShowProviderSelection": {
- "description": "alwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider.",
- "type": "boolean",
- "default": false
- },
- "assetPublicURL": {
- "description": "assetPublicURL is used for building valid client redirect URLs for external access",
- "type": "string",
- "default": ""
- },
- "grantConfig": {
- "description": "grantConfig describes how to handle grants",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.GrantConfig"
- },
- "identityProviders": {
- "description": "identityProviders is an ordered list of ways for a user to identify themselves",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.IdentityProvider"
- }
- },
- "masterCA": {
- "description": "masterCA is the CA for verifying the TLS connection back to the MasterURL.",
- "type": "string"
- },
- "masterPublicURL": {
- "description": "masterPublicURL is used for building valid client redirect URLs for internal and external access",
- "type": "string",
- "default": ""
- },
- "masterURL": {
- "description": "masterURL is used for making server-to-server calls to exchange authorization codes for access tokens",
- "type": "string",
- "default": ""
- },
- "sessionConfig": {
- "description": "sessionConfig hold information about configuring sessions.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.SessionConfig"
- },
- "templates": {
- "description": "templates allow you to customize pages like the login page.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.OAuthTemplates"
- },
- "tokenConfig": {
- "description": "tokenConfig contains options for authorization and access tokens",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.TokenConfig"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.OAuthTemplates": {
- "description": "OAuthTemplates allow for customization of pages like the login page",
- "type": "object",
- "required": [
- "login",
- "providerSelection",
- "error"
- ],
- "properties": {
- "error": {
- "description": "error is a path to a file containing a go template used to render error pages during the authentication or grant flow If unspecified, the default error page is used.",
- "type": "string",
- "default": ""
- },
- "login": {
- "description": "login is a path to a file containing a go template used to render the login page. If unspecified, the default login page is used.",
- "type": "string",
- "default": ""
- },
- "providerSelection": {
- "description": "providerSelection is a path to a file containing a go template used to render the provider selection page. If unspecified, the default provider selection page is used.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.OpenIDClaims": {
- "description": "OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider",
- "type": "object",
- "required": [
- "id",
- "preferredUsername",
- "name",
- "email"
- ],
- "properties": {
- "email": {
- "description": "email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "id": {
- "description": "id is the list of claims whose values should be used as the user ID. Required. OpenID standard identity claim is \"sub\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "name": {
- "description": "name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "preferredUsername": {
- "description": "preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the id claim",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.OpenIDIdentityProvider": {
- "description": "OpenIDIdentityProvider provides identities for users authenticating using OpenID credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "ca",
- "clientID",
- "clientSecret",
- "extraScopes",
- "extraAuthorizeParameters",
- "urls",
- "claims"
- ],
- "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",
- "type": "string"
- },
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used",
- "type": "string",
- "default": ""
- },
- "claims": {
- "description": "claims mappings",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.OpenIDClaims"
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.StringSource"
- },
- "extraAuthorizeParameters": {
- "description": "extraAuthorizeParameters are any custom parameters to add to the authorize request.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "extraScopes": {
- "description": "extraScopes are any scopes to request in addition to the standard \"openid\" scope.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "urls": {
- "description": "urls to use to authenticate",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.OpenIDURLs"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.OpenIDURLs": {
- "description": "OpenIDURLs are URLs to use when authenticating with an OpenID identity provider",
- "type": "object",
- "required": [
- "authorize",
- "token",
- "userInfo"
- ],
- "properties": {
- "authorize": {
- "description": "authorize is the oauth authorization URL",
- "type": "string",
- "default": ""
- },
- "token": {
- "description": "token is the oauth token granting URL",
- "type": "string",
- "default": ""
- },
- "userInfo": {
- "description": "userInfo is the optional userinfo URL. If present, a granted access_token is used to request claims If empty, a granted id_token is parsed for claims",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.PodManifestConfig": {
- "description": "PodManifestConfig holds the necessary configuration options for using pod manifests",
- "type": "object",
- "required": [
- "path",
- "fileCheckIntervalSeconds"
- ],
- "properties": {
- "fileCheckIntervalSeconds": {
- "description": "fileCheckIntervalSeconds is the interval in seconds for checking the manifest file(s) for new data The interval needs to be a positive value",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "path": {
- "description": "path specifies the path for the pod manifest file or directory If its a directory, its expected to contain on or more manifest files This is used by the Kubelet to create pods on the node",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.PolicyConfig": {
- "description": "holds the necessary configuration options for",
- "type": "object",
- "required": [
- "userAgentMatchingConfig"
- ],
- "properties": {
- "userAgentMatchingConfig": {
- "description": "userAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.UserAgentMatchingConfig"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ProjectConfig": {
- "description": "holds the necessary configuration options for",
- "type": "object",
- "required": [
- "defaultNodeSelector",
- "projectRequestMessage",
- "projectRequestTemplate",
- "securityAllocator"
- ],
- "properties": {
- "defaultNodeSelector": {
- "description": "defaultNodeSelector holds default project node label selector",
- "type": "string",
- "default": ""
- },
- "projectRequestMessage": {
- "description": "projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint",
- "type": "string",
- "default": ""
- },
- "projectRequestTemplate": {
- "description": "projectRequestTemplate is the template to use for creating projects in response to projectrequest. It is in the format namespace/template and it is optional. If it is not specified, a default template is used.",
- "type": "string",
- "default": ""
- },
- "securityAllocator": {
- "description": "securityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.SecurityAllocator"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.RFC2307Config": {
- "description": "RFC2307Config holds the necessary configuration options to define how an LDAP group sync interacts with an LDAP server using the RFC2307 schema",
- "type": "object",
- "required": [
- "groupsQuery",
- "groupUIDAttribute",
- "groupNameAttributes",
- "groupMembershipAttributes",
- "usersQuery",
- "userUIDAttribute",
- "userNameAttributes",
- "tolerateMemberNotFoundErrors",
- "tolerateMemberOutOfScopeErrors"
- ],
- "properties": {
- "groupMembershipAttributes": {
- "description": "groupMembershipAttributes defines which attributes on an LDAP group entry will be interpreted as its members. The values contained in those attributes must be queryable by your UserUIDAttribute",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groupNameAttributes": {
- "description": "groupNameAttributes defines which attributes on an LDAP group entry will be interpreted as its name to use for an OpenShift group",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groupUIDAttribute": {
- "description": "GroupUIDAttributes defines which attribute on an LDAP group entry will be interpreted as its unique identifier. (ldapGroupUID)",
- "type": "string",
- "default": ""
- },
- "groupsQuery": {
- "description": "AllGroupsQuery holds the template for an LDAP query that returns group entries.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LDAPQuery"
- },
- "tolerateMemberNotFoundErrors": {
- "description": "tolerateMemberNotFoundErrors determines the behavior of the LDAP sync job when missing user entries are encountered. If 'true', an LDAP query for users that doesn't find any will be tolerated and an only and error will be logged. If 'false', the LDAP sync job will fail if a query for users doesn't find any. The default value is 'false'. Misconfigured LDAP sync jobs with this flag set to 'true' can cause group membership to be removed, so it is recommended to use this flag with caution.",
- "type": "boolean",
- "default": false
- },
- "tolerateMemberOutOfScopeErrors": {
- "description": "tolerateMemberOutOfScopeErrors determines the behavior of the LDAP sync job when out-of-scope user entries are encountered. If 'true', an LDAP query for a user that falls outside of the base DN given for the all user query will be tolerated and only an error will be logged. If 'false', the LDAP sync job will fail if a user query would search outside of the base DN specified by the all user query. Misconfigured LDAP sync jobs with this flag set to 'true' can result in groups missing users, so it is recommended to use this flag with caution.",
- "type": "boolean",
- "default": false
- },
- "userNameAttributes": {
- "description": "userNameAttributes defines which attributes on an LDAP user entry will be used, in order, as its OpenShift user name. The first attribute with a non-empty value is used. This should match your PreferredUsername setting for your LDAPPasswordIdentityProvider",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "userUIDAttribute": {
- "description": "userUIDAttribute defines which attribute on an LDAP user entry will be interpreted as its unique identifier. It must correspond to values that will be found from the GroupMembershipAttributes",
- "type": "string",
- "default": ""
- },
- "usersQuery": {
- "description": "AllUsersQuery holds the template for an LDAP query that returns user entries.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.LDAPQuery"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.RegistryLocation": {
- "description": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.",
- "type": "object",
- "required": [
- "domainName"
- ],
- "properties": {
- "domainName": {
- "description": "domainName specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.",
- "type": "string",
- "default": ""
- },
- "insecure": {
- "description": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.RemoteConnectionInfo": {
- "description": "RemoteConnectionInfo holds information necessary for establishing a remote connection",
- "type": "object",
- "required": [
- "url",
- "ca",
- "certFile",
- "keyFile"
- ],
- "properties": {
- "ca": {
- "description": "ca is the CA for verifying TLS connections",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.RequestHeaderAuthenticationOptions": {
- "description": "RequestHeaderAuthenticationOptions provides options for setting up a front proxy against the entire API instead of against the /oauth endpoint.",
- "type": "object",
- "required": [
- "clientCA",
- "clientCommonNames",
- "usernameHeaders",
- "groupHeaders",
- "extraHeaderPrefixes"
- ],
- "properties": {
- "clientCA": {
- "description": "clientCA is a file with the trusted signer certs. It is required.",
- "type": "string",
- "default": ""
- },
- "clientCommonNames": {
- "description": "clientCommonNames is a required list of common names to require a match from.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "extraHeaderPrefixes": {
- "description": "extraHeaderPrefixes is the set of request header prefixes to inspect for user extra. X-Remote-Extra- is suggested.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groupHeaders": {
- "description": "GroupNameHeader is the set of headers to check for group information. All are unioned.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "usernameHeaders": {
- "description": "usernameHeaders is the list of headers to check for user information. First hit wins.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.RequestHeaderIdentityProvider": {
- "description": "RequestHeaderIdentityProvider provides identities for users authenticating using request header credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "loginURL",
- "challengeURL",
- "clientCA",
- "clientCommonNames",
- "headers",
- "preferredUsernameHeaders",
- "nameHeaders",
- "emailHeaders"
- ],
- "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",
- "type": "string"
- },
- "challengeURL": {
- "description": "challengeURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect WWW-Authenticate challenges will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}",
- "type": "string",
- "default": ""
- },
- "clientCA": {
- "description": "clientCA is a file with the trusted signer certs. If empty, no request verification is done, and any direct request to the OAuth server can impersonate any identity from this provider, merely by setting a request header.",
- "type": "string",
- "default": ""
- },
- "clientCommonNames": {
- "description": "clientCommonNames is an optional list of common names to require a match from. If empty, any client certificate validated against the clientCA bundle is considered authoritative.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "emailHeaders": {
- "description": "emailHeaders is the set of headers to check for the email address",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "headers": {
- "description": "headers is the set of headers to check for identity information",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "loginURL": {
- "description": "loginURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect interactive logins will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}",
- "type": "string",
- "default": ""
- },
- "nameHeaders": {
- "description": "nameHeaders is the set of headers to check for the display name",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "preferredUsernameHeaders": {
- "description": "preferredUsernameHeaders is the set of headers to check for the preferred username",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.RoutingConfig": {
- "description": "RoutingConfig holds the necessary configuration options for routing to subdomains",
- "type": "object",
- "required": [
- "subdomain"
- ],
- "properties": {
- "subdomain": {
- "description": "subdomain is the suffix appended to $service.$namespace. to form the default route hostname DEPRECATED: This field is being replaced by routers setting their own defaults. This is the \"default\" route.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.SecurityAllocator": {
- "description": "SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.",
- "type": "object",
- "required": [
- "uidAllocatorRange",
- "mcsAllocatorRange",
- "mcsLabelsPerProject"
- ],
- "properties": {
- "mcsAllocatorRange": {
- "description": "mcsAllocatorRange defines the range of MCS categories that will be assigned to namespaces. The format is \"/[,]\". The default is \"s0/2\" and will allocate from c0 -> c1023, which means a total of 535k labels are available (1024 choose 2 ~ 535k). If this value is changed after startup, new projects may receive labels that are already allocated to other projects. Prefix may be any valid SELinux set of terms (including user, role, and type), although leaving them as the default will allow the server to set them automatically.\n\nExamples: * s0:/2 - Allocate labels from s0:c0,c0 to s0:c511,c511 * s0:/2,512 - Allocate labels from s0:c0,c0,c0 to s0:c511,c511,511",
- "type": "string",
- "default": ""
- },
- "mcsLabelsPerProject": {
- "description": "mcsLabelsPerProject defines the number of labels that should be reserved per project. The default is 5 to match the default UID and MCS ranges (100k namespaces, 535k/5 labels).",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "uidAllocatorRange": {
- "description": "uidAllocatorRange defines the total set of Unix user IDs (UIDs) that will be allocated to projects automatically, and the size of the block each namespace gets. For example, 1000-1999/10 will allocate ten UIDs per namespace, and will be able to allocate up to 100 blocks before running out of space. The default is to allocate from 1 billion to 2 billion in 10k blocks (which is the expected size of the ranges container images will use once user namespaces are started).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ServiceAccountConfig": {
- "description": "ServiceAccountConfig holds the necessary configuration options for a service account",
- "type": "object",
- "required": [
- "managedNames",
- "limitSecretReferences",
- "privateKeyFile",
- "publicKeyFiles",
- "masterCA"
- ],
- "properties": {
- "limitSecretReferences": {
- "description": "limitSecretReferences controls whether or not to allow a service account to reference any secret in a namespace without explicitly referencing them",
- "type": "boolean",
- "default": false
- },
- "managedNames": {
- "description": "managedNames is a list of service account names that will be auto-created in every namespace. If no names are specified, the ServiceAccountsController will not be started.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "masterCA": {
- "description": "masterCA is the CA for verifying the TLS connection back to the master. The service account controller will automatically inject the contents of this file into pods so they can verify connections to the master.",
- "type": "string",
- "default": ""
- },
- "privateKeyFile": {
- "description": "privateKeyFile is a file containing a PEM-encoded private RSA key, used to sign service account tokens. If no private key is specified, the service account TokensController will not be started.",
- "type": "string",
- "default": ""
- },
- "publicKeyFiles": {
- "description": "publicKeyFiles is a list of files, each containing a PEM-encoded public RSA key. (If any file contains a private key, the public portion of the key is used) The list of public keys is used to verify presented service account tokens. Each key is tried in order until the list is exhausted or verification succeeds. If no keys are specified, no service account authentication will be available.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ServiceServingCert": {
- "description": "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.",
- "type": "object",
- "required": [
- "signer"
- ],
- "properties": {
- "signer": {
- "description": "signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.",
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.CertInfo"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.ServingInfo": {
- "description": "ServingInfo holds information about serving web pages",
- "type": "object",
- "required": [
- "bindAddress",
- "bindNetwork",
- "certFile",
- "keyFile",
- "clientCA",
- "namedCertificates"
- ],
- "properties": {
- "bindAddress": {
- "description": "bindAddress is the ip:port to serve on",
- "type": "string",
- "default": ""
- },
- "bindNetwork": {
- "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "cipherSuites": {
- "description": "cipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "clientCA": {
- "description": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
- "type": "string",
- "default": ""
- },
- "minTLSVersion": {
- "description": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
- "type": "string"
- },
- "namedCertificates": {
- "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.NamedCertificate"
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.SessionConfig": {
- "description": "SessionConfig specifies options for cookie-based sessions. Used by AuthRequestHandlerSession",
- "type": "object",
- "required": [
- "sessionSecretsFile",
- "sessionMaxAgeSeconds",
- "sessionName"
- ],
- "properties": {
- "sessionMaxAgeSeconds": {
- "description": "sessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "sessionName": {
- "description": "sessionName is the cookie name used to store the session",
- "type": "string",
- "default": ""
- },
- "sessionSecretsFile": {
- "description": "sessionSecretsFile is a reference to a file containing a serialized SessionSecrets object If no file is specified, a random signing and encryption key are generated at each server start",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.SessionSecret": {
- "description": "SessionSecret is a secret used to authenticate/decrypt cookie-based sessions",
- "type": "object",
- "required": [
- "authentication",
- "encryption"
- ],
- "properties": {
- "authentication": {
- "description": "authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.",
- "type": "string",
- "default": ""
- },
- "encryption": {
- "description": "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.SessionSecrets": {
- "description": "SessionSecrets list the secrets to use to sign/encrypt and authenticate/decrypt created sessions.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "secrets"
- ],
- "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",
- "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",
- "type": "string"
- },
- "secrets": {
- "description": "secrets is a list of secrets New sessions are signed and encrypted using the first secret. Existing sessions are decrypted/authenticated by each secret until one succeeds. This allows rotating secrets.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.SessionSecret"
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.SourceStrategyDefaultsConfig": {
- "description": "SourceStrategyDefaultsConfig contains values that apply to builds using the source strategy.",
- "type": "object",
- "properties": {
- "incremental": {
- "description": "incremental indicates if s2i build strategies should perform an incremental build or not",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.StringSource": {
- "description": "StringSource allows specifying a string inline, or externally via env var or file. When it contains only a string value, it marshals to a simple JSON string.",
- "type": "object",
- "required": [
- "value",
- "env",
- "file",
- "keyFile"
- ],
- "properties": {
- "env": {
- "description": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "file": {
- "description": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile references a file containing the key to use to decrypt the value.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.StringSourceSpec": {
- "description": "StringSourceSpec specifies a string value, or external location",
- "type": "object",
- "required": [
- "value",
- "env",
- "file",
- "keyFile"
- ],
- "properties": {
- "env": {
- "description": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "file": {
- "description": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
- "type": "string",
- "default": ""
- },
- "keyFile": {
- "description": "keyFile references a file containing the key to use to decrypt the value.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.TokenConfig": {
- "description": "TokenConfig holds the necessary configuration options for authorization and access tokens",
- "type": "object",
- "required": [
- "authorizeTokenMaxAgeSeconds",
- "accessTokenMaxAgeSeconds"
- ],
- "properties": {
- "accessTokenInactivityTimeoutSeconds": {
- "description": "accessTokenInactivityTimeoutSeconds defined the default token inactivity timeout for tokens granted by any client. Setting it to nil means the feature is completely disabled (default) The default setting can be overridden on OAuthClient basis. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Valid values are: - 0: Tokens never time out - X: Tokens time out if there is no activity for X seconds The current minimum allowed value for X is 300 (5 minutes)",
- "type": "integer",
- "format": "int32"
- },
- "accessTokenMaxAgeSeconds": {
- "description": "accessTokenMaxAgeSeconds defines the maximum age of access tokens",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "authorizeTokenMaxAgeSeconds": {
- "description": "authorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.UserAgentDenyRule": {
- "description": "UserAgentDenyRule adds a rejection message that can be used to help a user figure out how to get an approved client",
- "type": "object",
- "required": [
- "regex",
- "httpVerbs",
- "rejectionMessage"
- ],
- "properties": {
- "httpVerbs": {
- "description": "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "regex": {
- "description": "UserAgentRegex is a regex that is checked against the User-Agent. Known variants of oc clients 1. oc accessing kube resources: oc/v1.2.0 (linux/amd64) kubernetes/bc4550d 2. oc accessing openshift resources: oc/v1.1.3 (linux/amd64) openshift/b348c2f 3. openshift kubectl accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 4. openshift kubectl accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f 5. oadm accessing kube resources: oadm/v1.2.0 (linux/amd64) kubernetes/bc4550d 6. oadm accessing openshift resources: oadm/v1.1.3 (linux/amd64) openshift/b348c2f 7. openshift cli accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 8. openshift cli accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f",
- "type": "string",
- "default": ""
- },
- "rejectionMessage": {
- "description": "rejectionMessage is the message shown when rejecting a client. If it is not a set, the default message is used.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.UserAgentMatchRule": {
- "description": "UserAgentMatchRule describes how to match a given request based on User-Agent and HTTPVerb",
- "type": "object",
- "required": [
- "regex",
- "httpVerbs"
- ],
- "properties": {
- "httpVerbs": {
- "description": "httpVerbs specifies which HTTP verbs should be matched. An empty list means \"match all verbs\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "regex": {
- "description": "UserAgentRegex is a regex that is checked against the User-Agent. Known variants of oc clients 1. oc accessing kube resources: oc/v1.2.0 (linux/amd64) kubernetes/bc4550d 2. oc accessing openshift resources: oc/v1.1.3 (linux/amd64) openshift/b348c2f 3. openshift kubectl accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 4. openshift kubectl accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f 5. oadm accessing kube resources: oadm/v1.2.0 (linux/amd64) kubernetes/bc4550d 6. oadm accessing openshift resources: oadm/v1.1.3 (linux/amd64) openshift/b348c2f 7. openshift cli accessing kube resources: openshift/v1.2.0 (linux/amd64) kubernetes/bc4550d 8. openshift cli accessing openshift resources: openshift/v1.1.3 (linux/amd64) openshift/b348c2f",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.UserAgentMatchingConfig": {
- "description": "UserAgentMatchingConfig controls how API calls from *voluntarily* identifying clients will be handled. THIS DOES NOT DEFEND AGAINST MALICIOUS CLIENTS!",
- "type": "object",
- "required": [
- "requiredClients",
- "deniedClients",
- "defaultRejectionMessage"
- ],
- "properties": {
- "defaultRejectionMessage": {
- "description": "defaultRejectionMessage is the message shown when rejecting a client. If it is not a set, a generic message is given.",
- "type": "string",
- "default": ""
- },
- "deniedClients": {
- "description": "If this list is non-empty, then a User-Agent must not match any of the UserAgentRegexes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.UserAgentDenyRule"
- }
- },
- "requiredClients": {
- "description": "If this list is non-empty, then a User-Agent must match one of the UserAgentRegexes to be allowed",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.legacyconfig.v1.UserAgentMatchRule"
- }
- }
- }
- },
- "com.github.openshift.api.legacyconfig.v1.WebhookTokenAuthenticator": {
- "description": "WebhookTokenAuthenticators holds the necessary configuation options for external token authenticators",
- "type": "object",
- "required": [
- "configFile",
- "cacheTTL"
- ],
- "properties": {
- "cacheTTL": {
- "description": "cacheTTL indicates how long an authentication result should be cached. It takes a valid time duration string (e.g. \"5m\"). If empty, you get a default timeout of 2 minutes. If zero (e.g. \"0m\"), caching is disabled",
- "type": "string",
- "default": ""
- },
- "configFile": {
- "description": "configFile is a path to a Kubeconfig file with the webhook configuration",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.AWSFailureDomain": {
- "description": "AWSFailureDomain configures failure domain information for the AWS platform.",
- "type": "object",
- "properties": {
- "placement": {
- "description": "placement configures the placement information for this instance.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AWSFailureDomainPlacement"
- },
- "subnet": {
- "description": "subnet is a reference to the subnet to use for this instance.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AWSResourceReference"
- }
- }
- },
- "com.github.openshift.api.machine.v1.AWSFailureDomainPlacement": {
- "description": "AWSFailureDomainPlacement configures the placement information for the AWSFailureDomain.",
- "type": "object",
- "required": [
- "availabilityZone"
- ],
- "properties": {
- "availabilityZone": {
- "description": "availabilityZone is the availability zone of the instance.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.AWSResourceFilter": {
- "description": "AWSResourceFilter is a filter used to identify an AWS resource",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name of the filter. Filter names are case-sensitive.",
- "type": "string",
- "default": ""
- },
- "values": {
- "description": "values includes one or more filter values. Filter values are case-sensitive.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.machine.v1.AWSResourceReference": {
- "description": "AWSResourceReference is a reference to a specific AWS resource by ID, ARN, or filters. Only one of ID, ARN or Filters may be specified. Specifying more than one will result in a validation error.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "arn": {
- "description": "arn of resource.",
- "type": "string"
- },
- "filters": {
- "description": "filters is a set of filters used to identify a resource.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AWSResourceFilter"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "id": {
- "description": "id of resource.",
- "type": "string"
- },
- "type": {
- "description": "type determines how the reference will fetch the AWS resource.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "arn": "ARN",
- "filters": "Filters",
- "id": "ID"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1.AlibabaCloudMachineProviderConfig": {
- "description": "AlibabaCloudMachineProviderConfig is the Schema for the alibabacloudmachineproviderconfig API Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "instanceType",
- "vpcId",
- "regionId",
- "zoneId",
- "imageId",
- "vSwitch",
- "resourceGroup"
- ],
- "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",
- "type": "string"
- },
- "bandwidth": {
- "description": "bandwidth describes the internet bandwidth strategy for the instance",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.BandwidthProperties"
- },
- "credentialsSecret": {
- "description": "credentialsSecret is a reference to the secret with alibabacloud credentials. Otherwise, defaults to permissions provided by attached RAM role where the actuator is running.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "dataDisk": {
- "description": "DataDisks holds information regarding the extra disks attached to the instance",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.DataDiskProperties"
- }
- },
- "imageId": {
- "description": "The ID of the image used to create the instance.",
- "type": "string",
- "default": ""
- },
- "instanceType": {
- "description": "The instance type of the instance.",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "ramRoleName": {
- "description": "ramRoleName is the name of the instance Resource Access Management (RAM) role. This allows the instance to perform API calls as this specified RAM role.",
- "type": "string"
- },
- "regionId": {
- "description": "The ID of the region in which to create the instance. You can call the DescribeRegions operation to query the most recent region list.",
- "type": "string",
- "default": ""
- },
- "resourceGroup": {
- "description": "resourceGroup references the resource group to which to assign the instance. A reference holds either the resource group ID, the resource name, or the required tags to search. When more than one resource group are returned for a search, an error will be produced and the Machine will not be created. Resource Groups do not support searching by tags.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AlibabaResourceReference"
- },
- "securityGroups": {
- "description": "securityGroups is a list of security group references to assign to the instance. A reference holds either the security group ID, the resource name, or the required tags to search. When more than one security group is returned for a tag search, all the groups are associated with the instance up to the maximum number of security groups to which an instance can belong. For more information, see the \"Security group limits\" section in Limits. https://www.alibabacloud.com/help/en/doc-detail/25412.htm",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AlibabaResourceReference"
- }
- },
- "systemDisk": {
- "description": "systemDisk holds the properties regarding the system disk for the instance",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.SystemDiskProperties"
- },
- "tag": {
- "description": "Tags are the set of metadata to add to an instance.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.Tag"
- }
- },
- "tenancy": {
- "description": "tenancy specifies whether to create the instance on a dedicated host. Valid values:\n\ndefault: creates the instance on a non-dedicated host. host: creates the instance on a dedicated host. If you do not specify the DedicatedHostID parameter, Alibaba Cloud automatically selects a dedicated host for the instance. Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `default`.",
- "type": "string"
- },
- "userDataSecret": {
- "description": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "vSwitch": {
- "description": "vSwitch is a reference to the vswitch to use for this instance. A reference holds either the vSwitch ID, the resource name, or the required tags to search. When more than one vSwitch is returned for a tag search, only the first vSwitch returned will be used. This parameter is required when you create an instance of the VPC type. You can call the DescribeVSwitches operation to query the created vSwitches.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AlibabaResourceReference"
- },
- "vpcId": {
- "description": "The ID of the vpc",
- "type": "string",
- "default": ""
- },
- "zoneId": {
- "description": "The ID of the zone in which to create the instance. You can call the DescribeZones operation to query the most recent region list.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.AlibabaCloudMachineProviderConfigList": {
- "description": "AlibabaCloudMachineProviderConfigList contains a list of AlibabaCloudMachineProviderConfig Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AlibabaCloudMachineProviderConfig"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1.AlibabaCloudMachineProviderStatus": {
- "description": "AlibabaCloudMachineProviderStatus is the Schema for the alibabacloudmachineproviderconfig API Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "instanceId": {
- "description": "instanceId is the instance ID of the machine created in alibabacloud",
- "type": "string"
- },
- "instanceState": {
- "description": "instanceState is the state of the alibabacloud instance for this machine",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1.AlibabaResourceReference": {
- "description": "ResourceTagReference is a reference to a specific AlibabaCloud resource by ID, or tags. Only one of ID or Tags may be specified. Specifying more than one will result in a validation error.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "id": {
- "description": "id of resource",
- "type": "string"
- },
- "name": {
- "description": "name of the resource",
- "type": "string"
- },
- "tags": {
- "description": "tags is a set of metadata based upon ECS object tags used to identify a resource. For details about usage when multiple resources are found, please see the owning parent field documentation.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.Tag"
- }
- },
- "type": {
- "description": "type identifies the resource reference type for this entry.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.AzureFailureDomain": {
- "description": "AzureFailureDomain configures failure domain information for the Azure platform.",
- "type": "object",
- "required": [
- "zone"
- ],
- "properties": {
- "subnet": {
- "description": "subnet is the name of the network subnet in which the VM will be created. When omitted, the subnet value from the machine providerSpec template will be used.",
- "type": "string"
- },
- "zone": {
- "description": "Availability Zone for the virtual machine. If nil, the virtual machine should be deployed to no zone.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.BandwidthProperties": {
- "description": "Bandwidth describes the bandwidth strategy for the network of the instance",
- "type": "object",
- "properties": {
- "internetMaxBandwidthIn": {
- "description": "internetMaxBandwidthIn is the maximum inbound public bandwidth. Unit: Mbit/s. Valid values: When the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, the valid values of this parameter are 1 to 10. Currently the default is `10` when outbound bandwidth is less than or equal to 10 Mbit/s. When the purchased outbound public bandwidth is greater than 10, the valid values are 1 to the InternetMaxBandwidthOut value. Currently the default is the value used for `InternetMaxBandwidthOut` when outbound public bandwidth is greater than 10.",
- "type": "integer",
- "format": "int64"
- },
- "internetMaxBandwidthOut": {
- "description": "internetMaxBandwidthOut is the maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100. When a value greater than 0 is used then a public IP address is assigned to the instance. Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `0`",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.machine.v1.ControlPlaneMachineSet": {
- "description": "ControlPlaneMachineSet ensures that a specified number of control plane machine replicas are running at any given time. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.ControlPlaneMachineSetSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.ControlPlaneMachineSetStatus"
- }
- }
- },
- "com.github.openshift.api.machine.v1.ControlPlaneMachineSetList": {
- "description": "ControlPlaneMachineSetList contains a list of ControlPlaneMachineSet Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.ControlPlaneMachineSet"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1.ControlPlaneMachineSetSpec": {
- "description": "ControlPlaneMachineSet represents the configuration of the ControlPlaneMachineSet.",
- "type": "object",
- "required": [
- "replicas",
- "selector",
- "template"
- ],
- "properties": {
- "machineNamePrefix": {
- "description": "machineNamePrefix is the prefix used when creating machine names. Each machine name will consist of this prefix, followed by a randomly generated string of 5 characters, and the index of the machine. It must be a lowercase RFC 1123 subdomain, consisting of lowercase alphanumeric characters, hyphens ('-'), and periods ('.'). Each block, separated by periods, must start and end with an alphanumeric character. Hyphens are not allowed at the start or end of a block, and consecutive periods are not permitted. The prefix must be between 1 and 245 characters in length. For example, if machineNamePrefix is set to 'control-plane', and three machines are created, their names might be: control-plane-abcde-0, control-plane-fghij-1, control-plane-klmno-2",
- "type": "string"
- },
- "replicas": {
- "description": "replicas defines how many Control Plane Machines should be created by this ControlPlaneMachineSet. This field is immutable and cannot be changed after cluster installation. The ControlPlaneMachineSet only operates with 3 or 5 node control planes, 3 and 5 are the only valid values for this field.",
- "type": "integer",
- "format": "int32"
- },
- "selector": {
- "description": "Label selector for Machines. Existing Machines selected by this selector will be the ones affected by this ControlPlaneMachineSet. It must match the template's labels. This field is considered immutable after creation of the resource.",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "state": {
- "description": "state defines whether the ControlPlaneMachineSet is Active or Inactive. When Inactive, the ControlPlaneMachineSet will not take any action on the state of the Machines within the cluster. When Active, the ControlPlaneMachineSet will reconcile the Machines and will update the Machines as necessary. Once Active, a ControlPlaneMachineSet cannot be made Inactive. To prevent further action please remove the ControlPlaneMachineSet.",
- "type": "string",
- "default": "Inactive"
- },
- "strategy": {
- "description": "strategy defines how the ControlPlaneMachineSet will update Machines when it detects a change to the ProviderSpec.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.ControlPlaneMachineSetStrategy"
- },
- "template": {
- "description": "template describes the Control Plane Machines that will be created by this ControlPlaneMachineSet.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.ControlPlaneMachineSetTemplate"
- }
- }
- },
- "com.github.openshift.api.machine.v1.ControlPlaneMachineSetStatus": {
- "description": "ControlPlaneMachineSetStatus represents the status of the ControlPlaneMachineSet CRD.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions represents the observations of the ControlPlaneMachineSet's current state. Known .status.conditions.type are: Available, Degraded and Progressing.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "observedGeneration": {
- "description": "observedGeneration is the most recent generation observed for this ControlPlaneMachineSet. It corresponds to the ControlPlaneMachineSets's generation, which is updated on mutation by the API Server.",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas is the number of Control Plane Machines created by the ControlPlaneMachineSet controller which are ready. Note that this value may be higher than the desired number of replicas while rolling updates are in-progress.",
- "type": "integer",
- "format": "int32"
- },
- "replicas": {
- "description": "replicas is the number of Control Plane Machines created by the ControlPlaneMachineSet controller. Note that during update operations this value may differ from the desired replica count.",
- "type": "integer",
- "format": "int32"
- },
- "unavailableReplicas": {
- "description": "unavailableReplicas is the number of Control Plane Machines that are still required before the ControlPlaneMachineSet reaches the desired available capacity. When this value is non-zero, the number of ReadyReplicas is less than the desired Replicas.",
- "type": "integer",
- "format": "int32"
- },
- "updatedReplicas": {
- "description": "updatedReplicas is the number of non-terminated Control Plane Machines created by the ControlPlaneMachineSet controller that have the desired provider spec and are ready. This value is set to 0 when a change is detected to the desired spec. When the update strategy is RollingUpdate, this will also coincide with starting the process of updating the Machines. When the update strategy is OnDelete, this value will remain at 0 until a user deletes an existing replica and its replacement has become ready.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.machine.v1.ControlPlaneMachineSetStrategy": {
- "description": "ControlPlaneMachineSetStrategy defines the strategy for applying updates to the Control Plane Machines managed by the ControlPlaneMachineSet.",
- "type": "object",
- "properties": {
- "type": {
- "description": "type defines the type of update strategy that should be used when updating Machines owned by the ControlPlaneMachineSet. Valid values are \"RollingUpdate\" and \"OnDelete\". The current default value is \"RollingUpdate\".",
- "type": "string",
- "default": "RollingUpdate"
- }
- }
- },
- "com.github.openshift.api.machine.v1.ControlPlaneMachineSetTemplate": {
- "description": "ControlPlaneMachineSetTemplate is a template used by the ControlPlaneMachineSet to create the Machines that it will manage in the future.",
- "type": "object",
- "required": [
- "machineType"
- ],
- "properties": {
- "machineType": {
- "description": "machineType determines the type of Machines that should be managed by the ControlPlaneMachineSet. Currently, the only valid value is machines_v1beta1_machine_openshift_io.",
- "type": "string",
- "default": ""
- },
- "machines_v1beta1_machine_openshift_io": {
- "description": "OpenShiftMachineV1Beta1Machine defines the template for creating Machines from the v1beta1.machine.openshift.io API group.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.OpenShiftMachineV1Beta1MachineTemplate"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "machineType",
- "fields-to-discriminateBy": {
- "machines_v1beta1_machine_openshift_io": "OpenShiftMachineV1Beta1Machine"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1.ControlPlaneMachineSetTemplateObjectMeta": {
- "description": "ControlPlaneMachineSetTemplateObjectMeta is a subset of the metav1.ObjectMeta struct. It allows users to specify labels and annotations that will be copied onto Machines created from this template.",
- "type": "object",
- "required": [
- "labels"
- ],
- "properties": {
- "annotations": {
- "description": "annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "labels": {
- "description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels. This field must contain both the 'machine.openshift.io/cluster-api-machine-role' and 'machine.openshift.io/cluster-api-machine-type' labels, both with a value of 'master'. It must also contain a label with the key 'machine.openshift.io/cluster-api-cluster'.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.machine.v1.DataDiskProperties": {
- "description": "DataDisk contains the information regarding the datadisk attached to an instance",
- "type": "object",
- "properties": {
- "Category": {
- "description": "Category describes the type of data disk N. Valid values: cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: ESSD cloud: basic disk Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently for non-I/O optimized instances of retired instance types, the default is `cloud`. Currently for other instances, the default is `cloud_efficiency`.",
- "type": "string",
- "default": ""
- },
- "DiskEncryption": {
- "description": "DiskEncryption specifies whether to encrypt data disk N.\n\nEmpty value means the platform chooses a default, which is subject to change over time. Currently the default is `disabled`.",
- "type": "string",
- "default": ""
- },
- "DiskPreservation": {
- "description": "DiskPreservation specifies whether to release data disk N along with the instance. Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `DeleteWithInstance`",
- "type": "string",
- "default": ""
- },
- "KMSKeyID": {
- "description": "KMSKeyID is the ID of the Key Management Service (KMS) key to be used by data disk N. Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently the default is `\"\"` which is interpreted as do not use KMSKey encryption.",
- "type": "string",
- "default": ""
- },
- "Name": {
- "description": "Name is the name of data disk N. If the name is specified the name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).\n\nEmpty value means the platform chooses a default, which is subject to change over time. Currently the default is `\"\"`.",
- "type": "string",
- "default": ""
- },
- "PerformanceLevel": {
- "description": "PerformanceLevel is the performance level of the ESSD used as as data disk N. The N value must be the same as that in DataDisk.N.Category when DataDisk.N.Category is set to cloud_essd. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is `PL1`. Valid values:\n\nPL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. For more information about ESSD performance levels, see ESSDs.",
- "type": "string",
- "default": ""
- },
- "Size": {
- "description": "Size of the data disk N. Valid values of N: 1 to 16. Unit: GiB. Valid values:\n\nValid values when DataDisk.N.Category is set to cloud_efficiency: 20 to 32768 Valid values when DataDisk.N.Category is set to cloud_ssd: 20 to 32768 Valid values when DataDisk.N.Category is set to cloud_essd: 20 to 32768 Valid values when DataDisk.N.Category is set to cloud: 5 to 2000 The value of this parameter must be greater than or equal to the size of the snapshot specified by the SnapshotID parameter.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "SnapshotID": {
- "description": "SnapshotID is the ID of the snapshot used to create data disk N. Valid values of N: 1 to 16.\n\nWhen the DataDisk.N.SnapshotID parameter is specified, the DataDisk.N.Size parameter is ignored. The data disk is created based on the size of the specified snapshot. Use snapshots created after July 15, 2013. Otherwise, an error is returned and your request is rejected.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.FailureDomains": {
- "description": "FailureDomain represents the different configurations required to spread Machines across failure domains on different platforms.",
- "type": "object",
- "required": [
- "platform"
- ],
- "properties": {
- "aws": {
- "description": "aws configures failure domain information for the AWS platform.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AWSFailureDomain"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "azure": {
- "description": "azure configures failure domain information for the Azure platform.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.AzureFailureDomain"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "gcp": {
- "description": "gcp configures failure domain information for the GCP platform.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.GCPFailureDomain"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "nutanix": {
- "description": "nutanix configures failure domain information for the Nutanix platform.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixFailureDomainReference"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "openstack": {
- "description": "openstack configures failure domain information for the OpenStack platform.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.OpenStackFailureDomain"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "platform": {
- "description": "platform identifies the platform for which the FailureDomain represents. Currently supported values are AWS, Azure, GCP, OpenStack, VSphere and Nutanix.",
- "type": "string",
- "default": ""
- },
- "vsphere": {
- "description": "vsphere configures failure domain information for the VSphere platform.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.VSphereFailureDomain"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "platform",
- "fields-to-discriminateBy": {
- "aws": "AWS",
- "azure": "Azure",
- "gcp": "GCP",
- "nutanix": "Nutanix",
- "openstack": "OpenStack",
- "vsphere": "VSphere"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1.GCPFailureDomain": {
- "description": "GCPFailureDomain configures failure domain information for the GCP platform",
- "type": "object",
- "required": [
- "zone"
- ],
- "properties": {
- "zone": {
- "description": "zone is the zone in which the GCP machine provider will create the VM.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.LoadBalancerReference": {
- "description": "LoadBalancerReference is a reference to a load balancer on IBM Cloud virtual private cloud(VPC).",
- "type": "object",
- "required": [
- "name",
- "type"
- ],
- "properties": {
- "name": {
- "description": "name of the LoadBalancer in IBM Cloud VPC. The name should be between 1 and 63 characters long and may consist of lowercase alphanumeric characters and hyphens only. The value must not end with a hyphen. It is a reference to existing LoadBalancer created by openshift installer component.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type of the LoadBalancer service supported by IBM Cloud VPC. Currently, only Application LoadBalancer is supported. More details about Application LoadBalancer https://cloud.ibm.com/docs/vpc?topic=vpc-load-balancers-about&interface=ui Supported values are Application.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.NutanixCategory": {
- "description": "NutanixCategory identifies a pair of prism category key and value",
- "type": "object",
- "required": [
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key is the prism category key name",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value is the prism category value associated with the key",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.NutanixFailureDomainReference": {
- "description": "NutanixFailureDomainReference refers to the failure domain of the Nutanix platform.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name of the failure domain in which the nutanix machine provider will create the VM. Failure domains are defined in a cluster's config.openshift.io/Infrastructure resource.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.NutanixGPU": {
- "description": "NutanixGPU holds the identity of a Nutanix GPU resource in the Prism Central",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "deviceID": {
- "description": "deviceID is the GPU device ID with the integer value.",
- "type": "integer",
- "format": "int32"
- },
- "name": {
- "description": "name is the GPU device name",
- "type": "string"
- },
- "type": {
- "description": "type is the identifier type of the GPU device. Valid values are Name and DeviceID.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "deviceID": "DeviceID",
- "name": "Name"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1.NutanixMachineProviderConfig": {
- "description": "NutanixMachineProviderConfig is the Schema for the nutanixmachineproviderconfigs API Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "cluster",
- "image",
- "subnets",
- "vcpusPerSocket",
- "vcpuSockets",
- "memorySize",
- "systemDiskSize",
- "credentialsSecret"
- ],
- "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",
- "type": "string"
- },
- "bootType": {
- "description": "bootType indicates the boot type (Legacy, UEFI or SecureBoot) the Machine's VM uses to boot. If this field is empty or omitted, the VM will use the default boot type \"Legacy\" to boot. \"SecureBoot\" depends on \"UEFI\" boot, i.e., enabling \"SecureBoot\" means that \"UEFI\" boot is also enabled.",
- "type": "string",
- "default": ""
- },
- "categories": {
- "description": "categories optionally adds one or more prism categories (each with key and value) for the Machine's VM to associate with. All the category key and value pairs specified must already exist in the prism central.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixCategory"
- },
- "x-kubernetes-list-map-keys": [
- "key"
- ],
- "x-kubernetes-list-type": "map"
- },
- "cluster": {
- "description": "cluster is to identify the cluster (the Prism Element under management of the Prism Central), in which the Machine's VM will be created. The cluster identifier (uuid or name) can be obtained from the Prism Central console or using the prism_central API.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixResourceIdentifier"
- },
- "credentialsSecret": {
- "description": "credentialsSecret is a local reference to a secret that contains the credentials data to access Nutanix PC client",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "dataDisks": {
- "description": "dataDisks holds information of the data disks to attach to the Machine's VM",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixVMDisk"
- },
- "x-kubernetes-list-type": "set"
- },
- "failureDomain": {
- "description": "failureDomain refers to the name of the FailureDomain with which this Machine is associated. If this is configured, the Nutanix machine controller will use the prism_central endpoint and credentials defined in the referenced FailureDomain to communicate to the prism_central. It will also verify that the 'cluster' and subnets' configuration in the NutanixMachineProviderConfig is consistent with that in the referenced failureDomain.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixFailureDomainReference"
- },
- "gpus": {
- "description": "gpus is a list of GPU devices to attach to the machine's VM. The GPU devices should already exist in Prism Central and associated with one of the Prism Element's hosts and available for the VM to attach (in \"UNUSED\" status).",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixGPU"
- },
- "x-kubernetes-list-type": "set"
- },
- "image": {
- "description": "image is to identify the rhcos image uploaded to the Prism Central (PC) The image identifier (uuid or name) can be obtained from the Prism Central console or using the prism_central API.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixResourceIdentifier"
- },
- "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",
- "type": "string"
- },
- "memorySize": {
- "description": "memorySize is the memory size (in Quantity format) of the VM The minimum memorySize is 2Gi bytes",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "project": {
- "description": "project optionally identifies a Prism project for the Machine's VM to associate with.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixResourceIdentifier"
- },
- "subnets": {
- "description": "subnets holds a list of identifiers (one or more) of the cluster's network subnets for the Machine's VM to connect to. The subnet identifiers (uuid or name) can be obtained from the Prism Central console or using the prism_central API.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixResourceIdentifier"
- }
- },
- "systemDiskSize": {
- "description": "systemDiskSize is size (in Quantity format) of the system disk of the VM The minimum systemDiskSize is 20Gi bytes",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
- },
- "userDataSecret": {
- "description": "userDataSecret is a local reference to a secret that contains the UserData to apply to the VM",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "vcpuSockets": {
- "description": "vcpuSockets is the number of vCPU sockets of the VM",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "vcpusPerSocket": {
- "description": "vcpusPerSocket is the number of vCPUs per socket of the VM",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.machine.v1.NutanixMachineProviderStatus": {
- "description": "NutanixMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains nutanix-specific status information. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "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",
- "type": "string"
- },
- "vmUUID": {
- "description": "vmUUID is the Machine associated VM's UUID The field is missing before the VM is created. Once the VM is created, the field is filled with the VM's UUID and it will not change. The vmUUID is used to find the VM when updating the Machine status, and to delete the VM when the Machine is deleted.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1.NutanixResourceIdentifier": {
- "description": "NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.)",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "name": {
- "description": "name is the resource name in the PC",
- "type": "string"
- },
- "type": {
- "description": "type is the identifier type to use for this resource.",
- "type": "string",
- "default": ""
- },
- "uuid": {
- "description": "uuid is the UUID of the resource in the PC.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "name": "Name",
- "uuid": "UUID"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1.NutanixStorageResourceIdentifier": {
- "description": "NutanixStorageResourceIdentifier holds the identity of a Nutanix storage resource (storage_container, etc.)",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "type is the identifier type to use for this resource. The valid value is \"uuid\".",
- "type": "string",
- "default": ""
- },
- "uuid": {
- "description": "uuid is the UUID of the storage resource in the PC.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "uuid": "UUID"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1.NutanixVMDisk": {
- "description": "NutanixDataDisk specifies the VM data disk configuration parameters.",
- "type": "object",
- "required": [
- "diskSize"
- ],
- "properties": {
- "dataSource": {
- "description": "dataSource refers to a data source image for the VM disk.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixResourceIdentifier"
- },
- "deviceProperties": {
- "description": "deviceProperties are the properties of the disk device.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixVMDiskDeviceProperties"
- },
- "diskSize": {
- "description": "diskSize is size (in Quantity format) of the disk attached to the VM. See https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Format for the Quantity format and example documentation. The minimum diskSize is 1GB.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
- },
- "storageConfig": {
- "description": "storageConfig are the storage configuration parameters of the VM disks.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixVMStorageConfig"
- }
- }
- },
- "com.github.openshift.api.machine.v1.NutanixVMDiskDeviceProperties": {
- "description": "NutanixVMDiskDeviceProperties specifies the disk device properties.",
- "type": "object",
- "required": [
- "deviceType",
- "adapterType",
- "deviceIndex"
- ],
- "properties": {
- "adapterType": {
- "description": "adapterType is the adapter type of the disk address. If the deviceType is \"Disk\", the valid adapterType can be \"SCSI\", \"IDE\", \"PCI\", \"SATA\" or \"SPAPR\". If the deviceType is \"CDRom\", the valid adapterType can be \"IDE\" or \"SATA\".",
- "type": "string",
- "default": ""
- },
- "deviceIndex": {
- "description": "deviceIndex is the index of the disk address. The valid values are non-negative integers, with the default value 0. For a Machine VM, the deviceIndex for the disks with the same deviceType.adapterType combination should start from 0 and increase consecutively afterwards. Note that for each Machine VM, the Disk.SCSI.0 and CDRom.IDE.0 are reserved to be used by the VM's system. So for dataDisks of Disk.SCSI and CDRom.IDE, the deviceIndex should start from 1.",
- "type": "integer",
- "format": "int32"
- },
- "deviceType": {
- "description": "deviceType specifies the disk device type. The valid values are \"Disk\" and \"CDRom\", and the default is \"Disk\".",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.NutanixVMStorageConfig": {
- "description": "NutanixVMStorageConfig specifies the storage configuration parameters for VM disks.",
- "type": "object",
- "required": [
- "diskMode"
- ],
- "properties": {
- "diskMode": {
- "description": "diskMode specifies the disk mode. The valid values are Standard and Flash, and the default is Standard.",
- "type": "string",
- "default": ""
- },
- "storageContainer": {
- "description": "storageContainer refers to the storage_container used by the VM disk.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.NutanixStorageResourceIdentifier"
- }
- }
- },
- "com.github.openshift.api.machine.v1.OpenShiftMachineV1Beta1MachineTemplate": {
- "description": "OpenShiftMachineV1Beta1MachineTemplate is a template for the ControlPlaneMachineSet to create Machines from the v1beta1.machine.openshift.io API group.",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "properties": {
- "failureDomains": {
- "description": "failureDomains is the list of failure domains (sometimes called availability zones) in which the ControlPlaneMachineSet should balance the Control Plane Machines. This will be merged into the ProviderSpec given in the template. This field is optional on platforms that do not require placement information.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.FailureDomains"
- },
- "metadata": {
- "description": "ObjectMeta is the standard object metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata Labels are required to match the ControlPlaneMachineSet selector.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.ControlPlaneMachineSetTemplateObjectMeta"
- },
- "spec": {
- "description": "spec contains the desired configuration of the Control Plane Machines. The ProviderSpec within contains platform specific details for creating the Control Plane Machines. The ProviderSe should be complete apart from the platform specific failure domain field. This will be overridden when the Machines are created based on the FailureDomains field.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineSpec"
- }
- }
- },
- "com.github.openshift.api.machine.v1.OpenStackFailureDomain": {
- "description": "OpenStackFailureDomain configures failure domain information for the OpenStack platform.",
- "type": "object",
- "properties": {
- "availabilityZone": {
- "description": "availabilityZone is the nova availability zone in which the OpenStack machine provider will create the VM. If not specified, the VM will be created in the default availability zone specified in the nova configuration. Availability zone names must NOT contain : since it is used by admin users to specify hosts where instances are launched in server creation. Also, it must not contain spaces otherwise it will lead to node that belongs to this availability zone register failure, see kubernetes/cloud-provider-openstack#1379 for further information. The maximum length of availability zone name is 63 as per labels limits.",
- "type": "string"
- },
- "rootVolume": {
- "description": "rootVolume contains settings that will be used by the OpenStack machine provider to create the root volume attached to the VM. If not specified, no root volume will be created.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.RootVolume"
- }
- }
- },
- "com.github.openshift.api.machine.v1.PowerVSMachineProviderConfig": {
- "description": "PowerVSMachineProviderConfig is the type that will be embedded in a Machine.Spec.ProviderSpec field for a PowerVS virtual machine. It is used by the PowerVS machine actuator to create a single Machine.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "serviceInstance",
- "image",
- "network",
- "keyPairName"
- ],
- "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",
- "type": "string"
- },
- "credentialsSecret": {
- "description": "credentialsSecret is a reference to the secret with IBM Cloud credentials.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.PowerVSSecretReference"
- },
- "image": {
- "description": "image is to identify the rhcos image uploaded to IBM COS bucket which is used to create the instance. supported image identifier in PowerVSResource are Name and ID and that can be obtained from IBM Cloud UI or IBM Cloud cli.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.PowerVSResource"
- },
- "keyPairName": {
- "description": "keyPairName is the name of the KeyPair to use for SSH. The key pair will be exposed to the instance via the instance metadata service. On boot, the OS will copy the public keypair into the authorized keys for the core user.",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- },
- "loadBalancers": {
- "description": "loadBalancers is the set of load balancers to which the new control plane instance should be added once it is created.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.LoadBalancerReference"
- }
- },
- "memoryGiB": {
- "description": "memoryGiB is the size of a virtual machine's memory, in GiB. maximum value for the MemoryGiB depends on the selected SystemType. when SystemType is set to e880 maximum MemoryGiB value is 7463 GiB. when SystemType is set to e980 maximum MemoryGiB value is 15307 GiB. when SystemType is set to s922 maximum MemoryGiB value is 942 GiB. The minimum memory is 32 GiB. When omitted, this means the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 32.",
- "type": "integer",
- "format": "int32"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "network": {
- "description": "network is the reference to the Network to use for this instance. supported network identifier in PowerVSResource are Name, ID and RegEx and that can be obtained from IBM Cloud UI or IBM Cloud cli.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.PowerVSResource"
- },
- "processorType": {
- "description": "processorType is the VM instance processor type. It must be set to one of the following values: Dedicated, Capped or Shared. Dedicated: resources are allocated for a specific client, The hypervisor makes a 1:1 binding of a partition’s processor to a physical processor core. Shared: Shared among other clients. Capped: Shared, but resources do not expand beyond those that are requested, the amount of CPU time is Capped to the value specified for the entitlement. if the processorType is selected as Dedicated, then processors value cannot be fractional. When omitted, this means that the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is Shared.",
- "type": "string"
- },
- "processors": {
- "description": "processors is the number of virtual processors in a virtual machine. when the processorType is selected as Dedicated the processors value cannot be fractional. maximum value for the Processors depends on the selected SystemType. when SystemType is set to e880 or e980 maximum Processors value is 143. when SystemType is set to s922 maximum Processors value is 15. minimum value for Processors depends on the selected ProcessorType. when ProcessorType is set as Shared or Capped, The minimum processors is 0.5. when ProcessorType is set as Dedicated, The minimum processors is 1. When omitted, this means that the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The default is set based on the selected ProcessorType. when ProcessorType selected as Dedicated, the default is set to 1. when ProcessorType selected as Shared or Capped, the default is set to 0.5.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
- },
- "serviceInstance": {
- "description": "serviceInstance is the reference to the Power VS service on which the server instance(VM) will be created. Power VS service is a container for all Power VS instances at a specific geographic region. serviceInstance can be created via IBM Cloud catalog or CLI. supported serviceInstance identifier in PowerVSResource are Name and ID and that can be obtained from IBM Cloud UI or IBM Cloud cli. More detail about Power VS service instance. https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-creating-power-virtual-server",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.PowerVSResource"
- },
- "systemType": {
- "description": "systemType is the System type used to host the instance. systemType determines the number of cores and memory that is available. Few of the supported SystemTypes are s922,e880,e980. e880 systemType available only in Dallas Datacenters. e980 systemType available in Datacenters except Dallas and Washington. When omitted, this means that the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is s922 which is generally available.",
- "type": "string"
- },
- "userDataSecret": {
- "description": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1.PowerVSSecretReference"
- }
- }
- },
- "com.github.openshift.api.machine.v1.PowerVSMachineProviderStatus": {
- "description": "PowerVSMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains PowerVS-specific status information.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "instanceId": {
- "description": "instanceId is the instance ID of the machine created in PowerVS instanceId uniquely identifies a Power VS server instance(VM) under a Power VS service. This will help in updating or deleting a VM in Power VS Cloud",
- "type": "string"
- },
- "instanceState": {
- "description": "instanceState is the state of the PowerVS instance for this machine Possible instance states are Active, Build, ShutOff, Reboot This is used to display additional information to user regarding instance current state",
- "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",
- "type": "string"
- },
- "serviceInstanceID": {
- "description": "serviceInstanceID is the reference to the Power VS ServiceInstance on which the machine instance will be created. serviceInstanceID uniquely identifies the Power VS service By setting serviceInstanceID it will become easy and efficient to fetch a server instance(VM) within Power VS Cloud.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1.PowerVSResource": {
- "description": "PowerVSResource is a reference to a specific PowerVS resource by ID, Name or RegEx Only one of ID, Name or RegEx may be specified. Specifying more than one will result in a validation error.",
- "type": "object",
- "properties": {
- "id": {
- "description": "id of resource",
- "type": "string"
- },
- "name": {
- "description": "name of resource",
- "type": "string"
- },
- "regex": {
- "description": "regex to find resource Regex contains the pattern to match to find a resource",
- "type": "string"
- },
- "type": {
- "description": "type identifies the resource type for this entry. Valid values are ID, Name and RegEx",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "fields-to-discriminateBy": {
- "id": "ID",
- "name": "Name",
- "regex": "RegEx",
- "type": "Type"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1.PowerVSSecretReference": {
- "description": "PowerVSSecretReference contains enough information to locate the referenced secret inside the same namespace.",
- "type": "object",
- "properties": {
- "name": {
- "description": "name of the secret.",
- "type": "string"
- }
- },
- "x-kubernetes-map-type": "atomic"
- },
- "com.github.openshift.api.machine.v1.RootVolume": {
- "description": "RootVolume represents the volume metadata to boot from. The original RootVolume struct is defined in the v1alpha1 but it's not best practice to use it directly here so we define a new one that should stay in sync with the original one.",
- "type": "object",
- "required": [
- "volumeType"
- ],
- "properties": {
- "availabilityZone": {
- "description": "availabilityZone specifies the Cinder availability zone where the root volume will be created. If not specifified, the root volume will be created in the availability zone specified by the volume type in the cinder configuration. If the volume type (configured in the OpenStack cluster) does not specify an availability zone, the root volume will be created in the default availability zone specified in the cinder configuration. See https://docs.openstack.org/cinder/latest/admin/availability-zone-type.html for more details. If the OpenStack cluster is deployed with the cross_az_attach configuration option set to false, the root volume will have to be in the same availability zone as the VM (defined by OpenStackFailureDomain.AvailabilityZone). Availability zone names must NOT contain spaces otherwise it will lead to volume that belongs to this availability zone register failure, see kubernetes/cloud-provider-openstack#1379 for further information. The maximum length of availability zone name is 63 as per labels limits.",
- "type": "string"
- },
- "volumeType": {
- "description": "volumeType specifies the type of the root volume that will be provisioned. The maximum length of a volume type name is 255 characters, as per the OpenStack limit.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.SystemDiskProperties": {
- "description": "SystemDiskProperties contains the information regarding the system disk including performance, size, name, and category",
- "type": "object",
- "properties": {
- "category": {
- "description": "category is the category of the system disk. Valid values: cloud_essd: ESSD. When the parameter is set to this value, you can use the SystemDisk.PerformanceLevel parameter to specify the performance level of the disk. cloud_efficiency: ultra disk. cloud_ssd: standard SSD. cloud: basic disk. Empty value means no opinion and the platform chooses the a default, which is subject to change over time. Currently for non-I/O optimized instances of retired instance types, the default is `cloud`. Currently for other instances, the default is `cloud_efficiency`.",
- "type": "string"
- },
- "name": {
- "description": "name is the name of the system disk. If the name is specified the name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-). Empty value means the platform chooses a default, which is subject to change over time. Currently the default is `\"\"`.",
- "type": "string"
- },
- "performanceLevel": {
- "description": "performanceLevel is the performance level of the ESSD used as the system disk. Valid values:\n\nPL0: A single ESSD can deliver up to 10,000 random read/write IOPS. PL1: A single ESSD can deliver up to 50,000 random read/write IOPS. PL2: A single ESSD can deliver up to 100,000 random read/write IOPS. PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is `PL1`. For more information about ESSD performance levels, see ESSDs.",
- "type": "string"
- },
- "size": {
- "description": "size is the size of the system disk. Unit: GiB. Valid values: 20 to 500. The value must be at least 20 and greater than or equal to the size of the image. Empty value means the platform chooses a default, which is subject to change over time. Currently the default is `40` or the size of the image depending on whichever is greater.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.machine.v1.Tag": {
- "description": "Tag The tags of ECS Instance",
- "type": "object",
- "required": [
- "Key",
- "Value"
- ],
- "properties": {
- "Key": {
- "description": "Key is the name of the key pair",
- "type": "string",
- "default": ""
- },
- "Value": {
- "description": "Value is the value or data of the key pair",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1.VSphereFailureDomain": {
- "description": "VSphereFailureDomain configures failure domain information for the vSphere platform",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name of the failure domain in which the vSphere machine provider will create the VM. Failure domains are defined in a cluster's config.openshift.io/Infrastructure resource. When balancing machines across failure domains, the control plane machine set will inject configuration from the Infrastructure resource into the machine providerSpec to allocate the machine to a failure domain.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.AdditionalBlockDevice": {
- "description": "additionalBlockDevice is a block device to attach to the server.",
- "type": "object",
- "required": [
- "name",
- "sizeGiB",
- "storage"
- ],
- "properties": {
- "name": {
- "description": "name of the block device in the context of a machine. If the block device is a volume, the Cinder volume will be named as a combination of the machine name and this name. Also, this name will be used for tagging the block device. Information about the block device tag can be obtained from the OpenStack metadata API or the config drive.",
- "type": "string",
- "default": ""
- },
- "sizeGiB": {
- "description": "sizeGiB is the size of the block device in gibibytes (GiB).",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "storage": {
- "description": "storage specifies the storage type of the block device and additional storage options.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.BlockDeviceStorage"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.AddressPair": {
- "type": "object",
- "properties": {
- "ipAddress": {
- "type": "string"
- },
- "macAddress": {
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.BlockDeviceStorage": {
- "description": "blockDeviceStorage is the storage type of a block device to create and contains additional storage options.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "type": {
- "description": "type is the type of block device to create. This can be either \"Volume\" or \"Local\".",
- "type": "string",
- "default": ""
- },
- "volume": {
- "description": "volume contains additional storage options for a volume block device.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.BlockDeviceVolume"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "volume": "Volume"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1alpha1.BlockDeviceVolume": {
- "description": "blockDeviceVolume contains additional storage options for a volume block device.",
- "type": "object",
- "properties": {
- "availabilityZone": {
- "description": "availabilityZone is the volume availability zone to create the volume in. If omitted, the availability zone of the server will be used. The availability zone must NOT contain spaces otherwise it will lead to volume that belongs to this availability zone register failure, see kubernetes/cloud-provider-openstack#1379 for further information.",
- "type": "string"
- },
- "type": {
- "description": "type is the Cinder volume type of the volume. If omitted, the default Cinder volume type that is configured in the OpenStack cloud will be used.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.Filter": {
- "type": "object",
- "properties": {
- "adminStateUp": {
- "description": "Deprecated: adminStateUp is silently ignored. It has no replacement.",
- "type": "boolean"
- },
- "description": {
- "description": "description filters networks by description.",
- "type": "string"
- },
- "id": {
- "description": "Deprecated: use NetworkParam.uuid instead. Ignored if NetworkParam.uuid is set.",
- "type": "string"
- },
- "limit": {
- "description": "Deprecated: limit is silently ignored. It has no replacement.",
- "type": "integer",
- "format": "int32"
- },
- "marker": {
- "description": "Deprecated: marker is silently ignored. It has no replacement.",
- "type": "string"
- },
- "name": {
- "description": "name filters networks by name.",
- "type": "string"
- },
- "notTags": {
- "description": "notTags filters by networks which don't match all specified tags. NOT (t1 AND t2...) Multiple tags are comma separated.",
- "type": "string"
- },
- "notTagsAny": {
- "description": "notTagsAny filters by networks which don't match any specified tags. NOT (t1 OR t2...) Multiple tags are comma separated.",
- "type": "string"
- },
- "projectId": {
- "description": "projectId filters networks by project ID.",
- "type": "string"
- },
- "shared": {
- "description": "Deprecated: shared is silently ignored. It has no replacement.",
- "type": "boolean"
- },
- "sortDir": {
- "description": "Deprecated: sortDir is silently ignored. It has no replacement.",
- "type": "string"
- },
- "sortKey": {
- "description": "Deprecated: sortKey is silently ignored. It has no replacement.",
- "type": "string"
- },
- "status": {
- "description": "Deprecated: status is silently ignored. It has no replacement.",
- "type": "string"
- },
- "tags": {
- "description": "tags filters by networks containing all specified tags. Multiple tags are comma separated.",
- "type": "string"
- },
- "tagsAny": {
- "description": "tagsAny filters by networks containing any specified tags. Multiple tags are comma separated.",
- "type": "string"
- },
- "tenantId": {
- "description": "tenantId filters networks by tenant ID. Deprecated: use projectId instead. tenantId will be ignored if projectId is set.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.FixedIPs": {
- "type": "object",
- "required": [
- "subnetID"
- ],
- "properties": {
- "ipAddress": {
- "description": "ipAddress is a specific IP address to use in the given subnet. Port creation will fail if the address is not available. If not specified, an available IP from the given subnet will be selected automatically.",
- "type": "string"
- },
- "subnetID": {
- "description": "subnetID specifies the ID of the subnet where the fixed IP will be allocated.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.NetworkParam": {
- "type": "object",
- "properties": {
- "filter": {
- "description": "Filters for optional network query",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.Filter"
- },
- "fixedIp": {
- "description": "A fixed IPv4 address for the NIC. Deprecated: fixedIP is silently ignored. Use subnets instead.",
- "type": "string"
- },
- "noAllowedAddressPairs": {
- "description": "noAllowedAddressPairs disables creation of allowed address pairs for the network ports",
- "type": "boolean"
- },
- "portSecurity": {
- "description": "portSecurity optionally enables or disables security on ports managed by OpenStack",
- "type": "boolean"
- },
- "portTags": {
- "description": "portTags allows users to specify a list of tags to add to ports created in a given network",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "profile": {
- "description": "A dictionary that enables the application running on the specified host to pass and receive virtual network interface (VIF) port-specific information to the plug-in.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "subnets": {
- "description": "Subnet within a network to use",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.SubnetParam"
- }
- },
- "uuid": {
- "description": "The UUID of the network. Required if you omit the port attribute.",
- "type": "string"
- },
- "vnicType": {
- "description": "The virtual network interface card (vNIC) type that is bound to the neutron port.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.OpenstackProviderSpec": {
- "description": "OpenstackProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an OpenStack Instance. It is used by the Openstack machine actuator to create a single machine instance. Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "cloudsSecret",
- "cloudName",
- "flavor",
- "image"
- ],
- "properties": {
- "additionalBlockDevices": {
- "description": "additionalBlockDevices is a list of specifications for additional block devices to attach to the server instance",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.AdditionalBlockDevice"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "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",
- "type": "string"
- },
- "availabilityZone": {
- "description": "The availability zone from which to launch the server.",
- "type": "string"
- },
- "cloudName": {
- "description": "The name of the cloud to use from the clouds secret",
- "type": "string",
- "default": ""
- },
- "cloudsSecret": {
- "description": "The name of the secret containing the openstack credentials",
- "$ref": "#/definitions/io.k8s.api.core.v1.SecretReference"
- },
- "configDrive": {
- "description": "Config Drive support",
- "type": "boolean"
- },
- "flavor": {
- "description": "The flavor reference for the flavor for your server instance.",
- "type": "string",
- "default": ""
- },
- "floatingIP": {
- "description": "floatingIP specifies a floating IP to be associated with the machine. Note that it is not safe to use this parameter in a MachineSet, as only one Machine may be assigned the same floating IP.\n\nDeprecated: floatingIP will be removed in a future release as it cannot be implemented correctly.",
- "type": "string"
- },
- "image": {
- "description": "The name of the image to use for your server instance. If the RootVolume is specified, this will be ignored and use rootVolume directly.",
- "type": "string",
- "default": ""
- },
- "keyName": {
- "description": "The ssh key to inject in the instance",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "networks": {
- "description": "A networks object. Required parameter when there are multiple networks defined for the tenant. When you do not specify the networks parameter, the server attaches to the only network created for the current tenant.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.NetworkParam"
- }
- },
- "ports": {
- "description": "Create and assign additional ports to instances",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.PortOpts"
- }
- },
- "primarySubnet": {
- "description": "The subnet that a set of machines will get ingress/egress traffic from Deprecated: primarySubnet is silently ignored. Use subnets instead.",
- "type": "string"
- },
- "rootVolume": {
- "description": "The volume metadata to boot from",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.RootVolume"
- },
- "securityGroups": {
- "description": "The names of the security groups to assign to the instance",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.SecurityGroupParam"
- }
- },
- "serverGroupID": {
- "description": "The server group to assign the machine to.",
- "type": "string"
- },
- "serverGroupName": {
- "description": "The server group to assign the machine to. A server group with that name will be created if it does not exist. If both ServerGroupID and ServerGroupName are non-empty, they must refer to the same OpenStack resource.",
- "type": "string"
- },
- "serverMetadata": {
- "description": "Metadata mapping. Allows you to create a map of key value pairs to add to the server instance.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "sshUserName": {
- "description": "The machine ssh username Deprecated: sshUserName is silently ignored.",
- "type": "string"
- },
- "tags": {
- "description": "Machine tags Requires Nova api 2.52 minimum!",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "trunk": {
- "description": "Whether the server instance is created on a trunk port or not.",
- "type": "boolean"
- },
- "userDataSecret": {
- "description": "The name of the secret containing the user data (startup script in most cases)",
- "$ref": "#/definitions/io.k8s.api.core.v1.SecretReference"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.PortOpts": {
- "type": "object",
- "required": [
- "networkID"
- ],
- "properties": {
- "adminStateUp": {
- "description": "adminStateUp sets the administrative state of the created port to up (true), or down (false).",
- "type": "boolean"
- },
- "allowedAddressPairs": {
- "description": "allowedAddressPairs specifies a set of allowed address pairs to add to the port.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.AddressPair"
- }
- },
- "description": {
- "description": "description specifies the description of the created port.",
- "type": "string"
- },
- "fixedIPs": {
- "description": "fixedIPs specifies a set of fixed IPs to assign to the port. They must all be valid for the port's network.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.FixedIPs"
- }
- },
- "hostID": {
- "description": "The ID of the host where the port is allocated. Do not use this field: it cannot be used correctly. Deprecated: hostID is silently ignored. It will be removed with no replacement.",
- "type": "string"
- },
- "macAddress": {
- "description": "macAddress specifies the MAC address of the created port.",
- "type": "string"
- },
- "nameSuffix": {
- "description": "If nameSuffix is specified the created port will be named -. If not specified the port will be named -.",
- "type": "string"
- },
- "networkID": {
- "description": "networkID is the ID of the network the port will be created in. It is required.",
- "type": "string",
- "default": ""
- },
- "portSecurity": {
- "description": "enable or disable security on a given port incompatible with securityGroups and allowedAddressPairs",
- "type": "boolean"
- },
- "profile": {
- "description": "A dictionary that enables the application running on the specified host to pass and receive virtual network interface (VIF) port-specific information to the plug-in.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "projectID": {
- "description": "projectID specifies the project ID of the created port. Note that this requires OpenShift to have administrative permissions, which is typically not the case. Use of this field is not recommended. Deprecated: projectID is silently ignored.",
- "type": "string"
- },
- "securityGroups": {
- "description": "securityGroups specifies a set of security group UUIDs to use instead of the machine's default security groups. The default security groups will be used if this is left empty or not specified.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "tags": {
- "description": "tags species a set of tags to add to the port.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "tenantID": {
- "description": "tenantID specifies the tenant ID of the created port. Note that this requires OpenShift to have administrative permissions, which is typically not the case. Use of this field is not recommended. Deprecated: tenantID is silently ignored.",
- "type": "string"
- },
- "trunk": {
- "description": "Enables and disables trunk at port level. If not provided, openStackMachine.Spec.Trunk is inherited.",
- "type": "boolean"
- },
- "vnicType": {
- "description": "The virtual network interface card (vNIC) type that is bound to the neutron port.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.RootVolume": {
- "type": "object",
- "properties": {
- "availabilityZone": {
- "description": "availabilityZone specifies the Cinder availability where the root volume will be created.",
- "type": "string"
- },
- "deviceType": {
- "description": "Deprecated: deviceType will be silently ignored. There is no replacement.",
- "type": "string"
- },
- "diskSize": {
- "description": "diskSize specifies the size, in GiB, of the created root volume.",
- "type": "integer",
- "format": "int32"
- },
- "sourceType": {
- "description": "Deprecated: sourceType will be silently ignored. There is no replacement.",
- "type": "string"
- },
- "sourceUUID": {
- "description": "sourceUUID specifies the UUID of a glance image used to populate the root volume. Deprecated: set image in the platform spec instead. This will be ignored if image is set in the platform spec.",
- "type": "string"
- },
- "volumeType": {
- "description": "volumeType specifies a volume type to use when creating the root volume. If not specified the default volume type will be used.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.SecurityGroupFilter": {
- "type": "object",
- "properties": {
- "description": {
- "description": "description filters security groups by description.",
- "type": "string"
- },
- "id": {
- "description": "id specifies the ID of a security group to use. If set, id will not be validated before use. An invalid id will result in failure to create a server with an appropriate error message.",
- "type": "string"
- },
- "limit": {
- "description": "Deprecated: limit is silently ignored. It has no replacement.",
- "type": "integer",
- "format": "int32"
- },
- "marker": {
- "description": "Deprecated: marker is silently ignored. It has no replacement.",
- "type": "string"
- },
- "name": {
- "description": "name filters security groups by name.",
- "type": "string"
- },
- "notTags": {
- "description": "notTags filters by security groups which don't match all specified tags. NOT (t1 AND t2...) Multiple tags are comma separated.",
- "type": "string"
- },
- "notTagsAny": {
- "description": "notTagsAny filters by security groups which don't match any specified tags. NOT (t1 OR t2...) Multiple tags are comma separated.",
- "type": "string"
- },
- "projectId": {
- "description": "projectId filters security groups by project ID.",
- "type": "string"
- },
- "sortDir": {
- "description": "Deprecated: sortDir is silently ignored. It has no replacement.",
- "type": "string"
- },
- "sortKey": {
- "description": "Deprecated: sortKey is silently ignored. It has no replacement.",
- "type": "string"
- },
- "tags": {
- "description": "tags filters by security groups containing all specified tags. Multiple tags are comma separated.",
- "type": "string"
- },
- "tagsAny": {
- "description": "tagsAny filters by security groups containing any specified tags. Multiple tags are comma separated.",
- "type": "string"
- },
- "tenantId": {
- "description": "tenantId filters security groups by tenant ID. Deprecated: use projectId instead. tenantId will be ignored if projectId is set.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.SecurityGroupParam": {
- "type": "object",
- "properties": {
- "filter": {
- "description": "Filters used to query security groups in openstack",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.SecurityGroupFilter"
- },
- "name": {
- "description": "Security Group name",
- "type": "string"
- },
- "uuid": {
- "description": "Security Group UUID",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.SubnetFilter": {
- "type": "object",
- "properties": {
- "cidr": {
- "description": "cidr filters subnets by CIDR.",
- "type": "string"
- },
- "description": {
- "description": "description filters subnets by description.",
- "type": "string"
- },
- "enableDhcp": {
- "description": "Deprecated: enableDhcp is silently ignored. It has no replacement.",
- "type": "boolean"
- },
- "gateway_ip": {
- "description": "gateway_ip filters subnets by gateway IP.",
- "type": "string"
- },
- "id": {
- "description": "id is the uuid of a specific subnet to use. If specified, id will not be validated. Instead server creation will fail with an appropriate error.",
- "type": "string"
- },
- "ipVersion": {
- "description": "ipVersion filters subnets by IP version.",
- "type": "integer",
- "format": "int32"
- },
- "ipv6AddressMode": {
- "description": "ipv6AddressMode filters subnets by IPv6 address mode.",
- "type": "string"
- },
- "ipv6RaMode": {
- "description": "ipv6RaMode filters subnets by IPv6 router adversiement mode.",
- "type": "string"
- },
- "limit": {
- "description": "Deprecated: limit is silently ignored. It has no replacement.",
- "type": "integer",
- "format": "int32"
- },
- "marker": {
- "description": "Deprecated: marker is silently ignored. It has no replacement.",
- "type": "string"
- },
- "name": {
- "description": "name filters subnets by name.",
- "type": "string"
- },
- "networkId": {
- "description": "Deprecated: networkId is silently ignored. Set uuid on the containing network definition instead.",
- "type": "string"
- },
- "notTags": {
- "description": "notTags filters by subnets which don't match all specified tags. NOT (t1 AND t2...) Multiple tags are comma separated.",
- "type": "string"
- },
- "notTagsAny": {
- "description": "notTagsAny filters by subnets which don't match any specified tags. NOT (t1 OR t2...) Multiple tags are comma separated.",
- "type": "string"
- },
- "projectId": {
- "description": "projectId filters subnets by project ID.",
- "type": "string"
- },
- "sortDir": {
- "description": "Deprecated: sortDir is silently ignored. It has no replacement.",
- "type": "string"
- },
- "sortKey": {
- "description": "Deprecated: sortKey is silently ignored. It has no replacement.",
- "type": "string"
- },
- "subnetpoolId": {
- "description": "subnetpoolId filters subnets by subnet pool ID. Deprecated: subnetpoolId is silently ignored.",
- "type": "string"
- },
- "tags": {
- "description": "tags filters by subnets containing all specified tags. Multiple tags are comma separated.",
- "type": "string"
- },
- "tagsAny": {
- "description": "tagsAny filters by subnets containing any specified tags. Multiple tags are comma separated.",
- "type": "string"
- },
- "tenantId": {
- "description": "tenantId filters subnets by tenant ID. Deprecated: use projectId instead. tenantId will be ignored if projectId is set.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1alpha1.SubnetParam": {
- "type": "object",
- "properties": {
- "filter": {
- "description": "Filters for optional network query",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1alpha1.SubnetFilter"
- },
- "portSecurity": {
- "description": "portSecurity optionally enables or disables security on ports managed by OpenStack Deprecated: portSecurity is silently ignored. Set portSecurity on the parent network instead.",
- "type": "boolean"
- },
- "portTags": {
- "description": "portTags are tags that are added to ports created on this subnet",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "uuid": {
- "description": "The UUID of the network. Required if you omit the port attribute.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AWSMachineProviderConfig": {
- "description": "AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "ami",
- "instanceType",
- "deviceIndex",
- "subnet",
- "placement"
- ],
- "properties": {
- "ami": {
- "description": "ami is the reference to the AMI from which to create the machine instance.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AWSResourceReference"
- },
- "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",
- "type": "string"
- },
- "blockDevices": {
- "description": "blockDevices is the set of block device mapping associated to this instance, block device without a name will be used as a root device and only one device without a name is allowed https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.BlockDeviceMappingSpec"
- }
- },
- "capacityReservationId": {
- "description": "capacityReservationId specifies the target Capacity Reservation into which the instance should be launched. The field size should be greater than 0 and the field input must start with cr-***",
- "type": "string",
- "default": ""
- },
- "cpuOptions": {
- "description": "cpuOptions defines CPU-related settings for the instance, including the confidential computing policy. When omitted, this means no opinion and the AWS platform is left to choose a reasonable default. More info: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CpuOptionsRequest.html, https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.CPUOptions"
- },
- "credentialsSecret": {
- "description": "credentialsSecret is a reference to the secret with AWS credentials. Otherwise, defaults to permissions provided by attached IAM role where the actuator is running.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "deviceIndex": {
- "description": "deviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "hostPlacement": {
- "description": "hostPlacement configures placement on AWS Dedicated Hosts. This allows admins to assign instances to specific host for a variety of needs including for regulatory compliance, to leverage existing per-socket or per-core software licenses (BYOL), and to gain visibility and control over instance placement on a physical server. When omitted, the instance is not constrained to a dedicated host.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.HostPlacement"
- },
- "iamInstanceProfile": {
- "description": "iamInstanceProfile is a reference to an IAM role to assign to the instance",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AWSResourceReference"
- },
- "instanceType": {
- "description": "instanceType is the type of instance to create. Example: m4.xlarge",
- "type": "string",
- "default": ""
- },
- "keyName": {
- "description": "keyName is the name of the KeyPair to use for SSH",
- "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",
- "type": "string"
- },
- "loadBalancers": {
- "description": "loadBalancers is the set of load balancers to which the new instance should be added once it is created.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.LoadBalancerReference"
- }
- },
- "marketType": {
- "description": "marketType specifies the type of market for the EC2 instance. Valid values are OnDemand, Spot, CapacityBlock and omitted.\n\nDefaults to OnDemand. When SpotMarketOptions is provided, the marketType defaults to \"Spot\".\n\nWhen set to OnDemand the instance runs as a standard OnDemand instance. When set to Spot the instance runs as a Spot instance. When set to CapacityBlock the instance utilizes pre-purchased compute capacity (capacity blocks) with AWS Capacity Reservations. If this value is selected, capacityReservationID must be specified to identify the target reservation.",
- "type": "string"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "metadataServiceOptions": {
- "description": "metadataServiceOptions allows users to configure instance metadata service interaction options. If nothing specified, default AWS IMDS settings will be applied. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_InstanceMetadataOptionsRequest.html",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MetadataServiceOptions"
- },
- "networkInterfaceType": {
- "description": "networkInterfaceType specifies the type of network interface to be used for the primary network interface. Valid values are \"ENA\", \"EFA\", and omitted, which means no opinion and the platform chooses a good default which may change over time. The current default value is \"ENA\". Please visit https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html to learn more about the AWS Elastic Fabric Adapter interface option.",
- "type": "string"
- },
- "placement": {
- "description": "placement specifies where to create the instance in AWS",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Placement"
- },
- "placementGroupName": {
- "description": "placementGroupName specifies the name of the placement group in which to launch the instance. The placement group must already be created and may use any placement strategy. When omitted, no placement group is used when creating the EC2 instance.",
- "type": "string"
- },
- "placementGroupPartition": {
- "description": "placementGroupPartition is the partition number within the placement group in which to launch the instance. This must be an integer value between 1 and 7. It is only valid if the placement group, referred in `PlacementGroupName` was created with strategy set to partition.",
- "type": "integer",
- "format": "int32"
- },
- "publicIp": {
- "description": "publicIp specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.",
- "type": "boolean"
- },
- "securityGroups": {
- "description": "securityGroups is an array of references to security groups that should be applied to the instance.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AWSResourceReference"
- }
- },
- "spotMarketOptions": {
- "description": "spotMarketOptions allows users to configure instances to be run using AWS Spot instances.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.SpotMarketOptions"
- },
- "subnet": {
- "description": "subnet is a reference to the subnet to use for this instance",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AWSResourceReference"
- },
- "tags": {
- "description": "tags is the set of tags to add to apply to an instance, in addition to the ones added by default by the actuator. These tags are additive. The actuator will ensure these tags are present, but will not remove any other tags that may exist on the instance.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.TagSpecification"
- }
- },
- "userDataSecret": {
- "description": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AWSMachineProviderConfigList": {
- "description": "AWSMachineProviderConfigList contains a list of AWSMachineProviderConfig Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AWSMachineProviderConfig"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AWSMachineProviderStatus": {
- "description": "AWSMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains AWS-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "instanceId": {
- "description": "instanceId is the instance ID of the machine created in AWS",
- "type": "string"
- },
- "instanceState": {
- "description": "instanceState is the state of the AWS instance for this machine",
- "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",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AWSResourceReference": {
- "description": "AWSResourceReference is a reference to a specific AWS resource by ID, ARN, or filters. Only one of ID, ARN or Filters may be specified. Specifying more than one will result in a validation error.",
- "type": "object",
- "properties": {
- "arn": {
- "description": "arn of resource",
- "type": "string"
- },
- "filters": {
- "description": "filters is a set of filters used to identify a resource",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Filter"
- }
- },
- "id": {
- "description": "id of resource",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AddressesFromPool": {
- "description": "AddressesFromPool is an IPAddressPool that will be used to create IPAddressClaims for fulfillment by an external controller.",
- "type": "object",
- "required": [
- "group",
- "resource",
- "name"
- ],
- "properties": {
- "group": {
- "description": "group of the IP address pool type known to an external IPAM controller. This should be a fully qualified domain name, for example, externalipam.controller.io.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name of an IP address pool, for example, pool-config-1.",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource of the IP address pool type known to an external IPAM controller. It is normally the plural form of the resource kind in lowercase, for example, ippools.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AzureBootDiagnostics": {
- "description": "AzureBootDiagnostics configures the boot diagnostics settings for the virtual machine. This allows you to configure capturing serial output from the virtual machine on boot. This is useful for debugging software based launch issues.",
- "type": "object",
- "required": [
- "storageAccountType"
- ],
- "properties": {
- "customerManaged": {
- "description": "customerManaged provides reference to the customer manager storage account.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AzureCustomerManagedBootDiagnostics"
- },
- "storageAccountType": {
- "description": "storageAccountType determines if the storage account for storing the diagnostics data should be provisioned by Azure (AzureManaged) or by the customer (CustomerManaged).",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "storageAccountType",
- "fields-to-discriminateBy": {
- "customerManaged": "CustomerManaged"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1beta1.AzureCustomerManagedBootDiagnostics": {
- "description": "AzureCustomerManagedBootDiagnostics provides reference to a customer managed storage account.",
- "type": "object",
- "required": [
- "storageAccountURI"
- ],
- "properties": {
- "storageAccountURI": {
- "description": "storageAccountURI is the URI of the customer managed storage account. The URI typically will be `https://.blob.core.windows.net/` but may differ if you are using Azure DNS zone endpoints. You can find the correct endpoint by looking for the Blob Primary Endpoint in the endpoints tab in the Azure console.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AzureDiagnostics": {
- "description": "AzureDiagnostics is used to configure the diagnostic settings of the virtual machine.",
- "type": "object",
- "properties": {
- "boot": {
- "description": "AzureBootDiagnostics configures the boot diagnostics settings for the virtual machine. This allows you to configure capturing serial output from the virtual machine on boot. This is useful for debugging software based launch issues.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AzureBootDiagnostics"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AzureMachineProviderSpec": {
- "description": "AzureMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an Azure virtual machine. It is used by the Azure machine actuator to create a single Machine. Required parameters such as location that are not specified by this configuration, will be defaulted by the actuator. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "image",
- "osDisk",
- "publicIP",
- "subnet"
- ],
- "properties": {
- "acceleratedNetworking": {
- "description": "acceleratedNetworking enables or disables Azure accelerated networking feature. Set to false by default. If true, then this will depend on whether the requested VMSize is supported. If set to true with an unsupported VMSize, Azure will return an error.",
- "type": "boolean"
- },
- "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",
- "type": "string"
- },
- "applicationSecurityGroups": {
- "description": "Application Security Groups that need to be attached to the machine's interface. No application security groups will be attached if zero-length.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "availabilitySet": {
- "description": "availabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.",
- "type": "string"
- },
- "capacityReservationGroupID": {
- "description": "capacityReservationGroupID specifies the capacity reservation group resource id that should be used for allocating the virtual machine. The field size should be greater than 0 and the field input must start with '/'. The input for capacityReservationGroupID must be similar to '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}'. The keys which are used should be among 'subscriptions', 'providers' and 'resourcegroups' followed by valid ID or names respectively.",
- "type": "string"
- },
- "credentialsSecret": {
- "description": "credentialsSecret is a reference to the secret with Azure credentials.",
- "$ref": "#/definitions/io.k8s.api.core.v1.SecretReference"
- },
- "dataDisks": {
- "description": "DataDisk specifies the parameters that are used to add one or more data disks to the machine.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.DataDisk"
- }
- },
- "diagnostics": {
- "description": "diagnostics configures the diagnostics settings for the virtual machine. This allows you to configure boot diagnostics such as capturing serial output from the virtual machine on boot. This is useful for debugging software based launch issues.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AzureDiagnostics"
- },
- "image": {
- "description": "image is the OS image to use to create the instance.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Image"
- },
- "internalLoadBalancer": {
- "description": "InternalLoadBalancerName to use for this instance",
- "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",
- "type": "string"
- },
- "location": {
- "description": "location is the region to use to create the instance",
- "type": "string"
- },
- "managedIdentity": {
- "description": "managedIdentity to set managed identity name",
- "type": "string"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "natRule": {
- "description": "natRule to set inbound NAT rule of the load balancer",
- "type": "integer",
- "format": "int64"
- },
- "networkResourceGroup": {
- "description": "networkResourceGroup is the resource group for the virtual machine's network",
- "type": "string"
- },
- "osDisk": {
- "description": "osDisk represents the parameters for creating the OS disk.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.OSDisk"
- },
- "publicIP": {
- "description": "publicIP if true a public IP will be used",
- "type": "boolean",
- "default": false
- },
- "publicLoadBalancer": {
- "description": "publicLoadBalancer to use for this instance",
- "type": "string"
- },
- "resourceGroup": {
- "description": "resourceGroup is the resource group for the virtual machine",
- "type": "string"
- },
- "securityGroup": {
- "description": "Network Security Group that needs to be attached to the machine's interface. No security group will be attached if empty.",
- "type": "string"
- },
- "securityProfile": {
- "description": "securityProfile specifies the Security profile settings for a virtual machine.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.SecurityProfile"
- },
- "spotVMOptions": {
- "description": "spotVMOptions allows the ability to specify the Machine should use a Spot VM",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.SpotVMOptions"
- },
- "sshPublicKey": {
- "description": "sshPublicKey is the public key to use to SSH to the virtual machine.",
- "type": "string"
- },
- "subnet": {
- "description": "subnet to use for this instance",
- "type": "string",
- "default": ""
- },
- "tags": {
- "description": "tags is a list of tags to apply to the machine.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "ultraSSDCapability": {
- "description": "ultraSSDCapability enables or disables Azure UltraSSD capability for a virtual machine. This can be used to allow/disallow binding of Azure UltraSSD to the Machine both as Data Disks or via Persistent Volumes. This Azure feature is subject to a specific scope and certain limitations. More informations on this can be found in the official Azure documentation for Ultra Disks: (https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd?tabs=azure-portal#ga-scope-and-limitations).\n\nWhen omitted, if at least one Data Disk of type UltraSSD is specified, the platform will automatically enable the capability. If a Perisistent Volume backed by an UltraSSD is bound to a Pod on the Machine, when this field is ommitted, the platform will *not* automatically enable the capability (unless already enabled by the presence of an UltraSSD as Data Disk). This may manifest in the Pod being stuck in `ContainerCreating` phase. This defaulting behaviour may be subject to change in future.\n\nWhen set to \"Enabled\", if the capability is available for the Machine based on the scope and limitations described above, the capability will be set on the Machine. This will thus allow UltraSSD both as Data Disks and Persistent Volumes. If set to \"Enabled\" when the capability can't be available due to scope and limitations, the Machine will go into \"Failed\" state.\n\nWhen set to \"Disabled\", UltraSSDs will not be allowed either as Data Disks nor as Persistent Volumes. In this case if any UltraSSDs are specified as Data Disks on a Machine, the Machine will go into a \"Failed\" state. If instead any UltraSSDs are backing the volumes (via Persistent Volumes) of any Pods scheduled on a Node which is backed by the Machine, the Pod may get stuck in `ContainerCreating` phase.",
- "type": "string"
- },
- "userDataSecret": {
- "description": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
- "$ref": "#/definitions/io.k8s.api.core.v1.SecretReference"
- },
- "vmSize": {
- "description": "vmSize is the size of the VM to create.",
- "type": "string"
- },
- "vnet": {
- "description": "vnet to set virtual network name",
- "type": "string"
- },
- "zone": {
- "description": "Availability Zone for the virtual machine. If nil, the virtual machine should be deployed to no zone",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.AzureMachineProviderStatus": {
- "description": "AzureMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains Azure-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "vmId": {
- "description": "vmId is the ID of the virtual machine created in Azure.",
- "type": "string"
- },
- "vmState": {
- "description": "vmState is the provisioning state of the Azure virtual machine.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.BlockDeviceMappingSpec": {
- "description": "BlockDeviceMappingSpec describes a block device mapping",
- "type": "object",
- "properties": {
- "deviceName": {
- "description": "The device name exposed to the machine (for example, /dev/sdh or xvdh).",
- "type": "string"
- },
- "ebs": {
- "description": "Parameters used to automatically set up EBS volumes when the machine is launched.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.EBSBlockDeviceSpec"
- },
- "noDevice": {
- "description": "Suppresses the specified device included in the block device mapping of the AMI.",
- "type": "string"
- },
- "virtualName": {
- "description": "The virtual device name (ephemeralN). Machine store volumes are numbered starting from 0. An machine type with 2 available machine store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available machine store volumes depends on the machine type. After you connect to the machine, you must mount the volume.\n\nConstraints: For M3 machines, you must specify machine store volumes in the block device mapping for the machine. When you launch an M3 machine, we ignore any machine store volumes specified in the block device mapping for the AMI.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.CPUOptions": {
- "description": "CPUOptions defines CPU-related settings for the instance, including the confidential computing policy. If provided, it must not be empty — at least one field must be set.",
- "type": "object",
- "properties": {
- "confidentialCompute": {
- "description": "confidentialCompute specifies whether confidential computing should be enabled for the instance, and, if so, which confidential computing technology to use. Valid values are: Disabled, AMDEncryptedVirtualizationNestedPaging and omitted. When set to Disabled, confidential computing will be disabled for the instance. When set to AMDEncryptedVirtualizationNestedPaging, AMD SEV-SNP will be used as the confidential computing technology for the instance. In this case, ensure the following conditions are met: 1) The selected instance type supports AMD SEV-SNP. 2) The selected AWS region supports AMD SEV-SNP. 3) The selected AMI supports AMD SEV-SNP. More details can be checked at https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html When omitted, this means no opinion and the AWS platform is left to choose a reasonable default, which is subject to change without notice. The current default is Disabled.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.Condition": {
- "description": "Condition defines an observation of a Machine API resource operational state.",
- "type": "object",
- "required": [
- "type",
- "status",
- "lastTransitionTime"
- ],
- "properties": {
- "lastTransitionTime": {
- "description": "Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "A human readable message indicating details about the transition. This field may be empty.",
- "type": "string"
- },
- "reason": {
- "description": "The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.",
- "type": "string"
- },
- "severity": {
- "description": "severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.",
- "type": "string"
- },
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.ConfidentialVM": {
- "description": "ConfidentialVM defines the UEFI settings for the virtual machine.",
- "type": "object",
- "required": [
- "uefiSettings"
- ],
- "properties": {
- "uefiSettings": {
- "description": "uefiSettings specifies the security settings like secure boot and vTPM used while creating the virtual machine.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.UEFISettings"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.DataDisk": {
- "description": "DataDisk specifies the parameters that are used to add one or more data disks to the machine. A Data Disk is a managed disk that's attached to a virtual machine to store application data. It differs from an OS Disk as it doesn't come with a pre-installed OS, and it cannot contain the boot volume. It is registered as SCSI drive and labeled with the chosen `lun`. e.g. for `lun: 0` the raw disk device will be available at `/dev/disk/azure/scsi1/lun0`.\n\nAs the Data Disk disk device is attached raw to the virtual machine, it will need to be partitioned, formatted with a filesystem and mounted, in order for it to be usable. This can be done by creating a custom userdata Secret with custom Ignition configuration to achieve the desired initialization. At this stage the previously defined `lun` is to be used as the \"device\" key for referencing the raw disk device to be initialized. Once the custom userdata Secret has been created, it can be referenced in the Machine's `.providerSpec.userDataSecret`. For further guidance and examples, please refer to the official OpenShift docs.",
- "type": "object",
- "required": [
- "nameSuffix",
- "diskSizeGB",
- "lun",
- "deletionPolicy"
- ],
- "properties": {
- "cachingType": {
- "description": "cachingType specifies the caching requirements. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is CachingTypeNone.",
- "type": "string"
- },
- "deletionPolicy": {
- "description": "deletionPolicy specifies the data disk deletion policy upon Machine deletion. Possible values are \"Delete\",\"Detach\". When \"Delete\" is used the data disk is deleted when the Machine is deleted. When \"Detach\" is used the data disk is detached from the Machine and retained when the Machine is deleted.",
- "type": "string",
- "default": ""
- },
- "diskSizeGB": {
- "description": "diskSizeGB is the size in GB to assign to the data disk.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "lun": {
- "description": "lun Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. This value is also needed for referencing the data disks devices within userdata to perform disk initialization through Ignition (e.g. partition/format/mount). The value must be between 0 and 63.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "managedDisk": {
- "description": "managedDisk specifies the Managed Disk parameters for the data disk. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is a ManagedDisk with with storageAccountType: \"Premium_LRS\" and diskEncryptionSet.id: \"Default\".",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.DataDiskManagedDiskParameters"
- },
- "nameSuffix": {
- "description": "nameSuffix is the suffix to be appended to the machine name to generate the disk name. Each disk name will be in format _. NameSuffix name must start and finish with an alphanumeric character and can only contain letters, numbers, underscores, periods or hyphens. The overall disk name must not exceed 80 chars in length.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.DataDiskManagedDiskParameters": {
- "description": "DataDiskManagedDiskParameters is the parameters of a DataDisk managed disk.",
- "type": "object",
- "required": [
- "storageAccountType"
- ],
- "properties": {
- "diskEncryptionSet": {
- "description": "diskEncryptionSet is the disk encryption set properties. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is a DiskEncryptionSet with id: \"Default\".",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.DiskEncryptionSetParameters"
- },
- "storageAccountType": {
- "description": "storageAccountType is the storage account type to use. Possible values include \"Standard_LRS\", \"Premium_LRS\" and \"UltraSSD_LRS\".",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.DedicatedHost": {
- "description": "DedicatedHost represents the configuration for the usage of dedicated host.",
- "type": "object",
- "required": [
- "id"
- ],
- "properties": {
- "id": {
- "description": "id identifies the AWS Dedicated Host on which the instance must run. The value must start with \"h-\" followed by 17 lowercase hexadecimal characters (0-9 and a-f). Must be exactly 19 characters in length.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.DiskEncryptionSetParameters": {
- "description": "DiskEncryptionSetParameters is the disk encryption set properties",
- "type": "object",
- "properties": {
- "id": {
- "description": "id is the disk encryption set ID Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is: \"Default\".",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.DiskSettings": {
- "description": "DiskSettings describe ephemeral disk settings for the os disk.",
- "type": "object",
- "properties": {
- "ephemeralStorageLocation": {
- "description": "ephemeralStorageLocation enables ephemeral OS when set to 'Local'. Possible values include: 'Local'. See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks for full details. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is that disks are saved to remote Azure storage.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.EBSBlockDeviceSpec": {
- "description": "EBSBlockDeviceSpec describes a block device for an EBS volume. https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/EbsBlockDevice",
- "type": "object",
- "properties": {
- "deleteOnTermination": {
- "description": "Indicates whether the EBS volume is deleted on machine termination.\n\nDeprecated: setting this field has no effect.",
- "type": "boolean"
- },
- "encrypted": {
- "description": "Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to machines that support Amazon EBS encryption.",
- "type": "boolean"
- },
- "iops": {
- "description": "The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the Amazon Elastic Compute Cloud User Guide.\n\nMinimal and maximal IOPS for io1 and gp2 are constrained. Please, check https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html for precise boundaries for individual volumes.\n\nCondition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.",
- "type": "integer",
- "format": "int64"
- },
- "kmsKey": {
- "description": "Indicates the KMS key that should be used to encrypt the Amazon EBS volume.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AWSResourceReference"
- },
- "volumeSize": {
- "description": "The size of the volume, in GiB.\n\nConstraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.\n\nDefault: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.",
- "type": "integer",
- "format": "int64"
- },
- "volumeType": {
- "description": "The volume type: gp2, io1, st1, sc1, or standard. Default: standard",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.Filter": {
- "description": "Filter is a filter used to identify an AWS resource",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name of the filter. Filter names are case-sensitive.",
- "type": "string",
- "default": ""
- },
- "values": {
- "description": "values includes one or more filter values. Filter values are case-sensitive.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPDisk": {
- "description": "GCPDisk describes disks for GCP.",
- "type": "object",
- "required": [
- "autoDelete",
- "boot",
- "sizeGb",
- "type",
- "image",
- "labels"
- ],
- "properties": {
- "autoDelete": {
- "description": "autoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false).",
- "type": "boolean",
- "default": false
- },
- "boot": {
- "description": "boot indicates if this is a boot disk (default false).",
- "type": "boolean",
- "default": false
- },
- "encryptionKey": {
- "description": "encryptionKey is the customer-supplied encryption key of the disk.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPEncryptionKeyReference"
- },
- "image": {
- "description": "image is the source image to create this disk.",
- "type": "string",
- "default": ""
- },
- "labels": {
- "description": "labels list of labels to apply to the disk.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "sizeGb": {
- "description": "sizeGb is the size of the disk (in GB).",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "type": {
- "description": "type is the type of the disk (eg: pd-standard).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPEncryptionKeyReference": {
- "description": "GCPEncryptionKeyReference describes the encryptionKey to use for a disk's encryption.",
- "type": "object",
- "properties": {
- "kmsKey": {
- "description": "KMSKeyName is the reference KMS key, in the format",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPKMSKeyReference"
- },
- "kmsKeyServiceAccount": {
- "description": "kmsKeyServiceAccount is the service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. See https://cloud.google.com/compute/docs/access/service-accounts#compute_engine_service_account for details on the default service account.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPGPUConfig": {
- "description": "GCPGPUConfig describes type and count of GPUs attached to the instance on GCP.",
- "type": "object",
- "required": [
- "count",
- "type"
- ],
- "properties": {
- "count": {
- "description": "count is the number of GPUs to be attached to an instance.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "type": {
- "description": "type is the type of GPU to be attached to an instance. Supported GPU types are: nvidia-tesla-k80, nvidia-tesla-p100, nvidia-tesla-v100, nvidia-tesla-p4, nvidia-tesla-t4",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPKMSKeyReference": {
- "description": "GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key",
- "type": "object",
- "required": [
- "name",
- "keyRing",
- "location"
- ],
- "properties": {
- "keyRing": {
- "description": "keyRing is the name of the KMS Key Ring which the KMS Key belongs to.",
- "type": "string",
- "default": ""
- },
- "location": {
- "description": "location is the GCP location in which the Key Ring exists.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is the name of the customer managed encryption key to be used for the disk encryption.",
- "type": "string",
- "default": ""
- },
- "projectID": {
- "description": "projectID is the ID of the Project in which the KMS Key Ring exists. Defaults to the VM ProjectID if not set.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPMachineProviderSpec": {
- "description": "GCPMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an GCP virtual machine. It is used by the GCP machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "canIPForward",
- "deletionProtection",
- "serviceAccounts",
- "machineType",
- "region",
- "zone"
- ],
- "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",
- "type": "string"
- },
- "canIPForward": {
- "description": "canIPForward Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.",
- "type": "boolean",
- "default": false
- },
- "confidentialCompute": {
- "description": "confidentialCompute is an optional field defining whether the instance should have confidential compute enabled or not, and the confidential computing technology of choice. Allowed values are omitted, Disabled, Enabled, AMDEncryptedVirtualization, AMDEncryptedVirtualizationNestedPaging, and IntelTrustedDomainExtensions When set to Disabled, the machine will not be configured to be a confidential computing instance. When set to Enabled, the machine will be configured as a confidential computing instance with no preference on the confidential compute policy used. In this mode, the platform chooses a default that is subject to change over time. Currently, the default is to use AMD Secure Encrypted Virtualization. When set to AMDEncryptedVirtualization, the machine will be configured as a confidential computing instance with AMD Secure Encrypted Virtualization (AMD SEV) as the confidential computing technology. When set to AMDEncryptedVirtualizationNestedPaging, the machine will be configured as a confidential computing instance with AMD Secure Encrypted Virtualization Secure Nested Paging (AMD SEV-SNP) as the confidential computing technology. When set to IntelTrustedDomainExtensions, the machine will be configured as a confidential computing instance with Intel Trusted Domain Extensions (Intel TDX) as the confidential computing technology. If any value other than Disabled is set the selected machine type must support that specific confidential computing technology. The machine series supporting confidential computing technologies can be checked at https://cloud.google.com/confidential-computing/confidential-vm/docs/supported-configurations#all-confidential-vm-instances Currently, AMDEncryptedVirtualization is supported in c2d, n2d, and c3d machines. AMDEncryptedVirtualizationNestedPaging is supported in n2d machines. IntelTrustedDomainExtensions is supported in c3 machines. If any value other than Disabled is set, the selected region must support that specific confidential computing technology. The list of regions supporting confidential computing technologies can be checked at https://cloud.google.com/confidential-computing/confidential-vm/docs/supported-configurations#supported-zones If any value other than Disabled is set onHostMaintenance is required to be set to \"Terminate\". If omitted, the platform chooses a default, which is subject to change over time, currently that default is Disabled.",
- "type": "string"
- },
- "credentialsSecret": {
- "description": "credentialsSecret is a reference to the secret with GCP credentials.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "deletionProtection": {
- "description": "deletionProtection whether the resource should be protected against deletion.",
- "type": "boolean",
- "default": false
- },
- "disks": {
- "description": "disks is a list of disks to be attached to the VM.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPDisk"
- }
- },
- "gcpMetadata": {
- "description": "Metadata key/value pairs to apply to the VM.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPMetadata"
- }
- },
- "gpus": {
- "description": "gpus is a list of GPUs to be attached to the VM.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPGPUConfig"
- }
- },
- "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",
- "type": "string"
- },
- "labels": {
- "description": "labels list of labels to apply to the VM.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "machineType": {
- "description": "machineType is the machine type to use for the VM.",
- "type": "string",
- "default": ""
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "networkInterfaces": {
- "description": "networkInterfaces is a list of network interfaces to be attached to the VM.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPNetworkInterface"
- }
- },
- "onHostMaintenance": {
- "description": "onHostMaintenance determines the behavior when a maintenance event occurs that might cause the instance to reboot. This is required to be set to \"Terminate\" if you want to provision machine with attached GPUs. Otherwise, allowed values are \"Migrate\" and \"Terminate\". If omitted, the platform chooses a default, which is subject to change over time, currently that default is \"Migrate\".",
- "type": "string"
- },
- "preemptible": {
- "description": "preemptible indicates if created instance is preemptible.",
- "type": "boolean"
- },
- "projectID": {
- "description": "projectID is the project in which the GCP machine provider will create the VM.",
- "type": "string"
- },
- "provisioningModel": {
- "description": "provisioningModel is an optional field that determines the provisioning model for the GCP machine instance. Valid values are \"Spot\" and omitted. When set to Spot, the instance runs as a Google Cloud Spot instance which provides significant cost savings but may be preempted by Google Cloud Platform when resources are needed elsewhere. When omitted, the machine will be provisioned as a standard on-demand instance. This field cannot be used together with the preemptible field.",
- "type": "string"
- },
- "region": {
- "description": "region is the region in which the GCP machine provider will create the VM.",
- "type": "string",
- "default": ""
- },
- "resourceManagerTags": {
- "description": "resourceManagerTags is an optional list of tags to apply to the GCP resources created for the cluster. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for information on tagging GCP resources. GCP supports a maximum of 50 tags per resource.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.ResourceManagerTag"
- },
- "x-kubernetes-list-map-keys": [
- "key"
- ],
- "x-kubernetes-list-type": "map"
- },
- "restartPolicy": {
- "description": "restartPolicy determines the behavior when an instance crashes or the underlying infrastructure provider stops the instance as part of a maintenance event (default \"Always\"). Cannot be \"Always\" with preemptible instances. Otherwise, allowed values are \"Always\" and \"Never\". If omitted, the platform chooses a default, which is subject to change over time, currently that default is \"Always\". RestartPolicy represents AutomaticRestart in GCP compute api",
- "type": "string"
- },
- "serviceAccounts": {
- "description": "serviceAccounts is a list of GCP service accounts to be used by the VM.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPServiceAccount"
- }
- },
- "shieldedInstanceConfig": {
- "description": "shieldedInstanceConfig is the Shielded VM configuration for the VM",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.GCPShieldedInstanceConfig"
- },
- "tags": {
- "description": "tags list of network tags to apply to the VM.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "targetPools": {
- "description": "targetPools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "userDataSecret": {
- "description": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "zone": {
- "description": "zone is the zone in which the GCP machine provider will create the VM.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPMachineProviderStatus": {
- "description": "GCPMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains GCP-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "instanceId": {
- "description": "instanceId is the ID of the instance in GCP",
- "type": "string"
- },
- "instanceState": {
- "description": "instanceState is the provisioning state of the GCP Instance.",
- "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",
- "type": "string"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPMetadata": {
- "description": "GCPMetadata describes metadata for GCP.",
- "type": "object",
- "required": [
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key is the metadata key.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value is the metadata value.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPNetworkInterface": {
- "description": "GCPNetworkInterface describes network interfaces for GCP",
- "type": "object",
- "properties": {
- "network": {
- "description": "network is the network name.",
- "type": "string"
- },
- "projectID": {
- "description": "projectID is the project in which the GCP machine provider will create the VM.",
- "type": "string"
- },
- "publicIP": {
- "description": "publicIP indicates if true a public IP will be used",
- "type": "boolean"
- },
- "subnetwork": {
- "description": "subnetwork is the subnetwork name.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPServiceAccount": {
- "description": "GCPServiceAccount describes service accounts for GCP.",
- "type": "object",
- "required": [
- "email",
- "scopes"
- ],
- "properties": {
- "email": {
- "description": "email is the service account email.",
- "type": "string",
- "default": ""
- },
- "scopes": {
- "description": "scopes list of scopes to be assigned to the service account.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.GCPShieldedInstanceConfig": {
- "description": "GCPShieldedInstanceConfig describes the shielded VM configuration of the instance on GCP. Shielded VM configuration allow users to enable and disable Secure Boot, vTPM, and Integrity Monitoring.",
- "type": "object",
- "properties": {
- "integrityMonitoring": {
- "description": "integrityMonitoring determines whether the instance should have integrity monitoring that verify the runtime boot integrity. Compares the most recent boot measurements to the integrity policy baseline and return a pair of pass/fail results depending on whether they match or not. If omitted, the platform chooses a default, which is subject to change over time, currently that default is Enabled.",
- "type": "string"
- },
- "secureBoot": {
- "description": "secureBoot Defines whether the instance should have secure boot enabled. Secure Boot verify the digital signature of all boot components, and halting the boot process if signature verification fails. If omitted, the platform chooses a default, which is subject to change over time, currently that default is Disabled.",
- "type": "string"
- },
- "virtualizedTrustedPlatformModule": {
- "description": "virtualizedTrustedPlatformModule enable virtualized trusted platform module measurements to create a known good boot integrity policy baseline. The integrity policy baseline is used for comparison with measurements from subsequent VM boots to determine if anything has changed. This is required to be set to \"Enabled\" if IntegrityMonitoring is enabled. If omitted, the platform chooses a default, which is subject to change over time, currently that default is Enabled.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.HostPlacement": {
- "description": "HostPlacement is the type that will be used to configure the placement of AWS instances.",
- "type": "object",
- "required": [
- "affinity"
- ],
- "properties": {
- "affinity": {
- "description": "affinity specifies the affinity setting for the instance. Allowed values are AnyAvailable and DedicatedHost. When Affinity is set to DedicatedHost, an instance started onto a specific host always restarts on the same host if stopped. In this scenario, the `dedicatedHost` field must be set. When Affinity is set to AnyAvailable, and you stop and restart the instance, it can be restarted on any available host.",
- "type": "string"
- },
- "dedicatedHost": {
- "description": "dedicatedHost specifies the exact host that an instance should be restarted on if stopped. dedicatedHost is required when 'affinity' is set to DedicatedHost, and forbidden otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.DedicatedHost"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "affinity",
- "fields-to-discriminateBy": {
- "dedicatedHost": "DedicatedHost"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1beta1.Image": {
- "description": "Image is a mirror of azure sdk compute.ImageReference",
- "type": "object",
- "required": [
- "publisher",
- "offer",
- "sku",
- "version",
- "resourceID"
- ],
- "properties": {
- "offer": {
- "description": "offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer",
- "type": "string",
- "default": ""
- },
- "publisher": {
- "description": "publisher is the name of the organization that created the image",
- "type": "string",
- "default": ""
- },
- "resourceID": {
- "description": "resourceID specifies an image to use by ID",
- "type": "string",
- "default": ""
- },
- "sku": {
- "description": "sku specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type identifies the source of the image and related information, such as purchase plans. Valid values are \"ID\", \"MarketplaceWithPlan\", \"MarketplaceNoPlan\", and omitted, which means no opinion and the platform chooses a good default which may change over time. Currently that default is \"MarketplaceNoPlan\" if publisher data is supplied, or \"ID\" if not. For more information about purchase plans, see: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cli-ps-findimage#check-the-purchase-plan-information",
- "type": "string"
- },
- "version": {
- "description": "version specifies the version of an image sku. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.LastOperation": {
- "description": "LastOperation represents the detail of the last performed operation on the MachineObject.",
- "type": "object",
- "properties": {
- "description": {
- "description": "description is the human-readable description of the last operation.",
- "type": "string"
- },
- "lastUpdated": {
- "description": "lastUpdated is the timestamp at which LastOperation API was last-updated.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "state": {
- "description": "state is the current status of the last performed operation. E.g. Processing, Failed, Successful etc",
- "type": "string"
- },
- "type": {
- "description": "type is the type of operation which was last performed. E.g. Create, Delete, Update etc",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.LifecycleHook": {
- "description": "LifecycleHook represents a single instance of a lifecycle hook",
- "type": "object",
- "required": [
- "name",
- "owner"
- ],
- "properties": {
- "name": {
- "description": "name defines a unique name for the lifcycle hook. The name should be unique and descriptive, ideally 1-3 words, in CamelCase or it may be namespaced, eg. foo.example.com/CamelCase. Names must be unique and should only be managed by a single entity.",
- "type": "string",
- "default": ""
- },
- "owner": {
- "description": "owner defines the owner of the lifecycle hook. This should be descriptive enough so that users can identify who/what is responsible for blocking the lifecycle. This could be the name of a controller (e.g. clusteroperator/etcd) or an administrator managing the hook.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.LifecycleHooks": {
- "description": "LifecycleHooks allow users to pause operations on the machine at certain prefedined points within the machine lifecycle.",
- "type": "object",
- "properties": {
- "preDrain": {
- "description": "preDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.LifecycleHook"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "preTerminate": {
- "description": "preTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.LifecycleHook"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.LoadBalancerReference": {
- "description": "LoadBalancerReference is a reference to a load balancer on AWS.",
- "type": "object",
- "required": [
- "name",
- "type"
- ],
- "properties": {
- "name": {
- "type": "string",
- "default": ""
- },
- "type": {
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.Machine": {
- "description": "Machine is the Schema for the machines API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineStatus"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineHealthCheck": {
- "description": "MachineHealthCheck is the Schema for the machinehealthchecks API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "Specification of machine health check policy",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineHealthCheckSpec"
- },
- "status": {
- "description": "Most recently observed status of MachineHealthCheck resource",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineHealthCheckStatus"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineHealthCheckList": {
- "description": "MachineHealthCheckList contains a list of MachineHealthCheck Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineHealthCheck"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineHealthCheckSpec": {
- "description": "MachineHealthCheckSpec defines the desired state of MachineHealthCheck",
- "type": "object",
- "required": [
- "selector",
- "unhealthyConditions"
- ],
- "properties": {
- "maxUnhealthy": {
- "description": "Any farther remediation is only allowed if at most \"MaxUnhealthy\" machines selected by \"selector\" are not healthy. Expects either a postive integer value or a percentage value. Percentage values must be positive whole numbers and are capped at 100%. Both 0 and 0% are valid and will block all remediation. Defaults to 100% if not set.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
- },
- "nodeStartupTimeout": {
- "description": "Machines older than this duration without a node will be considered to have failed and will be remediated. To prevent Machines without Nodes from being removed, disable startup checks by setting this value explicitly to \"0\". Expects an unsigned duration string of decimal numbers each with optional fraction and a unit suffix, eg \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "remediationTemplate": {
- "description": "remediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Machine API Operator.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "selector": {
- "description": "Label selector to match machines whose health will be exercised. Note: An empty selector will match all machines.",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "unhealthyConditions": {
- "description": "unhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.UnhealthyCondition"
- }
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineHealthCheckStatus": {
- "description": "MachineHealthCheckStatus defines the observed state of MachineHealthCheck",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions defines the current state of the MachineHealthCheck",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "currentHealthy": {
- "description": "total number of machines counted by this machine health check",
- "type": "integer",
- "format": "int32"
- },
- "expectedMachines": {
- "description": "total number of machines counted by this machine health check",
- "type": "integer",
- "format": "int32"
- },
- "remediationsAllowed": {
- "description": "remediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineList": {
- "description": "MachineList contains a list of Machine Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Machine"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineSet": {
- "description": "MachineSet ensures that a specified number of machines replicas are running at any given time. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineSetSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineSetStatus"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineSetList": {
- "description": "MachineSetList contains a list of MachineSet Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineSet"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineSetSpec": {
- "description": "MachineSetSpec defines the desired state of MachineSet",
- "type": "object",
- "required": [
- "selector"
- ],
- "properties": {
- "authoritativeAPI": {
- "description": "authoritativeAPI is the API that is authoritative for this resource. Valid values are MachineAPI and ClusterAPI. When set to MachineAPI, writes to the spec of the machine.openshift.io copy of this resource will be reflected into the cluster.x-k8s.io copy. When set to ClusterAPI, writes to the spec of the cluster.x-k8s.io copy of this resource will be reflected into the machine.openshift.io copy. Updates to the status will be reflected in both copies of the resource, based on the controller implementing the functionality of the API. Currently the authoritative API determines which controller will manage the resource, this will change in a future release. To ensure the change has been accepted, please verify that the `status.authoritativeAPI` field has been updated to the desired value and that the `Synchronized` condition is present and set to `True`.",
- "type": "string",
- "default": "MachineAPI"
- },
- "deletePolicy": {
- "description": "deletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"",
- "type": "string"
- },
- "minReadySeconds": {
- "description": "minReadySeconds is the minimum number of seconds for which a newly created machine should be ready. Defaults to 0 (machine will be considered available as soon as it is ready)",
- "type": "integer",
- "format": "int32"
- },
- "replicas": {
- "description": "replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.",
- "type": "integer",
- "format": "int32"
- },
- "selector": {
- "description": "selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "template": {
- "description": "template is the object that describes the machine that will be created if insufficient replicas are detected.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineTemplateSpec"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineSetStatus": {
- "description": "MachineSetStatus defines the observed state of MachineSet",
- "type": "object",
- "properties": {
- "authoritativeAPI": {
- "description": "authoritativeAPI is the API that is authoritative for this resource. Valid values are MachineAPI, ClusterAPI and Migrating. This value is updated by the migration controller to reflect the authoritative API. Machine API and Cluster API controllers use this value to determine whether or not to reconcile the resource. When set to Migrating, the migration controller is currently performing the handover of authority from one API to the other.",
- "type": "string"
- },
- "availableReplicas": {
- "description": "The number of available replicas (ready for at least minReadySeconds) for this MachineSet.",
- "type": "integer",
- "format": "int32"
- },
- "conditions": {
- "description": "conditions defines the current state of the MachineSet",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "errorMessage": {
- "type": "string"
- },
- "errorReason": {
- "description": "In the event that there is a terminal problem reconciling the replicas, both ErrorReason and ErrorMessage will be set. ErrorReason will be populated with a succinct value suitable for machine interpretation, while ErrorMessage will contain a more verbose string suitable for logging and human consumption.\n\nThese fields should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachineTemplate's spec or the configuration of the machine controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the machine controller, or the responsible machine controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the MachineSet object and/or logged in the controller's output.",
- "type": "string"
- },
- "fullyLabeledReplicas": {
- "description": "The number of replicas that have labels matching the labels of the machine template of the MachineSet.",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration reflects the generation of the most recently observed MachineSet.",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "The number of ready replicas for this MachineSet. A machine is considered ready when the node has been created and is \"Ready\".",
- "type": "integer",
- "format": "int32"
- },
- "replicas": {
- "description": "replicas is the most recently observed number of replicas.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "synchronizedGeneration": {
- "description": "synchronizedGeneration is the generation of the authoritative resource that the non-authoritative resource is synchronised with. This field is set when the authoritative resource is updated and the sync controller has updated the non-authoritative resource to match.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineSpec": {
- "description": "MachineSpec defines the desired state of Machine",
- "type": "object",
- "properties": {
- "authoritativeAPI": {
- "description": "authoritativeAPI is the API that is authoritative for this resource. Valid values are MachineAPI and ClusterAPI. When set to MachineAPI, writes to the spec of the machine.openshift.io copy of this resource will be reflected into the cluster.x-k8s.io copy. When set to ClusterAPI, writes to the spec of the cluster.x-k8s.io copy of this resource will be reflected into the machine.openshift.io copy. Updates to the status will be reflected in both copies of the resource, based on the controller implementing the functionality of the API. Currently the authoritative API determines which controller will manage the resource, this will change in a future release. To ensure the change has been accepted, please verify that the `status.authoritativeAPI` field has been updated to the desired value and that the `Synchronized` condition is present and set to `True`.",
- "type": "string",
- "default": "MachineAPI"
- },
- "lifecycleHooks": {
- "description": "lifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.LifecycleHooks"
- },
- "metadata": {
- "description": "ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.ObjectMeta"
- },
- "providerID": {
- "description": "providerID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.",
- "type": "string"
- },
- "providerSpec": {
- "description": "providerSpec details Provider-specific configuration to use during node creation.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.ProviderSpec"
- },
- "taints": {
- "description": "The list of the taints to be applied to the corresponding Node in additive manner. This list will not overwrite any other taints added to the Node on an ongoing basis by other entities. These taints should be actively reconciled e.g. if you ask the machine controller to apply a taint and then manually remove the taint the machine controller will put it back) but not have the machine controller remove any taints",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Taint"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineStatus": {
- "description": "MachineStatus defines the observed state of Machine",
- "type": "object",
- "properties": {
- "addresses": {
- "description": "addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.NodeAddress"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "authoritativeAPI": {
- "description": "authoritativeAPI is the API that is authoritative for this resource. Valid values are MachineAPI, ClusterAPI and Migrating. This value is updated by the migration controller to reflect the authoritative API. Machine API and Cluster API controllers use this value to determine whether or not to reconcile the resource. When set to Migrating, the migration controller is currently performing the handover of authority from one API to the other.",
- "type": "string"
- },
- "conditions": {
- "description": "conditions defines the current state of the Machine",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "errorMessage": {
- "description": "errorMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.",
- "type": "string"
- },
- "errorReason": {
- "description": "errorReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.",
- "type": "string"
- },
- "lastOperation": {
- "description": "lastOperation describes the last-operation performed by the machine-controller. This API should be useful as a history in terms of the latest operation performed on the specific machine. It should also convey the state of the latest-operation for example if it is still on-going, failed or completed successfully.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.LastOperation"
- },
- "lastUpdated": {
- "description": "lastUpdated identifies when this status was last observed.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "nodeRef": {
- "description": "nodeRef will point to the corresponding Node if it exists.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "phase": {
- "description": "phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting",
- "type": "string"
- },
- "providerStatus": {
- "description": "providerStatus details a Provider-specific status. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "synchronizedGeneration": {
- "description": "synchronizedGeneration is the generation of the authoritative resource that the non-authoritative resource is synchronised with. This field is set when the authoritative resource is updated and the sync controller has updated the non-authoritative resource to match.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MachineTemplateSpec": {
- "description": "MachineTemplateSpec describes the data needed to create a Machine from a template",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.ObjectMeta"
- },
- "spec": {
- "description": "Specification of the desired behavior of the machine. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.MachineSpec"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.MetadataServiceOptions": {
- "description": "MetadataServiceOptions defines the options available to a user when configuring Instance Metadata Service (IMDS) Options.",
- "type": "object",
- "properties": {
- "authentication": {
- "description": "authentication determines whether or not the host requires the use of authentication when interacting with the metadata service. When using authentication, this enforces v2 interaction method (IMDSv2) with the metadata service. When omitted, this means the user has no opinion and the value is left to the platform to choose a good default, which is subject to change over time. The current default is optional. At this point this field represents `HttpTokens` parameter from `InstanceMetadataOptionsRequest` structure in AWS EC2 API https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_InstanceMetadataOptionsRequest.html",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.NetworkDeviceSpec": {
- "description": "NetworkDeviceSpec defines the network configuration for a virtual machine's network device.",
- "type": "object",
- "properties": {
- "addressesFromPools": {
- "description": "addressesFromPools is a list of references to IP pool types and instances which are handled by an external controller. addressesFromPool configurations provided via addressesFromPools defer IP address assignment to an external controller. IP addresses provided via ipAddrs, however, are intended to allow explicit assignment of a machine's IP address. If both addressesFromPool and ipAddrs are empty or not defined, DHCP will assign an IP address. If both ipAddrs and addressesFromPools are defined, the IP addresses associated with ipAddrs will be applied first followed by IP addresses from addressesFromPools.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.AddressesFromPool"
- }
- },
- "gateway": {
- "description": "gateway is an IPv4 or IPv6 address which represents the subnet gateway, for example, 192.168.1.1.",
- "type": "string"
- },
- "ipAddrs": {
- "description": "ipAddrs is a list of one or more IPv4 and/or IPv6 addresses and CIDR to assign to this device, for example, 192.168.1.100/24. IP addresses provided via ipAddrs are intended to allow explicit assignment of a machine's IP address. IP pool configurations provided via addressesFromPool, however, defer IP address assignment to an external controller. If both addressesFromPool and ipAddrs are empty or not defined, DHCP will be used to assign an IP address. If both ipAddrs and addressesFromPools are defined, the IP addresses associated with ipAddrs will be applied first followed by IP addresses from addressesFromPools.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "nameservers": {
- "description": "nameservers is a list of IPv4 and/or IPv6 addresses used as DNS nameservers, for example, 8.8.8.8. a nameserver is not provided by a fulfilled IPAddressClaim. If DHCP is not the source of IP addresses for this network device, nameservers should include a valid nameserver.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "networkName": {
- "description": "networkName is the name of the vSphere network or port group to which the network device will be connected, for example, port-group-1. When not provided, the vCenter API will attempt to select a default network. The available networks (port groups) can be listed using `govc ls 'network/*'`",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.NetworkSpec": {
- "description": "NetworkSpec defines the virtual machine's network configuration.",
- "type": "object",
- "required": [
- "devices"
- ],
- "properties": {
- "devices": {
- "description": "devices defines the virtual machine's network interfaces.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.NetworkDeviceSpec"
- }
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.OSDisk": {
- "type": "object",
- "required": [
- "osType",
- "managedDisk",
- "diskSizeGB"
- ],
- "properties": {
- "cachingType": {
- "description": "cachingType specifies the caching requirements. Possible values include: 'None', 'ReadOnly', 'ReadWrite'. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is `None`.",
- "type": "string"
- },
- "diskSettings": {
- "description": "diskSettings describe ephemeral disk settings for the os disk.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.DiskSettings"
- },
- "diskSizeGB": {
- "description": "diskSizeGB is the size in GB to assign to the data disk.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "managedDisk": {
- "description": "managedDisk specifies the Managed Disk parameters for the OS disk.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.OSDiskManagedDiskParameters"
- },
- "osType": {
- "description": "osType is the operating system type of the OS disk. Possible values include \"Linux\" and \"Windows\".",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.OSDiskManagedDiskParameters": {
- "description": "OSDiskManagedDiskParameters is the parameters of a OSDisk managed disk.",
- "type": "object",
- "required": [
- "storageAccountType"
- ],
- "properties": {
- "diskEncryptionSet": {
- "description": "diskEncryptionSet is the disk encryption set properties",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.DiskEncryptionSetParameters"
- },
- "securityProfile": {
- "description": "securityProfile specifies the security profile for the managed disk.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.VMDiskSecurityProfile"
- },
- "storageAccountType": {
- "description": "storageAccountType is the storage account type to use. Possible values include \"Standard_LRS\", \"Premium_LRS\".",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.ObjectMeta": {
- "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. This is a copy of customizable fields from metav1.ObjectMeta.\n\nObjectMeta is embedded in `Machine.Spec`, `MachineDeployment.Template` and `MachineSet.Template`, which are not top-level Kubernetes objects. Given that metav1.ObjectMeta has lots of special cases and read-only fields which end up in the generated CRD validation, having it as a subset simplifies the API and some issues that can impact user experience.\n\nDuring the [upgrade to controller-tools@v2](https://github.com/kubernetes-sigs/cluster-api/pull/1054) for v1alpha2, we noticed a failure would occur running Cluster API test suite against the new CRDs, specifically `spec.metadata.creationTimestamp in body must be of type string: \"null\"`. The investigation showed that `controller-tools@v2` behaves differently than its previous version when handling types from [metav1](k8s.io/apimachinery/pkg/apis/meta/v1) package.\n\nIn more details, we found that embedded (non-top level) types that embedded `metav1.ObjectMeta` had validation properties, including for `creationTimestamp` (metav1.Time). The `metav1.Time` type specifies a custom json marshaller that, when IsZero() is true, returns `null` which breaks validation because the field isn't marked as nullable.\n\nIn future versions, controller-tools@v2 might allow overriding the type and validation for embedded types. When that happens, this hack should be revisited.",
- "type": "object",
- "properties": {
- "annotations": {
- "description": "annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "generateName": {
- "description": "generateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
- "type": "string"
- },
- "labels": {
- "description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "name": {
- "description": "name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
- "type": "string"
- },
- "namespace": {
- "description": "namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
- "type": "string"
- },
- "ownerReferences": {
- "description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference"
- },
- "x-kubernetes-list-map-keys": [
- "uid"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "uid",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.Placement": {
- "description": "Placement indicates where to create the instance in AWS",
- "type": "object",
- "properties": {
- "availabilityZone": {
- "description": "availabilityZone is the availability zone of the instance",
- "type": "string"
- },
- "region": {
- "description": "region is the region to use to create the instance",
- "type": "string"
- },
- "tenancy": {
- "description": "tenancy indicates if instance should run on shared or single-tenant hardware. There are supported 3 options: default, dedicated and host.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.ProviderSpec": {
- "description": "ProviderSpec defines the configuration to use during node creation.",
- "type": "object",
- "properties": {
- "value": {
- "description": "value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.ResourceManagerTag": {
- "description": "ResourceManagerTag is a tag to apply to GCP resources created for the cluster.",
- "type": "object",
- "required": [
- "parentID",
- "key",
- "value"
- ],
- "properties": {
- "key": {
- "description": "key is the key part of the tag. A tag key can have a maximum of 63 characters and cannot be empty. Tag key must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters `._-`.",
- "type": "string",
- "default": ""
- },
- "parentID": {
- "description": "parentID is the ID of the hierarchical resource where the tags are defined e.g. at the Organization or the Project level. To find the Organization or Project ID ref https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects An OrganizationID can have a maximum of 32 characters and must consist of decimal numbers, and cannot have leading zeroes. A ProjectID must be 6 to 30 characters in length, can only contain lowercase letters, numbers, and hyphens, and must start with a letter, and cannot end with a hyphen.",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value is the value part of the tag. A tag value can have a maximum of 63 characters and cannot be empty. Tag value must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters `_-.@%=+:,*#&(){}[]` and spaces.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.SecurityProfile": {
- "description": "SecurityProfile specifies the Security profile settings for a virtual machine or virtual machine scale set.",
- "type": "object",
- "properties": {
- "encryptionAtHost": {
- "description": "encryptionAtHost indicates whether Host Encryption should be enabled or disabled for a virtual machine or virtual machine scale set. This should be disabled when SecurityEncryptionType is set to DiskWithVMGuestState. Default is disabled.",
- "type": "boolean"
- },
- "settings": {
- "description": "settings specify the security type and the UEFI settings of the virtual machine. This field can be set for Confidential VMs and Trusted Launch for VMs.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.SecuritySettings"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.SecuritySettings": {
- "description": "SecuritySettings define the security type and the UEFI settings of the virtual machine.",
- "type": "object",
- "required": [
- "securityType"
- ],
- "properties": {
- "confidentialVM": {
- "description": "confidentialVM specifies the security configuration of the virtual machine. For more information regarding Confidential VMs, please refer to: https://learn.microsoft.com/azure/confidential-computing/confidential-vm-overview",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.ConfidentialVM"
- },
- "securityType": {
- "description": "securityType specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UEFISettings. The default behavior is: UEFISettings will not be enabled unless this property is set.",
- "type": "string",
- "default": ""
- },
- "trustedLaunch": {
- "description": "trustedLaunch specifies the security configuration of the virtual machine. For more information regarding TrustedLaunch for VMs, please refer to: https://learn.microsoft.com/azure/virtual-machines/trusted-launch",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.TrustedLaunch"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "securityType",
- "fields-to-discriminateBy": {
- "confidentialVM": "ConfidentialVM",
- "trustedLaunch": "TrustedLaunch"
- }
- }
- ]
- },
- "com.github.openshift.api.machine.v1beta1.SpotMarketOptions": {
- "description": "SpotMarketOptions defines the options available to a user when configuring Machines to run on Spot instances. Most users should provide an empty struct.",
- "type": "object",
- "properties": {
- "maxPrice": {
- "description": "The maximum price the user is willing to pay for their instances Default: On-Demand price",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.SpotVMOptions": {
- "description": "SpotVMOptions defines the options relevant to running the Machine on Spot VMs",
- "type": "object",
- "properties": {
- "maxPrice": {
- "description": "maxPrice defines the maximum price the user is willing to pay for Spot VM instances",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.TagSpecification": {
- "description": "TagSpecification is the name/value pair for a tag",
- "type": "object",
- "required": [
- "name",
- "value"
- ],
- "properties": {
- "name": {
- "description": "name of the tag",
- "type": "string",
- "default": ""
- },
- "value": {
- "description": "value of the tag",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.TrustedLaunch": {
- "description": "TrustedLaunch defines the UEFI settings for the virtual machine.",
- "type": "object",
- "required": [
- "uefiSettings"
- ],
- "properties": {
- "uefiSettings": {
- "description": "uefiSettings specifies the security settings like secure boot and vTPM used while creating the virtual machine.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.UEFISettings"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.UEFISettings": {
- "description": "UEFISettings specifies the security settings like secure boot and vTPM used while creating the virtual machine.",
- "type": "object",
- "properties": {
- "secureBoot": {
- "description": "secureBoot specifies whether secure boot should be enabled on the virtual machine. Secure Boot verifies the digital signature of all boot components and halts the boot process if signature verification fails. If omitted, the platform chooses a default, which is subject to change over time, currently that default is disabled.",
- "type": "string"
- },
- "virtualizedTrustedPlatformModule": {
- "description": "virtualizedTrustedPlatformModule specifies whether vTPM should be enabled on the virtual machine. When enabled the virtualized trusted platform module measurements are used to create a known good boot integrity policy baseline. The integrity policy baseline is used for comparison with measurements from subsequent VM boots to determine if anything has changed. This is required to be enabled if SecurityEncryptionType is defined. If omitted, the platform chooses a default, which is subject to change over time, currently that default is disabled.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.UnhealthyCondition": {
- "description": "UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.",
- "type": "object",
- "required": [
- "type",
- "status",
- "timeout"
- ],
- "properties": {
- "status": {
- "type": "string",
- "default": ""
- },
- "timeout": {
- "description": "Expects an unsigned duration string of decimal numbers each with optional fraction and a unit suffix, eg \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "type": {
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.VMDiskSecurityProfile": {
- "description": "VMDiskSecurityProfile specifies the security profile settings for the managed disk. It can be set only for Confidential VMs.",
- "type": "object",
- "properties": {
- "diskEncryptionSet": {
- "description": "diskEncryptionSet specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.DiskEncryptionSetParameters"
- },
- "securityEncryptionType": {
- "description": "securityEncryptionType specifies the encryption type of the managed disk. It is set to DiskWithVMGuestState to encrypt the managed disk along with the VMGuestState blob, and to VMGuestStateOnly to encrypt the VMGuestState blob only. When set to VMGuestStateOnly, the vTPM should be enabled. When set to DiskWithVMGuestState, both SecureBoot and vTPM should be enabled. If the above conditions are not fulfilled, the VM will not be created and the respective error will be returned. It can be set only for Confidential VMs. Confidential VMs are defined by their SecurityProfile.SecurityType being set to ConfidentialVM, the SecurityEncryptionType of their OS disk being set to one of the allowed values and by enabling the respective SecurityProfile.UEFISettings of the VM (i.e. vTPM and SecureBoot), depending on the selected SecurityEncryptionType. For further details on Azure Confidential VMs, please refer to the respective documentation: https://learn.microsoft.com/azure/confidential-computing/confidential-vm-overview",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.VSphereDisk": {
- "description": "VSphereDisk describes additional disks for vSphere.",
- "type": "object",
- "required": [
- "name",
- "sizeGiB"
- ],
- "properties": {
- "name": {
- "description": "name is used to identify the disk definition. name is required needs to be unique so that it can be used to clearly identify purpose of the disk. It must be at most 80 characters in length and must consist only of alphanumeric characters, hyphens and underscores, and must start and end with an alphanumeric character.",
- "type": "string",
- "default": ""
- },
- "provisioningMode": {
- "description": "provisioningMode is an optional field that specifies the provisioning type to be used by this vSphere data disk. Allowed values are \"Thin\", \"Thick\", \"EagerlyZeroed\", and omitted. When set to Thin, the disk will be made using thin provisioning allocating the bare minimum space. When set to Thick, the full disk size will be allocated when disk is created. When set to EagerlyZeroed, the disk will be created using eager zero provisioning. An eager zeroed thick disk has all space allocated and wiped clean of any previous contents on the physical media at creation time. Such disks may take longer time during creation compared to other disk formats. When omitted, no setting will be applied to the data disk and the provisioning mode for the disk will be determined by the default storage policy configured for the datastore in vSphere.",
- "type": "string"
- },
- "sizeGiB": {
- "description": "sizeGiB is the size of the disk in GiB. The maximum supported size 16384 GiB.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.VSphereMachineProviderSpec": {
- "description": "VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "template",
- "network"
- ],
- "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",
- "type": "string"
- },
- "cloneMode": {
- "description": "cloneMode specifies the type of clone operation. The LinkedClone mode is only support for templates that have at least one snapshot. If the template has no snapshots, then CloneMode defaults to FullClone. When LinkedClone mode is enabled the DiskGiB field is ignored as it is not possible to expand disks of linked clones. Defaults to FullClone. When using LinkedClone, if no snapshots exist for the source template, falls back to FullClone.",
- "type": "string"
- },
- "credentialsSecret": {
- "description": "credentialsSecret is a reference to the secret with vSphere credentials.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "dataDisks": {
- "description": "dataDisks is a list of non OS disks to be created and attached to the VM. The max number of disk allowed to be attached is currently 29. The max number of disks for any controller is 30, but VM template will always have OS disk so that will leave 29 disks on any controller type.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.VSphereDisk"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "diskGiB": {
- "description": "diskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned. This parameter will be ignored if 'LinkedClone' CloneMode is set.",
- "type": "integer",
- "format": "int32"
- },
- "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",
- "type": "string"
- },
- "memoryMiB": {
- "description": "memoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.",
- "type": "integer",
- "format": "int64"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "network": {
- "description": "network is the network configuration for this machine's VM.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.NetworkSpec"
- },
- "numCPUs": {
- "description": "numCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.",
- "type": "integer",
- "format": "int32"
- },
- "numCoresPerSocket": {
- "description": "NumCPUs is the number of cores among which to distribute CPUs in this virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.",
- "type": "integer",
- "format": "int32"
- },
- "snapshot": {
- "description": "snapshot is the name of the snapshot from which the VM was cloned",
- "type": "string",
- "default": ""
- },
- "tagIDs": {
- "description": "tagIDs is an optional set of tags to add to an instance. Specified tagIDs must use URN-notation instead of display names. A maximum of 10 tag IDs may be specified.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "template": {
- "description": "template is the name, inventory path, or instance UUID of the template used to clone new machines.",
- "type": "string",
- "default": ""
- },
- "userDataSecret": {
- "description": "userDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "workspace": {
- "description": "workspace describes the workspace to use for the machine.",
- "$ref": "#/definitions/com.github.openshift.api.machine.v1beta1.Workspace"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.VSphereMachineProviderStatus": {
- "description": "VSphereMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains VSphere-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "conditions": {
- "description": "conditions is a set of conditions associated with the Machine to indicate errors or other status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "instanceId": {
- "description": "instanceId is the ID of the instance in VSphere",
- "type": "string"
- },
- "instanceState": {
- "description": "instanceState is the provisioning state of the VSphere Instance.",
- "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",
- "type": "string"
- },
- "taskRef": {
- "description": "taskRef is a managed object reference to a Task related to the machine. This value is set automatically at runtime and should not be set or modified by users.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machine.v1beta1.Workspace": {
- "description": "WorkspaceConfig defines a workspace configuration for the vSphere cloud provider.",
- "type": "object",
- "properties": {
- "datacenter": {
- "description": "datacenter is the datacenter in which VMs are created/located.",
- "type": "string"
- },
- "datastore": {
- "description": "datastore is the datastore in which VMs are created/located.",
- "type": "string"
- },
- "folder": {
- "description": "folder is the folder in which VMs are created/located.",
- "type": "string"
- },
- "resourcePool": {
- "description": "resourcePool is the resource pool in which VMs are created/located.",
- "type": "string"
- },
- "server": {
- "description": "server is the IP address or FQDN of the vSphere endpoint.",
- "type": "string"
- },
- "vmGroup": {
- "description": "vmGroup is the cluster vm group in which virtual machines will be added for vm host group based zonal.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MCOObjectReference": {
- "description": "MCOObjectReference holds information about an object the MCO either owns or modifies in some way",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the object being referenced. For example, this can represent a machine config pool or node name. Must be a lowercase RFC-1123 subdomain name (https://tools.ietf.org/html/rfc1123) consisting of only lowercase alphanumeric characters, hyphens (-), and periods (.), and must start and end with an alphanumeric character, and be at most 253 characters in length.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNode": {
- "description": "MachineConfigNode describes the health of the Machines on the system Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object metadata.",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec describes the configuration of the machine config node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeSpec"
- },
- "status": {
- "description": "status describes the last observed state of this machine config node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeStatus"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeList": {
- "description": "MachineConfigNodeList describes all of the MachinesStates on the system\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains a collection of MachineConfigNode resources.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNode"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list metadata.",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeSpec": {
- "description": "MachineConfigNodeSpec describes the MachineConfigNode we are managing.",
- "type": "object",
- "required": [
- "node",
- "pool",
- "configVersion"
- ],
- "properties": {
- "configVersion": {
- "description": "configVersion holds the desired config version for the node targeted by this machine config node resource. The desired version represents the machine config the node will attempt to update to and gets set before the machine config operator validates the new machine config against the current machine config.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeSpecMachineConfigVersion"
- },
- "node": {
- "description": "node contains a reference to the node for this machine config node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MCOObjectReference"
- },
- "pool": {
- "description": "pool contains a reference to the machine config pool that this machine config node's referenced node belongs to.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MCOObjectReference"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeSpecMachineConfigVersion": {
- "description": "MachineConfigNodeSpecMachineConfigVersion holds the desired config version for the current observed machine config node. When Current is not equal to Desired, the MachineConfigOperator is in an upgrade phase and the machine config node will take account of upgrade related events. Otherwise, they will be ignored given that certain operations happen both during the MCO's upgrade mode and the daily operations mode.",
- "type": "object",
- "required": [
- "desired"
- ],
- "properties": {
- "desired": {
- "description": "desired is the name of the machine config that the the node should be upgraded to. This value is set when the machine config pool generates a new version of its rendered configuration. When this value is changed, the machine config daemon starts the node upgrade process. This value gets set in the machine config node spec once the machine config has been targeted for upgrade and before it is validated. Must be a lowercase RFC-1123 subdomain name (https://tools.ietf.org/html/rfc1123) consisting of only lowercase alphanumeric characters, hyphens (-), and periods (.), and must start and end with an alphanumeric character, and be at most 253 characters in length.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeStatus": {
- "description": "MachineConfigNodeStatus holds the reported information on a particular machine config node.",
- "type": "object",
- "required": [
- "configVersion"
- ],
- "properties": {
- "conditions": {
- "description": "conditions represent the observations of a machine config node's current state.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "configVersion": {
- "description": "configVersion describes the current and desired machine config version for this node.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeStatusMachineConfigVersion"
- },
- "observedGeneration": {
- "description": "observedGeneration represents the generation of the MachineConfigNode object observed by the Machine Config Operator's controller. This field is updated when the controller observes a change to the desiredConfig in the configVersion of the machine config node spec.",
- "type": "integer",
- "format": "int64"
- },
- "pinnedImageSets": {
- "description": "pinnedImageSets describes the current and desired pinned image sets for this node.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeStatusPinnedImageSet"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeStatusMachineConfigVersion": {
- "description": "MachineConfigNodeStatusMachineConfigVersion holds the current and desired config versions as last updated in the MCN status. When the current and desired versions do not match, the machine config pool is processing an upgrade and the machine config node will monitor the upgrade process. When the current and desired versions do match, the machine config node will ignore these events given that certain operations happen both during the MCO's upgrade mode and the daily operations mode.",
- "type": "object",
- "required": [
- "desired"
- ],
- "properties": {
- "current": {
- "description": "current is the name of the machine config currently in use on the node. This value is updated once the machine config daemon has completed the update of the configuration for the node. This value should match the desired version unless an upgrade is in progress. Must be a lowercase RFC-1123 subdomain name (https://tools.ietf.org/html/rfc1123) consisting of only lowercase alphanumeric characters, hyphens (-), and periods (.), and must start and end with an alphanumeric character, and be at most 253 characters in length.",
- "type": "string",
- "default": ""
- },
- "desired": {
- "description": "desired is the MachineConfig the node wants to upgrade to. This value gets set in the machine config node status once the machine config has been validated against the current machine config. Must be a lowercase RFC-1123 subdomain name (https://tools.ietf.org/html/rfc1123) consisting of only lowercase alphanumeric characters, hyphens (-), and periods (.), and must start and end with an alphanumeric character, and be at most 253 characters in length.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.MachineConfigNodeStatusPinnedImageSet": {
- "description": "MachineConfigNodeStatusPinnedImageSet holds information about the current, desired, and failed pinned image sets for the observed machine config node.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "currentGeneration": {
- "description": "currentGeneration is the generation of the pinned image set that has most recently been successfully pulled and pinned on this node.",
- "type": "integer",
- "format": "int32"
- },
- "desiredGeneration": {
- "description": "desiredGeneration is the generation of the pinned image set that is targeted to be pulled and pinned on this node.",
- "type": "integer",
- "format": "int32"
- },
- "lastFailedGeneration": {
- "description": "lastFailedGeneration is the generation of the most recent pinned image set that failed to be pulled and pinned on this node.",
- "type": "integer",
- "format": "int32"
- },
- "lastFailedGenerationError": {
- "description": "lastFailedGenerationError is the error explaining why the desired images failed to be pulled and pinned. The error is an empty string if the image pull and pin is successful.",
- "type": "string"
- },
- "name": {
- "description": "name is the name of the pinned image set. Must be a lowercase RFC-1123 subdomain name (https://tools.ietf.org/html/rfc1123) consisting of only lowercase alphanumeric characters, hyphens (-), and periods (.), and must start and end with an alphanumeric character, and be at most 253 characters in length.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageRef": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is an OCI Image referenced by digest.\n\nThe format of the image ref is: host[:port][/namespace]/name@sha256:",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageSet": {
- "description": "PinnedImageSet describes a set of images that should be pinned by CRI-O and pulled to the nodes which are members of the declared MachineConfigPools.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec describes the configuration of this pinned image set.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageSetSpec"
- },
- "status": {
- "description": "status describes the last observed state of this pinned image set.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageSetStatus"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageSetList": {
- "description": "PinnedImageSetList is a list of PinnedImageSet resources\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageSet"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageSetSpec": {
- "description": "PinnedImageSetSpec defines the desired state of a PinnedImageSet.",
- "type": "object",
- "required": [
- "pinnedImages"
- ],
- "properties": {
- "pinnedImages": {
- "description": "pinnedImages is a list of OCI Image referenced by digest that should be pinned and pre-loaded by the nodes of a MachineConfigPool. Translates into a new file inside the /etc/crio/crio.conf.d directory with content similar to this:\n\n pinned_images = [\n \"quay.io/openshift-release-dev/ocp-release@sha256:...\",\n \"quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...\",\n \"quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:...\",\n ...\n ]\n\nThese image references should all be by digest, tags aren't allowed.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageRef"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.machineconfiguration.v1alpha1.PinnedImageSetStatus": {
- "description": "PinnedImageSetStatus describes the current state of a PinnedImageSet.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions represent the observations of a pinned image set's current state.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertRelabelConfig": {
- "description": "AlertRelabelConfig defines a set of relabel configs for alerts.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec describes the desired state of this AlertRelabelConfig object.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.AlertRelabelConfigSpec"
- },
- "status": {
- "description": "status describes the current state of this AlertRelabelConfig object.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.AlertRelabelConfigStatus"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertRelabelConfigList": {
- "description": "AlertRelabelConfigList is a list of AlertRelabelConfigs.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of AlertRelabelConfigs.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.AlertRelabelConfig"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertRelabelConfigSpec": {
- "description": "AlertRelabelConfigsSpec is the desired state of an AlertRelabelConfig resource.",
- "type": "object",
- "required": [
- "configs"
- ],
- "properties": {
- "configs": {
- "description": "configs is a list of sequentially evaluated alert relabel configs.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.RelabelConfig"
- }
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertRelabelConfigStatus": {
- "description": "AlertRelabelConfigStatus is the status of an AlertRelabelConfig resource.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions contains details on the state of the AlertRelabelConfig, may be empty.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertingRule": {
- "description": "AlertingRule represents a set of user-defined Prometheus rule groups containing alerting rules. This resource is the supported method for cluster admins to create alerts based on metrics recorded by the platform monitoring stack in OpenShift, i.e. the Prometheus instance deployed to the openshift-monitoring namespace. You might use this to create custom alerting rules not shipped with OpenShift based on metrics from components such as the node_exporter, which provides machine-level metrics such as CPU usage, or kube-state-metrics, which provides metrics on Kubernetes usage.\n\nThe API is mostly compatible with the upstream PrometheusRule type from the prometheus-operator. The primary difference being that recording rules are not allowed here -- only alerting rules. For each AlertingRule resource created, a corresponding PrometheusRule will be created in the openshift-monitoring namespace. OpenShift requires admins to use the AlertingRule resource rather than the upstream type in order to allow better OpenShift specific defaulting and validation, while not modifying the upstream APIs directly.\n\nYou can find upstream API documentation for PrometheusRule resources here:\n\nhttps://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec describes the desired state of this AlertingRule object.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.AlertingRuleSpec"
- },
- "status": {
- "description": "status describes the current state of this AlertOverrides object.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.AlertingRuleStatus"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertingRuleList": {
- "description": "AlertingRuleList is a list of AlertingRule objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of AlertingRule objects.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.AlertingRule"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertingRuleSpec": {
- "description": "AlertingRuleSpec is the desired state of an AlertingRule resource.",
- "type": "object",
- "required": [
- "groups"
- ],
- "properties": {
- "groups": {
- "description": "groups is a list of grouped alerting rules. Rule groups are the unit at which Prometheus parallelizes rule processing. All rules in a single group share a configured evaluation interval. All rules in the group will be processed together on this interval, sequentially, and all rules will be processed.\n\nIt's common to group related alerting rules into a single AlertingRule resources, and within that resource, closely related alerts, or simply alerts with the same interval, into individual groups. You are also free to create AlertingRule resources with only a single rule group, but be aware that this can have a performance impact on Prometheus if the group is extremely large or has very complex query expressions to evaluate. Spreading very complex rules across multiple groups to allow them to be processed in parallel is also a common use-case.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.RuleGroup"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.AlertingRuleStatus": {
- "description": "AlertingRuleStatus is the status of an AlertingRule resource.",
- "type": "object",
- "properties": {
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with.",
- "type": "integer",
- "format": "int64"
- },
- "prometheusRule": {
- "description": "prometheusRule is the generated PrometheusRule for this AlertingRule. Each AlertingRule instance results in a generated PrometheusRule object in the same namespace, which is always the openshift-monitoring namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.PrometheusRuleRef"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.PrometheusRuleRef": {
- "description": "PrometheusRuleRef is a reference to an existing PrometheusRule object. Each AlertingRule instance results in a generated PrometheusRule object in the same namespace, which is always the openshift-monitoring namespace. This is used to point to the generated PrometheusRule object in the AlertingRule status.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name of the referenced PrometheusRule.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.RelabelConfig": {
- "description": "RelabelConfig allows dynamic rewriting of label sets for alerts. See Prometheus documentation: - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config",
- "type": "object",
- "properties": {
- "action": {
- "description": "action to perform based on regex matching. Must be one of: 'Replace', 'Keep', 'Drop', 'HashMod', 'LabelMap', 'LabelDrop', or 'LabelKeep'. Default is: 'Replace'",
- "type": "string"
- },
- "modulus": {
- "description": "modulus to take of the hash of the source label values. This can be combined with the 'HashMod' action to set 'target_label' to the 'modulus' of a hash of the concatenated 'source_labels'. This is only valid if sourceLabels is not empty and action is not 'LabelKeep' or 'LabelDrop'.",
- "type": "integer",
- "format": "int64"
- },
- "regex": {
- "description": "regex against which the extracted value is matched. Default is: '(.*)' regex is required for all actions except 'HashMod'",
- "type": "string"
- },
- "replacement": {
- "description": "replacement value against which a regex replace is performed if the regular expression matches. This is required if the action is 'Replace' or 'LabelMap' and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available. Default is: '$1'",
- "type": "string"
- },
- "separator": {
- "description": "separator placed between concatenated source label values. When omitted, Prometheus will use its default value of ';'.",
- "type": "string"
- },
- "sourceLabels": {
- "description": "sourceLabels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the 'Replace', 'Keep', and 'Drop' actions. Not allowed for actions 'LabelKeep' and 'LabelDrop'.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "targetLabel": {
- "description": "targetLabel to which the resulting value is written in a 'Replace' action. It is required for 'Replace' and 'HashMod' actions and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.Rule": {
- "description": "Rule describes an alerting rule. See Prometheus documentation: - https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules",
- "type": "object",
- "required": [
- "alert",
- "expr"
- ],
- "properties": {
- "alert": {
- "description": "alert is the name of the alert. Must be a valid label value, i.e. may contain any Unicode character.",
- "type": "string",
- "default": ""
- },
- "annotations": {
- "description": "annotations to add to each alert. These are values that can be used to store longer additional information that you won't query on, such as alert descriptions or runbook links.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "expr": {
- "description": "expr is the PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending or firing alerts. This is most often a string representing a PromQL expression, e.g.: mapi_current_pending_csr > mapi_max_pending_csr In rare cases this could be a simple integer, e.g. a simple \"1\" if the intent is to create an alert that is always firing. This is sometimes used to create an always-firing \"Watchdog\" alert in order to ensure the alerting pipeline is functional.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
- },
- "for": {
- "description": "for is the time period after which alerts are considered firing after first returning results. Alerts which have not yet fired for long enough are considered pending.",
- "type": "string"
- },
- "labels": {
- "description": "labels to add or overwrite for each alert. The results of the PromQL expression for the alert will result in an existing set of labels for the alert, after evaluating the expression, for any label specified here with the same name as a label in that set, the label here wins and overwrites the previous value. These should typically be short identifying values that may be useful to query against. A common example is the alert severity, where one sets `severity: warning` under the `labels` key:",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.monitoring.v1.RuleGroup": {
- "description": "RuleGroup is a list of sequentially evaluated alerting rules.",
- "type": "object",
- "required": [
- "name",
- "rules"
- ],
- "properties": {
- "interval": {
- "description": "interval is how often rules in the group are evaluated. If not specified, it defaults to the global.evaluation_interval configured in Prometheus, which itself defaults to 30 seconds. You can check if this value has been modified from the default on your cluster by inspecting the platform Prometheus configuration: The relevant field in that resource is: spec.evaluationInterval",
- "type": "string"
- },
- "name": {
- "description": "name is the name of the group.",
- "type": "string",
- "default": ""
- },
- "rules": {
- "description": "rules is a list of sequentially evaluated alerting rules. Prometheus may process rule groups in parallel, but rules within a single group are always processed sequentially, and all rules are processed.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.monitoring.v1.Rule"
- }
- }
- }
- },
- "com.github.openshift.api.network.v1.ClusterNetwork": {
- "description": "ClusterNetwork was used by OpenShift SDN. DEPRECATED: OpenShift SDN is no longer supported and this object is no longer used in any way by OpenShift.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "serviceNetwork",
- "clusterNetworks"
- ],
- "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",
- "type": "string"
- },
- "clusterNetworks": {
- "description": "clusterNetworks is a list of ClusterNetwork objects that defines the global overlay network's L3 space by specifying a set of CIDR and netmasks that the SDN can allocate addresses from.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.ClusterNetworkEntry"
- }
- },
- "hostsubnetlength": {
- "description": "hostsubnetlength is the number of bits of network to allocate to each node. eg, 8 would mean that each node would have a /24 slice of the overlay network for its pods",
- "type": "integer",
- "format": "int64"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "mtu": {
- "description": "mtu is the MTU for the overlay network. This should be 50 less than the MTU of the network connecting the nodes. It is normally autodetected by the cluster network operator.",
- "type": "integer",
- "format": "int64"
- },
- "network": {
- "description": "network is a CIDR string specifying the global overlay network's L3 space",
- "type": "string"
- },
- "pluginName": {
- "description": "pluginName is the name of the network plugin being used",
- "type": "string"
- },
- "serviceNetwork": {
- "description": "serviceNetwork is the CIDR range that Service IP addresses are allocated from",
- "type": "string",
- "default": ""
- },
- "vxlanPort": {
- "description": "vxlanPort sets the VXLAN destination port used by the cluster. It is set by the master configuration file on startup and cannot be edited manually. Valid values for VXLANPort are integers 1-65535 inclusive and if unset defaults to 4789. Changing VXLANPort allows users to resolve issues between openshift SDN and other software trying to use the same VXLAN destination port.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.network.v1.ClusterNetworkEntry": {
- "description": "ClusterNetworkEntry defines an individual cluster network. The CIDRs cannot overlap with other cluster network CIDRs, CIDRs reserved for external ips, CIDRs reserved for service networks, and CIDRs reserved for ingress ips.",
- "type": "object",
- "required": [
- "CIDR",
- "hostSubnetLength"
- ],
- "properties": {
- "CIDR": {
- "description": "CIDR defines the total range of a cluster networks address space.",
- "type": "string",
- "default": ""
- },
- "hostSubnetLength": {
- "description": "hostSubnetLength is the number of bits of the accompanying CIDR address to allocate to each node. eg, 8 would mean that each node would have a /24 slice of the overlay network for its pods.",
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.network.v1.ClusterNetworkList": {
- "description": "ClusterNetworkList is a collection of ClusterNetworks\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of cluster networks",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.ClusterNetwork"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.network.v1.EgressNetworkPolicy": {
- "description": "EgressNetworkPolicy was used by OpenShift SDN. DEPRECATED: OpenShift SDN is no longer supported and this object is no longer used in any way by OpenShift.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the current egress network policy",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.EgressNetworkPolicySpec"
- }
- }
- },
- "com.github.openshift.api.network.v1.EgressNetworkPolicyList": {
- "description": "EgressNetworkPolicyList is a collection of EgressNetworkPolicy\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of policies",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.EgressNetworkPolicy"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.network.v1.EgressNetworkPolicyPeer": {
- "description": "EgressNetworkPolicyPeer specifies a target to apply egress network policy to",
- "type": "object",
- "properties": {
- "cidrSelector": {
- "description": "cidrSelector is the CIDR range to allow/deny traffic to. If this is set, dnsName must be unset Ideally we would have liked to use the cidr openapi format for this property. But openshift-sdn only supports v4 while specifying the cidr format allows both v4 and v6 cidrs We are therefore using a regex pattern to validate instead.",
- "type": "string"
- },
- "dnsName": {
- "description": "dnsName is the domain name to allow/deny traffic to. If this is set, cidrSelector must be unset",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.network.v1.EgressNetworkPolicyRule": {
- "description": "EgressNetworkPolicyRule contains a single egress network policy rule",
- "type": "object",
- "required": [
- "type",
- "to"
- ],
- "properties": {
- "to": {
- "description": "to is the target that traffic is allowed/denied to",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.EgressNetworkPolicyPeer"
- },
- "type": {
- "description": "type marks this as an \"Allow\" or \"Deny\" rule",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.network.v1.EgressNetworkPolicySpec": {
- "description": "EgressNetworkPolicySpec provides a list of policies on outgoing network traffic",
- "type": "object",
- "required": [
- "egress"
- ],
- "properties": {
- "egress": {
- "description": "egress contains the list of egress policy rules",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.EgressNetworkPolicyRule"
- }
- }
- }
- },
- "com.github.openshift.api.network.v1.HostSubnet": {
- "description": "HostSubnet was used by OpenShift SDN. DEPRECATED: OpenShift SDN is no longer supported and this object is no longer used in any way by OpenShift.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "host",
- "hostIP",
- "subnet"
- ],
- "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",
- "type": "string"
- },
- "egressCIDRs": {
- "description": "egressCIDRs is the list of CIDR ranges available for automatically assigning egress IPs to this node from. If this field is set then EgressIPs should be treated as read-only.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "egressIPs": {
- "description": "egressIPs is the list of automatic egress IP addresses currently hosted by this node. If EgressCIDRs is empty, this can be set by hand; if EgressCIDRs is set then the master will overwrite the value here with its own allocation of egress IPs.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "host": {
- "description": "host is the name of the node. (This is the same as the object's name, but both fields must be set.)",
- "type": "string",
- "default": ""
- },
- "hostIP": {
- "description": "hostIP is the IP address to be used as a VTEP by other nodes in the overlay network",
- "type": "string",
- "default": ""
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "subnet": {
- "description": "subnet is the CIDR range of the overlay network assigned to the node for its pods",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.network.v1.HostSubnetList": {
- "description": "HostSubnetList is a collection of HostSubnets\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of host subnets",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.HostSubnet"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.network.v1.NetNamespace": {
- "description": "NetNamespace was used by OpenShift SDN. DEPRECATED: OpenShift SDN is no longer supported and this object is no longer used in any way by OpenShift.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "netname",
- "netid"
- ],
- "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",
- "type": "string"
- },
- "egressIPs": {
- "description": "egressIPs is a list of reserved IPs that will be used as the source for external traffic coming from pods in this namespace. (If empty, external traffic will be masqueraded to Node IPs.)",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "netid": {
- "description": "netid is the network identifier of the network namespace assigned to each overlay network packet. This can be manipulated with the \"oc adm pod-network\" commands.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "netname": {
- "description": "netname is the name of the network namespace. (This is the same as the object's name, but both fields must be set.)",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.network.v1.NetNamespaceList": {
- "description": "NetNamespaceList is a collection of NetNamespaces\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of net namespaces",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1.NetNamespace"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.network.v1alpha1.DNSNameResolver": {
- "description": "DNSNameResolver stores the DNS name resolution information of a DNS name. It can be enabled by the TechPreviewNoUpgrade feature set. It can also be enabled by the feature gate DNSNameResolver when using CustomNoUpgrade feature set.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the DNSNameResolver.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1alpha1.DNSNameResolverSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the DNSNameResolver.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1alpha1.DNSNameResolverStatus"
- }
- }
- },
- "com.github.openshift.api.network.v1alpha1.DNSNameResolverList": {
- "description": "DNSNameResolverList contains a list of DNSNameResolvers.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items gives the list of DNSNameResolvers.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1alpha1.DNSNameResolver"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.network.v1alpha1.DNSNameResolverResolvedAddress": {
- "description": "DNSNameResolverResolvedAddress describes the details of an IP address for a resolved DNS name.",
- "type": "object",
- "required": [
- "ip",
- "ttlSeconds",
- "lastLookupTime"
- ],
- "properties": {
- "ip": {
- "description": "ip is an IP address associated with the dnsName. The validity of the IP address expires after lastLookupTime + ttlSeconds. To refresh the information, a DNS lookup will be performed upon the expiration of the IP address's validity. If the information is not refreshed then it will be removed with a grace period after the expiration of the IP address's validity.",
- "type": "string",
- "default": ""
- },
- "lastLookupTime": {
- "description": "lastLookupTime is the timestamp when the last DNS lookup was completed successfully. The validity of the IP address expires after lastLookupTime + ttlSeconds. The value of this field will be updated to the current time on a successful DNS lookup. If the information is not refreshed then it will be removed with a grace period after the expiration of the IP address's validity.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "ttlSeconds": {
- "description": "ttlSeconds is the time-to-live value of the IP address. The validity of the IP address expires after lastLookupTime + ttlSeconds. On a successful DNS lookup the value of this field will be updated with the current time-to-live value. If the information is not refreshed then it will be removed with a grace period after the expiration of the IP address's validity.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.network.v1alpha1.DNSNameResolverResolvedName": {
- "description": "DNSNameResolverResolvedName describes the details of a resolved DNS name.",
- "type": "object",
- "required": [
- "dnsName",
- "resolvedAddresses"
- ],
- "properties": {
- "conditions": {
- "description": "conditions provide information about the state of the DNS name. Known .status.conditions.type is: \"Degraded\". \"Degraded\" is true when the last resolution failed for the DNS name, and false otherwise.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "dnsName": {
- "description": "dnsName is the resolved DNS name matching the name field of DNSNameResolverSpec. This field can store both regular and wildcard DNS names which match the spec.name field. When the spec.name field contains a regular DNS name, this field will store the same regular DNS name after it is successfully resolved. When the spec.name field contains a wildcard DNS name, each resolvedName.dnsName will store the regular DNS names which match the wildcard DNS name and have been successfully resolved. If the wildcard DNS name can also be successfully resolved, then this field will store the wildcard DNS name as well.",
- "type": "string",
- "default": ""
- },
- "resolutionFailures": {
- "description": "resolutionFailures keeps the count of how many consecutive times the DNS resolution failed for the dnsName. If the DNS resolution succeeds then the field will be set to zero. Upon every failure, the value of the field will be incremented by one. The details about the DNS name will be removed, if the value of resolutionFailures reaches 5 and the TTL of all the associated IP addresses have expired.",
- "type": "integer",
- "format": "int32"
- },
- "resolvedAddresses": {
- "description": "resolvedAddresses gives the list of associated IP addresses and their corresponding TTLs and last lookup times for the dnsName.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1alpha1.DNSNameResolverResolvedAddress"
- },
- "x-kubernetes-list-map-keys": [
- "ip"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.network.v1alpha1.DNSNameResolverSpec": {
- "description": "DNSNameResolverSpec is a desired state description of DNSNameResolver.",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the DNS name for which the DNS name resolution information will be stored. For a regular DNS name, only the DNS name resolution information of the regular DNS name will be stored. For a wildcard DNS name, the DNS name resolution information of all the DNS names that match the wildcard DNS name will be stored. For a wildcard DNS name, the '*' will match only one label. Additionally, only a single '*' can be used at the beginning of the wildcard DNS name. For example, '*.example.com.' will match 'sub1.example.com.' but won't match 'sub2.sub1.example.com.'",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.network.v1alpha1.DNSNameResolverStatus": {
- "description": "DNSNameResolverStatus defines the observed status of DNSNameResolver.",
- "type": "object",
- "properties": {
- "resolvedNames": {
- "description": "resolvedNames contains a list of matching DNS names and their corresponding IP addresses along with their TTL and last DNS lookup times.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.network.v1alpha1.DNSNameResolverResolvedName"
- },
- "x-kubernetes-list-map-keys": [
- "dnsName"
- ],
- "x-kubernetes-list-type": "map",
- "x-kubernetes-patch-merge-key": "dnsName",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.networkoperator.v1.EgressRouter": {
- "description": "EgressRouter is a feature allowing the user to define an egress router that acts as a bridge between pods and external systems. The egress router runs a service that redirects egress traffic originating from a pod or a group of pods to a remote external system or multiple destinations as per configuration.\n\nIt is consumed by the cluster-network-operator. More specifically, given an EgressRouter CR with , the CNO will create and manage: - A service called - An egress pod called - A NAD called \n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).\n\nEgressRouter is a single egressrouter pod configuration object.",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "Specification of the desired egress router.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.networkoperator.v1.EgressRouterSpec"
- },
- "status": {
- "description": "Observed status of EgressRouter.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.networkoperator.v1.EgressRouterStatus"
- }
- }
- },
- "com.github.openshift.api.networkoperator.v1.EgressRouterSpec": {
- "description": "EgressRouterSpec contains the configuration for an egress router. Mode, networkInterface and addresses fields must be specified along with exactly one \"Config\" that matches the mode. Each config consists of parameters specific to that mode.",
- "type": "object",
- "required": [
- "mode",
- "networkInterface",
- "addresses"
- ],
- "properties": {
- "addresses": {
- "description": "List of IP addresses to configure on the pod's secondary interface.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.networkoperator.v1.EgressRouterAddress"
- }
- },
- "mode": {
- "description": "mode depicts the mode that is used for the egress router. The default mode is \"Redirect\" and is the only supported mode currently.",
- "type": "string",
- "default": ""
- },
- "networkInterface": {
- "description": "Specification of interface to create/use. The default is macvlan. Currently only macvlan is supported.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.networkoperator.v1.EgressRouterInterface"
- },
- "redirect": {
- "description": "redirect represents the configuration parameters specific to redirect mode.",
- "$ref": "#/definitions/com.github.openshift.api.networkoperator.v1.RedirectConfig"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.ClusterRoleScopeRestriction": {
- "description": "ClusterRoleScopeRestriction describes restrictions on cluster role scopes",
- "type": "object",
- "required": [
- "roleNames",
- "namespaces",
- "allowEscalation"
- ],
- "properties": {
- "allowEscalation": {
- "description": "allowEscalation indicates whether you can request roles and their escalating resources",
- "type": "boolean",
- "default": false
- },
- "namespaces": {
- "description": "namespaces is the list of namespaces that can be referenced. * means any of them (including *)",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "roleNames": {
- "description": "roleNames is the list of cluster roles that can referenced. * means anything",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthAccessToken": {
- "description": "OAuthAccessToken describes an OAuth access token. The name of a token must be prefixed with a `sha256~` string, must not contain \"/\" or \"%\" characters and must be at least 32 characters long.\n\nThe name of the token is constructed from the actual token by sha256-hashing it and using URL-safe unpadded base64-encoding (as described in RFC4648) on the hashed result.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "authorizeToken": {
- "description": "authorizeToken contains the token that authorized this token",
- "type": "string"
- },
- "clientName": {
- "description": "clientName references the client that created this token.",
- "type": "string"
- },
- "expiresIn": {
- "description": "expiresIn is the seconds from CreationTime before this token expires.",
- "type": "integer",
- "format": "int64"
- },
- "inactivityTimeoutSeconds": {
- "description": "inactivityTimeoutSeconds is the value in seconds, from the CreationTimestamp, after which this token can no longer be used. The value is automatically incremented when the token is used.",
- "type": "integer",
- "format": "int32"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "redirectURI": {
- "description": "redirectURI is the redirection associated with the token.",
- "type": "string"
- },
- "refreshToken": {
- "description": "refreshToken is the value by which this token can be renewed. Can be blank.",
- "type": "string"
- },
- "scopes": {
- "description": "scopes is an array of the requested scopes.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "userName": {
- "description": "userName is the user name associated with this token",
- "type": "string"
- },
- "userUID": {
- "description": "userUID is the unique UID associated with this token",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthAccessTokenList": {
- "description": "OAuthAccessTokenList is a collection of OAuth access tokens\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of OAuth access tokens",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.OAuthAccessToken"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthAuthorizeToken": {
- "description": "OAuthAuthorizeToken describes an OAuth authorization token\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "clientName": {
- "description": "clientName references the client that created this token.",
- "type": "string"
- },
- "codeChallenge": {
- "description": "codeChallenge is the optional code_challenge associated with this authorization code, as described in rfc7636",
- "type": "string"
- },
- "codeChallengeMethod": {
- "description": "codeChallengeMethod is the optional code_challenge_method associated with this authorization code, as described in rfc7636",
- "type": "string"
- },
- "expiresIn": {
- "description": "expiresIn is the seconds from CreationTime before this token expires.",
- "type": "integer",
- "format": "int64"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "redirectURI": {
- "description": "redirectURI is the redirection associated with the token.",
- "type": "string"
- },
- "scopes": {
- "description": "scopes is an array of the requested scopes.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "state": {
- "description": "state data from request",
- "type": "string"
- },
- "userName": {
- "description": "userName is the user name associated with this token",
- "type": "string"
- },
- "userUID": {
- "description": "userUID is the unique UID associated with this token. UserUID and UserName must both match for this token to be valid.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthAuthorizeTokenList": {
- "description": "OAuthAuthorizeTokenList is a collection of OAuth authorization tokens\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of OAuth authorization tokens",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.OAuthAuthorizeToken"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthClient": {
- "description": "OAuthClient describes an OAuth client\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "properties": {
- "accessTokenInactivityTimeoutSeconds": {
- "description": "accessTokenInactivityTimeoutSeconds overrides the default token inactivity timeout for tokens granted to this client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. This value needs to be set only if the default set in configuration is not appropriate for this client. Valid values are: - 0: Tokens for this client never time out - X: Tokens time out if there is no activity for X seconds The current minimum allowed value for X is 300 (5 minutes)\n\nWARNING: existing tokens' timeout will not be affected (lowered) by changing this value",
- "type": "integer",
- "format": "int32"
- },
- "accessTokenMaxAgeSeconds": {
- "description": "accessTokenMaxAgeSeconds overrides the default access token max age for tokens granted to this client. 0 means no expiration.",
- "type": "integer",
- "format": "int32"
- },
- "additionalSecrets": {
- "description": "additionalSecrets holds other secrets that may be used to identify the client. This is useful for rotation and for service account token validation",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "grantMethod": {
- "description": "grantMethod is a required field which determines how to handle grants for this client. Valid grant handling methods are:\n - auto: always approves grant requests, useful for trusted clients\n - prompt: prompts the end user for approval of grant requests, useful for third-party clients",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "redirectURIs": {
- "description": "redirectURIs is the valid redirection URIs associated with a client",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-patch-strategy": "merge"
- },
- "respondWithChallenges": {
- "description": "respondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects",
- "type": "boolean"
- },
- "scopeRestrictions": {
- "description": "scopeRestrictions describes which scopes this client can request. Each requested scope is checked against each restriction. If any restriction matches, then the scope is allowed. If no restriction matches, then the scope is denied.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.ScopeRestriction"
- }
- },
- "secret": {
- "description": "secret is the unique secret associated with a client",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthClientAuthorization": {
- "description": "OAuthClientAuthorization describes an authorization created by an OAuth client\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "type": "string"
- },
- "clientName": {
- "description": "clientName references the client that created this authorization",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "scopes": {
- "description": "scopes is an array of the granted scopes.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "userName": {
- "description": "userName is the user name that authorized this client",
- "type": "string"
- },
- "userUID": {
- "description": "userUID is the unique UID associated with this authorization. UserUID and UserName must both match for this authorization to be valid.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthClientAuthorizationList": {
- "description": "OAuthClientAuthorizationList is a collection of OAuth client authorizations\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of OAuth client authorizations",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.OAuthClientAuthorization"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthClientList": {
- "description": "OAuthClientList is a collection of OAuth clients\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of OAuth clients",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.OAuthClient"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.OAuthRedirectReference": {
- "description": "OAuthRedirectReference is a reference to an OAuth redirect object.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "reference": {
- "description": "The reference to an redirect object in the current namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.RedirectReference"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.RedirectReference": {
- "description": "RedirectReference specifies the target in the current namespace that resolves into redirect URIs. Only the 'Route' kind is currently allowed.",
- "type": "object",
- "required": [
- "group",
- "kind",
- "name"
- ],
- "properties": {
- "group": {
- "description": "The group of the target that is being referred to.",
- "type": "string",
- "default": ""
- },
- "kind": {
- "description": "The kind of the target that is being referred to. Currently, only 'Route' is allowed.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "The name of the target that is being referred to. e.g. name of the Route.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.oauth.v1.ScopeRestriction": {
- "description": "ScopeRestriction describe one restriction on scopes. Exactly one option must be non-nil.",
- "type": "object",
- "properties": {
- "clusterRole": {
- "description": "clusterRole describes a set of restrictions for cluster role scoping.",
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.ClusterRoleScopeRestriction"
- },
- "literals": {
- "description": "ExactValues means the scope has to match a particular set of strings exactly",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.oauth.v1.UserOAuthAccessToken": {
- "description": "UserOAuthAccessToken is a virtual resource to mirror OAuthAccessTokens to the user the access token was issued for",
- "type": "object",
- "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",
- "type": "string"
- },
- "authorizeToken": {
- "description": "authorizeToken contains the token that authorized this token",
- "type": "string"
- },
- "clientName": {
- "description": "clientName references the client that created this token.",
- "type": "string"
- },
- "expiresIn": {
- "description": "expiresIn is the seconds from CreationTime before this token expires.",
- "type": "integer",
- "format": "int64"
- },
- "inactivityTimeoutSeconds": {
- "description": "inactivityTimeoutSeconds is the value in seconds, from the CreationTimestamp, after which this token can no longer be used. The value is automatically incremented when the token is used.",
- "type": "integer",
- "format": "int32"
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "redirectURI": {
- "description": "redirectURI is the redirection associated with the token.",
- "type": "string"
- },
- "refreshToken": {
- "description": "refreshToken is the value by which this token can be renewed. Can be blank.",
- "type": "string"
- },
- "scopes": {
- "description": "scopes is an array of the requested scopes.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "userName": {
- "description": "userName is the user name associated with this token",
- "type": "string"
- },
- "userUID": {
- "description": "userUID is the unique UID associated with this token",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.oauth.v1.UserOAuthAccessTokenList": {
- "description": "UserOAuthAccessTokenList is a collection of access tokens issued on behalf of the requesting user\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.oauth.v1.UserOAuthAccessToken"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.APIServers": {
- "type": "object",
- "required": [
- "perGroupOptions"
- ],
- "properties": {
- "perGroupOptions": {
- "description": "perGroupOptions is a list of enabled/disabled API servers in addition to the defaults",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.PerGroupOptions"
- }
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.BuildControllerConfig": {
- "type": "object",
- "required": [
- "imageTemplateFormat",
- "buildDefaults",
- "buildOverrides",
- "additionalTrustedCA"
- ],
- "properties": {
- "additionalTrustedCA": {
- "description": "additionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted for image pushes and pulls during builds.",
- "type": "string",
- "default": ""
- },
- "buildDefaults": {
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.BuildDefaultsConfig"
- },
- "buildOverrides": {
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.BuildOverridesConfig"
- },
- "imageTemplateFormat": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ImageConfig"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.BuildDefaultsConfig": {
- "description": "BuildDefaultsConfig controls the default information for Builds\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "properties": {
- "annotations": {
- "description": "annotations are annotations that will be added to the build pod",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "env": {
- "description": "env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
- }
- },
- "gitHTTPProxy": {
- "description": "gitHTTPProxy is the location of the HTTPProxy for Git source",
- "type": "string"
- },
- "gitHTTPSProxy": {
- "description": "gitHTTPSProxy is the location of the HTTPSProxy for Git source",
- "type": "string"
- },
- "gitNoProxy": {
- "description": "gitNoProxy is the list of domains for which the proxy should not be used",
- "type": "string"
- },
- "imageLabels": {
- "description": "imageLabels is a list of labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageLabel"
- }
- },
- "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",
- "type": "string"
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "resources": {
- "description": "resources defines resource requirements to execute the build.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
- },
- "sourceStrategyDefaults": {
- "description": "sourceStrategyDefaults are default values that apply to builds using the source strategy.",
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.SourceStrategyDefaultsConfig"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.BuildOverridesConfig": {
- "description": "BuildOverridesConfig controls override settings for builds\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "properties": {
- "annotations": {
- "description": "annotations are annotations that will be added to the build pod",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
- },
- "forcePull": {
- "description": "forcePull overrides, if set, the equivalent value in the builds, i.e. false disables force pull for all builds, true enables force pull for all builds, independently of what each build specifies itself",
- "type": "boolean"
- },
- "imageLabels": {
- "description": "imageLabels is a list of labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user's label will be overwritten.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.build.v1.ImageLabel"
- }
- },
- "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",
- "type": "string"
- },
- "nodeSelector": {
- "description": "nodeSelector is a selector which must be true for the build pod to fit on a node",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "tolerations": {
- "description": "tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- }
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ClusterNetworkEntry": {
- "description": "ClusterNetworkEntry defines an individual cluster network. The CIDRs cannot overlap with other cluster network CIDRs, CIDRs reserved for external ips, CIDRs reserved for service networks, and CIDRs reserved for ingress ips.",
- "type": "object",
- "required": [
- "cidr",
- "hostSubnetLength"
- ],
- "properties": {
- "cidr": {
- "description": "cidr defines the total range of a cluster networks address space.",
- "type": "string",
- "default": ""
- },
- "hostSubnetLength": {
- "description": "hostSubnetLength is the number of bits of the accompanying CIDR address to allocate to each node. eg, 8 would mean that each node would have a /24 slice of the overlay network for its pod.",
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.DeployerControllerConfig": {
- "type": "object",
- "required": [
- "imageTemplateFormat"
- ],
- "properties": {
- "imageTemplateFormat": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ImageConfig"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.DockerPullSecretControllerConfig": {
- "type": "object",
- "required": [
- "registryURLs",
- "internalRegistryHostname"
- ],
- "properties": {
- "internalRegistryHostname": {
- "description": "internalRegistryHostname is the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format. Docker pull secrets will be generated for this registry.",
- "type": "string",
- "default": ""
- },
- "registryURLs": {
- "description": "registryURLs is a list of urls that the docker pull secrets should be valid for.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.FrontProxyConfig": {
- "type": "object",
- "required": [
- "clientCA",
- "allowedNames",
- "usernameHeaders",
- "groupHeaders",
- "extraHeaderPrefixes"
- ],
- "properties": {
- "allowedNames": {
- "description": "allowedNames is an optional list of common names to require a match from.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "clientCA": {
- "description": "clientCA is a path to the CA bundle to use to verify the common name of the front proxy's client cert",
- "type": "string",
- "default": ""
- },
- "extraHeaderPrefixes": {
- "description": "extraHeaderPrefixes is the set of header prefixes to check for user extra",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groupHeaders": {
- "description": "groupHeaders is the set of headers to check for groups",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "usernameHeaders": {
- "description": "usernameHeaders is the set of headers to check for the username",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ImageConfig": {
- "description": "ImageConfig holds the necessary configuration options for building image names for system components",
- "type": "object",
- "required": [
- "format",
- "latest"
- ],
- "properties": {
- "format": {
- "description": "format is the format of the name to be built for the system component",
- "type": "string",
- "default": ""
- },
- "latest": {
- "description": "latest determines if the latest tag will be pulled from the registry",
- "type": "boolean",
- "default": false
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ImageImportControllerConfig": {
- "type": "object",
- "required": [
- "maxScheduledImageImportsPerMinute",
- "disableScheduledImport",
- "scheduledImageImportMinimumIntervalSeconds"
- ],
- "properties": {
- "disableScheduledImport": {
- "description": "disableScheduledImport allows scheduled background import of images to be disabled.",
- "type": "boolean",
- "default": false
- },
- "maxScheduledImageImportsPerMinute": {
- "description": "maxScheduledImageImportsPerMinute is the maximum number of image streams that will be imported in the background per minute. The default value is 60. Set to -1 for unlimited.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "scheduledImageImportMinimumIntervalSeconds": {
- "description": "scheduledImageImportMinimumIntervalSeconds is the minimum number of seconds that can elapse between when image streams scheduled for background import are checked against the upstream repository. The default value is 15 minutes.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ImagePolicyConfig": {
- "type": "object",
- "required": [
- "maxImagesBulkImportedPerRepository",
- "allowedRegistriesForImport",
- "internalRegistryHostname",
- "externalRegistryHostnames",
- "additionalTrustedCA"
- ],
- "properties": {
- "additionalTrustedCA": {
- "description": "additionalTrustedCA is a path to a pem bundle file containing additional CAs that should be trusted during imagestream import.",
- "type": "string",
- "default": ""
- },
- "allowedRegistriesForImport": {
- "description": "allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.RegistryLocation"
- }
- },
- "externalRegistryHostnames": {
- "description": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "imageStreamImportMode": {
- "description": "imageStreamImportMode provides the import mode value for imagestreams. It can be `Legacy` or `PreserveOriginal`. `Legacy` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. `PreserveOriginal` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported.If this value is specified, this setting is applied to all newly created imagestreams which do not have the value set.\n\nPossible enum values:\n - `\"Legacy\"` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. This mode is the default.\n - `\"PreserveOriginal\"` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported.",
- "type": "string",
- "default": "",
- "enum": [
- "Legacy",
- "PreserveOriginal"
- ]
- },
- "internalRegistryHostname": {
- "description": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format.",
- "type": "string",
- "default": ""
- },
- "maxImagesBulkImportedPerRepository": {
- "description": "maxImagesBulkImportedPerRepository controls the number of images that are imported when a user does a bulk import of a container repository. This number is set low to prevent users from importing large numbers of images accidentally. Set -1 for no limit.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.IngressControllerConfig": {
- "type": "object",
- "required": [
- "ingressIPNetworkCIDR"
- ],
- "properties": {
- "ingressIPNetworkCIDR": {
- "description": "ingressIPNetworkCIDR controls the range to assign ingress ips from for services of type LoadBalancer on bare metal. If empty, ingress ips will not be assigned. It may contain a single CIDR that will be allocated from. For security reasons, you should ensure that this range does not overlap with the CIDRs reserved for external ips, nodes, pods, or services.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.JenkinsPipelineConfig": {
- "description": "JenkinsPipelineConfig holds configuration for the Jenkins pipeline strategy",
- "type": "object",
- "required": [
- "autoProvisionEnabled",
- "templateNamespace",
- "templateName",
- "serviceName",
- "parameters"
- ],
- "properties": {
- "autoProvisionEnabled": {
- "description": "autoProvisionEnabled determines whether a Jenkins server will be spawned from the provided template when the first build config in the project with type JenkinsPipeline is created. When not specified this option defaults to true.",
- "type": "boolean"
- },
- "parameters": {
- "description": "parameters specifies a set of optional parameters to the Jenkins template.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "serviceName": {
- "description": "serviceName is the name of the Jenkins service OpenShift uses to detect whether a Jenkins pipeline handler has already been installed in a project. This value *must* match a service name in the provided template.",
- "type": "string",
- "default": ""
- },
- "templateName": {
- "description": "templateName is the name of the default Jenkins template",
- "type": "string",
- "default": ""
- },
- "templateNamespace": {
- "description": "templateNamespace contains the namespace name where the Jenkins template is stored",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.NetworkControllerConfig": {
- "description": "MasterNetworkConfig to be passed to the compiled in network plugin",
- "type": "object",
- "required": [
- "networkPluginName",
- "clusterNetworks",
- "serviceNetworkCIDR",
- "vxlanPort"
- ],
- "properties": {
- "clusterNetworks": {
- "description": "clusterNetworks contains a list of cluster networks that defines the global overlay networks L3 space.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ClusterNetworkEntry"
- }
- },
- "networkPluginName": {
- "type": "string",
- "default": ""
- },
- "serviceNetworkCIDR": {
- "type": "string",
- "default": ""
- },
- "vxlanPort": {
- "type": "integer",
- "format": "int64",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.OpenShiftAPIServerConfig": {
- "description": "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "servingInfo",
- "corsAllowedOrigins",
- "auditConfig",
- "storageConfig",
- "admission",
- "kubeClientConfig",
- "aggregatorConfig",
- "imagePolicyConfig",
- "projectConfig",
- "routingConfig",
- "serviceAccountOAuthGrantMethod",
- "jenkinsPipelineConfig",
- "cloudProviderFile",
- "apiServerArguments",
- "apiServers"
- ],
- "properties": {
- "admission": {
- "description": "admissionConfig holds information about how to configure admission.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AdmissionConfig"
- },
- "aggregatorConfig": {
- "description": "aggregatorConfig contains information about how to verify the aggregator front proxy",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.FrontProxyConfig"
- },
- "apiServerArguments": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- },
- "apiServers": {
- "description": "apiServers holds information about enabled/disabled API servers",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.APIServers"
- },
- "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",
- "type": "string"
- },
- "auditConfig": {
- "description": "auditConfig describes how to configure audit information",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AuditConfig"
- },
- "cloudProviderFile": {
- "description": "cloudProviderFile points to the cloud config file",
- "type": "string",
- "default": ""
- },
- "corsAllowedOrigins": {
- "description": "corsAllowedOrigins",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "imagePolicyConfig": {
- "description": "imagePolicyConfig feeds the image policy admission plugin",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ImagePolicyConfig"
- },
- "jenkinsPipelineConfig": {
- "description": "jenkinsPipelineConfig holds information about the default Jenkins template used for JenkinsPipeline build strategy.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.JenkinsPipelineConfig"
- },
- "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",
- "type": "string"
- },
- "kubeClientConfig": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KubeClientConfig"
- },
- "projectConfig": {
- "description": "projectConfig feeds an admission plugin",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ProjectConfig"
- },
- "routingConfig": {
- "description": "routingConfig holds information about routing and route generation",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.RoutingConfig"
- },
- "serviceAccountOAuthGrantMethod": {
- "description": "serviceAccountOAuthGrantMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt, or \"\"",
- "type": "string",
- "default": ""
- },
- "servingInfo": {
- "description": "servingInfo describes how to start serving",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
- },
- "storageConfig": {
- "description": "storageConfig contains information about how to use",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.EtcdStorageConfig"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.OpenShiftControllerManagerConfig": {
- "description": "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "servingInfo",
- "leaderElection",
- "controllers",
- "resourceQuota",
- "serviceServingCert",
- "deployer",
- "build",
- "serviceAccount",
- "dockerPullSecret",
- "network",
- "ingress",
- "imageImport",
- "securityAllocator",
- "featureGates"
- ],
- "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",
- "type": "string"
- },
- "build": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.BuildControllerConfig"
- },
- "controllers": {
- "description": "controllers is a list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller \"+ named 'foo', '-foo' disables the controller named 'foo'. Defaults to \"*\".",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "deployer": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.DeployerControllerConfig"
- },
- "dockerPullSecret": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.DockerPullSecretControllerConfig"
- },
- "featureGates": {
- "description": "featureGates are the set of extra OpenShift feature gates for openshift-controller-manager. These feature gates can be used to enable features that are tech preview or otherwise not available on OpenShift by default.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "imageImport": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ImageImportControllerConfig"
- },
- "ingress": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.IngressControllerConfig"
- },
- "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",
- "type": "string"
- },
- "leaderElection": {
- "description": "leaderElection defines the configuration for electing a controller instance to make changes to the cluster. If unspecified, the ControllerTTL value is checked to determine whether the legacy direct etcd election code will be used.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.LeaderElection"
- },
- "network": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.NetworkControllerConfig"
- },
- "resourceQuota": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ResourceQuotaControllerConfig"
- },
- "securityAllocator": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.SecurityAllocator"
- },
- "serviceAccount": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ServiceAccountControllerConfig"
- },
- "serviceServingCert": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.openshiftcontrolplane.v1.ServiceServingCert"
- },
- "servingInfo": {
- "description": "servingInfo describes how to start serving",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.PerGroupOptions": {
- "type": "object",
- "required": [
- "name",
- "enabledVersions",
- "disabledVersions"
- ],
- "properties": {
- "disabledVersions": {
- "description": "disabledVersions is a list of versions that must be disabled in addition to the defaults. Must not collide with the list of enabled versions",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "enabledVersions": {
- "description": "enabledVersions is a list of versions that must be enabled in addition to the defaults. Must not collide with the list of disabled versions",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "name": {
- "description": "name is an API server name (see OpenShiftAPIserverName typed constants for a complete list of available API servers).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ProjectConfig": {
- "type": "object",
- "required": [
- "defaultNodeSelector",
- "projectRequestMessage",
- "projectRequestTemplate"
- ],
- "properties": {
- "defaultNodeSelector": {
- "description": "defaultNodeSelector holds default project node label selector",
- "type": "string",
- "default": ""
- },
- "projectRequestMessage": {
- "description": "projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint",
- "type": "string",
- "default": ""
- },
- "projectRequestTemplate": {
- "description": "projectRequestTemplate is the template to use for creating projects in response to projectrequest. It is in the format namespace/template and it is optional. If it is not specified, a default template is used.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.RegistryLocation": {
- "description": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.",
- "type": "object",
- "required": [
- "domainName"
- ],
- "properties": {
- "domainName": {
- "description": "domainName specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.",
- "type": "string",
- "default": ""
- },
- "insecure": {
- "description": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ResourceQuotaControllerConfig": {
- "type": "object",
- "required": [
- "concurrentSyncs",
- "syncPeriod",
- "minResyncPeriod"
- ],
- "properties": {
- "concurrentSyncs": {
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "minResyncPeriod": {
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "syncPeriod": {
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.RoutingConfig": {
- "description": "RoutingConfig holds the necessary configuration options for routing to subdomains",
- "type": "object",
- "required": [
- "subdomain"
- ],
- "properties": {
- "subdomain": {
- "description": "subdomain is the suffix appended to $service.$namespace. to form the default route hostname DEPRECATED: This field is being replaced by routers setting their own defaults. This is the \"default\" route.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.SecurityAllocator": {
- "description": "SecurityAllocator controls the automatic allocation of UIDs and MCS labels to a project. If nil, allocation is disabled.",
- "type": "object",
- "required": [
- "uidAllocatorRange",
- "mcsAllocatorRange",
- "mcsLabelsPerProject"
- ],
- "properties": {
- "mcsAllocatorRange": {
- "description": "mcsAllocatorRange defines the range of MCS categories that will be assigned to namespaces. The format is \"/[,]\". The default is \"s0/2\" and will allocate from c0 -> c1023, which means a total of 535k labels are available (1024 choose 2 ~ 535k). If this value is changed after startup, new projects may receive labels that are already allocated to other projects. Prefix may be any valid SELinux set of terms (including user, role, and type), although leaving them as the default will allow the server to set them automatically.\n\nExamples: * s0:/2 - Allocate labels from s0:c0,c0 to s0:c511,c511 * s0:/2,512 - Allocate labels from s0:c0,c0,c0 to s0:c511,c511,511",
- "type": "string",
- "default": ""
- },
- "mcsLabelsPerProject": {
- "description": "mcsLabelsPerProject defines the number of labels that should be reserved per project. The default is 5 to match the default UID and MCS ranges (100k namespaces, 535k/5 labels).",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "uidAllocatorRange": {
- "description": "uidAllocatorRange defines the total set of Unix user IDs (UIDs) that will be allocated to projects automatically, and the size of the block each namespace gets. For example, 1000-1999/10 will allocate ten UIDs per namespace, and will be able to allocate up to 100 blocks before running out of space. The default is to allocate from 1 billion to 2 billion in 10k blocks (which is the expected size of the ranges container images will use once user namespaces are started).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ServiceAccountControllerConfig": {
- "type": "object",
- "required": [
- "managedNames"
- ],
- "properties": {
- "managedNames": {
- "description": "managedNames is a list of service account names that will be auto-created in every namespace. If no names are specified, the ServiceAccountsController will not be started.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.ServiceServingCert": {
- "description": "ServiceServingCert holds configuration for service serving cert signer which creates cert/key pairs for pods fulfilling a service to serve with.",
- "type": "object",
- "required": [
- "signer"
- ],
- "properties": {
- "signer": {
- "description": "signer holds the signing information used to automatically sign serving certificates. If this value is nil, then certs are not signed automatically.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.CertInfo"
- }
- }
- },
- "com.github.openshift.api.openshiftcontrolplane.v1.SourceStrategyDefaultsConfig": {
- "description": "SourceStrategyDefaultsConfig contains values that apply to builds using the source strategy.",
- "type": "object",
- "properties": {
- "incremental": {
- "description": "incremental indicates if s2i build strategies should perform an incremental build or not",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AWSCSIDriverConfigSpec": {
- "description": "AWSCSIDriverConfigSpec defines properties that can be configured for the AWS CSI driver.",
- "type": "object",
- "properties": {
- "efsVolumeMetrics": {
- "description": "efsVolumeMetrics sets the configuration for collecting metrics from EFS volumes used by the EFS CSI Driver.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSEFSVolumeMetrics"
- },
- "kmsKeyARN": {
- "description": "kmsKeyARN sets the cluster default storage class to encrypt volumes with a user-defined KMS key, rather than the default KMS key used by AWS. The value may be either the ARN or Alias ARN of a KMS key.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AWSClassicLoadBalancerParameters": {
- "description": "AWSClassicLoadBalancerParameters holds configuration parameters for an AWS Classic load balancer.",
- "type": "object",
- "properties": {
- "connectionIdleTimeout": {
- "description": "connectionIdleTimeout specifies the maximum time period that a connection may be idle before the load balancer closes the connection. The value must be parseable as a time duration value; see . A nil or zero value means no opinion, in which case a default value is used. The default value for this field is 60s. This default is subject to change.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "subnets": {
- "description": "subnets specifies the subnets to which the load balancer will attach. The subnets may be specified by either their ID or name. The total number of subnets is limited to 10.\n\nIn order for the load balancer to be provisioned with subnets, each subnet must exist, each subnet must be from a different availability zone, and the load balancer service must be recreated to pick up new values.\n\nWhen omitted from the spec, the subnets will be auto-discovered for each availability zone. Auto-discovered subnets are not reported in the status of the IngressController object.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSSubnets"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AWSEFSVolumeMetrics": {
- "description": "AWSEFSVolumeMetrics defines the configuration for volume metrics in the EFS CSI Driver.",
- "type": "object",
- "required": [
- "state"
- ],
- "properties": {
- "recursiveWalk": {
- "description": "recursiveWalk provides additional configuration for collecting volume metrics in the AWS EFS CSI Driver when the state is set to RecursiveWalk.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSEFSVolumeMetricsRecursiveWalkConfig"
- },
- "state": {
- "description": "state defines the state of metric collection in the AWS EFS CSI Driver. This field is required and must be set to one of the following values: Disabled or RecursiveWalk. Disabled means no metrics collection will be performed. This is the default value. RecursiveWalk means the AWS EFS CSI Driver will recursively scan volumes to collect metrics. This process may result in high CPU and memory usage, depending on the volume size.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "state",
- "fields-to-discriminateBy": {
- "recursiveWalk": "RecursiveWalk"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.AWSEFSVolumeMetricsRecursiveWalkConfig": {
- "description": "AWSEFSVolumeMetricsRecursiveWalkConfig defines options for volume metrics in the EFS CSI Driver.",
- "type": "object",
- "properties": {
- "fsRateLimit": {
- "description": "fsRateLimit defines the rate limit, in goroutines per file system, for processing volume metrics. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 5. The valid range is from 1 to 100 goroutines.",
- "type": "integer",
- "format": "int32"
- },
- "refreshPeriodMinutes": {
- "description": "refreshPeriodMinutes specifies the frequency, in minutes, at which volume metrics are refreshed. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 240. The valid range is from 1 to 43200 minutes (30 days).",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AWSLoadBalancerParameters": {
- "description": "AWSLoadBalancerParameters provides configuration settings that are specific to AWS load balancers.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "classicLoadBalancer": {
- "description": "classicLoadBalancerParameters holds configuration parameters for an AWS classic load balancer. Present only if type is Classic.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSClassicLoadBalancerParameters"
- },
- "networkLoadBalancer": {
- "description": "networkLoadBalancerParameters holds configuration parameters for an AWS network load balancer. Present only if type is NLB.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSNetworkLoadBalancerParameters"
- },
- "type": {
- "description": "type is the type of AWS load balancer to instantiate for an ingresscontroller.\n\nValid values are:\n\n* \"Classic\": A Classic Load Balancer that makes routing decisions at either\n the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See\n the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb\n\n* \"NLB\": A Network Load Balancer that makes routing decisions at the\n transport layer (TCP/SSL). See the following for additional details:\n\n https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "classicLoadBalancer": "ClassicLoadBalancerParameters",
- "networkLoadBalancer": "NetworkLoadBalancerParameters"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.AWSNetworkLoadBalancerParameters": {
- "description": "AWSNetworkLoadBalancerParameters holds configuration parameters for an AWS Network load balancer. For Example: Setting AWS EIPs https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html",
- "type": "object",
- "properties": {
- "eipAllocations": {
- "description": "eipAllocations is a list of IDs for Elastic IP (EIP) addresses that are assigned to the Network Load Balancer. The following restrictions apply:\n\neipAllocations can only be used with external scope, not internal. An EIP can be allocated to only a single IngressController. The number of EIP allocations must match the number of subnets that are used for the load balancer. Each EIP allocation must be unique. A maximum of 10 EIP allocations are permitted.\n\nSee https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html for general information about configuration, characteristics, and limitations of Elastic IP addresses.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "subnets": {
- "description": "subnets specifies the subnets to which the load balancer will attach. The subnets may be specified by either their ID or name. The total number of subnets is limited to 10.\n\nIn order for the load balancer to be provisioned with subnets, each subnet must exist, each subnet must be from a different availability zone, and the load balancer service must be recreated to pick up new values.\n\nWhen omitted from the spec, the subnets will be auto-discovered for each availability zone. Auto-discovered subnets are not reported in the status of the IngressController object.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSSubnets"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AWSSubnets": {
- "description": "AWSSubnets contains a list of references to AWS subnets by ID or name.",
- "type": "object",
- "properties": {
- "ids": {
- "description": "ids specifies a list of AWS subnets by subnet ID. Subnet IDs must start with \"subnet-\", consist only of alphanumeric characters, must be exactly 24 characters long, must be unique, and the total number of subnets specified by ids and names must not exceed 10.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "names": {
- "description": "names specifies a list of AWS subnets by subnet name. Subnet names must not start with \"subnet-\", must not include commas, must be under 256 characters in length, must be unique, and the total number of subnets specified by ids and names must not exceed 10.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AccessLogging": {
- "description": "AccessLogging describes how client requests should be logged.",
- "type": "object",
- "required": [
- "destination"
- ],
- "properties": {
- "destination": {
- "description": "destination is where access logs go.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.LoggingDestination"
- },
- "httpCaptureCookies": {
- "description": "httpCaptureCookies specifies HTTP cookies that should be captured in access logs. If this field is empty, no cookies are captured.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPCookie"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "httpCaptureHeaders": {
- "description": "httpCaptureHeaders defines HTTP headers that should be captured in access logs. If this field is empty, no headers are captured.\n\nNote that this option only applies to cleartext HTTP connections and to secure HTTP connections for which the ingress controller terminates encryption (that is, edge-terminated or reencrypt connections). Headers cannot be captured for TLS passthrough connections.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPHeaders"
- },
- "httpLogFormat": {
- "description": "httpLogFormat specifies the format of the log message for an HTTP request.\n\nIf this field is empty, log messages use the implementation's default HTTP log format. For HAProxy's default HTTP log format, see the HAProxy documentation: http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3\n\nNote that this format only applies to cleartext HTTP connections and to secure HTTP connections for which the ingress controller terminates encryption (that is, edge-terminated or reencrypt connections). It does not affect the log format for TLS passthrough connections.",
- "type": "string"
- },
- "logEmptyRequests": {
- "description": "logEmptyRequests specifies how connections on which no request is received should be logged. Typically, these empty requests come from load balancers' health probes or Web browsers' speculative connections (\"preconnect\"), in which case logging these requests may be undesirable. However, these requests may also be caused by network errors, in which case logging empty requests may be useful for diagnosing the errors. In addition, these requests may be caused by port scans, in which case logging empty requests may aid in detecting intrusion attempts. Allowed values for this field are \"Log\" and \"Ignore\". The default value is \"Log\".",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AddPage": {
- "description": "AddPage allows customizing actions on the Add page in developer perspective.",
- "type": "object",
- "properties": {
- "disabledActions": {
- "description": "disabledActions is a list of actions that are not shown to users. Each action in the list is represented by its ID.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.operator.v1.AdditionalNetworkDefinition": {
- "description": "AdditionalNetworkDefinition configures an extra network that is available but not created by default. Instead, pods must request them by name. type must be specified, along with exactly one \"Config\" that matches the type.",
- "type": "object",
- "required": [
- "type",
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the network. This will be populated in the resulting CRD This must be unique.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace is the namespace of the network. This will be populated in the resulting CRD If not given the network will be created in the default namespace.",
- "type": "string"
- },
- "rawCNIConfig": {
- "description": "rawCNIConfig is the raw CNI configuration json to create in the NetworkAttachmentDefinition CRD",
- "type": "string"
- },
- "simpleMacvlanConfig": {
- "description": "simpleMacvlanConfig configures the macvlan interface in case of type:NetworkTypeSimpleMacvlan",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.SimpleMacvlanConfig"
- },
- "type": {
- "description": "type is the type of network The supported values are NetworkTypeRaw, NetworkTypeSimpleMacvlan",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.AdditionalRoutingCapabilities": {
- "description": "AdditionalRoutingCapabilities describes components and relevant configuration providing advanced routing capabilities.",
- "type": "object",
- "required": [
- "providers"
- ],
- "properties": {
- "providers": {
- "description": "providers is a set of enabled components that provide additional routing capabilities. Entries on this list must be unique. The only valid value is currrently \"FRR\" which provides FRR routing capabilities through the deployment of FRR.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.Authentication": {
- "description": "Authentication provides information to configure an operator to manage authentication.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AuthenticationSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AuthenticationStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AuthenticationList": {
- "description": "AuthenticationList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Authentication"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AuthenticationSpec": {
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AuthenticationStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "oauthAPIServer": {
- "description": "oauthAPIServer holds status specific only to oauth-apiserver",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OAuthAPIServerStatus"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AzureCSIDriverConfigSpec": {
- "description": "AzureCSIDriverConfigSpec defines properties that can be configured for the Azure CSI driver.",
- "type": "object",
- "properties": {
- "diskEncryptionSet": {
- "description": "diskEncryptionSet sets the cluster default storage class to encrypt volumes with a customer-managed encryption set, rather than the default platform-managed keys.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AzureDiskEncryptionSet"
- }
- }
- },
- "com.github.openshift.api.operator.v1.AzureDiskEncryptionSet": {
- "description": "AzureDiskEncryptionSet defines the configuration for a disk encryption set.",
- "type": "object",
- "required": [
- "subscriptionID",
- "resourceGroup",
- "name"
- ],
- "properties": {
- "name": {
- "description": "name is the name of the disk encryption set that will be set on the default storage class. The value should consist of only alphanumberic characters, underscores (_), hyphens, and be at most 80 characters in length.",
- "type": "string",
- "default": ""
- },
- "resourceGroup": {
- "description": "resourceGroup defines the Azure resource group that contains the disk encryption set. The value should consist of only alphanumberic characters, underscores (_), parentheses, hyphens and periods. The value should not end in a period and be at most 90 characters in length.",
- "type": "string",
- "default": ""
- },
- "subscriptionID": {
- "description": "subscriptionID defines the Azure subscription that contains the disk encryption set. The value should meet the following conditions: 1. It should be a 128-bit number. 2. It should be 36 characters (32 hexadecimal characters and 4 hyphens) long. 3. It should be displayed in five groups separated by hyphens (-). 4. The first group should be 8 characters long. 5. The second, third, and fourth groups should be 4 characters long. 6. The fifth group should be 12 characters long. An Example SubscrionID: f2007bbf-f802-4a47-9336-cf7c6b89b378",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.BootImageSkewEnforcementConfig": {
- "description": "BootImageSkewEnforcementConfig is used to configure how boot image version skew is enforced on the cluster.",
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "manual": {
- "description": "manual describes the current boot image of the cluster. This should be set to the oldest boot image used amongst all machine resources in the cluster. This must include either the RHCOS version of the boot image or the OCP release version which shipped with that RHCOS boot image. Required when mode is set to \"Manual\" and forbidden otherwise.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterBootImageManual"
- },
- "mode": {
- "description": "mode determines the underlying behavior of skew enforcement mechanism. Valid values are Manual and None. Manual means that the cluster admin is expected to perform manual boot image updates and store the OCP & RHCOS version associated with the last boot image update in the manual field. In Manual mode, the MCO will prevent upgrades when the boot image skew exceeds the skew limit described by the release image. None means that the MCO will no longer monitor the boot image skew. This may affect the cluster's ability to scale. This field is required.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "manual": "Manual"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.BootImageSkewEnforcementStatus": {
- "description": "BootImageSkewEnforcementStatus is the type for the status object. It represents the cluster defaults when the boot image skew enforcement configuration is undefined and reflects the actual configuration when it is defined.",
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "automatic": {
- "description": "automatic describes the current boot image of the cluster. This will be populated by the MCO when performing boot image updates. This value will be compared against the cluster's skew limit to determine skew compliance. Required when mode is set to \"Automatic\" and forbidden otherwise.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterBootImageAutomatic"
- },
- "manual": {
- "description": "manual describes the current boot image of the cluster. This will be populated by the MCO using the values provided in the spec.bootImageSkewEnforcement.manual field. This value will be compared against the cluster's skew limit to determine skew compliance. Required when mode is set to \"Manual\" and forbidden otherwise.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterBootImageManual"
- },
- "mode": {
- "description": "mode determines the underlying behavior of skew enforcement mechanism. Valid values are Automatic, Manual and None. Automatic means that the MCO will perform boot image updates and store the OCP & RHCOS version associated with the last boot image update in the automatic field. Manual means that the cluster admin is expected to perform manual boot image updates and store the OCP & RHCOS version associated with the last boot image update in the manual field. In Automatic and Manual mode, the MCO will prevent upgrades when the boot image skew exceeds the skew limit described by the release image. None means that the MCO will no longer monitor the boot image skew. This may affect the cluster's ability to scale. This field is required.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "automatic": "Automatic",
- "manual": "Manual"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.CSIDriverConfigSpec": {
- "description": "CSIDriverConfigSpec defines configuration spec that can be used to optionally configure a specific CSI Driver.",
- "type": "object",
- "required": [
- "driverType"
- ],
- "properties": {
- "aws": {
- "description": "aws is used to configure the AWS CSI driver.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSCSIDriverConfigSpec"
- },
- "azure": {
- "description": "azure is used to configure the Azure CSI driver.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AzureCSIDriverConfigSpec"
- },
- "driverType": {
- "description": "driverType indicates type of CSI driver for which the driverConfig is being applied to. Valid values are: AWS, Azure, GCP, IBMCloud, vSphere and omitted. Consumers should treat unknown values as a NO-OP.",
- "type": "string",
- "default": ""
- },
- "gcp": {
- "description": "gcp is used to configure the GCP CSI driver.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GCPCSIDriverConfigSpec"
- },
- "ibmcloud": {
- "description": "ibmcloud is used to configure the IBM Cloud CSI driver.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IBMCloudCSIDriverConfigSpec"
- },
- "vSphere": {
- "description": "vSphere is used to configure the vsphere CSI driver.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.VSphereCSIDriverConfigSpec"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "driverType",
- "fields-to-discriminateBy": {
- "aws": "AWS",
- "azure": "Azure",
- "gcp": "GCP",
- "ibmcloud": "IBMCloud",
- "vSphere": "VSphere"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.CSISnapshotController": {
- "description": "CSISnapshotController provides a means to configure an operator to manage the CSI snapshots. `cluster` is the canonical name.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CSISnapshotControllerSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CSISnapshotControllerStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.CSISnapshotControllerList": {
- "description": "CSISnapshotControllerList contains a list of CSISnapshotControllers.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CSISnapshotController"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.CSISnapshotControllerSpec": {
- "description": "CSISnapshotControllerSpec is the specification of the desired behavior of the CSISnapshotController operator.",
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.CSISnapshotControllerStatus": {
- "description": "CSISnapshotControllerStatus defines the observed status of the CSISnapshotController operator.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.Capability": {
- "description": "Capabilities contains set of UI capabilities and their state in the console UI.",
- "type": "object",
- "required": [
- "name",
- "visibility"
- ],
- "properties": {
- "name": {
- "description": "name is the unique name of a capability. Available capabilities are LightspeedButton and GettingStartedBanner.",
- "type": "string",
- "default": ""
- },
- "visibility": {
- "description": "visibility defines the visibility state of the capability.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CapabilityVisibility"
- }
- }
- },
- "com.github.openshift.api.operator.v1.CapabilityVisibility": {
- "description": "CapabilityVisibility defines the criteria to enable/disable a capability.",
- "type": "object",
- "required": [
- "state"
- ],
- "properties": {
- "state": {
- "description": "state defines if the capability is enabled or disabled in the console UI. Enabling the capability in the console UI is represented by the \"Enabled\" value. Disabling the capability in the console UI is represented by the \"Disabled\" value.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "state",
- "fields-to-discriminateBy": {}
- }
- ]
- },
- "com.github.openshift.api.operator.v1.ClientTLS": {
- "description": "ClientTLS specifies TLS configuration to enable client-to-server authentication, which can be used for mutual TLS.",
- "type": "object",
- "required": [
- "clientCertificatePolicy",
- "clientCA"
- ],
- "properties": {
- "allowedSubjectPatterns": {
- "description": "allowedSubjectPatterns specifies a list of regular expressions that should be matched against the distinguished name on a valid client certificate to filter requests. The regular expressions must use PCRE syntax. If this list is empty, no filtering is performed. If the list is nonempty, then at least one pattern must match a client certificate's distinguished name or else the ingress controller rejects the certificate and denies the connection.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "clientCA": {
- "description": "clientCA specifies a configmap containing the PEM-encoded CA certificate bundle that should be used to verify a client's certificate. The administrator must create this configmap in the openshift-config namespace.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "clientCertificatePolicy": {
- "description": "clientCertificatePolicy specifies whether the ingress controller requires clients to provide certificates. This field accepts the values \"Required\" or \"Optional\".\n\nNote that the ingress controller only checks client certificates for edge-terminated and reencrypt TLS routes; it cannot check certificates for cleartext HTTP or passthrough TLS routes.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.CloudCredential": {
- "description": "CloudCredential provides a means to configure an operator to manage CredentialsRequests.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CloudCredentialSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CloudCredentialStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.CloudCredentialList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CloudCredential"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.CloudCredentialSpec": {
- "description": "CloudCredentialSpec is the specification of the desired behavior of the cloud-credential-operator.",
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "credentialsMode": {
- "description": "credentialsMode allows informing CCO that it should not attempt to dynamically determine the root cloud credentials capabilities, and it should just run in the specified mode. It also allows putting the operator into \"manual\" mode if desired. Leaving the field in default mode runs CCO so that the cluster's cloud credentials will be dynamically probed for capabilities (on supported clouds/platforms). Supported modes:\n AWS/Azure/GCP: \"\" (Default), \"Mint\", \"Passthrough\", \"Manual\"\n Others: Do not set value as other platforms only support running in \"Passthrough\"",
- "type": "string"
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.CloudCredentialStatus": {
- "description": "CloudCredentialStatus defines the observed status of the cloud-credential-operator.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ClusterBootImageAutomatic": {
- "description": "ClusterBootImageAutomatic is used to describe the cluster boot image in Automatic mode. It stores the RHCOS version of the boot image and the OCP release version which shipped with that RHCOS boot image. At least one of these values are required. If ocpVersion and rhcosVersion are defined, both values will be used for checking skew compliance. If only ocpVersion is defined, only that value will be used for checking skew compliance. If only rhcosVersion is defined, only that value will be used for checking skew compliance.",
- "type": "object",
- "properties": {
- "ocpVersion": {
- "description": "ocpVersion provides a string which represents the OCP version of the boot image. This field must match the OCP semver compatible format of x.y.z. This field must be between 5 and 10 characters long.",
- "type": "string"
- },
- "rhcosVersion": {
- "description": "rhcosVersion provides a string which represents the RHCOS version of the boot image This field must match rhcosVersion formatting of [major].[minor].[datestamp(YYYYMMDD)]-[buildnumber] or the legacy format of [major].[minor].[timestamp(YYYYMMDDHHmm)]-[buildnumber]. This field must be between 14 and 21 characters long.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ClusterBootImageManual": {
- "description": "ClusterBootImageManual is used to describe the cluster boot image in Manual mode.",
- "type": "object",
- "required": [
- "mode"
- ],
- "properties": {
- "mode": {
- "description": "mode is used to configure which boot image field is defined in Manual mode. Valid values are OCPVersion and RHCOSVersion. OCPVersion means that the cluster admin is expected to set the OCP version associated with the last boot image update in the OCPVersion field. RHCOSVersion means that the cluster admin is expected to set the RHCOS version associated with the last boot image update in the RHCOSVersion field. This field is required.",
- "type": "string"
- },
- "ocpVersion": {
- "description": "ocpVersion provides a string which represents the OCP version of the boot image. This field must match the OCP semver compatible format of x.y.z. This field must be between 5 and 10 characters long. Required when mode is set to \"OCPVersion\" and forbidden otherwise.",
- "type": "string"
- },
- "rhcosVersion": {
- "description": "rhcosVersion provides a string which represents the RHCOS version of the boot image This field must match rhcosVersion formatting of [major].[minor].[datestamp(YYYYMMDD)]-[buildnumber] or the legacy format of [major].[minor].[timestamp(YYYYMMDDHHmm)]-[buildnumber]. This field must be between 14 and 21 characters long. Required when mode is set to \"RHCOSVersion\" and forbidden otherwise.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "ocpVersion": "OCPVersion",
- "rhcosVersion": "RHCOSVersion"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.ClusterCSIDriver": {
- "description": "ClusterCSIDriver object allows management and configuration of a CSI driver operator installed by default in OpenShift. Name of the object must be name of the CSI driver it operates. See CSIDriverName type for list of allowed values.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterCSIDriverSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterCSIDriverStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ClusterCSIDriverList": {
- "description": "ClusterCSIDriverList contains a list of ClusterCSIDriver\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterCSIDriver"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ClusterCSIDriverSpec": {
- "description": "ClusterCSIDriverSpec is the desired behavior of CSI driver operator",
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "driverConfig": {
- "description": "driverConfig can be used to specify platform specific driver configuration. When omitted, this means no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.CSIDriverConfigSpec"
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "storageClassState": {
- "description": "storageClassState determines if CSI operator should create and manage storage classes. If this field value is empty or Managed - CSI operator will continuously reconcile storage class and create if necessary. If this field value is Unmanaged - CSI operator will not reconcile any previously created storage class. If this field value is Removed - CSI operator will delete the storage class it created previously. When omitted, this means the user has no opinion and the platform chooses a reasonable default, which is subject to change over time. The current default behaviour is Managed.",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ClusterCSIDriverStatus": {
- "description": "ClusterCSIDriverStatus is the observed status of CSI driver operator",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ClusterNetworkEntry": {
- "description": "ClusterNetworkEntry is a subnet from which to allocate PodIPs. A network of size HostPrefix (in CIDR notation) will be allocated when nodes join the cluster. If the HostPrefix field is not used by the plugin, it can be left unset. Not all network providers support multiple ClusterNetworks",
- "type": "object",
- "required": [
- "cidr"
- ],
- "properties": {
- "cidr": {
- "type": "string",
- "default": ""
- },
- "hostPrefix": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.operator.v1.Config": {
- "description": "Config specifies the behavior of the config operator which is responsible for creating the initial configuration of other components on the cluster. The operator also handles installation, migration or synchronization of cloud configurations for AWS and Azure cloud based clusters\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the Config Operator.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConfigSpec"
- },
- "status": {
- "description": "status defines the observed status of the Config Operator.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConfigStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConfigList": {
- "description": "ConfigList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Config"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConfigMapFileReference": {
- "description": "ConfigMapFileReference references a specific file within a ConfigMap.",
- "type": "object",
- "required": [
- "name",
- "key"
- ],
- "properties": {
- "key": {
- "description": "key is the logo key inside the referenced ConfigMap. Must consist only of alphanumeric characters, dashes (-), underscores (_), and periods (.). Must be at most 253 characters in length. Must end in a valid file extension. A valid file extension must consist of a period followed by 2 to 5 alpha characters.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name is the name of the ConfigMap. name is a required field. Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character. Must be at most 253 characters in length.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConfigSpec": {
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConfigStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.Console": {
- "description": "Console provides a means to configure an operator to manage the console.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConsoleSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConsoleStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConsoleConfigRoute": {
- "description": "ConsoleConfigRoute holds information on external route access to console. DEPRECATED",
- "type": "object",
- "required": [
- "hostname"
- ],
- "properties": {
- "hostname": {
- "description": "hostname is the desired custom domain under which console will be available.",
- "type": "string",
- "default": ""
- },
- "secret": {
- "description": "secret points to secret in the openshift-config namespace that contains custom certificate and key and needs to be created manually by the cluster admin. Referenced Secret is required to contain following key value pairs: - \"tls.crt\" - to specifies custom certificate - \"tls.key\" - to specifies private key of the custom certificate If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConsoleCustomization": {
- "description": "ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.",
- "type": "object",
- "properties": {
- "addPage": {
- "description": "addPage allows customizing actions on the Add page in developer perspective.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AddPage"
- },
- "brand": {
- "description": "brand is the default branding of the web console which can be overridden by providing the brand field. There is a limited set of specific brand options. This field controls elements of the console such as the logo. Invalid value will prevent a console rollout.",
- "type": "string"
- },
- "capabilities": {
- "description": "capabilities defines an array of capabilities that can be interacted with in the console UI. Each capability defines a visual state that can be interacted with the console to render in the UI. Available capabilities are LightspeedButton and GettingStartedBanner. Each of the available capabilities may appear only once in the list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Capability"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "customLogoFile": {
- "description": "customLogoFile replaces the default OpenShift logo in the masthead and about dialog. It is a reference to a Only one of customLogoFile or logos can be set at a time. ConfigMap in the openshift-config namespace. This can be created with a command like 'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config'. Image size must be less than 1 MB due to constraints on the ConfigMap size. The ConfigMap key should include a file extension so that the console serves the file with the correct MIME type. The recommended file format for the logo is SVG, but other file formats are allowed if supported by the browser. Deprecated: Use logos instead.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapFileReference"
- },
- "customProductName": {
- "description": "customProductName is the name that will be displayed in page titles, logo alt text, and the about dialog instead of the normal OpenShift product name.",
- "type": "string"
- },
- "developerCatalog": {
- "description": "developerCatalog allows to configure the shown developer catalog categories (filters) and types (sub-catalogs).",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DeveloperConsoleCatalogCustomization"
- },
- "documentationBaseURL": {
- "description": "documentationBaseURL links to external documentation are shown in various sections of the web console. Providing documentationBaseURL will override the default documentation URL. Invalid value will prevent a console rollout.",
- "type": "string"
- },
- "logos": {
- "description": "logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos. logos is an optional field that allows a list of logos. Only one of logos or customLogoFile can be set at a time. If logos is set, customLogoFile must be unset. When specified, there must be at least one entry and no more than 2 entries. Each type must appear only once in the list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Logo"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "perspectives": {
- "description": "perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Perspective"
- },
- "x-kubernetes-list-map-keys": [
- "id"
- ],
- "x-kubernetes-list-type": "map"
- },
- "projectAccess": {
- "description": "projectAccess allows customizing the available list of ClusterRoles in the Developer perspective Project access page which can be used by a project admin to specify roles to other users and restrict access within the project. If set, the list will replace the default ClusterRole options.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ProjectAccess"
- },
- "quickStarts": {
- "description": "quickStarts allows customization of available ConsoleQuickStart resources in console.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.QuickStarts"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConsoleList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Console"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConsoleProviders": {
- "description": "ConsoleProviders defines a list of optional additional providers of functionality to the console.",
- "type": "object",
- "properties": {
- "statuspage": {
- "description": "statuspage contains ID for statuspage.io page that provides status info about.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.StatuspageProvider"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConsoleSpec": {
- "description": "ConsoleSpec is the specification of the desired behavior of the Console.",
- "type": "object",
- "required": [
- "managementState",
- "providers"
- ],
- "properties": {
- "customization": {
- "description": "customization is used to optionally provide a small set of customization options to the web console.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConsoleCustomization"
- },
- "ingress": {
- "description": "ingress allows to configure the alternative ingress for the console. This field is intended for clusters without ingress capability, where access to routes is not possible.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Ingress"
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "plugins": {
- "description": "plugins defines a list of enabled console plugin names.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "providers": {
- "description": "providers contains configuration for using specific service providers.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConsoleProviders"
- },
- "route": {
- "description": "route contains hostname and secret reference that contains the serving certificate. If a custom route is specified, a new route will be created with the provided hostname, under which console will be available. In case of custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed. In case of custom hostname points to an arbitrary domain, manual DNS configurations steps are necessary. The default console route will be maintained to reserve the default hostname for console if the custom route is removed. If not specified, default route will be used. DEPRECATED",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConsoleConfigRoute"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ConsoleStatus": {
- "description": "ConsoleStatus defines the observed status of the Console.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ContainerLoggingDestinationParameters": {
- "description": "ContainerLoggingDestinationParameters describes parameters for the Container logging destination type.",
- "type": "object",
- "properties": {
- "maxLength": {
- "description": "maxLength is the maximum length of the log message.\n\nValid values are integers in the range 480 to 8192, inclusive.\n\nWhen omitted, the default value is 1024.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNS": {
- "description": "DNS manages the CoreDNS component to provide a name resolution service for pods and services in the cluster.\n\nThis supports the DNS-based service discovery specification: https://github.com/kubernetes/dns/blob/master/docs/specification.md\n\nMore details: https://kubernetes.io/docs/tasks/administer-cluster/coredns\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the DNS.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the DNS.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNSCache": {
- "description": "DNSCache defines the fields for configuring DNS caching.",
- "type": "object",
- "properties": {
- "negativeTTL": {
- "description": "negativeTTL is optional and specifies the amount of time that a negative response should be cached.\n\nIf configured, it must be a value of 1s (1 second) or greater up to a theoretical maximum of several years. This field expects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, e.g. \"100s\", \"1m30s\", \"12h30m10s\". Values that are fractions of a second are rounded down to the nearest second. If the configured value is less than 1s, the default value will be used. If not configured, the value will be 0s and OpenShift will use a default value of 30 seconds unless noted otherwise in the respective Corefile for your version of OpenShift. The default value of 30 seconds is subject to change.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "positiveTTL": {
- "description": "positiveTTL is optional and specifies the amount of time that a positive response should be cached.\n\nIf configured, it must be a value of 1s (1 second) or greater up to a theoretical maximum of several years. This field expects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, e.g. \"100s\", \"1m30s\", \"12h30m10s\". Values that are fractions of a second are rounded down to the nearest second. If the configured value is less than 1s, the default value will be used. If not configured, the value will be 0s and OpenShift will use a default value of 900 seconds unless noted otherwise in the respective Corefile for your version of OpenShift. The default value of 900 seconds is subject to change.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNSList": {
- "description": "DNSList contains a list of DNS\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNS"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNSNodePlacement": {
- "description": "DNSNodePlacement describes the node scheduling configuration for DNS pods.",
- "type": "object",
- "properties": {
- "nodeSelector": {
- "description": "nodeSelector is the node selector applied to DNS pods.\n\nIf empty, the default is used, which is currently the following:\n\n kubernetes.io/os: linux\n\nThis default is subject to change.\n\nIf set, the specified selector is used and replaces the default.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "tolerations": {
- "description": "tolerations is a list of tolerations applied to DNS pods.\n\nIf empty, the DNS operator sets a toleration for the \"node-role.kubernetes.io/master\" taint. This default is subject to change. Specifying tolerations without including a toleration for the \"node-role.kubernetes.io/master\" taint may be risky as it could lead to an outage if all worker nodes become unavailable.\n\nNote that the daemon controller adds some tolerations as well. See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
- }
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNSOverTLSConfig": {
- "description": "DNSOverTLSConfig describes optional DNSTransportConfig fields that should be captured.",
- "type": "object",
- "required": [
- "serverName"
- ],
- "properties": {
- "caBundle": {
- "description": "caBundle references a ConfigMap that must contain either a single CA Certificate or a CA Bundle. This allows cluster administrators to provide their own CA or CA bundle for validating the certificate of upstream resolvers.\n\n1. The configmap must contain a `ca-bundle.crt` key. 2. The value must be a PEM encoded CA certificate or CA bundle. 3. The administrator must create this configmap in the openshift-config namespace. 4. The upstream server certificate must contain a Subject Alternative Name (SAN) that matches ServerName.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "serverName": {
- "description": "serverName is the upstream server to connect to when forwarding DNS queries. This is required when Transport is set to \"TLS\". ServerName will be validated against the DNS naming conventions in RFC 1123 and should match the TLS certificate installed in the upstream resolver(s).",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNSSpec": {
- "description": "DNSSpec is the specification of the desired behavior of the DNS.",
- "type": "object",
- "properties": {
- "cache": {
- "description": "cache describes the caching configuration that applies to all server blocks listed in the Corefile. This field allows a cluster admin to optionally configure: * positiveTTL which is a duration for which positive responses should be cached. * negativeTTL which is a duration for which negative responses should be cached. If this is not configured, OpenShift will configure positive and negative caching with a default value that is subject to change. At the time of writing, the default positiveTTL is 900 seconds and the default negativeTTL is 30 seconds or as noted in the respective Corefile for your version of OpenShift.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSCache"
- },
- "logLevel": {
- "description": "logLevel describes the desired logging verbosity for CoreDNS. Any one of the following values may be specified: * Normal logs errors from upstream resolvers. * Debug logs errors, NXDOMAIN responses, and NODATA responses. * Trace logs errors and all responses.\n Setting logLevel: Trace will produce extremely verbose logs.\nValid values are: \"Normal\", \"Debug\", \"Trace\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether the DNS operator should manage cluster DNS",
- "type": "string"
- },
- "nodePlacement": {
- "description": "nodePlacement provides explicit control over the scheduling of DNS pods.\n\nGenerally, it is useful to run a DNS pod on every node so that DNS queries are always handled by a local DNS pod instead of going over the network to a DNS pod on another node. However, security policies may require restricting the placement of DNS pods to specific nodes. For example, if a security policy prohibits pods on arbitrary nodes from communicating with the API, a node selector can be specified to restrict DNS pods to nodes that are permitted to communicate with the API. Conversely, if running DNS pods on nodes with a particular taint is desired, a toleration can be specified for that taint.\n\nIf unset, defaults are used. See nodePlacement for more details.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSNodePlacement"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel controls the logging level of the DNS Operator. Valid values are: \"Normal\", \"Debug\", \"Trace\". Defaults to \"Normal\". setting operatorLogLevel: Trace will produce extremely verbose logs.",
- "type": "string"
- },
- "servers": {
- "description": "servers is a list of DNS resolvers that provide name query delegation for one or more subdomains outside the scope of the cluster domain. If servers consists of more than one Server, longest suffix match will be used to determine the Server.\n\nFor example, if there are two Servers, one for \"foo.com\" and another for \"a.foo.com\", and the name query is for \"www.a.foo.com\", it will be routed to the Server with Zone \"a.foo.com\".\n\nIf this field is nil, no servers are created.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Server"
- }
- },
- "upstreamResolvers": {
- "description": "upstreamResolvers defines a schema for configuring CoreDNS to proxy DNS messages to upstream resolvers for the case of the default (\".\") server\n\nIf this field is not specified, the upstream used will default to /etc/resolv.conf, with policy \"sequential\"",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.UpstreamResolvers"
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNSStatus": {
- "description": "DNSStatus defines the observed status of the DNS.",
- "type": "object",
- "required": [
- "clusterIP",
- "clusterDomain"
- ],
- "properties": {
- "clusterDomain": {
- "description": "clusterDomain is the local cluster DNS domain suffix for DNS services. This will be a subdomain as defined in RFC 1034, section 3.5: https://tools.ietf.org/html/rfc1034#section-3.5 Example: \"cluster.local\"\n\nMore info: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service",
- "type": "string",
- "default": ""
- },
- "clusterIP": {
- "description": "clusterIP is the service IP through which this DNS is made available.\n\nIn the case of the default DNS, this will be a well known IP that is used as the default nameserver for pods that are using the default ClusterFirst DNS policy.\n\nIn general, this IP can be specified in a pod's spec.dnsConfig.nameservers list or used explicitly when performing name resolution from within the cluster. Example: dig foo.com @\n\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies",
- "type": "string",
- "default": ""
- },
- "conditions": {
- "description": "conditions provide information about the state of the DNS on the cluster.\n\nThese are the supported DNS conditions:\n\n * Available\n - True if the following conditions are met:\n * DNS controller daemonset is available.\n - False if any of those conditions are unsatisfied.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- }
- }
- },
- "com.github.openshift.api.operator.v1.DNSTransportConfig": {
- "description": "DNSTransportConfig groups related configuration parameters used for configuring forwarding to upstream resolvers that support DNS-over-TLS.",
- "type": "object",
- "properties": {
- "tls": {
- "description": "tls contains the additional configuration options to use when Transport is set to \"TLS\".",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSOverTLSConfig"
- },
- "transport": {
- "description": "transport allows cluster administrators to opt-in to using a DNS-over-TLS connection between cluster DNS and an upstream resolver(s). Configuring TLS as the transport at this level without configuring a CABundle will result in the system certificates being used to verify the serving certificate of the upstream resolver(s).\n\nPossible values: \"\" (empty) - This means no explicit choice has been made and the platform chooses the default which is subject to change over time. The current default is \"Cleartext\". \"Cleartext\" - Cluster admin specified cleartext option. This results in the same functionality as an empty value but may be useful when a cluster admin wants to be more explicit about the transport, or wants to switch from \"TLS\" to \"Cleartext\" explicitly. \"TLS\" - This indicates that DNS queries should be sent over a TLS connection. If Transport is set to TLS, you MUST also set ServerName. If a port is not included with the upstream IP, port 853 will be tried by default per RFC 7858 section 3.1; https://datatracker.ietf.org/doc/html/rfc7858#section-3.1.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "transport",
- "fields-to-discriminateBy": {
- "tls": "TLS"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.DefaultNetworkDefinition": {
- "description": "DefaultNetworkDefinition represents a single network plugin's configuration. type must be specified, along with exactly one \"Config\" that matches the type.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "openshiftSDNConfig": {
- "description": "openshiftSDNConfig was previously used to configure the openshift-sdn plugin. DEPRECATED: OpenShift SDN is no longer supported.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenShiftSDNConfig"
- },
- "ovnKubernetesConfig": {
- "description": "ovnKubernetesConfig configures the ovn-kubernetes plugin.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OVNKubernetesConfig"
- },
- "type": {
- "description": "type is the type of network All NetworkTypes are supported except for NetworkTypeRaw",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.DeveloperConsoleCatalogCategory": {
- "description": "DeveloperConsoleCatalogCategory for the developer console catalog.",
- "type": "object",
- "required": [
- "id",
- "label"
- ],
- "properties": {
- "id": {
- "description": "id is an identifier used in the URL to enable deep linking in console. ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.",
- "type": "string",
- "default": ""
- },
- "label": {
- "description": "label defines a category display label. It is required and must have 1-64 characters.",
- "type": "string",
- "default": ""
- },
- "subcategories": {
- "description": "subcategories defines a list of child categories.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DeveloperConsoleCatalogCategoryMeta"
- }
- },
- "tags": {
- "description": "tags is a list of strings that will match the category. A selected category show all items which has at least one overlapping tag between category and item.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.operator.v1.DeveloperConsoleCatalogCategoryMeta": {
- "description": "DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.",
- "type": "object",
- "required": [
- "id",
- "label"
- ],
- "properties": {
- "id": {
- "description": "id is an identifier used in the URL to enable deep linking in console. ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.",
- "type": "string",
- "default": ""
- },
- "label": {
- "description": "label defines a category display label. It is required and must have 1-64 characters.",
- "type": "string",
- "default": ""
- },
- "tags": {
- "description": "tags is a list of strings that will match the category. A selected category show all items which has at least one overlapping tag between category and item.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.operator.v1.DeveloperConsoleCatalogCustomization": {
- "description": "DeveloperConsoleCatalogCustomization allow cluster admin to configure developer catalog.",
- "type": "object",
- "properties": {
- "categories": {
- "description": "categories which are shown in the developer catalog.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DeveloperConsoleCatalogCategory"
- }
- },
- "types": {
- "description": "types allows enabling or disabling of sub-catalog types that user can see in the Developer catalog. When omitted, all the sub-catalog types will be shown.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DeveloperConsoleCatalogTypes"
- }
- }
- },
- "com.github.openshift.api.operator.v1.DeveloperConsoleCatalogTypes": {
- "description": "DeveloperConsoleCatalogTypes defines the state of the sub-catalog types.",
- "type": "object",
- "required": [
- "state"
- ],
- "properties": {
- "disabled": {
- "description": "disabled is a list of developer catalog types (sub-catalogs IDs) that are not shown to users. Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available in the console on the cluster configuration page, or when editing the YAML in the console. Example: \"Devfile\", \"HelmChart\", \"BuilderImage\" If the list is empty or all the available sub-catalog types are added, then the complete developer catalog should be hidden.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "enabled": {
- "description": "enabled is a list of developer catalog types (sub-catalogs IDs) that will be shown to users. Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available in the console on the cluster configuration page, or when editing the YAML in the console. Example: \"Devfile\", \"HelmChart\", \"BuilderImage\" If the list is non-empty, a new type will not be shown to the user until it is added to list. If the list is empty the complete developer catalog will be shown.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "state": {
- "description": "state defines if a list of catalog types should be enabled or disabled.",
- "type": "string",
- "default": "Enabled"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "state",
- "fields-to-discriminateBy": {
- "disabled": "Disabled",
- "enabled": "Enabled"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.EgressIPConfig": {
- "description": "EgressIPConfig defines the configuration knobs for egressip",
- "type": "object",
- "properties": {
- "reachabilityTotalTimeoutSeconds": {
- "description": "reachabilityTotalTimeout configures the EgressIP node reachability check total timeout in seconds. If the EgressIP node cannot be reached within this timeout, the node is declared down. Setting a large value may cause the EgressIP feature to react slowly to node changes. In particular, it may react slowly for EgressIP nodes that really have a genuine problem and are unreachable. When omitted, this means the user has no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 1 second. A value of 0 disables the EgressIP node's reachability check.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.operator.v1.EndpointPublishingStrategy": {
- "description": "EndpointPublishingStrategy is a way to publish the endpoints of an IngressController, and represents the type and any additional configuration for a specific type.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "hostNetwork": {
- "description": "hostNetwork holds parameters for the HostNetwork endpoint publishing strategy. Present only if type is HostNetwork.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.HostNetworkStrategy"
- },
- "loadBalancer": {
- "description": "loadBalancer holds parameters for the load balancer. Present only if type is LoadBalancerService.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.LoadBalancerStrategy"
- },
- "nodePort": {
- "description": "nodePort holds parameters for the NodePortService endpoint publishing strategy. Present only if type is NodePortService.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodePortStrategy"
- },
- "private": {
- "description": "private holds parameters for the Private endpoint publishing strategy. Present only if type is Private.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.PrivateStrategy"
- },
- "type": {
- "description": "type is the publishing strategy to use. Valid values are:\n\n* LoadBalancerService\n\nPublishes the ingress controller using a Kubernetes LoadBalancer Service.\n\nIn this configuration, the ingress controller deployment uses container networking. A LoadBalancer Service is created to publish the deployment.\n\nSee: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer\n\nIf domain is set, a wildcard DNS record will be managed to point at the LoadBalancer Service's external name. DNS records are managed only in DNS zones defined by dns.config.openshift.io/cluster .spec.publicZone and .spec.privateZone.\n\nWildcard DNS management is currently supported only on the AWS, Azure, and GCP platforms.\n\n* HostNetwork\n\nPublishes the ingress controller on node ports where the ingress controller is deployed.\n\nIn this configuration, the ingress controller deployment uses host networking, bound to node ports 80 and 443. The user is responsible for configuring an external load balancer to publish the ingress controller via the node ports.\n\n* Private\n\nDoes not publish the ingress controller.\n\nIn this configuration, the ingress controller deployment uses container networking, and is not explicitly published. The user must manually publish the ingress controller.\n\n* NodePortService\n\nPublishes the ingress controller using a Kubernetes NodePort Service.\n\nIn this configuration, the ingress controller deployment uses container networking. A NodePort Service is created to publish the deployment. The specific node ports are dynamically allocated by OpenShift; however, to support static port allocations, user changes to the node port field of the managed NodePort Service will preserved.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "hostNetwork": "HostNetwork",
- "loadBalancer": "LoadBalancer",
- "nodePort": "NodePort",
- "private": "Private"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.Etcd": {
- "description": "Etcd provides information to configure an operator to manage etcd.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.EtcdSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.EtcdStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.EtcdList": {
- "description": "KubeAPISOperatorConfigList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Etcd"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.EtcdSpec": {
- "type": "object",
- "required": [
- "managementState",
- "forceRedeploymentReason"
- ],
- "properties": {
- "backendQuotaGiB": {
- "description": "backendQuotaGiB sets the etcd backend storage size limit in gibibytes. The value should be an integer not less than 8 and not more than 32. When not specified, the default value is 8.",
- "type": "integer",
- "format": "int32",
- "default": 8
- },
- "controlPlaneHardwareSpeed": {
- "description": "HardwareSpeed allows user to change the etcd tuning profile which configures the latency parameters for heartbeat interval and leader election timeouts allowing the cluster to tolerate longer round-trip-times between etcd members. Valid values are \"\", \"Standard\" and \"Slower\".\n\t\"\" means no opinion and the platform is left to choose a reasonable default\n\twhich is subject to change without notice.\n\nPossible enum values:\n - `\"Slower\"` provides more tolerance for slower hardware and/or higher latency networks. Sets (values subject to change): ETCD_HEARTBEAT_INTERVAL: 5x Standard ETCD_LEADER_ELECTION_TIMEOUT: 2.5x Standard\n - `\"Standard\"` provides the normal tolerances for hardware speed and latency. Currently sets (values subject to change at any time): ETCD_HEARTBEAT_INTERVAL: 100ms ETCD_LEADER_ELECTION_TIMEOUT: 1000ms",
- "type": "string",
- "default": "",
- "enum": [
- "Slower",
- "Standard"
- ]
- },
- "failedRevisionLimit": {
- "description": "failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "forceRedeploymentReason": {
- "description": "forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.",
- "type": "string",
- "default": ""
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "succeededRevisionLimit": {
- "description": "succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.EtcdStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "controlPlaneHardwareSpeed": {
- "description": "Possible enum values:\n - `\"Slower\"` provides more tolerance for slower hardware and/or higher latency networks. Sets (values subject to change): ETCD_HEARTBEAT_INTERVAL: 5x Standard ETCD_LEADER_ELECTION_TIMEOUT: 2.5x Standard\n - `\"Standard\"` provides the normal tolerances for hardware speed and latency. Currently sets (values subject to change at any time): ETCD_HEARTBEAT_INTERVAL: 100ms ETCD_LEADER_ELECTION_TIMEOUT: 1000ms",
- "type": "string",
- "default": "",
- "enum": [
- "Slower",
- "Standard"
- ]
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "latestAvailableRevisionReason": {
- "description": "latestAvailableRevisionReason describe the detailed reason for the most recent deployment",
- "type": "string"
- },
- "nodeStatuses": {
- "description": "nodeStatuses track the deployment values and errors across individual nodes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeStatus"
- },
- "x-kubernetes-list-map-keys": [
- "nodeName"
- ],
- "x-kubernetes-list-type": "map"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ExportNetworkFlows": {
- "type": "object",
- "properties": {
- "ipfix": {
- "description": "ipfix defines IPFIX configuration.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPFIXConfig"
- },
- "netFlow": {
- "description": "netFlow defines the NetFlow configuration.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NetFlowConfig"
- },
- "sFlow": {
- "description": "sFlow defines the SFlow configuration.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.SFlowConfig"
- }
- }
- },
- "com.github.openshift.api.operator.v1.FeaturesMigration": {
- "type": "object",
- "properties": {
- "egressFirewall": {
- "description": "egressFirewall specified whether or not the Egress Firewall configuration was migrated. DEPRECATED: network type migration is no longer supported.",
- "type": "boolean"
- },
- "egressIP": {
- "description": "egressIP specified whether or not the Egress IP configuration was migrated. DEPRECATED: network type migration is no longer supported.",
- "type": "boolean"
- },
- "multicast": {
- "description": "multicast specified whether or not the multicast configuration was migrated. DEPRECATED: network type migration is no longer supported.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.operator.v1.FileReferenceSource": {
- "description": "FileReferenceSource is used by the console to locate the specified file containing a custom logo.",
- "type": "object",
- "required": [
- "from"
- ],
- "properties": {
- "configMap": {
- "description": "configMap specifies the ConfigMap sourcing details such as the name of the ConfigMap and the key for the file. The ConfigMap must exist in the openshift-config namespace. Required when from is \"ConfigMap\", and forbidden otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ConfigMapFileReference"
- },
- "from": {
- "description": "from is a required field to specify the source type of the file reference. Allowed values are ConfigMap. When set to ConfigMap, the file will be sourced from a ConfigMap in the openshift-config namespace. The configMap field must be set when from is set to ConfigMap.\n\nPossible enum values:\n - `\"ConfigMap\"` represents a ConfigMap source.",
- "type": "string",
- "default": "",
- "enum": [
- "ConfigMap"
- ]
- }
- }
- },
- "com.github.openshift.api.operator.v1.ForwardPlugin": {
- "description": "ForwardPlugin defines a schema for configuring the CoreDNS forward plugin.",
- "type": "object",
- "required": [
- "upstreams"
- ],
- "properties": {
- "policy": {
- "description": "policy is used to determine the order in which upstream servers are selected for querying. Any one of the following values may be specified:\n\n* \"Random\" picks a random upstream server for each query. * \"RoundRobin\" picks upstream servers in a round-robin order, moving to the next server for each new query. * \"Sequential\" tries querying upstream servers in a sequential order until one responds, starting with the first server for each new query.\n\nThe default value is \"Random\"",
- "type": "string"
- },
- "protocolStrategy": {
- "description": "protocolStrategy specifies the protocol to use for upstream DNS requests. Valid values for protocolStrategy are \"TCP\" and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is to use the protocol of the original client request. \"TCP\" specifies that the platform should use TCP for all upstream DNS requests, even if the client request uses UDP. \"TCP\" is useful for UDP-specific issues such as those created by non-compliant upstream resolvers, but may consume more bandwidth or increase DNS response time. Note that protocolStrategy only affects the protocol of DNS requests that CoreDNS makes to upstream resolvers. It does not affect the protocol of DNS requests between clients and CoreDNS.",
- "type": "string",
- "default": ""
- },
- "transportConfig": {
- "description": "transportConfig is used to configure the transport type, server name, and optional custom CA or CA bundle to use when forwarding DNS requests to an upstream resolver.\n\nThe default value is \"\" (empty) which results in a standard cleartext connection being used when forwarding DNS requests to an upstream resolver.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSTransportConfig"
- },
- "upstreams": {
- "description": "upstreams is a list of resolvers to forward name queries for subdomains of Zones. Each instance of CoreDNS performs health checking of Upstreams. When a healthy upstream returns an error during the exchange, another resolver is tried from Upstreams. The Upstreams are selected in the order specified in Policy. Each upstream is represented by an IP address or IP:port if the upstream listens on a port other than 53.\n\nA maximum of 15 upstreams is allowed per ForwardPlugin.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
- }
- },
- "com.github.openshift.api.operator.v1.GCPCSIDriverConfigSpec": {
- "description": "GCPCSIDriverConfigSpec defines properties that can be configured for the GCP CSI driver.",
- "type": "object",
- "properties": {
- "kmsKey": {
- "description": "kmsKey sets the cluster default storage class to encrypt volumes with customer-supplied encryption keys, rather than the default keys managed by GCP.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GCPKMSKeyReference"
- }
- }
- },
- "com.github.openshift.api.operator.v1.GCPKMSKeyReference": {
- "description": "GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key",
- "type": "object",
- "required": [
- "name",
- "keyRing",
- "projectID"
- ],
- "properties": {
- "keyRing": {
- "description": "keyRing is the name of the KMS Key Ring which the KMS Key belongs to. The value should correspond to an existing KMS key ring and should consist of only alphanumeric characters, hyphens (-) and underscores (_), and be at most 63 characters in length.",
- "type": "string",
- "default": ""
- },
- "location": {
- "description": "location is the GCP location in which the Key Ring exists. The value must match an existing GCP location, or \"global\". Defaults to global, if not set.",
- "type": "string"
- },
- "name": {
- "description": "name is the name of the customer-managed encryption key to be used for disk encryption. The value should correspond to an existing KMS key and should consist of only alphanumeric characters, hyphens (-) and underscores (_), and be at most 63 characters in length.",
- "type": "string",
- "default": ""
- },
- "projectID": {
- "description": "projectID is the ID of the Project in which the KMS Key Ring exists. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.GCPLoadBalancerParameters": {
- "description": "GCPLoadBalancerParameters provides configuration settings that are specific to GCP load balancers.",
- "type": "object",
- "properties": {
- "clientAccess": {
- "description": "clientAccess describes how client access is restricted for internal load balancers.\n\nValid values are: * \"Global\": Specifying an internal load balancer with Global client access\n allows clients from any region within the VPC to communicate with the load\n balancer.\n\n https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#global_access\n\n* \"Local\": Specifying an internal load balancer with Local client access\n means only clients within the same region (and VPC) as the GCP load balancer\n can communicate with the load balancer. Note that this is the default behavior.\n\n https://cloud.google.com/load-balancing/docs/internal#client_access",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.GatewayConfig": {
- "description": "GatewayConfig holds node gateway-related parsed config file parameters and command-line overrides",
- "type": "object",
- "properties": {
- "ipForwarding": {
- "description": "ipForwarding controls IP forwarding for all traffic on OVN-Kubernetes managed interfaces (such as br-ex). By default this is set to Restricted, and Kubernetes related traffic is still forwarded appropriately, but other IP traffic will not be routed by the OCP node. If there is a desire to allow the host to forward traffic across OVN-Kubernetes managed interfaces, then set this field to \"Global\". The supported values are \"Restricted\" and \"Global\".",
- "type": "string"
- },
- "ipv4": {
- "description": "ipv4 allows users to configure IP settings for IPv4 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv4 for details of default values.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPv4GatewayConfig"
- },
- "ipv6": {
- "description": "ipv6 allows users to configure IP settings for IPv6 connections. When omitted, this means no opinion and the default configuration is used. Check individual members fields within ipv6 for details of default values.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPv6GatewayConfig"
- },
- "routingViaHost": {
- "description": "routingViaHost allows pod egress traffic to exit via the ovn-k8s-mp0 management port into the host before sending it out. If this is not set, traffic will always egress directly from OVN to outside without touching the host stack. Setting this to true means hardware offload will not be supported. Default is false if GatewayConfig is specified.",
- "type": "boolean"
- }
- }
- },
- "com.github.openshift.api.operator.v1.GatherStatus": {
- "description": "gatherStatus provides information about the last known gather event.",
- "type": "object",
- "properties": {
- "gatherers": {
- "description": "gatherers is a list of active gatherers (and their statuses) in the last gathering.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GathererStatus"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "lastGatherDuration": {
- "description": "lastGatherDuration is the total time taken to process all gatherers during the last gather event.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "lastGatherTime": {
- "description": "lastGatherTime is the last time when Insights data gathering finished. An empty value means that no data has been gathered yet.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- }
- }
- },
- "com.github.openshift.api.operator.v1.GathererStatus": {
- "description": "gathererStatus represents information about a particular data gatherer.",
- "type": "object",
- "required": [
- "conditions",
- "name",
- "lastGatherDuration"
- ],
- "properties": {
- "conditions": {
- "description": "conditions provide details on the status of each gatherer.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "lastGatherDuration": {
- "description": "lastGatherDuration represents the time spent gathering.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "name": {
- "description": "name is the name of the gatherer.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.GenerationStatus": {
- "description": "GenerationStatus keeps track of the generation for a given resource so that decisions about forced updates can be made.",
- "type": "object",
- "required": [
- "group",
- "resource",
- "namespace",
- "name",
- "lastGeneration",
- "hash"
- ],
- "properties": {
- "group": {
- "description": "group is the group of the thing you're tracking",
- "type": "string",
- "default": ""
- },
- "hash": {
- "description": "hash is an optional field set for resources without generation that are content sensitive like secrets and configmaps",
- "type": "string",
- "default": ""
- },
- "lastGeneration": {
- "description": "lastGeneration is the last generation of the workload controller involved",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "name": {
- "description": "name is the name of the thing you're tracking",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace is where the thing you're tracking is",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is the resource type of the thing you're tracking",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.HTTPCompressionPolicy": {
- "description": "httpCompressionPolicy turns on compression for the specified MIME types.\n\nThis field is optional, and its absence implies that compression should not be enabled globally in HAProxy.\n\nIf httpCompressionPolicy exists, compression should be enabled only for the specified MIME types.",
- "type": "object",
- "properties": {
- "mimeTypes": {
- "description": "mimeTypes is a list of MIME types that should have compression applied. This list can be empty, in which case the ingress controller does not apply compression.\n\nNote: Not all MIME types benefit from compression, but HAProxy will still use resources to try to compress if instructed to. Generally speaking, text (html, css, js, etc.) formats benefit from compression, but formats that are already compressed (image, audio, video, etc.) benefit little in exchange for the time and cpu spent on compressing again. See https://joehonton.medium.com/the-gzip-penalty-d31bd697f1a2",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.operator.v1.HealthCheck": {
- "description": "healthCheck represents an Insights health check attributes.",
- "type": "object",
- "required": [
- "description",
- "totalRisk",
- "advisorURI",
- "state"
- ],
- "properties": {
- "advisorURI": {
- "description": "advisorURI provides the URL link to the Insights Advisor.",
- "type": "string",
- "default": ""
- },
- "description": {
- "description": "description provides basic description of the healtcheck.",
- "type": "string",
- "default": ""
- },
- "state": {
- "description": "state determines what the current state of the health check is. Health check is enabled by default and can be disabled by the user in the Insights advisor user interface.",
- "type": "string",
- "default": ""
- },
- "totalRisk": {
- "description": "totalRisk of the healthcheck. Indicator of the total risk posed by the detected issue; combination of impact and likelihood. The values can be from 1 to 4, and the higher the number, the more important the issue.",
- "type": "integer",
- "format": "int32",
- "default": 0
- }
- }
- },
- "com.github.openshift.api.operator.v1.HostNetworkStrategy": {
- "description": "HostNetworkStrategy holds parameters for the HostNetwork endpoint publishing strategy.",
- "type": "object",
- "properties": {
- "httpPort": {
- "description": "httpPort is the port on the host which should be used to listen for HTTP requests. This field should be set when port 80 is already in use. The value should not coincide with the NodePort range of the cluster. When the value is 0 or is not specified it defaults to 80.",
- "type": "integer",
- "format": "int32"
- },
- "httpsPort": {
- "description": "httpsPort is the port on the host which should be used to listen for HTTPS requests. This field should be set when port 443 is already in use. The value should not coincide with the NodePort range of the cluster. When the value is 0 or is not specified it defaults to 443.",
- "type": "integer",
- "format": "int32"
- },
- "protocol": {
- "description": "protocol specifies whether the IngressController expects incoming connections to use plain TCP or whether the IngressController expects PROXY protocol.\n\nPROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController. Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs. Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController. See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol.\n\nThe following values are valid for this field:\n\n* The empty string. * \"TCP\". * \"PROXY\".\n\nThe empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change.",
- "type": "string"
- },
- "statsPort": {
- "description": "statsPort is the port on the host where the stats from the router are published. The value should not coincide with the NodePort range of the cluster. If an external load balancer is configured to forward connections to this IngressController, the load balancer should use this port for health checks. The load balancer can send HTTP probes on this port on a given node, with the path /healthz/ready to determine if the ingress controller is ready to receive traffic on the node. For proper operation the load balancer must not forward traffic to a node until the health check reports ready. The load balancer should also stop forwarding requests within a maximum of 45 seconds after /healthz/ready starts reporting not-ready. Probing every 5 to 10 seconds, with a 5-second timeout and with a threshold of two successful or failed requests to become healthy or unhealthy respectively, are well-tested values. When the value is 0 or is not specified it defaults to 1936.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.operator.v1.HybridOverlayConfig": {
- "type": "object",
- "required": [
- "hybridClusterNetwork"
- ],
- "properties": {
- "hybridClusterNetwork": {
- "description": "hybridClusterNetwork defines a network space given to nodes on an additional overlay network.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterNetworkEntry"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "hybridOverlayVXLANPort": {
- "description": "hybridOverlayVXLANPort defines the VXLAN port number to be used by the additional overlay network. Default is 4789",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IBMCloudCSIDriverConfigSpec": {
- "description": "IBMCloudCSIDriverConfigSpec defines the properties that can be configured for the IBM Cloud CSI driver.",
- "type": "object",
- "required": [
- "encryptionKeyCRN"
- ],
- "properties": {
- "encryptionKeyCRN": {
- "description": "encryptionKeyCRN is the IBM Cloud CRN of the customer-managed root key to use for disk encryption of volumes for the default storage classes.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.IBMLoadBalancerParameters": {
- "description": "IBMLoadBalancerParameters provides configuration settings that are specific to IBM Cloud load balancers.",
- "type": "object",
- "properties": {
- "protocol": {
- "description": "protocol specifies whether the load balancer uses PROXY protocol to forward connections to the IngressController. See \"service.kubernetes.io/ibm-load-balancer-cloud-provider-enable-features: \"proxy-protocol\"\" at https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas\"\n\nPROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController. Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs. Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController. See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol.\n\nValid values for protocol are TCP, PROXY and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is TCP, without the proxy protocol enabled.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IPAMConfig": {
- "description": "IPAMConfig contains configurations for IPAM (IP Address Management)",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "staticIPAMConfig": {
- "description": "staticIPAMConfig configures the static IP address in case of type:IPAMTypeStatic",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.StaticIPAMConfig"
- },
- "type": {
- "description": "type is the type of IPAM module will be used for IP Address Management(IPAM). The supported values are IPAMTypeDHCP, IPAMTypeStatic",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.IPFIXConfig": {
- "type": "object",
- "properties": {
- "collectors": {
- "description": "ipfixCollectors is list of strings formatted as ip:port with a maximum of ten items",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IPsecConfig": {
- "type": "object",
- "properties": {
- "full": {
- "description": "full defines configuration parameters for the IPsec `Full` mode. This is permitted only when mode is configured with `Full`, and forbidden otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPsecFullModeConfig"
- },
- "mode": {
- "description": "mode defines the behaviour of the ipsec configuration within the platform. Valid values are `Disabled`, `External` and `Full`. When 'Disabled', ipsec will not be enabled at the node level. When 'External', ipsec is enabled on the node level but requires the user to configure the secure communication parameters. This mode is for external secure communications and the configuration can be done using the k8s-nmstate operator. When 'Full', ipsec is configured on the node level and inter-pod secure communication within the cluster is configured. Note with `Full`, if ipsec is desired for communication with external (to the cluster) entities (such as storage arrays), this is left to the user to configure.",
- "type": "string"
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "full": "Full"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.IPsecFullModeConfig": {
- "description": "IPsecFullModeConfig defines configuration parameters for the IPsec `Full` mode.",
- "type": "object",
- "properties": {
- "encapsulation": {
- "description": "encapsulation option to configure libreswan on how inter-pod traffic across nodes are encapsulated to handle NAT traversal. When configured it uses UDP port 4500 for the encapsulation. Valid values are Always, Auto and omitted. Always means enable UDP encapsulation regardless of whether NAT is detected. Auto means enable UDP encapsulation based on the detection of NAT. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is Auto.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IPv4GatewayConfig": {
- "description": "IPV4GatewayConfig holds the configuration paramaters for IPV4 connections in the GatewayConfig for OVN-Kubernetes",
- "type": "object",
- "properties": {
- "internalMasqueradeSubnet": {
- "description": "internalMasqueradeSubnet contains the masquerade addresses in IPV4 CIDR format used internally by ovn-kubernetes to enable host to service traffic. Each host in the cluster is configured with these addresses, as well as the shared gateway bridge interface. The values can be changed after installation. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must be large enough to accommodate 6 IPs (maximum prefix length /29). When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is 169.254.0.0/17 The value must be in proper IPV4 CIDR format",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IPv4OVNKubernetesConfig": {
- "type": "object",
- "properties": {
- "internalJoinSubnet": {
- "description": "internalJoinSubnet is a v4 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The current default value is 100.64.0.0/16 The subnet must be large enough to accommodate one IP per node in your cluster The value must be in proper IPV4 CIDR format",
- "type": "string"
- },
- "internalTransitSwitchSubnet": {
- "description": "internalTransitSwitchSubnet is a v4 subnet in IPV4 CIDR format used internally by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect architecture that connects the cluster routers on each node together to enable east west traffic. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. When ommitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is 100.88.0.0/16 The subnet must be large enough to accommodate one IP per node in your cluster The value must be in proper IPV4 CIDR format",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IPv6GatewayConfig": {
- "description": "IPV6GatewayConfig holds the configuration paramaters for IPV6 connections in the GatewayConfig for OVN-Kubernetes",
- "type": "object",
- "properties": {
- "internalMasqueradeSubnet": {
- "description": "internalMasqueradeSubnet contains the masquerade addresses in IPV6 CIDR format used internally by ovn-kubernetes to enable host to service traffic. Each host in the cluster is configured with these addresses, as well as the shared gateway bridge interface. The values can be changed after installation. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. Additionally the subnet must be large enough to accommodate 6 IPs (maximum prefix length /125). When omitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The current default subnet is fd69::/112 Note that IPV6 dual addresses are not permitted",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IPv6OVNKubernetesConfig": {
- "type": "object",
- "properties": {
- "internalJoinSubnet": {
- "description": "internalJoinSubnet is a v6 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. The subnet must be large enough to accommodate one IP per node in your cluster The current default value is fd98::/64 The value must be in proper IPV6 CIDR format Note that IPV6 dual addresses are not permitted",
- "type": "string"
- },
- "internalTransitSwitchSubnet": {
- "description": "internalTransitSwitchSubnet is a v4 subnet in IPV4 CIDR format used internally by OVN-Kubernetes for the distributed transit switch in the OVN Interconnect architecture that connects the cluster routers on each node together to enable east west traffic. The subnet chosen should not overlap with other networks specified for OVN-Kubernetes as well as other networks used on the host. When ommitted, this means no opinion and the platform is left to choose a reasonable default which is subject to change over time. The subnet must be large enough to accommodate one IP per node in your cluster The current default subnet is fd97::/64 The value must be in proper IPV6 CIDR format Note that IPV6 dual addresses are not permitted",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.Ingress": {
- "description": "Ingress allows cluster admin to configure alternative ingress for the console.",
- "type": "object",
- "properties": {
- "clientDownloadsURL": {
- "description": "clientDownloadsURL is a URL to be used as the address to download client binaries. If not specified, the downloads route hostname will be used. This field is required for clusters without ingress capability, where access to routes is not possible. The console operator will monitor the URL and may go degraded if it's unreachable for an extended period. Must use the HTTPS scheme.",
- "type": "string",
- "default": ""
- },
- "consoleURL": {
- "description": "consoleURL is a URL to be used as the base console address. If not specified, the console route hostname will be used. This field is required for clusters without ingress capability, where access to routes is not possible. Make sure that appropriate ingress is set up at this URL. The console operator will monitor the URL and may go degraded if it's unreachable for an extended period. Must use the HTTPS scheme.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressController": {
- "description": "IngressController describes a managed ingress controller for the cluster. The controller can service OpenShift Route and Kubernetes Ingress resources.\n\nWhen an IngressController is created, a new ingress controller deployment is created to allow external traffic to reach the services that expose Ingress or Route resources. Updating this resource may lead to disruption for public facing network connections as a new ingress controller revision may be rolled out.\n\nhttps://kubernetes.io/docs/concepts/services-networking/ingress-controllers\n\nWhenever possible, sensible defaults for the platform are used. See each field for more details.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the IngressController.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the IngressController.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPCookie": {
- "description": "IngressControllerCaptureHTTPCookie describes an HTTP cookie that should be captured.",
- "type": "object",
- "required": [
- "matchType",
- "maxLength"
- ],
- "properties": {
- "matchType": {
- "description": "matchType specifies the type of match to be performed on the cookie name. Allowed values are \"Exact\" for an exact string match and \"Prefix\" for a string prefix match. If \"Exact\" is specified, a name must be specified in the name field. If \"Prefix\" is provided, a prefix must be specified in the namePrefix field. For example, specifying matchType \"Prefix\" and namePrefix \"foo\" will capture a cookie named \"foo\" or \"foobar\" but not one named \"bar\". The first matching cookie is captured.",
- "type": "string",
- "default": ""
- },
- "maxLength": {
- "description": "maxLength specifies a maximum length of the string that will be logged, which includes the cookie name, cookie value, and one-character delimiter. If the log entry exceeds this length, the value will be truncated in the log message. Note that the ingress controller may impose a separate bound on the total length of HTTP headers in a request.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "name": {
- "description": "name specifies a cookie name. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
- "type": "string",
- "default": ""
- },
- "namePrefix": {
- "description": "namePrefix specifies a cookie name prefix. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "matchType",
- "fields-to-discriminateBy": {
- "name": "Name",
- "namePrefix": "NamePrefix"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPCookieUnion": {
- "description": "IngressControllerCaptureHTTPCookieUnion describes optional fields of an HTTP cookie that should be captured.",
- "type": "object",
- "required": [
- "matchType"
- ],
- "properties": {
- "matchType": {
- "description": "matchType specifies the type of match to be performed on the cookie name. Allowed values are \"Exact\" for an exact string match and \"Prefix\" for a string prefix match. If \"Exact\" is specified, a name must be specified in the name field. If \"Prefix\" is provided, a prefix must be specified in the namePrefix field. For example, specifying matchType \"Prefix\" and namePrefix \"foo\" will capture a cookie named \"foo\" or \"foobar\" but not one named \"bar\". The first matching cookie is captured.",
- "type": "string",
- "default": ""
- },
- "name": {
- "description": "name specifies a cookie name. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
- "type": "string",
- "default": ""
- },
- "namePrefix": {
- "description": "namePrefix specifies a cookie name prefix. Its value must be a valid HTTP cookie name as defined in RFC 6265 section 4.1.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "matchType",
- "fields-to-discriminateBy": {
- "name": "Name",
- "namePrefix": "NamePrefix"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPHeader": {
- "description": "IngressControllerCaptureHTTPHeader describes an HTTP header that should be captured.",
- "type": "object",
- "required": [
- "name",
- "maxLength"
- ],
- "properties": {
- "maxLength": {
- "description": "maxLength specifies a maximum length for the header value. If a header value exceeds this length, the value will be truncated in the log message. Note that the ingress controller may impose a separate bound on the total length of HTTP headers in a request.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "name": {
- "description": "name specifies a header name. Its value must be a valid HTTP header name as defined in RFC 2616 section 4.2.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPHeaders": {
- "description": "IngressControllerCaptureHTTPHeaders specifies which HTTP headers the IngressController captures.",
- "type": "object",
- "properties": {
- "request": {
- "description": "request specifies which HTTP request headers to capture.\n\nIf this field is empty, no request headers are captured.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPHeader"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "response": {
- "description": "response specifies which HTTP response headers to capture.\n\nIf this field is empty, no response headers are captured.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerCaptureHTTPHeader"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerHTTPHeader": {
- "description": "IngressControllerHTTPHeader specifies configuration for setting or deleting an HTTP header.",
- "type": "object",
- "required": [
- "name",
- "action"
- ],
- "properties": {
- "action": {
- "description": "action specifies actions to perform on headers, such as setting or deleting headers.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerHTTPHeaderActionUnion"
- },
- "name": {
- "description": "name specifies the name of a header on which to perform an action. Its value must be a valid HTTP header name as defined in RFC 2616 section 4.2. The name must consist only of alphanumeric and the following special characters, \"-!#$%&'*+.^_`\". The following header names are reserved and may not be modified via this API: Strict-Transport-Security, Proxy, Host, Cookie, Set-Cookie. It must be no more than 255 characters in length. Header name must be unique.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerHTTPHeaderActionUnion": {
- "description": "IngressControllerHTTPHeaderActionUnion specifies an action to take on an HTTP header.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "set": {
- "description": "set specifies how the HTTP header should be set. This field is required when type is Set and forbidden otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerSetHTTPHeader"
- },
- "type": {
- "description": "type defines the type of the action to be applied on the header. Possible values are Set or Delete. Set allows you to set HTTP request and response headers. Delete allows you to delete HTTP request and response headers.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "set": "Set"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.IngressControllerHTTPHeaderActions": {
- "description": "IngressControllerHTTPHeaderActions defines configuration for actions on HTTP request and response headers.",
- "type": "object",
- "properties": {
- "request": {
- "description": "request is a list of HTTP request headers to modify. Actions defined here will modify the request headers of all requests passing through an ingress controller. These actions are applied to all Routes i.e. for all connections handled by the ingress controller defined within a cluster. IngressController actions for request headers will be executed before Route actions. Currently, actions may define to either `Set` or `Delete` headers values. Actions are applied in sequence as defined in this list. A maximum of 20 request header actions may be configured. Sample fetchers allowed are \"req.hdr\" and \"ssl_c_der\". Converters allowed are \"lower\" and \"base64\". Example header values: \"%[req.hdr(X-target),lower]\", \"%{+Q}[ssl_c_der,base64]\".",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerHTTPHeader"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "response": {
- "description": "response is a list of HTTP response headers to modify. Actions defined here will modify the response headers of all requests passing through an ingress controller. These actions are applied to all Routes i.e. for all connections handled by the ingress controller defined within a cluster. IngressController actions for response headers will be executed after Route actions. Currently, actions may define to either `Set` or `Delete` headers values. Actions are applied in sequence as defined in this list. A maximum of 20 response header actions may be configured. Sample fetchers allowed are \"res.hdr\" and \"ssl_c_der\". Converters allowed are \"lower\" and \"base64\". Example header values: \"%[res.hdr(X-target),lower]\", \"%{+Q}[ssl_c_der,base64]\".",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerHTTPHeader"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerHTTPHeaders": {
- "description": "IngressControllerHTTPHeaders specifies how the IngressController handles certain HTTP headers.",
- "type": "object",
- "properties": {
- "actions": {
- "description": "actions specifies options for modifying headers and their values. Note that this option only applies to cleartext HTTP connections and to secure HTTP connections for which the ingress controller terminates encryption (that is, edge-terminated or reencrypt connections). Headers cannot be modified for TLS passthrough connections. Setting the HSTS (`Strict-Transport-Security`) header is not supported via actions. `Strict-Transport-Security` may only be configured using the \"haproxy.router.openshift.io/hsts_header\" route annotation, and only in accordance with the policy specified in Ingress.Spec.RequiredHSTSPolicies. Any actions defined here are applied after any actions related to the following other fields: cache-control, spec.clientTLS, spec.httpHeaders.forwardedHeaderPolicy, spec.httpHeaders.uniqueId, and spec.httpHeaders.headerNameCaseAdjustments. In case of HTTP request headers, the actions specified in spec.httpHeaders.actions on the Route will be executed after the actions specified in the IngressController's spec.httpHeaders.actions field. In case of HTTP response headers, the actions specified in spec.httpHeaders.actions on the IngressController will be executed after the actions specified in the Route's spec.httpHeaders.actions field. Headers set using this API cannot be captured for use in access logs. The following header names are reserved and may not be modified via this API: Strict-Transport-Security, Proxy, Host, Cookie, Set-Cookie. Note that the total size of all net added headers *after* interpolating dynamic values must not exceed the value of spec.tuningOptions.headerBufferMaxRewriteBytes on the IngressController. Please refer to the documentation for that API field for more details.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerHTTPHeaderActions"
- },
- "forwardedHeaderPolicy": {
- "description": "forwardedHeaderPolicy specifies when and how the IngressController sets the Forwarded, X-Forwarded-For, X-Forwarded-Host, X-Forwarded-Port, X-Forwarded-Proto, and X-Forwarded-Proto-Version HTTP headers. The value may be one of the following:\n\n* \"Append\", which specifies that the IngressController appends the\n headers, preserving existing headers.\n\n* \"Replace\", which specifies that the IngressController sets the\n headers, replacing any existing Forwarded or X-Forwarded-* headers.\n\n* \"IfNone\", which specifies that the IngressController sets the\n headers if they are not already set.\n\n* \"Never\", which specifies that the IngressController never sets the\n headers, preserving any existing headers.\n\nBy default, the policy is \"Append\".",
- "type": "string"
- },
- "headerNameCaseAdjustments": {
- "description": "headerNameCaseAdjustments specifies case adjustments that can be applied to HTTP header names. Each adjustment is specified as an HTTP header name with the desired capitalization. For example, specifying \"X-Forwarded-For\" indicates that the \"x-forwarded-for\" HTTP header should be adjusted to have the specified capitalization.\n\nThese adjustments are only applied to cleartext, edge-terminated, and re-encrypt routes, and only when using HTTP/1.\n\nFor request headers, these adjustments are applied only for routes that have the haproxy.router.openshift.io/h1-adjust-case=true annotation. For response headers, these adjustments are applied to all HTTP responses.\n\nIf this field is empty, no request headers are adjusted.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "uniqueId": {
- "description": "uniqueId describes configuration for a custom HTTP header that the ingress controller should inject into incoming HTTP requests. Typically, this header is configured to have a value that is unique to the HTTP request. The header can be used by applications or included in access logs to facilitate tracing individual HTTP requests.\n\nIf this field is empty, no such header is injected into requests.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerHTTPUniqueIdHeaderPolicy"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerHTTPUniqueIdHeaderPolicy": {
- "description": "IngressControllerHTTPUniqueIdHeaderPolicy describes configuration for a unique id header.",
- "type": "object",
- "properties": {
- "format": {
- "description": "format specifies the format for the injected HTTP header's value. This field has no effect unless name is specified. For the HAProxy-based ingress controller implementation, this format uses the same syntax as the HTTP log format. If the field is empty, the default value is \"%{+X}o\\\\ %ci:%cp_%fi:%fp_%Ts_%rt:%pid\"; see the corresponding HAProxy documentation: http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3",
- "type": "string"
- },
- "name": {
- "description": "name specifies the name of the HTTP header (for example, \"unique-id\") that the ingress controller should inject into HTTP requests. The field's value must be a valid HTTP header name as defined in RFC 2616 section 4.2. If the field is empty, no header is injected.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerList": {
- "description": "IngressControllerList contains a list of IngressControllers.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressController"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerLogging": {
- "description": "IngressControllerLogging describes what should be logged where.",
- "type": "object",
- "properties": {
- "access": {
- "description": "access describes how the client requests should be logged.\n\nIf this field is empty, access logging is disabled.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AccessLogging"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerSetHTTPHeader": {
- "description": "IngressControllerSetHTTPHeader defines the value which needs to be set on an HTTP header.",
- "type": "object",
- "required": [
- "value"
- ],
- "properties": {
- "value": {
- "description": "value specifies a header value. Dynamic values can be added. The value will be interpreted as an HAProxy format string as defined in http://cbonte.github.io/haproxy-dconv/2.6/configuration.html#8.2.6 and may use HAProxy's %[] syntax and otherwise must be a valid HTTP header value as defined in https://datatracker.ietf.org/doc/html/rfc7230#section-3.2. The value of this field must be no more than 16384 characters in length. Note that the total size of all net added headers *after* interpolating dynamic values must not exceed the value of spec.tuningOptions.headerBufferMaxRewriteBytes on the IngressController.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerSpec": {
- "description": "IngressControllerSpec is the specification of the desired behavior of the IngressController.",
- "type": "object",
- "properties": {
- "clientTLS": {
- "description": "clientTLS specifies settings for requesting and verifying client certificates, which can be used to enable mutual TLS for edge-terminated and reencrypt routes.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClientTLS"
- },
- "defaultCertificate": {
- "description": "defaultCertificate is a reference to a secret containing the default certificate served by the ingress controller. When Routes don't specify their own certificate, defaultCertificate is used.\n\nThe secret must contain the following keys and data:\n\n tls.crt: certificate file contents\n tls.key: key file contents\n\nIf unset, a wildcard certificate is automatically generated and used. The certificate is valid for the ingress controller domain (and subdomains) and the generated certificate's CA will be automatically integrated with the cluster's trust store.\n\nIf a wildcard certificate is used and shared by multiple HTTP/2 enabled routes (which implies ALPN) then clients (i.e., notably browsers) are at liberty to reuse open connections. This means a client can reuse a connection to another route and that is likely to fail. This behaviour is generally known as connection coalescing.\n\nThe in-use certificate (whether generated or user-specified) will be automatically integrated with OpenShift's built-in OAuth server.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
- },
- "domain": {
- "description": "domain is a DNS name serviced by the ingress controller and is used to configure multiple features:\n\n* For the LoadBalancerService endpoint publishing strategy, domain is\n used to configure DNS records. See endpointPublishingStrategy.\n\n* When using a generated default certificate, the certificate will be valid\n for domain and its subdomains. See defaultCertificate.\n\n* The value is published to individual Route statuses so that end-users\n know where to target external DNS records.\n\ndomain must be unique among all IngressControllers, and cannot be updated.\n\nIf empty, defaults to ingress.config.openshift.io/cluster .spec.domain.\n\nThe domain value must be a valid DNS name. It must consist of lowercase alphanumeric characters, '-' or '.', and each label must start and end with an alphanumeric character and not exceed 63 characters. Maximum length of a valid DNS domain is 253 characters.\n\nThe implementation may add a prefix such as \"router-default.\" to the domain when constructing the router canonical hostname. To ensure the resulting hostname does not exceed the DNS maximum length of 253 characters, the domain length is additionally validated at the IngressController object level. For the maximum length of the domain value itself, the shortest possible variant of the prefix and the ingress controller name was considered for example \"router-a.\"",
- "type": "string"
- },
- "endpointPublishingStrategy": {
- "description": "endpointPublishingStrategy is used to publish the ingress controller endpoints to other networks, enable load balancer integrations, etc.\n\nIf unset, the default is based on infrastructure.config.openshift.io/cluster .status.platform:\n\n AWS: LoadBalancerService (with External scope)\n Azure: LoadBalancerService (with External scope)\n GCP: LoadBalancerService (with External scope)\n IBMCloud: LoadBalancerService (with External scope)\n AlibabaCloud: LoadBalancerService (with External scope)\n Libvirt: HostNetwork\n\nAny other platform types (including None) default to HostNetwork.\n\nendpointPublishingStrategy cannot be updated.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.EndpointPublishingStrategy"
- },
- "httpCompression": {
- "description": "httpCompression defines a policy for HTTP traffic compression. By default, there is no HTTP compression.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.HTTPCompressionPolicy"
- },
- "httpEmptyRequestsPolicy": {
- "description": "httpEmptyRequestsPolicy describes how HTTP connections should be handled if the connection times out before a request is received. Allowed values for this field are \"Respond\" and \"Ignore\". If the field is set to \"Respond\", the ingress controller sends an HTTP 400 or 408 response, logs the connection (if access logging is enabled), and counts the connection in the appropriate metrics. If the field is set to \"Ignore\", the ingress controller closes the connection without sending a response, logging the connection, or incrementing metrics. The default value is \"Respond\".\n\nTypically, these connections come from load balancers' health probes or Web browsers' speculative connections (\"preconnect\") and can be safely ignored. However, these requests may also be caused by network errors, and so setting this field to \"Ignore\" may impede detection and diagnosis of problems. In addition, these requests may be caused by port scans, in which case logging empty requests may aid in detecting intrusion attempts.",
- "type": "string"
- },
- "httpErrorCodePages": {
- "description": "httpErrorCodePages specifies a configmap with custom error pages. The administrator must create this configmap in the openshift-config namespace. This configmap should have keys in the format \"error-page-.http\", where is an HTTP error code. For example, \"error-page-503.http\" defines an error page for HTTP 503 responses. Currently only error pages for 503 and 404 responses can be customized. Each value in the configmap should be the full response, including HTTP headers. Eg- https://raw.githubusercontent.com/openshift/router/fadab45747a9b30cc3f0a4b41ad2871f95827a93/images/router/haproxy/conf/error-page-503.http If this field is empty, the ingress controller uses the default error pages.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
- },
- "httpHeaders": {
- "description": "httpHeaders defines policy for HTTP headers.\n\nIf this field is empty, the default values are used.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerHTTPHeaders"
- },
- "idleConnectionTerminationPolicy": {
- "description": "idleConnectionTerminationPolicy maps directly to HAProxy's idle-close-on-response option and controls whether HAProxy keeps idle frontend connections open during a soft stop (router reload).\n\nAllowed values for this field are \"Immediate\" and \"Deferred\". The default value is \"Immediate\".\n\nWhen set to \"Immediate\", idle connections are closed immediately during router reloads. This ensures immediate propagation of route changes but may impact clients sensitive to connection resets.\n\nWhen set to \"Deferred\", HAProxy will maintain idle connections during a soft reload instead of closing them immediately. These connections remain open until any of the following occurs:\n\n - A new request is received on the connection, in which\n case HAProxy handles it in the old process and closes\n the connection after sending the response.\n\n - HAProxy's `timeout http-keep-alive` duration expires\n (300 seconds in OpenShift's configuration, not\n configurable).\n\n - The client's keep-alive timeout expires, causing the\n client to close the connection.\n\nSetting Deferred can help prevent errors in clients or load balancers that do not properly handle connection resets. Additionally, this option allows you to retain the pre-2.4 HAProxy behaviour: in HAProxy version 2.2 (OpenShift versions < 4.14), maintaining idle connections during a soft reload was the default behaviour, but starting with HAProxy 2.4, the default changed to closing idle connections immediately.\n\nImportant Consideration:\n\n - Using Deferred will result in temporary inconsistencies\n for the first request on each persistent connection\n after a route update and router reload. This request\n will be processed by the old HAProxy process using its\n old configuration. Subsequent requests will use the\n updated configuration.\n\nOperational Considerations:\n\n - Keeping idle connections open during reloads may lead\n to an accumulation of old HAProxy processes if\n connections remain idle for extended periods,\n especially in environments where frequent reloads\n occur.\n\n - Consider monitoring the number of HAProxy processes in\n the router pods when Deferred is set.\n\n - You may need to enable or adjust the\n `ingress.operator.openshift.io/hard-stop-after`\n duration (configured via an annotation on the\n IngressController resource) in environments with\n frequent reloads to prevent resource exhaustion.",
- "type": "string",
- "default": "Immediate"
- },
- "logging": {
- "description": "logging defines parameters for what should be logged where. If this field is empty, operational logs are enabled but access logs are disabled.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerLogging"
- },
- "namespaceSelector": {
- "description": "namespaceSelector is used to filter the set of namespaces serviced by the ingress controller. This is useful for implementing shards.\n\nIf unset, the default is no filtering.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "nodePlacement": {
- "description": "nodePlacement enables explicit control over the scheduling of the ingress controller.\n\nIf unset, defaults are used. See NodePlacement for more details.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodePlacement"
- },
- "replicas": {
- "description": "replicas is the desired number of ingress controller replicas. If unset, the default depends on the value of the defaultPlacement field in the cluster config.openshift.io/v1/ingresses status.\n\nThe value of replicas is set based on the value of a chosen field in the Infrastructure CR. If defaultPlacement is set to ControlPlane, the chosen field will be controlPlaneTopology. If it is set to Workers the chosen field will be infrastructureTopology. Replicas will then be set to 1 or 2 based whether the chosen field's value is SingleReplica or HighlyAvailable, respectively.\n\nThese defaults are subject to change.",
- "type": "integer",
- "format": "int32"
- },
- "routeAdmission": {
- "description": "routeAdmission defines a policy for handling new route claims (for example, to allow or deny claims across namespaces).\n\nIf empty, defaults will be applied. See specific routeAdmission fields for details about their defaults.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.RouteAdmissionPolicy"
- },
- "routeSelector": {
- "description": "routeSelector is used to filter the set of Routes serviced by the ingress controller. This is useful for implementing shards.\n\nIf unset, the default is no filtering.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "tlsSecurityProfile": {
- "description": "tlsSecurityProfile specifies settings for TLS connections for ingresscontrollers.\n\nIf unset, the default is based on the apiservers.config.openshift.io/cluster resource.\n\nNote that when using the Old, Intermediate, and Modern profile types, the effective profile configuration is subject to change between releases. For example, given a specification to use the Intermediate profile deployed on release X.Y.Z, an upgrade to release X.Y.Z+1 may cause a new profile configuration to be applied to the ingress controller, resulting in a rollout.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TLSSecurityProfile"
- },
- "tuningOptions": {
- "description": "tuningOptions defines parameters for adjusting the performance of ingress controller pods. All fields are optional and will use their respective defaults if not set. See specific tuningOptions fields for more details.\n\nSetting fields within tuningOptions is generally not recommended. The default values are suitable for most configurations.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IngressControllerTuningOptions"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides allows specifying unsupported configuration options. Its use is unsupported.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerStatus": {
- "description": "IngressControllerStatus defines the observed status of the IngressController.",
- "type": "object",
- "properties": {
- "availableReplicas": {
- "description": "availableReplicas is number of observed available replicas according to the ingress controller deployment.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "conditions": {
- "description": "conditions is a list of conditions and their status.\n\nAvailable means the ingress controller deployment is available and servicing route and ingress resources (i.e, .status.availableReplicas equals .spec.replicas)\n\nThere are additional conditions which indicate the status of other ingress controller features and capabilities.\n\n * LoadBalancerManaged\n - True if the following conditions are met:\n * The endpoint publishing strategy requires a service load balancer.\n - False if any of those conditions are unsatisfied.\n\n * LoadBalancerReady\n - True if the following conditions are met:\n * A load balancer is managed.\n * The load balancer is ready.\n - False if any of those conditions are unsatisfied.\n\n * DNSManaged\n - True if the following conditions are met:\n * The endpoint publishing strategy and platform support DNS.\n * The ingress controller domain is set.\n * dns.config.openshift.io/cluster configures DNS zones.\n - False if any of those conditions are unsatisfied.\n\n * DNSReady\n - True if the following conditions are met:\n * DNS is managed.\n * DNS records have been successfully created.\n - False if any of those conditions are unsatisfied.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "domain": {
- "description": "domain is the actual domain in use.",
- "type": "string",
- "default": ""
- },
- "endpointPublishingStrategy": {
- "description": "endpointPublishingStrategy is the actual strategy in use.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.EndpointPublishingStrategy"
- },
- "namespaceSelector": {
- "description": "namespaceSelector is the actual namespaceSelector in use.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "observedGeneration": {
- "description": "observedGeneration is the most recent generation observed.",
- "type": "integer",
- "format": "int64"
- },
- "routeSelector": {
- "description": "routeSelector is the actual routeSelector in use.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "selector": {
- "description": "selector is a label selector, in string format, for ingress controller pods corresponding to the IngressController. The number of matching pods should equal the value of availableReplicas.",
- "type": "string",
- "default": ""
- },
- "tlsProfile": {
- "description": "tlsProfile is the TLS connection configuration that is in effect.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.TLSProfileSpec"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IngressControllerTuningOptions": {
- "description": "IngressControllerTuningOptions specifies options for tuning the performance of ingress controller pods",
- "type": "object",
- "properties": {
- "clientFinTimeout": {
- "description": "clientFinTimeout defines how long a connection will be held open while waiting for the client response to the server/backend closing the connection.\n\nIf unset, the default timeout is 1s",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "clientTimeout": {
- "description": "clientTimeout defines how long a connection will be held open while waiting for a client response.\n\nIf unset, the default timeout is 30s",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "connectTimeout": {
- "description": "connectTimeout defines the maximum time to wait for a connection attempt to a server/backend to succeed.\n\nThis field expects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, e.g. \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\" U+00B5 or \"μs\" U+03BC), \"ms\", \"s\", \"m\", \"h\".\n\nWhen omitted, this means the user has no opinion and the platform is left to choose a reasonable default. This default is subject to change over time. The current default is 5s.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "headerBufferBytes": {
- "description": "headerBufferBytes describes how much memory should be reserved (in bytes) for IngressController connection sessions. Note that this value must be at least 16384 if HTTP/2 is enabled for the IngressController (https://tools.ietf.org/html/rfc7540). If this field is empty, the IngressController will use a default value of 32768 bytes.\n\nSetting this field is generally not recommended as headerBufferBytes values that are too small may break the IngressController and headerBufferBytes values that are too large could cause the IngressController to use significantly more memory than necessary.",
- "type": "integer",
- "format": "int32"
- },
- "headerBufferMaxRewriteBytes": {
- "description": "headerBufferMaxRewriteBytes describes how much memory should be reserved (in bytes) from headerBufferBytes for HTTP header rewriting and appending for IngressController connection sessions. Note that incoming HTTP requests will be limited to (headerBufferBytes - headerBufferMaxRewriteBytes) bytes, meaning headerBufferBytes must be greater than headerBufferMaxRewriteBytes. If this field is empty, the IngressController will use a default value of 8192 bytes.\n\nSetting this field is generally not recommended as headerBufferMaxRewriteBytes values that are too small may break the IngressController and headerBufferMaxRewriteBytes values that are too large could cause the IngressController to use significantly more memory than necessary.",
- "type": "integer",
- "format": "int32"
- },
- "healthCheckInterval": {
- "description": "healthCheckInterval defines how long the router waits between two consecutive health checks on its configured backends. This value is applied globally as a default for all routes, but may be overridden per-route by the route annotation \"router.openshift.io/haproxy.health.check.interval\".\n\nExpects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, eg \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\" U+00B5 or \"μs\" U+03BC), \"ms\", \"s\", \"m\", \"h\".\n\nSetting this to less than 5s can cause excess traffic due to too frequent TCP health checks and accompanying SYN packet storms. Alternatively, setting this too high can result in increased latency, due to backend servers that are no longer available, but haven't yet been detected as such.\n\nAn empty or zero healthCheckInterval means no opinion and IngressController chooses a default, which is subject to change over time. Currently the default healthCheckInterval value is 5s.\n\nCurrently the minimum allowed value is 1s and the maximum allowed value is 2147483647ms (24.85 days). Both are subject to change over time.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "maxConnections": {
- "description": "maxConnections defines the maximum number of simultaneous connections that can be established per HAProxy process. Increasing this value allows each ingress controller pod to handle more connections but at the cost of additional system resources being consumed.\n\nPermitted values are: empty, 0, -1, and the range 2000-2000000.\n\nIf this field is empty or 0, the IngressController will use the default value of 50000, but the default is subject to change in future releases.\n\nIf the value is -1 then HAProxy will dynamically compute a maximum value based on the available ulimits in the running container. Selecting -1 (i.e., auto) will result in a large value being computed (~520000 on OpenShift >=4.10 clusters) and therefore each HAProxy process will incur significant memory usage compared to the current default of 50000.\n\nSetting a value that is greater than the current operating system limit will prevent the HAProxy process from starting.\n\nIf you choose a discrete value (e.g., 750000) and the router pod is migrated to a new node, there's no guarantee that that new node has identical ulimits configured. In such a scenario the pod would fail to start. If you have nodes with different ulimits configured (e.g., different tuned profiles) and you choose a discrete value then the guidance is to use -1 and let the value be computed dynamically at runtime.\n\nYou can monitor memory usage for router containers with the following metric: 'container_memory_working_set_bytes{container=\"router\",namespace=\"openshift-ingress\"}'.\n\nYou can monitor memory usage of individual HAProxy processes in router containers with the following metric: 'container_memory_working_set_bytes{container=\"router\",namespace=\"openshift-ingress\"}/container_processes{container=\"router\",namespace=\"openshift-ingress\"}'.",
- "type": "integer",
- "format": "int32"
- },
- "reloadInterval": {
- "description": "reloadInterval defines the minimum interval at which the router is allowed to reload to accept new changes. Increasing this value can prevent the accumulation of HAProxy processes, depending on the scenario. Increasing this interval can also lessen load imbalance on a backend's servers when using the roundrobin balancing algorithm. Alternatively, decreasing this value may decrease latency since updates to HAProxy's configuration can take effect more quickly.\n\nThe value must be a time duration value; see . Currently, the minimum value allowed is 1s, and the maximum allowed value is 120s. Minimum and maximum allowed values may change in future versions of OpenShift. Note that if a duration outside of these bounds is provided, the value of reloadInterval will be capped/floored and not rejected (e.g. a duration of over 120s will be capped to 120s; the IngressController will not reject and replace this disallowed value with the default).\n\nA zero value for reloadInterval tells the IngressController to choose the default, which is currently 5s and subject to change without notice.\n\nThis field expects an unsigned duration string of decimal numbers, each with optional fraction and a unit suffix, e.g. \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\" U+00B5 or \"μs\" U+03BC), \"ms\", \"s\", \"m\", \"h\".\n\nNote: Setting a value significantly larger than the default of 5s can cause latency in observing updates to routes and their endpoints. HAProxy's configuration will be reloaded less frequently, and newly created routes will not be served until the subsequent reload.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "serverFinTimeout": {
- "description": "serverFinTimeout defines how long a connection will be held open while waiting for the server/backend response to the client closing the connection.\n\nIf unset, the default timeout is 1s",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "serverTimeout": {
- "description": "serverTimeout defines how long a connection will be held open while waiting for a server/backend response.\n\nIf unset, the default timeout is 30s",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "threadCount": {
- "description": "threadCount defines the number of threads created per HAProxy process. Creating more threads allows each ingress controller pod to handle more connections, at the cost of more system resources being used. HAProxy currently supports up to 64 threads. If this field is empty, the IngressController will use the default value. The current default is 4 threads, but this may change in future releases.\n\nSetting this field is generally not recommended. Increasing the number of HAProxy threads allows ingress controller pods to utilize more CPU time under load, potentially starving other pods if set too high. Reducing the number of threads may cause the ingress controller to perform poorly.",
- "type": "integer",
- "format": "int32"
- },
- "tlsInspectDelay": {
- "description": "tlsInspectDelay defines how long the router can hold data to find a matching route.\n\nSetting this too short can cause the router to fall back to the default certificate for edge-terminated or reencrypt routes even when a better matching certificate could be used.\n\nIf unset, the default inspect delay is 5s",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "tunnelTimeout": {
- "description": "tunnelTimeout defines how long a tunnel connection (including websockets) will be held open while the tunnel is idle.\n\nIf unset, the default timeout is 1h",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- }
- }
- },
- "com.github.openshift.api.operator.v1.InsightsOperator": {
- "description": "InsightsOperator holds cluster-wide information about the Insights Operator.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the Insights.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.InsightsOperatorSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the Insights operator.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.InsightsOperatorStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.InsightsOperatorList": {
- "description": "InsightsOperatorList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.InsightsOperator"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.InsightsOperatorSpec": {
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.InsightsOperatorStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "gatherStatus": {
- "description": "gatherStatus provides basic information about the last Insights data gathering. When omitted, this means no data gathering has taken place yet.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GatherStatus"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "insightsReport": {
- "description": "insightsReport provides general Insights analysis results. When omitted, this means no data gathering has taken place yet.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.InsightsReport"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.InsightsReport": {
- "description": "insightsReport provides Insights health check report based on the most recently sent Insights data.",
- "type": "object",
- "properties": {
- "downloadedAt": {
- "description": "downloadedAt is the time when the last Insights report was downloaded. An empty value means that there has not been any Insights report downloaded yet and it usually appears in disconnected clusters (or clusters when the Insights data gathering is disabled).",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "healthChecks": {
- "description": "healthChecks provides basic information about active Insights health checks in a cluster.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.HealthCheck"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.IrreconcilableValidationOverrides": {
- "description": "IrreconcilableValidationOverrides holds the irreconcilable validations overrides to be applied on each rendered MachineConfig generation.",
- "type": "object",
- "properties": {
- "storage": {
- "description": "storage can be used to allow making irreconcilable changes to the selected sections under the `spec.config.storage` field of MachineConfig CRs It must have at least one item, may not exceed 3 items and must not contain duplicates. Allowed element values are \"Disks\", \"FileSystems\", \"Raid\" and omitted. When contains \"Disks\" changes to the `spec.config.storage.disks` section of MachineConfig CRs are allowed. When contains \"FileSystems\" changes to the `spec.config.storage.filesystems` section of MachineConfig CRs are allowed. When contains \"Raid\" changes to the `spec.config.storage.raid` section of MachineConfig CRs are allowed. When omitted changes to the `spec.config.storage` section are forbidden.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeAPIServer": {
- "description": "KubeAPIServer provides information to configure an operator to manage kube-apiserver.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the Kubernetes API Server",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeAPIServerSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the Kubernetes API Server",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeAPIServerStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeAPIServerList": {
- "description": "KubeAPIServerList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeAPIServer"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeAPIServerSpec": {
- "type": "object",
- "required": [
- "managementState",
- "forceRedeploymentReason"
- ],
- "properties": {
- "eventTTLMinutes": {
- "description": "eventTTLMinutes specifies the amount of time that the events are stored before being deleted. The TTL is allowed between 5 minutes minimum up to a maximum of 180 minutes (3 hours).\n\nLowering this value will reduce the storage required in etcd. Note that this setting will only apply to new events being created and will not update existing events.\n\nWhen omitted this means no opinion, and the platform is left to choose a reasonable default, which is subject to change over time. The current default value is 3h (180 minutes).",
- "type": "integer",
- "format": "int32"
- },
- "failedRevisionLimit": {
- "description": "failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "forceRedeploymentReason": {
- "description": "forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.",
- "type": "string",
- "default": ""
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "succeededRevisionLimit": {
- "description": "succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeAPIServerStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "latestAvailableRevisionReason": {
- "description": "latestAvailableRevisionReason describe the detailed reason for the most recent deployment",
- "type": "string"
- },
- "nodeStatuses": {
- "description": "nodeStatuses track the deployment values and errors across individual nodes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeStatus"
- },
- "x-kubernetes-list-map-keys": [
- "nodeName"
- ],
- "x-kubernetes-list-type": "map"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "serviceAccountIssuers": {
- "description": "serviceAccountIssuers tracks history of used service account issuers. The item without expiration time represents the currently used service account issuer. The other items represents service account issuers that were used previously and are still being trusted. The default expiration for the items is set by the platform and it defaults to 24h. see: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceAccountIssuerStatus"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeControllerManager": {
- "description": "KubeControllerManager provides information to configure an operator to manage kube-controller-manager.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the Kubernetes Controller Manager",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeControllerManagerSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the Kubernetes Controller Manager",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeControllerManagerStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeControllerManagerList": {
- "description": "KubeControllerManagerList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeControllerManager"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeControllerManagerSpec": {
- "type": "object",
- "required": [
- "managementState",
- "forceRedeploymentReason",
- "useMoreSecureServiceCA"
- ],
- "properties": {
- "failedRevisionLimit": {
- "description": "failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "forceRedeploymentReason": {
- "description": "forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.",
- "type": "string",
- "default": ""
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "succeededRevisionLimit": {
- "description": "succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "useMoreSecureServiceCA": {
- "description": "useMoreSecureServiceCA indicates that the service-ca.crt provided in SA token volumes should include only enough certificates to validate service serving certificates. Once set to true, it cannot be set to false. Even if someone finds a way to set it back to false, the service-ca.crt files that previously existed will only have the more secure content.",
- "type": "boolean",
- "default": false
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeControllerManagerStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "latestAvailableRevisionReason": {
- "description": "latestAvailableRevisionReason describe the detailed reason for the most recent deployment",
- "type": "string"
- },
- "nodeStatuses": {
- "description": "nodeStatuses track the deployment values and errors across individual nodes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeStatus"
- },
- "x-kubernetes-list-map-keys": [
- "nodeName"
- ],
- "x-kubernetes-list-type": "map"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeScheduler": {
- "description": "KubeScheduler provides information to configure an operator to manage scheduler.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the Kubernetes Scheduler",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeSchedulerSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the Kubernetes Scheduler",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeSchedulerStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeSchedulerList": {
- "description": "KubeSchedulerList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeScheduler"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeSchedulerSpec": {
- "type": "object",
- "required": [
- "managementState",
- "forceRedeploymentReason"
- ],
- "properties": {
- "failedRevisionLimit": {
- "description": "failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "forceRedeploymentReason": {
- "description": "forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.",
- "type": "string",
- "default": ""
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "succeededRevisionLimit": {
- "description": "succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeSchedulerStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "latestAvailableRevisionReason": {
- "description": "latestAvailableRevisionReason describe the detailed reason for the most recent deployment",
- "type": "string"
- },
- "nodeStatuses": {
- "description": "nodeStatuses track the deployment values and errors across individual nodes",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeStatus"
- },
- "x-kubernetes-list-map-keys": [
- "nodeName"
- ],
- "x-kubernetes-list-type": "map"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeStorageVersionMigrator": {
- "description": "KubeStorageVersionMigrator provides information to configure an operator to manage kube-storage-version-migrator.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeStorageVersionMigratorSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeStorageVersionMigratorStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeStorageVersionMigratorList": {
- "description": "KubeStorageVersionMigratorList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.KubeStorageVersionMigrator"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeStorageVersionMigratorSpec": {
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.KubeStorageVersionMigratorStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.LoadBalancerStrategy": {
- "description": "LoadBalancerStrategy holds parameters for a load balancer.",
- "type": "object",
- "required": [
- "scope",
- "dnsManagementPolicy"
- ],
- "properties": {
- "allowedSourceRanges": {
- "description": "allowedSourceRanges specifies an allowlist of IP address ranges to which access to the load balancer should be restricted. Each range must be specified using CIDR notation (e.g. \"10.0.0.0/8\" or \"fd00::/8\"). If no range is specified, \"0.0.0.0/0\" for IPv4 and \"::/0\" for IPv6 are used by default, which allows all source addresses.\n\nTo facilitate migration from earlier versions of OpenShift that did not have the allowedSourceRanges field, you may set the service.beta.kubernetes.io/load-balancer-source-ranges annotation on the \"router-\" service in the \"openshift-ingress\" namespace, and this annotation will take effect if allowedSourceRanges is empty on OpenShift 4.12.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "dnsManagementPolicy": {
- "description": "dnsManagementPolicy indicates if the lifecycle of the wildcard DNS record associated with the load balancer service will be managed by the ingress operator. It defaults to Managed. Valid values are: Managed and Unmanaged.",
- "type": "string",
- "default": "Managed"
- },
- "providerParameters": {
- "description": "providerParameters holds desired load balancer information specific to the underlying infrastructure provider.\n\nIf empty, defaults will be applied. See specific providerParameters fields for details about their defaults.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ProviderLoadBalancerParameters"
- },
- "scope": {
- "description": "scope indicates the scope at which the load balancer is exposed. Possible values are \"External\" and \"Internal\".",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.LoggingDestination": {
- "description": "LoggingDestination describes a destination for log messages.",
- "type": "object",
- "required": [
- "type"
- ],
- "properties": {
- "container": {
- "description": "container holds parameters for the Container logging destination. Present only if type is Container.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ContainerLoggingDestinationParameters"
- },
- "syslog": {
- "description": "syslog holds parameters for a syslog endpoint. Present only if type is Syslog.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.SyslogLoggingDestinationParameters"
- },
- "type": {
- "description": "type is the type of destination for logs. It must be one of the following:\n\n* Container\n\nThe ingress operator configures the sidecar container named \"logs\" on the ingress controller pod and configures the ingress controller to write logs to the sidecar. The logs are then available as container logs. The expectation is that the administrator configures a custom logging solution that reads logs from this sidecar. Note that using container logs means that logs may be dropped if the rate of logs exceeds the container runtime's or the custom logging solution's capacity.\n\n* Syslog\n\nLogs are sent to a syslog endpoint. The administrator must specify an endpoint that can receive syslog messages. The expectation is that the administrator has configured a custom syslog instance.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "container": "Container",
- "syslog": "Syslog"
- }
- }
- ]
- },
- "com.github.openshift.api.operator.v1.Logo": {
- "description": "Logo defines a configuration based on theme modes for the console UI logo.",
- "type": "object",
- "required": [
- "type",
- "themes"
- ],
- "properties": {
- "themes": {
- "description": "themes specifies the themes for the console UI logo. themes is a required field that allows a list of themes. Each item in the themes list must have a unique mode and a source field. Each mode determines whether the logo is for the dark or light mode of the console UI. If a theme is not specified, the default OpenShift logo will be displayed for that theme. There must be at least one entry and no more than 2 entries.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Theme"
- },
- "x-kubernetes-list-map-keys": [
- "mode"
- ],
- "x-kubernetes-list-type": "map"
- },
- "type": {
- "description": "type specifies the type of the logo for the console UI. It determines whether the logo is for the masthead or favicon. type is a required field that allows values of Masthead and Favicon. When set to \"Masthead\", the logo will be used in the masthead and about modal of the console UI. When set to \"Favicon\", the logo will be used as the favicon of the console UI.\n\nPossible enum values:\n - `\"Favicon\"` Favicon represents the favicon logo.\n - `\"Masthead\"` Masthead represents the logo in the masthead.",
- "type": "string",
- "default": "",
- "enum": [
- "Favicon",
- "Masthead"
- ]
- }
- }
- },
- "com.github.openshift.api.operator.v1.MTUMigration": {
- "description": "MTUMigration contains infomation about MTU migration.",
- "type": "object",
- "properties": {
- "machine": {
- "description": "machine contains MTU migration configuration for the machine's uplink. Needs to be migrated along with the default network MTU unless the current uplink MTU already accommodates the default network MTU.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MTUMigrationValues"
- },
- "network": {
- "description": "network contains information about MTU migration for the default network. Migrations are only allowed to MTU values lower than the machine's uplink MTU by the minimum appropriate offset.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MTUMigrationValues"
- }
- }
- },
- "com.github.openshift.api.operator.v1.MTUMigrationValues": {
- "description": "MTUMigrationValues contains the values for a MTU migration.",
- "type": "object",
- "required": [
- "to"
- ],
- "properties": {
- "from": {
- "description": "from is the MTU to migrate from.",
- "type": "integer",
- "format": "int64"
- },
- "to": {
- "description": "to is the MTU to migrate to.",
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "com.github.openshift.api.operator.v1.MachineConfiguration": {
- "description": "MachineConfiguration provides information to configure an operator to manage Machine Configuration.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the Machine Config Operator",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MachineConfigurationSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the Machine Config Operator",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MachineConfigurationStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.MachineConfigurationList": {
- "description": "MachineConfigurationList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
+ "webhookTokenAuthenticator": {
+ "description": "webhookTokenAuthenticator configures a remote token reviewer. These remote authentication webhooks can be used to verify bearer tokens via the tokenreviews.authentication.k8s.io REST API. This is required to honor bearer tokens that are provisioned by an external authentication service.\n\nCan only be set if \"Type\" is set to \"None\".",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.WebhookTokenAuthenticator"
},
- "items": {
- "description": "items contains the items",
+ "webhookTokenAuthenticators": {
+ "description": "webhookTokenAuthenticators is DEPRECATED, setting it has no effect.",
"type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MachineConfiguration"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1.MachineConfigurationSpec": {
- "type": "object",
- "required": [
- "managementState",
- "forceRedeploymentReason"
- ],
- "properties": {
- "bootImageSkewEnforcement": {
- "description": "bootImageSkewEnforcement allows an admin to configure how boot image version skew is enforced on the cluster. When omitted, this will default to Automatic for clusters that support automatic boot image updates. For clusters that do not support automatic boot image updates, cluster upgrades will be disabled until a skew enforcement mode has been specified. When version skew is being enforced, cluster upgrades will be disabled until the version skew is deemed acceptable for the current release payload.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.BootImageSkewEnforcementConfig"
- },
- "failedRevisionLimit": {
- "description": "failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "forceRedeploymentReason": {
- "description": "forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.",
- "type": "string",
- "default": ""
- },
- "irreconcilableValidationOverrides": {
- "description": "irreconcilableValidationOverrides is an optional field that can used to make changes to a MachineConfig that cannot be applied to existing nodes. When specified, the fields configured with validation overrides will no longer reject changes to those respective fields due to them not being able to be applied to existing nodes. Only newly provisioned nodes will have these configurations applied. Existing nodes will report observed configuration differences in their MachineConfigNode status.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IrreconcilableValidationOverrides"
- },
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managedBootImages": {
- "description": "managedBootImages allows configuration for the management of boot images for machine resources within the cluster. This configuration allows users to select resources that should be updated to the latest boot images during cluster upgrades, ensuring that new machines always boot with the current cluster version's boot image. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The default for each machine manager mode is All for GCP and AWS platforms, and None for all other platforms.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ManagedBootImages"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "nodeDisruptionPolicy": {
- "description": "nodeDisruptionPolicy allows an admin to set granular node disruption actions for MachineConfig-based updates, such as drains, service reloads, etc. Specifying this will allow for less downtime when doing small configuration updates to the cluster. This configuration has no effect on cluster upgrades which will still incur node disruption where required.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyConfig"
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "succeededRevisionLimit": {
- "description": "succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DeprecatedWebhookTokenAuthenticator"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.operator.v1.MachineConfigurationStatus": {
+ "com.github.openshift.api.config.v1.AuthenticationStatus": {
"type": "object",
"properties": {
- "bootImageSkewEnforcementStatus": {
- "description": "bootImageSkewEnforcementStatus reflects what the latest cluster-validated boot image skew enforcement configuration is and will be used by Machine Config Controller while performing boot image skew enforcement. When omitted, the MCO has no knowledge of how to enforce boot image skew. When the MCO does not know how boot image skew should be enforced, cluster upgrades will be blocked until it can either automatically determine skew enforcement or there is an explicit skew enforcement configuration provided in the spec.bootImageSkewEnforcement field.",
+ "integratedOAuthMetadata": {
+ "description": "integratedOAuthMetadata contains the discovery endpoint data for OAuth 2.0 Authorization Server Metadata for the in-cluster integrated OAuth server. This discovery document can be viewed from its served location: oc get --raw '/.well-known/oauth-authorization-server' For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 This contains the observed value based on cluster state. An explicitly set value in spec.oauthMetadata has precedence over this field. This field has no meaning if authentication spec.type is not set to IntegratedOAuth. The key \"oauthMetadata\" is used to locate the data. If the config map or expected key is not found, no metadata is served. If the specified metadata is not valid, no metadata is served. The namespace for this config map is openshift-config-managed.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.BootImageSkewEnforcementStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "conditions": {
- "description": "conditions is a list of conditions and their status",
+ "oidcClients": {
+ "description": "oidcClients is where participating operators place the current OIDC client status for OIDC clients that can be customized by the cluster-admin.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCClientStatus"
},
"x-kubernetes-list-map-keys": [
- "type"
+ "componentNamespace",
+ "componentName"
],
"x-kubernetes-list-type": "map"
- },
- "managedBootImagesStatus": {
- "description": "managedBootImagesStatus reflects what the latest cluster-validated boot image configuration is and will be used by Machine Config Controller while performing boot image updates.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ManagedBootImages"
- },
- "nodeDisruptionPolicyStatus": {
- "description": "nodeDisruptionPolicyStatus status reflects what the latest cluster-validated policies are, and will be used by the Machine Config Daemon during future node updates.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatus"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
}
}
},
- "com.github.openshift.api.operator.v1.MachineManager": {
- "description": "MachineManager describes a target machine resource that is registered for boot image updates. It stores identifying information such as the resource type and the API Group of the resource. It also provides granular control via the selection field.",
+ "com.github.openshift.api.config.v1.AzurePlatformSpec": {
+ "description": "AzurePlatformSpec holds the desired state of the Azure infrastructure provider. This only includes fields that can be modified in the cluster.",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.AzurePlatformStatus": {
+ "description": "AzurePlatformStatus holds the current status of the Azure infrastructure provider.",
"type": "object",
"required": [
- "resource",
- "apiGroup",
- "selection"
+ "resourceGroupName"
],
"properties": {
- "apiGroup": {
- "description": "apiGroup is name of the APIGroup that the machine management resource belongs to. The only current valid value is machine.openshift.io. machine.openshift.io means that the machine manager will only register resources that belong to OpenShift machine API group.",
+ "armEndpoint": {
+ "description": "armEndpoint specifies a URL to use for resource management in non-soverign clouds such as Azure Stack.",
+ "type": "string"
+ },
+ "cloudLoadBalancerConfig": {
+ "description": "cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer.",
+ "default": {
+ "dnsType": "PlatformDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerConfig"
+ },
+ "cloudName": {
+ "description": "cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK with the appropriate Azure API endpoints. If empty, the value is equal to `AzurePublicCloud`.",
+ "type": "string"
+ },
+ "ipFamily": {
+ "description": "ipFamily specifies the IP protocol family that should be used for Azure network resources. This controls whether Azure resources are created with IPv4-only, or dual-stack networking with IPv4 or IPv6 as the primary protocol family.",
"type": "string",
- "default": ""
+ "default": "IPv4"
},
- "resource": {
- "description": "resource is the machine management resource's type. Valid values are machinesets and controlplanemachinesets. machinesets means that the machine manager will only register resources of the kind MachineSet. controlplanemachinesets means that the machine manager will only register resources of the kind ControlPlaneMachineSet.",
+ "networkResourceGroupName": {
+ "description": "networkResourceGroupName is the Resource Group for network resources like the Virtual Network and Subnets used by the cluster. If empty, the value is same as ResourceGroupName.",
+ "type": "string"
+ },
+ "resourceGroupName": {
+ "description": "resourceGroupName is the Resource Group for new Azure resources created for the cluster.",
"type": "string",
"default": ""
},
- "selection": {
- "description": "selection allows granular control of the machine management resources that will be registered for boot image updates.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MachineManagerSelector"
+ "resourceTags": {
+ "description": "resourceTags is a list of additional tags to apply to Azure resources created for the cluster. See https://docs.microsoft.com/en-us/rest/api/resources/tags for information on tagging Azure resources. Due to limitations on Automation, Content Delivery Network, DNS Azure resources, a maximum of 15 tags may be applied. OpenShift reserves 5 tags for internal use, allowing 10 tags for user configuration.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AzureResourceTag"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.operator.v1.MachineManagerSelector": {
+ "com.github.openshift.api.config.v1.AzureResourceTag": {
+ "description": "AzureResourceTag is a tag to apply to Azure resources created for the cluster.",
"type": "object",
"required": [
- "mode"
+ "key",
+ "value"
],
"properties": {
- "mode": {
- "description": "mode determines how machine managers will be selected for updates. Valid values are All, Partial and None. All means that every resource matched by the machine manager will be updated. Partial requires specified selector(s) and allows customisation of which resources matched by the machine manager will be updated. Partial is not permitted for the controlplanemachinesets resource type as they are a singleton within the cluster. None means that every resource matched by the machine manager will not be updated.",
+ "key": {
+ "description": "key is the key part of the tag. A tag key can have a maximum of 128 characters and cannot be empty. Key must begin with a letter, end with a letter, number or underscore, and must contain only alphanumeric characters and the following special characters `_ . -`.",
"type": "string",
"default": ""
},
- "partial": {
- "description": "partial provides label selector(s) that can be used to match machine management resources. Only permitted when mode is set to \"Partial\".",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.PartialSelector"
+ "value": {
+ "description": "value is the value part of the tag. A tag value can have a maximum of 256 characters and cannot be empty. Value must contain only alphanumeric characters and the following special characters `_ + , - . / : ; < = > ? @`.",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.BareMetalPlatformLoadBalancer": {
+ "description": "BareMetalPlatformLoadBalancer defines the load balancer used by the cluster on BareMetal platform.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "type defines the type of load balancer used by the cluster on BareMetal platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
+ "type": "string",
+ "default": "OpenShiftManagedDefault"
}
},
"x-kubernetes-unions": [
{
- "discriminator": "mode",
- "fields-to-discriminateBy": {
- "partial": "Partial"
- }
+ "discriminator": "type",
+ "fields-to-discriminateBy": {}
}
]
},
- "com.github.openshift.api.operator.v1.ManagedBootImages": {
+ "com.github.openshift.api.config.v1.BareMetalPlatformSpec": {
+ "description": "BareMetalPlatformSpec holds the desired state of the BareMetal infrastructure provider. This only includes fields that can be modified in the cluster.",
"type": "object",
"properties": {
- "machineManagers": {
- "description": "machineManagers can be used to register machine management resources for boot image updates. The Machine Config Operator will watch for changes to this list. Only one entry is permitted per type of machine management resource.",
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MachineManager"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "resource",
- "apiGroup"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.operator.v1.MyOperatorResource": {
- "description": "MyOperatorResource is an example operator configuration type\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "spec",
- "status"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "x-kubernetes-list-type": "atomic"
},
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MyOperatorResourceSpec"
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MyOperatorResourceStatus"
+ "machineNetworks": {
+ "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example \"10.0.0.0/8\" or \"fd00::/8\".",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.operator.v1.MyOperatorResourceSpec": {
+ "com.github.openshift.api.config.v1.BareMetalPlatformStatus": {
+ "description": "BareMetalPlatformStatus holds the current status of the BareMetal infrastructure provider. For more information about the network architecture used with the BareMetal platform type, see: https://github.com/openshift/installer/blob/master/docs/design/baremetal/networking-infrastructure.md",
"type": "object",
"required": [
- "managementState"
+ "apiServerInternalIPs",
+ "ingressIPs"
],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "apiServerInternalIP": {
+ "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
"type": "string"
},
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "ingressIP": {
+ "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
"type": "string"
},
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.MyOperatorResourceStatus": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
+ "x-kubernetes-list-type": "atomic"
+ },
+ "loadBalancer": {
+ "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
+ "default": {
+ "type": "OpenShiftManagedDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BareMetalPlatformLoadBalancer"
},
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "machineNetworks": {
+ "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "x-kubernetes-list-type": "atomic"
},
- "version": {
- "description": "version is the level this availability applies to",
+ "nodeDNSIP": {
+ "description": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for BareMetal deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
"type": "string"
}
}
},
- "com.github.openshift.api.operator.v1.NetFlowConfig": {
+ "com.github.openshift.api.config.v1.BasicAuthIdentityProvider": {
+ "description": "BasicAuthPasswordIdentityProvider provides identities for users authenticating using HTTP basic auth credentials",
"type": "object",
+ "required": [
+ "url"
+ ],
"properties": {
- "collectors": {
- "description": "netFlow defines the NetFlow collectors that will consume the flow data exported from OVS. It is a list of strings formatted as ip:port with a maximum of ten items",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
+ "ca": {
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
+ },
+ "tlsClientCert": {
+ "description": "tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key \"tls.crt\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "tlsClientKey": {
+ "description": "tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key \"tls.key\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "url": {
+ "description": "url is the remote URL to connect to",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.Network": {
- "description": "Network describes the cluster's desired network configuration. It is consumed by the cluster-network-operator.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.Build": {
+ "description": "Build configures the behavior of OpenShift builds for the entire cluster. This includes default settings that can be overridden in BuildConfig objects, and overrides which are applied to all builds.\n\nThe canonical name is \"cluster\"\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
+ "required": [
+ "spec"
+ ],
"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",
@@ -32097,19 +887,51 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
+ "description": "spec holds user-settable values for the build controller configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NetworkSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildSpec"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.BuildDefaults": {
+ "type": "object",
+ "properties": {
+ "defaultProxy": {
+ "description": "defaultProxy contains the default proxy settings for all build operations, including image pull/push and source download.\n\nValues can be overrode by setting the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables in the build config's strategy.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxySpec"
},
- "status": {
+ "env": {
+ "description": "env is a set of default environment variables that will be applied to the build if the specified variables do not exist on the build",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
+ }
+ },
+ "gitProxy": {
+ "description": "gitProxy contains the proxy settings for git operations only. If set, this will override any Proxy settings for all git commands, such as git clone.\n\nValues that are not set here will be inherited from DefaultProxy.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxySpec"
+ },
+ "imageLabels": {
+ "description": "imageLabels is a list of docker labels that are applied to the resulting image. User can override a default label by providing a label with the same name in their Build/BuildConfig.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageLabel"
+ }
+ },
+ "resources": {
+ "description": "resources defines resource requirements to execute the build.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NetworkStatus"
+ "$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
}
}
},
- "com.github.openshift.api.operator.v1.NetworkList": {
- "description": "NetworkList contains a list of Network configurations\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.BuildList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -32121,7 +943,7 @@
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Network"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Build"
}
},
"kind": {
@@ -32135,551 +957,322 @@
}
}
},
- "com.github.openshift.api.operator.v1.NetworkMigration": {
- "description": "NetworkMigration represents the cluster network migration configuration.",
+ "com.github.openshift.api.config.v1.BuildOverrides": {
"type": "object",
"properties": {
- "features": {
- "description": "features was previously used to configure which network plugin features would be migrated in a network type migration. DEPRECATED: network type migration is no longer supported, and setting this to a non-empty value will result in the network operator rejecting the configuration.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.FeaturesMigration"
- },
- "mode": {
- "description": "mode indicates the mode of network type migration. DEPRECATED: network type migration is no longer supported, and setting this to a non-empty value will result in the network operator rejecting the configuration.",
- "type": "string"
- },
- "mtu": {
- "description": "mtu contains the MTU migration configuration. Set this to allow changing the MTU values for the default network. If unset, the operation of changing the MTU for the default network will be rejected.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.MTUMigration"
+ "forcePull": {
+ "description": "forcePull overrides, if set, the equivalent value in the builds, i.e. false disables force pull for all builds, true enables force pull for all builds, independently of what each build specifies itself",
+ "type": "boolean"
},
- "networkType": {
- "description": "networkType was previously used when changing the default network type. DEPRECATED: network type migration is no longer supported, and setting this to a non-empty value will result in the network operator rejecting the configuration.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.NetworkSpec": {
- "description": "NetworkSpec is the top-level network configuration object.",
- "type": "object",
- "required": [
- "managementState",
- "clusterNetwork",
- "serviceNetwork",
- "defaultNetwork"
- ],
- "properties": {
- "additionalNetworks": {
- "description": "additionalNetworks is a list of extra networks to make available to pods when multiple networks are enabled.",
+ "imageLabels": {
+ "description": "imageLabels is a list of docker labels that are applied to the resulting image. If user provided a label in their Build/BuildConfig with the same name as one in this list, the user's label will be overwritten.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AdditionalNetworkDefinition"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageLabel"
+ }
},
- "additionalRoutingCapabilities": {
- "description": "additionalRoutingCapabilities describes components and relevant configuration providing additional routing capabilities. When set, it enables such components and the usage of the routing capabilities they provide for the machine network. Upstream operators, like MetalLB operator, requiring these capabilities may rely on, or automatically set this attribute. Network plugins may leverage advanced routing capabilities acquired through the enablement of these components but may require specific configuration on their side to do so; refer to their respective documentation and configuration options.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AdditionalRoutingCapabilities"
+ "nodeSelector": {
+ "description": "nodeSelector is a selector which must be true for the build pod to fit on a node",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "default": ""
+ }
},
- "clusterNetwork": {
- "description": "clusterNetwork is the IP address pool to use for pod IPs. Some network providers support multiple ClusterNetworks. Others only support one. This is equivalent to the cluster-cidr.",
+ "tolerations": {
+ "description": "tolerations is a list of Tolerations that will override any existing tolerations set on a build pod.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ClusterNetworkEntry"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "defaultNetwork": {
- "description": "defaultNetwork is the \"default\" network that all pods will receive",
+ "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
+ }
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.BuildSpec": {
+ "type": "object",
+ "properties": {
+ "additionalTrustedCA": {
+ "description": "additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted for image pushes and pulls during builds. The namespace for this config map is openshift-config.\n\nDEPRECATED: Additional CAs for image pull and push should be set on image.config.openshift.io/cluster instead.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DefaultNetworkDefinition"
- },
- "deployKubeProxy": {
- "description": "deployKubeProxy specifies whether or not a standalone kube-proxy should be deployed by the operator. Some network providers include kube-proxy or similar functionality. If unset, the plugin will attempt to select the correct value, which is false when ovn-kubernetes is used and true otherwise.",
- "type": "boolean"
- },
- "disableMultiNetwork": {
- "description": "disableMultiNetwork defaults to 'false' and this setting enables the pod multi-networking capability. disableMultiNetwork when set to 'true' at cluster install time does not install the components, typically the Multus CNI and the network-attachment-definition CRD, that enable the pod multi-networking capability. Setting the parameter to 'true' might be useful when you need install third-party CNI plugins, but these plugins are not supported by Red Hat. Changing the parameter value as a postinstallation cluster task has no effect.",
- "type": "boolean"
- },
- "disableNetworkDiagnostics": {
- "description": "disableNetworkDiagnostics specifies whether or not PodNetworkConnectivityCheck CRs from a test pod to every node, apiserver and LB should be disabled or not. If unset, this property defaults to 'false' and network diagnostics is enabled. Setting this to 'true' would reduce the additional load of the pods performing the checks.",
- "type": "boolean",
- "default": false
- },
- "exportNetworkFlows": {
- "description": "exportNetworkFlows enables and configures the export of network flow metadata from the pod network by using protocols NetFlow, SFlow or IPFIX. Currently only supported on OVN-Kubernetes plugin. If unset, flows will not be exported to any collector.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ExportNetworkFlows"
- },
- "kubeProxyConfig": {
- "description": "kubeProxyConfig lets us configure desired proxy configuration, if deployKubeProxy is true. If not specified, sensible defaults will be chosen by OpenShift directly.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ProxyConfig"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
+ "buildDefaults": {
+ "description": "buildDefaults controls the default information for Builds",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildDefaults"
},
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
+ "buildOverrides": {
+ "description": "buildOverrides controls override settings for builds",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BuildOverrides"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.CertInfo": {
+ "description": "CertInfo relates a certificate with a private key",
+ "type": "object",
+ "required": [
+ "certFile",
+ "keyFile"
+ ],
+ "properties": {
+ "certFile": {
+ "description": "certFile is a file containing a PEM-encoded certificate",
"type": "string",
"default": ""
},
- "migration": {
- "description": "migration enables and configures cluster network migration, for network changes that cannot be made instantly.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NetworkMigration"
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "serviceNetwork": {
- "description": "serviceNetwork is the ip address pool to use for Service IPs Currently, all existing network providers only support a single value here, but this is an array to allow for growth.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "useMultiNetworkPolicy": {
- "description": "useMultiNetworkPolicy enables a controller which allows for MultiNetworkPolicy objects to be used on additional networks as created by Multus CNI. MultiNetworkPolicy are similar to NetworkPolicy objects, but NetworkPolicy objects only apply to the primary interface. With MultiNetworkPolicy, you can control the traffic that a pod can receive over the secondary interfaces. If unset, this property defaults to 'false' and MultiNetworkPolicy objects are ignored. If 'disableMultiNetwork' is 'true' then the value of this field is ignored.",
- "type": "boolean"
+ "keyFile": {
+ "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.NetworkStatus": {
- "description": "NetworkStatus is detailed operator status, which is distilled up to the Network clusteroperator object.",
+ "com.github.openshift.api.config.v1.ClientConnectionOverrides": {
"type": "object",
+ "required": [
+ "acceptContentTypes",
+ "contentType",
+ "qps",
+ "burst"
+ ],
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
+ "acceptContentTypes": {
+ "description": "acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the default value of 'application/json'. This field will control all connections to the server used by a particular client.",
+ "type": "string",
+ "default": ""
},
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
+ "burst": {
+ "description": "burst allows extra queries to accumulate when a client is exceeding its rate.",
"type": "integer",
"format": "int32",
"default": 0
},
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicyClusterStatus": {
- "description": "NodeDisruptionPolicyClusterStatus is the type for the status object, rendered by the controller as a merge of cluster defaults and user provided policies",
- "type": "object",
- "properties": {
- "files": {
- "description": "files is a list of MachineConfig file definitions and actions to take to changes on those paths",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusFile"
- },
- "x-kubernetes-list-map-keys": [
- "path"
- ],
- "x-kubernetes-list-type": "map"
- },
- "sshkey": {
- "description": "sshkey is the overall sshkey MachineConfig definition",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusSSHKey"
+ "contentType": {
+ "description": "contentType is the content type used when sending data to the server from this client.",
+ "type": "string",
+ "default": ""
},
- "units": {
- "description": "units is a list MachineConfig unit definitions and actions to take on changes to those services",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusUnit"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
+ "qps": {
+ "description": "qps controls the number of queries per second allowed for this connection.",
+ "type": "number",
+ "format": "float",
+ "default": 0
}
}
},
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicyConfig": {
- "description": "NodeDisruptionPolicyConfig is the overall spec definition for files/units/sshkeys",
+ "com.github.openshift.api.config.v1.CloudControllerManagerStatus": {
+ "description": "CloudControllerManagerStatus holds the state of Cloud Controller Manager (a.k.a. CCM or CPI) related settings",
"type": "object",
"properties": {
- "files": {
- "description": "files is a list of MachineConfig file definitions and actions to take to changes on those paths This list supports a maximum of 50 entries.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecFile"
- },
- "x-kubernetes-list-map-keys": [
- "path"
- ],
- "x-kubernetes-list-type": "map"
- },
- "sshkey": {
- "description": "sshkey maps to the ignition.sshkeys field in the MachineConfig object, definition an action for this will apply to all sshkey changes in the cluster",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecSSHKey"
- },
- "units": {
- "description": "units is a list MachineConfig unit definitions and actions to take on changes to those services This list supports a maximum of 50 entries.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecUnit"
- },
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
+ "state": {
+ "description": "state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager\n\nValid values are \"External\", \"None\" and omitted. When set to \"External\", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to \"None\", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecAction": {
+ "com.github.openshift.api.config.v1.CloudLoadBalancerConfig": {
+ "description": "CloudLoadBalancerConfig contains an union discriminator indicating the type of DNS solution in use within the cluster. When the DNSType is `ClusterHosted`, the cloud's Load Balancer configuration needs to be provided so that the DNS solution hosted within the cluster can be configured with those values.",
"type": "object",
- "required": [
- "type"
- ],
"properties": {
- "reload": {
- "description": "reload specifies the service to reload, only valid if type is reload",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ReloadService"
- },
- "restart": {
- "description": "restart specifies the service to restart, only valid if type is restart",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.RestartService"
+ "clusterHosted": {
+ "description": "clusterHosted holds the IP addresses of API, API-Int and Ingress Load Balancers on Cloud Platforms. The DNS solution hosted within the cluster use these IP addresses to provide resolution for API, API-Int and Ingress services.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerIPs"
},
- "type": {
- "description": "type represents the commands that will be carried out if this NodeDisruptionPolicySpecActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload and None. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration",
+ "dnsType": {
+ "description": "dnsType indicates the type of DNS solution in use within the cluster. Its default value of `PlatformDefault` indicates that the cluster's DNS is the default provided by the cloud platform. It can be set to `ClusterHosted` to bypass the configuration of the cloud default DNS. In this mode, the cluster needs to provide a self-hosted DNS solution for the cluster's installation to succeed. The cluster's use of the cloud's Load Balancers is unaffected by this setting. The value is immutable after it has been set at install time. Currently, there is no way for the customer to add additional DNS entries into the cluster hosted DNS. Enabling this functionality allows the user to start their own DNS solution outside the cluster after installation is complete. The customer would be responsible for configuring this custom DNS solution, and it can be run in addition to the in-cluster DNS solution.",
"type": "string",
- "default": ""
+ "default": "PlatformDefault"
}
},
"x-kubernetes-unions": [
{
- "discriminator": "type",
+ "discriminator": "dnsType",
"fields-to-discriminateBy": {
- "reload": "Reload",
- "restart": "Restart"
+ "clusterHosted": "ClusterHosted"
}
}
]
},
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecFile": {
- "description": "NodeDisruptionPolicySpecFile is a file entry and corresponding actions to take and is used in the NodeDisruptionPolicyConfig object",
+ "com.github.openshift.api.config.v1.CloudLoadBalancerIPs": {
+ "description": "CloudLoadBalancerIPs contains the Load Balancer IPs for the cloud's API, API-Int and Ingress Load balancers. They will be populated as soon as the respective Load Balancers have been configured. These values are utilized to configure the DNS solution hosted within the cluster.",
"type": "object",
- "required": [
- "path",
- "actions"
- ],
"properties": {
- "actions": {
- "description": "actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.",
+ "apiIntLoadBalancerIPs": {
+ "description": "apiIntLoadBalancerIPs holds Load Balancer IPs for the internal API service. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Entries in the apiIntLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecAction"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-type": "atomic"
+ "x-kubernetes-list-type": "set"
},
- "path": {
- "description": "path is the location of a file being managed through a MachineConfig. The Actions in the policy will apply to changes to the file at this path.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecSSHKey": {
- "description": "NodeDisruptionPolicySpecSSHKey is actions to take for any SSHKey change and is used in the NodeDisruptionPolicyConfig object",
- "type": "object",
- "required": [
- "actions"
- ],
- "properties": {
- "actions": {
- "description": "actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.",
+ "apiLoadBalancerIPs": {
+ "description": "apiLoadBalancerIPs holds Load Balancer IPs for the API service. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Could be empty for private clusters. Entries in the apiLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecAction"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecUnit": {
- "description": "NodeDisruptionPolicySpecUnit is a systemd unit name and corresponding actions to take and is used in the NodeDisruptionPolicyConfig object",
- "type": "object",
- "required": [
- "name",
- "actions"
- ],
- "properties": {
- "actions": {
- "description": "actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.",
+ "x-kubernetes-list-type": "set"
+ },
+ "ingressLoadBalancerIPs": {
+ "description": "ingressLoadBalancerIPs holds IPs for Ingress Load Balancers. These Load Balancer IP addresses can be IPv4 and/or IPv6 addresses. Entries in the ingressLoadBalancerIPs must be unique. A maximum of 16 IP addresses are permitted.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicySpecAction"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-type": "atomic"
- },
- "name": {
- "description": "name represents the service name of a systemd service managed through a MachineConfig Actions specified will be applied for changes to the named service. Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, \":\", \"-\", \"_\", \".\", and \"\\\". ${SERVICETYPE} must be one of \".service\", \".socket\", \".device\", \".mount\", \".automount\", \".swap\", \".target\", \".path\", \".timer\", \".snapshot\", \".slice\" or \".scope\".",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatus": {
- "type": "object",
- "properties": {
- "clusterPolicies": {
- "description": "clusterPolicies is a merge of cluster default and user provided node disruption policies.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyClusterStatus"
+ "x-kubernetes-list-type": "set"
}
}
},
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusAction": {
+ "com.github.openshift.api.config.v1.ClusterCondition": {
+ "description": "ClusterCondition is a union of typed cluster conditions. The 'type' property determines which of the type-specific properties are relevant. When evaluated on a cluster, the condition may match, not match, or fail to evaluate.",
"type": "object",
"required": [
"type"
],
"properties": {
- "reload": {
- "description": "reload specifies the service to reload, only valid if type is reload",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ReloadService"
- },
- "restart": {
- "description": "restart specifies the service to restart, only valid if type is restart",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.RestartService"
+ "promql": {
+ "description": "promql represents a cluster condition based on PromQL.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PromQLClusterCondition"
},
"type": {
- "description": "type represents the commands that will be carried out if this NodeDisruptionPolicyStatusActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload, None and Special. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration",
+ "description": "type represents the cluster-condition type. This defines the members and semantics of any additional properties.",
"type": "string",
"default": ""
}
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "type",
- "fields-to-discriminateBy": {
- "reload": "Reload",
- "restart": "Restart"
- }
- }
- ]
+ }
},
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusFile": {
- "description": "NodeDisruptionPolicyStatusFile is a file entry and corresponding actions to take and is used in the NodeDisruptionPolicyClusterStatus object",
+ "com.github.openshift.api.config.v1.ClusterImagePolicy": {
+ "description": "ClusterImagePolicy holds cluster-wide configuration for image signature verification\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "path",
- "actions"
+ "spec"
],
"properties": {
- "actions": {
- "description": "actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusAction"
- },
- "x-kubernetes-list-type": "atomic"
+ "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",
+ "type": "string"
},
- "path": {
- "description": "path is the location of a file being managed through a MachineConfig. The Actions in the policy will apply to changes to the file at this path.",
- "type": "string",
- "default": ""
+ "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",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ },
+ "spec": {
+ "description": "spec contains the configuration for the cluster image policy.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterImagePolicySpec"
+ },
+ "status": {
+ "description": "status contains the observed state of the resource.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterImagePolicyStatus"
}
}
},
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusSSHKey": {
- "description": "NodeDisruptionPolicyStatusSSHKey is actions to take for any SSHKey change and is used in the NodeDisruptionPolicyClusterStatus object",
+ "com.github.openshift.api.config.v1.ClusterImagePolicyList": {
+ "description": "ClusterImagePolicyList is a list of ClusterImagePolicy resources\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "actions"
+ "metadata",
+ "items"
],
"properties": {
- "actions": {
- "description": "actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.",
+ "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",
+ "type": "string"
+ },
+ "items": {
+ "description": "items is a list of ClusterImagePolices",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusAction"
- },
- "x-kubernetes-list-type": "atomic"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterImagePolicy"
+ }
+ },
+ "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",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusUnit": {
- "description": "NodeDisruptionPolicyStatusUnit is a systemd unit name and corresponding actions to take and is used in the NodeDisruptionPolicyClusterStatus object",
+ "com.github.openshift.api.config.v1.ClusterImagePolicySpec": {
+ "description": "CLusterImagePolicySpec is the specification of the ClusterImagePolicy custom resource.",
"type": "object",
"required": [
- "name",
- "actions"
+ "scopes",
+ "policy"
],
"properties": {
- "actions": {
- "description": "actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.",
+ "policy": {
+ "description": "policy is a required field that contains configuration to allow scopes to be verified, and defines how images not matching the verification policy will be treated.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Policy"
+ },
+ "scopes": {
+ "description": "scopes is a required field that defines the list of image identities assigned to a policy. Each item refers to a scope in a registry implementing the \"Docker Registry HTTP API V2\". Scopes matching individual images are named Docker references in the fully expanded form, either using a tag or digest. For example, docker.io/library/busybox:latest (not busybox:latest). More general scopes are prefixes of individual-image scopes, and specify a repository (by omitting the tag or digest), a repository namespace, or a registry host (by only specifying the host name and possibly a port number) or a wildcard expression starting with `*.`, for matching all subdomains (not including a port number). Wildcards are only supported for subdomain matching, and may not be used in the middle of the host, i.e. *.example.com is a valid case, but example*.*.com is not. This support no more than 256 scopes in one object. If multiple scopes match a given image, only the policy requirements for the most specific scope apply. The policy requirements for more general scopes are ignored. In addition to setting a policy appropriate for your own deployed applications, make sure that a policy on the OpenShift image repositories quay.io/openshift-release-dev/ocp-release, quay.io/openshift-release-dev/ocp-v4.0-art-dev (or on a more general scope) allows deployment of the OpenShift images required for cluster operation. If a scope is configured in both the ClusterImagePolicy and the ImagePolicy, or if the scope in ImagePolicy is nested under one of the scopes from the ClusterImagePolicy, only the policy from the ClusterImagePolicy will be applied. For additional details about the format, please refer to the document explaining the docker transport field, which can be found at: https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md#docker",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeDisruptionPolicyStatusAction"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-type": "atomic"
- },
- "name": {
- "description": "name represents the service name of a systemd service managed through a MachineConfig Actions specified will be applied for changes to the named service. Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, \":\", \"-\", \"_\", \".\", and \"\\\". ${SERVICETYPE} must be one of \".service\", \".socket\", \".device\", \".mount\", \".automount\", \".swap\", \".target\", \".path\", \".timer\", \".snapshot\", \".slice\" or \".scope\".",
- "type": "string",
- "default": ""
+ "x-kubernetes-list-type": "set"
}
}
},
- "com.github.openshift.api.operator.v1.NodePlacement": {
- "description": "NodePlacement describes node scheduling configuration for an ingress controller.",
+ "com.github.openshift.api.config.v1.ClusterImagePolicyStatus": {
"type": "object",
"properties": {
- "nodeSelector": {
- "description": "nodeSelector is the node selector applied to ingress controller deployments.\n\nIf set, the specified selector is used and replaces the default.\n\nIf unset, the default depends on the value of the defaultPlacement field in the cluster config.openshift.io/v1/ingresses status.\n\nWhen defaultPlacement is Workers, the default is:\n\n kubernetes.io/os: linux\n node-role.kubernetes.io/worker: ''\n\nWhen defaultPlacement is ControlPlane, the default is:\n\n kubernetes.io/os: linux\n node-role.kubernetes.io/master: ''\n\nThese defaults are subject to change.\n\nNote that using nodeSelector.matchExpressions is not supported. Only nodeSelector.matchLabels may be used. This is a limitation of the Kubernetes API: the pod spec does not allow complex expressions for node selectors.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
- },
- "tolerations": {
- "description": "tolerations is a list of tolerations applied to ingress controller deployments.\n\nThe default is an empty list.\n\nSee https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
+ "conditions": {
+ "description": "conditions provide details on the status of this API Resource.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
},
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.NodePortStrategy": {
- "description": "NodePortStrategy holds parameters for the NodePortService endpoint publishing strategy.",
- "type": "object",
- "properties": {
- "protocol": {
- "description": "protocol specifies whether the IngressController expects incoming connections to use plain TCP or whether the IngressController expects PROXY protocol.\n\nPROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController. Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs. Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController. See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol.\n\nThe following values are valid for this field:\n\n* The empty string. * \"TCP\". * \"PROXY\".\n\nThe empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change.",
- "type": "string"
+ "x-kubernetes-list-map-keys": [
+ "type"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.operator.v1.NodeStatus": {
- "description": "NodeStatus provides information about the current state of a particular node managed by this operator.",
+ "com.github.openshift.api.config.v1.ClusterNetworkEntry": {
+ "description": "ClusterNetworkEntry is a contiguous block of IP addresses from which pod IPs are allocated.",
"type": "object",
"required": [
- "nodeName"
+ "cidr"
],
"properties": {
- "currentRevision": {
- "description": "currentRevision is the generation of the most recently successful deployment. Can not be set on creation of a nodeStatus. Updates must only increase the value.",
- "type": "integer",
- "format": "int32"
- },
- "lastFailedCount": {
- "description": "lastFailedCount is how often the installer pod of the last failed revision failed.",
- "type": "integer",
- "format": "int32"
- },
- "lastFailedReason": {
- "description": "lastFailedReason is a machine readable failure reason string.",
- "type": "string"
- },
- "lastFailedRevision": {
- "description": "lastFailedRevision is the generation of the deployment we tried and failed to deploy.",
- "type": "integer",
- "format": "int32"
- },
- "lastFailedRevisionErrors": {
- "description": "lastFailedRevisionErrors is a list of human readable errors during the failed deployment referenced in lastFailedRevision.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "lastFailedTime": {
- "description": "lastFailedTime is the time the last failed revision failed the last time.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "lastFallbackCount": {
- "description": "lastFallbackCount is how often a fallback to a previous revision happened.",
- "type": "integer",
- "format": "int32"
- },
- "nodeName": {
- "description": "nodeName is the name of the node",
+ "cidr": {
+ "description": "The complete block for pod IPs.",
"type": "string",
"default": ""
},
- "targetRevision": {
- "description": "targetRevision is the generation of the deployment we're trying to apply. Can not be set on creation of a nodeStatus.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.operator.v1.OAuthAPIServerStatus": {
- "type": "object",
- "properties": {
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the latest revision used as suffix of revisioned secrets like encryption-config. A new revision causes a new deployment of pods.",
+ "hostPrefix": {
+ "description": "The size (prefix) of block to allocate to each node. If this field is not used by the plugin, it can be left unset.",
"type": "integer",
- "format": "int32"
+ "format": "int64"
}
}
},
- "com.github.openshift.api.operator.v1.OLM": {
- "description": "OLM provides information to configure an operator to manage the OLM controllers\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ClusterOperator": {
+ "description": "ClusterOperator holds the status of a core or optional OpenShift component managed by the Cluster Version Operator (CVO). This object is used by operators to convey their state to the rest of the cluster. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -32700,19 +1293,19 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec holds user settable values for configuration",
+ "description": "spec holds configuration that could apply to any operator.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OLMSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorSpec"
},
"status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
+ "description": "status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OLMStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorStatus"
}
}
},
- "com.github.openshift.api.operator.v1.OLMList": {
- "description": "OLMList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ClusterOperatorList": {
+ "description": "ClusterOperatorList is a list of OperatorStatus resources.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -32724,11 +1317,10 @@
"type": "string"
},
"items": {
- "description": "items contains the items",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OLM"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperator"
}
},
"kind": {
@@ -32742,152 +1334,87 @@
}
}
},
- "com.github.openshift.api.operator.v1.OLMSpec": {
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
+ "com.github.openshift.api.config.v1.ClusterOperatorSpec": {
+ "description": "ClusterOperatorSpec is empty for now, but you could imagine holding information like \"pause\".",
+ "type": "object"
},
- "com.github.openshift.api.operator.v1.OLMStatus": {
+ "com.github.openshift.api.config.v1.ClusterOperatorStatus": {
+ "description": "ClusterOperatorStatus provides information about the status of the operator.",
"type": "object",
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "conditions": {
+ "description": "conditions describes the state of the operator's managed and monitored components.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorStatusCondition"
},
"x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
+ "type"
],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
+ "x-kubernetes-list-type": "map",
+ "x-kubernetes-patch-merge-key": "type",
+ "x-kubernetes-patch-strategy": "merge"
},
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
+ "extension": {
+ "description": "extension contains any additional status information specific to the operator which owns this status object.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
},
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "relatedObjects": {
+ "description": "relatedObjects is a list of objects that are \"interesting\" or related to this operator. Common uses are: 1. the detailed resource driving the operator 2. operator namespaces 3. operand namespaces",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ObjectReference"
+ }
},
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
+ "versions": {
+ "description": "versions is a slice of operator and operand version tuples. Operators which manage multiple operands will have multiple operand entries in the array. Available operators must report the version of the operator itself with the name \"operator\". An operator reports a new \"operator\" version when it has rolled out the new version to all of its operands.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OperandVersion"
+ }
}
}
},
- "com.github.openshift.api.operator.v1.OVNKubernetesConfig": {
- "description": "ovnKubernetesConfig contains the configuration parameters for networks using the ovn-kubernetes network project",
+ "com.github.openshift.api.config.v1.ClusterOperatorStatusCondition": {
+ "description": "ClusterOperatorStatusCondition represents the state of the operator's managed and monitored components.",
"type": "object",
+ "required": [
+ "type",
+ "status",
+ "lastTransitionTime"
+ ],
"properties": {
- "egressIPConfig": {
- "description": "egressIPConfig holds the configuration for EgressIP options.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.EgressIPConfig"
- },
- "gatewayConfig": {
- "description": "gatewayConfig holds the configuration for node gateway options.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GatewayConfig"
- },
- "genevePort": {
- "description": "geneve port is the UDP port to be used by geneve encapulation. Default is 6081",
- "type": "integer",
- "format": "int64"
- },
- "hybridOverlayConfig": {
- "description": "hybridOverlayConfig configures an additional overlay network for peers that are not using OVN.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.HybridOverlayConfig"
- },
- "ipsecConfig": {
- "description": "ipsecConfig enables and configures IPsec for pods on the pod network within the cluster.",
- "default": {
- "mode": "Disabled"
- },
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPsecConfig"
- },
- "ipv4": {
- "description": "ipv4 allows users to configure IP settings for IPv4 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPv4OVNKubernetesConfig"
- },
- "ipv6": {
- "description": "ipv6 allows users to configure IP settings for IPv6 connections. When ommitted, this means no opinions and the default configuration is used. Check individual fields within ipv4 for details of default values.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPv6OVNKubernetesConfig"
- },
- "mtu": {
- "description": "mtu is the MTU to use for the tunnel interface. This must be 100 bytes smaller than the uplink mtu. Default is 1400",
- "type": "integer",
- "format": "int64"
- },
- "policyAuditConfig": {
- "description": "policyAuditConfig is the configuration for network policy audit events. If unset, reported defaults are used.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.PolicyAuditConfig"
+ "lastTransitionTime": {
+ "description": "lastTransitionTime is the time of the last update to the current status property.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
},
- "routeAdvertisements": {
- "description": "routeAdvertisements determines if the functionality to advertise cluster network routes through a dynamic routing protocol, such as BGP, is enabled or not. This functionality is configured through the ovn-kubernetes RouteAdvertisements CRD. Requires the 'FRR' routing capability provider to be enabled as an additional routing capability. Allowed values are \"Enabled\", \"Disabled\" and ommited. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is \"Disabled\".",
+ "message": {
+ "description": "message provides additional information about the current condition. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
"type": "string"
},
- "v4InternalSubnet": {
- "description": "v4InternalSubnet is a v4 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. Default is 100.64.0.0/16",
+ "reason": {
+ "description": "reason is the CamelCase reason for the condition's current status.",
"type": "string"
},
- "v6InternalSubnet": {
- "description": "v6InternalSubnet is a v6 subnet used internally by ovn-kubernetes in case the default one is being already used by something else. It must not overlap with any other subnet being used by OpenShift or by the node network. The size of the subnet must be larger than the number of nodes. Default is fd98::/64",
- "type": "string"
+ "status": {
+ "description": "status of the condition, one of True, False, Unknown.",
+ "type": "string",
+ "default": ""
+ },
+ "type": {
+ "description": "type specifies the aspect reported by this condition.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftAPIServer": {
- "description": "OpenShiftAPIServer provides information to configure an operator to manage openshift-apiserver.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ClusterVersion": {
+ "description": "ClusterVersion is the configuration for the ClusterVersionOperator. This is where parameters related to automatic updates can be set.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "metadata",
"spec"
],
"properties": {
@@ -32905,19 +1432,62 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec is the specification of the desired behavior of the OpenShift API Server.",
+ "description": "spec is the desired state of the cluster version - the operator will work to ensure that the desired version is applied to the cluster.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenShiftAPIServerSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionSpec"
},
"status": {
- "description": "status defines the observed status of the OpenShift API Server.",
+ "description": "status contains information about the available updates and any in-progress updates.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenShiftAPIServerStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionStatus"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.ClusterVersionCapabilitiesSpec": {
+ "description": "ClusterVersionCapabilitiesSpec selects the managed set of optional, core cluster components.",
+ "type": "object",
+ "properties": {
+ "additionalEnabledCapabilities": {
+ "description": "additionalEnabledCapabilities extends the set of managed capabilities beyond the baseline defined in baselineCapabilitySet. The default is an empty set.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "baselineCapabilitySet": {
+ "description": "baselineCapabilitySet selects an initial set of optional capabilities to enable, which can be extended via additionalEnabledCapabilities. If unset, the cluster will choose a default, and the default may change over time. The current default is vCurrent.",
+ "type": "string"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.ClusterVersionCapabilitiesStatus": {
+ "description": "ClusterVersionCapabilitiesStatus describes the state of optional, core cluster components.",
+ "type": "object",
+ "properties": {
+ "enabledCapabilities": {
+ "description": "enabledCapabilities lists all the capabilities that are currently managed.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "knownCapabilities": {
+ "description": "knownCapabilities lists all the capabilities known to the current cluster.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftAPIServerList": {
- "description": "OpenShiftAPIServerList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ClusterVersionList": {
+ "description": "ClusterVersionList is a list of ClusterVersion resources.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -32929,11 +1499,10 @@
"type": "string"
},
"items": {
- "description": "items contains the items",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenShiftAPIServer"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersion"
}
},
"kind": {
@@ -32947,555 +1516,611 @@
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftAPIServerSpec": {
+ "com.github.openshift.api.config.v1.ClusterVersionSpec": {
+ "description": "ClusterVersionSpec is the desired version state of the cluster. It includes the version the cluster should be at, how the cluster is identified, and where the cluster should look for version updates.",
"type": "object",
"required": [
- "managementState"
+ "clusterID"
],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "capabilities": {
+ "description": "capabilities configures the installation of optional, core cluster components. A null value here is identical to an empty object; see the child properties for default semantics.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionCapabilitiesSpec"
+ },
+ "channel": {
+ "description": "channel is an identifier for explicitly requesting a non-default set of updates to be applied to this cluster. The default channel will contain stable updates that are appropriate for production clusters.",
"type": "string"
},
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
+ "clusterID": {
+ "description": "clusterID uniquely identifies this cluster. This is expected to be an RFC4122 UUID value (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx in hexadecimal values). This is a required field.",
"type": "string",
"default": ""
},
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "desiredUpdate": {
+ "description": "desiredUpdate is an optional field that indicates the desired value of the cluster version. Setting this value will trigger an upgrade (if the current version does not match the desired version). The set of recommended update values is listed as part of available updates in status, and setting values outside that range may cause the upgrade to fail.\n\nSome of the fields are inter-related with restrictions and meanings described here. 1. image is specified, version is specified, architecture is specified. API validation error. 2. image is specified, version is specified, architecture is not specified. The version extracted from the referenced image must match the specified version. 3. image is specified, version is not specified, architecture is specified. API validation error. 4. image is specified, version is not specified, architecture is not specified. image is used. 5. image is not specified, version is specified, architecture is specified. version and desired architecture are used to select an image. 6. image is not specified, version is specified, architecture is not specified. version and current architecture are used to select an image. 7. image is not specified, version is not specified, architecture is specified. API validation error. 8. image is not specified, version is not specified, architecture is not specified. API validation error.\n\nIf an upgrade fails the operator will halt and report status about the failing component. Setting the desired update value back to the previous version will cause a rollback to be attempted if the previous version is within the current minor version. Not all rollbacks will succeed, and some may unrecoverably break the cluster.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Update"
},
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
+ "overrides": {
+ "description": "overrides is list of overides for components that are managed by cluster version operator. Marking a component unmanaged will prevent the operator from creating or updating the object.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ComponentOverride"
+ },
+ "x-kubernetes-list-map-keys": [
+ "kind",
+ "group",
+ "namespace",
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
},
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "signatureStores": {
+ "description": "signatureStores contains the upstream URIs to verify release signatures and optional reference to a config map by name containing the PEM-encoded CA bundle.\n\nBy default, CVO will use existing signature stores if this property is empty. The CVO will check the release signatures in the local ConfigMaps first. It will search for a valid signature in these stores in parallel only when local ConfigMaps did not include a valid signature. Validation will fail if none of the signature stores reply with valid signature before timeout. Setting signatureStores will replace the default signature stores with custom signature stores. Default stores can be used with custom signature stores by adding them manually.\n\nA maximum of 32 signature stores may be configured.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SignatureStore"
+ },
+ "x-kubernetes-list-map-keys": [
+ "url"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "upstream": {
+ "description": "upstream may be used to specify the preferred update server. By default it will use the appropriate update server for the cluster and region.",
+ "type": "string"
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftAPIServerStatus": {
+ "com.github.openshift.api.config.v1.ClusterVersionStatus": {
+ "description": "ClusterVersionStatus reports the status of the cluster versioning, including any upgrades that are in progress. The current field will be set to whichever version the cluster is reconciling to, and the conditions array will report whether the update succeeded, is in progress, or is failing.",
"type": "object",
+ "required": [
+ "desired",
+ "observedGeneration",
+ "versionHash",
+ "availableUpdates"
+ ],
"properties": {
+ "availableUpdates": {
+ "description": "availableUpdates contains updates recommended for this cluster. Updates which appear in conditionalUpdates but not in availableUpdates may expose this cluster to known issues. This list may be empty if no updates are recommended, if the update service is unavailable, or if an invalid channel has been specified.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Release"
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "capabilities": {
+ "description": "capabilities describes the state of optional, core cluster components.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterVersionCapabilitiesStatus"
+ },
+ "conditionalUpdates": {
+ "description": "conditionalUpdates contains the list of updates that may be recommended for this cluster if it meets specific required conditions. Consumers interested in the set of updates that are actually recommended for this cluster should use availableUpdates. This list may be empty if no updates are recommended, if the update service is unavailable, or if an empty or invalid channel has been specified.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConditionalUpdate"
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
"conditions": {
- "description": "conditions is a list of conditions and their status",
+ "description": "conditions provides information about the cluster version. The condition \"Available\" is set to true if the desiredUpdate has been reached. The condition \"Progressing\" is set to true if an update is being applied. The condition \"Degraded\" is set to true if an update is currently blocked by a temporary or permanent error. Conditions are only valid for the current desiredUpdate when metadata.generation is equal to status.generation.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterOperatorStatusCondition"
},
"x-kubernetes-list-map-keys": [
"type"
],
- "x-kubernetes-list-type": "map"
+ "x-kubernetes-list-type": "map",
+ "x-kubernetes-patch-merge-key": "type",
+ "x-kubernetes-patch-strategy": "merge"
},
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "desired": {
+ "description": "desired is the version that the cluster is reconciling towards. If the cluster is not yet fully initialized desired will be set with the information available, which may be an image or a tag.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Release"
+ },
+ "history": {
+ "description": "history contains a list of the most recent versions applied to the cluster. This value may be empty during cluster startup, and then will be updated when a new update is being applied. The newest update is first in the list and it is ordered by recency. Updates in the history have state Completed if the rollout completed - if an update was failing or halfway applied the state will be Partial. Only a limited amount of update history is preserved.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.UpdateHistory"
},
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
+ "x-kubernetes-list-type": "atomic"
},
"observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
+ "description": "observedGeneration reports which version of the spec is being synced. If this value is not equal to metadata.generation, then the desired and conditions fields may represent a previous version.",
"type": "integer",
- "format": "int32",
+ "format": "int64",
"default": 0
},
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
+ "versionHash": {
+ "description": "versionHash is a fingerprint of the content that the cluster will be updated with. It is used by the operator to avoid unnecessary work and is for internal use only.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftControllerManager": {
- "description": "OpenShiftControllerManager provides information to configure an operator to manage openshift-controller-manager.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ComponentOverride": {
+ "description": "ComponentOverride allows overriding cluster version operator's behavior for a component.",
"type": "object",
"required": [
- "metadata",
- "spec"
+ "kind",
+ "group",
+ "namespace",
+ "name",
+ "unmanaged"
],
"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",
- "type": "string"
+ "group": {
+ "description": "group identifies the API group that the kind is in.",
+ "type": "string",
+ "default": ""
},
"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",
- "type": "string"
+ "description": "kind indentifies which object to override.",
+ "type": "string",
+ "default": ""
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "name": {
+ "description": "name is the component's name.",
+ "type": "string",
+ "default": ""
},
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenShiftControllerManagerSpec"
+ "namespace": {
+ "description": "namespace is the component's namespace. If the resource is cluster scoped, the namespace should be empty.",
+ "type": "string",
+ "default": ""
},
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenShiftControllerManagerStatus"
+ "unmanaged": {
+ "description": "unmanaged controls if cluster version operator should stop managing the resources in this cluster. Default: false",
+ "type": "boolean",
+ "default": false
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftControllerManagerList": {
- "description": "OpenShiftControllerManagerList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ComponentRouteSpec": {
+ "description": "ComponentRouteSpec allows for configuration of a route's hostname and serving certificate.",
"type": "object",
"required": [
- "metadata",
- "items"
+ "namespace",
+ "name",
+ "hostname"
],
"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",
- "type": "string"
+ "hostname": {
+ "description": "hostname is the hostname that should be used by the route.",
+ "type": "string",
+ "default": ""
},
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenShiftControllerManager"
- }
+ "name": {
+ "description": "name is the logical name of the route to customize.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of status.componentRoutes if the route is to be customized.",
+ "type": "string",
+ "default": ""
},
- "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",
- "type": "string"
+ "namespace": {
+ "description": "namespace is the namespace of the route to customize.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of status.componentRoutes if the route is to be customized.",
+ "type": "string",
+ "default": ""
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "servingCertKeyPairSecret": {
+ "description": "servingCertKeyPairSecret is a reference to a secret of type `kubernetes.io/tls` in the openshift-config namespace. The serving cert/key pair must match and will be used by the operator to fulfill the intent of serving with this name. If the custom hostname uses the default routing suffix of the cluster, the Secret specification for a serving certificate will not be needed.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftControllerManagerSpec": {
+ "com.github.openshift.api.config.v1.ComponentRouteStatus": {
+ "description": "ComponentRouteStatus contains information allowing configuration of a route's hostname and serving certificate.",
"type": "object",
"required": [
- "managementState"
+ "namespace",
+ "name",
+ "defaultHostname",
+ "relatedObjects"
],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
+ "conditions": {
+ "description": "conditions are used to communicate the state of the componentRoutes entry.\n\nSupported conditions include Available, Degraded and Progressing.\n\nIf available is true, the content served by the route can be accessed by users. This includes cases where a default may continue to serve content while the customized route specified by the cluster-admin is being configured.\n\nIf Degraded is true, that means something has gone wrong trying to handle the componentRoutes entry. The currentHostnames field may or may not be in effect.\n\nIf Progressing is true, that means the component is taking some action related to the componentRoutes entry.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
+ },
+ "x-kubernetes-list-map-keys": [
+ "type"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "consumingUsers": {
+ "description": "consumingUsers is a slice of ServiceAccounts that need to have read permission on the servingCertKeyPairSecret secret.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "currentHostnames": {
+ "description": "currentHostnames is the list of current names used by the route. Typically, this list should consist of a single hostname, but if multiple hostnames are supported by the route the operator may write multiple entries to this list.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
},
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
+ "defaultHostname": {
+ "description": "defaultHostname is the hostname of this route prior to customization.",
"type": "string",
"default": ""
},
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "name": {
+ "description": "name is the logical name of the route to customize. It does not have to be the actual name of a route resource but it cannot be renamed.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of spec.componentRoutes if the route is to be customized.",
+ "type": "string",
+ "default": ""
},
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
+ "namespace": {
+ "description": "namespace is the namespace of the route to customize. It must be a real namespace. Using an actual namespace ensures that no two components will conflict and the same component can be installed multiple times.\n\nThe namespace and name of this componentRoute must match a corresponding entry in the list of spec.componentRoutes if the route is to be customized.",
+ "type": "string",
+ "default": ""
},
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "relatedObjects": {
+ "description": "relatedObjects is a list of resources which are useful when debugging or inspecting how spec.componentRoutes is applied.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ObjectReference"
+ }
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftControllerManagerStatus": {
+ "com.github.openshift.api.config.v1.ConditionalUpdate": {
+ "description": "ConditionalUpdate represents an update which is recommended to some clusters on the version the current cluster is reconciling, but which may not be recommended for the current cluster.",
"type": "object",
+ "required": [
+ "release",
+ "risks"
+ ],
"properties": {
"conditions": {
- "description": "conditions is a list of conditions and their status",
+ "description": "conditions represents the observations of the conditional update's current status. Known types are: * Recommended, for whether the update is recommended for the current cluster.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
},
"x-kubernetes-list-map-keys": [
"type"
],
"x-kubernetes-list-type": "map"
},
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "release": {
+ "description": "release is the target of the update.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Release"
+ },
+ "risks": {
+ "description": "risks represents the range of issues associated with updating to the target release. The cluster-version operator will evaluate all entries, and only recommend the update if there is at least one entry and all entries recommend the update.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConditionalUpdateRisk"
},
"x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
"name"
],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
+ "x-kubernetes-list-type": "map",
+ "x-kubernetes-patch-merge-key": "name",
+ "x-kubernetes-patch-strategy": "merge"
}
}
},
- "com.github.openshift.api.operator.v1.OpenShiftSDNConfig": {
- "description": "OpenShiftSDNConfig was used to configure the OpenShift SDN plugin. It is no longer used.",
+ "com.github.openshift.api.config.v1.ConditionalUpdateRisk": {
+ "description": "ConditionalUpdateRisk represents a reason and cluster-state for not recommending a conditional update.",
"type": "object",
"required": [
- "mode"
+ "url",
+ "name",
+ "message",
+ "matchingRules"
],
"properties": {
- "enableUnidling": {
- "description": "enableUnidling controls whether or not the service proxy will support idling and unidling of services. By default, unidling is enabled.",
- "type": "boolean"
+ "matchingRules": {
+ "description": "matchingRules is a slice of conditions for deciding which clusters match the risk and which do not. The slice is ordered by decreasing precedence. The cluster-version operator will walk the slice in order, and stop after the first it can successfully evaluate. If no condition can be successfully evaluated, the update will not be recommended.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterCondition"
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "mode": {
- "description": "mode is one of \"Multitenant\", \"Subnet\", or \"NetworkPolicy\"",
+ "message": {
+ "description": "message provides additional information about the risk of updating, in the event that matchingRules match the cluster state. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
"type": "string",
"default": ""
},
- "mtu": {
- "description": "mtu is the mtu to use for the tunnel interface. Defaults to 1450 if unset. This must be 50 bytes smaller than the machine's uplink.",
- "type": "integer",
- "format": "int64"
- },
- "useExternalOpenvswitch": {
- "description": "useExternalOpenvswitch used to control whether the operator would deploy an OVS DaemonSet itself or expect someone else to start OVS. As of 4.6, OVS is always run as a system service, and this flag is ignored.",
- "type": "boolean"
+ "name": {
+ "description": "name is the CamelCase reason for not recommending a conditional update, in the event that matchingRules match the cluster state.",
+ "type": "string",
+ "default": ""
},
- "vxlanPort": {
- "description": "vxlanPort is the port to use for all vxlan packets. The default is 4789.",
- "type": "integer",
- "format": "int64"
+ "url": {
+ "description": "url contains information about this risk.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.OpenStackLoadBalancerParameters": {
- "description": "OpenStackLoadBalancerParameters provides configuration settings that are specific to OpenStack load balancers.",
+ "com.github.openshift.api.config.v1.ConfigMapFileReference": {
+ "description": "ConfigMapFileReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
"type": "object",
+ "required": [
+ "name"
+ ],
"properties": {
- "floatingIP": {
- "description": "floatingIP specifies the IP address that the load balancer will use. When not specified, an IP address will be assigned randomly by the OpenStack cloud provider. When specified, the floating IP has to be pre-created. If the specified value is not a floating IP or is already claimed, the OpenStack cloud provider won't be able to provision the load balancer. This field may only be used if the IngressController has External scope. This value must be a valid IPv4 or IPv6 address.",
+ "key": {
+ "description": "key allows pointing to a specific key/value inside of the configmap. This is useful for logical file references.",
"type": "string"
+ },
+ "name": {
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.OperatorCondition": {
- "description": "OperatorCondition is just the standard condition fields.",
+ "com.github.openshift.api.config.v1.ConfigMapNameReference": {
+ "description": "ConfigMapNameReference references a config map in a specific namespace. The namespace must be specified at the point of use.",
"type": "object",
"required": [
- "type",
- "status",
- "lastTransitionTime"
+ "name"
],
"properties": {
- "lastTransitionTime": {
- "description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
+ "name": {
+ "description": "name is the metadata.name of the referenced config map",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.Console": {
+ "description": "Console holds cluster-wide configuration for the web console, including the logout URL, and reports the public URL of the console. The canonical name is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "type": "object",
+ "required": [
+ "spec"
+ ],
+ "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",
+ "type": "string"
},
- "message": {
+ "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",
"type": "string"
},
- "reason": {
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ },
+ "spec": {
+ "description": "spec holds user settable values for configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConsoleSpec"
+ },
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConsoleStatus"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.ConsoleAuthentication": {
+ "description": "ConsoleAuthentication defines a list of optional configuration for console authentication.",
+ "type": "object",
+ "properties": {
+ "logoutRedirect": {
+ "description": "An optional, absolute URL to redirect web browsers to after logging out of the console. If not specified, it will redirect to the default login page. This is required when using an identity provider that supports single sign-on (SSO) such as: - OpenID (Keycloak, Azure) - RequestHeader (GSSAPI, SSPI, SAML) - OAuth (GitHub, GitLab, Google) Logging out of the console will destroy the user's token. The logoutRedirect provides the user the option to perform single logout (SLO) through the identity provider to destroy their single sign-on session.",
"type": "string"
- },
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type of condition in CamelCase or in foo.example.com/CamelCase.",
- "type": "string",
- "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.OperatorSpec": {
- "description": "OperatorSpec contains common fields operators need. It is intended to be anonymous included inside of the Spec struct for your particular operator.",
+ "com.github.openshift.api.config.v1.ConsoleList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "managementState"
+ "metadata",
+ "items"
],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "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",
"type": "string"
},
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "items": {
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Console"
+ }
},
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "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",
"type": "string"
},
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.operator.v1.OperatorStatus": {
+ "com.github.openshift.api.config.v1.ConsoleSpec": {
+ "description": "ConsoleSpec is the specification of the desired behavior of the Console.",
"type": "object",
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
+ "authentication": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConsoleAuthentication"
}
}
},
- "com.github.openshift.api.operator.v1.PartialSelector": {
- "description": "PartialSelector provides label selector(s) that can be used to match machine management resources.",
+ "com.github.openshift.api.config.v1.ConsoleStatus": {
+ "description": "ConsoleStatus defines the observed status of the Console.",
"type": "object",
- "required": [
- "machineResourceSelector"
- ],
"properties": {
- "machineResourceSelector": {
- "description": "machineResourceSelector is a label selector that can be used to select machine resources like MachineSets.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
+ "consoleURL": {
+ "description": "The URL for the console. This will be derived from the host for the route that is created for the console.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.Perspective": {
- "description": "Perspective defines a perspective that cluster admins want to show/hide in the perspective switcher dropdown",
+ "com.github.openshift.api.config.v1.Custom": {
+ "description": "Custom provides the custom configuration of gatherers",
"type": "object",
"required": [
- "id",
- "visibility"
+ "configs"
],
"properties": {
- "id": {
- "description": "id defines the id of the perspective. Example: \"dev\", \"admin\". The available perspective ids can be found in the code snippet section next to the yaml editor. Incorrect or unknown ids will be ignored.",
- "type": "string",
- "default": ""
- },
- "pinnedResources": {
- "description": "pinnedResources defines the list of default pinned resources that users will see on the perspective navigation if they have not customized these pinned resources themselves. The list of available Kubernetes resources could be read via `kubectl api-resources`. The console will also provide a configuration UI and a YAML snippet that will list the available resources that can be pinned to the navigation. Incorrect or unknown resources will be ignored.",
+ "configs": {
+ "description": "configs is a required list of gatherers configurations that can be used to enable or disable specific gatherers. It may not exceed 100 items and each gatherer can be present only once. It is possible to disable an entire set of gatherers while allowing a specific function within that set. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.PinnedResourceReference"
- }
- },
- "visibility": {
- "description": "visibility defines the state of perspective along with access review checks if needed for that perspective.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.PerspectiveVisibility"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GathererConfig"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.operator.v1.PerspectiveVisibility": {
- "description": "PerspectiveVisibility defines the criteria to show/hide a perspective",
+ "com.github.openshift.api.config.v1.CustomFeatureGates": {
"type": "object",
- "required": [
- "state"
- ],
"properties": {
- "accessReview": {
- "description": "accessReview defines required and missing access review checks.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ResourceAttributesAccessReview"
+ "disabled": {
+ "description": "disabled is a list of all feature gates that you want to force off",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
},
- "state": {
- "description": "state defines the perspective is enabled or disabled or access review check is required.",
- "type": "string",
- "default": ""
- }
- },
- "x-kubernetes-unions": [
- {
- "discriminator": "state",
- "fields-to-discriminateBy": {
- "accessReview": "AccessReview"
+ "enabled": {
+ "description": "enabled is a list of all feature gates that you want to force on",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
}
}
- ]
+ }
},
- "com.github.openshift.api.operator.v1.PinnedResourceReference": {
- "description": "PinnedResourceReference includes the group, version and type of resource",
+ "com.github.openshift.api.config.v1.CustomTLSProfile": {
+ "description": "CustomTLSProfile is a user-defined TLS security profile. Be extremely careful using a custom TLS profile as invalid configurations can be catastrophic.",
"type": "object",
"required": [
- "group",
- "version",
- "resource"
+ "ciphers",
+ "minTLSVersion"
],
"properties": {
- "group": {
- "description": "group is the API Group of the Resource. Enter empty string for the core group. This value should consist of only lowercase alphanumeric characters, hyphens and periods. Example: \"\", \"apps\", \"build.openshift.io\", etc.",
- "type": "string",
- "default": ""
- },
- "resource": {
- "description": "resource is the type that is being referenced. It is normally the plural form of the resource kind in lowercase. This value should consist of only lowercase alphanumeric characters and hyphens. Example: \"deployments\", \"deploymentconfigs\", \"pods\", etc.",
- "type": "string",
- "default": ""
+ "ciphers": {
+ "description": "ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake. Operators may remove entries their operands do not support. For example, to use DES-CBC3-SHA (yaml):\n\n ciphers:\n - DES-CBC3-SHA",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "version": {
- "description": "version is the API Version of the Resource. This value should consist of only lowercase alphanumeric characters. Example: \"v1\", \"v1beta1\", etc.",
+ "minTLSVersion": {
+ "description": "minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml):\n\n minTLSVersion: VersionTLS11\n\nNOTE: currently the highest minTLSVersion allowed is VersionTLS12",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.operator.v1.PolicyAuditConfig": {
+ "com.github.openshift.api.config.v1.DNS": {
+ "description": "DNS holds cluster-wide information about DNS. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
+ "required": [
+ "spec"
+ ],
"properties": {
- "destination": {
- "description": "destination is the location for policy log messages. Regardless of this config, persistent logs will always be dumped to the host at /var/log/ovn/ however Additionally syslog output may be configured as follows. Valid values are: - \"libc\" -> to use the libc syslog() function of the host node's journdald process - \"udp:host:port\" -> for sending syslog over UDP - \"unix:file\" -> for using the UNIX domain socket directly - \"null\" -> to discard all messages logged to syslog The default is \"null\"",
+ "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",
"type": "string"
},
- "maxFileSize": {
- "description": "maxFilesSize is the max size an ACL_audit log file is allowed to reach before rotation occurs Units are in MB and the Default is 50MB",
- "type": "integer",
- "format": "int64"
+ "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",
+ "type": "string"
},
- "maxLogFiles": {
- "description": "maxLogFiles specifies the maximum number of ACL_audit log files that can be present.",
- "type": "integer",
- "format": "int32"
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "rateLimit": {
- "description": "rateLimit is the approximate maximum number of messages to generate per-second per-node. If unset the default of 20 msg/sec is used.",
- "type": "integer",
- "format": "int64"
+ "spec": {
+ "description": "spec holds user settable values for configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSSpec"
},
- "syslogFacility": {
- "description": "syslogFacility the RFC5424 facility for generated messages, e.g. \"kern\". Default is \"local0\"",
- "type": "string"
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSStatus"
}
}
},
- "com.github.openshift.api.operator.v1.PrivateStrategy": {
- "description": "PrivateStrategy holds parameters for the Private endpoint publishing strategy.",
+ "com.github.openshift.api.config.v1.DNSList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
+ "required": [
+ "metadata",
+ "items"
+ ],
"properties": {
- "protocol": {
- "description": "protocol specifies whether the IngressController expects incoming connections to use plain TCP or whether the IngressController expects PROXY protocol.\n\nPROXY protocol can be used with load balancers that support it to communicate the source addresses of client connections when forwarding those connections to the IngressController. Using PROXY protocol enables the IngressController to report those source addresses instead of reporting the load balancer's address in HTTP headers and logs. Note that enabling PROXY protocol on the IngressController will cause connections to fail if you are not using a load balancer that uses PROXY protocol to forward connections to the IngressController. See http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt for information about PROXY protocol.\n\nThe following values are valid for this field:\n\n* The empty string. * \"TCP\". * \"PROXY\".\n\nThe empty string specifies the default, which is TCP without PROXY protocol. Note that the default is subject to change.",
+ "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",
"type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ProjectAccess": {
- "description": "ProjectAccess contains options for project access roles",
- "type": "object",
- "properties": {
- "availableClusterRoles": {
- "description": "availableClusterRoles is the list of ClusterRole names that are assignable to users through the project access tab.",
+ },
+ "items": {
"type": "array",
"items": {
- "type": "string",
- "default": ""
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DNS"
}
+ },
+ "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",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.operator.v1.ProviderLoadBalancerParameters": {
- "description": "ProviderLoadBalancerParameters holds desired load balancer information specific to the underlying infrastructure provider.",
+ "com.github.openshift.api.config.v1.DNSPlatformSpec": {
+ "description": "DNSPlatformSpec holds cloud-provider-specific configuration for DNS administration.",
"type": "object",
"required": [
"type"
],
"properties": {
"aws": {
- "description": "aws provides configuration settings that are specific to AWS load balancers.\n\nIf empty, defaults will be applied. See specific aws fields for details about their defaults.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.AWSLoadBalancerParameters"
- },
- "gcp": {
- "description": "gcp provides configuration settings that are specific to GCP load balancers.\n\nIf empty, defaults will be applied. See specific gcp fields for details about their defaults.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GCPLoadBalancerParameters"
- },
- "ibm": {
- "description": "ibm provides configuration settings that are specific to IBM Cloud load balancers.\n\nIf empty, defaults will be applied. See specific ibm fields for details about their defaults.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IBMLoadBalancerParameters"
- },
- "openstack": {
- "description": "openstack provides configuration settings that are specific to OpenStack load balancers.\n\nIf empty, defaults will be applied. See specific openstack fields for details about their defaults.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OpenStackLoadBalancerParameters"
+ "description": "aws contains DNS configuration specific to the Amazon Web Services cloud provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSDNSSpec"
},
"type": {
- "description": "type is the underlying infrastructure provider for the load balancer. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"IBM\", \"Nutanix\", \"OpenStack\", and \"VSphere\".",
+ "description": "type is the underlying infrastructure provider for the cluster. Allowed values: \"\", \"AWS\".\n\nIndividual components may not support all platforms, and must handle unrecognized platforms with best-effort defaults.",
"type": "string",
"default": ""
}
@@ -33504,152 +2129,175 @@
{
"discriminator": "type",
"fields-to-discriminateBy": {
- "aws": "AWS",
- "gcp": "GCP",
- "ibm": "IBM",
- "openstack": "OpenStack"
+ "aws": "AWS"
}
}
]
},
- "com.github.openshift.api.operator.v1.ProxyConfig": {
- "description": "ProxyConfig defines the configuration knobs for kubeproxy All of these are optional and have sensible defaults",
+ "com.github.openshift.api.config.v1.DNSSpec": {
"type": "object",
+ "required": [
+ "baseDomain"
+ ],
"properties": {
- "bindAddress": {
- "description": "The address to \"bind\" on Defaults to 0.0.0.0",
- "type": "string"
+ "baseDomain": {
+ "description": "baseDomain is the base domain of the cluster. All managed DNS records will be sub-domains of this base.\n\nFor example, given the base domain `openshift.example.com`, an API server DNS record may be created for `cluster-api.openshift.example.com`.\n\nOnce set, this field cannot be changed.",
+ "type": "string",
+ "default": ""
},
- "iptablesSyncPeriod": {
- "description": "An internal kube-proxy parameter. In older releases of OCP, this sometimes needed to be adjusted in large clusters for performance reasons, but this is no longer necessary, and there is no reason to change this from the default value. Default: 30s",
- "type": "string"
+ "platform": {
+ "description": "platform holds configuration specific to the underlying infrastructure provider for DNS. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSPlatformSpec"
},
- "proxyArguments": {
- "description": "Any additional arguments to pass to the kubeproxy process",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
+ "privateZone": {
+ "description": "privateZone is the location where all the DNS records that are only available internally to the cluster exist.\n\nIf this field is nil, no private records should be created.\n\nOnce set, this field cannot be changed.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSZone"
+ },
+ "publicZone": {
+ "description": "publicZone is the location where all the DNS records that are publicly accessible to the internet exist.\n\nIf this field is nil, no public records should be created.\n\nOnce set, this field cannot be changed.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSZone"
}
}
},
- "com.github.openshift.api.operator.v1.QuickStarts": {
- "description": "QuickStarts allow cluster admins to customize available ConsoleQuickStart resources.",
+ "com.github.openshift.api.config.v1.DNSStatus": {
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.DNSZone": {
+ "description": "DNSZone is used to define a DNS hosted zone. A zone can be identified by an ID or tags.",
"type": "object",
"properties": {
- "disabled": {
- "description": "disabled is a list of ConsoleQuickStart resource names that are not shown to users.",
- "type": "array",
- "items": {
+ "id": {
+ "description": "id is the identifier that can be used to find the DNS hosted zone.\n\non AWS zone can be fetched using `ID` as id in [1] on Azure zone can be fetched using `ID` as a pre-determined name in [2], on GCP zone can be fetched using `ID` as a pre-determined name in [3].\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get",
+ "type": "string"
+ },
+ "tags": {
+ "description": "tags can be used to query the DNS hosted zone.\n\non AWS, resourcegroupstaggingapi [1] can be used to fetch a zone using `Tags` as tag-filters,\n\n[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options",
+ "type": "object",
+ "additionalProperties": {
"type": "string",
"default": ""
}
}
}
},
- "com.github.openshift.api.operator.v1.ReloadService": {
- "description": "ReloadService allows the user to specify the services to be reloaded",
+ "com.github.openshift.api.config.v1.DelegatedAuthentication": {
+ "description": "DelegatedAuthentication allows authentication to be disabled.",
"type": "object",
- "required": [
- "serviceName"
- ],
"properties": {
- "serviceName": {
- "description": "serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, \":\", \"-\", \"_\", \".\", and \"\\\". ${SERVICETYPE} must be one of \".service\", \".socket\", \".device\", \".mount\", \".automount\", \".swap\", \".target\", \".path\", \".timer\", \".snapshot\", \".slice\" or \".scope\".",
- "type": "string",
- "default": ""
+ "disabled": {
+ "description": "disabled indicates that authentication should be disabled. By default it will use delegated authentication.",
+ "type": "boolean"
}
}
},
- "com.github.openshift.api.operator.v1.ResourceAttributesAccessReview": {
- "description": "ResourceAttributesAccessReview defines the visibility of the perspective depending on the access review checks. `required` and `missing` can work together esp. in the case where the cluster admin wants to show another perspective to users without specific permissions. Out of `required` and `missing` atleast one property should be non-empty.",
+ "com.github.openshift.api.config.v1.DelegatedAuthorization": {
+ "description": "DelegatedAuthorization allows authorization to be disabled.",
"type": "object",
"properties": {
- "missing": {
- "description": "missing defines a list of permission checks. The perspective will only be shown when at least one check fails. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the required access review list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.authorization.v1.ResourceAttributes"
- }
- },
- "required": {
- "description": "required defines a list of permission checks. The perspective will only be shown when all checks are successful. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the missing access review list.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.authorization.v1.ResourceAttributes"
- }
+ "disabled": {
+ "description": "disabled indicates that authorization should be disabled. By default it will use delegated authorization.",
+ "type": "boolean"
}
}
},
- "com.github.openshift.api.operator.v1.RestartService": {
- "description": "RestartService allows the user to specify the services to be restarted",
+ "com.github.openshift.api.config.v1.DeprecatedWebhookTokenAuthenticator": {
+ "description": "deprecatedWebhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator. It's the same as WebhookTokenAuthenticator but it's missing the 'required' validation on KubeConfig field.",
"type": "object",
"required": [
- "serviceName"
+ "kubeConfig"
],
"properties": {
- "serviceName": {
- "description": "serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, \":\", \"-\", \"_\", \".\", and \"\\\". ${SERVICETYPE} must be one of \".service\", \".socket\", \".device\", \".mount\", \".automount\", \".swap\", \".target\", \".path\", \".timer\", \".snapshot\", \".slice\" or \".scope\".",
- "type": "string",
- "default": ""
+ "kubeConfig": {
+ "description": "kubeConfig contains kube config file data which describes how to access the remote webhook service. For further details, see: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication The key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored. The namespace for this secret is determined by the point of use.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
}
}
},
- "com.github.openshift.api.operator.v1.RouteAdmissionPolicy": {
- "description": "RouteAdmissionPolicy is an admission policy for allowing new route claims.",
+ "com.github.openshift.api.config.v1.EquinixMetalPlatformSpec": {
+ "description": "EquinixMetalPlatformSpec holds the desired state of the Equinix Metal infrastructure provider. This only includes fields that can be modified in the cluster.",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.EquinixMetalPlatformStatus": {
+ "description": "EquinixMetalPlatformStatus holds the current status of the Equinix Metal infrastructure provider.",
"type": "object",
"properties": {
- "namespaceOwnership": {
- "description": "namespaceOwnership describes how host name claims across namespaces should be handled.\n\nValue must be one of:\n\n- Strict: Do not allow routes in different namespaces to claim the same host.\n\n- InterNamespaceAllowed: Allow routes to claim different paths of the same\n host name across namespaces.\n\nIf empty, the default is Strict.",
+ "apiServerInternalIP": {
+ "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
"type": "string"
},
- "wildcardPolicy": {
- "description": "wildcardPolicy describes how routes with wildcard policies should be handled for the ingress controller. WildcardPolicy controls use of routes [1] exposed by the ingress controller based on the route's wildcard policy.\n\n[1] https://github.com/openshift/api/blob/master/route/v1/types.go\n\nNote: Updating WildcardPolicy from WildcardsAllowed to WildcardsDisallowed will cause admitted routes with a wildcard policy of Subdomain to stop working. These routes must be updated to a wildcard policy of None to be readmitted by the ingress controller.\n\nWildcardPolicy supports WildcardsAllowed and WildcardsDisallowed values.\n\nIf empty, defaults to \"WildcardsDisallowed\".",
+ "ingressIP": {
+ "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
"type": "string"
}
}
},
- "com.github.openshift.api.operator.v1.SFlowConfig": {
+ "com.github.openshift.api.config.v1.EtcdConnectionInfo": {
+ "description": "EtcdConnectionInfo holds information necessary for connecting to an etcd server",
"type": "object",
+ "required": [
+ "ca",
+ "certFile",
+ "keyFile"
+ ],
"properties": {
- "collectors": {
- "description": "sFlowCollectors is list of strings formatted as ip:port with a maximum of ten items",
+ "ca": {
+ "description": "ca is a file containing trusted roots for the etcd server certificates",
+ "type": "string",
+ "default": ""
+ },
+ "certFile": {
+ "description": "certFile is a file containing a PEM-encoded certificate",
+ "type": "string",
+ "default": ""
+ },
+ "keyFile": {
+ "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "type": "string",
+ "default": ""
+ },
+ "urls": {
+ "description": "urls are the URLs for etcd",
"type": "array",
"items": {
"type": "string",
"default": ""
- },
- "x-kubernetes-list-type": "atomic"
+ }
}
}
},
- "com.github.openshift.api.operator.v1.Server": {
- "description": "Server defines the schema for a server that runs per instance of CoreDNS.",
+ "com.github.openshift.api.config.v1.EtcdStorageConfig": {
"type": "object",
"required": [
- "name",
- "zones",
- "forwardPlugin"
+ "ca",
+ "certFile",
+ "keyFile",
+ "storagePrefix"
],
"properties": {
- "forwardPlugin": {
- "description": "forwardPlugin defines a schema for configuring CoreDNS to proxy DNS messages to upstream resolvers.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ForwardPlugin"
+ "ca": {
+ "description": "ca is a file containing trusted roots for the etcd server certificates",
+ "type": "string",
+ "default": ""
},
- "name": {
- "description": "name is required and specifies a unique name for the server. Name must comply with the Service Name Syntax of rfc6335.",
+ "certFile": {
+ "description": "certFile is a file containing a PEM-encoded certificate",
"type": "string",
"default": ""
},
- "zones": {
- "description": "zones is required and specifies the subdomains that Server is authoritative for. Zones must conform to the rfc1123 definition of a subdomain. Specifying the cluster domain (i.e., \"cluster.local\") is invalid.",
+ "keyFile": {
+ "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "type": "string",
+ "default": ""
+ },
+ "storagePrefix": {
+ "description": "storagePrefix is the path within etcd that the OpenShift resources will be rooted under. This value, if changed, will mean existing objects in etcd will no longer be located.",
+ "type": "string",
+ "default": ""
+ },
+ "urls": {
+ "description": "urls are the URLs for etcd",
"type": "array",
"items": {
"type": "string",
@@ -33658,170 +2306,93 @@
}
}
},
- "com.github.openshift.api.operator.v1.ServiceAccountIssuerStatus": {
+ "com.github.openshift.api.config.v1.ExternalIPConfig": {
+ "description": "ExternalIPConfig specifies some IP blocks relevant for the ExternalIP field of a Service resource.",
"type": "object",
- "required": [
- "name"
- ],
"properties": {
- "expirationTime": {
- "description": "expirationTime is the time after which this service account issuer will be pruned and removed from the trusted list of service account issuers.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
+ "autoAssignCIDRs": {
+ "description": "autoAssignCIDRs is a list of CIDRs from which to automatically assign Service.ExternalIP. These are assigned when the service is of type LoadBalancer. In general, this is only useful for bare-metal clusters. In Openshift 3.x, this was misleadingly called \"IngressIPs\". Automatically assigned External IPs are not affected by any ExternalIPPolicy rules. Currently, only one entry may be provided.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "name": {
- "description": "name is the name of the service account issuer",
- "type": "string",
- "default": ""
+ "policy": {
+ "description": "policy is a set of restrictions applied to the ExternalIP field. If nil or empty, then ExternalIP is not allowed to be set.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalIPPolicy"
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCA": {
- "description": "ServiceCA provides information to configure an operator to manage the service cert controllers\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ExternalIPPolicy": {
+ "description": "ExternalIPPolicy configures exactly which IPs are allowed for the ExternalIP field in a Service. If the zero struct is supplied, then none are permitted. The policy controller always allows automatically assigned external IPs.",
"type": "object",
- "required": [
- "metadata",
- "spec"
- ],
"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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCASpec"
+ "allowedCIDRs": {
+ "description": "allowedCIDRs is the list of allowed CIDRs.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCAStatus"
+ "rejectedCIDRs": {
+ "description": "rejectedCIDRs is the list of disallowed CIDRs. These take precedence over allowedCIDRs.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCAList": {
- "description": "ServiceCAList is a collection of items\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ExternalPlatformSpec": {
+ "description": "ExternalPlatformSpec holds the desired state for the generic External infrastructure provider.",
"type": "object",
- "required": [
- "metadata",
- "items"
- ],
"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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCA"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "platformName": {
+ "description": "platformName holds the arbitrary string representing the infrastructure provider name, expected to be set at the installation time. This field is solely for informational and reporting purposes and is not expected to be used for decision-making.",
+ "type": "string",
+ "default": "Unknown"
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCASpec": {
+ "com.github.openshift.api.config.v1.ExternalPlatformStatus": {
+ "description": "ExternalPlatformStatus holds the current status of the generic External infrastructure provider.",
"type": "object",
- "required": [
- "managementState"
- ],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "cloudControllerManager": {
+ "description": "cloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI). When omitted, new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudControllerManagerStatus"
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCAStatus": {
+ "com.github.openshift.api.config.v1.ExtraMapping": {
+ "description": "ExtraMapping allows specifying a key and CEL expression to evaluate the keys' value. It is used to create additional mappings and attributes added to a cluster identity from a provided authentication token.",
"type": "object",
+ "required": [
+ "key",
+ "valueExpression"
+ ],
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "key": {
+ "description": "key is a required field that specifies the string to use as the extra attribute key.\n\nkey must be a domain-prefix path (e.g 'example.org/foo'). key must not exceed 510 characters in length. key must contain the '/' character, separating the domain and path characters. key must not be empty.\n\nThe domain portion of the key (string of characters prior to the '/') must be a valid RFC1123 subdomain. It must not exceed 253 characters in length. It must start and end with an alphanumeric character. It must only contain lower case alphanumeric characters and '-' or '.'. It must not use the reserved domains, or be subdomains of, \"kubernetes.io\", \"k8s.io\", and \"openshift.io\".\n\nThe path portion of the key (string of characters after the '/') must not be empty and must consist of at least one alphanumeric character, percent-encoded octets, '-', '.', '_', '~', '!', '$', '&', ''', '(', ')', '*', '+', ',', ';', '=', and ':'. It must not exceed 256 characters in length.",
+ "type": "string",
+ "default": ""
},
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
+ "valueExpression": {
+ "description": "valueExpression is a required field to specify the CEL expression to extract the extra attribute value from a JWT token's claims. valueExpression must produce a string or string array value. \"\", [], and null are treated as the extra mapping not being present. Empty string values within an array are filtered out.\n\nCEL expressions have access to the token claims through a CEL variable, 'claims'. 'claims' is a map of claim names to claim values. For example, the 'sub' claim value can be accessed as 'claims.sub'. Nested claims can be accessed using dot notation ('claims.foo.bar').\n\nvalueExpression must not exceed 1024 characters in length. valueExpression must not be empty.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCatalogAPIServer": {
- "description": "ServiceCatalogAPIServer provides information to configure an operator to manage Service Catalog API Server DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.FeatureGate": {
+ "description": "Feature holds cluster-wide information about feature gates. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"spec"
@@ -33841,160 +2412,61 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCatalogAPIServerSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateSpec"
},
"status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCatalogAPIServerStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ServiceCatalogAPIServerList": {
- "description": "ServiceCatalogAPIServerList is a collection of items DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCatalogAPIServer"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateStatus"
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCatalogAPIServerSpec": {
+ "com.github.openshift.api.config.v1.FeatureGateAttributes": {
"type": "object",
"required": [
- "managementState"
+ "name"
],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
+ "name": {
+ "description": "name is the name of the FeatureGate.",
"type": "string",
"default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCatalogAPIServerStatus": {
+ "com.github.openshift.api.config.v1.FeatureGateDetails": {
"type": "object",
+ "required": [
+ "version"
+ ],
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
+ "disabled": {
+ "description": "disabled is a list of all feature gates that are disabled in the cluster for the named version.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateAttributes"
+ }
},
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "enabled": {
+ "description": "enabled is a list of all feature gates that are enabled in the cluster for the named version.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateAttributes"
+ }
},
"version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.ServiceCatalogControllerManager": {
- "description": "ServiceCatalogControllerManager provides information to configure an operator to manage Service Catalog Controller Manager DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "metadata",
- "spec"
- ],
- "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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCatalogControllerManagerSpec"
- },
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCatalogControllerManagerStatus"
+ "description": "version matches the version provided by the ClusterVersion and in the ClusterOperator.Status.Versions field.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCatalogControllerManagerList": {
- "description": "ServiceCatalogControllerManagerList is a collection of items DEPRECATED: will be removed in 4.6\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.FeatureGateList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -34006,11 +2478,10 @@
"type": "string"
},
"items": {
- "description": "items contains the items",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.ServiceCatalogControllerManager"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGate"
}
},
"kind": {
@@ -34024,907 +2495,816 @@
}
}
},
- "com.github.openshift.api.operator.v1.ServiceCatalogControllerManagerSpec": {
+ "com.github.openshift.api.config.v1.FeatureGateSelection": {
"type": "object",
- "required": [
- "managementState"
- ],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "customNoUpgrade": {
+ "description": "customNoUpgrade allows the enabling or disabling of any feature. Turning this feature set on IS NOT SUPPORTED, CANNOT BE UNDONE, and PREVENTS UPGRADES. Because of its nature, this setting cannot be validated. If you have any typos or accidentally apply invalid combinations your cluster may fail in an unrecoverable way. featureSet must equal \"CustomNoUpgrade\" must be set to use this field.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CustomFeatureGates"
},
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "featureSet": {
+ "description": "featureSet changes the list of features in the cluster. The default is empty. Be very careful adjusting this setting. Turning on or off features may cause irreversible changes in your cluster which cannot be undone.",
"type": "string"
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "featureSet",
+ "fields-to-discriminateBy": {
+ "customNoUpgrade": "CustomNoUpgrade"
+ }
+ }
+ ]
+ },
+ "com.github.openshift.api.config.v1.FeatureGateSpec": {
+ "type": "object",
+ "properties": {
+ "customNoUpgrade": {
+ "description": "customNoUpgrade allows the enabling or disabling of any feature. Turning this feature set on IS NOT SUPPORTED, CANNOT BE UNDONE, and PREVENTS UPGRADES. Because of its nature, this setting cannot be validated. If you have any typos or accidentally apply invalid combinations your cluster may fail in an unrecoverable way. featureSet must equal \"CustomNoUpgrade\" must be set to use this field.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CustomFeatureGates"
},
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "featureSet": {
+ "description": "featureSet changes the list of features in the cluster. The default is empty. Be very careful adjusting this setting. Turning on or off features may cause irreversible changes in your cluster which cannot be undone.",
+ "type": "string"
}
- }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "featureSet",
+ "fields-to-discriminateBy": {
+ "customNoUpgrade": "CustomNoUpgrade"
+ }
+ }
+ ]
},
- "com.github.openshift.api.operator.v1.ServiceCatalogControllerManagerStatus": {
+ "com.github.openshift.api.config.v1.FeatureGateStatus": {
"type": "object",
"properties": {
"conditions": {
- "description": "conditions is a list of conditions and their status",
+ "description": "conditions represent the observations of the current state. Known .status.conditions.type are: \"DeterminationDegraded\"",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
},
"x-kubernetes-list-map-keys": [
"type"
],
"x-kubernetes-list-type": "map"
},
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "featureGates": {
+ "description": "featureGates contains a list of enabled and disabled featureGates that are keyed by payloadVersion. Operators other than the CVO and cluster-config-operator, must read the .status.featureGates, locate the version they are managing, find the enabled/disabled featuregates and make the operand and operator match. The enabled/disabled values for a particular version may change during the life of the cluster as various .spec.featureSet values are selected. Operators may choose to restart their processes to pick up these changes, but remembering past enable/disable lists is beyond the scope of this API and is the responsibility of individual operators. Only featureGates with .version in the ClusterVersion.status will be present in this list.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateDetails"
},
"x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
+ "version"
],
"x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.SimpleMacvlanConfig": {
- "description": "SimpleMacvlanConfig contains configurations for macvlan interface.",
- "type": "object",
- "properties": {
- "ipamConfig": {
- "description": "ipamConfig configures IPAM module will be used for IP Address Management (IPAM).",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.IPAMConfig"
- },
- "master": {
- "description": "master is the host interface to create the macvlan interface from. If not specified, it will be default route interface",
- "type": "string"
- },
- "mode": {
- "description": "mode is the macvlan mode: bridge, private, vepa, passthru. The default is bridge",
- "type": "string"
- },
- "mtu": {
- "description": "mtu is the mtu to use for the macvlan interface. if unset, host's kernel will select the value.",
- "type": "integer",
- "format": "int64"
}
}
},
- "com.github.openshift.api.operator.v1.StaticIPAMAddresses": {
- "description": "StaticIPAMAddresses provides IP address and Gateway for static IPAM addresses",
+ "com.github.openshift.api.config.v1.FeatureGateTests": {
"type": "object",
+ "required": [
+ "featureGate",
+ "tests"
+ ],
"properties": {
- "address": {
- "description": "address is the IP address in CIDR format",
+ "featureGate": {
+ "description": "featureGate is the name of the FeatureGate as it appears in The FeatureGate CR instance.",
"type": "string",
"default": ""
},
- "gateway": {
- "description": "gateway is IP inside of subnet to designate as the gateway",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1.StaticIPAMConfig": {
- "description": "StaticIPAMConfig contains configurations for static IPAM (IP Address Management)",
- "type": "object",
- "properties": {
- "addresses": {
- "description": "addresses configures IP address for the interface",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.StaticIPAMAddresses"
- },
- "x-kubernetes-list-type": "atomic"
- },
- "dns": {
- "description": "dns configures DNS for the interface",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.StaticIPAMDNS"
- },
- "routes": {
- "description": "routes configures IP routes for the interface",
+ "tests": {
+ "description": "tests contains an item for every TestName",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.StaticIPAMRoutes"
- },
- "x-kubernetes-list-type": "atomic"
- }
- }
- },
- "com.github.openshift.api.operator.v1.StaticIPAMDNS": {
- "description": "StaticIPAMDNS provides DNS related information for static IPAM",
- "type": "object",
- "properties": {
- "domain": {
- "description": "domain configures the domainname the local domain used for short hostname lookups",
- "type": "string"
- },
- "nameservers": {
- "description": "nameservers points DNS servers for IP lookup",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "search": {
- "description": "search configures priority ordered search domains for short hostname lookups",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TestDetails"
+ }
}
}
},
- "com.github.openshift.api.operator.v1.StaticIPAMRoutes": {
- "description": "StaticIPAMRoutes provides Destination/Gateway pairs for static IPAM routes",
+ "com.github.openshift.api.config.v1.FulcioCAWithRekor": {
+ "description": "FulcioCAWithRekor defines the root of trust based on the Fulcio certificate and the Rekor public key.",
"type": "object",
"required": [
- "destination"
+ "fulcioCAData",
+ "rekorKeyData",
+ "fulcioSubject"
],
"properties": {
- "destination": {
- "description": "destination points the IP route destination",
+ "fulcioCAData": {
+ "description": "fulcioCAData is a required field contains inline base64-encoded data for the PEM format fulcio CA. fulcioCAData must be at most 8192 characters.",
"type": "string",
- "default": ""
+ "format": "byte"
},
- "gateway": {
- "description": "gateway is the route's next-hop IP address If unset, a default gateway is assumed (as determined by the CNI plugin).",
- "type": "string"
+ "fulcioSubject": {
+ "description": "fulcioSubject is a required field specifies OIDC issuer and the email of the Fulcio authentication configuration.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyFulcioSubject"
+ },
+ "rekorKeyData": {
+ "description": "rekorKeyData is a required field contains inline base64-encoded data for the PEM format from the Rekor public key. rekorKeyData must be at most 8192 characters.",
+ "type": "string",
+ "format": "byte"
}
}
},
- "com.github.openshift.api.operator.v1.StaticPodOperatorSpec": {
- "description": "StaticPodOperatorSpec is spec for controllers that manage static pods.",
+ "com.github.openshift.api.config.v1.GCPPlatformSpec": {
+ "description": "GCPPlatformSpec holds the desired state of the Google Cloud Platform infrastructure provider. This only includes fields that can be modified in the cluster.",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.GCPPlatformStatus": {
+ "description": "GCPPlatformStatus holds the current status of the Google Cloud Platform infrastructure provider.",
"type": "object",
"required": [
- "managementState",
- "forceRedeploymentReason"
+ "projectID",
+ "region"
],
"properties": {
- "failedRevisionLimit": {
- "description": "failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
+ "cloudLoadBalancerConfig": {
+ "description": "cloudLoadBalancerConfig holds configuration related to DNS and cloud load balancers. It allows configuration of in-cluster DNS as an alternative to the platform default DNS implementation. When using the ClusterHosted DNS type, Load Balancer IP addresses must be provided for the API and internal API load balancers as well as the ingress load balancer.",
+ "default": {
+ "dnsType": "PlatformDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudLoadBalancerConfig"
},
- "forceRedeploymentReason": {
- "description": "forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.",
+ "projectID": {
+ "description": "resourceGroupName is the Project ID for new GCP resources created for the cluster.",
"type": "string",
"default": ""
},
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
+ "region": {
+ "description": "region holds the region for new GCP resources created for the cluster.",
"type": "string",
"default": ""
},
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "succeededRevisionLimit": {
- "description": "succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)",
- "type": "integer",
- "format": "int32"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1.StaticPodOperatorStatus": {
- "description": "StaticPodOperatorStatus is status for controllers that manage static pods. There are different needs because individual node status must be tracked.",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
+ "resourceLabels": {
+ "description": "resourceLabels is a list of additional labels to apply to GCP resources created for the cluster. See https://cloud.google.com/compute/docs/labeling-resources for information on labeling GCP resources. GCP supports a maximum of 64 labels per resource. OpenShift reserves 32 labels for internal use, allowing 32 labels for user configuration.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPResourceLabel"
},
"x-kubernetes-list-map-keys": [
- "type"
+ "key"
],
"x-kubernetes-list-type": "map"
},
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "resourceTags": {
+ "description": "resourceTags is a list of additional tags to apply to GCP resources created for the cluster. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for information on tagging GCP resources. GCP supports a maximum of 50 tags per resource.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPResourceTag"
},
"x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
+ "key"
],
"x-kubernetes-list-type": "map"
},
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "latestAvailableRevisionReason": {
- "description": "latestAvailableRevisionReason describe the detailed reason for the most recent deployment",
- "type": "string"
- },
- "nodeStatuses": {
- "description": "nodeStatuses track the deployment values and errors across individual nodes",
+ "serviceEndpoints": {
+ "description": "serviceEndpoints specifies endpoints that override the default endpoints used when creating clients to interact with GCP services. When not specified, the default endpoint for the GCP region will be used. Only 1 endpoint override is permitted for each GCP service. The maximum number of endpoint overrides allowed is 11.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.NodeStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPServiceEndpoint"
},
"x-kubernetes-list-map-keys": [
- "nodeName"
+ "name"
],
"x-kubernetes-list-type": "map"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
}
}
},
- "com.github.openshift.api.operator.v1.StatuspageProvider": {
- "description": "StatuspageProvider provides identity for statuspage account.",
+ "com.github.openshift.api.config.v1.GCPResourceLabel": {
+ "description": "GCPResourceLabel is a label to apply to GCP resources created for the cluster.",
"type": "object",
"required": [
- "pageID"
+ "key",
+ "value"
],
"properties": {
- "pageID": {
- "description": "pageID is the unique ID assigned by Statuspage for your page. This must be a public page.",
+ "key": {
+ "description": "key is the key part of the label. A label key can have a maximum of 63 characters and cannot be empty. Label key must begin with a lowercase letter, and must contain only lowercase letters, numeric characters, and the following special characters `_-`. Label key must not have the reserved prefixes `kubernetes-io` and `openshift-io`.",
+ "type": "string",
+ "default": ""
+ },
+ "value": {
+ "description": "value is the value part of the label. A label value can have a maximum of 63 characters and cannot be empty. Value must contain only lowercase letters, numeric characters, and the following special characters `_-`.",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.operator.v1.Storage": {
- "description": "Storage provides a means to configure an operator to manage the cluster storage operator. `cluster` is the canonical name.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.GCPResourceTag": {
+ "description": "GCPResourceTag is a tag to apply to GCP resources created for the cluster.",
"type": "object",
"required": [
- "spec"
+ "parentID",
+ "key",
+ "value"
],
"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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "key": {
+ "description": "key is the key part of the tag. A tag key can have a maximum of 63 characters and cannot be empty. Tag key must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters `._-`.",
+ "type": "string",
+ "default": ""
},
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.StorageSpec"
+ "parentID": {
+ "description": "parentID is the ID of the hierarchical resource where the tags are defined, e.g. at the Organization or the Project level. To find the Organization or Project ID refer to the following pages: https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id, https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects. An OrganizationID must consist of decimal numbers, and cannot have leading zeroes. A ProjectID must be 6 to 30 characters in length, can only contain lowercase letters, numbers, and hyphens, and must start with a letter, and cannot end with a hyphen.",
+ "type": "string",
+ "default": ""
},
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.StorageStatus"
+ "value": {
+ "description": "value is the value part of the tag. A tag value can have a maximum of 63 characters and cannot be empty. Tag value must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters `_-.@%=+:,*#&(){}[]` and spaces.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.StorageList": {
- "description": "StorageList contains a list of Storages.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.GCPServiceEndpoint": {
+ "description": "GCPServiceEndpoint store the configuration of a custom url to override existing defaults of GCP Services.",
"type": "object",
"required": [
- "items"
+ "name",
+ "url"
],
"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",
- "type": "string"
+ "name": {
+ "description": "name is the name of the GCP service whose endpoint is being overridden. This must be provided and cannot be empty.\n\nAllowed values are Compute, Container, CloudResourceManager, DNS, File, IAM, ServiceUsage, Storage, and TagManager.\n\nAs an example, when setting the name to Compute all requests made by the caller to the GCP Compute Service will be directed to the endpoint specified in the url field.",
+ "type": "string",
+ "default": ""
},
- "items": {
+ "url": {
+ "description": "url is a fully qualified URI that overrides the default endpoint for a client using the GCP service specified in the name field. url is required, must use the scheme https, must not be more than 253 characters in length, and must be a valid URL according to Go's net/url package (https://pkg.go.dev/net/url#URL)\n\nAn example of a valid endpoint that overrides the Compute Service: \"https://compute-myendpoint1.p.googleapis.com\"",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.GatherConfig": {
+ "description": "GatherConfig provides data gathering configuration options.",
+ "type": "object",
+ "required": [
+ "gatherers"
+ ],
+ "properties": {
+ "dataPolicy": {
+ "description": "dataPolicy is an optional list of DataPolicyOptions that allows user to enable additional obfuscation of the Insights archive data. It may not exceed 2 items and must not contain duplicates. Valid values are ObfuscateNetworking and WorkloadNames. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When set to WorkloadNames, the gathered data about cluster resources will not contain the workload names for your deployments. Resources UIDs will be used instead. When omitted no obfuscation is applied.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Storage"
- }
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "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",
- "type": "string"
+ "gatherers": {
+ "description": "gatherers is a required field that specifies the configuration of the gatherers.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Gatherers"
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "storage": {
+ "description": "storage is an optional field that allows user to define persistent storage for gathering jobs to store the Insights data archive. If omitted, the gathering job will use ephemeral storage.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Storage"
}
}
},
- "com.github.openshift.api.operator.v1.StorageSpec": {
- "description": "StorageSpec is the specification of the desired behavior of the cluster storage operator.",
+ "com.github.openshift.api.config.v1.GathererConfig": {
+ "description": "GathererConfig allows to configure specific gatherers",
"type": "object",
"required": [
- "managementState"
+ "name",
+ "state"
],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "name": {
+ "description": "name is the required name of a specific gatherer. It may not exceed 256 characters. The format for a gatherer name is: {gatherer}/{function} where the function is optional. Gatherer consists of a lowercase letters only that may include underscores (_). Function consists of a lowercase letters only that may include underscores (_) and is separated from the gatherer by a forward slash (/). The particular gatherers can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\"",
"type": "string"
},
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
+ "state": {
+ "description": "state is a required field that allows you to configure specific gatherer. Valid values are \"Enabled\" and \"Disabled\". When set to Enabled the gatherer will run. When set to Disabled the gatherer will not run.",
"type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "vsphereStorageDriver": {
- "description": "vsphereStorageDriver indicates the storage driver to use on VSphere clusters. Once this field is set to CSIWithMigrationDriver, it can not be changed. If this is empty, the platform will choose a good default, which may change over time without notice. The current default is CSIWithMigrationDriver and may not be changed. DEPRECATED: This field will be removed in a future release.",
- "type": "string",
- "default": ""
}
}
},
- "com.github.openshift.api.operator.v1.StorageStatus": {
- "description": "StorageStatus defines the observed status of the cluster storage operator.",
+ "com.github.openshift.api.config.v1.Gatherers": {
+ "description": "Gatherers specifies the configuration of the gatherers",
"type": "object",
+ "required": [
+ "mode"
+ ],
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
- },
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "custom": {
+ "description": "custom provides gathering configuration. It is required when mode is Custom, and forbidden otherwise. Custom configuration allows user to disable only a subset of gatherers. Gatherers that are not explicitly disabled in custom configuration will run.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Custom"
},
- "version": {
- "description": "version is the level this availability applies to",
+ "mode": {
+ "description": "mode is a required field that specifies the mode for gatherers. Allowed values are All, None, and Custom. When set to All, all gatherers will run and gather data. When set to None, all gatherers will be disabled and no data will be gathered. When set to Custom, the custom configuration from the custom field will be applied.",
"type": "string"
}
- }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "mode",
+ "fields-to-discriminateBy": {
+ "custom": "Custom"
+ }
+ }
+ ]
},
- "com.github.openshift.api.operator.v1.SyslogLoggingDestinationParameters": {
- "description": "SyslogLoggingDestinationParameters describes parameters for the Syslog logging destination type.",
+ "com.github.openshift.api.config.v1.GenericAPIServerConfig": {
+ "description": "GenericAPIServerConfig is an inline-able struct for aggregated apiservers that need to store data in etcd",
"type": "object",
"required": [
- "address",
- "port"
+ "servingInfo",
+ "corsAllowedOrigins",
+ "auditConfig",
+ "storageConfig",
+ "admission",
+ "kubeClientConfig"
],
"properties": {
- "address": {
- "description": "address is the IP address of the syslog endpoint that receives log messages.",
- "type": "string",
- "default": ""
+ "admission": {
+ "description": "admissionConfig holds information about how to configure admission.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AdmissionConfig"
},
- "facility": {
- "description": "facility specifies the syslog facility of log messages.\n\nIf this field is empty, the facility is \"local1\".",
- "type": "string"
+ "auditConfig": {
+ "description": "auditConfig describes how to configure audit information",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AuditConfig"
},
- "maxLength": {
- "description": "maxLength is the maximum length of the log message.\n\nValid values are integers in the range 480 to 4096, inclusive.\n\nWhen omitted, the default value is 1024.",
- "type": "integer",
- "format": "int64"
+ "corsAllowedOrigins": {
+ "description": "corsAllowedOrigins",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
},
- "port": {
- "description": "port is the UDP port number of the syslog endpoint that receives log messages.",
- "type": "integer",
- "format": "int64",
- "default": 0
+ "kubeClientConfig": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.KubeClientConfig"
+ },
+ "servingInfo": {
+ "description": "servingInfo describes how to start serving",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
+ },
+ "storageConfig": {
+ "description": "storageConfig contains information about how to use",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.EtcdStorageConfig"
}
}
},
- "com.github.openshift.api.operator.v1.Theme": {
- "description": "Theme defines a theme mode for the console UI.",
+ "com.github.openshift.api.config.v1.GenericControllerConfig": {
+ "description": "GenericControllerConfig provides information to configure a controller",
"type": "object",
"required": [
- "mode",
- "source"
+ "servingInfo",
+ "leaderElection",
+ "authentication",
+ "authorization"
],
"properties": {
- "mode": {
- "description": "mode is used to specify what theme mode a logo will apply to in the console UI. mode is a required field that allows values of Dark and Light. When set to Dark, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Dark mode. When set to Light, the logo file referenced in the 'file' field will be used when an end-user of the console UI enables the Light mode.\n\nPossible enum values:\n - `\"Dark\"` represents the dark mode for a console theme.\n - `\"Light\"` represents the light mode for a console theme.",
- "type": "string",
- "default": "",
- "enum": [
- "Dark",
- "Light"
- ]
+ "authentication": {
+ "description": "authentication allows configuration of authentication for the endpoints",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DelegatedAuthentication"
},
- "source": {
- "description": "source is used by the console to locate the specified file containing a custom logo. source is a required field that references a ConfigMap name and key that contains the custom logo file in the openshift-config namespace. You can create it with a command like: - 'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file' The ConfigMap key must include the file extension so that the console serves the file with the correct MIME type. The recommended file format for the Masthead and Favicon logos is SVG, but other file formats are allowed if supported by the browser. The logo image size must be less than 1 MB due to constraints on the ConfigMap size. For more information, see the documentation: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console",
+ "authorization": {
+ "description": "authorization allows configuration of authentication for the endpoints",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.DelegatedAuthorization"
+ },
+ "leaderElection": {
+ "description": "leaderElection provides information to elect a leader. Only override this if you have a specific need",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.LeaderElection"
+ },
+ "servingInfo": {
+ "description": "servingInfo is the HTTP serving information for the controller's endpoints",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.FileReferenceSource"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
}
}
},
- "com.github.openshift.api.operator.v1.Upstream": {
- "description": "Upstream can either be of type SystemResolvConf, or of type Network.\n\n - For an Upstream of type SystemResolvConf, no further fields are necessary:\n The upstream will be configured to use /etc/resolv.conf.\n - For an Upstream of type Network, a NetworkResolver field needs to be defined\n with an IP address or IP:port if the upstream listens on a port other than 53.",
+ "com.github.openshift.api.config.v1.GitHubIdentityProvider": {
+ "description": "GitHubIdentityProvider provides identities for users authenticating using GitHub credentials",
"type": "object",
"required": [
- "type"
+ "clientID",
+ "clientSecret"
],
"properties": {
- "address": {
- "description": "address must be defined when Type is set to Network. It will be ignored otherwise. It must be a valid ipv4 or ipv6 address.",
- "type": "string"
- },
- "port": {
- "description": "port may be defined when Type is set to Network. It will be ignored otherwise. Port must be between 65535",
- "type": "integer",
- "format": "int64"
+ "ca": {
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value. The namespace for this config map is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "type": {
- "description": "type defines whether this upstream contains an IP/IP:port resolver or the local /etc/resolv.conf. Type accepts 2 possible values: SystemResolvConf or Network.\n\n* When SystemResolvConf is used, the Upstream structure does not require any further fields to be defined:\n /etc/resolv.conf will be used\n* When Network is used, the Upstream structure must contain at least an Address",
+ "clientID": {
+ "description": "clientID is the oauth client ID",
"type": "string",
"default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1.UpstreamResolvers": {
- "description": "UpstreamResolvers defines a schema for configuring the CoreDNS forward plugin in the specific case of the default (\".\") server. It defers from ForwardPlugin in the default values it accepts: * At least one upstream should be specified. * the default policy is Sequential",
- "type": "object",
- "properties": {
- "policy": {
- "description": "policy is used to determine the order in which upstream servers are selected for querying. Any one of the following values may be specified:\n\n* \"Random\" picks a random upstream server for each query. * \"RoundRobin\" picks upstream servers in a round-robin order, moving to the next server for each new query. * \"Sequential\" tries querying upstream servers in a sequential order until one responds, starting with the first server for each new query.\n\nThe default value is \"Sequential\"",
- "type": "string"
},
- "protocolStrategy": {
- "description": "protocolStrategy specifies the protocol to use for upstream DNS requests. Valid values for protocolStrategy are \"TCP\" and omitted. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is to use the protocol of the original client request. \"TCP\" specifies that the platform should use TCP for all upstream DNS requests, even if the client request uses UDP. \"TCP\" is useful for UDP-specific issues such as those created by non-compliant upstream resolvers, but may consume more bandwidth or increase DNS response time. Note that protocolStrategy only affects the protocol of DNS requests that CoreDNS makes to upstream resolvers. It does not affect the protocol of DNS requests between clients and CoreDNS.",
+ "clientSecret": {
+ "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "hostname": {
+ "description": "hostname is the optional domain (e.g. \"mycompany.com\") for use with a hosted instance of GitHub Enterprise. It must match the GitHub Enterprise settings value configured at /setup/settings#hostname.",
"type": "string",
"default": ""
},
- "transportConfig": {
- "description": "transportConfig is used to configure the transport type, server name, and optional custom CA or CA bundle to use when forwarding DNS requests to an upstream resolver.\n\nThe default value is \"\" (empty) which results in a standard cleartext connection being used when forwarding DNS requests to an upstream resolver.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.DNSTransportConfig"
+ "organizations": {
+ "description": "organizations optionally restricts which organizations are allowed to log in",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
},
- "upstreams": {
- "description": "upstreams is a list of resolvers to forward name queries for the \".\" domain. Each instance of CoreDNS performs health checking of Upstreams. When a healthy upstream returns an error during the exchange, another resolver is tried from Upstreams. The Upstreams are selected in the order specified in Policy.\n\nA maximum of 15 upstreams is allowed per ForwardPlugin. If no Upstreams are specified, /etc/resolv.conf is used by default",
+ "teams": {
+ "description": "teams optionally restricts which teams are allowed to log in. Format is /.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.Upstream"
+ "type": "string",
+ "default": ""
}
}
}
},
- "com.github.openshift.api.operator.v1.VSphereCSIDriverConfigSpec": {
- "description": "VSphereCSIDriverConfigSpec defines properties that can be configured for vsphere CSI driver.",
+ "com.github.openshift.api.config.v1.GitLabIdentityProvider": {
+ "description": "GitLabIdentityProvider provides identities for users authenticating using GitLab credentials",
"type": "object",
+ "required": [
+ "clientID",
+ "clientSecret",
+ "url"
+ ],
"properties": {
- "globalMaxSnapshotsPerBlockVolume": {
- "description": "globalMaxSnapshotsPerBlockVolume is a global configuration parameter that applies to volumes on all kinds of datastores. If omitted, the platform chooses a default, which is subject to change over time, currently that default is 3. Snapshots can not be disabled using this parameter. Increasing number of snapshots above 3 can have negative impact on performance, for more details see: https://kb.vmware.com/s/article/1025279 Volume snapshot documentation: https://docs.vmware.com/en/VMware-vSphere-Container-Storage-Plug-in/3.0/vmware-vsphere-csp-getting-started/GUID-E0B41C69-7EEB-450F-A73D-5FD2FF39E891.html",
- "type": "integer",
- "format": "int64"
- },
- "granularMaxSnapshotsPerBlockVolumeInVSAN": {
- "description": "granularMaxSnapshotsPerBlockVolumeInVSAN is a granular configuration parameter on vSAN datastore only. It overrides GlobalMaxSnapshotsPerBlockVolume if set, while it falls back to the global constraint if unset. Snapshots for VSAN can not be disabled using this parameter.",
- "type": "integer",
- "format": "int64"
+ "ca": {
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "granularMaxSnapshotsPerBlockVolumeInVVOL": {
- "description": "granularMaxSnapshotsPerBlockVolumeInVVOL is a granular configuration parameter on Virtual Volumes datastore only. It overrides GlobalMaxSnapshotsPerBlockVolume if set, while it falls back to the global constraint if unset. Snapshots for VVOL can not be disabled using this parameter.",
- "type": "integer",
- "format": "int64"
+ "clientID": {
+ "description": "clientID is the oauth client ID",
+ "type": "string",
+ "default": ""
},
- "maxAllowedBlockVolumesPerNode": {
- "description": "maxAllowedBlockVolumesPerNode is an optional configuration parameter that allows setting a custom value for the limit of the number of PersistentVolumes attached to a node. In vSphere version 7 this limit was set to 59 by default, however in vSphere version 8 this limit was increased to 255. Before increasing this value above 59 the cluster administrator needs to ensure that every node forming the cluster is updated to ESXi version 8 or higher and that all nodes are running the same version. The limit must be between 1 and 255, which matches the vSphere version 8 maximum. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is 59, which matches the limit for vSphere version 7.",
- "type": "integer",
- "format": "int32"
+ "clientSecret": {
+ "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
},
- "topologyCategories": {
- "description": "topologyCategories indicates tag categories with which vcenter resources such as hostcluster or datacenter were tagged with. If cluster Infrastructure object has a topology, values specified in Infrastructure object will be used and modifications to topologyCategories will be rejected.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "atomic"
+ "url": {
+ "description": "url is the oauth server base URL",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1alpha1.BackupJobReference": {
- "description": "BackupJobReference holds a reference to the batch/v1 Job created to run the etcd backup",
+ "com.github.openshift.api.config.v1.GoogleIdentityProvider": {
+ "description": "GoogleIdentityProvider provides identities for users authenticating using Google credentials",
"type": "object",
"required": [
- "namespace",
- "name"
+ "clientID",
+ "clientSecret"
],
"properties": {
- "name": {
- "description": "name is the name of the Job. Required",
+ "clientID": {
+ "description": "clientID is the oauth client ID",
"type": "string",
"default": ""
},
- "namespace": {
- "description": "namespace is the namespace of the Job. this is always expected to be \"openshift-etcd\" since the user provided PVC is also required to be in \"openshift-etcd\" Required",
+ "clientSecret": {
+ "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "hostedDomain": {
+ "description": "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.operator.v1alpha1.ClusterVersionOperator": {
- "description": "ClusterVersionOperator holds cluster-wide information about the Cluster Version Operator.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.HTPasswdIdentityProvider": {
+ "description": "HTPasswdPasswordIdentityProvider provides identities for users authenticating using htpasswd credentials",
"type": "object",
"required": [
- "metadata",
- "spec"
+ "fileData"
],
"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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec is the specification of the desired behavior of the Cluster Version Operator.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.ClusterVersionOperatorSpec"
- },
- "status": {
- "description": "status is the most recently observed status of the Cluster Version Operator.",
+ "fileData": {
+ "description": "fileData is a required reference to a secret by name containing the data to use as the htpasswd file. The key \"htpasswd\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. If the specified htpasswd data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.ClusterVersionOperatorStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.ClusterVersionOperatorList": {
- "description": "ClusterVersionOperatorList is a collection of ClusterVersionOperators.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.HTTPServingInfo": {
+ "description": "HTTPServingInfo holds configuration for serving HTTP",
"type": "object",
"required": [
- "metadata"
+ "bindAddress",
+ "bindNetwork",
+ "certFile",
+ "keyFile",
+ "maxRequestsInFlight",
+ "requestTimeoutSeconds"
],
"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",
+ "bindAddress": {
+ "description": "bindAddress is the ip:port to serve on",
+ "type": "string",
+ "default": ""
+ },
+ "bindNetwork": {
+ "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
+ "type": "string",
+ "default": ""
+ },
+ "certFile": {
+ "description": "certFile is a file containing a PEM-encoded certificate",
+ "type": "string",
+ "default": ""
+ },
+ "cipherSuites": {
+ "description": "cipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "clientCA": {
+ "description": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
"type": "string"
},
- "items": {
- "description": "items is a list of ClusterVersionOperators.",
+ "keyFile": {
+ "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "type": "string",
+ "default": ""
+ },
+ "maxRequestsInFlight": {
+ "description": "maxRequestsInFlight is the number of concurrent requests allowed to the server. If zero, no limit.",
+ "type": "integer",
+ "format": "int64",
+ "default": 0
+ },
+ "minTLSVersion": {
+ "description": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
+ "type": "string"
+ },
+ "namedCertificates": {
+ "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.ClusterVersionOperator"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NamedCertificate"
}
},
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.ClusterVersionOperatorSpec": {
- "description": "ClusterVersionOperatorSpec is the specification of the desired behavior of the Cluster Version Operator.",
- "type": "object",
- "properties": {
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
+ "requestTimeoutSeconds": {
+ "description": "requestTimeoutSeconds is the number of seconds before requests are timed out. The default is 60 minutes, if -1 there is no limit on requests.",
+ "type": "integer",
+ "format": "int64",
+ "default": 0
}
}
},
- "com.github.openshift.api.operator.v1alpha1.ClusterVersionOperatorStatus": {
- "description": "ClusterVersionOperatorStatus defines the observed status of the Cluster Version Operator.",
+ "com.github.openshift.api.config.v1.HubSource": {
+ "description": "HubSource is used to specify the hub source and its configuration",
"type": "object",
+ "required": [
+ "name",
+ "disabled"
+ ],
"properties": {
- "observedGeneration": {
- "description": "observedGeneration represents the most recent generation observed by the operator and specifies the version of the spec field currently being synced.",
- "type": "integer",
- "format": "int64"
+ "disabled": {
+ "description": "disabled is used to disable a default hub source on cluster",
+ "type": "boolean",
+ "default": false
+ },
+ "name": {
+ "description": "name is the name of one of the default hub sources",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1alpha1.DelegatedAuthentication": {
- "description": "DelegatedAuthentication allows authentication to be disabled.",
+ "com.github.openshift.api.config.v1.HubSourceStatus": {
+ "description": "HubSourceStatus is used to reflect the current state of applying the configuration to a default source",
"type": "object",
"properties": {
- "disabled": {
- "description": "disabled indicates that authentication should be disabled. By default it will use delegated authentication.",
- "type": "boolean"
+ "message": {
+ "description": "message provides more information regarding failures",
+ "type": "string"
+ },
+ "status": {
+ "description": "status indicates success or failure in applying the configuration",
+ "type": "string"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.DelegatedAuthorization": {
- "description": "DelegatedAuthorization allows authorization to be disabled.",
+ "com.github.openshift.api.config.v1.IBMCloudPlatformSpec": {
+ "description": "IBMCloudPlatformSpec holds the desired state of the IBMCloud infrastructure provider. This only includes fields that can be modified in the cluster.",
"type": "object",
"properties": {
- "disabled": {
- "description": "disabled indicates that authorization should be disabled. By default it will use delegated authorization.",
- "type": "boolean"
+ "serviceEndpoints": {
+ "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of an IBM service. These endpoints are used by components within the cluster when trying to reach the IBM Cloud Services that have been overridden. The CCCMO reads in the IBMCloudPlatformSpec and validates each endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus are updated to reflect the same custom endpoints. A maximum of 13 service endpoints overrides are supported.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudServiceEndpoint"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.EtcdBackup": {
- "description": "# EtcdBackup provides configuration options and status for a one-time backup attempt of the etcd cluster\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.IBMCloudPlatformStatus": {
+ "description": "IBMCloudPlatformStatus holds the current status of the IBMCloud infrastructure provider.",
"type": "object",
- "required": [
- "spec"
- ],
"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",
+ "cisInstanceCRN": {
+ "description": "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain",
"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",
+ "dnsInstanceCRN": {
+ "description": "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain",
"type": "string"
},
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "location": {
+ "description": "location is where the cluster has been deployed",
+ "type": "string"
},
- "spec": {
- "description": "spec holds user settable values for configuration",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.EtcdBackupSpec"
+ "providerType": {
+ "description": "providerType indicates the type of cluster that was created",
+ "type": "string"
},
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.EtcdBackupStatus"
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.EtcdBackupList": {
- "description": "EtcdBackupList is a collection of items\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
+ "resourceGroupName": {
+ "description": "resourceGroupName is the Resource Group for new IBMCloud resources created for the cluster.",
"type": "string"
},
- "items": {
+ "serviceEndpoints": {
+ "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of an IBM service. These endpoints are used by components within the cluster when trying to reach the IBM Cloud Services that have been overridden. The CCCMO reads in the IBMCloudPlatformSpec and validates each endpoint is resolvable. Once validated, the cloud config and IBMCloudPlatformStatus are updated to reflect the same custom endpoints.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.EtcdBackup"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudServiceEndpoint"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.EtcdBackupSpec": {
+ "com.github.openshift.api.config.v1.IBMCloudServiceEndpoint": {
+ "description": "IBMCloudServiceEndpoint stores the configuration of a custom url to override existing defaults of IBM Cloud Services.",
"type": "object",
+ "required": [
+ "name",
+ "url"
+ ],
"properties": {
- "pvcName": {
- "description": "pvcName specifies the name of the PersistentVolumeClaim (PVC) which binds a PersistentVolume where the etcd backup file would be saved The PVC itself must always be created in the \"openshift-etcd\" namespace If the PVC is left unspecified \"\" then the platform will choose a reasonable default location to save the backup. In the future this would be backups saved across the control-plane master nodes.",
+ "name": {
+ "description": "name is the name of the IBM Cloud service. Possible values are: CIS, COS, COSConfig, DNSServices, GlobalCatalog, GlobalSearch, GlobalTagging, HyperProtect, IAM, KeyProtect, ResourceController, ResourceManager, or VPC. For example, the IBM Cloud Private IAM service could be configured with the service `name` of `IAM` and `url` of `https://private.iam.cloud.ibm.com` Whereas the IBM Cloud Private VPC service for US South (Dallas) could be configured with the service `name` of `VPC` and `url` of `https://us.south.private.iaas.cloud.ibm.com`",
"type": "string",
"default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.EtcdBackupStatus": {
- "type": "object",
- "properties": {
- "backupJob": {
- "description": "backupJob is the reference to the Job that executes the backup. Optional",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.BackupJobReference"
},
- "conditions": {
- "description": "conditions provide details on the status of the etcd backup job.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
+ "url": {
+ "description": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty. The path must follow the pattern /v[0,9]+ or /api/v[0,9]+",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1alpha1.GenerationHistory": {
- "description": "GenerationHistory keeps track of the generation for a given resource so that decisions about forced updated can be made. DEPRECATED: Use fields in v1.GenerationStatus instead",
+ "com.github.openshift.api.config.v1.IdentityProvider": {
+ "description": "IdentityProvider provides identities for users authenticating using credentials",
"type": "object",
"required": [
- "group",
- "resource",
- "namespace",
"name",
- "lastGeneration"
+ "type"
],
"properties": {
- "group": {
- "description": "group is the group of the thing you're tracking",
- "type": "string",
- "default": ""
+ "basicAuth": {
+ "description": "basicAuth contains configuration options for the BasicAuth IdP",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BasicAuthIdentityProvider"
},
- "lastGeneration": {
- "description": "lastGeneration is the last generation of the workload controller involved",
- "type": "integer",
- "format": "int64",
- "default": 0
+ "github": {
+ "description": "github enables user authentication using GitHub credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GitHubIdentityProvider"
+ },
+ "gitlab": {
+ "description": "gitlab enables user authentication using GitLab credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GitLabIdentityProvider"
+ },
+ "google": {
+ "description": "google enables user authentication using Google credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GoogleIdentityProvider"
+ },
+ "htpasswd": {
+ "description": "htpasswd enables user authentication using an HTPasswd file to validate credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.HTPasswdIdentityProvider"
+ },
+ "keystone": {
+ "description": "keystone enables user authentication using keystone password credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.KeystoneIdentityProvider"
+ },
+ "ldap": {
+ "description": "ldap enables user authentication using LDAP credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.LDAPIdentityProvider"
+ },
+ "mappingMethod": {
+ "description": "mappingMethod determines how identities from this provider are mapped to users Defaults to \"claim\"",
+ "type": "string"
},
"name": {
- "description": "name is the name of the thing you're tracking",
+ "description": "name is used to qualify the identities returned by this provider. - It MUST be unique and not shared by any other identity provider used - It MUST be a valid path segment: name cannot equal \".\" or \"..\" or contain \"/\" or \"%\" or \":\"\n Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName",
"type": "string",
"default": ""
},
- "namespace": {
- "description": "namespace is where the thing you're tracking is",
- "type": "string",
- "default": ""
+ "openID": {
+ "description": "openID enables user authentication using OpenID credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenIDIdentityProvider"
},
- "resource": {
- "description": "resource is the resource type of the thing you're tracking",
+ "requestHeader": {
+ "description": "requestHeader enables user authentication using request header credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.RequestHeaderIdentityProvider"
+ },
+ "type": {
+ "description": "type identifies the identity provider type for this entry.",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.operator.v1alpha1.GenericOperatorConfig": {
- "description": "GenericOperatorConfig provides information to configure an operator\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.IdentityProviderConfig": {
+ "description": "IdentityProviderConfig contains configuration for using a specific identity provider",
"type": "object",
+ "required": [
+ "type"
+ ],
"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",
- "type": "string"
+ "basicAuth": {
+ "description": "basicAuth contains configuration options for the BasicAuth IdP",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BasicAuthIdentityProvider"
},
- "authentication": {
- "description": "authentication allows configuration of authentication for the endpoints",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.DelegatedAuthentication"
+ "github": {
+ "description": "github enables user authentication using GitHub credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GitHubIdentityProvider"
},
- "authorization": {
- "description": "authorization allows configuration of authentication for the endpoints",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.DelegatedAuthorization"
+ "gitlab": {
+ "description": "gitlab enables user authentication using GitLab credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GitLabIdentityProvider"
},
- "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",
- "type": "string"
+ "google": {
+ "description": "google enables user authentication using Google credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GoogleIdentityProvider"
+ },
+ "htpasswd": {
+ "description": "htpasswd enables user authentication using an HTPasswd file to validate credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.HTPasswdIdentityProvider"
+ },
+ "keystone": {
+ "description": "keystone enables user authentication using keystone password credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.KeystoneIdentityProvider"
+ },
+ "ldap": {
+ "description": "ldap enables user authentication using LDAP credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.LDAPIdentityProvider"
+ },
+ "openID": {
+ "description": "openID enables user authentication using OpenID credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenIDIdentityProvider"
},
- "leaderElection": {
- "description": "leaderElection provides information to elect a leader. Only override this if you have a specific need",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.LeaderElection"
+ "requestHeader": {
+ "description": "requestHeader enables user authentication using request header credentials",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.RequestHeaderIdentityProvider"
},
- "servingInfo": {
- "description": "servingInfo is the HTTP serving information for the controller's endpoints",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
+ "type": {
+ "description": "type identifies the identity provider type for this entry.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operator.v1alpha1.ImageContentSourcePolicy": {
- "description": "ImageContentSourcePolicy holds cluster-wide information about how to handle registry mirror rules. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.Image": {
+ "description": "Image governs policies related to imagestream imports and runtime configuration for external registries. It allows cluster admins to configure which registries OpenShift is allowed to import images from, extra CA trust bundles for external registries, and policies to block or allow registry hostnames. When exposing OpenShift's image registry to the public, this also lets cluster admins specify the external hostname.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"spec"
@@ -34946,124 +3326,19 @@
"spec": {
"description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.ImageContentSourcePolicySpec"
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.ImageContentSourcePolicyList": {
- "description": "ImageContentSourcePolicyList lists the items in the ImageContentSourcePolicy CRD.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "metadata",
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.ImageContentSourcePolicy"
- }
- },
- "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",
- "type": "string"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageSpec"
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.ImageContentSourcePolicySpec": {
- "description": "ImageContentSourcePolicySpec is the specification of the ImageContentSourcePolicy CRD.",
- "type": "object",
- "properties": {
- "repositoryDigestMirrors": {
- "description": "repositoryDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in RepositoryDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. Only image pull specifications that have an image digest will have this behavior applied to them - tags will continue to be pulled from the specified repository in the pull spec.\n\nEach “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.RepositoryDigestMirrors"
- }
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.LoggingConfig": {
- "description": "LoggingConfig holds information about configuring logging DEPRECATED: Use v1.LogLevel instead",
- "type": "object",
- "required": [
- "level",
- "vmodule"
- ],
- "properties": {
- "level": {
- "description": "level is passed to glog.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "vmodule": {
- "description": "vmodule is passed to glog.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.NodeStatus": {
- "description": "NodeStatus provides information about the current state of a particular node managed by this operator. Deprecated: Use v1.NodeStatus instead",
- "type": "object",
- "required": [
- "nodeName",
- "currentDeploymentGeneration",
- "targetDeploymentGeneration",
- "lastFailedDeploymentGeneration",
- "lastFailedDeploymentErrors"
- ],
- "properties": {
- "currentDeploymentGeneration": {
- "description": "currentDeploymentGeneration is the generation of the most recently successful deployment",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "lastFailedDeploymentErrors": {
- "description": "lastFailedDeploymentGenerationErrors is a list of the errors during the failed deployment referenced in lastFailedDeploymentGeneration",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "lastFailedDeploymentGeneration": {
- "description": "lastFailedDeploymentGeneration is the generation of the deployment we tried and failed to deploy.",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "nodeName": {
- "description": "nodeName is the name of the node",
- "type": "string",
- "default": ""
- },
- "targetDeploymentGeneration": {
- "description": "targetDeploymentGeneration is the generation of the deployment we're trying to apply",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageStatus"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.OLM": {
- "description": "OLM provides information to configure an operator to manage the OLM controllers\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.ImageContentPolicy": {
+ "description": "ImageContentPolicy holds cluster-wide information about how to handle registry mirror rules. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "metadata",
"spec"
],
"properties": {
@@ -35083,17 +3358,12 @@
"spec": {
"description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.OLMSpec"
- },
- "status": {
- "description": "status holds observed values from the cluster. They may not be overridden.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.OLMStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageContentPolicySpec"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.OLMList": {
- "description": "OLMList is a collection of items\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.ImageContentPolicyList": {
+ "description": "ImageContentPolicyList lists the items in the ImageContentPolicy CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -35105,11 +3375,10 @@
"type": "string"
},
"items": {
- "description": "items contains the items",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.OLM"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageContentPolicy"
}
},
"kind": {
@@ -35123,380 +3392,182 @@
}
}
},
- "com.github.openshift.api.operator.v1alpha1.OLMSpec": {
- "type": "object",
- "required": [
- "managementState"
- ],
- "properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- },
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.OLMStatus": {
+ "com.github.openshift.api.config.v1.ImageContentPolicySpec": {
+ "description": "ImageContentPolicySpec is the specification of the ImageContentPolicy CRD.",
"type": "object",
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "repositoryDigestMirrors": {
+ "description": "repositoryDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in RepositoryDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To pull image from mirrors by tags, should set the \"allowMirrorByTags\".\n\nEach “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.RepositoryDigestMirrors"
},
"x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
+ "source"
],
"x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.OperatorCondition": {
- "description": "OperatorCondition is just the standard condition fields. DEPRECATED: Use v1.OperatorCondition instead",
+ "com.github.openshift.api.config.v1.ImageDigestMirrorSet": {
+ "description": "ImageDigestMirrorSet holds cluster-wide information about how to handle registry mirror rules on using digest pull specification. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "type",
- "status"
+ "spec"
],
"properties": {
- "lastTransitionTime": {
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
+ "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",
"type": "string"
},
- "reason": {
+ "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",
"type": "string"
},
- "status": {
- "type": "string",
- "default": ""
- },
- "type": {
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.OperatorSpec": {
- "description": "OperatorSpec contains common fields for an operator to need. It is intended to be anonymous included inside of the Spec struct for you particular operator. DEPRECATED: Use v1.OperatorSpec instead",
- "type": "object",
- "required": [
- "managementState",
- "imagePullSpec",
- "imagePullPolicy",
- "version"
- ],
- "properties": {
- "imagePullPolicy": {
- "description": "imagePullPolicy specifies the image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.",
- "type": "string",
- "default": ""
- },
- "imagePullSpec": {
- "description": "imagePullSpec is the image to use for the component.",
- "type": "string",
- "default": ""
- },
- "logging": {
- "description": "logging contains glog parameters for the component pods. It's always a command line arg for the moment",
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.LoggingConfig"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
- "type": "string",
- "default": ""
- },
- "version": {
- "description": "version is the desired state in major.minor.micro-patch. Usually patch is ignored.",
- "type": "string",
- "default": ""
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.OperatorStatus": {
- "description": "OperatorStatus contains common fields for an operator to need. It is intended to be anonymous included inside of the Status struct for you particular operator. DEPRECATED: Use v1.OperatorStatus instead",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.OperatorCondition"
- }
- },
- "currentVersionAvailability": {
- "description": "currentVersionAvailability is availability information for the current version. If it is unmanged or removed, this doesn't exist.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.VersionAvailability"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "state": {
- "description": "state indicates what the operator has observed to be its current operational status.",
- "type": "string"
- },
- "targetVersionAvailability": {
- "description": "targetVersionAvailability is availability information for the target version if we are migrating",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.VersionAvailability"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "taskSummary": {
- "description": "taskSummary is a high level summary of what the controller is currently attempting to do. It is high-level, human-readable and not guaranteed in any way. (I needed this for debugging and realized it made a great summary).",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.operator.v1alpha1.RepositoryDigestMirrors": {
- "description": "RepositoryDigestMirrors holds cluster-wide information about how to handle mirros in the registries config. Note: the mirrors only work when pulling the images that are referenced by their digests.",
- "type": "object",
- "required": [
- "source"
- ],
- "properties": {
- "mirrors": {
- "description": "mirrors is one or more repositories that may also contain the same images. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. Other cluster configuration, including (but not limited to) other repositoryDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
+ "spec": {
+ "description": "spec holds user settable values for configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrorSetSpec"
},
- "source": {
- "description": "source is the repository that users refer to, e.g. in image pull specifications.",
- "type": "string",
- "default": ""
+ "status": {
+ "description": "status contains the observed state of the resource.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrorSetStatus"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.StaticPodOperatorStatus": {
- "description": "StaticPodOperatorStatus is status for controllers that manage static pods. There are different needs because individual node status must be tracked. DEPRECATED: Use v1.StaticPodOperatorStatus instead",
+ "com.github.openshift.api.config.v1.ImageDigestMirrorSetList": {
+ "description": "ImageDigestMirrorSetList lists the items in the ImageDigestMirrorSet CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "latestAvailableDeploymentGeneration",
- "nodeStatuses"
+ "metadata",
+ "items"
],
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
+ "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",
+ "type": "string"
+ },
+ "items": {
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.OperatorCondition"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrorSet"
}
},
- "currentVersionAvailability": {
- "description": "currentVersionAvailability is availability information for the current version. If it is unmanged or removed, this doesn't exist.",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.VersionAvailability"
- },
- "latestAvailableDeploymentGeneration": {
- "description": "latestAvailableDeploymentGeneration is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "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",
+ "type": "string"
},
- "nodeStatuses": {
- "description": "nodeStatuses track the deployment values and errors across individual nodes",
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.ImageDigestMirrorSetSpec": {
+ "description": "ImageDigestMirrorSetSpec is the specification of the ImageDigestMirrorSet CRD.",
+ "type": "object",
+ "properties": {
+ "imageDigestMirrors": {
+ "description": "imageDigestMirrors allows images referenced by image digests in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in imageDigestMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To use mirrors to pull images using tag specification, users should configure a list of mirrors using \"ImageTagMirrorSet\" CRD.\n\nIf the image pull specification matches the repository of \"source\" in multiple imagedigestmirrorset objects, only the objects which define the most specific namespace match will be used. For example, if there are objects using quay.io/libpod and quay.io/libpod/busybox as the \"source\", only the objects using quay.io/libpod/busybox are going to apply for pull specification quay.io/libpod/busybox. Each “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. Users who want to use a specific order of mirrors, should configure them into one list of mirrors using the expected order.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.NodeStatus"
- }
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "state": {
- "description": "state indicates what the operator has observed to be its current operational status.",
- "type": "string"
- },
- "targetVersionAvailability": {
- "description": "targetVersionAvailability is availability information for the target version if we are migrating",
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.VersionAvailability"
- },
- "taskSummary": {
- "description": "taskSummary is a high level summary of what the controller is currently attempting to do. It is high-level, human-readable and not guaranteed in any way. (I needed this for debugging and realized it made a great summary).",
- "type": "string"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageDigestMirrors"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.operator.v1alpha1.VersionAvailability": {
- "description": "VersionAvailability gives information about the synchronization and operational status of a particular version of the component DEPRECATED: Use fields in v1.OperatorStatus instead",
+ "com.github.openshift.api.config.v1.ImageDigestMirrorSetStatus": {
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.ImageDigestMirrors": {
+ "description": "ImageDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
"type": "object",
"required": [
- "version",
- "updatedReplicas",
- "readyReplicas",
- "errors",
- "generations"
+ "source"
],
"properties": {
- "errors": {
- "description": "errors indicates what failures are associated with the operator trying to manage this version",
+ "mirrorSourcePolicy": {
+ "description": "mirrorSourcePolicy defines the fallback policy if fails to pull image from the mirrors. If unset, the image will continue to be pulled from the the repository in the pull spec. sourcePolicy is valid configuration only when one or more mirrors are in the mirror list.",
+ "type": "string"
+ },
+ "mirrors": {
+ "description": "mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their digests. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair *.redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec unless explicitly prohibited by \"mirrorSourcePolicy\" Other cluster configuration, including (but not limited to) other imageDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. \"mirrors\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
"type": "array",
"items": {
"type": "string",
"default": ""
- }
- },
- "generations": {
- "description": "generations allows an operator to track what the generation of \"important\" resources was the last time we updated them",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1alpha1.GenerationHistory"
- }
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "updatedReplicas": {
- "description": "updatedReplicas indicates how many replicas are at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
+ },
+ "x-kubernetes-list-type": "set"
},
- "version": {
- "description": "version is the level this availability applies to",
+ "source": {
+ "description": "source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname e.g. docker.io. quay.io, or registry.redhat.io, will match the image pull specification of corressponding registry. \"source\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo [*.]host for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.operatorcontrolplane.v1alpha1.LogEntry": {
- "description": "LogEntry records events",
+ "com.github.openshift.api.config.v1.ImageLabel": {
"type": "object",
"required": [
- "time",
- "success"
+ "name"
],
"properties": {
- "latency": {
- "description": "latency records how long the action mentioned in the entry took.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
- },
- "message": {
- "description": "message explaining status in a human readable format.",
- "type": "string"
+ "name": {
+ "description": "name defines the name of the label. It must have non-zero length.",
+ "type": "string",
+ "default": ""
},
- "reason": {
- "description": "reason for status in a machine readable format.",
+ "value": {
+ "description": "value defines the literal value of the label.",
"type": "string"
- },
- "success": {
- "description": "success indicates if the log entry indicates a success or failure.",
- "type": "boolean",
- "default": false
- },
- "time": {
- "description": "Start time of check action.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}
}
},
- "com.github.openshift.api.operatorcontrolplane.v1alpha1.OutageEntry": {
- "description": "OutageEntry records time period of an outage",
+ "com.github.openshift.api.config.v1.ImageList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "start"
+ "metadata",
+ "items"
],
"properties": {
- "end": {
- "description": "end of outage detected",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
+ "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",
+ "type": "string"
},
- "endLogs": {
- "description": "endLogs contains log entries related to the end of this outage. Should contain the success entry that resolved the outage and possibly a few of the failure log entries that preceded it.",
+ "items": {
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.LogEntry"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Image"
}
},
- "message": {
- "description": "message summarizes outage details in a human readable format.",
+ "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",
"type": "string"
},
- "start": {
- "description": "start of outage detected",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "startLogs": {
- "description": "startLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.LogEntry"
- }
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheck": {
- "description": "PodNetworkConnectivityCheck\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.ImagePolicy": {
+ "description": "ImagePolicy holds namespace-wide configuration for image signature verification\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "metadata",
"spec"
],
"properties": {
@@ -35514,52 +3585,19 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec defines the source and target of the connectivity check",
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImagePolicySpec"
},
"status": {
- "description": "status contains the observed status of the connectivity check",
+ "description": "status contains the observed state of the resource.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckStatus"
- }
- }
- },
- "com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckCondition": {
- "description": "PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity.",
- "type": "object",
- "required": [
- "type",
- "status",
- "lastTransitionTime"
- ],
- "properties": {
- "lastTransitionTime": {
- "description": "Last time the condition transitioned from one status to another.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "message indicating details about last transition in a human readable format.",
- "type": "string"
- },
- "reason": {
- "description": "reason for the condition's last status transition in a machine readable format.",
- "type": "string"
- },
- "status": {
- "description": "status of the condition",
- "type": "string",
- "default": ""
- },
- "type": {
- "description": "type of the condition",
- "type": "string",
- "default": ""
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImagePolicyStatus"
}
}
},
- "com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckList": {
- "description": "PodNetworkConnectivityCheckList is a collection of PodNetworkConnectivityCheck\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.ImagePolicyList": {
+ "description": "ImagePolicyList is a list of ImagePolicy resources\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -35571,11 +3609,11 @@
"type": "string"
},
"items": {
- "description": "items contains the items",
+ "description": "items is a list of ImagePolicies",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheck"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImagePolicy"
}
},
"kind": {
@@ -35589,75 +3627,120 @@
}
}
},
- "com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckSpec": {
+ "com.github.openshift.api.config.v1.ImagePolicySpec": {
+ "description": "ImagePolicySpec is the specification of the ImagePolicy CRD.",
"type": "object",
"required": [
- "sourcePod",
- "targetEndpoint"
+ "scopes",
+ "policy"
],
"properties": {
- "sourcePod": {
- "description": "sourcePod names the pod from which the condition will be checked",
- "type": "string",
- "default": ""
- },
- "targetEndpoint": {
- "description": "EndpointAddress to check. A TCP address of the form host:port. Note that if host is a DNS name, then the check would fail if the DNS name cannot be resolved. Specify an IP address for host to bypass DNS name lookup.",
- "type": "string",
- "default": ""
- },
- "tlsClientCert": {
- "description": "TLSClientCert, if specified, references a kubernetes.io/tls type secret with 'tls.crt' and 'tls.key' entries containing an optional TLS client certificate and key to be used when checking endpoints that require a client certificate in order to gracefully preform the scan without causing excessive logging in the endpoint process. The secret must exist in the same namespace as this resource.",
+ "policy": {
+ "description": "policy is a required field that contains configuration to allow scopes to be verified, and defines how images not matching the verification policy will be treated.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Policy"
+ },
+ "scopes": {
+ "description": "scopes is a required field that defines the list of image identities assigned to a policy. Each item refers to a scope in a registry implementing the \"Docker Registry HTTP API V2\". Scopes matching individual images are named Docker references in the fully expanded form, either using a tag or digest. For example, docker.io/library/busybox:latest (not busybox:latest). More general scopes are prefixes of individual-image scopes, and specify a repository (by omitting the tag or digest), a repository namespace, or a registry host (by only specifying the host name and possibly a port number) or a wildcard expression starting with `*.`, for matching all subdomains (not including a port number). Wildcards are only supported for subdomain matching, and may not be used in the middle of the host, i.e. *.example.com is a valid case, but example*.*.com is not. This support no more than 256 scopes in one object. If multiple scopes match a given image, only the policy requirements for the most specific scope apply. The policy requirements for more general scopes are ignored. In addition to setting a policy appropriate for your own deployed applications, make sure that a policy on the OpenShift image repositories quay.io/openshift-release-dev/ocp-release, quay.io/openshift-release-dev/ocp-v4.0-art-dev (or on a more general scope) allows deployment of the OpenShift images required for cluster operation. If a scope is configured in both the ClusterImagePolicy and the ImagePolicy, or if the scope in ImagePolicy is nested under one of the scopes from the ClusterImagePolicy, only the policy from the ClusterImagePolicy will be applied. For additional details about the format, please refer to the document explaining the docker transport field, which can be found at: https://github.com/containers/image/blob/main/docs/containers-policy.json.5.md#docker",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "set"
}
}
},
- "com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckStatus": {
+ "com.github.openshift.api.config.v1.ImagePolicyStatus": {
"type": "object",
"properties": {
"conditions": {
- "description": "conditions summarize the status of the check",
+ "description": "conditions provide details on the status of this API Resource. condition type 'Pending' indicates that the customer resource contains a policy that cannot take effect. It is either overwritten by a global policy or the image scope is not valid.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.PodNetworkConnectivityCheckCondition"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
},
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
+ "x-kubernetes-list-map-keys": [
+ "type"
+ ],
+ "x-kubernetes-list-type": "map"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.ImageSpec": {
+ "type": "object",
+ "properties": {
+ "additionalTrustedCA": {
+ "description": "additionalTrustedCA is a reference to a ConfigMap containing additional CAs that should be trusted during imagestream import, pod image pull, build image pull, and imageregistry pullthrough. The namespace for this config map is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "failures": {
- "description": "failures contains logs of unsuccessful check actions",
+ "allowedRegistriesForImport": {
+ "description": "allowedRegistriesForImport limits the container image registries that normal users may import images from. Set this list to the registries that you trust to contain valid Docker images and that you want applications to be able to import from. Users with permission to create Images or ImageStreamMappings via the API are not affected by this policy - typically only administrators or system integrations will have those permissions.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.LogEntry"
- }
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.RegistryLocation"
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "outages": {
- "description": "outages contains logs of time periods of outages",
+ "externalRegistryHostnames": {
+ "description": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.OutageEntry"
- }
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "imageStreamImportMode": {
+ "description": "imageStreamImportMode controls the import mode behaviour of imagestreams. It can be set to `Legacy` or `PreserveOriginal` or the empty string. If this value is specified, this setting is applied to all newly created imagestreams which do not have the value set. `Legacy` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. `PreserveOriginal` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported. When empty, the behaviour will be decided based on the payload type advertised by the ClusterVersion status, i.e single arch payload implies the import mode is Legacy and multi payload implies PreserveOriginal.\n\nPossible enum values:\n - `\"Legacy\"` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. This mode is the default.\n - `\"PreserveOriginal\"` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported.",
+ "type": "string",
+ "default": "",
+ "enum": [
+ "Legacy",
+ "PreserveOriginal"
+ ]
},
- "successes": {
- "description": "successes contains logs successful check actions",
+ "registrySources": {
+ "description": "registrySources contains configuration that determines how the container runtime should treat individual registries when accessing images for builds+pods. (e.g. whether or not to allow insecure access). It does not contain configuration for the internal cluster registry.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.RegistrySources"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.ImageStatus": {
+ "type": "object",
+ "properties": {
+ "externalRegistryHostnames": {
+ "description": "externalRegistryHostnames provides the hostnames for the default external image registry. The external hostname should be set only when the image registry is exposed externally. The first value is used in 'publicDockerImageRepository' field in ImageStreams. The value must be in \"hostname[:port]\" format.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatorcontrolplane.v1alpha1.LogEntry"
- }
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "imageStreamImportMode": {
+ "description": "imageStreamImportMode controls the import mode behaviour of imagestreams. It can be `Legacy` or `PreserveOriginal`. `Legacy` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. `PreserveOriginal` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported. This value will be reconciled based on either the spec value or if no spec value is specified, the image registry operator would look at the ClusterVersion status to determine the payload type and set the import mode accordingly, i.e single arch payload implies the import mode is Legacy and multi payload implies PreserveOriginal.\n\nPossible enum values:\n - `\"Legacy\"` indicates that the legacy behaviour should be used. For manifest lists, the legacy behaviour will discard the manifest list and import a single sub-manifest. In this case, the platform is chosen in the following order of priority: 1. tag annotations; 2. control plane arch/os; 3. linux/amd64; 4. the first manifest in the list. This mode is the default.\n - `\"PreserveOriginal\"` indicates that the original manifest will be preserved. For manifest lists, the manifest list and all its sub-manifests will be imported.",
+ "type": "string",
+ "enum": [
+ "Legacy",
+ "PreserveOriginal"
+ ]
+ },
+ "internalRegistryHostname": {
+ "description": "internalRegistryHostname sets the hostname for the default internal image registry. The value must be in \"hostname[:port]\" format. This value is set by the image registry operator which controls the internal registry hostname.",
+ "type": "string"
}
}
},
- "com.github.openshift.api.operatoringress.v1.DNSRecord": {
- "description": "DNSRecord is a DNS record managed in the zones defined by dns.config.openshift.io/cluster .spec.publicZone and .spec.privateZone.\n\nCluster admin manipulation of this resource is not supported. This resource is only for internal communication of OpenShift operators.\n\nIf DNSManagementPolicy is \"Unmanaged\", the operator will not be responsible for managing the DNS records on the cloud provider.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ImageTagMirrorSet": {
+ "description": "ImageTagMirrorSet holds cluster-wide information about how to handle registry mirror rules on using tag pull specification. When multiple policies are defined, the outcome of the behavior is defined on each field.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "spec",
- "status"
+ "spec"
],
"properties": {
"apiVersion": {
@@ -35674,21 +3757,22 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec is the specification of the desired behavior of the dnsRecord.",
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatoringress.v1.DNSRecordSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrorSetSpec"
},
"status": {
- "description": "status is the most recently observed status of the dnsRecord.",
+ "description": "status contains the observed state of the resource.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatoringress.v1.DNSRecordStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrorSetStatus"
}
}
},
- "com.github.openshift.api.operatoringress.v1.DNSRecordList": {
- "description": "DNSRecordList contains a list of dnsrecords.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ImageTagMirrorSetList": {
+ "description": "ImageTagMirrorSetList lists the items in the ImageTagMirrorSet CRD.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -35700,7 +3784,7 @@
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatoringress.v1.DNSRecord"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrorSet"
}
},
"kind": {
@@ -35714,456 +3798,510 @@
}
}
},
- "com.github.openshift.api.operatoringress.v1.DNSRecordSpec": {
- "description": "DNSRecordSpec contains the details of a DNS record.",
+ "com.github.openshift.api.config.v1.ImageTagMirrorSetSpec": {
+ "description": "ImageTagMirrorSetSpec is the specification of the ImageTagMirrorSet CRD.",
"type": "object",
- "required": [
- "dnsName",
- "targets",
- "recordType",
- "recordTTL",
- "dnsManagementPolicy"
- ],
"properties": {
- "dnsManagementPolicy": {
- "description": "dnsManagementPolicy denotes the current policy applied on the DNS record. Records that have policy set as \"Unmanaged\" are ignored by the ingress operator. This means that the DNS record on the cloud provider is not managed by the operator, and the \"Published\" status condition will be updated to \"Unknown\" status, since it is externally managed. Any existing record on the cloud provider can be deleted at the discretion of the cluster admin.\n\nThis field defaults to Managed. Valid values are \"Managed\" and \"Unmanaged\".",
- "type": "string",
- "default": "Managed"
- },
- "dnsName": {
- "description": "dnsName is the hostname of the DNS record",
- "type": "string",
- "default": ""
- },
- "recordTTL": {
- "description": "recordTTL is the record TTL in seconds. If zero, the default is 30. RecordTTL will not be used in AWS regions Alias targets, but will be used in CNAME targets, per AWS API contract.",
- "type": "integer",
- "format": "int64",
- "default": 0
- },
- "recordType": {
- "description": "recordType is the DNS record type. For example, \"A\" or \"CNAME\".",
- "type": "string",
- "default": ""
- },
- "targets": {
- "description": "targets are record targets.",
+ "imageTagMirrors": {
+ "description": "imageTagMirrors allows images referenced by image tags in pods to be pulled from alternative mirrored repository locations. The image pull specification provided to the pod will be compared to the source locations described in imageTagMirrors and the image may be pulled down from any of the mirrors in the list instead of the specified repository allowing administrators to choose a potentially faster mirror. To use mirrors to pull images using digest specification only, users should configure a list of mirrors using \"ImageDigestMirrorSet\" CRD.\n\nIf the image pull specification matches the repository of \"source\" in multiple imagetagmirrorset objects, only the objects which define the most specific namespace match will be used. For example, if there are objects using quay.io/libpod and quay.io/libpod/busybox as the \"source\", only the objects using quay.io/libpod/busybox are going to apply for pull specification quay.io/libpod/busybox. Each “source” repository is treated independently; configurations for different “source” repositories don’t interact.\n\nIf the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec.\n\nWhen multiple policies are defined for the same “source” repository, the sets of defined mirrors will be merged together, preserving the relative order of the mirrors, if possible. For example, if policy A has mirrors `a, b, c` and policy B has mirrors `c, d, e`, the mirrors will be used in the order `a, b, c, d, e`. If the orders of mirror entries conflict (e.g. `a, b` vs. `b, a`) the configuration is not rejected but the resulting order is unspecified. Users who want to use a deterministic order of mirrors, should configure them into one list of mirrors using the expected order.",
"type": "array",
"items": {
- "type": "string",
- "default": ""
- }
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ImageTagMirrors"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.operatoringress.v1.DNSRecordStatus": {
- "description": "DNSRecordStatus is the most recently observed status of each record.",
+ "com.github.openshift.api.config.v1.ImageTagMirrorSetStatus": {
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.ImageTagMirrors": {
+ "description": "ImageTagMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
"type": "object",
+ "required": [
+ "source"
+ ],
"properties": {
- "observedGeneration": {
- "description": "observedGeneration is the most recently observed generation of the DNSRecord. When the DNSRecord is updated, the controller updates the corresponding record in each managed zone. If an update for a particular zone fails, that failure is recorded in the status condition for the zone so that the controller can determine that it needs to retry the update for that specific zone.",
- "type": "integer",
- "format": "int64"
+ "mirrorSourcePolicy": {
+ "description": "mirrorSourcePolicy defines the fallback policy if fails to pull image from the mirrors. If unset, the image will continue to be pulled from the repository in the pull spec. sourcePolicy is valid configuration only when one or more mirrors are in the mirror list.",
+ "type": "string"
},
- "zones": {
- "description": "zones are the status of the record in each zone.",
+ "mirrors": {
+ "description": "mirrors is zero or more locations that may also contain the same images. No mirror will be configured if not specified. Images can be pulled from these mirrors only if they are referenced by their tags. The mirrored location is obtained by replacing the part of the input reference that matches source by the mirrors entry, e.g. for registry.redhat.io/product/repo reference, a (source, mirror) pair *.redhat.io, mirror.local/redhat causes a mirror.local/redhat/product/repo repository to be used. Pulling images by tag can potentially yield different images, depending on which endpoint we pull from. Configuring a list of mirrors using \"ImageDigestMirrorSet\" CRD and forcing digest-pulls for mirrors avoids that issue. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. If no mirror is specified or all image pulls from the mirror list fail, the image will continue to be pulled from the repository in the pull spec unless explicitly prohibited by \"mirrorSourcePolicy\". Other cluster configuration, including (but not limited to) other imageTagMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering. \"mirrors\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatoringress.v1.DNSZoneStatus"
- }
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "set"
+ },
+ "source": {
+ "description": "source matches the repository that users refer to, e.g. in image pull specifications. Setting source to a registry hostname e.g. docker.io. quay.io, or registry.redhat.io, will match the image pull specification of corressponding registry. \"source\" uses one of the following formats: host[:port] host[:port]/namespace[/namespace…] host[:port]/namespace[/namespace…]/repo [*.]host for more information about the format, see the document about the location field: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md#choosing-a-registry-toml-table",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.operatoringress.v1.DNSZoneCondition": {
- "description": "DNSZoneCondition is just the standard condition fields.",
+ "com.github.openshift.api.config.v1.Infrastructure": {
+ "description": "Infrastructure holds cluster-wide information about Infrastructure. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "type",
- "status"
+ "spec"
],
"properties": {
- "lastTransitionTime": {
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
+ "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",
"type": "string"
},
- "reason": {
+ "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",
"type": "string"
},
- "status": {
- "type": "string",
- "default": ""
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "type": {
- "type": "string",
- "default": ""
+ "spec": {
+ "description": "spec holds user settable values for configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.InfrastructureSpec"
+ },
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.InfrastructureStatus"
}
}
},
- "com.github.openshift.api.operatoringress.v1.DNSZoneStatus": {
- "description": "DNSZoneStatus is the status of a record within a specific zone.",
+ "com.github.openshift.api.config.v1.InfrastructureList": {
+ "description": "InfrastructureList is\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "dnsZone"
+ "metadata",
+ "items"
],
"properties": {
- "conditions": {
- "description": "conditions are any conditions associated with the record in the zone.\n\nIf publishing the record succeeds, the \"Published\" condition will be set with status \"True\" and upon failure it will be set to \"False\" along with the reason and message describing the cause of the failure.",
+ "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",
+ "type": "string"
+ },
+ "items": {
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.operatoringress.v1.DNSZoneCondition"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Infrastructure"
}
},
- "dnsZone": {
- "description": "dnsZone is the zone where the record is published.",
+ "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",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.DNSZone"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.osin.v1.AllowAllPasswordIdentityProvider": {
- "description": "AllowAllPasswordIdentityProvider provides identities for users authenticating using non-empty passwords\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.InfrastructureSpec": {
+ "description": "InfrastructureSpec contains settings that apply to the cluster infrastructure.",
"type": "object",
"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",
- "type": "string"
+ "cloudConfig": {
+ "description": "cloudConfig is a reference to a ConfigMap containing the cloud provider configuration file. This configuration file is used to configure the Kubernetes cloud provider integration when using the built-in cloud provider integration or the external cloud controller manager. The namespace for this config map is openshift-config.\n\ncloudConfig should only be consumed by the kube_cloud_config controller. The controller is responsible for using the user configuration in the spec for various platforms and combining that with the user provided ConfigMap in this field to create a stitched kube cloud config. The controller generates a ConfigMap `kube-cloud-config` in `openshift-config-managed` namespace with the kube cloud config is stored in `cloud.conf` key. All the clients are expected to use the generated ConfigMap only.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapFileReference"
},
- "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",
- "type": "string"
+ "platformSpec": {
+ "description": "platformSpec holds desired information specific to the underlying infrastructure provider.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PlatformSpec"
}
}
},
- "com.github.openshift.api.osin.v1.BasicAuthPasswordIdentityProvider": {
- "description": "BasicAuthPasswordIdentityProvider provides identities for users authenticating using HTTP basic auth credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.InfrastructureStatus": {
+ "description": "InfrastructureStatus describes the infrastructure the cluster is leveraging.",
"type": "object",
- "required": [
- "url",
- "ca",
- "certFile",
- "keyFile"
- ],
"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",
- "type": "string"
+ "apiServerInternalURI": {
+ "description": "apiServerInternalURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerInternalURL can be used by components like kubelets, to contact the Kubernetes API server using the infrastructure provider rather than Kubernetes networking.",
+ "type": "string",
+ "default": ""
},
- "ca": {
- "description": "ca is the CA for verifying TLS connections",
+ "apiServerURL": {
+ "description": "apiServerURL is a valid URI with scheme 'https', address and optionally a port (defaulting to 443). apiServerURL can be used by components like the web console to tell users where to find the Kubernetes API.",
"type": "string",
"default": ""
},
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
+ "controlPlaneTopology": {
+ "description": "controlPlaneTopology expresses the expectations for operands that normally run on control nodes. The default is 'HighlyAvailable', which represents the behavior operators have in a \"normal\" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation The 'External' mode indicates that the control plane is hosted externally to the cluster and that its components are not visible within the cluster.",
"type": "string",
"default": ""
},
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "cpuPartitioning": {
+ "description": "cpuPartitioning expresses if CPU partitioning is a currently enabled feature in the cluster. CPU Partitioning means that this cluster can support partitioning workloads to specific CPU Sets. Valid values are \"None\" and \"AllNodes\". When omitted, the default value is \"None\". The default value of \"None\" indicates that no nodes will be setup with CPU partitioning. The \"AllNodes\" value indicates that all nodes have been setup with CPU partitioning, and can then be further configured via the PerformanceProfile API.",
+ "type": "string",
+ "default": "None"
+ },
+ "etcdDiscoveryDomain": {
+ "description": "etcdDiscoveryDomain is the domain used to fetch the SRV records for discovering etcd servers and clients. For more info: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery deprecated: as of 4.7, this field is no longer set or honored. It will be removed in a future release.",
"type": "string",
"default": ""
},
+ "infrastructureName": {
+ "description": "infrastructureName uniquely identifies a cluster with a human friendly name. Once set it should not be changed. Must be of max length 27 and must have only alphanumeric or hyphen characters.",
+ "type": "string",
+ "default": ""
+ },
+ "infrastructureTopology": {
+ "description": "infrastructureTopology expresses the expectations for infrastructure services that do not run on control plane nodes, usually indicated by a node selector for a `role` value other than `master`. The default is 'HighlyAvailable', which represents the behavior operators have in a \"normal\" cluster. The 'SingleReplica' mode will be used in single-node deployments and the operators should not configure the operand for highly-available operation NOTE: External topology mode is not applicable for this field.",
+ "type": "string"
+ },
+ "platform": {
+ "description": "platform is the underlying infrastructure provider for the cluster.\n\nDeprecated: Use platformStatus.type instead.",
+ "type": "string"
+ },
+ "platformStatus": {
+ "description": "platformStatus holds status information specific to the underlying infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PlatformStatus"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.Ingress": {
+ "description": "Ingress holds cluster-wide information about ingress, including the default ingress domain used for routes. The canonical name is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "type": "object",
+ "required": [
+ "spec"
+ ],
+ "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",
+ "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",
"type": "string"
},
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ },
+ "spec": {
+ "description": "spec holds user settable values for configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IngressSpec"
+ },
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IngressStatus"
}
}
},
- "com.github.openshift.api.osin.v1.DenyAllPasswordIdentityProvider": {
- "description": "DenyAllPasswordIdentityProvider provides no identities for users\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.IngressList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
+ "required": [
+ "metadata",
+ "items"
+ ],
"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",
"type": "string"
},
+ "items": {
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Ingress"
+ }
+ },
"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",
"type": "string"
+ },
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.osin.v1.GitHubIdentityProvider": {
- "description": "GitHubIdentityProvider provides identities for users authenticating using GitHub credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.IngressPlatformSpec": {
+ "description": "IngressPlatformSpec holds the desired state of Ingress specific to the underlying infrastructure provider of the current cluster. Since these are used at spec-level for the underlying cluster, it is supposed that only one of the spec structs is set.",
"type": "object",
"required": [
- "clientID",
- "clientSecret",
- "organizations",
- "teams",
- "hostname",
- "ca"
+ "type"
+ ],
+ "properties": {
+ "aws": {
+ "description": "aws contains settings specific to the Amazon Web Services infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSIngressSpec"
+ },
+ "type": {
+ "description": "type is the underlying infrastructure provider for the cluster. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"KubeVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.",
+ "type": "string",
+ "default": ""
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {
+ "aws": "AWS"
+ }
+ }
+ ]
+ },
+ "com.github.openshift.api.config.v1.IngressSpec": {
+ "type": "object",
+ "required": [
+ "domain"
],
"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",
+ "appsDomain": {
+ "description": "appsDomain is an optional domain to use instead of the one specified in the domain field when a Route is created without specifying an explicit host. If appsDomain is nonempty, this value is used to generate default host values for Route. Unlike domain, appsDomain may be modified after installation. This assumes a new ingresscontroller has been setup with a wildcard certificate.",
"type": "string"
},
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server. If empty, the default system roots are used. This can only be configured when hostname is set to a non-empty value.",
- "type": "string",
- "default": ""
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.StringSource"
+ "componentRoutes": {
+ "description": "componentRoutes is an optional list of routes that are managed by OpenShift components that a cluster-admin is able to configure the hostname and serving certificate for. The namespace and name of each route in this list should match an existing entry in the status.componentRoutes list.\n\nTo determine the set of configurable Routes, look at namespace and name of entries in the .status.componentRoutes list, where participating operators write the status of configurable routes.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ComponentRouteSpec"
+ },
+ "x-kubernetes-list-map-keys": [
+ "namespace",
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
},
- "hostname": {
- "description": "hostname is the optional domain (e.g. \"mycompany.com\") for use with a hosted instance of GitHub Enterprise. It must match the GitHub Enterprise settings value that is configured at /setup/settings#hostname.",
+ "domain": {
+ "description": "domain is used to generate a default host name for a route when the route's host name is empty. The generated host name will follow this pattern: \"..\".\n\nIt is also used as the default wildcard domain suffix for ingress. The default ingresscontroller domain will follow this pattern: \"*.\".\n\nOnce set, changing domain is not currently supported.",
"type": "string",
"default": ""
},
- "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",
- "type": "string"
+ "loadBalancer": {
+ "description": "loadBalancer contains the load balancer details in general which are not only specific to the underlying infrastructure provider of the current cluster and are required for Ingress Controller to work on OpenShift.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.LoadBalancer"
},
- "organizations": {
- "description": "organizations optionally restricts which organizations are allowed to log in",
+ "requiredHSTSPolicies": {
+ "description": "requiredHSTSPolicies specifies HSTS policies that are required to be set on newly created or updated routes matching the domainPattern/s and namespaceSelector/s that are specified in the policy. Each requiredHSTSPolicy must have at least a domainPattern and a maxAge to validate a route HSTS Policy route annotation, and affect route admission.\n\nA candidate route is checked for HSTS Policies if it has the HSTS Policy route annotation: \"haproxy.router.openshift.io/hsts_header\" E.g. haproxy.router.openshift.io/hsts_header: max-age=31536000;preload;includeSubDomains\n\n- For each candidate route, if it matches a requiredHSTSPolicy domainPattern and optional namespaceSelector, then the maxAge, preloadPolicy, and includeSubdomainsPolicy must be valid to be admitted. Otherwise, the route is rejected. - The first match, by domainPattern and optional namespaceSelector, in the ordering of the RequiredHSTSPolicies determines the route's admission status. - If the candidate route doesn't match any requiredHSTSPolicy domainPattern and optional namespaceSelector, then it may use any HSTS Policy annotation.\n\nThe HSTS policy configuration may be changed after routes have already been created. An update to a previously admitted route may then fail if the updated route does not conform to the updated HSTS policy configuration. However, changing the HSTS policy configuration will not cause a route that is already admitted to stop working.\n\nNote that if there are no RequiredHSTSPolicies, any HSTS Policy annotation on the route is valid.",
"type": "array",
"items": {
- "type": "string",
- "default": ""
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.RequiredHSTSPolicy"
}
- },
- "teams": {
- "description": "teams optionally restricts which teams are allowed to log in. Format is /.",
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.IngressStatus": {
+ "type": "object",
+ "properties": {
+ "componentRoutes": {
+ "description": "componentRoutes is where participating operators place the current route status for routes whose hostnames and serving certificates can be customized by the cluster-admin.",
"type": "array",
"items": {
- "type": "string",
- "default": ""
- }
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ComponentRouteStatus"
+ },
+ "x-kubernetes-list-map-keys": [
+ "namespace",
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "defaultPlacement": {
+ "description": "defaultPlacement is set at installation time to control which nodes will host the ingress router pods by default. The options are control-plane nodes or worker nodes.\n\nThis field works by dictating how the Cluster Ingress Operator will consider unset replicas and nodePlacement fields in IngressController resources when creating the corresponding Deployments.\n\nSee the documentation for the IngressController replicas and nodePlacement fields for more information.\n\nWhen omitted, the default value is Workers",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.osin.v1.GitLabIdentityProvider": {
- "description": "GitLabIdentityProvider provides identities for users authenticating using GitLab credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.InsightsDataGather": {
+ "description": "InsightsDataGather provides data gather configuration options for the Insights Operator.\n\n\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "ca",
- "url",
- "clientID",
- "clientSecret"
+ "spec"
],
"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",
"type": "string"
},
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used",
- "type": "string",
- "default": ""
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.StringSource"
- },
"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",
"type": "string"
},
- "legacy": {
- "description": "legacy determines if OAuth2 or OIDC should be used If true, OAuth2 is used If false, OIDC is used If nil and the URL's host is gitlab.com, OIDC is used Otherwise, OAuth2 is used In a future release, nil will default to using OIDC Eventually this flag will be removed and only OIDC will be used",
- "type": "boolean"
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "url": {
- "description": "url is the oauth server base URL",
- "type": "string",
- "default": ""
+ "spec": {
+ "description": "spec holds user settable values for configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.InsightsDataGatherSpec"
}
}
},
- "com.github.openshift.api.osin.v1.GoogleIdentityProvider": {
- "description": "GoogleIdentityProvider provides identities for users authenticating using Google credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.InsightsDataGatherList": {
+ "description": "InsightsDataGatherList is a collection of items Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "clientID",
- "clientSecret",
- "hostedDomain"
+ "metadata",
+ "items"
],
"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",
"type": "string"
},
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.StringSource"
- },
- "hostedDomain": {
- "description": "hostedDomain is the optional Google App domain (e.g. \"mycompany.com\") to restrict logins to",
- "type": "string",
- "default": ""
+ "items": {
+ "description": "items is the required list of InsightsDataGather objects it may not exceed 100 items",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.InsightsDataGather"
+ }
},
"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",
"type": "string"
+ },
+ "metadata": {
+ "description": "metadata is the required standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.osin.v1.GrantConfig": {
- "description": "GrantConfig holds the necessary configuration options for grant handlers",
+ "com.github.openshift.api.config.v1.InsightsDataGatherSpec": {
+ "description": "InsightsDataGatherSpec contains the configuration for the data gathering.",
"type": "object",
"required": [
- "method",
- "serviceAccountMethod"
+ "gatherConfig"
],
"properties": {
- "method": {
- "description": "method determines the default strategy to use when an OAuth client requests a grant. This method will be used only if the specific OAuth client doesn't provide a strategy of their own. Valid grant handling methods are:\n - auto: always approves grant requests, useful for trusted clients\n - prompt: prompts the end user for approval of grant requests, useful for third-party clients\n - deny: always denies grant requests, useful for black-listed clients",
- "type": "string",
- "default": ""
- },
- "serviceAccountMethod": {
- "description": "serviceAccountMethod is used for determining client authorization for service account oauth client. It must be either: deny, prompt",
- "type": "string",
- "default": ""
+ "gatherConfig": {
+ "description": "gatherConfig is a required spec attribute that includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GatherConfig"
}
}
},
- "com.github.openshift.api.osin.v1.HTPasswdPasswordIdentityProvider": {
- "description": "HTPasswdPasswordIdentityProvider provides identities for users authenticating using htpasswd credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.IntermediateTLSProfile": {
+ "description": "IntermediateTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.KMSConfig": {
+ "description": "KMSConfig defines the configuration for the KMS instance that will be used with KMSEncryptionProvider encryption",
"type": "object",
"required": [
- "file"
+ "type"
],
"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",
- "type": "string"
+ "aws": {
+ "description": "aws defines the key config for using an AWS KMS instance for the encryption. The AWS KMS instance is managed by the user outside the purview of the control plane.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSKMSConfig"
},
- "file": {
- "description": "file is a reference to your htpasswd file",
+ "type": {
+ "description": "type defines the kind of platform for the KMS provider. Available provider types are AWS only.",
"type": "string",
"default": ""
- },
- "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",
- "type": "string"
}
- }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {
+ "aws": "AWS"
+ }
+ }
+ ]
},
- "com.github.openshift.api.osin.v1.IdentityProvider": {
- "description": "IdentityProvider provides identities for users authenticating using credentials",
+ "com.github.openshift.api.config.v1.KeystoneIdentityProvider": {
+ "description": "KeystonePasswordIdentityProvider provides identities for users authenticating using keystone password credentials",
"type": "object",
"required": [
- "name",
- "challenge",
- "login",
- "mappingMethod",
- "provider"
+ "url",
+ "domainName"
],
"properties": {
- "challenge": {
- "description": "challenge indicates whether to issue WWW-Authenticate challenges for this provider",
- "type": "boolean",
- "default": false
- },
- "login": {
- "description": "login indicates whether to use this identity provider for unauthenticated browsers to login against",
- "type": "boolean",
- "default": false
+ "ca": {
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "mappingMethod": {
- "description": "mappingMethod determines how identities from this provider are mapped to users",
+ "domainName": {
+ "description": "domainName is required for keystone v3",
"type": "string",
"default": ""
},
- "name": {
- "description": "name is used to qualify the identities returned by this provider",
+ "tlsClientCert": {
+ "description": "tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key \"tls.crt\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "tlsClientKey": {
+ "description": "tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key \"tls.key\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "url": {
+ "description": "url is the remote URL to connect to",
"type": "string",
"default": ""
- },
- "provider": {
- "description": "provider contains the information about how to set up a specific identity provider",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
}
}
},
- "com.github.openshift.api.osin.v1.KeystonePasswordIdentityProvider": {
- "description": "KeystonePasswordIdentityProvider provides identities for users authenticating using keystone password credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.KubeClientConfig": {
"type": "object",
"required": [
- "url",
- "ca",
- "certFile",
- "keyFile",
- "domainName",
- "useKeystoneIdentity"
+ "kubeConfig",
+ "connectionOverrides"
],
"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",
- "type": "string"
- },
- "ca": {
- "description": "ca is the CA for verifying TLS connections",
- "type": "string",
- "default": ""
- },
- "certFile": {
- "description": "certFile is a file containing a PEM-encoded certificate",
- "type": "string",
- "default": ""
- },
- "domainName": {
- "description": "domainName is required for keystone v3",
- "type": "string",
- "default": ""
+ "connectionOverrides": {
+ "description": "connectionOverrides specifies client overrides for system components to loop back to this master.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClientConnectionOverrides"
},
- "keyFile": {
- "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "kubeConfig": {
+ "description": "kubeConfig is a .kubeconfig filename for going to the owning kube-apiserver. Empty uses an in-cluster-config",
"type": "string",
"default": ""
- },
- "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",
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.KubevirtPlatformSpec": {
+ "description": "KubevirtPlatformSpec holds the desired state of the kubevirt infrastructure provider. This only includes fields that can be modified in the cluster.",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.KubevirtPlatformStatus": {
+ "description": "KubevirtPlatformStatus holds the current status of the kubevirt infrastructure provider.",
+ "type": "object",
+ "properties": {
+ "apiServerInternalIP": {
+ "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.",
"type": "string"
},
- "url": {
- "description": "url is the remote URL to connect to",
- "type": "string",
- "default": ""
- },
- "useKeystoneIdentity": {
- "description": "useKeystoneIdentity flag indicates that user should be authenticated by keystone ID, not by username",
- "type": "boolean",
- "default": false
+ "ingressIP": {
+ "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.",
+ "type": "string"
}
}
},
- "com.github.openshift.api.osin.v1.LDAPAttributeMapping": {
+ "com.github.openshift.api.config.v1.LDAPAttributeMapping": {
"description": "LDAPAttributeMapping maps LDAP attributes to OpenShift identity fields",
"type": "object",
"required": [
- "id",
- "preferredUsername",
- "name",
- "email"
+ "id"
],
"properties": {
"email": {
@@ -36175,7 +4313,7 @@
}
},
"id": {
- "description": "id is the list of attributes whose values should be used as the user ID. Required. LDAP standard identity attribute is \"dn\"",
+ "description": "id is the list of attributes whose values should be used as the user ID. Required. First non-empty attribute is used. At least one attribute is required. If none of the listed attribute have a value, authentication fails. LDAP standard identity attribute is \"dn\"",
"type": "array",
"items": {
"type": "string",
@@ -36200,26 +4338,19 @@
}
}
},
- "com.github.openshift.api.osin.v1.LDAPPasswordIdentityProvider": {
- "description": "LDAPPasswordIdentityProvider provides identities for users authenticating using LDAP credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.LDAPIdentityProvider": {
+ "description": "LDAPPasswordIdentityProvider provides identities for users authenticating using LDAP credentials",
"type": "object",
"required": [
"url",
- "bindDN",
- "bindPassword",
"insecure",
- "ca",
"attributes"
],
"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",
- "type": "string"
- },
"attributes": {
"description": "attributes maps LDAP attributes to identities",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.LDAPAttributeMapping"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.LDAPAttributeMapping"
},
"bindDN": {
"description": "bindDN is an optional DN to bind with during the search phase.",
@@ -36227,511 +4358,397 @@
"default": ""
},
"bindPassword": {
- "description": "bindPassword is an optional password to bind with during the search phase.",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.StringSource"
+ "description": "bindPassword is an optional reference to a secret by name containing a password to bind with during the search phase. The key \"bindPassword\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
},
"ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used",
- "type": "string",
- "default": ""
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
"insecure": {
- "description": "insecure, if true, indicates the connection should not use TLS. Cannot be set to true with a URL scheme of \"ldaps://\" If false, \"ldaps://\" URLs connect using TLS, and \"ldap://\" URLs are upgraded to a TLS connection using StartTLS as specified in https://tools.ietf.org/html/rfc2830",
+ "description": "insecure, if true, indicates the connection should not use TLS WARNING: Should not be set to `true` with the URL scheme \"ldaps://\" as \"ldaps://\" URLs always\n attempt to connect using TLS, even when `insecure` is set to `true`\nWhen `true`, \"ldap://\" URLS connect insecurely. When `false`, \"ldap://\" URLs are upgraded to a TLS connection using StartTLS as specified in https://tools.ietf.org/html/rfc2830.",
"type": "boolean",
"default": false
},
- "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",
- "type": "string"
- },
"url": {
- "description": "url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is\n ldap://host:port/basedn?attribute?scope?filter",
+ "description": "url is an RFC 2255 URL which specifies the LDAP search parameters to use. The syntax of the URL is: ldap://host:port/basedn?attribute?scope?filter",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.osin.v1.OAuthConfig": {
- "description": "OAuthConfig holds the necessary configuration options for OAuth authentication",
+ "com.github.openshift.api.config.v1.LeaderElection": {
+ "description": "LeaderElection provides information to elect a leader",
"type": "object",
"required": [
- "masterCA",
- "masterURL",
- "masterPublicURL",
- "loginURL",
- "assetPublicURL",
- "alwaysShowProviderSelection",
- "identityProviders",
- "grantConfig",
- "sessionConfig",
- "tokenConfig",
- "templates"
+ "leaseDuration",
+ "renewDeadline",
+ "retryPeriod"
],
"properties": {
- "alwaysShowProviderSelection": {
- "description": "alwaysShowProviderSelection will force the provider selection page to render even when there is only a single provider.",
- "type": "boolean",
- "default": false
- },
- "assetPublicURL": {
- "description": "assetPublicURL is used for building valid client redirect URLs for external access",
- "type": "string",
- "default": ""
- },
- "grantConfig": {
- "description": "grantConfig describes how to handle grants",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.GrantConfig"
- },
- "identityProviders": {
- "description": "identityProviders is an ordered list of ways for a user to identify themselves",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.IdentityProvider"
- }
+ "disable": {
+ "description": "disable allows leader election to be suspended while allowing a fully defaulted \"normal\" startup case.",
+ "type": "boolean"
},
- "loginURL": {
- "description": "loginURL, along with masterCA, masterURL and masterPublicURL have distinct meanings depending on how the OAuth server is run. The two states are: 1. embedded in the kube api server (all 3.x releases) 2. as a standalone external process (all 4.x releases) in the embedded configuration, loginURL is equivalent to masterPublicURL and the other fields have functionality that matches their docs. in the standalone configuration, the fields are used as: loginURL is the URL required to login to the cluster: oc login --server= masterPublicURL is the issuer URL it is accessible from inside (service network) and outside (ingress) of the cluster masterURL is the loopback variation of the token_endpoint URL with no path component it is only accessible from inside (service network) of the cluster masterCA is used to perform TLS verification for connections made to masterURL For further details, see the IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2",
- "type": "string",
- "default": ""
+ "leaseDuration": {
+ "description": "leaseDuration is the duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
},
- "masterCA": {
- "description": "masterCA is the CA for verifying the TLS connection back to the MasterURL. This field is deprecated and will be removed in a future release. See loginURL for details. Deprecated",
+ "name": {
+ "description": "name indicates what name to use for the resource",
"type": "string"
},
- "masterPublicURL": {
- "description": "masterPublicURL is used for building valid client redirect URLs for internal and external access This field is deprecated and will be removed in a future release. See loginURL for details. Deprecated",
- "type": "string",
- "default": ""
- },
- "masterURL": {
- "description": "masterURL is used for making server-to-server calls to exchange authorization codes for access tokens This field is deprecated and will be removed in a future release. See loginURL for details. Deprecated",
- "type": "string",
- "default": ""
- },
- "sessionConfig": {
- "description": "sessionConfig hold information about configuring sessions.",
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.SessionConfig"
+ "namespace": {
+ "description": "namespace indicates which namespace the resource is in",
+ "type": "string"
},
- "templates": {
- "description": "templates allow you to customize pages like the login page.",
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.OAuthTemplates"
+ "renewDeadline": {
+ "description": "renewDeadline is the interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
},
- "tokenConfig": {
- "description": "tokenConfig contains options for authorization and access tokens",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.TokenConfig"
+ "retryPeriod": {
+ "description": "retryPeriod is the duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
}
}
},
- "com.github.openshift.api.osin.v1.OAuthTemplates": {
- "description": "OAuthTemplates allow for customization of pages like the login page",
+ "com.github.openshift.api.config.v1.LoadBalancer": {
"type": "object",
- "required": [
- "login",
- "providerSelection",
- "error"
- ],
"properties": {
- "error": {
- "description": "error is a path to a file containing a go template used to render error pages during the authentication or grant flow If unspecified, the default error page is used.",
- "type": "string",
- "default": ""
- },
- "login": {
- "description": "login is a path to a file containing a go template used to render the login page. If unspecified, the default login page is used.",
- "type": "string",
- "default": ""
- },
- "providerSelection": {
- "description": "providerSelection is a path to a file containing a go template used to render the provider selection page. If unspecified, the default provider selection page is used.",
- "type": "string",
- "default": ""
+ "platform": {
+ "description": "platform holds configuration specific to the underlying infrastructure provider for the ingress load balancers. When omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IngressPlatformSpec"
}
}
},
- "com.github.openshift.api.osin.v1.OpenIDClaims": {
- "description": "OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider",
+ "com.github.openshift.api.config.v1.MTUMigration": {
+ "description": "MTUMigration contains infomation about MTU migration.",
"type": "object",
- "required": [
- "id",
- "preferredUsername",
- "name",
- "email",
- "groups"
- ],
"properties": {
- "email": {
- "description": "email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "groups": {
- "description": "groups is the list of claims value of which should be used to synchronize groups from the OIDC provider to OpenShift for the user",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "id": {
- "description": "id is the list of claims whose values should be used as the user ID. Required. OpenID standard identity claim is \"sub\"",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "name": {
- "description": "name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
+ "machine": {
+ "description": "machine contains MTU migration configuration for the machine's uplink.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.MTUMigrationValues"
},
- "preferredUsername": {
- "description": "preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the id claim",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
+ "network": {
+ "description": "network contains MTU migration configuration for the default network.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.MTUMigrationValues"
}
}
},
- "com.github.openshift.api.osin.v1.OpenIDIdentityProvider": {
- "description": "OpenIDIdentityProvider provides identities for users authenticating using OpenID credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.MTUMigrationValues": {
+ "description": "MTUMigrationValues contains the values for a MTU migration.",
"type": "object",
"required": [
- "ca",
- "clientID",
- "clientSecret",
- "extraScopes",
- "extraAuthorizeParameters",
- "urls",
- "claims"
+ "to"
],
"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",
- "type": "string"
- },
- "ca": {
- "description": "ca is the optional trusted certificate authority bundle to use when making requests to the server If empty, the default system roots are used",
- "type": "string",
- "default": ""
- },
- "claims": {
- "description": "claims mappings",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.OpenIDClaims"
- },
- "clientID": {
- "description": "clientID is the oauth client ID",
- "type": "string",
- "default": ""
- },
- "clientSecret": {
- "description": "clientSecret is the oauth client secret",
- "$ref": "#/definitions/com.github.openshift.api.config.v1.StringSource"
- },
- "extraAuthorizeParameters": {
- "description": "extraAuthorizeParameters are any custom parameters to add to the authorize request.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
- },
- "extraScopes": {
- "description": "extraScopes are any scopes to request in addition to the standard \"openid\" scope.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
- "type": "string"
+ "from": {
+ "description": "from is the MTU to migrate from.",
+ "type": "integer",
+ "format": "int64"
},
- "urls": {
- "description": "urls to use to authenticate",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.OpenIDURLs"
+ "to": {
+ "description": "to is the MTU to migrate to.",
+ "type": "integer",
+ "format": "int64"
}
}
},
- "com.github.openshift.api.osin.v1.OpenIDURLs": {
- "description": "OpenIDURLs are URLs to use when authenticating with an OpenID identity provider",
+ "com.github.openshift.api.config.v1.MaxAgePolicy": {
+ "description": "MaxAgePolicy contains a numeric range for specifying a compliant HSTS max-age for the enclosing RequiredHSTSPolicy",
"type": "object",
- "required": [
- "authorize",
- "token",
- "userInfo"
- ],
"properties": {
- "authorize": {
- "description": "authorize is the oauth authorization URL",
- "type": "string",
- "default": ""
- },
- "token": {
- "description": "token is the oauth token granting URL",
- "type": "string",
- "default": ""
+ "largestMaxAge": {
+ "description": "The largest allowed value (in seconds) of the RequiredHSTSPolicy max-age This value can be left unspecified, in which case no upper limit is enforced.",
+ "type": "integer",
+ "format": "int32"
},
- "userInfo": {
- "description": "userInfo is the optional userinfo URL. If present, a granted access_token is used to request claims If empty, a granted id_token is parsed for claims",
- "type": "string",
- "default": ""
+ "smallestMaxAge": {
+ "description": "The smallest allowed value (in seconds) of the RequiredHSTSPolicy max-age Setting max-age=0 allows the deletion of an existing HSTS header from a host. This is a necessary tool for administrators to quickly correct mistakes. This value can be left unspecified, in which case no lower limit is enforced.",
+ "type": "integer",
+ "format": "int32"
}
}
},
- "com.github.openshift.api.osin.v1.OsinServerConfig": {
- "description": "Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.ModernTLSProfile": {
+ "description": "ModernTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.NamedCertificate": {
+ "description": "NamedCertificate specifies a certificate/key, and the names it should be served for",
"type": "object",
"required": [
- "servingInfo",
- "corsAllowedOrigins",
- "auditConfig",
- "storageConfig",
- "admission",
- "kubeClientConfig",
- "oauthConfig"
+ "certFile",
+ "keyFile"
],
"properties": {
- "admission": {
- "description": "admissionConfig holds information about how to configure admission.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AdmissionConfig"
- },
- "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",
- "type": "string"
- },
- "auditConfig": {
- "description": "auditConfig describes how to configure audit information",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.AuditConfig"
+ "certFile": {
+ "description": "certFile is a file containing a PEM-encoded certificate",
+ "type": "string",
+ "default": ""
},
- "corsAllowedOrigins": {
- "description": "corsAllowedOrigins",
+ "keyFile": {
+ "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "type": "string",
+ "default": ""
+ },
+ "names": {
+ "description": "names is a list of DNS names this certificate should be used to secure A name can be a normal DNS name, or can contain leading wildcard segments.",
"type": "array",
"items": {
"type": "string",
"default": ""
}
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.Network": {
+ "description": "Network holds cluster-wide information about Network. The canonical name is `cluster`. It is used to configure the desired network configuration, such as: IP address pools for services/pod IPs, network plugin, etc. Please view network.spec for an explanation on what applies when configuring this resource.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "type": "object",
+ "required": [
+ "spec"
+ ],
+ "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",
+ "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",
"type": "string"
},
- "kubeClientConfig": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.KubeClientConfig"
- },
- "oauthConfig": {
- "description": "oauthConfig holds the necessary configuration options for OAuth authentication",
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.OAuthConfig"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "servingInfo": {
- "description": "servingInfo describes how to start serving",
+ "spec": {
+ "description": "spec holds user settable values for configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.HTTPServingInfo"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkSpec"
},
- "storageConfig": {
- "description": "storageConfig contains information about how to use",
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.config.v1.EtcdStorageConfig"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkStatus"
}
}
},
- "com.github.openshift.api.osin.v1.RequestHeaderIdentityProvider": {
- "description": "RequestHeaderIdentityProvider provides identities for users authenticating using request header credentials\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.NetworkDiagnostics": {
"type": "object",
- "required": [
- "loginURL",
- "challengeURL",
- "clientCA",
- "clientCommonNames",
- "headers",
- "preferredUsernameHeaders",
- "nameHeaders",
- "emailHeaders"
- ],
"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",
- "type": "string"
- },
- "challengeURL": {
- "description": "challengeURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect WWW-Authenticate challenges will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}",
+ "mode": {
+ "description": "mode controls the network diagnostics mode\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is All.",
"type": "string",
"default": ""
},
- "clientCA": {
- "description": "clientCA is a file with the trusted signer certs. If empty, no request verification is done, and any direct request to the OAuth server can impersonate any identity from this provider, merely by setting a request header.",
- "type": "string",
- "default": ""
+ "sourcePlacement": {
+ "description": "sourcePlacement controls the scheduling of network diagnostics source deployment\n\nSee NetworkDiagnosticsSourcePlacement for more details about default values.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkDiagnosticsSourcePlacement"
},
- "clientCommonNames": {
- "description": "clientCommonNames is an optional list of common names to require a match from. If empty, any client certificate validated against the clientCA bundle is considered authoritative.",
- "type": "array",
- "items": {
+ "targetPlacement": {
+ "description": "targetPlacement controls the scheduling of network diagnostics target daemonset\n\nSee NetworkDiagnosticsTargetPlacement for more details about default values.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkDiagnosticsTargetPlacement"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NetworkDiagnosticsSourcePlacement": {
+ "description": "NetworkDiagnosticsSourcePlacement defines node scheduling configuration network diagnostics source components",
+ "type": "object",
+ "properties": {
+ "nodeSelector": {
+ "description": "nodeSelector is the node selector applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `kubernetes.io/os: linux`.",
+ "type": "object",
+ "additionalProperties": {
"type": "string",
"default": ""
}
},
- "emailHeaders": {
- "description": "emailHeaders is the set of headers to check for the email address",
+ "tolerations": {
+ "description": "tolerations is a list of tolerations applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is an empty list.",
"type": "array",
"items": {
+ "default": {},
+ "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
+ },
+ "x-kubernetes-list-type": "atomic"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NetworkDiagnosticsTargetPlacement": {
+ "description": "NetworkDiagnosticsTargetPlacement defines node scheduling configuration network diagnostics target components",
+ "type": "object",
+ "properties": {
+ "nodeSelector": {
+ "description": "nodeSelector is the node selector applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `kubernetes.io/os: linux`.",
+ "type": "object",
+ "additionalProperties": {
"type": "string",
"default": ""
}
},
- "headers": {
- "description": "headers is the set of headers to check for identity information",
+ "tolerations": {
+ "description": "tolerations is a list of tolerations applied to network diagnostics components\n\nWhen omitted, this means the user has no opinion and the platform is left to choose reasonable defaults. These defaults are subject to change over time. The current default is `- operator: \"Exists\"` which means that all taints are tolerated.",
"type": "array",
"items": {
- "type": "string",
- "default": ""
- }
- },
- "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",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
+ },
+ "x-kubernetes-list-type": "atomic"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NetworkList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "type": "object",
+ "required": [
+ "metadata",
+ "items"
+ ],
+ "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",
"type": "string"
},
- "loginURL": {
- "description": "loginURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect interactive logins will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}",
- "type": "string",
- "default": ""
- },
- "nameHeaders": {
- "description": "nameHeaders is the set of headers to check for the display name",
+ "items": {
"type": "array",
"items": {
- "type": "string",
- "default": ""
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Network"
}
},
- "preferredUsernameHeaders": {
- "description": "preferredUsernameHeaders is the set of headers to check for the preferred username",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
+ "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",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.osin.v1.SessionConfig": {
- "description": "SessionConfig specifies options for cookie-based sessions. Used by AuthRequestHandlerSession",
+ "com.github.openshift.api.config.v1.NetworkMigration": {
+ "description": "NetworkMigration represents the network migration status.",
"type": "object",
- "required": [
- "sessionSecretsFile",
- "sessionMaxAgeSeconds",
- "sessionName"
- ],
"properties": {
- "sessionMaxAgeSeconds": {
- "description": "sessionMaxAgeSeconds specifies how long created sessions last. Used by AuthRequestHandlerSession",
- "type": "integer",
- "format": "int32",
- "default": 0
- },
- "sessionName": {
- "description": "sessionName is the cookie name used to store the session",
- "type": "string",
- "default": ""
+ "mtu": {
+ "description": "mtu is the MTU configuration that is being deployed.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.MTUMigration"
},
- "sessionSecretsFile": {
- "description": "sessionSecretsFile is a reference to a file containing a serialized SessionSecrets object If no file is specified, a random signing and encryption key are generated at each server start",
- "type": "string",
- "default": ""
+ "networkType": {
+ "description": "networkType is the target plugin that is being deployed. DEPRECATED: network type migration is no longer supported, so this should always be unset.",
+ "type": "string"
}
}
},
- "com.github.openshift.api.osin.v1.SessionSecret": {
- "description": "SessionSecret is a secret used to authenticate/decrypt cookie-based sessions",
+ "com.github.openshift.api.config.v1.NetworkSpec": {
+ "description": "NetworkSpec is the desired network configuration. As a general rule, this SHOULD NOT be read directly. Instead, you should consume the NetworkStatus, as it indicates the currently deployed configuration. Currently, most spec fields are immutable after installation. Please view the individual ones for further details on each.",
"type": "object",
"required": [
- "authentication",
- "encryption"
+ "clusterNetwork",
+ "serviceNetwork",
+ "networkType"
],
"properties": {
- "authentication": {
- "description": "authentication is used to authenticate sessions using HMAC. Recommended to use a secret with 32 or 64 bytes.",
- "type": "string",
- "default": ""
+ "clusterNetwork": {
+ "description": "IP address pool to use for pod IPs. This field is immutable after installation.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterNetworkEntry"
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "encryption": {
- "description": "encryption is used to encrypt sessions. Must be 16, 24, or 32 characters long, to select AES-128, AES-",
+ "externalIP": {
+ "description": "externalIP defines configuration for controllers that affect Service.ExternalIP. If nil, then ExternalIP is not allowed to be set.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalIPConfig"
+ },
+ "networkDiagnostics": {
+ "description": "networkDiagnostics defines network diagnostics configuration.\n\nTakes precedence over spec.disableNetworkDiagnostics in network.operator.openshift.io. If networkDiagnostics is not specified or is empty, and the spec.disableNetworkDiagnostics flag in network.operator.openshift.io is set to true, the network diagnostics feature will be disabled.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkDiagnostics"
+ },
+ "networkType": {
+ "description": "networkType is the plugin that is to be deployed (e.g. OVNKubernetes). This should match a value that the cluster-network-operator understands, or else no networking will be installed. Currently supported values are: - OVNKubernetes This field is immutable after installation.",
"type": "string",
"default": ""
+ },
+ "serviceNetwork": {
+ "description": "IP address pool for services. Currently, we only support a single entry here. This field is immutable after installation.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "serviceNodePortRange": {
+ "description": "The port range allowed for Services of type NodePort. If not specified, the default of 30000-32767 will be used. Such Services without a NodePort specified will have one automatically allocated from this range. This parameter can be updated after the cluster is installed.",
+ "type": "string"
}
}
},
- "com.github.openshift.api.osin.v1.SessionSecrets": {
- "description": "SessionSecrets list the secrets to use to sign/encrypt and authenticate/decrypt created sessions.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.NetworkStatus": {
+ "description": "NetworkStatus is the current network configuration.",
"type": "object",
- "required": [
- "secrets"
- ],
"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",
- "type": "string"
+ "clusterNetwork": {
+ "description": "IP address pool to use for pod IPs.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ClusterNetworkEntry"
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "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",
- "type": "string"
+ "clusterNetworkMTU": {
+ "description": "clusterNetworkMTU is the MTU for inter-pod networking.",
+ "type": "integer",
+ "format": "int32"
},
- "secrets": {
- "description": "secrets is a list of secrets New sessions are signed and encrypted using the first secret. Existing sessions are decrypted/authenticated by each secret until one succeeds. This allows rotating secrets.",
+ "conditions": {
+ "description": "conditions represents the observations of a network.config current state. Known .status.conditions.type are: \"NetworkDiagnosticsAvailable\"",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.osin.v1.SessionSecret"
- }
- }
- }
- },
- "com.github.openshift.api.osin.v1.TokenConfig": {
- "description": "TokenConfig holds the necessary configuration options for authorization and access tokens",
- "type": "object",
- "properties": {
- "accessTokenInactivityTimeout": {
- "description": "accessTokenInactivityTimeout defines the token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Takes valid time duration string such as \"5m\", \"1.5h\" or \"2h45m\". The minimum allowed value for duration is 300s (5 minutes). If the timeout is configured per client, then that value takes precedence. If the timeout value is not specified and the client does not override the value, then tokens are valid until their lifetime.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
+ },
+ "x-kubernetes-list-map-keys": [
+ "type"
+ ],
+ "x-kubernetes-list-type": "map"
},
- "accessTokenInactivityTimeoutSeconds": {
- "description": "accessTokenInactivityTimeoutSeconds - DEPRECATED: setting this field has no effect.",
- "type": "integer",
- "format": "int32"
+ "migration": {
+ "description": "migration contains the cluster network migration configuration.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NetworkMigration"
},
- "accessTokenMaxAgeSeconds": {
- "description": "accessTokenMaxAgeSeconds defines the maximum age of access tokens",
- "type": "integer",
- "format": "int32"
+ "networkType": {
+ "description": "networkType is the plugin that is deployed (e.g. OVNKubernetes).",
+ "type": "string"
},
- "authorizeTokenMaxAgeSeconds": {
- "description": "authorizeTokenMaxAgeSeconds defines the maximum age of authorize tokens",
- "type": "integer",
- "format": "int32"
+ "serviceNetwork": {
+ "description": "IP address pool for services. Currently, we only support a single entry here.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.project.v1.Project": {
- "description": "Projects are the unit of isolation and collaboration in OpenShift. A project has one or more members, a quota on the resources that the project may consume, and the security controls on the resources in the project. Within a project, members may have different roles - project administrators can set membership, editors can create and manage the resources, and viewers can see but not access running containers. In a normal cluster project administrators are not able to alter their quotas - that is restricted to cluster administrators.\n\nListing or watching projects will return only projects the user has the reader role on.\n\nAn OpenShift project is an alternative representation of a Kubernetes namespace. Projects are exposed as editable to end users while namespaces are not. Direct creation of a project is typically restricted to administrators, while end users should use the requestproject resource.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.Node": {
+ "description": "Node holds cluster-wide information about node specific features.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
+ "required": [
+ "spec"
+ ],
"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",
@@ -36747,21 +4764,22 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec defines the behavior of the Namespace.",
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.project.v1.ProjectSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NodeSpec"
},
"status": {
- "description": "status describes the current status of a Namespace",
+ "description": "status holds observed values.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.project.v1.ProjectStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NodeStatus"
}
}
},
- "com.github.openshift.api.project.v1.ProjectList": {
- "description": "ProjectList is a list of Project objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.NodeList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -36770,11 +4788,10 @@
"type": "string"
},
"items": {
- "description": "items is the list of projects",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.project.v1.Project"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Node"
}
},
"kind": {
@@ -36788,73 +4805,244 @@
}
}
},
- "com.github.openshift.api.project.v1.ProjectRequest": {
- "description": "ProjectRequest is the set of options necessary to fully qualify a project request\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.NodeSpec": {
"type": "object",
"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",
+ "cgroupMode": {
+ "description": "cgroupMode determines the cgroups version on the node",
"type": "string"
},
- "description": {
- "description": "description is the description to apply to a project",
- "type": "string"
+ "minimumKubeletVersion": {
+ "description": "minimumKubeletVersion is the lowest version of a kubelet that can join the cluster. Specifically, the apiserver will deny most authorization requests of kubelets that are older than the specified version, only allowing the kubelet to get and update its node object, and perform subjectaccessreviews. This means any kubelet that attempts to join the cluster will not be able to run any assigned workloads, and will eventually be marked as not ready. Its max length is 8, so maximum version allowed is either \"9.999.99\" or \"99.99.99\". Since the kubelet reports the version of the kubernetes release, not Openshift, this field references the underlying kubernetes version this version of Openshift is based off of. In other words: if an admin wishes to ensure no nodes run an older version than Openshift 4.17, then they should set the minimumKubeletVersion to 1.30.0. When comparing versions, the kubelet's version is stripped of any contents outside of major.minor.patch version. Thus, a kubelet with version \"1.0.0-ec.0\" will be compatible with minimumKubeletVersion \"1.0.0\" or earlier.",
+ "type": "string",
+ "default": ""
},
- "displayName": {
- "description": "displayName is the display name to apply to a project",
+ "workerLatencyProfile": {
+ "description": "workerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster",
"type": "string"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NodeStatus": {
+ "type": "object",
+ "properties": {
+ "conditions": {
+ "description": "conditions contain the details and the current state of the nodes.config object",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
+ },
+ "x-kubernetes-list-map-keys": [
+ "type"
+ ],
+ "x-kubernetes-list-type": "map"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NutanixFailureDomain": {
+ "description": "NutanixFailureDomain configures failure domain information for the Nutanix platform.",
+ "type": "object",
+ "required": [
+ "name",
+ "cluster",
+ "subnets"
+ ],
+ "properties": {
+ "cluster": {
+ "description": "cluster is to identify the cluster (the Prism Element under management of the Prism Central), in which the Machine's VM will be created. The cluster identifier (uuid or name) can be obtained from the Prism Central console or using the prism_central API.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixResourceIdentifier"
},
- "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",
- "type": "string"
+ "name": {
+ "description": "name defines the unique name of a failure domain. Name is required and must be at most 64 characters in length. It must consist of only lower case alphanumeric characters and hyphens (-). It must start and end with an alphanumeric character. This value is arbitrary and is used to identify the failure domain within the platform.",
+ "type": "string",
+ "default": ""
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "subnets": {
+ "description": "subnets holds a list of identifiers (one or more) of the cluster's network subnets If the feature gate NutanixMultiSubnets is enabled, up to 32 subnets may be configured. for the Machine's VM to connect to. The subnet identifiers (uuid or name) can be obtained from the Prism Central console or using the prism_central API.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixResourceIdentifier"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.project.v1.ProjectSpec": {
- "description": "ProjectSpec describes the attributes on a Project",
+ "com.github.openshift.api.config.v1.NutanixPlatformLoadBalancer": {
+ "description": "NutanixPlatformLoadBalancer defines the load balancer used by the cluster on Nutanix platform.",
"type": "object",
"properties": {
- "finalizers": {
- "description": "finalizers is an opaque list of values that must be empty to permanently remove object from storage",
+ "type": {
+ "description": "type defines the type of load balancer used by the cluster on Nutanix platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
+ "type": "string",
+ "default": "OpenShiftManagedDefault"
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {}
+ }
+ ]
+ },
+ "com.github.openshift.api.config.v1.NutanixPlatformSpec": {
+ "description": "NutanixPlatformSpec holds the desired state of the Nutanix infrastructure provider. This only includes fields that can be modified in the cluster.",
+ "type": "object",
+ "required": [
+ "prismCentral",
+ "prismElements"
+ ],
+ "properties": {
+ "failureDomains": {
+ "description": "failureDomains configures failure domains information for the Nutanix platform. When set, the failure domains defined here may be used to spread Machines across prism element clusters to improve fault tolerance of the cluster.",
"type": "array",
"items": {
- "type": "string",
- "default": ""
- }
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixFailureDomain"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "prismCentral": {
+ "description": "prismCentral holds the endpoint address and port to access the Nutanix Prism Central. When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPrismEndpoint"
+ },
+ "prismElements": {
+ "description": "prismElements holds one or more endpoint address and port data to access the Nutanix Prism Elements (clusters) of the Nutanix Prism Central. Currently we only support one Prism Element (cluster) for an OpenShift cluster, where all the Nutanix resources (VMs, subnets, volumes, etc.) used in the OpenShift cluster are located. In the future, we may support Nutanix resources (VMs, etc.) spread over multiple Prism Elements (clusters) of the Prism Central.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPrismElementEndpoint"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.project.v1.ProjectStatus": {
- "description": "ProjectStatus is information about the current status of a Project",
+ "com.github.openshift.api.config.v1.NutanixPlatformStatus": {
+ "description": "NutanixPlatformStatus holds the current status of the Nutanix infrastructure provider.",
"type": "object",
+ "required": [
+ "apiServerInternalIPs",
+ "ingressIPs"
+ ],
"properties": {
- "conditions": {
- "description": "Represents the latest available observations of the project current state.",
+ "apiServerInternalIP": {
+ "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
+ "type": "string"
+ },
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.NamespaceCondition"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
+ "x-kubernetes-list-type": "set"
},
- "phase": {
- "description": "phase is the current lifecycle phase of the project\n\nPossible enum values:\n - `\"Active\"` means the namespace is available for use in the system\n - `\"Terminating\"` means the namespace is undergoing graceful termination",
+ "ingressIP": {
+ "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
+ "type": "string"
+ },
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "set"
+ },
+ "loadBalancer": {
+ "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
+ "default": {
+ "type": "OpenShiftManagedDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPlatformLoadBalancer"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NutanixPrismElementEndpoint": {
+ "description": "NutanixPrismElementEndpoint holds the name and endpoint data for a Prism Element (cluster)",
+ "type": "object",
+ "required": [
+ "name",
+ "endpoint"
+ ],
+ "properties": {
+ "endpoint": {
+ "description": "endpoint holds the endpoint address and port data of the Prism Element (cluster). When a cluster-wide proxy is installed, by default, this endpoint will be accessed via the proxy. Should you wish for communication with this endpoint not to be proxied, please add the endpoint to the proxy spec.noProxy list.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPrismEndpoint"
+ },
+ "name": {
+ "description": "name is the name of the Prism Element (cluster). This value will correspond with the cluster field configured on other resources (eg Machines, PVCs, etc).",
"type": "string",
- "enum": [
- "Active",
- "Terminating"
- ]
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NutanixPrismEndpoint": {
+ "description": "NutanixPrismEndpoint holds the endpoint address and port to access the Nutanix Prism Central or Element (cluster)",
+ "type": "object",
+ "required": [
+ "address",
+ "port"
+ ],
+ "properties": {
+ "address": {
+ "description": "address is the endpoint address (DNS name or IP address) of the Nutanix Prism Central or Element (cluster)",
+ "type": "string",
+ "default": ""
+ },
+ "port": {
+ "description": "port is the port number to access the Nutanix Prism Central or Element (cluster)",
+ "type": "integer",
+ "format": "int32",
+ "default": 0
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.NutanixResourceIdentifier": {
+ "description": "NutanixResourceIdentifier holds the identity of a Nutanix PC resource (cluster, image, subnet, etc.)",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "name": {
+ "description": "name is the resource name in the PC. It cannot be empty if the type is Name.",
+ "type": "string"
+ },
+ "type": {
+ "description": "type is the identifier type to use for this resource.",
+ "type": "string",
+ "default": ""
+ },
+ "uuid": {
+ "description": "uuid is the UUID of the resource in the PC. It cannot be empty if the type is UUID.",
+ "type": "string"
}
- }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {
+ "name": "Name",
+ "uuid": "UUID"
+ }
+ }
+ ]
},
- "com.github.openshift.api.quota.v1.AppliedClusterResourceQuota": {
- "description": "AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.OAuth": {
+ "description": "OAuth holds cluster-wide information about OAuth. The canonical name is `cluster`. It is used to configure the integrated OAuth server. This configuration is only honored when the top level Authentication config has type set to IntegratedOAuth.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"metadata",
@@ -36875,21 +5063,22 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec defines the desired quota",
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuthSpec"
},
"status": {
- "description": "status defines the actual enforced quota and its current usage",
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuthStatus"
}
}
},
- "com.github.openshift.api.quota.v1.AppliedClusterResourceQuotaList": {
- "description": "AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.OAuthList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -36898,11 +5087,10 @@
"type": "string"
},
"items": {
- "description": "items is a list of AppliedClusterResourceQuota",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.AppliedClusterResourceQuota"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuth"
}
},
"kind": {
@@ -36916,349 +5104,550 @@
}
}
},
- "com.github.openshift.api.quota.v1.ClusterResourceQuota": {
- "description": "ClusterResourceQuota mirrors ResourceQuota at a cluster scope. This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.OAuthRemoteConnectionInfo": {
+ "description": "OAuthRemoteConnectionInfo holds information necessary for establishing a remote connection",
"type": "object",
"required": [
- "metadata",
- "spec"
+ "url"
],
"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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "ca": {
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "spec": {
- "description": "spec defines the desired quota",
+ "tlsClientCert": {
+ "description": "tlsClientCert is an optional reference to a secret by name that contains the PEM-encoded TLS client certificate to present when connecting to the server. The key \"tls.crt\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
},
- "status": {
- "description": "status defines the actual enforced quota and its current usage",
+ "tlsClientKey": {
+ "description": "tlsClientKey is an optional reference to a secret by name that contains the PEM-encoded TLS private key for the client certificate referenced in tlsClientCert. The key \"tls.key\" is used to locate the data. If specified and the secret or expected key is not found, the identity provider is not honored. If the specified certificate data is not valid, the identity provider is not honored. The namespace for this secret is openshift-config.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "url": {
+ "description": "url is the remote URL to connect to",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.quota.v1.ClusterResourceQuotaList": {
- "description": "ClusterResourceQuotaList is a collection of ClusterResourceQuotas\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.OAuthSpec": {
+ "description": "OAuthSpec contains desired cluster auth configuration",
"type": "object",
"required": [
- "items"
+ "tokenConfig"
],
"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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of ClusterResourceQuotas",
+ "identityProviders": {
+ "description": "identityProviders is an ordered list of ways for a user to identify themselves. When this list is empty, no identities are provisioned for users.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuota"
- }
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IdentityProvider"
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "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",
- "type": "string"
+ "templates": {
+ "description": "templates allow you to customize pages like the login page.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OAuthTemplates"
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "tokenConfig": {
+ "description": "tokenConfig contains options for authorization and access tokens",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenConfig"
}
}
},
- "com.github.openshift.api.quota.v1.ClusterResourceQuotaSelector": {
- "description": "ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions.",
+ "com.github.openshift.api.config.v1.OAuthStatus": {
+ "description": "OAuthStatus shows current known state of OAuth server in the cluster",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.OAuthTemplates": {
+ "description": "OAuthTemplates allow for customization of pages like the login page",
"type": "object",
"properties": {
- "annotations": {
- "description": "AnnotationSelector is used to select projects by annotation.",
- "type": "object",
- "additionalProperties": {
+ "error": {
+ "description": "error is the name of a secret that specifies a go template to use to render error pages during the authentication or grant flow. The key \"errors.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default error page is used. If the specified template is not valid, the default error page is used. If unspecified, the default error page is used. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "login": {
+ "description": "login is the name of a secret that specifies a go template to use to render the login page. The key \"login.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default login page is used. If the specified template is not valid, the default login page is used. If unspecified, the default login page is used. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "providerSelection": {
+ "description": "providerSelection is the name of a secret that specifies a go template to use to render the provider selection page. The key \"providers.html\" is used to locate the template data. If specified and the secret or expected key is not found, the default provider selection page is used. If the specified template is not valid, the default provider selection page is used. If unspecified, the default provider selection page is used. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.OIDCClientConfig": {
+ "description": "OIDCClientConfig configures how platform clients interact with identity providers as an authentication method",
+ "type": "object",
+ "required": [
+ "componentName",
+ "componentNamespace",
+ "clientID"
+ ],
+ "properties": {
+ "clientID": {
+ "description": "clientID is a required field that configures the client identifier, from the identity provider, that the platform component uses for authentication requests made to the identity provider. The identity provider must accept this identifier for platform components to be able to use the identity provider as an authentication mode.\n\nclientID must not be an empty string (\"\").",
+ "type": "string",
+ "default": ""
+ },
+ "clientSecret": {
+ "description": "clientSecret is an optional field that configures the client secret used by the platform component when making authentication requests to the identity provider.\n\nWhen not specified, no client secret will be used when making authentication requests to the identity provider.\n\nWhen specified, clientSecret references a Secret in the 'openshift-config' namespace that contains the client secret in the 'clientSecret' key of the '.data' field. The client secret will be used when making authentication requests to the identity provider.\n\nPublic clients do not require a client secret but private clients do require a client secret to work with the identity provider.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "componentName": {
+ "description": "componentName is a required field that specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.\n\ncomponentName must not be an empty string (\"\") and must not exceed 256 characters in length.",
+ "type": "string",
+ "default": ""
+ },
+ "componentNamespace": {
+ "description": "componentNamespace is a required field that specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.\n\ncomponentNamespace must not be an empty string (\"\") and must not exceed 63 characters in length.",
+ "type": "string",
+ "default": ""
+ },
+ "extraScopes": {
+ "description": "extraScopes is an optional field that configures the extra scopes that should be requested by the platform component when making authentication requests to the identity provider. This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes.\n\nWhen omitted, no additional scopes are requested.",
+ "type": "array",
+ "items": {
"type": "string",
"default": ""
- }
+ },
+ "x-kubernetes-list-type": "set"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.OIDCClientReference": {
+ "description": "OIDCClientReference is a reference to a platform component client configuration.",
+ "type": "object",
+ "required": [
+ "oidcProviderName",
+ "issuerURL",
+ "clientID"
+ ],
+ "properties": {
+ "clientID": {
+ "description": "clientID is a required field that specifies the client identifier, from the identity provider, that the platform component is using for authentication requests made to the identity provider.\n\nclientID must not be empty.",
+ "type": "string",
+ "default": ""
},
- "labels": {
- "description": "LabelSelector is used to select projects by label.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
+ "issuerURL": {
+ "description": "issuerURL is a required field that specifies the URL of the identity provider that this client is configured to make requests against.\n\nissuerURL must use the 'https' scheme.",
+ "type": "string",
+ "default": ""
+ },
+ "oidcProviderName": {
+ "description": "oidcProviderName is a required reference to the 'name' of the identity provider configured in 'oidcProviders' that this client is associated with.\n\noidcProviderName must not be an empty string (\"\").",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.quota.v1.ClusterResourceQuotaSpec": {
- "description": "ClusterResourceQuotaSpec defines the desired quota restrictions",
+ "com.github.openshift.api.config.v1.OIDCClientStatus": {
+ "description": "OIDCClientStatus represents the current state of platform components and how they interact with the configured identity providers.",
"type": "object",
"required": [
- "selector",
- "quota"
+ "componentName",
+ "componentNamespace"
],
"properties": {
- "quota": {
- "description": "quota defines the desired quota",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceQuotaSpec"
+ "componentName": {
+ "description": "componentName is a required field that specifies the name of the platform component using the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.\n\ncomponentName must not be an empty string (\"\") and must not exceed 256 characters in length.",
+ "type": "string",
+ "default": ""
},
- "selector": {
- "description": "selector is the selector used to match projects. It should only select active projects on the scale of dozens (though it can select many more less active projects). These projects will contend on object creation through this resource.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.ClusterResourceQuotaSelector"
+ "componentNamespace": {
+ "description": "componentNamespace is a required field that specifies the namespace in which the platform component using the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.\n\ncomponentNamespace must not be an empty string (\"\") and must not exceed 63 characters in length.",
+ "type": "string",
+ "default": ""
+ },
+ "conditions": {
+ "description": "conditions are used to communicate the state of the `oidcClients` entry.\n\nSupported conditions include Available, Degraded and Progressing.\n\nIf Available is true, the component is successfully using the configured client. If Degraded is true, that means something has gone wrong trying to handle the client configuration. If Progressing is true, that means the component is taking some action related to the `oidcClients` entry.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
+ },
+ "x-kubernetes-list-map-keys": [
+ "type"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "consumingUsers": {
+ "description": "consumingUsers is an optional list of ServiceAccounts requiring read permissions on the `clientSecret` secret.\n\nconsumingUsers must not exceed 5 entries.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "set"
+ },
+ "currentOIDCClients": {
+ "description": "currentOIDCClients is an optional list of clients that the component is currently using. Entries must have unique issuerURL/clientID pairs.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCClientReference"
+ },
+ "x-kubernetes-list-map-keys": [
+ "issuerURL",
+ "clientID"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.quota.v1.ClusterResourceQuotaStatus": {
- "description": "ClusterResourceQuotaStatus defines the actual enforced quota and its current usage",
+ "com.github.openshift.api.config.v1.OIDCProvider": {
"type": "object",
"required": [
- "total"
+ "name",
+ "issuer",
+ "claimMappings"
],
"properties": {
- "namespaces": {
- "description": "namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project.",
+ "claimMappings": {
+ "description": "claimMappings is a required field that configures the rules to be used by the Kubernetes API server for translating claims in a JWT token, issued by the identity provider, to a cluster identity.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenClaimMappings"
+ },
+ "claimValidationRules": {
+ "description": "claimValidationRules is an optional field that configures the rules to be used by the Kubernetes API server for validating the claims in a JWT token issued by the identity provider.\n\nValidation rules are joined via an AND operation.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.quota.v1.ResourceQuotaStatusByNamespace"
- }
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenClaimValidationRule"
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "total": {
- "description": "total defines the actual enforced quota and its current usage across all projects",
+ "issuer": {
+ "description": "issuer is a required field that configures how the platform interacts with the identity provider and how tokens issued from the identity provider are evaluated by the Kubernetes API server.",
"default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceQuotaStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenIssuer"
+ },
+ "name": {
+ "description": "name is a required field that configures the unique human-readable identifier associated with the identity provider. It is used to distinguish between multiple identity providers and has no impact on token validation or authentication mechanics.\n\nname must not be an empty string (\"\").",
+ "type": "string",
+ "default": ""
+ },
+ "oidcClients": {
+ "description": "oidcClients is an optional field that configures how on-cluster, platform clients should request tokens from the identity provider. oidcClients must not exceed 20 entries and entries must have unique namespace/name pairs.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OIDCClientConfig"
+ },
+ "x-kubernetes-list-map-keys": [
+ "componentNamespace",
+ "componentName"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.quota.v1.ResourceQuotaStatusByNamespace": {
- "description": "ResourceQuotaStatusByNamespace gives status for a particular project",
+ "com.github.openshift.api.config.v1.ObjectReference": {
+ "description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
"type": "object",
"required": [
- "namespace",
- "status"
+ "group",
+ "resource",
+ "name"
],
"properties": {
- "namespace": {
- "description": "namespace the project this status applies to",
+ "group": {
+ "description": "group of the referent.",
"type": "string",
"default": ""
},
- "status": {
- "description": "status indicates how many resources have been consumed by this project",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ResourceQuotaStatus"
- }
- }
- },
- "com.github.openshift.api.route.v1.LocalObjectReference": {
- "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
- "type": "object",
- "properties": {
"name": {
- "description": "name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
+ "description": "name of the referent.",
+ "type": "string",
+ "default": ""
+ },
+ "namespace": {
+ "description": "namespace of the referent.",
"type": "string"
+ },
+ "resource": {
+ "description": "resource of the referent.",
+ "type": "string",
+ "default": ""
}
- },
- "x-kubernetes-map-type": "atomic"
+ }
},
- "com.github.openshift.api.route.v1.Route": {
- "description": "A route allows developers to expose services through an HTTP(S) aware load balancing and proxy layer via a public DNS entry. The route may further specify TLS options and a certificate, or specify a public CNAME that the router should also accept for HTTP and HTTPS traffic. An administrator typically configures their router to be visible outside the cluster firewall, and may also add additional security, caching, or traffic controls on the service content. Routers usually talk directly to the service endpoints.\n\nOnce a route is created, the `host` field may not be changed. Generally, routers use the oldest route with a given host when resolving conflicts.\n\nRouters are subject to additional customization and may support additional controls via the annotations field.\n\nBecause administrators may configure multiple routers, the route status field is used to return information to clients about the names and states of the route under each router. If a client chooses a duplicate name, for instance, the route status conditions are used to indicate the route cannot be chosen.\n\nTo enable HTTP/2 ALPN on a route it requires a custom (non-wildcard) certificate. This prevents connection coalescing by clients, notably web browsers. We do not support HTTP/2 ALPN on routes that use the default certificate because of the risk of connection re-use/coalescing. Routes that do not have their own custom certificate will not be HTTP/2 ALPN-enabled on either the frontend or the backend.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.OldTLSProfile": {
+ "description": "OldTLSProfile is a TLS security profile based on: https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.OpenIDClaims": {
+ "description": "OpenIDClaims contains a list of OpenID claims to use when authenticating with an OpenID identity provider",
"type": "object",
- "required": [
- "spec"
- ],
"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",
- "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",
- "type": "string"
+ "email": {
+ "description": "email is the list of claims whose values should be used as the email address. Optional. If unspecified, no email is set for the identity",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "groups": {
+ "description": "groups is the list of claims value of which should be used to synchronize groups from the OIDC provider to OpenShift for the user. If multiple claims are specified, the first one with a non-empty value is used.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "spec": {
- "description": "spec is the desired state of the route",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteSpec"
+ "name": {
+ "description": "name is the list of claims whose values should be used as the display name. Optional. If unspecified, no display name is set for the identity",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "status": {
- "description": "status is the current state of the route",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteStatus"
+ "preferredUsername": {
+ "description": "preferredUsername is the list of claims whose values should be used as the preferred username. If unspecified, the preferred username is determined from the value of the sub claim",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.route.v1.RouteHTTPHeader": {
- "description": "RouteHTTPHeader specifies configuration for setting or deleting an HTTP header.",
+ "com.github.openshift.api.config.v1.OpenIDIdentityProvider": {
+ "description": "OpenIDIdentityProvider provides identities for users authenticating using OpenID credentials",
"type": "object",
"required": [
- "name",
- "action"
+ "clientID",
+ "clientSecret",
+ "issuer",
+ "claims"
],
"properties": {
- "action": {
- "description": "action specifies actions to perform on headers, such as setting or deleting headers.",
+ "ca": {
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. If empty, the default system roots are used. The namespace for this config map is openshift-config.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteHTTPHeaderActionUnion"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "name": {
- "description": "name specifies the name of a header on which to perform an action. Its value must be a valid HTTP header name as defined in RFC 2616 section 4.2. The name must consist only of alphanumeric and the following special characters, \"-!#$%&'*+.^_`\". The following header names are reserved and may not be modified via this API: Strict-Transport-Security, Proxy, Cookie, Set-Cookie. It must be no more than 255 characters in length. Header name must be unique.",
+ "claims": {
+ "description": "claims mappings",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenIDClaims"
+ },
+ "clientID": {
+ "description": "clientID is the oauth client ID",
+ "type": "string",
+ "default": ""
+ },
+ "clientSecret": {
+ "description": "clientSecret is a required reference to the secret by name containing the oauth client secret. The key \"clientSecret\" is used to locate the data. If the secret or expected key is not found, the identity provider is not honored. The namespace for this secret is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
+ },
+ "extraAuthorizeParameters": {
+ "description": "extraAuthorizeParameters are any custom parameters to add to the authorize request.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "extraScopes": {
+ "description": "extraScopes are any scopes to request in addition to the standard \"openid\" scope.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "issuer": {
+ "description": "issuer is the URL that the OpenID Provider asserts as its Issuer Identifier. It must use the https scheme with no query or fragment component.",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.route.v1.RouteHTTPHeaderActionUnion": {
- "description": "RouteHTTPHeaderActionUnion specifies an action to take on an HTTP header.",
+ "com.github.openshift.api.config.v1.OpenStackPlatformLoadBalancer": {
+ "description": "OpenStackPlatformLoadBalancer defines the load balancer used by the cluster on OpenStack platform.",
"type": "object",
- "required": [
- "type"
- ],
"properties": {
- "set": {
- "description": "set defines the HTTP header that should be set: added if it doesn't exist or replaced if it does. This field is required when type is Set and forbidden otherwise.",
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteSetHTTPHeader"
- },
"type": {
- "description": "type defines the type of the action to be applied on the header. Possible values are Set or Delete. Set allows you to set HTTP request and response headers. Delete allows you to delete HTTP request and response headers.",
+ "description": "type defines the type of load balancer used by the cluster on OpenStack platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
"type": "string",
- "default": ""
+ "default": "OpenShiftManagedDefault"
}
},
"x-kubernetes-unions": [
{
"discriminator": "type",
- "fields-to-discriminateBy": {
- "set": "Set"
- }
+ "fields-to-discriminateBy": {}
}
]
},
- "com.github.openshift.api.route.v1.RouteHTTPHeaderActions": {
- "description": "RouteHTTPHeaderActions defines configuration for actions on HTTP request and response headers.",
+ "com.github.openshift.api.config.v1.OpenStackPlatformSpec": {
+ "description": "OpenStackPlatformSpec holds the desired state of the OpenStack infrastructure provider. This only includes fields that can be modified in the cluster.",
"type": "object",
"properties": {
- "request": {
- "description": "request is a list of HTTP request headers to modify. Currently, actions may define to either `Set` or `Delete` headers values. Actions defined here will modify the request headers of all requests made through a route. These actions are applied to a specific Route defined within a cluster i.e. connections made through a route. Currently, actions may define to either `Set` or `Delete` headers values. Route actions will be executed after IngressController actions for request headers. Actions are applied in sequence as defined in this list. A maximum of 20 request header actions may be configured. You can use this field to specify HTTP request headers that should be set or deleted when forwarding connections from the client to your application. Sample fetchers allowed are \"req.hdr\" and \"ssl_c_der\". Converters allowed are \"lower\" and \"base64\". Example header values: \"%[req.hdr(X-target),lower]\", \"%{+Q}[ssl_c_der,base64]\". Any request header configuration applied directly via a Route resource using this API will override header configuration for a header of the same name applied via spec.httpHeaders.actions on the IngressController or route annotation. Note: This field cannot be used if your route uses TLS passthrough.",
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteHTTPHeader"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
+ "x-kubernetes-list-type": "atomic"
},
- "response": {
- "description": "response is a list of HTTP response headers to modify. Currently, actions may define to either `Set` or `Delete` headers values. Actions defined here will modify the response headers of all requests made through a route. These actions are applied to a specific Route defined within a cluster i.e. connections made through a route. Route actions will be executed before IngressController actions for response headers. Actions are applied in sequence as defined in this list. A maximum of 20 response header actions may be configured. You can use this field to specify HTTP response headers that should be set or deleted when forwarding responses from your application to the client. Sample fetchers allowed are \"res.hdr\" and \"ssl_c_der\". Converters allowed are \"lower\" and \"base64\". Example header values: \"%[res.hdr(X-target),lower]\", \"%{+Q}[ssl_c_der,base64]\". Note: This field cannot be used if your route uses TLS passthrough.",
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteHTTPHeader"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "name"
- ],
- "x-kubernetes-list-type": "map"
- }
- }
- },
- "com.github.openshift.api.route.v1.RouteHTTPHeaders": {
- "description": "RouteHTTPHeaders defines policy for HTTP headers.",
- "type": "object",
- "properties": {
- "actions": {
- "description": "actions specifies options for modifying headers and their values. Note that this option only applies to cleartext HTTP connections and to secure HTTP connections for which the ingress controller terminates encryption (that is, edge-terminated or reencrypt connections). Headers cannot be modified for TLS passthrough connections. Setting the HSTS (`Strict-Transport-Security`) header is not supported via actions. `Strict-Transport-Security` may only be configured using the \"haproxy.router.openshift.io/hsts_header\" route annotation, and only in accordance with the policy specified in Ingress.Spec.RequiredHSTSPolicies. In case of HTTP request headers, the actions specified in spec.httpHeaders.actions on the Route will be executed after the actions specified in the IngressController's spec.httpHeaders.actions field. In case of HTTP response headers, the actions specified in spec.httpHeaders.actions on the IngressController will be executed after the actions specified in the Route's spec.httpHeaders.actions field. The headers set via this API will not appear in access logs. Any actions defined here are applied after any actions related to the following other fields: cache-control, spec.clientTLS, spec.httpHeaders.forwardedHeaderPolicy, spec.httpHeaders.uniqueId, and spec.httpHeaders.headerNameCaseAdjustments. The following header names are reserved and may not be modified via this API: Strict-Transport-Security, Proxy, Cookie, Set-Cookie. Note that the total size of all net added headers *after* interpolating dynamic values must not exceed the value of spec.tuningOptions.headerBufferMaxRewriteBytes on the IngressController. Please refer to the documentation for that API field for more details.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteHTTPHeaderActions"
+ "x-kubernetes-list-type": "atomic"
+ },
+ "machineNetworks": {
+ "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example \"10.0.0.0/8\" or \"fd00::/8\".",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.route.v1.RouteIngress": {
- "description": "RouteIngress holds information about the places where a route is exposed.",
+ "com.github.openshift.api.config.v1.OpenStackPlatformStatus": {
+ "description": "OpenStackPlatformStatus holds the current status of the OpenStack infrastructure provider.",
"type": "object",
+ "required": [
+ "apiServerInternalIPs",
+ "ingressIPs"
+ ],
"properties": {
- "conditions": {
- "description": "conditions is the state of the route, may be empty.",
+ "apiServerInternalIP": {
+ "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
+ "type": "string"
+ },
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteIngressCondition"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
+ "x-kubernetes-list-type": "atomic"
},
- "host": {
- "description": "host is the host string under which the route is exposed; this value is required",
+ "cloudName": {
+ "description": "cloudName is the name of the desired OpenStack cloud in the client configuration file (`clouds.yaml`).",
"type": "string"
},
- "routerCanonicalHostname": {
- "description": "CanonicalHostname is the external host name for the router that can be used as a CNAME for the host requested for this route. This value is optional and may not be set in all cases.",
+ "ingressIP": {
+ "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
"type": "string"
},
- "routerName": {
- "description": "Name is a name chosen by the router to identify itself; this value is required",
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "loadBalancer": {
+ "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
+ "default": {
+ "type": "OpenShiftManagedDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenStackPlatformLoadBalancer"
+ },
+ "machineNetworks": {
+ "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "nodeDNSIP": {
+ "description": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for OpenStack deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
"type": "string"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.OperandVersion": {
+ "type": "object",
+ "required": [
+ "name",
+ "version"
+ ],
+ "properties": {
+ "name": {
+ "description": "name is the name of the particular operand this version is for. It usually matches container images, not operators.",
+ "type": "string",
+ "default": ""
},
- "wildcardPolicy": {
- "description": "Wildcard policy is the wildcard policy that was allowed where this route is exposed.",
- "type": "string"
+ "version": {
+ "description": "version indicates which version of a particular operand is currently being managed. It must always match the Available operand. If 1.0.0 is Available, then this must indicate 1.0.0 even if the operator is trying to rollout 1.1.0",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.route.v1.RouteIngressCondition": {
- "description": "RouteIngressCondition contains details for the current condition of this route on a particular router.",
+ "com.github.openshift.api.config.v1.OperatorHub": {
+ "description": "OperatorHub is the Schema for the operatorhubs API. It can be used to change the state of the default hub sources for OperatorHub on the cluster from enabled to disabled and vice versa.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "type",
+ "metadata",
+ "spec",
"status"
],
"properties": {
- "lastTransitionTime": {
- "description": "RFC 3339 date and time when this condition last transitioned",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "Human readable message indicating details about last transition.",
+ "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",
"type": "string"
},
- "reason": {
- "description": "(brief) reason for the condition's last transition, and is usually a machine and human readable constant",
+ "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",
"type": "string"
},
- "status": {
- "description": "status is the status of the condition. Can be True, False, Unknown.",
- "type": "string",
- "default": ""
+ "metadata": {
+ "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "default": {},
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "type": {
- "description": "type is the type of the condition. Currently only Admitted or UnservableInFutureVersions.",
- "type": "string",
- "default": ""
+ "spec": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OperatorHubSpec"
+ },
+ "status": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OperatorHubStatus"
}
}
},
- "com.github.openshift.api.route.v1.RouteList": {
- "description": "RouteList is a collection of Routes.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.OperatorHubList": {
+ "description": "OperatorHubList contains a list of OperatorHub\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -37267,11 +5656,10 @@
"type": "string"
},
"items": {
- "description": "items is a list of routes",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.Route"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OperatorHub"
}
},
"kind": {
@@ -37285,513 +5673,557 @@
}
}
},
- "com.github.openshift.api.route.v1.RoutePort": {
- "description": "RoutePort defines a port mapping from a router to an endpoint in the service endpoints.",
+ "com.github.openshift.api.config.v1.OperatorHubSpec": {
+ "description": "OperatorHubSpec defines the desired state of OperatorHub",
"type": "object",
- "required": [
- "targetPort"
- ],
"properties": {
- "targetPort": {
- "description": "The target port on pods selected by the service this route points to. If this is a string, it will be looked up as a named port in the target endpoints port list. Required",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
+ "disableAllDefaultSources": {
+ "description": "disableAllDefaultSources allows you to disable all the default hub sources. If this is true, a specific entry in sources can be used to enable a default source. If this is false, a specific entry in sources can be used to disable or enable a default source.",
+ "type": "boolean"
+ },
+ "sources": {
+ "description": "sources is the list of default hub sources and their configuration. If the list is empty, it implies that the default hub sources are enabled on the cluster unless disableAllDefaultSources is true. If disableAllDefaultSources is true and sources is not empty, the configuration present in sources will take precedence. The list of default hub sources and their current state will always be reflected in the status block.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.HubSource"
+ }
}
}
},
- "com.github.openshift.api.route.v1.RouteSetHTTPHeader": {
- "description": "RouteSetHTTPHeader specifies what value needs to be set on an HTTP header.",
+ "com.github.openshift.api.config.v1.OperatorHubStatus": {
+ "description": "OperatorHubStatus defines the observed state of OperatorHub. The current state of the default hub sources will always be reflected here.",
"type": "object",
- "required": [
- "value"
- ],
"properties": {
- "value": {
- "description": "value specifies a header value. Dynamic values can be added. The value will be interpreted as an HAProxy format string as defined in http://cbonte.github.io/haproxy-dconv/2.6/configuration.html#8.2.6 and may use HAProxy's %[] syntax and otherwise must be a valid HTTP header value as defined in https://datatracker.ietf.org/doc/html/rfc7230#section-3.2. The value of this field must be no more than 16384 characters in length. Note that the total size of all net added headers *after* interpolating dynamic values must not exceed the value of spec.tuningOptions.headerBufferMaxRewriteBytes on the IngressController.",
- "type": "string",
- "default": ""
+ "sources": {
+ "description": "sources encapsulates the result of applying the configuration for each hub source",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.HubSourceStatus"
+ }
}
}
},
- "com.github.openshift.api.route.v1.RouteSpec": {
- "description": "RouteSpec describes the hostname or path the route exposes, any security information, and one to four backends (services) the route points to. Requests are distributed among the backends depending on the weights assigned to each backend. When using roundrobin scheduling the portion of requests that go to each backend is the backend weight divided by the sum of all of the backend weights. When the backend has more than one endpoint the requests that end up on the backend are roundrobin distributed among the endpoints. Weights are between 0 and 256 with default 100. Weight 0 causes no requests to the backend. If all weights are zero the route will be considered to have no backends and return a standard 503 response.\n\nThe `tls` field is optional and allows specific certificates or behavior for the route. Routers typically configure a default certificate on a wildcard domain to terminate routes without explicit certificates, but custom hostnames usually must choose passthrough (send traffic directly to the backend via the TLS Server-Name- Indication field) or provide a certificate.",
+ "com.github.openshift.api.config.v1.OvirtPlatformLoadBalancer": {
+ "description": "OvirtPlatformLoadBalancer defines the load balancer used by the cluster on Ovirt platform.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "type defines the type of load balancer used by the cluster on Ovirt platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
+ "type": "string",
+ "default": "OpenShiftManagedDefault"
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {}
+ }
+ ]
+ },
+ "com.github.openshift.api.config.v1.OvirtPlatformSpec": {
+ "description": "OvirtPlatformSpec holds the desired state of the oVirt infrastructure provider. This only includes fields that can be modified in the cluster.",
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.OvirtPlatformStatus": {
+ "description": "OvirtPlatformStatus holds the current status of the oVirt infrastructure provider.",
"type": "object",
"required": [
- "to"
+ "apiServerInternalIPs",
+ "ingressIPs"
],
"properties": {
- "alternateBackends": {
- "description": "alternateBackends allows up to 3 additional backends to be assigned to the route. Only the Service kind is allowed, and it will be defaulted to Service. Use the weight field in RouteTargetReference object to specify relative preference.",
+ "apiServerInternalIP": {
+ "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
+ "type": "string"
+ },
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteTargetReference"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "name",
- "kind"
- ],
- "x-kubernetes-list-type": "map"
+ "x-kubernetes-list-type": "set"
},
- "host": {
- "description": "host is an alias/DNS that points to the service. Optional. If not specified a route name will typically be automatically chosen. Must follow DNS952 subdomain conventions.",
+ "ingressIP": {
+ "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
"type": "string"
},
- "httpHeaders": {
- "description": "httpHeaders defines policy for HTTP headers.",
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteHTTPHeaders"
- },
- "path": {
- "description": "path that the router watches for, to route traffic for to the service. Optional",
- "type": "string"
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "set"
},
- "port": {
- "description": "If specified, the port to be used by the router. Most routers will use all endpoints exposed by the service by default - set this value to instruct routers which port to use.",
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RoutePort"
+ "loadBalancer": {
+ "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
+ "default": {
+ "type": "OpenShiftManagedDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OvirtPlatformLoadBalancer"
},
- "subdomain": {
- "description": "subdomain is a DNS subdomain that is requested within the ingress controller's domain (as a subdomain). If host is set this field is ignored. An ingress controller may choose to ignore this suggested name, in which case the controller will report the assigned name in the status.ingress array or refuse to admit the route. If this value is set and the server does not support this field host will be populated automatically. Otherwise host is left empty. The field may have multiple parts separated by a dot, but not all ingress controllers may honor the request. This field may not be changed after creation except by a user with the update routes/custom-host permission.\n\nExample: subdomain `frontend` automatically receives the router subdomain `apps.mycluster.com` to have a full hostname `frontend.apps.mycluster.com`.",
+ "nodeDNSIP": {
+ "description": "deprecated: as of 4.6, this field is no longer set or honored. It will be removed in a future release.",
"type": "string"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.PKI": {
+ "description": "PKI defines the root of trust based on Root CA(s) and corresponding intermediate certificates.",
+ "type": "object",
+ "required": [
+ "caRootsData",
+ "pkiCertificateSubject"
+ ],
+ "properties": {
+ "caIntermediatesData": {
+ "description": "caIntermediatesData contains base64-encoded data of a certificate bundle PEM file, which contains one or more intermediate certificates in the PEM format. The total length of the data must not exceed 8192 characters. caIntermediatesData requires caRootsData to be set.",
+ "type": "string",
+ "format": "byte"
},
- "tls": {
- "description": "The tls field provides the ability to configure certificates and termination for the route.",
- "$ref": "#/definitions/com.github.openshift.api.route.v1.TLSConfig"
+ "caRootsData": {
+ "description": "caRootsData contains base64-encoded data of a certificate bundle PEM file, which contains one or more CA roots in the PEM format. The total length of the data must not exceed 8192 characters.",
+ "type": "string",
+ "format": "byte"
},
- "to": {
- "description": "to is an object the route should use as the primary backend. Only the Service kind is allowed, and it will be defaulted to Service. If the weight field (0-256 default 100) is set to zero, no traffic will be sent to this backend.",
+ "pkiCertificateSubject": {
+ "description": "pkiCertificateSubject defines the requirements imposed on the subject to which the certificate was issued.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteTargetReference"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PKICertificateSubject"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.PKICertificateSubject": {
+ "description": "PKICertificateSubject defines the requirements imposed on the subject to which the certificate was issued.",
+ "type": "object",
+ "properties": {
+ "email": {
+ "description": "email specifies the expected email address imposed on the subject to which the certificate was issued, and must match the email address listed in the Subject Alternative Name (SAN) field of the certificate. The email must be a valid email address and at most 320 characters in length.",
+ "type": "string"
},
- "wildcardPolicy": {
- "description": "Wildcard policy if any for the route. Currently only 'Subdomain' or 'None' is allowed.",
+ "hostname": {
+ "description": "hostname specifies the expected hostname imposed on the subject to which the certificate was issued, and it must match the hostname listed in the Subject Alternative Name (SAN) DNS field of the certificate. The hostname must be a valid dns 1123 subdomain name, optionally prefixed by '*.', and at most 253 characters in length. It must consist only of lowercase alphanumeric characters, hyphens, periods and the optional preceding asterisk.",
"type": "string"
}
}
},
- "com.github.openshift.api.route.v1.RouteStatus": {
- "description": "RouteStatus provides relevant info about the status of a route, including which routers acknowledge it.",
+ "com.github.openshift.api.config.v1.PersistentVolumeClaimReference": {
+ "description": "PersistentVolumeClaimReference is a reference to a PersistentVolumeClaim.",
"type": "object",
+ "required": [
+ "name"
+ ],
"properties": {
- "ingress": {
- "description": "ingress describes the places where the route may be exposed. The list of ingress points may contain duplicate Host or RouterName values. Routes are considered live once they are `Ready`",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.route.v1.RouteIngress"
- },
- "x-kubernetes-list-type": "atomic"
+ "name": {
+ "description": "name is the name of the PersistentVolumeClaim that will be used to store the Insights data archive. It is a string that follows the DNS1123 subdomain format. It must be at most 253 characters in length, and must consist only of lower case alphanumeric characters, '-' and '.', and must start and end with an alphanumeric character.",
+ "type": "string"
}
}
},
- "com.github.openshift.api.route.v1.RouteTargetReference": {
- "description": "RouteTargetReference specifies the target that resolve into endpoints. Only the 'Service' kind is allowed. Use 'weight' field to emphasize one over others.",
+ "com.github.openshift.api.config.v1.PersistentVolumeConfig": {
+ "description": "PersistentVolumeConfig provides configuration options for PersistentVolume storage.",
"type": "object",
"required": [
- "kind",
- "name"
+ "claim"
],
"properties": {
- "kind": {
- "description": "The kind of target that the route is referring to. Currently, only 'Service' is allowed",
- "type": "string",
- "default": ""
+ "claim": {
+ "description": "claim is a required field that specifies the configuration of the PersistentVolumeClaim that will be used to store the Insights data archive. The PersistentVolumeClaim must be created in the openshift-insights namespace.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PersistentVolumeClaimReference"
+ },
+ "mountPath": {
+ "description": "mountPath is an optional field specifying the directory where the PVC will be mounted inside the Insights data gathering Pod. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default mount path is /var/lib/insights-operator The path may not exceed 1024 characters and must not contain a colon.",
+ "type": "string"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.PlatformSpec": {
+ "description": "PlatformSpec holds the desired state specific to the underlying infrastructure provider of the current cluster. Since these are used at spec-level for the underlying cluster, it is supposed that only one of the spec structs is set.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "alibabaCloud": {
+ "description": "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AlibabaCloudPlatformSpec"
+ },
+ "aws": {
+ "description": "aws contains settings specific to the Amazon Web Services infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSPlatformSpec"
+ },
+ "azure": {
+ "description": "azure contains settings specific to the Azure infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AzurePlatformSpec"
+ },
+ "baremetal": {
+ "description": "baremetal contains settings specific to the BareMetal platform.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BareMetalPlatformSpec"
+ },
+ "equinixMetal": {
+ "description": "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.EquinixMetalPlatformSpec"
+ },
+ "external": {
+ "description": "ExternalPlatformType represents generic infrastructure provider. Platform-specific components should be supplemented separately.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalPlatformSpec"
+ },
+ "gcp": {
+ "description": "gcp contains settings specific to the Google Cloud Platform infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPPlatformSpec"
+ },
+ "ibmcloud": {
+ "description": "ibmcloud contains settings specific to the IBMCloud infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudPlatformSpec"
+ },
+ "kubevirt": {
+ "description": "kubevirt contains settings specific to the kubevirt infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.KubevirtPlatformSpec"
+ },
+ "nutanix": {
+ "description": "nutanix contains settings specific to the Nutanix infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPlatformSpec"
+ },
+ "openstack": {
+ "description": "openstack contains settings specific to the OpenStack infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenStackPlatformSpec"
},
- "name": {
- "description": "name of the service/target that is being referred to. e.g. name of the service",
- "type": "string",
- "default": ""
+ "ovirt": {
+ "description": "ovirt contains settings specific to the oVirt infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OvirtPlatformSpec"
},
- "weight": {
- "description": "weight as an integer between 0 and 256, default 100, that specifies the target's relative weight against other target reference objects. 0 suppresses requests to this backend.",
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "com.github.openshift.api.route.v1.RouterShard": {
- "description": "RouterShard has information of a routing shard and is used to generate host names and routing table entries when a routing shard is allocated for a specific route. Caveat: This is WIP and will likely undergo modifications when sharding support is added.",
- "type": "object",
- "required": [
- "shardName",
- "dnsSuffix"
- ],
- "properties": {
- "dnsSuffix": {
- "description": "dnsSuffix for the shard ala: shard-1.v3.openshift.com",
- "type": "string",
- "default": ""
+ "powervs": {
+ "description": "powervs contains settings specific to the IBM Power Systems Virtual Servers infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSPlatformSpec"
},
- "shardName": {
- "description": "shardName uniquely identifies a router shard in the \"set\" of routers used for routing traffic to the services.",
+ "type": {
+ "description": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"KubeVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.",
"type": "string",
"default": ""
+ },
+ "vsphere": {
+ "description": "vsphere contains settings specific to the VSphere infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformSpec"
}
}
},
- "com.github.openshift.api.route.v1.TLSConfig": {
- "description": "TLSConfig defines config used to secure a route and provide termination",
+ "com.github.openshift.api.config.v1.PlatformStatus": {
+ "description": "PlatformStatus holds the current status specific to the underlying infrastructure provider of the current cluster. Since these are used at status-level for the underlying cluster, it is supposed that only one of the status structs is set.",
"type": "object",
"required": [
- "termination"
+ "type"
],
"properties": {
- "caCertificate": {
- "description": "caCertificate provides the cert authority certificate contents",
- "type": "string"
+ "alibabaCloud": {
+ "description": "alibabaCloud contains settings specific to the Alibaba Cloud infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AlibabaCloudPlatformStatus"
},
- "certificate": {
- "description": "certificate provides certificate contents. This should be a single serving certificate, not a certificate chain. Do not include a CA certificate.",
- "type": "string"
+ "aws": {
+ "description": "aws contains settings specific to the Amazon Web Services infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AWSPlatformStatus"
},
- "destinationCACertificate": {
- "description": "destinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt termination this file should be provided in order to have routers use it for health checks on the secure connection. If this field is not specified, the router may provide its own destination CA and perform hostname validation using the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically verify.",
- "type": "string"
+ "azure": {
+ "description": "azure contains settings specific to the Azure infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.AzurePlatformStatus"
},
- "externalCertificate": {
- "description": "externalCertificate provides certificate contents as a secret reference. This should be a single serving certificate, not a certificate chain. Do not include a CA certificate. The secret referenced should be present in the same namespace as that of the Route. Forbidden when `certificate` is set. The router service account needs to be granted with read-only access to this secret, please refer to openshift docs for additional details.",
- "$ref": "#/definitions/com.github.openshift.api.route.v1.LocalObjectReference"
+ "baremetal": {
+ "description": "baremetal contains settings specific to the BareMetal platform.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.BareMetalPlatformStatus"
},
- "insecureEdgeTerminationPolicy": {
- "description": "insecureEdgeTerminationPolicy indicates the desired behavior for insecure connections to a route. While each router may make its own decisions on which ports to expose, this is normally port 80.\n\nIf a route does not specify insecureEdgeTerminationPolicy, then the default behavior is \"None\".\n\n* Allow - traffic is sent to the server on the insecure port (edge/reencrypt terminations only).\n\n* None - no traffic is allowed on the insecure port (default).\n\n* Redirect - clients are redirected to the secure port.",
- "type": "string"
+ "equinixMetal": {
+ "description": "equinixMetal contains settings specific to the Equinix Metal infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.EquinixMetalPlatformStatus"
},
- "key": {
- "description": "key provides key file contents",
- "type": "string"
+ "external": {
+ "description": "external contains settings specific to the generic External infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ExternalPlatformStatus"
+ },
+ "gcp": {
+ "description": "gcp contains settings specific to the Google Cloud Platform infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.GCPPlatformStatus"
+ },
+ "ibmcloud": {
+ "description": "ibmcloud contains settings specific to the IBMCloud infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IBMCloudPlatformStatus"
},
- "termination": {
- "description": "termination indicates the TLS termination type.\n\n* edge - TLS termination is done by the router and http is used to communicate with the backend (default)\n\n* passthrough - Traffic is sent straight to the destination without the router providing TLS termination\n\n* reencrypt - TLS termination is done by the router and https is used to communicate with the backend\n\nNote: passthrough termination is incompatible with httpHeader actions",
+ "kubevirt": {
+ "description": "kubevirt contains settings specific to the kubevirt infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.KubevirtPlatformStatus"
+ },
+ "nutanix": {
+ "description": "nutanix contains settings specific to the Nutanix infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NutanixPlatformStatus"
+ },
+ "openstack": {
+ "description": "openstack contains settings specific to the OpenStack infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OpenStackPlatformStatus"
+ },
+ "ovirt": {
+ "description": "ovirt contains settings specific to the oVirt infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OvirtPlatformStatus"
+ },
+ "powervs": {
+ "description": "powervs contains settings specific to the Power Systems Virtual Servers infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSPlatformStatus"
+ },
+ "type": {
+ "description": "type is the underlying infrastructure provider for the cluster. This value controls whether infrastructure automation such as service load balancers, dynamic volume provisioning, machine creation and deletion, and other integrations are enabled. If None, no infrastructure automation is enabled. Allowed values are \"AWS\", \"Azure\", \"BareMetal\", \"GCP\", \"Libvirt\", \"OpenStack\", \"VSphere\", \"oVirt\", \"EquinixMetal\", \"PowerVS\", \"AlibabaCloud\", \"Nutanix\" and \"None\". Individual components may not support all platforms, and must handle unrecognized platforms as None if they do not support that platform.\n\nThis value will be synced with to the `status.platform` and `status.platformStatus.type`. Currently this value cannot be changed once set.",
"type": "string",
"default": ""
+ },
+ "vsphere": {
+ "description": "vsphere contains settings specific to the VSphere infrastructure provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformStatus"
}
}
},
- "com.github.openshift.api.samples.v1.Config": {
- "description": "Config contains the configuration and detailed condition status for the Samples Operator.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.Policy": {
+ "description": "Policy defines the verification policy for the items in the scopes list.",
"type": "object",
"required": [
- "metadata",
- "spec"
+ "rootOfTrust"
],
"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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
+ "rootOfTrust": {
+ "description": "rootOfTrust is a required field that defines the root of trust for verifying image signatures during retrieval. This allows image consumers to specify policyType and corresponding configuration of the policy, matching how the policy was generated.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.samples.v1.ConfigSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyRootOfTrust"
},
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.samples.v1.ConfigStatus"
+ "signedIdentity": {
+ "description": "signedIdentity is an optional field specifies what image identity the signature claims about the image. This is useful when the image identity in the signature differs from the original image spec, such as when mirror registry is configured for the image scope, the signature from the mirror registry contains the image identity of the mirror instead of the original scope. The required matchPolicy field specifies the approach used in the verification process to verify the identity in the signature and the actual image identity, the default matchPolicy is \"MatchRepoDigestOrExact\".",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyIdentity"
}
}
},
- "com.github.openshift.api.samples.v1.ConfigCondition": {
- "description": "ConfigCondition captures various conditions of the Config as entries are processed.",
+ "com.github.openshift.api.config.v1.PolicyFulcioSubject": {
+ "description": "PolicyFulcioSubject defines the OIDC issuer and the email of the Fulcio authentication configuration.",
"type": "object",
"required": [
- "type",
- "status"
+ "oidcIssuer",
+ "signedEmail"
],
"properties": {
- "lastTransitionTime": {
- "description": "lastTransitionTime is the last time the condition transitioned from one status to another.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "lastUpdateTime": {
- "description": "lastUpdateTime is the last time this condition was updated.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "message is a human readable message indicating details about the transition.",
- "type": "string"
- },
- "reason": {
- "description": "reason is what caused the condition's last transition.",
- "type": "string"
- },
- "status": {
- "description": "status of the condition, one of True, False, Unknown.",
+ "oidcIssuer": {
+ "description": "oidcIssuer is a required filed contains the expected OIDC issuer. The oidcIssuer must be a valid URL and at most 2048 characters in length. It will be verified that the Fulcio-issued certificate contains a (Fulcio-defined) certificate extension pointing at this OIDC issuer URL. When Fulcio issues certificates, it includes a value based on an URL inside the client-provided ID token. Example: \"https://expected.OIDC.issuer/\"",
"type": "string",
"default": ""
},
- "type": {
- "description": "type of condition.",
+ "signedEmail": {
+ "description": "signedEmail is a required field holds the email address that the Fulcio certificate is issued for. The signedEmail must be a valid email address and at most 320 characters in length. Example: \"expected-signing-user@example.com\"",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.samples.v1.ConfigList": {
- "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.PolicyIdentity": {
+ "description": "PolicyIdentity defines image identity the signature claims about the image. When omitted, the default matchPolicy is \"MatchRepoDigestOrExact\".",
"type": "object",
"required": [
- "metadata",
- "items"
+ "matchPolicy"
],
"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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.samples.v1.Config"
- }
+ "exactRepository": {
+ "description": "exactRepository specifies the repository that must be exactly matched by the identity in the signature. exactRepository is required if matchPolicy is set to \"ExactRepository\". It is used to verify that the signature claims an identity matching this exact repository, rather than the original image identity.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyMatchExactRepository"
},
- "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",
- "type": "string"
+ "matchPolicy": {
+ "description": "matchPolicy is a required filed specifies matching strategy to verify the image identity in the signature against the image scope. Allowed values are \"MatchRepoDigestOrExact\", \"MatchRepository\", \"ExactRepository\", \"RemapIdentity\". When omitted, the default value is \"MatchRepoDigestOrExact\". When set to \"MatchRepoDigestOrExact\", the identity in the signature must be in the same repository as the image identity if the image identity is referenced by a digest. Otherwise, the identity in the signature must be the same as the image identity. When set to \"MatchRepository\", the identity in the signature must be in the same repository as the image identity. When set to \"ExactRepository\", the exactRepository must be specified. The identity in the signature must be in the same repository as a specific identity specified by \"repository\". When set to \"RemapIdentity\", the remapIdentity must be specified. The signature must be in the same as the remapped image identity. Remapped image identity is obtained by replacing the \"prefix\" with the specified “signedPrefix” if the the image identity matches the specified remapPrefix.",
+ "type": "string",
+ "default": ""
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "remapIdentity": {
+ "description": "remapIdentity specifies the prefix remapping rule for verifying image identity. remapIdentity is required if matchPolicy is set to \"RemapIdentity\". It is used to verify that the signature claims a different registry/repository prefix than the original image.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PolicyMatchRemapIdentity"
}
- }
- },
- "com.github.openshift.api.samples.v1.ConfigSpec": {
- "description": "ConfigSpec contains the desired configuration and state for the Samples Operator, controlling various behavior around the imagestreams and templates it creates/updates in the openshift namespace.",
- "type": "object",
- "properties": {
- "architectures": {
- "description": "architectures determine which hardware architecture(s) to install, where x86_64, ppc64le, and s390x are the only supported choices currently.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "managementState": {
- "description": "managementState is top level on/off type of switch for all operators. When \"Managed\", this operator processes config and manipulates the samples accordingly. When \"Unmanaged\", this operator ignores any updates to the resources it watches. When \"Removed\", it reacts that same wasy as it does if the Config object is deleted, meaning any ImageStreams or Templates it manages (i.e. it honors the skipped lists) and the registry secret are deleted, along with the ConfigMap in the operator's namespace that represents the last config used to manipulate the samples,",
- "type": "string"
- },
- "samplesRegistry": {
- "description": "samplesRegistry allows for the specification of which registry is accessed by the ImageStreams for their image content. Defaults on the content in https://github.com/openshift/library that are pulled into this github repository, but based on our pulling only ocp content it typically defaults to registry.redhat.io.",
- "type": "string"
- },
- "skippedHelmCharts": {
- "description": "skippedHelmCharts specifies names of helm charts that should NOT be managed. Admins can use this to allow them to delete content they don’t want. They will still have to MANUALLY DELETE the content but the operator will not recreate(or update) anything listed here. Few examples of the name of helmcharts which can be skipped are 'redhat-redhat-perl-imagestreams','redhat-redhat-nodejs-imagestreams','redhat-nginx-imagestreams', 'redhat-redhat-ruby-imagestreams','redhat-redhat-python-imagestreams','redhat-redhat-php-imagestreams', 'redhat-httpd-imagestreams','redhat-redhat-dotnet-imagestreams'. Rest of the names can be obtained from openshift console --> helmcharts -->installed helmcharts. This will display the list of all the 12 helmcharts(of imagestreams)being installed by Samples Operator. The skippedHelmCharts must be a valid Kubernetes resource name. May contain only lowercase alphanumeric characters, hyphens and periods, and each period separated segment must begin and end with an alphanumeric character. It must be non-empty and at most 253 characters in length",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-list-type": "set"
- },
- "skippedImagestreams": {
- "description": "skippedImagestreams specifies names of image streams that should NOT be created/updated. Admins can use this to allow them to delete content they don’t want. They will still have to manually delete the content but the operator will not recreate(or update) anything listed here.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- },
- "skippedTemplates": {
- "description": "skippedTemplates specifies names of templates that should NOT be created/updated. Admins can use this to allow them to delete content they don’t want. They will still have to manually delete the content but the operator will not recreate(or update) anything listed here.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "matchPolicy",
+ "fields-to-discriminateBy": {
+ "exactRepository": "PolicyMatchExactRepository",
+ "remapIdentity": "PolicyMatchRemapIdentity"
}
}
- }
+ ]
},
- "com.github.openshift.api.samples.v1.ConfigStatus": {
- "description": "ConfigStatus contains the actual configuration in effect, as well as various details that describe the state of the Samples Operator.",
+ "com.github.openshift.api.config.v1.PolicyMatchExactRepository": {
"type": "object",
- "properties": {
- "architectures": {
- "description": "architectures determine which hardware architecture(s) to install, where x86_64 and ppc64le are the supported choices.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "conditions": {
- "description": "conditions represents the available maintenance status of the sample imagestreams and templates.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.samples.v1.ConfigCondition"
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "managementState": {
- "description": "managementState reflects the current operational status of the on/off switch for the operator. This operator compares the ManagementState as part of determining that we are turning the operator back on (i.e. \"Managed\") when it was previously \"Unmanaged\".",
- "type": "string",
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "samplesRegistry": {
- "description": "samplesRegistry allows for the specification of which registry is accessed by the ImageStreams for their image content. Defaults on the content in https://github.com/openshift/library that are pulled into this github repository, but based on our pulling only ocp content it typically defaults to registry.redhat.io.",
- "type": "string",
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "skippedImagestreams": {
- "description": "skippedImagestreams specifies names of image streams that should NOT be created/updated. Admins can use this to allow them to delete content they don’t want. They will still have to manually delete the content but the operator will not recreate(or update) anything listed here.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "skippedTemplates": {
- "description": "skippedTemplates specifies names of templates that should NOT be created/updated. Admins can use this to allow them to delete content they don’t want. They will still have to manually delete the content but the operator will not recreate(or update) anything listed here.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- },
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
- },
- "version": {
- "description": "version is the value of the operator's payload based version indicator when it was last successfully processed",
+ "required": [
+ "repository"
+ ],
+ "properties": {
+ "repository": {
+ "description": "repository is the reference of the image identity to be matched. repository is required if matchPolicy is set to \"ExactRepository\". The value should be a repository name (by omitting the tag or digest) in a registry implementing the \"Docker Registry HTTP API V2\". For example, docker.io/library/busybox",
"type": "string",
- "x-kubernetes-patch-merge-key": "type",
- "x-kubernetes-patch-strategy": "merge"
+ "default": ""
}
}
},
- "com.github.openshift.api.security.v1.AllowedFlexVolume": {
- "description": "AllowedFlexVolume represents a single Flexvolume that is allowed to be used.",
+ "com.github.openshift.api.config.v1.PolicyMatchRemapIdentity": {
"type": "object",
"required": [
- "driver"
+ "prefix",
+ "signedPrefix"
],
"properties": {
- "driver": {
- "description": "driver is the name of the Flexvolume driver.",
+ "prefix": {
+ "description": "prefix is required if matchPolicy is set to \"RemapIdentity\". prefix is the prefix of the image identity to be matched. If the image identity matches the specified prefix, that prefix is replaced by the specified “signedPrefix” (otherwise it is used as unchanged and no remapping takes place). This is useful when verifying signatures for a mirror of some other repository namespace that preserves the vendor’s repository structure. The prefix and signedPrefix values can be either host[:port] values (matching exactly the same host[:port], string), repository namespaces, or repositories (i.e. they must not contain tags/digests), and match as prefixes of the fully expanded form. For example, docker.io/library/busybox (not busybox) to specify that single repository, or docker.io/library (not an empty string) to specify the parent namespace of docker.io/library/busybox.",
+ "type": "string",
+ "default": ""
+ },
+ "signedPrefix": {
+ "description": "signedPrefix is required if matchPolicy is set to \"RemapIdentity\". signedPrefix is the prefix of the image identity to be matched in the signature. The format is the same as \"prefix\". The values can be either host[:port] values (matching exactly the same host[:port], string), repository namespaces, or repositories (i.e. they must not contain tags/digests), and match as prefixes of the fully expanded form. For example, docker.io/library/busybox (not busybox) to specify that single repository, or docker.io/library (not an empty string) to specify the parent namespace of docker.io/library/busybox.",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.security.v1.FSGroupStrategyOptions": {
- "description": "FSGroupStrategyOptions defines the strategy type and options used to create the strategy.",
+ "com.github.openshift.api.config.v1.PolicyRootOfTrust": {
+ "description": "PolicyRootOfTrust defines the root of trust based on the selected policyType.",
"type": "object",
+ "required": [
+ "policyType"
+ ],
"properties": {
- "ranges": {
- "description": "ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.IDRange"
- },
- "x-kubernetes-list-type": "atomic"
+ "fulcioCAWithRekor": {
+ "description": "fulcioCAWithRekor defines the root of trust configuration based on the Fulcio certificate and the Rekor public key. fulcioCAWithRekor is required when policyType is FulcioCAWithRekor, and forbidden otherwise For more information about Fulcio and Rekor, please refer to the document at: https://github.com/sigstore/fulcio and https://github.com/sigstore/rekor",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FulcioCAWithRekor"
},
- "type": {
- "description": "type is the strategy that will dictate what FSGroup is used in the SecurityContext.",
- "type": "string"
+ "pki": {
+ "description": "pki defines the root of trust configuration based on Bring Your Own Public Key Infrastructure (BYOPKI) Root CA(s) and corresponding intermediate certificates. pki is required when policyType is PKI, and forbidden otherwise.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PKI"
+ },
+ "policyType": {
+ "description": "policyType is a required field specifies the type of the policy for verification. This field must correspond to how the policy was generated. Allowed values are \"PublicKey\", \"FulcioCAWithRekor\", and \"PKI\". When set to \"PublicKey\", the policy relies on a sigstore publicKey and may optionally use a Rekor verification. When set to \"FulcioCAWithRekor\", the policy is based on the Fulcio certification and incorporates a Rekor verification. When set to \"PKI\", the policy is based on the certificates from Bring Your Own Public Key Infrastructure (BYOPKI). This value is enabled by turning on the SigstoreImageVerificationPKI feature gate.",
+ "type": "string",
+ "default": ""
+ },
+ "publicKey": {
+ "description": "publicKey defines the root of trust configuration based on a sigstore public key. Optionally include a Rekor public key for Rekor verification. publicKey is required when policyType is PublicKey, and forbidden otherwise.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PublicKey"
}
- }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "policyType",
+ "fields-to-discriminateBy": {
+ "fulcioCAWithRekor": "FulcioCAWithRekor",
+ "pki": "PKI",
+ "publicKey": "PublicKey"
+ }
+ }
+ ]
},
- "com.github.openshift.api.security.v1.IDRange": {
- "description": "IDRange provides a min/max of an allowed range of IDs.",
+ "com.github.openshift.api.config.v1.PowerVSPlatformSpec": {
+ "description": "PowerVSPlatformSpec holds the desired state of the IBM Power Systems Virtual Servers infrastructure provider. This only includes fields that can be modified in the cluster.",
"type": "object",
"properties": {
- "max": {
- "description": "max is the end of the range, inclusive.",
- "type": "integer",
- "format": "int64"
- },
- "min": {
- "description": "min is the start of the range, inclusive.",
- "type": "integer",
- "format": "int64"
+ "serviceEndpoints": {
+ "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSServiceEndpoint"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
}
}
},
- "com.github.openshift.api.security.v1.PodSecurityPolicyReview": {
- "description": "PodSecurityPolicyReview checks which service accounts (not users, since that would be cluster-wide) can create the `PodTemplateSpec` in question.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.PowerVSPlatformStatus": {
+ "description": "PowerVSPlatformStatus holds the current status of the IBM Power Systems Virtual Servers infrastrucutre provider.",
"type": "object",
"required": [
- "spec"
+ "region",
+ "zone"
],
"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",
+ "cisInstanceCRN": {
+ "description": "cisInstanceCRN is the CRN of the Cloud Internet Services instance managing the DNS zone for the cluster's base domain",
"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",
+ "dnsInstanceCRN": {
+ "description": "dnsInstanceCRN is the CRN of the DNS Services instance managing the DNS zone for the cluster's base domain",
"type": "string"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "region": {
+ "description": "region holds the default Power VS region for new Power VS resources created by the cluster.",
+ "type": "string",
+ "default": ""
},
- "spec": {
- "description": "spec is the PodSecurityPolicy to check.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.PodSecurityPolicyReviewSpec"
+ "resourceGroup": {
+ "description": "resourceGroup is the resource group name for new IBMCloud resources created for a cluster. The resource group specified here will be used by cluster-image-registry-operator to set up a COS Instance in IBMCloud for the cluster registry. More about resource groups can be found here: https://cloud.ibm.com/docs/account?topic=account-rgs. When omitted, the image registry operator won't be able to configure storage, which results in the image registry cluster operator not being in an available state.",
+ "type": "string",
+ "default": ""
},
- "status": {
- "description": "status represents the current information/status for the PodSecurityPolicyReview.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.PodSecurityPolicyReviewStatus"
+ "serviceEndpoints": {
+ "description": "serviceEndpoints is a list of custom endpoints which will override the default service endpoints of a Power VS service.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PowerVSServiceEndpoint"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
+ },
+ "zone": {
+ "description": "zone holds the default zone for the new Power VS resources created by the cluster. Note: Currently only single-zone OCP clusters are supported",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.security.v1.PodSecurityPolicyReviewSpec": {
- "description": "PodSecurityPolicyReviewSpec defines specification for PodSecurityPolicyReview",
+ "com.github.openshift.api.config.v1.PowerVSServiceEndpoint": {
+ "description": "PowervsServiceEndpoint stores the configuration of a custom url to override existing defaults of PowerVS Services.",
"type": "object",
"required": [
- "template"
+ "name",
+ "url"
],
"properties": {
- "serviceAccountNames": {
- "description": "serviceAccountNames is an optional set of ServiceAccounts to run the check with. If serviceAccountNames is empty, the template.spec.serviceAccountName is used, unless it's empty, in which case \"default\" is used instead. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
+ "name": {
+ "description": "name is the name of the Power VS service. Few of the services are IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud",
+ "type": "string",
+ "default": ""
},
- "template": {
- "description": "template is the PodTemplateSpec to check. The template.spec.serviceAccountName field is used if serviceAccountNames is empty, unless the template.spec.serviceAccountName is empty, in which case \"default\" is used. If serviceAccountNames is specified, template.spec.serviceAccountName is ignored.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.PodTemplateSpec"
+ "url": {
+ "description": "url is fully qualified URI with scheme https, that overrides the default generated endpoint for a client. This must be provided and cannot be empty.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.security.v1.PodSecurityPolicyReviewStatus": {
- "description": "PodSecurityPolicyReviewStatus represents the status of PodSecurityPolicyReview.",
+ "com.github.openshift.api.config.v1.PrefixedClaimMapping": {
+ "description": "PrefixedClaimMapping configures a claim mapping that allows for an optional prefix.",
"type": "object",
+ "required": [
+ "claim"
+ ],
"properties": {
- "allowedServiceAccounts": {
- "description": "allowedServiceAccounts returns the list of service accounts in *this* namespace that have the power to create the PodTemplateSpec.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.ServiceAccountPodSecurityPolicyReviewStatus"
- }
+ "claim": {
+ "description": "claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.",
+ "type": "string",
+ "default": ""
+ },
+ "prefix": {
+ "description": "prefix is an optional field that configures the prefix that will be applied to the cluster identity attribute during the process of mapping JWT claims to cluster identity attributes.\n\nWhen omitted (\"\"), no prefix is applied to the cluster identity attribute.\n\nExample: if `prefix` is set to \"myoidc:\" and the `claim` in JWT contains an array of strings \"a\", \"b\" and \"c\", the mapping will result in an array of string \"myoidc:a\", \"myoidc:b\" and \"myoidc:c\".",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.security.v1.PodSecurityPolicySelfSubjectReview": {
- "description": "PodSecurityPolicySelfSubjectReview checks whether this user/SA tuple can create the PodTemplateSpec\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.Project": {
+ "description": "Project holds cluster-wide information about Project. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
"spec"
@@ -37811,125 +6243,91 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec defines specification the PodSecurityPolicySelfSubjectReview.",
+ "description": "spec holds user settable values for configuration",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.PodSecurityPolicySelfSubjectReviewSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ProjectSpec"
},
"status": {
- "description": "status represents the current information/status for the PodSecurityPolicySelfSubjectReview.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.PodSecurityPolicySubjectReviewStatus"
- }
- }
- },
- "com.github.openshift.api.security.v1.PodSecurityPolicySelfSubjectReviewSpec": {
- "description": "PodSecurityPolicySelfSubjectReviewSpec contains specification for PodSecurityPolicySelfSubjectReview.",
- "type": "object",
- "required": [
- "template"
- ],
- "properties": {
- "template": {
- "description": "template is the PodTemplateSpec to check.",
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.PodTemplateSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ProjectStatus"
}
}
},
- "com.github.openshift.api.security.v1.PodSecurityPolicySubjectReview": {
- "description": "PodSecurityPolicySubjectReview checks whether a particular user/SA tuple can create the PodTemplateSpec.\n\nCompatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ProjectList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "spec"
+ "metadata",
+ "items"
],
"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",
"type": "string"
},
+ "items": {
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Project"
+ }
+ },
"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",
"type": "string"
},
"metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec defines specification for the PodSecurityPolicySubjectReview.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.PodSecurityPolicySubjectReviewSpec"
- },
- "status": {
- "description": "status represents the current information/status for the PodSecurityPolicySubjectReview.",
+ "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.PodSecurityPolicySubjectReviewStatus"
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.security.v1.PodSecurityPolicySubjectReviewSpec": {
- "description": "PodSecurityPolicySubjectReviewSpec defines specification for PodSecurityPolicySubjectReview",
+ "com.github.openshift.api.config.v1.ProjectSpec": {
+ "description": "ProjectSpec holds the project creation configuration.",
"type": "object",
- "required": [
- "template"
- ],
"properties": {
- "groups": {
- "description": "groups is the groups you're testing for.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
+ "projectRequestMessage": {
+ "description": "projectRequestMessage is the string presented to a user if they are unable to request a project via the projectrequest api endpoint",
+ "type": "string",
+ "default": ""
},
- "template": {
- "description": "template is the PodTemplateSpec to check. If template.spec.serviceAccountName is empty it will not be defaulted. If its non-empty, it will be checked.",
+ "projectRequestTemplate": {
+ "description": "projectRequestTemplate is the template to use for creating projects in response to projectrequest. This must point to a template in 'openshift-config' namespace. It is optional. If it is not specified, a default template is used.",
"default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.PodTemplateSpec"
- },
- "user": {
- "description": "user is the user you're testing for. If you specify \"user\" but not \"group\", then is it interpreted as \"What if user were not a member of any groups. If user and groups are empty, then the check is performed using *only* the serviceAccountName in the template.",
- "type": "string"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TemplateReference"
}
}
},
- "com.github.openshift.api.security.v1.PodSecurityPolicySubjectReviewStatus": {
- "description": "PodSecurityPolicySubjectReviewStatus contains information/status for PodSecurityPolicySubjectReview.",
+ "com.github.openshift.api.config.v1.ProjectStatus": {
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.PromQLClusterCondition": {
+ "description": "PromQLClusterCondition represents a cluster condition based on PromQL.",
"type": "object",
+ "required": [
+ "promql"
+ ],
"properties": {
- "allowedBy": {
- "description": "allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A `nil`, indicates that it was denied.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "reason": {
- "description": "A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
- "type": "string"
- },
- "template": {
- "description": "template is the PodTemplateSpec after the defaulting is applied.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.PodTemplateSpec"
+ "promql": {
+ "description": "promql is a PromQL query classifying clusters. This query query should return a 1 in the match case and a 0 in the does-not-match case. Queries which return no time series, or which return values besides 0 or 1, are evaluation failures.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.security.v1.RangeAllocation": {
- "description": "RangeAllocation is used so we can easily expose a RangeAllocation typed for security group\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.Proxy": {
+ "description": "Proxy holds cluster-wide information on how to configure default proxies for the cluster. The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "range",
- "data"
+ "spec"
],
"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",
"type": "string"
},
- "data": {
- "description": "data is a byte array representing the serialized state of a range allocation. It is a bitmap with each bit set to one to represent a range is taken.",
- "type": "string",
- "format": "byte"
- },
"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",
"type": "string"
@@ -37939,17 +6337,23 @@
"default": {},
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "range": {
- "description": "range is a string representing a unique label for a range of uids, \"1000000000-2000000000/10000\".",
- "type": "string",
- "default": ""
+ "spec": {
+ "description": "spec holds user-settable values for the proxy configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxySpec"
+ },
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ProxyStatus"
}
}
},
- "com.github.openshift.api.security.v1.RangeAllocationList": {
- "description": "RangeAllocationList is a list of RangeAllocations objects\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.ProxyList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -37958,11 +6362,10 @@
"type": "string"
},
"items": {
- "description": "List of RangeAllocations.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.RangeAllocation"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Proxy"
}
},
"kind": {
@@ -37976,99 +6379,98 @@
}
}
},
- "com.github.openshift.api.security.v1.RunAsUserStrategyOptions": {
- "description": "RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.",
+ "com.github.openshift.api.config.v1.ProxySpec": {
+ "description": "ProxySpec contains cluster proxy creation configuration.",
"type": "object",
"properties": {
- "type": {
- "description": "type is the strategy that will dictate what RunAsUser is used in the SecurityContext.",
+ "httpProxy": {
+ "description": "httpProxy is the URL of the proxy for HTTP requests. Empty means unset and will not result in an env var.",
"type": "string"
},
- "uid": {
- "description": "uid is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids.",
- "type": "integer",
- "format": "int64"
+ "httpsProxy": {
+ "description": "httpsProxy is the URL of the proxy for HTTPS requests. Empty means unset and will not result in an env var.",
+ "type": "string"
},
- "uidRangeMax": {
- "description": "uidRangeMax defines the max value for a strategy that allocates by range.",
- "type": "integer",
- "format": "int64"
+ "noProxy": {
+ "description": "noProxy is a comma-separated list of hostnames and/or CIDRs and/or IPs for which the proxy should not be used. Empty means unset and will not result in an env var.",
+ "type": "string"
},
- "uidRangeMin": {
- "description": "uidRangeMin defines the min value for a strategy that allocates by range.",
- "type": "integer",
- "format": "int64"
+ "readinessEndpoints": {
+ "description": "readinessEndpoints is a list of endpoints used to verify readiness of the proxy.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "trustedCA": {
+ "description": "trustedCA is a reference to a ConfigMap containing a CA certificate bundle. The trustedCA field should only be consumed by a proxy validator. The validator is responsible for reading the certificate bundle from the required key \"ca-bundle.crt\", merging it with the system default trust bundle, and writing the merged trust bundle to a ConfigMap named \"trusted-ca-bundle\" in the \"openshift-config-managed\" namespace. Clients that expect to make proxy connections must use the trusted-ca-bundle for all HTTPS requests to the proxy, and may use the trusted-ca-bundle for non-proxy HTTPS requests as well.\n\nThe namespace for the ConfigMap referenced by trustedCA is \"openshift-config\". Here is an example ConfigMap (in yaml):\n\napiVersion: v1 kind: ConfigMap metadata:\n name: user-ca-bundle\n namespace: openshift-config\n data:\n ca-bundle.crt: |\n -----BEGIN CERTIFICATE-----\n Custom CA certificate bundle.\n -----END CERTIFICATE-----",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
}
}
},
- "com.github.openshift.api.security.v1.SELinuxContextStrategyOptions": {
- "description": "SELinuxContextStrategyOptions defines the strategy type and any options used to create the strategy.",
+ "com.github.openshift.api.config.v1.ProxyStatus": {
+ "description": "ProxyStatus shows current known state of the cluster proxy.",
"type": "object",
"properties": {
- "seLinuxOptions": {
- "description": "seLinuxOptions required to run as; required for MustRunAs",
- "$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions"
+ "httpProxy": {
+ "description": "httpProxy is the URL of the proxy for HTTP requests.",
+ "type": "string"
},
- "type": {
- "description": "type is the strategy that will dictate what SELinux context is used in the SecurityContext.",
+ "httpsProxy": {
+ "description": "httpsProxy is the URL of the proxy for HTTPS requests.",
+ "type": "string"
+ },
+ "noProxy": {
+ "description": "noProxy is a comma-separated list of hostnames and/or CIDRs for which the proxy should not be used.",
"type": "string"
}
}
},
- "com.github.openshift.api.security.v1.SecurityContextConstraints": {
- "description": "SecurityContextConstraints governs the ability to make requests that affect the SecurityContext that will be applied to a container. For historical reasons SCC was exposed under the core Kubernetes API group. That exposure is deprecated and will be removed in a future release - users should instead use the security.openshift.io group to manage SecurityContextConstraints.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.PublicKey": {
+ "description": "PublicKey defines the root of trust based on a sigstore public key.",
"type": "object",
"required": [
- "priority",
- "allowPrivilegedContainer",
- "defaultAddCapabilities",
- "requiredDropCapabilities",
- "allowedCapabilities",
- "allowHostDirVolumePlugin",
- "volumes",
- "allowHostNetwork",
- "allowHostPorts",
- "allowHostPID",
- "allowHostIPC",
- "readOnlyRootFilesystem"
+ "keyData"
],
"properties": {
- "allowHostDirVolumePlugin": {
- "description": "allowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin",
- "type": "boolean",
- "default": false
- },
- "allowHostIPC": {
- "description": "allowHostIPC determines if the policy allows host ipc in the containers.",
- "type": "boolean",
- "default": false
- },
- "allowHostNetwork": {
- "description": "allowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec.",
- "type": "boolean",
- "default": false
- },
- "allowHostPID": {
- "description": "allowHostPID determines if the policy allows host pid in the containers.",
- "type": "boolean",
- "default": false
+ "keyData": {
+ "description": "keyData is a required field contains inline base64-encoded data for the PEM format public key. keyData must be at most 8192 characters.",
+ "type": "string",
+ "format": "byte"
},
- "allowHostPorts": {
- "description": "allowHostPorts determines if the policy allows host ports in the containers.",
- "type": "boolean",
- "default": false
+ "rekorKeyData": {
+ "description": "rekorKeyData is an optional field contains inline base64-encoded data for the PEM format from the Rekor public key. rekorKeyData must be at most 8192 characters.",
+ "type": "string",
+ "format": "byte"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.RegistryLocation": {
+ "description": "RegistryLocation contains a location of the registry specified by the registry domain name. The domain name might include wildcards, like '*' or '??'.",
+ "type": "object",
+ "required": [
+ "domainName"
+ ],
+ "properties": {
+ "domainName": {
+ "description": "domainName specifies a domain name for the registry In case the registry use non-standard (80 or 443) port, the port should be included in the domain name as well.",
+ "type": "string",
+ "default": ""
},
- "allowPrivilegeEscalation": {
- "description": "allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.",
+ "insecure": {
+ "description": "insecure indicates whether the registry is secure (https) or insecure (http) By default (if not specified) the registry is assumed as secure.",
"type": "boolean"
- },
- "allowPrivilegedContainer": {
- "description": "allowPrivilegedContainer determines if a container can request to be run as privileged.",
- "type": "boolean",
- "default": false
- },
- "allowedCapabilities": {
- "description": "allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field maybe added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities. To allow all capabilities you may use '*'.",
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.RegistrySources": {
+ "description": "RegistrySources holds cluster-wide information about how to handle the registries config.",
+ "type": "object",
+ "properties": {
+ "allowedRegistries": {
+ "description": "allowedRegistries are the only registries permitted for image pull and push actions. All other registries are denied.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
"type": "array",
"items": {
"type": "string",
@@ -38076,234 +6478,246 @@
},
"x-kubernetes-list-type": "atomic"
},
- "allowedFlexVolumes": {
- "description": "allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the \"Volumes\" field.",
+ "blockedRegistries": {
+ "description": "blockedRegistries cannot be used for image pull and push actions. All other registries are permitted.\n\nOnly one of BlockedRegistries or AllowedRegistries may be set.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.AllowedFlexVolume"
+ "type": "string",
+ "default": ""
},
"x-kubernetes-list-type": "atomic"
},
- "allowedUnsafeSysctls": {
- "description": "allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in \"*\" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection.\n\nExamples: e.g. \"foo/*\" allows \"foo/bar\", \"foo/baz\", etc. e.g. \"foo.*\" allows \"foo.bar\", \"foo.baz\", etc.",
+ "containerRuntimeSearchRegistries": {
+ "description": "containerRuntimeSearchRegistries are registries that will be searched when pulling images that do not have fully qualified domains in their pull specs. Registries will be searched in the order provided in the list. Note: this search list only works with the container runtime, i.e CRI-O. Will NOT work with builds or imagestream imports.",
"type": "array",
"items": {
"type": "string",
"default": ""
},
- "x-kubernetes-list-type": "atomic"
- },
- "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",
- "type": "string"
+ "x-kubernetes-list-type": "set"
},
- "defaultAddCapabilities": {
- "description": "defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capabiility in both DefaultAddCapabilities and RequiredDropCapabilities.",
+ "insecureRegistries": {
+ "description": "insecureRegistries are registries which do not have a valid TLS certificates or only support HTTP connections.",
"type": "array",
"items": {
"type": "string",
"default": ""
},
"x-kubernetes-list-type": "atomic"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.Release": {
+ "description": "Release represents an OpenShift release image and associated metadata.",
+ "type": "object",
+ "required": [
+ "version",
+ "image"
+ ],
+ "properties": {
+ "architecture": {
+ "description": "architecture is an optional field that indicates the value of the cluster architecture. In this context cluster architecture means either a single architecture or a multi architecture. Valid values are 'Multi' and empty.",
+ "type": "string"
},
- "defaultAllowPrivilegeEscalation": {
- "description": "defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.",
- "type": "boolean"
- },
- "forbiddenSysctls": {
- "description": "forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in \"*\" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden.\n\nExamples: e.g. \"foo/*\" forbids \"foo/bar\", \"foo/baz\", etc. e.g. \"foo.*\" forbids \"foo.bar\", \"foo.baz\", etc.",
+ "channels": {
+ "description": "channels is the set of Cincinnati channels to which the release currently belongs.",
"type": "array",
"items": {
"type": "string",
"default": ""
},
- "x-kubernetes-list-type": "atomic"
+ "x-kubernetes-list-type": "set"
},
- "fsGroup": {
- "description": "fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.FSGroupStrategyOptions"
+ "image": {
+ "description": "image is a container image location that contains the update. When this field is part of spec, image is optional if version is specified and the availableUpdates field contains a matching version.",
+ "type": "string",
+ "default": ""
},
- "groups": {
- "description": "The groups that have permission to use this security context constraints",
+ "url": {
+ "description": "url contains information about this release. This URL is set by the 'url' metadata property on a release or the metadata returned by the update API and should be displayed as a link in user interfaces. The URL field may not be set for test or nightly releases.",
+ "type": "string"
+ },
+ "version": {
+ "description": "version is a semantic version identifying the update version. When this field is part of spec, version is optional if image is specified.",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.RemoteConnectionInfo": {
+ "description": "RemoteConnectionInfo holds information necessary for establishing a remote connection",
+ "type": "object",
+ "required": [
+ "url",
+ "ca",
+ "certFile",
+ "keyFile"
+ ],
+ "properties": {
+ "ca": {
+ "description": "ca is the CA for verifying TLS connections",
+ "type": "string",
+ "default": ""
+ },
+ "certFile": {
+ "description": "certFile is a file containing a PEM-encoded certificate",
+ "type": "string",
+ "default": ""
+ },
+ "keyFile": {
+ "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "type": "string",
+ "default": ""
+ },
+ "url": {
+ "description": "url is the remote URL to connect to",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.RepositoryDigestMirrors": {
+ "description": "RepositoryDigestMirrors holds cluster-wide information about how to handle mirrors in the registries config.",
+ "type": "object",
+ "required": [
+ "source"
+ ],
+ "properties": {
+ "allowMirrorByTags": {
+ "description": "allowMirrorByTags if true, the mirrors can be used to pull the images that are referenced by their tags. Default is false, the mirrors only work when pulling the images that are referenced by their digests. Pulling images by tag can potentially yield different images, depending on which endpoint we pull from. Forcing digest-pulls for mirrors avoids that issue.",
+ "type": "boolean"
+ },
+ "mirrors": {
+ "description": "mirrors is zero or more repositories that may also contain the same images. If the \"mirrors\" is not specified, the image will continue to be pulled from the specified repository in the pull spec. No mirror will be configured. The order of mirrors in this list is treated as the user's desired priority, while source is by default considered lower priority than all mirrors. Other cluster configuration, including (but not limited to) other repositoryDigestMirrors objects, may impact the exact order mirrors are contacted in, or some mirrors may be contacted in parallel, so this should be considered a preference rather than a guarantee of ordering.",
"type": "array",
"items": {
"type": "string",
"default": ""
},
- "x-kubernetes-list-type": "atomic"
- },
- "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",
- "type": "string"
+ "x-kubernetes-list-type": "set"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "source": {
+ "description": "source is the repository that users refer to, e.g. in image pull specifications.",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.RequestHeaderIdentityProvider": {
+ "description": "RequestHeaderIdentityProvider provides identities for users authenticating using request header credentials",
+ "type": "object",
+ "required": [
+ "loginURL",
+ "challengeURL",
+ "ca",
+ "headers",
+ "preferredUsernameHeaders",
+ "nameHeaders",
+ "emailHeaders"
+ ],
+ "properties": {
+ "ca": {
+ "description": "ca is a required reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. Specifically, it allows verification of incoming requests to prevent header spoofing. The key \"ca.crt\" is used to locate the data. If the config map or expected key is not found, the identity provider is not honored. If the specified ca data is not valid, the identity provider is not honored. The namespace for this config map is openshift-config.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "priority": {
- "description": "priority influences the sort order of SCCs when evaluating which SCCs to try first for a given pod request based on access in the Users and Groups fields. The higher the int, the higher priority. An unset value is considered a 0 priority. If scores for multiple SCCs are equal they will be sorted from most restrictive to least restrictive. If both priorities and restrictions are equal the SCCs will be sorted by name.",
- "type": "integer",
- "format": "int32"
+ "challengeURL": {
+ "description": "challengeURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect WWW-Authenticate challenges will be redirected here. ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}\nRequired when challenge is set to true.",
+ "type": "string",
+ "default": ""
},
- "readOnlyRootFilesystem": {
- "description": "readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the SCC should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to.",
- "type": "boolean",
- "default": false
+ "clientCommonNames": {
+ "description": "clientCommonNames is an optional list of common names to require a match from. If empty, any client certificate validated against the clientCA bundle is considered authoritative.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
},
- "requiredDropCapabilities": {
- "description": "requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added.",
+ "emailHeaders": {
+ "description": "emailHeaders is the set of headers to check for the email address",
"type": "array",
"items": {
"type": "string",
"default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "runAsUser": {
- "description": "runAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.RunAsUserStrategyOptions"
- },
- "seLinuxContext": {
- "description": "seLinuxContext is the strategy that will dictate what labels will be set in the SecurityContext.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.SELinuxContextStrategyOptions"
+ }
},
- "seccompProfiles": {
- "description": "seccompProfiles lists the allowed profiles that may be set for the pod or container's seccomp annotations. An unset (nil) or empty value means that no profiles may be specifid by the pod or container.\tThe wildcard '*' may be used to allow all profiles. When used to generate a value for a pod the first non-wildcard profile will be used as the default.",
+ "headers": {
+ "description": "headers is the set of headers to check for identity information",
"type": "array",
"items": {
"type": "string",
"default": ""
- },
- "x-kubernetes-list-type": "atomic"
- },
- "supplementalGroups": {
- "description": "supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.SupplementalGroupsStrategyOptions"
+ }
},
- "userNamespaceLevel": {
- "description": "userNamespaceLevel determines if the policy allows host users in containers. Valid values are \"AllowHostLevel\", \"RequirePodLevel\", and omitted. When \"AllowHostLevel\" is set, a pod author may set `hostUsers` to either `true` or `false`. When \"RequirePodLevel\" is set, a pod author must set `hostUsers` to `false`. When omitted, the default value is \"AllowHostLevel\".",
+ "loginURL": {
+ "description": "loginURL is a URL to redirect unauthenticated /authorize requests to Unauthenticated requests from OAuth clients which expect interactive logins will be redirected here ${url} is replaced with the current URL, escaped to be safe in a query parameter\n https://www.example.com/sso-login?then=${url}\n${query} is replaced with the current query string\n https://www.example.com/auth-proxy/oauth/authorize?${query}\nRequired when login is set to true.",
"type": "string",
- "default": "AllowHostLevel"
+ "default": ""
},
- "users": {
- "description": "The users who have permissions to use this security context constraints",
+ "nameHeaders": {
+ "description": "nameHeaders is the set of headers to check for the display name",
"type": "array",
"items": {
"type": "string",
"default": ""
- },
- "x-kubernetes-list-type": "atomic"
+ }
},
- "volumes": {
- "description": "volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names of a VolumeSource (azureFile, configMap, emptyDir). To allow all volumes you may use \"*\". To allow no volumes, set to [\"none\"].",
+ "preferredUsernameHeaders": {
+ "description": "preferredUsernameHeaders is the set of headers to check for the preferred username",
"type": "array",
"items": {
"type": "string",
"default": ""
- },
- "x-kubernetes-list-type": "atomic"
+ }
}
}
},
- "com.github.openshift.api.security.v1.SecurityContextConstraintsList": {
- "description": "SecurityContextConstraintsList is a list of SecurityContextConstraints objects\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.RequiredHSTSPolicy": {
"type": "object",
"required": [
- "items"
+ "domainPatterns",
+ "maxAge"
],
"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",
- "type": "string"
- },
- "items": {
- "description": "List of security context constraints.",
+ "domainPatterns": {
+ "description": "domainPatterns is a list of domains for which the desired HSTS annotations are required. If domainPatterns is specified and a route is created with a spec.host matching one of the domains, the route must specify the HSTS Policy components described in the matching RequiredHSTSPolicy.\n\nThe use of wildcards is allowed like this: *.foo.com matches everything under foo.com. foo.com only matches foo.com, so to cover foo.com and everything under it, you must specify *both*.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.SecurityContextConstraints"
+ "type": "string",
+ "default": ""
}
},
- "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",
+ "includeSubDomainsPolicy": {
+ "description": "includeSubDomainsPolicy means the HSTS Policy should apply to any subdomains of the host's domain name. Thus, for the host bar.foo.com, if includeSubDomainsPolicy was set to RequireIncludeSubDomains: - the host app.bar.foo.com would inherit the HSTS Policy of bar.foo.com - the host bar.foo.com would inherit the HSTS Policy of bar.foo.com - the host foo.com would NOT inherit the HSTS Policy of bar.foo.com - the host def.foo.com would NOT inherit the HSTS Policy of bar.foo.com",
"type": "string"
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "maxAge": {
+ "description": "maxAge is the delta time range in seconds during which hosts are regarded as HSTS hosts. If set to 0, it negates the effect, and hosts are removed as HSTS hosts. If set to 0 and includeSubdomains is specified, all subdomains of the host are also removed as HSTS hosts. maxAge is a time-to-live value, and if this policy is not refreshed on a client, the HSTS policy will eventually expire on that client.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.security.v1.ServiceAccountPodSecurityPolicyReviewStatus": {
- "description": "ServiceAccountPodSecurityPolicyReviewStatus represents ServiceAccount name and related review status",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "allowedBy": {
- "description": "allowedBy is a reference to the rule that allows the PodTemplateSpec. A rule can be a SecurityContextConstraint or a PodSecurityPolicy A `nil`, indicates that it was denied.",
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "name": {
- "description": "name contains the allowed and the denied ServiceAccount name",
- "type": "string",
- "default": ""
- },
- "reason": {
- "description": "A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
- "type": "string"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.MaxAgePolicy"
},
- "template": {
- "description": "template is the PodTemplateSpec after the defaulting is applied.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.PodTemplateSpec"
- }
- }
- },
- "com.github.openshift.api.security.v1.SupplementalGroupsStrategyOptions": {
- "description": "SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.",
- "type": "object",
- "properties": {
- "ranges": {
- "description": "ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.security.v1.IDRange"
- },
- "x-kubernetes-list-type": "atomic"
+ "namespaceSelector": {
+ "description": "namespaceSelector specifies a label selector such that the policy applies only to those routes that are in namespaces with labels that match the selector, and are in one of the DomainPatterns. Defaults to the empty LabelSelector, which matches everything.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
- "type": {
- "description": "type is the strategy that will dictate what supplemental groups is used in the SecurityContext.",
+ "preloadPolicy": {
+ "description": "preloadPolicy directs the client to include hosts in its host preload list so that it never needs to do an initial load to get the HSTS header (note that this is not defined in RFC 6797 and is therefore client implementation-dependent).",
"type": "string"
}
}
},
- "com.github.openshift.api.securityinternal.v1.RangeAllocation": {
- "description": "RangeAllocation is used so we can easily expose a RangeAllocation typed for security group This is an internal API, not intended for external consumption.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.Scheduler": {
+ "description": "Scheduler holds cluster-wide config information to run the Kubernetes Scheduler and influence its placement decisions. The canonical name for this config is `cluster`.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
- "range",
- "data"
+ "spec"
],
"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",
"type": "string"
},
- "data": {
- "description": "data is a byte array representing the serialized state of a range allocation. It is a bitmap with each bit set to one to represent a range is taken.",
- "type": "string",
- "format": "byte"
- },
"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",
"type": "string"
@@ -38313,17 +6727,23 @@
"default": {},
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
- "range": {
- "description": "range is a string representing a unique label for a range of uids, \"1000000000-2000000000/10000\".",
- "type": "string",
- "default": ""
+ "spec": {
+ "description": "spec holds user settable values for configuration",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SchedulerSpec"
+ },
+ "status": {
+ "description": "status holds observed values from the cluster. They may not be overridden.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SchedulerStatus"
}
}
},
- "com.github.openshift.api.securityinternal.v1.RangeAllocationList": {
- "description": "RangeAllocationList is a list of RangeAllocations objects This is an internal API, not intended for external consumption.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.SchedulerList": {
+ "description": "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
"type": "object",
"required": [
+ "metadata",
"items"
],
"properties": {
@@ -38332,11 +6752,10 @@
"type": "string"
},
"items": {
- "description": "List of RangeAllocations.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.securityinternal.v1.RangeAllocation"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.Scheduler"
}
},
"kind": {
@@ -38350,268 +6769,302 @@
}
}
},
- "com.github.openshift.api.servicecertsigner.v1alpha1.ServiceCertSignerOperatorConfig": {
- "description": "ServiceCertSignerOperatorConfig provides information to configure an operator to manage the service cert signing controllers\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.SchedulerSpec": {
+ "type": "object",
+ "properties": {
+ "defaultNodeSelector": {
+ "description": "defaultNodeSelector helps set the cluster-wide default node selector to restrict pod placement to specific nodes. This is applied to the pods created in all namespaces and creates an intersection with any existing nodeSelectors already set on a pod, additionally constraining that pod's selector. For example, defaultNodeSelector: \"type=user-node,region=east\" would set nodeSelector field in pod spec to \"type=user-node,region=east\" to all pods created in all namespaces. Namespaces having project-wide node selectors won't be impacted even if this field is set. This adds an annotation section to the namespace. For example, if a new namespace is created with node-selector='type=user-node,region=east', the annotation openshift.io/node-selector: type=user-node,region=east gets added to the project. When the openshift.io/node-selector annotation is set on the project the value is used in preference to the value we are setting for defaultNodeSelector field. For instance, openshift.io/node-selector: \"type=user-node,region=west\" means that the default of \"type=user-node,region=east\" set in defaultNodeSelector would not be applied.",
+ "type": "string"
+ },
+ "mastersSchedulable": {
+ "description": "mastersSchedulable allows masters nodes to be schedulable. When this flag is turned on, all the master nodes in the cluster will be made schedulable, so that workload pods can run on them. The default value for this field is false, meaning none of the master nodes are schedulable. Important Note: Once the workload pods start running on the master nodes, extreme care must be taken to ensure that cluster-critical control plane components are not impacted. Please turn on this field after doing due diligence.",
+ "type": "boolean",
+ "default": false
+ },
+ "policy": {
+ "description": "DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release. policy is a reference to a ConfigMap containing scheduler policy which has user specified predicates and priorities. If this ConfigMap is not available scheduler will default to use DefaultAlgorithmProvider. The namespace for this configmap is openshift-config.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
+ },
+ "profile": {
+ "description": "profile sets which scheduling profile should be set in order to configure scheduling decisions for new pods.\n\nValid values are \"LowNodeUtilization\", \"HighNodeUtilization\", \"NoScoring\" Defaults to \"LowNodeUtilization\"",
+ "type": "string"
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.SchedulerStatus": {
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.SecretNameReference": {
+ "description": "SecretNameReference references a secret in a specific namespace. The namespace must be specified at the point of use.",
"type": "object",
"required": [
- "metadata",
- "spec",
- "status"
+ "name"
],
"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",
+ "name": {
+ "description": "name is the metadata.name of the referenced secret",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.ServingInfo": {
+ "description": "ServingInfo holds information about serving web pages",
+ "type": "object",
+ "required": [
+ "bindAddress",
+ "bindNetwork",
+ "certFile",
+ "keyFile"
+ ],
+ "properties": {
+ "bindAddress": {
+ "description": "bindAddress is the ip:port to serve on",
+ "type": "string",
+ "default": ""
+ },
+ "bindNetwork": {
+ "description": "bindNetwork is the type of network to bind to - defaults to \"tcp4\", accepts \"tcp\", \"tcp4\", and \"tcp6\"",
+ "type": "string",
+ "default": ""
+ },
+ "certFile": {
+ "description": "certFile is a file containing a PEM-encoded certificate",
+ "type": "string",
+ "default": ""
+ },
+ "cipherSuites": {
+ "description": "cipherSuites contains an overridden list of ciphers for the server to support. Values must match cipher suite IDs from https://golang.org/pkg/crypto/tls/#pkg-constants",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "clientCA": {
+ "description": "clientCA is the certificate bundle for all the signers that you'll recognize for incoming client certificates",
"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",
+ "keyFile": {
+ "description": "keyFile is a file containing a PEM-encoded private key for the certificate specified by CertFile",
+ "type": "string",
+ "default": ""
+ },
+ "minTLSVersion": {
+ "description": "minTLSVersion is the minimum TLS version supported. Values must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants",
"type": "string"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "namedCertificates": {
+ "description": "namedCertificates is a list of certificates to use to secure requests to specific hostnames",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.NamedCertificate"
+ }
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.SignatureStore": {
+ "description": "SignatureStore represents the URL of custom Signature Store",
+ "type": "object",
+ "required": [
+ "url"
+ ],
+ "properties": {
+ "ca": {
+ "description": "ca is an optional reference to a config map by name containing the PEM-encoded CA bundle. It is used as a trust anchor to validate the TLS certificate presented by the remote server. The key \"ca.crt\" is used to locate the data. If specified and the config map or expected key is not found, the signature store is not honored. If the specified ca data is not valid, the signature store is not honored. If empty, we fall back to the CA configured via Proxy, which is appended to the default system roots. The namespace for this config map is openshift-config.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "spec": {
+ "url": {
+ "description": "url contains the upstream custom signature store URL. url should be a valid absolute http/https URI of an upstream signature store as per rfc1738. This must be provided and cannot be empty.",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.Storage": {
+ "description": "Storage provides persistent storage configuration options for gathering jobs. If the type is set to PersistentVolume, then the PersistentVolume must be defined. If the type is set to Ephemeral, then the PersistentVolume must not be defined.",
+ "type": "object",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "persistentVolume": {
+ "description": "persistentVolume is an optional field that specifies the PersistentVolume that will be used to store the Insights data archive. The PersistentVolume must be created in the openshift-insights namespace.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.servicecertsigner.v1alpha1.ServiceCertSignerOperatorConfigSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PersistentVolumeConfig"
},
- "status": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.servicecertsigner.v1alpha1.ServiceCertSignerOperatorConfigStatus"
+ "type": {
+ "description": "type is a required field that specifies the type of storage that will be used to store the Insights data archive. Valid values are \"PersistentVolume\" and \"Ephemeral\". When set to Ephemeral, the Insights data archive is stored in the ephemeral storage of the gathering job. When set to PersistentVolume, the Insights data archive is stored in the PersistentVolume that is defined by the persistentVolume field.",
+ "type": "string"
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {
+ "persistentVolume": "PersistentVolume"
+ }
}
- }
+ ]
},
- "com.github.openshift.api.servicecertsigner.v1alpha1.ServiceCertSignerOperatorConfigList": {
- "description": "ServiceCertSignerOperatorConfigList is a collection of items\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.StringSource": {
+ "description": "StringSource allows specifying a string inline, or externally via env var or file. When it contains only a string value, it marshals to a simple JSON string.",
"type": "object",
"required": [
- "items"
+ "value",
+ "env",
+ "file",
+ "keyFile"
],
"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",
- "type": "string"
+ "env": {
+ "description": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
+ "type": "string",
+ "default": ""
},
- "items": {
- "description": "items contains the items",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.servicecertsigner.v1alpha1.ServiceCertSignerOperatorConfig"
- }
+ "file": {
+ "description": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
+ "type": "string",
+ "default": ""
},
- "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",
- "type": "string"
+ "keyFile": {
+ "description": "keyFile references a file containing the key to use to decrypt the value.",
+ "type": "string",
+ "default": ""
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "value": {
+ "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.servicecertsigner.v1alpha1.ServiceCertSignerOperatorConfigSpec": {
+ "com.github.openshift.api.config.v1.StringSourceSpec": {
+ "description": "StringSourceSpec specifies a string value, or external location",
"type": "object",
"required": [
- "managementState"
+ "value",
+ "env",
+ "file",
+ "keyFile"
],
"properties": {
- "logLevel": {
- "description": "logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
- },
- "managementState": {
- "description": "managementState indicates whether and how the operator should manage the component",
+ "env": {
+ "description": "env specifies an envvar containing the cleartext value, or an encrypted value if the keyFile is specified.",
"type": "string",
"default": ""
},
- "observedConfig": {
- "description": "observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "file": {
+ "description": "file references a file containing the cleartext value, or an encrypted value if a keyFile is specified.",
+ "type": "string",
+ "default": ""
},
- "operatorLogLevel": {
- "description": "operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves.\n\nValid values are: \"Normal\", \"Debug\", \"Trace\", \"TraceAll\". Defaults to \"Normal\".",
- "type": "string"
+ "keyFile": {
+ "description": "keyFile references a file containing the key to use to decrypt the value.",
+ "type": "string",
+ "default": ""
},
- "unsupportedConfigOverrides": {
- "description": "unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
+ "value": {
+ "description": "value specifies the cleartext value, or an encrypted value if keyFile is specified.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.servicecertsigner.v1alpha1.ServiceCertSignerOperatorConfigStatus": {
+ "com.github.openshift.api.config.v1.TLSProfileSpec": {
+ "description": "TLSProfileSpec is the desired behavior of a TLSSecurityProfile.",
"type": "object",
+ "required": [
+ "ciphers",
+ "minTLSVersion"
+ ],
"properties": {
- "conditions": {
- "description": "conditions is a list of conditions and their status",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.OperatorCondition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
- },
- "generations": {
- "description": "generations are used to determine when an item needs to be reconciled or has changed in a way that needs a reaction.",
+ "ciphers": {
+ "description": "ciphers is used to specify the cipher algorithms that are negotiated during the TLS handshake. Operators may remove entries their operands do not support. For example, to use DES-CBC3-SHA (yaml):\n\n ciphers:\n - DES-CBC3-SHA",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.operator.v1.GenerationStatus"
+ "type": "string",
+ "default": ""
},
- "x-kubernetes-list-map-keys": [
- "group",
- "resource",
- "namespace",
- "name"
- ],
- "x-kubernetes-list-type": "map"
- },
- "latestAvailableRevision": {
- "description": "latestAvailableRevision is the deploymentID of the most recent deployment",
- "type": "integer",
- "format": "int32"
- },
- "observedGeneration": {
- "description": "observedGeneration is the last generation change you've dealt with",
- "type": "integer",
- "format": "int64"
- },
- "readyReplicas": {
- "description": "readyReplicas indicates how many replicas are ready and at the desired state",
- "type": "integer",
- "format": "int32",
- "default": 0
+ "x-kubernetes-list-type": "atomic"
},
- "version": {
- "description": "version is the level this availability applies to",
- "type": "string"
+ "minTLSVersion": {
+ "description": "minTLSVersion is used to specify the minimal version of the TLS protocol that is negotiated during the TLS handshake. For example, to use TLS versions 1.1, 1.2 and 1.3 (yaml):\n\n minTLSVersion: VersionTLS11\n\nNOTE: currently the highest minTLSVersion allowed is VersionTLS12",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMap": {
- "description": "SharedConfigMap allows a ConfigMap to be shared across namespaces. Pods can mount the shared ConfigMap by adding a CSI volume to the pod specification using the \"csi.sharedresource.openshift.io\" CSI driver and a reference to the SharedConfigMap in the volume attributes:\n\nspec:\n\n\tvolumes:\n\t- name: shared-configmap\n\t csi:\n\t driver: csi.sharedresource.openshift.io\n\t volumeAttributes:\n\t sharedConfigMap: my-share\n\nFor the mount to be successful, the pod's service account must be granted permission to 'use' the named SharedConfigMap object within its namespace with an appropriate Role and RoleBinding. For compactness, here are example `oc` invocations for creating such Role and RoleBinding objects.\n\n\t`oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share`\n\t`oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default`\n\nShared resource objects, in this case ConfigMaps, have default permissions of list, get, and watch for system authenticated users.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.TLSSecurityProfile": {
+ "description": "TLSSecurityProfile defines the schema for a TLS security profile. This object is used by operators to apply TLS security settings to operands.",
"type": "object",
- "required": [
- "spec"
- ],
"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",
- "type": "string"
+ "custom": {
+ "description": "custom is a user-defined TLS security profile. Be extremely careful using a custom profile as invalid configurations can be catastrophic. An example custom profile looks like this:\n\n ciphers:\n\n - ECDHE-ECDSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-AES128-GCM-SHA256\n\n - ECDHE-ECDSA-AES128-GCM-SHA256\n\n minTLSVersion: VersionTLS11",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.CustomTLSProfile"
},
- "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",
- "type": "string"
+ "intermediate": {
+ "description": "intermediate is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29\n\nand looks like this (yaml):\n\n ciphers:\n\n - TLS_AES_128_GCM_SHA256\n\n - TLS_AES_256_GCM_SHA384\n\n - TLS_CHACHA20_POLY1305_SHA256\n\n - ECDHE-ECDSA-AES128-GCM-SHA256\n\n - ECDHE-RSA-AES128-GCM-SHA256\n\n - ECDHE-ECDSA-AES256-GCM-SHA384\n\n - ECDHE-RSA-AES256-GCM-SHA384\n\n - ECDHE-ECDSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-CHACHA20-POLY1305\n\n - DHE-RSA-AES128-GCM-SHA256\n\n - DHE-RSA-AES256-GCM-SHA384\n\n minTLSVersion: VersionTLS12",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.IntermediateTLSProfile"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "modern": {
+ "description": "modern is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility\n\nand looks like this (yaml):\n\n ciphers:\n\n - TLS_AES_128_GCM_SHA256\n\n - TLS_AES_256_GCM_SHA384\n\n - TLS_CHACHA20_POLY1305_SHA256\n\n minTLSVersion: VersionTLS13",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ModernTLSProfile"
},
- "spec": {
- "description": "spec is the specification of the desired shared configmap",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMapSpec"
+ "old": {
+ "description": "old is a TLS security profile based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility\n\nand looks like this (yaml):\n\n ciphers:\n\n - TLS_AES_128_GCM_SHA256\n\n - TLS_AES_256_GCM_SHA384\n\n - TLS_CHACHA20_POLY1305_SHA256\n\n - ECDHE-ECDSA-AES128-GCM-SHA256\n\n - ECDHE-RSA-AES128-GCM-SHA256\n\n - ECDHE-ECDSA-AES256-GCM-SHA384\n\n - ECDHE-RSA-AES256-GCM-SHA384\n\n - ECDHE-ECDSA-CHACHA20-POLY1305\n\n - ECDHE-RSA-CHACHA20-POLY1305\n\n - DHE-RSA-AES128-GCM-SHA256\n\n - DHE-RSA-AES256-GCM-SHA384\n\n - DHE-RSA-CHACHA20-POLY1305\n\n - ECDHE-ECDSA-AES128-SHA256\n\n - ECDHE-RSA-AES128-SHA256\n\n - ECDHE-ECDSA-AES128-SHA\n\n - ECDHE-RSA-AES128-SHA\n\n - ECDHE-ECDSA-AES256-SHA384\n\n - ECDHE-RSA-AES256-SHA384\n\n - ECDHE-ECDSA-AES256-SHA\n\n - ECDHE-RSA-AES256-SHA\n\n - DHE-RSA-AES128-SHA256\n\n - DHE-RSA-AES256-SHA256\n\n - AES128-GCM-SHA256\n\n - AES256-GCM-SHA384\n\n - AES128-SHA256\n\n - AES256-SHA256\n\n - AES128-SHA\n\n - AES256-SHA\n\n - DES-CBC3-SHA\n\n minTLSVersion: VersionTLS10",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.OldTLSProfile"
},
- "status": {
- "description": "status is the observed status of the shared configmap",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMapStatus"
+ "type": {
+ "description": "type is one of Old, Intermediate, Modern or Custom. Custom provides the ability to specify individual TLS security profile parameters. Old, Intermediate and Modern are TLS security profiles based on:\n\nhttps://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations\n\nThe profiles are intent based, so they may change over time as new ciphers are developed and existing ciphers are found to be insecure. Depending on precisely which ciphers are available to a process, the list may be reduced.\n\nNote that the Modern profile is currently not supported because it is not yet well adopted by common software libraries.",
+ "type": "string",
+ "default": ""
}
- }
- },
- "com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMapList": {
- "description": "SharedConfigMapList contains a list of SharedConfigMap objects.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
- },
- "items": {
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMap"
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {
+ "custom": "Custom",
+ "intermediate": "Intermediate",
+ "modern": "Modern",
+ "old": "Old"
}
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
- }
+ ]
},
- "com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMapReference": {
- "description": "SharedConfigMapReference contains information about which ConfigMap to share",
+ "com.github.openshift.api.config.v1.TemplateReference": {
+ "description": "TemplateReference references a template in a specific namespace. The namespace must be specified at the point of use.",
"type": "object",
"required": [
- "name",
- "namespace"
+ "name"
],
"properties": {
"name": {
- "description": "name represents the name of the ConfigMap that is being referenced.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace represents the namespace where the referenced ConfigMap is located.",
+ "description": "name is the metadata.name of the referenced project request template",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMapSpec": {
- "description": "SharedConfigMapSpec defines the desired state of a SharedConfigMap",
+ "com.github.openshift.api.config.v1.TestDetails": {
"type": "object",
"required": [
- "configMapRef"
+ "testName"
],
"properties": {
- "configMapRef": {
- "description": "configMapRef is a reference to the ConfigMap to share",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMapReference"
- },
- "description": {
- "description": "description is a user readable explanation of what the backing resource provides.",
- "type": "string"
- }
- }
- },
- "com.github.openshift.api.sharedresource.v1alpha1.SharedConfigMapStatus": {
- "description": "SharedSecretStatus contains the observed status of the shared resource",
- "type": "object",
- "properties": {
- "conditions": {
- "description": "conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
- },
- "x-kubernetes-list-map-keys": [
- "type"
- ],
- "x-kubernetes-list-type": "map"
+ "testName": {
+ "description": "testName is the name of the test as it appears in junit XMLs. It does not include the suite name since the same test can be executed in many suites.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.sharedresource.v1alpha1.SharedSecret": {
- "description": "SharedSecret allows a Secret to be shared across namespaces. Pods can mount the shared Secret by adding a CSI volume to the pod specification using the \"csi.sharedresource.openshift.io\" CSI driver and a reference to the SharedSecret in the volume attributes:\n\nspec:\n\n\tvolumes:\n\t- name: shared-secret\n\t csi:\n\t driver: csi.sharedresource.openshift.io\n\t volumeAttributes:\n\t sharedSecret: my-share\n\nFor the mount to be successful, the pod's service account must be granted permission to 'use' the named SharedSecret object within its namespace with an appropriate Role and RoleBinding. For compactness, here are example `oc` invocations for creating such Role and RoleBinding objects.\n\n\t`oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share`\n\t`oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default`\n\nShared resource objects, in this case Secrets, have default permissions of list, get, and watch for system authenticated users.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.TestReporting": {
+ "description": "TestReporting is used for origin (and potentially others) to report the test names for a given FeatureGate into the payload for later analysis on a per-payload basis. This doesn't need any CRD because it's never stored in the cluster.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
"type": "object",
"required": [
"spec"
@@ -38631,726 +7084,687 @@
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
- "description": "spec is the specification of the desired shared secret",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedSecretSpec"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TestReportingSpec"
},
"status": {
- "description": "status is the observed status of the shared secret",
+ "description": "status holds observed values from the cluster. They may not be overridden.",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedSecretStatus"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TestReportingStatus"
}
}
},
- "com.github.openshift.api.sharedresource.v1alpha1.SharedSecretList": {
- "description": "SharedSecretList contains a list of SharedSecret objects.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
+ "com.github.openshift.api.config.v1.TestReportingSpec": {
"type": "object",
"required": [
- "items"
+ "testsForFeatureGates"
],
"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",
- "type": "string"
- },
- "items": {
+ "testsForFeatureGates": {
+ "description": "testsForFeatureGates is a list, indexed by FeatureGate and includes information about testing.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedSecret"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.FeatureGateTests"
}
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
- }
- }
- },
- "com.github.openshift.api.sharedresource.v1alpha1.SharedSecretReference": {
- "description": "SharedSecretReference contains information about which Secret to share",
- "type": "object",
- "required": [
- "name",
- "namespace"
- ],
- "properties": {
- "name": {
- "description": "name represents the name of the Secret that is being referenced.",
- "type": "string",
- "default": ""
- },
- "namespace": {
- "description": "namespace represents the namespace where the referenced Secret is located.",
- "type": "string",
- "default": ""
}
}
},
- "com.github.openshift.api.sharedresource.v1alpha1.SharedSecretSpec": {
- "description": "SharedSecretSpec defines the desired state of a SharedSecret",
+ "com.github.openshift.api.config.v1.TestReportingStatus": {
+ "type": "object"
+ },
+ "com.github.openshift.api.config.v1.TokenClaimMapping": {
+ "description": "TokenClaimMapping allows specifying a JWT token claim to be used when mapping claims from an authentication token to cluster identities.",
"type": "object",
"required": [
- "secretRef"
+ "claim"
],
"properties": {
- "description": {
- "description": "description is a user readable explanation of what the backing resource provides.",
- "type": "string"
- },
- "secretRef": {
- "description": "secretRef is a reference to the Secret to share",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.sharedresource.v1alpha1.SharedSecretReference"
+ "claim": {
+ "description": "claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.sharedresource.v1alpha1.SharedSecretStatus": {
- "description": "SharedSecretStatus contains the observed status of the shared resource",
+ "com.github.openshift.api.config.v1.TokenClaimMappings": {
"type": "object",
+ "required": [
+ "username"
+ ],
"properties": {
- "conditions": {
- "description": "conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.",
+ "extra": {
+ "description": "extra is an optional field for configuring the mappings used to construct the extra attribute for the cluster identity. When omitted, no extra attributes will be present on the cluster identity. key values for extra mappings must be unique. A maximum of 32 extra attribute mappings may be provided.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ExtraMapping"
},
"x-kubernetes-list-map-keys": [
- "type"
+ "key"
],
"x-kubernetes-list-type": "map"
+ },
+ "groups": {
+ "description": "groups is an optional field that configures how the groups of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider. When referencing a claim, if the claim is present in the JWT token, its value must be a list of groups separated by a comma (','). For example - '\"example\"' and '\"exampleOne\", \"exampleTwo\", \"exampleThree\"' are valid claim values.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.PrefixedClaimMapping"
+ },
+ "uid": {
+ "description": "uid is an optional field for configuring the claim mapping used to construct the uid for the cluster identity.\n\nWhen using uid.claim to specify the claim it must be a single string value. When using uid.expression the expression must result in a single string value.\n\nWhen omitted, this means the user has no opinion and the platform is left to choose a default, which is subject to change over time. The current default is to use the 'sub' claim.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenClaimOrExpressionMapping"
+ },
+ "username": {
+ "description": "username is a required field that configures how the username of a cluster identity should be constructed from the claims in a JWT token issued by the identity provider.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.UsernameClaimMapping"
}
}
},
- "com.github.openshift.api.template.v1.BrokerTemplateInstance": {
- "description": "BrokerTemplateInstance holds the service broker-related state associated with a TemplateInstance. BrokerTemplateInstance is part of an experimental API.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.TokenClaimOrExpressionMapping": {
+ "description": "TokenClaimOrExpressionMapping allows specifying either a JWT token claim or CEL expression to be used when mapping claims from an authentication token to cluster identities.",
"type": "object",
- "required": [
- "spec"
- ],
"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",
+ "claim": {
+ "description": "claim is an optional field for specifying the JWT token claim that is used in the mapping. The value of this claim will be assigned to the field in which this mapping is associated.\n\nPrecisely one of claim or expression must be set. claim must not be specified when expression is set. When specified, claim must be at least 1 character in length and must not exceed 256 characters in length.",
"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",
+ "expression": {
+ "description": "expression is an optional field for specifying a CEL expression that produces a string value from JWT token claims.\n\nCEL expressions have access to the token claims through a CEL variable, 'claims'. 'claims' is a map of claim names to claim values. For example, the 'sub' claim value can be accessed as 'claims.sub'. Nested claims can be accessed using dot notation ('claims.foo.bar').\n\nPrecisely one of claim or expression must be set. expression must not be specified when claim is set. When specified, expression must be at least 1 character in length and must not exceed 1024 characters in length.",
"type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec describes the state of this BrokerTemplateInstance.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.BrokerTemplateInstanceSpec"
}
}
},
- "com.github.openshift.api.template.v1.BrokerTemplateInstanceList": {
- "description": "BrokerTemplateInstanceList is a list of BrokerTemplateInstance objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.TokenClaimValidationRule": {
"type": "object",
"required": [
- "items"
+ "type"
],
"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",
- "type": "string"
+ "requiredClaim": {
+ "description": "requiredClaim is an optional field that configures the required claim and value that the Kubernetes API server will use to validate if an incoming JWT is valid for this identity provider.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.TokenRequiredClaim"
},
- "items": {
- "description": "items is a list of BrokerTemplateInstances",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.BrokerTemplateInstance"
- }
+ "type": {
+ "description": "type is an optional field that configures the type of the validation rule.\n\nAllowed values are 'RequiredClaim' and omitted (not provided or an empty string).\n\nWhen set to 'RequiredClaim', the Kubernetes API server will be configured to validate that the incoming JWT contains the required claim and that its value matches the required value.\n\nDefaults to 'RequiredClaim'.",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.TokenConfig": {
+ "description": "TokenConfig holds the necessary configuration options for authorization and access tokens",
+ "type": "object",
+ "properties": {
+ "accessTokenInactivityTimeout": {
+ "description": "accessTokenInactivityTimeout defines the token inactivity timeout for tokens granted by any client. The value represents the maximum amount of time that can occur between consecutive uses of the token. Tokens become invalid if they are not used within this temporal window. The user will need to acquire a new token to regain access once a token times out. Takes valid time duration string such as \"5m\", \"1.5h\" or \"2h45m\". The minimum allowed value for duration is 300s (5 minutes). If the timeout is configured per client, then that value takes precedence. If the timeout value is not specified and the client does not override the value, then tokens are valid until their lifetime.\n\nWARNING: existing tokens' timeout will not be affected (lowered) by changing this value",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
},
- "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",
- "type": "string"
+ "accessTokenInactivityTimeoutSeconds": {
+ "description": "accessTokenInactivityTimeoutSeconds - DEPRECATED: setting this field has no effect.",
+ "type": "integer",
+ "format": "int32"
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "accessTokenMaxAgeSeconds": {
+ "description": "accessTokenMaxAgeSeconds defines the maximum age of access tokens",
+ "type": "integer",
+ "format": "int32"
}
}
},
- "com.github.openshift.api.template.v1.BrokerTemplateInstanceSpec": {
- "description": "BrokerTemplateInstanceSpec describes the state of a BrokerTemplateInstance.",
+ "com.github.openshift.api.config.v1.TokenIssuer": {
"type": "object",
"required": [
- "templateInstance",
- "secret"
+ "issuerURL",
+ "audiences"
],
"properties": {
- "bindingIDs": {
- "description": "bindingIDs is a list of 'binding_id's provided during successive bind calls to the template service broker.",
+ "audiences": {
+ "description": "audiences is a required field that configures the acceptable audiences the JWT token, issued by the identity provider, must be issued to. At least one of the entries must match the 'aud' claim in the JWT token.\n\naudiences must contain at least one entry and must not exceed ten entries.",
"type": "array",
"items": {
"type": "string",
"default": ""
- }
+ },
+ "x-kubernetes-list-type": "set"
},
- "secret": {
- "description": "secret is a reference to a Secret object residing in a namespace, containing the necessary template parameters.",
+ "issuerCertificateAuthority": {
+ "description": "issuerCertificateAuthority is an optional field that configures the certificate authority, used by the Kubernetes API server, to validate the connection to the identity provider when fetching discovery information.\n\nWhen not specified, the system trust is used.\n\nWhen specified, it must reference a ConfigMap in the openshift-config namespace containing the PEM-encoded CA certificates under the 'ca-bundle.crt' key in the data field of the ConfigMap.",
"default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.ConfigMapNameReference"
},
- "templateInstance": {
- "description": "templateInstance is a reference to a TemplateInstance object residing in a namespace.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
+ "issuerURL": {
+ "description": "issuerURL is a required field that configures the URL used to issue tokens by the identity provider. The Kubernetes API server determines how authentication tokens should be handled by matching the 'iss' claim in the JWT to the issuerURL of configured identity providers.\n\nMust be at least 1 character and must not exceed 512 characters in length. Must be a valid URL that uses the 'https' scheme and does not contain a query, fragment or user.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.template.v1.Parameter": {
- "description": "Parameter defines a name/value variable that is to be processed during the Template to Config transformation.",
+ "com.github.openshift.api.config.v1.TokenRequiredClaim": {
"type": "object",
"required": [
- "name"
+ "claim",
+ "requiredValue"
],
"properties": {
- "description": {
- "description": "description of a parameter. Optional.",
- "type": "string"
- },
- "displayName": {
- "description": "Optional: The name that will show in UI instead of parameter 'Name'",
- "type": "string"
+ "claim": {
+ "description": "claim is a required field that configures the name of the required claim. When taken from the JWT claims, claim must be a string value.\n\nclaim must not be an empty string (\"\").",
+ "type": "string",
+ "default": ""
},
- "from": {
- "description": "from is an input value for the generator. Optional.",
- "type": "string"
+ "requiredValue": {
+ "description": "requiredValue is a required field that configures the value that 'claim' must have when taken from the incoming JWT claims. If the value in the JWT claims does not match, the token will be rejected for authentication.\n\nrequiredValue must not be an empty string (\"\").",
+ "type": "string",
+ "default": ""
+ }
+ }
+ },
+ "com.github.openshift.api.config.v1.Update": {
+ "description": "Update represents an administrator update request.",
+ "type": "object",
+ "properties": {
+ "architecture": {
+ "description": "architecture is an optional field that indicates the desired value of the cluster architecture. In this context cluster architecture means either a single architecture or a multi architecture. architecture can only be set to Multi thereby only allowing updates from single to multi architecture. If architecture is set, image cannot be set and version must be set. Valid values are 'Multi' and empty.",
+ "type": "string",
+ "default": ""
},
- "generate": {
- "description": "generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.\n\nThe only supported generator is \"expression\", which accepts a \"from\" value in the form of a simple regular expression containing the range expression \"[a-zA-Z0-9]\", and the length expression \"a{length}\".\n\nExamples:\n\nfrom | value ----------------------------- \"test[0-9]{1}x\" | \"test7x\" \"[0-1]{8}\" | \"01001100\" \"0x[A-F0-9]{4}\" | \"0xB3AF\" \"[a-zA-Z0-9]{8}\" | \"hW4yQU5i\"",
- "type": "string"
+ "force": {
+ "description": "force allows an administrator to update to an image that has failed verification or upgradeable checks that are designed to keep your cluster safe. Only use this if: * you are testing unsigned release images in short-lived test clusters or * you are working around a known bug in the cluster-version\n operator and you have verified the authenticity of the provided\n image yourself.\nThe provided image will run with full administrative access to the cluster. Do not use this flag with images that come from unknown or potentially malicious sources.",
+ "type": "boolean",
+ "default": false
},
- "name": {
- "description": "name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.",
+ "image": {
+ "description": "image is a container image location that contains the update. image should be used when the desired version does not exist in availableUpdates or history. When image is set, architecture cannot be specified. If both version and image are set, the version extracted from the referenced image must match the specified version.",
"type": "string",
"default": ""
},
- "required": {
- "description": "Optional: Indicates the parameter must have a value. Defaults to false.",
- "type": "boolean"
- },
- "value": {
- "description": "value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.",
- "type": "string"
+ "version": {
+ "description": "version is a semantic version identifying the update version. version is required if architecture is specified. If both version and image are set, the version extracted from the referenced image must match the specified version.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.template.v1.Template": {
- "description": "Template contains the inputs needed to produce a Config.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.UpdateHistory": {
+ "description": "UpdateHistory is a single attempted update to the cluster.",
"type": "object",
"required": [
- "objects"
+ "state",
+ "startedTime",
+ "completionTime",
+ "image",
+ "verified"
],
"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",
+ "acceptedRisks": {
+ "description": "acceptedRisks records risks which were accepted to initiate the update. For example, it may menition an Upgradeable=False or missing signature that was overridden via desiredUpdate.force, or an update that was initiated despite not being in the availableUpdates set of recommended update targets.",
"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",
- "type": "string"
+ "completionTime": {
+ "description": "completionTime, if set, is when the update was fully applied. The update that is currently being applied will have a null completion time. Completion time will always be set for entries that are not the current update (usually to the started time of the next update).",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
},
- "labels": {
- "description": "labels is a optional set of labels that are applied to every object during the Template to Config transformation.",
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "default": ""
- }
+ "image": {
+ "description": "image is a container image location that contains the update. This value is always populated.",
+ "type": "string",
+ "default": ""
},
- "message": {
- "description": "message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output.",
- "type": "string"
+ "startedTime": {
+ "description": "startedTime is the time at which the update was started.",
+ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "state": {
+ "description": "state reflects whether the update was fully applied. The Partial state indicates the update is not fully applied, while the Completed state indicates the update was successfully rolled out at least once (all parts of the update successfully applied).",
+ "type": "string",
+ "default": ""
},
- "objects": {
- "description": "objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.runtime.RawExtension"
- }
+ "verified": {
+ "description": "verified indicates whether the provided update was properly verified before it was installed. If this is false the cluster may not be trusted. Verified does not cover upgradeable checks that depend on the cluster state at the time when the update target was accepted.",
+ "type": "boolean",
+ "default": false
},
- "parameters": {
- "description": "parameters is an optional array of Parameters used during the Template to Config transformation.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.Parameter"
- }
+ "version": {
+ "description": "version is a semantic version identifying the update version. If the requested image does not define a version, or if a failure occurs retrieving the image, this value may be empty.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.template.v1.TemplateInstance": {
- "description": "TemplateInstance requests and records the instantiation of a Template. TemplateInstance is part of an experimental API.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.UsernameClaimMapping": {
+ "type": "object",
+ "required": [
+ "claim"
+ ],
+ "properties": {
+ "claim": {
+ "description": "claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.\n\nclaim must not be an empty string (\"\") and must not exceed 256 characters.",
+ "type": "string",
+ "default": ""
+ },
+ "prefix": {
+ "description": "prefix configures the prefix that should be prepended to the value of the JWT claim.\n\nprefix must be set when prefixPolicy is set to 'Prefix' and must be unset otherwise.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.UsernamePrefix"
+ },
+ "prefixPolicy": {
+ "description": "prefixPolicy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field.\n\nAllowed values are 'Prefix', 'NoPrefix', and omitted (not provided or an empty string).\n\nWhen set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'.\n\nWhen set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim.\n\nWhen omitted, this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends `{issuerURL}#` to the value of the JWT claim when the claim is not 'email'. As an example, consider the following scenario:\n `prefix` is unset, `issuerURL` is set to `https://myoidc.tld`,\n the JWT claims include \"username\":\"userA\" and \"email\":\"userA@myoidc.tld\",\n and `claim` is set to:\n - \"username\": the mapped value will be \"https://myoidc.tld#userA\"\n - \"email\": the mapped value will be \"userA@myoidc.tld\"",
+ "type": "string",
+ "default": ""
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "prefixPolicy",
+ "fields-to-discriminateBy": {
+ "claim": "Claim",
+ "prefix": "Prefix"
+ }
+ }
+ ]
+ },
+ "com.github.openshift.api.config.v1.UsernamePrefix": {
+ "description": "UsernamePrefix configures the string that should be used as a prefix for username claim mappings.",
"type": "object",
"required": [
- "spec"
+ "prefixString"
],
"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",
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "spec": {
- "description": "spec describes the desired state of this TemplateInstance.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.TemplateInstanceSpec"
- },
- "status": {
- "description": "status describes the current state of this TemplateInstance.",
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.TemplateInstanceStatus"
+ "prefixString": {
+ "description": "prefixString is a required field that configures the prefix that will be applied to cluster identity username attribute during the process of mapping JWT claims to cluster identity attributes.\n\nprefixString must not be an empty string (\"\").",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.template.v1.TemplateInstanceCondition": {
- "description": "TemplateInstanceCondition contains condition information for a TemplateInstance.",
+ "com.github.openshift.api.config.v1.VSphereFailureDomainHostGroup": {
+ "description": "VSphereFailureDomainHostGroup holds the vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.",
"type": "object",
"required": [
- "type",
- "status",
- "lastTransitionTime",
- "reason",
- "message"
+ "vmGroup",
+ "hostGroup",
+ "vmHostRule"
],
"properties": {
- "lastTransitionTime": {
- "description": "lastTransitionTime is the last time a condition status transitioned from one state to another.",
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
- },
- "message": {
- "description": "message is a human readable description of the details of the last transition, complementing reason.",
- "type": "string",
- "default": ""
- },
- "reason": {
- "description": "reason is a brief machine readable explanation for the condition's last transition.",
+ "hostGroup": {
+ "description": "hostGroup is the name of the vm-host group of type host within vCenter for this failure domain. hostGroup is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup",
"type": "string",
"default": ""
},
- "status": {
- "description": "status of the condition, one of True, False or Unknown.",
+ "vmGroup": {
+ "description": "vmGroup is the name of the vm-host group of type virtual machine within vCenter for this failure domain. vmGroup is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup",
"type": "string",
"default": ""
},
- "type": {
- "description": "type of the condition, currently Ready or InstantiateFailure.",
+ "vmHostRule": {
+ "description": "vmHostRule is the name of the affinity vm-host rule within vCenter for this failure domain. vmHostRule is limited to 80 characters. This field is required when the VSphereFailureDomain ZoneType is HostGroup",
"type": "string",
"default": ""
}
}
},
- "com.github.openshift.api.template.v1.TemplateInstanceList": {
- "description": "TemplateInstanceList is a list of TemplateInstance objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.VSphereFailureDomainRegionAffinity": {
+ "description": "VSphereFailureDomainRegionAffinity contains the region type which is the string representation of the VSphereFailureDomainRegionType with available options of Datacenter and ComputeCluster.",
"type": "object",
"required": [
- "items"
+ "type"
],
"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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of Templateinstances",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.TemplateInstance"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "type": {
+ "description": "type determines the vSphere object type for a region within this failure domain. Available types are Datacenter and ComputeCluster. When set to Datacenter, this means the vCenter Datacenter defined is the region. When set to ComputeCluster, this means the vCenter cluster defined is the region.\n\nPossible enum values:\n - `\"ComputeCluster\"` is a failure domain region for a vCenter compute cluster.\n - `\"Datacenter\"` is a failure domain region for a vCenter datacenter.",
+ "type": "string",
+ "default": "",
+ "enum": [
+ "ComputeCluster",
+ "Datacenter"
+ ]
}
- }
- },
- "com.github.openshift.api.template.v1.TemplateInstanceObject": {
- "description": "TemplateInstanceObject references an object created by a TemplateInstance.",
- "type": "object",
- "properties": {
- "ref": {
- "description": "ref is a reference to the created object. When used under .spec, only name and namespace are used; these can contain references to parameters which will be substituted following the usual rules.",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {}
}
- }
+ ]
},
- "com.github.openshift.api.template.v1.TemplateInstanceRequester": {
- "description": "TemplateInstanceRequester holds the identity of an agent requesting a template instantiation.",
+ "com.github.openshift.api.config.v1.VSphereFailureDomainZoneAffinity": {
+ "description": "VSphereFailureDomainZoneAffinity contains the vCenter cluster vm-host group (virtual machine and host types) and the vm-host affinity rule that together creates an affinity configuration for vm-host based zonal. This configuration within vCenter creates the required association between a failure domain, virtual machines and ESXi hosts to create a vm-host based zone.",
"type": "object",
+ "required": [
+ "type"
+ ],
"properties": {
- "extra": {
- "description": "extra holds additional information provided by the authenticator.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
- }
+ "hostGroup": {
+ "description": "hostGroup holds the vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSphereFailureDomainHostGroup"
},
- "groups": {
- "description": "groups represent the groups this user is a part of.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
+ "type": {
+ "description": "type determines the vSphere object type for a zone within this failure domain. Available types are ComputeCluster and HostGroup. When set to ComputeCluster, this means the vCenter cluster defined is the zone. When set to HostGroup, hostGroup must be configured with hostGroup, vmGroup and vmHostRule and this means the zone is defined by the grouping of those fields.\n\nPossible enum values:\n - `\"ComputeCluster\"` is a failure domain zone for a vCenter compute cluster.\n - `\"HostGroup\"` is a failure domain zone for a vCenter vm-host group.",
+ "type": "string",
+ "default": "",
+ "enum": [
+ "ComputeCluster",
+ "HostGroup"
+ ]
+ }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {
+ "hostGroup": "HostGroup"
}
- },
- "uid": {
- "description": "uid is a unique value that identifies this user across time; if this user is deleted and another user by the same name is added, they will have different UIDs.",
- "type": "string"
- },
- "username": {
- "description": "username uniquely identifies this user among all active users.",
- "type": "string"
}
- }
+ ]
},
- "com.github.openshift.api.template.v1.TemplateInstanceSpec": {
- "description": "TemplateInstanceSpec describes the desired state of a TemplateInstance.",
+ "com.github.openshift.api.config.v1.VSpherePlatformFailureDomainSpec": {
+ "description": "VSpherePlatformFailureDomainSpec holds the region and zone failure domain and the vCenter topology of that failure domain.",
"type": "object",
"required": [
- "template"
+ "name",
+ "region",
+ "zone",
+ "server",
+ "topology"
],
"properties": {
- "requester": {
- "description": "requester holds the identity of the agent requesting the template instantiation.",
- "$ref": "#/definitions/com.github.openshift.api.template.v1.TemplateInstanceRequester"
+ "name": {
+ "description": "name defines the arbitrary but unique name of a failure domain.",
+ "type": "string",
+ "default": ""
},
- "secret": {
- "description": "secret is a reference to a Secret object containing the necessary template parameters.",
- "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
+ "region": {
+ "description": "region defines the name of a region tag that will be attached to a vCenter datacenter. The tag category in vCenter must be named openshift-region.",
+ "type": "string",
+ "default": ""
},
- "template": {
- "description": "template is a full copy of the template for instantiation.",
+ "regionAffinity": {
+ "description": "regionAffinity holds the type of region, Datacenter or ComputeCluster. When set to Datacenter, this means the region is a vCenter Datacenter as defined in topology. When set to ComputeCluster, this means the region is a vCenter Cluster as defined in topology.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSphereFailureDomainRegionAffinity"
+ },
+ "server": {
+ "description": "server is the fully-qualified domain name or the IP address of the vCenter server.",
+ "type": "string",
+ "default": ""
+ },
+ "topology": {
+ "description": "topology describes a given failure domain using vSphere constructs",
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.Template"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformTopology"
+ },
+ "zone": {
+ "description": "zone defines the name of a zone tag that will be attached to a vCenter cluster. The tag category in vCenter must be named openshift-zone.",
+ "type": "string",
+ "default": ""
+ },
+ "zoneAffinity": {
+ "description": "zoneAffinity holds the type of the zone and the hostGroup which vmGroup and the hostGroup names in vCenter corresponds to a vm-host group of type Virtual Machine and Host respectively. Is also contains the vmHostRule which is an affinity vm-host rule in vCenter.",
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSphereFailureDomainZoneAffinity"
}
}
},
- "com.github.openshift.api.template.v1.TemplateInstanceStatus": {
- "description": "TemplateInstanceStatus describes the current state of a TemplateInstance.",
+ "com.github.openshift.api.config.v1.VSpherePlatformLoadBalancer": {
+ "description": "VSpherePlatformLoadBalancer defines the load balancer used by the cluster on VSphere platform.",
"type": "object",
"properties": {
- "conditions": {
- "description": "conditions represent the latest available observations of a TemplateInstance's current state.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.TemplateInstanceCondition"
- }
- },
- "objects": {
- "description": "objects references the objects created by the TemplateInstance.",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.TemplateInstanceObject"
- }
+ "type": {
+ "description": "type defines the type of load balancer used by the cluster on VSphere platform which can be a user-managed or openshift-managed load balancer that is to be used for the OpenShift API and Ingress endpoints. When set to OpenShiftManagedDefault the static pods in charge of API and Ingress traffic load-balancing defined in the machine config operator will be deployed. When set to UserManaged these static pods will not be deployed and it is expected that the load balancer is configured out of band by the deployer. When omitted, this means no opinion and the platform is left to choose a reasonable default. The default value is OpenShiftManagedDefault.",
+ "type": "string",
+ "default": "OpenShiftManagedDefault"
}
- }
+ },
+ "x-kubernetes-unions": [
+ {
+ "discriminator": "type",
+ "fields-to-discriminateBy": {}
+ }
+ ]
},
- "com.github.openshift.api.template.v1.TemplateList": {
- "description": "TemplateList is a list of Template objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.VSpherePlatformNodeNetworking": {
+ "description": "VSpherePlatformNodeNetworking holds the external and internal node networking spec.",
"type": "object",
- "required": [
- "items"
- ],
"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",
- "type": "string"
- },
- "items": {
- "description": "items is a list of templates",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.template.v1.Template"
- }
- },
- "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",
- "type": "string"
+ "external": {
+ "description": "external represents the network configuration of the node that is externally routable.",
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformNodeNetworkingSpec"
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "internal": {
+ "description": "internal represents the network configuration of the node that is routable only within the cluster.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformNodeNetworkingSpec"
}
}
},
- "com.github.openshift.api.user.v1.Group": {
- "description": "Group represents a referenceable set of Users\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.VSpherePlatformNodeNetworkingSpec": {
+ "description": "VSpherePlatformNodeNetworkingSpec holds the network CIDR(s) and port group name for including and excluding IP ranges in the cloud provider. This would be used for example when multiple network adapters are attached to a guest to help determine which IP address the cloud config manager should use for the external and internal node networking.",
"type": "object",
- "required": [
- "users"
- ],
"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",
- "type": "string"
+ "excludeNetworkSubnetCidr": {
+ "description": "excludeNetworkSubnetCidr IP addresses in subnet ranges will be excluded when selecting the IP address from the VirtualMachine's VM for use in the status.addresses fields.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "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",
+ "network": {
+ "description": "network VirtualMachine's VM Network names that will be used to when searching for status.addresses fields. Note that if internal.networkSubnetCIDR and external.networkSubnetCIDR are not set, then the vNIC associated to this network must only have a single IP address assigned to it. The available networks (port groups) can be listed using `govc ls 'network/*'`",
"type": "string"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "users": {
- "description": "users is the list of users in this group.",
+ "networkSubnetCidr": {
+ "description": "networkSubnetCidr IP address on VirtualMachine's network interfaces included in the fields' CIDRs that will be used in respective status.addresses fields.",
"type": "array",
"items": {
"type": "string",
"default": ""
- }
+ },
+ "x-kubernetes-list-type": "set"
}
}
},
- "com.github.openshift.api.user.v1.GroupList": {
- "description": "GroupList is a collection of Groups\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.VSpherePlatformSpec": {
+ "description": "VSpherePlatformSpec holds the desired state of the vSphere infrastructure provider. In the future the cloud provider operator, storage operator and machine operator will use these fields for configuration.",
"type": "object",
- "required": [
- "items"
- ],
"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",
- "type": "string"
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.apiServerInternalIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "items": {
- "description": "items is the list of groups",
+ "failureDomains": {
+ "description": "failureDomains contains the definition of region, zone and the vCenter topology. If this is omitted failure domains (regions and zones) will not be used.",
"type": "array",
"items": {
"default": {},
- "$ref": "#/definitions/com.github.openshift.api.user.v1.Group"
- }
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformFailureDomainSpec"
+ },
+ "x-kubernetes-list-map-keys": [
+ "name"
+ ],
+ "x-kubernetes-list-type": "map"
},
- "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",
- "type": "string"
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IP addresses, one from IPv4 family and one from IPv6. In single stack clusters a single IP address is expected. When omitted, values from the status.ingressIPs will be used. Once set, the list cannot be completely removed (but its second entry can).",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "machineNetworks": {
+ "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes. Each network is provided in the CIDR format and should be IPv4 or IPv6, for example \"10.0.0.0/8\" or \"fd00::/8\".",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
+ },
+ "nodeNetworking": {
+ "description": "nodeNetworking contains the definition of internal and external network constraints for assigning the node's networking. If this field is omitted, networking defaults to the legacy address selection behavior which is to only support a single address and return the first one found.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformNodeNetworking"
+ },
+ "vcenters": {
+ "description": "vcenters holds the connection details for services to communicate with vCenter. Currently, only a single vCenter is supported, but in tech preview 3 vCenters are supported. Once the cluster has been installed, you are unable to change the current number of defined vCenters except in the case where the cluster has been upgraded from a version of OpenShift where the vsphere platform spec was not present. You may make modifications to the existing vCenters that are defined in the vcenters list in order to match with any added or modified failure domains.",
+ "type": "array",
+ "items": {
+ "default": {},
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformVCenterSpec"
+ },
+ "x-kubernetes-list-type": "atomic"
}
}
},
- "com.github.openshift.api.user.v1.Identity": {
- "description": "Identity records a successful authentication of a user with an identity provider. The information about the source of authentication is stored on the identity, and the identity is then associated with a single user object. Multiple identities can reference a single user. Information retrieved from the authentication provider is stored in the extra field using a schema determined by the provider.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.VSpherePlatformStatus": {
+ "description": "VSpherePlatformStatus holds the current status of the vSphere infrastructure provider.",
"type": "object",
"required": [
- "providerName",
- "providerUserName",
- "user"
+ "apiServerInternalIPs",
+ "ingressIPs"
],
"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",
+ "apiServerInternalIP": {
+ "description": "apiServerInternalIP is an IP address to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. It is the IP that the Infrastructure.status.apiServerInternalURI points to. It is the IP for a self-hosted load balancer in front of the API servers.\n\nDeprecated: Use APIServerInternalIPs instead.",
"type": "string"
},
- "extra": {
- "description": "extra holds extra information about this identity",
- "type": "object",
- "additionalProperties": {
+ "apiServerInternalIPs": {
+ "description": "apiServerInternalIPs are the IP addresses to contact the Kubernetes API server that can be used by components inside the cluster, like kubelets using the infrastructure rather than Kubernetes networking. These are the IPs for a self-hosted load balancer in front of the API servers. In dual stack clusters this list contains two IPs otherwise only one.",
+ "type": "array",
+ "items": {
"type": "string",
"default": ""
- }
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "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",
+ "ingressIP": {
+ "description": "ingressIP is an external IP which routes to the default ingress controller. The IP is a suitable target of a wildcard DNS record used to resolve default route host names.\n\nDeprecated: Use IngressIPs instead.",
"type": "string"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
- },
- "providerName": {
- "description": "providerName is the source of identity information",
- "type": "string",
- "default": ""
- },
- "providerUserName": {
- "description": "providerUserName uniquely represents this identity in the scope of the provider",
- "type": "string",
- "default": ""
+ "ingressIPs": {
+ "description": "ingressIPs are the external IPs which route to the default ingress controller. The IPs are suitable targets of a wildcard DNS record used to resolve default route host names. In dual stack clusters this list contains two IPs otherwise only one.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "user": {
- "description": "user is a reference to the user this identity is associated with Both Name and UID must be set",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- }
- }
- },
- "com.github.openshift.api.user.v1.IdentityList": {
- "description": "IdentityList is a collection of Identities\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
- "type": "object",
- "required": [
- "items"
- ],
- "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",
- "type": "string"
+ "loadBalancer": {
+ "description": "loadBalancer defines how the load balancer used by the cluster is configured.",
+ "default": {
+ "type": "OpenShiftManagedDefault"
+ },
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.VSpherePlatformLoadBalancer"
},
- "items": {
- "description": "items is the list of identities",
+ "machineNetworks": {
+ "description": "machineNetworks are IP networks used to connect all the OpenShift cluster nodes.",
"type": "array",
"items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.user.v1.Identity"
- }
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "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",
+ "nodeDNSIP": {
+ "description": "nodeDNSIP is the IP address for the internal DNS used by the nodes. Unlike the one managed by the DNS operator, `NodeDNSIP` provides name resolution for the nodes themselves. There is no DNS-as-a-service for vSphere deployments. In order to minimize necessary changes to the datacenter DNS, a DNS service is hosted as a static pod to serve those hostnames to the nodes in the cluster.",
"type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
- "com.github.openshift.api.user.v1.User": {
- "description": "Upon log in, every user of the system receives a User and Identity resource. Administrators may directly manipulate the attributes of the users for their own tracking, or set groups via the API. The user name is unique and is chosen based on the value provided by the identity provider - if a user already exists with the incoming name, the user name may have a number appended to it depending on the configuration of the system.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.VSpherePlatformTopology": {
+ "description": "VSpherePlatformTopology holds the required and optional vCenter objects - datacenter, computeCluster, networks, datastore and resourcePool - to provision virtual machines.",
"type": "object",
"required": [
- "groups"
+ "datacenter",
+ "computeCluster",
+ "networks",
+ "datastore"
],
"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",
- "type": "string"
+ "computeCluster": {
+ "description": "computeCluster the absolute path of the vCenter cluster in which virtual machine will be located. The absolute path is of the form //host/. The maximum length of the path is 2048 characters.",
+ "type": "string",
+ "default": ""
},
- "fullName": {
- "description": "fullName is the full name of user",
- "type": "string"
+ "datacenter": {
+ "description": "datacenter is the name of vCenter datacenter in which virtual machines will be located. The maximum length of the datacenter name is 80 characters.",
+ "type": "string",
+ "default": ""
},
- "groups": {
- "description": "groups specifies group names this user is a member of. This field is deprecated and will be removed in a future release. Instead, create a Group object containing the name of this User.",
- "type": "array",
- "items": {
- "type": "string",
- "default": ""
- }
+ "datastore": {
+ "description": "datastore is the absolute path of the datastore in which the virtual machine is located. The absolute path is of the form //datastore/ The maximum length of the path is 2048 characters.",
+ "type": "string",
+ "default": ""
+ },
+ "folder": {
+ "description": "folder is the absolute path of the folder where virtual machines are located. The absolute path is of the form //vm/. The maximum length of the path is 2048 characters.",
+ "type": "string"
},
- "identities": {
- "description": "identities are the identities associated with this user",
+ "networks": {
+ "description": "networks is the list of port group network names within this failure domain. If feature gate VSphereMultiNetworks is enabled, up to 10 network adapters may be defined. 10 is the maximum number of virtual network devices which may be attached to a VM as defined by: https://configmax.esp.vmware.com/guest?vmwareproduct=vSphere&release=vSphere%208.0&categories=1-0 The available networks (port groups) can be listed using `govc ls 'network/*'` Networks should be in the form of an absolute path: //network/.",
"type": "array",
"items": {
"type": "string",
"default": ""
- }
+ },
+ "x-kubernetes-list-type": "atomic"
},
- "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",
+ "resourcePool": {
+ "description": "resourcePool is the absolute path of the resource pool where virtual machines will be created. The absolute path is of the form //host//Resources/. The maximum length of the path is 2048 characters.",
"type": "string"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "template": {
+ "description": "template is the full inventory path of the virtual machine or template that will be cloned when creating new machines in this failure domain. The maximum length of the path is 2048 characters.\n\nWhen omitted, the template will be calculated by the control plane machineset operator based on the region and zone defined in VSpherePlatformFailureDomainSpec. For example, for zone=zonea, region=region1, and infrastructure name=test, the template path would be calculated as //vm/test-rhcos-region1-zonea.",
+ "type": "string"
}
}
},
- "com.github.openshift.api.user.v1.UserIdentityMapping": {
- "description": "UserIdentityMapping maps a user to an identity\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.VSpherePlatformVCenterSpec": {
+ "description": "VSpherePlatformVCenterSpec stores the vCenter connection fields. This is used by the vSphere CCM.",
"type": "object",
+ "required": [
+ "server",
+ "datacenters"
+ ],
"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",
- "type": "string"
- },
- "identity": {
- "description": "identity is a reference to an identity",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
- },
- "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",
- "type": "string"
+ "datacenters": {
+ "description": "The vCenter Datacenters in which the RHCOS vm guests are located. This field will be used by the Cloud Controller Manager. Each datacenter listed here should be used within a topology.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "default": ""
+ },
+ "x-kubernetes-list-type": "set"
},
- "metadata": {
- "description": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
- "default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
+ "port": {
+ "description": "port is the TCP port that will be used to communicate to the vCenter endpoint. When omitted, this means the user has no opinion and it is up to the platform to choose a sensible default, which is subject to change over time.",
+ "type": "integer",
+ "format": "int32"
},
- "user": {
- "description": "user is a reference to a user",
- "default": {},
- "$ref": "#/definitions/io.k8s.api.core.v1.ObjectReference"
+ "server": {
+ "description": "server is the fully-qualified domain name or the IP address of the vCenter server.",
+ "type": "string",
+ "default": ""
}
}
},
- "com.github.openshift.api.user.v1.UserList": {
- "description": "UserList is a collection of Users\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
+ "com.github.openshift.api.config.v1.WebhookTokenAuthenticator": {
+ "description": "webhookTokenAuthenticator holds the necessary configuration options for a remote token authenticator",
"type": "object",
"required": [
- "items"
+ "kubeConfig"
],
"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",
- "type": "string"
- },
- "items": {
- "description": "items is the list of users",
- "type": "array",
- "items": {
- "default": {},
- "$ref": "#/definitions/com.github.openshift.api.user.v1.User"
- }
- },
- "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",
- "type": "string"
- },
- "metadata": {
- "description": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
+ "kubeConfig": {
+ "description": "kubeConfig references a secret that contains kube config file data which describes how to access the remote webhook service. The namespace for the referenced secret is openshift-config.\n\nFor further details, see:\n\nhttps://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication\n\nThe key \"kubeConfig\" is used to locate the data. If the secret or expected key is not found, the webhook is not honored. If the specified kube config data is not valid, the webhook is not honored.",
"default": {},
- "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
+ "$ref": "#/definitions/com.github.openshift.api.config.v1.SecretNameReference"
}
}
},
diff --git a/payload-manifests/crds/0000_10_config-operator_01_schedulers-CustomNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_schedulers-CustomNoUpgrade.crd.yaml
deleted file mode 100644
index d058dd7dccc..00000000000
--- a/payload-manifests/crds/0000_10_config-operator_01_schedulers-CustomNoUpgrade.crd.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- annotations:
- api-approved.openshift.io: https://github.com/openshift/api/pull/470
- api.openshift.io/merged-by-featuregates: "true"
- include.release.openshift.io/ibm-cloud-managed: "true"
- include.release.openshift.io/self-managed-high-availability: "true"
- release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: CustomNoUpgrade
- name: schedulers.config.openshift.io
-spec:
- group: config.openshift.io
- names:
- kind: Scheduler
- listKind: SchedulerList
- plural: schedulers
- singular: scheduler
- scope: Cluster
- versions:
- - name: v1
- schema:
- openAPIV3Schema:
- description: |-
- Scheduler holds cluster-wide config information to run the Kubernetes Scheduler
- and influence its placement decisions. The canonical name for this config is `cluster`.
-
- Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- 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
- 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
- type: string
- metadata:
- type: object
- spec:
- description: spec holds user settable values for configuration
- properties:
- defaultNodeSelector:
- description: |-
- defaultNodeSelector helps set the cluster-wide default node selector to
- restrict pod placement to specific nodes. This is applied to the pods
- created in all namespaces and creates an intersection with any existing
- nodeSelectors already set on a pod, additionally constraining that pod's selector.
- For example,
- defaultNodeSelector: "type=user-node,region=east" would set nodeSelector
- field in pod spec to "type=user-node,region=east" to all pods created
- in all namespaces. Namespaces having project-wide node selectors won't be
- impacted even if this field is set. This adds an annotation section to
- the namespace.
- For example, if a new namespace is created with
- node-selector='type=user-node,region=east',
- the annotation openshift.io/node-selector: type=user-node,region=east
- gets added to the project. When the openshift.io/node-selector annotation
- is set on the project the value is used in preference to the value we are setting
- for defaultNodeSelector field.
- For instance,
- openshift.io/node-selector: "type=user-node,region=west" means
- that the default of "type=user-node,region=east" set in defaultNodeSelector
- would not be applied.
- type: string
- mastersSchedulable:
- description: |-
- mastersSchedulable allows masters nodes to be schedulable. When this flag is
- turned on, all the master nodes in the cluster will be made schedulable,
- so that workload pods can run on them. The default value for this field is false,
- meaning none of the master nodes are schedulable.
- Important Note: Once the workload pods start running on the master nodes,
- extreme care must be taken to ensure that cluster-critical control plane components
- are not impacted.
- Please turn on this field after doing due diligence.
- type: boolean
- policy:
- description: |-
- DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release.
- policy is a reference to a ConfigMap containing scheduler policy which has
- user specified predicates and priorities. If this ConfigMap is not available
- scheduler will default to use DefaultAlgorithmProvider.
- The namespace for this configmap is openshift-config.
- properties:
- name:
- description: name is the metadata.name of the referenced config
- map
- type: string
- required:
- - name
- type: object
- profile:
- description: |-
- profile sets which scheduling profile should be set in order to configure scheduling
- decisions for new pods.
-
- Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring"
- Defaults to "LowNodeUtilization"
- enum:
- - ""
- - LowNodeUtilization
- - HighNodeUtilization
- - NoScoring
- type: string
- profileCustomizations:
- description: profileCustomizations contains configuration for modifying
- the default behavior of existing scheduler profiles.
- properties:
- dynamicResourceAllocation:
- description: |-
- dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- Third-party resource drivers are responsible for tracking and allocating resources.
- Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- Valid values are Enabled, Disabled and omitted.
- When omitted, this means no opinion and the platform is left to choose a reasonable default,
- which is subject to change over time.
- The current default is Disabled.
- enum:
- - ""
- - Enabled
- - Disabled
- type: string
- type: object
- type: object
- status:
- description: status holds observed values from the cluster. They may not
- be overridden.
- type: object
- required:
- - spec
- type: object
- served: true
- storage: true
- subresources:
- status: {}
diff --git a/payload-manifests/crds/0000_10_config-operator_01_schedulers-DevPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_schedulers-DevPreviewNoUpgrade.crd.yaml
deleted file mode 100644
index a62eb09733f..00000000000
--- a/payload-manifests/crds/0000_10_config-operator_01_schedulers-DevPreviewNoUpgrade.crd.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- annotations:
- api-approved.openshift.io: https://github.com/openshift/api/pull/470
- api.openshift.io/merged-by-featuregates: "true"
- include.release.openshift.io/ibm-cloud-managed: "true"
- include.release.openshift.io/self-managed-high-availability: "true"
- release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: DevPreviewNoUpgrade
- name: schedulers.config.openshift.io
-spec:
- group: config.openshift.io
- names:
- kind: Scheduler
- listKind: SchedulerList
- plural: schedulers
- singular: scheduler
- scope: Cluster
- versions:
- - name: v1
- schema:
- openAPIV3Schema:
- description: |-
- Scheduler holds cluster-wide config information to run the Kubernetes Scheduler
- and influence its placement decisions. The canonical name for this config is `cluster`.
-
- Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- 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
- 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
- type: string
- metadata:
- type: object
- spec:
- description: spec holds user settable values for configuration
- properties:
- defaultNodeSelector:
- description: |-
- defaultNodeSelector helps set the cluster-wide default node selector to
- restrict pod placement to specific nodes. This is applied to the pods
- created in all namespaces and creates an intersection with any existing
- nodeSelectors already set on a pod, additionally constraining that pod's selector.
- For example,
- defaultNodeSelector: "type=user-node,region=east" would set nodeSelector
- field in pod spec to "type=user-node,region=east" to all pods created
- in all namespaces. Namespaces having project-wide node selectors won't be
- impacted even if this field is set. This adds an annotation section to
- the namespace.
- For example, if a new namespace is created with
- node-selector='type=user-node,region=east',
- the annotation openshift.io/node-selector: type=user-node,region=east
- gets added to the project. When the openshift.io/node-selector annotation
- is set on the project the value is used in preference to the value we are setting
- for defaultNodeSelector field.
- For instance,
- openshift.io/node-selector: "type=user-node,region=west" means
- that the default of "type=user-node,region=east" set in defaultNodeSelector
- would not be applied.
- type: string
- mastersSchedulable:
- description: |-
- mastersSchedulable allows masters nodes to be schedulable. When this flag is
- turned on, all the master nodes in the cluster will be made schedulable,
- so that workload pods can run on them. The default value for this field is false,
- meaning none of the master nodes are schedulable.
- Important Note: Once the workload pods start running on the master nodes,
- extreme care must be taken to ensure that cluster-critical control plane components
- are not impacted.
- Please turn on this field after doing due diligence.
- type: boolean
- policy:
- description: |-
- DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release.
- policy is a reference to a ConfigMap containing scheduler policy which has
- user specified predicates and priorities. If this ConfigMap is not available
- scheduler will default to use DefaultAlgorithmProvider.
- The namespace for this configmap is openshift-config.
- properties:
- name:
- description: name is the metadata.name of the referenced config
- map
- type: string
- required:
- - name
- type: object
- profile:
- description: |-
- profile sets which scheduling profile should be set in order to configure scheduling
- decisions for new pods.
-
- Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring"
- Defaults to "LowNodeUtilization"
- enum:
- - ""
- - LowNodeUtilization
- - HighNodeUtilization
- - NoScoring
- type: string
- profileCustomizations:
- description: profileCustomizations contains configuration for modifying
- the default behavior of existing scheduler profiles.
- properties:
- dynamicResourceAllocation:
- description: |-
- dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- Third-party resource drivers are responsible for tracking and allocating resources.
- Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- Valid values are Enabled, Disabled and omitted.
- When omitted, this means no opinion and the platform is left to choose a reasonable default,
- which is subject to change over time.
- The current default is Disabled.
- enum:
- - ""
- - Enabled
- - Disabled
- type: string
- type: object
- type: object
- status:
- description: status holds observed values from the cluster. They may not
- be overridden.
- type: object
- required:
- - spec
- type: object
- served: true
- storage: true
- subresources:
- status: {}
diff --git a/payload-manifests/crds/0000_10_config-operator_01_schedulers-TechPreviewNoUpgrade.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_schedulers-TechPreviewNoUpgrade.crd.yaml
deleted file mode 100644
index 24fbbb3021f..00000000000
--- a/payload-manifests/crds/0000_10_config-operator_01_schedulers-TechPreviewNoUpgrade.crd.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- annotations:
- api-approved.openshift.io: https://github.com/openshift/api/pull/470
- api.openshift.io/merged-by-featuregates: "true"
- include.release.openshift.io/ibm-cloud-managed: "true"
- include.release.openshift.io/self-managed-high-availability: "true"
- release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: TechPreviewNoUpgrade
- name: schedulers.config.openshift.io
-spec:
- group: config.openshift.io
- names:
- kind: Scheduler
- listKind: SchedulerList
- plural: schedulers
- singular: scheduler
- scope: Cluster
- versions:
- - name: v1
- schema:
- openAPIV3Schema:
- description: |-
- Scheduler holds cluster-wide config information to run the Kubernetes Scheduler
- and influence its placement decisions. The canonical name for this config is `cluster`.
-
- Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- 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
- 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
- type: string
- metadata:
- type: object
- spec:
- description: spec holds user settable values for configuration
- properties:
- defaultNodeSelector:
- description: |-
- defaultNodeSelector helps set the cluster-wide default node selector to
- restrict pod placement to specific nodes. This is applied to the pods
- created in all namespaces and creates an intersection with any existing
- nodeSelectors already set on a pod, additionally constraining that pod's selector.
- For example,
- defaultNodeSelector: "type=user-node,region=east" would set nodeSelector
- field in pod spec to "type=user-node,region=east" to all pods created
- in all namespaces. Namespaces having project-wide node selectors won't be
- impacted even if this field is set. This adds an annotation section to
- the namespace.
- For example, if a new namespace is created with
- node-selector='type=user-node,region=east',
- the annotation openshift.io/node-selector: type=user-node,region=east
- gets added to the project. When the openshift.io/node-selector annotation
- is set on the project the value is used in preference to the value we are setting
- for defaultNodeSelector field.
- For instance,
- openshift.io/node-selector: "type=user-node,region=west" means
- that the default of "type=user-node,region=east" set in defaultNodeSelector
- would not be applied.
- type: string
- mastersSchedulable:
- description: |-
- mastersSchedulable allows masters nodes to be schedulable. When this flag is
- turned on, all the master nodes in the cluster will be made schedulable,
- so that workload pods can run on them. The default value for this field is false,
- meaning none of the master nodes are schedulable.
- Important Note: Once the workload pods start running on the master nodes,
- extreme care must be taken to ensure that cluster-critical control plane components
- are not impacted.
- Please turn on this field after doing due diligence.
- type: boolean
- policy:
- description: |-
- DEPRECATED: the scheduler Policy API has been deprecated and will be removed in a future release.
- policy is a reference to a ConfigMap containing scheduler policy which has
- user specified predicates and priorities. If this ConfigMap is not available
- scheduler will default to use DefaultAlgorithmProvider.
- The namespace for this configmap is openshift-config.
- properties:
- name:
- description: name is the metadata.name of the referenced config
- map
- type: string
- required:
- - name
- type: object
- profile:
- description: |-
- profile sets which scheduling profile should be set in order to configure scheduling
- decisions for new pods.
-
- Valid values are "LowNodeUtilization", "HighNodeUtilization", "NoScoring"
- Defaults to "LowNodeUtilization"
- enum:
- - ""
- - LowNodeUtilization
- - HighNodeUtilization
- - NoScoring
- type: string
- profileCustomizations:
- description: profileCustomizations contains configuration for modifying
- the default behavior of existing scheduler profiles.
- properties:
- dynamicResourceAllocation:
- description: |-
- dynamicResourceAllocation allows to enable or disable dynamic resource allocation within the scheduler.
- Dynamic resource allocation is an API for requesting and sharing resources between pods and containers inside a pod.
- Third-party resource drivers are responsible for tracking and allocating resources.
- Different kinds of resources support arbitrary parameters for defining requirements and initialization.
- Valid values are Enabled, Disabled and omitted.
- When omitted, this means no opinion and the platform is left to choose a reasonable default,
- which is subject to change over time.
- The current default is Disabled.
- enum:
- - ""
- - Enabled
- - Disabled
- type: string
- type: object
- type: object
- status:
- description: status holds observed values from the cluster. They may not
- be overridden.
- type: object
- required:
- - spec
- type: object
- served: true
- storage: true
- subresources:
- status: {}
diff --git a/payload-manifests/crds/0000_10_config-operator_01_schedulers-Default.crd.yaml b/payload-manifests/crds/0000_10_config-operator_01_schedulers.crd.yaml
similarity index 99%
rename from payload-manifests/crds/0000_10_config-operator_01_schedulers-Default.crd.yaml
rename to payload-manifests/crds/0000_10_config-operator_01_schedulers.crd.yaml
index 37abbe9a533..96993e1399c 100644
--- a/payload-manifests/crds/0000_10_config-operator_01_schedulers-Default.crd.yaml
+++ b/payload-manifests/crds/0000_10_config-operator_01_schedulers.crd.yaml
@@ -7,7 +7,6 @@ metadata:
include.release.openshift.io/ibm-cloud-managed: "true"
include.release.openshift.io/self-managed-high-availability: "true"
release.openshift.io/bootstrap-required: "true"
- release.openshift.io/feature-set: Default
name: schedulers.config.openshift.io
spec:
group: config.openshift.io
diff --git a/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml b/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml
index 417c9f9aa17..c011e50b12a 100644
--- a/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml
+++ b/payload-manifests/featuregates/featureGate-Hypershift-Default.yaml
@@ -87,9 +87,6 @@
{
"name": "DyanmicServiceEndpointIBMCloud"
},
- {
- "name": "DynamicResourceAllocation"
- },
{
"name": "EtcdBackendQuota"
},
diff --git a/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml
index 937ea4b0691..5b404ba6e08 100644
--- a/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-Hypershift-DevPreviewNoUpgrade.yaml
@@ -142,9 +142,6 @@
{
"name": "DyanmicServiceEndpointIBMCloud"
},
- {
- "name": "DynamicResourceAllocation"
- },
{
"name": "EtcdBackendQuota"
},
diff --git a/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml
index 19f95a39ff8..a03e7d60da9 100644
--- a/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-Hypershift-TechPreviewNoUpgrade.yaml
@@ -154,9 +154,6 @@
{
"name": "DyanmicServiceEndpointIBMCloud"
},
- {
- "name": "DynamicResourceAllocation"
- },
{
"name": "EtcdBackendQuota"
},
diff --git a/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml b/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml
index 9618cf01e02..eb49c8baf46 100644
--- a/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml
+++ b/payload-manifests/featuregates/featureGate-SelfManagedHA-Default.yaml
@@ -87,9 +87,6 @@
{
"name": "DyanmicServiceEndpointIBMCloud"
},
- {
- "name": "DynamicResourceAllocation"
- },
{
"name": "EtcdBackendQuota"
},
diff --git a/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml
index bec36643559..796cc6b2d14 100644
--- a/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-SelfManagedHA-DevPreviewNoUpgrade.yaml
@@ -124,9 +124,6 @@
{
"name": "DyanmicServiceEndpointIBMCloud"
},
- {
- "name": "DynamicResourceAllocation"
- },
{
"name": "EtcdBackendQuota"
},
diff --git a/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml b/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml
index b4994c92bf1..904a066e12a 100644
--- a/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml
+++ b/payload-manifests/featuregates/featureGate-SelfManagedHA-TechPreviewNoUpgrade.yaml
@@ -136,9 +136,6 @@
{
"name": "DyanmicServiceEndpointIBMCloud"
},
- {
- "name": "DynamicResourceAllocation"
- },
{
"name": "EtcdBackendQuota"
},